@@ -116,8 +116,8 @@ |
||
| 116 | 116 | * Looks up a system wide defined value |
| 117 | 117 | * |
| 118 | 118 | * @param string $key the key of the value, under which it was saved |
| 119 | - * @param mixed $default the default value to be returned if the value isn't set |
|
| 120 | - * @return mixed the value or $default |
|
| 119 | + * @param string|false $default the default value to be returned if the value isn't set |
|
| 120 | + * @return string the value or $default |
|
| 121 | 121 | */ |
| 122 | 122 | public function getSystemValue($key, $default = '') { |
| 123 | 123 | return $this->systemConfig->getValue($key, $default); |
@@ -37,427 +37,427 @@ |
||
| 37 | 37 | * Class to combine all the configuration options ownCloud offers |
| 38 | 38 | */ |
| 39 | 39 | class AllConfig implements \OCP\IConfig { |
| 40 | - /** @var SystemConfig */ |
|
| 41 | - private $systemConfig; |
|
| 42 | - |
|
| 43 | - /** @var IDBConnection */ |
|
| 44 | - private $connection; |
|
| 45 | - |
|
| 46 | - /** |
|
| 47 | - * 3 dimensional array with the following structure: |
|
| 48 | - * [ $userId => |
|
| 49 | - * [ $appId => |
|
| 50 | - * [ $key => $value ] |
|
| 51 | - * ] |
|
| 52 | - * ] |
|
| 53 | - * |
|
| 54 | - * database table: preferences |
|
| 55 | - * |
|
| 56 | - * methods that use this: |
|
| 57 | - * - setUserValue |
|
| 58 | - * - getUserValue |
|
| 59 | - * - getUserKeys |
|
| 60 | - * - deleteUserValue |
|
| 61 | - * - deleteAllUserValues |
|
| 62 | - * - deleteAppFromAllUsers |
|
| 63 | - * |
|
| 64 | - * @var CappedMemoryCache $userCache |
|
| 65 | - */ |
|
| 66 | - private $userCache; |
|
| 67 | - |
|
| 68 | - /** |
|
| 69 | - * @param SystemConfig $systemConfig |
|
| 70 | - */ |
|
| 71 | - public function __construct(SystemConfig $systemConfig) { |
|
| 72 | - $this->userCache = new CappedMemoryCache(); |
|
| 73 | - $this->systemConfig = $systemConfig; |
|
| 74 | - } |
|
| 75 | - |
|
| 76 | - /** |
|
| 77 | - * TODO - FIXME This fixes an issue with base.php that cause cyclic |
|
| 78 | - * dependencies, especially with autoconfig setup |
|
| 79 | - * |
|
| 80 | - * Replace this by properly injected database connection. Currently the |
|
| 81 | - * base.php triggers the getDatabaseConnection too early which causes in |
|
| 82 | - * autoconfig setup case a too early distributed database connection and |
|
| 83 | - * the autoconfig then needs to reinit all already initialized dependencies |
|
| 84 | - * that use the database connection. |
|
| 85 | - * |
|
| 86 | - * otherwise a SQLite database is created in the wrong directory |
|
| 87 | - * because the database connection was created with an uninitialized config |
|
| 88 | - */ |
|
| 89 | - private function fixDIInit() { |
|
| 90 | - if($this->connection === null) { |
|
| 91 | - $this->connection = \OC::$server->getDatabaseConnection(); |
|
| 92 | - } |
|
| 93 | - } |
|
| 94 | - |
|
| 95 | - /** |
|
| 96 | - * Sets and deletes system wide values |
|
| 97 | - * |
|
| 98 | - * @param array $configs Associative array with `key => value` pairs |
|
| 99 | - * If value is null, the config key will be deleted |
|
| 100 | - */ |
|
| 101 | - public function setSystemValues(array $configs) { |
|
| 102 | - $this->systemConfig->setValues($configs); |
|
| 103 | - } |
|
| 104 | - |
|
| 105 | - /** |
|
| 106 | - * Sets a new system wide value |
|
| 107 | - * |
|
| 108 | - * @param string $key the key of the value, under which will be saved |
|
| 109 | - * @param mixed $value the value that should be stored |
|
| 110 | - */ |
|
| 111 | - public function setSystemValue($key, $value) { |
|
| 112 | - $this->systemConfig->setValue($key, $value); |
|
| 113 | - } |
|
| 114 | - |
|
| 115 | - /** |
|
| 116 | - * Looks up a system wide defined value |
|
| 117 | - * |
|
| 118 | - * @param string $key the key of the value, under which it was saved |
|
| 119 | - * @param mixed $default the default value to be returned if the value isn't set |
|
| 120 | - * @return mixed the value or $default |
|
| 121 | - */ |
|
| 122 | - public function getSystemValue($key, $default = '') { |
|
| 123 | - return $this->systemConfig->getValue($key, $default); |
|
| 124 | - } |
|
| 125 | - |
|
| 126 | - /** |
|
| 127 | - * Looks up a system wide defined value and filters out sensitive data |
|
| 128 | - * |
|
| 129 | - * @param string $key the key of the value, under which it was saved |
|
| 130 | - * @param mixed $default the default value to be returned if the value isn't set |
|
| 131 | - * @return mixed the value or $default |
|
| 132 | - */ |
|
| 133 | - public function getFilteredSystemValue($key, $default = '') { |
|
| 134 | - return $this->systemConfig->getFilteredValue($key, $default); |
|
| 135 | - } |
|
| 136 | - |
|
| 137 | - /** |
|
| 138 | - * Delete a system wide defined value |
|
| 139 | - * |
|
| 140 | - * @param string $key the key of the value, under which it was saved |
|
| 141 | - */ |
|
| 142 | - public function deleteSystemValue($key) { |
|
| 143 | - $this->systemConfig->deleteValue($key); |
|
| 144 | - } |
|
| 145 | - |
|
| 146 | - /** |
|
| 147 | - * Get all keys stored for an app |
|
| 148 | - * |
|
| 149 | - * @param string $appName the appName that we stored the value under |
|
| 150 | - * @return string[] the keys stored for the app |
|
| 151 | - */ |
|
| 152 | - public function getAppKeys($appName) { |
|
| 153 | - return \OC::$server->getAppConfig()->getKeys($appName); |
|
| 154 | - } |
|
| 155 | - |
|
| 156 | - /** |
|
| 157 | - * Writes a new app wide value |
|
| 158 | - * |
|
| 159 | - * @param string $appName the appName that we want to store the value under |
|
| 160 | - * @param string $key the key of the value, under which will be saved |
|
| 161 | - * @param string|float|int $value the value that should be stored |
|
| 162 | - */ |
|
| 163 | - public function setAppValue($appName, $key, $value) { |
|
| 164 | - \OC::$server->getAppConfig()->setValue($appName, $key, $value); |
|
| 165 | - } |
|
| 166 | - |
|
| 167 | - /** |
|
| 168 | - * Looks up an app wide defined value |
|
| 169 | - * |
|
| 170 | - * @param string $appName the appName that we stored the value under |
|
| 171 | - * @param string $key the key of the value, under which it was saved |
|
| 172 | - * @param string $default the default value to be returned if the value isn't set |
|
| 173 | - * @return string the saved value |
|
| 174 | - */ |
|
| 175 | - public function getAppValue($appName, $key, $default = '') { |
|
| 176 | - return \OC::$server->getAppConfig()->getValue($appName, $key, $default); |
|
| 177 | - } |
|
| 178 | - |
|
| 179 | - /** |
|
| 180 | - * Delete an app wide defined value |
|
| 181 | - * |
|
| 182 | - * @param string $appName the appName that we stored the value under |
|
| 183 | - * @param string $key the key of the value, under which it was saved |
|
| 184 | - */ |
|
| 185 | - public function deleteAppValue($appName, $key) { |
|
| 186 | - \OC::$server->getAppConfig()->deleteKey($appName, $key); |
|
| 187 | - } |
|
| 188 | - |
|
| 189 | - /** |
|
| 190 | - * Removes all keys in appconfig belonging to the app |
|
| 191 | - * |
|
| 192 | - * @param string $appName the appName the configs are stored under |
|
| 193 | - */ |
|
| 194 | - public function deleteAppValues($appName) { |
|
| 195 | - \OC::$server->getAppConfig()->deleteApp($appName); |
|
| 196 | - } |
|
| 197 | - |
|
| 198 | - |
|
| 199 | - /** |
|
| 200 | - * Set a user defined value |
|
| 201 | - * |
|
| 202 | - * @param string $userId the userId of the user that we want to store the value under |
|
| 203 | - * @param string $appName the appName that we want to store the value under |
|
| 204 | - * @param string $key the key under which the value is being stored |
|
| 205 | - * @param string|float|int $value the value that you want to store |
|
| 206 | - * @param string $preCondition only update if the config value was previously the value passed as $preCondition |
|
| 207 | - * @throws \OCP\PreConditionNotMetException if a precondition is specified and is not met |
|
| 208 | - * @throws \UnexpectedValueException when trying to store an unexpected value |
|
| 209 | - */ |
|
| 210 | - public function setUserValue($userId, $appName, $key, $value, $preCondition = null) { |
|
| 211 | - if (!is_int($value) && !is_float($value) && !is_string($value)) { |
|
| 212 | - throw new \UnexpectedValueException('Only integers, floats and strings are allowed as value'); |
|
| 213 | - } |
|
| 214 | - |
|
| 215 | - // TODO - FIXME |
|
| 216 | - $this->fixDIInit(); |
|
| 217 | - |
|
| 218 | - $prevValue = $this->getUserValue($userId, $appName, $key, null); |
|
| 219 | - |
|
| 220 | - if ($prevValue !== null) { |
|
| 221 | - if ($prevValue === (string)$value) { |
|
| 222 | - return; |
|
| 223 | - } else if ($preCondition !== null && $prevValue !== (string)$preCondition) { |
|
| 224 | - throw new PreConditionNotMetException(); |
|
| 225 | - } else { |
|
| 226 | - $qb = $this->connection->getQueryBuilder(); |
|
| 227 | - $qb->update('preferences') |
|
| 228 | - ->set('configvalue', $qb->createNamedParameter($value)) |
|
| 229 | - ->where($qb->expr()->eq('userid', $qb->createNamedParameter($userId))) |
|
| 230 | - ->andWhere($qb->expr()->eq('appid', $qb->createNamedParameter($appName))) |
|
| 231 | - ->andWhere($qb->expr()->eq('configkey', $qb->createNamedParameter($key))); |
|
| 232 | - $qb->execute(); |
|
| 233 | - |
|
| 234 | - $this->userCache[$userId][$appName][$key] = $value; |
|
| 235 | - return; |
|
| 236 | - } |
|
| 237 | - } |
|
| 238 | - |
|
| 239 | - $preconditionArray = []; |
|
| 240 | - if (isset($preCondition)) { |
|
| 241 | - $preconditionArray = [ |
|
| 242 | - 'configvalue' => $preCondition, |
|
| 243 | - ]; |
|
| 244 | - } |
|
| 245 | - |
|
| 246 | - $this->connection->setValues('preferences', [ |
|
| 247 | - 'userid' => $userId, |
|
| 248 | - 'appid' => $appName, |
|
| 249 | - 'configkey' => $key, |
|
| 250 | - ], [ |
|
| 251 | - 'configvalue' => $value, |
|
| 252 | - ], $preconditionArray); |
|
| 253 | - |
|
| 254 | - // only add to the cache if we already loaded data for the user |
|
| 255 | - if (isset($this->userCache[$userId])) { |
|
| 256 | - if (!isset($this->userCache[$userId][$appName])) { |
|
| 257 | - $this->userCache[$userId][$appName] = array(); |
|
| 258 | - } |
|
| 259 | - $this->userCache[$userId][$appName][$key] = $value; |
|
| 260 | - } |
|
| 261 | - } |
|
| 262 | - |
|
| 263 | - /** |
|
| 264 | - * Getting a user defined value |
|
| 265 | - * |
|
| 266 | - * @param string $userId the userId of the user that we want to store the value under |
|
| 267 | - * @param string $appName the appName that we stored the value under |
|
| 268 | - * @param string $key the key under which the value is being stored |
|
| 269 | - * @param mixed $default the default value to be returned if the value isn't set |
|
| 270 | - * @return string |
|
| 271 | - */ |
|
| 272 | - public function getUserValue($userId, $appName, $key, $default = '') { |
|
| 273 | - $data = $this->getUserValues($userId); |
|
| 274 | - if (isset($data[$appName]) and isset($data[$appName][$key])) { |
|
| 275 | - return $data[$appName][$key]; |
|
| 276 | - } else { |
|
| 277 | - return $default; |
|
| 278 | - } |
|
| 279 | - } |
|
| 280 | - |
|
| 281 | - /** |
|
| 282 | - * Get the keys of all stored by an app for the user |
|
| 283 | - * |
|
| 284 | - * @param string $userId the userId of the user that we want to store the value under |
|
| 285 | - * @param string $appName the appName that we stored the value under |
|
| 286 | - * @return string[] |
|
| 287 | - */ |
|
| 288 | - public function getUserKeys($userId, $appName) { |
|
| 289 | - $data = $this->getUserValues($userId); |
|
| 290 | - if (isset($data[$appName])) { |
|
| 291 | - return array_keys($data[$appName]); |
|
| 292 | - } else { |
|
| 293 | - return array(); |
|
| 294 | - } |
|
| 295 | - } |
|
| 296 | - |
|
| 297 | - /** |
|
| 298 | - * Delete a user value |
|
| 299 | - * |
|
| 300 | - * @param string $userId the userId of the user that we want to store the value under |
|
| 301 | - * @param string $appName the appName that we stored the value under |
|
| 302 | - * @param string $key the key under which the value is being stored |
|
| 303 | - */ |
|
| 304 | - public function deleteUserValue($userId, $appName, $key) { |
|
| 305 | - // TODO - FIXME |
|
| 306 | - $this->fixDIInit(); |
|
| 307 | - |
|
| 308 | - $sql = 'DELETE FROM `*PREFIX*preferences` '. |
|
| 309 | - 'WHERE `userid` = ? AND `appid` = ? AND `configkey` = ?'; |
|
| 310 | - $this->connection->executeUpdate($sql, array($userId, $appName, $key)); |
|
| 311 | - |
|
| 312 | - if (isset($this->userCache[$userId]) and isset($this->userCache[$userId][$appName])) { |
|
| 313 | - unset($this->userCache[$userId][$appName][$key]); |
|
| 314 | - } |
|
| 315 | - } |
|
| 316 | - |
|
| 317 | - /** |
|
| 318 | - * Delete all user values |
|
| 319 | - * |
|
| 320 | - * @param string $userId the userId of the user that we want to remove all values from |
|
| 321 | - */ |
|
| 322 | - public function deleteAllUserValues($userId) { |
|
| 323 | - // TODO - FIXME |
|
| 324 | - $this->fixDIInit(); |
|
| 325 | - |
|
| 326 | - $sql = 'DELETE FROM `*PREFIX*preferences` '. |
|
| 327 | - 'WHERE `userid` = ?'; |
|
| 328 | - $this->connection->executeUpdate($sql, array($userId)); |
|
| 329 | - |
|
| 330 | - unset($this->userCache[$userId]); |
|
| 331 | - } |
|
| 332 | - |
|
| 333 | - /** |
|
| 334 | - * Delete all user related values of one app |
|
| 335 | - * |
|
| 336 | - * @param string $appName the appName of the app that we want to remove all values from |
|
| 337 | - */ |
|
| 338 | - public function deleteAppFromAllUsers($appName) { |
|
| 339 | - // TODO - FIXME |
|
| 340 | - $this->fixDIInit(); |
|
| 341 | - |
|
| 342 | - $sql = 'DELETE FROM `*PREFIX*preferences` '. |
|
| 343 | - 'WHERE `appid` = ?'; |
|
| 344 | - $this->connection->executeUpdate($sql, array($appName)); |
|
| 345 | - |
|
| 346 | - foreach ($this->userCache as &$userCache) { |
|
| 347 | - unset($userCache[$appName]); |
|
| 348 | - } |
|
| 349 | - } |
|
| 350 | - |
|
| 351 | - /** |
|
| 352 | - * Returns all user configs sorted by app of one user |
|
| 353 | - * |
|
| 354 | - * @param string $userId the user ID to get the app configs from |
|
| 355 | - * @return array[] - 2 dimensional array with the following structure: |
|
| 356 | - * [ $appId => |
|
| 357 | - * [ $key => $value ] |
|
| 358 | - * ] |
|
| 359 | - */ |
|
| 360 | - private function getUserValues($userId) { |
|
| 361 | - if (isset($this->userCache[$userId])) { |
|
| 362 | - return $this->userCache[$userId]; |
|
| 363 | - } |
|
| 364 | - if ($userId === null || $userId === '') { |
|
| 365 | - $this->userCache[$userId]=array(); |
|
| 366 | - return $this->userCache[$userId]; |
|
| 367 | - } |
|
| 368 | - |
|
| 369 | - // TODO - FIXME |
|
| 370 | - $this->fixDIInit(); |
|
| 371 | - |
|
| 372 | - $data = array(); |
|
| 373 | - $query = 'SELECT `appid`, `configkey`, `configvalue` FROM `*PREFIX*preferences` WHERE `userid` = ?'; |
|
| 374 | - $result = $this->connection->executeQuery($query, array($userId)); |
|
| 375 | - while ($row = $result->fetch()) { |
|
| 376 | - $appId = $row['appid']; |
|
| 377 | - if (!isset($data[$appId])) { |
|
| 378 | - $data[$appId] = array(); |
|
| 379 | - } |
|
| 380 | - $data[$appId][$row['configkey']] = $row['configvalue']; |
|
| 381 | - } |
|
| 382 | - $this->userCache[$userId] = $data; |
|
| 383 | - return $data; |
|
| 384 | - } |
|
| 385 | - |
|
| 386 | - /** |
|
| 387 | - * Fetches a mapped list of userId -> value, for a specified app and key and a list of user IDs. |
|
| 388 | - * |
|
| 389 | - * @param string $appName app to get the value for |
|
| 390 | - * @param string $key the key to get the value for |
|
| 391 | - * @param array $userIds the user IDs to fetch the values for |
|
| 392 | - * @return array Mapped values: userId => value |
|
| 393 | - */ |
|
| 394 | - public function getUserValueForUsers($appName, $key, $userIds) { |
|
| 395 | - // TODO - FIXME |
|
| 396 | - $this->fixDIInit(); |
|
| 397 | - |
|
| 398 | - if (empty($userIds) || !is_array($userIds)) { |
|
| 399 | - return array(); |
|
| 400 | - } |
|
| 401 | - |
|
| 402 | - $chunkedUsers = array_chunk($userIds, 50, true); |
|
| 403 | - $placeholders50 = implode(',', array_fill(0, 50, '?')); |
|
| 404 | - |
|
| 405 | - $userValues = array(); |
|
| 406 | - foreach ($chunkedUsers as $chunk) { |
|
| 407 | - $queryParams = $chunk; |
|
| 408 | - // create [$app, $key, $chunkedUsers] |
|
| 409 | - array_unshift($queryParams, $key); |
|
| 410 | - array_unshift($queryParams, $appName); |
|
| 411 | - |
|
| 412 | - $placeholders = (sizeof($chunk) == 50) ? $placeholders50 : implode(',', array_fill(0, sizeof($chunk), '?')); |
|
| 413 | - |
|
| 414 | - $query = 'SELECT `userid`, `configvalue` ' . |
|
| 415 | - 'FROM `*PREFIX*preferences` ' . |
|
| 416 | - 'WHERE `appid` = ? AND `configkey` = ? ' . |
|
| 417 | - 'AND `userid` IN (' . $placeholders . ')'; |
|
| 418 | - $result = $this->connection->executeQuery($query, $queryParams); |
|
| 419 | - |
|
| 420 | - while ($row = $result->fetch()) { |
|
| 421 | - $userValues[$row['userid']] = $row['configvalue']; |
|
| 422 | - } |
|
| 423 | - } |
|
| 424 | - |
|
| 425 | - return $userValues; |
|
| 426 | - } |
|
| 427 | - |
|
| 428 | - /** |
|
| 429 | - * Determines the users that have the given value set for a specific app-key-pair |
|
| 430 | - * |
|
| 431 | - * @param string $appName the app to get the user for |
|
| 432 | - * @param string $key the key to get the user for |
|
| 433 | - * @param string $value the value to get the user for |
|
| 434 | - * @return array of user IDs |
|
| 435 | - */ |
|
| 436 | - public function getUsersForUserValue($appName, $key, $value) { |
|
| 437 | - // TODO - FIXME |
|
| 438 | - $this->fixDIInit(); |
|
| 439 | - |
|
| 440 | - $sql = 'SELECT `userid` FROM `*PREFIX*preferences` ' . |
|
| 441 | - 'WHERE `appid` = ? AND `configkey` = ? '; |
|
| 442 | - |
|
| 443 | - if($this->getSystemValue('dbtype', 'sqlite') === 'oci') { |
|
| 444 | - //oracle hack: need to explicitly cast CLOB to CHAR for comparison |
|
| 445 | - $sql .= 'AND to_char(`configvalue`) = ?'; |
|
| 446 | - } else { |
|
| 447 | - $sql .= 'AND `configvalue` = ?'; |
|
| 448 | - } |
|
| 449 | - |
|
| 450 | - $result = $this->connection->executeQuery($sql, array($appName, $key, $value)); |
|
| 451 | - |
|
| 452 | - $userIDs = array(); |
|
| 453 | - while ($row = $result->fetch()) { |
|
| 454 | - $userIDs[] = $row['userid']; |
|
| 455 | - } |
|
| 456 | - |
|
| 457 | - return $userIDs; |
|
| 458 | - } |
|
| 459 | - |
|
| 460 | - public function getSystemConfig() { |
|
| 461 | - return $this->systemConfig; |
|
| 462 | - } |
|
| 40 | + /** @var SystemConfig */ |
|
| 41 | + private $systemConfig; |
|
| 42 | + |
|
| 43 | + /** @var IDBConnection */ |
|
| 44 | + private $connection; |
|
| 45 | + |
|
| 46 | + /** |
|
| 47 | + * 3 dimensional array with the following structure: |
|
| 48 | + * [ $userId => |
|
| 49 | + * [ $appId => |
|
| 50 | + * [ $key => $value ] |
|
| 51 | + * ] |
|
| 52 | + * ] |
|
| 53 | + * |
|
| 54 | + * database table: preferences |
|
| 55 | + * |
|
| 56 | + * methods that use this: |
|
| 57 | + * - setUserValue |
|
| 58 | + * - getUserValue |
|
| 59 | + * - getUserKeys |
|
| 60 | + * - deleteUserValue |
|
| 61 | + * - deleteAllUserValues |
|
| 62 | + * - deleteAppFromAllUsers |
|
| 63 | + * |
|
| 64 | + * @var CappedMemoryCache $userCache |
|
| 65 | + */ |
|
| 66 | + private $userCache; |
|
| 67 | + |
|
| 68 | + /** |
|
| 69 | + * @param SystemConfig $systemConfig |
|
| 70 | + */ |
|
| 71 | + public function __construct(SystemConfig $systemConfig) { |
|
| 72 | + $this->userCache = new CappedMemoryCache(); |
|
| 73 | + $this->systemConfig = $systemConfig; |
|
| 74 | + } |
|
| 75 | + |
|
| 76 | + /** |
|
| 77 | + * TODO - FIXME This fixes an issue with base.php that cause cyclic |
|
| 78 | + * dependencies, especially with autoconfig setup |
|
| 79 | + * |
|
| 80 | + * Replace this by properly injected database connection. Currently the |
|
| 81 | + * base.php triggers the getDatabaseConnection too early which causes in |
|
| 82 | + * autoconfig setup case a too early distributed database connection and |
|
| 83 | + * the autoconfig then needs to reinit all already initialized dependencies |
|
| 84 | + * that use the database connection. |
|
| 85 | + * |
|
| 86 | + * otherwise a SQLite database is created in the wrong directory |
|
| 87 | + * because the database connection was created with an uninitialized config |
|
| 88 | + */ |
|
| 89 | + private function fixDIInit() { |
|
| 90 | + if($this->connection === null) { |
|
| 91 | + $this->connection = \OC::$server->getDatabaseConnection(); |
|
| 92 | + } |
|
| 93 | + } |
|
| 94 | + |
|
| 95 | + /** |
|
| 96 | + * Sets and deletes system wide values |
|
| 97 | + * |
|
| 98 | + * @param array $configs Associative array with `key => value` pairs |
|
| 99 | + * If value is null, the config key will be deleted |
|
| 100 | + */ |
|
| 101 | + public function setSystemValues(array $configs) { |
|
| 102 | + $this->systemConfig->setValues($configs); |
|
| 103 | + } |
|
| 104 | + |
|
| 105 | + /** |
|
| 106 | + * Sets a new system wide value |
|
| 107 | + * |
|
| 108 | + * @param string $key the key of the value, under which will be saved |
|
| 109 | + * @param mixed $value the value that should be stored |
|
| 110 | + */ |
|
| 111 | + public function setSystemValue($key, $value) { |
|
| 112 | + $this->systemConfig->setValue($key, $value); |
|
| 113 | + } |
|
| 114 | + |
|
| 115 | + /** |
|
| 116 | + * Looks up a system wide defined value |
|
| 117 | + * |
|
| 118 | + * @param string $key the key of the value, under which it was saved |
|
| 119 | + * @param mixed $default the default value to be returned if the value isn't set |
|
| 120 | + * @return mixed the value or $default |
|
| 121 | + */ |
|
| 122 | + public function getSystemValue($key, $default = '') { |
|
| 123 | + return $this->systemConfig->getValue($key, $default); |
|
| 124 | + } |
|
| 125 | + |
|
| 126 | + /** |
|
| 127 | + * Looks up a system wide defined value and filters out sensitive data |
|
| 128 | + * |
|
| 129 | + * @param string $key the key of the value, under which it was saved |
|
| 130 | + * @param mixed $default the default value to be returned if the value isn't set |
|
| 131 | + * @return mixed the value or $default |
|
| 132 | + */ |
|
| 133 | + public function getFilteredSystemValue($key, $default = '') { |
|
| 134 | + return $this->systemConfig->getFilteredValue($key, $default); |
|
| 135 | + } |
|
| 136 | + |
|
| 137 | + /** |
|
| 138 | + * Delete a system wide defined value |
|
| 139 | + * |
|
| 140 | + * @param string $key the key of the value, under which it was saved |
|
| 141 | + */ |
|
| 142 | + public function deleteSystemValue($key) { |
|
| 143 | + $this->systemConfig->deleteValue($key); |
|
| 144 | + } |
|
| 145 | + |
|
| 146 | + /** |
|
| 147 | + * Get all keys stored for an app |
|
| 148 | + * |
|
| 149 | + * @param string $appName the appName that we stored the value under |
|
| 150 | + * @return string[] the keys stored for the app |
|
| 151 | + */ |
|
| 152 | + public function getAppKeys($appName) { |
|
| 153 | + return \OC::$server->getAppConfig()->getKeys($appName); |
|
| 154 | + } |
|
| 155 | + |
|
| 156 | + /** |
|
| 157 | + * Writes a new app wide value |
|
| 158 | + * |
|
| 159 | + * @param string $appName the appName that we want to store the value under |
|
| 160 | + * @param string $key the key of the value, under which will be saved |
|
| 161 | + * @param string|float|int $value the value that should be stored |
|
| 162 | + */ |
|
| 163 | + public function setAppValue($appName, $key, $value) { |
|
| 164 | + \OC::$server->getAppConfig()->setValue($appName, $key, $value); |
|
| 165 | + } |
|
| 166 | + |
|
| 167 | + /** |
|
| 168 | + * Looks up an app wide defined value |
|
| 169 | + * |
|
| 170 | + * @param string $appName the appName that we stored the value under |
|
| 171 | + * @param string $key the key of the value, under which it was saved |
|
| 172 | + * @param string $default the default value to be returned if the value isn't set |
|
| 173 | + * @return string the saved value |
|
| 174 | + */ |
|
| 175 | + public function getAppValue($appName, $key, $default = '') { |
|
| 176 | + return \OC::$server->getAppConfig()->getValue($appName, $key, $default); |
|
| 177 | + } |
|
| 178 | + |
|
| 179 | + /** |
|
| 180 | + * Delete an app wide defined value |
|
| 181 | + * |
|
| 182 | + * @param string $appName the appName that we stored the value under |
|
| 183 | + * @param string $key the key of the value, under which it was saved |
|
| 184 | + */ |
|
| 185 | + public function deleteAppValue($appName, $key) { |
|
| 186 | + \OC::$server->getAppConfig()->deleteKey($appName, $key); |
|
| 187 | + } |
|
| 188 | + |
|
| 189 | + /** |
|
| 190 | + * Removes all keys in appconfig belonging to the app |
|
| 191 | + * |
|
| 192 | + * @param string $appName the appName the configs are stored under |
|
| 193 | + */ |
|
| 194 | + public function deleteAppValues($appName) { |
|
| 195 | + \OC::$server->getAppConfig()->deleteApp($appName); |
|
| 196 | + } |
|
| 197 | + |
|
| 198 | + |
|
| 199 | + /** |
|
| 200 | + * Set a user defined value |
|
| 201 | + * |
|
| 202 | + * @param string $userId the userId of the user that we want to store the value under |
|
| 203 | + * @param string $appName the appName that we want to store the value under |
|
| 204 | + * @param string $key the key under which the value is being stored |
|
| 205 | + * @param string|float|int $value the value that you want to store |
|
| 206 | + * @param string $preCondition only update if the config value was previously the value passed as $preCondition |
|
| 207 | + * @throws \OCP\PreConditionNotMetException if a precondition is specified and is not met |
|
| 208 | + * @throws \UnexpectedValueException when trying to store an unexpected value |
|
| 209 | + */ |
|
| 210 | + public function setUserValue($userId, $appName, $key, $value, $preCondition = null) { |
|
| 211 | + if (!is_int($value) && !is_float($value) && !is_string($value)) { |
|
| 212 | + throw new \UnexpectedValueException('Only integers, floats and strings are allowed as value'); |
|
| 213 | + } |
|
| 214 | + |
|
| 215 | + // TODO - FIXME |
|
| 216 | + $this->fixDIInit(); |
|
| 217 | + |
|
| 218 | + $prevValue = $this->getUserValue($userId, $appName, $key, null); |
|
| 219 | + |
|
| 220 | + if ($prevValue !== null) { |
|
| 221 | + if ($prevValue === (string)$value) { |
|
| 222 | + return; |
|
| 223 | + } else if ($preCondition !== null && $prevValue !== (string)$preCondition) { |
|
| 224 | + throw new PreConditionNotMetException(); |
|
| 225 | + } else { |
|
| 226 | + $qb = $this->connection->getQueryBuilder(); |
|
| 227 | + $qb->update('preferences') |
|
| 228 | + ->set('configvalue', $qb->createNamedParameter($value)) |
|
| 229 | + ->where($qb->expr()->eq('userid', $qb->createNamedParameter($userId))) |
|
| 230 | + ->andWhere($qb->expr()->eq('appid', $qb->createNamedParameter($appName))) |
|
| 231 | + ->andWhere($qb->expr()->eq('configkey', $qb->createNamedParameter($key))); |
|
| 232 | + $qb->execute(); |
|
| 233 | + |
|
| 234 | + $this->userCache[$userId][$appName][$key] = $value; |
|
| 235 | + return; |
|
| 236 | + } |
|
| 237 | + } |
|
| 238 | + |
|
| 239 | + $preconditionArray = []; |
|
| 240 | + if (isset($preCondition)) { |
|
| 241 | + $preconditionArray = [ |
|
| 242 | + 'configvalue' => $preCondition, |
|
| 243 | + ]; |
|
| 244 | + } |
|
| 245 | + |
|
| 246 | + $this->connection->setValues('preferences', [ |
|
| 247 | + 'userid' => $userId, |
|
| 248 | + 'appid' => $appName, |
|
| 249 | + 'configkey' => $key, |
|
| 250 | + ], [ |
|
| 251 | + 'configvalue' => $value, |
|
| 252 | + ], $preconditionArray); |
|
| 253 | + |
|
| 254 | + // only add to the cache if we already loaded data for the user |
|
| 255 | + if (isset($this->userCache[$userId])) { |
|
| 256 | + if (!isset($this->userCache[$userId][$appName])) { |
|
| 257 | + $this->userCache[$userId][$appName] = array(); |
|
| 258 | + } |
|
| 259 | + $this->userCache[$userId][$appName][$key] = $value; |
|
| 260 | + } |
|
| 261 | + } |
|
| 262 | + |
|
| 263 | + /** |
|
| 264 | + * Getting a user defined value |
|
| 265 | + * |
|
| 266 | + * @param string $userId the userId of the user that we want to store the value under |
|
| 267 | + * @param string $appName the appName that we stored the value under |
|
| 268 | + * @param string $key the key under which the value is being stored |
|
| 269 | + * @param mixed $default the default value to be returned if the value isn't set |
|
| 270 | + * @return string |
|
| 271 | + */ |
|
| 272 | + public function getUserValue($userId, $appName, $key, $default = '') { |
|
| 273 | + $data = $this->getUserValues($userId); |
|
| 274 | + if (isset($data[$appName]) and isset($data[$appName][$key])) { |
|
| 275 | + return $data[$appName][$key]; |
|
| 276 | + } else { |
|
| 277 | + return $default; |
|
| 278 | + } |
|
| 279 | + } |
|
| 280 | + |
|
| 281 | + /** |
|
| 282 | + * Get the keys of all stored by an app for the user |
|
| 283 | + * |
|
| 284 | + * @param string $userId the userId of the user that we want to store the value under |
|
| 285 | + * @param string $appName the appName that we stored the value under |
|
| 286 | + * @return string[] |
|
| 287 | + */ |
|
| 288 | + public function getUserKeys($userId, $appName) { |
|
| 289 | + $data = $this->getUserValues($userId); |
|
| 290 | + if (isset($data[$appName])) { |
|
| 291 | + return array_keys($data[$appName]); |
|
| 292 | + } else { |
|
| 293 | + return array(); |
|
| 294 | + } |
|
| 295 | + } |
|
| 296 | + |
|
| 297 | + /** |
|
| 298 | + * Delete a user value |
|
| 299 | + * |
|
| 300 | + * @param string $userId the userId of the user that we want to store the value under |
|
| 301 | + * @param string $appName the appName that we stored the value under |
|
| 302 | + * @param string $key the key under which the value is being stored |
|
| 303 | + */ |
|
| 304 | + public function deleteUserValue($userId, $appName, $key) { |
|
| 305 | + // TODO - FIXME |
|
| 306 | + $this->fixDIInit(); |
|
| 307 | + |
|
| 308 | + $sql = 'DELETE FROM `*PREFIX*preferences` '. |
|
| 309 | + 'WHERE `userid` = ? AND `appid` = ? AND `configkey` = ?'; |
|
| 310 | + $this->connection->executeUpdate($sql, array($userId, $appName, $key)); |
|
| 311 | + |
|
| 312 | + if (isset($this->userCache[$userId]) and isset($this->userCache[$userId][$appName])) { |
|
| 313 | + unset($this->userCache[$userId][$appName][$key]); |
|
| 314 | + } |
|
| 315 | + } |
|
| 316 | + |
|
| 317 | + /** |
|
| 318 | + * Delete all user values |
|
| 319 | + * |
|
| 320 | + * @param string $userId the userId of the user that we want to remove all values from |
|
| 321 | + */ |
|
| 322 | + public function deleteAllUserValues($userId) { |
|
| 323 | + // TODO - FIXME |
|
| 324 | + $this->fixDIInit(); |
|
| 325 | + |
|
| 326 | + $sql = 'DELETE FROM `*PREFIX*preferences` '. |
|
| 327 | + 'WHERE `userid` = ?'; |
|
| 328 | + $this->connection->executeUpdate($sql, array($userId)); |
|
| 329 | + |
|
| 330 | + unset($this->userCache[$userId]); |
|
| 331 | + } |
|
| 332 | + |
|
| 333 | + /** |
|
| 334 | + * Delete all user related values of one app |
|
| 335 | + * |
|
| 336 | + * @param string $appName the appName of the app that we want to remove all values from |
|
| 337 | + */ |
|
| 338 | + public function deleteAppFromAllUsers($appName) { |
|
| 339 | + // TODO - FIXME |
|
| 340 | + $this->fixDIInit(); |
|
| 341 | + |
|
| 342 | + $sql = 'DELETE FROM `*PREFIX*preferences` '. |
|
| 343 | + 'WHERE `appid` = ?'; |
|
| 344 | + $this->connection->executeUpdate($sql, array($appName)); |
|
| 345 | + |
|
| 346 | + foreach ($this->userCache as &$userCache) { |
|
| 347 | + unset($userCache[$appName]); |
|
| 348 | + } |
|
| 349 | + } |
|
| 350 | + |
|
| 351 | + /** |
|
| 352 | + * Returns all user configs sorted by app of one user |
|
| 353 | + * |
|
| 354 | + * @param string $userId the user ID to get the app configs from |
|
| 355 | + * @return array[] - 2 dimensional array with the following structure: |
|
| 356 | + * [ $appId => |
|
| 357 | + * [ $key => $value ] |
|
| 358 | + * ] |
|
| 359 | + */ |
|
| 360 | + private function getUserValues($userId) { |
|
| 361 | + if (isset($this->userCache[$userId])) { |
|
| 362 | + return $this->userCache[$userId]; |
|
| 363 | + } |
|
| 364 | + if ($userId === null || $userId === '') { |
|
| 365 | + $this->userCache[$userId]=array(); |
|
| 366 | + return $this->userCache[$userId]; |
|
| 367 | + } |
|
| 368 | + |
|
| 369 | + // TODO - FIXME |
|
| 370 | + $this->fixDIInit(); |
|
| 371 | + |
|
| 372 | + $data = array(); |
|
| 373 | + $query = 'SELECT `appid`, `configkey`, `configvalue` FROM `*PREFIX*preferences` WHERE `userid` = ?'; |
|
| 374 | + $result = $this->connection->executeQuery($query, array($userId)); |
|
| 375 | + while ($row = $result->fetch()) { |
|
| 376 | + $appId = $row['appid']; |
|
| 377 | + if (!isset($data[$appId])) { |
|
| 378 | + $data[$appId] = array(); |
|
| 379 | + } |
|
| 380 | + $data[$appId][$row['configkey']] = $row['configvalue']; |
|
| 381 | + } |
|
| 382 | + $this->userCache[$userId] = $data; |
|
| 383 | + return $data; |
|
| 384 | + } |
|
| 385 | + |
|
| 386 | + /** |
|
| 387 | + * Fetches a mapped list of userId -> value, for a specified app and key and a list of user IDs. |
|
| 388 | + * |
|
| 389 | + * @param string $appName app to get the value for |
|
| 390 | + * @param string $key the key to get the value for |
|
| 391 | + * @param array $userIds the user IDs to fetch the values for |
|
| 392 | + * @return array Mapped values: userId => value |
|
| 393 | + */ |
|
| 394 | + public function getUserValueForUsers($appName, $key, $userIds) { |
|
| 395 | + // TODO - FIXME |
|
| 396 | + $this->fixDIInit(); |
|
| 397 | + |
|
| 398 | + if (empty($userIds) || !is_array($userIds)) { |
|
| 399 | + return array(); |
|
| 400 | + } |
|
| 401 | + |
|
| 402 | + $chunkedUsers = array_chunk($userIds, 50, true); |
|
| 403 | + $placeholders50 = implode(',', array_fill(0, 50, '?')); |
|
| 404 | + |
|
| 405 | + $userValues = array(); |
|
| 406 | + foreach ($chunkedUsers as $chunk) { |
|
| 407 | + $queryParams = $chunk; |
|
| 408 | + // create [$app, $key, $chunkedUsers] |
|
| 409 | + array_unshift($queryParams, $key); |
|
| 410 | + array_unshift($queryParams, $appName); |
|
| 411 | + |
|
| 412 | + $placeholders = (sizeof($chunk) == 50) ? $placeholders50 : implode(',', array_fill(0, sizeof($chunk), '?')); |
|
| 413 | + |
|
| 414 | + $query = 'SELECT `userid`, `configvalue` ' . |
|
| 415 | + 'FROM `*PREFIX*preferences` ' . |
|
| 416 | + 'WHERE `appid` = ? AND `configkey` = ? ' . |
|
| 417 | + 'AND `userid` IN (' . $placeholders . ')'; |
|
| 418 | + $result = $this->connection->executeQuery($query, $queryParams); |
|
| 419 | + |
|
| 420 | + while ($row = $result->fetch()) { |
|
| 421 | + $userValues[$row['userid']] = $row['configvalue']; |
|
| 422 | + } |
|
| 423 | + } |
|
| 424 | + |
|
| 425 | + return $userValues; |
|
| 426 | + } |
|
| 427 | + |
|
| 428 | + /** |
|
| 429 | + * Determines the users that have the given value set for a specific app-key-pair |
|
| 430 | + * |
|
| 431 | + * @param string $appName the app to get the user for |
|
| 432 | + * @param string $key the key to get the user for |
|
| 433 | + * @param string $value the value to get the user for |
|
| 434 | + * @return array of user IDs |
|
| 435 | + */ |
|
| 436 | + public function getUsersForUserValue($appName, $key, $value) { |
|
| 437 | + // TODO - FIXME |
|
| 438 | + $this->fixDIInit(); |
|
| 439 | + |
|
| 440 | + $sql = 'SELECT `userid` FROM `*PREFIX*preferences` ' . |
|
| 441 | + 'WHERE `appid` = ? AND `configkey` = ? '; |
|
| 442 | + |
|
| 443 | + if($this->getSystemValue('dbtype', 'sqlite') === 'oci') { |
|
| 444 | + //oracle hack: need to explicitly cast CLOB to CHAR for comparison |
|
| 445 | + $sql .= 'AND to_char(`configvalue`) = ?'; |
|
| 446 | + } else { |
|
| 447 | + $sql .= 'AND `configvalue` = ?'; |
|
| 448 | + } |
|
| 449 | + |
|
| 450 | + $result = $this->connection->executeQuery($sql, array($appName, $key, $value)); |
|
| 451 | + |
|
| 452 | + $userIDs = array(); |
|
| 453 | + while ($row = $result->fetch()) { |
|
| 454 | + $userIDs[] = $row['userid']; |
|
| 455 | + } |
|
| 456 | + |
|
| 457 | + return $userIDs; |
|
| 458 | + } |
|
| 459 | + |
|
| 460 | + public function getSystemConfig() { |
|
| 461 | + return $this->systemConfig; |
|
| 462 | + } |
|
| 463 | 463 | } |
@@ -87,7 +87,7 @@ discard block |
||
| 87 | 87 | * because the database connection was created with an uninitialized config |
| 88 | 88 | */ |
| 89 | 89 | private function fixDIInit() { |
| 90 | - if($this->connection === null) { |
|
| 90 | + if ($this->connection === null) { |
|
| 91 | 91 | $this->connection = \OC::$server->getDatabaseConnection(); |
| 92 | 92 | } |
| 93 | 93 | } |
@@ -218,9 +218,9 @@ discard block |
||
| 218 | 218 | $prevValue = $this->getUserValue($userId, $appName, $key, null); |
| 219 | 219 | |
| 220 | 220 | if ($prevValue !== null) { |
| 221 | - if ($prevValue === (string)$value) { |
|
| 221 | + if ($prevValue === (string) $value) { |
|
| 222 | 222 | return; |
| 223 | - } else if ($preCondition !== null && $prevValue !== (string)$preCondition) { |
|
| 223 | + } else if ($preCondition !== null && $prevValue !== (string) $preCondition) { |
|
| 224 | 224 | throw new PreConditionNotMetException(); |
| 225 | 225 | } else { |
| 226 | 226 | $qb = $this->connection->getQueryBuilder(); |
@@ -305,7 +305,7 @@ discard block |
||
| 305 | 305 | // TODO - FIXME |
| 306 | 306 | $this->fixDIInit(); |
| 307 | 307 | |
| 308 | - $sql = 'DELETE FROM `*PREFIX*preferences` '. |
|
| 308 | + $sql = 'DELETE FROM `*PREFIX*preferences` '. |
|
| 309 | 309 | 'WHERE `userid` = ? AND `appid` = ? AND `configkey` = ?'; |
| 310 | 310 | $this->connection->executeUpdate($sql, array($userId, $appName, $key)); |
| 311 | 311 | |
@@ -323,7 +323,7 @@ discard block |
||
| 323 | 323 | // TODO - FIXME |
| 324 | 324 | $this->fixDIInit(); |
| 325 | 325 | |
| 326 | - $sql = 'DELETE FROM `*PREFIX*preferences` '. |
|
| 326 | + $sql = 'DELETE FROM `*PREFIX*preferences` '. |
|
| 327 | 327 | 'WHERE `userid` = ?'; |
| 328 | 328 | $this->connection->executeUpdate($sql, array($userId)); |
| 329 | 329 | |
@@ -339,7 +339,7 @@ discard block |
||
| 339 | 339 | // TODO - FIXME |
| 340 | 340 | $this->fixDIInit(); |
| 341 | 341 | |
| 342 | - $sql = 'DELETE FROM `*PREFIX*preferences` '. |
|
| 342 | + $sql = 'DELETE FROM `*PREFIX*preferences` '. |
|
| 343 | 343 | 'WHERE `appid` = ?'; |
| 344 | 344 | $this->connection->executeUpdate($sql, array($appName)); |
| 345 | 345 | |
@@ -362,7 +362,7 @@ discard block |
||
| 362 | 362 | return $this->userCache[$userId]; |
| 363 | 363 | } |
| 364 | 364 | if ($userId === null || $userId === '') { |
| 365 | - $this->userCache[$userId]=array(); |
|
| 365 | + $this->userCache[$userId] = array(); |
|
| 366 | 366 | return $this->userCache[$userId]; |
| 367 | 367 | } |
| 368 | 368 | |
@@ -409,12 +409,12 @@ discard block |
||
| 409 | 409 | array_unshift($queryParams, $key); |
| 410 | 410 | array_unshift($queryParams, $appName); |
| 411 | 411 | |
| 412 | - $placeholders = (sizeof($chunk) == 50) ? $placeholders50 : implode(',', array_fill(0, sizeof($chunk), '?')); |
|
| 412 | + $placeholders = (sizeof($chunk) == 50) ? $placeholders50 : implode(',', array_fill(0, sizeof($chunk), '?')); |
|
| 413 | 413 | |
| 414 | - $query = 'SELECT `userid`, `configvalue` ' . |
|
| 415 | - 'FROM `*PREFIX*preferences` ' . |
|
| 416 | - 'WHERE `appid` = ? AND `configkey` = ? ' . |
|
| 417 | - 'AND `userid` IN (' . $placeholders . ')'; |
|
| 414 | + $query = 'SELECT `userid`, `configvalue` '. |
|
| 415 | + 'FROM `*PREFIX*preferences` '. |
|
| 416 | + 'WHERE `appid` = ? AND `configkey` = ? '. |
|
| 417 | + 'AND `userid` IN ('.$placeholders.')'; |
|
| 418 | 418 | $result = $this->connection->executeQuery($query, $queryParams); |
| 419 | 419 | |
| 420 | 420 | while ($row = $result->fetch()) { |
@@ -437,10 +437,10 @@ discard block |
||
| 437 | 437 | // TODO - FIXME |
| 438 | 438 | $this->fixDIInit(); |
| 439 | 439 | |
| 440 | - $sql = 'SELECT `userid` FROM `*PREFIX*preferences` ' . |
|
| 440 | + $sql = 'SELECT `userid` FROM `*PREFIX*preferences` '. |
|
| 441 | 441 | 'WHERE `appid` = ? AND `configkey` = ? '; |
| 442 | 442 | |
| 443 | - if($this->getSystemValue('dbtype', 'sqlite') === 'oci') { |
|
| 443 | + if ($this->getSystemValue('dbtype', 'sqlite') === 'oci') { |
|
| 444 | 444 | //oracle hack: need to explicitly cast CLOB to CHAR for comparison |
| 445 | 445 | $sql .= 'AND to_char(`configvalue`) = ?'; |
| 446 | 446 | } else { |
@@ -22,7 +22,6 @@ |
||
| 22 | 22 | use OC\Files\Cache\CacheEntry; |
| 23 | 23 | use OCP\Constants; |
| 24 | 24 | use OCP\Files\Cache\ICache; |
| 25 | -use OCP\Files\Cache\ICacheEntry; |
|
| 26 | 25 | use OCP\Files\FileInfo; |
| 27 | 26 | |
| 28 | 27 | class NullCache implements ICache { |
@@ -26,97 +26,97 @@ |
||
| 26 | 26 | use OCP\Files\FileInfo; |
| 27 | 27 | |
| 28 | 28 | class NullCache implements ICache { |
| 29 | - public function getNumericStorageId() { |
|
| 30 | - return -1; |
|
| 31 | - } |
|
| 32 | - |
|
| 33 | - public function get($file) { |
|
| 34 | - return $file !== '' ? null : |
|
| 35 | - new CacheEntry([ |
|
| 36 | - 'fileid' => -1, |
|
| 37 | - 'parent' => -1, |
|
| 38 | - 'name' => '', |
|
| 39 | - 'path' => '', |
|
| 40 | - 'size' => '0', |
|
| 41 | - 'mtime' => time(), |
|
| 42 | - 'storage_mtime' => time(), |
|
| 43 | - 'etag' => '', |
|
| 44 | - 'mimetype' => FileInfo::MIMETYPE_FOLDER, |
|
| 45 | - 'mimepart' => 'httpd', |
|
| 46 | - 'permissions' => Constants::PERMISSION_READ |
|
| 47 | - ]); |
|
| 48 | - } |
|
| 49 | - |
|
| 50 | - public function getFolderContents($folder) { |
|
| 51 | - return []; |
|
| 52 | - } |
|
| 53 | - |
|
| 54 | - public function getFolderContentsById($fileId) { |
|
| 55 | - return []; |
|
| 56 | - } |
|
| 57 | - |
|
| 58 | - public function put($file, array $data) { |
|
| 59 | - throw new \OC\ForbiddenException('This request is not allowed to access the filesystem'); |
|
| 60 | - } |
|
| 61 | - |
|
| 62 | - public function insert($file, array $data) { |
|
| 63 | - throw new \OC\ForbiddenException('This request is not allowed to access the filesystem'); |
|
| 64 | - } |
|
| 65 | - |
|
| 66 | - public function update($id, array $data) { |
|
| 67 | - throw new \OC\ForbiddenException('This request is not allowed to access the filesystem'); |
|
| 68 | - } |
|
| 69 | - |
|
| 70 | - public function getId($file) { |
|
| 71 | - return -1; |
|
| 72 | - } |
|
| 73 | - |
|
| 74 | - public function getParentId($file) { |
|
| 75 | - return -1; |
|
| 76 | - } |
|
| 77 | - |
|
| 78 | - public function inCache($file) { |
|
| 79 | - return $file === ''; |
|
| 80 | - } |
|
| 81 | - |
|
| 82 | - public function remove($file) { |
|
| 83 | - throw new \OC\ForbiddenException('This request is not allowed to access the filesystem'); |
|
| 84 | - } |
|
| 85 | - |
|
| 86 | - public function move($source, $target) { |
|
| 87 | - throw new \OC\ForbiddenException('This request is not allowed to access the filesystem'); |
|
| 88 | - } |
|
| 89 | - |
|
| 90 | - public function moveFromCache(ICache $sourceCache, $sourcePath, $targetPath) { |
|
| 91 | - throw new \OC\ForbiddenException('This request is not allowed to access the filesystem'); |
|
| 92 | - } |
|
| 93 | - |
|
| 94 | - public function getStatus($file) { |
|
| 95 | - return ICache::COMPLETE; |
|
| 96 | - } |
|
| 97 | - |
|
| 98 | - public function search($pattern) { |
|
| 99 | - return []; |
|
| 100 | - } |
|
| 101 | - |
|
| 102 | - public function searchByMime($mimetype) { |
|
| 103 | - return []; |
|
| 104 | - } |
|
| 105 | - |
|
| 106 | - public function searchByTag($tag, $userId) { |
|
| 107 | - return []; |
|
| 108 | - } |
|
| 109 | - |
|
| 110 | - public function getIncomplete() { |
|
| 111 | - return []; |
|
| 112 | - } |
|
| 113 | - |
|
| 114 | - public function getPathById($id) { |
|
| 115 | - return ''; |
|
| 116 | - } |
|
| 117 | - |
|
| 118 | - public function normalize($path) { |
|
| 119 | - return $path; |
|
| 120 | - } |
|
| 29 | + public function getNumericStorageId() { |
|
| 30 | + return -1; |
|
| 31 | + } |
|
| 32 | + |
|
| 33 | + public function get($file) { |
|
| 34 | + return $file !== '' ? null : |
|
| 35 | + new CacheEntry([ |
|
| 36 | + 'fileid' => -1, |
|
| 37 | + 'parent' => -1, |
|
| 38 | + 'name' => '', |
|
| 39 | + 'path' => '', |
|
| 40 | + 'size' => '0', |
|
| 41 | + 'mtime' => time(), |
|
| 42 | + 'storage_mtime' => time(), |
|
| 43 | + 'etag' => '', |
|
| 44 | + 'mimetype' => FileInfo::MIMETYPE_FOLDER, |
|
| 45 | + 'mimepart' => 'httpd', |
|
| 46 | + 'permissions' => Constants::PERMISSION_READ |
|
| 47 | + ]); |
|
| 48 | + } |
|
| 49 | + |
|
| 50 | + public function getFolderContents($folder) { |
|
| 51 | + return []; |
|
| 52 | + } |
|
| 53 | + |
|
| 54 | + public function getFolderContentsById($fileId) { |
|
| 55 | + return []; |
|
| 56 | + } |
|
| 57 | + |
|
| 58 | + public function put($file, array $data) { |
|
| 59 | + throw new \OC\ForbiddenException('This request is not allowed to access the filesystem'); |
|
| 60 | + } |
|
| 61 | + |
|
| 62 | + public function insert($file, array $data) { |
|
| 63 | + throw new \OC\ForbiddenException('This request is not allowed to access the filesystem'); |
|
| 64 | + } |
|
| 65 | + |
|
| 66 | + public function update($id, array $data) { |
|
| 67 | + throw new \OC\ForbiddenException('This request is not allowed to access the filesystem'); |
|
| 68 | + } |
|
| 69 | + |
|
| 70 | + public function getId($file) { |
|
| 71 | + return -1; |
|
| 72 | + } |
|
| 73 | + |
|
| 74 | + public function getParentId($file) { |
|
| 75 | + return -1; |
|
| 76 | + } |
|
| 77 | + |
|
| 78 | + public function inCache($file) { |
|
| 79 | + return $file === ''; |
|
| 80 | + } |
|
| 81 | + |
|
| 82 | + public function remove($file) { |
|
| 83 | + throw new \OC\ForbiddenException('This request is not allowed to access the filesystem'); |
|
| 84 | + } |
|
| 85 | + |
|
| 86 | + public function move($source, $target) { |
|
| 87 | + throw new \OC\ForbiddenException('This request is not allowed to access the filesystem'); |
|
| 88 | + } |
|
| 89 | + |
|
| 90 | + public function moveFromCache(ICache $sourceCache, $sourcePath, $targetPath) { |
|
| 91 | + throw new \OC\ForbiddenException('This request is not allowed to access the filesystem'); |
|
| 92 | + } |
|
| 93 | + |
|
| 94 | + public function getStatus($file) { |
|
| 95 | + return ICache::COMPLETE; |
|
| 96 | + } |
|
| 97 | + |
|
| 98 | + public function search($pattern) { |
|
| 99 | + return []; |
|
| 100 | + } |
|
| 101 | + |
|
| 102 | + public function searchByMime($mimetype) { |
|
| 103 | + return []; |
|
| 104 | + } |
|
| 105 | + |
|
| 106 | + public function searchByTag($tag, $userId) { |
|
| 107 | + return []; |
|
| 108 | + } |
|
| 109 | + |
|
| 110 | + public function getIncomplete() { |
|
| 111 | + return []; |
|
| 112 | + } |
|
| 113 | + |
|
| 114 | + public function getPathById($id) { |
|
| 115 | + return ''; |
|
| 116 | + } |
|
| 117 | + |
|
| 118 | + public function normalize($path) { |
|
| 119 | + return $path; |
|
| 120 | + } |
|
| 121 | 121 | |
| 122 | 122 | } |
@@ -31,8 +31,7 @@ |
||
| 31 | 31 | } |
| 32 | 32 | |
| 33 | 33 | public function get($file) { |
| 34 | - return $file !== '' ? null : |
|
| 35 | - new CacheEntry([ |
|
| 34 | + return $file !== '' ? null : new CacheEntry([ |
|
| 36 | 35 | 'fileid' => -1, |
| 37 | 36 | 'parent' => -1, |
| 38 | 37 | 'name' => '', |
@@ -334,7 +334,7 @@ |
||
| 334 | 334 | * |
| 335 | 335 | * @param int $size file size in bytes |
| 336 | 336 | * @param array $files override '.htaccess' and '.user.ini' locations |
| 337 | - * @return bool false on failure, size on success |
|
| 337 | + * @return integer false on failure, size on success |
|
| 338 | 338 | */ |
| 339 | 339 | public static function setUploadLimit($size, $files = []) { |
| 340 | 340 | //don't allow user to break his config |
@@ -46,394 +46,394 @@ |
||
| 46 | 46 | * |
| 47 | 47 | */ |
| 48 | 48 | class OC_Files { |
| 49 | - const FILE = 1; |
|
| 50 | - const ZIP_FILES = 2; |
|
| 51 | - const ZIP_DIR = 3; |
|
| 52 | - |
|
| 53 | - const UPLOAD_MIN_LIMIT_BYTES = 1048576; // 1 MiB |
|
| 54 | - |
|
| 55 | - |
|
| 56 | - private static $multipartBoundary = ''; |
|
| 57 | - |
|
| 58 | - /** |
|
| 59 | - * @return string |
|
| 60 | - */ |
|
| 61 | - private static function getBoundary() { |
|
| 62 | - if (empty(self::$multipartBoundary)) { |
|
| 63 | - self::$multipartBoundary = md5(mt_rand()); |
|
| 64 | - } |
|
| 65 | - return self::$multipartBoundary; |
|
| 66 | - } |
|
| 67 | - |
|
| 68 | - /** |
|
| 69 | - * @param string $filename |
|
| 70 | - * @param string $name |
|
| 71 | - * @param array $rangeArray ('from'=>int,'to'=>int), ... |
|
| 72 | - */ |
|
| 73 | - private static function sendHeaders($filename, $name, array $rangeArray) { |
|
| 74 | - OC_Response::setContentDispositionHeader($name, 'attachment'); |
|
| 75 | - header('Content-Transfer-Encoding: binary', true); |
|
| 76 | - OC_Response::disableCaching(); |
|
| 77 | - $fileSize = \OC\Files\Filesystem::filesize($filename); |
|
| 78 | - $type = \OC::$server->getMimeTypeDetector()->getSecureMimeType(\OC\Files\Filesystem::getMimeType($filename)); |
|
| 79 | - if ($fileSize > -1) { |
|
| 80 | - if (!empty($rangeArray)) { |
|
| 81 | - header('HTTP/1.1 206 Partial Content', true); |
|
| 82 | - header('Accept-Ranges: bytes', true); |
|
| 83 | - if (count($rangeArray) > 1) { |
|
| 84 | - $type = 'multipart/byteranges; boundary='.self::getBoundary(); |
|
| 85 | - // no Content-Length header here |
|
| 86 | - } |
|
| 87 | - else { |
|
| 88 | - header(sprintf('Content-Range: bytes %d-%d/%d', $rangeArray[0]['from'], $rangeArray[0]['to'], $fileSize), true); |
|
| 89 | - OC_Response::setContentLengthHeader($rangeArray[0]['to'] - $rangeArray[0]['from'] + 1); |
|
| 90 | - } |
|
| 91 | - } |
|
| 92 | - else { |
|
| 93 | - OC_Response::setContentLengthHeader($fileSize); |
|
| 94 | - } |
|
| 95 | - } |
|
| 96 | - header('Content-Type: '.$type, true); |
|
| 97 | - } |
|
| 98 | - |
|
| 99 | - /** |
|
| 100 | - * return the content of a file or return a zip file containing multiple files |
|
| 101 | - * |
|
| 102 | - * @param string $dir |
|
| 103 | - * @param string $files ; separated list of files to download |
|
| 104 | - * @param array $params ; 'head' boolean to only send header of the request ; 'range' http range header |
|
| 105 | - */ |
|
| 106 | - public static function get($dir, $files, $params = null) { |
|
| 107 | - |
|
| 108 | - $view = \OC\Files\Filesystem::getView(); |
|
| 109 | - $getType = self::FILE; |
|
| 110 | - $filename = $dir; |
|
| 111 | - try { |
|
| 112 | - |
|
| 113 | - if (is_array($files) && count($files) === 1) { |
|
| 114 | - $files = $files[0]; |
|
| 115 | - } |
|
| 116 | - |
|
| 117 | - if (!is_array($files)) { |
|
| 118 | - $filename = $dir . '/' . $files; |
|
| 119 | - if (!$view->is_dir($filename)) { |
|
| 120 | - self::getSingleFile($view, $dir, $files, is_null($params) ? array() : $params); |
|
| 121 | - return; |
|
| 122 | - } |
|
| 123 | - } |
|
| 124 | - |
|
| 125 | - $name = 'download'; |
|
| 126 | - if (is_array($files)) { |
|
| 127 | - $getType = self::ZIP_FILES; |
|
| 128 | - $basename = basename($dir); |
|
| 129 | - if ($basename) { |
|
| 130 | - $name = $basename; |
|
| 131 | - } |
|
| 132 | - |
|
| 133 | - $filename = $dir . '/' . $name; |
|
| 134 | - } else { |
|
| 135 | - $filename = $dir . '/' . $files; |
|
| 136 | - $getType = self::ZIP_DIR; |
|
| 137 | - // downloading root ? |
|
| 138 | - if ($files !== '') { |
|
| 139 | - $name = $files; |
|
| 140 | - } |
|
| 141 | - } |
|
| 142 | - |
|
| 143 | - $streamer = new Streamer(); |
|
| 144 | - OC_Util::obEnd(); |
|
| 145 | - |
|
| 146 | - self::lockFiles($view, $dir, $files); |
|
| 147 | - |
|
| 148 | - $streamer->sendHeaders($name); |
|
| 149 | - $executionTime = intval(OC::$server->getIniWrapper()->getNumeric('max_execution_time')); |
|
| 150 | - set_time_limit(0); |
|
| 151 | - ignore_user_abort(true); |
|
| 152 | - if ($getType === self::ZIP_FILES) { |
|
| 153 | - foreach ($files as $file) { |
|
| 154 | - $file = $dir . '/' . $file; |
|
| 155 | - if (\OC\Files\Filesystem::is_file($file)) { |
|
| 156 | - $fileSize = \OC\Files\Filesystem::filesize($file); |
|
| 157 | - $fileTime = \OC\Files\Filesystem::filemtime($file); |
|
| 158 | - $fh = \OC\Files\Filesystem::fopen($file, 'r'); |
|
| 159 | - $streamer->addFileFromStream($fh, basename($file), $fileSize, $fileTime); |
|
| 160 | - fclose($fh); |
|
| 161 | - } elseif (\OC\Files\Filesystem::is_dir($file)) { |
|
| 162 | - $streamer->addDirRecursive($file); |
|
| 163 | - } |
|
| 164 | - } |
|
| 165 | - } elseif ($getType === self::ZIP_DIR) { |
|
| 166 | - $file = $dir . '/' . $files; |
|
| 167 | - $streamer->addDirRecursive($file); |
|
| 168 | - } |
|
| 169 | - $streamer->finalize(); |
|
| 170 | - set_time_limit($executionTime); |
|
| 171 | - self::unlockAllTheFiles($dir, $files, $getType, $view, $filename); |
|
| 172 | - } catch (\OCP\Lock\LockedException $ex) { |
|
| 173 | - self::unlockAllTheFiles($dir, $files, $getType, $view, $filename); |
|
| 174 | - OC::$server->getLogger()->logException($ex); |
|
| 175 | - $l = \OC::$server->getL10N('core'); |
|
| 176 | - $hint = method_exists($ex, 'getHint') ? $ex->getHint() : ''; |
|
| 177 | - \OC_Template::printErrorPage($l->t('File is currently busy, please try again later'), $hint); |
|
| 178 | - } catch (\OCP\Files\ForbiddenException $ex) { |
|
| 179 | - self::unlockAllTheFiles($dir, $files, $getType, $view, $filename); |
|
| 180 | - OC::$server->getLogger()->logException($ex); |
|
| 181 | - $l = \OC::$server->getL10N('core'); |
|
| 182 | - \OC_Template::printErrorPage($l->t('Can\'t read file'), $ex->getMessage()); |
|
| 183 | - } catch (\Exception $ex) { |
|
| 184 | - self::unlockAllTheFiles($dir, $files, $getType, $view, $filename); |
|
| 185 | - OC::$server->getLogger()->logException($ex); |
|
| 186 | - $l = \OC::$server->getL10N('core'); |
|
| 187 | - $hint = method_exists($ex, 'getHint') ? $ex->getHint() : ''; |
|
| 188 | - \OC_Template::printErrorPage($l->t('Can\'t read file'), $hint); |
|
| 189 | - } |
|
| 190 | - } |
|
| 191 | - |
|
| 192 | - /** |
|
| 193 | - * @param string $rangeHeaderPos |
|
| 194 | - * @param int $fileSize |
|
| 195 | - * @return array $rangeArray ('from'=>int,'to'=>int), ... |
|
| 196 | - */ |
|
| 197 | - private static function parseHttpRangeHeader($rangeHeaderPos, $fileSize) { |
|
| 198 | - $rArray=explode(',', $rangeHeaderPos); |
|
| 199 | - $minOffset = 0; |
|
| 200 | - $ind = 0; |
|
| 201 | - |
|
| 202 | - $rangeArray = array(); |
|
| 203 | - |
|
| 204 | - foreach ($rArray as $value) { |
|
| 205 | - $ranges = explode('-', $value); |
|
| 206 | - if (is_numeric($ranges[0])) { |
|
| 207 | - if ($ranges[0] < $minOffset) { // case: bytes=500-700,601-999 |
|
| 208 | - $ranges[0] = $minOffset; |
|
| 209 | - } |
|
| 210 | - if ($ind > 0 && $rangeArray[$ind-1]['to']+1 == $ranges[0]) { // case: bytes=500-600,601-999 |
|
| 211 | - $ind--; |
|
| 212 | - $ranges[0] = $rangeArray[$ind]['from']; |
|
| 213 | - } |
|
| 214 | - } |
|
| 215 | - |
|
| 216 | - if (is_numeric($ranges[0]) && is_numeric($ranges[1]) && $ranges[0] < $fileSize && $ranges[0] <= $ranges[1]) { |
|
| 217 | - // case: x-x |
|
| 218 | - if ($ranges[1] >= $fileSize) { |
|
| 219 | - $ranges[1] = $fileSize-1; |
|
| 220 | - } |
|
| 221 | - $rangeArray[$ind++] = array( 'from' => $ranges[0], 'to' => $ranges[1], 'size' => $fileSize ); |
|
| 222 | - $minOffset = $ranges[1] + 1; |
|
| 223 | - if ($minOffset >= $fileSize) { |
|
| 224 | - break; |
|
| 225 | - } |
|
| 226 | - } |
|
| 227 | - elseif (is_numeric($ranges[0]) && $ranges[0] < $fileSize) { |
|
| 228 | - // case: x- |
|
| 229 | - $rangeArray[$ind++] = array( 'from' => $ranges[0], 'to' => $fileSize-1, 'size' => $fileSize ); |
|
| 230 | - break; |
|
| 231 | - } |
|
| 232 | - elseif (is_numeric($ranges[1])) { |
|
| 233 | - // case: -x |
|
| 234 | - if ($ranges[1] > $fileSize) { |
|
| 235 | - $ranges[1] = $fileSize; |
|
| 236 | - } |
|
| 237 | - $rangeArray[$ind++] = array( 'from' => $fileSize-$ranges[1], 'to' => $fileSize-1, 'size' => $fileSize ); |
|
| 238 | - break; |
|
| 239 | - } |
|
| 240 | - } |
|
| 241 | - return $rangeArray; |
|
| 242 | - } |
|
| 243 | - |
|
| 244 | - /** |
|
| 245 | - * @param View $view |
|
| 246 | - * @param string $name |
|
| 247 | - * @param string $dir |
|
| 248 | - * @param array $params ; 'head' boolean to only send header of the request ; 'range' http range header |
|
| 249 | - */ |
|
| 250 | - private static function getSingleFile($view, $dir, $name, $params) { |
|
| 251 | - $filename = $dir . '/' . $name; |
|
| 252 | - OC_Util::obEnd(); |
|
| 253 | - $view->lockFile($filename, ILockingProvider::LOCK_SHARED); |
|
| 49 | + const FILE = 1; |
|
| 50 | + const ZIP_FILES = 2; |
|
| 51 | + const ZIP_DIR = 3; |
|
| 52 | + |
|
| 53 | + const UPLOAD_MIN_LIMIT_BYTES = 1048576; // 1 MiB |
|
| 54 | + |
|
| 55 | + |
|
| 56 | + private static $multipartBoundary = ''; |
|
| 57 | + |
|
| 58 | + /** |
|
| 59 | + * @return string |
|
| 60 | + */ |
|
| 61 | + private static function getBoundary() { |
|
| 62 | + if (empty(self::$multipartBoundary)) { |
|
| 63 | + self::$multipartBoundary = md5(mt_rand()); |
|
| 64 | + } |
|
| 65 | + return self::$multipartBoundary; |
|
| 66 | + } |
|
| 67 | + |
|
| 68 | + /** |
|
| 69 | + * @param string $filename |
|
| 70 | + * @param string $name |
|
| 71 | + * @param array $rangeArray ('from'=>int,'to'=>int), ... |
|
| 72 | + */ |
|
| 73 | + private static function sendHeaders($filename, $name, array $rangeArray) { |
|
| 74 | + OC_Response::setContentDispositionHeader($name, 'attachment'); |
|
| 75 | + header('Content-Transfer-Encoding: binary', true); |
|
| 76 | + OC_Response::disableCaching(); |
|
| 77 | + $fileSize = \OC\Files\Filesystem::filesize($filename); |
|
| 78 | + $type = \OC::$server->getMimeTypeDetector()->getSecureMimeType(\OC\Files\Filesystem::getMimeType($filename)); |
|
| 79 | + if ($fileSize > -1) { |
|
| 80 | + if (!empty($rangeArray)) { |
|
| 81 | + header('HTTP/1.1 206 Partial Content', true); |
|
| 82 | + header('Accept-Ranges: bytes', true); |
|
| 83 | + if (count($rangeArray) > 1) { |
|
| 84 | + $type = 'multipart/byteranges; boundary='.self::getBoundary(); |
|
| 85 | + // no Content-Length header here |
|
| 86 | + } |
|
| 87 | + else { |
|
| 88 | + header(sprintf('Content-Range: bytes %d-%d/%d', $rangeArray[0]['from'], $rangeArray[0]['to'], $fileSize), true); |
|
| 89 | + OC_Response::setContentLengthHeader($rangeArray[0]['to'] - $rangeArray[0]['from'] + 1); |
|
| 90 | + } |
|
| 91 | + } |
|
| 92 | + else { |
|
| 93 | + OC_Response::setContentLengthHeader($fileSize); |
|
| 94 | + } |
|
| 95 | + } |
|
| 96 | + header('Content-Type: '.$type, true); |
|
| 97 | + } |
|
| 98 | + |
|
| 99 | + /** |
|
| 100 | + * return the content of a file or return a zip file containing multiple files |
|
| 101 | + * |
|
| 102 | + * @param string $dir |
|
| 103 | + * @param string $files ; separated list of files to download |
|
| 104 | + * @param array $params ; 'head' boolean to only send header of the request ; 'range' http range header |
|
| 105 | + */ |
|
| 106 | + public static function get($dir, $files, $params = null) { |
|
| 107 | + |
|
| 108 | + $view = \OC\Files\Filesystem::getView(); |
|
| 109 | + $getType = self::FILE; |
|
| 110 | + $filename = $dir; |
|
| 111 | + try { |
|
| 112 | + |
|
| 113 | + if (is_array($files) && count($files) === 1) { |
|
| 114 | + $files = $files[0]; |
|
| 115 | + } |
|
| 116 | + |
|
| 117 | + if (!is_array($files)) { |
|
| 118 | + $filename = $dir . '/' . $files; |
|
| 119 | + if (!$view->is_dir($filename)) { |
|
| 120 | + self::getSingleFile($view, $dir, $files, is_null($params) ? array() : $params); |
|
| 121 | + return; |
|
| 122 | + } |
|
| 123 | + } |
|
| 124 | + |
|
| 125 | + $name = 'download'; |
|
| 126 | + if (is_array($files)) { |
|
| 127 | + $getType = self::ZIP_FILES; |
|
| 128 | + $basename = basename($dir); |
|
| 129 | + if ($basename) { |
|
| 130 | + $name = $basename; |
|
| 131 | + } |
|
| 132 | + |
|
| 133 | + $filename = $dir . '/' . $name; |
|
| 134 | + } else { |
|
| 135 | + $filename = $dir . '/' . $files; |
|
| 136 | + $getType = self::ZIP_DIR; |
|
| 137 | + // downloading root ? |
|
| 138 | + if ($files !== '') { |
|
| 139 | + $name = $files; |
|
| 140 | + } |
|
| 141 | + } |
|
| 142 | + |
|
| 143 | + $streamer = new Streamer(); |
|
| 144 | + OC_Util::obEnd(); |
|
| 145 | + |
|
| 146 | + self::lockFiles($view, $dir, $files); |
|
| 147 | + |
|
| 148 | + $streamer->sendHeaders($name); |
|
| 149 | + $executionTime = intval(OC::$server->getIniWrapper()->getNumeric('max_execution_time')); |
|
| 150 | + set_time_limit(0); |
|
| 151 | + ignore_user_abort(true); |
|
| 152 | + if ($getType === self::ZIP_FILES) { |
|
| 153 | + foreach ($files as $file) { |
|
| 154 | + $file = $dir . '/' . $file; |
|
| 155 | + if (\OC\Files\Filesystem::is_file($file)) { |
|
| 156 | + $fileSize = \OC\Files\Filesystem::filesize($file); |
|
| 157 | + $fileTime = \OC\Files\Filesystem::filemtime($file); |
|
| 158 | + $fh = \OC\Files\Filesystem::fopen($file, 'r'); |
|
| 159 | + $streamer->addFileFromStream($fh, basename($file), $fileSize, $fileTime); |
|
| 160 | + fclose($fh); |
|
| 161 | + } elseif (\OC\Files\Filesystem::is_dir($file)) { |
|
| 162 | + $streamer->addDirRecursive($file); |
|
| 163 | + } |
|
| 164 | + } |
|
| 165 | + } elseif ($getType === self::ZIP_DIR) { |
|
| 166 | + $file = $dir . '/' . $files; |
|
| 167 | + $streamer->addDirRecursive($file); |
|
| 168 | + } |
|
| 169 | + $streamer->finalize(); |
|
| 170 | + set_time_limit($executionTime); |
|
| 171 | + self::unlockAllTheFiles($dir, $files, $getType, $view, $filename); |
|
| 172 | + } catch (\OCP\Lock\LockedException $ex) { |
|
| 173 | + self::unlockAllTheFiles($dir, $files, $getType, $view, $filename); |
|
| 174 | + OC::$server->getLogger()->logException($ex); |
|
| 175 | + $l = \OC::$server->getL10N('core'); |
|
| 176 | + $hint = method_exists($ex, 'getHint') ? $ex->getHint() : ''; |
|
| 177 | + \OC_Template::printErrorPage($l->t('File is currently busy, please try again later'), $hint); |
|
| 178 | + } catch (\OCP\Files\ForbiddenException $ex) { |
|
| 179 | + self::unlockAllTheFiles($dir, $files, $getType, $view, $filename); |
|
| 180 | + OC::$server->getLogger()->logException($ex); |
|
| 181 | + $l = \OC::$server->getL10N('core'); |
|
| 182 | + \OC_Template::printErrorPage($l->t('Can\'t read file'), $ex->getMessage()); |
|
| 183 | + } catch (\Exception $ex) { |
|
| 184 | + self::unlockAllTheFiles($dir, $files, $getType, $view, $filename); |
|
| 185 | + OC::$server->getLogger()->logException($ex); |
|
| 186 | + $l = \OC::$server->getL10N('core'); |
|
| 187 | + $hint = method_exists($ex, 'getHint') ? $ex->getHint() : ''; |
|
| 188 | + \OC_Template::printErrorPage($l->t('Can\'t read file'), $hint); |
|
| 189 | + } |
|
| 190 | + } |
|
| 191 | + |
|
| 192 | + /** |
|
| 193 | + * @param string $rangeHeaderPos |
|
| 194 | + * @param int $fileSize |
|
| 195 | + * @return array $rangeArray ('from'=>int,'to'=>int), ... |
|
| 196 | + */ |
|
| 197 | + private static function parseHttpRangeHeader($rangeHeaderPos, $fileSize) { |
|
| 198 | + $rArray=explode(',', $rangeHeaderPos); |
|
| 199 | + $minOffset = 0; |
|
| 200 | + $ind = 0; |
|
| 201 | + |
|
| 202 | + $rangeArray = array(); |
|
| 203 | + |
|
| 204 | + foreach ($rArray as $value) { |
|
| 205 | + $ranges = explode('-', $value); |
|
| 206 | + if (is_numeric($ranges[0])) { |
|
| 207 | + if ($ranges[0] < $minOffset) { // case: bytes=500-700,601-999 |
|
| 208 | + $ranges[0] = $minOffset; |
|
| 209 | + } |
|
| 210 | + if ($ind > 0 && $rangeArray[$ind-1]['to']+1 == $ranges[0]) { // case: bytes=500-600,601-999 |
|
| 211 | + $ind--; |
|
| 212 | + $ranges[0] = $rangeArray[$ind]['from']; |
|
| 213 | + } |
|
| 214 | + } |
|
| 215 | + |
|
| 216 | + if (is_numeric($ranges[0]) && is_numeric($ranges[1]) && $ranges[0] < $fileSize && $ranges[0] <= $ranges[1]) { |
|
| 217 | + // case: x-x |
|
| 218 | + if ($ranges[1] >= $fileSize) { |
|
| 219 | + $ranges[1] = $fileSize-1; |
|
| 220 | + } |
|
| 221 | + $rangeArray[$ind++] = array( 'from' => $ranges[0], 'to' => $ranges[1], 'size' => $fileSize ); |
|
| 222 | + $minOffset = $ranges[1] + 1; |
|
| 223 | + if ($minOffset >= $fileSize) { |
|
| 224 | + break; |
|
| 225 | + } |
|
| 226 | + } |
|
| 227 | + elseif (is_numeric($ranges[0]) && $ranges[0] < $fileSize) { |
|
| 228 | + // case: x- |
|
| 229 | + $rangeArray[$ind++] = array( 'from' => $ranges[0], 'to' => $fileSize-1, 'size' => $fileSize ); |
|
| 230 | + break; |
|
| 231 | + } |
|
| 232 | + elseif (is_numeric($ranges[1])) { |
|
| 233 | + // case: -x |
|
| 234 | + if ($ranges[1] > $fileSize) { |
|
| 235 | + $ranges[1] = $fileSize; |
|
| 236 | + } |
|
| 237 | + $rangeArray[$ind++] = array( 'from' => $fileSize-$ranges[1], 'to' => $fileSize-1, 'size' => $fileSize ); |
|
| 238 | + break; |
|
| 239 | + } |
|
| 240 | + } |
|
| 241 | + return $rangeArray; |
|
| 242 | + } |
|
| 243 | + |
|
| 244 | + /** |
|
| 245 | + * @param View $view |
|
| 246 | + * @param string $name |
|
| 247 | + * @param string $dir |
|
| 248 | + * @param array $params ; 'head' boolean to only send header of the request ; 'range' http range header |
|
| 249 | + */ |
|
| 250 | + private static function getSingleFile($view, $dir, $name, $params) { |
|
| 251 | + $filename = $dir . '/' . $name; |
|
| 252 | + OC_Util::obEnd(); |
|
| 253 | + $view->lockFile($filename, ILockingProvider::LOCK_SHARED); |
|
| 254 | 254 | |
| 255 | - $rangeArray = array(); |
|
| 255 | + $rangeArray = array(); |
|
| 256 | 256 | |
| 257 | - if (isset($params['range']) && substr($params['range'], 0, 6) === 'bytes=') { |
|
| 258 | - $rangeArray = self::parseHttpRangeHeader(substr($params['range'], 6), |
|
| 259 | - \OC\Files\Filesystem::filesize($filename)); |
|
| 260 | - } |
|
| 257 | + if (isset($params['range']) && substr($params['range'], 0, 6) === 'bytes=') { |
|
| 258 | + $rangeArray = self::parseHttpRangeHeader(substr($params['range'], 6), |
|
| 259 | + \OC\Files\Filesystem::filesize($filename)); |
|
| 260 | + } |
|
| 261 | 261 | |
| 262 | - if (\OC\Files\Filesystem::isReadable($filename)) { |
|
| 263 | - self::sendHeaders($filename, $name, $rangeArray); |
|
| 264 | - } elseif (!\OC\Files\Filesystem::file_exists($filename)) { |
|
| 265 | - header("HTTP/1.0 404 Not Found"); |
|
| 266 | - $tmpl = new OC_Template('', '404', 'guest'); |
|
| 267 | - $tmpl->printPage(); |
|
| 268 | - exit(); |
|
| 269 | - } else { |
|
| 270 | - header("HTTP/1.0 403 Forbidden"); |
|
| 271 | - die('403 Forbidden'); |
|
| 272 | - } |
|
| 273 | - if (isset($params['head']) && $params['head']) { |
|
| 274 | - return; |
|
| 275 | - } |
|
| 276 | - if (!empty($rangeArray)) { |
|
| 277 | - try { |
|
| 278 | - if (count($rangeArray) == 1) { |
|
| 279 | - $view->readfilePart($filename, $rangeArray[0]['from'], $rangeArray[0]['to']); |
|
| 280 | - } |
|
| 281 | - else { |
|
| 282 | - // check if file is seekable (if not throw UnseekableException) |
|
| 283 | - // we have to check it before body contents |
|
| 284 | - $view->readfilePart($filename, $rangeArray[0]['size'], $rangeArray[0]['size']); |
|
| 285 | - |
|
| 286 | - $type = \OC::$server->getMimeTypeDetector()->getSecureMimeType(\OC\Files\Filesystem::getMimeType($filename)); |
|
| 287 | - |
|
| 288 | - foreach ($rangeArray as $range) { |
|
| 289 | - echo "\r\n--".self::getBoundary()."\r\n". |
|
| 290 | - "Content-type: ".$type."\r\n". |
|
| 291 | - "Content-range: bytes ".$range['from']."-".$range['to']."/".$range['size']."\r\n\r\n"; |
|
| 292 | - $view->readfilePart($filename, $range['from'], $range['to']); |
|
| 293 | - } |
|
| 294 | - echo "\r\n--".self::getBoundary()."--\r\n"; |
|
| 295 | - } |
|
| 296 | - } catch (\OCP\Files\UnseekableException $ex) { |
|
| 297 | - // file is unseekable |
|
| 298 | - header_remove('Accept-Ranges'); |
|
| 299 | - header_remove('Content-Range'); |
|
| 300 | - header("HTTP/1.1 200 OK"); |
|
| 301 | - self::sendHeaders($filename, $name, array()); |
|
| 302 | - $view->readfile($filename); |
|
| 303 | - } |
|
| 304 | - } |
|
| 305 | - else { |
|
| 306 | - $view->readfile($filename); |
|
| 307 | - } |
|
| 308 | - } |
|
| 309 | - |
|
| 310 | - /** |
|
| 311 | - * @param View $view |
|
| 312 | - * @param string $dir |
|
| 313 | - * @param string[]|string $files |
|
| 314 | - */ |
|
| 315 | - public static function lockFiles($view, $dir, $files) { |
|
| 316 | - if (!is_array($files)) { |
|
| 317 | - $file = $dir . '/' . $files; |
|
| 318 | - $files = [$file]; |
|
| 319 | - } |
|
| 320 | - foreach ($files as $file) { |
|
| 321 | - $file = $dir . '/' . $file; |
|
| 322 | - $view->lockFile($file, ILockingProvider::LOCK_SHARED); |
|
| 323 | - if ($view->is_dir($file)) { |
|
| 324 | - $contents = $view->getDirectoryContent($file); |
|
| 325 | - $contents = array_map(function($fileInfo) use ($file) { |
|
| 326 | - /** @var \OCP\Files\FileInfo $fileInfo */ |
|
| 327 | - return $file . '/' . $fileInfo->getName(); |
|
| 328 | - }, $contents); |
|
| 329 | - self::lockFiles($view, $dir, $contents); |
|
| 330 | - } |
|
| 331 | - } |
|
| 332 | - } |
|
| 333 | - |
|
| 334 | - /** |
|
| 335 | - * set the maximum upload size limit for apache hosts using .htaccess |
|
| 336 | - * |
|
| 337 | - * @param int $size file size in bytes |
|
| 338 | - * @param array $files override '.htaccess' and '.user.ini' locations |
|
| 339 | - * @return bool false on failure, size on success |
|
| 340 | - */ |
|
| 341 | - public static function setUploadLimit($size, $files = []) { |
|
| 342 | - //don't allow user to break his config |
|
| 343 | - $size = intval($size); |
|
| 344 | - if ($size < self::UPLOAD_MIN_LIMIT_BYTES) { |
|
| 345 | - return false; |
|
| 346 | - } |
|
| 347 | - $size = OC_Helper::phpFileSize($size); |
|
| 348 | - |
|
| 349 | - $phpValueKeys = array( |
|
| 350 | - 'upload_max_filesize', |
|
| 351 | - 'post_max_size' |
|
| 352 | - ); |
|
| 353 | - |
|
| 354 | - // default locations if not overridden by $files |
|
| 355 | - $files = array_merge([ |
|
| 356 | - '.htaccess' => OC::$SERVERROOT . '/.htaccess', |
|
| 357 | - '.user.ini' => OC::$SERVERROOT . '/.user.ini' |
|
| 358 | - ], $files); |
|
| 359 | - |
|
| 360 | - $updateFiles = [ |
|
| 361 | - $files['.htaccess'] => [ |
|
| 362 | - 'pattern' => '/php_value %1$s (\S)*/', |
|
| 363 | - 'setting' => 'php_value %1$s %2$s' |
|
| 364 | - ], |
|
| 365 | - $files['.user.ini'] => [ |
|
| 366 | - 'pattern' => '/%1$s=(\S)*/', |
|
| 367 | - 'setting' => '%1$s=%2$s' |
|
| 368 | - ] |
|
| 369 | - ]; |
|
| 370 | - |
|
| 371 | - $success = true; |
|
| 372 | - |
|
| 373 | - foreach ($updateFiles as $filename => $patternMap) { |
|
| 374 | - // suppress warnings from fopen() |
|
| 375 | - $handle = @fopen($filename, 'r+'); |
|
| 376 | - if (!$handle) { |
|
| 377 | - \OCP\Util::writeLog('files', |
|
| 378 | - 'Can\'t write upload limit to ' . $filename . '. Please check the file permissions', |
|
| 379 | - \OCP\Util::WARN); |
|
| 380 | - $success = false; |
|
| 381 | - continue; // try to update as many files as possible |
|
| 382 | - } |
|
| 383 | - |
|
| 384 | - $content = ''; |
|
| 385 | - while (!feof($handle)) { |
|
| 386 | - $content .= fread($handle, 1000); |
|
| 387 | - } |
|
| 388 | - |
|
| 389 | - foreach ($phpValueKeys as $key) { |
|
| 390 | - $pattern = vsprintf($patternMap['pattern'], [$key]); |
|
| 391 | - $setting = vsprintf($patternMap['setting'], [$key, $size]); |
|
| 392 | - $hasReplaced = 0; |
|
| 393 | - $newContent = preg_replace($pattern, $setting, $content, 2, $hasReplaced); |
|
| 394 | - if ($newContent !== null) { |
|
| 395 | - $content = $newContent; |
|
| 396 | - } |
|
| 397 | - if ($hasReplaced === 0) { |
|
| 398 | - $content .= "\n" . $setting; |
|
| 399 | - } |
|
| 400 | - } |
|
| 401 | - |
|
| 402 | - // write file back |
|
| 403 | - ftruncate($handle, 0); |
|
| 404 | - rewind($handle); |
|
| 405 | - fwrite($handle, $content); |
|
| 406 | - |
|
| 407 | - fclose($handle); |
|
| 408 | - } |
|
| 409 | - |
|
| 410 | - if ($success) { |
|
| 411 | - return OC_Helper::computerFileSize($size); |
|
| 412 | - } |
|
| 413 | - return false; |
|
| 414 | - } |
|
| 415 | - |
|
| 416 | - /** |
|
| 417 | - * @param string $dir |
|
| 418 | - * @param $files |
|
| 419 | - * @param integer $getType |
|
| 420 | - * @param View $view |
|
| 421 | - * @param string $filename |
|
| 422 | - */ |
|
| 423 | - private static function unlockAllTheFiles($dir, $files, $getType, $view, $filename) { |
|
| 424 | - if ($getType === self::FILE) { |
|
| 425 | - $view->unlockFile($filename, ILockingProvider::LOCK_SHARED); |
|
| 426 | - } |
|
| 427 | - if ($getType === self::ZIP_FILES) { |
|
| 428 | - foreach ($files as $file) { |
|
| 429 | - $file = $dir . '/' . $file; |
|
| 430 | - $view->unlockFile($file, ILockingProvider::LOCK_SHARED); |
|
| 431 | - } |
|
| 432 | - } |
|
| 433 | - if ($getType === self::ZIP_DIR) { |
|
| 434 | - $file = $dir . '/' . $files; |
|
| 435 | - $view->unlockFile($file, ILockingProvider::LOCK_SHARED); |
|
| 436 | - } |
|
| 437 | - } |
|
| 262 | + if (\OC\Files\Filesystem::isReadable($filename)) { |
|
| 263 | + self::sendHeaders($filename, $name, $rangeArray); |
|
| 264 | + } elseif (!\OC\Files\Filesystem::file_exists($filename)) { |
|
| 265 | + header("HTTP/1.0 404 Not Found"); |
|
| 266 | + $tmpl = new OC_Template('', '404', 'guest'); |
|
| 267 | + $tmpl->printPage(); |
|
| 268 | + exit(); |
|
| 269 | + } else { |
|
| 270 | + header("HTTP/1.0 403 Forbidden"); |
|
| 271 | + die('403 Forbidden'); |
|
| 272 | + } |
|
| 273 | + if (isset($params['head']) && $params['head']) { |
|
| 274 | + return; |
|
| 275 | + } |
|
| 276 | + if (!empty($rangeArray)) { |
|
| 277 | + try { |
|
| 278 | + if (count($rangeArray) == 1) { |
|
| 279 | + $view->readfilePart($filename, $rangeArray[0]['from'], $rangeArray[0]['to']); |
|
| 280 | + } |
|
| 281 | + else { |
|
| 282 | + // check if file is seekable (if not throw UnseekableException) |
|
| 283 | + // we have to check it before body contents |
|
| 284 | + $view->readfilePart($filename, $rangeArray[0]['size'], $rangeArray[0]['size']); |
|
| 285 | + |
|
| 286 | + $type = \OC::$server->getMimeTypeDetector()->getSecureMimeType(\OC\Files\Filesystem::getMimeType($filename)); |
|
| 287 | + |
|
| 288 | + foreach ($rangeArray as $range) { |
|
| 289 | + echo "\r\n--".self::getBoundary()."\r\n". |
|
| 290 | + "Content-type: ".$type."\r\n". |
|
| 291 | + "Content-range: bytes ".$range['from']."-".$range['to']."/".$range['size']."\r\n\r\n"; |
|
| 292 | + $view->readfilePart($filename, $range['from'], $range['to']); |
|
| 293 | + } |
|
| 294 | + echo "\r\n--".self::getBoundary()."--\r\n"; |
|
| 295 | + } |
|
| 296 | + } catch (\OCP\Files\UnseekableException $ex) { |
|
| 297 | + // file is unseekable |
|
| 298 | + header_remove('Accept-Ranges'); |
|
| 299 | + header_remove('Content-Range'); |
|
| 300 | + header("HTTP/1.1 200 OK"); |
|
| 301 | + self::sendHeaders($filename, $name, array()); |
|
| 302 | + $view->readfile($filename); |
|
| 303 | + } |
|
| 304 | + } |
|
| 305 | + else { |
|
| 306 | + $view->readfile($filename); |
|
| 307 | + } |
|
| 308 | + } |
|
| 309 | + |
|
| 310 | + /** |
|
| 311 | + * @param View $view |
|
| 312 | + * @param string $dir |
|
| 313 | + * @param string[]|string $files |
|
| 314 | + */ |
|
| 315 | + public static function lockFiles($view, $dir, $files) { |
|
| 316 | + if (!is_array($files)) { |
|
| 317 | + $file = $dir . '/' . $files; |
|
| 318 | + $files = [$file]; |
|
| 319 | + } |
|
| 320 | + foreach ($files as $file) { |
|
| 321 | + $file = $dir . '/' . $file; |
|
| 322 | + $view->lockFile($file, ILockingProvider::LOCK_SHARED); |
|
| 323 | + if ($view->is_dir($file)) { |
|
| 324 | + $contents = $view->getDirectoryContent($file); |
|
| 325 | + $contents = array_map(function($fileInfo) use ($file) { |
|
| 326 | + /** @var \OCP\Files\FileInfo $fileInfo */ |
|
| 327 | + return $file . '/' . $fileInfo->getName(); |
|
| 328 | + }, $contents); |
|
| 329 | + self::lockFiles($view, $dir, $contents); |
|
| 330 | + } |
|
| 331 | + } |
|
| 332 | + } |
|
| 333 | + |
|
| 334 | + /** |
|
| 335 | + * set the maximum upload size limit for apache hosts using .htaccess |
|
| 336 | + * |
|
| 337 | + * @param int $size file size in bytes |
|
| 338 | + * @param array $files override '.htaccess' and '.user.ini' locations |
|
| 339 | + * @return bool false on failure, size on success |
|
| 340 | + */ |
|
| 341 | + public static function setUploadLimit($size, $files = []) { |
|
| 342 | + //don't allow user to break his config |
|
| 343 | + $size = intval($size); |
|
| 344 | + if ($size < self::UPLOAD_MIN_LIMIT_BYTES) { |
|
| 345 | + return false; |
|
| 346 | + } |
|
| 347 | + $size = OC_Helper::phpFileSize($size); |
|
| 348 | + |
|
| 349 | + $phpValueKeys = array( |
|
| 350 | + 'upload_max_filesize', |
|
| 351 | + 'post_max_size' |
|
| 352 | + ); |
|
| 353 | + |
|
| 354 | + // default locations if not overridden by $files |
|
| 355 | + $files = array_merge([ |
|
| 356 | + '.htaccess' => OC::$SERVERROOT . '/.htaccess', |
|
| 357 | + '.user.ini' => OC::$SERVERROOT . '/.user.ini' |
|
| 358 | + ], $files); |
|
| 359 | + |
|
| 360 | + $updateFiles = [ |
|
| 361 | + $files['.htaccess'] => [ |
|
| 362 | + 'pattern' => '/php_value %1$s (\S)*/', |
|
| 363 | + 'setting' => 'php_value %1$s %2$s' |
|
| 364 | + ], |
|
| 365 | + $files['.user.ini'] => [ |
|
| 366 | + 'pattern' => '/%1$s=(\S)*/', |
|
| 367 | + 'setting' => '%1$s=%2$s' |
|
| 368 | + ] |
|
| 369 | + ]; |
|
| 370 | + |
|
| 371 | + $success = true; |
|
| 372 | + |
|
| 373 | + foreach ($updateFiles as $filename => $patternMap) { |
|
| 374 | + // suppress warnings from fopen() |
|
| 375 | + $handle = @fopen($filename, 'r+'); |
|
| 376 | + if (!$handle) { |
|
| 377 | + \OCP\Util::writeLog('files', |
|
| 378 | + 'Can\'t write upload limit to ' . $filename . '. Please check the file permissions', |
|
| 379 | + \OCP\Util::WARN); |
|
| 380 | + $success = false; |
|
| 381 | + continue; // try to update as many files as possible |
|
| 382 | + } |
|
| 383 | + |
|
| 384 | + $content = ''; |
|
| 385 | + while (!feof($handle)) { |
|
| 386 | + $content .= fread($handle, 1000); |
|
| 387 | + } |
|
| 388 | + |
|
| 389 | + foreach ($phpValueKeys as $key) { |
|
| 390 | + $pattern = vsprintf($patternMap['pattern'], [$key]); |
|
| 391 | + $setting = vsprintf($patternMap['setting'], [$key, $size]); |
|
| 392 | + $hasReplaced = 0; |
|
| 393 | + $newContent = preg_replace($pattern, $setting, $content, 2, $hasReplaced); |
|
| 394 | + if ($newContent !== null) { |
|
| 395 | + $content = $newContent; |
|
| 396 | + } |
|
| 397 | + if ($hasReplaced === 0) { |
|
| 398 | + $content .= "\n" . $setting; |
|
| 399 | + } |
|
| 400 | + } |
|
| 401 | + |
|
| 402 | + // write file back |
|
| 403 | + ftruncate($handle, 0); |
|
| 404 | + rewind($handle); |
|
| 405 | + fwrite($handle, $content); |
|
| 406 | + |
|
| 407 | + fclose($handle); |
|
| 408 | + } |
|
| 409 | + |
|
| 410 | + if ($success) { |
|
| 411 | + return OC_Helper::computerFileSize($size); |
|
| 412 | + } |
|
| 413 | + return false; |
|
| 414 | + } |
|
| 415 | + |
|
| 416 | + /** |
|
| 417 | + * @param string $dir |
|
| 418 | + * @param $files |
|
| 419 | + * @param integer $getType |
|
| 420 | + * @param View $view |
|
| 421 | + * @param string $filename |
|
| 422 | + */ |
|
| 423 | + private static function unlockAllTheFiles($dir, $files, $getType, $view, $filename) { |
|
| 424 | + if ($getType === self::FILE) { |
|
| 425 | + $view->unlockFile($filename, ILockingProvider::LOCK_SHARED); |
|
| 426 | + } |
|
| 427 | + if ($getType === self::ZIP_FILES) { |
|
| 428 | + foreach ($files as $file) { |
|
| 429 | + $file = $dir . '/' . $file; |
|
| 430 | + $view->unlockFile($file, ILockingProvider::LOCK_SHARED); |
|
| 431 | + } |
|
| 432 | + } |
|
| 433 | + if ($getType === self::ZIP_DIR) { |
|
| 434 | + $file = $dir . '/' . $files; |
|
| 435 | + $view->unlockFile($file, ILockingProvider::LOCK_SHARED); |
|
| 436 | + } |
|
| 437 | + } |
|
| 438 | 438 | |
| 439 | 439 | } |
@@ -115,7 +115,7 @@ discard block |
||
| 115 | 115 | } |
| 116 | 116 | |
| 117 | 117 | if (!is_array($files)) { |
| 118 | - $filename = $dir . '/' . $files; |
|
| 118 | + $filename = $dir.'/'.$files; |
|
| 119 | 119 | if (!$view->is_dir($filename)) { |
| 120 | 120 | self::getSingleFile($view, $dir, $files, is_null($params) ? array() : $params); |
| 121 | 121 | return; |
@@ -130,9 +130,9 @@ discard block |
||
| 130 | 130 | $name = $basename; |
| 131 | 131 | } |
| 132 | 132 | |
| 133 | - $filename = $dir . '/' . $name; |
|
| 133 | + $filename = $dir.'/'.$name; |
|
| 134 | 134 | } else { |
| 135 | - $filename = $dir . '/' . $files; |
|
| 135 | + $filename = $dir.'/'.$files; |
|
| 136 | 136 | $getType = self::ZIP_DIR; |
| 137 | 137 | // downloading root ? |
| 138 | 138 | if ($files !== '') { |
@@ -151,7 +151,7 @@ discard block |
||
| 151 | 151 | ignore_user_abort(true); |
| 152 | 152 | if ($getType === self::ZIP_FILES) { |
| 153 | 153 | foreach ($files as $file) { |
| 154 | - $file = $dir . '/' . $file; |
|
| 154 | + $file = $dir.'/'.$file; |
|
| 155 | 155 | if (\OC\Files\Filesystem::is_file($file)) { |
| 156 | 156 | $fileSize = \OC\Files\Filesystem::filesize($file); |
| 157 | 157 | $fileTime = \OC\Files\Filesystem::filemtime($file); |
@@ -163,7 +163,7 @@ discard block |
||
| 163 | 163 | } |
| 164 | 164 | } |
| 165 | 165 | } elseif ($getType === self::ZIP_DIR) { |
| 166 | - $file = $dir . '/' . $files; |
|
| 166 | + $file = $dir.'/'.$files; |
|
| 167 | 167 | $streamer->addDirRecursive($file); |
| 168 | 168 | } |
| 169 | 169 | $streamer->finalize(); |
@@ -195,7 +195,7 @@ discard block |
||
| 195 | 195 | * @return array $rangeArray ('from'=>int,'to'=>int), ... |
| 196 | 196 | */ |
| 197 | 197 | private static function parseHttpRangeHeader($rangeHeaderPos, $fileSize) { |
| 198 | - $rArray=explode(',', $rangeHeaderPos); |
|
| 198 | + $rArray = explode(',', $rangeHeaderPos); |
|
| 199 | 199 | $minOffset = 0; |
| 200 | 200 | $ind = 0; |
| 201 | 201 | |
@@ -207,7 +207,7 @@ discard block |
||
| 207 | 207 | if ($ranges[0] < $minOffset) { // case: bytes=500-700,601-999 |
| 208 | 208 | $ranges[0] = $minOffset; |
| 209 | 209 | } |
| 210 | - if ($ind > 0 && $rangeArray[$ind-1]['to']+1 == $ranges[0]) { // case: bytes=500-600,601-999 |
|
| 210 | + if ($ind > 0 && $rangeArray[$ind - 1]['to'] + 1 == $ranges[0]) { // case: bytes=500-600,601-999 |
|
| 211 | 211 | $ind--; |
| 212 | 212 | $ranges[0] = $rangeArray[$ind]['from']; |
| 213 | 213 | } |
@@ -216,9 +216,9 @@ discard block |
||
| 216 | 216 | if (is_numeric($ranges[0]) && is_numeric($ranges[1]) && $ranges[0] < $fileSize && $ranges[0] <= $ranges[1]) { |
| 217 | 217 | // case: x-x |
| 218 | 218 | if ($ranges[1] >= $fileSize) { |
| 219 | - $ranges[1] = $fileSize-1; |
|
| 219 | + $ranges[1] = $fileSize - 1; |
|
| 220 | 220 | } |
| 221 | - $rangeArray[$ind++] = array( 'from' => $ranges[0], 'to' => $ranges[1], 'size' => $fileSize ); |
|
| 221 | + $rangeArray[$ind++] = array('from' => $ranges[0], 'to' => $ranges[1], 'size' => $fileSize); |
|
| 222 | 222 | $minOffset = $ranges[1] + 1; |
| 223 | 223 | if ($minOffset >= $fileSize) { |
| 224 | 224 | break; |
@@ -226,7 +226,7 @@ discard block |
||
| 226 | 226 | } |
| 227 | 227 | elseif (is_numeric($ranges[0]) && $ranges[0] < $fileSize) { |
| 228 | 228 | // case: x- |
| 229 | - $rangeArray[$ind++] = array( 'from' => $ranges[0], 'to' => $fileSize-1, 'size' => $fileSize ); |
|
| 229 | + $rangeArray[$ind++] = array('from' => $ranges[0], 'to' => $fileSize - 1, 'size' => $fileSize); |
|
| 230 | 230 | break; |
| 231 | 231 | } |
| 232 | 232 | elseif (is_numeric($ranges[1])) { |
@@ -234,7 +234,7 @@ discard block |
||
| 234 | 234 | if ($ranges[1] > $fileSize) { |
| 235 | 235 | $ranges[1] = $fileSize; |
| 236 | 236 | } |
| 237 | - $rangeArray[$ind++] = array( 'from' => $fileSize-$ranges[1], 'to' => $fileSize-1, 'size' => $fileSize ); |
|
| 237 | + $rangeArray[$ind++] = array('from' => $fileSize - $ranges[1], 'to' => $fileSize - 1, 'size' => $fileSize); |
|
| 238 | 238 | break; |
| 239 | 239 | } |
| 240 | 240 | } |
@@ -248,7 +248,7 @@ discard block |
||
| 248 | 248 | * @param array $params ; 'head' boolean to only send header of the request ; 'range' http range header |
| 249 | 249 | */ |
| 250 | 250 | private static function getSingleFile($view, $dir, $name, $params) { |
| 251 | - $filename = $dir . '/' . $name; |
|
| 251 | + $filename = $dir.'/'.$name; |
|
| 252 | 252 | OC_Util::obEnd(); |
| 253 | 253 | $view->lockFile($filename, ILockingProvider::LOCK_SHARED); |
| 254 | 254 | |
@@ -314,17 +314,17 @@ discard block |
||
| 314 | 314 | */ |
| 315 | 315 | public static function lockFiles($view, $dir, $files) { |
| 316 | 316 | if (!is_array($files)) { |
| 317 | - $file = $dir . '/' . $files; |
|
| 317 | + $file = $dir.'/'.$files; |
|
| 318 | 318 | $files = [$file]; |
| 319 | 319 | } |
| 320 | 320 | foreach ($files as $file) { |
| 321 | - $file = $dir . '/' . $file; |
|
| 321 | + $file = $dir.'/'.$file; |
|
| 322 | 322 | $view->lockFile($file, ILockingProvider::LOCK_SHARED); |
| 323 | 323 | if ($view->is_dir($file)) { |
| 324 | 324 | $contents = $view->getDirectoryContent($file); |
| 325 | 325 | $contents = array_map(function($fileInfo) use ($file) { |
| 326 | 326 | /** @var \OCP\Files\FileInfo $fileInfo */ |
| 327 | - return $file . '/' . $fileInfo->getName(); |
|
| 327 | + return $file.'/'.$fileInfo->getName(); |
|
| 328 | 328 | }, $contents); |
| 329 | 329 | self::lockFiles($view, $dir, $contents); |
| 330 | 330 | } |
@@ -353,8 +353,8 @@ discard block |
||
| 353 | 353 | |
| 354 | 354 | // default locations if not overridden by $files |
| 355 | 355 | $files = array_merge([ |
| 356 | - '.htaccess' => OC::$SERVERROOT . '/.htaccess', |
|
| 357 | - '.user.ini' => OC::$SERVERROOT . '/.user.ini' |
|
| 356 | + '.htaccess' => OC::$SERVERROOT.'/.htaccess', |
|
| 357 | + '.user.ini' => OC::$SERVERROOT.'/.user.ini' |
|
| 358 | 358 | ], $files); |
| 359 | 359 | |
| 360 | 360 | $updateFiles = [ |
@@ -375,7 +375,7 @@ discard block |
||
| 375 | 375 | $handle = @fopen($filename, 'r+'); |
| 376 | 376 | if (!$handle) { |
| 377 | 377 | \OCP\Util::writeLog('files', |
| 378 | - 'Can\'t write upload limit to ' . $filename . '. Please check the file permissions', |
|
| 378 | + 'Can\'t write upload limit to '.$filename.'. Please check the file permissions', |
|
| 379 | 379 | \OCP\Util::WARN); |
| 380 | 380 | $success = false; |
| 381 | 381 | continue; // try to update as many files as possible |
@@ -395,7 +395,7 @@ discard block |
||
| 395 | 395 | $content = $newContent; |
| 396 | 396 | } |
| 397 | 397 | if ($hasReplaced === 0) { |
| 398 | - $content .= "\n" . $setting; |
|
| 398 | + $content .= "\n".$setting; |
|
| 399 | 399 | } |
| 400 | 400 | } |
| 401 | 401 | |
@@ -426,12 +426,12 @@ discard block |
||
| 426 | 426 | } |
| 427 | 427 | if ($getType === self::ZIP_FILES) { |
| 428 | 428 | foreach ($files as $file) { |
| 429 | - $file = $dir . '/' . $file; |
|
| 429 | + $file = $dir.'/'.$file; |
|
| 430 | 430 | $view->unlockFile($file, ILockingProvider::LOCK_SHARED); |
| 431 | 431 | } |
| 432 | 432 | } |
| 433 | 433 | if ($getType === self::ZIP_DIR) { |
| 434 | - $file = $dir . '/' . $files; |
|
| 434 | + $file = $dir.'/'.$files; |
|
| 435 | 435 | $view->unlockFile($file, ILockingProvider::LOCK_SHARED); |
| 436 | 436 | } |
| 437 | 437 | } |
@@ -83,13 +83,11 @@ discard block |
||
| 83 | 83 | if (count($rangeArray) > 1) { |
| 84 | 84 | $type = 'multipart/byteranges; boundary='.self::getBoundary(); |
| 85 | 85 | // no Content-Length header here |
| 86 | - } |
|
| 87 | - else { |
|
| 86 | + } else { |
|
| 88 | 87 | header(sprintf('Content-Range: bytes %d-%d/%d', $rangeArray[0]['from'], $rangeArray[0]['to'], $fileSize), true); |
| 89 | 88 | OC_Response::setContentLengthHeader($rangeArray[0]['to'] - $rangeArray[0]['from'] + 1); |
| 90 | 89 | } |
| 91 | - } |
|
| 92 | - else { |
|
| 90 | + } else { |
|
| 93 | 91 | OC_Response::setContentLengthHeader($fileSize); |
| 94 | 92 | } |
| 95 | 93 | } |
@@ -223,13 +221,11 @@ discard block |
||
| 223 | 221 | if ($minOffset >= $fileSize) { |
| 224 | 222 | break; |
| 225 | 223 | } |
| 226 | - } |
|
| 227 | - elseif (is_numeric($ranges[0]) && $ranges[0] < $fileSize) { |
|
| 224 | + } elseif (is_numeric($ranges[0]) && $ranges[0] < $fileSize) { |
|
| 228 | 225 | // case: x- |
| 229 | 226 | $rangeArray[$ind++] = array( 'from' => $ranges[0], 'to' => $fileSize-1, 'size' => $fileSize ); |
| 230 | 227 | break; |
| 231 | - } |
|
| 232 | - elseif (is_numeric($ranges[1])) { |
|
| 228 | + } elseif (is_numeric($ranges[1])) { |
|
| 233 | 229 | // case: -x |
| 234 | 230 | if ($ranges[1] > $fileSize) { |
| 235 | 231 | $ranges[1] = $fileSize; |
@@ -277,8 +273,7 @@ discard block |
||
| 277 | 273 | try { |
| 278 | 274 | if (count($rangeArray) == 1) { |
| 279 | 275 | $view->readfilePart($filename, $rangeArray[0]['from'], $rangeArray[0]['to']); |
| 280 | - } |
|
| 281 | - else { |
|
| 276 | + } else { |
|
| 282 | 277 | // check if file is seekable (if not throw UnseekableException) |
| 283 | 278 | // we have to check it before body contents |
| 284 | 279 | $view->readfilePart($filename, $rangeArray[0]['size'], $rangeArray[0]['size']); |
@@ -301,8 +296,7 @@ discard block |
||
| 301 | 296 | self::sendHeaders($filename, $name, array()); |
| 302 | 297 | $view->readfile($filename); |
| 303 | 298 | } |
| 304 | - } |
|
| 305 | - else { |
|
| 299 | + } else { |
|
| 306 | 300 | $view->readfile($filename); |
| 307 | 301 | } |
| 308 | 302 | } |
@@ -72,7 +72,7 @@ discard block |
||
| 72 | 72 | * |
| 73 | 73 | * @NoAdminRequired |
| 74 | 74 | * @NoSubadminRequired |
| 75 | - * @return array |
|
| 75 | + * @return DataResponse |
|
| 76 | 76 | */ |
| 77 | 77 | public function addPersonalRootCertificate() { |
| 78 | 78 | return $this->addCertificate($this->userCertificateManager); |
@@ -160,7 +160,7 @@ discard block |
||
| 160 | 160 | /** |
| 161 | 161 | * Add a new personal root certificate to the system's trust store |
| 162 | 162 | * |
| 163 | - * @return array |
|
| 163 | + * @return DataResponse |
|
| 164 | 164 | */ |
| 165 | 165 | public function addSystemRootCertificate() { |
| 166 | 166 | return $this->addCertificate($this->systemCertificateManager); |
@@ -37,144 +37,144 @@ |
||
| 37 | 37 | * @package OC\Settings\Controller |
| 38 | 38 | */ |
| 39 | 39 | class CertificateController extends Controller { |
| 40 | - /** @var ICertificateManager */ |
|
| 41 | - private $userCertificateManager; |
|
| 42 | - /** @var ICertificateManager */ |
|
| 43 | - private $systemCertificateManager; |
|
| 44 | - /** @var IL10N */ |
|
| 45 | - private $l10n; |
|
| 46 | - /** @var IAppManager */ |
|
| 47 | - private $appManager; |
|
| 48 | - |
|
| 49 | - /** |
|
| 50 | - * @param string $appName |
|
| 51 | - * @param IRequest $request |
|
| 52 | - * @param ICertificateManager $userCertificateManager |
|
| 53 | - * @param ICertificateManager $systemCertificateManager |
|
| 54 | - * @param IL10N $l10n |
|
| 55 | - * @param IAppManager $appManager |
|
| 56 | - */ |
|
| 57 | - public function __construct($appName, |
|
| 58 | - IRequest $request, |
|
| 59 | - ICertificateManager $userCertificateManager, |
|
| 60 | - ICertificateManager $systemCertificateManager, |
|
| 61 | - IL10N $l10n, |
|
| 62 | - IAppManager $appManager) { |
|
| 63 | - parent::__construct($appName, $request); |
|
| 64 | - $this->userCertificateManager = $userCertificateManager; |
|
| 65 | - $this->systemCertificateManager = $systemCertificateManager; |
|
| 66 | - $this->l10n = $l10n; |
|
| 67 | - $this->appManager = $appManager; |
|
| 68 | - } |
|
| 69 | - |
|
| 70 | - /** |
|
| 71 | - * Add a new personal root certificate to the users' trust store |
|
| 72 | - * |
|
| 73 | - * @NoAdminRequired |
|
| 74 | - * @NoSubadminRequired |
|
| 75 | - * @return array |
|
| 76 | - */ |
|
| 77 | - public function addPersonalRootCertificate() { |
|
| 78 | - return $this->addCertificate($this->userCertificateManager); |
|
| 79 | - } |
|
| 80 | - |
|
| 81 | - /** |
|
| 82 | - * Add a new root certificate to a trust store |
|
| 83 | - * |
|
| 84 | - * @param ICertificateManager $certificateManager |
|
| 85 | - * @return DataResponse |
|
| 86 | - */ |
|
| 87 | - private function addCertificate(ICertificateManager $certificateManager) { |
|
| 88 | - $headers = []; |
|
| 89 | - |
|
| 90 | - if ($this->isCertificateImportAllowed() === false) { |
|
| 91 | - return new DataResponse(['message' => 'Individual certificate management disabled'], Http::STATUS_FORBIDDEN, $headers); |
|
| 92 | - } |
|
| 93 | - |
|
| 94 | - $file = $this->request->getUploadedFile('rootcert_import'); |
|
| 95 | - if (empty($file)) { |
|
| 96 | - return new DataResponse(['message' => 'No file uploaded'], Http::STATUS_UNPROCESSABLE_ENTITY, $headers); |
|
| 97 | - } |
|
| 98 | - |
|
| 99 | - try { |
|
| 100 | - $certificate = $certificateManager->addCertificate(file_get_contents($file['tmp_name']), $file['name']); |
|
| 101 | - return new DataResponse( |
|
| 102 | - [ |
|
| 103 | - 'name' => $certificate->getName(), |
|
| 104 | - 'commonName' => $certificate->getCommonName(), |
|
| 105 | - 'organization' => $certificate->getOrganization(), |
|
| 106 | - 'validFrom' => $certificate->getIssueDate()->getTimestamp(), |
|
| 107 | - 'validTill' => $certificate->getExpireDate()->getTimestamp(), |
|
| 108 | - 'validFromString' => $this->l10n->l('date', $certificate->getIssueDate()), |
|
| 109 | - 'validTillString' => $this->l10n->l('date', $certificate->getExpireDate()), |
|
| 110 | - 'issuer' => $certificate->getIssuerName(), |
|
| 111 | - 'issuerOrganization' => $certificate->getIssuerOrganization(), |
|
| 112 | - ], |
|
| 113 | - Http::STATUS_OK, |
|
| 114 | - $headers |
|
| 115 | - ); |
|
| 116 | - } catch (\Exception $e) { |
|
| 117 | - return new DataResponse('An error occurred.', Http::STATUS_UNPROCESSABLE_ENTITY, $headers); |
|
| 118 | - } |
|
| 119 | - } |
|
| 120 | - |
|
| 121 | - /** |
|
| 122 | - * Removes a personal root certificate from the users' trust store |
|
| 123 | - * |
|
| 124 | - * @NoAdminRequired |
|
| 125 | - * @NoSubadminRequired |
|
| 126 | - * @param string $certificateIdentifier |
|
| 127 | - * @return DataResponse |
|
| 128 | - */ |
|
| 129 | - public function removePersonalRootCertificate($certificateIdentifier) { |
|
| 130 | - |
|
| 131 | - if ($this->isCertificateImportAllowed() === false) { |
|
| 132 | - return new DataResponse('Individual certificate management disabled', Http::STATUS_FORBIDDEN); |
|
| 133 | - } |
|
| 134 | - |
|
| 135 | - $this->userCertificateManager->removeCertificate($certificateIdentifier); |
|
| 136 | - return new DataResponse(); |
|
| 137 | - } |
|
| 138 | - |
|
| 139 | - /** |
|
| 140 | - * check if certificate import is allowed |
|
| 141 | - * |
|
| 142 | - * @return bool |
|
| 143 | - */ |
|
| 144 | - protected function isCertificateImportAllowed() { |
|
| 145 | - $externalStorageEnabled = $this->appManager->isEnabledForUser('files_external'); |
|
| 146 | - if ($externalStorageEnabled) { |
|
| 147 | - /** @var \OCA\Files_External\Service\BackendService $backendService */ |
|
| 148 | - $backendService = \OC_Mount_Config::$app->getContainer()->query('\OCA\Files_External\Service\BackendService'); |
|
| 149 | - if ($backendService->isUserMountingAllowed()) { |
|
| 150 | - return true; |
|
| 151 | - } |
|
| 152 | - } |
|
| 153 | - return false; |
|
| 154 | - } |
|
| 155 | - |
|
| 156 | - /** |
|
| 157 | - * Add a new personal root certificate to the system's trust store |
|
| 158 | - * |
|
| 159 | - * @return array |
|
| 160 | - */ |
|
| 161 | - public function addSystemRootCertificate() { |
|
| 162 | - return $this->addCertificate($this->systemCertificateManager); |
|
| 163 | - } |
|
| 164 | - |
|
| 165 | - /** |
|
| 166 | - * Removes a personal root certificate from the users' trust store |
|
| 167 | - * |
|
| 168 | - * @param string $certificateIdentifier |
|
| 169 | - * @return DataResponse |
|
| 170 | - */ |
|
| 171 | - public function removeSystemRootCertificate($certificateIdentifier) { |
|
| 172 | - |
|
| 173 | - if ($this->isCertificateImportAllowed() === false) { |
|
| 174 | - return new DataResponse('Individual certificate management disabled', Http::STATUS_FORBIDDEN); |
|
| 175 | - } |
|
| 176 | - |
|
| 177 | - $this->systemCertificateManager->removeCertificate($certificateIdentifier); |
|
| 178 | - return new DataResponse(); |
|
| 179 | - } |
|
| 40 | + /** @var ICertificateManager */ |
|
| 41 | + private $userCertificateManager; |
|
| 42 | + /** @var ICertificateManager */ |
|
| 43 | + private $systemCertificateManager; |
|
| 44 | + /** @var IL10N */ |
|
| 45 | + private $l10n; |
|
| 46 | + /** @var IAppManager */ |
|
| 47 | + private $appManager; |
|
| 48 | + |
|
| 49 | + /** |
|
| 50 | + * @param string $appName |
|
| 51 | + * @param IRequest $request |
|
| 52 | + * @param ICertificateManager $userCertificateManager |
|
| 53 | + * @param ICertificateManager $systemCertificateManager |
|
| 54 | + * @param IL10N $l10n |
|
| 55 | + * @param IAppManager $appManager |
|
| 56 | + */ |
|
| 57 | + public function __construct($appName, |
|
| 58 | + IRequest $request, |
|
| 59 | + ICertificateManager $userCertificateManager, |
|
| 60 | + ICertificateManager $systemCertificateManager, |
|
| 61 | + IL10N $l10n, |
|
| 62 | + IAppManager $appManager) { |
|
| 63 | + parent::__construct($appName, $request); |
|
| 64 | + $this->userCertificateManager = $userCertificateManager; |
|
| 65 | + $this->systemCertificateManager = $systemCertificateManager; |
|
| 66 | + $this->l10n = $l10n; |
|
| 67 | + $this->appManager = $appManager; |
|
| 68 | + } |
|
| 69 | + |
|
| 70 | + /** |
|
| 71 | + * Add a new personal root certificate to the users' trust store |
|
| 72 | + * |
|
| 73 | + * @NoAdminRequired |
|
| 74 | + * @NoSubadminRequired |
|
| 75 | + * @return array |
|
| 76 | + */ |
|
| 77 | + public function addPersonalRootCertificate() { |
|
| 78 | + return $this->addCertificate($this->userCertificateManager); |
|
| 79 | + } |
|
| 80 | + |
|
| 81 | + /** |
|
| 82 | + * Add a new root certificate to a trust store |
|
| 83 | + * |
|
| 84 | + * @param ICertificateManager $certificateManager |
|
| 85 | + * @return DataResponse |
|
| 86 | + */ |
|
| 87 | + private function addCertificate(ICertificateManager $certificateManager) { |
|
| 88 | + $headers = []; |
|
| 89 | + |
|
| 90 | + if ($this->isCertificateImportAllowed() === false) { |
|
| 91 | + return new DataResponse(['message' => 'Individual certificate management disabled'], Http::STATUS_FORBIDDEN, $headers); |
|
| 92 | + } |
|
| 93 | + |
|
| 94 | + $file = $this->request->getUploadedFile('rootcert_import'); |
|
| 95 | + if (empty($file)) { |
|
| 96 | + return new DataResponse(['message' => 'No file uploaded'], Http::STATUS_UNPROCESSABLE_ENTITY, $headers); |
|
| 97 | + } |
|
| 98 | + |
|
| 99 | + try { |
|
| 100 | + $certificate = $certificateManager->addCertificate(file_get_contents($file['tmp_name']), $file['name']); |
|
| 101 | + return new DataResponse( |
|
| 102 | + [ |
|
| 103 | + 'name' => $certificate->getName(), |
|
| 104 | + 'commonName' => $certificate->getCommonName(), |
|
| 105 | + 'organization' => $certificate->getOrganization(), |
|
| 106 | + 'validFrom' => $certificate->getIssueDate()->getTimestamp(), |
|
| 107 | + 'validTill' => $certificate->getExpireDate()->getTimestamp(), |
|
| 108 | + 'validFromString' => $this->l10n->l('date', $certificate->getIssueDate()), |
|
| 109 | + 'validTillString' => $this->l10n->l('date', $certificate->getExpireDate()), |
|
| 110 | + 'issuer' => $certificate->getIssuerName(), |
|
| 111 | + 'issuerOrganization' => $certificate->getIssuerOrganization(), |
|
| 112 | + ], |
|
| 113 | + Http::STATUS_OK, |
|
| 114 | + $headers |
|
| 115 | + ); |
|
| 116 | + } catch (\Exception $e) { |
|
| 117 | + return new DataResponse('An error occurred.', Http::STATUS_UNPROCESSABLE_ENTITY, $headers); |
|
| 118 | + } |
|
| 119 | + } |
|
| 120 | + |
|
| 121 | + /** |
|
| 122 | + * Removes a personal root certificate from the users' trust store |
|
| 123 | + * |
|
| 124 | + * @NoAdminRequired |
|
| 125 | + * @NoSubadminRequired |
|
| 126 | + * @param string $certificateIdentifier |
|
| 127 | + * @return DataResponse |
|
| 128 | + */ |
|
| 129 | + public function removePersonalRootCertificate($certificateIdentifier) { |
|
| 130 | + |
|
| 131 | + if ($this->isCertificateImportAllowed() === false) { |
|
| 132 | + return new DataResponse('Individual certificate management disabled', Http::STATUS_FORBIDDEN); |
|
| 133 | + } |
|
| 134 | + |
|
| 135 | + $this->userCertificateManager->removeCertificate($certificateIdentifier); |
|
| 136 | + return new DataResponse(); |
|
| 137 | + } |
|
| 138 | + |
|
| 139 | + /** |
|
| 140 | + * check if certificate import is allowed |
|
| 141 | + * |
|
| 142 | + * @return bool |
|
| 143 | + */ |
|
| 144 | + protected function isCertificateImportAllowed() { |
|
| 145 | + $externalStorageEnabled = $this->appManager->isEnabledForUser('files_external'); |
|
| 146 | + if ($externalStorageEnabled) { |
|
| 147 | + /** @var \OCA\Files_External\Service\BackendService $backendService */ |
|
| 148 | + $backendService = \OC_Mount_Config::$app->getContainer()->query('\OCA\Files_External\Service\BackendService'); |
|
| 149 | + if ($backendService->isUserMountingAllowed()) { |
|
| 150 | + return true; |
|
| 151 | + } |
|
| 152 | + } |
|
| 153 | + return false; |
|
| 154 | + } |
|
| 155 | + |
|
| 156 | + /** |
|
| 157 | + * Add a new personal root certificate to the system's trust store |
|
| 158 | + * |
|
| 159 | + * @return array |
|
| 160 | + */ |
|
| 161 | + public function addSystemRootCertificate() { |
|
| 162 | + return $this->addCertificate($this->systemCertificateManager); |
|
| 163 | + } |
|
| 164 | + |
|
| 165 | + /** |
|
| 166 | + * Removes a personal root certificate from the users' trust store |
|
| 167 | + * |
|
| 168 | + * @param string $certificateIdentifier |
|
| 169 | + * @return DataResponse |
|
| 170 | + */ |
|
| 171 | + public function removeSystemRootCertificate($certificateIdentifier) { |
|
| 172 | + |
|
| 173 | + if ($this->isCertificateImportAllowed() === false) { |
|
| 174 | + return new DataResponse('Individual certificate management disabled', Http::STATUS_FORBIDDEN); |
|
| 175 | + } |
|
| 176 | + |
|
| 177 | + $this->systemCertificateManager->removeCertificate($certificateIdentifier); |
|
| 178 | + return new DataResponse(); |
|
| 179 | + } |
|
| 180 | 180 | } |
@@ -95,7 +95,7 @@ |
||
| 95 | 95 | * @param string $key |
| 96 | 96 | * @param mixed $value |
| 97 | 97 | * @param int $ttl |
| 98 | - * @return bool|mixed |
|
| 98 | + * @return boolean |
|
| 99 | 99 | * @throws \OC\ForbiddenException |
| 100 | 100 | */ |
| 101 | 101 | public function set($key, $value, $ttl = 0) { |
@@ -33,170 +33,170 @@ |
||
| 33 | 33 | |
| 34 | 34 | class File implements ICache { |
| 35 | 35 | |
| 36 | - /** @var View */ |
|
| 37 | - protected $storage; |
|
| 36 | + /** @var View */ |
|
| 37 | + protected $storage; |
|
| 38 | 38 | |
| 39 | - /** |
|
| 40 | - * Returns the cache storage for the logged in user |
|
| 41 | - * |
|
| 42 | - * @return \OC\Files\View cache storage |
|
| 43 | - * @throws \OC\ForbiddenException |
|
| 44 | - * @throws \OC\User\NoUserException |
|
| 45 | - */ |
|
| 46 | - protected function getStorage() { |
|
| 47 | - if (isset($this->storage)) { |
|
| 48 | - return $this->storage; |
|
| 49 | - } |
|
| 50 | - if (\OC_User::isLoggedIn()) { |
|
| 51 | - $rootView = new View(); |
|
| 52 | - $user = \OC::$server->getUserSession()->getUser(); |
|
| 53 | - Filesystem::initMountPoints($user->getUID()); |
|
| 54 | - if (!$rootView->file_exists('/' . $user->getUID() . '/cache')) { |
|
| 55 | - $rootView->mkdir('/' . $user->getUID() . '/cache'); |
|
| 56 | - } |
|
| 57 | - $this->storage = new View('/' . $user->getUID() . '/cache'); |
|
| 58 | - return $this->storage; |
|
| 59 | - } else { |
|
| 60 | - \OCP\Util::writeLog('core', 'Can\'t get cache storage, user not logged in', \OCP\Util::ERROR); |
|
| 61 | - throw new \OC\ForbiddenException('Can\t get cache storage, user not logged in'); |
|
| 62 | - } |
|
| 63 | - } |
|
| 39 | + /** |
|
| 40 | + * Returns the cache storage for the logged in user |
|
| 41 | + * |
|
| 42 | + * @return \OC\Files\View cache storage |
|
| 43 | + * @throws \OC\ForbiddenException |
|
| 44 | + * @throws \OC\User\NoUserException |
|
| 45 | + */ |
|
| 46 | + protected function getStorage() { |
|
| 47 | + if (isset($this->storage)) { |
|
| 48 | + return $this->storage; |
|
| 49 | + } |
|
| 50 | + if (\OC_User::isLoggedIn()) { |
|
| 51 | + $rootView = new View(); |
|
| 52 | + $user = \OC::$server->getUserSession()->getUser(); |
|
| 53 | + Filesystem::initMountPoints($user->getUID()); |
|
| 54 | + if (!$rootView->file_exists('/' . $user->getUID() . '/cache')) { |
|
| 55 | + $rootView->mkdir('/' . $user->getUID() . '/cache'); |
|
| 56 | + } |
|
| 57 | + $this->storage = new View('/' . $user->getUID() . '/cache'); |
|
| 58 | + return $this->storage; |
|
| 59 | + } else { |
|
| 60 | + \OCP\Util::writeLog('core', 'Can\'t get cache storage, user not logged in', \OCP\Util::ERROR); |
|
| 61 | + throw new \OC\ForbiddenException('Can\t get cache storage, user not logged in'); |
|
| 62 | + } |
|
| 63 | + } |
|
| 64 | 64 | |
| 65 | - /** |
|
| 66 | - * @param string $key |
|
| 67 | - * @return mixed|null |
|
| 68 | - * @throws \OC\ForbiddenException |
|
| 69 | - */ |
|
| 70 | - public function get($key) { |
|
| 71 | - $result = null; |
|
| 72 | - if ($this->hasKey($key)) { |
|
| 73 | - $storage = $this->getStorage(); |
|
| 74 | - $result = $storage->file_get_contents($key); |
|
| 75 | - } |
|
| 76 | - return $result; |
|
| 77 | - } |
|
| 65 | + /** |
|
| 66 | + * @param string $key |
|
| 67 | + * @return mixed|null |
|
| 68 | + * @throws \OC\ForbiddenException |
|
| 69 | + */ |
|
| 70 | + public function get($key) { |
|
| 71 | + $result = null; |
|
| 72 | + if ($this->hasKey($key)) { |
|
| 73 | + $storage = $this->getStorage(); |
|
| 74 | + $result = $storage->file_get_contents($key); |
|
| 75 | + } |
|
| 76 | + return $result; |
|
| 77 | + } |
|
| 78 | 78 | |
| 79 | - /** |
|
| 80 | - * Returns the size of the stored/cached data |
|
| 81 | - * |
|
| 82 | - * @param string $key |
|
| 83 | - * @return int |
|
| 84 | - */ |
|
| 85 | - public function size($key) { |
|
| 86 | - $result = 0; |
|
| 87 | - if ($this->hasKey($key)) { |
|
| 88 | - $storage = $this->getStorage(); |
|
| 89 | - $result = $storage->filesize($key); |
|
| 90 | - } |
|
| 91 | - return $result; |
|
| 92 | - } |
|
| 79 | + /** |
|
| 80 | + * Returns the size of the stored/cached data |
|
| 81 | + * |
|
| 82 | + * @param string $key |
|
| 83 | + * @return int |
|
| 84 | + */ |
|
| 85 | + public function size($key) { |
|
| 86 | + $result = 0; |
|
| 87 | + if ($this->hasKey($key)) { |
|
| 88 | + $storage = $this->getStorage(); |
|
| 89 | + $result = $storage->filesize($key); |
|
| 90 | + } |
|
| 91 | + return $result; |
|
| 92 | + } |
|
| 93 | 93 | |
| 94 | - /** |
|
| 95 | - * @param string $key |
|
| 96 | - * @param mixed $value |
|
| 97 | - * @param int $ttl |
|
| 98 | - * @return bool|mixed |
|
| 99 | - * @throws \OC\ForbiddenException |
|
| 100 | - */ |
|
| 101 | - public function set($key, $value, $ttl = 0) { |
|
| 102 | - $storage = $this->getStorage(); |
|
| 103 | - $result = false; |
|
| 104 | - // unique id to avoid chunk collision, just in case |
|
| 105 | - $uniqueId = \OC::$server->getSecureRandom()->generate( |
|
| 106 | - 16, |
|
| 107 | - ISecureRandom::CHAR_DIGITS . ISecureRandom::CHAR_LOWER . ISecureRandom::CHAR_UPPER |
|
| 108 | - ); |
|
| 94 | + /** |
|
| 95 | + * @param string $key |
|
| 96 | + * @param mixed $value |
|
| 97 | + * @param int $ttl |
|
| 98 | + * @return bool|mixed |
|
| 99 | + * @throws \OC\ForbiddenException |
|
| 100 | + */ |
|
| 101 | + public function set($key, $value, $ttl = 0) { |
|
| 102 | + $storage = $this->getStorage(); |
|
| 103 | + $result = false; |
|
| 104 | + // unique id to avoid chunk collision, just in case |
|
| 105 | + $uniqueId = \OC::$server->getSecureRandom()->generate( |
|
| 106 | + 16, |
|
| 107 | + ISecureRandom::CHAR_DIGITS . ISecureRandom::CHAR_LOWER . ISecureRandom::CHAR_UPPER |
|
| 108 | + ); |
|
| 109 | 109 | |
| 110 | - // use part file to prevent hasKey() to find the key |
|
| 111 | - // while it is being written |
|
| 112 | - $keyPart = $key . '.' . $uniqueId . '.part'; |
|
| 113 | - if ($storage and $storage->file_put_contents($keyPart, $value)) { |
|
| 114 | - if ($ttl === 0) { |
|
| 115 | - $ttl = 86400; // 60*60*24 |
|
| 116 | - } |
|
| 117 | - $result = $storage->touch($keyPart, time() + $ttl); |
|
| 118 | - $result &= $storage->rename($keyPart, $key); |
|
| 119 | - } |
|
| 120 | - return $result; |
|
| 121 | - } |
|
| 110 | + // use part file to prevent hasKey() to find the key |
|
| 111 | + // while it is being written |
|
| 112 | + $keyPart = $key . '.' . $uniqueId . '.part'; |
|
| 113 | + if ($storage and $storage->file_put_contents($keyPart, $value)) { |
|
| 114 | + if ($ttl === 0) { |
|
| 115 | + $ttl = 86400; // 60*60*24 |
|
| 116 | + } |
|
| 117 | + $result = $storage->touch($keyPart, time() + $ttl); |
|
| 118 | + $result &= $storage->rename($keyPart, $key); |
|
| 119 | + } |
|
| 120 | + return $result; |
|
| 121 | + } |
|
| 122 | 122 | |
| 123 | - /** |
|
| 124 | - * @param string $key |
|
| 125 | - * @return bool |
|
| 126 | - * @throws \OC\ForbiddenException |
|
| 127 | - */ |
|
| 128 | - public function hasKey($key) { |
|
| 129 | - $storage = $this->getStorage(); |
|
| 130 | - if ($storage && $storage->is_file($key) && $storage->isReadable($key)) { |
|
| 131 | - return true; |
|
| 132 | - } |
|
| 133 | - return false; |
|
| 134 | - } |
|
| 123 | + /** |
|
| 124 | + * @param string $key |
|
| 125 | + * @return bool |
|
| 126 | + * @throws \OC\ForbiddenException |
|
| 127 | + */ |
|
| 128 | + public function hasKey($key) { |
|
| 129 | + $storage = $this->getStorage(); |
|
| 130 | + if ($storage && $storage->is_file($key) && $storage->isReadable($key)) { |
|
| 131 | + return true; |
|
| 132 | + } |
|
| 133 | + return false; |
|
| 134 | + } |
|
| 135 | 135 | |
| 136 | - /** |
|
| 137 | - * @param string $key |
|
| 138 | - * @return bool|mixed |
|
| 139 | - * @throws \OC\ForbiddenException |
|
| 140 | - */ |
|
| 141 | - public function remove($key) { |
|
| 142 | - $storage = $this->getStorage(); |
|
| 143 | - if (!$storage) { |
|
| 144 | - return false; |
|
| 145 | - } |
|
| 146 | - return $storage->unlink($key); |
|
| 147 | - } |
|
| 136 | + /** |
|
| 137 | + * @param string $key |
|
| 138 | + * @return bool|mixed |
|
| 139 | + * @throws \OC\ForbiddenException |
|
| 140 | + */ |
|
| 141 | + public function remove($key) { |
|
| 142 | + $storage = $this->getStorage(); |
|
| 143 | + if (!$storage) { |
|
| 144 | + return false; |
|
| 145 | + } |
|
| 146 | + return $storage->unlink($key); |
|
| 147 | + } |
|
| 148 | 148 | |
| 149 | - /** |
|
| 150 | - * @param string $prefix |
|
| 151 | - * @return bool |
|
| 152 | - * @throws \OC\ForbiddenException |
|
| 153 | - */ |
|
| 154 | - public function clear($prefix = '') { |
|
| 155 | - $storage = $this->getStorage(); |
|
| 156 | - if ($storage and $storage->is_dir('/')) { |
|
| 157 | - $dh = $storage->opendir('/'); |
|
| 158 | - if (is_resource($dh)) { |
|
| 159 | - while (($file = readdir($dh)) !== false) { |
|
| 160 | - if ($file != '.' and $file != '..' and ($prefix === '' || strpos($file, $prefix) === 0)) { |
|
| 161 | - $storage->unlink('/' . $file); |
|
| 162 | - } |
|
| 163 | - } |
|
| 164 | - } |
|
| 165 | - } |
|
| 166 | - return true; |
|
| 167 | - } |
|
| 149 | + /** |
|
| 150 | + * @param string $prefix |
|
| 151 | + * @return bool |
|
| 152 | + * @throws \OC\ForbiddenException |
|
| 153 | + */ |
|
| 154 | + public function clear($prefix = '') { |
|
| 155 | + $storage = $this->getStorage(); |
|
| 156 | + if ($storage and $storage->is_dir('/')) { |
|
| 157 | + $dh = $storage->opendir('/'); |
|
| 158 | + if (is_resource($dh)) { |
|
| 159 | + while (($file = readdir($dh)) !== false) { |
|
| 160 | + if ($file != '.' and $file != '..' and ($prefix === '' || strpos($file, $prefix) === 0)) { |
|
| 161 | + $storage->unlink('/' . $file); |
|
| 162 | + } |
|
| 163 | + } |
|
| 164 | + } |
|
| 165 | + } |
|
| 166 | + return true; |
|
| 167 | + } |
|
| 168 | 168 | |
| 169 | - /** |
|
| 170 | - * Runs GC |
|
| 171 | - * @throws \OC\ForbiddenException |
|
| 172 | - */ |
|
| 173 | - public function gc() { |
|
| 174 | - $storage = $this->getStorage(); |
|
| 175 | - if ($storage and $storage->is_dir('/')) { |
|
| 176 | - // extra hour safety, in case of stray part chunks that take longer to write, |
|
| 177 | - // because touch() is only called after the chunk was finished |
|
| 178 | - $now = time() - 3600; |
|
| 179 | - $dh = $storage->opendir('/'); |
|
| 180 | - if (!is_resource($dh)) { |
|
| 181 | - return null; |
|
| 182 | - } |
|
| 183 | - while (($file = readdir($dh)) !== false) { |
|
| 184 | - if ($file != '.' and $file != '..') { |
|
| 185 | - try { |
|
| 186 | - $mtime = $storage->filemtime('/' . $file); |
|
| 187 | - if ($mtime < $now) { |
|
| 188 | - $storage->unlink('/' . $file); |
|
| 189 | - } |
|
| 190 | - } catch (\OCP\Lock\LockedException $e) { |
|
| 191 | - // ignore locked chunks |
|
| 192 | - \OC::$server->getLogger()->debug('Could not cleanup locked chunk "' . $file . '"', array('app' => 'core')); |
|
| 193 | - } catch (\OCP\Files\ForbiddenException $e) { |
|
| 194 | - \OC::$server->getLogger()->debug('Could not cleanup forbidden chunk "' . $file . '"', array('app' => 'core')); |
|
| 195 | - } catch (\OCP\Files\LockNotAcquiredException $e) { |
|
| 196 | - \OC::$server->getLogger()->debug('Could not cleanup locked chunk "' . $file . '"', array('app' => 'core')); |
|
| 197 | - } |
|
| 198 | - } |
|
| 199 | - } |
|
| 200 | - } |
|
| 201 | - } |
|
| 169 | + /** |
|
| 170 | + * Runs GC |
|
| 171 | + * @throws \OC\ForbiddenException |
|
| 172 | + */ |
|
| 173 | + public function gc() { |
|
| 174 | + $storage = $this->getStorage(); |
|
| 175 | + if ($storage and $storage->is_dir('/')) { |
|
| 176 | + // extra hour safety, in case of stray part chunks that take longer to write, |
|
| 177 | + // because touch() is only called after the chunk was finished |
|
| 178 | + $now = time() - 3600; |
|
| 179 | + $dh = $storage->opendir('/'); |
|
| 180 | + if (!is_resource($dh)) { |
|
| 181 | + return null; |
|
| 182 | + } |
|
| 183 | + while (($file = readdir($dh)) !== false) { |
|
| 184 | + if ($file != '.' and $file != '..') { |
|
| 185 | + try { |
|
| 186 | + $mtime = $storage->filemtime('/' . $file); |
|
| 187 | + if ($mtime < $now) { |
|
| 188 | + $storage->unlink('/' . $file); |
|
| 189 | + } |
|
| 190 | + } catch (\OCP\Lock\LockedException $e) { |
|
| 191 | + // ignore locked chunks |
|
| 192 | + \OC::$server->getLogger()->debug('Could not cleanup locked chunk "' . $file . '"', array('app' => 'core')); |
|
| 193 | + } catch (\OCP\Files\ForbiddenException $e) { |
|
| 194 | + \OC::$server->getLogger()->debug('Could not cleanup forbidden chunk "' . $file . '"', array('app' => 'core')); |
|
| 195 | + } catch (\OCP\Files\LockNotAcquiredException $e) { |
|
| 196 | + \OC::$server->getLogger()->debug('Could not cleanup locked chunk "' . $file . '"', array('app' => 'core')); |
|
| 197 | + } |
|
| 198 | + } |
|
| 199 | + } |
|
| 200 | + } |
|
| 201 | + } |
|
| 202 | 202 | } |
@@ -51,10 +51,10 @@ discard block |
||
| 51 | 51 | $rootView = new View(); |
| 52 | 52 | $user = \OC::$server->getUserSession()->getUser(); |
| 53 | 53 | Filesystem::initMountPoints($user->getUID()); |
| 54 | - if (!$rootView->file_exists('/' . $user->getUID() . '/cache')) { |
|
| 55 | - $rootView->mkdir('/' . $user->getUID() . '/cache'); |
|
| 54 | + if (!$rootView->file_exists('/'.$user->getUID().'/cache')) { |
|
| 55 | + $rootView->mkdir('/'.$user->getUID().'/cache'); |
|
| 56 | 56 | } |
| 57 | - $this->storage = new View('/' . $user->getUID() . '/cache'); |
|
| 57 | + $this->storage = new View('/'.$user->getUID().'/cache'); |
|
| 58 | 58 | return $this->storage; |
| 59 | 59 | } else { |
| 60 | 60 | \OCP\Util::writeLog('core', 'Can\'t get cache storage, user not logged in', \OCP\Util::ERROR); |
@@ -104,12 +104,12 @@ discard block |
||
| 104 | 104 | // unique id to avoid chunk collision, just in case |
| 105 | 105 | $uniqueId = \OC::$server->getSecureRandom()->generate( |
| 106 | 106 | 16, |
| 107 | - ISecureRandom::CHAR_DIGITS . ISecureRandom::CHAR_LOWER . ISecureRandom::CHAR_UPPER |
|
| 107 | + ISecureRandom::CHAR_DIGITS.ISecureRandom::CHAR_LOWER.ISecureRandom::CHAR_UPPER |
|
| 108 | 108 | ); |
| 109 | 109 | |
| 110 | 110 | // use part file to prevent hasKey() to find the key |
| 111 | 111 | // while it is being written |
| 112 | - $keyPart = $key . '.' . $uniqueId . '.part'; |
|
| 112 | + $keyPart = $key.'.'.$uniqueId.'.part'; |
|
| 113 | 113 | if ($storage and $storage->file_put_contents($keyPart, $value)) { |
| 114 | 114 | if ($ttl === 0) { |
| 115 | 115 | $ttl = 86400; // 60*60*24 |
@@ -158,7 +158,7 @@ discard block |
||
| 158 | 158 | if (is_resource($dh)) { |
| 159 | 159 | while (($file = readdir($dh)) !== false) { |
| 160 | 160 | if ($file != '.' and $file != '..' and ($prefix === '' || strpos($file, $prefix) === 0)) { |
| 161 | - $storage->unlink('/' . $file); |
|
| 161 | + $storage->unlink('/'.$file); |
|
| 162 | 162 | } |
| 163 | 163 | } |
| 164 | 164 | } |
@@ -183,17 +183,17 @@ discard block |
||
| 183 | 183 | while (($file = readdir($dh)) !== false) { |
| 184 | 184 | if ($file != '.' and $file != '..') { |
| 185 | 185 | try { |
| 186 | - $mtime = $storage->filemtime('/' . $file); |
|
| 186 | + $mtime = $storage->filemtime('/'.$file); |
|
| 187 | 187 | if ($mtime < $now) { |
| 188 | - $storage->unlink('/' . $file); |
|
| 188 | + $storage->unlink('/'.$file); |
|
| 189 | 189 | } |
| 190 | 190 | } catch (\OCP\Lock\LockedException $e) { |
| 191 | 191 | // ignore locked chunks |
| 192 | - \OC::$server->getLogger()->debug('Could not cleanup locked chunk "' . $file . '"', array('app' => 'core')); |
|
| 192 | + \OC::$server->getLogger()->debug('Could not cleanup locked chunk "'.$file.'"', array('app' => 'core')); |
|
| 193 | 193 | } catch (\OCP\Files\ForbiddenException $e) { |
| 194 | - \OC::$server->getLogger()->debug('Could not cleanup forbidden chunk "' . $file . '"', array('app' => 'core')); |
|
| 194 | + \OC::$server->getLogger()->debug('Could not cleanup forbidden chunk "'.$file.'"', array('app' => 'core')); |
|
| 195 | 195 | } catch (\OCP\Files\LockNotAcquiredException $e) { |
| 196 | - \OC::$server->getLogger()->debug('Could not cleanup locked chunk "' . $file . '"', array('app' => 'core')); |
|
| 196 | + \OC::$server->getLogger()->debug('Could not cleanup locked chunk "'.$file.'"', array('app' => 'core')); |
|
| 197 | 197 | } |
| 198 | 198 | } |
| 199 | 199 | } |
@@ -132,7 +132,7 @@ |
||
| 132 | 132 | } |
| 133 | 133 | |
| 134 | 134 | /** |
| 135 | - * @param $message |
|
| 135 | + * @param string $message |
|
| 136 | 136 | * @param array $additional |
| 137 | 137 | * @return array |
| 138 | 138 | */ |
@@ -30,7 +30,6 @@ |
||
| 30 | 30 | |
| 31 | 31 | namespace OC\Core\Controller; |
| 32 | 32 | |
| 33 | -use OCA\Encryption\Exceptions\PrivateKeyMissingException; |
|
| 34 | 33 | use \OCP\AppFramework\Controller; |
| 35 | 34 | use \OCP\AppFramework\Http\TemplateResponse; |
| 36 | 35 | use OCP\AppFramework\Utility\ITimeFactory; |
@@ -53,256 +53,256 @@ |
||
| 53 | 53 | */ |
| 54 | 54 | class LostController extends Controller { |
| 55 | 55 | |
| 56 | - /** @var IURLGenerator */ |
|
| 57 | - protected $urlGenerator; |
|
| 58 | - /** @var IUserManager */ |
|
| 59 | - protected $userManager; |
|
| 60 | - /** @var \OC_Defaults */ |
|
| 61 | - protected $defaults; |
|
| 62 | - /** @var IL10N */ |
|
| 63 | - protected $l10n; |
|
| 64 | - /** @var string */ |
|
| 65 | - protected $from; |
|
| 66 | - /** @var IManager */ |
|
| 67 | - protected $encryptionManager; |
|
| 68 | - /** @var IConfig */ |
|
| 69 | - protected $config; |
|
| 70 | - /** @var ISecureRandom */ |
|
| 71 | - protected $secureRandom; |
|
| 72 | - /** @var IMailer */ |
|
| 73 | - protected $mailer; |
|
| 74 | - /** @var ITimeFactory */ |
|
| 75 | - protected $timeFactory; |
|
| 76 | - /** @var ICrypto */ |
|
| 77 | - protected $crypto; |
|
| 56 | + /** @var IURLGenerator */ |
|
| 57 | + protected $urlGenerator; |
|
| 58 | + /** @var IUserManager */ |
|
| 59 | + protected $userManager; |
|
| 60 | + /** @var \OC_Defaults */ |
|
| 61 | + protected $defaults; |
|
| 62 | + /** @var IL10N */ |
|
| 63 | + protected $l10n; |
|
| 64 | + /** @var string */ |
|
| 65 | + protected $from; |
|
| 66 | + /** @var IManager */ |
|
| 67 | + protected $encryptionManager; |
|
| 68 | + /** @var IConfig */ |
|
| 69 | + protected $config; |
|
| 70 | + /** @var ISecureRandom */ |
|
| 71 | + protected $secureRandom; |
|
| 72 | + /** @var IMailer */ |
|
| 73 | + protected $mailer; |
|
| 74 | + /** @var ITimeFactory */ |
|
| 75 | + protected $timeFactory; |
|
| 76 | + /** @var ICrypto */ |
|
| 77 | + protected $crypto; |
|
| 78 | 78 | |
| 79 | - /** |
|
| 80 | - * @param string $appName |
|
| 81 | - * @param IRequest $request |
|
| 82 | - * @param IURLGenerator $urlGenerator |
|
| 83 | - * @param IUserManager $userManager |
|
| 84 | - * @param \OC_Defaults $defaults |
|
| 85 | - * @param IL10N $l10n |
|
| 86 | - * @param IConfig $config |
|
| 87 | - * @param ISecureRandom $secureRandom |
|
| 88 | - * @param string $defaultMailAddress |
|
| 89 | - * @param IManager $encryptionManager |
|
| 90 | - * @param IMailer $mailer |
|
| 91 | - * @param ITimeFactory $timeFactory |
|
| 92 | - * @param ICrypto $crypto |
|
| 93 | - */ |
|
| 94 | - public function __construct($appName, |
|
| 95 | - IRequest $request, |
|
| 96 | - IURLGenerator $urlGenerator, |
|
| 97 | - IUserManager $userManager, |
|
| 98 | - \OC_Defaults $defaults, |
|
| 99 | - IL10N $l10n, |
|
| 100 | - IConfig $config, |
|
| 101 | - ISecureRandom $secureRandom, |
|
| 102 | - $defaultMailAddress, |
|
| 103 | - IManager $encryptionManager, |
|
| 104 | - IMailer $mailer, |
|
| 105 | - ITimeFactory $timeFactory, |
|
| 106 | - ICrypto $crypto) { |
|
| 107 | - parent::__construct($appName, $request); |
|
| 108 | - $this->urlGenerator = $urlGenerator; |
|
| 109 | - $this->userManager = $userManager; |
|
| 110 | - $this->defaults = $defaults; |
|
| 111 | - $this->l10n = $l10n; |
|
| 112 | - $this->secureRandom = $secureRandom; |
|
| 113 | - $this->from = $defaultMailAddress; |
|
| 114 | - $this->encryptionManager = $encryptionManager; |
|
| 115 | - $this->config = $config; |
|
| 116 | - $this->mailer = $mailer; |
|
| 117 | - $this->timeFactory = $timeFactory; |
|
| 118 | - $this->crypto = $crypto; |
|
| 119 | - } |
|
| 79 | + /** |
|
| 80 | + * @param string $appName |
|
| 81 | + * @param IRequest $request |
|
| 82 | + * @param IURLGenerator $urlGenerator |
|
| 83 | + * @param IUserManager $userManager |
|
| 84 | + * @param \OC_Defaults $defaults |
|
| 85 | + * @param IL10N $l10n |
|
| 86 | + * @param IConfig $config |
|
| 87 | + * @param ISecureRandom $secureRandom |
|
| 88 | + * @param string $defaultMailAddress |
|
| 89 | + * @param IManager $encryptionManager |
|
| 90 | + * @param IMailer $mailer |
|
| 91 | + * @param ITimeFactory $timeFactory |
|
| 92 | + * @param ICrypto $crypto |
|
| 93 | + */ |
|
| 94 | + public function __construct($appName, |
|
| 95 | + IRequest $request, |
|
| 96 | + IURLGenerator $urlGenerator, |
|
| 97 | + IUserManager $userManager, |
|
| 98 | + \OC_Defaults $defaults, |
|
| 99 | + IL10N $l10n, |
|
| 100 | + IConfig $config, |
|
| 101 | + ISecureRandom $secureRandom, |
|
| 102 | + $defaultMailAddress, |
|
| 103 | + IManager $encryptionManager, |
|
| 104 | + IMailer $mailer, |
|
| 105 | + ITimeFactory $timeFactory, |
|
| 106 | + ICrypto $crypto) { |
|
| 107 | + parent::__construct($appName, $request); |
|
| 108 | + $this->urlGenerator = $urlGenerator; |
|
| 109 | + $this->userManager = $userManager; |
|
| 110 | + $this->defaults = $defaults; |
|
| 111 | + $this->l10n = $l10n; |
|
| 112 | + $this->secureRandom = $secureRandom; |
|
| 113 | + $this->from = $defaultMailAddress; |
|
| 114 | + $this->encryptionManager = $encryptionManager; |
|
| 115 | + $this->config = $config; |
|
| 116 | + $this->mailer = $mailer; |
|
| 117 | + $this->timeFactory = $timeFactory; |
|
| 118 | + $this->crypto = $crypto; |
|
| 119 | + } |
|
| 120 | 120 | |
| 121 | - /** |
|
| 122 | - * Someone wants to reset their password: |
|
| 123 | - * |
|
| 124 | - * @PublicPage |
|
| 125 | - * @NoCSRFRequired |
|
| 126 | - * |
|
| 127 | - * @param string $token |
|
| 128 | - * @param string $userId |
|
| 129 | - * @return TemplateResponse |
|
| 130 | - */ |
|
| 131 | - public function resetform($token, $userId) { |
|
| 132 | - try { |
|
| 133 | - $this->checkPasswordResetToken($token, $userId); |
|
| 134 | - } catch (\Exception $e) { |
|
| 135 | - return new TemplateResponse( |
|
| 136 | - 'core', 'error', [ |
|
| 137 | - "errors" => array(array("error" => $e->getMessage())) |
|
| 138 | - ], |
|
| 139 | - 'guest' |
|
| 140 | - ); |
|
| 141 | - } |
|
| 121 | + /** |
|
| 122 | + * Someone wants to reset their password: |
|
| 123 | + * |
|
| 124 | + * @PublicPage |
|
| 125 | + * @NoCSRFRequired |
|
| 126 | + * |
|
| 127 | + * @param string $token |
|
| 128 | + * @param string $userId |
|
| 129 | + * @return TemplateResponse |
|
| 130 | + */ |
|
| 131 | + public function resetform($token, $userId) { |
|
| 132 | + try { |
|
| 133 | + $this->checkPasswordResetToken($token, $userId); |
|
| 134 | + } catch (\Exception $e) { |
|
| 135 | + return new TemplateResponse( |
|
| 136 | + 'core', 'error', [ |
|
| 137 | + "errors" => array(array("error" => $e->getMessage())) |
|
| 138 | + ], |
|
| 139 | + 'guest' |
|
| 140 | + ); |
|
| 141 | + } |
|
| 142 | 142 | |
| 143 | - return new TemplateResponse( |
|
| 144 | - 'core', |
|
| 145 | - 'lostpassword/resetpassword', |
|
| 146 | - array( |
|
| 147 | - 'link' => $this->urlGenerator->linkToRouteAbsolute('core.lost.setPassword', array('userId' => $userId, 'token' => $token)), |
|
| 148 | - ), |
|
| 149 | - 'guest' |
|
| 150 | - ); |
|
| 151 | - } |
|
| 143 | + return new TemplateResponse( |
|
| 144 | + 'core', |
|
| 145 | + 'lostpassword/resetpassword', |
|
| 146 | + array( |
|
| 147 | + 'link' => $this->urlGenerator->linkToRouteAbsolute('core.lost.setPassword', array('userId' => $userId, 'token' => $token)), |
|
| 148 | + ), |
|
| 149 | + 'guest' |
|
| 150 | + ); |
|
| 151 | + } |
|
| 152 | 152 | |
| 153 | - /** |
|
| 154 | - * @param string $token |
|
| 155 | - * @param string $userId |
|
| 156 | - * @throws \Exception |
|
| 157 | - */ |
|
| 158 | - protected function checkPasswordResetToken($token, $userId) { |
|
| 159 | - $user = $this->userManager->get($userId); |
|
| 160 | - if($user === null) { |
|
| 161 | - throw new \Exception($this->l10n->t('Couldn\'t reset password because the token is invalid')); |
|
| 162 | - } |
|
| 153 | + /** |
|
| 154 | + * @param string $token |
|
| 155 | + * @param string $userId |
|
| 156 | + * @throws \Exception |
|
| 157 | + */ |
|
| 158 | + protected function checkPasswordResetToken($token, $userId) { |
|
| 159 | + $user = $this->userManager->get($userId); |
|
| 160 | + if($user === null) { |
|
| 161 | + throw new \Exception($this->l10n->t('Couldn\'t reset password because the token is invalid')); |
|
| 162 | + } |
|
| 163 | 163 | |
| 164 | - try { |
|
| 165 | - $encryptedToken = $this->config->getUserValue($userId, 'core', 'lostpassword', null); |
|
| 166 | - $mailAddress = !is_null($user->getEMailAddress()) ? $user->getEMailAddress() : ''; |
|
| 167 | - $decryptedToken = $this->crypto->decrypt($encryptedToken, $mailAddress.$this->config->getSystemValue('secret')); |
|
| 168 | - } catch (\Exception $e) { |
|
| 169 | - throw new \Exception($this->l10n->t('Couldn\'t reset password because the token is invalid')); |
|
| 170 | - } |
|
| 164 | + try { |
|
| 165 | + $encryptedToken = $this->config->getUserValue($userId, 'core', 'lostpassword', null); |
|
| 166 | + $mailAddress = !is_null($user->getEMailAddress()) ? $user->getEMailAddress() : ''; |
|
| 167 | + $decryptedToken = $this->crypto->decrypt($encryptedToken, $mailAddress.$this->config->getSystemValue('secret')); |
|
| 168 | + } catch (\Exception $e) { |
|
| 169 | + throw new \Exception($this->l10n->t('Couldn\'t reset password because the token is invalid')); |
|
| 170 | + } |
|
| 171 | 171 | |
| 172 | - $splittedToken = explode(':', $decryptedToken); |
|
| 173 | - if(count($splittedToken) !== 2) { |
|
| 174 | - throw new \Exception($this->l10n->t('Couldn\'t reset password because the token is invalid')); |
|
| 175 | - } |
|
| 172 | + $splittedToken = explode(':', $decryptedToken); |
|
| 173 | + if(count($splittedToken) !== 2) { |
|
| 174 | + throw new \Exception($this->l10n->t('Couldn\'t reset password because the token is invalid')); |
|
| 175 | + } |
|
| 176 | 176 | |
| 177 | - if ($splittedToken[0] < ($this->timeFactory->getTime() - 60*60*12) || |
|
| 178 | - $user->getLastLogin() > $splittedToken[0]) { |
|
| 179 | - throw new \Exception($this->l10n->t('Couldn\'t reset password because the token is expired')); |
|
| 180 | - } |
|
| 177 | + if ($splittedToken[0] < ($this->timeFactory->getTime() - 60*60*12) || |
|
| 178 | + $user->getLastLogin() > $splittedToken[0]) { |
|
| 179 | + throw new \Exception($this->l10n->t('Couldn\'t reset password because the token is expired')); |
|
| 180 | + } |
|
| 181 | 181 | |
| 182 | - if (!hash_equals($splittedToken[1], $token)) { |
|
| 183 | - throw new \Exception($this->l10n->t('Couldn\'t reset password because the token is invalid')); |
|
| 184 | - } |
|
| 185 | - } |
|
| 182 | + if (!hash_equals($splittedToken[1], $token)) { |
|
| 183 | + throw new \Exception($this->l10n->t('Couldn\'t reset password because the token is invalid')); |
|
| 184 | + } |
|
| 185 | + } |
|
| 186 | 186 | |
| 187 | - /** |
|
| 188 | - * @param $message |
|
| 189 | - * @param array $additional |
|
| 190 | - * @return array |
|
| 191 | - */ |
|
| 192 | - private function error($message, array $additional=array()) { |
|
| 193 | - return array_merge(array('status' => 'error', 'msg' => $message), $additional); |
|
| 194 | - } |
|
| 187 | + /** |
|
| 188 | + * @param $message |
|
| 189 | + * @param array $additional |
|
| 190 | + * @return array |
|
| 191 | + */ |
|
| 192 | + private function error($message, array $additional=array()) { |
|
| 193 | + return array_merge(array('status' => 'error', 'msg' => $message), $additional); |
|
| 194 | + } |
|
| 195 | 195 | |
| 196 | - /** |
|
| 197 | - * @return array |
|
| 198 | - */ |
|
| 199 | - private function success() { |
|
| 200 | - return array('status'=>'success'); |
|
| 201 | - } |
|
| 196 | + /** |
|
| 197 | + * @return array |
|
| 198 | + */ |
|
| 199 | + private function success() { |
|
| 200 | + return array('status'=>'success'); |
|
| 201 | + } |
|
| 202 | 202 | |
| 203 | - /** |
|
| 204 | - * @PublicPage |
|
| 205 | - * @BruteForceProtection passwordResetEmail |
|
| 206 | - * |
|
| 207 | - * @param string $user |
|
| 208 | - * @return array |
|
| 209 | - */ |
|
| 210 | - public function email($user){ |
|
| 211 | - // FIXME: use HTTP error codes |
|
| 212 | - try { |
|
| 213 | - $this->sendEmail($user); |
|
| 214 | - } catch (\Exception $e){ |
|
| 215 | - return $this->error($e->getMessage()); |
|
| 216 | - } |
|
| 203 | + /** |
|
| 204 | + * @PublicPage |
|
| 205 | + * @BruteForceProtection passwordResetEmail |
|
| 206 | + * |
|
| 207 | + * @param string $user |
|
| 208 | + * @return array |
|
| 209 | + */ |
|
| 210 | + public function email($user){ |
|
| 211 | + // FIXME: use HTTP error codes |
|
| 212 | + try { |
|
| 213 | + $this->sendEmail($user); |
|
| 214 | + } catch (\Exception $e){ |
|
| 215 | + return $this->error($e->getMessage()); |
|
| 216 | + } |
|
| 217 | 217 | |
| 218 | - return $this->success(); |
|
| 219 | - } |
|
| 218 | + return $this->success(); |
|
| 219 | + } |
|
| 220 | 220 | |
| 221 | - /** |
|
| 222 | - * @PublicPage |
|
| 223 | - * @param string $token |
|
| 224 | - * @param string $userId |
|
| 225 | - * @param string $password |
|
| 226 | - * @param boolean $proceed |
|
| 227 | - * @return array |
|
| 228 | - */ |
|
| 229 | - public function setPassword($token, $userId, $password, $proceed) { |
|
| 230 | - if ($this->encryptionManager->isEnabled() && !$proceed) { |
|
| 231 | - return $this->error('', array('encryption' => true)); |
|
| 232 | - } |
|
| 221 | + /** |
|
| 222 | + * @PublicPage |
|
| 223 | + * @param string $token |
|
| 224 | + * @param string $userId |
|
| 225 | + * @param string $password |
|
| 226 | + * @param boolean $proceed |
|
| 227 | + * @return array |
|
| 228 | + */ |
|
| 229 | + public function setPassword($token, $userId, $password, $proceed) { |
|
| 230 | + if ($this->encryptionManager->isEnabled() && !$proceed) { |
|
| 231 | + return $this->error('', array('encryption' => true)); |
|
| 232 | + } |
|
| 233 | 233 | |
| 234 | - try { |
|
| 235 | - $this->checkPasswordResetToken($token, $userId); |
|
| 236 | - $user = $this->userManager->get($userId); |
|
| 234 | + try { |
|
| 235 | + $this->checkPasswordResetToken($token, $userId); |
|
| 236 | + $user = $this->userManager->get($userId); |
|
| 237 | 237 | |
| 238 | - \OC_Hook::emit('\OC\Core\LostPassword\Controller\LostController', 'pre_passwordReset', array('uid' => $userId, 'password' => $password)); |
|
| 238 | + \OC_Hook::emit('\OC\Core\LostPassword\Controller\LostController', 'pre_passwordReset', array('uid' => $userId, 'password' => $password)); |
|
| 239 | 239 | |
| 240 | - if (!$user->setPassword($password)) { |
|
| 241 | - throw new \Exception(); |
|
| 242 | - } |
|
| 240 | + if (!$user->setPassword($password)) { |
|
| 241 | + throw new \Exception(); |
|
| 242 | + } |
|
| 243 | 243 | |
| 244 | - \OC_Hook::emit('\OC\Core\LostPassword\Controller\LostController', 'post_passwordReset', array('uid' => $userId, 'password' => $password)); |
|
| 244 | + \OC_Hook::emit('\OC\Core\LostPassword\Controller\LostController', 'post_passwordReset', array('uid' => $userId, 'password' => $password)); |
|
| 245 | 245 | |
| 246 | - $this->config->deleteUserValue($userId, 'core', 'lostpassword'); |
|
| 247 | - @\OC_User::unsetMagicInCookie(); |
|
| 248 | - } catch (\Exception $e){ |
|
| 249 | - return $this->error($e->getMessage()); |
|
| 250 | - } |
|
| 246 | + $this->config->deleteUserValue($userId, 'core', 'lostpassword'); |
|
| 247 | + @\OC_User::unsetMagicInCookie(); |
|
| 248 | + } catch (\Exception $e){ |
|
| 249 | + return $this->error($e->getMessage()); |
|
| 250 | + } |
|
| 251 | 251 | |
| 252 | - return $this->success(); |
|
| 253 | - } |
|
| 252 | + return $this->success(); |
|
| 253 | + } |
|
| 254 | 254 | |
| 255 | - /** |
|
| 256 | - * @param string $user |
|
| 257 | - * @throws \Exception |
|
| 258 | - */ |
|
| 259 | - protected function sendEmail($user) { |
|
| 260 | - if (!$this->userManager->userExists($user)) { |
|
| 261 | - throw new \Exception($this->l10n->t('Couldn\'t send reset email. Please make sure your username is correct.')); |
|
| 262 | - } |
|
| 255 | + /** |
|
| 256 | + * @param string $user |
|
| 257 | + * @throws \Exception |
|
| 258 | + */ |
|
| 259 | + protected function sendEmail($user) { |
|
| 260 | + if (!$this->userManager->userExists($user)) { |
|
| 261 | + throw new \Exception($this->l10n->t('Couldn\'t send reset email. Please make sure your username is correct.')); |
|
| 262 | + } |
|
| 263 | 263 | |
| 264 | - $userObject = $this->userManager->get($user); |
|
| 265 | - $email = $userObject->getEMailAddress(); |
|
| 264 | + $userObject = $this->userManager->get($user); |
|
| 265 | + $email = $userObject->getEMailAddress(); |
|
| 266 | 266 | |
| 267 | - if (empty($email)) { |
|
| 268 | - throw new \Exception( |
|
| 269 | - $this->l10n->t('Could not send reset email because there is no email address for this username. Please contact your administrator.') |
|
| 270 | - ); |
|
| 271 | - } |
|
| 267 | + if (empty($email)) { |
|
| 268 | + throw new \Exception( |
|
| 269 | + $this->l10n->t('Could not send reset email because there is no email address for this username. Please contact your administrator.') |
|
| 270 | + ); |
|
| 271 | + } |
|
| 272 | 272 | |
| 273 | - // Generate the token. It is stored encrypted in the database with the |
|
| 274 | - // secret being the users' email address appended with the system secret. |
|
| 275 | - // This makes the token automatically invalidate once the user changes |
|
| 276 | - // their email address. |
|
| 277 | - $token = $this->secureRandom->generate( |
|
| 278 | - 21, |
|
| 279 | - ISecureRandom::CHAR_DIGITS. |
|
| 280 | - ISecureRandom::CHAR_LOWER. |
|
| 281 | - ISecureRandom::CHAR_UPPER |
|
| 282 | - ); |
|
| 283 | - $tokenValue = $this->timeFactory->getTime() .':'. $token; |
|
| 284 | - $mailAddress = !is_null($userObject->getEMailAddress()) ? $userObject->getEMailAddress() : ''; |
|
| 285 | - $encryptedValue = $this->crypto->encrypt($tokenValue, $mailAddress.$this->config->getSystemValue('secret')); |
|
| 286 | - $this->config->setUserValue($user, 'core', 'lostpassword', $encryptedValue); |
|
| 273 | + // Generate the token. It is stored encrypted in the database with the |
|
| 274 | + // secret being the users' email address appended with the system secret. |
|
| 275 | + // This makes the token automatically invalidate once the user changes |
|
| 276 | + // their email address. |
|
| 277 | + $token = $this->secureRandom->generate( |
|
| 278 | + 21, |
|
| 279 | + ISecureRandom::CHAR_DIGITS. |
|
| 280 | + ISecureRandom::CHAR_LOWER. |
|
| 281 | + ISecureRandom::CHAR_UPPER |
|
| 282 | + ); |
|
| 283 | + $tokenValue = $this->timeFactory->getTime() .':'. $token; |
|
| 284 | + $mailAddress = !is_null($userObject->getEMailAddress()) ? $userObject->getEMailAddress() : ''; |
|
| 285 | + $encryptedValue = $this->crypto->encrypt($tokenValue, $mailAddress.$this->config->getSystemValue('secret')); |
|
| 286 | + $this->config->setUserValue($user, 'core', 'lostpassword', $encryptedValue); |
|
| 287 | 287 | |
| 288 | - $link = $this->urlGenerator->linkToRouteAbsolute('core.lost.resetform', array('userId' => $user, 'token' => $token)); |
|
| 288 | + $link = $this->urlGenerator->linkToRouteAbsolute('core.lost.resetform', array('userId' => $user, 'token' => $token)); |
|
| 289 | 289 | |
| 290 | - $tmpl = new \OC_Template('core', 'lostpassword/email'); |
|
| 291 | - $tmpl->assign('link', $link); |
|
| 292 | - $msg = $tmpl->fetchPage(); |
|
| 290 | + $tmpl = new \OC_Template('core', 'lostpassword/email'); |
|
| 291 | + $tmpl->assign('link', $link); |
|
| 292 | + $msg = $tmpl->fetchPage(); |
|
| 293 | 293 | |
| 294 | - try { |
|
| 295 | - $message = $this->mailer->createMessage(); |
|
| 296 | - $message->setTo([$email => $user]); |
|
| 297 | - $message->setSubject($this->l10n->t('%s password reset', [$this->defaults->getName()])); |
|
| 298 | - $message->setPlainBody($msg); |
|
| 299 | - $message->setFrom([$this->from => $this->defaults->getName()]); |
|
| 300 | - $this->mailer->send($message); |
|
| 301 | - } catch (\Exception $e) { |
|
| 302 | - throw new \Exception($this->l10n->t( |
|
| 303 | - 'Couldn\'t send reset email. Please contact your administrator.' |
|
| 304 | - )); |
|
| 305 | - } |
|
| 306 | - } |
|
| 294 | + try { |
|
| 295 | + $message = $this->mailer->createMessage(); |
|
| 296 | + $message->setTo([$email => $user]); |
|
| 297 | + $message->setSubject($this->l10n->t('%s password reset', [$this->defaults->getName()])); |
|
| 298 | + $message->setPlainBody($msg); |
|
| 299 | + $message->setFrom([$this->from => $this->defaults->getName()]); |
|
| 300 | + $this->mailer->send($message); |
|
| 301 | + } catch (\Exception $e) { |
|
| 302 | + throw new \Exception($this->l10n->t( |
|
| 303 | + 'Couldn\'t send reset email. Please contact your administrator.' |
|
| 304 | + )); |
|
| 305 | + } |
|
| 306 | + } |
|
| 307 | 307 | |
| 308 | 308 | } |
@@ -157,7 +157,7 @@ discard block |
||
| 157 | 157 | */ |
| 158 | 158 | protected function checkPasswordResetToken($token, $userId) { |
| 159 | 159 | $user = $this->userManager->get($userId); |
| 160 | - if($user === null) { |
|
| 160 | + if ($user === null) { |
|
| 161 | 161 | throw new \Exception($this->l10n->t('Couldn\'t reset password because the token is invalid')); |
| 162 | 162 | } |
| 163 | 163 | |
@@ -170,11 +170,11 @@ discard block |
||
| 170 | 170 | } |
| 171 | 171 | |
| 172 | 172 | $splittedToken = explode(':', $decryptedToken); |
| 173 | - if(count($splittedToken) !== 2) { |
|
| 173 | + if (count($splittedToken) !== 2) { |
|
| 174 | 174 | throw new \Exception($this->l10n->t('Couldn\'t reset password because the token is invalid')); |
| 175 | 175 | } |
| 176 | 176 | |
| 177 | - if ($splittedToken[0] < ($this->timeFactory->getTime() - 60*60*12) || |
|
| 177 | + if ($splittedToken[0] < ($this->timeFactory->getTime() - 60 * 60 * 12) || |
|
| 178 | 178 | $user->getLastLogin() > $splittedToken[0]) { |
| 179 | 179 | throw new \Exception($this->l10n->t('Couldn\'t reset password because the token is expired')); |
| 180 | 180 | } |
@@ -189,7 +189,7 @@ discard block |
||
| 189 | 189 | * @param array $additional |
| 190 | 190 | * @return array |
| 191 | 191 | */ |
| 192 | - private function error($message, array $additional=array()) { |
|
| 192 | + private function error($message, array $additional = array()) { |
|
| 193 | 193 | return array_merge(array('status' => 'error', 'msg' => $message), $additional); |
| 194 | 194 | } |
| 195 | 195 | |
@@ -207,11 +207,11 @@ discard block |
||
| 207 | 207 | * @param string $user |
| 208 | 208 | * @return array |
| 209 | 209 | */ |
| 210 | - public function email($user){ |
|
| 210 | + public function email($user) { |
|
| 211 | 211 | // FIXME: use HTTP error codes |
| 212 | 212 | try { |
| 213 | 213 | $this->sendEmail($user); |
| 214 | - } catch (\Exception $e){ |
|
| 214 | + } catch (\Exception $e) { |
|
| 215 | 215 | return $this->error($e->getMessage()); |
| 216 | 216 | } |
| 217 | 217 | |
@@ -245,7 +245,7 @@ discard block |
||
| 245 | 245 | |
| 246 | 246 | $this->config->deleteUserValue($userId, 'core', 'lostpassword'); |
| 247 | 247 | @\OC_User::unsetMagicInCookie(); |
| 248 | - } catch (\Exception $e){ |
|
| 248 | + } catch (\Exception $e) { |
|
| 249 | 249 | return $this->error($e->getMessage()); |
| 250 | 250 | } |
| 251 | 251 | |
@@ -280,7 +280,7 @@ discard block |
||
| 280 | 280 | ISecureRandom::CHAR_LOWER. |
| 281 | 281 | ISecureRandom::CHAR_UPPER |
| 282 | 282 | ); |
| 283 | - $tokenValue = $this->timeFactory->getTime() .':'. $token; |
|
| 283 | + $tokenValue = $this->timeFactory->getTime().':'.$token; |
|
| 284 | 284 | $mailAddress = !is_null($userObject->getEMailAddress()) ? $userObject->getEMailAddress() : ''; |
| 285 | 285 | $encryptedValue = $this->crypto->encrypt($tokenValue, $mailAddress.$this->config->getSystemValue('secret')); |
| 286 | 286 | $this->config->setUserValue($user, 'core', 'lostpassword', $encryptedValue); |
@@ -361,7 +361,7 @@ discard block |
||
| 361 | 361 | |
| 362 | 362 | /** |
| 363 | 363 | * returns the internal ownCloud name for the given LDAP DN of the user, false on DN outside of search DN or failure |
| 364 | - * @param string $dn the dn of the user object |
|
| 364 | + * @param string $fdn the dn of the user object |
|
| 365 | 365 | * @param string $ldapName optional, the display name of the object |
| 366 | 366 | * @return string|false with with the name to use in ownCloud |
| 367 | 367 | */ |
@@ -378,7 +378,7 @@ discard block |
||
| 378 | 378 | |
| 379 | 379 | /** |
| 380 | 380 | * returns an internal ownCloud name for the given LDAP DN, false on DN outside of search DN |
| 381 | - * @param string $dn the dn of the user object |
|
| 381 | + * @param string $fdn the dn of the user object |
|
| 382 | 382 | * @param string $ldapName optional, the display name of the object |
| 383 | 383 | * @param bool $isUser optional, whether it is a user object (otherwise group assumed) |
| 384 | 384 | * @return string|false with with the name to use in ownCloud |
@@ -638,7 +638,7 @@ discard block |
||
| 638 | 638 | * the login filter. |
| 639 | 639 | * |
| 640 | 640 | * @param string $loginName |
| 641 | - * @param array $attributes optional, list of attributes to read |
|
| 641 | + * @param string[] $attributes optional, list of attributes to read |
|
| 642 | 642 | * @return array |
| 643 | 643 | */ |
| 644 | 644 | public function fetchUsersByLoginName($loginName, $attributes = array('dn')) { |
@@ -711,7 +711,7 @@ discard block |
||
| 711 | 711 | |
| 712 | 712 | /** |
| 713 | 713 | * @param string $filter |
| 714 | - * @param string|string[] $attr |
|
| 714 | + * @param string[] $attr |
|
| 715 | 715 | * @param int $limit |
| 716 | 716 | * @param int $offset |
| 717 | 717 | * @return array |
@@ -759,7 +759,7 @@ discard block |
||
| 759 | 759 | |
| 760 | 760 | /** |
| 761 | 761 | * @param string $filter |
| 762 | - * @param string|string[] $attr |
|
| 762 | + * @param string[] $attr |
|
| 763 | 763 | * @param int $limit |
| 764 | 764 | * @param int $offset |
| 765 | 765 | * @return false|int |
@@ -809,6 +809,7 @@ discard block |
||
| 809 | 809 | * retrieved. Results will according to the order in the array. |
| 810 | 810 | * @param int $limit optional, maximum results to be counted |
| 811 | 811 | * @param int $offset optional, a starting point |
| 812 | + * @param string $filter |
|
| 812 | 813 | * @return array|false array with the search result as first value and pagedSearchOK as |
| 813 | 814 | * second | false if not successful |
| 814 | 815 | */ |
@@ -1063,7 +1064,7 @@ discard block |
||
| 1063 | 1064 | |
| 1064 | 1065 | /** |
| 1065 | 1066 | * @param string $name |
| 1066 | - * @return bool|mixed|string |
|
| 1067 | + * @return string |
|
| 1067 | 1068 | */ |
| 1068 | 1069 | public function sanitizeUsername($name) { |
| 1069 | 1070 | if($this->connection->ldapIgnoreNamingRules) { |
@@ -1087,6 +1088,7 @@ discard block |
||
| 1087 | 1088 | * escapes (user provided) parts for LDAP filter |
| 1088 | 1089 | * @param string $input, the provided value |
| 1089 | 1090 | * @param bool $allowAsterisk whether in * at the beginning should be preserved |
| 1091 | + * @param string $input |
|
| 1090 | 1092 | * @return string the escaped string |
| 1091 | 1093 | */ |
| 1092 | 1094 | public function escapeFilterPart($input, $allowAsterisk = false) { |
@@ -52,1527 +52,1527 @@ discard block |
||
| 52 | 52 | * @package OCA\User_LDAP |
| 53 | 53 | */ |
| 54 | 54 | class Access extends LDAPUtility implements IUserTools { |
| 55 | - /** |
|
| 56 | - * @var \OCA\User_LDAP\Connection |
|
| 57 | - */ |
|
| 58 | - public $connection; |
|
| 59 | - /** @var Manager */ |
|
| 60 | - public $userManager; |
|
| 61 | - //never ever check this var directly, always use getPagedSearchResultState |
|
| 62 | - protected $pagedSearchedSuccessful; |
|
| 63 | - |
|
| 64 | - /** |
|
| 65 | - * @var string[] $cookies an array of returned Paged Result cookies |
|
| 66 | - */ |
|
| 67 | - protected $cookies = array(); |
|
| 68 | - |
|
| 69 | - /** |
|
| 70 | - * @var string $lastCookie the last cookie returned from a Paged Results |
|
| 71 | - * operation, defaults to an empty string |
|
| 72 | - */ |
|
| 73 | - protected $lastCookie = ''; |
|
| 74 | - |
|
| 75 | - /** |
|
| 76 | - * @var AbstractMapping $userMapper |
|
| 77 | - */ |
|
| 78 | - protected $userMapper; |
|
| 79 | - |
|
| 80 | - /** |
|
| 81 | - * @var AbstractMapping $userMapper |
|
| 82 | - */ |
|
| 83 | - protected $groupMapper; |
|
| 55 | + /** |
|
| 56 | + * @var \OCA\User_LDAP\Connection |
|
| 57 | + */ |
|
| 58 | + public $connection; |
|
| 59 | + /** @var Manager */ |
|
| 60 | + public $userManager; |
|
| 61 | + //never ever check this var directly, always use getPagedSearchResultState |
|
| 62 | + protected $pagedSearchedSuccessful; |
|
| 63 | + |
|
| 64 | + /** |
|
| 65 | + * @var string[] $cookies an array of returned Paged Result cookies |
|
| 66 | + */ |
|
| 67 | + protected $cookies = array(); |
|
| 68 | + |
|
| 69 | + /** |
|
| 70 | + * @var string $lastCookie the last cookie returned from a Paged Results |
|
| 71 | + * operation, defaults to an empty string |
|
| 72 | + */ |
|
| 73 | + protected $lastCookie = ''; |
|
| 74 | + |
|
| 75 | + /** |
|
| 76 | + * @var AbstractMapping $userMapper |
|
| 77 | + */ |
|
| 78 | + protected $userMapper; |
|
| 79 | + |
|
| 80 | + /** |
|
| 81 | + * @var AbstractMapping $userMapper |
|
| 82 | + */ |
|
| 83 | + protected $groupMapper; |
|
| 84 | 84 | |
| 85 | - /** |
|
| 86 | - * @var \OCA\User_LDAP\Helper |
|
| 87 | - */ |
|
| 88 | - private $helper; |
|
| 89 | - |
|
| 90 | - public function __construct(Connection $connection, ILDAPWrapper $ldap, |
|
| 91 | - Manager $userManager, Helper $helper) { |
|
| 92 | - parent::__construct($ldap); |
|
| 93 | - $this->connection = $connection; |
|
| 94 | - $this->userManager = $userManager; |
|
| 95 | - $this->userManager->setLdapAccess($this); |
|
| 96 | - $this->helper = $helper; |
|
| 97 | - } |
|
| 98 | - |
|
| 99 | - /** |
|
| 100 | - * sets the User Mapper |
|
| 101 | - * @param AbstractMapping $mapper |
|
| 102 | - */ |
|
| 103 | - public function setUserMapper(AbstractMapping $mapper) { |
|
| 104 | - $this->userMapper = $mapper; |
|
| 105 | - } |
|
| 106 | - |
|
| 107 | - /** |
|
| 108 | - * returns the User Mapper |
|
| 109 | - * @throws \Exception |
|
| 110 | - * @return AbstractMapping |
|
| 111 | - */ |
|
| 112 | - public function getUserMapper() { |
|
| 113 | - if(is_null($this->userMapper)) { |
|
| 114 | - throw new \Exception('UserMapper was not assigned to this Access instance.'); |
|
| 115 | - } |
|
| 116 | - return $this->userMapper; |
|
| 117 | - } |
|
| 118 | - |
|
| 119 | - /** |
|
| 120 | - * sets the Group Mapper |
|
| 121 | - * @param AbstractMapping $mapper |
|
| 122 | - */ |
|
| 123 | - public function setGroupMapper(AbstractMapping $mapper) { |
|
| 124 | - $this->groupMapper = $mapper; |
|
| 125 | - } |
|
| 126 | - |
|
| 127 | - /** |
|
| 128 | - * returns the Group Mapper |
|
| 129 | - * @throws \Exception |
|
| 130 | - * @return AbstractMapping |
|
| 131 | - */ |
|
| 132 | - public function getGroupMapper() { |
|
| 133 | - if(is_null($this->groupMapper)) { |
|
| 134 | - throw new \Exception('GroupMapper was not assigned to this Access instance.'); |
|
| 135 | - } |
|
| 136 | - return $this->groupMapper; |
|
| 137 | - } |
|
| 138 | - |
|
| 139 | - /** |
|
| 140 | - * @return bool |
|
| 141 | - */ |
|
| 142 | - private function checkConnection() { |
|
| 143 | - return ($this->connection instanceof Connection); |
|
| 144 | - } |
|
| 145 | - |
|
| 146 | - /** |
|
| 147 | - * returns the Connection instance |
|
| 148 | - * @return \OCA\User_LDAP\Connection |
|
| 149 | - */ |
|
| 150 | - public function getConnection() { |
|
| 151 | - return $this->connection; |
|
| 152 | - } |
|
| 153 | - |
|
| 154 | - /** |
|
| 155 | - * reads a given attribute for an LDAP record identified by a DN |
|
| 156 | - * @param string $dn the record in question |
|
| 157 | - * @param string $attr the attribute that shall be retrieved |
|
| 158 | - * if empty, just check the record's existence |
|
| 159 | - * @param string $filter |
|
| 160 | - * @return array|false an array of values on success or an empty |
|
| 161 | - * array if $attr is empty, false otherwise |
|
| 162 | - */ |
|
| 163 | - public function readAttribute($dn, $attr, $filter = 'objectClass=*') { |
|
| 164 | - if(!$this->checkConnection()) { |
|
| 165 | - \OCP\Util::writeLog('user_ldap', |
|
| 166 | - 'No LDAP Connector assigned, access impossible for readAttribute.', |
|
| 167 | - \OCP\Util::WARN); |
|
| 168 | - return false; |
|
| 169 | - } |
|
| 170 | - $cr = $this->connection->getConnectionResource(); |
|
| 171 | - if(!$this->ldap->isResource($cr)) { |
|
| 172 | - //LDAP not available |
|
| 173 | - \OCP\Util::writeLog('user_ldap', 'LDAP resource not available.', \OCP\Util::DEBUG); |
|
| 174 | - return false; |
|
| 175 | - } |
|
| 176 | - //Cancel possibly running Paged Results operation, otherwise we run in |
|
| 177 | - //LDAP protocol errors |
|
| 178 | - $this->abandonPagedSearch(); |
|
| 179 | - // openLDAP requires that we init a new Paged Search. Not needed by AD, |
|
| 180 | - // but does not hurt either. |
|
| 181 | - $pagingSize = intval($this->connection->ldapPagingSize); |
|
| 182 | - // 0 won't result in replies, small numbers may leave out groups |
|
| 183 | - // (cf. #12306), 500 is default for paging and should work everywhere. |
|
| 184 | - $maxResults = $pagingSize > 20 ? $pagingSize : 500; |
|
| 185 | - $attr = mb_strtolower($attr, 'UTF-8'); |
|
| 186 | - // the actual read attribute later may contain parameters on a ranged |
|
| 187 | - // request, e.g. member;range=99-199. Depends on server reply. |
|
| 188 | - $attrToRead = $attr; |
|
| 189 | - |
|
| 190 | - $values = []; |
|
| 191 | - $isRangeRequest = false; |
|
| 192 | - do { |
|
| 193 | - $result = $this->executeRead($cr, $dn, $attrToRead, $filter, $maxResults); |
|
| 194 | - if(is_bool($result)) { |
|
| 195 | - // when an exists request was run and it was successful, an empty |
|
| 196 | - // array must be returned |
|
| 197 | - return $result ? [] : false; |
|
| 198 | - } |
|
| 199 | - |
|
| 200 | - if (!$isRangeRequest) { |
|
| 201 | - $values = $this->extractAttributeValuesFromResult($result, $attr); |
|
| 202 | - if (!empty($values)) { |
|
| 203 | - return $values; |
|
| 204 | - } |
|
| 205 | - } |
|
| 206 | - |
|
| 207 | - $isRangeRequest = false; |
|
| 208 | - $result = $this->extractRangeData($result, $attr); |
|
| 209 | - if (!empty($result)) { |
|
| 210 | - $normalizedResult = $this->extractAttributeValuesFromResult( |
|
| 211 | - [ $attr => $result['values'] ], |
|
| 212 | - $attr |
|
| 213 | - ); |
|
| 214 | - $values = array_merge($values, $normalizedResult); |
|
| 215 | - |
|
| 216 | - if($result['rangeHigh'] === '*') { |
|
| 217 | - // when server replies with * as high range value, there are |
|
| 218 | - // no more results left |
|
| 219 | - return $values; |
|
| 220 | - } else { |
|
| 221 | - $low = $result['rangeHigh'] + 1; |
|
| 222 | - $attrToRead = $result['attributeName'] . ';range=' . $low . '-*'; |
|
| 223 | - $isRangeRequest = true; |
|
| 224 | - } |
|
| 225 | - } |
|
| 226 | - } while($isRangeRequest); |
|
| 227 | - |
|
| 228 | - \OCP\Util::writeLog('user_ldap', 'Requested attribute '.$attr.' not found for '.$dn, \OCP\Util::DEBUG); |
|
| 229 | - return false; |
|
| 230 | - } |
|
| 231 | - |
|
| 232 | - /** |
|
| 233 | - * Runs an read operation against LDAP |
|
| 234 | - * |
|
| 235 | - * @param resource $cr the LDAP connection |
|
| 236 | - * @param string $dn |
|
| 237 | - * @param string $attribute |
|
| 238 | - * @param string $filter |
|
| 239 | - * @param int $maxResults |
|
| 240 | - * @return array|bool false if there was any error, true if an exists check |
|
| 241 | - * was performed and the requested DN found, array with the |
|
| 242 | - * returned data on a successful usual operation |
|
| 243 | - */ |
|
| 244 | - public function executeRead($cr, $dn, $attribute, $filter, $maxResults) { |
|
| 245 | - $this->initPagedSearch($filter, array($dn), array($attribute), $maxResults, 0); |
|
| 246 | - $dn = $this->helper->DNasBaseParameter($dn); |
|
| 247 | - $rr = @$this->ldap->read($cr, $dn, $filter, array($attribute)); |
|
| 248 | - if (!$this->ldap->isResource($rr)) { |
|
| 249 | - if ($attribute !== '') { |
|
| 250 | - //do not throw this message on userExists check, irritates |
|
| 251 | - \OCP\Util::writeLog('user_ldap', 'readAttribute failed for DN ' . $dn, \OCP\Util::DEBUG); |
|
| 252 | - } |
|
| 253 | - //in case an error occurs , e.g. object does not exist |
|
| 254 | - return false; |
|
| 255 | - } |
|
| 256 | - if ($attribute === '' && ($filter === 'objectclass=*' || $this->ldap->countEntries($cr, $rr) === 1)) { |
|
| 257 | - \OCP\Util::writeLog('user_ldap', 'readAttribute: ' . $dn . ' found', \OCP\Util::DEBUG); |
|
| 258 | - return true; |
|
| 259 | - } |
|
| 260 | - $er = $this->ldap->firstEntry($cr, $rr); |
|
| 261 | - if (!$this->ldap->isResource($er)) { |
|
| 262 | - //did not match the filter, return false |
|
| 263 | - return false; |
|
| 264 | - } |
|
| 265 | - //LDAP attributes are not case sensitive |
|
| 266 | - $result = \OCP\Util::mb_array_change_key_case( |
|
| 267 | - $this->ldap->getAttributes($cr, $er), MB_CASE_LOWER, 'UTF-8'); |
|
| 268 | - |
|
| 269 | - return $result; |
|
| 270 | - } |
|
| 271 | - |
|
| 272 | - /** |
|
| 273 | - * Normalizes a result grom getAttributes(), i.e. handles DNs and binary |
|
| 274 | - * data if present. |
|
| 275 | - * |
|
| 276 | - * @param array $result from ILDAPWrapper::getAttributes() |
|
| 277 | - * @param string $attribute the attribute name that was read |
|
| 278 | - * @return string[] |
|
| 279 | - */ |
|
| 280 | - public function extractAttributeValuesFromResult($result, $attribute) { |
|
| 281 | - $values = []; |
|
| 282 | - if(isset($result[$attribute]) && $result[$attribute]['count'] > 0) { |
|
| 283 | - $lowercaseAttribute = strtolower($attribute); |
|
| 284 | - for($i=0;$i<$result[$attribute]['count'];$i++) { |
|
| 285 | - if($this->resemblesDN($attribute)) { |
|
| 286 | - $values[] = $this->helper->sanitizeDN($result[$attribute][$i]); |
|
| 287 | - } elseif($lowercaseAttribute === 'objectguid' || $lowercaseAttribute === 'guid') { |
|
| 288 | - $values[] = $this->convertObjectGUID2Str($result[$attribute][$i]); |
|
| 289 | - } else { |
|
| 290 | - $values[] = $result[$attribute][$i]; |
|
| 291 | - } |
|
| 292 | - } |
|
| 293 | - } |
|
| 294 | - return $values; |
|
| 295 | - } |
|
| 296 | - |
|
| 297 | - /** |
|
| 298 | - * Attempts to find ranged data in a getAttribute results and extracts the |
|
| 299 | - * returned values as well as information on the range and full attribute |
|
| 300 | - * name for further processing. |
|
| 301 | - * |
|
| 302 | - * @param array $result from ILDAPWrapper::getAttributes() |
|
| 303 | - * @param string $attribute the attribute name that was read. Without ";range=…" |
|
| 304 | - * @return array If a range was detected with keys 'values', 'attributeName', |
|
| 305 | - * 'attributeFull' and 'rangeHigh', otherwise empty. |
|
| 306 | - */ |
|
| 307 | - public function extractRangeData($result, $attribute) { |
|
| 308 | - $keys = array_keys($result); |
|
| 309 | - foreach($keys as $key) { |
|
| 310 | - if($key !== $attribute && strpos($key, $attribute) === 0) { |
|
| 311 | - $queryData = explode(';', $key); |
|
| 312 | - if(strpos($queryData[1], 'range=') === 0) { |
|
| 313 | - $high = substr($queryData[1], 1 + strpos($queryData[1], '-')); |
|
| 314 | - $data = [ |
|
| 315 | - 'values' => $result[$key], |
|
| 316 | - 'attributeName' => $queryData[0], |
|
| 317 | - 'attributeFull' => $key, |
|
| 318 | - 'rangeHigh' => $high, |
|
| 319 | - ]; |
|
| 320 | - return $data; |
|
| 321 | - } |
|
| 322 | - } |
|
| 323 | - } |
|
| 324 | - return []; |
|
| 325 | - } |
|
| 85 | + /** |
|
| 86 | + * @var \OCA\User_LDAP\Helper |
|
| 87 | + */ |
|
| 88 | + private $helper; |
|
| 89 | + |
|
| 90 | + public function __construct(Connection $connection, ILDAPWrapper $ldap, |
|
| 91 | + Manager $userManager, Helper $helper) { |
|
| 92 | + parent::__construct($ldap); |
|
| 93 | + $this->connection = $connection; |
|
| 94 | + $this->userManager = $userManager; |
|
| 95 | + $this->userManager->setLdapAccess($this); |
|
| 96 | + $this->helper = $helper; |
|
| 97 | + } |
|
| 98 | + |
|
| 99 | + /** |
|
| 100 | + * sets the User Mapper |
|
| 101 | + * @param AbstractMapping $mapper |
|
| 102 | + */ |
|
| 103 | + public function setUserMapper(AbstractMapping $mapper) { |
|
| 104 | + $this->userMapper = $mapper; |
|
| 105 | + } |
|
| 106 | + |
|
| 107 | + /** |
|
| 108 | + * returns the User Mapper |
|
| 109 | + * @throws \Exception |
|
| 110 | + * @return AbstractMapping |
|
| 111 | + */ |
|
| 112 | + public function getUserMapper() { |
|
| 113 | + if(is_null($this->userMapper)) { |
|
| 114 | + throw new \Exception('UserMapper was not assigned to this Access instance.'); |
|
| 115 | + } |
|
| 116 | + return $this->userMapper; |
|
| 117 | + } |
|
| 118 | + |
|
| 119 | + /** |
|
| 120 | + * sets the Group Mapper |
|
| 121 | + * @param AbstractMapping $mapper |
|
| 122 | + */ |
|
| 123 | + public function setGroupMapper(AbstractMapping $mapper) { |
|
| 124 | + $this->groupMapper = $mapper; |
|
| 125 | + } |
|
| 126 | + |
|
| 127 | + /** |
|
| 128 | + * returns the Group Mapper |
|
| 129 | + * @throws \Exception |
|
| 130 | + * @return AbstractMapping |
|
| 131 | + */ |
|
| 132 | + public function getGroupMapper() { |
|
| 133 | + if(is_null($this->groupMapper)) { |
|
| 134 | + throw new \Exception('GroupMapper was not assigned to this Access instance.'); |
|
| 135 | + } |
|
| 136 | + return $this->groupMapper; |
|
| 137 | + } |
|
| 138 | + |
|
| 139 | + /** |
|
| 140 | + * @return bool |
|
| 141 | + */ |
|
| 142 | + private function checkConnection() { |
|
| 143 | + return ($this->connection instanceof Connection); |
|
| 144 | + } |
|
| 145 | + |
|
| 146 | + /** |
|
| 147 | + * returns the Connection instance |
|
| 148 | + * @return \OCA\User_LDAP\Connection |
|
| 149 | + */ |
|
| 150 | + public function getConnection() { |
|
| 151 | + return $this->connection; |
|
| 152 | + } |
|
| 153 | + |
|
| 154 | + /** |
|
| 155 | + * reads a given attribute for an LDAP record identified by a DN |
|
| 156 | + * @param string $dn the record in question |
|
| 157 | + * @param string $attr the attribute that shall be retrieved |
|
| 158 | + * if empty, just check the record's existence |
|
| 159 | + * @param string $filter |
|
| 160 | + * @return array|false an array of values on success or an empty |
|
| 161 | + * array if $attr is empty, false otherwise |
|
| 162 | + */ |
|
| 163 | + public function readAttribute($dn, $attr, $filter = 'objectClass=*') { |
|
| 164 | + if(!$this->checkConnection()) { |
|
| 165 | + \OCP\Util::writeLog('user_ldap', |
|
| 166 | + 'No LDAP Connector assigned, access impossible for readAttribute.', |
|
| 167 | + \OCP\Util::WARN); |
|
| 168 | + return false; |
|
| 169 | + } |
|
| 170 | + $cr = $this->connection->getConnectionResource(); |
|
| 171 | + if(!$this->ldap->isResource($cr)) { |
|
| 172 | + //LDAP not available |
|
| 173 | + \OCP\Util::writeLog('user_ldap', 'LDAP resource not available.', \OCP\Util::DEBUG); |
|
| 174 | + return false; |
|
| 175 | + } |
|
| 176 | + //Cancel possibly running Paged Results operation, otherwise we run in |
|
| 177 | + //LDAP protocol errors |
|
| 178 | + $this->abandonPagedSearch(); |
|
| 179 | + // openLDAP requires that we init a new Paged Search. Not needed by AD, |
|
| 180 | + // but does not hurt either. |
|
| 181 | + $pagingSize = intval($this->connection->ldapPagingSize); |
|
| 182 | + // 0 won't result in replies, small numbers may leave out groups |
|
| 183 | + // (cf. #12306), 500 is default for paging and should work everywhere. |
|
| 184 | + $maxResults = $pagingSize > 20 ? $pagingSize : 500; |
|
| 185 | + $attr = mb_strtolower($attr, 'UTF-8'); |
|
| 186 | + // the actual read attribute later may contain parameters on a ranged |
|
| 187 | + // request, e.g. member;range=99-199. Depends on server reply. |
|
| 188 | + $attrToRead = $attr; |
|
| 189 | + |
|
| 190 | + $values = []; |
|
| 191 | + $isRangeRequest = false; |
|
| 192 | + do { |
|
| 193 | + $result = $this->executeRead($cr, $dn, $attrToRead, $filter, $maxResults); |
|
| 194 | + if(is_bool($result)) { |
|
| 195 | + // when an exists request was run and it was successful, an empty |
|
| 196 | + // array must be returned |
|
| 197 | + return $result ? [] : false; |
|
| 198 | + } |
|
| 199 | + |
|
| 200 | + if (!$isRangeRequest) { |
|
| 201 | + $values = $this->extractAttributeValuesFromResult($result, $attr); |
|
| 202 | + if (!empty($values)) { |
|
| 203 | + return $values; |
|
| 204 | + } |
|
| 205 | + } |
|
| 206 | + |
|
| 207 | + $isRangeRequest = false; |
|
| 208 | + $result = $this->extractRangeData($result, $attr); |
|
| 209 | + if (!empty($result)) { |
|
| 210 | + $normalizedResult = $this->extractAttributeValuesFromResult( |
|
| 211 | + [ $attr => $result['values'] ], |
|
| 212 | + $attr |
|
| 213 | + ); |
|
| 214 | + $values = array_merge($values, $normalizedResult); |
|
| 215 | + |
|
| 216 | + if($result['rangeHigh'] === '*') { |
|
| 217 | + // when server replies with * as high range value, there are |
|
| 218 | + // no more results left |
|
| 219 | + return $values; |
|
| 220 | + } else { |
|
| 221 | + $low = $result['rangeHigh'] + 1; |
|
| 222 | + $attrToRead = $result['attributeName'] . ';range=' . $low . '-*'; |
|
| 223 | + $isRangeRequest = true; |
|
| 224 | + } |
|
| 225 | + } |
|
| 226 | + } while($isRangeRequest); |
|
| 227 | + |
|
| 228 | + \OCP\Util::writeLog('user_ldap', 'Requested attribute '.$attr.' not found for '.$dn, \OCP\Util::DEBUG); |
|
| 229 | + return false; |
|
| 230 | + } |
|
| 231 | + |
|
| 232 | + /** |
|
| 233 | + * Runs an read operation against LDAP |
|
| 234 | + * |
|
| 235 | + * @param resource $cr the LDAP connection |
|
| 236 | + * @param string $dn |
|
| 237 | + * @param string $attribute |
|
| 238 | + * @param string $filter |
|
| 239 | + * @param int $maxResults |
|
| 240 | + * @return array|bool false if there was any error, true if an exists check |
|
| 241 | + * was performed and the requested DN found, array with the |
|
| 242 | + * returned data on a successful usual operation |
|
| 243 | + */ |
|
| 244 | + public function executeRead($cr, $dn, $attribute, $filter, $maxResults) { |
|
| 245 | + $this->initPagedSearch($filter, array($dn), array($attribute), $maxResults, 0); |
|
| 246 | + $dn = $this->helper->DNasBaseParameter($dn); |
|
| 247 | + $rr = @$this->ldap->read($cr, $dn, $filter, array($attribute)); |
|
| 248 | + if (!$this->ldap->isResource($rr)) { |
|
| 249 | + if ($attribute !== '') { |
|
| 250 | + //do not throw this message on userExists check, irritates |
|
| 251 | + \OCP\Util::writeLog('user_ldap', 'readAttribute failed for DN ' . $dn, \OCP\Util::DEBUG); |
|
| 252 | + } |
|
| 253 | + //in case an error occurs , e.g. object does not exist |
|
| 254 | + return false; |
|
| 255 | + } |
|
| 256 | + if ($attribute === '' && ($filter === 'objectclass=*' || $this->ldap->countEntries($cr, $rr) === 1)) { |
|
| 257 | + \OCP\Util::writeLog('user_ldap', 'readAttribute: ' . $dn . ' found', \OCP\Util::DEBUG); |
|
| 258 | + return true; |
|
| 259 | + } |
|
| 260 | + $er = $this->ldap->firstEntry($cr, $rr); |
|
| 261 | + if (!$this->ldap->isResource($er)) { |
|
| 262 | + //did not match the filter, return false |
|
| 263 | + return false; |
|
| 264 | + } |
|
| 265 | + //LDAP attributes are not case sensitive |
|
| 266 | + $result = \OCP\Util::mb_array_change_key_case( |
|
| 267 | + $this->ldap->getAttributes($cr, $er), MB_CASE_LOWER, 'UTF-8'); |
|
| 268 | + |
|
| 269 | + return $result; |
|
| 270 | + } |
|
| 271 | + |
|
| 272 | + /** |
|
| 273 | + * Normalizes a result grom getAttributes(), i.e. handles DNs and binary |
|
| 274 | + * data if present. |
|
| 275 | + * |
|
| 276 | + * @param array $result from ILDAPWrapper::getAttributes() |
|
| 277 | + * @param string $attribute the attribute name that was read |
|
| 278 | + * @return string[] |
|
| 279 | + */ |
|
| 280 | + public function extractAttributeValuesFromResult($result, $attribute) { |
|
| 281 | + $values = []; |
|
| 282 | + if(isset($result[$attribute]) && $result[$attribute]['count'] > 0) { |
|
| 283 | + $lowercaseAttribute = strtolower($attribute); |
|
| 284 | + for($i=0;$i<$result[$attribute]['count'];$i++) { |
|
| 285 | + if($this->resemblesDN($attribute)) { |
|
| 286 | + $values[] = $this->helper->sanitizeDN($result[$attribute][$i]); |
|
| 287 | + } elseif($lowercaseAttribute === 'objectguid' || $lowercaseAttribute === 'guid') { |
|
| 288 | + $values[] = $this->convertObjectGUID2Str($result[$attribute][$i]); |
|
| 289 | + } else { |
|
| 290 | + $values[] = $result[$attribute][$i]; |
|
| 291 | + } |
|
| 292 | + } |
|
| 293 | + } |
|
| 294 | + return $values; |
|
| 295 | + } |
|
| 296 | + |
|
| 297 | + /** |
|
| 298 | + * Attempts to find ranged data in a getAttribute results and extracts the |
|
| 299 | + * returned values as well as information on the range and full attribute |
|
| 300 | + * name for further processing. |
|
| 301 | + * |
|
| 302 | + * @param array $result from ILDAPWrapper::getAttributes() |
|
| 303 | + * @param string $attribute the attribute name that was read. Without ";range=…" |
|
| 304 | + * @return array If a range was detected with keys 'values', 'attributeName', |
|
| 305 | + * 'attributeFull' and 'rangeHigh', otherwise empty. |
|
| 306 | + */ |
|
| 307 | + public function extractRangeData($result, $attribute) { |
|
| 308 | + $keys = array_keys($result); |
|
| 309 | + foreach($keys as $key) { |
|
| 310 | + if($key !== $attribute && strpos($key, $attribute) === 0) { |
|
| 311 | + $queryData = explode(';', $key); |
|
| 312 | + if(strpos($queryData[1], 'range=') === 0) { |
|
| 313 | + $high = substr($queryData[1], 1 + strpos($queryData[1], '-')); |
|
| 314 | + $data = [ |
|
| 315 | + 'values' => $result[$key], |
|
| 316 | + 'attributeName' => $queryData[0], |
|
| 317 | + 'attributeFull' => $key, |
|
| 318 | + 'rangeHigh' => $high, |
|
| 319 | + ]; |
|
| 320 | + return $data; |
|
| 321 | + } |
|
| 322 | + } |
|
| 323 | + } |
|
| 324 | + return []; |
|
| 325 | + } |
|
| 326 | 326 | |
| 327 | - /** |
|
| 328 | - * Set password for an LDAP user identified by a DN |
|
| 329 | - * |
|
| 330 | - * @param string $userDN the user in question |
|
| 331 | - * @param string $password the new password |
|
| 332 | - * @return bool |
|
| 333 | - * @throws HintException |
|
| 334 | - * @throws \Exception |
|
| 335 | - */ |
|
| 336 | - public function setPassword($userDN, $password) { |
|
| 337 | - if(intval($this->connection->turnOnPasswordChange) !== 1) { |
|
| 338 | - throw new \Exception('LDAP password changes are disabled.'); |
|
| 339 | - } |
|
| 340 | - $cr = $this->connection->getConnectionResource(); |
|
| 341 | - if(!$this->ldap->isResource($cr)) { |
|
| 342 | - //LDAP not available |
|
| 343 | - \OCP\Util::writeLog('user_ldap', 'LDAP resource not available.', \OCP\Util::DEBUG); |
|
| 344 | - return false; |
|
| 345 | - } |
|
| 327 | + /** |
|
| 328 | + * Set password for an LDAP user identified by a DN |
|
| 329 | + * |
|
| 330 | + * @param string $userDN the user in question |
|
| 331 | + * @param string $password the new password |
|
| 332 | + * @return bool |
|
| 333 | + * @throws HintException |
|
| 334 | + * @throws \Exception |
|
| 335 | + */ |
|
| 336 | + public function setPassword($userDN, $password) { |
|
| 337 | + if(intval($this->connection->turnOnPasswordChange) !== 1) { |
|
| 338 | + throw new \Exception('LDAP password changes are disabled.'); |
|
| 339 | + } |
|
| 340 | + $cr = $this->connection->getConnectionResource(); |
|
| 341 | + if(!$this->ldap->isResource($cr)) { |
|
| 342 | + //LDAP not available |
|
| 343 | + \OCP\Util::writeLog('user_ldap', 'LDAP resource not available.', \OCP\Util::DEBUG); |
|
| 344 | + return false; |
|
| 345 | + } |
|
| 346 | 346 | |
| 347 | - try { |
|
| 348 | - return $this->ldap->modReplace($cr, $userDN, $password); |
|
| 349 | - } catch(ConstraintViolationException $e) { |
|
| 350 | - throw new HintException('Password change rejected.', \OC::$server->getL10N('user_ldap')->t('Password change rejected. Hint: ').$e->getMessage(), $e->getCode()); |
|
| 351 | - } |
|
| 352 | - } |
|
| 353 | - |
|
| 354 | - /** |
|
| 355 | - * checks whether the given attributes value is probably a DN |
|
| 356 | - * @param string $attr the attribute in question |
|
| 357 | - * @return boolean if so true, otherwise false |
|
| 358 | - */ |
|
| 359 | - private function resemblesDN($attr) { |
|
| 360 | - $resemblingAttributes = array( |
|
| 361 | - 'dn', |
|
| 362 | - 'uniquemember', |
|
| 363 | - 'member', |
|
| 364 | - // memberOf is an "operational" attribute, without a definition in any RFC |
|
| 365 | - 'memberof' |
|
| 366 | - ); |
|
| 367 | - return in_array($attr, $resemblingAttributes); |
|
| 368 | - } |
|
| 369 | - |
|
| 370 | - /** |
|
| 371 | - * checks whether the given string is probably a DN |
|
| 372 | - * @param string $string |
|
| 373 | - * @return boolean |
|
| 374 | - */ |
|
| 375 | - public function stringResemblesDN($string) { |
|
| 376 | - $r = $this->ldap->explodeDN($string, 0); |
|
| 377 | - // if exploding a DN succeeds and does not end up in |
|
| 378 | - // an empty array except for $r[count] being 0. |
|
| 379 | - return (is_array($r) && count($r) > 1); |
|
| 380 | - } |
|
| 381 | - |
|
| 382 | - /** |
|
| 383 | - * returns a DN-string that is cleaned from not domain parts, e.g. |
|
| 384 | - * cn=foo,cn=bar,dc=foobar,dc=server,dc=org |
|
| 385 | - * becomes dc=foobar,dc=server,dc=org |
|
| 386 | - * @param string $dn |
|
| 387 | - * @return string |
|
| 388 | - */ |
|
| 389 | - public function getDomainDNFromDN($dn) { |
|
| 390 | - $allParts = $this->ldap->explodeDN($dn, 0); |
|
| 391 | - if($allParts === false) { |
|
| 392 | - //not a valid DN |
|
| 393 | - return ''; |
|
| 394 | - } |
|
| 395 | - $domainParts = array(); |
|
| 396 | - $dcFound = false; |
|
| 397 | - foreach($allParts as $part) { |
|
| 398 | - if(!$dcFound && strpos($part, 'dc=') === 0) { |
|
| 399 | - $dcFound = true; |
|
| 400 | - } |
|
| 401 | - if($dcFound) { |
|
| 402 | - $domainParts[] = $part; |
|
| 403 | - } |
|
| 404 | - } |
|
| 405 | - $domainDN = implode(',', $domainParts); |
|
| 406 | - return $domainDN; |
|
| 407 | - } |
|
| 408 | - |
|
| 409 | - /** |
|
| 410 | - * returns the LDAP DN for the given internal ownCloud name of the group |
|
| 411 | - * @param string $name the ownCloud name in question |
|
| 412 | - * @return string|false LDAP DN on success, otherwise false |
|
| 413 | - */ |
|
| 414 | - public function groupname2dn($name) { |
|
| 415 | - return $this->groupMapper->getDNByName($name); |
|
| 416 | - } |
|
| 417 | - |
|
| 418 | - /** |
|
| 419 | - * returns the LDAP DN for the given internal ownCloud name of the user |
|
| 420 | - * @param string $name the ownCloud name in question |
|
| 421 | - * @return string|false with the LDAP DN on success, otherwise false |
|
| 422 | - */ |
|
| 423 | - public function username2dn($name) { |
|
| 424 | - $fdn = $this->userMapper->getDNByName($name); |
|
| 425 | - |
|
| 426 | - //Check whether the DN belongs to the Base, to avoid issues on multi- |
|
| 427 | - //server setups |
|
| 428 | - if(is_string($fdn) && $this->isDNPartOfBase($fdn, $this->connection->ldapBaseUsers)) { |
|
| 429 | - return $fdn; |
|
| 430 | - } |
|
| 431 | - |
|
| 432 | - return false; |
|
| 433 | - } |
|
| 434 | - |
|
| 435 | - /** |
|
| 436 | - * returns the internal ownCloud name for the given LDAP DN of the group, false on DN outside of search DN or failure |
|
| 437 | - * @param string $fdn the dn of the group object |
|
| 438 | - * @param string $ldapName optional, the display name of the object |
|
| 439 | - * @return string|false with the name to use in ownCloud, false on DN outside of search DN |
|
| 440 | - */ |
|
| 441 | - public function dn2groupname($fdn, $ldapName = null) { |
|
| 442 | - //To avoid bypassing the base DN settings under certain circumstances |
|
| 443 | - //with the group support, check whether the provided DN matches one of |
|
| 444 | - //the given Bases |
|
| 445 | - if(!$this->isDNPartOfBase($fdn, $this->connection->ldapBaseGroups)) { |
|
| 446 | - return false; |
|
| 447 | - } |
|
| 448 | - |
|
| 449 | - return $this->dn2ocname($fdn, $ldapName, false); |
|
| 450 | - } |
|
| 451 | - |
|
| 452 | - /** |
|
| 453 | - * accepts an array of group DNs and tests whether they match the user |
|
| 454 | - * filter by doing read operations against the group entries. Returns an |
|
| 455 | - * array of DNs that match the filter. |
|
| 456 | - * |
|
| 457 | - * @param string[] $groupDNs |
|
| 458 | - * @return string[] |
|
| 459 | - */ |
|
| 460 | - public function groupsMatchFilter($groupDNs) { |
|
| 461 | - $validGroupDNs = []; |
|
| 462 | - foreach($groupDNs as $dn) { |
|
| 463 | - $cacheKey = 'groupsMatchFilter-'.$dn; |
|
| 464 | - $groupMatchFilter = $this->connection->getFromCache($cacheKey); |
|
| 465 | - if(!is_null($groupMatchFilter)) { |
|
| 466 | - if($groupMatchFilter) { |
|
| 467 | - $validGroupDNs[] = $dn; |
|
| 468 | - } |
|
| 469 | - continue; |
|
| 470 | - } |
|
| 471 | - |
|
| 472 | - // Check the base DN first. If this is not met already, we don't |
|
| 473 | - // need to ask the server at all. |
|
| 474 | - if(!$this->isDNPartOfBase($dn, $this->connection->ldapBaseGroups)) { |
|
| 475 | - $this->connection->writeToCache($cacheKey, false); |
|
| 476 | - continue; |
|
| 477 | - } |
|
| 478 | - |
|
| 479 | - $result = $this->readAttribute($dn, 'cn', $this->connection->ldapGroupFilter); |
|
| 480 | - if(is_array($result)) { |
|
| 481 | - $this->connection->writeToCache($cacheKey, true); |
|
| 482 | - $validGroupDNs[] = $dn; |
|
| 483 | - } else { |
|
| 484 | - $this->connection->writeToCache($cacheKey, false); |
|
| 485 | - } |
|
| 486 | - |
|
| 487 | - } |
|
| 488 | - return $validGroupDNs; |
|
| 489 | - } |
|
| 490 | - |
|
| 491 | - /** |
|
| 492 | - * returns the internal ownCloud name for the given LDAP DN of the user, false on DN outside of search DN or failure |
|
| 493 | - * @param string $dn the dn of the user object |
|
| 494 | - * @param string $ldapName optional, the display name of the object |
|
| 495 | - * @return string|false with with the name to use in ownCloud |
|
| 496 | - */ |
|
| 497 | - public function dn2username($fdn, $ldapName = null) { |
|
| 498 | - //To avoid bypassing the base DN settings under certain circumstances |
|
| 499 | - //with the group support, check whether the provided DN matches one of |
|
| 500 | - //the given Bases |
|
| 501 | - if(!$this->isDNPartOfBase($fdn, $this->connection->ldapBaseUsers)) { |
|
| 502 | - return false; |
|
| 503 | - } |
|
| 504 | - |
|
| 505 | - return $this->dn2ocname($fdn, $ldapName, true); |
|
| 506 | - } |
|
| 507 | - |
|
| 508 | - /** |
|
| 509 | - * returns an internal ownCloud name for the given LDAP DN, false on DN outside of search DN |
|
| 510 | - * @param string $dn the dn of the user object |
|
| 511 | - * @param string $ldapName optional, the display name of the object |
|
| 512 | - * @param bool $isUser optional, whether it is a user object (otherwise group assumed) |
|
| 513 | - * @return string|false with with the name to use in ownCloud |
|
| 514 | - */ |
|
| 515 | - public function dn2ocname($fdn, $ldapName = null, $isUser = true) { |
|
| 516 | - if($isUser) { |
|
| 517 | - $mapper = $this->getUserMapper(); |
|
| 518 | - $nameAttribute = $this->connection->ldapUserDisplayName; |
|
| 519 | - } else { |
|
| 520 | - $mapper = $this->getGroupMapper(); |
|
| 521 | - $nameAttribute = $this->connection->ldapGroupDisplayName; |
|
| 522 | - } |
|
| 523 | - |
|
| 524 | - //let's try to retrieve the ownCloud name from the mappings table |
|
| 525 | - $ocName = $mapper->getNameByDN($fdn); |
|
| 526 | - if(is_string($ocName)) { |
|
| 527 | - return $ocName; |
|
| 528 | - } |
|
| 529 | - |
|
| 530 | - //second try: get the UUID and check if it is known. Then, update the DN and return the name. |
|
| 531 | - $uuid = $this->getUUID($fdn, $isUser); |
|
| 532 | - if(is_string($uuid)) { |
|
| 533 | - $ocName = $mapper->getNameByUUID($uuid); |
|
| 534 | - if(is_string($ocName)) { |
|
| 535 | - $mapper->setDNbyUUID($fdn, $uuid); |
|
| 536 | - return $ocName; |
|
| 537 | - } |
|
| 538 | - } else { |
|
| 539 | - //If the UUID can't be detected something is foul. |
|
| 540 | - \OCP\Util::writeLog('user_ldap', 'Cannot determine UUID for '.$fdn.'. Skipping.', \OCP\Util::INFO); |
|
| 541 | - return false; |
|
| 542 | - } |
|
| 543 | - |
|
| 544 | - if(is_null($ldapName)) { |
|
| 545 | - $ldapName = $this->readAttribute($fdn, $nameAttribute); |
|
| 546 | - if(!isset($ldapName[0]) && empty($ldapName[0])) { |
|
| 547 | - \OCP\Util::writeLog('user_ldap', 'No or empty name for '.$fdn.'.', \OCP\Util::INFO); |
|
| 548 | - return false; |
|
| 549 | - } |
|
| 550 | - $ldapName = $ldapName[0]; |
|
| 551 | - } |
|
| 552 | - |
|
| 553 | - if($isUser) { |
|
| 554 | - $usernameAttribute = strval($this->connection->ldapExpertUsernameAttr); |
|
| 555 | - if ($usernameAttribute !== '') { |
|
| 556 | - $username = $this->readAttribute($fdn, $usernameAttribute); |
|
| 557 | - $username = $username[0]; |
|
| 558 | - } else { |
|
| 559 | - $username = $uuid; |
|
| 560 | - } |
|
| 561 | - $intName = $this->sanitizeUsername($username); |
|
| 562 | - } else { |
|
| 563 | - $intName = $ldapName; |
|
| 564 | - } |
|
| 565 | - |
|
| 566 | - //a new user/group! Add it only if it doesn't conflict with other backend's users or existing groups |
|
| 567 | - //disabling Cache is required to avoid that the new user is cached as not-existing in fooExists check |
|
| 568 | - //NOTE: mind, disabling cache affects only this instance! Using it |
|
| 569 | - // outside of core user management will still cache the user as non-existing. |
|
| 570 | - $originalTTL = $this->connection->ldapCacheTTL; |
|
| 571 | - $this->connection->setConfiguration(array('ldapCacheTTL' => 0)); |
|
| 572 | - if(($isUser && !\OCP\User::userExists($intName)) |
|
| 573 | - || (!$isUser && !\OC_Group::groupExists($intName))) { |
|
| 574 | - if($mapper->map($fdn, $intName, $uuid)) { |
|
| 575 | - $this->connection->setConfiguration(array('ldapCacheTTL' => $originalTTL)); |
|
| 576 | - return $intName; |
|
| 577 | - } |
|
| 578 | - } |
|
| 579 | - $this->connection->setConfiguration(array('ldapCacheTTL' => $originalTTL)); |
|
| 580 | - |
|
| 581 | - $altName = $this->createAltInternalOwnCloudName($intName, $isUser); |
|
| 582 | - if(is_string($altName) && $mapper->map($fdn, $altName, $uuid)) { |
|
| 583 | - return $altName; |
|
| 584 | - } |
|
| 585 | - |
|
| 586 | - //if everything else did not help.. |
|
| 587 | - \OCP\Util::writeLog('user_ldap', 'Could not create unique name for '.$fdn.'.', \OCP\Util::INFO); |
|
| 588 | - return false; |
|
| 589 | - } |
|
| 590 | - |
|
| 591 | - /** |
|
| 592 | - * gives back the user names as they are used ownClod internally |
|
| 593 | - * @param array $ldapUsers as returned by fetchList() |
|
| 594 | - * @return array an array with the user names to use in ownCloud |
|
| 595 | - * |
|
| 596 | - * gives back the user names as they are used ownClod internally |
|
| 597 | - */ |
|
| 598 | - public function ownCloudUserNames($ldapUsers) { |
|
| 599 | - return $this->ldap2ownCloudNames($ldapUsers, true); |
|
| 600 | - } |
|
| 601 | - |
|
| 602 | - /** |
|
| 603 | - * gives back the group names as they are used ownClod internally |
|
| 604 | - * @param array $ldapGroups as returned by fetchList() |
|
| 605 | - * @return array an array with the group names to use in ownCloud |
|
| 606 | - * |
|
| 607 | - * gives back the group names as they are used ownClod internally |
|
| 608 | - */ |
|
| 609 | - public function ownCloudGroupNames($ldapGroups) { |
|
| 610 | - return $this->ldap2ownCloudNames($ldapGroups, false); |
|
| 611 | - } |
|
| 612 | - |
|
| 613 | - /** |
|
| 614 | - * @param array $ldapObjects as returned by fetchList() |
|
| 615 | - * @param bool $isUsers |
|
| 616 | - * @return array |
|
| 617 | - */ |
|
| 618 | - private function ldap2ownCloudNames($ldapObjects, $isUsers) { |
|
| 619 | - if($isUsers) { |
|
| 620 | - $nameAttribute = $this->connection->ldapUserDisplayName; |
|
| 621 | - $sndAttribute = $this->connection->ldapUserDisplayName2; |
|
| 622 | - } else { |
|
| 623 | - $nameAttribute = $this->connection->ldapGroupDisplayName; |
|
| 624 | - } |
|
| 625 | - $ownCloudNames = array(); |
|
| 626 | - |
|
| 627 | - foreach($ldapObjects as $ldapObject) { |
|
| 628 | - $nameByLDAP = null; |
|
| 629 | - if( isset($ldapObject[$nameAttribute]) |
|
| 630 | - && is_array($ldapObject[$nameAttribute]) |
|
| 631 | - && isset($ldapObject[$nameAttribute][0]) |
|
| 632 | - ) { |
|
| 633 | - // might be set, but not necessarily. if so, we use it. |
|
| 634 | - $nameByLDAP = $ldapObject[$nameAttribute][0]; |
|
| 635 | - } |
|
| 636 | - |
|
| 637 | - $ocName = $this->dn2ocname($ldapObject['dn'][0], $nameByLDAP, $isUsers); |
|
| 638 | - if($ocName) { |
|
| 639 | - $ownCloudNames[] = $ocName; |
|
| 640 | - if($isUsers) { |
|
| 641 | - //cache the user names so it does not need to be retrieved |
|
| 642 | - //again later (e.g. sharing dialogue). |
|
| 643 | - if(is_null($nameByLDAP)) { |
|
| 644 | - continue; |
|
| 645 | - } |
|
| 646 | - $sndName = isset($ldapObject[$sndAttribute][0]) |
|
| 647 | - ? $ldapObject[$sndAttribute][0] : ''; |
|
| 648 | - $this->cacheUserDisplayName($ocName, $nameByLDAP, $sndName); |
|
| 649 | - } |
|
| 650 | - } |
|
| 651 | - } |
|
| 652 | - return $ownCloudNames; |
|
| 653 | - } |
|
| 654 | - |
|
| 655 | - /** |
|
| 656 | - * caches the user display name |
|
| 657 | - * @param string $ocName the internal ownCloud username |
|
| 658 | - * @param string|false $home the home directory path |
|
| 659 | - */ |
|
| 660 | - public function cacheUserHome($ocName, $home) { |
|
| 661 | - $cacheKey = 'getHome'.$ocName; |
|
| 662 | - $this->connection->writeToCache($cacheKey, $home); |
|
| 663 | - } |
|
| 664 | - |
|
| 665 | - /** |
|
| 666 | - * caches a user as existing |
|
| 667 | - * @param string $ocName the internal ownCloud username |
|
| 668 | - */ |
|
| 669 | - public function cacheUserExists($ocName) { |
|
| 670 | - $this->connection->writeToCache('userExists'.$ocName, true); |
|
| 671 | - } |
|
| 672 | - |
|
| 673 | - /** |
|
| 674 | - * caches the user display name |
|
| 675 | - * @param string $ocName the internal ownCloud username |
|
| 676 | - * @param string $displayName the display name |
|
| 677 | - * @param string $displayName2 the second display name |
|
| 678 | - */ |
|
| 679 | - public function cacheUserDisplayName($ocName, $displayName, $displayName2 = '') { |
|
| 680 | - $user = $this->userManager->get($ocName); |
|
| 681 | - if($user === null) { |
|
| 682 | - return; |
|
| 683 | - } |
|
| 684 | - $displayName = $user->composeAndStoreDisplayName($displayName, $displayName2); |
|
| 685 | - $cacheKeyTrunk = 'getDisplayName'; |
|
| 686 | - $this->connection->writeToCache($cacheKeyTrunk.$ocName, $displayName); |
|
| 687 | - } |
|
| 688 | - |
|
| 689 | - /** |
|
| 690 | - * creates a unique name for internal ownCloud use for users. Don't call it directly. |
|
| 691 | - * @param string $name the display name of the object |
|
| 692 | - * @return string|false with with the name to use in ownCloud or false if unsuccessful |
|
| 693 | - * |
|
| 694 | - * Instead of using this method directly, call |
|
| 695 | - * createAltInternalOwnCloudName($name, true) |
|
| 696 | - */ |
|
| 697 | - private function _createAltInternalOwnCloudNameForUsers($name) { |
|
| 698 | - $attempts = 0; |
|
| 699 | - //while loop is just a precaution. If a name is not generated within |
|
| 700 | - //20 attempts, something else is very wrong. Avoids infinite loop. |
|
| 701 | - while($attempts < 20){ |
|
| 702 | - $altName = $name . '_' . rand(1000,9999); |
|
| 703 | - if(!\OCP\User::userExists($altName)) { |
|
| 704 | - return $altName; |
|
| 705 | - } |
|
| 706 | - $attempts++; |
|
| 707 | - } |
|
| 708 | - return false; |
|
| 709 | - } |
|
| 710 | - |
|
| 711 | - /** |
|
| 712 | - * creates a unique name for internal ownCloud use for groups. Don't call it directly. |
|
| 713 | - * @param string $name the display name of the object |
|
| 714 | - * @return string|false with with the name to use in ownCloud or false if unsuccessful. |
|
| 715 | - * |
|
| 716 | - * Instead of using this method directly, call |
|
| 717 | - * createAltInternalOwnCloudName($name, false) |
|
| 718 | - * |
|
| 719 | - * Group names are also used as display names, so we do a sequential |
|
| 720 | - * numbering, e.g. Developers_42 when there are 41 other groups called |
|
| 721 | - * "Developers" |
|
| 722 | - */ |
|
| 723 | - private function _createAltInternalOwnCloudNameForGroups($name) { |
|
| 724 | - $usedNames = $this->groupMapper->getNamesBySearch($name, "", '_%'); |
|
| 725 | - if(!($usedNames) || count($usedNames) === 0) { |
|
| 726 | - $lastNo = 1; //will become name_2 |
|
| 727 | - } else { |
|
| 728 | - natsort($usedNames); |
|
| 729 | - $lastName = array_pop($usedNames); |
|
| 730 | - $lastNo = intval(substr($lastName, strrpos($lastName, '_') + 1)); |
|
| 731 | - } |
|
| 732 | - $altName = $name.'_'.strval($lastNo+1); |
|
| 733 | - unset($usedNames); |
|
| 734 | - |
|
| 735 | - $attempts = 1; |
|
| 736 | - while($attempts < 21){ |
|
| 737 | - // Check to be really sure it is unique |
|
| 738 | - // while loop is just a precaution. If a name is not generated within |
|
| 739 | - // 20 attempts, something else is very wrong. Avoids infinite loop. |
|
| 740 | - if(!\OC_Group::groupExists($altName)) { |
|
| 741 | - return $altName; |
|
| 742 | - } |
|
| 743 | - $altName = $name . '_' . ($lastNo + $attempts); |
|
| 744 | - $attempts++; |
|
| 745 | - } |
|
| 746 | - return false; |
|
| 747 | - } |
|
| 748 | - |
|
| 749 | - /** |
|
| 750 | - * creates a unique name for internal ownCloud use. |
|
| 751 | - * @param string $name the display name of the object |
|
| 752 | - * @param boolean $isUser whether name should be created for a user (true) or a group (false) |
|
| 753 | - * @return string|false with with the name to use in ownCloud or false if unsuccessful |
|
| 754 | - */ |
|
| 755 | - private function createAltInternalOwnCloudName($name, $isUser) { |
|
| 756 | - $originalTTL = $this->connection->ldapCacheTTL; |
|
| 757 | - $this->connection->setConfiguration(array('ldapCacheTTL' => 0)); |
|
| 758 | - if($isUser) { |
|
| 759 | - $altName = $this->_createAltInternalOwnCloudNameForUsers($name); |
|
| 760 | - } else { |
|
| 761 | - $altName = $this->_createAltInternalOwnCloudNameForGroups($name); |
|
| 762 | - } |
|
| 763 | - $this->connection->setConfiguration(array('ldapCacheTTL' => $originalTTL)); |
|
| 764 | - |
|
| 765 | - return $altName; |
|
| 766 | - } |
|
| 767 | - |
|
| 768 | - /** |
|
| 769 | - * fetches a list of users according to a provided loginName and utilizing |
|
| 770 | - * the login filter. |
|
| 771 | - * |
|
| 772 | - * @param string $loginName |
|
| 773 | - * @param array $attributes optional, list of attributes to read |
|
| 774 | - * @return array |
|
| 775 | - */ |
|
| 776 | - public function fetchUsersByLoginName($loginName, $attributes = array('dn')) { |
|
| 777 | - $loginName = $this->escapeFilterPart($loginName); |
|
| 778 | - $filter = str_replace('%uid', $loginName, $this->connection->ldapLoginFilter); |
|
| 779 | - $users = $this->fetchListOfUsers($filter, $attributes); |
|
| 780 | - return $users; |
|
| 781 | - } |
|
| 782 | - |
|
| 783 | - /** |
|
| 784 | - * counts the number of users according to a provided loginName and |
|
| 785 | - * utilizing the login filter. |
|
| 786 | - * |
|
| 787 | - * @param string $loginName |
|
| 788 | - * @return array |
|
| 789 | - */ |
|
| 790 | - public function countUsersByLoginName($loginName) { |
|
| 791 | - $loginName = $this->escapeFilterPart($loginName); |
|
| 792 | - $filter = str_replace('%uid', $loginName, $this->connection->ldapLoginFilter); |
|
| 793 | - $users = $this->countUsers($filter); |
|
| 794 | - return $users; |
|
| 795 | - } |
|
| 796 | - |
|
| 797 | - /** |
|
| 798 | - * @param string $filter |
|
| 799 | - * @param string|string[] $attr |
|
| 800 | - * @param int $limit |
|
| 801 | - * @param int $offset |
|
| 802 | - * @return array |
|
| 803 | - */ |
|
| 804 | - public function fetchListOfUsers($filter, $attr, $limit = null, $offset = null) { |
|
| 805 | - $ldapRecords = $this->searchUsers($filter, $attr, $limit, $offset); |
|
| 806 | - $this->batchApplyUserAttributes($ldapRecords); |
|
| 807 | - return $this->fetchList($ldapRecords, (count($attr) > 1)); |
|
| 808 | - } |
|
| 809 | - |
|
| 810 | - /** |
|
| 811 | - * provided with an array of LDAP user records the method will fetch the |
|
| 812 | - * user object and requests it to process the freshly fetched attributes and |
|
| 813 | - * and their values |
|
| 814 | - * @param array $ldapRecords |
|
| 815 | - */ |
|
| 816 | - public function batchApplyUserAttributes(array $ldapRecords){ |
|
| 817 | - $displayNameAttribute = strtolower($this->connection->ldapUserDisplayName); |
|
| 818 | - foreach($ldapRecords as $userRecord) { |
|
| 819 | - if(!isset($userRecord[$displayNameAttribute])) { |
|
| 820 | - // displayName is obligatory |
|
| 821 | - continue; |
|
| 822 | - } |
|
| 823 | - $ocName = $this->dn2ocname($userRecord['dn'][0]); |
|
| 824 | - if($ocName === false) { |
|
| 825 | - continue; |
|
| 826 | - } |
|
| 827 | - $this->cacheUserExists($ocName); |
|
| 828 | - $user = $this->userManager->get($ocName); |
|
| 829 | - if($user instanceof OfflineUser) { |
|
| 830 | - $user->unmark(); |
|
| 831 | - $user = $this->userManager->get($ocName); |
|
| 832 | - } |
|
| 833 | - if ($user !== null) { |
|
| 834 | - $user->processAttributes($userRecord); |
|
| 835 | - } else { |
|
| 836 | - \OC::$server->getLogger()->debug( |
|
| 837 | - "The ldap user manager returned null for $ocName", |
|
| 838 | - ['app'=>'user_ldap'] |
|
| 839 | - ); |
|
| 840 | - } |
|
| 841 | - } |
|
| 842 | - } |
|
| 843 | - |
|
| 844 | - /** |
|
| 845 | - * @param string $filter |
|
| 846 | - * @param string|string[] $attr |
|
| 847 | - * @param int $limit |
|
| 848 | - * @param int $offset |
|
| 849 | - * @return array |
|
| 850 | - */ |
|
| 851 | - public function fetchListOfGroups($filter, $attr, $limit = null, $offset = null) { |
|
| 852 | - return $this->fetchList($this->searchGroups($filter, $attr, $limit, $offset), (count($attr) > 1)); |
|
| 853 | - } |
|
| 854 | - |
|
| 855 | - /** |
|
| 856 | - * @param array $list |
|
| 857 | - * @param bool $manyAttributes |
|
| 858 | - * @return array |
|
| 859 | - */ |
|
| 860 | - private function fetchList($list, $manyAttributes) { |
|
| 861 | - if(is_array($list)) { |
|
| 862 | - if($manyAttributes) { |
|
| 863 | - return $list; |
|
| 864 | - } else { |
|
| 865 | - $list = array_reduce($list, function($carry, $item) { |
|
| 866 | - $attribute = array_keys($item)[0]; |
|
| 867 | - $carry[] = $item[$attribute][0]; |
|
| 868 | - return $carry; |
|
| 869 | - }, array()); |
|
| 870 | - return array_unique($list, SORT_LOCALE_STRING); |
|
| 871 | - } |
|
| 872 | - } |
|
| 873 | - |
|
| 874 | - //error cause actually, maybe throw an exception in future. |
|
| 875 | - return array(); |
|
| 876 | - } |
|
| 877 | - |
|
| 878 | - /** |
|
| 879 | - * executes an LDAP search, optimized for Users |
|
| 880 | - * @param string $filter the LDAP filter for the search |
|
| 881 | - * @param string|string[] $attr optional, when a certain attribute shall be filtered out |
|
| 882 | - * @param integer $limit |
|
| 883 | - * @param integer $offset |
|
| 884 | - * @return array with the search result |
|
| 885 | - * |
|
| 886 | - * Executes an LDAP search |
|
| 887 | - */ |
|
| 888 | - public function searchUsers($filter, $attr = null, $limit = null, $offset = null) { |
|
| 889 | - return $this->search($filter, $this->connection->ldapBaseUsers, $attr, $limit, $offset); |
|
| 890 | - } |
|
| 891 | - |
|
| 892 | - /** |
|
| 893 | - * @param string $filter |
|
| 894 | - * @param string|string[] $attr |
|
| 895 | - * @param int $limit |
|
| 896 | - * @param int $offset |
|
| 897 | - * @return false|int |
|
| 898 | - */ |
|
| 899 | - public function countUsers($filter, $attr = array('dn'), $limit = null, $offset = null) { |
|
| 900 | - return $this->count($filter, $this->connection->ldapBaseUsers, $attr, $limit, $offset); |
|
| 901 | - } |
|
| 902 | - |
|
| 903 | - /** |
|
| 904 | - * executes an LDAP search, optimized for Groups |
|
| 905 | - * @param string $filter the LDAP filter for the search |
|
| 906 | - * @param string|string[] $attr optional, when a certain attribute shall be filtered out |
|
| 907 | - * @param integer $limit |
|
| 908 | - * @param integer $offset |
|
| 909 | - * @return array with the search result |
|
| 910 | - * |
|
| 911 | - * Executes an LDAP search |
|
| 912 | - */ |
|
| 913 | - public function searchGroups($filter, $attr = null, $limit = null, $offset = null) { |
|
| 914 | - return $this->search($filter, $this->connection->ldapBaseGroups, $attr, $limit, $offset); |
|
| 915 | - } |
|
| 916 | - |
|
| 917 | - /** |
|
| 918 | - * returns the number of available groups |
|
| 919 | - * @param string $filter the LDAP search filter |
|
| 920 | - * @param string[] $attr optional |
|
| 921 | - * @param int|null $limit |
|
| 922 | - * @param int|null $offset |
|
| 923 | - * @return int|bool |
|
| 924 | - */ |
|
| 925 | - public function countGroups($filter, $attr = array('dn'), $limit = null, $offset = null) { |
|
| 926 | - return $this->count($filter, $this->connection->ldapBaseGroups, $attr, $limit, $offset); |
|
| 927 | - } |
|
| 928 | - |
|
| 929 | - /** |
|
| 930 | - * returns the number of available objects on the base DN |
|
| 931 | - * |
|
| 932 | - * @param int|null $limit |
|
| 933 | - * @param int|null $offset |
|
| 934 | - * @return int|bool |
|
| 935 | - */ |
|
| 936 | - public function countObjects($limit = null, $offset = null) { |
|
| 937 | - return $this->count('objectclass=*', $this->connection->ldapBase, array('dn'), $limit, $offset); |
|
| 938 | - } |
|
| 939 | - |
|
| 940 | - /** |
|
| 941 | - * retrieved. Results will according to the order in the array. |
|
| 942 | - * @param int $limit optional, maximum results to be counted |
|
| 943 | - * @param int $offset optional, a starting point |
|
| 944 | - * @return array|false array with the search result as first value and pagedSearchOK as |
|
| 945 | - * second | false if not successful |
|
| 946 | - */ |
|
| 947 | - private function executeSearch($filter, $base, &$attr = null, $limit = null, $offset = null) { |
|
| 948 | - if(!is_null($attr) && !is_array($attr)) { |
|
| 949 | - $attr = array(mb_strtolower($attr, 'UTF-8')); |
|
| 950 | - } |
|
| 951 | - |
|
| 952 | - // See if we have a resource, in case not cancel with message |
|
| 953 | - $cr = $this->connection->getConnectionResource(); |
|
| 954 | - if(!$this->ldap->isResource($cr)) { |
|
| 955 | - // Seems like we didn't find any resource. |
|
| 956 | - // Return an empty array just like before. |
|
| 957 | - \OCP\Util::writeLog('user_ldap', 'Could not search, because resource is missing.', \OCP\Util::DEBUG); |
|
| 958 | - return false; |
|
| 959 | - } |
|
| 960 | - |
|
| 961 | - //check whether paged search should be attempted |
|
| 962 | - $pagedSearchOK = $this->initPagedSearch($filter, $base, $attr, intval($limit), $offset); |
|
| 963 | - |
|
| 964 | - $linkResources = array_pad(array(), count($base), $cr); |
|
| 965 | - $sr = $this->ldap->search($linkResources, $base, $filter, $attr); |
|
| 966 | - $error = $this->ldap->errno($cr); |
|
| 967 | - if(!is_array($sr) || $error !== 0) { |
|
| 968 | - \OCP\Util::writeLog('user_ldap', 'Attempt for Paging? '.print_r($pagedSearchOK, true), \OCP\Util::ERROR); |
|
| 969 | - return false; |
|
| 970 | - } |
|
| 971 | - |
|
| 972 | - return array($sr, $pagedSearchOK); |
|
| 973 | - } |
|
| 974 | - |
|
| 975 | - /** |
|
| 976 | - * processes an LDAP paged search operation |
|
| 977 | - * @param array $sr the array containing the LDAP search resources |
|
| 978 | - * @param string $filter the LDAP filter for the search |
|
| 979 | - * @param array $base an array containing the LDAP subtree(s) that shall be searched |
|
| 980 | - * @param int $iFoundItems number of results in the search operation |
|
| 981 | - * @param int $limit maximum results to be counted |
|
| 982 | - * @param int $offset a starting point |
|
| 983 | - * @param bool $pagedSearchOK whether a paged search has been executed |
|
| 984 | - * @param bool $skipHandling required for paged search when cookies to |
|
| 985 | - * prior results need to be gained |
|
| 986 | - * @return bool cookie validity, true if we have more pages, false otherwise. |
|
| 987 | - */ |
|
| 988 | - private function processPagedSearchStatus($sr, $filter, $base, $iFoundItems, $limit, $offset, $pagedSearchOK, $skipHandling) { |
|
| 989 | - $cookie = null; |
|
| 990 | - if($pagedSearchOK) { |
|
| 991 | - $cr = $this->connection->getConnectionResource(); |
|
| 992 | - foreach($sr as $key => $res) { |
|
| 993 | - if($this->ldap->controlPagedResultResponse($cr, $res, $cookie)) { |
|
| 994 | - $this->setPagedResultCookie($base[$key], $filter, $limit, $offset, $cookie); |
|
| 995 | - } |
|
| 996 | - } |
|
| 997 | - |
|
| 998 | - //browsing through prior pages to get the cookie for the new one |
|
| 999 | - if($skipHandling) { |
|
| 1000 | - return false; |
|
| 1001 | - } |
|
| 1002 | - // if count is bigger, then the server does not support |
|
| 1003 | - // paged search. Instead, he did a normal search. We set a |
|
| 1004 | - // flag here, so the callee knows how to deal with it. |
|
| 1005 | - if($iFoundItems <= $limit) { |
|
| 1006 | - $this->pagedSearchedSuccessful = true; |
|
| 1007 | - } |
|
| 1008 | - } else { |
|
| 1009 | - if(!is_null($limit)) { |
|
| 1010 | - \OCP\Util::writeLog('user_ldap', 'Paged search was not available', \OCP\Util::INFO); |
|
| 1011 | - } |
|
| 1012 | - } |
|
| 1013 | - /* ++ Fixing RHDS searches with pages with zero results ++ |
|
| 347 | + try { |
|
| 348 | + return $this->ldap->modReplace($cr, $userDN, $password); |
|
| 349 | + } catch(ConstraintViolationException $e) { |
|
| 350 | + throw new HintException('Password change rejected.', \OC::$server->getL10N('user_ldap')->t('Password change rejected. Hint: ').$e->getMessage(), $e->getCode()); |
|
| 351 | + } |
|
| 352 | + } |
|
| 353 | + |
|
| 354 | + /** |
|
| 355 | + * checks whether the given attributes value is probably a DN |
|
| 356 | + * @param string $attr the attribute in question |
|
| 357 | + * @return boolean if so true, otherwise false |
|
| 358 | + */ |
|
| 359 | + private function resemblesDN($attr) { |
|
| 360 | + $resemblingAttributes = array( |
|
| 361 | + 'dn', |
|
| 362 | + 'uniquemember', |
|
| 363 | + 'member', |
|
| 364 | + // memberOf is an "operational" attribute, without a definition in any RFC |
|
| 365 | + 'memberof' |
|
| 366 | + ); |
|
| 367 | + return in_array($attr, $resemblingAttributes); |
|
| 368 | + } |
|
| 369 | + |
|
| 370 | + /** |
|
| 371 | + * checks whether the given string is probably a DN |
|
| 372 | + * @param string $string |
|
| 373 | + * @return boolean |
|
| 374 | + */ |
|
| 375 | + public function stringResemblesDN($string) { |
|
| 376 | + $r = $this->ldap->explodeDN($string, 0); |
|
| 377 | + // if exploding a DN succeeds and does not end up in |
|
| 378 | + // an empty array except for $r[count] being 0. |
|
| 379 | + return (is_array($r) && count($r) > 1); |
|
| 380 | + } |
|
| 381 | + |
|
| 382 | + /** |
|
| 383 | + * returns a DN-string that is cleaned from not domain parts, e.g. |
|
| 384 | + * cn=foo,cn=bar,dc=foobar,dc=server,dc=org |
|
| 385 | + * becomes dc=foobar,dc=server,dc=org |
|
| 386 | + * @param string $dn |
|
| 387 | + * @return string |
|
| 388 | + */ |
|
| 389 | + public function getDomainDNFromDN($dn) { |
|
| 390 | + $allParts = $this->ldap->explodeDN($dn, 0); |
|
| 391 | + if($allParts === false) { |
|
| 392 | + //not a valid DN |
|
| 393 | + return ''; |
|
| 394 | + } |
|
| 395 | + $domainParts = array(); |
|
| 396 | + $dcFound = false; |
|
| 397 | + foreach($allParts as $part) { |
|
| 398 | + if(!$dcFound && strpos($part, 'dc=') === 0) { |
|
| 399 | + $dcFound = true; |
|
| 400 | + } |
|
| 401 | + if($dcFound) { |
|
| 402 | + $domainParts[] = $part; |
|
| 403 | + } |
|
| 404 | + } |
|
| 405 | + $domainDN = implode(',', $domainParts); |
|
| 406 | + return $domainDN; |
|
| 407 | + } |
|
| 408 | + |
|
| 409 | + /** |
|
| 410 | + * returns the LDAP DN for the given internal ownCloud name of the group |
|
| 411 | + * @param string $name the ownCloud name in question |
|
| 412 | + * @return string|false LDAP DN on success, otherwise false |
|
| 413 | + */ |
|
| 414 | + public function groupname2dn($name) { |
|
| 415 | + return $this->groupMapper->getDNByName($name); |
|
| 416 | + } |
|
| 417 | + |
|
| 418 | + /** |
|
| 419 | + * returns the LDAP DN for the given internal ownCloud name of the user |
|
| 420 | + * @param string $name the ownCloud name in question |
|
| 421 | + * @return string|false with the LDAP DN on success, otherwise false |
|
| 422 | + */ |
|
| 423 | + public function username2dn($name) { |
|
| 424 | + $fdn = $this->userMapper->getDNByName($name); |
|
| 425 | + |
|
| 426 | + //Check whether the DN belongs to the Base, to avoid issues on multi- |
|
| 427 | + //server setups |
|
| 428 | + if(is_string($fdn) && $this->isDNPartOfBase($fdn, $this->connection->ldapBaseUsers)) { |
|
| 429 | + return $fdn; |
|
| 430 | + } |
|
| 431 | + |
|
| 432 | + return false; |
|
| 433 | + } |
|
| 434 | + |
|
| 435 | + /** |
|
| 436 | + * returns the internal ownCloud name for the given LDAP DN of the group, false on DN outside of search DN or failure |
|
| 437 | + * @param string $fdn the dn of the group object |
|
| 438 | + * @param string $ldapName optional, the display name of the object |
|
| 439 | + * @return string|false with the name to use in ownCloud, false on DN outside of search DN |
|
| 440 | + */ |
|
| 441 | + public function dn2groupname($fdn, $ldapName = null) { |
|
| 442 | + //To avoid bypassing the base DN settings under certain circumstances |
|
| 443 | + //with the group support, check whether the provided DN matches one of |
|
| 444 | + //the given Bases |
|
| 445 | + if(!$this->isDNPartOfBase($fdn, $this->connection->ldapBaseGroups)) { |
|
| 446 | + return false; |
|
| 447 | + } |
|
| 448 | + |
|
| 449 | + return $this->dn2ocname($fdn, $ldapName, false); |
|
| 450 | + } |
|
| 451 | + |
|
| 452 | + /** |
|
| 453 | + * accepts an array of group DNs and tests whether they match the user |
|
| 454 | + * filter by doing read operations against the group entries. Returns an |
|
| 455 | + * array of DNs that match the filter. |
|
| 456 | + * |
|
| 457 | + * @param string[] $groupDNs |
|
| 458 | + * @return string[] |
|
| 459 | + */ |
|
| 460 | + public function groupsMatchFilter($groupDNs) { |
|
| 461 | + $validGroupDNs = []; |
|
| 462 | + foreach($groupDNs as $dn) { |
|
| 463 | + $cacheKey = 'groupsMatchFilter-'.$dn; |
|
| 464 | + $groupMatchFilter = $this->connection->getFromCache($cacheKey); |
|
| 465 | + if(!is_null($groupMatchFilter)) { |
|
| 466 | + if($groupMatchFilter) { |
|
| 467 | + $validGroupDNs[] = $dn; |
|
| 468 | + } |
|
| 469 | + continue; |
|
| 470 | + } |
|
| 471 | + |
|
| 472 | + // Check the base DN first. If this is not met already, we don't |
|
| 473 | + // need to ask the server at all. |
|
| 474 | + if(!$this->isDNPartOfBase($dn, $this->connection->ldapBaseGroups)) { |
|
| 475 | + $this->connection->writeToCache($cacheKey, false); |
|
| 476 | + continue; |
|
| 477 | + } |
|
| 478 | + |
|
| 479 | + $result = $this->readAttribute($dn, 'cn', $this->connection->ldapGroupFilter); |
|
| 480 | + if(is_array($result)) { |
|
| 481 | + $this->connection->writeToCache($cacheKey, true); |
|
| 482 | + $validGroupDNs[] = $dn; |
|
| 483 | + } else { |
|
| 484 | + $this->connection->writeToCache($cacheKey, false); |
|
| 485 | + } |
|
| 486 | + |
|
| 487 | + } |
|
| 488 | + return $validGroupDNs; |
|
| 489 | + } |
|
| 490 | + |
|
| 491 | + /** |
|
| 492 | + * returns the internal ownCloud name for the given LDAP DN of the user, false on DN outside of search DN or failure |
|
| 493 | + * @param string $dn the dn of the user object |
|
| 494 | + * @param string $ldapName optional, the display name of the object |
|
| 495 | + * @return string|false with with the name to use in ownCloud |
|
| 496 | + */ |
|
| 497 | + public function dn2username($fdn, $ldapName = null) { |
|
| 498 | + //To avoid bypassing the base DN settings under certain circumstances |
|
| 499 | + //with the group support, check whether the provided DN matches one of |
|
| 500 | + //the given Bases |
|
| 501 | + if(!$this->isDNPartOfBase($fdn, $this->connection->ldapBaseUsers)) { |
|
| 502 | + return false; |
|
| 503 | + } |
|
| 504 | + |
|
| 505 | + return $this->dn2ocname($fdn, $ldapName, true); |
|
| 506 | + } |
|
| 507 | + |
|
| 508 | + /** |
|
| 509 | + * returns an internal ownCloud name for the given LDAP DN, false on DN outside of search DN |
|
| 510 | + * @param string $dn the dn of the user object |
|
| 511 | + * @param string $ldapName optional, the display name of the object |
|
| 512 | + * @param bool $isUser optional, whether it is a user object (otherwise group assumed) |
|
| 513 | + * @return string|false with with the name to use in ownCloud |
|
| 514 | + */ |
|
| 515 | + public function dn2ocname($fdn, $ldapName = null, $isUser = true) { |
|
| 516 | + if($isUser) { |
|
| 517 | + $mapper = $this->getUserMapper(); |
|
| 518 | + $nameAttribute = $this->connection->ldapUserDisplayName; |
|
| 519 | + } else { |
|
| 520 | + $mapper = $this->getGroupMapper(); |
|
| 521 | + $nameAttribute = $this->connection->ldapGroupDisplayName; |
|
| 522 | + } |
|
| 523 | + |
|
| 524 | + //let's try to retrieve the ownCloud name from the mappings table |
|
| 525 | + $ocName = $mapper->getNameByDN($fdn); |
|
| 526 | + if(is_string($ocName)) { |
|
| 527 | + return $ocName; |
|
| 528 | + } |
|
| 529 | + |
|
| 530 | + //second try: get the UUID and check if it is known. Then, update the DN and return the name. |
|
| 531 | + $uuid = $this->getUUID($fdn, $isUser); |
|
| 532 | + if(is_string($uuid)) { |
|
| 533 | + $ocName = $mapper->getNameByUUID($uuid); |
|
| 534 | + if(is_string($ocName)) { |
|
| 535 | + $mapper->setDNbyUUID($fdn, $uuid); |
|
| 536 | + return $ocName; |
|
| 537 | + } |
|
| 538 | + } else { |
|
| 539 | + //If the UUID can't be detected something is foul. |
|
| 540 | + \OCP\Util::writeLog('user_ldap', 'Cannot determine UUID for '.$fdn.'. Skipping.', \OCP\Util::INFO); |
|
| 541 | + return false; |
|
| 542 | + } |
|
| 543 | + |
|
| 544 | + if(is_null($ldapName)) { |
|
| 545 | + $ldapName = $this->readAttribute($fdn, $nameAttribute); |
|
| 546 | + if(!isset($ldapName[0]) && empty($ldapName[0])) { |
|
| 547 | + \OCP\Util::writeLog('user_ldap', 'No or empty name for '.$fdn.'.', \OCP\Util::INFO); |
|
| 548 | + return false; |
|
| 549 | + } |
|
| 550 | + $ldapName = $ldapName[0]; |
|
| 551 | + } |
|
| 552 | + |
|
| 553 | + if($isUser) { |
|
| 554 | + $usernameAttribute = strval($this->connection->ldapExpertUsernameAttr); |
|
| 555 | + if ($usernameAttribute !== '') { |
|
| 556 | + $username = $this->readAttribute($fdn, $usernameAttribute); |
|
| 557 | + $username = $username[0]; |
|
| 558 | + } else { |
|
| 559 | + $username = $uuid; |
|
| 560 | + } |
|
| 561 | + $intName = $this->sanitizeUsername($username); |
|
| 562 | + } else { |
|
| 563 | + $intName = $ldapName; |
|
| 564 | + } |
|
| 565 | + |
|
| 566 | + //a new user/group! Add it only if it doesn't conflict with other backend's users or existing groups |
|
| 567 | + //disabling Cache is required to avoid that the new user is cached as not-existing in fooExists check |
|
| 568 | + //NOTE: mind, disabling cache affects only this instance! Using it |
|
| 569 | + // outside of core user management will still cache the user as non-existing. |
|
| 570 | + $originalTTL = $this->connection->ldapCacheTTL; |
|
| 571 | + $this->connection->setConfiguration(array('ldapCacheTTL' => 0)); |
|
| 572 | + if(($isUser && !\OCP\User::userExists($intName)) |
|
| 573 | + || (!$isUser && !\OC_Group::groupExists($intName))) { |
|
| 574 | + if($mapper->map($fdn, $intName, $uuid)) { |
|
| 575 | + $this->connection->setConfiguration(array('ldapCacheTTL' => $originalTTL)); |
|
| 576 | + return $intName; |
|
| 577 | + } |
|
| 578 | + } |
|
| 579 | + $this->connection->setConfiguration(array('ldapCacheTTL' => $originalTTL)); |
|
| 580 | + |
|
| 581 | + $altName = $this->createAltInternalOwnCloudName($intName, $isUser); |
|
| 582 | + if(is_string($altName) && $mapper->map($fdn, $altName, $uuid)) { |
|
| 583 | + return $altName; |
|
| 584 | + } |
|
| 585 | + |
|
| 586 | + //if everything else did not help.. |
|
| 587 | + \OCP\Util::writeLog('user_ldap', 'Could not create unique name for '.$fdn.'.', \OCP\Util::INFO); |
|
| 588 | + return false; |
|
| 589 | + } |
|
| 590 | + |
|
| 591 | + /** |
|
| 592 | + * gives back the user names as they are used ownClod internally |
|
| 593 | + * @param array $ldapUsers as returned by fetchList() |
|
| 594 | + * @return array an array with the user names to use in ownCloud |
|
| 595 | + * |
|
| 596 | + * gives back the user names as they are used ownClod internally |
|
| 597 | + */ |
|
| 598 | + public function ownCloudUserNames($ldapUsers) { |
|
| 599 | + return $this->ldap2ownCloudNames($ldapUsers, true); |
|
| 600 | + } |
|
| 601 | + |
|
| 602 | + /** |
|
| 603 | + * gives back the group names as they are used ownClod internally |
|
| 604 | + * @param array $ldapGroups as returned by fetchList() |
|
| 605 | + * @return array an array with the group names to use in ownCloud |
|
| 606 | + * |
|
| 607 | + * gives back the group names as they are used ownClod internally |
|
| 608 | + */ |
|
| 609 | + public function ownCloudGroupNames($ldapGroups) { |
|
| 610 | + return $this->ldap2ownCloudNames($ldapGroups, false); |
|
| 611 | + } |
|
| 612 | + |
|
| 613 | + /** |
|
| 614 | + * @param array $ldapObjects as returned by fetchList() |
|
| 615 | + * @param bool $isUsers |
|
| 616 | + * @return array |
|
| 617 | + */ |
|
| 618 | + private function ldap2ownCloudNames($ldapObjects, $isUsers) { |
|
| 619 | + if($isUsers) { |
|
| 620 | + $nameAttribute = $this->connection->ldapUserDisplayName; |
|
| 621 | + $sndAttribute = $this->connection->ldapUserDisplayName2; |
|
| 622 | + } else { |
|
| 623 | + $nameAttribute = $this->connection->ldapGroupDisplayName; |
|
| 624 | + } |
|
| 625 | + $ownCloudNames = array(); |
|
| 626 | + |
|
| 627 | + foreach($ldapObjects as $ldapObject) { |
|
| 628 | + $nameByLDAP = null; |
|
| 629 | + if( isset($ldapObject[$nameAttribute]) |
|
| 630 | + && is_array($ldapObject[$nameAttribute]) |
|
| 631 | + && isset($ldapObject[$nameAttribute][0]) |
|
| 632 | + ) { |
|
| 633 | + // might be set, but not necessarily. if so, we use it. |
|
| 634 | + $nameByLDAP = $ldapObject[$nameAttribute][0]; |
|
| 635 | + } |
|
| 636 | + |
|
| 637 | + $ocName = $this->dn2ocname($ldapObject['dn'][0], $nameByLDAP, $isUsers); |
|
| 638 | + if($ocName) { |
|
| 639 | + $ownCloudNames[] = $ocName; |
|
| 640 | + if($isUsers) { |
|
| 641 | + //cache the user names so it does not need to be retrieved |
|
| 642 | + //again later (e.g. sharing dialogue). |
|
| 643 | + if(is_null($nameByLDAP)) { |
|
| 644 | + continue; |
|
| 645 | + } |
|
| 646 | + $sndName = isset($ldapObject[$sndAttribute][0]) |
|
| 647 | + ? $ldapObject[$sndAttribute][0] : ''; |
|
| 648 | + $this->cacheUserDisplayName($ocName, $nameByLDAP, $sndName); |
|
| 649 | + } |
|
| 650 | + } |
|
| 651 | + } |
|
| 652 | + return $ownCloudNames; |
|
| 653 | + } |
|
| 654 | + |
|
| 655 | + /** |
|
| 656 | + * caches the user display name |
|
| 657 | + * @param string $ocName the internal ownCloud username |
|
| 658 | + * @param string|false $home the home directory path |
|
| 659 | + */ |
|
| 660 | + public function cacheUserHome($ocName, $home) { |
|
| 661 | + $cacheKey = 'getHome'.$ocName; |
|
| 662 | + $this->connection->writeToCache($cacheKey, $home); |
|
| 663 | + } |
|
| 664 | + |
|
| 665 | + /** |
|
| 666 | + * caches a user as existing |
|
| 667 | + * @param string $ocName the internal ownCloud username |
|
| 668 | + */ |
|
| 669 | + public function cacheUserExists($ocName) { |
|
| 670 | + $this->connection->writeToCache('userExists'.$ocName, true); |
|
| 671 | + } |
|
| 672 | + |
|
| 673 | + /** |
|
| 674 | + * caches the user display name |
|
| 675 | + * @param string $ocName the internal ownCloud username |
|
| 676 | + * @param string $displayName the display name |
|
| 677 | + * @param string $displayName2 the second display name |
|
| 678 | + */ |
|
| 679 | + public function cacheUserDisplayName($ocName, $displayName, $displayName2 = '') { |
|
| 680 | + $user = $this->userManager->get($ocName); |
|
| 681 | + if($user === null) { |
|
| 682 | + return; |
|
| 683 | + } |
|
| 684 | + $displayName = $user->composeAndStoreDisplayName($displayName, $displayName2); |
|
| 685 | + $cacheKeyTrunk = 'getDisplayName'; |
|
| 686 | + $this->connection->writeToCache($cacheKeyTrunk.$ocName, $displayName); |
|
| 687 | + } |
|
| 688 | + |
|
| 689 | + /** |
|
| 690 | + * creates a unique name for internal ownCloud use for users. Don't call it directly. |
|
| 691 | + * @param string $name the display name of the object |
|
| 692 | + * @return string|false with with the name to use in ownCloud or false if unsuccessful |
|
| 693 | + * |
|
| 694 | + * Instead of using this method directly, call |
|
| 695 | + * createAltInternalOwnCloudName($name, true) |
|
| 696 | + */ |
|
| 697 | + private function _createAltInternalOwnCloudNameForUsers($name) { |
|
| 698 | + $attempts = 0; |
|
| 699 | + //while loop is just a precaution. If a name is not generated within |
|
| 700 | + //20 attempts, something else is very wrong. Avoids infinite loop. |
|
| 701 | + while($attempts < 20){ |
|
| 702 | + $altName = $name . '_' . rand(1000,9999); |
|
| 703 | + if(!\OCP\User::userExists($altName)) { |
|
| 704 | + return $altName; |
|
| 705 | + } |
|
| 706 | + $attempts++; |
|
| 707 | + } |
|
| 708 | + return false; |
|
| 709 | + } |
|
| 710 | + |
|
| 711 | + /** |
|
| 712 | + * creates a unique name for internal ownCloud use for groups. Don't call it directly. |
|
| 713 | + * @param string $name the display name of the object |
|
| 714 | + * @return string|false with with the name to use in ownCloud or false if unsuccessful. |
|
| 715 | + * |
|
| 716 | + * Instead of using this method directly, call |
|
| 717 | + * createAltInternalOwnCloudName($name, false) |
|
| 718 | + * |
|
| 719 | + * Group names are also used as display names, so we do a sequential |
|
| 720 | + * numbering, e.g. Developers_42 when there are 41 other groups called |
|
| 721 | + * "Developers" |
|
| 722 | + */ |
|
| 723 | + private function _createAltInternalOwnCloudNameForGroups($name) { |
|
| 724 | + $usedNames = $this->groupMapper->getNamesBySearch($name, "", '_%'); |
|
| 725 | + if(!($usedNames) || count($usedNames) === 0) { |
|
| 726 | + $lastNo = 1; //will become name_2 |
|
| 727 | + } else { |
|
| 728 | + natsort($usedNames); |
|
| 729 | + $lastName = array_pop($usedNames); |
|
| 730 | + $lastNo = intval(substr($lastName, strrpos($lastName, '_') + 1)); |
|
| 731 | + } |
|
| 732 | + $altName = $name.'_'.strval($lastNo+1); |
|
| 733 | + unset($usedNames); |
|
| 734 | + |
|
| 735 | + $attempts = 1; |
|
| 736 | + while($attempts < 21){ |
|
| 737 | + // Check to be really sure it is unique |
|
| 738 | + // while loop is just a precaution. If a name is not generated within |
|
| 739 | + // 20 attempts, something else is very wrong. Avoids infinite loop. |
|
| 740 | + if(!\OC_Group::groupExists($altName)) { |
|
| 741 | + return $altName; |
|
| 742 | + } |
|
| 743 | + $altName = $name . '_' . ($lastNo + $attempts); |
|
| 744 | + $attempts++; |
|
| 745 | + } |
|
| 746 | + return false; |
|
| 747 | + } |
|
| 748 | + |
|
| 749 | + /** |
|
| 750 | + * creates a unique name for internal ownCloud use. |
|
| 751 | + * @param string $name the display name of the object |
|
| 752 | + * @param boolean $isUser whether name should be created for a user (true) or a group (false) |
|
| 753 | + * @return string|false with with the name to use in ownCloud or false if unsuccessful |
|
| 754 | + */ |
|
| 755 | + private function createAltInternalOwnCloudName($name, $isUser) { |
|
| 756 | + $originalTTL = $this->connection->ldapCacheTTL; |
|
| 757 | + $this->connection->setConfiguration(array('ldapCacheTTL' => 0)); |
|
| 758 | + if($isUser) { |
|
| 759 | + $altName = $this->_createAltInternalOwnCloudNameForUsers($name); |
|
| 760 | + } else { |
|
| 761 | + $altName = $this->_createAltInternalOwnCloudNameForGroups($name); |
|
| 762 | + } |
|
| 763 | + $this->connection->setConfiguration(array('ldapCacheTTL' => $originalTTL)); |
|
| 764 | + |
|
| 765 | + return $altName; |
|
| 766 | + } |
|
| 767 | + |
|
| 768 | + /** |
|
| 769 | + * fetches a list of users according to a provided loginName and utilizing |
|
| 770 | + * the login filter. |
|
| 771 | + * |
|
| 772 | + * @param string $loginName |
|
| 773 | + * @param array $attributes optional, list of attributes to read |
|
| 774 | + * @return array |
|
| 775 | + */ |
|
| 776 | + public function fetchUsersByLoginName($loginName, $attributes = array('dn')) { |
|
| 777 | + $loginName = $this->escapeFilterPart($loginName); |
|
| 778 | + $filter = str_replace('%uid', $loginName, $this->connection->ldapLoginFilter); |
|
| 779 | + $users = $this->fetchListOfUsers($filter, $attributes); |
|
| 780 | + return $users; |
|
| 781 | + } |
|
| 782 | + |
|
| 783 | + /** |
|
| 784 | + * counts the number of users according to a provided loginName and |
|
| 785 | + * utilizing the login filter. |
|
| 786 | + * |
|
| 787 | + * @param string $loginName |
|
| 788 | + * @return array |
|
| 789 | + */ |
|
| 790 | + public function countUsersByLoginName($loginName) { |
|
| 791 | + $loginName = $this->escapeFilterPart($loginName); |
|
| 792 | + $filter = str_replace('%uid', $loginName, $this->connection->ldapLoginFilter); |
|
| 793 | + $users = $this->countUsers($filter); |
|
| 794 | + return $users; |
|
| 795 | + } |
|
| 796 | + |
|
| 797 | + /** |
|
| 798 | + * @param string $filter |
|
| 799 | + * @param string|string[] $attr |
|
| 800 | + * @param int $limit |
|
| 801 | + * @param int $offset |
|
| 802 | + * @return array |
|
| 803 | + */ |
|
| 804 | + public function fetchListOfUsers($filter, $attr, $limit = null, $offset = null) { |
|
| 805 | + $ldapRecords = $this->searchUsers($filter, $attr, $limit, $offset); |
|
| 806 | + $this->batchApplyUserAttributes($ldapRecords); |
|
| 807 | + return $this->fetchList($ldapRecords, (count($attr) > 1)); |
|
| 808 | + } |
|
| 809 | + |
|
| 810 | + /** |
|
| 811 | + * provided with an array of LDAP user records the method will fetch the |
|
| 812 | + * user object and requests it to process the freshly fetched attributes and |
|
| 813 | + * and their values |
|
| 814 | + * @param array $ldapRecords |
|
| 815 | + */ |
|
| 816 | + public function batchApplyUserAttributes(array $ldapRecords){ |
|
| 817 | + $displayNameAttribute = strtolower($this->connection->ldapUserDisplayName); |
|
| 818 | + foreach($ldapRecords as $userRecord) { |
|
| 819 | + if(!isset($userRecord[$displayNameAttribute])) { |
|
| 820 | + // displayName is obligatory |
|
| 821 | + continue; |
|
| 822 | + } |
|
| 823 | + $ocName = $this->dn2ocname($userRecord['dn'][0]); |
|
| 824 | + if($ocName === false) { |
|
| 825 | + continue; |
|
| 826 | + } |
|
| 827 | + $this->cacheUserExists($ocName); |
|
| 828 | + $user = $this->userManager->get($ocName); |
|
| 829 | + if($user instanceof OfflineUser) { |
|
| 830 | + $user->unmark(); |
|
| 831 | + $user = $this->userManager->get($ocName); |
|
| 832 | + } |
|
| 833 | + if ($user !== null) { |
|
| 834 | + $user->processAttributes($userRecord); |
|
| 835 | + } else { |
|
| 836 | + \OC::$server->getLogger()->debug( |
|
| 837 | + "The ldap user manager returned null for $ocName", |
|
| 838 | + ['app'=>'user_ldap'] |
|
| 839 | + ); |
|
| 840 | + } |
|
| 841 | + } |
|
| 842 | + } |
|
| 843 | + |
|
| 844 | + /** |
|
| 845 | + * @param string $filter |
|
| 846 | + * @param string|string[] $attr |
|
| 847 | + * @param int $limit |
|
| 848 | + * @param int $offset |
|
| 849 | + * @return array |
|
| 850 | + */ |
|
| 851 | + public function fetchListOfGroups($filter, $attr, $limit = null, $offset = null) { |
|
| 852 | + return $this->fetchList($this->searchGroups($filter, $attr, $limit, $offset), (count($attr) > 1)); |
|
| 853 | + } |
|
| 854 | + |
|
| 855 | + /** |
|
| 856 | + * @param array $list |
|
| 857 | + * @param bool $manyAttributes |
|
| 858 | + * @return array |
|
| 859 | + */ |
|
| 860 | + private function fetchList($list, $manyAttributes) { |
|
| 861 | + if(is_array($list)) { |
|
| 862 | + if($manyAttributes) { |
|
| 863 | + return $list; |
|
| 864 | + } else { |
|
| 865 | + $list = array_reduce($list, function($carry, $item) { |
|
| 866 | + $attribute = array_keys($item)[0]; |
|
| 867 | + $carry[] = $item[$attribute][0]; |
|
| 868 | + return $carry; |
|
| 869 | + }, array()); |
|
| 870 | + return array_unique($list, SORT_LOCALE_STRING); |
|
| 871 | + } |
|
| 872 | + } |
|
| 873 | + |
|
| 874 | + //error cause actually, maybe throw an exception in future. |
|
| 875 | + return array(); |
|
| 876 | + } |
|
| 877 | + |
|
| 878 | + /** |
|
| 879 | + * executes an LDAP search, optimized for Users |
|
| 880 | + * @param string $filter the LDAP filter for the search |
|
| 881 | + * @param string|string[] $attr optional, when a certain attribute shall be filtered out |
|
| 882 | + * @param integer $limit |
|
| 883 | + * @param integer $offset |
|
| 884 | + * @return array with the search result |
|
| 885 | + * |
|
| 886 | + * Executes an LDAP search |
|
| 887 | + */ |
|
| 888 | + public function searchUsers($filter, $attr = null, $limit = null, $offset = null) { |
|
| 889 | + return $this->search($filter, $this->connection->ldapBaseUsers, $attr, $limit, $offset); |
|
| 890 | + } |
|
| 891 | + |
|
| 892 | + /** |
|
| 893 | + * @param string $filter |
|
| 894 | + * @param string|string[] $attr |
|
| 895 | + * @param int $limit |
|
| 896 | + * @param int $offset |
|
| 897 | + * @return false|int |
|
| 898 | + */ |
|
| 899 | + public function countUsers($filter, $attr = array('dn'), $limit = null, $offset = null) { |
|
| 900 | + return $this->count($filter, $this->connection->ldapBaseUsers, $attr, $limit, $offset); |
|
| 901 | + } |
|
| 902 | + |
|
| 903 | + /** |
|
| 904 | + * executes an LDAP search, optimized for Groups |
|
| 905 | + * @param string $filter the LDAP filter for the search |
|
| 906 | + * @param string|string[] $attr optional, when a certain attribute shall be filtered out |
|
| 907 | + * @param integer $limit |
|
| 908 | + * @param integer $offset |
|
| 909 | + * @return array with the search result |
|
| 910 | + * |
|
| 911 | + * Executes an LDAP search |
|
| 912 | + */ |
|
| 913 | + public function searchGroups($filter, $attr = null, $limit = null, $offset = null) { |
|
| 914 | + return $this->search($filter, $this->connection->ldapBaseGroups, $attr, $limit, $offset); |
|
| 915 | + } |
|
| 916 | + |
|
| 917 | + /** |
|
| 918 | + * returns the number of available groups |
|
| 919 | + * @param string $filter the LDAP search filter |
|
| 920 | + * @param string[] $attr optional |
|
| 921 | + * @param int|null $limit |
|
| 922 | + * @param int|null $offset |
|
| 923 | + * @return int|bool |
|
| 924 | + */ |
|
| 925 | + public function countGroups($filter, $attr = array('dn'), $limit = null, $offset = null) { |
|
| 926 | + return $this->count($filter, $this->connection->ldapBaseGroups, $attr, $limit, $offset); |
|
| 927 | + } |
|
| 928 | + |
|
| 929 | + /** |
|
| 930 | + * returns the number of available objects on the base DN |
|
| 931 | + * |
|
| 932 | + * @param int|null $limit |
|
| 933 | + * @param int|null $offset |
|
| 934 | + * @return int|bool |
|
| 935 | + */ |
|
| 936 | + public function countObjects($limit = null, $offset = null) { |
|
| 937 | + return $this->count('objectclass=*', $this->connection->ldapBase, array('dn'), $limit, $offset); |
|
| 938 | + } |
|
| 939 | + |
|
| 940 | + /** |
|
| 941 | + * retrieved. Results will according to the order in the array. |
|
| 942 | + * @param int $limit optional, maximum results to be counted |
|
| 943 | + * @param int $offset optional, a starting point |
|
| 944 | + * @return array|false array with the search result as first value and pagedSearchOK as |
|
| 945 | + * second | false if not successful |
|
| 946 | + */ |
|
| 947 | + private function executeSearch($filter, $base, &$attr = null, $limit = null, $offset = null) { |
|
| 948 | + if(!is_null($attr) && !is_array($attr)) { |
|
| 949 | + $attr = array(mb_strtolower($attr, 'UTF-8')); |
|
| 950 | + } |
|
| 951 | + |
|
| 952 | + // See if we have a resource, in case not cancel with message |
|
| 953 | + $cr = $this->connection->getConnectionResource(); |
|
| 954 | + if(!$this->ldap->isResource($cr)) { |
|
| 955 | + // Seems like we didn't find any resource. |
|
| 956 | + // Return an empty array just like before. |
|
| 957 | + \OCP\Util::writeLog('user_ldap', 'Could not search, because resource is missing.', \OCP\Util::DEBUG); |
|
| 958 | + return false; |
|
| 959 | + } |
|
| 960 | + |
|
| 961 | + //check whether paged search should be attempted |
|
| 962 | + $pagedSearchOK = $this->initPagedSearch($filter, $base, $attr, intval($limit), $offset); |
|
| 963 | + |
|
| 964 | + $linkResources = array_pad(array(), count($base), $cr); |
|
| 965 | + $sr = $this->ldap->search($linkResources, $base, $filter, $attr); |
|
| 966 | + $error = $this->ldap->errno($cr); |
|
| 967 | + if(!is_array($sr) || $error !== 0) { |
|
| 968 | + \OCP\Util::writeLog('user_ldap', 'Attempt for Paging? '.print_r($pagedSearchOK, true), \OCP\Util::ERROR); |
|
| 969 | + return false; |
|
| 970 | + } |
|
| 971 | + |
|
| 972 | + return array($sr, $pagedSearchOK); |
|
| 973 | + } |
|
| 974 | + |
|
| 975 | + /** |
|
| 976 | + * processes an LDAP paged search operation |
|
| 977 | + * @param array $sr the array containing the LDAP search resources |
|
| 978 | + * @param string $filter the LDAP filter for the search |
|
| 979 | + * @param array $base an array containing the LDAP subtree(s) that shall be searched |
|
| 980 | + * @param int $iFoundItems number of results in the search operation |
|
| 981 | + * @param int $limit maximum results to be counted |
|
| 982 | + * @param int $offset a starting point |
|
| 983 | + * @param bool $pagedSearchOK whether a paged search has been executed |
|
| 984 | + * @param bool $skipHandling required for paged search when cookies to |
|
| 985 | + * prior results need to be gained |
|
| 986 | + * @return bool cookie validity, true if we have more pages, false otherwise. |
|
| 987 | + */ |
|
| 988 | + private function processPagedSearchStatus($sr, $filter, $base, $iFoundItems, $limit, $offset, $pagedSearchOK, $skipHandling) { |
|
| 989 | + $cookie = null; |
|
| 990 | + if($pagedSearchOK) { |
|
| 991 | + $cr = $this->connection->getConnectionResource(); |
|
| 992 | + foreach($sr as $key => $res) { |
|
| 993 | + if($this->ldap->controlPagedResultResponse($cr, $res, $cookie)) { |
|
| 994 | + $this->setPagedResultCookie($base[$key], $filter, $limit, $offset, $cookie); |
|
| 995 | + } |
|
| 996 | + } |
|
| 997 | + |
|
| 998 | + //browsing through prior pages to get the cookie for the new one |
|
| 999 | + if($skipHandling) { |
|
| 1000 | + return false; |
|
| 1001 | + } |
|
| 1002 | + // if count is bigger, then the server does not support |
|
| 1003 | + // paged search. Instead, he did a normal search. We set a |
|
| 1004 | + // flag here, so the callee knows how to deal with it. |
|
| 1005 | + if($iFoundItems <= $limit) { |
|
| 1006 | + $this->pagedSearchedSuccessful = true; |
|
| 1007 | + } |
|
| 1008 | + } else { |
|
| 1009 | + if(!is_null($limit)) { |
|
| 1010 | + \OCP\Util::writeLog('user_ldap', 'Paged search was not available', \OCP\Util::INFO); |
|
| 1011 | + } |
|
| 1012 | + } |
|
| 1013 | + /* ++ Fixing RHDS searches with pages with zero results ++ |
|
| 1014 | 1014 | * Return cookie status. If we don't have more pages, with RHDS |
| 1015 | 1015 | * cookie is null, with openldap cookie is an empty string and |
| 1016 | 1016 | * to 386ds '0' is a valid cookie. Even if $iFoundItems == 0 |
| 1017 | 1017 | */ |
| 1018 | - return !empty($cookie) || $cookie === '0'; |
|
| 1019 | - } |
|
| 1020 | - |
|
| 1021 | - /** |
|
| 1022 | - * executes an LDAP search, but counts the results only |
|
| 1023 | - * @param string $filter the LDAP filter for the search |
|
| 1024 | - * @param array $base an array containing the LDAP subtree(s) that shall be searched |
|
| 1025 | - * @param string|string[] $attr optional, array, one or more attributes that shall be |
|
| 1026 | - * retrieved. Results will according to the order in the array. |
|
| 1027 | - * @param int $limit optional, maximum results to be counted |
|
| 1028 | - * @param int $offset optional, a starting point |
|
| 1029 | - * @param bool $skipHandling indicates whether the pages search operation is |
|
| 1030 | - * completed |
|
| 1031 | - * @return int|false Integer or false if the search could not be initialized |
|
| 1032 | - * |
|
| 1033 | - */ |
|
| 1034 | - private function count($filter, $base, $attr = null, $limit = null, $offset = null, $skipHandling = false) { |
|
| 1035 | - \OCP\Util::writeLog('user_ldap', 'Count filter: '.print_r($filter, true), \OCP\Util::DEBUG); |
|
| 1036 | - |
|
| 1037 | - $limitPerPage = intval($this->connection->ldapPagingSize); |
|
| 1038 | - if(!is_null($limit) && $limit < $limitPerPage && $limit > 0) { |
|
| 1039 | - $limitPerPage = $limit; |
|
| 1040 | - } |
|
| 1041 | - |
|
| 1042 | - $counter = 0; |
|
| 1043 | - $count = null; |
|
| 1044 | - $this->connection->getConnectionResource(); |
|
| 1045 | - |
|
| 1046 | - do { |
|
| 1047 | - $search = $this->executeSearch($filter, $base, $attr, |
|
| 1048 | - $limitPerPage, $offset); |
|
| 1049 | - if($search === false) { |
|
| 1050 | - return $counter > 0 ? $counter : false; |
|
| 1051 | - } |
|
| 1052 | - list($sr, $pagedSearchOK) = $search; |
|
| 1053 | - |
|
| 1054 | - /* ++ Fixing RHDS searches with pages with zero results ++ |
|
| 1018 | + return !empty($cookie) || $cookie === '0'; |
|
| 1019 | + } |
|
| 1020 | + |
|
| 1021 | + /** |
|
| 1022 | + * executes an LDAP search, but counts the results only |
|
| 1023 | + * @param string $filter the LDAP filter for the search |
|
| 1024 | + * @param array $base an array containing the LDAP subtree(s) that shall be searched |
|
| 1025 | + * @param string|string[] $attr optional, array, one or more attributes that shall be |
|
| 1026 | + * retrieved. Results will according to the order in the array. |
|
| 1027 | + * @param int $limit optional, maximum results to be counted |
|
| 1028 | + * @param int $offset optional, a starting point |
|
| 1029 | + * @param bool $skipHandling indicates whether the pages search operation is |
|
| 1030 | + * completed |
|
| 1031 | + * @return int|false Integer or false if the search could not be initialized |
|
| 1032 | + * |
|
| 1033 | + */ |
|
| 1034 | + private function count($filter, $base, $attr = null, $limit = null, $offset = null, $skipHandling = false) { |
|
| 1035 | + \OCP\Util::writeLog('user_ldap', 'Count filter: '.print_r($filter, true), \OCP\Util::DEBUG); |
|
| 1036 | + |
|
| 1037 | + $limitPerPage = intval($this->connection->ldapPagingSize); |
|
| 1038 | + if(!is_null($limit) && $limit < $limitPerPage && $limit > 0) { |
|
| 1039 | + $limitPerPage = $limit; |
|
| 1040 | + } |
|
| 1041 | + |
|
| 1042 | + $counter = 0; |
|
| 1043 | + $count = null; |
|
| 1044 | + $this->connection->getConnectionResource(); |
|
| 1045 | + |
|
| 1046 | + do { |
|
| 1047 | + $search = $this->executeSearch($filter, $base, $attr, |
|
| 1048 | + $limitPerPage, $offset); |
|
| 1049 | + if($search === false) { |
|
| 1050 | + return $counter > 0 ? $counter : false; |
|
| 1051 | + } |
|
| 1052 | + list($sr, $pagedSearchOK) = $search; |
|
| 1053 | + |
|
| 1054 | + /* ++ Fixing RHDS searches with pages with zero results ++ |
|
| 1055 | 1055 | * countEntriesInSearchResults() method signature changed |
| 1056 | 1056 | * by removing $limit and &$hasHitLimit parameters |
| 1057 | 1057 | */ |
| 1058 | - $count = $this->countEntriesInSearchResults($sr); |
|
| 1059 | - $counter += $count; |
|
| 1058 | + $count = $this->countEntriesInSearchResults($sr); |
|
| 1059 | + $counter += $count; |
|
| 1060 | 1060 | |
| 1061 | - $hasMorePages = $this->processPagedSearchStatus($sr, $filter, $base, $count, $limitPerPage, |
|
| 1062 | - $offset, $pagedSearchOK, $skipHandling); |
|
| 1063 | - $offset += $limitPerPage; |
|
| 1064 | - /* ++ Fixing RHDS searches with pages with zero results ++ |
|
| 1061 | + $hasMorePages = $this->processPagedSearchStatus($sr, $filter, $base, $count, $limitPerPage, |
|
| 1062 | + $offset, $pagedSearchOK, $skipHandling); |
|
| 1063 | + $offset += $limitPerPage; |
|
| 1064 | + /* ++ Fixing RHDS searches with pages with zero results ++ |
|
| 1065 | 1065 | * Continue now depends on $hasMorePages value |
| 1066 | 1066 | */ |
| 1067 | - $continue = $pagedSearchOK && $hasMorePages; |
|
| 1068 | - } while($continue && (is_null($limit) || $limit <= 0 || $limit > $counter)); |
|
| 1069 | - |
|
| 1070 | - return $counter; |
|
| 1071 | - } |
|
| 1072 | - |
|
| 1073 | - /** |
|
| 1074 | - * @param array $searchResults |
|
| 1075 | - * @return int |
|
| 1076 | - */ |
|
| 1077 | - private function countEntriesInSearchResults($searchResults) { |
|
| 1078 | - $cr = $this->connection->getConnectionResource(); |
|
| 1079 | - $counter = 0; |
|
| 1080 | - |
|
| 1081 | - foreach($searchResults as $res) { |
|
| 1082 | - $count = intval($this->ldap->countEntries($cr, $res)); |
|
| 1083 | - $counter += $count; |
|
| 1084 | - } |
|
| 1085 | - |
|
| 1086 | - return $counter; |
|
| 1087 | - } |
|
| 1088 | - |
|
| 1089 | - /** |
|
| 1090 | - * Executes an LDAP search |
|
| 1091 | - * @param string $filter the LDAP filter for the search |
|
| 1092 | - * @param array $base an array containing the LDAP subtree(s) that shall be searched |
|
| 1093 | - * @param string|string[] $attr optional, array, one or more attributes that shall be |
|
| 1094 | - * @param int $limit |
|
| 1095 | - * @param int $offset |
|
| 1096 | - * @param bool $skipHandling |
|
| 1097 | - * @return array with the search result |
|
| 1098 | - */ |
|
| 1099 | - private function search($filter, $base, $attr = null, $limit = null, $offset = null, $skipHandling = false) { |
|
| 1100 | - if($limit <= 0) { |
|
| 1101 | - //otherwise search will fail |
|
| 1102 | - $limit = null; |
|
| 1103 | - } |
|
| 1104 | - |
|
| 1105 | - /* ++ Fixing RHDS searches with pages with zero results ++ |
|
| 1067 | + $continue = $pagedSearchOK && $hasMorePages; |
|
| 1068 | + } while($continue && (is_null($limit) || $limit <= 0 || $limit > $counter)); |
|
| 1069 | + |
|
| 1070 | + return $counter; |
|
| 1071 | + } |
|
| 1072 | + |
|
| 1073 | + /** |
|
| 1074 | + * @param array $searchResults |
|
| 1075 | + * @return int |
|
| 1076 | + */ |
|
| 1077 | + private function countEntriesInSearchResults($searchResults) { |
|
| 1078 | + $cr = $this->connection->getConnectionResource(); |
|
| 1079 | + $counter = 0; |
|
| 1080 | + |
|
| 1081 | + foreach($searchResults as $res) { |
|
| 1082 | + $count = intval($this->ldap->countEntries($cr, $res)); |
|
| 1083 | + $counter += $count; |
|
| 1084 | + } |
|
| 1085 | + |
|
| 1086 | + return $counter; |
|
| 1087 | + } |
|
| 1088 | + |
|
| 1089 | + /** |
|
| 1090 | + * Executes an LDAP search |
|
| 1091 | + * @param string $filter the LDAP filter for the search |
|
| 1092 | + * @param array $base an array containing the LDAP subtree(s) that shall be searched |
|
| 1093 | + * @param string|string[] $attr optional, array, one or more attributes that shall be |
|
| 1094 | + * @param int $limit |
|
| 1095 | + * @param int $offset |
|
| 1096 | + * @param bool $skipHandling |
|
| 1097 | + * @return array with the search result |
|
| 1098 | + */ |
|
| 1099 | + private function search($filter, $base, $attr = null, $limit = null, $offset = null, $skipHandling = false) { |
|
| 1100 | + if($limit <= 0) { |
|
| 1101 | + //otherwise search will fail |
|
| 1102 | + $limit = null; |
|
| 1103 | + } |
|
| 1104 | + |
|
| 1105 | + /* ++ Fixing RHDS searches with pages with zero results ++ |
|
| 1106 | 1106 | * As we can have pages with zero results and/or pages with less |
| 1107 | 1107 | * than $limit results but with a still valid server 'cookie', |
| 1108 | 1108 | * loops through until we get $continue equals true and |
| 1109 | 1109 | * $findings['count'] < $limit |
| 1110 | 1110 | */ |
| 1111 | - $findings = array(); |
|
| 1112 | - $savedoffset = $offset; |
|
| 1113 | - do { |
|
| 1114 | - $search = $this->executeSearch($filter, $base, $attr, $limit, $offset); |
|
| 1115 | - if($search === false) { |
|
| 1116 | - return array(); |
|
| 1117 | - } |
|
| 1118 | - list($sr, $pagedSearchOK) = $search; |
|
| 1119 | - $cr = $this->connection->getConnectionResource(); |
|
| 1120 | - |
|
| 1121 | - if($skipHandling) { |
|
| 1122 | - //i.e. result do not need to be fetched, we just need the cookie |
|
| 1123 | - //thus pass 1 or any other value as $iFoundItems because it is not |
|
| 1124 | - //used |
|
| 1125 | - $this->processPagedSearchStatus($sr, $filter, $base, 1, $limit, |
|
| 1126 | - $offset, $pagedSearchOK, |
|
| 1127 | - $skipHandling); |
|
| 1128 | - return array(); |
|
| 1129 | - } |
|
| 1130 | - |
|
| 1131 | - foreach($sr as $res) { |
|
| 1132 | - $findings = array_merge($findings, $this->ldap->getEntries($cr , $res )); |
|
| 1133 | - } |
|
| 1134 | - |
|
| 1135 | - $continue = $this->processPagedSearchStatus($sr, $filter, $base, $findings['count'], |
|
| 1136 | - $limit, $offset, $pagedSearchOK, |
|
| 1137 | - $skipHandling); |
|
| 1138 | - $offset += $limit; |
|
| 1139 | - } while ($continue && $pagedSearchOK && $findings['count'] < $limit); |
|
| 1140 | - // reseting offset |
|
| 1141 | - $offset = $savedoffset; |
|
| 1142 | - |
|
| 1143 | - // if we're here, probably no connection resource is returned. |
|
| 1144 | - // to make ownCloud behave nicely, we simply give back an empty array. |
|
| 1145 | - if(is_null($findings)) { |
|
| 1146 | - return array(); |
|
| 1147 | - } |
|
| 1148 | - |
|
| 1149 | - if(!is_null($attr)) { |
|
| 1150 | - $selection = array(); |
|
| 1151 | - $i = 0; |
|
| 1152 | - foreach($findings as $item) { |
|
| 1153 | - if(!is_array($item)) { |
|
| 1154 | - continue; |
|
| 1155 | - } |
|
| 1156 | - $item = \OCP\Util::mb_array_change_key_case($item, MB_CASE_LOWER, 'UTF-8'); |
|
| 1157 | - foreach($attr as $key) { |
|
| 1158 | - $key = mb_strtolower($key, 'UTF-8'); |
|
| 1159 | - if(isset($item[$key])) { |
|
| 1160 | - if(is_array($item[$key]) && isset($item[$key]['count'])) { |
|
| 1161 | - unset($item[$key]['count']); |
|
| 1162 | - } |
|
| 1163 | - if($key !== 'dn') { |
|
| 1164 | - $selection[$i][$key] = $this->resemblesDN($key) ? |
|
| 1165 | - $this->helper->sanitizeDN($item[$key]) |
|
| 1166 | - : $item[$key]; |
|
| 1167 | - } else { |
|
| 1168 | - $selection[$i][$key] = [$this->helper->sanitizeDN($item[$key])]; |
|
| 1169 | - } |
|
| 1170 | - } |
|
| 1171 | - |
|
| 1172 | - } |
|
| 1173 | - $i++; |
|
| 1174 | - } |
|
| 1175 | - $findings = $selection; |
|
| 1176 | - } |
|
| 1177 | - //we slice the findings, when |
|
| 1178 | - //a) paged search unsuccessful, though attempted |
|
| 1179 | - //b) no paged search, but limit set |
|
| 1180 | - if((!$this->getPagedSearchResultState() |
|
| 1181 | - && $pagedSearchOK) |
|
| 1182 | - || ( |
|
| 1183 | - !$pagedSearchOK |
|
| 1184 | - && !is_null($limit) |
|
| 1185 | - ) |
|
| 1186 | - ) { |
|
| 1187 | - $findings = array_slice($findings, intval($offset), $limit); |
|
| 1188 | - } |
|
| 1189 | - return $findings; |
|
| 1190 | - } |
|
| 1191 | - |
|
| 1192 | - /** |
|
| 1193 | - * @param string $name |
|
| 1194 | - * @return bool|mixed|string |
|
| 1195 | - */ |
|
| 1196 | - public function sanitizeUsername($name) { |
|
| 1197 | - if($this->connection->ldapIgnoreNamingRules) { |
|
| 1198 | - return $name; |
|
| 1199 | - } |
|
| 1200 | - |
|
| 1201 | - // Transliteration |
|
| 1202 | - // latin characters to ASCII |
|
| 1203 | - $name = iconv('UTF-8', 'ASCII//TRANSLIT', $name); |
|
| 1204 | - |
|
| 1205 | - // Replacements |
|
| 1206 | - $name = str_replace(' ', '_', $name); |
|
| 1207 | - |
|
| 1208 | - // Every remaining disallowed characters will be removed |
|
| 1209 | - $name = preg_replace('/[^a-zA-Z0-9_.@-]/u', '', $name); |
|
| 1210 | - |
|
| 1211 | - return $name; |
|
| 1212 | - } |
|
| 1213 | - |
|
| 1214 | - /** |
|
| 1215 | - * escapes (user provided) parts for LDAP filter |
|
| 1216 | - * @param string $input, the provided value |
|
| 1217 | - * @param bool $allowAsterisk whether in * at the beginning should be preserved |
|
| 1218 | - * @return string the escaped string |
|
| 1219 | - */ |
|
| 1220 | - public function escapeFilterPart($input, $allowAsterisk = false) { |
|
| 1221 | - $asterisk = ''; |
|
| 1222 | - if($allowAsterisk && strlen($input) > 0 && $input[0] === '*') { |
|
| 1223 | - $asterisk = '*'; |
|
| 1224 | - $input = mb_substr($input, 1, null, 'UTF-8'); |
|
| 1225 | - } |
|
| 1226 | - $search = array('*', '\\', '(', ')'); |
|
| 1227 | - $replace = array('\\*', '\\\\', '\\(', '\\)'); |
|
| 1228 | - return $asterisk . str_replace($search, $replace, $input); |
|
| 1229 | - } |
|
| 1230 | - |
|
| 1231 | - /** |
|
| 1232 | - * combines the input filters with AND |
|
| 1233 | - * @param string[] $filters the filters to connect |
|
| 1234 | - * @return string the combined filter |
|
| 1235 | - */ |
|
| 1236 | - public function combineFilterWithAnd($filters) { |
|
| 1237 | - return $this->combineFilter($filters, '&'); |
|
| 1238 | - } |
|
| 1239 | - |
|
| 1240 | - /** |
|
| 1241 | - * combines the input filters with OR |
|
| 1242 | - * @param string[] $filters the filters to connect |
|
| 1243 | - * @return string the combined filter |
|
| 1244 | - * Combines Filter arguments with OR |
|
| 1245 | - */ |
|
| 1246 | - public function combineFilterWithOr($filters) { |
|
| 1247 | - return $this->combineFilter($filters, '|'); |
|
| 1248 | - } |
|
| 1249 | - |
|
| 1250 | - /** |
|
| 1251 | - * combines the input filters with given operator |
|
| 1252 | - * @param string[] $filters the filters to connect |
|
| 1253 | - * @param string $operator either & or | |
|
| 1254 | - * @return string the combined filter |
|
| 1255 | - */ |
|
| 1256 | - private function combineFilter($filters, $operator) { |
|
| 1257 | - $combinedFilter = '('.$operator; |
|
| 1258 | - foreach($filters as $filter) { |
|
| 1259 | - if ($filter !== '' && $filter[0] !== '(') { |
|
| 1260 | - $filter = '('.$filter.')'; |
|
| 1261 | - } |
|
| 1262 | - $combinedFilter.=$filter; |
|
| 1263 | - } |
|
| 1264 | - $combinedFilter.=')'; |
|
| 1265 | - return $combinedFilter; |
|
| 1266 | - } |
|
| 1267 | - |
|
| 1268 | - /** |
|
| 1269 | - * creates a filter part for to perform search for users |
|
| 1270 | - * @param string $search the search term |
|
| 1271 | - * @return string the final filter part to use in LDAP searches |
|
| 1272 | - */ |
|
| 1273 | - public function getFilterPartForUserSearch($search) { |
|
| 1274 | - return $this->getFilterPartForSearch($search, |
|
| 1275 | - $this->connection->ldapAttributesForUserSearch, |
|
| 1276 | - $this->connection->ldapUserDisplayName); |
|
| 1277 | - } |
|
| 1278 | - |
|
| 1279 | - /** |
|
| 1280 | - * creates a filter part for to perform search for groups |
|
| 1281 | - * @param string $search the search term |
|
| 1282 | - * @return string the final filter part to use in LDAP searches |
|
| 1283 | - */ |
|
| 1284 | - public function getFilterPartForGroupSearch($search) { |
|
| 1285 | - return $this->getFilterPartForSearch($search, |
|
| 1286 | - $this->connection->ldapAttributesForGroupSearch, |
|
| 1287 | - $this->connection->ldapGroupDisplayName); |
|
| 1288 | - } |
|
| 1289 | - |
|
| 1290 | - /** |
|
| 1291 | - * creates a filter part for searches by splitting up the given search |
|
| 1292 | - * string into single words |
|
| 1293 | - * @param string $search the search term |
|
| 1294 | - * @param string[] $searchAttributes needs to have at least two attributes, |
|
| 1295 | - * otherwise it does not make sense :) |
|
| 1296 | - * @return string the final filter part to use in LDAP searches |
|
| 1297 | - * @throws \Exception |
|
| 1298 | - */ |
|
| 1299 | - private function getAdvancedFilterPartForSearch($search, $searchAttributes) { |
|
| 1300 | - if(!is_array($searchAttributes) || count($searchAttributes) < 2) { |
|
| 1301 | - throw new \Exception('searchAttributes must be an array with at least two string'); |
|
| 1302 | - } |
|
| 1303 | - $searchWords = explode(' ', trim($search)); |
|
| 1304 | - $wordFilters = array(); |
|
| 1305 | - foreach($searchWords as $word) { |
|
| 1306 | - $word = $this->prepareSearchTerm($word); |
|
| 1307 | - //every word needs to appear at least once |
|
| 1308 | - $wordMatchOneAttrFilters = array(); |
|
| 1309 | - foreach($searchAttributes as $attr) { |
|
| 1310 | - $wordMatchOneAttrFilters[] = $attr . '=' . $word; |
|
| 1311 | - } |
|
| 1312 | - $wordFilters[] = $this->combineFilterWithOr($wordMatchOneAttrFilters); |
|
| 1313 | - } |
|
| 1314 | - return $this->combineFilterWithAnd($wordFilters); |
|
| 1315 | - } |
|
| 1316 | - |
|
| 1317 | - /** |
|
| 1318 | - * creates a filter part for searches |
|
| 1319 | - * @param string $search the search term |
|
| 1320 | - * @param string[]|null $searchAttributes |
|
| 1321 | - * @param string $fallbackAttribute a fallback attribute in case the user |
|
| 1322 | - * did not define search attributes. Typically the display name attribute. |
|
| 1323 | - * @return string the final filter part to use in LDAP searches |
|
| 1324 | - */ |
|
| 1325 | - private function getFilterPartForSearch($search, $searchAttributes, $fallbackAttribute) { |
|
| 1326 | - $filter = array(); |
|
| 1327 | - $haveMultiSearchAttributes = (is_array($searchAttributes) && count($searchAttributes) > 0); |
|
| 1328 | - if($haveMultiSearchAttributes && strpos(trim($search), ' ') !== false) { |
|
| 1329 | - try { |
|
| 1330 | - return $this->getAdvancedFilterPartForSearch($search, $searchAttributes); |
|
| 1331 | - } catch(\Exception $e) { |
|
| 1332 | - \OCP\Util::writeLog( |
|
| 1333 | - 'user_ldap', |
|
| 1334 | - 'Creating advanced filter for search failed, falling back to simple method.', |
|
| 1335 | - \OCP\Util::INFO |
|
| 1336 | - ); |
|
| 1337 | - } |
|
| 1338 | - } |
|
| 1339 | - |
|
| 1340 | - $search = $this->prepareSearchTerm($search); |
|
| 1341 | - if(!is_array($searchAttributes) || count($searchAttributes) === 0) { |
|
| 1342 | - if ($fallbackAttribute === '') { |
|
| 1343 | - return ''; |
|
| 1344 | - } |
|
| 1345 | - $filter[] = $fallbackAttribute . '=' . $search; |
|
| 1346 | - } else { |
|
| 1347 | - foreach($searchAttributes as $attribute) { |
|
| 1348 | - $filter[] = $attribute . '=' . $search; |
|
| 1349 | - } |
|
| 1350 | - } |
|
| 1351 | - if(count($filter) === 1) { |
|
| 1352 | - return '('.$filter[0].')'; |
|
| 1353 | - } |
|
| 1354 | - return $this->combineFilterWithOr($filter); |
|
| 1355 | - } |
|
| 1356 | - |
|
| 1357 | - /** |
|
| 1358 | - * returns the search term depending on whether we are allowed |
|
| 1359 | - * list users found by ldap with the current input appended by |
|
| 1360 | - * a * |
|
| 1361 | - * @return string |
|
| 1362 | - */ |
|
| 1363 | - private function prepareSearchTerm($term) { |
|
| 1364 | - $config = \OC::$server->getConfig(); |
|
| 1365 | - |
|
| 1366 | - $allowEnum = $config->getAppValue('core', 'shareapi_allow_share_dialog_user_enumeration', 'yes'); |
|
| 1367 | - |
|
| 1368 | - $result = $term; |
|
| 1369 | - if ($term === '') { |
|
| 1370 | - $result = '*'; |
|
| 1371 | - } else if ($allowEnum !== 'no') { |
|
| 1372 | - $result = $term . '*'; |
|
| 1373 | - } |
|
| 1374 | - return $result; |
|
| 1375 | - } |
|
| 1376 | - |
|
| 1377 | - /** |
|
| 1378 | - * returns the filter used for counting users |
|
| 1379 | - * @return string |
|
| 1380 | - */ |
|
| 1381 | - public function getFilterForUserCount() { |
|
| 1382 | - $filter = $this->combineFilterWithAnd(array( |
|
| 1383 | - $this->connection->ldapUserFilter, |
|
| 1384 | - $this->connection->ldapUserDisplayName . '=*' |
|
| 1385 | - )); |
|
| 1386 | - |
|
| 1387 | - return $filter; |
|
| 1388 | - } |
|
| 1389 | - |
|
| 1390 | - /** |
|
| 1391 | - * @param string $name |
|
| 1392 | - * @param string $password |
|
| 1393 | - * @return bool |
|
| 1394 | - */ |
|
| 1395 | - public function areCredentialsValid($name, $password) { |
|
| 1396 | - $name = $this->helper->DNasBaseParameter($name); |
|
| 1397 | - $testConnection = clone $this->connection; |
|
| 1398 | - $credentials = array( |
|
| 1399 | - 'ldapAgentName' => $name, |
|
| 1400 | - 'ldapAgentPassword' => $password |
|
| 1401 | - ); |
|
| 1402 | - if(!$testConnection->setConfiguration($credentials)) { |
|
| 1403 | - return false; |
|
| 1404 | - } |
|
| 1405 | - return $testConnection->bind(); |
|
| 1406 | - } |
|
| 1407 | - |
|
| 1408 | - /** |
|
| 1409 | - * reverse lookup of a DN given a known UUID |
|
| 1410 | - * |
|
| 1411 | - * @param string $uuid |
|
| 1412 | - * @return string |
|
| 1413 | - * @throws \Exception |
|
| 1414 | - */ |
|
| 1415 | - public function getUserDnByUuid($uuid) { |
|
| 1416 | - $uuidOverride = $this->connection->ldapExpertUUIDUserAttr; |
|
| 1417 | - $filter = $this->connection->ldapUserFilter; |
|
| 1418 | - $base = $this->connection->ldapBaseUsers; |
|
| 1419 | - |
|
| 1420 | - if ($this->connection->ldapUuidUserAttribute === 'auto' && $uuidOverride === '') { |
|
| 1421 | - // Sacrebleu! The UUID attribute is unknown :( We need first an |
|
| 1422 | - // existing DN to be able to reliably detect it. |
|
| 1423 | - $result = $this->search($filter, $base, ['dn'], 1); |
|
| 1424 | - if(!isset($result[0]) || !isset($result[0]['dn'])) { |
|
| 1425 | - throw new \Exception('Cannot determine UUID attribute'); |
|
| 1426 | - } |
|
| 1427 | - $dn = $result[0]['dn'][0]; |
|
| 1428 | - if(!$this->detectUuidAttribute($dn, true)) { |
|
| 1429 | - throw new \Exception('Cannot determine UUID attribute'); |
|
| 1430 | - } |
|
| 1431 | - } else { |
|
| 1432 | - // The UUID attribute is either known or an override is given. |
|
| 1433 | - // By calling this method we ensure that $this->connection->$uuidAttr |
|
| 1434 | - // is definitely set |
|
| 1435 | - if(!$this->detectUuidAttribute('', true)) { |
|
| 1436 | - throw new \Exception('Cannot determine UUID attribute'); |
|
| 1437 | - } |
|
| 1438 | - } |
|
| 1439 | - |
|
| 1440 | - $uuidAttr = $this->connection->ldapUuidUserAttribute; |
|
| 1441 | - if($uuidAttr === 'guid' || $uuidAttr === 'objectguid') { |
|
| 1442 | - $uuid = $this->formatGuid2ForFilterUser($uuid); |
|
| 1443 | - } |
|
| 1444 | - |
|
| 1445 | - $filter = $uuidAttr . '=' . $uuid; |
|
| 1446 | - $result = $this->searchUsers($filter, ['dn'], 2); |
|
| 1447 | - if(is_array($result) && isset($result[0]) && isset($result[0]['dn']) && count($result) === 1) { |
|
| 1448 | - // we put the count into account to make sure that this is |
|
| 1449 | - // really unique |
|
| 1450 | - return $result[0]['dn'][0]; |
|
| 1451 | - } |
|
| 1452 | - |
|
| 1453 | - throw new \Exception('Cannot determine UUID attribute'); |
|
| 1454 | - } |
|
| 1455 | - |
|
| 1456 | - /** |
|
| 1457 | - * auto-detects the directory's UUID attribute |
|
| 1458 | - * @param string $dn a known DN used to check against |
|
| 1459 | - * @param bool $isUser |
|
| 1460 | - * @param bool $force the detection should be run, even if it is not set to auto |
|
| 1461 | - * @return bool true on success, false otherwise |
|
| 1462 | - */ |
|
| 1463 | - private function detectUuidAttribute($dn, $isUser = true, $force = false) { |
|
| 1464 | - if($isUser) { |
|
| 1465 | - $uuidAttr = 'ldapUuidUserAttribute'; |
|
| 1466 | - $uuidOverride = $this->connection->ldapExpertUUIDUserAttr; |
|
| 1467 | - } else { |
|
| 1468 | - $uuidAttr = 'ldapUuidGroupAttribute'; |
|
| 1469 | - $uuidOverride = $this->connection->ldapExpertUUIDGroupAttr; |
|
| 1470 | - } |
|
| 1471 | - |
|
| 1472 | - if(($this->connection->$uuidAttr !== 'auto') && !$force) { |
|
| 1473 | - return true; |
|
| 1474 | - } |
|
| 1475 | - |
|
| 1476 | - if (is_string($uuidOverride) && trim($uuidOverride) !== '' && !$force) { |
|
| 1477 | - $this->connection->$uuidAttr = $uuidOverride; |
|
| 1478 | - return true; |
|
| 1479 | - } |
|
| 1480 | - |
|
| 1481 | - // for now, supported attributes are entryUUID, nsuniqueid, objectGUID, ipaUniqueID |
|
| 1482 | - $testAttributes = array('entryuuid', 'nsuniqueid', 'objectguid', 'guid', 'ipauniqueid'); |
|
| 1483 | - |
|
| 1484 | - foreach($testAttributes as $attribute) { |
|
| 1485 | - $value = $this->readAttribute($dn, $attribute); |
|
| 1486 | - if(is_array($value) && isset($value[0]) && !empty($value[0])) { |
|
| 1487 | - \OCP\Util::writeLog('user_ldap', |
|
| 1488 | - 'Setting '.$attribute.' as '.$uuidAttr, |
|
| 1489 | - \OCP\Util::DEBUG); |
|
| 1490 | - $this->connection->$uuidAttr = $attribute; |
|
| 1491 | - return true; |
|
| 1492 | - } |
|
| 1493 | - } |
|
| 1494 | - \OCP\Util::writeLog('user_ldap', |
|
| 1495 | - 'Could not autodetect the UUID attribute', |
|
| 1496 | - \OCP\Util::ERROR); |
|
| 1497 | - |
|
| 1498 | - return false; |
|
| 1499 | - } |
|
| 1500 | - |
|
| 1501 | - /** |
|
| 1502 | - * @param string $dn |
|
| 1503 | - * @param bool $isUser |
|
| 1504 | - * @return string|bool |
|
| 1505 | - */ |
|
| 1506 | - public function getUUID($dn, $isUser = true) { |
|
| 1507 | - if($isUser) { |
|
| 1508 | - $uuidAttr = 'ldapUuidUserAttribute'; |
|
| 1509 | - $uuidOverride = $this->connection->ldapExpertUUIDUserAttr; |
|
| 1510 | - } else { |
|
| 1511 | - $uuidAttr = 'ldapUuidGroupAttribute'; |
|
| 1512 | - $uuidOverride = $this->connection->ldapExpertUUIDGroupAttr; |
|
| 1513 | - } |
|
| 1514 | - |
|
| 1515 | - $uuid = false; |
|
| 1516 | - if($this->detectUuidAttribute($dn, $isUser)) { |
|
| 1517 | - $uuid = $this->readAttribute($dn, $this->connection->$uuidAttr); |
|
| 1518 | - if( !is_array($uuid) |
|
| 1519 | - && $uuidOverride !== '' |
|
| 1520 | - && $this->detectUuidAttribute($dn, $isUser, true)) { |
|
| 1521 | - $uuid = $this->readAttribute($dn, |
|
| 1522 | - $this->connection->$uuidAttr); |
|
| 1523 | - } |
|
| 1524 | - if(is_array($uuid) && isset($uuid[0]) && !empty($uuid[0])) { |
|
| 1525 | - $uuid = $uuid[0]; |
|
| 1526 | - } |
|
| 1527 | - } |
|
| 1528 | - |
|
| 1529 | - return $uuid; |
|
| 1530 | - } |
|
| 1531 | - |
|
| 1532 | - /** |
|
| 1533 | - * converts a binary ObjectGUID into a string representation |
|
| 1534 | - * @param string $oguid the ObjectGUID in it's binary form as retrieved from AD |
|
| 1535 | - * @return string |
|
| 1536 | - * @link http://www.php.net/manual/en/function.ldap-get-values-len.php#73198 |
|
| 1537 | - */ |
|
| 1538 | - private function convertObjectGUID2Str($oguid) { |
|
| 1539 | - $hex_guid = bin2hex($oguid); |
|
| 1540 | - $hex_guid_to_guid_str = ''; |
|
| 1541 | - for($k = 1; $k <= 4; ++$k) { |
|
| 1542 | - $hex_guid_to_guid_str .= substr($hex_guid, 8 - 2 * $k, 2); |
|
| 1543 | - } |
|
| 1544 | - $hex_guid_to_guid_str .= '-'; |
|
| 1545 | - for($k = 1; $k <= 2; ++$k) { |
|
| 1546 | - $hex_guid_to_guid_str .= substr($hex_guid, 12 - 2 * $k, 2); |
|
| 1547 | - } |
|
| 1548 | - $hex_guid_to_guid_str .= '-'; |
|
| 1549 | - for($k = 1; $k <= 2; ++$k) { |
|
| 1550 | - $hex_guid_to_guid_str .= substr($hex_guid, 16 - 2 * $k, 2); |
|
| 1551 | - } |
|
| 1552 | - $hex_guid_to_guid_str .= '-' . substr($hex_guid, 16, 4); |
|
| 1553 | - $hex_guid_to_guid_str .= '-' . substr($hex_guid, 20); |
|
| 1554 | - |
|
| 1555 | - return strtoupper($hex_guid_to_guid_str); |
|
| 1556 | - } |
|
| 1557 | - |
|
| 1558 | - /** |
|
| 1559 | - * the first three blocks of the string-converted GUID happen to be in |
|
| 1560 | - * reverse order. In order to use it in a filter, this needs to be |
|
| 1561 | - * corrected. Furthermore the dashes need to be replaced and \\ preprended |
|
| 1562 | - * to every two hax figures. |
|
| 1563 | - * |
|
| 1564 | - * If an invalid string is passed, it will be returned without change. |
|
| 1565 | - * |
|
| 1566 | - * @param string $guid |
|
| 1567 | - * @return string |
|
| 1568 | - */ |
|
| 1569 | - public function formatGuid2ForFilterUser($guid) { |
|
| 1570 | - if(!is_string($guid)) { |
|
| 1571 | - throw new \InvalidArgumentException('String expected'); |
|
| 1572 | - } |
|
| 1573 | - $blocks = explode('-', $guid); |
|
| 1574 | - if(count($blocks) !== 5) { |
|
| 1575 | - /* |
|
| 1111 | + $findings = array(); |
|
| 1112 | + $savedoffset = $offset; |
|
| 1113 | + do { |
|
| 1114 | + $search = $this->executeSearch($filter, $base, $attr, $limit, $offset); |
|
| 1115 | + if($search === false) { |
|
| 1116 | + return array(); |
|
| 1117 | + } |
|
| 1118 | + list($sr, $pagedSearchOK) = $search; |
|
| 1119 | + $cr = $this->connection->getConnectionResource(); |
|
| 1120 | + |
|
| 1121 | + if($skipHandling) { |
|
| 1122 | + //i.e. result do not need to be fetched, we just need the cookie |
|
| 1123 | + //thus pass 1 or any other value as $iFoundItems because it is not |
|
| 1124 | + //used |
|
| 1125 | + $this->processPagedSearchStatus($sr, $filter, $base, 1, $limit, |
|
| 1126 | + $offset, $pagedSearchOK, |
|
| 1127 | + $skipHandling); |
|
| 1128 | + return array(); |
|
| 1129 | + } |
|
| 1130 | + |
|
| 1131 | + foreach($sr as $res) { |
|
| 1132 | + $findings = array_merge($findings, $this->ldap->getEntries($cr , $res )); |
|
| 1133 | + } |
|
| 1134 | + |
|
| 1135 | + $continue = $this->processPagedSearchStatus($sr, $filter, $base, $findings['count'], |
|
| 1136 | + $limit, $offset, $pagedSearchOK, |
|
| 1137 | + $skipHandling); |
|
| 1138 | + $offset += $limit; |
|
| 1139 | + } while ($continue && $pagedSearchOK && $findings['count'] < $limit); |
|
| 1140 | + // reseting offset |
|
| 1141 | + $offset = $savedoffset; |
|
| 1142 | + |
|
| 1143 | + // if we're here, probably no connection resource is returned. |
|
| 1144 | + // to make ownCloud behave nicely, we simply give back an empty array. |
|
| 1145 | + if(is_null($findings)) { |
|
| 1146 | + return array(); |
|
| 1147 | + } |
|
| 1148 | + |
|
| 1149 | + if(!is_null($attr)) { |
|
| 1150 | + $selection = array(); |
|
| 1151 | + $i = 0; |
|
| 1152 | + foreach($findings as $item) { |
|
| 1153 | + if(!is_array($item)) { |
|
| 1154 | + continue; |
|
| 1155 | + } |
|
| 1156 | + $item = \OCP\Util::mb_array_change_key_case($item, MB_CASE_LOWER, 'UTF-8'); |
|
| 1157 | + foreach($attr as $key) { |
|
| 1158 | + $key = mb_strtolower($key, 'UTF-8'); |
|
| 1159 | + if(isset($item[$key])) { |
|
| 1160 | + if(is_array($item[$key]) && isset($item[$key]['count'])) { |
|
| 1161 | + unset($item[$key]['count']); |
|
| 1162 | + } |
|
| 1163 | + if($key !== 'dn') { |
|
| 1164 | + $selection[$i][$key] = $this->resemblesDN($key) ? |
|
| 1165 | + $this->helper->sanitizeDN($item[$key]) |
|
| 1166 | + : $item[$key]; |
|
| 1167 | + } else { |
|
| 1168 | + $selection[$i][$key] = [$this->helper->sanitizeDN($item[$key])]; |
|
| 1169 | + } |
|
| 1170 | + } |
|
| 1171 | + |
|
| 1172 | + } |
|
| 1173 | + $i++; |
|
| 1174 | + } |
|
| 1175 | + $findings = $selection; |
|
| 1176 | + } |
|
| 1177 | + //we slice the findings, when |
|
| 1178 | + //a) paged search unsuccessful, though attempted |
|
| 1179 | + //b) no paged search, but limit set |
|
| 1180 | + if((!$this->getPagedSearchResultState() |
|
| 1181 | + && $pagedSearchOK) |
|
| 1182 | + || ( |
|
| 1183 | + !$pagedSearchOK |
|
| 1184 | + && !is_null($limit) |
|
| 1185 | + ) |
|
| 1186 | + ) { |
|
| 1187 | + $findings = array_slice($findings, intval($offset), $limit); |
|
| 1188 | + } |
|
| 1189 | + return $findings; |
|
| 1190 | + } |
|
| 1191 | + |
|
| 1192 | + /** |
|
| 1193 | + * @param string $name |
|
| 1194 | + * @return bool|mixed|string |
|
| 1195 | + */ |
|
| 1196 | + public function sanitizeUsername($name) { |
|
| 1197 | + if($this->connection->ldapIgnoreNamingRules) { |
|
| 1198 | + return $name; |
|
| 1199 | + } |
|
| 1200 | + |
|
| 1201 | + // Transliteration |
|
| 1202 | + // latin characters to ASCII |
|
| 1203 | + $name = iconv('UTF-8', 'ASCII//TRANSLIT', $name); |
|
| 1204 | + |
|
| 1205 | + // Replacements |
|
| 1206 | + $name = str_replace(' ', '_', $name); |
|
| 1207 | + |
|
| 1208 | + // Every remaining disallowed characters will be removed |
|
| 1209 | + $name = preg_replace('/[^a-zA-Z0-9_.@-]/u', '', $name); |
|
| 1210 | + |
|
| 1211 | + return $name; |
|
| 1212 | + } |
|
| 1213 | + |
|
| 1214 | + /** |
|
| 1215 | + * escapes (user provided) parts for LDAP filter |
|
| 1216 | + * @param string $input, the provided value |
|
| 1217 | + * @param bool $allowAsterisk whether in * at the beginning should be preserved |
|
| 1218 | + * @return string the escaped string |
|
| 1219 | + */ |
|
| 1220 | + public function escapeFilterPart($input, $allowAsterisk = false) { |
|
| 1221 | + $asterisk = ''; |
|
| 1222 | + if($allowAsterisk && strlen($input) > 0 && $input[0] === '*') { |
|
| 1223 | + $asterisk = '*'; |
|
| 1224 | + $input = mb_substr($input, 1, null, 'UTF-8'); |
|
| 1225 | + } |
|
| 1226 | + $search = array('*', '\\', '(', ')'); |
|
| 1227 | + $replace = array('\\*', '\\\\', '\\(', '\\)'); |
|
| 1228 | + return $asterisk . str_replace($search, $replace, $input); |
|
| 1229 | + } |
|
| 1230 | + |
|
| 1231 | + /** |
|
| 1232 | + * combines the input filters with AND |
|
| 1233 | + * @param string[] $filters the filters to connect |
|
| 1234 | + * @return string the combined filter |
|
| 1235 | + */ |
|
| 1236 | + public function combineFilterWithAnd($filters) { |
|
| 1237 | + return $this->combineFilter($filters, '&'); |
|
| 1238 | + } |
|
| 1239 | + |
|
| 1240 | + /** |
|
| 1241 | + * combines the input filters with OR |
|
| 1242 | + * @param string[] $filters the filters to connect |
|
| 1243 | + * @return string the combined filter |
|
| 1244 | + * Combines Filter arguments with OR |
|
| 1245 | + */ |
|
| 1246 | + public function combineFilterWithOr($filters) { |
|
| 1247 | + return $this->combineFilter($filters, '|'); |
|
| 1248 | + } |
|
| 1249 | + |
|
| 1250 | + /** |
|
| 1251 | + * combines the input filters with given operator |
|
| 1252 | + * @param string[] $filters the filters to connect |
|
| 1253 | + * @param string $operator either & or | |
|
| 1254 | + * @return string the combined filter |
|
| 1255 | + */ |
|
| 1256 | + private function combineFilter($filters, $operator) { |
|
| 1257 | + $combinedFilter = '('.$operator; |
|
| 1258 | + foreach($filters as $filter) { |
|
| 1259 | + if ($filter !== '' && $filter[0] !== '(') { |
|
| 1260 | + $filter = '('.$filter.')'; |
|
| 1261 | + } |
|
| 1262 | + $combinedFilter.=$filter; |
|
| 1263 | + } |
|
| 1264 | + $combinedFilter.=')'; |
|
| 1265 | + return $combinedFilter; |
|
| 1266 | + } |
|
| 1267 | + |
|
| 1268 | + /** |
|
| 1269 | + * creates a filter part for to perform search for users |
|
| 1270 | + * @param string $search the search term |
|
| 1271 | + * @return string the final filter part to use in LDAP searches |
|
| 1272 | + */ |
|
| 1273 | + public function getFilterPartForUserSearch($search) { |
|
| 1274 | + return $this->getFilterPartForSearch($search, |
|
| 1275 | + $this->connection->ldapAttributesForUserSearch, |
|
| 1276 | + $this->connection->ldapUserDisplayName); |
|
| 1277 | + } |
|
| 1278 | + |
|
| 1279 | + /** |
|
| 1280 | + * creates a filter part for to perform search for groups |
|
| 1281 | + * @param string $search the search term |
|
| 1282 | + * @return string the final filter part to use in LDAP searches |
|
| 1283 | + */ |
|
| 1284 | + public function getFilterPartForGroupSearch($search) { |
|
| 1285 | + return $this->getFilterPartForSearch($search, |
|
| 1286 | + $this->connection->ldapAttributesForGroupSearch, |
|
| 1287 | + $this->connection->ldapGroupDisplayName); |
|
| 1288 | + } |
|
| 1289 | + |
|
| 1290 | + /** |
|
| 1291 | + * creates a filter part for searches by splitting up the given search |
|
| 1292 | + * string into single words |
|
| 1293 | + * @param string $search the search term |
|
| 1294 | + * @param string[] $searchAttributes needs to have at least two attributes, |
|
| 1295 | + * otherwise it does not make sense :) |
|
| 1296 | + * @return string the final filter part to use in LDAP searches |
|
| 1297 | + * @throws \Exception |
|
| 1298 | + */ |
|
| 1299 | + private function getAdvancedFilterPartForSearch($search, $searchAttributes) { |
|
| 1300 | + if(!is_array($searchAttributes) || count($searchAttributes) < 2) { |
|
| 1301 | + throw new \Exception('searchAttributes must be an array with at least two string'); |
|
| 1302 | + } |
|
| 1303 | + $searchWords = explode(' ', trim($search)); |
|
| 1304 | + $wordFilters = array(); |
|
| 1305 | + foreach($searchWords as $word) { |
|
| 1306 | + $word = $this->prepareSearchTerm($word); |
|
| 1307 | + //every word needs to appear at least once |
|
| 1308 | + $wordMatchOneAttrFilters = array(); |
|
| 1309 | + foreach($searchAttributes as $attr) { |
|
| 1310 | + $wordMatchOneAttrFilters[] = $attr . '=' . $word; |
|
| 1311 | + } |
|
| 1312 | + $wordFilters[] = $this->combineFilterWithOr($wordMatchOneAttrFilters); |
|
| 1313 | + } |
|
| 1314 | + return $this->combineFilterWithAnd($wordFilters); |
|
| 1315 | + } |
|
| 1316 | + |
|
| 1317 | + /** |
|
| 1318 | + * creates a filter part for searches |
|
| 1319 | + * @param string $search the search term |
|
| 1320 | + * @param string[]|null $searchAttributes |
|
| 1321 | + * @param string $fallbackAttribute a fallback attribute in case the user |
|
| 1322 | + * did not define search attributes. Typically the display name attribute. |
|
| 1323 | + * @return string the final filter part to use in LDAP searches |
|
| 1324 | + */ |
|
| 1325 | + private function getFilterPartForSearch($search, $searchAttributes, $fallbackAttribute) { |
|
| 1326 | + $filter = array(); |
|
| 1327 | + $haveMultiSearchAttributes = (is_array($searchAttributes) && count($searchAttributes) > 0); |
|
| 1328 | + if($haveMultiSearchAttributes && strpos(trim($search), ' ') !== false) { |
|
| 1329 | + try { |
|
| 1330 | + return $this->getAdvancedFilterPartForSearch($search, $searchAttributes); |
|
| 1331 | + } catch(\Exception $e) { |
|
| 1332 | + \OCP\Util::writeLog( |
|
| 1333 | + 'user_ldap', |
|
| 1334 | + 'Creating advanced filter for search failed, falling back to simple method.', |
|
| 1335 | + \OCP\Util::INFO |
|
| 1336 | + ); |
|
| 1337 | + } |
|
| 1338 | + } |
|
| 1339 | + |
|
| 1340 | + $search = $this->prepareSearchTerm($search); |
|
| 1341 | + if(!is_array($searchAttributes) || count($searchAttributes) === 0) { |
|
| 1342 | + if ($fallbackAttribute === '') { |
|
| 1343 | + return ''; |
|
| 1344 | + } |
|
| 1345 | + $filter[] = $fallbackAttribute . '=' . $search; |
|
| 1346 | + } else { |
|
| 1347 | + foreach($searchAttributes as $attribute) { |
|
| 1348 | + $filter[] = $attribute . '=' . $search; |
|
| 1349 | + } |
|
| 1350 | + } |
|
| 1351 | + if(count($filter) === 1) { |
|
| 1352 | + return '('.$filter[0].')'; |
|
| 1353 | + } |
|
| 1354 | + return $this->combineFilterWithOr($filter); |
|
| 1355 | + } |
|
| 1356 | + |
|
| 1357 | + /** |
|
| 1358 | + * returns the search term depending on whether we are allowed |
|
| 1359 | + * list users found by ldap with the current input appended by |
|
| 1360 | + * a * |
|
| 1361 | + * @return string |
|
| 1362 | + */ |
|
| 1363 | + private function prepareSearchTerm($term) { |
|
| 1364 | + $config = \OC::$server->getConfig(); |
|
| 1365 | + |
|
| 1366 | + $allowEnum = $config->getAppValue('core', 'shareapi_allow_share_dialog_user_enumeration', 'yes'); |
|
| 1367 | + |
|
| 1368 | + $result = $term; |
|
| 1369 | + if ($term === '') { |
|
| 1370 | + $result = '*'; |
|
| 1371 | + } else if ($allowEnum !== 'no') { |
|
| 1372 | + $result = $term . '*'; |
|
| 1373 | + } |
|
| 1374 | + return $result; |
|
| 1375 | + } |
|
| 1376 | + |
|
| 1377 | + /** |
|
| 1378 | + * returns the filter used for counting users |
|
| 1379 | + * @return string |
|
| 1380 | + */ |
|
| 1381 | + public function getFilterForUserCount() { |
|
| 1382 | + $filter = $this->combineFilterWithAnd(array( |
|
| 1383 | + $this->connection->ldapUserFilter, |
|
| 1384 | + $this->connection->ldapUserDisplayName . '=*' |
|
| 1385 | + )); |
|
| 1386 | + |
|
| 1387 | + return $filter; |
|
| 1388 | + } |
|
| 1389 | + |
|
| 1390 | + /** |
|
| 1391 | + * @param string $name |
|
| 1392 | + * @param string $password |
|
| 1393 | + * @return bool |
|
| 1394 | + */ |
|
| 1395 | + public function areCredentialsValid($name, $password) { |
|
| 1396 | + $name = $this->helper->DNasBaseParameter($name); |
|
| 1397 | + $testConnection = clone $this->connection; |
|
| 1398 | + $credentials = array( |
|
| 1399 | + 'ldapAgentName' => $name, |
|
| 1400 | + 'ldapAgentPassword' => $password |
|
| 1401 | + ); |
|
| 1402 | + if(!$testConnection->setConfiguration($credentials)) { |
|
| 1403 | + return false; |
|
| 1404 | + } |
|
| 1405 | + return $testConnection->bind(); |
|
| 1406 | + } |
|
| 1407 | + |
|
| 1408 | + /** |
|
| 1409 | + * reverse lookup of a DN given a known UUID |
|
| 1410 | + * |
|
| 1411 | + * @param string $uuid |
|
| 1412 | + * @return string |
|
| 1413 | + * @throws \Exception |
|
| 1414 | + */ |
|
| 1415 | + public function getUserDnByUuid($uuid) { |
|
| 1416 | + $uuidOverride = $this->connection->ldapExpertUUIDUserAttr; |
|
| 1417 | + $filter = $this->connection->ldapUserFilter; |
|
| 1418 | + $base = $this->connection->ldapBaseUsers; |
|
| 1419 | + |
|
| 1420 | + if ($this->connection->ldapUuidUserAttribute === 'auto' && $uuidOverride === '') { |
|
| 1421 | + // Sacrebleu! The UUID attribute is unknown :( We need first an |
|
| 1422 | + // existing DN to be able to reliably detect it. |
|
| 1423 | + $result = $this->search($filter, $base, ['dn'], 1); |
|
| 1424 | + if(!isset($result[0]) || !isset($result[0]['dn'])) { |
|
| 1425 | + throw new \Exception('Cannot determine UUID attribute'); |
|
| 1426 | + } |
|
| 1427 | + $dn = $result[0]['dn'][0]; |
|
| 1428 | + if(!$this->detectUuidAttribute($dn, true)) { |
|
| 1429 | + throw new \Exception('Cannot determine UUID attribute'); |
|
| 1430 | + } |
|
| 1431 | + } else { |
|
| 1432 | + // The UUID attribute is either known or an override is given. |
|
| 1433 | + // By calling this method we ensure that $this->connection->$uuidAttr |
|
| 1434 | + // is definitely set |
|
| 1435 | + if(!$this->detectUuidAttribute('', true)) { |
|
| 1436 | + throw new \Exception('Cannot determine UUID attribute'); |
|
| 1437 | + } |
|
| 1438 | + } |
|
| 1439 | + |
|
| 1440 | + $uuidAttr = $this->connection->ldapUuidUserAttribute; |
|
| 1441 | + if($uuidAttr === 'guid' || $uuidAttr === 'objectguid') { |
|
| 1442 | + $uuid = $this->formatGuid2ForFilterUser($uuid); |
|
| 1443 | + } |
|
| 1444 | + |
|
| 1445 | + $filter = $uuidAttr . '=' . $uuid; |
|
| 1446 | + $result = $this->searchUsers($filter, ['dn'], 2); |
|
| 1447 | + if(is_array($result) && isset($result[0]) && isset($result[0]['dn']) && count($result) === 1) { |
|
| 1448 | + // we put the count into account to make sure that this is |
|
| 1449 | + // really unique |
|
| 1450 | + return $result[0]['dn'][0]; |
|
| 1451 | + } |
|
| 1452 | + |
|
| 1453 | + throw new \Exception('Cannot determine UUID attribute'); |
|
| 1454 | + } |
|
| 1455 | + |
|
| 1456 | + /** |
|
| 1457 | + * auto-detects the directory's UUID attribute |
|
| 1458 | + * @param string $dn a known DN used to check against |
|
| 1459 | + * @param bool $isUser |
|
| 1460 | + * @param bool $force the detection should be run, even if it is not set to auto |
|
| 1461 | + * @return bool true on success, false otherwise |
|
| 1462 | + */ |
|
| 1463 | + private function detectUuidAttribute($dn, $isUser = true, $force = false) { |
|
| 1464 | + if($isUser) { |
|
| 1465 | + $uuidAttr = 'ldapUuidUserAttribute'; |
|
| 1466 | + $uuidOverride = $this->connection->ldapExpertUUIDUserAttr; |
|
| 1467 | + } else { |
|
| 1468 | + $uuidAttr = 'ldapUuidGroupAttribute'; |
|
| 1469 | + $uuidOverride = $this->connection->ldapExpertUUIDGroupAttr; |
|
| 1470 | + } |
|
| 1471 | + |
|
| 1472 | + if(($this->connection->$uuidAttr !== 'auto') && !$force) { |
|
| 1473 | + return true; |
|
| 1474 | + } |
|
| 1475 | + |
|
| 1476 | + if (is_string($uuidOverride) && trim($uuidOverride) !== '' && !$force) { |
|
| 1477 | + $this->connection->$uuidAttr = $uuidOverride; |
|
| 1478 | + return true; |
|
| 1479 | + } |
|
| 1480 | + |
|
| 1481 | + // for now, supported attributes are entryUUID, nsuniqueid, objectGUID, ipaUniqueID |
|
| 1482 | + $testAttributes = array('entryuuid', 'nsuniqueid', 'objectguid', 'guid', 'ipauniqueid'); |
|
| 1483 | + |
|
| 1484 | + foreach($testAttributes as $attribute) { |
|
| 1485 | + $value = $this->readAttribute($dn, $attribute); |
|
| 1486 | + if(is_array($value) && isset($value[0]) && !empty($value[0])) { |
|
| 1487 | + \OCP\Util::writeLog('user_ldap', |
|
| 1488 | + 'Setting '.$attribute.' as '.$uuidAttr, |
|
| 1489 | + \OCP\Util::DEBUG); |
|
| 1490 | + $this->connection->$uuidAttr = $attribute; |
|
| 1491 | + return true; |
|
| 1492 | + } |
|
| 1493 | + } |
|
| 1494 | + \OCP\Util::writeLog('user_ldap', |
|
| 1495 | + 'Could not autodetect the UUID attribute', |
|
| 1496 | + \OCP\Util::ERROR); |
|
| 1497 | + |
|
| 1498 | + return false; |
|
| 1499 | + } |
|
| 1500 | + |
|
| 1501 | + /** |
|
| 1502 | + * @param string $dn |
|
| 1503 | + * @param bool $isUser |
|
| 1504 | + * @return string|bool |
|
| 1505 | + */ |
|
| 1506 | + public function getUUID($dn, $isUser = true) { |
|
| 1507 | + if($isUser) { |
|
| 1508 | + $uuidAttr = 'ldapUuidUserAttribute'; |
|
| 1509 | + $uuidOverride = $this->connection->ldapExpertUUIDUserAttr; |
|
| 1510 | + } else { |
|
| 1511 | + $uuidAttr = 'ldapUuidGroupAttribute'; |
|
| 1512 | + $uuidOverride = $this->connection->ldapExpertUUIDGroupAttr; |
|
| 1513 | + } |
|
| 1514 | + |
|
| 1515 | + $uuid = false; |
|
| 1516 | + if($this->detectUuidAttribute($dn, $isUser)) { |
|
| 1517 | + $uuid = $this->readAttribute($dn, $this->connection->$uuidAttr); |
|
| 1518 | + if( !is_array($uuid) |
|
| 1519 | + && $uuidOverride !== '' |
|
| 1520 | + && $this->detectUuidAttribute($dn, $isUser, true)) { |
|
| 1521 | + $uuid = $this->readAttribute($dn, |
|
| 1522 | + $this->connection->$uuidAttr); |
|
| 1523 | + } |
|
| 1524 | + if(is_array($uuid) && isset($uuid[0]) && !empty($uuid[0])) { |
|
| 1525 | + $uuid = $uuid[0]; |
|
| 1526 | + } |
|
| 1527 | + } |
|
| 1528 | + |
|
| 1529 | + return $uuid; |
|
| 1530 | + } |
|
| 1531 | + |
|
| 1532 | + /** |
|
| 1533 | + * converts a binary ObjectGUID into a string representation |
|
| 1534 | + * @param string $oguid the ObjectGUID in it's binary form as retrieved from AD |
|
| 1535 | + * @return string |
|
| 1536 | + * @link http://www.php.net/manual/en/function.ldap-get-values-len.php#73198 |
|
| 1537 | + */ |
|
| 1538 | + private function convertObjectGUID2Str($oguid) { |
|
| 1539 | + $hex_guid = bin2hex($oguid); |
|
| 1540 | + $hex_guid_to_guid_str = ''; |
|
| 1541 | + for($k = 1; $k <= 4; ++$k) { |
|
| 1542 | + $hex_guid_to_guid_str .= substr($hex_guid, 8 - 2 * $k, 2); |
|
| 1543 | + } |
|
| 1544 | + $hex_guid_to_guid_str .= '-'; |
|
| 1545 | + for($k = 1; $k <= 2; ++$k) { |
|
| 1546 | + $hex_guid_to_guid_str .= substr($hex_guid, 12 - 2 * $k, 2); |
|
| 1547 | + } |
|
| 1548 | + $hex_guid_to_guid_str .= '-'; |
|
| 1549 | + for($k = 1; $k <= 2; ++$k) { |
|
| 1550 | + $hex_guid_to_guid_str .= substr($hex_guid, 16 - 2 * $k, 2); |
|
| 1551 | + } |
|
| 1552 | + $hex_guid_to_guid_str .= '-' . substr($hex_guid, 16, 4); |
|
| 1553 | + $hex_guid_to_guid_str .= '-' . substr($hex_guid, 20); |
|
| 1554 | + |
|
| 1555 | + return strtoupper($hex_guid_to_guid_str); |
|
| 1556 | + } |
|
| 1557 | + |
|
| 1558 | + /** |
|
| 1559 | + * the first three blocks of the string-converted GUID happen to be in |
|
| 1560 | + * reverse order. In order to use it in a filter, this needs to be |
|
| 1561 | + * corrected. Furthermore the dashes need to be replaced and \\ preprended |
|
| 1562 | + * to every two hax figures. |
|
| 1563 | + * |
|
| 1564 | + * If an invalid string is passed, it will be returned without change. |
|
| 1565 | + * |
|
| 1566 | + * @param string $guid |
|
| 1567 | + * @return string |
|
| 1568 | + */ |
|
| 1569 | + public function formatGuid2ForFilterUser($guid) { |
|
| 1570 | + if(!is_string($guid)) { |
|
| 1571 | + throw new \InvalidArgumentException('String expected'); |
|
| 1572 | + } |
|
| 1573 | + $blocks = explode('-', $guid); |
|
| 1574 | + if(count($blocks) !== 5) { |
|
| 1575 | + /* |
|
| 1576 | 1576 | * Why not throw an Exception instead? This method is a utility |
| 1577 | 1577 | * called only when trying to figure out whether a "missing" known |
| 1578 | 1578 | * LDAP user was or was not renamed on the LDAP server. And this |
@@ -1583,275 +1583,275 @@ discard block |
||
| 1583 | 1583 | * an exception here would kill the experience for a valid, acting |
| 1584 | 1584 | * user. Instead we write a log message. |
| 1585 | 1585 | */ |
| 1586 | - \OC::$server->getLogger()->info( |
|
| 1587 | - 'Passed string does not resemble a valid GUID. Known UUID ' . |
|
| 1588 | - '({uuid}) probably does not match UUID configuration.', |
|
| 1589 | - [ 'app' => 'user_ldap', 'uuid' => $guid ] |
|
| 1590 | - ); |
|
| 1591 | - return $guid; |
|
| 1592 | - } |
|
| 1593 | - for($i=0; $i < 3; $i++) { |
|
| 1594 | - $pairs = str_split($blocks[$i], 2); |
|
| 1595 | - $pairs = array_reverse($pairs); |
|
| 1596 | - $blocks[$i] = implode('', $pairs); |
|
| 1597 | - } |
|
| 1598 | - for($i=0; $i < 5; $i++) { |
|
| 1599 | - $pairs = str_split($blocks[$i], 2); |
|
| 1600 | - $blocks[$i] = '\\' . implode('\\', $pairs); |
|
| 1601 | - } |
|
| 1602 | - return implode('', $blocks); |
|
| 1603 | - } |
|
| 1604 | - |
|
| 1605 | - /** |
|
| 1606 | - * gets a SID of the domain of the given dn |
|
| 1607 | - * @param string $dn |
|
| 1608 | - * @return string|bool |
|
| 1609 | - */ |
|
| 1610 | - public function getSID($dn) { |
|
| 1611 | - $domainDN = $this->getDomainDNFromDN($dn); |
|
| 1612 | - $cacheKey = 'getSID-'.$domainDN; |
|
| 1613 | - $sid = $this->connection->getFromCache($cacheKey); |
|
| 1614 | - if(!is_null($sid)) { |
|
| 1615 | - return $sid; |
|
| 1616 | - } |
|
| 1617 | - |
|
| 1618 | - $objectSid = $this->readAttribute($domainDN, 'objectsid'); |
|
| 1619 | - if(!is_array($objectSid) || empty($objectSid)) { |
|
| 1620 | - $this->connection->writeToCache($cacheKey, false); |
|
| 1621 | - return false; |
|
| 1622 | - } |
|
| 1623 | - $domainObjectSid = $this->convertSID2Str($objectSid[0]); |
|
| 1624 | - $this->connection->writeToCache($cacheKey, $domainObjectSid); |
|
| 1625 | - |
|
| 1626 | - return $domainObjectSid; |
|
| 1627 | - } |
|
| 1628 | - |
|
| 1629 | - /** |
|
| 1630 | - * converts a binary SID into a string representation |
|
| 1631 | - * @param string $sid |
|
| 1632 | - * @return string |
|
| 1633 | - */ |
|
| 1634 | - public function convertSID2Str($sid) { |
|
| 1635 | - // The format of a SID binary string is as follows: |
|
| 1636 | - // 1 byte for the revision level |
|
| 1637 | - // 1 byte for the number n of variable sub-ids |
|
| 1638 | - // 6 bytes for identifier authority value |
|
| 1639 | - // n*4 bytes for n sub-ids |
|
| 1640 | - // |
|
| 1641 | - // Example: 010400000000000515000000a681e50e4d6c6c2bca32055f |
|
| 1642 | - // Legend: RRNNAAAAAAAAAAAA11111111222222223333333344444444 |
|
| 1643 | - $revision = ord($sid[0]); |
|
| 1644 | - $numberSubID = ord($sid[1]); |
|
| 1645 | - |
|
| 1646 | - $subIdStart = 8; // 1 + 1 + 6 |
|
| 1647 | - $subIdLength = 4; |
|
| 1648 | - if (strlen($sid) !== $subIdStart + $subIdLength * $numberSubID) { |
|
| 1649 | - // Incorrect number of bytes present. |
|
| 1650 | - return ''; |
|
| 1651 | - } |
|
| 1652 | - |
|
| 1653 | - // 6 bytes = 48 bits can be represented using floats without loss of |
|
| 1654 | - // precision (see https://gist.github.com/bantu/886ac680b0aef5812f71) |
|
| 1655 | - $iav = number_format(hexdec(bin2hex(substr($sid, 2, 6))), 0, '', ''); |
|
| 1656 | - |
|
| 1657 | - $subIDs = array(); |
|
| 1658 | - for ($i = 0; $i < $numberSubID; $i++) { |
|
| 1659 | - $subID = unpack('V', substr($sid, $subIdStart + $subIdLength * $i, $subIdLength)); |
|
| 1660 | - $subIDs[] = sprintf('%u', $subID[1]); |
|
| 1661 | - } |
|
| 1662 | - |
|
| 1663 | - // Result for example above: S-1-5-21-249921958-728525901-1594176202 |
|
| 1664 | - return sprintf('S-%d-%s-%s', $revision, $iav, implode('-', $subIDs)); |
|
| 1665 | - } |
|
| 1666 | - |
|
| 1667 | - /** |
|
| 1668 | - * checks if the given DN is part of the given base DN(s) |
|
| 1669 | - * @param string $dn the DN |
|
| 1670 | - * @param string[] $bases array containing the allowed base DN or DNs |
|
| 1671 | - * @return bool |
|
| 1672 | - */ |
|
| 1673 | - public function isDNPartOfBase($dn, $bases) { |
|
| 1674 | - $belongsToBase = false; |
|
| 1675 | - $bases = $this->helper->sanitizeDN($bases); |
|
| 1676 | - |
|
| 1677 | - foreach($bases as $base) { |
|
| 1678 | - $belongsToBase = true; |
|
| 1679 | - if(mb_strripos($dn, $base, 0, 'UTF-8') !== (mb_strlen($dn, 'UTF-8')-mb_strlen($base, 'UTF-8'))) { |
|
| 1680 | - $belongsToBase = false; |
|
| 1681 | - } |
|
| 1682 | - if($belongsToBase) { |
|
| 1683 | - break; |
|
| 1684 | - } |
|
| 1685 | - } |
|
| 1686 | - return $belongsToBase; |
|
| 1687 | - } |
|
| 1688 | - |
|
| 1689 | - /** |
|
| 1690 | - * resets a running Paged Search operation |
|
| 1691 | - */ |
|
| 1692 | - private function abandonPagedSearch() { |
|
| 1693 | - if($this->connection->hasPagedResultSupport) { |
|
| 1694 | - $cr = $this->connection->getConnectionResource(); |
|
| 1695 | - $this->ldap->controlPagedResult($cr, 0, false, $this->lastCookie); |
|
| 1696 | - $this->getPagedSearchResultState(); |
|
| 1697 | - $this->lastCookie = ''; |
|
| 1698 | - $this->cookies = array(); |
|
| 1699 | - } |
|
| 1700 | - } |
|
| 1701 | - |
|
| 1702 | - /** |
|
| 1703 | - * get a cookie for the next LDAP paged search |
|
| 1704 | - * @param string $base a string with the base DN for the search |
|
| 1705 | - * @param string $filter the search filter to identify the correct search |
|
| 1706 | - * @param int $limit the limit (or 'pageSize'), to identify the correct search well |
|
| 1707 | - * @param int $offset the offset for the new search to identify the correct search really good |
|
| 1708 | - * @return string containing the key or empty if none is cached |
|
| 1709 | - */ |
|
| 1710 | - private function getPagedResultCookie($base, $filter, $limit, $offset) { |
|
| 1711 | - if($offset === 0) { |
|
| 1712 | - return ''; |
|
| 1713 | - } |
|
| 1714 | - $offset -= $limit; |
|
| 1715 | - //we work with cache here |
|
| 1716 | - $cacheKey = 'lc' . crc32($base) . '-' . crc32($filter) . '-' . intval($limit) . '-' . intval($offset); |
|
| 1717 | - $cookie = ''; |
|
| 1718 | - if(isset($this->cookies[$cacheKey])) { |
|
| 1719 | - $cookie = $this->cookies[$cacheKey]; |
|
| 1720 | - if(is_null($cookie)) { |
|
| 1721 | - $cookie = ''; |
|
| 1722 | - } |
|
| 1723 | - } |
|
| 1724 | - return $cookie; |
|
| 1725 | - } |
|
| 1726 | - |
|
| 1727 | - /** |
|
| 1728 | - * checks whether an LDAP paged search operation has more pages that can be |
|
| 1729 | - * retrieved, typically when offset and limit are provided. |
|
| 1730 | - * |
|
| 1731 | - * Be very careful to use it: the last cookie value, which is inspected, can |
|
| 1732 | - * be reset by other operations. Best, call it immediately after a search(), |
|
| 1733 | - * searchUsers() or searchGroups() call. count-methods are probably safe as |
|
| 1734 | - * well. Don't rely on it with any fetchList-method. |
|
| 1735 | - * @return bool |
|
| 1736 | - */ |
|
| 1737 | - public function hasMoreResults() { |
|
| 1738 | - if(!$this->connection->hasPagedResultSupport) { |
|
| 1739 | - return false; |
|
| 1740 | - } |
|
| 1741 | - |
|
| 1742 | - if(empty($this->lastCookie) && $this->lastCookie !== '0') { |
|
| 1743 | - // as in RFC 2696, when all results are returned, the cookie will |
|
| 1744 | - // be empty. |
|
| 1745 | - return false; |
|
| 1746 | - } |
|
| 1747 | - |
|
| 1748 | - return true; |
|
| 1749 | - } |
|
| 1750 | - |
|
| 1751 | - /** |
|
| 1752 | - * set a cookie for LDAP paged search run |
|
| 1753 | - * @param string $base a string with the base DN for the search |
|
| 1754 | - * @param string $filter the search filter to identify the correct search |
|
| 1755 | - * @param int $limit the limit (or 'pageSize'), to identify the correct search well |
|
| 1756 | - * @param int $offset the offset for the run search to identify the correct search really good |
|
| 1757 | - * @param string $cookie string containing the cookie returned by ldap_control_paged_result_response |
|
| 1758 | - * @return void |
|
| 1759 | - */ |
|
| 1760 | - private function setPagedResultCookie($base, $filter, $limit, $offset, $cookie) { |
|
| 1761 | - // allow '0' for 389ds |
|
| 1762 | - if(!empty($cookie) || $cookie === '0') { |
|
| 1763 | - $cacheKey = 'lc' . crc32($base) . '-' . crc32($filter) . '-' .intval($limit) . '-' . intval($offset); |
|
| 1764 | - $this->cookies[$cacheKey] = $cookie; |
|
| 1765 | - $this->lastCookie = $cookie; |
|
| 1766 | - } |
|
| 1767 | - } |
|
| 1768 | - |
|
| 1769 | - /** |
|
| 1770 | - * Check whether the most recent paged search was successful. It flushed the state var. Use it always after a possible paged search. |
|
| 1771 | - * @return boolean|null true on success, null or false otherwise |
|
| 1772 | - */ |
|
| 1773 | - public function getPagedSearchResultState() { |
|
| 1774 | - $result = $this->pagedSearchedSuccessful; |
|
| 1775 | - $this->pagedSearchedSuccessful = null; |
|
| 1776 | - return $result; |
|
| 1777 | - } |
|
| 1778 | - |
|
| 1779 | - /** |
|
| 1780 | - * Prepares a paged search, if possible |
|
| 1781 | - * @param string $filter the LDAP filter for the search |
|
| 1782 | - * @param string[] $bases an array containing the LDAP subtree(s) that shall be searched |
|
| 1783 | - * @param string[] $attr optional, when a certain attribute shall be filtered outside |
|
| 1784 | - * @param int $limit |
|
| 1785 | - * @param int $offset |
|
| 1786 | - * @return bool|true |
|
| 1787 | - */ |
|
| 1788 | - private function initPagedSearch($filter, $bases, $attr, $limit, $offset) { |
|
| 1789 | - $pagedSearchOK = false; |
|
| 1790 | - if($this->connection->hasPagedResultSupport && ($limit !== 0)) { |
|
| 1791 | - $offset = intval($offset); //can be null |
|
| 1792 | - \OCP\Util::writeLog('user_ldap', |
|
| 1793 | - 'initializing paged search for Filter '.$filter.' base '.print_r($bases, true) |
|
| 1794 | - .' attr '.print_r($attr, true). ' limit ' .$limit.' offset '.$offset, |
|
| 1795 | - \OCP\Util::DEBUG); |
|
| 1796 | - //get the cookie from the search for the previous search, required by LDAP |
|
| 1797 | - foreach($bases as $base) { |
|
| 1798 | - |
|
| 1799 | - $cookie = $this->getPagedResultCookie($base, $filter, $limit, $offset); |
|
| 1800 | - if(empty($cookie) && $cookie !== "0" && ($offset > 0)) { |
|
| 1801 | - // no cookie known, although the offset is not 0. Maybe cache run out. We need |
|
| 1802 | - // to start all over *sigh* (btw, Dear Reader, did you know LDAP paged |
|
| 1803 | - // searching was designed by MSFT?) |
|
| 1804 | - // Lukas: No, but thanks to reading that source I finally know! |
|
| 1805 | - // '0' is valid, because 389ds |
|
| 1806 | - $reOffset = ($offset - $limit) < 0 ? 0 : $offset - $limit; |
|
| 1807 | - //a bit recursive, $offset of 0 is the exit |
|
| 1808 | - \OCP\Util::writeLog('user_ldap', 'Looking for cookie L/O '.$limit.'/'.$reOffset, \OCP\Util::INFO); |
|
| 1809 | - $this->search($filter, array($base), $attr, $limit, $reOffset, true); |
|
| 1810 | - $cookie = $this->getPagedResultCookie($base, $filter, $limit, $offset); |
|
| 1811 | - //still no cookie? obviously, the server does not like us. Let's skip paging efforts. |
|
| 1812 | - //TODO: remember this, probably does not change in the next request... |
|
| 1813 | - if(empty($cookie) && $cookie !== '0') { |
|
| 1814 | - // '0' is valid, because 389ds |
|
| 1815 | - $cookie = null; |
|
| 1816 | - } |
|
| 1817 | - } |
|
| 1818 | - if(!is_null($cookie)) { |
|
| 1819 | - //since offset = 0, this is a new search. We abandon other searches that might be ongoing. |
|
| 1820 | - $this->abandonPagedSearch(); |
|
| 1821 | - $pagedSearchOK = $this->ldap->controlPagedResult( |
|
| 1822 | - $this->connection->getConnectionResource(), $limit, |
|
| 1823 | - false, $cookie); |
|
| 1824 | - if(!$pagedSearchOK) { |
|
| 1825 | - return false; |
|
| 1826 | - } |
|
| 1827 | - \OCP\Util::writeLog('user_ldap', 'Ready for a paged search', \OCP\Util::DEBUG); |
|
| 1828 | - } else { |
|
| 1829 | - \OCP\Util::writeLog('user_ldap', |
|
| 1830 | - 'No paged search for us, Cpt., Limit '.$limit.' Offset '.$offset, |
|
| 1831 | - \OCP\Util::INFO); |
|
| 1832 | - } |
|
| 1833 | - |
|
| 1834 | - } |
|
| 1835 | - /* ++ Fixing RHDS searches with pages with zero results ++ |
|
| 1586 | + \OC::$server->getLogger()->info( |
|
| 1587 | + 'Passed string does not resemble a valid GUID. Known UUID ' . |
|
| 1588 | + '({uuid}) probably does not match UUID configuration.', |
|
| 1589 | + [ 'app' => 'user_ldap', 'uuid' => $guid ] |
|
| 1590 | + ); |
|
| 1591 | + return $guid; |
|
| 1592 | + } |
|
| 1593 | + for($i=0; $i < 3; $i++) { |
|
| 1594 | + $pairs = str_split($blocks[$i], 2); |
|
| 1595 | + $pairs = array_reverse($pairs); |
|
| 1596 | + $blocks[$i] = implode('', $pairs); |
|
| 1597 | + } |
|
| 1598 | + for($i=0; $i < 5; $i++) { |
|
| 1599 | + $pairs = str_split($blocks[$i], 2); |
|
| 1600 | + $blocks[$i] = '\\' . implode('\\', $pairs); |
|
| 1601 | + } |
|
| 1602 | + return implode('', $blocks); |
|
| 1603 | + } |
|
| 1604 | + |
|
| 1605 | + /** |
|
| 1606 | + * gets a SID of the domain of the given dn |
|
| 1607 | + * @param string $dn |
|
| 1608 | + * @return string|bool |
|
| 1609 | + */ |
|
| 1610 | + public function getSID($dn) { |
|
| 1611 | + $domainDN = $this->getDomainDNFromDN($dn); |
|
| 1612 | + $cacheKey = 'getSID-'.$domainDN; |
|
| 1613 | + $sid = $this->connection->getFromCache($cacheKey); |
|
| 1614 | + if(!is_null($sid)) { |
|
| 1615 | + return $sid; |
|
| 1616 | + } |
|
| 1617 | + |
|
| 1618 | + $objectSid = $this->readAttribute($domainDN, 'objectsid'); |
|
| 1619 | + if(!is_array($objectSid) || empty($objectSid)) { |
|
| 1620 | + $this->connection->writeToCache($cacheKey, false); |
|
| 1621 | + return false; |
|
| 1622 | + } |
|
| 1623 | + $domainObjectSid = $this->convertSID2Str($objectSid[0]); |
|
| 1624 | + $this->connection->writeToCache($cacheKey, $domainObjectSid); |
|
| 1625 | + |
|
| 1626 | + return $domainObjectSid; |
|
| 1627 | + } |
|
| 1628 | + |
|
| 1629 | + /** |
|
| 1630 | + * converts a binary SID into a string representation |
|
| 1631 | + * @param string $sid |
|
| 1632 | + * @return string |
|
| 1633 | + */ |
|
| 1634 | + public function convertSID2Str($sid) { |
|
| 1635 | + // The format of a SID binary string is as follows: |
|
| 1636 | + // 1 byte for the revision level |
|
| 1637 | + // 1 byte for the number n of variable sub-ids |
|
| 1638 | + // 6 bytes for identifier authority value |
|
| 1639 | + // n*4 bytes for n sub-ids |
|
| 1640 | + // |
|
| 1641 | + // Example: 010400000000000515000000a681e50e4d6c6c2bca32055f |
|
| 1642 | + // Legend: RRNNAAAAAAAAAAAA11111111222222223333333344444444 |
|
| 1643 | + $revision = ord($sid[0]); |
|
| 1644 | + $numberSubID = ord($sid[1]); |
|
| 1645 | + |
|
| 1646 | + $subIdStart = 8; // 1 + 1 + 6 |
|
| 1647 | + $subIdLength = 4; |
|
| 1648 | + if (strlen($sid) !== $subIdStart + $subIdLength * $numberSubID) { |
|
| 1649 | + // Incorrect number of bytes present. |
|
| 1650 | + return ''; |
|
| 1651 | + } |
|
| 1652 | + |
|
| 1653 | + // 6 bytes = 48 bits can be represented using floats without loss of |
|
| 1654 | + // precision (see https://gist.github.com/bantu/886ac680b0aef5812f71) |
|
| 1655 | + $iav = number_format(hexdec(bin2hex(substr($sid, 2, 6))), 0, '', ''); |
|
| 1656 | + |
|
| 1657 | + $subIDs = array(); |
|
| 1658 | + for ($i = 0; $i < $numberSubID; $i++) { |
|
| 1659 | + $subID = unpack('V', substr($sid, $subIdStart + $subIdLength * $i, $subIdLength)); |
|
| 1660 | + $subIDs[] = sprintf('%u', $subID[1]); |
|
| 1661 | + } |
|
| 1662 | + |
|
| 1663 | + // Result for example above: S-1-5-21-249921958-728525901-1594176202 |
|
| 1664 | + return sprintf('S-%d-%s-%s', $revision, $iav, implode('-', $subIDs)); |
|
| 1665 | + } |
|
| 1666 | + |
|
| 1667 | + /** |
|
| 1668 | + * checks if the given DN is part of the given base DN(s) |
|
| 1669 | + * @param string $dn the DN |
|
| 1670 | + * @param string[] $bases array containing the allowed base DN or DNs |
|
| 1671 | + * @return bool |
|
| 1672 | + */ |
|
| 1673 | + public function isDNPartOfBase($dn, $bases) { |
|
| 1674 | + $belongsToBase = false; |
|
| 1675 | + $bases = $this->helper->sanitizeDN($bases); |
|
| 1676 | + |
|
| 1677 | + foreach($bases as $base) { |
|
| 1678 | + $belongsToBase = true; |
|
| 1679 | + if(mb_strripos($dn, $base, 0, 'UTF-8') !== (mb_strlen($dn, 'UTF-8')-mb_strlen($base, 'UTF-8'))) { |
|
| 1680 | + $belongsToBase = false; |
|
| 1681 | + } |
|
| 1682 | + if($belongsToBase) { |
|
| 1683 | + break; |
|
| 1684 | + } |
|
| 1685 | + } |
|
| 1686 | + return $belongsToBase; |
|
| 1687 | + } |
|
| 1688 | + |
|
| 1689 | + /** |
|
| 1690 | + * resets a running Paged Search operation |
|
| 1691 | + */ |
|
| 1692 | + private function abandonPagedSearch() { |
|
| 1693 | + if($this->connection->hasPagedResultSupport) { |
|
| 1694 | + $cr = $this->connection->getConnectionResource(); |
|
| 1695 | + $this->ldap->controlPagedResult($cr, 0, false, $this->lastCookie); |
|
| 1696 | + $this->getPagedSearchResultState(); |
|
| 1697 | + $this->lastCookie = ''; |
|
| 1698 | + $this->cookies = array(); |
|
| 1699 | + } |
|
| 1700 | + } |
|
| 1701 | + |
|
| 1702 | + /** |
|
| 1703 | + * get a cookie for the next LDAP paged search |
|
| 1704 | + * @param string $base a string with the base DN for the search |
|
| 1705 | + * @param string $filter the search filter to identify the correct search |
|
| 1706 | + * @param int $limit the limit (or 'pageSize'), to identify the correct search well |
|
| 1707 | + * @param int $offset the offset for the new search to identify the correct search really good |
|
| 1708 | + * @return string containing the key or empty if none is cached |
|
| 1709 | + */ |
|
| 1710 | + private function getPagedResultCookie($base, $filter, $limit, $offset) { |
|
| 1711 | + if($offset === 0) { |
|
| 1712 | + return ''; |
|
| 1713 | + } |
|
| 1714 | + $offset -= $limit; |
|
| 1715 | + //we work with cache here |
|
| 1716 | + $cacheKey = 'lc' . crc32($base) . '-' . crc32($filter) . '-' . intval($limit) . '-' . intval($offset); |
|
| 1717 | + $cookie = ''; |
|
| 1718 | + if(isset($this->cookies[$cacheKey])) { |
|
| 1719 | + $cookie = $this->cookies[$cacheKey]; |
|
| 1720 | + if(is_null($cookie)) { |
|
| 1721 | + $cookie = ''; |
|
| 1722 | + } |
|
| 1723 | + } |
|
| 1724 | + return $cookie; |
|
| 1725 | + } |
|
| 1726 | + |
|
| 1727 | + /** |
|
| 1728 | + * checks whether an LDAP paged search operation has more pages that can be |
|
| 1729 | + * retrieved, typically when offset and limit are provided. |
|
| 1730 | + * |
|
| 1731 | + * Be very careful to use it: the last cookie value, which is inspected, can |
|
| 1732 | + * be reset by other operations. Best, call it immediately after a search(), |
|
| 1733 | + * searchUsers() or searchGroups() call. count-methods are probably safe as |
|
| 1734 | + * well. Don't rely on it with any fetchList-method. |
|
| 1735 | + * @return bool |
|
| 1736 | + */ |
|
| 1737 | + public function hasMoreResults() { |
|
| 1738 | + if(!$this->connection->hasPagedResultSupport) { |
|
| 1739 | + return false; |
|
| 1740 | + } |
|
| 1741 | + |
|
| 1742 | + if(empty($this->lastCookie) && $this->lastCookie !== '0') { |
|
| 1743 | + // as in RFC 2696, when all results are returned, the cookie will |
|
| 1744 | + // be empty. |
|
| 1745 | + return false; |
|
| 1746 | + } |
|
| 1747 | + |
|
| 1748 | + return true; |
|
| 1749 | + } |
|
| 1750 | + |
|
| 1751 | + /** |
|
| 1752 | + * set a cookie for LDAP paged search run |
|
| 1753 | + * @param string $base a string with the base DN for the search |
|
| 1754 | + * @param string $filter the search filter to identify the correct search |
|
| 1755 | + * @param int $limit the limit (or 'pageSize'), to identify the correct search well |
|
| 1756 | + * @param int $offset the offset for the run search to identify the correct search really good |
|
| 1757 | + * @param string $cookie string containing the cookie returned by ldap_control_paged_result_response |
|
| 1758 | + * @return void |
|
| 1759 | + */ |
|
| 1760 | + private function setPagedResultCookie($base, $filter, $limit, $offset, $cookie) { |
|
| 1761 | + // allow '0' for 389ds |
|
| 1762 | + if(!empty($cookie) || $cookie === '0') { |
|
| 1763 | + $cacheKey = 'lc' . crc32($base) . '-' . crc32($filter) . '-' .intval($limit) . '-' . intval($offset); |
|
| 1764 | + $this->cookies[$cacheKey] = $cookie; |
|
| 1765 | + $this->lastCookie = $cookie; |
|
| 1766 | + } |
|
| 1767 | + } |
|
| 1768 | + |
|
| 1769 | + /** |
|
| 1770 | + * Check whether the most recent paged search was successful. It flushed the state var. Use it always after a possible paged search. |
|
| 1771 | + * @return boolean|null true on success, null or false otherwise |
|
| 1772 | + */ |
|
| 1773 | + public function getPagedSearchResultState() { |
|
| 1774 | + $result = $this->pagedSearchedSuccessful; |
|
| 1775 | + $this->pagedSearchedSuccessful = null; |
|
| 1776 | + return $result; |
|
| 1777 | + } |
|
| 1778 | + |
|
| 1779 | + /** |
|
| 1780 | + * Prepares a paged search, if possible |
|
| 1781 | + * @param string $filter the LDAP filter for the search |
|
| 1782 | + * @param string[] $bases an array containing the LDAP subtree(s) that shall be searched |
|
| 1783 | + * @param string[] $attr optional, when a certain attribute shall be filtered outside |
|
| 1784 | + * @param int $limit |
|
| 1785 | + * @param int $offset |
|
| 1786 | + * @return bool|true |
|
| 1787 | + */ |
|
| 1788 | + private function initPagedSearch($filter, $bases, $attr, $limit, $offset) { |
|
| 1789 | + $pagedSearchOK = false; |
|
| 1790 | + if($this->connection->hasPagedResultSupport && ($limit !== 0)) { |
|
| 1791 | + $offset = intval($offset); //can be null |
|
| 1792 | + \OCP\Util::writeLog('user_ldap', |
|
| 1793 | + 'initializing paged search for Filter '.$filter.' base '.print_r($bases, true) |
|
| 1794 | + .' attr '.print_r($attr, true). ' limit ' .$limit.' offset '.$offset, |
|
| 1795 | + \OCP\Util::DEBUG); |
|
| 1796 | + //get the cookie from the search for the previous search, required by LDAP |
|
| 1797 | + foreach($bases as $base) { |
|
| 1798 | + |
|
| 1799 | + $cookie = $this->getPagedResultCookie($base, $filter, $limit, $offset); |
|
| 1800 | + if(empty($cookie) && $cookie !== "0" && ($offset > 0)) { |
|
| 1801 | + // no cookie known, although the offset is not 0. Maybe cache run out. We need |
|
| 1802 | + // to start all over *sigh* (btw, Dear Reader, did you know LDAP paged |
|
| 1803 | + // searching was designed by MSFT?) |
|
| 1804 | + // Lukas: No, but thanks to reading that source I finally know! |
|
| 1805 | + // '0' is valid, because 389ds |
|
| 1806 | + $reOffset = ($offset - $limit) < 0 ? 0 : $offset - $limit; |
|
| 1807 | + //a bit recursive, $offset of 0 is the exit |
|
| 1808 | + \OCP\Util::writeLog('user_ldap', 'Looking for cookie L/O '.$limit.'/'.$reOffset, \OCP\Util::INFO); |
|
| 1809 | + $this->search($filter, array($base), $attr, $limit, $reOffset, true); |
|
| 1810 | + $cookie = $this->getPagedResultCookie($base, $filter, $limit, $offset); |
|
| 1811 | + //still no cookie? obviously, the server does not like us. Let's skip paging efforts. |
|
| 1812 | + //TODO: remember this, probably does not change in the next request... |
|
| 1813 | + if(empty($cookie) && $cookie !== '0') { |
|
| 1814 | + // '0' is valid, because 389ds |
|
| 1815 | + $cookie = null; |
|
| 1816 | + } |
|
| 1817 | + } |
|
| 1818 | + if(!is_null($cookie)) { |
|
| 1819 | + //since offset = 0, this is a new search. We abandon other searches that might be ongoing. |
|
| 1820 | + $this->abandonPagedSearch(); |
|
| 1821 | + $pagedSearchOK = $this->ldap->controlPagedResult( |
|
| 1822 | + $this->connection->getConnectionResource(), $limit, |
|
| 1823 | + false, $cookie); |
|
| 1824 | + if(!$pagedSearchOK) { |
|
| 1825 | + return false; |
|
| 1826 | + } |
|
| 1827 | + \OCP\Util::writeLog('user_ldap', 'Ready for a paged search', \OCP\Util::DEBUG); |
|
| 1828 | + } else { |
|
| 1829 | + \OCP\Util::writeLog('user_ldap', |
|
| 1830 | + 'No paged search for us, Cpt., Limit '.$limit.' Offset '.$offset, |
|
| 1831 | + \OCP\Util::INFO); |
|
| 1832 | + } |
|
| 1833 | + |
|
| 1834 | + } |
|
| 1835 | + /* ++ Fixing RHDS searches with pages with zero results ++ |
|
| 1836 | 1836 | * We coudn't get paged searches working with our RHDS for login ($limit = 0), |
| 1837 | 1837 | * due to pages with zero results. |
| 1838 | 1838 | * So we added "&& !empty($this->lastCookie)" to this test to ignore pagination |
| 1839 | 1839 | * if we don't have a previous paged search. |
| 1840 | 1840 | */ |
| 1841 | - } else if($this->connection->hasPagedResultSupport && $limit === 0 && !empty($this->lastCookie)) { |
|
| 1842 | - // a search without limit was requested. However, if we do use |
|
| 1843 | - // Paged Search once, we always must do it. This requires us to |
|
| 1844 | - // initialize it with the configured page size. |
|
| 1845 | - $this->abandonPagedSearch(); |
|
| 1846 | - // in case someone set it to 0 … use 500, otherwise no results will |
|
| 1847 | - // be returned. |
|
| 1848 | - $pageSize = intval($this->connection->ldapPagingSize) > 0 ? intval($this->connection->ldapPagingSize) : 500; |
|
| 1849 | - $pagedSearchOK = $this->ldap->controlPagedResult( |
|
| 1850 | - $this->connection->getConnectionResource(), $pageSize, false, '' |
|
| 1851 | - ); |
|
| 1852 | - } |
|
| 1853 | - |
|
| 1854 | - return $pagedSearchOK; |
|
| 1855 | - } |
|
| 1841 | + } else if($this->connection->hasPagedResultSupport && $limit === 0 && !empty($this->lastCookie)) { |
|
| 1842 | + // a search without limit was requested. However, if we do use |
|
| 1843 | + // Paged Search once, we always must do it. This requires us to |
|
| 1844 | + // initialize it with the configured page size. |
|
| 1845 | + $this->abandonPagedSearch(); |
|
| 1846 | + // in case someone set it to 0 … use 500, otherwise no results will |
|
| 1847 | + // be returned. |
|
| 1848 | + $pageSize = intval($this->connection->ldapPagingSize) > 0 ? intval($this->connection->ldapPagingSize) : 500; |
|
| 1849 | + $pagedSearchOK = $this->ldap->controlPagedResult( |
|
| 1850 | + $this->connection->getConnectionResource(), $pageSize, false, '' |
|
| 1851 | + ); |
|
| 1852 | + } |
|
| 1853 | + |
|
| 1854 | + return $pagedSearchOK; |
|
| 1855 | + } |
|
| 1856 | 1856 | |
| 1857 | 1857 | } |
@@ -110,7 +110,7 @@ discard block |
||
| 110 | 110 | * @return AbstractMapping |
| 111 | 111 | */ |
| 112 | 112 | public function getUserMapper() { |
| 113 | - if(is_null($this->userMapper)) { |
|
| 113 | + if (is_null($this->userMapper)) { |
|
| 114 | 114 | throw new \Exception('UserMapper was not assigned to this Access instance.'); |
| 115 | 115 | } |
| 116 | 116 | return $this->userMapper; |
@@ -130,7 +130,7 @@ discard block |
||
| 130 | 130 | * @return AbstractMapping |
| 131 | 131 | */ |
| 132 | 132 | public function getGroupMapper() { |
| 133 | - if(is_null($this->groupMapper)) { |
|
| 133 | + if (is_null($this->groupMapper)) { |
|
| 134 | 134 | throw new \Exception('GroupMapper was not assigned to this Access instance.'); |
| 135 | 135 | } |
| 136 | 136 | return $this->groupMapper; |
@@ -161,14 +161,14 @@ discard block |
||
| 161 | 161 | * array if $attr is empty, false otherwise |
| 162 | 162 | */ |
| 163 | 163 | public function readAttribute($dn, $attr, $filter = 'objectClass=*') { |
| 164 | - if(!$this->checkConnection()) { |
|
| 164 | + if (!$this->checkConnection()) { |
|
| 165 | 165 | \OCP\Util::writeLog('user_ldap', |
| 166 | 166 | 'No LDAP Connector assigned, access impossible for readAttribute.', |
| 167 | 167 | \OCP\Util::WARN); |
| 168 | 168 | return false; |
| 169 | 169 | } |
| 170 | 170 | $cr = $this->connection->getConnectionResource(); |
| 171 | - if(!$this->ldap->isResource($cr)) { |
|
| 171 | + if (!$this->ldap->isResource($cr)) { |
|
| 172 | 172 | //LDAP not available |
| 173 | 173 | \OCP\Util::writeLog('user_ldap', 'LDAP resource not available.', \OCP\Util::DEBUG); |
| 174 | 174 | return false; |
@@ -191,7 +191,7 @@ discard block |
||
| 191 | 191 | $isRangeRequest = false; |
| 192 | 192 | do { |
| 193 | 193 | $result = $this->executeRead($cr, $dn, $attrToRead, $filter, $maxResults); |
| 194 | - if(is_bool($result)) { |
|
| 194 | + if (is_bool($result)) { |
|
| 195 | 195 | // when an exists request was run and it was successful, an empty |
| 196 | 196 | // array must be returned |
| 197 | 197 | return $result ? [] : false; |
@@ -208,22 +208,22 @@ discard block |
||
| 208 | 208 | $result = $this->extractRangeData($result, $attr); |
| 209 | 209 | if (!empty($result)) { |
| 210 | 210 | $normalizedResult = $this->extractAttributeValuesFromResult( |
| 211 | - [ $attr => $result['values'] ], |
|
| 211 | + [$attr => $result['values']], |
|
| 212 | 212 | $attr |
| 213 | 213 | ); |
| 214 | 214 | $values = array_merge($values, $normalizedResult); |
| 215 | 215 | |
| 216 | - if($result['rangeHigh'] === '*') { |
|
| 216 | + if ($result['rangeHigh'] === '*') { |
|
| 217 | 217 | // when server replies with * as high range value, there are |
| 218 | 218 | // no more results left |
| 219 | 219 | return $values; |
| 220 | 220 | } else { |
| 221 | - $low = $result['rangeHigh'] + 1; |
|
| 222 | - $attrToRead = $result['attributeName'] . ';range=' . $low . '-*'; |
|
| 221 | + $low = $result['rangeHigh'] + 1; |
|
| 222 | + $attrToRead = $result['attributeName'].';range='.$low.'-*'; |
|
| 223 | 223 | $isRangeRequest = true; |
| 224 | 224 | } |
| 225 | 225 | } |
| 226 | - } while($isRangeRequest); |
|
| 226 | + } while ($isRangeRequest); |
|
| 227 | 227 | |
| 228 | 228 | \OCP\Util::writeLog('user_ldap', 'Requested attribute '.$attr.' not found for '.$dn, \OCP\Util::DEBUG); |
| 229 | 229 | return false; |
@@ -248,13 +248,13 @@ discard block |
||
| 248 | 248 | if (!$this->ldap->isResource($rr)) { |
| 249 | 249 | if ($attribute !== '') { |
| 250 | 250 | //do not throw this message on userExists check, irritates |
| 251 | - \OCP\Util::writeLog('user_ldap', 'readAttribute failed for DN ' . $dn, \OCP\Util::DEBUG); |
|
| 251 | + \OCP\Util::writeLog('user_ldap', 'readAttribute failed for DN '.$dn, \OCP\Util::DEBUG); |
|
| 252 | 252 | } |
| 253 | 253 | //in case an error occurs , e.g. object does not exist |
| 254 | 254 | return false; |
| 255 | 255 | } |
| 256 | 256 | if ($attribute === '' && ($filter === 'objectclass=*' || $this->ldap->countEntries($cr, $rr) === 1)) { |
| 257 | - \OCP\Util::writeLog('user_ldap', 'readAttribute: ' . $dn . ' found', \OCP\Util::DEBUG); |
|
| 257 | + \OCP\Util::writeLog('user_ldap', 'readAttribute: '.$dn.' found', \OCP\Util::DEBUG); |
|
| 258 | 258 | return true; |
| 259 | 259 | } |
| 260 | 260 | $er = $this->ldap->firstEntry($cr, $rr); |
@@ -279,12 +279,12 @@ discard block |
||
| 279 | 279 | */ |
| 280 | 280 | public function extractAttributeValuesFromResult($result, $attribute) { |
| 281 | 281 | $values = []; |
| 282 | - if(isset($result[$attribute]) && $result[$attribute]['count'] > 0) { |
|
| 282 | + if (isset($result[$attribute]) && $result[$attribute]['count'] > 0) { |
|
| 283 | 283 | $lowercaseAttribute = strtolower($attribute); |
| 284 | - for($i=0;$i<$result[$attribute]['count'];$i++) { |
|
| 285 | - if($this->resemblesDN($attribute)) { |
|
| 284 | + for ($i = 0; $i < $result[$attribute]['count']; $i++) { |
|
| 285 | + if ($this->resemblesDN($attribute)) { |
|
| 286 | 286 | $values[] = $this->helper->sanitizeDN($result[$attribute][$i]); |
| 287 | - } elseif($lowercaseAttribute === 'objectguid' || $lowercaseAttribute === 'guid') { |
|
| 287 | + } elseif ($lowercaseAttribute === 'objectguid' || $lowercaseAttribute === 'guid') { |
|
| 288 | 288 | $values[] = $this->convertObjectGUID2Str($result[$attribute][$i]); |
| 289 | 289 | } else { |
| 290 | 290 | $values[] = $result[$attribute][$i]; |
@@ -306,10 +306,10 @@ discard block |
||
| 306 | 306 | */ |
| 307 | 307 | public function extractRangeData($result, $attribute) { |
| 308 | 308 | $keys = array_keys($result); |
| 309 | - foreach($keys as $key) { |
|
| 310 | - if($key !== $attribute && strpos($key, $attribute) === 0) { |
|
| 309 | + foreach ($keys as $key) { |
|
| 310 | + if ($key !== $attribute && strpos($key, $attribute) === 0) { |
|
| 311 | 311 | $queryData = explode(';', $key); |
| 312 | - if(strpos($queryData[1], 'range=') === 0) { |
|
| 312 | + if (strpos($queryData[1], 'range=') === 0) { |
|
| 313 | 313 | $high = substr($queryData[1], 1 + strpos($queryData[1], '-')); |
| 314 | 314 | $data = [ |
| 315 | 315 | 'values' => $result[$key], |
@@ -334,11 +334,11 @@ discard block |
||
| 334 | 334 | * @throws \Exception |
| 335 | 335 | */ |
| 336 | 336 | public function setPassword($userDN, $password) { |
| 337 | - if(intval($this->connection->turnOnPasswordChange) !== 1) { |
|
| 337 | + if (intval($this->connection->turnOnPasswordChange) !== 1) { |
|
| 338 | 338 | throw new \Exception('LDAP password changes are disabled.'); |
| 339 | 339 | } |
| 340 | 340 | $cr = $this->connection->getConnectionResource(); |
| 341 | - if(!$this->ldap->isResource($cr)) { |
|
| 341 | + if (!$this->ldap->isResource($cr)) { |
|
| 342 | 342 | //LDAP not available |
| 343 | 343 | \OCP\Util::writeLog('user_ldap', 'LDAP resource not available.', \OCP\Util::DEBUG); |
| 344 | 344 | return false; |
@@ -346,7 +346,7 @@ discard block |
||
| 346 | 346 | |
| 347 | 347 | try { |
| 348 | 348 | return $this->ldap->modReplace($cr, $userDN, $password); |
| 349 | - } catch(ConstraintViolationException $e) { |
|
| 349 | + } catch (ConstraintViolationException $e) { |
|
| 350 | 350 | throw new HintException('Password change rejected.', \OC::$server->getL10N('user_ldap')->t('Password change rejected. Hint: ').$e->getMessage(), $e->getCode()); |
| 351 | 351 | } |
| 352 | 352 | } |
@@ -388,17 +388,17 @@ discard block |
||
| 388 | 388 | */ |
| 389 | 389 | public function getDomainDNFromDN($dn) { |
| 390 | 390 | $allParts = $this->ldap->explodeDN($dn, 0); |
| 391 | - if($allParts === false) { |
|
| 391 | + if ($allParts === false) { |
|
| 392 | 392 | //not a valid DN |
| 393 | 393 | return ''; |
| 394 | 394 | } |
| 395 | 395 | $domainParts = array(); |
| 396 | 396 | $dcFound = false; |
| 397 | - foreach($allParts as $part) { |
|
| 398 | - if(!$dcFound && strpos($part, 'dc=') === 0) { |
|
| 397 | + foreach ($allParts as $part) { |
|
| 398 | + if (!$dcFound && strpos($part, 'dc=') === 0) { |
|
| 399 | 399 | $dcFound = true; |
| 400 | 400 | } |
| 401 | - if($dcFound) { |
|
| 401 | + if ($dcFound) { |
|
| 402 | 402 | $domainParts[] = $part; |
| 403 | 403 | } |
| 404 | 404 | } |
@@ -425,7 +425,7 @@ discard block |
||
| 425 | 425 | |
| 426 | 426 | //Check whether the DN belongs to the Base, to avoid issues on multi- |
| 427 | 427 | //server setups |
| 428 | - if(is_string($fdn) && $this->isDNPartOfBase($fdn, $this->connection->ldapBaseUsers)) { |
|
| 428 | + if (is_string($fdn) && $this->isDNPartOfBase($fdn, $this->connection->ldapBaseUsers)) { |
|
| 429 | 429 | return $fdn; |
| 430 | 430 | } |
| 431 | 431 | |
@@ -442,7 +442,7 @@ discard block |
||
| 442 | 442 | //To avoid bypassing the base DN settings under certain circumstances |
| 443 | 443 | //with the group support, check whether the provided DN matches one of |
| 444 | 444 | //the given Bases |
| 445 | - if(!$this->isDNPartOfBase($fdn, $this->connection->ldapBaseGroups)) { |
|
| 445 | + if (!$this->isDNPartOfBase($fdn, $this->connection->ldapBaseGroups)) { |
|
| 446 | 446 | return false; |
| 447 | 447 | } |
| 448 | 448 | |
@@ -459,11 +459,11 @@ discard block |
||
| 459 | 459 | */ |
| 460 | 460 | public function groupsMatchFilter($groupDNs) { |
| 461 | 461 | $validGroupDNs = []; |
| 462 | - foreach($groupDNs as $dn) { |
|
| 462 | + foreach ($groupDNs as $dn) { |
|
| 463 | 463 | $cacheKey = 'groupsMatchFilter-'.$dn; |
| 464 | 464 | $groupMatchFilter = $this->connection->getFromCache($cacheKey); |
| 465 | - if(!is_null($groupMatchFilter)) { |
|
| 466 | - if($groupMatchFilter) { |
|
| 465 | + if (!is_null($groupMatchFilter)) { |
|
| 466 | + if ($groupMatchFilter) { |
|
| 467 | 467 | $validGroupDNs[] = $dn; |
| 468 | 468 | } |
| 469 | 469 | continue; |
@@ -471,13 +471,13 @@ discard block |
||
| 471 | 471 | |
| 472 | 472 | // Check the base DN first. If this is not met already, we don't |
| 473 | 473 | // need to ask the server at all. |
| 474 | - if(!$this->isDNPartOfBase($dn, $this->connection->ldapBaseGroups)) { |
|
| 474 | + if (!$this->isDNPartOfBase($dn, $this->connection->ldapBaseGroups)) { |
|
| 475 | 475 | $this->connection->writeToCache($cacheKey, false); |
| 476 | 476 | continue; |
| 477 | 477 | } |
| 478 | 478 | |
| 479 | 479 | $result = $this->readAttribute($dn, 'cn', $this->connection->ldapGroupFilter); |
| 480 | - if(is_array($result)) { |
|
| 480 | + if (is_array($result)) { |
|
| 481 | 481 | $this->connection->writeToCache($cacheKey, true); |
| 482 | 482 | $validGroupDNs[] = $dn; |
| 483 | 483 | } else { |
@@ -498,7 +498,7 @@ discard block |
||
| 498 | 498 | //To avoid bypassing the base DN settings under certain circumstances |
| 499 | 499 | //with the group support, check whether the provided DN matches one of |
| 500 | 500 | //the given Bases |
| 501 | - if(!$this->isDNPartOfBase($fdn, $this->connection->ldapBaseUsers)) { |
|
| 501 | + if (!$this->isDNPartOfBase($fdn, $this->connection->ldapBaseUsers)) { |
|
| 502 | 502 | return false; |
| 503 | 503 | } |
| 504 | 504 | |
@@ -513,7 +513,7 @@ discard block |
||
| 513 | 513 | * @return string|false with with the name to use in ownCloud |
| 514 | 514 | */ |
| 515 | 515 | public function dn2ocname($fdn, $ldapName = null, $isUser = true) { |
| 516 | - if($isUser) { |
|
| 516 | + if ($isUser) { |
|
| 517 | 517 | $mapper = $this->getUserMapper(); |
| 518 | 518 | $nameAttribute = $this->connection->ldapUserDisplayName; |
| 519 | 519 | } else { |
@@ -523,15 +523,15 @@ discard block |
||
| 523 | 523 | |
| 524 | 524 | //let's try to retrieve the ownCloud name from the mappings table |
| 525 | 525 | $ocName = $mapper->getNameByDN($fdn); |
| 526 | - if(is_string($ocName)) { |
|
| 526 | + if (is_string($ocName)) { |
|
| 527 | 527 | return $ocName; |
| 528 | 528 | } |
| 529 | 529 | |
| 530 | 530 | //second try: get the UUID and check if it is known. Then, update the DN and return the name. |
| 531 | 531 | $uuid = $this->getUUID($fdn, $isUser); |
| 532 | - if(is_string($uuid)) { |
|
| 532 | + if (is_string($uuid)) { |
|
| 533 | 533 | $ocName = $mapper->getNameByUUID($uuid); |
| 534 | - if(is_string($ocName)) { |
|
| 534 | + if (is_string($ocName)) { |
|
| 535 | 535 | $mapper->setDNbyUUID($fdn, $uuid); |
| 536 | 536 | return $ocName; |
| 537 | 537 | } |
@@ -541,16 +541,16 @@ discard block |
||
| 541 | 541 | return false; |
| 542 | 542 | } |
| 543 | 543 | |
| 544 | - if(is_null($ldapName)) { |
|
| 544 | + if (is_null($ldapName)) { |
|
| 545 | 545 | $ldapName = $this->readAttribute($fdn, $nameAttribute); |
| 546 | - if(!isset($ldapName[0]) && empty($ldapName[0])) { |
|
| 546 | + if (!isset($ldapName[0]) && empty($ldapName[0])) { |
|
| 547 | 547 | \OCP\Util::writeLog('user_ldap', 'No or empty name for '.$fdn.'.', \OCP\Util::INFO); |
| 548 | 548 | return false; |
| 549 | 549 | } |
| 550 | 550 | $ldapName = $ldapName[0]; |
| 551 | 551 | } |
| 552 | 552 | |
| 553 | - if($isUser) { |
|
| 553 | + if ($isUser) { |
|
| 554 | 554 | $usernameAttribute = strval($this->connection->ldapExpertUsernameAttr); |
| 555 | 555 | if ($usernameAttribute !== '') { |
| 556 | 556 | $username = $this->readAttribute($fdn, $usernameAttribute); |
@@ -569,9 +569,9 @@ discard block |
||
| 569 | 569 | // outside of core user management will still cache the user as non-existing. |
| 570 | 570 | $originalTTL = $this->connection->ldapCacheTTL; |
| 571 | 571 | $this->connection->setConfiguration(array('ldapCacheTTL' => 0)); |
| 572 | - if(($isUser && !\OCP\User::userExists($intName)) |
|
| 572 | + if (($isUser && !\OCP\User::userExists($intName)) |
|
| 573 | 573 | || (!$isUser && !\OC_Group::groupExists($intName))) { |
| 574 | - if($mapper->map($fdn, $intName, $uuid)) { |
|
| 574 | + if ($mapper->map($fdn, $intName, $uuid)) { |
|
| 575 | 575 | $this->connection->setConfiguration(array('ldapCacheTTL' => $originalTTL)); |
| 576 | 576 | return $intName; |
| 577 | 577 | } |
@@ -579,7 +579,7 @@ discard block |
||
| 579 | 579 | $this->connection->setConfiguration(array('ldapCacheTTL' => $originalTTL)); |
| 580 | 580 | |
| 581 | 581 | $altName = $this->createAltInternalOwnCloudName($intName, $isUser); |
| 582 | - if(is_string($altName) && $mapper->map($fdn, $altName, $uuid)) { |
|
| 582 | + if (is_string($altName) && $mapper->map($fdn, $altName, $uuid)) { |
|
| 583 | 583 | return $altName; |
| 584 | 584 | } |
| 585 | 585 | |
@@ -616,7 +616,7 @@ discard block |
||
| 616 | 616 | * @return array |
| 617 | 617 | */ |
| 618 | 618 | private function ldap2ownCloudNames($ldapObjects, $isUsers) { |
| 619 | - if($isUsers) { |
|
| 619 | + if ($isUsers) { |
|
| 620 | 620 | $nameAttribute = $this->connection->ldapUserDisplayName; |
| 621 | 621 | $sndAttribute = $this->connection->ldapUserDisplayName2; |
| 622 | 622 | } else { |
@@ -624,9 +624,9 @@ discard block |
||
| 624 | 624 | } |
| 625 | 625 | $ownCloudNames = array(); |
| 626 | 626 | |
| 627 | - foreach($ldapObjects as $ldapObject) { |
|
| 627 | + foreach ($ldapObjects as $ldapObject) { |
|
| 628 | 628 | $nameByLDAP = null; |
| 629 | - if( isset($ldapObject[$nameAttribute]) |
|
| 629 | + if (isset($ldapObject[$nameAttribute]) |
|
| 630 | 630 | && is_array($ldapObject[$nameAttribute]) |
| 631 | 631 | && isset($ldapObject[$nameAttribute][0]) |
| 632 | 632 | ) { |
@@ -635,12 +635,12 @@ discard block |
||
| 635 | 635 | } |
| 636 | 636 | |
| 637 | 637 | $ocName = $this->dn2ocname($ldapObject['dn'][0], $nameByLDAP, $isUsers); |
| 638 | - if($ocName) { |
|
| 638 | + if ($ocName) { |
|
| 639 | 639 | $ownCloudNames[] = $ocName; |
| 640 | - if($isUsers) { |
|
| 640 | + if ($isUsers) { |
|
| 641 | 641 | //cache the user names so it does not need to be retrieved |
| 642 | 642 | //again later (e.g. sharing dialogue). |
| 643 | - if(is_null($nameByLDAP)) { |
|
| 643 | + if (is_null($nameByLDAP)) { |
|
| 644 | 644 | continue; |
| 645 | 645 | } |
| 646 | 646 | $sndName = isset($ldapObject[$sndAttribute][0]) |
@@ -678,7 +678,7 @@ discard block |
||
| 678 | 678 | */ |
| 679 | 679 | public function cacheUserDisplayName($ocName, $displayName, $displayName2 = '') { |
| 680 | 680 | $user = $this->userManager->get($ocName); |
| 681 | - if($user === null) { |
|
| 681 | + if ($user === null) { |
|
| 682 | 682 | return; |
| 683 | 683 | } |
| 684 | 684 | $displayName = $user->composeAndStoreDisplayName($displayName, $displayName2); |
@@ -698,9 +698,9 @@ discard block |
||
| 698 | 698 | $attempts = 0; |
| 699 | 699 | //while loop is just a precaution. If a name is not generated within |
| 700 | 700 | //20 attempts, something else is very wrong. Avoids infinite loop. |
| 701 | - while($attempts < 20){ |
|
| 702 | - $altName = $name . '_' . rand(1000,9999); |
|
| 703 | - if(!\OCP\User::userExists($altName)) { |
|
| 701 | + while ($attempts < 20) { |
|
| 702 | + $altName = $name.'_'.rand(1000, 9999); |
|
| 703 | + if (!\OCP\User::userExists($altName)) { |
|
| 704 | 704 | return $altName; |
| 705 | 705 | } |
| 706 | 706 | $attempts++; |
@@ -722,25 +722,25 @@ discard block |
||
| 722 | 722 | */ |
| 723 | 723 | private function _createAltInternalOwnCloudNameForGroups($name) { |
| 724 | 724 | $usedNames = $this->groupMapper->getNamesBySearch($name, "", '_%'); |
| 725 | - if(!($usedNames) || count($usedNames) === 0) { |
|
| 725 | + if (!($usedNames) || count($usedNames) === 0) { |
|
| 726 | 726 | $lastNo = 1; //will become name_2 |
| 727 | 727 | } else { |
| 728 | 728 | natsort($usedNames); |
| 729 | 729 | $lastName = array_pop($usedNames); |
| 730 | 730 | $lastNo = intval(substr($lastName, strrpos($lastName, '_') + 1)); |
| 731 | 731 | } |
| 732 | - $altName = $name.'_'.strval($lastNo+1); |
|
| 732 | + $altName = $name.'_'.strval($lastNo + 1); |
|
| 733 | 733 | unset($usedNames); |
| 734 | 734 | |
| 735 | 735 | $attempts = 1; |
| 736 | - while($attempts < 21){ |
|
| 736 | + while ($attempts < 21) { |
|
| 737 | 737 | // Check to be really sure it is unique |
| 738 | 738 | // while loop is just a precaution. If a name is not generated within |
| 739 | 739 | // 20 attempts, something else is very wrong. Avoids infinite loop. |
| 740 | - if(!\OC_Group::groupExists($altName)) { |
|
| 740 | + if (!\OC_Group::groupExists($altName)) { |
|
| 741 | 741 | return $altName; |
| 742 | 742 | } |
| 743 | - $altName = $name . '_' . ($lastNo + $attempts); |
|
| 743 | + $altName = $name.'_'.($lastNo + $attempts); |
|
| 744 | 744 | $attempts++; |
| 745 | 745 | } |
| 746 | 746 | return false; |
@@ -755,7 +755,7 @@ discard block |
||
| 755 | 755 | private function createAltInternalOwnCloudName($name, $isUser) { |
| 756 | 756 | $originalTTL = $this->connection->ldapCacheTTL; |
| 757 | 757 | $this->connection->setConfiguration(array('ldapCacheTTL' => 0)); |
| 758 | - if($isUser) { |
|
| 758 | + if ($isUser) { |
|
| 759 | 759 | $altName = $this->_createAltInternalOwnCloudNameForUsers($name); |
| 760 | 760 | } else { |
| 761 | 761 | $altName = $this->_createAltInternalOwnCloudNameForGroups($name); |
@@ -813,20 +813,20 @@ discard block |
||
| 813 | 813 | * and their values |
| 814 | 814 | * @param array $ldapRecords |
| 815 | 815 | */ |
| 816 | - public function batchApplyUserAttributes(array $ldapRecords){ |
|
| 816 | + public function batchApplyUserAttributes(array $ldapRecords) { |
|
| 817 | 817 | $displayNameAttribute = strtolower($this->connection->ldapUserDisplayName); |
| 818 | - foreach($ldapRecords as $userRecord) { |
|
| 819 | - if(!isset($userRecord[$displayNameAttribute])) { |
|
| 818 | + foreach ($ldapRecords as $userRecord) { |
|
| 819 | + if (!isset($userRecord[$displayNameAttribute])) { |
|
| 820 | 820 | // displayName is obligatory |
| 821 | 821 | continue; |
| 822 | 822 | } |
| 823 | - $ocName = $this->dn2ocname($userRecord['dn'][0]); |
|
| 824 | - if($ocName === false) { |
|
| 823 | + $ocName = $this->dn2ocname($userRecord['dn'][0]); |
|
| 824 | + if ($ocName === false) { |
|
| 825 | 825 | continue; |
| 826 | 826 | } |
| 827 | 827 | $this->cacheUserExists($ocName); |
| 828 | 828 | $user = $this->userManager->get($ocName); |
| 829 | - if($user instanceof OfflineUser) { |
|
| 829 | + if ($user instanceof OfflineUser) { |
|
| 830 | 830 | $user->unmark(); |
| 831 | 831 | $user = $this->userManager->get($ocName); |
| 832 | 832 | } |
@@ -858,8 +858,8 @@ discard block |
||
| 858 | 858 | * @return array |
| 859 | 859 | */ |
| 860 | 860 | private function fetchList($list, $manyAttributes) { |
| 861 | - if(is_array($list)) { |
|
| 862 | - if($manyAttributes) { |
|
| 861 | + if (is_array($list)) { |
|
| 862 | + if ($manyAttributes) { |
|
| 863 | 863 | return $list; |
| 864 | 864 | } else { |
| 865 | 865 | $list = array_reduce($list, function($carry, $item) { |
@@ -945,13 +945,13 @@ discard block |
||
| 945 | 945 | * second | false if not successful |
| 946 | 946 | */ |
| 947 | 947 | private function executeSearch($filter, $base, &$attr = null, $limit = null, $offset = null) { |
| 948 | - if(!is_null($attr) && !is_array($attr)) { |
|
| 948 | + if (!is_null($attr) && !is_array($attr)) { |
|
| 949 | 949 | $attr = array(mb_strtolower($attr, 'UTF-8')); |
| 950 | 950 | } |
| 951 | 951 | |
| 952 | 952 | // See if we have a resource, in case not cancel with message |
| 953 | 953 | $cr = $this->connection->getConnectionResource(); |
| 954 | - if(!$this->ldap->isResource($cr)) { |
|
| 954 | + if (!$this->ldap->isResource($cr)) { |
|
| 955 | 955 | // Seems like we didn't find any resource. |
| 956 | 956 | // Return an empty array just like before. |
| 957 | 957 | \OCP\Util::writeLog('user_ldap', 'Could not search, because resource is missing.', \OCP\Util::DEBUG); |
@@ -964,7 +964,7 @@ discard block |
||
| 964 | 964 | $linkResources = array_pad(array(), count($base), $cr); |
| 965 | 965 | $sr = $this->ldap->search($linkResources, $base, $filter, $attr); |
| 966 | 966 | $error = $this->ldap->errno($cr); |
| 967 | - if(!is_array($sr) || $error !== 0) { |
|
| 967 | + if (!is_array($sr) || $error !== 0) { |
|
| 968 | 968 | \OCP\Util::writeLog('user_ldap', 'Attempt for Paging? '.print_r($pagedSearchOK, true), \OCP\Util::ERROR); |
| 969 | 969 | return false; |
| 970 | 970 | } |
@@ -987,26 +987,26 @@ discard block |
||
| 987 | 987 | */ |
| 988 | 988 | private function processPagedSearchStatus($sr, $filter, $base, $iFoundItems, $limit, $offset, $pagedSearchOK, $skipHandling) { |
| 989 | 989 | $cookie = null; |
| 990 | - if($pagedSearchOK) { |
|
| 990 | + if ($pagedSearchOK) { |
|
| 991 | 991 | $cr = $this->connection->getConnectionResource(); |
| 992 | - foreach($sr as $key => $res) { |
|
| 993 | - if($this->ldap->controlPagedResultResponse($cr, $res, $cookie)) { |
|
| 992 | + foreach ($sr as $key => $res) { |
|
| 993 | + if ($this->ldap->controlPagedResultResponse($cr, $res, $cookie)) { |
|
| 994 | 994 | $this->setPagedResultCookie($base[$key], $filter, $limit, $offset, $cookie); |
| 995 | 995 | } |
| 996 | 996 | } |
| 997 | 997 | |
| 998 | 998 | //browsing through prior pages to get the cookie for the new one |
| 999 | - if($skipHandling) { |
|
| 999 | + if ($skipHandling) { |
|
| 1000 | 1000 | return false; |
| 1001 | 1001 | } |
| 1002 | 1002 | // if count is bigger, then the server does not support |
| 1003 | 1003 | // paged search. Instead, he did a normal search. We set a |
| 1004 | 1004 | // flag here, so the callee knows how to deal with it. |
| 1005 | - if($iFoundItems <= $limit) { |
|
| 1005 | + if ($iFoundItems <= $limit) { |
|
| 1006 | 1006 | $this->pagedSearchedSuccessful = true; |
| 1007 | 1007 | } |
| 1008 | 1008 | } else { |
| 1009 | - if(!is_null($limit)) { |
|
| 1009 | + if (!is_null($limit)) { |
|
| 1010 | 1010 | \OCP\Util::writeLog('user_ldap', 'Paged search was not available', \OCP\Util::INFO); |
| 1011 | 1011 | } |
| 1012 | 1012 | } |
@@ -1035,7 +1035,7 @@ discard block |
||
| 1035 | 1035 | \OCP\Util::writeLog('user_ldap', 'Count filter: '.print_r($filter, true), \OCP\Util::DEBUG); |
| 1036 | 1036 | |
| 1037 | 1037 | $limitPerPage = intval($this->connection->ldapPagingSize); |
| 1038 | - if(!is_null($limit) && $limit < $limitPerPage && $limit > 0) { |
|
| 1038 | + if (!is_null($limit) && $limit < $limitPerPage && $limit > 0) { |
|
| 1039 | 1039 | $limitPerPage = $limit; |
| 1040 | 1040 | } |
| 1041 | 1041 | |
@@ -1046,7 +1046,7 @@ discard block |
||
| 1046 | 1046 | do { |
| 1047 | 1047 | $search = $this->executeSearch($filter, $base, $attr, |
| 1048 | 1048 | $limitPerPage, $offset); |
| 1049 | - if($search === false) { |
|
| 1049 | + if ($search === false) { |
|
| 1050 | 1050 | return $counter > 0 ? $counter : false; |
| 1051 | 1051 | } |
| 1052 | 1052 | list($sr, $pagedSearchOK) = $search; |
@@ -1065,7 +1065,7 @@ discard block |
||
| 1065 | 1065 | * Continue now depends on $hasMorePages value |
| 1066 | 1066 | */ |
| 1067 | 1067 | $continue = $pagedSearchOK && $hasMorePages; |
| 1068 | - } while($continue && (is_null($limit) || $limit <= 0 || $limit > $counter)); |
|
| 1068 | + } while ($continue && (is_null($limit) || $limit <= 0 || $limit > $counter)); |
|
| 1069 | 1069 | |
| 1070 | 1070 | return $counter; |
| 1071 | 1071 | } |
@@ -1078,7 +1078,7 @@ discard block |
||
| 1078 | 1078 | $cr = $this->connection->getConnectionResource(); |
| 1079 | 1079 | $counter = 0; |
| 1080 | 1080 | |
| 1081 | - foreach($searchResults as $res) { |
|
| 1081 | + foreach ($searchResults as $res) { |
|
| 1082 | 1082 | $count = intval($this->ldap->countEntries($cr, $res)); |
| 1083 | 1083 | $counter += $count; |
| 1084 | 1084 | } |
@@ -1097,7 +1097,7 @@ discard block |
||
| 1097 | 1097 | * @return array with the search result |
| 1098 | 1098 | */ |
| 1099 | 1099 | private function search($filter, $base, $attr = null, $limit = null, $offset = null, $skipHandling = false) { |
| 1100 | - if($limit <= 0) { |
|
| 1100 | + if ($limit <= 0) { |
|
| 1101 | 1101 | //otherwise search will fail |
| 1102 | 1102 | $limit = null; |
| 1103 | 1103 | } |
@@ -1112,13 +1112,13 @@ discard block |
||
| 1112 | 1112 | $savedoffset = $offset; |
| 1113 | 1113 | do { |
| 1114 | 1114 | $search = $this->executeSearch($filter, $base, $attr, $limit, $offset); |
| 1115 | - if($search === false) { |
|
| 1115 | + if ($search === false) { |
|
| 1116 | 1116 | return array(); |
| 1117 | 1117 | } |
| 1118 | 1118 | list($sr, $pagedSearchOK) = $search; |
| 1119 | 1119 | $cr = $this->connection->getConnectionResource(); |
| 1120 | 1120 | |
| 1121 | - if($skipHandling) { |
|
| 1121 | + if ($skipHandling) { |
|
| 1122 | 1122 | //i.e. result do not need to be fetched, we just need the cookie |
| 1123 | 1123 | //thus pass 1 or any other value as $iFoundItems because it is not |
| 1124 | 1124 | //used |
@@ -1128,8 +1128,8 @@ discard block |
||
| 1128 | 1128 | return array(); |
| 1129 | 1129 | } |
| 1130 | 1130 | |
| 1131 | - foreach($sr as $res) { |
|
| 1132 | - $findings = array_merge($findings, $this->ldap->getEntries($cr , $res )); |
|
| 1131 | + foreach ($sr as $res) { |
|
| 1132 | + $findings = array_merge($findings, $this->ldap->getEntries($cr, $res)); |
|
| 1133 | 1133 | } |
| 1134 | 1134 | |
| 1135 | 1135 | $continue = $this->processPagedSearchStatus($sr, $filter, $base, $findings['count'], |
@@ -1142,25 +1142,25 @@ discard block |
||
| 1142 | 1142 | |
| 1143 | 1143 | // if we're here, probably no connection resource is returned. |
| 1144 | 1144 | // to make ownCloud behave nicely, we simply give back an empty array. |
| 1145 | - if(is_null($findings)) { |
|
| 1145 | + if (is_null($findings)) { |
|
| 1146 | 1146 | return array(); |
| 1147 | 1147 | } |
| 1148 | 1148 | |
| 1149 | - if(!is_null($attr)) { |
|
| 1149 | + if (!is_null($attr)) { |
|
| 1150 | 1150 | $selection = array(); |
| 1151 | 1151 | $i = 0; |
| 1152 | - foreach($findings as $item) { |
|
| 1153 | - if(!is_array($item)) { |
|
| 1152 | + foreach ($findings as $item) { |
|
| 1153 | + if (!is_array($item)) { |
|
| 1154 | 1154 | continue; |
| 1155 | 1155 | } |
| 1156 | 1156 | $item = \OCP\Util::mb_array_change_key_case($item, MB_CASE_LOWER, 'UTF-8'); |
| 1157 | - foreach($attr as $key) { |
|
| 1157 | + foreach ($attr as $key) { |
|
| 1158 | 1158 | $key = mb_strtolower($key, 'UTF-8'); |
| 1159 | - if(isset($item[$key])) { |
|
| 1160 | - if(is_array($item[$key]) && isset($item[$key]['count'])) { |
|
| 1159 | + if (isset($item[$key])) { |
|
| 1160 | + if (is_array($item[$key]) && isset($item[$key]['count'])) { |
|
| 1161 | 1161 | unset($item[$key]['count']); |
| 1162 | 1162 | } |
| 1163 | - if($key !== 'dn') { |
|
| 1163 | + if ($key !== 'dn') { |
|
| 1164 | 1164 | $selection[$i][$key] = $this->resemblesDN($key) ? |
| 1165 | 1165 | $this->helper->sanitizeDN($item[$key]) |
| 1166 | 1166 | : $item[$key]; |
@@ -1177,7 +1177,7 @@ discard block |
||
| 1177 | 1177 | //we slice the findings, when |
| 1178 | 1178 | //a) paged search unsuccessful, though attempted |
| 1179 | 1179 | //b) no paged search, but limit set |
| 1180 | - if((!$this->getPagedSearchResultState() |
|
| 1180 | + if ((!$this->getPagedSearchResultState() |
|
| 1181 | 1181 | && $pagedSearchOK) |
| 1182 | 1182 | || ( |
| 1183 | 1183 | !$pagedSearchOK |
@@ -1194,7 +1194,7 @@ discard block |
||
| 1194 | 1194 | * @return bool|mixed|string |
| 1195 | 1195 | */ |
| 1196 | 1196 | public function sanitizeUsername($name) { |
| 1197 | - if($this->connection->ldapIgnoreNamingRules) { |
|
| 1197 | + if ($this->connection->ldapIgnoreNamingRules) { |
|
| 1198 | 1198 | return $name; |
| 1199 | 1199 | } |
| 1200 | 1200 | |
@@ -1219,13 +1219,13 @@ discard block |
||
| 1219 | 1219 | */ |
| 1220 | 1220 | public function escapeFilterPart($input, $allowAsterisk = false) { |
| 1221 | 1221 | $asterisk = ''; |
| 1222 | - if($allowAsterisk && strlen($input) > 0 && $input[0] === '*') { |
|
| 1222 | + if ($allowAsterisk && strlen($input) > 0 && $input[0] === '*') { |
|
| 1223 | 1223 | $asterisk = '*'; |
| 1224 | 1224 | $input = mb_substr($input, 1, null, 'UTF-8'); |
| 1225 | 1225 | } |
| 1226 | 1226 | $search = array('*', '\\', '(', ')'); |
| 1227 | 1227 | $replace = array('\\*', '\\\\', '\\(', '\\)'); |
| 1228 | - return $asterisk . str_replace($search, $replace, $input); |
|
| 1228 | + return $asterisk.str_replace($search, $replace, $input); |
|
| 1229 | 1229 | } |
| 1230 | 1230 | |
| 1231 | 1231 | /** |
@@ -1255,13 +1255,13 @@ discard block |
||
| 1255 | 1255 | */ |
| 1256 | 1256 | private function combineFilter($filters, $operator) { |
| 1257 | 1257 | $combinedFilter = '('.$operator; |
| 1258 | - foreach($filters as $filter) { |
|
| 1258 | + foreach ($filters as $filter) { |
|
| 1259 | 1259 | if ($filter !== '' && $filter[0] !== '(') { |
| 1260 | 1260 | $filter = '('.$filter.')'; |
| 1261 | 1261 | } |
| 1262 | - $combinedFilter.=$filter; |
|
| 1262 | + $combinedFilter .= $filter; |
|
| 1263 | 1263 | } |
| 1264 | - $combinedFilter.=')'; |
|
| 1264 | + $combinedFilter .= ')'; |
|
| 1265 | 1265 | return $combinedFilter; |
| 1266 | 1266 | } |
| 1267 | 1267 | |
@@ -1297,17 +1297,17 @@ discard block |
||
| 1297 | 1297 | * @throws \Exception |
| 1298 | 1298 | */ |
| 1299 | 1299 | private function getAdvancedFilterPartForSearch($search, $searchAttributes) { |
| 1300 | - if(!is_array($searchAttributes) || count($searchAttributes) < 2) { |
|
| 1300 | + if (!is_array($searchAttributes) || count($searchAttributes) < 2) { |
|
| 1301 | 1301 | throw new \Exception('searchAttributes must be an array with at least two string'); |
| 1302 | 1302 | } |
| 1303 | 1303 | $searchWords = explode(' ', trim($search)); |
| 1304 | 1304 | $wordFilters = array(); |
| 1305 | - foreach($searchWords as $word) { |
|
| 1305 | + foreach ($searchWords as $word) { |
|
| 1306 | 1306 | $word = $this->prepareSearchTerm($word); |
| 1307 | 1307 | //every word needs to appear at least once |
| 1308 | 1308 | $wordMatchOneAttrFilters = array(); |
| 1309 | - foreach($searchAttributes as $attr) { |
|
| 1310 | - $wordMatchOneAttrFilters[] = $attr . '=' . $word; |
|
| 1309 | + foreach ($searchAttributes as $attr) { |
|
| 1310 | + $wordMatchOneAttrFilters[] = $attr.'='.$word; |
|
| 1311 | 1311 | } |
| 1312 | 1312 | $wordFilters[] = $this->combineFilterWithOr($wordMatchOneAttrFilters); |
| 1313 | 1313 | } |
@@ -1325,10 +1325,10 @@ discard block |
||
| 1325 | 1325 | private function getFilterPartForSearch($search, $searchAttributes, $fallbackAttribute) { |
| 1326 | 1326 | $filter = array(); |
| 1327 | 1327 | $haveMultiSearchAttributes = (is_array($searchAttributes) && count($searchAttributes) > 0); |
| 1328 | - if($haveMultiSearchAttributes && strpos(trim($search), ' ') !== false) { |
|
| 1328 | + if ($haveMultiSearchAttributes && strpos(trim($search), ' ') !== false) { |
|
| 1329 | 1329 | try { |
| 1330 | 1330 | return $this->getAdvancedFilterPartForSearch($search, $searchAttributes); |
| 1331 | - } catch(\Exception $e) { |
|
| 1331 | + } catch (\Exception $e) { |
|
| 1332 | 1332 | \OCP\Util::writeLog( |
| 1333 | 1333 | 'user_ldap', |
| 1334 | 1334 | 'Creating advanced filter for search failed, falling back to simple method.', |
@@ -1338,17 +1338,17 @@ discard block |
||
| 1338 | 1338 | } |
| 1339 | 1339 | |
| 1340 | 1340 | $search = $this->prepareSearchTerm($search); |
| 1341 | - if(!is_array($searchAttributes) || count($searchAttributes) === 0) { |
|
| 1341 | + if (!is_array($searchAttributes) || count($searchAttributes) === 0) { |
|
| 1342 | 1342 | if ($fallbackAttribute === '') { |
| 1343 | 1343 | return ''; |
| 1344 | 1344 | } |
| 1345 | - $filter[] = $fallbackAttribute . '=' . $search; |
|
| 1345 | + $filter[] = $fallbackAttribute.'='.$search; |
|
| 1346 | 1346 | } else { |
| 1347 | - foreach($searchAttributes as $attribute) { |
|
| 1348 | - $filter[] = $attribute . '=' . $search; |
|
| 1347 | + foreach ($searchAttributes as $attribute) { |
|
| 1348 | + $filter[] = $attribute.'='.$search; |
|
| 1349 | 1349 | } |
| 1350 | 1350 | } |
| 1351 | - if(count($filter) === 1) { |
|
| 1351 | + if (count($filter) === 1) { |
|
| 1352 | 1352 | return '('.$filter[0].')'; |
| 1353 | 1353 | } |
| 1354 | 1354 | return $this->combineFilterWithOr($filter); |
@@ -1369,7 +1369,7 @@ discard block |
||
| 1369 | 1369 | if ($term === '') { |
| 1370 | 1370 | $result = '*'; |
| 1371 | 1371 | } else if ($allowEnum !== 'no') { |
| 1372 | - $result = $term . '*'; |
|
| 1372 | + $result = $term.'*'; |
|
| 1373 | 1373 | } |
| 1374 | 1374 | return $result; |
| 1375 | 1375 | } |
@@ -1381,7 +1381,7 @@ discard block |
||
| 1381 | 1381 | public function getFilterForUserCount() { |
| 1382 | 1382 | $filter = $this->combineFilterWithAnd(array( |
| 1383 | 1383 | $this->connection->ldapUserFilter, |
| 1384 | - $this->connection->ldapUserDisplayName . '=*' |
|
| 1384 | + $this->connection->ldapUserDisplayName.'=*' |
|
| 1385 | 1385 | )); |
| 1386 | 1386 | |
| 1387 | 1387 | return $filter; |
@@ -1399,7 +1399,7 @@ discard block |
||
| 1399 | 1399 | 'ldapAgentName' => $name, |
| 1400 | 1400 | 'ldapAgentPassword' => $password |
| 1401 | 1401 | ); |
| 1402 | - if(!$testConnection->setConfiguration($credentials)) { |
|
| 1402 | + if (!$testConnection->setConfiguration($credentials)) { |
|
| 1403 | 1403 | return false; |
| 1404 | 1404 | } |
| 1405 | 1405 | return $testConnection->bind(); |
@@ -1421,30 +1421,30 @@ discard block |
||
| 1421 | 1421 | // Sacrebleu! The UUID attribute is unknown :( We need first an |
| 1422 | 1422 | // existing DN to be able to reliably detect it. |
| 1423 | 1423 | $result = $this->search($filter, $base, ['dn'], 1); |
| 1424 | - if(!isset($result[0]) || !isset($result[0]['dn'])) { |
|
| 1424 | + if (!isset($result[0]) || !isset($result[0]['dn'])) { |
|
| 1425 | 1425 | throw new \Exception('Cannot determine UUID attribute'); |
| 1426 | 1426 | } |
| 1427 | 1427 | $dn = $result[0]['dn'][0]; |
| 1428 | - if(!$this->detectUuidAttribute($dn, true)) { |
|
| 1428 | + if (!$this->detectUuidAttribute($dn, true)) { |
|
| 1429 | 1429 | throw new \Exception('Cannot determine UUID attribute'); |
| 1430 | 1430 | } |
| 1431 | 1431 | } else { |
| 1432 | 1432 | // The UUID attribute is either known or an override is given. |
| 1433 | 1433 | // By calling this method we ensure that $this->connection->$uuidAttr |
| 1434 | 1434 | // is definitely set |
| 1435 | - if(!$this->detectUuidAttribute('', true)) { |
|
| 1435 | + if (!$this->detectUuidAttribute('', true)) { |
|
| 1436 | 1436 | throw new \Exception('Cannot determine UUID attribute'); |
| 1437 | 1437 | } |
| 1438 | 1438 | } |
| 1439 | 1439 | |
| 1440 | 1440 | $uuidAttr = $this->connection->ldapUuidUserAttribute; |
| 1441 | - if($uuidAttr === 'guid' || $uuidAttr === 'objectguid') { |
|
| 1441 | + if ($uuidAttr === 'guid' || $uuidAttr === 'objectguid') { |
|
| 1442 | 1442 | $uuid = $this->formatGuid2ForFilterUser($uuid); |
| 1443 | 1443 | } |
| 1444 | 1444 | |
| 1445 | - $filter = $uuidAttr . '=' . $uuid; |
|
| 1445 | + $filter = $uuidAttr.'='.$uuid; |
|
| 1446 | 1446 | $result = $this->searchUsers($filter, ['dn'], 2); |
| 1447 | - if(is_array($result) && isset($result[0]) && isset($result[0]['dn']) && count($result) === 1) { |
|
| 1447 | + if (is_array($result) && isset($result[0]) && isset($result[0]['dn']) && count($result) === 1) { |
|
| 1448 | 1448 | // we put the count into account to make sure that this is |
| 1449 | 1449 | // really unique |
| 1450 | 1450 | return $result[0]['dn'][0]; |
@@ -1461,7 +1461,7 @@ discard block |
||
| 1461 | 1461 | * @return bool true on success, false otherwise |
| 1462 | 1462 | */ |
| 1463 | 1463 | private function detectUuidAttribute($dn, $isUser = true, $force = false) { |
| 1464 | - if($isUser) { |
|
| 1464 | + if ($isUser) { |
|
| 1465 | 1465 | $uuidAttr = 'ldapUuidUserAttribute'; |
| 1466 | 1466 | $uuidOverride = $this->connection->ldapExpertUUIDUserAttr; |
| 1467 | 1467 | } else { |
@@ -1469,7 +1469,7 @@ discard block |
||
| 1469 | 1469 | $uuidOverride = $this->connection->ldapExpertUUIDGroupAttr; |
| 1470 | 1470 | } |
| 1471 | 1471 | |
| 1472 | - if(($this->connection->$uuidAttr !== 'auto') && !$force) { |
|
| 1472 | + if (($this->connection->$uuidAttr !== 'auto') && !$force) { |
|
| 1473 | 1473 | return true; |
| 1474 | 1474 | } |
| 1475 | 1475 | |
@@ -1481,9 +1481,9 @@ discard block |
||
| 1481 | 1481 | // for now, supported attributes are entryUUID, nsuniqueid, objectGUID, ipaUniqueID |
| 1482 | 1482 | $testAttributes = array('entryuuid', 'nsuniqueid', 'objectguid', 'guid', 'ipauniqueid'); |
| 1483 | 1483 | |
| 1484 | - foreach($testAttributes as $attribute) { |
|
| 1484 | + foreach ($testAttributes as $attribute) { |
|
| 1485 | 1485 | $value = $this->readAttribute($dn, $attribute); |
| 1486 | - if(is_array($value) && isset($value[0]) && !empty($value[0])) { |
|
| 1486 | + if (is_array($value) && isset($value[0]) && !empty($value[0])) { |
|
| 1487 | 1487 | \OCP\Util::writeLog('user_ldap', |
| 1488 | 1488 | 'Setting '.$attribute.' as '.$uuidAttr, |
| 1489 | 1489 | \OCP\Util::DEBUG); |
@@ -1504,7 +1504,7 @@ discard block |
||
| 1504 | 1504 | * @return string|bool |
| 1505 | 1505 | */ |
| 1506 | 1506 | public function getUUID($dn, $isUser = true) { |
| 1507 | - if($isUser) { |
|
| 1507 | + if ($isUser) { |
|
| 1508 | 1508 | $uuidAttr = 'ldapUuidUserAttribute'; |
| 1509 | 1509 | $uuidOverride = $this->connection->ldapExpertUUIDUserAttr; |
| 1510 | 1510 | } else { |
@@ -1513,15 +1513,15 @@ discard block |
||
| 1513 | 1513 | } |
| 1514 | 1514 | |
| 1515 | 1515 | $uuid = false; |
| 1516 | - if($this->detectUuidAttribute($dn, $isUser)) { |
|
| 1516 | + if ($this->detectUuidAttribute($dn, $isUser)) { |
|
| 1517 | 1517 | $uuid = $this->readAttribute($dn, $this->connection->$uuidAttr); |
| 1518 | - if( !is_array($uuid) |
|
| 1518 | + if (!is_array($uuid) |
|
| 1519 | 1519 | && $uuidOverride !== '' |
| 1520 | 1520 | && $this->detectUuidAttribute($dn, $isUser, true)) { |
| 1521 | 1521 | $uuid = $this->readAttribute($dn, |
| 1522 | 1522 | $this->connection->$uuidAttr); |
| 1523 | 1523 | } |
| 1524 | - if(is_array($uuid) && isset($uuid[0]) && !empty($uuid[0])) { |
|
| 1524 | + if (is_array($uuid) && isset($uuid[0]) && !empty($uuid[0])) { |
|
| 1525 | 1525 | $uuid = $uuid[0]; |
| 1526 | 1526 | } |
| 1527 | 1527 | } |
@@ -1538,19 +1538,19 @@ discard block |
||
| 1538 | 1538 | private function convertObjectGUID2Str($oguid) { |
| 1539 | 1539 | $hex_guid = bin2hex($oguid); |
| 1540 | 1540 | $hex_guid_to_guid_str = ''; |
| 1541 | - for($k = 1; $k <= 4; ++$k) { |
|
| 1541 | + for ($k = 1; $k <= 4; ++$k) { |
|
| 1542 | 1542 | $hex_guid_to_guid_str .= substr($hex_guid, 8 - 2 * $k, 2); |
| 1543 | 1543 | } |
| 1544 | 1544 | $hex_guid_to_guid_str .= '-'; |
| 1545 | - for($k = 1; $k <= 2; ++$k) { |
|
| 1545 | + for ($k = 1; $k <= 2; ++$k) { |
|
| 1546 | 1546 | $hex_guid_to_guid_str .= substr($hex_guid, 12 - 2 * $k, 2); |
| 1547 | 1547 | } |
| 1548 | 1548 | $hex_guid_to_guid_str .= '-'; |
| 1549 | - for($k = 1; $k <= 2; ++$k) { |
|
| 1549 | + for ($k = 1; $k <= 2; ++$k) { |
|
| 1550 | 1550 | $hex_guid_to_guid_str .= substr($hex_guid, 16 - 2 * $k, 2); |
| 1551 | 1551 | } |
| 1552 | - $hex_guid_to_guid_str .= '-' . substr($hex_guid, 16, 4); |
|
| 1553 | - $hex_guid_to_guid_str .= '-' . substr($hex_guid, 20); |
|
| 1552 | + $hex_guid_to_guid_str .= '-'.substr($hex_guid, 16, 4); |
|
| 1553 | + $hex_guid_to_guid_str .= '-'.substr($hex_guid, 20); |
|
| 1554 | 1554 | |
| 1555 | 1555 | return strtoupper($hex_guid_to_guid_str); |
| 1556 | 1556 | } |
@@ -1567,11 +1567,11 @@ discard block |
||
| 1567 | 1567 | * @return string |
| 1568 | 1568 | */ |
| 1569 | 1569 | public function formatGuid2ForFilterUser($guid) { |
| 1570 | - if(!is_string($guid)) { |
|
| 1570 | + if (!is_string($guid)) { |
|
| 1571 | 1571 | throw new \InvalidArgumentException('String expected'); |
| 1572 | 1572 | } |
| 1573 | 1573 | $blocks = explode('-', $guid); |
| 1574 | - if(count($blocks) !== 5) { |
|
| 1574 | + if (count($blocks) !== 5) { |
|
| 1575 | 1575 | /* |
| 1576 | 1576 | * Why not throw an Exception instead? This method is a utility |
| 1577 | 1577 | * called only when trying to figure out whether a "missing" known |
@@ -1584,20 +1584,20 @@ discard block |
||
| 1584 | 1584 | * user. Instead we write a log message. |
| 1585 | 1585 | */ |
| 1586 | 1586 | \OC::$server->getLogger()->info( |
| 1587 | - 'Passed string does not resemble a valid GUID. Known UUID ' . |
|
| 1587 | + 'Passed string does not resemble a valid GUID. Known UUID '. |
|
| 1588 | 1588 | '({uuid}) probably does not match UUID configuration.', |
| 1589 | - [ 'app' => 'user_ldap', 'uuid' => $guid ] |
|
| 1589 | + ['app' => 'user_ldap', 'uuid' => $guid] |
|
| 1590 | 1590 | ); |
| 1591 | 1591 | return $guid; |
| 1592 | 1592 | } |
| 1593 | - for($i=0; $i < 3; $i++) { |
|
| 1593 | + for ($i = 0; $i < 3; $i++) { |
|
| 1594 | 1594 | $pairs = str_split($blocks[$i], 2); |
| 1595 | 1595 | $pairs = array_reverse($pairs); |
| 1596 | 1596 | $blocks[$i] = implode('', $pairs); |
| 1597 | 1597 | } |
| 1598 | - for($i=0; $i < 5; $i++) { |
|
| 1598 | + for ($i = 0; $i < 5; $i++) { |
|
| 1599 | 1599 | $pairs = str_split($blocks[$i], 2); |
| 1600 | - $blocks[$i] = '\\' . implode('\\', $pairs); |
|
| 1600 | + $blocks[$i] = '\\'.implode('\\', $pairs); |
|
| 1601 | 1601 | } |
| 1602 | 1602 | return implode('', $blocks); |
| 1603 | 1603 | } |
@@ -1611,12 +1611,12 @@ discard block |
||
| 1611 | 1611 | $domainDN = $this->getDomainDNFromDN($dn); |
| 1612 | 1612 | $cacheKey = 'getSID-'.$domainDN; |
| 1613 | 1613 | $sid = $this->connection->getFromCache($cacheKey); |
| 1614 | - if(!is_null($sid)) { |
|
| 1614 | + if (!is_null($sid)) { |
|
| 1615 | 1615 | return $sid; |
| 1616 | 1616 | } |
| 1617 | 1617 | |
| 1618 | 1618 | $objectSid = $this->readAttribute($domainDN, 'objectsid'); |
| 1619 | - if(!is_array($objectSid) || empty($objectSid)) { |
|
| 1619 | + if (!is_array($objectSid) || empty($objectSid)) { |
|
| 1620 | 1620 | $this->connection->writeToCache($cacheKey, false); |
| 1621 | 1621 | return false; |
| 1622 | 1622 | } |
@@ -1674,12 +1674,12 @@ discard block |
||
| 1674 | 1674 | $belongsToBase = false; |
| 1675 | 1675 | $bases = $this->helper->sanitizeDN($bases); |
| 1676 | 1676 | |
| 1677 | - foreach($bases as $base) { |
|
| 1677 | + foreach ($bases as $base) { |
|
| 1678 | 1678 | $belongsToBase = true; |
| 1679 | - if(mb_strripos($dn, $base, 0, 'UTF-8') !== (mb_strlen($dn, 'UTF-8')-mb_strlen($base, 'UTF-8'))) { |
|
| 1679 | + if (mb_strripos($dn, $base, 0, 'UTF-8') !== (mb_strlen($dn, 'UTF-8') - mb_strlen($base, 'UTF-8'))) { |
|
| 1680 | 1680 | $belongsToBase = false; |
| 1681 | 1681 | } |
| 1682 | - if($belongsToBase) { |
|
| 1682 | + if ($belongsToBase) { |
|
| 1683 | 1683 | break; |
| 1684 | 1684 | } |
| 1685 | 1685 | } |
@@ -1690,7 +1690,7 @@ discard block |
||
| 1690 | 1690 | * resets a running Paged Search operation |
| 1691 | 1691 | */ |
| 1692 | 1692 | private function abandonPagedSearch() { |
| 1693 | - if($this->connection->hasPagedResultSupport) { |
|
| 1693 | + if ($this->connection->hasPagedResultSupport) { |
|
| 1694 | 1694 | $cr = $this->connection->getConnectionResource(); |
| 1695 | 1695 | $this->ldap->controlPagedResult($cr, 0, false, $this->lastCookie); |
| 1696 | 1696 | $this->getPagedSearchResultState(); |
@@ -1708,16 +1708,16 @@ discard block |
||
| 1708 | 1708 | * @return string containing the key or empty if none is cached |
| 1709 | 1709 | */ |
| 1710 | 1710 | private function getPagedResultCookie($base, $filter, $limit, $offset) { |
| 1711 | - if($offset === 0) { |
|
| 1711 | + if ($offset === 0) { |
|
| 1712 | 1712 | return ''; |
| 1713 | 1713 | } |
| 1714 | 1714 | $offset -= $limit; |
| 1715 | 1715 | //we work with cache here |
| 1716 | - $cacheKey = 'lc' . crc32($base) . '-' . crc32($filter) . '-' . intval($limit) . '-' . intval($offset); |
|
| 1716 | + $cacheKey = 'lc'.crc32($base).'-'.crc32($filter).'-'.intval($limit).'-'.intval($offset); |
|
| 1717 | 1717 | $cookie = ''; |
| 1718 | - if(isset($this->cookies[$cacheKey])) { |
|
| 1718 | + if (isset($this->cookies[$cacheKey])) { |
|
| 1719 | 1719 | $cookie = $this->cookies[$cacheKey]; |
| 1720 | - if(is_null($cookie)) { |
|
| 1720 | + if (is_null($cookie)) { |
|
| 1721 | 1721 | $cookie = ''; |
| 1722 | 1722 | } |
| 1723 | 1723 | } |
@@ -1735,11 +1735,11 @@ discard block |
||
| 1735 | 1735 | * @return bool |
| 1736 | 1736 | */ |
| 1737 | 1737 | public function hasMoreResults() { |
| 1738 | - if(!$this->connection->hasPagedResultSupport) { |
|
| 1738 | + if (!$this->connection->hasPagedResultSupport) { |
|
| 1739 | 1739 | return false; |
| 1740 | 1740 | } |
| 1741 | 1741 | |
| 1742 | - if(empty($this->lastCookie) && $this->lastCookie !== '0') { |
|
| 1742 | + if (empty($this->lastCookie) && $this->lastCookie !== '0') { |
|
| 1743 | 1743 | // as in RFC 2696, when all results are returned, the cookie will |
| 1744 | 1744 | // be empty. |
| 1745 | 1745 | return false; |
@@ -1759,8 +1759,8 @@ discard block |
||
| 1759 | 1759 | */ |
| 1760 | 1760 | private function setPagedResultCookie($base, $filter, $limit, $offset, $cookie) { |
| 1761 | 1761 | // allow '0' for 389ds |
| 1762 | - if(!empty($cookie) || $cookie === '0') { |
|
| 1763 | - $cacheKey = 'lc' . crc32($base) . '-' . crc32($filter) . '-' .intval($limit) . '-' . intval($offset); |
|
| 1762 | + if (!empty($cookie) || $cookie === '0') { |
|
| 1763 | + $cacheKey = 'lc'.crc32($base).'-'.crc32($filter).'-'.intval($limit).'-'.intval($offset); |
|
| 1764 | 1764 | $this->cookies[$cacheKey] = $cookie; |
| 1765 | 1765 | $this->lastCookie = $cookie; |
| 1766 | 1766 | } |
@@ -1787,17 +1787,17 @@ discard block |
||
| 1787 | 1787 | */ |
| 1788 | 1788 | private function initPagedSearch($filter, $bases, $attr, $limit, $offset) { |
| 1789 | 1789 | $pagedSearchOK = false; |
| 1790 | - if($this->connection->hasPagedResultSupport && ($limit !== 0)) { |
|
| 1790 | + if ($this->connection->hasPagedResultSupport && ($limit !== 0)) { |
|
| 1791 | 1791 | $offset = intval($offset); //can be null |
| 1792 | 1792 | \OCP\Util::writeLog('user_ldap', |
| 1793 | 1793 | 'initializing paged search for Filter '.$filter.' base '.print_r($bases, true) |
| 1794 | - .' attr '.print_r($attr, true). ' limit ' .$limit.' offset '.$offset, |
|
| 1794 | + .' attr '.print_r($attr, true).' limit '.$limit.' offset '.$offset, |
|
| 1795 | 1795 | \OCP\Util::DEBUG); |
| 1796 | 1796 | //get the cookie from the search for the previous search, required by LDAP |
| 1797 | - foreach($bases as $base) { |
|
| 1797 | + foreach ($bases as $base) { |
|
| 1798 | 1798 | |
| 1799 | 1799 | $cookie = $this->getPagedResultCookie($base, $filter, $limit, $offset); |
| 1800 | - if(empty($cookie) && $cookie !== "0" && ($offset > 0)) { |
|
| 1800 | + if (empty($cookie) && $cookie !== "0" && ($offset > 0)) { |
|
| 1801 | 1801 | // no cookie known, although the offset is not 0. Maybe cache run out. We need |
| 1802 | 1802 | // to start all over *sigh* (btw, Dear Reader, did you know LDAP paged |
| 1803 | 1803 | // searching was designed by MSFT?) |
@@ -1810,18 +1810,18 @@ discard block |
||
| 1810 | 1810 | $cookie = $this->getPagedResultCookie($base, $filter, $limit, $offset); |
| 1811 | 1811 | //still no cookie? obviously, the server does not like us. Let's skip paging efforts. |
| 1812 | 1812 | //TODO: remember this, probably does not change in the next request... |
| 1813 | - if(empty($cookie) && $cookie !== '0') { |
|
| 1813 | + if (empty($cookie) && $cookie !== '0') { |
|
| 1814 | 1814 | // '0' is valid, because 389ds |
| 1815 | 1815 | $cookie = null; |
| 1816 | 1816 | } |
| 1817 | 1817 | } |
| 1818 | - if(!is_null($cookie)) { |
|
| 1818 | + if (!is_null($cookie)) { |
|
| 1819 | 1819 | //since offset = 0, this is a new search. We abandon other searches that might be ongoing. |
| 1820 | 1820 | $this->abandonPagedSearch(); |
| 1821 | 1821 | $pagedSearchOK = $this->ldap->controlPagedResult( |
| 1822 | 1822 | $this->connection->getConnectionResource(), $limit, |
| 1823 | 1823 | false, $cookie); |
| 1824 | - if(!$pagedSearchOK) { |
|
| 1824 | + if (!$pagedSearchOK) { |
|
| 1825 | 1825 | return false; |
| 1826 | 1826 | } |
| 1827 | 1827 | \OCP\Util::writeLog('user_ldap', 'Ready for a paged search', \OCP\Util::DEBUG); |
@@ -1838,7 +1838,7 @@ discard block |
||
| 1838 | 1838 | * So we added "&& !empty($this->lastCookie)" to this test to ignore pagination |
| 1839 | 1839 | * if we don't have a previous paged search. |
| 1840 | 1840 | */ |
| 1841 | - } else if($this->connection->hasPagedResultSupport && $limit === 0 && !empty($this->lastCookie)) { |
|
| 1841 | + } else if ($this->connection->hasPagedResultSupport && $limit === 0 && !empty($this->lastCookie)) { |
|
| 1842 | 1842 | // a search without limit was requested. However, if we do use |
| 1843 | 1843 | // Paged Search once, we always must do it. This requires us to |
| 1844 | 1844 | // initialize it with the configured page size. |
@@ -52,7 +52,7 @@ discard block |
||
| 52 | 52 | /** |
| 53 | 53 | * get color for on-page elements: |
| 54 | 54 | * theme color by default, grey if theme color is to bright |
| 55 | - * @param $color |
|
| 55 | + * @param string $color |
|
| 56 | 56 | * @return string |
| 57 | 57 | */ |
| 58 | 58 | public function elementColor($color) { |
@@ -83,7 +83,7 @@ discard block |
||
| 83 | 83 | } |
| 84 | 84 | |
| 85 | 85 | /** |
| 86 | - * @param $color |
|
| 86 | + * @param string $color |
|
| 87 | 87 | * @return string base64 encoded radio button svg |
| 88 | 88 | */ |
| 89 | 89 | public function generateRadioButton($color) { |
@@ -152,8 +152,8 @@ discard block |
||
| 152 | 152 | /** |
| 153 | 153 | * replace default color with a custom one |
| 154 | 154 | * |
| 155 | - * @param $svg string content of a svg file |
|
| 156 | - * @param $color string color to match |
|
| 155 | + * @param string $svg string content of a svg file |
|
| 156 | + * @param string $color string color to match |
|
| 157 | 157 | * @return string |
| 158 | 158 | */ |
| 159 | 159 | public function colorizeSvg($svg, $color) { |
@@ -30,164 +30,164 @@ |
||
| 30 | 30 | |
| 31 | 31 | class Util { |
| 32 | 32 | |
| 33 | - /** @var IConfig */ |
|
| 34 | - private $config; |
|
| 35 | - |
|
| 36 | - /** @var IRootFolder */ |
|
| 37 | - private $rootFolder; |
|
| 38 | - |
|
| 39 | - /** @var IAppManager */ |
|
| 40 | - private $appManager; |
|
| 41 | - |
|
| 42 | - /** |
|
| 43 | - * Util constructor. |
|
| 44 | - * |
|
| 45 | - * @param IConfig $config |
|
| 46 | - * @param IRootFolder $rootFolder |
|
| 47 | - * @param IAppManager $appManager |
|
| 48 | - */ |
|
| 49 | - public function __construct(IConfig $config, IRootFolder $rootFolder, IAppManager $appManager) { |
|
| 50 | - $this->config = $config; |
|
| 51 | - $this->rootFolder = $rootFolder; |
|
| 52 | - $this->appManager = $appManager; |
|
| 53 | - } |
|
| 54 | - |
|
| 55 | - /** |
|
| 56 | - * @param string $color rgb color value |
|
| 57 | - * @return bool |
|
| 58 | - */ |
|
| 59 | - public function invertTextColor($color) { |
|
| 60 | - $l = $this->calculateLuminance($color); |
|
| 61 | - if($l>0.5) { |
|
| 62 | - return true; |
|
| 63 | - } else { |
|
| 64 | - return false; |
|
| 65 | - } |
|
| 66 | - } |
|
| 67 | - |
|
| 68 | - /** |
|
| 69 | - * get color for on-page elements: |
|
| 70 | - * theme color by default, grey if theme color is to bright |
|
| 71 | - * @param $color |
|
| 72 | - * @return string |
|
| 73 | - */ |
|
| 74 | - public function elementColor($color) { |
|
| 75 | - $l = $this->calculateLuminance($color); |
|
| 76 | - if($l>0.8) { |
|
| 77 | - return '#555555'; |
|
| 78 | - } else { |
|
| 79 | - return $color; |
|
| 80 | - } |
|
| 81 | - } |
|
| 82 | - |
|
| 83 | - /** |
|
| 84 | - * @param string $color rgb color value |
|
| 85 | - * @return float |
|
| 86 | - */ |
|
| 87 | - public function calculateLuminance($color) { |
|
| 88 | - $hex = preg_replace("/[^0-9A-Fa-f]/", '', $color); |
|
| 89 | - if (strlen($hex) === 3) { |
|
| 90 | - $hex = $hex{0} . $hex{0} . $hex{1} . $hex{1} . $hex{2} . $hex{2}; |
|
| 91 | - } |
|
| 92 | - if (strlen($hex) !== 6) { |
|
| 93 | - return 0; |
|
| 94 | - } |
|
| 95 | - $r = hexdec(substr($hex, 0, 2)); |
|
| 96 | - $g = hexdec(substr($hex, 2, 2)); |
|
| 97 | - $b = hexdec(substr($hex, 4, 2)); |
|
| 98 | - return (0.299 * $r + 0.587 * $g + 0.114 * $b)/255; |
|
| 99 | - } |
|
| 100 | - |
|
| 101 | - /** |
|
| 102 | - * @param $color |
|
| 103 | - * @return string base64 encoded radio button svg |
|
| 104 | - */ |
|
| 105 | - public function generateRadioButton($color) { |
|
| 106 | - $radioButtonIcon = '<svg xmlns="http://www.w3.org/2000/svg" height="16" width="16">' . |
|
| 107 | - '<path d="M8 1a7 7 0 0 0-7 7 7 7 0 0 0 7 7 7 7 0 0 0 7-7 7 7 0 0 0-7-7zm0 1a6 6 0 0 1 6 6 6 6 0 0 1-6 6 6 6 0 0 1-6-6 6 6 0 0 1 6-6zm0 2a4 4 0 1 0 0 8 4 4 0 0 0 0-8z" fill="'.$color.'"/></svg>'; |
|
| 108 | - return base64_encode($radioButtonIcon); |
|
| 109 | - } |
|
| 110 | - |
|
| 111 | - |
|
| 112 | - /** |
|
| 113 | - * @param $app string app name |
|
| 114 | - * @return string path to app icon / logo |
|
| 115 | - */ |
|
| 116 | - public function getAppIcon($app) { |
|
| 117 | - $app = str_replace(array('\0', '/', '\\', '..'), '', $app); |
|
| 118 | - try { |
|
| 119 | - $appPath = $this->appManager->getAppPath($app); |
|
| 120 | - $icon = $appPath . '/img/' . $app . '.svg'; |
|
| 121 | - if (file_exists($icon)) { |
|
| 122 | - return $icon; |
|
| 123 | - } |
|
| 124 | - $icon = $appPath . '/img/app.svg'; |
|
| 125 | - if (file_exists($icon)) { |
|
| 126 | - return $icon; |
|
| 127 | - } |
|
| 128 | - } catch (AppPathNotFoundException $e) {} |
|
| 129 | - |
|
| 130 | - if($this->config->getAppValue('theming', 'logoMime', '') !== '' && $this->rootFolder->nodeExists('/themedinstancelogo')) { |
|
| 131 | - return $this->config->getSystemValue('datadirectory', \OC::$SERVERROOT . '/data') . '/themedinstancelogo'; |
|
| 132 | - } |
|
| 133 | - return \OC::$SERVERROOT . '/core/img/logo.svg'; |
|
| 134 | - } |
|
| 135 | - |
|
| 136 | - /** |
|
| 137 | - * @param $app string app name |
|
| 138 | - * @param $image string relative path to image in app folder |
|
| 139 | - * @return string|false absolute path to image |
|
| 140 | - */ |
|
| 141 | - public function getAppImage($app, $image) { |
|
| 142 | - $app = str_replace(array('\0', '/', '\\', '..'), '', $app); |
|
| 143 | - $image = str_replace(array('\0', '\\', '..'), '', $image); |
|
| 144 | - if ($app === "core") { |
|
| 145 | - $icon = \OC::$SERVERROOT . '/core/img/' . $image; |
|
| 146 | - if (file_exists($icon)) { |
|
| 147 | - return $icon; |
|
| 148 | - } |
|
| 149 | - } |
|
| 150 | - |
|
| 151 | - try { |
|
| 152 | - $appPath = $this->appManager->getAppPath($app); |
|
| 153 | - } catch (AppPathNotFoundException $e) { |
|
| 154 | - return false; |
|
| 155 | - } |
|
| 156 | - |
|
| 157 | - $icon = $appPath . '/img/' . $image; |
|
| 158 | - if (file_exists($icon)) { |
|
| 159 | - return $icon; |
|
| 160 | - } |
|
| 161 | - $icon = $appPath . '/img/' . $image . '.svg'; |
|
| 162 | - if (file_exists($icon)) { |
|
| 163 | - return $icon; |
|
| 164 | - } |
|
| 165 | - $icon = $appPath . '/img/' . $image . '.png'; |
|
| 166 | - if (file_exists($icon)) { |
|
| 167 | - return $icon; |
|
| 168 | - } |
|
| 169 | - $icon = $appPath . '/img/' . $image . '.gif'; |
|
| 170 | - if (file_exists($icon)) { |
|
| 171 | - return $icon; |
|
| 172 | - } |
|
| 173 | - $icon = $appPath . '/img/' . $image . '.jpg'; |
|
| 174 | - if (file_exists($icon)) { |
|
| 175 | - return $icon; |
|
| 176 | - } |
|
| 177 | - |
|
| 178 | - return false; |
|
| 179 | - } |
|
| 180 | - |
|
| 181 | - /** |
|
| 182 | - * replace default color with a custom one |
|
| 183 | - * |
|
| 184 | - * @param $svg string content of a svg file |
|
| 185 | - * @param $color string color to match |
|
| 186 | - * @return string |
|
| 187 | - */ |
|
| 188 | - public function colorizeSvg($svg, $color) { |
|
| 189 | - $svg = preg_replace('/#0082c9/i', $color, $svg); |
|
| 190 | - return $svg; |
|
| 191 | - } |
|
| 33 | + /** @var IConfig */ |
|
| 34 | + private $config; |
|
| 35 | + |
|
| 36 | + /** @var IRootFolder */ |
|
| 37 | + private $rootFolder; |
|
| 38 | + |
|
| 39 | + /** @var IAppManager */ |
|
| 40 | + private $appManager; |
|
| 41 | + |
|
| 42 | + /** |
|
| 43 | + * Util constructor. |
|
| 44 | + * |
|
| 45 | + * @param IConfig $config |
|
| 46 | + * @param IRootFolder $rootFolder |
|
| 47 | + * @param IAppManager $appManager |
|
| 48 | + */ |
|
| 49 | + public function __construct(IConfig $config, IRootFolder $rootFolder, IAppManager $appManager) { |
|
| 50 | + $this->config = $config; |
|
| 51 | + $this->rootFolder = $rootFolder; |
|
| 52 | + $this->appManager = $appManager; |
|
| 53 | + } |
|
| 54 | + |
|
| 55 | + /** |
|
| 56 | + * @param string $color rgb color value |
|
| 57 | + * @return bool |
|
| 58 | + */ |
|
| 59 | + public function invertTextColor($color) { |
|
| 60 | + $l = $this->calculateLuminance($color); |
|
| 61 | + if($l>0.5) { |
|
| 62 | + return true; |
|
| 63 | + } else { |
|
| 64 | + return false; |
|
| 65 | + } |
|
| 66 | + } |
|
| 67 | + |
|
| 68 | + /** |
|
| 69 | + * get color for on-page elements: |
|
| 70 | + * theme color by default, grey if theme color is to bright |
|
| 71 | + * @param $color |
|
| 72 | + * @return string |
|
| 73 | + */ |
|
| 74 | + public function elementColor($color) { |
|
| 75 | + $l = $this->calculateLuminance($color); |
|
| 76 | + if($l>0.8) { |
|
| 77 | + return '#555555'; |
|
| 78 | + } else { |
|
| 79 | + return $color; |
|
| 80 | + } |
|
| 81 | + } |
|
| 82 | + |
|
| 83 | + /** |
|
| 84 | + * @param string $color rgb color value |
|
| 85 | + * @return float |
|
| 86 | + */ |
|
| 87 | + public function calculateLuminance($color) { |
|
| 88 | + $hex = preg_replace("/[^0-9A-Fa-f]/", '', $color); |
|
| 89 | + if (strlen($hex) === 3) { |
|
| 90 | + $hex = $hex{0} . $hex{0} . $hex{1} . $hex{1} . $hex{2} . $hex{2}; |
|
| 91 | + } |
|
| 92 | + if (strlen($hex) !== 6) { |
|
| 93 | + return 0; |
|
| 94 | + } |
|
| 95 | + $r = hexdec(substr($hex, 0, 2)); |
|
| 96 | + $g = hexdec(substr($hex, 2, 2)); |
|
| 97 | + $b = hexdec(substr($hex, 4, 2)); |
|
| 98 | + return (0.299 * $r + 0.587 * $g + 0.114 * $b)/255; |
|
| 99 | + } |
|
| 100 | + |
|
| 101 | + /** |
|
| 102 | + * @param $color |
|
| 103 | + * @return string base64 encoded radio button svg |
|
| 104 | + */ |
|
| 105 | + public function generateRadioButton($color) { |
|
| 106 | + $radioButtonIcon = '<svg xmlns="http://www.w3.org/2000/svg" height="16" width="16">' . |
|
| 107 | + '<path d="M8 1a7 7 0 0 0-7 7 7 7 0 0 0 7 7 7 7 0 0 0 7-7 7 7 0 0 0-7-7zm0 1a6 6 0 0 1 6 6 6 6 0 0 1-6 6 6 6 0 0 1-6-6 6 6 0 0 1 6-6zm0 2a4 4 0 1 0 0 8 4 4 0 0 0 0-8z" fill="'.$color.'"/></svg>'; |
|
| 108 | + return base64_encode($radioButtonIcon); |
|
| 109 | + } |
|
| 110 | + |
|
| 111 | + |
|
| 112 | + /** |
|
| 113 | + * @param $app string app name |
|
| 114 | + * @return string path to app icon / logo |
|
| 115 | + */ |
|
| 116 | + public function getAppIcon($app) { |
|
| 117 | + $app = str_replace(array('\0', '/', '\\', '..'), '', $app); |
|
| 118 | + try { |
|
| 119 | + $appPath = $this->appManager->getAppPath($app); |
|
| 120 | + $icon = $appPath . '/img/' . $app . '.svg'; |
|
| 121 | + if (file_exists($icon)) { |
|
| 122 | + return $icon; |
|
| 123 | + } |
|
| 124 | + $icon = $appPath . '/img/app.svg'; |
|
| 125 | + if (file_exists($icon)) { |
|
| 126 | + return $icon; |
|
| 127 | + } |
|
| 128 | + } catch (AppPathNotFoundException $e) {} |
|
| 129 | + |
|
| 130 | + if($this->config->getAppValue('theming', 'logoMime', '') !== '' && $this->rootFolder->nodeExists('/themedinstancelogo')) { |
|
| 131 | + return $this->config->getSystemValue('datadirectory', \OC::$SERVERROOT . '/data') . '/themedinstancelogo'; |
|
| 132 | + } |
|
| 133 | + return \OC::$SERVERROOT . '/core/img/logo.svg'; |
|
| 134 | + } |
|
| 135 | + |
|
| 136 | + /** |
|
| 137 | + * @param $app string app name |
|
| 138 | + * @param $image string relative path to image in app folder |
|
| 139 | + * @return string|false absolute path to image |
|
| 140 | + */ |
|
| 141 | + public function getAppImage($app, $image) { |
|
| 142 | + $app = str_replace(array('\0', '/', '\\', '..'), '', $app); |
|
| 143 | + $image = str_replace(array('\0', '\\', '..'), '', $image); |
|
| 144 | + if ($app === "core") { |
|
| 145 | + $icon = \OC::$SERVERROOT . '/core/img/' . $image; |
|
| 146 | + if (file_exists($icon)) { |
|
| 147 | + return $icon; |
|
| 148 | + } |
|
| 149 | + } |
|
| 150 | + |
|
| 151 | + try { |
|
| 152 | + $appPath = $this->appManager->getAppPath($app); |
|
| 153 | + } catch (AppPathNotFoundException $e) { |
|
| 154 | + return false; |
|
| 155 | + } |
|
| 156 | + |
|
| 157 | + $icon = $appPath . '/img/' . $image; |
|
| 158 | + if (file_exists($icon)) { |
|
| 159 | + return $icon; |
|
| 160 | + } |
|
| 161 | + $icon = $appPath . '/img/' . $image . '.svg'; |
|
| 162 | + if (file_exists($icon)) { |
|
| 163 | + return $icon; |
|
| 164 | + } |
|
| 165 | + $icon = $appPath . '/img/' . $image . '.png'; |
|
| 166 | + if (file_exists($icon)) { |
|
| 167 | + return $icon; |
|
| 168 | + } |
|
| 169 | + $icon = $appPath . '/img/' . $image . '.gif'; |
|
| 170 | + if (file_exists($icon)) { |
|
| 171 | + return $icon; |
|
| 172 | + } |
|
| 173 | + $icon = $appPath . '/img/' . $image . '.jpg'; |
|
| 174 | + if (file_exists($icon)) { |
|
| 175 | + return $icon; |
|
| 176 | + } |
|
| 177 | + |
|
| 178 | + return false; |
|
| 179 | + } |
|
| 180 | + |
|
| 181 | + /** |
|
| 182 | + * replace default color with a custom one |
|
| 183 | + * |
|
| 184 | + * @param $svg string content of a svg file |
|
| 185 | + * @param $color string color to match |
|
| 186 | + * @return string |
|
| 187 | + */ |
|
| 188 | + public function colorizeSvg($svg, $color) { |
|
| 189 | + $svg = preg_replace('/#0082c9/i', $color, $svg); |
|
| 190 | + return $svg; |
|
| 191 | + } |
|
| 192 | 192 | |
| 193 | 193 | } |
@@ -58,7 +58,7 @@ discard block |
||
| 58 | 58 | */ |
| 59 | 59 | public function invertTextColor($color) { |
| 60 | 60 | $l = $this->calculateLuminance($color); |
| 61 | - if($l>0.5) { |
|
| 61 | + if ($l > 0.5) { |
|
| 62 | 62 | return true; |
| 63 | 63 | } else { |
| 64 | 64 | return false; |
@@ -73,7 +73,7 @@ discard block |
||
| 73 | 73 | */ |
| 74 | 74 | public function elementColor($color) { |
| 75 | 75 | $l = $this->calculateLuminance($color); |
| 76 | - if($l>0.8) { |
|
| 76 | + if ($l > 0.8) { |
|
| 77 | 77 | return '#555555'; |
| 78 | 78 | } else { |
| 79 | 79 | return $color; |
@@ -87,7 +87,7 @@ discard block |
||
| 87 | 87 | public function calculateLuminance($color) { |
| 88 | 88 | $hex = preg_replace("/[^0-9A-Fa-f]/", '', $color); |
| 89 | 89 | if (strlen($hex) === 3) { |
| 90 | - $hex = $hex{0} . $hex{0} . $hex{1} . $hex{1} . $hex{2} . $hex{2}; |
|
| 90 | + $hex = $hex{0}.$hex{0}.$hex{1}.$hex{1}.$hex{2}.$hex{2}; |
|
| 91 | 91 | } |
| 92 | 92 | if (strlen($hex) !== 6) { |
| 93 | 93 | return 0; |
@@ -95,7 +95,7 @@ discard block |
||
| 95 | 95 | $r = hexdec(substr($hex, 0, 2)); |
| 96 | 96 | $g = hexdec(substr($hex, 2, 2)); |
| 97 | 97 | $b = hexdec(substr($hex, 4, 2)); |
| 98 | - return (0.299 * $r + 0.587 * $g + 0.114 * $b)/255; |
|
| 98 | + return (0.299 * $r + 0.587 * $g + 0.114 * $b) / 255; |
|
| 99 | 99 | } |
| 100 | 100 | |
| 101 | 101 | /** |
@@ -103,7 +103,7 @@ discard block |
||
| 103 | 103 | * @return string base64 encoded radio button svg |
| 104 | 104 | */ |
| 105 | 105 | public function generateRadioButton($color) { |
| 106 | - $radioButtonIcon = '<svg xmlns="http://www.w3.org/2000/svg" height="16" width="16">' . |
|
| 106 | + $radioButtonIcon = '<svg xmlns="http://www.w3.org/2000/svg" height="16" width="16">'. |
|
| 107 | 107 | '<path d="M8 1a7 7 0 0 0-7 7 7 7 0 0 0 7 7 7 7 0 0 0 7-7 7 7 0 0 0-7-7zm0 1a6 6 0 0 1 6 6 6 6 0 0 1-6 6 6 6 0 0 1-6-6 6 6 0 0 1 6-6zm0 2a4 4 0 1 0 0 8 4 4 0 0 0 0-8z" fill="'.$color.'"/></svg>'; |
| 108 | 108 | return base64_encode($radioButtonIcon); |
| 109 | 109 | } |
@@ -117,20 +117,20 @@ discard block |
||
| 117 | 117 | $app = str_replace(array('\0', '/', '\\', '..'), '', $app); |
| 118 | 118 | try { |
| 119 | 119 | $appPath = $this->appManager->getAppPath($app); |
| 120 | - $icon = $appPath . '/img/' . $app . '.svg'; |
|
| 120 | + $icon = $appPath.'/img/'.$app.'.svg'; |
|
| 121 | 121 | if (file_exists($icon)) { |
| 122 | 122 | return $icon; |
| 123 | 123 | } |
| 124 | - $icon = $appPath . '/img/app.svg'; |
|
| 124 | + $icon = $appPath.'/img/app.svg'; |
|
| 125 | 125 | if (file_exists($icon)) { |
| 126 | 126 | return $icon; |
| 127 | 127 | } |
| 128 | 128 | } catch (AppPathNotFoundException $e) {} |
| 129 | 129 | |
| 130 | - if($this->config->getAppValue('theming', 'logoMime', '') !== '' && $this->rootFolder->nodeExists('/themedinstancelogo')) { |
|
| 131 | - return $this->config->getSystemValue('datadirectory', \OC::$SERVERROOT . '/data') . '/themedinstancelogo'; |
|
| 130 | + if ($this->config->getAppValue('theming', 'logoMime', '') !== '' && $this->rootFolder->nodeExists('/themedinstancelogo')) { |
|
| 131 | + return $this->config->getSystemValue('datadirectory', \OC::$SERVERROOT.'/data').'/themedinstancelogo'; |
|
| 132 | 132 | } |
| 133 | - return \OC::$SERVERROOT . '/core/img/logo.svg'; |
|
| 133 | + return \OC::$SERVERROOT.'/core/img/logo.svg'; |
|
| 134 | 134 | } |
| 135 | 135 | |
| 136 | 136 | /** |
@@ -142,7 +142,7 @@ discard block |
||
| 142 | 142 | $app = str_replace(array('\0', '/', '\\', '..'), '', $app); |
| 143 | 143 | $image = str_replace(array('\0', '\\', '..'), '', $image); |
| 144 | 144 | if ($app === "core") { |
| 145 | - $icon = \OC::$SERVERROOT . '/core/img/' . $image; |
|
| 145 | + $icon = \OC::$SERVERROOT.'/core/img/'.$image; |
|
| 146 | 146 | if (file_exists($icon)) { |
| 147 | 147 | return $icon; |
| 148 | 148 | } |
@@ -154,23 +154,23 @@ discard block |
||
| 154 | 154 | return false; |
| 155 | 155 | } |
| 156 | 156 | |
| 157 | - $icon = $appPath . '/img/' . $image; |
|
| 157 | + $icon = $appPath.'/img/'.$image; |
|
| 158 | 158 | if (file_exists($icon)) { |
| 159 | 159 | return $icon; |
| 160 | 160 | } |
| 161 | - $icon = $appPath . '/img/' . $image . '.svg'; |
|
| 161 | + $icon = $appPath.'/img/'.$image.'.svg'; |
|
| 162 | 162 | if (file_exists($icon)) { |
| 163 | 163 | return $icon; |
| 164 | 164 | } |
| 165 | - $icon = $appPath . '/img/' . $image . '.png'; |
|
| 165 | + $icon = $appPath.'/img/'.$image.'.png'; |
|
| 166 | 166 | if (file_exists($icon)) { |
| 167 | 167 | return $icon; |
| 168 | 168 | } |
| 169 | - $icon = $appPath . '/img/' . $image . '.gif'; |
|
| 169 | + $icon = $appPath.'/img/'.$image.'.gif'; |
|
| 170 | 170 | if (file_exists($icon)) { |
| 171 | 171 | return $icon; |
| 172 | 172 | } |
| 173 | - $icon = $appPath . '/img/' . $image . '.jpg'; |
|
| 173 | + $icon = $appPath.'/img/'.$image.'.jpg'; |
|
| 174 | 174 | if (file_exists($icon)) { |
| 175 | 175 | return $icon; |
| 176 | 176 | } |
@@ -21,7 +21,6 @@ |
||
| 21 | 21 | namespace OCA\DAV\CalDAV; |
| 22 | 22 | |
| 23 | 23 | use Sabre\DAV\Collection; |
| 24 | -use Sabre\DAV\Exception\NotFound; |
|
| 25 | 24 | |
| 26 | 25 | class PublicCalendarRoot extends Collection { |
| 27 | 26 | |
@@ -25,43 +25,43 @@ |
||
| 25 | 25 | |
| 26 | 26 | class PublicCalendarRoot extends Collection { |
| 27 | 27 | |
| 28 | - /** @var CalDavBackend */ |
|
| 29 | - protected $caldavBackend; |
|
| 28 | + /** @var CalDavBackend */ |
|
| 29 | + protected $caldavBackend; |
|
| 30 | 30 | |
| 31 | - /** @var \OCP\IL10N */ |
|
| 32 | - protected $l10n; |
|
| 31 | + /** @var \OCP\IL10N */ |
|
| 32 | + protected $l10n; |
|
| 33 | 33 | |
| 34 | - function __construct(CalDavBackend $caldavBackend) { |
|
| 35 | - $this->caldavBackend = $caldavBackend; |
|
| 36 | - $this->l10n = \OC::$server->getL10N('dav'); |
|
| 37 | - } |
|
| 34 | + function __construct(CalDavBackend $caldavBackend) { |
|
| 35 | + $this->caldavBackend = $caldavBackend; |
|
| 36 | + $this->l10n = \OC::$server->getL10N('dav'); |
|
| 37 | + } |
|
| 38 | 38 | |
| 39 | - /** |
|
| 40 | - * @inheritdoc |
|
| 41 | - */ |
|
| 42 | - function getName() { |
|
| 43 | - return 'public-calendars'; |
|
| 44 | - } |
|
| 39 | + /** |
|
| 40 | + * @inheritdoc |
|
| 41 | + */ |
|
| 42 | + function getName() { |
|
| 43 | + return 'public-calendars'; |
|
| 44 | + } |
|
| 45 | 45 | |
| 46 | - /** |
|
| 47 | - * @inheritdoc |
|
| 48 | - */ |
|
| 49 | - function getChild($name) { |
|
| 50 | - $calendar = $this->caldavBackend->getPublicCalendar($name); |
|
| 51 | - return new Calendar($this->caldavBackend, $calendar, $this->l10n); |
|
| 52 | - } |
|
| 46 | + /** |
|
| 47 | + * @inheritdoc |
|
| 48 | + */ |
|
| 49 | + function getChild($name) { |
|
| 50 | + $calendar = $this->caldavBackend->getPublicCalendar($name); |
|
| 51 | + return new Calendar($this->caldavBackend, $calendar, $this->l10n); |
|
| 52 | + } |
|
| 53 | 53 | |
| 54 | - /** |
|
| 55 | - * @inheritdoc |
|
| 56 | - */ |
|
| 57 | - function getChildren() { |
|
| 58 | - $calendars = $this->caldavBackend->getPublicCalendars(); |
|
| 59 | - $children = []; |
|
| 60 | - foreach ($calendars as $calendar) { |
|
| 61 | - // TODO: maybe implement a new class PublicCalendar ??? |
|
| 62 | - $children[] = new Calendar($this->caldavBackend, $calendar, $this->l10n); |
|
| 63 | - } |
|
| 54 | + /** |
|
| 55 | + * @inheritdoc |
|
| 56 | + */ |
|
| 57 | + function getChildren() { |
|
| 58 | + $calendars = $this->caldavBackend->getPublicCalendars(); |
|
| 59 | + $children = []; |
|
| 60 | + foreach ($calendars as $calendar) { |
|
| 61 | + // TODO: maybe implement a new class PublicCalendar ??? |
|
| 62 | + $children[] = new Calendar($this->caldavBackend, $calendar, $this->l10n); |
|
| 63 | + } |
|
| 64 | 64 | |
| 65 | - return $children; |
|
| 66 | - } |
|
| 65 | + return $children; |
|
| 66 | + } |
|
| 67 | 67 | } |