1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462 |
- <?php
- /**
- * Class for utility functions
- *
- */
- class OC_Util {
- public static $scripts = array();
- public static $styles = array();
- public static $headers = array();
- private static $rootMounted = false;
- private static $fsSetup = false;
- protected static function getAppManager() {
- return \OC::$server->getAppManager();
- }
- private static function initLocalStorageRootFS() {
- // mount local file backend as root
- $configDataDirectory = OC_Config::getValue("datadirectory", OC::$SERVERROOT . "/data");
- //first set up the local "root" storage
- \OC\Files\Filesystem::initMounts();
- if (!self::$rootMounted) {
- \OC\Files\Filesystem::mount('\OC\Files\Storage\Local', array('datadir' => $configDataDirectory), '/');
- self::$rootMounted = true;
- }
- }
- /**
- * mounting an object storage as the root fs will in essence remove the
- * necessity of a data folder being present.
- * TODO make home storage aware of this and use the object storage instead of local disk access
- *
- * @param array $config containing 'class' and optional 'arguments'
- */
- private static function initObjectStoreRootFS($config) {
- // check misconfiguration
- if (empty($config['class'])) {
- \OCP\Util::writeLog('files', 'No class given for objectstore', \OCP\Util::ERROR);
- }
- if (!isset($config['arguments'])) {
- $config['arguments'] = array();
- }
- // instantiate object store implementation
- $config['arguments']['objectstore'] = new $config['class']($config['arguments']);
- // mount with plain / root object store implementation
- $config['class'] = '\OC\Files\ObjectStore\ObjectStoreStorage';
- // mount object storage as root
- \OC\Files\Filesystem::initMounts();
- if (!self::$rootMounted) {
- \OC\Files\Filesystem::mount($config['class'], $config['arguments'], '/');
- self::$rootMounted = true;
- }
- }
- /**
- * Can be set up
- *
- * @param string $user
- * @return boolean
- * @description configure the initial filesystem based on the configuration
- */
- public static function setupFS($user = '') {
- //setting up the filesystem twice can only lead to trouble
- if (self::$fsSetup) {
- return false;
- }
- \OC::$server->getEventLogger()->start('setup_fs', 'Setup filesystem');
- // If we are not forced to load a specific user we load the one that is logged in
- if ($user == "" && OC_User::isLoggedIn()) {
- $user = OC_User::getUser();
- }
- // load all filesystem apps before, so no setup-hook gets lost
- OC_App::loadApps(array('filesystem'));
- // the filesystem will finish when $user is not empty,
- // mark fs setup here to avoid doing the setup from loading
- // OC_Filesystem
- if ($user != '') {
- self::$fsSetup = true;
- }
- //check if we are using an object storage
- $objectStore = OC_Config::getValue('objectstore');
- if (isset($objectStore)) {
- self::initObjectStoreRootFS($objectStore);
- } else {
- self::initLocalStorageRootFS();
- }
- if ($user != '' && !OCP\User::userExists($user)) {
- \OC::$server->getEventLogger()->end('setup_fs');
- return false;
- }
- \OC\Files\Filesystem::addStorageWrapper('mount_options', function($mountPoint, \OCP\Files\Storage $storage, \OCP\Files\Mount\IMountPoint $mount) {
- if($storage->instanceOfStorage('\OC\Files\Storage\Common')) {
- /** @var \OC\Files\Storage\Common $storage */
- $storage->setMountOptions($mount->getOptions());
- }
- return $storage;
- });
- //if we aren't logged in, there is no use to set up the filesystem
- if ($user != "") {
- \OC\Files\Filesystem::addStorageWrapper('oc_quota', function ($mountPoint, $storage) {
- // set up quota for home storages, even for other users
- // which can happen when using sharing
- /**
- * @var \OC\Files\Storage\Storage $storage
- */
- if ($storage->instanceOfStorage('\OC\Files\Storage\Home')
- || $storage->instanceOfStorage('\OC\Files\ObjectStore\HomeObjectStoreStorage')
- ) {
- if (is_object($storage->getUser())) {
- $user = $storage->getUser()->getUID();
- $quota = OC_Util::getUserQuota($user);
- if ($quota !== \OCP\Files\FileInfo::SPACE_UNLIMITED) {
- return new \OC\Files\Storage\Wrapper\Quota(array('storage' => $storage, 'quota' => $quota, 'root' => 'files'));
- }
- }
- }
- return $storage;
- });
- $userDir = '/' . $user . '/files';
- //jail the user into his "home" directory
- \OC\Files\Filesystem::init($user, $userDir);
- //trigger creation of user home and /files folder
- \OC::$server->getUserFolder($user);
- OC_Hook::emit('OC_Filesystem', 'setup', array('user' => $user, 'user_dir' => $userDir));
- }
- \OC::$server->getEventLogger()->end('setup_fs');
- return true;
- }
- /**
- * check if a password is required for each public link
- *
- * @return boolean
- */
- public static function isPublicLinkPasswordRequired() {
- $appConfig = \OC::$server->getAppConfig();
- $enforcePassword = $appConfig->getValue('core', 'shareapi_enforce_links_password', 'no');
- return ($enforcePassword === 'yes') ? true : false;
- }
- /**
- * check if sharing is disabled for the current user
- *
- * @return boolean
- */
- public static function isSharingDisabledForUser() {
- if (\OC_Appconfig::getValue('core', 'shareapi_exclude_groups', 'no') === 'yes') {
- $user = \OCP\User::getUser();
- $groupsList = \OC_Appconfig::getValue('core', 'shareapi_exclude_groups_list', '');
- $excludedGroups = explode(',', $groupsList);
- $usersGroups = \OC_Group::getUserGroups($user);
- if (!empty($usersGroups)) {
- $remainingGroups = array_diff($usersGroups, $excludedGroups);
- // if the user is only in groups which are disabled for sharing then
- // sharing is also disabled for the user
- if (empty($remainingGroups)) {
- return true;
- }
- }
- }
- return false;
- }
- /**
- * check if share API enforces a default expire date
- *
- * @return boolean
- */
- public static function isDefaultExpireDateEnforced() {
- $isDefaultExpireDateEnabled = \OCP\Config::getAppValue('core', 'shareapi_default_expire_date', 'no');
- $enforceDefaultExpireDate = false;
- if ($isDefaultExpireDateEnabled === 'yes') {
- $value = \OCP\Config::getAppValue('core', 'shareapi_enforce_expire_date', 'no');
- $enforceDefaultExpireDate = ($value === 'yes') ? true : false;
- }
- return $enforceDefaultExpireDate;
- }
- /**
- * Get the quota of a user
- *
- * @param string $user
- * @return int Quota bytes
- */
- public static function getUserQuota($user) {
- $config = \OC::$server->getConfig();
- $userQuota = $config->getUserValue($user, 'files', 'quota', 'default');
- if ($userQuota === 'default') {
- $userQuota = $config->getAppValue('files', 'default_quota', 'none');
- }
- if($userQuota === 'none') {
- return \OCP\Files\FileInfo::SPACE_UNLIMITED;
- }else{
- return OC_Helper::computerFileSize($userQuota);
- }
- }
- /**
- * copies the skeleton to the users /files
- *
- * @param \OC\User\User $user
- * @param \OCP\Files\Folder $userDirectory
- */
- public static function copySkeleton(\OC\User\User $user, \OCP\Files\Folder $userDirectory) {
- $skeletonDirectory = \OCP\Config::getSystemValue('skeletondirectory', \OC::$SERVERROOT . '/core/skeleton');
- if (!empty($skeletonDirectory)) {
- \OCP\Util::writeLog(
- 'files_skeleton',
- 'copying skeleton for '.$user->getUID().' from '.$skeletonDirectory.' to '.$userDirectory->getFullPath('/'),
- \OCP\Util::DEBUG
- );
- self::copyr($skeletonDirectory, $userDirectory);
- // update the file cache
- $userDirectory->getStorage()->getScanner()->scan('', \OC\Files\Cache\Scanner::SCAN_RECURSIVE);
- }
- }
- /**
- * copies a directory recursively by using streams
- *
- * @param string $source
- * @param \OCP\Files\Folder $target
- * @return void
- */
- public static function copyr($source, \OCP\Files\Folder $target) {
- $dir = opendir($source);
- while (false !== ($file = readdir($dir))) {
- if (!\OC\Files\Filesystem::isIgnoredDir($file)) {
- if (is_dir($source . '/' . $file)) {
- $child = $target->newFolder($file);
- self::copyr($source . '/' . $file, $child);
- } else {
- $child = $target->newFile($file);
- stream_copy_to_stream(fopen($source . '/' . $file,'r'), $child->fopen('w'));
- }
- }
- }
- closedir($dir);
- }
- /**
- * @return void
- */
- public static function tearDownFS() {
- \OC\Files\Filesystem::tearDown();
- self::$fsSetup = false;
- self::$rootMounted = false;
- }
- /**
- * get the current installed version of ownCloud
- *
- * @return array
- */
- public static function getVersion() {
- OC_Util::loadVersion();
- return \OC::$server->getSession()->get('OC_Version');
- }
- /**
- * get the current installed version string of ownCloud
- *
- * @return string
- */
- public static function getVersionString() {
- OC_Util::loadVersion();
- return \OC::$server->getSession()->get('OC_VersionString');
- }
- /**
- * @description get the current installed edition of ownCloud. There is the community
- * edition that just returns an empty string and the enterprise edition
- * that returns "Enterprise".
- * @return string
- */
- public static function getEditionString() {
- if (OC_App::isEnabled('enterprise_key')) {
- return "Enterprise";
- } else {
- return "";
- }
- }
- /**
- * @description get the update channel of the current installed of ownCloud.
- * @return string
- */
- public static function getChannel() {
- OC_Util::loadVersion();
- return \OC::$server->getSession()->get('OC_Channel');
- }
- /**
- * @description get the build number of the current installed of ownCloud.
- * @return string
- */
- public static function getBuild() {
- OC_Util::loadVersion();
- return \OC::$server->getSession()->get('OC_Build');
- }
- /**
- * @description load the version.php into the session as cache
- */
- private static function loadVersion() {
- $timestamp = filemtime(OC::$SERVERROOT . '/version.php');
- if (!\OC::$server->getSession()->exists('OC_Version') or OC::$server->getSession()->get('OC_Version_Timestamp') != $timestamp) {
- require OC::$SERVERROOT . '/version.php';
- $session = \OC::$server->getSession();
- /** @var $timestamp int */
- $session->set('OC_Version_Timestamp', $timestamp);
- /** @var $OC_Version string */
- $session->set('OC_Version', $OC_Version);
- /** @var $OC_VersionString string */
- $session->set('OC_VersionString', $OC_VersionString);
- /** @var $OC_Channel string */
- $session->set('OC_Channel', $OC_Channel);
- /** @var $OC_Build string */
- $session->set('OC_Build', $OC_Build);
- }
- }
- /**
- * generates a path for JS/CSS files. If no application is provided it will create the path for core.
- *
- * @param string $application application to get the files from
- * @param string $directory directory withing this application (css, js, vendor, etc)
- * @param string $file the file inside of the above folder
- * @return string the path
- */
- private static function generatePath($application, $directory, $file) {
- if (is_null($file)) {
- $file = $application;
- $application = "";
- }
- if (!empty($application)) {
- return "$application/$directory/$file";
- } else {
- return "$directory/$file";
- }
- }
- /**
- * add a javascript file
- *
- * @param string $application application id
- * @param string|null $file filename
- * @return void
- */
- public static function addScript($application, $file = null) {
- $path = OC_Util::generatePath($application, 'js', $file);
- if (!in_array($path, self::$scripts)) {
- // core js files need separate handling
- if ($application !== 'core' && $file !== null) {
- self::addTranslations($application);
- }
- self::$scripts[] = $path;
- }
- }
- /**
- * add a javascript file from the vendor sub folder
- *
- * @param string $application application id
- * @param string|null $file filename
- * @return void
- */
- public static function addVendorScript($application, $file = null) {
- $path = OC_Util::generatePath($application, 'vendor', $file);
- if (!in_array($path, self::$scripts)) {
- self::$scripts[] = $path;
- }
- }
- /**
- * add a translation JS file
- *
- * @param string $application application id
- * @param string $languageCode language code, defaults to the current language
- */
- public static function addTranslations($application, $languageCode = null) {
- if (is_null($languageCode)) {
- $languageCode = \OC_L10N::findLanguage($application);
- }
- if (!empty($application)) {
- $path = "$application/l10n/$languageCode";
- } else {
- $path = "l10n/$languageCode";
- }
- if (!in_array($path, self::$scripts)) {
- self::$scripts[] = $path;
- }
- }
- /**
- * add a css file
- *
- * @param string $application application id
- * @param string|null $file filename
- * @return void
- */
- public static function addStyle($application, $file = null) {
- $path = OC_Util::generatePath($application, 'css', $file);
- if (!in_array($path, self::$styles)) {
- self::$styles[] = $path;
- }
- }
- /**
- * add a css file from the vendor sub folder
- *
- * @param string $application application id
- * @param string|null $file filename
- * @return void
- */
- public static function addVendorStyle($application, $file = null) {
- $path = OC_Util::generatePath($application, 'vendor', $file);
- if (!in_array($path, self::$styles)) {
- self::$styles[] = $path;
- }
- }
- /**
- * Add a custom element to the header
- * If $text is null then the element will be written as empty element.
- * So use "" to get a closing tag.
- * @param string $tag tag name of the element
- * @param array $attributes array of attributes for the element
- * @param string $text the text content for the element
- */
- public static function addHeader($tag, $attributes, $text=null) {
- self::$headers[] = array(
- 'tag' => $tag,
- 'attributes' => $attributes,
- 'text' => $text
- );
- }
- /**
- * formats a timestamp in the "right" way
- *
- * @param int $timestamp
- * @param bool $dateOnly option to omit time from the result
- * @param DateTimeZone|string $timeZone where the given timestamp shall be converted to
- * @return string timestamp
- *
- * @deprecated Use \OC::$server->query('DateTimeFormatter') instead
- */
- public static function formatDate($timestamp, $dateOnly = false, $timeZone = null) {
- if ($timeZone !== null && !$timeZone instanceof \DateTimeZone) {
- $timeZone = new \DateTimeZone($timeZone);
- }
- /** @var \OC\DateTimeFormatter $formatter */
- $formatter = \OC::$server->query('DateTimeFormatter');
- if ($dateOnly) {
- return $formatter->formatDate($timestamp, 'long', $timeZone);
- }
- return $formatter->formatDateTime($timestamp, 'long', 'long', $timeZone);
- }
- /**
- * check if the current server configuration is suitable for ownCloud
- *
- * @param \OCP\IConfig $config
- * @return array arrays with error messages and hints
- */
- public static function checkServer(\OCP\IConfig $config) {
- $l = \OC::$server->getL10N('lib');
- $errors = array();
- $CONFIG_DATADIRECTORY = $config->getSystemValue('datadirectory', OC::$SERVERROOT . '/data');
- if (!self::needUpgrade($config) && $config->getSystemValue('installed', false)) {
- // this check needs to be done every time
- $errors = self::checkDataDirectoryValidity($CONFIG_DATADIRECTORY);
- }
- // Assume that if checkServer() succeeded before in this session, then all is fine.
- if (\OC::$server->getSession()->exists('checkServer_succeeded') && \OC::$server->getSession()->get('checkServer_succeeded')) {
- return $errors;
- }
- $webServerRestart = false;
- $setup = new \OC\Setup($config, \OC::$server->getIniWrapper(), \OC::$server->getL10N('lib'), new \OC_Defaults());
- $availableDatabases = $setup->getSupportedDatabases();
- if (empty($availableDatabases)) {
- $errors[] = array(
- 'error' => $l->t('No database drivers (sqlite, mysql, or postgresql) installed.'),
- 'hint' => '' //TODO: sane hint
- );
- $webServerRestart = true;
- }
- // Check if config folder is writable.
- if (!is_writable(OC::$configDir) or !is_readable(OC::$configDir)) {
- $errors[] = array(
- 'error' => $l->t('Cannot write into "config" directory'),
- 'hint' => $l->t('This can usually be fixed by '
- . '%sgiving the webserver write access to the config directory%s.',
- array('<a href="' . \OC_Helper::linkToDocs('admin-dir_permissions') . '" target="_blank">', '</a>'))
- );
- }
- // Check if there is a writable install folder.
- if ($config->getSystemValue('appstoreenabled', true)) {
- if (OC_App::getInstallPath() === null
- || !is_writable(OC_App::getInstallPath())
- || !is_readable(OC_App::getInstallPath())
- ) {
- $errors[] = array(
- 'error' => $l->t('Cannot write into "apps" directory'),
- 'hint' => $l->t('This can usually be fixed by '
- . '%sgiving the webserver write access to the apps directory%s'
- . ' or disabling the appstore in the config file.',
- array('<a href="' . \OC_Helper::linkToDocs('admin-dir_permissions') . '" target="_blank">', '</a>'))
- );
- }
- }
- // Create root dir.
- if ($config->getSystemValue('installed', false)) {
- if (!is_dir($CONFIG_DATADIRECTORY)) {
- $success = @mkdir($CONFIG_DATADIRECTORY);
- if ($success) {
- $errors = array_merge($errors, self::checkDataDirectoryPermissions($CONFIG_DATADIRECTORY));
- } else {
- $errors[] = array(
- 'error' => $l->t('Cannot create "data" directory (%s)', array($CONFIG_DATADIRECTORY)),
- 'hint' => $l->t('This can usually be fixed by '
- . '<a href="%s" target="_blank">giving the webserver write access to the root directory</a>.',
- array(OC_Helper::linkToDocs('admin-dir_permissions')))
- );
- }
- } else if (!is_writable($CONFIG_DATADIRECTORY) or !is_readable($CONFIG_DATADIRECTORY)) {
- //common hint for all file permissions error messages
- $permissionsHint = $l->t('Permissions can usually be fixed by '
- . '%sgiving the webserver write access to the root directory%s.',
- array('<a href="' . \OC_Helper::linkToDocs('admin-dir_permissions') . '" target="_blank">', '</a>'));
- $errors[] = array(
- 'error' => 'Data directory (' . $CONFIG_DATADIRECTORY . ') not writable by ownCloud',
- 'hint' => $permissionsHint
- );
- } else {
- $errors = array_merge($errors, self::checkDataDirectoryPermissions($CONFIG_DATADIRECTORY));
- }
- }
- if (!OC_Util::isSetLocaleWorking()) {
- $errors[] = array(
- 'error' => $l->t('Setting locale to %s failed',
- array('en_US.UTF-8/fr_FR.UTF-8/es_ES.UTF-8/de_DE.UTF-8/ru_RU.UTF-8/'
- . 'pt_BR.UTF-8/it_IT.UTF-8/ja_JP.UTF-8/zh_CN.UTF-8')),
- 'hint' => $l->t('Please install one of these locales on your system and restart your webserver.')
- );
- }
- // Contains the dependencies that should be checked against
- // classes = class_exists
- // functions = function_exists
- // defined = defined
- // ini = ini_get
- // If the dependency is not found the missing module name is shown to the EndUser
- // When adding new checks always verify that they pass on Travis as well
- // for ini settings, see https://github.com/owncloud/administration/blob/master/travis-ci/custom.ini
- $dependencies = array(
- 'classes' => array(
- 'ZipArchive' => 'zip',
- 'DOMDocument' => 'dom',
- 'XMLWriter' => 'XMLWriter'
- ),
- 'functions' => [
- 'xml_parser_create' => 'libxml',
- 'mb_detect_encoding' => 'mb multibyte',
- 'ctype_digit' => 'ctype',
- 'json_encode' => 'JSON',
- 'gd_info' => 'GD',
- 'gzencode' => 'zlib',
- 'iconv' => 'iconv',
- 'simplexml_load_string' => 'SimpleXML',
- 'hash' => 'HASH Message Digest Framework',
- 'curl_init' => 'cURL',
- ],
- 'defined' => array(
- 'PDO::ATTR_DRIVER_NAME' => 'PDO'
- ),
- 'ini' => [
- 'mbstring.func_overload' => 0,
- 'output_buffering' => false,
- 'default_charset' => 'UTF-8',
- ],
- );
- $missingDependencies = array();
- $invalidIniSettings = [];
- $moduleHint = $l->t('Please ask your server administrator to install the module.');
- /**
- * FIXME: The dependency check does not work properly on HHVM on the moment
- * and prevents installation. Once HHVM is more compatible with our
- * approach to check for these values we should re-enable those
- * checks.
- */
- if (!self::runningOnHhvm()) {
- foreach ($dependencies['classes'] as $class => $module) {
- if (!class_exists($class)) {
- $missingDependencies[] = $module;
- }
- }
- foreach ($dependencies['functions'] as $function => $module) {
- if (!function_exists($function)) {
- $missingDependencies[] = $module;
- }
- }
- foreach ($dependencies['defined'] as $defined => $module) {
- if (!defined($defined)) {
- $missingDependencies[] = $module;
- }
- }
- foreach ($dependencies['ini'] as $setting => $expected) {
- $iniWrapper = \OC::$server->getIniWrapper();
- if (is_bool($expected)) {
- if ($iniWrapper->getBool($setting) !== $expected) {
- $invalidIniSettings[] = [$setting, $expected];
- }
- }
- if (is_int($expected)) {
- if ($iniWrapper->getNumeric($setting) !== $expected) {
- $invalidIniSettings[] = [$setting, $expected];
- }
- }
- if (is_string($expected)) {
- if (strtolower($iniWrapper->getString($setting)) !== strtolower($expected)) {
- $invalidIniSettings[] = [$setting, $expected];
- }
- }
- }
- }
- foreach($missingDependencies as $missingDependency) {
- $errors[] = array(
- 'error' => $l->t('PHP module %s not installed.', array($missingDependency)),
- 'hint' => $moduleHint
- );
- $webServerRestart = true;
- }
- foreach($invalidIniSettings as $setting) {
- if(is_bool($setting[1])) {
- $setting[1] = ($setting[1]) ? 'on' : 'off';
- }
- $errors[] = [
- 'error' => $l->t('PHP setting "%s" is not set to "%s".', [$setting[0], var_export($setting[1], true)]),
- 'hint' => $l->t('Adjusting this setting in php.ini will make ownCloud run again')
- ];
- $webServerRestart = true;
- }
- if (version_compare(phpversion(), '5.4.0', '<')) {
- $errors[] = array(
- 'error' => $l->t('PHP %s or higher is required.', '5.4.0'),
- 'hint' => $l->t('Please ask your server administrator to update PHP to the latest version.'
- . ' Your PHP version is no longer supported by ownCloud and the PHP community.')
- );
- $webServerRestart = true;
- }
- /**
- * PHP 5.6 ships with a PHP setting which throws notices by default for a
- * lot of endpoints. Thus we need to ensure that the value is set to -1
- *
- * FIXME: Due to https://github.com/owncloud/core/pull/13593#issuecomment-71178078
- * this check is disabled for HHVM at the moment. This should get re-evaluated
- * at a later point.
- *
- * @link https://github.com/owncloud/core/issues/13592
- */
- if(version_compare(phpversion(), '5.6.0', '>=') &&
- !self::runningOnHhvm() &&
- \OC::$server->getIniWrapper()->getNumeric('always_populate_raw_post_data') !== -1) {
- $errors[] = array(
- 'error' => $l->t('PHP is configured to populate raw post data. Since PHP 5.6 this will lead to PHP throwing notices for perfectly valid code.'),
- 'hint' => $l->t('To fix this issue set <code>always_populate_raw_post_data</code> to <code>-1</code> in your php.ini')
- );
- }
- if (!self::isAnnotationsWorking()) {
- $errors[] = array(
- 'error' => $l->t('PHP is apparently setup to strip inline doc blocks. This will make several core apps inaccessible.'),
- 'hint' => $l->t('This is probably caused by a cache/accelerator such as Zend OPcache or eAccelerator.')
- );
- }
- if (!\OC::$CLI && $webServerRestart) {
- $errors[] = array(
- 'error' => $l->t('PHP modules have been installed, but they are still listed as missing?'),
- 'hint' => $l->t('Please ask your server administrator to restart the web server.')
- );
- }
- $errors = array_merge($errors, self::checkDatabaseVersion());
- // Cache the result of this function
- \OC::$server->getSession()->set('checkServer_succeeded', count($errors) == 0);
- return $errors;
- }
- /**
- * Check the database version
- *
- * @return array errors array
- */
- public static function checkDatabaseVersion() {
- $l = \OC::$server->getL10N('lib');
- $errors = array();
- $dbType = \OC_Config::getValue('dbtype', 'sqlite');
- if ($dbType === 'pgsql') {
- // check PostgreSQL version
- try {
- $result = \OC_DB::executeAudited('SHOW SERVER_VERSION');
- $data = $result->fetchRow();
- if (isset($data['server_version'])) {
- $version = $data['server_version'];
- if (version_compare($version, '9.0.0', '<')) {
- $errors[] = array(
- 'error' => $l->t('PostgreSQL >= 9 required'),
- 'hint' => $l->t('Please upgrade your database version')
- );
- }
- }
- } catch (\Doctrine\DBAL\DBALException $e) {
- \OCP\Util::logException('core', $e);
- $errors[] = array(
- 'error' => $l->t('Error occurred while checking PostgreSQL version'),
- 'hint' => $l->t('Please make sure you have PostgreSQL >= 9 or'
- . ' check the logs for more information about the error')
- );
- }
- }
- return $errors;
- }
- /**
- * check if there are still some encrypted files stored
- *
- * @return boolean
- */
- public static function encryptedFiles() {
- //check if encryption was enabled in the past
- $encryptedFiles = false;
- if (OC_App::isEnabled('files_encryption') === false) {
- $view = new OC\Files\View('/' . OCP\User::getUser());
- $keysPath = '/files_encryption/keys';
- if ($view->is_dir($keysPath)) {
- $dircontent = $view->getDirectoryContent($keysPath);
- if (!empty($dircontent)) {
- $encryptedFiles = true;
- }
- }
- }
- return $encryptedFiles;
- }
- /**
- * check if a backup from the encryption keys exists
- *
- * @return boolean
- */
- public static function backupKeysExists() {
- //check if encryption was enabled in the past
- $backupExists = false;
- if (OC_App::isEnabled('files_encryption') === false) {
- $view = new OC\Files\View('/' . OCP\User::getUser());
- $backupPath = '/files_encryption/backup.decryptAll';
- if ($view->is_dir($backupPath)) {
- $dircontent = $view->getDirectoryContent($backupPath);
- if (!empty($dircontent)) {
- $backupExists = true;
- }
- }
- }
- return $backupExists;
- }
- /**
- * Check for correct file permissions of data directory
- *
- * @param string $dataDirectory
- * @return array arrays with error messages and hints
- */
- public static function checkDataDirectoryPermissions($dataDirectory) {
- $l = \OC::$server->getL10N('lib');
- $errors = array();
- if (self::runningOnWindows()) {
- //TODO: permissions checks for windows hosts
- } else {
- $permissionsModHint = $l->t('Please change the permissions to 0770 so that the directory'
- . ' cannot be listed by other users.');
- $perms = substr(decoct(@fileperms($dataDirectory)), -3);
- if (substr($perms, -1) != '0') {
- chmod($dataDirectory, 0770);
- clearstatcache();
- $perms = substr(decoct(@fileperms($dataDirectory)), -3);
- if (substr($perms, 2, 1) != '0') {
- $errors[] = array(
- 'error' => $l->t('Data directory (%s) is readable by other users', array($dataDirectory)),
- 'hint' => $permissionsModHint
- );
- }
- }
- }
- return $errors;
- }
- /**
- * Check that the data directory exists and is valid by
- * checking the existence of the ".ocdata" file.
- *
- * @param string $dataDirectory data directory path
- * @return bool true if the data directory is valid, false otherwise
- */
- public static function checkDataDirectoryValidity($dataDirectory) {
- $l = \OC::$server->getL10N('lib');
- $errors = array();
- if (!file_exists($dataDirectory . '/.ocdata')) {
- $errors[] = array(
- 'error' => $l->t('Data directory (%s) is invalid', array($dataDirectory)),
- 'hint' => $l->t('Please check that the data directory contains a file' .
- ' ".ocdata" in its root.')
- );
- }
- return $errors;
- }
- /**
- * @param array $errors
- * @param string[] $messages
- */
- public static function displayLoginPage($errors = array(), $messages = []) {
- $parameters = array();
- foreach ($errors as $value) {
- $parameters[$value] = true;
- }
- $parameters['messages'] = $messages;
- if (!empty($_REQUEST['user'])) {
- $parameters["username"] = $_REQUEST['user'];
- $parameters['user_autofocus'] = false;
- } else {
- $parameters["username"] = '';
- $parameters['user_autofocus'] = true;
- }
- if (isset($_REQUEST['redirect_url'])) {
- $parameters['redirect_url'] = $_REQUEST['redirect_url'];
- }
- $parameters['alt_login'] = OC_App::getAlternativeLogIns();
- $parameters['rememberLoginAllowed'] = self::rememberLoginAllowed();
- OC_Template::printGuestPage("", "login", $parameters);
- }
- /**
- * Check if the app is enabled, redirects to home if not
- *
- * @param string $app
- * @return void
- */
- public static function checkAppEnabled($app) {
- if (!OC_App::isEnabled($app)) {
- header('Location: ' . OC_Helper::linkToAbsolute('', 'index.php'));
- exit();
- }
- }
- /**
- * Check if the user is logged in, redirects to home if not. With
- * redirect URL parameter to the request URI.
- *
- * @return void
- */
- public static function checkLoggedIn() {
- // Check if we are a user
- if (!OC_User::isLoggedIn()) {
- header('Location: ' . OC_Helper::linkToAbsolute('', 'index.php',
- [
- 'redirect_url' => \OC::$server->getRequest()->getRequestUri()
- ]
- )
- );
- exit();
- }
- }
- /**
- * Check if the user is a admin, redirects to home if not
- *
- * @return void
- */
- public static function checkAdminUser() {
- OC_Util::checkLoggedIn();
- if (!OC_User::isAdminUser(OC_User::getUser())) {
- header('Location: ' . OC_Helper::linkToAbsolute('', 'index.php'));
- exit();
- }
- }
- /**
- * Check if it is allowed to remember login.
- *
- * @note Every app can set 'rememberlogin' to 'false' to disable the remember login feature
- *
- * @return bool
- */
- public static function rememberLoginAllowed() {
- $apps = OC_App::getEnabledApps();
- foreach ($apps as $app) {
- $appInfo = OC_App::getAppInfo($app);
- if (isset($appInfo['rememberlogin']) && $appInfo['rememberlogin'] === 'false') {
- return false;
- }
- }
- return true;
- }
- /**
- * Check if the user is a subadmin, redirects to home if not
- *
- * @return null|boolean $groups where the current user is subadmin
- */
- public static function checkSubAdminUser() {
- OC_Util::checkLoggedIn();
- if (!OC_SubAdmin::isSubAdmin(OC_User::getUser())) {
- header('Location: ' . OC_Helper::linkToAbsolute('', 'index.php'));
- exit();
- }
- return true;
- }
- /**
- * Returns the URL of the default page
- * based on the system configuration and
- * the apps visible for the current user
- *
- * @return string URL
- */
- public static function getDefaultPageUrl() {
- $urlGenerator = \OC::$server->getURLGenerator();
- // Deny the redirect if the URL contains a @
- // This prevents unvalidated redirects like ?redirect_url=:user@domain.com
- if (isset($_REQUEST['redirect_url']) && strpos($_REQUEST['redirect_url'], '@') === false) {
- $location = $urlGenerator->getAbsoluteURL(urldecode($_REQUEST['redirect_url']));
- } else {
- $defaultPage = OC_Appconfig::getValue('core', 'defaultpage');
- if ($defaultPage) {
- $location = $urlGenerator->getAbsoluteURL($defaultPage);
- } else {
- $appId = 'files';
- $defaultApps = explode(',', \OCP\Config::getSystemValue('defaultapp', 'files'));
- // find the first app that is enabled for the current user
- foreach ($defaultApps as $defaultApp) {
- $defaultApp = OC_App::cleanAppId(strip_tags($defaultApp));
- if (static::getAppManager()->isEnabledForUser($defaultApp)) {
- $appId = $defaultApp;
- break;
- }
- }
- $location = $urlGenerator->getAbsoluteURL('/index.php/apps/' . $appId . '/');
- }
- }
- return $location;
- }
- /**
- * Redirect to the user default page
- *
- * @return void
- */
- public static function redirectToDefaultPage() {
- $location = self::getDefaultPageUrl();
- header('Location: ' . $location);
- exit();
- }
- /**
- * get an id unique for this instance
- *
- * @return string
- */
- public static function getInstanceId() {
- $id = OC_Config::getValue('instanceid', null);
- if (is_null($id)) {
- // We need to guarantee at least one letter in instanceid so it can be used as the session_name
- $id = 'oc' . \OC::$server->getSecureRandom()->getLowStrengthGenerator()->generate(10, \OCP\Security\ISecureRandom::CHAR_LOWER.\OCP\Security\ISecureRandom::CHAR_DIGITS);
- OC_Config::$object->setValue('instanceid', $id);
- }
- return $id;
- }
- /**
- * Register an get/post call. Important to prevent CSRF attacks.
- *
- * @return string Generated token.
- * @description
- * Creates a 'request token' (random) and stores it inside the session.
- * Ever subsequent (ajax) request must use such a valid token to succeed,
- * otherwise the request will be denied as a protection against CSRF.
- * @see OC_Util::isCallRegistered()
- */
- public static function callRegister() {
- // Check if a token exists
- if (!\OC::$server->getSession()->exists('requesttoken')) {
- // No valid token found, generate a new one.
- $requestToken = \OC::$server->getSecureRandom()->getMediumStrengthGenerator()->generate(30);
- \OC::$server->getSession()->set('requesttoken', $requestToken);
- } else {
- // Valid token already exists, send it
- $requestToken = \OC::$server->getSession()->get('requesttoken');
- }
- return ($requestToken);
- }
- /**
- * Check an ajax get/post call if the request token is valid.
- *
- * @return boolean False if request token is not set or is invalid.
- * @see OC_Util::callRegister()
- */
- public static function isCallRegistered() {
- return \OC::$server->getRequest()->passesCSRFCheck();
- }
- /**
- * Check an ajax get/post call if the request token is valid. Exit if not.
- *
- * @return void
- */
- public static function callCheck() {
- if (!OC_Util::isCallRegistered()) {
- exit();
- }
- }
- /**
- * Public function to sanitize HTML
- *
- * This function is used to sanitize HTML and should be applied on any
- * string or array of strings before displaying it on a web page.
- *
- * @param string|array &$value
- * @return string|array an array of sanitized strings or a single sanitized string, depends on the input parameter.
- */
- public static function sanitizeHTML(&$value) {
- if (is_array($value)) {
- array_walk_recursive($value, 'OC_Util::sanitizeHTML');
- } else {
- //Specify encoding for PHP<5.4
- $value = htmlspecialchars((string)$value, ENT_QUOTES, 'UTF-8');
- }
- return $value;
- }
- /**
- * Public function to encode url parameters
- *
- * This function is used to encode path to file before output.
- * Encoding is done according to RFC 3986 with one exception:
- * Character '/' is preserved as is.
- *
- * @param string $component part of URI to encode
- * @return string
- */
- public static function encodePath($component) {
- $encoded = rawurlencode($component);
- $encoded = str_replace('%2F', '/', $encoded);
- return $encoded;
- }
- /**
- * Check if the .htaccess file is working
- *
- * @throws OC\HintException If the testfile can't get written.
- * @return bool
- * @description Check if the .htaccess file is working by creating a test
- * file in the data directory and trying to access via http
- */
- public static function isHtaccessWorking() {
- if (\OC::$CLI || !OC::$server->getConfig()->getSystemValue('check_for_working_htaccess', true)) {
- return true;
- }
- // php dev server does not support htaccess
- if (php_sapi_name() === 'cli-server') {
- return false;
- }
- // testdata
- $fileName = '/htaccesstest.txt';
- $testContent = 'testcontent';
- // creating a test file
- $testFile = OC::$server->getConfig()->getSystemValue('datadirectory', OC::$SERVERROOT . '/data') . '/' . $fileName;
- if (file_exists($testFile)) {// already running this test, possible recursive call
- return false;
- }
- $fp = @fopen($testFile, 'w');
- if (!$fp) {
- throw new OC\HintException('Can\'t create test file to check for working .htaccess file.',
- 'Make sure it is possible for the webserver to write to ' . $testFile);
- }
- fwrite($fp, $testContent);
- fclose($fp);
- // accessing the file via http
- $url = OC_Helper::makeURLAbsolute(OC::$WEBROOT . '/data' . $fileName);
- $content = self::getUrlContent($url);
- // cleanup
- @unlink($testFile);
- /*
- * If the content is not equal to test content our .htaccess
- * is working as required
- */
- return $content !== $testContent;
- }
- /**
- * Check if the setlocal call does not work. This can happen if the right
- * local packages are not available on the server.
- *
- * @return bool
- */
- public static function isSetLocaleWorking() {
- // setlocale test is pointless on Windows
- if (OC_Util::runningOnWindows()) {
- return true;
- }
- \Patchwork\Utf8\Bootup::initLocale();
- if ('' === basename('§')) {
- return false;
- }
- return true;
- }
- /**
- * Check if it's possible to get the inline annotations
- *
- * @return bool
- */
- public static function isAnnotationsWorking() {
- $reflection = new \ReflectionMethod(__METHOD__);
- $docs = $reflection->getDocComment();
- return (is_string($docs) && strlen($docs) > 50);
- }
- /**
- * Check if the PHP module fileinfo is loaded.
- *
- * @return bool
- */
- public static function fileInfoLoaded() {
- return function_exists('finfo_open');
- }
- /**
- * Check if the ownCloud server can connect to the internet
- *
- * @param \OCP\Http\Client\IClientService $clientService
- * @return bool
- */
- public static function isInternetConnectionWorking(\OCP\Http\Client\IClientService $clientService) {
- // in case there is no internet connection on purpose return false
- if (self::isInternetConnectionEnabled() === false) {
- return false;
- }
- try {
- $client = $clientService->newClient();
- $response = $client->get('https://www.owncloud.org/');
- return $response->getStatusCode() === 200;
- } catch (\Exception $e) {
- return false;
- }
- }
- /**
- * Check if the connection to the internet is disabled on purpose
- *
- * @return string
- */
- public static function isInternetConnectionEnabled() {
- return \OC_Config::getValue("has_internet_connection", true);
- }
- /**
- * clear all levels of output buffering
- *
- * @return void
- */
- public static function obEnd() {
- while (ob_get_level()) {
- ob_end_clean();
- }
- }
- /**
- * Generates a cryptographic secure pseudo-random string
- *
- * @param int $length of the random string
- * @return string
- * @deprecated Use \OC::$server->getSecureRandom()->getMediumStrengthGenerator()->generate($length); instead
- */
- public static function generateRandomBytes($length = 30) {
- return \OC::$server->getSecureRandom()->getMediumStrengthGenerator()->generate($length, \OCP\Security\ISecureRandom::CHAR_LOWER.\OCP\Security\ISecureRandom::CHAR_DIGITS);
- }
- /**
- * Get URL content
- * @param string $url Url to get content
- * @deprecated Use \OC::$server->getHTTPHelper()->getUrlContent($url);
- * @throws Exception If the URL does not start with http:// or https://
- * @return string of the response or false on error
- * This function get the content of a page via curl, if curl is enabled.
- * If not, file_get_contents is used.
- */
- public static function getUrlContent($url) {
- try {
- return \OC::$server->getHTTPHelper()->getUrlContent($url);
- } catch (\Exception $e) {
- throw $e;
- }
- }
- /**
- * Checks whether the server is running on Windows
- *
- * @return bool true if running on Windows, false otherwise
- */
- public static function runningOnWindows() {
- return (substr(PHP_OS, 0, 3) === "WIN");
- }
- /**
- * Checks whether the server is running on Mac OS X
- *
- * @return bool true if running on Mac OS X, false otherwise
- */
- public static function runningOnMac() {
- return (strtoupper(substr(PHP_OS, 0, 6)) === 'DARWIN');
- }
- /**
- * Checks whether server is running on HHVM
- *
- * @return bool True if running on HHVM, false otherwise
- */
- public static function runningOnHhvm() {
- return defined('HHVM_VERSION');
- }
- /**
- * Handles the case that there may not be a theme, then check if a "default"
- * theme exists and take that one
- *
- * @return string the theme
- */
- public static function getTheme() {
- $theme = OC_Config::getValue("theme", '');
- if ($theme === '') {
- if (is_dir(OC::$SERVERROOT . '/themes/default')) {
- $theme = 'default';
- }
- }
- return $theme;
- }
- /**
- * Clear a single file from the opcode cache
- * This is useful for writing to the config file
- * in case the opcode cache does not re-validate files
- * Returns true if successful, false if unsuccessful:
- * caller should fall back on clearing the entire cache
- * with clearOpcodeCache() if unsuccessful
- *
- * @param string $path the path of the file to clear from the cache
- * @return bool true if underlying function returns true, otherwise false
- */
- public static function deleteFromOpcodeCache($path) {
- $ret = false;
- if ($path) {
- // APC >= 3.1.1
- if (function_exists('apc_delete_file')) {
- $ret = @apc_delete_file($path);
- }
- // Zend OpCache >= 7.0.0, PHP >= 5.5.0
- if (function_exists('opcache_invalidate')) {
- $ret = opcache_invalidate($path);
- }
- }
- return $ret;
- }
- /**
- * Clear the opcode cache if one exists
- * This is necessary for writing to the config file
- * in case the opcode cache does not re-validate files
- *
- * @return void
- */
- public static function clearOpcodeCache() {
- // APC
- if (function_exists('apc_clear_cache')) {
- apc_clear_cache();
- }
- // Zend Opcache
- if (function_exists('accelerator_reset')) {
- accelerator_reset();
- }
- // XCache
- if (function_exists('xcache_clear_cache')) {
- if (ini_get('xcache.admin.enable_auth')) {
- OC_Log::write('core', 'XCache opcode cache will not be cleared because "xcache.admin.enable_auth" is enabled.', \OC_Log::WARN);
- } else {
- xcache_clear_cache(XC_TYPE_PHP, 0);
- }
- }
- // Opcache (PHP >= 5.5)
- if (function_exists('opcache_reset')) {
- opcache_reset();
- }
- }
- /**
- * Normalize a unicode string
- *
- * @param string $value a not normalized string
- * @return bool|string
- */
- public static function normalizeUnicode($value) {
- if(Normalizer::isNormalized($value)) {
- return $value;
- }
- $normalizedValue = Normalizer::normalize($value);
- if ($normalizedValue === null || $normalizedValue === false) {
- \OC::$server->getLogger()->warning('normalizing failed for "' . $value . '"', ['app' => 'core']);
- return $value;
- }
- return $normalizedValue;
- }
- /**
- * @param boolean|string $file
- * @return string
- */
- public static function basename($file) {
- $file = rtrim($file, '/');
- $t = explode('/', $file);
- return array_pop($t);
- }
- /**
- * A human readable string is generated based on version, channel and build number
- *
- * @return string
- */
- public static function getHumanVersion() {
- $version = OC_Util::getVersionString() . ' (' . OC_Util::getChannel() . ')';
- $build = OC_Util::getBuild();
- if (!empty($build) and OC_Util::getChannel() === 'daily') {
- $version .= ' Build:' . $build;
- }
- return $version;
- }
- /**
- * Returns whether the given file name is valid
- *
- * @param string $file file name to check
- * @return bool true if the file name is valid, false otherwise
- * @deprecated use \OC\Files\View::verifyPath()
- */
- public static function isValidFileName($file) {
- $trimmed = trim($file);
- if ($trimmed === '') {
- return false;
- }
- if ($trimmed === '.' || $trimmed === '..') {
- return false;
- }
- foreach (str_split($trimmed) as $char) {
- if (strpos(\OCP\Constants::FILENAME_INVALID_CHARS, $char) !== false) {
- return false;
- }
- }
- return true;
- }
- /**
- * Check whether the instance needs to perform an upgrade,
- * either when the core version is higher or any app requires
- * an upgrade.
- *
- * @param \OCP\IConfig $config
- * @return bool whether the core or any app needs an upgrade
- */
- public static function needUpgrade(\OCP\IConfig $config) {
- if ($config->getSystemValue('installed', false)) {
- $installedVersion = $config->getSystemValue('version', '0.0.0');
- $currentVersion = implode('.', OC_Util::getVersion());
- if (version_compare($currentVersion, $installedVersion, '>')) {
- return true;
- }
- // also check for upgrades for apps (independently from the user)
- $apps = \OC_App::getEnabledApps(false, true);
- $shouldUpgrade = false;
- foreach ($apps as $app) {
- if (\OC_App::shouldUpgrade($app)) {
- $shouldUpgrade = true;
- break;
- }
- }
- return $shouldUpgrade;
- } else {
- return false;
- }
- }
- }
|