Blame view

sources/lib/private/util.php 42.3 KB
31b7f2792   Kload   Upgrade to ownclo...
1
2
3
4
5
6
7
8
9
10
11
12
13
  <?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;
6d9380f96   Cédric Dupont   Update sources OC...
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
  
  	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;
  		}
  	}
31b7f2792   Kload   Upgrade to ownclo...
53
54
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
55
  	 * Can be set up
31b7f2792   Kload   Upgrade to ownclo...
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
  	 * @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
6d9380f96   Cédric Dupont   Update sources OC...
72
  		OC_App::loadApps(array('filesystem'));
31b7f2792   Kload   Upgrade to ownclo...
73
74
75
76
77
78
79
  
  		// 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;
  		}
6d9380f96   Cédric Dupont   Update sources OC...
80
81
82
83
84
85
  		//check if we are using an object storage
  		$objectStore = OC_Config::getValue( 'objectstore' );
  		if ( isset( $objectStore ) ) {
  			self::initObjectStoreRootFS($objectStore);
  		} else {
  			self::initLocalStorageRootFS();
31b7f2792   Kload   Upgrade to ownclo...
86
  		}
a293d369c   Kload   Update sources to...
87
88
89
  		if ($user != '' && !OCP\User::userExists($user)) {
  			return false;
  		}
31b7f2792   Kload   Upgrade to ownclo...
90
91
  		//if we aren't logged in, there is no use to set up the filesystem
  		if( $user != "" ) {
6d9380f96   Cédric Dupont   Update sources OC...
92
  			\OC\Files\Filesystem::addStorageWrapper('oc_quota', function($mountPoint, $storage){
31b7f2792   Kload   Upgrade to ownclo...
93
94
  				// set up quota for home storages, even for other users
  				// which can happen when using sharing
6d9380f96   Cédric Dupont   Update sources OC...
95
96
97
98
99
100
101
102
103
104
105
106
  				/**
  				 * @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 !== \OC\Files\SPACE_UNLIMITED) {
  							return new \OC\Files\Storage\Wrapper\Quota(array('storage' => $storage, 'quota' => $quota, 'root' => 'files'));
  						}
31b7f2792   Kload   Upgrade to ownclo...
107
108
109
110
111
  					}
  				}
  
  				return $storage;
  			});
6d9380f96   Cédric Dupont   Update sources OC...
112
113
114
115
116
117
118
119
  			// copy skeleton for local storage only
  			if ( ! isset( $objectStore ) ) {
  				$userRoot = OC_User::getHome($user);
  				$userDirectory = $userRoot . '/files';
  				if( !is_dir( $userDirectory )) {
  					mkdir( $userDirectory, 0755, true );
  					OC_Util::copySkeleton($userDirectory);
  				}
31b7f2792   Kload   Upgrade to ownclo...
120
  			}
6d9380f96   Cédric Dupont   Update sources OC...
121
122
  
  			$userDir = '/'.$user.'/files';
31b7f2792   Kload   Upgrade to ownclo...
123
124
125
126
127
128
129
130
131
132
  			//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;
  	}
6d9380f96   Cédric Dupont   Update sources OC...
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
  	/**
  	 * 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
  	 */
31b7f2792   Kload   Upgrade to ownclo...
186
  	public static function getUserQuota($user){
6d9380f96   Cédric Dupont   Update sources OC...
187
188
  		$config = \OC::$server->getConfig();
  		$userQuota = $config->getUserValue($user, 'files', 'quota', 'default');
31b7f2792   Kload   Upgrade to ownclo...
189
  		if($userQuota === 'default') {
6d9380f96   Cédric Dupont   Update sources OC...
190
  			$userQuota = $config->getAppValue('files', 'default_quota', 'none');
31b7f2792   Kload   Upgrade to ownclo...
191
192
193
194
195
196
197
198
199
  		}
  		if($userQuota === 'none') {
  			return \OC\Files\SPACE_UNLIMITED;
  		}else{
  			return OC_Helper::computerFileSize($userQuota);
  		}
  	}
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
200
  	 * copies the user skeleton files into the fresh user home files
31b7f2792   Kload   Upgrade to ownclo...
201
202
203
204
205
206
207
  	 * @param string $userDirectory
  	 */
  	public static function copySkeleton($userDirectory) {
  		OC_Util::copyr(\OC::$SERVERROOT.'/core/skeleton' , $userDirectory);
  	}
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
208
  	 * copies a directory recursively
31b7f2792   Kload   Upgrade to ownclo...
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
  	 * @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;
  	}
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
238
  	 * get the current installed version of ownCloud
31b7f2792   Kload   Upgrade to ownclo...
239
240
241
242
243
244
245
246
  	 * @return array
  	 */
  	public static function getVersion() {
  		OC_Util::loadVersion();
  		return \OC::$server->getSession()->get('OC_Version');
  	}
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
247
  	 * get the current installed version string of ownCloud
31b7f2792   Kload   Upgrade to ownclo...
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
  	 * @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);
  		}
  	}
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
308
  	 * add a javascript file
