nextcloud /
server
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like OC_Util often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use OC_Util, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 67 | class OC_Util { |
||
|
|
|||
| 68 | public static $scripts = array(); |
||
| 69 | public static $styles = array(); |
||
| 70 | public static $headers = array(); |
||
| 71 | private static $rootMounted = false; |
||
| 72 | private static $fsSetup = false; |
||
| 73 | |||
| 74 | /** @var array Local cache of version.php */ |
||
| 75 | private static $versionCache = null; |
||
| 76 | |||
| 77 | protected static function getAppManager() { |
||
| 80 | |||
| 81 | private static function initLocalStorageRootFS() { |
||
| 91 | |||
| 92 | /** |
||
| 93 | * mounting an object storage as the root fs will in essence remove the |
||
| 94 | * necessity of a data folder being present. |
||
| 95 | * TODO make home storage aware of this and use the object storage instead of local disk access |
||
| 96 | * |
||
| 97 | * @param array $config containing 'class' and optional 'arguments' |
||
| 98 | * @suppress PhanDeprecatedFunction |
||
| 99 | */ |
||
| 100 | private static function initObjectStoreRootFS($config) { |
||
| 126 | |||
| 127 | /** |
||
| 128 | * mounting an object storage as the root fs will in essence remove the |
||
| 129 | * necessity of a data folder being present. |
||
| 130 | * |
||
| 131 | * @param array $config containing 'class' and optional 'arguments' |
||
| 132 | * @suppress PhanDeprecatedFunction |
||
| 133 | */ |
||
| 134 | private static function initObjectStoreMultibucketRootFS($config) { |
||
| 167 | |||
| 168 | /** |
||
| 169 | * Can be set up |
||
| 170 | * |
||
| 171 | * @param string $user |
||
| 172 | * @return boolean |
||
| 173 | * @description configure the initial filesystem based on the configuration |
||
| 174 | * @suppress PhanDeprecatedFunction |
||
| 175 | * @suppress PhanAccessMethodInternal |
||
| 176 | */ |
||
| 177 | public static function setupFS($user = '') { |
||
| 295 | |||
| 296 | /** |
||
| 297 | * check if a password is required for each public link |
||
| 298 | * |
||
| 299 | * @return boolean |
||
| 300 | * @suppress PhanDeprecatedFunction |
||
| 301 | */ |
||
| 302 | public static function isPublicLinkPasswordRequired() { |
||
| 303 | $enforcePassword = \OC::$server->getConfig()->getAppValue('core', 'shareapi_enforce_links_password', 'no'); |
||
| 304 | return $enforcePassword === 'yes'; |
||
| 305 | } |
||
| 306 | |||
| 307 | /** |
||
| 308 | * check if sharing is disabled for the current user |
||
| 309 | * @param IConfig $config |
||
| 310 | * @param IGroupManager $groupManager |
||
| 311 | * @param IUser|null $user |
||
| 312 | * @return bool |
||
| 313 | */ |
||
| 314 | public static function isSharingDisabledForUser(IConfig $config, IGroupManager $groupManager, $user) { |
||
| 315 | if ($config->getAppValue('core', 'shareapi_exclude_groups', 'no') === 'yes') { |
||
| 316 | $groupsList = $config->getAppValue('core', 'shareapi_exclude_groups_list', ''); |
||
| 317 | $excludedGroups = json_decode($groupsList); |
||
| 318 | View Code Duplication | if (is_null($excludedGroups)) { |
|
| 319 | $excludedGroups = explode(',', $groupsList); |
||
| 320 | $newValue = json_encode($excludedGroups); |
||
| 321 | $config->setAppValue('core', 'shareapi_exclude_groups_list', $newValue); |
||
| 322 | } |
||
| 323 | $usersGroups = $groupManager->getUserGroupIds($user); |
||
| 324 | View Code Duplication | if (!empty($usersGroups)) { |
|
| 325 | $remainingGroups = array_diff($usersGroups, $excludedGroups); |
||
| 326 | // if the user is only in groups which are disabled for sharing then |
||
| 327 | // sharing is also disabled for the user |
||
| 328 | if (empty($remainingGroups)) { |
||
| 329 | return true; |
||
| 330 | } |
||
| 331 | } |
||
| 332 | } |
||
| 333 | return false; |
||
| 334 | } |
||
| 335 | |||
| 336 | /** |
||
| 337 | * check if share API enforces a default expire date |
||
| 338 | * |
||
| 339 | * @return boolean |
||
| 340 | * @suppress PhanDeprecatedFunction |
||
| 341 | */ |
||
| 342 | public static function isDefaultExpireDateEnforced() { |
||
| 343 | $isDefaultExpireDateEnabled = \OC::$server->getConfig()->getAppValue('core', 'shareapi_default_expire_date', 'no'); |
||
| 344 | $enforceDefaultExpireDate = false; |
||
| 345 | if ($isDefaultExpireDateEnabled === 'yes') { |
||
| 346 | $value = \OC::$server->getConfig()->getAppValue('core', 'shareapi_enforce_expire_date', 'no'); |
||
| 347 | $enforceDefaultExpireDate = $value === 'yes'; |
||
| 348 | } |
||
| 349 | |||
| 350 | return $enforceDefaultExpireDate; |
||
| 351 | } |
||
| 352 | |||
| 353 | /** |
||
| 354 | * Get the quota of a user |
||
| 355 | * |
||
| 356 | * @param string $userId |
||
| 357 | * @return float Quota bytes |
||
| 358 | */ |
||
| 359 | public static function getUserQuota($userId) { |
||
| 360 | $user = \OC::$server->getUserManager()->get($userId); |
||
| 361 | if (is_null($user)) { |
||
| 362 | return \OCP\Files\FileInfo::SPACE_UNLIMITED; |
||
| 363 | } |
||
| 364 | $userQuota = $user->getQuota(); |
||
| 365 | if($userQuota === 'none') { |
||
| 366 | return \OCP\Files\FileInfo::SPACE_UNLIMITED; |
||
| 367 | } |
||
| 368 | return OC_Helper::computerFileSize($userQuota); |
||
| 369 | } |
||
| 370 | |||
| 371 | /** |
||
| 372 | * copies the skeleton to the users /files |
||
| 373 | * |
||
| 374 | * @param String $userId |
||
| 375 | * @param \OCP\Files\Folder $userDirectory |
||
| 376 | * @throws \RuntimeException |
||
| 377 | * @suppress PhanDeprecatedFunction |
||
| 378 | */ |
||
| 379 | public static function copySkeleton($userId, \OCP\Files\Folder $userDirectory) { |
||
| 380 | |||
| 381 | $plainSkeletonDirectory = \OC::$server->getConfig()->getSystemValue('skeletondirectory', \OC::$SERVERROOT . '/core/skeleton'); |
||
| 382 | $userLang = \OC::$server->getL10NFactory()->findLanguage(); |
||
| 383 | $skeletonDirectory = str_replace('{lang}', $userLang, $plainSkeletonDirectory); |
||
| 384 | |||
| 385 | if (!file_exists($skeletonDirectory)) { |
||
| 386 | $dialectStart = strpos($userLang, '_'); |
||
| 387 | if ($dialectStart !== false) { |
||
| 388 | $skeletonDirectory = str_replace('{lang}', substr($userLang, 0, $dialectStart), $plainSkeletonDirectory); |
||
| 389 | } |
||
| 390 | if ($dialectStart === false || !file_exists($skeletonDirectory)) { |
||
| 391 | $skeletonDirectory = str_replace('{lang}', 'default', $plainSkeletonDirectory); |
||
| 392 | } |
||
| 393 | if (!file_exists($skeletonDirectory)) { |
||
| 394 | $skeletonDirectory = ''; |
||
| 395 | } |
||
| 396 | } |
||
| 397 | |||
| 398 | $instanceId = \OC::$server->getConfig()->getSystemValue('instanceid', ''); |
||
| 399 | |||
| 400 | if ($instanceId === null) { |
||
| 401 | throw new \RuntimeException('no instance id!'); |
||
| 402 | } |
||
| 403 | $appdata = 'appdata_' . $instanceId; |
||
| 404 | if ($userId === $appdata) { |
||
| 405 | throw new \RuntimeException('username is reserved name: ' . $appdata); |
||
| 406 | } |
||
| 407 | |||
| 408 | if (!empty($skeletonDirectory)) { |
||
| 409 | \OCP\Util::writeLog( |
||
| 410 | 'files_skeleton', |
||
| 411 | 'copying skeleton for '.$userId.' from '.$skeletonDirectory.' to '.$userDirectory->getFullPath('/'), |
||
| 412 | \OCP\Util::DEBUG |
||
| 413 | ); |
||
| 414 | self::copyr($skeletonDirectory, $userDirectory); |
||
| 415 | // update the file cache |
||
| 416 | $userDirectory->getStorage()->getScanner()->scan('', \OC\Files\Cache\Scanner::SCAN_RECURSIVE); |
||
| 417 | } |
||
| 418 | } |
||
| 419 | |||
| 420 | /** |
||
| 421 | * copies a directory recursively by using streams |
||
| 422 | * |
||
| 423 | * @param string $source |
||
| 424 | * @param \OCP\Files\Folder $target |
||
| 425 | * @return void |
||
| 426 | */ |
||
| 427 | public static function copyr($source, \OCP\Files\Folder $target) { |
||
| 428 | $logger = \OC::$server->getLogger(); |
||
| 429 | |||
| 430 | // Verify if folder exists |
||
| 431 | $dir = opendir($source); |
||
| 432 | if($dir === false) { |
||
| 433 | $logger->error(sprintf('Could not opendir "%s"', $source), ['app' => 'core']); |
||
| 434 | return; |
||
| 435 | } |
||
| 436 | |||
| 437 | // Copy the files |
||
| 438 | while (false !== ($file = readdir($dir))) { |
||
| 439 | if (!\OC\Files\Filesystem::isIgnoredDir($file)) { |
||
| 440 | if (is_dir($source . '/' . $file)) { |
||
| 441 | $child = $target->newFolder($file); |
||
| 442 | self::copyr($source . '/' . $file, $child); |
||
| 443 | } else { |
||
| 444 | $child = $target->newFile($file); |
||
| 445 | $sourceStream = fopen($source . '/' . $file, 'r'); |
||
| 446 | if($sourceStream === false) { |
||
| 447 | $logger->error(sprintf('Could not fopen "%s"', $source . '/' . $file), ['app' => 'core']); |
||
| 448 | closedir($dir); |
||
| 449 | return; |
||
| 450 | } |
||
| 451 | stream_copy_to_stream($sourceStream, $child->fopen('w')); |
||
| 452 | } |
||
| 453 | } |
||
| 454 | } |
||
| 455 | closedir($dir); |
||
| 456 | } |
||
| 457 | |||
| 458 | /** |
||
| 459 | * @return void |
||
| 460 | * @suppress PhanUndeclaredMethod |
||
| 461 | */ |
||
| 462 | public static function tearDownFS() { |
||
| 463 | \OC\Files\Filesystem::tearDown(); |
||
| 464 | \OC::$server->getRootFolder()->clearCache(); |
||
| 465 | self::$fsSetup = false; |
||
| 466 | self::$rootMounted = false; |
||
| 467 | } |
||
| 468 | |||
| 469 | /** |
||
| 470 | * get the current installed version of ownCloud |
||
| 471 | * |
||
| 472 | * @return array |
||
| 473 | */ |
||
| 474 | public static function getVersion() { |
||
| 475 | OC_Util::loadVersion(); |
||
| 476 | return self::$versionCache['OC_Version']; |
||
| 477 | } |
||
| 478 | |||
| 479 | /** |
||
| 480 | * get the current installed version string of ownCloud |
||
| 481 | * |
||
| 482 | * @return string |
||
| 483 | */ |
||
| 484 | public static function getVersionString() { |
||
| 485 | OC_Util::loadVersion(); |
||
| 486 | return self::$versionCache['OC_VersionString']; |
||
| 487 | } |
||
| 488 | |||
| 489 | /** |
||
| 490 | * @deprecated the value is of no use anymore |
||
| 491 | * @return string |
||
| 492 | */ |
||
| 493 | public static function getEditionString() { |
||
| 494 | return ''; |
||
| 495 | } |
||
| 496 | |||
| 497 | /** |
||
| 498 | * @description get the update channel of the current installed of ownCloud. |
||
| 499 | * @return string |
||
| 500 | */ |
||
| 501 | public static function getChannel() { |
||
| 502 | OC_Util::loadVersion(); |
||
| 503 | return \OC::$server->getConfig()->getSystemValue('updater.release.channel', self::$versionCache['OC_Channel']); |
||
| 504 | } |
||
| 505 | |||
| 506 | /** |
||
| 507 | * @description get the build number of the current installed of ownCloud. |
||
| 508 | * @return string |
||
| 509 | */ |
||
| 510 | public static function getBuild() { |
||
| 511 | OC_Util::loadVersion(); |
||
| 512 | return self::$versionCache['OC_Build']; |
||
| 513 | } |
||
| 514 | |||
| 515 | /** |
||
| 516 | * @description load the version.php into the session as cache |
||
| 517 | * @suppress PhanUndeclaredVariable |
||
| 518 | */ |
||
| 519 | private static function loadVersion() { |
||
| 520 | if (self::$versionCache !== null) { |
||
| 521 | return; |
||
| 522 | } |
||
| 523 | |||
| 524 | $timestamp = filemtime(OC::$SERVERROOT . '/version.php'); |
||
| 525 | require OC::$SERVERROOT . '/version.php'; |
||
| 526 | /** @var $timestamp int */ |
||
| 527 | self::$versionCache['OC_Version_Timestamp'] = $timestamp; |
||
| 528 | /** @var $OC_Version string */ |
||
| 529 | self::$versionCache['OC_Version'] = $OC_Version; |
||
| 530 | /** @var $OC_VersionString string */ |
||
| 531 | self::$versionCache['OC_VersionString'] = $OC_VersionString; |
||
| 532 | /** @var $OC_Build string */ |
||
| 533 | self::$versionCache['OC_Build'] = $OC_Build; |
||
| 534 | |||
| 535 | /** @var $OC_Channel string */ |
||
| 536 | self::$versionCache['OC_Channel'] = $OC_Channel; |
||
| 537 | } |
||
| 538 | |||
| 539 | /** |
||
| 540 | * generates a path for JS/CSS files. If no application is provided it will create the path for core. |
||
| 541 | * |
||
| 542 | * @param string $application application to get the files from |
||
| 543 | * @param string $directory directory within this application (css, js, vendor, etc) |
||
| 544 | * @param string $file the file inside of the above folder |
||
| 545 | * @return string the path |
||
| 546 | */ |
||
| 547 | private static function generatePath($application, $directory, $file) { |
||
| 548 | if (is_null($file)) { |
||
| 549 | $file = $application; |
||
| 550 | $application = ""; |
||
| 551 | } |
||
| 552 | if (!empty($application)) { |
||
| 553 | return "$application/$directory/$file"; |
||
| 554 | } else { |
||
| 555 | return "$directory/$file"; |
||
| 556 | } |
||
| 557 | } |
||
| 558 | |||
| 559 | /** |
||
| 560 | * add a javascript file |
||
| 561 | * |
||
| 562 | * @param string $application application id |
||
| 563 | * @param string|null $file filename |
||
| 564 | * @param bool $prepend prepend the Script to the beginning of the list |
||
| 565 | * @return void |
||
| 566 | */ |
||
| 567 | public static function addScript($application, $file = null, $prepend = false) { |
||
| 568 | $path = OC_Util::generatePath($application, 'js', $file); |
||
| 569 | |||
| 570 | // core js files need separate handling |
||
| 571 | if ($application !== 'core' && $file !== null) { |
||
| 572 | self::addTranslations ( $application ); |
||
| 573 | } |
||
| 574 | self::addExternalResource($application, $prepend, $path, "script"); |
||
| 575 | } |
||
| 576 | |||
| 577 | /** |
||
| 578 | * add a javascript file from the vendor sub folder |
||
| 579 | * |
||
| 580 | * @param string $application application id |
||
| 581 | * @param string|null $file filename |
||
| 582 | * @param bool $prepend prepend the Script to the beginning of the list |
||
| 583 | * @return void |
||
| 584 | */ |
||
| 585 | public static function addVendorScript($application, $file = null, $prepend = false) { |
||
| 586 | $path = OC_Util::generatePath($application, 'vendor', $file); |
||
| 587 | self::addExternalResource($application, $prepend, $path, "script"); |
||
| 588 | } |
||
| 589 | |||
| 590 | /** |
||
| 591 | * add a translation JS file |
||
| 592 | * |
||
| 593 | * @param string $application application id |
||
| 594 | * @param string|null $languageCode language code, defaults to the current language |
||
| 595 | * @param bool|null $prepend prepend the Script to the beginning of the list |
||
| 596 | */ |
||
| 597 | public static function addTranslations($application, $languageCode = null, $prepend = false) { |
||
| 598 | if (is_null($languageCode)) { |
||
| 599 | $languageCode = \OC::$server->getL10NFactory()->findLanguage($application); |
||
| 600 | } |
||
| 601 | if (!empty($application)) { |
||
| 602 | $path = "$application/l10n/$languageCode"; |
||
| 603 | } else { |
||
| 604 | $path = "l10n/$languageCode"; |
||
| 605 | } |
||
| 606 | self::addExternalResource($application, $prepend, $path, "script"); |
||
| 607 | } |
||
| 608 | |||
| 609 | /** |
||
| 610 | * add a css file |
||
| 611 | * |
||
| 612 | * @param string $application application id |
||
| 613 | * @param string|null $file filename |
||
| 614 | * @param bool $prepend prepend the Style to the beginning of the list |
||
| 615 | * @return void |
||
| 616 | */ |
||
| 617 | public static function addStyle($application, $file = null, $prepend = false) { |
||
| 618 | $path = OC_Util::generatePath($application, 'css', $file); |
||
| 619 | self::addExternalResource($application, $prepend, $path, "style"); |
||
| 620 | } |
||
| 621 | |||
| 622 | /** |
||
| 623 | * add a css file from the vendor sub folder |
||
| 624 | * |
||
| 625 | * @param string $application application id |
||
| 626 | * @param string|null $file filename |
||
| 627 | * @param bool $prepend prepend the Style to the beginning of the list |
||
| 628 | * @return void |
||
| 629 | */ |
||
| 630 | public static function addVendorStyle($application, $file = null, $prepend = false) { |
||
| 631 | $path = OC_Util::generatePath($application, 'vendor', $file); |
||
| 632 | self::addExternalResource($application, $prepend, $path, "style"); |
||
| 633 | } |
||
| 634 | |||
| 635 | /** |
||
| 636 | * add an external resource css/js file |
||
| 637 | * |
||
| 638 | * @param string $application application id |
||
| 639 | * @param bool $prepend prepend the file to the beginning of the list |
||
| 640 | * @param string $path |
||
| 641 | * @param string $type (script or style) |
||
| 642 | * @return void |
||
| 643 | */ |
||
| 644 | private static function addExternalResource($application, $prepend, $path, $type = "script") { |
||
| 645 | |||
| 646 | if ($type === "style") { |
||
| 647 | View Code Duplication | if (!in_array($path, self::$styles)) { |
|
| 648 | if ($prepend === true) { |
||
| 649 | array_unshift ( self::$styles, $path ); |
||
| 650 | } else { |
||
| 651 | self::$styles[] = $path; |
||
| 652 | } |
||
| 653 | } |
||
| 654 | View Code Duplication | } elseif ($type === "script") { |
|
| 655 | if (!in_array($path, self::$scripts)) { |
||
| 656 | if ($prepend === true) { |
||
| 657 | array_unshift ( self::$scripts, $path ); |
||
| 658 | } else { |
||
| 659 | self::$scripts [] = $path; |
||
| 660 | } |
||
| 661 | } |
||
| 662 | } |
||
| 663 | } |
||
| 664 | |||
| 665 | /** |
||
| 666 | * Add a custom element to the header |
||
| 667 | * If $text is null then the element will be written as empty element. |
||
| 668 | * So use "" to get a closing tag. |
||
| 669 | * @param string $tag tag name of the element |
||
| 670 | * @param array $attributes array of attributes for the element |
||
| 671 | * @param string $text the text content for the element |
||
| 672 | */ |
||
| 673 | View Code Duplication | public static function addHeader($tag, $attributes, $text=null) { |
|
| 674 | self::$headers[] = array( |
||
| 675 | 'tag' => $tag, |
||
| 676 | 'attributes' => $attributes, |
||
| 677 | 'text' => $text |
||
| 678 | ); |
||
| 679 | } |
||
| 680 | |||
| 681 | /** |
||
| 682 | * check if the current server configuration is suitable for ownCloud |
||
| 683 | * |
||
| 684 | * @param \OC\SystemConfig $config |
||
| 685 | * @return array arrays with error messages and hints |
||
| 686 | */ |
||
| 687 | public static function checkServer(\OC\SystemConfig $config) { |
||
| 688 | $l = \OC::$server->getL10N('lib'); |
||
| 689 | $errors = array(); |
||
| 690 | $CONFIG_DATADIRECTORY = $config->getValue('datadirectory', OC::$SERVERROOT . '/data'); |
||
| 691 | |||
| 692 | if (!self::needUpgrade($config) && $config->getValue('installed', false)) { |
||
| 693 | // this check needs to be done every time |
||
| 694 | $errors = self::checkDataDirectoryValidity($CONFIG_DATADIRECTORY); |
||
| 695 | } |
||
| 696 | |||
| 697 | // Assume that if checkServer() succeeded before in this session, then all is fine. |
||
| 698 | if (\OC::$server->getSession()->exists('checkServer_succeeded') && \OC::$server->getSession()->get('checkServer_succeeded')) { |
||
| 699 | return $errors; |
||
| 700 | } |
||
| 701 | |||
| 702 | $webServerRestart = false; |
||
| 703 | $setup = new \OC\Setup( |
||
| 704 | $config, |
||
| 705 | \OC::$server->getIniWrapper(), |
||
| 706 | \OC::$server->getL10N('lib'), |
||
| 707 | \OC::$server->query(\OCP\Defaults::class), |
||
| 708 | \OC::$server->getLogger(), |
||
| 709 | \OC::$server->getSecureRandom(), |
||
| 710 | \OC::$server->query(\OC\Installer::class) |
||
| 711 | ); |
||
| 712 | |||
| 713 | $urlGenerator = \OC::$server->getURLGenerator(); |
||
| 714 | |||
| 715 | $availableDatabases = $setup->getSupportedDatabases(); |
||
| 716 | if (empty($availableDatabases)) { |
||
| 717 | $errors[] = array( |
||
| 718 | 'error' => $l->t('No database drivers (sqlite, mysql, or postgresql) installed.'), |
||
| 719 | 'hint' => '' //TODO: sane hint |
||
| 720 | ); |
||
| 721 | $webServerRestart = true; |
||
| 722 | } |
||
| 723 | |||
| 724 | // Check if config folder is writable. |
||
| 725 | if(!OC_Helper::isReadOnlyConfigEnabled()) { |
||
| 726 | if (!is_writable(OC::$configDir) or !is_readable(OC::$configDir)) { |
||
| 727 | $errors[] = array( |
||
| 728 | 'error' => $l->t('Cannot write into "config" directory'), |
||
| 729 | 'hint' => $l->t('This can usually be fixed by giving the webserver write access to the config directory. See %s', |
||
| 730 | [$urlGenerator->linkToDocs('admin-dir_permissions')]) |
||
| 731 | ); |
||
| 732 | } |
||
| 733 | } |
||
| 734 | |||
| 735 | // Check if there is a writable install folder. |
||
| 736 | if ($config->getValue('appstoreenabled', true)) { |
||
| 737 | if (OC_App::getInstallPath() === null |
||
| 738 | || !is_writable(OC_App::getInstallPath()) |
||
| 739 | || !is_readable(OC_App::getInstallPath()) |
||
| 740 | ) { |
||
| 741 | $errors[] = array( |
||
| 742 | 'error' => $l->t('Cannot write into "apps" directory'), |
||
| 743 | 'hint' => $l->t('This can usually be fixed by giving the webserver write access to the apps directory' |
||
| 744 | . ' or disabling the appstore in the config file. See %s', |
||
| 745 | [$urlGenerator->linkToDocs('admin-dir_permissions')]) |
||
| 746 | ); |
||
| 747 | } |
||
| 748 | } |
||
| 749 | // Create root dir. |
||
| 750 | if ($config->getValue('installed', false)) { |
||
| 751 | if (!is_dir($CONFIG_DATADIRECTORY)) { |
||
| 752 | $success = @mkdir($CONFIG_DATADIRECTORY); |
||
| 753 | if ($success) { |
||
| 754 | $errors = array_merge($errors, self::checkDataDirectoryPermissions($CONFIG_DATADIRECTORY)); |
||
| 755 | } else { |
||
| 756 | $errors[] = [ |
||
| 757 | 'error' => $l->t('Cannot create "data" directory'), |
||
| 758 | 'hint' => $l->t('This can usually be fixed by giving the webserver write access to the root directory. See %s', |
||
| 759 | [$urlGenerator->linkToDocs('admin-dir_permissions')]) |
||
| 760 | ]; |
||
| 761 | } |
||
| 762 | } else if (!is_writable($CONFIG_DATADIRECTORY) or !is_readable($CONFIG_DATADIRECTORY)) { |
||
| 763 | //common hint for all file permissions error messages |
||
| 764 | $permissionsHint = $l->t('Permissions can usually be fixed by giving the webserver write access to the root directory. See %s.', |
||
| 765 | [$urlGenerator->linkToDocs('admin-dir_permissions')]); |
||
| 766 | $errors[] = [ |
||
| 767 | 'error' => 'Your data directory is not writable', |
||
| 768 | 'hint' => $permissionsHint |
||
| 769 | ]; |
||
| 770 | } else { |
||
| 771 | $errors = array_merge($errors, self::checkDataDirectoryPermissions($CONFIG_DATADIRECTORY)); |
||
| 772 | } |
||
| 773 | } |
||
| 774 | |||
| 775 | if (!OC_Util::isSetLocaleWorking()) { |
||
| 776 | $errors[] = array( |
||
| 777 | 'error' => $l->t('Setting locale to %s failed', |
||
| 778 | array('en_US.UTF-8/fr_FR.UTF-8/es_ES.UTF-8/de_DE.UTF-8/ru_RU.UTF-8/' |
||
| 779 | . 'pt_BR.UTF-8/it_IT.UTF-8/ja_JP.UTF-8/zh_CN.UTF-8')), |
||
| 780 | 'hint' => $l->t('Please install one of these locales on your system and restart your webserver.') |
||
| 781 | ); |
||
| 782 | } |
||
| 783 | |||
| 784 | // Contains the dependencies that should be checked against |
||
| 785 | // classes = class_exists |
||
| 786 | // functions = function_exists |
||
| 787 | // defined = defined |
||
| 788 | // ini = ini_get |
||
| 789 | // If the dependency is not found the missing module name is shown to the EndUser |
||
| 790 | // When adding new checks always verify that they pass on Travis as well |
||
| 791 | // for ini settings, see https://github.com/owncloud/administration/blob/master/travis-ci/custom.ini |
||
| 792 | $dependencies = array( |
||
| 793 | 'classes' => array( |
||
| 794 | 'ZipArchive' => 'zip', |
||
| 795 | 'DOMDocument' => 'dom', |
||
| 796 | 'XMLWriter' => 'XMLWriter', |
||
| 797 | 'XMLReader' => 'XMLReader', |
||
| 798 | ), |
||
| 799 | 'functions' => [ |
||
| 800 | 'xml_parser_create' => 'libxml', |
||
| 801 | 'mb_strcut' => 'mb multibyte', |
||
| 802 | 'ctype_digit' => 'ctype', |
||
| 803 | 'json_encode' => 'JSON', |
||
| 804 | 'gd_info' => 'GD', |
||
| 805 | 'gzencode' => 'zlib', |
||
| 806 | 'iconv' => 'iconv', |
||
| 807 | 'simplexml_load_string' => 'SimpleXML', |
||
| 808 | 'hash' => 'HASH Message Digest Framework', |
||
| 809 | 'curl_init' => 'cURL', |
||
| 810 | 'openssl_verify' => 'OpenSSL', |
||
| 811 | ], |
||
| 812 | 'defined' => array( |
||
| 813 | 'PDO::ATTR_DRIVER_NAME' => 'PDO' |
||
| 814 | ), |
||
| 815 | 'ini' => [ |
||
| 816 | 'default_charset' => 'UTF-8', |
||
| 817 | ], |
||
| 818 | ); |
||
| 819 | $missingDependencies = array(); |
||
| 820 | $invalidIniSettings = []; |
||
| 821 | $moduleHint = $l->t('Please ask your server administrator to install the module.'); |
||
| 822 | |||
| 823 | /** |
||
| 824 | * FIXME: The dependency check does not work properly on HHVM on the moment |
||
| 825 | * and prevents installation. Once HHVM is more compatible with our |
||
| 826 | * approach to check for these values we should re-enable those |
||
| 827 | * checks. |
||
| 828 | */ |
||
| 829 | $iniWrapper = \OC::$server->getIniWrapper(); |
||
| 830 | if (!self::runningOnHhvm()) { |
||
| 831 | foreach ($dependencies['classes'] as $class => $module) { |
||
| 832 | if (!class_exists($class)) { |
||
| 833 | $missingDependencies[] = $module; |
||
| 834 | } |
||
| 835 | } |
||
| 836 | foreach ($dependencies['functions'] as $function => $module) { |
||
| 837 | if (!function_exists($function)) { |
||
| 838 | $missingDependencies[] = $module; |
||
| 839 | } |
||
| 840 | } |
||
| 841 | foreach ($dependencies['defined'] as $defined => $module) { |
||
| 842 | if (!defined($defined)) { |
||
| 843 | $missingDependencies[] = $module; |
||
| 844 | } |
||
| 845 | } |
||
| 846 | foreach ($dependencies['ini'] as $setting => $expected) { |
||
| 847 | if (is_bool($expected)) { |
||
| 848 | if ($iniWrapper->getBool($setting) !== $expected) { |
||
| 849 | $invalidIniSettings[] = [$setting, $expected]; |
||
| 850 | } |
||
| 851 | } |
||
| 852 | if (is_int($expected)) { |
||
| 853 | if ($iniWrapper->getNumeric($setting) !== $expected) { |
||
| 854 | $invalidIniSettings[] = [$setting, $expected]; |
||
| 855 | } |
||
| 856 | } |
||
| 857 | if (is_string($expected)) { |
||
| 858 | if (strtolower($iniWrapper->getString($setting)) !== strtolower($expected)) { |
||
| 859 | $invalidIniSettings[] = [$setting, $expected]; |
||
| 860 | } |
||
| 861 | } |
||
| 862 | } |
||
| 863 | } |
||
| 864 | |||
| 865 | foreach($missingDependencies as $missingDependency) { |
||
| 866 | $errors[] = array( |
||
| 867 | 'error' => $l->t('PHP module %s not installed.', array($missingDependency)), |
||
| 868 | 'hint' => $moduleHint |
||
| 869 | ); |
||
| 870 | $webServerRestart = true; |
||
| 871 | } |
||
| 872 | foreach($invalidIniSettings as $setting) { |
||
| 873 | if(is_bool($setting[1])) { |
||
| 874 | $setting[1] = $setting[1] ? 'on' : 'off'; |
||
| 875 | } |
||
| 876 | $errors[] = [ |
||
| 877 | 'error' => $l->t('PHP setting "%s" is not set to "%s".', [$setting[0], var_export($setting[1], true)]), |
||
| 878 | 'hint' => $l->t('Adjusting this setting in php.ini will make Nextcloud run again') |
||
| 879 | ]; |
||
| 880 | $webServerRestart = true; |
||
| 881 | } |
||
| 882 | |||
| 883 | /** |
||
| 884 | * The mbstring.func_overload check can only be performed if the mbstring |
||
| 885 | * module is installed as it will return null if the checking setting is |
||
| 886 | * not available and thus a check on the boolean value fails. |
||
| 887 | * |
||
| 888 | * TODO: Should probably be implemented in the above generic dependency |
||
| 889 | * check somehow in the long-term. |
||
| 890 | */ |
||
| 891 | if($iniWrapper->getBool('mbstring.func_overload') !== null && |
||
| 892 | $iniWrapper->getBool('mbstring.func_overload') === true) { |
||
| 893 | $errors[] = array( |
||
| 894 | 'error' => $l->t('mbstring.func_overload is set to "%s" instead of the expected value "0"', [$iniWrapper->getString('mbstring.func_overload')]), |
||
| 895 | 'hint' => $l->t('To fix this issue set <code>mbstring.func_overload</code> to <code>0</code> in your php.ini') |
||
| 896 | ); |
||
| 897 | } |
||
| 898 | |||
| 899 | if(function_exists('xml_parser_create') && |
||
| 900 | LIBXML_LOADED_VERSION < 20700 ) { |
||
| 901 | $version = LIBXML_LOADED_VERSION; |
||
| 902 | $major = floor($version/10000); |
||
| 903 | $version -= ($major * 10000); |
||
| 904 | $minor = floor($version/100); |
||
| 905 | $version -= ($minor * 100); |
||
| 906 | $patch = $version; |
||
| 907 | $errors[] = array( |
||
| 908 | 'error' => $l->t('libxml2 2.7.0 is at least required. Currently %s is installed.', [$major . '.' . $minor . '.' . $patch]), |
||
| 909 | 'hint' => $l->t('To fix this issue update your libxml2 version and restart your web server.') |
||
| 910 | ); |
||
| 911 | } |
||
| 912 | |||
| 913 | if (!self::isAnnotationsWorking()) { |
||
| 914 | $errors[] = array( |
||
| 915 | 'error' => $l->t('PHP is apparently set up to strip inline doc blocks. This will make several core apps inaccessible.'), |
||
| 916 | 'hint' => $l->t('This is probably caused by a cache/accelerator such as Zend OPcache or eAccelerator.') |
||
| 917 | ); |
||
| 918 | } |
||
| 919 | |||
| 920 | if (!\OC::$CLI && $webServerRestart) { |
||
| 921 | $errors[] = array( |
||
| 922 | 'error' => $l->t('PHP modules have been installed, but they are still listed as missing?'), |
||
| 923 | 'hint' => $l->t('Please ask your server administrator to restart the web server.') |
||
| 924 | ); |
||
| 925 | } |
||
| 926 | |||
| 927 | $errors = array_merge($errors, self::checkDatabaseVersion()); |
||
| 928 | |||
| 929 | // Cache the result of this function |
||
| 930 | \OC::$server->getSession()->set('checkServer_succeeded', count($errors) == 0); |
||
| 931 | |||
| 932 | return $errors; |
||
| 933 | } |
||
| 934 | |||
| 935 | /** |
||
| 936 | * Check the database version |
||
| 937 | * |
||
| 938 | * @return array errors array |
||
| 939 | */ |
||
| 940 | public static function checkDatabaseVersion() { |
||
| 941 | $l = \OC::$server->getL10N('lib'); |
||
| 942 | $errors = array(); |
||
| 943 | $dbType = \OC::$server->getSystemConfig()->getValue('dbtype', 'sqlite'); |
||
| 944 | if ($dbType === 'pgsql') { |
||
| 945 | // check PostgreSQL version |
||
| 946 | try { |
||
| 947 | $result = \OC_DB::executeAudited('SHOW SERVER_VERSION'); |
||
| 948 | $data = $result->fetchRow(); |
||
| 949 | if (isset($data['server_version'])) { |
||
| 950 | $version = $data['server_version']; |
||
| 951 | if (version_compare($version, '9.0.0', '<')) { |
||
| 952 | $errors[] = array( |
||
| 953 | 'error' => $l->t('PostgreSQL >= 9 required'), |
||
| 954 | 'hint' => $l->t('Please upgrade your database version') |
||
| 955 | ); |
||
| 956 | } |
||
| 957 | } |
||
| 958 | } catch (\Doctrine\DBAL\DBALException $e) { |
||
| 959 | $logger = \OC::$server->getLogger(); |
||
| 960 | $logger->warning('Error occurred while checking PostgreSQL version, assuming >= 9'); |
||
| 961 | $logger->logException($e); |
||
| 962 | } |
||
| 963 | } |
||
| 964 | return $errors; |
||
| 965 | } |
||
| 966 | |||
| 967 | /** |
||
| 968 | * Check for correct file permissions of data directory |
||
| 969 | * |
||
| 970 | * @param string $dataDirectory |
||
| 971 | * @return array arrays with error messages and hints |
||
| 972 | */ |
||
| 973 | public static function checkDataDirectoryPermissions($dataDirectory) { |
||
| 974 | if(\OC::$server->getConfig()->getSystemValue('check_data_directory_permissions', true) === false) { |
||
| 975 | return []; |
||
| 976 | } |
||
| 977 | $l = \OC::$server->getL10N('lib'); |
||
| 978 | $errors = []; |
||
| 979 | $permissionsModHint = $l->t('Please change the permissions to 0770 so that the directory' |
||
| 980 | . ' cannot be listed by other users.'); |
||
| 981 | $perms = substr(decoct(@fileperms($dataDirectory)), -3); |
||
| 982 | if (substr($perms, -1) !== '0') { |
||
| 983 | chmod($dataDirectory, 0770); |
||
| 984 | clearstatcache(); |
||
| 985 | $perms = substr(decoct(@fileperms($dataDirectory)), -3); |
||
| 986 | if ($perms[2] !== '0') { |
||
| 987 | $errors[] = [ |
||
| 988 | 'error' => $l->t('Your data directory is readable by other users'), |
||
| 989 | 'hint' => $permissionsModHint |
||
| 990 | ]; |
||
| 991 | } |
||
| 992 | } |
||
| 993 | return $errors; |
||
| 994 | } |
||
| 995 | |||
| 996 | /** |
||
| 997 | * Check that the data directory exists and is valid by |
||
| 998 | * checking the existence of the ".ocdata" file. |
||
| 999 | * |
||
| 1000 | * @param string $dataDirectory data directory path |
||
| 1001 | * @return array errors found |
||
| 1002 | */ |
||
| 1003 | public static function checkDataDirectoryValidity($dataDirectory) { |
||
| 1021 | |||
| 1022 | /** |
||
| 1023 | * Check if the user is logged in, redirects to home if not. With |
||
| 1024 | * redirect URL parameter to the request URI. |
||
| 1025 | * |
||
| 1026 | * @return void |
||
| 1027 | */ |
||
| 1028 | public static function checkLoggedIn() { |
||
| 1029 | // Check if we are a user |
||
| 1030 | View Code Duplication | if (!\OC::$server->getUserSession()->isLoggedIn()) { |
|
| 1031 | header('Location: ' . \OC::$server->getURLGenerator()->linkToRoute( |
||
| 1032 | 'core.login.showLoginForm', |
||
| 1033 | [ |
||
| 1034 | 'redirect_url' => \OC::$server->getRequest()->getRequestUri(), |
||
| 1035 | ] |
||
| 1036 | ) |
||
| 1037 | ); |
||
| 1038 | exit(); |
||
| 1039 | } |
||
| 1040 | // Redirect to 2FA challenge selection if 2FA challenge was not solved yet |
||
| 1041 | View Code Duplication | if (\OC::$server->getTwoFactorAuthManager()->needsSecondFactor(\OC::$server->getUserSession()->getUser())) { |
|
| 1042 | header('Location: ' . \OC::$server->getURLGenerator()->linkToRoute('core.TwoFactorChallenge.selectChallenge')); |
||
| 1043 | exit(); |
||
| 1044 | } |
||
| 1045 | } |
||
| 1046 | |||
| 1047 | /** |
||
| 1048 | * Check if the user is a admin, redirects to home if not |
||
| 1049 | * |
||
| 1050 | * @return void |
||
| 1051 | */ |
||
| 1052 | public static function checkAdminUser() { |
||
| 1059 | |||
| 1060 | /** |
||
| 1061 | * Check if the user is a subadmin, redirects to home if not |
||
| 1062 | * |
||
| 1063 | * @return null|boolean $groups where the current user is subadmin |
||
| 1064 | */ |
||
| 1065 | public static function checkSubAdminUser() { |
||
| 1079 | |||
| 1080 | /** |
||
| 1081 | * Returns the URL of the default page |
||
| 1082 | * based on the system configuration and |
||
| 1083 | * the apps visible for the current user |
||
| 1084 | * |
||
| 1085 | * @return string URL |
||
| 1086 | * @suppress PhanDeprecatedFunction |
||
| 1087 | */ |
||
| 1088 | public static function getDefaultPageUrl() { |
||
| 1120 | |||
| 1121 | /** |
||
| 1122 | * Redirect to the user default page |
||
| 1123 | * |
||
| 1124 | * @return void |
||
| 1125 | */ |
||
| 1126 | public static function redirectToDefaultPage() { |
||
| 1131 | |||
| 1132 | /** |
||
| 1133 | * get an id unique for this instance |
||
| 1134 | * |
||
| 1135 | * @return string |
||
| 1136 | */ |
||
| 1137 | public static function getInstanceId() { |
||
| 1146 | |||
| 1147 | /** |
||
| 1148 | * Public function to sanitize HTML |
||
| 1149 | * |
||
| 1150 | * This function is used to sanitize HTML and should be applied on any |
||
| 1151 | * string or array of strings before displaying it on a web page. |
||
| 1152 | * |
||
| 1153 | * @param string|array $value |
||
| 1154 | * @return string|array an array of sanitized strings or a single sanitized string, depends on the input parameter. |
||
| 1155 | */ |
||
| 1156 | public static function sanitizeHTML($value) { |
||
| 1167 | |||
| 1168 | /** |
||
| 1169 | * Public function to encode url parameters |
||
| 1170 | * |
||
| 1171 | * This function is used to encode path to file before output. |
||
| 1172 | * Encoding is done according to RFC 3986 with one exception: |
||
| 1173 | * Character '/' is preserved as is. |
||
| 1174 | * |
||
| 1175 | * @param string $component part of URI to encode |
||
| 1176 | * @return string |
||
| 1177 | */ |
||
| 1178 | public static function encodePath($component) { |
||
| 1183 | |||
| 1184 | |||
| 1185 | public function createHtaccessTestFile(\OCP\IConfig $config) { |
||
| 1212 | |||
| 1213 | /** |
||
| 1214 | * Check if the .htaccess file is working |
||
| 1215 | * @param \OCP\IConfig $config |
||
| 1216 | * @return bool |
||
| 1217 | * @throws Exception |
||
| 1218 | * @throws \OC\HintException If the test file can't get written. |
||
| 1219 | */ |
||
| 1220 | public function isHtaccessWorking(\OCP\IConfig $config) { |
||
| 1251 | |||
| 1252 | /** |
||
| 1253 | * Check if the setlocal call does not work. This can happen if the right |
||
| 1254 | * local packages are not available on the server. |
||
| 1255 | * |
||
| 1256 | * @return bool |
||
| 1257 | */ |
||
| 1258 | public static function isSetLocaleWorking() { |
||
| 1265 | |||
| 1266 | /** |
||
| 1267 | * Check if it's possible to get the inline annotations |
||
| 1268 | * |
||
| 1269 | * @return bool |
||
| 1270 | */ |
||
| 1271 | public static function isAnnotationsWorking() { |
||
| 1277 | |||
| 1278 | /** |
||
| 1279 | * Check if the PHP module fileinfo is loaded. |
||
| 1280 | * |
||
| 1281 | * @return bool |
||
| 1282 | */ |
||
| 1283 | public static function fileInfoLoaded() { |
||
| 1286 | |||
| 1287 | /** |
||
| 1288 | * clear all levels of output buffering |
||
| 1289 | * |
||
| 1290 | * @return void |
||
| 1291 | */ |
||
| 1292 | public static function obEnd() { |
||
| 1297 | |||
| 1298 | /** |
||
| 1299 | * Checks whether the server is running on Mac OS X |
||
| 1300 | * |
||
| 1301 | * @return bool true if running on Mac OS X, false otherwise |
||
| 1302 | */ |
||
| 1303 | public static function runningOnMac() { |
||
| 1306 | |||
| 1307 | /** |
||
| 1308 | * Checks whether server is running on HHVM |
||
| 1309 | * |
||
| 1310 | * @return bool True if running on HHVM, false otherwise |
||
| 1311 | */ |
||
| 1312 | public static function runningOnHhvm() { |
||
| 1315 | |||
| 1316 | /** |
||
| 1317 | * Handles the case that there may not be a theme, then check if a "default" |
||
| 1318 | * theme exists and take that one |
||
| 1319 | * |
||
| 1320 | * @return string the theme |
||
| 1321 | */ |
||
| 1322 | public static function getTheme() { |
||
| 1333 | |||
| 1334 | /** |
||
| 1335 | * Clear a single file from the opcode cache |
||
| 1336 | * This is useful for writing to the config file |
||
| 1337 | * in case the opcode cache does not re-validate files |
||
| 1338 | * Returns true if successful, false if unsuccessful: |
||
| 1339 | * caller should fall back on clearing the entire cache |
||
| 1340 | * with clearOpcodeCache() if unsuccessful |
||
| 1341 | * |
||
| 1342 | * @param string $path the path of the file to clear from the cache |
||
| 1343 | * @return bool true if underlying function returns true, otherwise false |
||
| 1344 | */ |
||
| 1345 | public static function deleteFromOpcodeCache($path) { |
||
| 1359 | |||
| 1360 | /** |
||
| 1361 | * Clear the opcode cache if one exists |
||
| 1362 | * This is necessary for writing to the config file |
||
| 1363 | * in case the opcode cache does not re-validate files |
||
| 1364 | * |
||
| 1365 | * @return void |
||
| 1366 | * @suppress PhanDeprecatedFunction |
||
| 1367 | * @suppress PhanUndeclaredConstant |
||
| 1368 | */ |
||
| 1369 | public static function clearOpcodeCache() { |
||
| 1391 | |||
| 1392 | /** |
||
| 1393 | * Normalize a unicode string |
||
| 1394 | * |
||
| 1395 | * @param string $value a not normalized string |
||
| 1396 | * @return bool|string |
||
| 1397 | */ |
||
| 1398 | public static function normalizeUnicode($value) { |
||
| 1411 | |||
| 1412 | /** |
||
| 1413 | * A human readable string is generated based on version and build number |
||
| 1414 | * |
||
| 1415 | * @return string |
||
| 1416 | */ |
||
| 1417 | public static function getHumanVersion() { |
||
| 1418 | $version = OC_Util::getVersionString(); |
||
| 1419 | $build = OC_Util::getBuild(); |
||
| 1420 | if (!empty($build) and OC_Util::getChannel() === 'daily') { |
||
| 1421 | $version .= ' Build:' . $build; |
||
| 1422 | } |
||
| 1423 | return $version; |
||
| 1424 | } |
||
| 1425 | |||
| 1426 | /** |
||
| 1427 | * Returns whether the given file name is valid |
||
| 1428 | * |
||
| 1429 | * @param string $file file name to check |
||
| 1430 | * @return bool true if the file name is valid, false otherwise |
||
| 1431 | * @deprecated use \OC\Files\View::verifyPath() |
||
| 1432 | */ |
||
| 1433 | public static function isValidFileName($file) { |
||
| 1434 | $trimmed = trim($file); |
||
| 1435 | if ($trimmed === '') { |
||
| 1436 | return false; |
||
| 1437 | } |
||
| 1454 | |||
| 1455 | /** |
||
| 1456 | * Check whether the instance needs to perform an upgrade, |
||
| 1457 | * either when the core version is higher or any app requires |
||
| 1458 | * an upgrade. |
||
| 1459 | * |
||
| 1460 | * @param \OC\SystemConfig $config |
||
| 1461 | * @return bool whether the core or any app needs an upgrade |
||
| 1462 | * @throws \OC\HintException When the upgrade from the given version is not allowed |
||
| 1463 | */ |
||
| 1464 | public static function needUpgrade(\OC\SystemConfig $config) { |
||
| 1503 | |||
| 1504 | } |
||
| 1505 |
Loading history...
You can fix this by adding a namespace to your class:
When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries.