2011-07-27 19:07:28 +02:00
< ? php
/**
* Class for utility functions
*
*/
2012-10-12 15:37:44 +02:00
2011-07-29 21:36:03 +02:00
class OC_Util {
2011-07-27 19:07:28 +02:00
public static $scripts = array ();
public static $styles = array ();
public static $headers = array ();
2012-02-05 23:49:22 +01:00
private static $rootMounted = false ;
2011-07-27 19:07:28 +02:00
private static $fsSetup = false ;
2012-05-14 17:57:43 +02:00
public static $core_styles = array ();
2012-05-14 23:15:53 +02:00
public static $core_scripts = array ();
2011-07-27 19:07:28 +02:00
// Can be set up
2012-09-07 15:22:01 +02:00
public static function setupFS ( $user = '' ) { // configure the initial filesystem based on the configuration
if ( self :: $fsSetup ) { //setting up the filesystem twice can only lead to trouble
2011-07-27 19:07:28 +02:00
return false ;
}
2012-08-29 21:35:55 +02:00
// If we are not forced to load a specific user we load the one that is logged in
2012-09-07 15:22:01 +02:00
if ( $user == " " && OC_User :: isLoggedIn ()) {
2012-08-29 21:35:55 +02:00
$user = OC_User :: getUser ();
}
2012-10-28 13:47:53 +01:00
// load all filesystem apps before, so no setup-hook gets lost
2012-10-28 15:10:15 +01:00
if ( ! isset ( $RUNTIME_NOAPPS ) || ! $RUNTIME_NOAPPS ) {
2012-10-28 13:47:53 +01:00
OC_App :: loadApps ( array ( 'filesystem' ));
}
2012-08-29 21:35:55 +02:00
// 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 ;
}
2012-06-19 22:50:28 +02:00
$CONFIG_DATADIRECTORY = OC_Config :: getValue ( " datadirectory " , OC :: $SERVERROOT . " /data " );
2012-02-05 21:45:41 +01:00
//first set up the local "root" storage
2012-09-07 15:22:01 +02:00
if ( ! self :: $rootMounted ) {
2012-10-25 18:26:08 +02:00
\OC\Files\Filesystem :: mount ( '\OC\Files\Storage\Local' , array ( 'datadir' => $CONFIG_DATADIRECTORY ), '/' );
2012-02-05 23:49:22 +01:00
self :: $rootMounted = true ;
}
2012-06-20 08:57:21 +02:00
2012-09-07 15:22:01 +02:00
if ( $user != " " ) { //if we aren't logged in, there is no use to set up the filesystem
2012-06-19 17:38:04 +02:00
$user_dir = '/' . $user . '/files' ;
2012-08-26 22:03:02 +02:00
$user_root = OC_User :: getHome ( $user );
$userdirectory = $user_root . '/files' ;
2012-09-07 15:22:01 +02:00
if ( ! is_dir ( $userdirectory )) {
2012-06-19 22:50:28 +02:00
mkdir ( $userdirectory , 0755 , true );
2011-07-27 19:07:28 +02:00
}
2012-08-27 15:55:22 +02:00
//jail the user into his "home" directory
2013-02-11 01:09:58 +01:00
\OC\Files\Filesystem :: init ( $user , $user_dir );
2012-10-23 16:16:46 +02:00
2011-08-15 20:37:50 +02:00
$quotaProxy = new OC_FileProxy_Quota ();
2012-10-12 16:29:35 +02:00
$fileOperationProxy = new OC_FileProxy_FileOperations ();
2011-08-15 20:37:50 +02:00
OC_FileProxy :: register ( $quotaProxy );
2012-10-12 16:29:35 +02:00
OC_FileProxy :: register ( $fileOperationProxy );
2012-10-18 23:24:28 +02:00
2012-06-19 17:38:04 +02:00
OC_Hook :: emit ( 'OC_Filesystem' , 'setup' , array ( 'user' => $user , 'user_dir' => $user_dir ));
2011-07-27 19:07:28 +02:00
}
2012-10-26 18:29:24 +02:00
return true ;
2011-07-27 19:07:28 +02:00
}
2012-09-07 15:22:01 +02:00
public static function tearDownFS () {
2012-10-10 13:18:36 +02:00
\OC\Files\Filesystem :: tearDown ();
2011-07-27 19:07:28 +02:00
self :: $fsSetup = false ;
}
2012-10-28 13:45:37 +01:00
2011-07-27 19:07:28 +02:00
/**
* get the current installed version of ownCloud
* @ return array
*/
2012-09-07 15:22:01 +02:00
public static function getVersion () {
2013-02-21 21:30:25 +01:00
// hint: We only can count up. Reset minor/patchlevel when
// updating major/minor version number.
2013-03-19 01:35:12 +01:00
return array ( 5 , 80 , 01 );
2011-09-28 13:52:26 +02:00
}
/**
* get the current installed version string of ownCloud
* @ return string
*/
2012-09-07 15:22:01 +02:00
public static function getVersionString () {
2013-03-09 20:19:34 +01:00
return '6.0 pre alpha' ;
2011-07-27 19:07:28 +02:00
}
2012-07-24 00:39:59 +02:00
/**
2013-02-11 17:44:02 +01:00
* 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 " .
2012-07-24 00:39:59 +02:00
* @ return string
*/
2012-09-07 15:22:01 +02:00
public static function getEditionString () {
2013-01-02 23:02:38 +01:00
return '' ;
2012-07-24 00:39:59 +02:00
}
2012-04-01 11:20:12 +02:00
2011-07-27 19:07:28 +02:00
/**
* add a javascript file
*
2012-05-01 21:07:08 +02:00
* @ param appid $application
* @ param filename $file
2011-07-27 19:07:28 +02:00
*/
2012-09-07 15:22:01 +02:00
public static function addScript ( $application , $file = null ) {
if ( is_null ( $file )) {
2011-07-27 19:07:28 +02:00
$file = $application ;
$application = " " ;
}
2012-09-07 15:22:01 +02:00
if ( ! empty ( $application )) {
2011-07-27 19:07:28 +02:00
self :: $scripts [] = " $application /js/ $file " ;
} else {
self :: $scripts [] = " js/ $file " ;
}
}
/**
* add a css file
*
2012-05-01 21:07:08 +02:00
* @ param appid $application
* @ param filename $file
2011-07-27 19:07:28 +02:00
*/
2012-09-07 15:22:01 +02:00
public static function addStyle ( $application , $file = null ) {
if ( is_null ( $file )) {
2011-07-27 19:07:28 +02:00
$file = $application ;
$application = " " ;
}
2012-09-07 15:22:01 +02:00
if ( ! empty ( $application )) {
2011-07-27 19:07:28 +02:00
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
2012-02-07 22:33:01 +01:00
* @ param array $attributes array of attributes for the element
2011-07-27 19:07:28 +02:00
* @ param string $text the text content for the element
*/
2012-09-07 15:22:01 +02:00
public static function addHeader ( $tag , $attributes , $text = '' ) {
2012-11-30 00:18:42 +01:00
self :: $headers [] = array ( 'tag' => $tag , 'attributes' => $attributes , 'text' => $text );
2011-07-27 19:07:28 +02:00
}
2012-07-24 00:39:59 +02:00
/**
* formats a timestamp in the " right " way
*
* @ param int timestamp $timestamp
2012-11-30 00:18:42 +01:00
* @ param bool dateOnly option to omit time from the result
2012-07-24 00:39:59 +02:00
*/
2012-12-13 19:26:05 +01:00
public static function formatDate ( $timestamp , $dateOnly = false ) {
2012-09-07 15:22:01 +02:00
if ( isset ( $_SESSION [ 'timezone' ])) { //adjust to clients timezone if we know it
2012-04-16 12:21:12 +02:00
$systemTimeZone = intval ( date ( 'O' ));
2012-10-28 18:12:31 +01:00
$systemTimeZone = ( round ( $systemTimeZone / 100 , 0 ) * 60 ) + ( $systemTimeZone % 100 );
2012-04-16 12:21:12 +02:00
$clientTimeZone = $_SESSION [ 'timezone' ] * 60 ;
$offset = $clientTimeZone - $systemTimeZone ;
$timestamp = $timestamp + $offset * 60 ;
}
2012-06-07 14:44:59 +02:00
$l = OC_L10N :: get ( 'lib' );
return $l -> l ( $dateOnly ? 'date' : 'datetime' , $timestamp );
2011-07-27 19:07:28 +02:00
}
/**
* check if the current server configuration is suitable for ownCloud
* @ return array arrays with error messages and hints
*/
2012-09-07 15:22:01 +02:00
public static function checkServer () {
2011-07-27 19:07:28 +02:00
$errors = array ();
2012-09-11 23:51:12 +02:00
$web_server_restart = false ;
2011-07-27 19:07:28 +02:00
//check for database drivers
2013-02-11 17:44:02 +01:00
if ( ! ( is_callable ( 'sqlite_open' ) or class_exists ( 'SQLite3' ))
and ! is_callable ( 'mysql_connect' )
and ! is_callable ( 'pg_connect' )) {
2013-03-07 17:28:28 +01:00
$errors [] = array ( 'error' => 'No database drivers (sqlite, mysql, or postgresql) installed.' ,
2013-02-11 17:44:02 +01:00
'hint' => '' ); //TODO: sane hint
2012-09-11 23:51:12 +02:00
$web_server_restart = true ;
2011-07-27 19:07:28 +02:00
}
//common hint for all file permissons error messages
2013-02-26 20:48:01 +01:00
$permissionsHint = 'Permissions can usually be fixed by giving the webserver write access'
. ' to the ownCloud directory' ;
2011-07-27 19:07:28 +02:00
2012-06-19 22:12:05 +02:00
// Check if config folder is writable.
2012-09-16 22:49:03 +02:00
if ( ! is_writable ( OC :: $SERVERROOT . " /config/ " ) or ! is_readable ( OC :: $SERVERROOT . " /config/ " )) {
2013-02-11 17:44:02 +01:00
$errors [] = array ( 'error' => " Can't write into config directory 'config' " ,
2013-02-26 20:48:01 +01:00
'hint' => 'You can usually fix this by giving the webserver user write access'
. ' to the config directory in owncloud' );
2012-06-19 22:12:05 +02:00
}
2012-06-21 21:35:34 +02:00
// Check if there is a writable install folder.
if ( OC_Config :: getValue ( 'appstoreenabled' , true )) {
2013-02-11 17:44:02 +01:00
if ( OC_App :: getInstallPath () === null
|| ! is_writable ( OC_App :: getInstallPath ())
|| ! is_readable ( OC_App :: getInstallPath ()) ) {
$errors [] = array ( 'error' => " Can't write into apps directory " ,
2013-02-26 20:48:01 +01:00
'hint' => 'You can usually fix this by giving the webserver user write access'
. ' to the apps directory in owncloud or disabling the appstore in the config file.' );
2012-06-21 21:35:34 +02:00
}
2012-06-19 22:12:05 +02:00
}
2012-06-19 22:50:28 +02:00
$CONFIG_DATADIRECTORY = OC_Config :: getValue ( " datadirectory " , OC :: $SERVERROOT . " /data " );
2012-06-19 22:12:05 +02:00
// Create root dir.
2012-09-07 15:22:01 +02:00
if ( ! is_dir ( $CONFIG_DATADIRECTORY )) {
2012-06-19 22:50:28 +02:00
$success =@ mkdir ( $CONFIG_DATADIRECTORY );
2013-01-19 05:30:56 +01:00
if ( $success ) {
$errors = array_merge ( $errors , self :: checkDataDirectoryPermissions ( $CONFIG_DATADIRECTORY ));
} else {
2013-02-11 17:44:02 +01:00
$errors [] = array ( 'error' => " Can't create data directory ( " . $CONFIG_DATADIRECTORY . " ) " ,
'hint' => " You can usually fix this by giving the webserver write access to the ownCloud directory ' "
. OC :: $SERVERROOT . " ' (in a terminal, use the command "
. " 'chown -R www-data:www-data /path/to/your/owncloud/install/data' " );
2012-06-19 22:12:05 +02:00
}
2012-09-16 22:49:03 +02:00
} else if ( ! is_writable ( $CONFIG_DATADIRECTORY ) or ! is_readable ( $CONFIG_DATADIRECTORY )) {
2013-03-09 13:45:37 +01:00
$errors [] = array ( 'error' => 'Data directory (' . $CONFIG_DATADIRECTORY . ') not writable by ownCloud' ,
2013-02-11 17:44:02 +01:00
'hint' => $permissionsHint );
2013-01-13 05:35:13 +01:00
} else {
2013-01-19 05:30:56 +01:00
$errors = array_merge ( $errors , self :: checkDataDirectoryPermissions ( $CONFIG_DATADIRECTORY ));
2011-07-27 19:07:28 +02:00
}
2011-09-27 19:08:38 +02:00
// check if all required php modules are present
2012-09-07 15:22:01 +02:00
if ( ! class_exists ( 'ZipArchive' )) {
2013-03-07 17:28:28 +01:00
$errors [] = array ( 'error' => 'PHP module zip not installed.' ,
2013-02-11 17:44:02 +01:00
'hint' => 'Please ask your server administrator to install the module.' );
2012-09-11 23:51:12 +02:00
$web_server_restart = false ;
2011-09-27 19:08:38 +02:00
}
2013-02-28 15:13:18 +01:00
if ( ! class_exists ( 'DOMDocument' )) {
2013-03-07 17:28:28 +01:00
$errors [] = array ( 'error' => 'PHP module dom not installed.' ,
2013-02-28 15:13:18 +01:00
'hint' => 'Please ask your server administrator to install the module.' );
$web_server_restart = false ;
}
if ( ! function_exists ( 'xml_parser_create' )) {
2013-03-07 17:28:28 +01:00
$errors [] = array ( 'error' => 'PHP module libxml not installed.' ,
2013-02-28 15:13:18 +01:00
'hint' => 'Please ask your server administrator to install the module.' );
$web_server_restart = false ;
}
2012-09-07 15:22:01 +02:00
if ( ! function_exists ( 'mb_detect_encoding' )) {
2013-03-07 17:28:28 +01:00
$errors [] = array ( 'error' => 'PHP module mb multibyte not installed.' ,
2013-02-11 17:44:02 +01:00
'hint' => 'Please ask your server administrator to install the module.' );
2012-09-11 23:51:12 +02:00
$web_server_restart = false ;
2011-09-27 19:08:38 +02:00
}
2012-09-07 15:22:01 +02:00
if ( ! function_exists ( 'ctype_digit' )) {
2013-03-07 17:28:28 +01:00
$errors [] = array ( 'error' => 'PHP module ctype is not installed.' ,
2013-02-11 17:44:02 +01:00
'hint' => 'Please ask your server administrator to install the module.' );
2012-09-11 23:51:12 +02:00
$web_server_restart = false ;
2011-09-28 11:47:29 +02:00
}
2012-09-07 15:22:01 +02:00
if ( ! function_exists ( 'json_encode' )) {
2013-03-07 17:28:28 +01:00
$errors [] = array ( 'error' => 'PHP module JSON is not installed.' ,
2013-02-11 17:44:02 +01:00
'hint' => 'Please ask your server administrator to install the module.' );
2012-09-11 23:51:12 +02:00
$web_server_restart = false ;
2012-04-17 19:06:45 +02:00
}
2012-09-07 15:22:01 +02:00
if ( ! function_exists ( 'imagepng' )) {
2013-03-07 17:28:28 +01:00
$errors [] = array ( 'error' => 'PHP module GD is not installed.' ,
2013-02-11 17:44:02 +01:00
'hint' => 'Please ask your server administrator to install the module.' );
2012-09-11 23:51:12 +02:00
$web_server_restart = false ;
2012-04-17 19:09:41 +02:00
}
2012-09-07 15:22:01 +02:00
if ( ! function_exists ( 'gzencode' )) {
2013-03-07 17:28:28 +01:00
$errors [] = array ( 'error' => 'PHP module zlib is not installed.' ,
2013-02-11 17:44:02 +01:00
'hint' => 'Please ask your server administrator to install the module.' );
2012-09-11 23:51:12 +02:00
$web_server_restart = false ;
2012-09-07 01:39:11 +02:00
}
2012-10-25 16:49:55 +02:00
if ( ! function_exists ( 'iconv' )) {
2013-03-07 17:28:28 +01:00
$errors [] = array ( 'error' => 'PHP module iconv is not installed.' ,
2013-02-11 17:44:02 +01:00
'hint' => 'Please ask your server administrator to install the module.' );
2012-10-25 16:49:55 +02:00
$web_server_restart = false ;
}
2012-10-06 17:37:38 +02:00
if ( ! function_exists ( 'simplexml_load_string' )) {
2013-03-07 17:28:28 +01:00
$errors [] = array ( 'error' => 'PHP module SimpleXML is not installed.' ,
2013-02-11 17:44:02 +01:00
'hint' => 'Please ask your server administrator to install the module.' );
2012-10-06 17:37:38 +02:00
$web_server_restart = false ;
}
2012-09-07 15:22:01 +02:00
if ( floatval ( phpversion ()) < 5.3 ) {
2013-03-07 17:28:28 +01:00
$errors [] = array ( 'error' => 'PHP 5.3 is required.' ,
2013-02-11 17:44:02 +01:00
'hint' => 'Please ask your server administrator to update PHP to version 5.3 or higher.'
. ' PHP 5.2 is no longer supported by ownCloud and the PHP community.' );
2012-09-11 23:51:12 +02:00
$web_server_restart = false ;
2012-04-30 13:28:31 +02:00
}
2012-09-07 15:22:01 +02:00
if ( ! defined ( 'PDO::ATTR_DRIVER_NAME' )) {
2013-03-07 17:28:28 +01:00
$errors [] = array ( 'error' => 'PHP PDO module is not installed.' ,
2013-02-11 17:44:02 +01:00
'hint' => 'Please ask your server administrator to install the module.' );
2012-09-11 23:51:12 +02:00
$web_server_restart = false ;
}
2013-03-19 14:36:52 +01:00
if ((( strtolower ( @ ini_get ( 'safe_mode' )) == 'on' )
|| ( strtolower ( @ ini_get ( 'safe_mode' )) == 'yes' )
|| ( strtolower ( @ ini_get ( 'safe_mode' )) == 'true' )
|| ( ini_get ( " safe_mode " ) == 1 ))) {
2013-03-07 17:28:28 +01:00
$errors [] = array ( 'error' => 'PHP Safe Mode is enabled. ownCloud requires that it is disabled to work properly.' ,
2013-02-21 11:09:00 +01:00
'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.' );
$web_server_restart = false ;
}
2012-09-11 23:51:12 +02:00
if ( $web_server_restart ) {
2013-03-07 17:28:28 +01:00
$errors [] = array ( 'error' => 'PHP modules have been installed, but they are still listed as missing?' ,
2013-02-11 17:44:02 +01:00
'hint' => 'Please ask your server administrator to restart the web server.' );
2012-06-01 20:00:33 +02:00
}
2011-07-27 19:07:28 +02:00
return $errors ;
}
2011-09-18 21:31:56 +02:00
2013-01-19 05:30:56 +01:00
/**
* Check for correct file permissions of data directory
* @ return array arrays with error messages and hints
*/
public static function checkDataDirectoryPermissions ( $dataDirectory ) {
$errors = array ();
if ( stristr ( PHP_OS , 'WIN' )) {
//TODO: permissions checks for windows hosts
} else {
2013-02-11 17:44:02 +01:00
$permissionsModHint = 'Please change the permissions to 0770 so that the directory'
. ' cannot be listed by other users.' ;
2013-01-19 05:30:56 +01:00
$prems = substr ( decoct ( @ fileperms ( $dataDirectory )), - 3 );
if ( substr ( $prems , - 1 ) != '0' ) {
OC_Helper :: chmodr ( $dataDirectory , 0770 );
clearstatcache ();
$prems = substr ( decoct ( @ fileperms ( $dataDirectory )), - 3 );
if ( substr ( $prems , 2 , 1 ) != '0' ) {
2013-03-09 13:45:37 +01:00
$errors [] = array ( 'error' => 'Data directory (' . $dataDirectory . ') is readable for other users' ,
2013-02-11 17:44:02 +01:00
'hint' => $permissionsModHint );
2013-01-19 05:30:56 +01:00
}
}
}
return $errors ;
}
2012-10-12 16:12:43 +02:00
public static function displayLoginPage ( $errors = array ()) {
2012-08-09 18:27:59 +02:00
$parameters = array ();
2012-10-12 16:12:43 +02:00
foreach ( $errors as $key => $value ) {
$parameters [ $value ] = true ;
}
2012-08-09 18:27:59 +02:00
if ( ! empty ( $_POST [ 'user' ])) {
2013-03-02 20:21:51 +01:00
$parameters [ " username " ] = $_POST [ 'user' ];
2012-08-09 18:27:59 +02:00
$parameters [ 'user_autofocus' ] = false ;
2011-09-30 23:48:20 +02:00
} else {
$parameters [ " username " ] = '' ;
2012-08-09 18:27:59 +02:00
$parameters [ 'user_autofocus' ] = true ;
2011-09-25 22:47:29 +02:00
}
2012-08-09 18:27:59 +02:00
if ( isset ( $_REQUEST [ 'redirect_url' ])) {
2013-03-02 20:21:51 +01:00
$redirect_url = $_REQUEST [ 'redirect_url' ];
2012-12-07 12:07:56 +01:00
$parameters [ 'redirect_url' ] = urlencode ( $redirect_url );
2013-01-02 23:02:38 +01:00
}
2013-01-29 17:28:08 +01:00
$parameters [ 'alt_login' ] = OC_App :: getAlternativeLogIns ();
2011-09-25 22:47:29 +02:00
OC_Template :: printGuestPage ( " " , " login " , $parameters );
}
2011-09-28 11:44:46 +02:00
2011-09-30 23:05:10 +02:00
/**
2013-01-02 23:02:38 +01:00
* Check if the app is enabled , redirects to home if not
*/
2012-09-07 15:22:01 +02:00
public static function checkAppEnabled ( $app ) {
if ( ! OC_App :: isEnabled ( $app )) {
2012-02-16 19:45:00 +01:00
header ( 'Location: ' . OC_Helper :: linkToAbsolute ( '' , 'index.php' ));
2011-09-30 23:05:10 +02:00
exit ();
}
}
2011-09-18 21:31:56 +02:00
/**
2013-01-02 23:02:38 +01:00
* Check if the user is logged in , redirects to home if not . With
* redirect URL parameter to the request URI .
*/
2012-09-07 15:22:01 +02:00
public static function checkLoggedIn () {
2011-09-18 21:31:56 +02:00
// Check if we are a user
2012-09-07 15:22:01 +02:00
if ( ! OC_User :: isLoggedIn ()) {
2013-02-11 17:44:02 +01:00
header ( 'Location: ' . OC_Helper :: linkToAbsolute ( '' , 'index.php' ,
array ( 'redirect_url' => OC_Request :: requestUri ())));
2011-09-18 21:31:56 +02:00
exit ();
}
}
/**
2013-01-02 23:02:38 +01:00
* Check if the user is a admin , redirects to home if not
*/
2012-09-07 15:22:01 +02:00
public static function checkAdminUser () {
2013-01-14 19:45:17 +01:00
if ( ! OC_User :: isAdminUser ( OC_User :: getUser ())) {
2012-02-16 19:45:00 +01:00
header ( 'Location: ' . OC_Helper :: linkToAbsolute ( '' , 'index.php' ));
2011-09-18 21:31:56 +02:00
exit ();
}
}
2012-07-09 21:51:19 +02:00
/**
2013-01-02 23:02:38 +01:00
* Check if the user is a subadmin , redirects to home if not
* @ return array $groups where the current user is subadmin
*/
2012-09-07 15:22:01 +02:00
public static function checkSubAdminUser () {
if ( ! OC_SubAdmin :: isSubAdmin ( OC_User :: getUser ())) {
2012-07-09 21:51:19 +02:00
header ( 'Location: ' . OC_Helper :: linkToAbsolute ( '' , 'index.php' ));
exit ();
}
2012-07-15 16:31:28 +02:00
return true ;
2012-07-09 21:51:19 +02:00
}
2011-09-18 21:31:56 +02:00
/**
2013-01-02 23:02:38 +01:00
* Redirect to the user default page
*/
2012-09-07 15:22:01 +02:00
public static function redirectToDefaultPage () {
2012-10-31 22:03:55 +01:00
if ( isset ( $_REQUEST [ 'redirect_url' ])) {
$location = OC_Helper :: makeURLAbsolute ( urldecode ( $_REQUEST [ 'redirect_url' ]));
2012-06-20 17:10:17 +02:00
}
else if ( isset ( OC :: $REQUESTEDAPP ) && ! empty ( OC :: $REQUESTEDAPP )) {
2012-08-06 18:49:06 +02:00
$location = OC_Helper :: linkToAbsolute ( OC :: $REQUESTEDAPP , 'index.php' );
2012-06-20 17:10:17 +02:00
}
else {
2012-08-06 18:49:06 +02:00
$defaultpage = OC_Appconfig :: getValue ( 'core' , 'defaultpage' );
if ( $defaultpage ) {
2012-08-06 22:15:55 +02:00
$location = OC_Helper :: makeURLAbsolute ( OC :: $WEBROOT . '/' . $defaultpage );
2012-08-06 18:49:06 +02:00
}
else {
$location = OC_Helper :: linkToAbsolute ( 'files' , 'index.php' );
}
2011-10-04 19:27:57 +02:00
}
2012-07-03 17:54:12 +02:00
OC_Log :: write ( 'core' , 'redirectToDefaultPage: ' . $location , OC_Log :: DEBUG );
header ( 'Location: ' . $location );
2011-09-18 21:31:56 +02:00
exit ();
}
2012-06-05 19:32:48 +02:00
2013-03-26 13:46:13 +01:00
/**
* get an id unique for this instance
* @ return string
*/
public static function getInstanceId () {
$id = OC_Config :: getValue ( 'instanceid' , null );
if ( is_null ( $id )) {
2013-03-26 22:49:32 +01:00
// We need to guarantee at least one letter in instanceid so it can be used as the session_name
2013-04-04 00:33:18 +02:00
$id = 'oc' . OC_Util :: generate_random_bytes ( 10 );
2013-03-26 13:46:13 +01:00
OC_Config :: setValue ( 'instanceid' , $id );
}
return $id ;
}
2012-06-09 15:05:14 +02:00
/**
2012-09-28 13:30:44 +02:00
* @ 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 piont in time when to
* request a fresh token . The client will do so when nearly 97 % of the
2012-10-14 21:04:08 +02:00
* timespan coded here has expired .
2012-09-28 13:30:44 +02:00
*/
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
2012-06-13 17:33:19 +02:00
* @ return $token Generated token .
2012-09-28 13:30:44 +02:00
* @ 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 ()
2012-06-09 15:05:14 +02:00
*/
2012-09-07 15:22:01 +02:00
public static function callRegister () {
2012-10-28 20:50:50 +01:00
// Check if a token exists
2012-10-31 18:37:59 +01:00
if ( ! isset ( $_SESSION [ 'requesttoken' ])) {
2012-10-28 20:50:50 +01:00
// No valid token found, generate a new one.
2012-10-31 18:37:59 +01:00
$requestToken = self :: generate_random_bytes ( 20 );
$_SESSION [ 'requesttoken' ] = $requestToken ;
2012-10-28 20:50:50 +01:00
} else {
// Valid token already exists, send it
2012-10-31 18:37:59 +01:00
$requestToken = $_SESSION [ 'requesttoken' ];
2012-06-11 12:13:08 +02:00
}
2012-10-31 18:37:59 +01:00
return ( $requestToken );
2012-06-09 15:05:14 +02:00
}
/**
2012-06-13 17:33:19 +02:00
* @ 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 .
2012-09-28 13:30:44 +02:00
* @ see OC_Util :: $callLifespan
2012-10-28 18:24:11 +01:00
* @ see OC_Util :: callRegister ()
2012-06-09 15:05:14 +02:00
*/
2012-09-07 15:22:01 +02:00
public static function isCallRegistered () {
2013-03-01 14:59:51 +01:00
if ( ! isset ( $_SESSION [ 'requesttoken' ])) {
return false ;
}
2012-06-09 15:05:14 +02:00
if ( isset ( $_GET [ 'requesttoken' ])) {
$token = $_GET [ 'requesttoken' ];
2013-03-01 14:59:24 +01:00
} elseif ( isset ( $_POST [ 'requesttoken' ])) {
2012-06-09 15:05:14 +02:00
$token = $_POST [ 'requesttoken' ];
2013-03-01 14:59:24 +01:00
} elseif ( isset ( $_SERVER [ 'HTTP_REQUESTTOKEN' ])) {
2012-06-13 17:33:19 +02:00
$token = $_SERVER [ 'HTTP_REQUESTTOKEN' ];
2013-03-01 14:59:24 +01:00
} else {
2012-06-13 17:33:19 +02:00
//no token found.
return false ;
2012-06-09 15:05:14 +02:00
}
2012-10-28 20:50:50 +01:00
// Check if the token is valid
2012-10-31 18:37:59 +01:00
if ( $token !== $_SESSION [ 'requesttoken' ]) {
2012-10-28 20:50:50 +01:00
// Not valid
2012-06-13 17:33:19 +02:00
return false ;
2012-10-28 20:50:50 +01:00
} else {
// Valid token
return true ;
2012-06-09 15:05:14 +02:00
}
}
2012-06-13 17:33:19 +02:00
/**
* @ brief Check an ajax get / post call if the request token is valid . exit if not .
* Todo : Write howto
*/
2012-09-07 15:22:01 +02:00
public static function callCheck () {
2012-06-13 17:33:19 +02:00
if ( ! OC_Util :: isCallRegistered ()) {
exit ;
}
}
2012-08-29 08:38:33 +02:00
2012-06-21 14:07:04 +02:00
/**
* @ brief Public function to sanitize HTML
*
2012-06-22 08:17:35 +02:00
* 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 .
2012-08-29 08:38:33 +02:00
*
2012-06-19 17:20:19 +02:00
* @ param string or array of strings
2012-06-22 08:17:35 +02:00
* @ return array with sanitized strings or a single sanitized string , depends on the input parameter .
2012-06-19 17:20:19 +02:00
*/
2012-09-07 15:22:01 +02:00
public static function sanitizeHTML ( & $value ) {
2013-02-22 00:51:54 +01:00
if ( is_array ( $value )) {
2013-01-14 22:01:52 +01:00
array_walk_recursive ( $value , 'OC_Util::sanitizeHTML' );
} else {
2013-02-22 00:51:54 +01:00
$value = htmlentities (( string ) $value , ENT_QUOTES , 'UTF-8' ); //Specify encoding for PHP<5.4
2013-01-14 22:01:52 +01:00
}
2012-06-19 17:20:19 +02:00
return $value ;
}
2012-06-21 14:07:04 +02:00
2012-07-24 00:39:59 +02:00
/**
* 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 () {
2012-06-21 14:07:04 +02:00
// testdata
$filename = '/htaccesstest.txt' ;
$testcontent = 'testcontent' ;
// creating a test file
2012-07-24 00:39:59 +02:00
$testfile = OC_Config :: getValue ( " datadirectory " , OC :: $SERVERROOT . " /data " ) . '/' . $filename ;
2012-10-26 18:17:43 +02:00
2012-11-04 18:18:03 +01:00
if ( file_exists ( $testfile )) { // already running this test, possible recursive call
2012-10-26 18:17:43 +02:00
return false ;
}
2012-07-24 00:39:59 +02:00
$fp = @ fopen ( $testfile , 'w' );
@ fwrite ( $fp , $testcontent );
@ fclose ( $fp );
2012-06-21 14:07:04 +02:00
// accessing the file via http
2012-08-06 22:15:55 +02:00
$url = OC_Helper :: makeURLAbsolute ( OC :: $WEBROOT . '/data' . $filename );
2012-07-24 00:39:59 +02:00
$fp = @ fopen ( $url , 'r' );
$content =@ fread ( $fp , 2048 );
@ fclose ( $fp );
2012-06-21 14:07:04 +02:00
// cleanup
@ unlink ( $testfile );
// does it work ?
if ( $content == $testcontent ) {
return ( false );
} else {
return ( true );
}
2012-07-24 00:39:59 +02:00
}
2012-06-21 14:07:04 +02:00
2013-02-05 23:33:44 +01:00
/**
* we test if webDAV is working properly
*
* 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 PROFIND 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 () {
2013-02-09 22:44:11 +01:00
if ( ! function_exists ( 'curl_init' )) {
2013-02-20 23:11:38 +01:00
return true ;
2013-02-09 22:44:11 +01:00
}
2013-02-05 23:33:44 +01:00
$settings = array (
'baseUri' => OC_Helper :: linkToRemote ( 'webdav' ),
);
2013-02-25 16:30:11 +01:00
// save the old timeout so that we can restore it later
$old_timeout = ini_get ( " default_socket_timeout " );
// use a 5 sec timeout for the check. Should be enough for local requests.
ini_set ( " default_socket_timeout " , 5 );
2013-02-05 23:33:44 +01:00
$client = new \Sabre_DAV_Client ( $settings );
2013-03-01 20:34:16 +01:00
// for this self test we don't care if the ssl certificate is self signed and the peer cannot be verified.
$client -> setVerifyPeer ( false );
2013-02-05 23:33:44 +01:00
$return = true ;
try {
// test PROPFIND
$client -> propfind ( '' , array ( '{DAV:}resourcetype' ));
} catch ( \Sabre_DAV_Exception_NotAuthenticated $e ) {
$return = true ;
} catch ( \Exception $e ) {
2013-02-20 23:11:38 +01:00
OC_Log :: write ( 'core' , 'isWebDAVWorking: NO - Reason: ' . $e , OC_Log :: WARN );
2013-02-05 23:33:44 +01:00
$return = false ;
}
2013-02-25 16:30:11 +01:00
// restore the original timeout
ini_set ( " default_socket_timeout " , $old_timeout );
2013-02-05 23:33:44 +01:00
return $return ;
}
2012-11-08 18:08:44 +01:00
2013-01-02 23:02:38 +01:00
/**
2013-02-11 17:44:02 +01:00
* Check if the setlocal call doesn ' t work . This can happen if the right
* local packages are not available on the server .
2013-01-02 23:02:38 +01:00
*/
2012-12-19 15:10:33 +01:00
public static function issetlocaleworking () {
2013-02-05 15:46:55 +01:00
// setlocale test is pointless on Windows
if ( OC_Util :: runningOnWindows () ) {
return true ;
}
2013-02-08 17:49:54 +01:00
$result = setlocale ( LC_ALL , 'en_US.UTF-8' , 'en_US.UTF8' );
if ( $result == false ) {
return false ;
}
return true ;
2012-12-19 15:10:33 +01:00
}
2013-02-04 15:04:26 +01:00
/**
* Check if the PHP module fileinfo is loaded .
* @ return bool
*/
public static function fileInfoLoaded () {
return function_exists ( 'finfo_open' );
}
2013-01-02 23:02:38 +01:00
/**
* Check if the ownCloud server can connect to the internet
*/
2012-12-14 23:04:42 +01:00
public static function isinternetconnectionworking () {
2012-11-08 18:08:44 +01:00
// try to connect to owncloud.org to see if http connections to the internet are possible.
2013-01-02 23:02:38 +01:00
$connected = @ fsockopen ( " www.owncloud.org " , 80 );
2012-11-10 00:58:03 +01:00
if ( $connected ) {
2012-11-08 18:08:44 +01:00
fclose ( $connected );
2012-11-29 17:58:24 +01:00
return true ;
2012-11-08 18:08:44 +01:00
} else {
// second try in case one server is down
2013-01-02 23:02:38 +01:00
$connected = @ fsockopen ( " apps.owncloud.com " , 80 );
2012-11-10 00:58:03 +01:00
if ( $connected ) {
2012-11-08 18:08:44 +01:00
fclose ( $connected );
2012-11-29 17:58:24 +01:00
return true ;
2012-11-08 18:08:44 +01:00
} else {
2012-11-29 17:58:24 +01:00
return false ;
2012-11-08 18:08:44 +01:00
}
}
}
2012-11-29 17:58:24 +01:00
/**
* clear all levels of output buffering
*/
public static function obEnd (){
while ( ob_get_level ()) {
ob_end_clean ();
}
}
2012-11-08 18:08:44 +01:00
2012-10-15 14:25:40 +02:00
/**
2013-01-02 23:02:38 +01:00
* @ brief Generates a cryptographical secure pseudorandom string
* @ param Int with the length of the random string
* @ return String
* Please also update secureRNG_available if you change something here
*/
2012-09-29 16:44:02 +02:00
public static function generate_random_bytes ( $length = 30 ) {
2012-10-14 16:14:45 +02:00
// Try to use openssl_random_pseudo_bytes
2012-10-14 21:04:08 +02:00
if ( function_exists ( 'openssl_random_pseudo_bytes' )) {
2012-09-29 16:44:02 +02:00
$pseudo_byte = bin2hex ( openssl_random_pseudo_bytes ( $length , $strong ));
2012-10-23 08:01:09 +02:00
if ( $strong == true ) {
2012-09-29 16:44:02 +02:00
return substr ( $pseudo_byte , 0 , $length ); // Truncate it to match the length
}
}
2012-10-15 19:21:37 +02:00
// Try to use /dev/urandom
$fp = @ file_get_contents ( '/dev/urandom' , false , null , 0 , $length );
2012-10-23 08:01:09 +02:00
if ( $fp !== false ) {
2012-10-14 21:04:08 +02:00
$string = substr ( bin2hex ( $fp ), 0 , $length );
2012-10-14 16:14:45 +02:00
return $string ;
}
2012-10-14 21:04:08 +02:00
// Fallback to mt_rand()
2012-09-29 16:44:02 +02:00
$characters = '0123456789' ;
2012-10-14 21:04:08 +02:00
$characters .= 'abcdefghijklmnopqrstuvwxyz' ;
2012-09-29 16:44:02 +02:00
$charactersLength = strlen ( $characters ) - 1 ;
$pseudo_byte = " " ;
// Select some random characters
for ( $i = 0 ; $i < $length ; $i ++ ) {
$pseudo_byte .= $characters [ mt_rand ( 0 , $charactersLength )];
2012-10-14 21:04:08 +02:00
}
2012-09-29 16:44:02 +02:00
return $pseudo_byte ;
}
2012-10-14 21:04:08 +02:00
2012-10-15 14:25:40 +02:00
/**
2013-01-02 23:02:38 +01:00
* @ brief Checks if a secure random number generator is available
* @ return bool
*/
2012-10-14 17:17:06 +02:00
public static function secureRNG_available () {
// Check openssl_random_pseudo_bytes
2012-10-14 21:04:08 +02:00
if ( function_exists ( 'openssl_random_pseudo_bytes' )) {
2012-10-14 17:17:06 +02:00
openssl_random_pseudo_bytes ( 1 , $strong );
2012-10-23 08:01:09 +02:00
if ( $strong == true ) {
2012-10-14 17:17:06 +02:00
return true ;
}
}
2012-10-15 19:21:37 +02:00
// Check /dev/urandom
$fp = @ file_get_contents ( '/dev/urandom' , false , null , 0 , 1 );
2012-10-23 08:01:09 +02:00
if ( $fp !== false ) {
2012-10-14 17:17:06 +02:00
return true ;
}
return false ;
2012-10-14 21:04:08 +02:00
}
2013-01-02 23:02:38 +01:00
/**
* @ 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_element is used .
*/
public static function getUrlContent ( $url ){
if ( function_exists ( 'curl_init' )) {
$curl = curl_init ();
curl_setopt ( $curl , CURLOPT_HEADER , 0 );
curl_setopt ( $curl , CURLOPT_RETURNTRANSFER , 1 );
curl_setopt ( $curl , CURLOPT_CONNECTTIMEOUT , 10 );
curl_setopt ( $curl , CURLOPT_URL , $url );
2013-02-04 23:38:10 +01:00
curl_setopt ( $curl , CURLOPT_FOLLOWLOCATION , true );
curl_setopt ( $curl , CURLOPT_MAXREDIRS , 10 );
2013-01-02 23:02:38 +01:00
curl_setopt ( $curl , CURLOPT_USERAGENT , " ownCloud Server Crawler " );
2013-02-09 17:35:47 +01:00
if ( OC_Config :: getValue ( 'proxy' , '' ) <> '' ) {
2013-01-02 23:02:38 +01:00
curl_setopt ( $curl , CURLOPT_PROXY , OC_Config :: getValue ( 'proxy' ));
}
2013-02-09 17:35:47 +01:00
if ( OC_Config :: getValue ( 'proxyuserpwd' , '' ) <> '' ) {
2013-01-02 23:02:38 +01:00
curl_setopt ( $curl , CURLOPT_PROXYUSERPWD , OC_Config :: getValue ( 'proxyuserpwd' ));
}
$data = curl_exec ( $curl );
curl_close ( $curl );
} else {
$contextArray = null ;
2013-02-09 17:35:47 +01:00
if ( OC_Config :: getValue ( 'proxy' , '' ) <> '' ) {
2013-01-02 23:02:38 +01:00
$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 ;
2012-12-14 23:04:42 +01:00
}
2013-01-02 23:02:38 +01:00
2013-02-05 15:43:12 +01:00
/**
* @ return bool - well are we running on windows or not
*/
public static function runningOnWindows () {
return ( substr ( PHP_OS , 0 , 3 ) === " WIN " );
}
2011-07-27 19:07:28 +02:00
}