31b7f2792   Kload   Upgrade to ownclo...
309
310
  	 *
  	 * @param string $application
6d9380f96   Cédric Dupont   Update sources OC...
311
  	 * @param string|null $file filename
31b7f2792   Kload   Upgrade to ownclo...
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
  	 * @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";
  		}
  	}
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
327
  	 * add a css file
31b7f2792   Kload   Upgrade to ownclo...
328
329
  	 *
  	 * @param string $application
6d9380f96   Cédric Dupont   Update sources OC...
330
  	 * @param string|null $file filename
31b7f2792   Kload   Upgrade to ownclo...
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
  	 * @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";
  		}
  	}
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
346
  	 * Add a custom element to the header
31b7f2792   Kload   Upgrade to ownclo...
347
348
349
350
351
352
353
354
355
356
357
358
359
360
  	 * @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
  		);
  	}
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
361
  	 * formats a timestamp in the "right" way
31b7f2792   Kload   Upgrade to ownclo...
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
  	 *
  	 * @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);
  	}
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
381
  	 * check if the current server configuration is suitable for ownCloud
31b7f2792   Kload   Upgrade to ownclo...
382
383
384
  	 * @return array arrays with error messages and hints
  	 */
  	public static function checkServer() {
6d9380f96   Cédric Dupont   Update sources OC...
385
  		$l = OC_L10N::get('lib');
837968727   Kload   [enh] Upgrade to ...
386
387
  		$errors = array();
  		$CONFIG_DATADIRECTORY = OC_Config::getValue('datadirectory', OC::$SERVERROOT . '/data');
6d9380f96   Cédric Dupont   Update sources OC...
388
  		if (!self::needUpgrade() && OC_Config::getValue('installed', false)) {
837968727   Kload   [enh] Upgrade to ...
389
390
391
  			// this check needs to be done every time
  			$errors = self::checkDataDirectoryValidity($CONFIG_DATADIRECTORY);
  		}
31b7f2792   Kload   Upgrade to ownclo...
392
  		// Assume that if checkServer() succeeded before in this session, then all is fine.
6d9380f96   Cédric Dupont   Update sources OC...
393
  		if(\OC::$session->exists('checkServer_succeeded') && \OC::$session->get('checkServer_succeeded')) {
837968727   Kload   [enh] Upgrade to ...
394
  			return $errors;
31b7f2792   Kload   Upgrade to ownclo...
395
  		}
31b7f2792   Kload   Upgrade to ownclo...
396
397
398
399
400
401
402
  		$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(
6d9380f96   Cédric Dupont   Update sources OC...
403
  				'error'=> $l->t('No database drivers (sqlite, mysql, or postgresql) installed.'),
31b7f2792   Kload   Upgrade to ownclo...
404
405
406
407
408
409
  				'hint'=>'' //TODO: sane hint
  			);
  			$webServerRestart = true;
  		}
  
  		//common hint for all file permissions error messages
6d9380f96   Cédric Dupont   Update sources OC...
410
411
412
  		$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>'));
31b7f2792   Kload   Upgrade to ownclo...
413
414
  
  		// Check if config folder is writable.
