1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288 |
- <?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;
-
- /**
- * @brief 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;
- }
-
- // 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;
- }
-
- $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;
- }
-
- if ($user != '' && !OCP\User::userExists($user)) {
- return false;
- }
-
- //if we aren't logged in, there is no use to set up the filesystem
- if( $user != "" ) {
- \OC\Files\Filesystem::addStorageWrapper(function($mountPoint, $storage){
- // set up quota for home storages, even for other users
- // which can happen when using sharing
-
- if ($storage instanceof \OC\Files\Storage\Home) {
- $user = $storage->getUser()->getUID();
- $quota = OC_Util::getUserQuota($user);
- if ($quota !== \OC\Files\SPACE_UNLIMITED) {
- return new \OC\Files\Storage\Wrapper\Quota(array('storage' => $storage, 'quota' => $quota, 'root' => 'files'));
- }
- }
-
- return $storage;
- });
-
- $userDir = '/'.$user.'/files';
- $userRoot = OC_User::getHome($user);
- $userDirectory = $userRoot . '/files';
- if( !is_dir( $userDirectory )) {
- mkdir( $userDirectory, 0755, true );
- OC_Util::copySkeleton($userDirectory);
- }
- //jail the user into his "home" directory
- \OC\Files\Filesystem::init($user, $userDir);
-
- $fileOperationProxy = new OC_FileProxy_FileOperations();
- OC_FileProxy::register($fileOperationProxy);
-
- OC_Hook::emit('OC_Filesystem', 'setup', array('user' => $user, 'user_dir' => $userDir));
- }
- return true;
- }
-
- /**
- * 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 \OC\Files\SPACE_UNLIMITED;
- }else{
- return OC_Helper::computerFileSize($userQuota);
- }
- }
-
- /**
- * @brief copies the user skeleton files into the fresh user home files
- * @param string $userDirectory
- */
- public static function copySkeleton($userDirectory) {
- OC_Util::copyr(\OC::$SERVERROOT.'/core/skeleton' , $userDirectory);
- }
-
- /**
- * @brief copies a directory recursively
- * @param string $source
- * @param string $target
- * @return void
- */
- public static function copyr($source,$target) {
- $dir = opendir($source);
- @mkdir($target);
- while(false !== ( $file = readdir($dir)) ) {
- if ( !\OC\Files\Filesystem::isIgnoredDir($file) ) {
- if ( is_dir($source . '/' . $file) ) {
- OC_Util::copyr($source . '/' . $file , $target . '/' . $file);
- } else {
- copy($source . '/' . $file,$target . '/' . $file);
- }
- }
- }
- closedir($dir);
- }
-
- /**
- * @return void
- */
- public static function tearDownFS() {
- \OC\Files\Filesystem::tearDown();
- self::$fsSetup=false;
- self::$rootMounted=false;
- }
-
- /**
- * @brief get the current installed version of ownCloud
- * @return array
- */
- public static function getVersion() {
- OC_Util::loadVersion();
- return \OC::$server->getSession()->get('OC_Version');
- }
-
- /**
- * @brief 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() {
- OC_Util::loadVersion();
- return \OC::$server->getSession()->get('OC_Edition');
- }
-
- /**
- * @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 '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_Edition string */
- $session->set('OC_Edition', $OC_Edition);
- /** @var $OC_Channel string */
- $session->set('OC_Channel', $OC_Channel);
- /** @var $OC_Build string */
- $session->set('OC_Build', $OC_Build);
- }
- }
-
- /**
- * @brief add a javascript file
- *
- * @param string $application
- * @param string|null $file filename
- * @return void
- */
- public static function addScript( $application, $file = null ) {
- if ( is_null( $file )) {
- $file = $application;
- $application = "";
- }
- if ( !empty( $application )) {
- self::$scripts[] = "$application/js/$file";
- } else {
- self::$scripts[] = "js/$file";
- }
- }
-
- /**
- * @brief add a css file
- *
- * @param string $application
- * @param string|null $file filename
- * @return void
- */
- public static function addStyle( $application, $file = null ) {
- if ( is_null( $file )) {
- $file = $application;
- $application = "";
- }
- if ( !empty( $application )) {
- self::$styles[] = "$application/css/$file";
- } else {
- self::$styles[] = "css/$file";
- }
- }
-
- /**
- * @brief Add a custom element to the header
- * @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
- * @return void
- */
- public static function addHeader( $tag, $attributes, $text='') {
- self::$headers[] = array(
- 'tag'=>$tag,
- 'attributes'=>$attributes,
- 'text'=>$text
- );
- }
-
- /**
- * @brief formats a timestamp in the "right" way
- *
- * @param int $timestamp
- * @param bool $dateOnly option to omit time from the result
- * @return string timestamp
- * @description adjust to clients timezone if we know it
- */
- public static function formatDate( $timestamp, $dateOnly=false) {
- if(\OC::$session->exists('timezone')) {
- $systemTimeZone = intval(date('O'));
- $systemTimeZone = (round($systemTimeZone/100, 0)*60) + ($systemTimeZone%100);
- $clientTimeZone = \OC::$session->get('timezone')*60;
- $offset = $clientTimeZone - $systemTimeZone;
- $timestamp = $timestamp + $offset*60;
- }
- $l = OC_L10N::get('lib');
- return $l->l($dateOnly ? 'date' : 'datetime', $timestamp);
- }
-
- /**
- * @brief check if the current server configuration is suitable for ownCloud
- * @return array arrays with error messages and hints
- */
- public static function checkServer() {
- $errors = array();
- $CONFIG_DATADIRECTORY = OC_Config::getValue('datadirectory', OC::$SERVERROOT . '/data');
-
- if (!\OC::needUpgrade() && OC_Config::getValue('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::$session->exists('checkServer_suceeded') && \OC::$session->get('checkServer_suceeded')) {
- return $errors;
- }
-
- $webServerRestart = false;
- //check for database drivers
- if(!(is_callable('sqlite_open') or class_exists('SQLite3'))
- and !is_callable('mysql_connect')
- and !is_callable('pg_connect')
- and !is_callable('oci_connect')) {
- $errors[] = array(
- 'error'=>'No database drivers (sqlite, mysql, or postgresql) installed.',
- 'hint'=>'' //TODO: sane hint
- );
- $webServerRestart = true;
- }
-
- //common hint for all file permissions error messages
- $permissionsHint = 'Permissions can usually be fixed by '
- .'<a href="' . OC_Helper::linkToDocs('admin-dir_permissions')
- .'" target="_blank">giving the webserver write access to the root directory</a>.';
-
- // Check if config folder is writable.
- if(!is_writable(OC::$configDir) or !is_readable(OC::$configDir)) {
- $errors[] = array(
- 'error' => "Can't write into config directory",
- 'hint' => 'This can usually be fixed by '
- .'<a href="' . OC_Helper::linkToDocs('admin-dir_permissions')
- .'" target="_blank">giving the webserver write access to the config directory</a>.'
- );
- }
-
- // Check if there is a writable install folder.
- if(OC_Config::getValue('appstoreenabled', true)) {
- if( OC_App::getInstallPath() === null
- || !is_writable(OC_App::getInstallPath())
- || !is_readable(OC_App::getInstallPath()) ) {
- $errors[] = array(
- 'error' => "Can't write into apps directory",
- 'hint' => 'This can usually be fixed by '
- .'<a href="' . OC_Helper::linkToDocs('admin-dir_permissions')
- .'" target="_blank">giving the webserver write access to the apps directory</a> '
- .'or disabling the appstore in the config file.'
- );
- }
- }
- // Create root dir.
- if(!is_dir($CONFIG_DATADIRECTORY)) {
- $success=@mkdir($CONFIG_DATADIRECTORY);
- if ($success) {
- $errors = array_merge($errors, self::checkDataDirectoryPermissions($CONFIG_DATADIRECTORY));
- } else {
- $errors[] = array(
- 'error' => "Can't create data directory (".$CONFIG_DATADIRECTORY.")",
- 'hint' => 'This can usually be fixed by '
- .'<a href="' . OC_Helper::linkToDocs('admin-dir_permissions')
- .'" target="_blank">giving the webserver write access to the root directory</a>.'
- );
- }
- } else if(!is_writable($CONFIG_DATADIRECTORY) or !is_readable($CONFIG_DATADIRECTORY)) {
- $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' => 'Setting locale to 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 failed',
- 'hint' => 'Please install one of theses locales on your system and restart your webserver.'
- );
- }
-
- $moduleHint = "Please ask your server administrator to install the module.";
- // check if all required php modules are present
- if(!class_exists('ZipArchive')) {
- $errors[] = array(
- 'error'=>'PHP module zip not installed.',
- 'hint'=>$moduleHint
- );
- $webServerRestart = true;
- }
- if(!class_exists('DOMDocument')) {
- $errors[] = array(
- 'error' => 'PHP module dom not installed.',
- 'hint' => $moduleHint
- );
- $webServerRestart =true;
- }
- if(!function_exists('xml_parser_create')) {
- $errors[] = array(
- 'error' => 'PHP module libxml not installed.',
- 'hint' => $moduleHint
- );
- $webServerRestart = true;
- }
- if(!function_exists('mb_detect_encoding')) {
- $errors[] = array(
- 'error'=>'PHP module mb multibyte not installed.',
- 'hint'=>$moduleHint
- );
- $webServerRestart = true;
- }
- if(!function_exists('ctype_digit')) {
- $errors[] = array(
- 'error'=>'PHP module ctype is not installed.',
- 'hint'=>$moduleHint
- );
- $webServerRestart = true;
- }
- if(!function_exists('json_encode')) {
- $errors[] = array(
- 'error'=>'PHP module JSON is not installed.',
- 'hint'=>$moduleHint
- );
- $webServerRestart = true;
- }
- if(!extension_loaded('gd') || !function_exists('gd_info')) {
- $errors[] = array(
- 'error'=>'PHP module GD is not installed.',
- 'hint'=>$moduleHint
- );
- $webServerRestart = true;
- }
- if(!function_exists('gzencode')) {
- $errors[] = array(
- 'error'=>'PHP module zlib is not installed.',
- 'hint'=>$moduleHint
- );
- $webServerRestart = true;
- }
- if(!function_exists('iconv')) {
- $errors[] = array(
- 'error'=>'PHP module iconv is not installed.',
- 'hint'=>$moduleHint
- );
- $webServerRestart = true;
- }
- if(!function_exists('simplexml_load_string')) {
- $errors[] = array(
- 'error'=>'PHP module SimpleXML is not installed.',
- 'hint'=>$moduleHint
- );
- $webServerRestart = true;
- }
- if(version_compare(phpversion(), '5.3.3', '<')) {
- $errors[] = array(
- 'error'=>'PHP 5.3.3 or higher is required.',
- 'hint'=>'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;
- }
- if(!defined('PDO::ATTR_DRIVER_NAME')) {
- $errors[] = array(
- 'error'=>'PHP PDO module is not installed.',
- 'hint'=>$moduleHint
- );
- $webServerRestart = true;
- }
- if (((strtolower(@ini_get('safe_mode')) == 'on')
- || (strtolower(@ini_get('safe_mode')) == 'yes')
- || (strtolower(@ini_get('safe_mode')) == 'true')
- || (ini_get("safe_mode") == 1 ))) {
- $errors[] = array(
- 'error'=>'PHP Safe Mode is enabled. ownCloud requires that it is disabled to work properly.',
- 'hint'=>'PHP Safe Mode is a deprecated and mostly useless setting that should be disabled. '
- .'Please ask your server administrator to disable it in php.ini or in your webserver config.'
- );
- $webServerRestart = true;
- }
- if (get_magic_quotes_gpc() == 1 ) {
- $errors[] = array(
- 'error'=>'Magic Quotes is enabled. ownCloud requires that it is disabled to work properly.',
- 'hint'=>'Magic Quotes is a deprecated and mostly useless setting that should be disabled. '
- .'Please ask your server administrator to disable it in php.ini or in your webserver config.'
- );
- $webServerRestart = true;
- }
-
- if($webServerRestart) {
- $errors[] = array(
- 'error'=>'PHP modules have been installed, but they are still listed as missing?',
- 'hint'=>'Please ask your server administrator to restart the web server.'
- );
- }
-
- $errors = array_merge($errors, self::checkDatabaseVersion());
-
- // Cache the result of this function
- \OC::$session->set('checkServer_suceeded', count($errors) == 0);
-
- return $errors;
- }
-
- /**
- * Check the database version
- * @return array errors array
- */
- public static function checkDatabaseVersion() {
- $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' => 'PostgreSQL >= 9 required',
- 'hint' => 'Please upgrade your database version'
- );
- }
- }
- } catch (\Doctrine\DBAL\DBALException $e) {
- \OCP\Util::logException('core', $e);
- $errors[] = array(
- 'error' => 'Error occurred while checking PostgreSQL version',
- 'hint' => 'Please make sure you have PostgreSQL >= 9 or check the logs for more information about the error'
- );
- }
- }
- return $errors;
- }
-
-
- /**
- * @brief 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());
- $keyfilePath = '/files_encryption/keyfiles';
- if ($view->is_dir($keyfilePath)) {
- $dircontent = $view->getDirectoryContent($keyfilePath);
- if (!empty($dircontent)) {
- $encryptedFiles = true;
- }
- }
- }
-
- return $encryptedFiles;
- }
-
- /**
- * @brief Check for correct file permissions of data directory
- * @param string $dataDirectory
- * @return array arrays with error messages and hints
- */
- public static function checkDataDirectoryPermissions($dataDirectory) {
- $errors = array();
- if (self::runningOnWindows()) {
- //TODO: permissions checks for windows hosts
- } else {
- $permissionsModHint = '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' => 'Data directory ('.$dataDirectory.') is readable for other users',
- '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) {
- $errors = array();
- if (!file_exists($dataDirectory.'/.ocdata')) {
- $errors[] = array(
- 'error' => 'Data directory (' . $dataDirectory . ') is invalid',
- 'hint' => 'Please check that the data directory contains a file' .
- ' ".ocdata" in its root.'
- );
- }
- return $errors;
- }
-
- /**
- * @param array $errors
- */
- public static function displayLoginPage($errors = array()) {
- $parameters = array();
- foreach( $errors as $value ) {
- $parameters[$value] = true;
- }
- if (!empty($_POST['user'])) {
- $parameters["username"] = $_POST['user'];
- $parameters['user_autofocus'] = false;
- } else {
- $parameters["username"] = '';
- $parameters['user_autofocus'] = true;
- }
- if (isset($_REQUEST['redirect_url'])) {
- $redirectUrl = $_REQUEST['redirect_url'];
- $parameters['redirect_url'] = urlencode($redirectUrl);
- }
-
- $parameters['alt_login'] = OC_App::getAlternativeLogIns();
- $parameters['rememberLoginAllowed'] = self::rememberLoginAllowed();
- OC_Template::printGuestPage("", "login", $parameters);
- }
-
-
- /**
- * @brief 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',
- array('redirect_url' => OC_Request::requestUri())
- ));
- exit();
- }
- }
-
- /**
- * @brief 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;
- }
-
- /**
- * @brief 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;
- }
-
- /**
- * @brief Redirect to the user default page
- * @return void
- */
- public static function redirectToDefaultPage() {
- $urlGenerator = \OC::$server->getURLGenerator();
- if(isset($_REQUEST['redirect_url'])) {
- $location = urldecode($_REQUEST['redirect_url']);
- }
- else if (isset(OC::$REQUESTEDAPP) && !empty(OC::$REQUESTEDAPP)) {
- $location = $urlGenerator->getAbsoluteURL('/index.php/apps/'.OC::$REQUESTEDAPP.'/index.php');
- } else {
- $defaultPage = OC_Appconfig::getValue('core', 'defaultpage');
- if ($defaultPage) {
- $location = $urlGenerator->getAbsoluteURL($defaultPage);
- } else {
- $location = $urlGenerator->getAbsoluteURL('/index.php/files/index.php');
- }
- }
- OC_Log::write('core', 'redirectToDefaultPage: '.$location, OC_Log::DEBUG);
- header( 'Location: '.$location );
- exit();
- }
-
- /**
- * @brief 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' . self::generateRandomBytes(10);
- OC_Config::$object->setValue('instanceid', $id);
- }
- return $id;
- }
-
- /**
- * @brief Static lifespan (in seconds) when a request token expires.
- * @see OC_Util::callRegister()
- * @see OC_Util::isCallRegistered()
- * @description
- * Also required for the client side to compute the point in time when to
- * request a fresh token. The client will do so when nearly 97% of the
- * time span coded here has expired.
- */
- public static $callLifespan = 3600; // 3600 secs = 1 hour
-
- /**
- * @brief Register an get/post call. Important to prevent CSRF attacks.
- * @todo Write howto: CSRF protection guide
- * @return $token 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.
- * The tokens expire after a fixed lifespan.
- * @see OC_Util::$callLifespan
- * @see OC_Util::isCallRegistered()
- */
- public static function callRegister() {
- // Check if a token exists
- if(!\OC::$session->exists('requesttoken')) {
- // No valid token found, generate a new one.
- $requestToken = self::generateRandomBytes(20);
- \OC::$session->set('requesttoken', $requestToken);
- } else {
- // Valid token already exists, send it
- $requestToken = \OC::$session->get('requesttoken');
- }
- return($requestToken);
- }
-
- /**
- * @brief 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::$callLifespan
- * @see OC_Util::callRegister()
- */
- public static function isCallRegistered() {
- return \OC::$server->getRequest()->passesCSRFCheck();
- }
-
- /**
- * @brief Check an ajax get/post call if the request token is valid. exit if not.
- * @todo Write howto
- * @return void
- */
- public static function callCheck() {
- if(!OC_Util::isCallRegistered()) {
- exit();
- }
- }
-
- /**
- * @brief 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 of strings
- * @return array with 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;
- }
-
- /**
- * @brief 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;
- }
-
- /**
- * @brief 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_Config::getValue("check_for_working_htaccess", true)) {
- return true;
- }
-
- // testdata
- $fileName = '/htaccesstest.txt';
- $testContent = 'testcontent';
-
- // creating a test file
- $testFile = OC_Config::getValue( "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);
- $fp = @fopen($url, 'r');
- $content=@fread($fp, 2048);
- @fclose($fp);
-
- // cleanup
- @unlink($testFile);
-
- // does it work ?
- if($content==$testContent) {
- return false;
- } else {
- return true;
- }
- }
-
- /**
- * @brief test if webDAV is working properly
- * @return bool
- * @description
- * The basic assumption is that if the server returns 401/Not Authenticated for an unauthenticated PROPFIND
- * the web server it self is setup properly.
- *
- * Why not an authenticated PROPFIND and other verbs?
- * - We don't have the password available
- * - We have no idea about other auth methods implemented (e.g. OAuth with Bearer header)
- *
- */
- public static function isWebDAVWorking() {
- if (!function_exists('curl_init')) {
- return true;
- }
- if (!\OC_Config::getValue("check_for_working_webdav", true)) {
- return true;
- }
- $settings = array(
- 'baseUri' => OC_Helper::linkToRemote('webdav'),
- );
-
- $client = new \OC_DAVClient($settings);
-
- $client->setRequestTimeout(10);
-
- // for this self test we don't care if the ssl certificate is self signed and the peer cannot be verified.
- $client->setVerifyPeer(false);
- // also don't care if the host can't be verified
- $client->setVerifyHost(0);
-
- $return = true;
- try {
- // test PROPFIND
- $client->propfind('', array('{DAV:}resourcetype'));
- } catch (\Sabre_DAV_Exception_NotAuthenticated $e) {
- $return = true;
- } catch (\Exception $e) {
- OC_Log::write('core', 'isWebDAVWorking: NO - Reason: '.$e->getMessage(). ' ('.get_class($e).')', OC_Log::WARN);
- $return = false;
- }
-
- return $return;
- }
-
- /**
- * 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;
- }
-
- /**
- * @brief Check if the PHP module fileinfo is loaded.
- * @return bool
- */
- public static function fileInfoLoaded() {
- return function_exists('finfo_open');
- }
-
- /**
- * @brief Check if a PHP version older then 5.3.8 is installed.
- * @return bool
- */
- public static function isPHPoutdated() {
- return version_compare(phpversion(), '5.3.8', '<');
- }
-
- /**
- * @brief Check if the ownCloud server can connect to the internet
- * @return bool
- */
- public static function isInternetConnectionWorking() {
- // in case there is no internet connection on purpose return false
- if (self::isInternetConnectionEnabled() === false) {
- return false;
- }
-
- // in case the connection is via proxy return true to avoid connecting to owncloud.org
- if(OC_Config::getValue('proxy', '') != '') {
- return true;
- }
-
- // try to connect to owncloud.org to see if http connections to the internet are possible.
- $connected = @fsockopen("www.owncloud.org", 80);
- if ($connected) {
- fclose($connected);
- return true;
- } else {
- // second try in case one server is down
- $connected = @fsockopen("apps.owncloud.com", 80);
- if ($connected) {
- fclose($connected);
- return true;
- } else {
- return false;
- }
- }
- }
-
- /**
- * @brief 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);
- }
-
- /**
- * @brief clear all levels of output buffering
- * @return void
- */
- public static function obEnd(){
- while (ob_get_level()) {
- ob_end_clean();
- }
- }
-
-
- /**
- * @brief Generates a cryptographic secure pseudo-random string
- * @param Int $length of the random string
- * @return String
- * Please also update secureRNGAvailable if you change something here
- */
- public static function generateRandomBytes($length = 30) {
- // Try to use openssl_random_pseudo_bytes
- if (function_exists('openssl_random_pseudo_bytes')) {
- $pseudoByte = bin2hex(openssl_random_pseudo_bytes($length, $strong));
- if($strong == true) {
- return substr($pseudoByte, 0, $length); // Truncate it to match the length
- }
- }
-
- // Try to use /dev/urandom
- if (!self::runningOnWindows()) {
- $fp = @file_get_contents('/dev/urandom', false, null, 0, $length);
- if ($fp !== false) {
- $string = substr(bin2hex($fp), 0, $length);
- return $string;
- }
- }
-
- // Fallback to mt_rand()
- $characters = '0123456789';
- $characters .= 'abcdefghijklmnopqrstuvwxyz';
- $charactersLength = strlen($characters)-1;
- $pseudoByte = "";
-
- // Select some random characters
- for ($i = 0; $i < $length; $i++) {
- $pseudoByte .= $characters[mt_rand(0, $charactersLength)];
- }
- return $pseudoByte;
- }
-
- /**
- * @brief Checks if a secure random number generator is available
- * @return bool
- */
- public static function secureRNGAvailable() {
- // Check openssl_random_pseudo_bytes
- if(function_exists('openssl_random_pseudo_bytes')) {
- openssl_random_pseudo_bytes(1, $strong);
- if($strong == true) {
- return true;
- }
- }
-
- // Check /dev/urandom
- if (!self::runningOnWindows()) {
- $fp = @file_get_contents('/dev/urandom', false, null, 0, 1);
- if ($fp !== false) {
- return true;
- }
- }
-
- return false;
- }
-
- /**
- * @Brief Get file content via curl.
- * @param string $url Url to get content
- * @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) {
- if (function_exists('curl_init')) {
- $curl = curl_init();
- $max_redirects = 10;
-
- curl_setopt($curl, CURLOPT_HEADER, 0);
- curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
- curl_setopt($curl, CURLOPT_CONNECTTIMEOUT, 10);
- curl_setopt($curl, CURLOPT_URL, $url);
-
-
- curl_setopt($curl, CURLOPT_USERAGENT, "ownCloud Server Crawler");
- if(OC_Config::getValue('proxy', '') != '') {
- curl_setopt($curl, CURLOPT_PROXY, OC_Config::getValue('proxy'));
- }
- if(OC_Config::getValue('proxyuserpwd', '') != '') {
- curl_setopt($curl, CURLOPT_PROXYUSERPWD, OC_Config::getValue('proxyuserpwd'));
- }
-
- if (ini_get('open_basedir') === '' && ini_get('safe_mode' === 'Off')) {
- curl_setopt($curl, CURLOPT_FOLLOWLOCATION, true);
- curl_setopt($curl, CURLOPT_MAXREDIRS, $max_redirects);
- $data = curl_exec($curl);
- } else {
- curl_setopt($curl, CURLOPT_FOLLOWLOCATION, false);
- $mr = $max_redirects;
- if ($mr > 0) {
- $newurl = curl_getinfo($curl, CURLINFO_EFFECTIVE_URL);
-
- $rcurl = curl_copy_handle($curl);
- curl_setopt($rcurl, CURLOPT_HEADER, true);
- curl_setopt($rcurl, CURLOPT_NOBODY, true);
- curl_setopt($rcurl, CURLOPT_FORBID_REUSE, false);
- curl_setopt($rcurl, CURLOPT_RETURNTRANSFER, true);
- do {
- curl_setopt($rcurl, CURLOPT_URL, $newurl);
- $header = curl_exec($rcurl);
- if (curl_errno($rcurl)) {
- $code = 0;
- } else {
- $code = curl_getinfo($rcurl, CURLINFO_HTTP_CODE);
- if ($code == 301 || $code == 302) {
- preg_match('/Location:(.*?)\n/', $header, $matches);
- $newurl = trim(array_pop($matches));
- } else {
- $code = 0;
- }
- }
- } while ($code && --$mr);
- curl_close($rcurl);
- if ($mr > 0) {
- curl_setopt($curl, CURLOPT_URL, $newurl);
- }
- }
-
- if($mr == 0 && $max_redirects > 0) {
- $data = false;
- } else {
- $data = curl_exec($curl);
- }
- }
- curl_close($curl);
- } else {
- $contextArray = null;
-
- if(OC_Config::getValue('proxy', '') != '') {
- $contextArray = array(
- 'http' => array(
- 'timeout' => 10,
- 'proxy' => OC_Config::getValue('proxy')
- )
- );
- } else {
- $contextArray = array(
- 'http' => array(
- 'timeout' => 10
- )
- );
- }
-
- $ctx = stream_context_create(
- $contextArray
- );
- $data = @file_get_contents($url, 0, $ctx);
-
- }
- return $data;
- }
-
- /**
- * 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');
- }
-
- /**
- * 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;
- }
-
- /**
- * @brief 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(class_exists('Patchwork\PHP\Shim\Normalizer')) {
- $normalizedValue = \Patchwork\PHP\Shim\Normalizer::normalize($value);
- if($normalizedValue === false) {
- \OC_Log::write( 'core', 'normalizing failed for "' . $value . '"', \OC_Log::WARN);
- } else {
- $value = $normalizedValue;
- }
- }
-
- return $value;
- }
-
- /**
- * @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 $file string file name to check
- * @return bool true if the file name is valid, false otherwise
- */
- 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\FILENAME_INVALID_CHARS, $char) !== false) {
- return false;
- }
- }
- return true;
- }
- }
|