Blame view

sources/lib/private/helper.php 26.5 KB
03e52840d   Kload   Init
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
  <?php
  /**
   * ownCloud
   *
   * @author Frank Karlitschek
   * @author Jakob Sack
   * @copyright 2012 Frank Karlitschek frank@owncloud.org
   *
   * This library is free software; you can redistribute it and/or
   * modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
   * License as published by the Free Software Foundation; either
   * version 3 of the License, or any later version.
   *
   * This library is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   * GNU AFFERO GENERAL PUBLIC LICENSE for more details.
   *
   * You should have received a copy of the GNU Affero General Public
   * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
   *
   */
  
  /**
   * Collection of useful functions
   */
  class OC_Helper {
31b7f2792   Kload   Upgrade to ownclo...
28
  	private static $tmpFiles = array();
03e52840d   Kload   Init
29
  	private static $mimetypeIcons = array();
31b7f2792   Kload   Upgrade to ownclo...
30
31
  	private static $mimetypeDetector;
  	private static $templateManager;
03e52840d   Kload   Init
32
33
34
35
36
37
38
39
40
41
42
  
  	/**
  	 * @brief Creates an url using a defined route
  	 * @param $route
  	 * @param array $parameters
  	 * @return
  	 * @internal param array $args with param=>value, will be appended to the returned url
  	 * @returns the url
  	 *
  	 * Returns a url to the given app and file.
  	 */
31b7f2792   Kload   Upgrade to ownclo...
43
44
  	public static function linkToRoute($route, $parameters = array()) {
  		return OC::$server->getURLGenerator()->linkToRoute($route, $parameters);
03e52840d   Kload   Init
45
46
47
48
49
50
51
  	}
  
  	/**
  	 * @brief Creates an url
  	 * @param string $app app
  	 * @param string $file file
  	 * @param array $args array with param=>value, will be appended to the returned url
31b7f2792   Kload   Upgrade to ownclo...
52
  	 *    The value of $args will be urlencoded
03e52840d   Kload   Init
53
54
55
56
57
  	 * @return string the url
  	 *
  	 * Returns a url to the given app and file.
  	 */
  	public static function linkTo( $app, $file, $args = array() ) {
31b7f2792   Kload   Upgrade to ownclo...
58
59
  		return OC::$server->getURLGenerator()->linkTo($app, $file, $args);
  	}
03e52840d   Kload   Init
60

31b7f2792   Kload   Upgrade to ownclo...
61
62
63
64
65
66
  	/**
  	 * @param $key
  	 * @return string url to the online documentation
  	 */
  	public static function linkToDocs($key) {
  		$theme = new OC_Defaults();
a293d369c   Kload   Update sources to...
67
  		return $theme->buildDocLinkToKey($key);
03e52840d   Kload   Init
68
69
70
71
72
73
74
  	}
  
  	/**
  	 * @brief Creates an absolute url
  	 * @param string $app app
  	 * @param string $file file
  	 * @param array $args array with param=>value, will be appended to the returned url
31b7f2792   Kload   Upgrade to ownclo...
75
  	 *    The value of $args will be urlencoded
03e52840d   Kload   Init
76
77
78
79
  	 * @return string the url
  	 *
  	 * Returns a absolute url to the given app and file.
  	 */
31b7f2792   Kload   Upgrade to ownclo...
80
81
  	public static function linkToAbsolute($app, $file, $args = array()) {
  		$urlLinkTo = self::linkTo($app, $file, $args);
03e52840d   Kload   Init
82
83
84
85
86
87
88
89
90
91
  		return self::makeURLAbsolute($urlLinkTo);
  	}
  
  	/**
  	 * @brief Makes an $url absolute
  	 * @param string $url the url
  	 * @return string the absolute url
  	 *
  	 * Returns a absolute url to the given app and file.
  	 */
31b7f2792   Kload   Upgrade to ownclo...
92
93
  	public static function makeURLAbsolute($url) {
  		return OC::$server->getURLGenerator()->getAbsoluteURL($url);
03e52840d   Kload   Init
94
95
96
97
98
99
100
101
102
  	}
  
  	/**
  	 * @brief Creates an url for remote use
  	 * @param string $service id
  	 * @return string the url
  	 *
  	 * Returns a url to the given service.
  	 */
31b7f2792   Kload   Upgrade to ownclo...
103
104
  	public static function linkToRemoteBase($service) {
  		return self::linkTo('', 'remote.php') . '/' . $service;
03e52840d   Kload   Init
105
106
107
108
109
110
111
112
113
114
  	}
  
  	/**
  	 * @brief Creates an absolute url for remote use
  	 * @param string $service id
  	 * @param bool $add_slash
  	 * @return string the url
  	 *
  	 * Returns a absolute url to the given service.
  	 */
31b7f2792   Kload   Upgrade to ownclo...
115
  	public static function linkToRemote($service, $add_slash = true) {
03e52840d   Kload   Init
116
  		return self::makeURLAbsolute(self::linkToRemoteBase($service))
31b7f2792   Kload   Upgrade to ownclo...
117
  		. (($add_slash && $service[strlen($service) - 1] != '/') ? '/' : '');
03e52840d   Kload   Init
118
119
120
121
122
123
124
125
126
127
128
  	}
  
  	/**
  	 * @brief Creates an absolute url for public use
  	 * @param string $service id
  	 * @param bool $add_slash
  	 * @return string the url
  	 *
  	 * Returns a absolute url to the given service.
  	 */
  	public static function linkToPublic($service, $add_slash = false) {
31b7f2792   Kload   Upgrade to ownclo...
129
130
  		return self::linkToAbsolute('', 'public.php') . '?service=' . $service
  		. (($add_slash && $service[strlen($service) - 1] != '/') ? '/' : '');
03e52840d   Kload   Init
131
132
133
134
135
136
137
138
139
140
  	}
  
  	/**
  	 * @brief Creates path to an image
  	 * @param string $app app
  	 * @param string $image image name
  	 * @return string the url
  	 *
  	 * Returns the path to the image.
  	 */
31b7f2792   Kload   Upgrade to ownclo...
141
142
  	public static function imagePath($app, $image) {
  		return OC::$server->getURLGenerator()->imagePath($app, $image);
03e52840d   Kload   Init
143
144
145
146
147
148
149
150
151
152
  	}
  
  	/**
  	 * @brief get path to icon of file type
  	 * @param string $mimetype mimetype
  	 * @return string the url
  	 *
  	 * Returns the path to the image of this file type.
  	 */
  	public static function mimetypeIcon($mimetype) {
31b7f2792   Kload   Upgrade to ownclo...
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
  		$alias = array(
  			'application/xml' => 'code/xml',
  			'application/msword' => 'x-office/document',
  			'application/vnd.openxmlformats-officedocument.wordprocessingml.document' => 'x-office/document',
  			'application/vnd.openxmlformats-officedocument.wordprocessingml.template' => 'x-office/document',
  			'application/vnd.ms-word.document.macroEnabled.12' => 'x-office/document',
  			'application/vnd.ms-word.template.macroEnabled.12' => 'x-office/document',
  			'application/vnd.oasis.opendocument.text' => 'x-office/document',
  			'application/vnd.oasis.opendocument.text-template' => 'x-office/document',
  			'application/vnd.oasis.opendocument.text-web' => 'x-office/document',
  			'application/vnd.oasis.opendocument.text-master' => 'x-office/document',
  			'application/vnd.ms-powerpoint' => 'x-office/presentation',
  			'application/vnd.openxmlformats-officedocument.presentationml.presentation' => 'x-office/presentation',
  			'application/vnd.openxmlformats-officedocument.presentationml.template' => 'x-office/presentation',
  			'application/vnd.openxmlformats-officedocument.presentationml.slideshow' => 'x-office/presentation',
  			'application/vnd.ms-powerpoint.addin.macroEnabled.12' => 'x-office/presentation',
  			'application/vnd.ms-powerpoint.presentation.macroEnabled.12' => 'x-office/presentation',
  			'application/vnd.ms-powerpoint.template.macroEnabled.12' => 'x-office/presentation',
  			'application/vnd.ms-powerpoint.slideshow.macroEnabled.12' => 'x-office/presentation',
  			'application/vnd.oasis.opendocument.presentation' => 'x-office/presentation',
  			'application/vnd.oasis.opendocument.presentation-template' => 'x-office/presentation',
  			'application/vnd.ms-excel' => 'x-office/spreadsheet',
  			'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' => 'x-office/spreadsheet',
  			'application/vnd.openxmlformats-officedocument.spreadsheetml.template' => 'x-office/spreadsheet',
  			'application/vnd.ms-excel.sheet.macroEnabled.12' => 'x-office/spreadsheet',
  			'application/vnd.ms-excel.template.macroEnabled.12' => 'x-office/spreadsheet',
  			'application/vnd.ms-excel.addin.macroEnabled.12' => 'x-office/spreadsheet',
  			'application/vnd.ms-excel.sheet.binary.macroEnabled.12' => 'x-office/spreadsheet',
  			'application/vnd.oasis.opendocument.spreadsheet' => 'x-office/spreadsheet',
  			'application/vnd.oasis.opendocument.spreadsheet-template' => 'x-office/spreadsheet',
  		);
03e52840d   Kload   Init
184
185
186
187
188
189
190
191
  		if (isset($alias[$mimetype])) {
  			$mimetype = $alias[$mimetype];
  		}
  		if (isset(self::$mimetypeIcons[$mimetype])) {
  			return self::$mimetypeIcons[$mimetype];
  		}
  		// Replace slash and backslash with a minus
  		$icon = str_replace('/', '-', $mimetype);
31b7f2792   Kload   Upgrade to ownclo...
192
  		$icon = str_replace('\\', '-', $icon);
03e52840d   Kload   Init
193
194
195
  
  		// Is it a dir?
  		if ($mimetype === 'dir') {
31b7f2792   Kload   Upgrade to ownclo...
196
197
198
199
200
201
202
203
204
205
  			self::$mimetypeIcons[$mimetype] = OC::$WEBROOT . '/core/img/filetypes/folder.png';
  			return OC::$WEBROOT . '/core/img/filetypes/folder.png';
  		}
  		if ($mimetype === 'dir-shared') {
  			self::$mimetypeIcons[$mimetype] = OC::$WEBROOT . '/core/img/filetypes/folder-shared.png';
  			return OC::$WEBROOT . '/core/img/filetypes/folder-shared.png';
  		}
  		if ($mimetype === 'dir-external') {
  			self::$mimetypeIcons[$mimetype] = OC::$WEBROOT . '/core/img/filetypes/folder-external.png';
  			return OC::$WEBROOT . '/core/img/filetypes/folder-external.png';
03e52840d   Kload   Init
206
207
208
  		}
  
  		// Icon exists?
31b7f2792   Kload   Upgrade to ownclo...
209
210
211
  		if (file_exists(OC::$SERVERROOT . '/core/img/filetypes/' . $icon . '.png')) {
  			self::$mimetypeIcons[$mimetype] = OC::$WEBROOT . '/core/img/filetypes/' . $icon . '.png';
  			return OC::$WEBROOT . '/core/img/filetypes/' . $icon . '.png';
03e52840d   Kload   Init
212
213
214
215
  		}
  
  		// Try only the first part of the filetype
  		$mimePart = substr($icon, 0, strpos($icon, '-'));
31b7f2792   Kload   Upgrade to ownclo...
216
217
218
  		if (file_exists(OC::$SERVERROOT . '/core/img/filetypes/' . $mimePart . '.png')) {
  			self::$mimetypeIcons[$mimetype] = OC::$WEBROOT . '/core/img/filetypes/' . $mimePart . '.png';
  			return OC::$WEBROOT . '/core/img/filetypes/' . $mimePart . '.png';
03e52840d   Kload   Init
219
  		} else {
31b7f2792   Kload   Upgrade to ownclo...
220
221
  			self::$mimetypeIcons[$mimetype] = OC::$WEBROOT . '/core/img/filetypes/file.png';
  			return OC::$WEBROOT . '/core/img/filetypes/file.png';
03e52840d   Kload   Init
222
223
224
225
  		}
  	}
  
  	/**
31b7f2792   Kload   Upgrade to ownclo...
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
  	 * @brief get path to preview of file
  	 * @param string $path path
  	 * @return string the url
  	 *
  	 * Returns the path to the preview of the file.
  	 */
  	public static function previewIcon($path) {
  		return self::linkToRoute( 'core_ajax_preview', array('x' => 36, 'y' => 36, 'file' => $path ));
  	}
  
  	public static function publicPreviewIcon( $path, $token ) {
  		return self::linkToRoute( 'core_ajax_public_preview', array('x' => 36, 'y' => 36, 'file' => $path, 't' => $token));
  	}
  
  	/**
03e52840d   Kload   Init
241
242
243
244
245
246
  	 * @brief Make a human file size
  	 * @param int $bytes file size in bytes
  	 * @return string a human readable file size
  	 *
  	 * Makes 2048 to 2 kB.
  	 */
31b7f2792   Kload   Upgrade to ownclo...
247
248
249
  	public static function humanFileSize($bytes) {
  		if ($bytes < 0) {
  			return "?";
03e52840d   Kload   Init
250
  		}
31b7f2792   Kload   Upgrade to ownclo...
251
  		if ($bytes < 1024) {
03e52840d   Kload   Init
252
253
  			return "$bytes B";
  		}
31b7f2792   Kload   Upgrade to ownclo...
254
255
  		$bytes = round($bytes / 1024, 1);
  		if ($bytes < 1024) {
03e52840d   Kload   Init
256
257
  			return "$bytes kB";
  		}
31b7f2792   Kload   Upgrade to ownclo...
258
259
  		$bytes = round($bytes / 1024, 1);
  		if ($bytes < 1024) {
03e52840d   Kload   Init
260
261
  			return "$bytes MB";
  		}
31b7f2792   Kload   Upgrade to ownclo...
262
263
264
265
266
267
268
269
  		$bytes = round($bytes / 1024, 1);
  		if ($bytes < 1024) {
  			return "$bytes GB";
  		}
  		$bytes = round($bytes / 1024, 1);
  		if ($bytes < 1024) {
  			return "$bytes TB";
  		}
03e52840d   Kload   Init
270

31b7f2792   Kload   Upgrade to ownclo...
271
272
  		$bytes = round($bytes / 1024, 1);
  		return "$bytes PB";
03e52840d   Kload   Init
273
274
275
276
277
278
279
280
281
282
283
  	}
  
  	/**
  	 * @brief Make a computer file size
  	 * @param string $str file size in a fancy format
  	 * @return int a file size in bytes
  	 *
  	 * Makes 2kB to 2048.
  	 *
  	 * Inspired by: http://www.php.net/manual/en/function.filesize.php#92418
  	 */
31b7f2792   Kload   Upgrade to ownclo...
284
285
  	public static function computerFileSize($str) {
  		$str = strtolower($str);
03e52840d   Kload   Init
286
287
288
289
290
291
  
  		$bytes_array = array(
  			'b' => 1,
  			'k' => 1024,
  			'kb' => 1024,
  			'mb' => 1024 * 1024,
31b7f2792   Kload   Upgrade to ownclo...
292
  			'm' => 1024 * 1024,
03e52840d   Kload   Init
293
  			'gb' => 1024 * 1024 * 1024,
31b7f2792   Kload   Upgrade to ownclo...
294
  			'g' => 1024 * 1024 * 1024,
03e52840d   Kload   Init
295
  			'tb' => 1024 * 1024 * 1024 * 1024,
31b7f2792   Kload   Upgrade to ownclo...
296
  			't' => 1024 * 1024 * 1024 * 1024,
03e52840d   Kload   Init
297
  			'pb' => 1024 * 1024 * 1024 * 1024 * 1024,
31b7f2792   Kload   Upgrade to ownclo...
298
  			'p' => 1024 * 1024 * 1024 * 1024 * 1024,
03e52840d   Kload   Init
299
300
301
302
303
304
305
306
307
308
309
310
311
312
  		);
  
  		$bytes = floatval($str);
  
  		if (preg_match('#([kmgtp]?b?)$#si', $str, $matches) && !empty($bytes_array[$matches[1]])) {
  			$bytes *= $bytes_array[$matches[1]];
  		}
  
  		$bytes = round($bytes, 2);
  
  		return $bytes;
  	}
  
  	/**
03e52840d   Kload   Init
313
314
315
316
317
318
  	 * @brief Recursive copying of folders
  	 * @param string $src source folder
  	 * @param string $dest target folder
  	 *
  	 */
  	static function copyr($src, $dest) {
31b7f2792   Kload   Upgrade to ownclo...
319
320
  		if (is_dir($src)) {
  			if (!is_dir($dest)) {
03e52840d   Kload   Init
321
322
323
324
325
326
327
328
  				mkdir($dest);
  			}
  			$files = scandir($src);
  			foreach ($files as $file) {
  				if ($file != "." && $file != "..") {
  					self::copyr("$src/$file", "$dest/$file");
  				}
  			}
31b7f2792   Kload   Upgrade to ownclo...
329
  		} elseif (file_exists($src) && !\OC\Files\Filesystem::isFileBlacklisted($src)) {
03e52840d   Kload   Init
330
331
332
333
334
335
336
337
338
339
  			copy($src, $dest);
  		}
  	}
  
  	/**
  	 * @brief Recursive deletion of folders
  	 * @param string $dir path to the folder
  	 * @return bool
  	 */
  	static function rmdirr($dir) {
31b7f2792   Kload   Upgrade to ownclo...
340
341
342
  		if (is_dir($dir)) {
  			$files = scandir($dir);
  			foreach ($files as $file) {
03e52840d   Kload   Init
343
344
345
346
347
  				if ($file != "." && $file != "..") {
  					self::rmdirr("$dir/$file");
  				}
  			}
  			rmdir($dir);
31b7f2792   Kload   Upgrade to ownclo...
348
  		} elseif (file_exists($dir)) {
03e52840d   Kload   Init
349
350
  			unlink($dir);
  		}
31b7f2792   Kload   Upgrade to ownclo...
351
  		if (file_exists($dir)) {
03e52840d   Kload   Init
352
  			return false;
31b7f2792   Kload   Upgrade to ownclo...
353
  		} else {
03e52840d   Kload   Init
354
355
356
357
358
  			return true;
  		}
  	}
  
  	/**
31b7f2792   Kload   Upgrade to ownclo...
359
  	 * @return \OC\Files\Type\Detection
03e52840d   Kload   Init
360
  	 */
31b7f2792   Kload   Upgrade to ownclo...
361
362
363
364
  	static public function getMimetypeDetector() {
  		if (!self::$mimetypeDetector) {
  			self::$mimetypeDetector = new \OC\Files\Type\Detection();
  			self::$mimetypeDetector->registerTypeArray(include 'mimetypes.list.php');
03e52840d   Kload   Init
365
  		}
31b7f2792   Kload   Upgrade to ownclo...
366
367
  		return self::$mimetypeDetector;
  	}
03e52840d   Kload   Init
368

31b7f2792   Kload   Upgrade to ownclo...
369
370
371
372
373
374
  	/**
  	 * @return \OC\Files\Type\TemplateManager
  	 */
  	static public function getFileTemplateManager() {
  		if (!self::$templateManager) {
  			self::$templateManager = new \OC\Files\Type\TemplateManager();
03e52840d   Kload   Init
375
  		}
31b7f2792   Kload   Upgrade to ownclo...
376
377
  		return self::$templateManager;
  	}
03e52840d   Kload   Init
378

31b7f2792   Kload   Upgrade to ownclo...
379
380
381
382
383
384
385
386
387
  	/**
  	 * Try to guess the mimetype based on filename
  	 *
  	 * @param string $path
  	 * @return string
  	 */
  	static public function getFileNameMimeType($path) {
  		return self::getMimetypeDetector()->detectPath($path);
  	}
03e52840d   Kload   Init
388

31b7f2792   Kload   Upgrade to ownclo...
389
390
391
392
393
394
395
396
397
  	/**
  	 * get the mimetype form a local file
  	 *
  	 * @param string $path
  	 * @return string
  	 * does NOT work for ownClouds filesystem, use OC_FileSystem::getMimeType instead
  	 */
  	static function getMimeType($path) {
  		return self::getMimetypeDetector()->detect($path);
03e52840d   Kload   Init
398
399
400
  	}
  
  	/**
837968727   Kload   [enh] Upgrade to ...
401
402
403
404
405
406
407
408
409
410
  	 * Get a secure mimetype that won't expose potential XSS.
  	 *
  	 * @param string $mimeType
  	 * @return string
  	 */
  	static function getSecureMimeType($mimeType) {
  		return self::getMimetypeDetector()->getSecureMimeType($mimeType);
  	}
  	
  	/**
03e52840d   Kload   Init
411
  	 * get the mimetype form a data string
31b7f2792   Kload   Upgrade to ownclo...
412
  	 *
03e52840d   Kload   Init
413
414
415
416
  	 * @param string $data
  	 * @return string
  	 */
  	static function getStringMimeType($data) {
31b7f2792   Kload   Upgrade to ownclo...
417
  		return self::getMimetypeDetector()->detectString($data);
03e52840d   Kload   Init
418
419
420
421
422
423
424
425
426
427
428
  	}
  
  	/**
  	 * @brief Checks $_REQUEST contains a var for the $s key. If so, returns the html-escaped value of this var; otherwise returns the default value provided by $d.
  	 * @param string $s name of the var to escape, if set.
  	 * @param string $d default value.
  	 * @return string the print-safe value.
  	 *
  	 */
  
  	//FIXME: should also check for value validation (i.e. the email is an email).
31b7f2792   Kload   Upgrade to ownclo...
429
  	public static function init_var($s, $d = "") {
03e52840d   Kload   Init
430
  		$r = $d;
31b7f2792   Kload   Upgrade to ownclo...
431
  		if (isset($_REQUEST[$s]) && !empty($_REQUEST[$s])) {
03e52840d   Kload   Init
432
433
434
435
436
437
438
439
440
  			$r = OC_Util::sanitizeHTML($_REQUEST[$s]);
  		}
  
  		return $r;
  	}
  
  	/**
  	 * returns "checked"-attribute if request contains selected radio element
  	 * OR if radio element is the default one -- maybe?
31b7f2792   Kload   Upgrade to ownclo...
441
  	 *
03e52840d   Kload   Init
442
443
444
445
446
  	 * @param string $s Name of radio-button element name
  	 * @param string $v Value of current radio-button element
  	 * @param string $d Value of default radio-button element
  	 */
  	public static function init_radio($s, $v, $d) {
31b7f2792   Kload   Upgrade to ownclo...
447
  		if ((isset($_REQUEST[$s]) && $_REQUEST[$s] == $v) || (!isset($_REQUEST[$s]) && $v == $d))
03e52840d   Kload   Init
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
  			print "checked=\"checked\" ";
  	}
  
  	/**
  	 * detect if a given program is found in the search PATH
  	 *
  	 * @param $name
  	 * @param bool $path
  	 * @internal param string $program name
  	 * @internal param string $optional search path, defaults to $PATH
  	 * @return bool    true if executable program found in path
  	 */
  	public static function canExecute($name, $path = false) {
  		// path defaults to PATH from environment if not set
  		if ($path === false) {
  			$path = getenv("PATH");
  		}
  		// check method depends on operating system
  		if (!strncmp(PHP_OS, "WIN", 3)) {
  			// on Windows an appropriate COM or EXE file needs to exist
  			$exts = array(".exe", ".com");
  			$check_fn = "file_exists";
  		} else {
  			// anywhere else we look for an executable file of that name
  			$exts = array("");
  			$check_fn = "is_executable";
  		}
  		// Default check will be done with $path directories :
  		$dirs = explode(PATH_SEPARATOR, $path);
  		// WARNING : We have to check if open_basedir is enabled :
  		$obd = ini_get('open_basedir');
31b7f2792   Kload   Upgrade to ownclo...
479
  		if ($obd != "none") {
03e52840d   Kload   Init
480
  			$obd_values = explode(PATH_SEPARATOR, $obd);
31b7f2792   Kload   Upgrade to ownclo...
481
  			if (count($obd_values) > 0 and $obd_values[0]) {
03e52840d   Kload   Init
482
483
484
485
486
  				// open_basedir is in effect !
  				// We need to check if the program is in one of these dirs :
  				$dirs = $obd_values;
  			}
  		}
31b7f2792   Kload   Upgrade to ownclo...
487
488
489
  		foreach ($dirs as $dir) {
  			foreach ($exts as $ext) {
  				if ($check_fn("$dir/$name" . $ext))
03e52840d   Kload   Init
490
491
492
493
494
495
496
497
  					return true;
  			}
  		}
  		return false;
  	}
  
  	/**
  	 * copy the contents of one stream to another
31b7f2792   Kload   Upgrade to ownclo...
498
  	 *
03e52840d   Kload   Init
499
500
501
502
503
504
505
506
507
508
  	 * @param resource $source
  	 * @param resource $target
  	 * @return array the number of bytes copied and result
  	 */
  	public static function streamCopy($source, $target) {
  		if (!$source or !$target) {
  			return array(0, false);
  		}
  		$result = true;
  		$count = 0;
31b7f2792   Kload   Upgrade to ownclo...
509
510
  		while (!feof($source)) {
  			if (($c = fwrite($target, fread($source, 8192))) === false) {
03e52840d   Kload   Init
511
512
513
514
515
516
517
518
519
520
  				$result = false;
  			} else {
  				$count += $c;
  			}
  		}
  		return array($count, $result);
  	}
  
  	/**
  	 * create a temporary file with an unique filename
31b7f2792   Kload   Upgrade to ownclo...
521
  	 *
03e52840d   Kload   Init
522
523
524
525
526
  	 * @param string $postfix
  	 * @return string
  	 *
  	 * temporary files are automatically cleaned up after the script is finished
  	 */
31b7f2792   Kload   Upgrade to ownclo...
527
528
529
  	public static function tmpFile($postfix = '') {
  		$file = get_temp_dir() . '/' . md5(time() . rand()) . $postfix;
  		$fh = fopen($file, 'w');
03e52840d   Kload   Init
530
  		fclose($fh);
31b7f2792   Kload   Upgrade to ownclo...
531
  		self::$tmpFiles[] = $file;
03e52840d   Kload   Init
532
533
534
535
  		return $file;
  	}
  
  	/**
31b7f2792   Kload   Upgrade to ownclo...
536
537
538
539
  	 * move a file to oc-noclean temp dir
  	 *
  	 * @param string $filename
  	 * @return mixed
03e52840d   Kload   Init
540
541
  	 *
  	 */
31b7f2792   Kload   Upgrade to ownclo...
542
543
544
545
546
  	public static function moveToNoClean($filename = '') {
  		if ($filename == '') {
  			return false;
  		}
  		$tmpDirNoClean = get_temp_dir() . '/oc-noclean/';
03e52840d   Kload   Init
547
548
549
550
551
552
  		if (!file_exists($tmpDirNoClean) || !is_dir($tmpDirNoClean)) {
  			if (file_exists($tmpDirNoClean)) {
  				unlink($tmpDirNoClean);
  			}
  			mkdir($tmpDirNoClean);
  		}
31b7f2792   Kload   Upgrade to ownclo...
553
554
555
556
557
558
  		$newname = $tmpDirNoClean . basename($filename);
  		if (rename($filename, $newname)) {
  			return $newname;
  		} else {
  			return false;
  		}
03e52840d   Kload   Init
559
560
561
562
  	}
  
  	/**
  	 * create a temporary folder with an unique filename
31b7f2792   Kload   Upgrade to ownclo...
563
  	 *
03e52840d   Kload   Init
564
565
566
567
568
  	 * @return string
  	 *
  	 * temporary files are automatically cleaned up after the script is finished
  	 */
  	public static function tmpFolder() {
31b7f2792   Kload   Upgrade to ownclo...
569
  		$path = get_temp_dir() . '/' . md5(time() . rand());
03e52840d   Kload   Init
570
  		mkdir($path);
31b7f2792   Kload   Upgrade to ownclo...
571
572
  		self::$tmpFiles[] = $path;
  		return $path . '/';
03e52840d   Kload   Init
573
574
575
576
577
578
  	}
  
  	/**
  	 * remove all files created by self::tmpFile
  	 */
  	public static function cleanTmp() {
31b7f2792   Kload   Upgrade to ownclo...
579
580
581
582
  		$leftoversFile = get_temp_dir() . '/oc-not-deleted';
  		if (file_exists($leftoversFile)) {
  			$leftovers = file($leftoversFile);
  			foreach ($leftovers as $file) {
03e52840d   Kload   Init
583
584
585
586
  				self::rmdirr($file);
  			}
  			unlink($leftoversFile);
  		}
31b7f2792   Kload   Upgrade to ownclo...
587
588
589
590
591
  		foreach (self::$tmpFiles as $file) {
  			if (file_exists($file)) {
  				if (!self::rmdirr($file)) {
  					file_put_contents($leftoversFile, $file . "
  ", FILE_APPEND);
03e52840d   Kload   Init
592
593
594
595
596
597
  				}
  			}
  		}
  	}
  
  	/**
31b7f2792   Kload   Upgrade to ownclo...
598
  	 * remove all files in PHP /oc-noclean temp dir
03e52840d   Kload   Init
599
600
  	 */
  	public static function cleanTmpNoClean() {
31b7f2792   Kload   Upgrade to ownclo...
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
  		$tmpDirNoCleanName=get_temp_dir() . '/oc-noclean/';
  		if(file_exists($tmpDirNoCleanName) && is_dir($tmpDirNoCleanName)) {
  			$files=scandir($tmpDirNoCleanName);
  			foreach($files as $file) {
  				$fileName = $tmpDirNoCleanName . $file;
  				if (!\OC\Files\Filesystem::isIgnoredDir($file) && filemtime($fileName) + 600 < time()) {
  					unlink($fileName);
  				}
  			}
  			// if oc-noclean is empty delete it
  			$isTmpDirNoCleanEmpty = true;
  			$tmpDirNoClean = opendir($tmpDirNoCleanName);
  			if(is_resource($tmpDirNoClean)) {
  				while (false !== ($file = readdir($tmpDirNoClean))) {
  					if (!\OC\Files\Filesystem::isIgnoredDir($file)) {
  						$isTmpDirNoCleanEmpty = false;
  					}
  				}
  			}
  			if ($isTmpDirNoCleanEmpty) {
  				rmdir($tmpDirNoCleanName);
  			}
03e52840d   Kload   Init
623
624
625
626
  		}
  	}
  
  	/**
31b7f2792   Kload   Upgrade to ownclo...
627
628
629
630
631
632
  	 * Adds a suffix to the name in case the file exists
  	 *
  	 * @param $path
  	 * @param $filename
  	 * @return string
  	 */
03e52840d   Kload   Init
633
  	public static function buildNotExistingFileName($path, $filename) {
31b7f2792   Kload   Upgrade to ownclo...
634
635
636
637
638
639
640
641
642
643
644
645
646
647
  		$view = \OC\Files\Filesystem::getView();
  		return self::buildNotExistingFileNameForView($path, $filename, $view);
  	}
  
  	/**
  	 * Adds a suffix to the name in case the file exists
  	 *
  	 * @param $path
  	 * @param $filename
  	 * @return string
  	 */
  	public static function buildNotExistingFileNameForView($path, $filename, \OC\Files\View $view) {
  		if ($path === '/') {
  			$path = '';
03e52840d   Kload   Init
648
649
650
651
652
653
654
655
656
657
  		}
  		if ($pos = strrpos($filename, '.')) {
  			$name = substr($filename, 0, $pos);
  			$ext = substr($filename, $pos);
  		} else {
  			$name = $filename;
  			$ext = '';
  		}
  
  		$newpath = $path . '/' . $filename;
31b7f2792   Kload   Upgrade to ownclo...
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
  		if ($view->file_exists($newpath)) {
  			if (preg_match_all('/\((\d+)\)/', $name, $matches, PREG_OFFSET_CAPTURE)) {
  				//Replace the last "(number)" with "(number+1)"
  				$last_match = count($matches[0]) - 1;
  				$counter = $matches[1][$last_match][0] + 1;
  				$offset = $matches[0][$last_match][1];
  				$match_length = strlen($matches[0][$last_match][0]);
  			} else {
  				$counter = 2;
  				$offset = false;
  			}
  			do {
  				if ($offset) {
  					//Replace the last "(number)" with "(number+1)"
  					$newname = substr_replace($name, '(' . $counter . ')', $offset, $match_length);
  				} else {
  					$newname = $name . ' (' . $counter . ')';
  				}
  				$newpath = $path . '/' . $newname . $ext;
  				$counter++;
  			} while ($view->file_exists($newpath));
03e52840d   Kload   Init
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
  		}
  
  		return $newpath;
  	}
  
  	/**
  	 * @brief Checks if $sub is a subdirectory of $parent
  	 *
  	 * @param string $sub
  	 * @param string $parent
  	 * @return bool
  	 */
  	public static function issubdirectory($sub, $parent) {
  		if (strpos(realpath($sub), realpath($parent)) === 0) {
  			return true;
  		}
  		return false;
  	}
  
  	/**
31b7f2792   Kload   Upgrade to ownclo...
699
700
701
702
703
704
705
706
707
708
709
  	 * @brief Returns an array with all keys from input lowercased or uppercased. Numbered indices are left as is.
  	 *
  	 * @param array $input The array to work on
  	 * @param int $case Either MB_CASE_UPPER or MB_CASE_LOWER (default)
  	 * @param string $encoding The encoding parameter is the character encoding. Defaults to UTF-8
  	 * @return array
  	 *
  	 * Returns an array with all keys from input lowercased or uppercased. Numbered indices are left as is.
  	 * based on http://www.php.net/manual/en/function.array-change-key-case.php#107715
  	 *
  	 */
03e52840d   Kload   Init
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
  	public static function mb_array_change_key_case($input, $case = MB_CASE_LOWER, $encoding = 'UTF-8') {
  		$case = ($case != MB_CASE_UPPER) ? MB_CASE_LOWER : MB_CASE_UPPER;
  		$ret = array();
  		foreach ($input as $k => $v) {
  			$ret[mb_convert_case($k, $case, $encoding)] = $v;
  		}
  		return $ret;
  	}
  
  	/**
  	 * @brief replaces a copy of string delimited by the start and (optionally) length parameters with the string given in replacement.
  	 *
  	 * @param $string
  	 * @param string $replacement The replacement string.
  	 * @param int $start If start is positive, the replacing will begin at the start'th offset into string. If start is negative, the replacing will begin at the start'th character from the end of string.
  	 * @param int $length Length of the part to be replaced
  	 * @param string $encoding The encoding parameter is the character encoding. Defaults to UTF-8
  	 * @internal param string $input The input string. .Opposite to the PHP build-in function does not accept an array.
  	 * @return string
  	 */
  	public static function mb_substr_replace($string, $replacement, $start, $length = null, $encoding = 'UTF-8') {
  		$start = intval($start);
  		$length = intval($length);
  		$string = mb_substr($string, 0, $start, $encoding) .
  			$replacement .
31b7f2792   Kload   Upgrade to ownclo...
735
  			mb_substr($string, $start + $length, mb_strlen($string, 'UTF-8') - $start, $encoding);
03e52840d   Kload   Init
736
737
738
739
740
  
  		return $string;
  	}
  
  	/**
31b7f2792   Kload   Upgrade to ownclo...
741
742
743
744
745
746
747
748
749
750
  	 * @brief Replace all occurrences of the search string with the replacement string
  	 *
  	 * @param string $search The value being searched for, otherwise known as the needle.
  	 * @param string $replace The replacement
  	 * @param string $subject The string or array being searched and replaced on, otherwise known as the haystack.
  	 * @param string $encoding The encoding parameter is the character encoding. Defaults to UTF-8
  	 * @param int $count If passed, this will be set to the number of replacements performed.
  	 * @return string
  	 *
  	 */
03e52840d   Kload   Init
751
752
753
  	public static function mb_str_replace($search, $replace, $subject, $encoding = 'UTF-8', &$count = null) {
  		$offset = -1;
  		$length = mb_strlen($search, $encoding);
31b7f2792   Kload   Upgrade to ownclo...
754
  		while (($i = mb_strrpos($subject, $search, $offset, $encoding)) !== false) {
03e52840d   Kload   Init
755
756
757
758
759
760
761
762
  			$subject = OC_Helper::mb_substr_replace($subject, $replace, $i, $length);
  			$offset = $i - mb_strlen($subject, $encoding);
  			$count++;
  		}
  		return $subject;
  	}
  
  	/**
31b7f2792   Kload   Upgrade to ownclo...
763
764
765
766
767
768
769
770
771
772
  	 * @brief performs a search in a nested array
  	 * @param array $haystack the array to be searched
  	 * @param string $needle the search string
  	 * @param string $index optional, only search this key name
  	 * @return mixed the key of the matching field, otherwise false
  	 *
  	 * performs a search in a nested array
  	 *
  	 * taken from http://www.php.net/manual/en/function.array-search.php#97645
  	 */
03e52840d   Kload   Init
773
774
775
  	public static function recursiveArraySearch($haystack, $needle, $index = null) {
  		$aIt = new RecursiveArrayIterator($haystack);
  		$it = new RecursiveIteratorIterator($aIt);
31b7f2792   Kload   Upgrade to ownclo...
776
  		while ($it->valid()) {
03e52840d   Kload   Init
777
778
779
780
781
782
783
784
785
786
787
788
789
  			if (((isset($index) AND ($it->key() == $index)) OR (!isset($index))) AND ($it->current() == $needle)) {
  				return $aIt->key();
  			}
  
  			$it->next();
  		}
  
  		return false;
  	}
  
  	/**
  	 * Shortens str to maxlen by replacing characters in the middle with '...', eg.
  	 * ellipsis('a very long string with lots of useless info to make a better example', 14) becomes 'a very ...example'
31b7f2792   Kload   Upgrade to ownclo...
790
  	 *
03e52840d   Kload   Init
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
  	 * @param string $str the string
  	 * @param string $maxlen the maximum length of the result
  	 * @return string with at most maxlen characters
  	 */
  	public static function ellipsis($str, $maxlen) {
  		if (strlen($str) > $maxlen) {
  			$characters = floor($maxlen / 2);
  			return substr($str, 0, $characters) . '...' . substr($str, -1 * $characters);
  		}
  		return $str;
  	}
  
  	/**
  	 * @brief calculates the maximum upload size respecting system settings, free space and user quota
  	 *
  	 * @param $dir the current folder where the user currently operates
  	 * @return number of bytes representing
  	 */
  	public static function maxUploadFilesize($dir) {
  		$upload_max_filesize = OCP\Util::computerFileSize(ini_get('upload_max_filesize'));
  		$post_max_size = OCP\Util::computerFileSize(ini_get('post_max_size'));
03e52840d   Kload   Init
812
  		$freeSpace = \OC\Files\Filesystem::free_space($dir);
31b7f2792   Kload   Upgrade to ownclo...
813
814
815
816
817
818
819
820
821
  		if ((int)$upload_max_filesize === 0 and (int)$post_max_size === 0) {
  			$maxUploadFilesize = \OC\Files\SPACE_UNLIMITED;
  		} elseif ((int)$upload_max_filesize === 0 or (int)$post_max_size === 0) {
  			$maxUploadFilesize = max($upload_max_filesize, $post_max_size); //only the non 0 value counts
  		} else {
  			$maxUploadFilesize = min($upload_max_filesize, $post_max_size);
  		}
  
  		if ($freeSpace !== \OC\Files\SPACE_UNKNOWN) {
03e52840d   Kload   Init
822
823
824
825
826
827
828
829
830
831
  			$freeSpace = max($freeSpace, 0);
  
  			return min($maxUploadFilesize, $freeSpace);
  		} else {
  			return $maxUploadFilesize;
  		}
  	}
  
  	/**
  	 * Checks if a function is available
31b7f2792   Kload   Upgrade to ownclo...
832
  	 *
03e52840d   Kload   Init
833
834
835
836
837
838
839
  	 * @param string $function_name
  	 * @return bool
  	 */
  	public static function is_function_enabled($function_name) {
  		if (!function_exists($function_name)) {
  			return false;
  		}
a293d369c   Kload   Update sources to...
840
841
  		$disabled = explode(',', ini_get('disable_functions'));
  		$disabled = array_map('trim', $disabled);
03e52840d   Kload   Init
842
843
844
  		if (in_array($function_name, $disabled)) {
  			return false;
  		}
a293d369c   Kload   Update sources to...
845
846
  		$disabled = explode(',', ini_get('suhosin.executor.func.blacklist'));
  		$disabled = array_map('trim', $disabled);
03e52840d   Kload   Init
847
848
849
850
851
852
853
854
855
856
857
858
859
  		if (in_array($function_name, $disabled)) {
  			return false;
  		}
  		return true;
  	}
  
  	/**
  	 * Calculate the disc space for the given path
  	 *
  	 * @param string $path
  	 * @return array
  	 */
  	public static function getStorageInfo($path) {
31b7f2792   Kload   Upgrade to ownclo...
860
861
  		// return storage info without adding mount points
  		$rootInfo = \OC\Files\Filesystem::getFileInfo($path, false);
03e52840d   Kload   Init
862
863
864
865
866
867
868
869
870
871
  		$used = $rootInfo['size'];
  		if ($used < 0) {
  			$used = 0;
  		}
  		$free = \OC\Files\Filesystem::free_space($path);
  		if ($free >= 0) {
  			$total = $free + $used;
  		} else {
  			$total = $free; //either unknown or unlimited
  		}
31b7f2792   Kload   Upgrade to ownclo...
872
873
  		if ($total > 0) {
  			// prevent division by zero or error codes (negative values)
03e52840d   Kload   Init
874
875
876
877
878
879
880
881
  			$relative = round(($used / $total) * 10000) / 100;
  		} else {
  			$relative = 0;
  		}
  
  		return array('free' => $free, 'used' => $used, 'total' => $total, 'relative' => $relative);
  	}
  }