6d9380f96   Cédric Dupont   Update sources OC...
415
  		if(!is_writable(OC::$configDir) or !is_readable(OC::$configDir)) {
31b7f2792   Kload   Upgrade to ownclo...
416
  			$errors[] = array(
6d9380f96   Cédric Dupont   Update sources OC...
417
418
419
420
  				'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>'))
31b7f2792   Kload   Upgrade to ownclo...
421
422
423
424
425
426
427
428
429
  				);
  		}
  
  		// 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(
6d9380f96   Cédric Dupont   Update sources OC...
430
431
432
433
434
  					'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>'))
31b7f2792   Kload   Upgrade to ownclo...
435
436
437
  					);
  			}
  		}
31b7f2792   Kload   Upgrade to ownclo...
438
439
440
441
442
443
444
  		// 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(
6d9380f96   Cédric Dupont   Update sources OC...
445
446
447
448
449
  					'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')))
  					);
31b7f2792   Kload   Upgrade to ownclo...
450
451
452
453
454
455
456
457
458
459
460
461
  			}
  		} 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(
6d9380f96   Cédric Dupont   Update sources OC...
462
463
464
465
  				'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 theses locales on your system and restart your webserver.')
31b7f2792   Kload   Upgrade to ownclo...
466
467
  			);
  		}
6d9380f96   Cédric Dupont   Update sources OC...
468
  		$moduleHint = $l->t('Please ask your server administrator to install the module.');
31b7f2792   Kload   Upgrade to ownclo...
469
470
471
  		// check if all required php modules are present
  		if(!class_exists('ZipArchive')) {
  			$errors[] = array(
6d9380f96   Cédric Dupont   Update sources OC...
472
  				'error'=> $l->t('PHP module %s not installed.', array('zip')),
31b7f2792   Kload   Upgrade to ownclo...
473
474
475
476
477
478
  				'hint'=>$moduleHint
  			);
  			$webServerRestart = true;
  		}
  		if(!class_exists('DOMDocument')) {
  			$errors[] = array(
6d9380f96   Cédric Dupont   Update sources OC...
479
  				'error'=> $l->t('PHP module %s not installed.', array('dom')),
31b7f2792   Kload   Upgrade to ownclo...
480
481
482
483
484
485
  				'hint' => $moduleHint
  			);
  			$webServerRestart =true;
  		}
  		if(!function_exists('xml_parser_create')) {
  			$errors[] = array(
6d9380f96   Cédric Dupont   Update sources OC...
486
  				'error'=> $l->t('PHP module %s not installed.', array('libxml')),
31b7f2792   Kload   Upgrade to ownclo...
487
488
489
490
491
492
493
494
495
496
497
498
499
  				'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(
6d9380f96   Cédric Dupont   Update sources OC...
500
  				'error'=> $l->t('PHP module %s not installed.', array('ctype')),
31b7f2792   Kload   Upgrade to ownclo...
501
502
503
504
505
506
  				'hint'=>$moduleHint
  			);
  			$webServerRestart = true;
  		}
  		if(!function_exists('json_encode')) {
  			$errors[] = array(
6d9380f96   Cédric Dupont   Update sources OC...
507
  				'error'=> $l->t('PHP module %s not installed.', array('JSON')),
31b7f2792   Kload   Upgrade to ownclo...
508
509
510
511
512
513
  				'hint'=>$moduleHint
  			);
  			$webServerRestart = true;
  		}
  		if(!extension_loaded('gd') || !function_exists('gd_info')) {
  			$errors[] = array(
6d9380f96   Cédric Dupont   Update sources OC...
514
  				'error'=> $l->t('PHP module %s not installed.', array('GD')),
31b7f2792   Kload   Upgrade to ownclo...
515
516
517
518
519
520
  				'hint'=>$moduleHint
  			);
  			$webServerRestart = true;
  		}
  		if(!function_exists('gzencode')) {
  			$errors[] = array(
6d9380f96   Cédric Dupont   Update sources OC...
521
  				'error'=> $l->t('PHP module %s not installed.', array('zlib')),
31b7f2792   Kload   Upgrade to ownclo...
522
523
524
525
526
527
  				'hint'=>$moduleHint
  			);
  			$webServerRestart = true;
  		}
  		if(!function_exists('iconv')) {
  			$errors[] = array(
6d9380f96   Cédric Dupont   Update sources OC...
528
  				'error'=> $l->t('PHP module %s not installed.', array('iconv')),
31b7f2792   Kload   Upgrade to ownclo...
529
530
531
532
533
534
  				'hint'=>$moduleHint
  			);
  			$webServerRestart = true;
  		}
  		if(!function_exists('simplexml_load_string')) {
  			$errors[] = array(
6d9380f96   Cédric Dupont   Update sources OC...
535
  				'error'=> $l->t('PHP module %s not installed.', array('SimpleXML')),
31b7f2792   Kload   Upgrade to ownclo...
536
537
538
539
540
541
  				'hint'=>$moduleHint
  			);
  			$webServerRestart = true;
  		}
  		if(version_compare(phpversion(), '5.3.3', '<')) {
  			$errors[] = array(
6d9380f96   Cédric Dupont   Update sources OC...
542
543
544
  				'error'=> $l->t('PHP %s or higher is required.', '5.3.3'),
  				'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.')
31b7f2792   Kload   Upgrade to ownclo...
545
546
547
548
549
  			);
  			$webServerRestart = true;
  		}
  		if(!defined('PDO::ATTR_DRIVER_NAME')) {
  			$errors[] = array(
6d9380f96   Cédric Dupont   Update sources OC...
550
  				'error'=> $l->t('PHP module %s not installed.', array('PDO')),
31b7f2792   Kload   Upgrade to ownclo...
551
552
553
554
555
556
557
558
559
  				'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(
6d9380f96   Cédric Dupont   Update sources OC...
560
561
562
  				'error'=> $l->t('PHP Safe Mode is enabled. ownCloud requires that it is disabled to work properly.'),
  				'hint'=> $l->t('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.')
31b7f2792   Kload   Upgrade to ownclo...
563
564
565
566
567
  			);
  			$webServerRestart = true;
  		}
  		if (get_magic_quotes_gpc() == 1 ) {
  			$errors[] = array(
6d9380f96   Cédric Dupont   Update sources OC...
568
569
570
  				'error'=> $l->t('Magic Quotes is enabled. ownCloud requires that it is disabled to work properly.'),
  				'hint'=> $l->t('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.')
31b7f2792   Kload   Upgrade to ownclo...
571
572
573
  			);
  			$webServerRestart = true;
  		}
6d9380f96   Cédric Dupont   Update sources OC...
574
575
576
577
578
579
  		if (!self::isAnnotationsWorking()) {
  			$errors[] = array(
  				'error'=>'PHP is apparently setup to strip inline doc blocks. This will make several core apps inaccessible.',
  				'hint'=>'This is probably caused by a cache/accelerator such as Zend OPcache or eAccelerator.'
  			);
  		}
31b7f2792   Kload   Upgrade to ownclo...
580
581
582
  
  		if($webServerRestart) {
  			$errors[] = array(
6d9380f96   Cédric Dupont   Update sources OC...
583
584
  				'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.')
31b7f2792   Kload   Upgrade to ownclo...
585
586
  			);
  		}
6d9380f96   Cédric Dupont   Update sources OC...
587
  		$errors = array_merge($errors, self::checkDatabaseVersion());
31b7f2792   Kload   Upgrade to ownclo...
588
  		// Cache the result of this function
6d9380f96   Cédric Dupont   Update sources OC...
589
590
591
592
  		\OC::$session->set('checkServer_succeeded', count($errors) == 0);
  
  		return $errors;
  	}
31b7f2792   Kload   Upgrade to ownclo...
593

6d9380f96   Cédric Dupont   Update sources OC...
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
  	/**
  	 * Check the database version
  	 * @return array errors array
  	 */
  	public static function checkDatabaseVersion() {
  		$l = OC_L10N::get('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')
  				);
  			}
  		}
31b7f2792   Kload   Upgrade to ownclo...
625
626
  		return $errors;
  	}
6d9380f96   Cédric Dupont   Update sources OC...
627

31b7f2792   Kload   Upgrade to ownclo...
628
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
629
  	 * check if there are still some encrypted files stored
31b7f2792   Kload   Upgrade to ownclo...
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
  	 * @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;
  	}
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
  	 * 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/keyfiles.backup';
  			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
31b7f2792   Kload   Upgrade to ownclo...
673
674
675
  	 * @return array arrays with error messages and hints
  	 */
  	public static function checkDataDirectoryPermissions($dataDirectory) {
6d9380f96   Cédric Dupont   Update sources OC...
676
  		$l = OC_L10N::get('lib');
31b7f2792   Kload   Upgrade to ownclo...
677
678
679
680
  		$errors = array();
  		if (self::runningOnWindows()) {
  			//TODO: permissions checks for windows hosts
  		} else {
6d9380f96   Cédric Dupont   Update sources OC...
681
682
  			$permissionsModHint = $l->t('Please change the permissions to 0770 so that the directory'
  				.' cannot be listed by other users.');
31b7f2792   Kload   Upgrade to ownclo...
683
684
  			$perms = substr(decoct(@fileperms($dataDirectory)), -3);
  			if (substr($perms, -1) != '0') {
837968727   Kload   [enh] Upgrade to ...
685
  				chmod($dataDirectory, 0770);
31b7f2792   Kload   Upgrade to ownclo...
686
687
688
689
  				clearstatcache();
  				$perms = substr(decoct(@fileperms($dataDirectory)), -3);
  				if (substr($perms, 2, 1) != '0') {
  					$errors[] = array(
6d9380f96   Cédric Dupont   Update sources OC...
690
  						'error' => $l->t('Data directory (%s) is readable by other users', array($dataDirectory)),
31b7f2792   Kload   Upgrade to ownclo...
691
692
693
694
695
696
697
698
699
  						'hint' => $permissionsModHint
  					);
  				}
  			}
  		}
  		return $errors;
  	}
  
  	/**
837968727   Kload   [enh] Upgrade to ...
700
701
702
703
704
705
706
  	 * 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) {
6d9380f96   Cédric Dupont   Update sources OC...
707
  		$l = OC_L10N::get('lib');
837968727   Kload   [enh] Upgrade to ...
708
709
710
  		$errors = array();
  		if (!file_exists($dataDirectory.'/.ocdata')) {
  			$errors[] = array(
6d9380f96   Cédric Dupont   Update sources OC...
711
712
713
  				'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.')
837968727   Kload   [enh] Upgrade to ...
714
715
716
717
718
719
  			);
  		}
  		return $errors;
  	}
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
720
  	 * @param array $errors
31b7f2792   Kload   Upgrade to ownclo...
721
722
723
  	 */
  	public static function displayLoginPage($errors = array()) {
  		$parameters = array();
6d9380f96   Cédric Dupont   Update sources OC...
724
  		foreach( $errors as $value ) {
31b7f2792   Kload   Upgrade to ownclo...
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
  			$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);
  	}
  
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
746
747
  	 * Check if the app is enabled, redirects to home if not
  	 * @param string $app
31b7f2792   Kload   Upgrade to ownclo...
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
  	 * @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',
a293d369c   Kload   Update sources to...
766
  				array('redirect_url' => OC_Request::requestUri())
31b7f2792   Kload   Upgrade to ownclo...
767
768
769
770
771
772
  			));
  			exit();
  		}
  	}
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
773
  	 * Check if the user is a admin, redirects to home if not
31b7f2792   Kload   Upgrade to ownclo...
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
  	 * @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;
  	}
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
806
807
  	 * Check if the user is a subadmin, redirects to home if not
  	 * @return null|boolean $groups where the current user is subadmin
31b7f2792   Kload   Upgrade to ownclo...
808
809
810
811
812
813
814
815
816
817
818
  	 */
  	public static function checkSubAdminUser() {
  		OC_Util::checkLoggedIn();
  		if(!OC_SubAdmin::isSubAdmin(OC_User::getUser())) {
  			header( 'Location: '.OC_Helper::linkToAbsolute( '', 'index.php' ));
  			exit();
  		}
  		return true;
  	}
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
819
820
821
822
823
  	 * Returns the URL of the default page
  	 * based on the system configuration and
  	 * the apps visible for the current user
  	 *
  	 * @return string URL
31b7f2792   Kload   Upgrade to ownclo...
824
  	 */
6d9380f96   Cédric Dupont   Update sources OC...
825
826
  	public static function getDefaultPageUrl() {
  		$urlGenerator = \OC::$server->getURLGenerator();
31b7f2792   Kload   Upgrade to ownclo...
827
  		if(isset($_REQUEST['redirect_url'])) {
6d9380f96   Cédric Dupont   Update sources OC...
828
  			$location = urldecode($_REQUEST['redirect_url']);
31b7f2792   Kload   Upgrade to ownclo...
829
830
831
  		} else {
  			$defaultPage = OC_Appconfig::getValue('core', 'defaultpage');
  			if ($defaultPage) {
6d9380f96   Cédric Dupont   Update sources OC...
832
  				$location = $urlGenerator->getAbsoluteURL($defaultPage);
31b7f2792   Kload   Upgrade to ownclo...
833
  			} else {
6d9380f96   Cédric Dupont   Update sources OC...
834
835
836
837
838
839
840
841
842
843
844
  				$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 (OC_App::isEnabled($defaultApp)) {
  						$appId = $defaultApp;
  						break;
  					}
  				}
  				$location = $urlGenerator->getAbsoluteURL('/index.php/apps/' . $appId . '/');
31b7f2792   Kload   Upgrade to ownclo...
845
846
  			}
  		}
6d9380f96   Cédric Dupont   Update sources OC...
847
848
849
850
851
852
853
854
855
856
  		return $location;
  	}
  
  	/**
  	 * Redirect to the user default page
  	 * @return void
  	 */
  	public static function redirectToDefaultPage() {
  		$location = self::getDefaultPageUrl();
  		header('Location: '.$location);
31b7f2792   Kload   Upgrade to ownclo...
857
858
859
860
  		exit();
  	}
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
861
  	 * get an id unique for this instance
31b7f2792   Kload   Upgrade to ownclo...
862
863
864
865
866
867
868
869
870
871
872
873
874
  	 * @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;
  	}
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
875
  	 * Static lifespan (in seconds) when a request token expires.
31b7f2792   Kload   Upgrade to ownclo...
876
877
878
879
880
881
882
883
884
885
  	 * @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
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
886
  	 * Register an get/post call. Important to prevent CSRF attacks.
31b7f2792   Kload   Upgrade to ownclo...
887
  	 * @todo Write howto: CSRF protection guide
6d9380f96   Cédric Dupont   Update sources OC...
888
  	 * @return string Generated token.
31b7f2792   Kload   Upgrade to ownclo...
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
  	 * @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);
  	}
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
911
  	 * Check an ajax get/post call if the request token is valid.
31b7f2792   Kload   Upgrade to ownclo...
912
913
914
915
916
917
918
919
920
  	 * @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();
  	}
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
921
  	 * Check an ajax get/post call if the request token is valid. Exit if not.
31b7f2792   Kload   Upgrade to ownclo...
922
923
924
925
926
927
928
929
930
931
  	 * @todo Write howto
  	 * @return void
  	 */
  	public static function callCheck() {
  		if(!OC_Util::isCallRegistered()) {
  			exit();
  		}
  	}
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
932
  	 * Public function to sanitize HTML
31b7f2792   Kload   Upgrade to ownclo...
933
934
935
936
  	 *
  	 * 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.
  	 *
6d9380f96   Cédric Dupont   Update sources OC...
937
938
  	 * @param string|array &$value
  	 * @return string|array an array of sanitized strings or a single sanitized string, depends on the input parameter.
31b7f2792   Kload   Upgrade to ownclo...
939
940
941
942
943
944
  	 */
  	public static function sanitizeHTML( &$value ) {
  		if (is_array($value)) {
  			array_walk_recursive($value, 'OC_Util::sanitizeHTML');
  		} else {
  			//Specify encoding for PHP<5.4
6d9380f96   Cédric Dupont   Update sources OC...
945
  			$value = htmlspecialchars((string)$value, ENT_QUOTES, 'UTF-8');
31b7f2792   Kload   Upgrade to ownclo...
946
947
948
949
950
  		}
  		return $value;
  	}
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
951
  	 * Public function to encode url parameters
31b7f2792   Kload   Upgrade to ownclo...
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
  	 *
  	 * 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;
  	}
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
967
968
  	 * Check if the .htaccess file is working
  	 * @throws OC\HintException If the testfile can't get written.
31b7f2792   Kload   Upgrade to ownclo...
969
  	 * @return bool
6d9380f96   Cédric Dupont   Update sources OC...
970
  	 * @description Check if the .htaccess file is working by creating a test
31b7f2792   Kload   Upgrade to ownclo...
971
972
  	 * file in the data directory and trying to access via http
  	 */
6d9380f96   Cédric Dupont   Update sources OC...
973
  	public static function isHtaccessWorking() {
31b7f2792   Kload   Upgrade to ownclo...
974
975
976
  		if (!\OC_Config::getValue("check_for_working_htaccess", true)) {
  			return true;
  		}
6d9380f96   Cédric Dupont   Update sources OC...
977

31b7f2792   Kload   Upgrade to ownclo...
978
979
980
981
982
983
984
985
986
987
988
989
  		// 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');
6d9380f96   Cédric Dupont   Update sources OC...
990
991
992
993
994
995
  		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);
31b7f2792   Kload   Upgrade to ownclo...
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
  
  		// 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;
  		}
  	}
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
1015
  	 * test if webDAV is working properly
31b7f2792   Kload   Upgrade to ownclo...
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
  	 * @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);
6d9380f96   Cédric Dupont   Update sources OC...
1043
1044
  		// also don't care if the host can't be verified
  		$client->setVerifyHost(0);
31b7f2792   Kload   Upgrade to ownclo...
1045
1046
1047
1048
1049
  
  		$return = true;
  		try {
  			// test PROPFIND
  			$client->propfind('', array('{DAV:}resourcetype'));
6d9380f96   Cédric Dupont   Update sources OC...
1050
  		} catch (\Sabre\DAV\Exception\NotAuthenticated $e) {
31b7f2792   Kload   Upgrade to ownclo...
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
  			$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;
  	}
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
  	 * 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.
31b7f2792   Kload   Upgrade to ownclo...
1092
1093
1094
1095
1096
1097
1098
  	 * @return bool
  	 */
  	public static function fileInfoLoaded() {
  		return function_exists('finfo_open');
  	}
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
1099
  	 * Check if a PHP version older then 5.3.8 is installed.
31b7f2792   Kload   Upgrade to ownclo...
1100
1101
1102
1103
1104
1105
1106
  	 * @return bool
  	 */
  	public static function isPHPoutdated() {
  		return version_compare(phpversion(), '5.3.8', '<');
  	}
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
1107
  	 * Check if the ownCloud server can connect to the internet
31b7f2792   Kload   Upgrade to ownclo...
1108
1109
1110
1111
1112
1113
1114
  	 * @return bool
  	 */
  	public static function isInternetConnectionWorking() {
  		// in case there is no internet connection on purpose return false
  		if (self::isInternetConnectionEnabled() === false) {
  			return false;
  		}
837968727   Kload   [enh] Upgrade to ...
1115
1116
1117
1118
  		// in case the connection is via proxy return true to avoid connecting to owncloud.org
  		if(OC_Config::getValue('proxy', '') != '') {
  			return true;
  		}
31b7f2792   Kload   Upgrade to ownclo...
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
  		// 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;
  			}
  		}
  	}
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
1137
1138
  	 * Check if the connection to the internet is disabled on purpose
  	 * @return string
31b7f2792   Kload   Upgrade to ownclo...
1139
1140
1141
1142
1143
1144
  	 */
  	public static function isInternetConnectionEnabled(){
  		return \OC_Config::getValue("has_internet_connection", true);
  	}
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
1145
  	 * clear all levels of output buffering
31b7f2792   Kload   Upgrade to ownclo...
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
  	 * @return void
  	 */
  	public static function obEnd(){
  		while (ob_get_level()) {
  			ob_end_clean();
  		}
  	}
  
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
1156
1157
1158
  	 * Generates a cryptographic secure pseudo-random string
  	 * @param int $length of the random string
  	 * @return string
31b7f2792   Kload   Upgrade to ownclo...
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
  	 * 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;
  	}
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
1193
  	 * Checks if a secure random number generator is available
31b7f2792   Kload   Upgrade to ownclo...
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
  	 * @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
6d9380f96   Cédric Dupont   Update sources OC...
1219
  	 * @throws Exception If the URL does not start with http:// or https://
31b7f2792   Kload   Upgrade to ownclo...
1220
1221
1222
1223
1224
  	 * @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) {
6d9380f96   Cédric Dupont   Update sources OC...
1225
1226
1227
1228
  		if (strpos($url, 'http://') !== 0 && strpos($url, 'https://') !== 0) {
  			throw new Exception('$url must start with https:// or http://', 1);
  		}
  		
31b7f2792   Kload   Upgrade to ownclo...
1229
1230
  		if (function_exists('curl_init')) {
  			$curl = curl_init();
6d9380f96   Cédric Dupont   Update sources OC...
1231
  			$max_redirects = 10;
31b7f2792   Kload   Upgrade to ownclo...
1232
1233
1234
1235
1236
  
  			curl_setopt($curl, CURLOPT_HEADER, 0);
  			curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
  			curl_setopt($curl, CURLOPT_CONNECTTIMEOUT, 10);
  			curl_setopt($curl, CURLOPT_URL, $url);
6d9380f96   Cédric Dupont   Update sources OC...
1237

31b7f2792   Kload   Upgrade to ownclo...
1238
1239
1240
1241
1242
1243
1244
1245
  
  			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'));
  			}
31b7f2792   Kload   Upgrade to ownclo...
1246

6d9380f96   Cédric Dupont   Update sources OC...
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
  			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:(.*?)
  /', $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);
31b7f2792   Kload   Upgrade to ownclo...
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
  		} 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;
  	}
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
1318
1319
  	 * Checks whether the server is running on Windows
  	 * @return bool true if running on Windows, false otherwise
31b7f2792   Kload   Upgrade to ownclo...
1320
1321
1322
1323
1324
1325
  	 */
  	public static function runningOnWindows() {
  		return (substr(PHP_OS, 0, 3) === "WIN");
  	}
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
1326
1327
1328
1329
1330
1331
1332
1333
  	 * 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');
  	}
  
  	/**
31b7f2792   Kload   Upgrade to ownclo...
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
  	 * 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;
  	}
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
1351
  	 * Clear the opcode cache if one exists
31b7f2792   Kload   Upgrade to ownclo...
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
  	 * 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')) {
a293d369c   Kload   Update sources to...
1367
1368
1369
1370
1371
  			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);
  			}
31b7f2792   Kload   Upgrade to ownclo...
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
  		}
  		// 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;
  	}
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
1398
  	 * @param boolean|string $file
31b7f2792   Kload   Upgrade to ownclo...
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
  	 * @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;
  	}
6d9380f96   Cédric Dupont   Update sources OC...
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
  
  	/**
  	 * 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
  	 */
  	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;
  	}
  
  	/**
  	 * Check whether the instance needs to preform an upgrade
  	 *
  	 * @return bool
  	 */
  	public static function needUpgrade() {
  		if (OC_Config::getValue('installed', false)) {
  			$installedVersion = OC_Config::getValue('version', '0.0.0');
  			$currentVersion = implode('.', OC_Util::getVersion());
  			return version_compare($currentVersion, $installedVersion, '>');
  		} else {
  			return false;
  		}
  	}
31b7f2792   Kload   Upgrade to ownclo...
1455
  }