Fixed bug #11468: [Bug]: $altUrl parameter has no effect in t3lib_BEfunc::viewOnClick...
[Packages/TYPO3.CMS.git] / t3lib / class.t3lib_basicfilefunc.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2009 Kasper Skaarhoj (kasperYYYY@typo3.com)
6 * All rights reserved
7 *
8 * This script is part of the TYPO3 project. The TYPO3 project is
9 * free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * The GNU General Public License can be found at
15 * http://www.gnu.org/copyleft/gpl.html.
16 * A copy is found in the textfile GPL.txt and important notices to the license
17 * from the author is found in LICENSE.txt distributed with these scripts.
18 *
19 *
20 * This script is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
24 *
25 * This copyright notice MUST APPEAR in all copies of the script!
26 ***************************************************************/
27 /**
28 * Contains class with basic file management functions
29 *
30 * $Id$
31 * Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj
32 *
33 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
34 */
35 /**
36 * [CLASS/FUNCTION INDEX of SCRIPT]
37 *
38 *
39 *
40 * 81: class t3lib_basicFileFunctions
41 *
42 * SECTION: Checking functions
43 * 133: function init($mounts, $f_ext)
44 * 152: function getTotalFileInfo($wholePath)
45 * 172: function is_allowed($iconkey,$type)
46 * 197: function checkIfFullAccess($theDest)
47 * 211: function is_webpath($path)
48 * 231: function checkIfAllowed($ext, $theDest, $filename='')
49 * 241: function checkFileNameLen($fileName)
50 * 251: function is_directory($theDir)
51 * 268: function isPathValid($theFile)
52 * 283: function getUniqueName($theFile, $theDest, $dontCheckForUnique=0)
53 * 326: function checkPathAgainstMounts($thePath)
54 * 342: function findFirstWebFolder()
55 * 362: function blindPath($thePath)
56 * 378: function findTempFolder()
57 *
58 * SECTION: Cleaning functions
59 * 412: function cleanDirectoryName($theDir)
60 * 422: function rmDoubleSlash($string)
61 * 432: function slashPath($path)
62 * 446: function cleanFileName($fileName,$charset='')
63 * 480: function formatSize($sizeInBytes)
64 *
65 * TOTAL FUNCTIONS: 19
66 * (This index is automatically created/updated by the extension "extdeveval")
67 *
68 */
69
70
71
72 /**
73 * Contains functions for management, validation etc of files in TYPO3, using the concepts of web- and ftp-space. Please see the comment for the init() function
74 *
75 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
76 * @package TYPO3
77 * @subpackage t3lib
78 * @see t3lib_basicFileFunctions::init()
79 */
80 class t3lib_basicFileFunctions {
81 var $getUniqueNamePrefix = ''; // Prefix which will be prepended the file when using the getUniqueName-function
82 var $maxNumber = 99; // This number decides the highest allowed appended number used on a filename before we use naming with unique strings
83 var $uniquePrecision = 6; // This number decides how many characters out of a unique MD5-hash that is appended to a filename if getUniqueName is asked to find an available filename.
84 var $maxInputNameLen = 60; // This is the maximum length of names treated by cleanFileName()
85 var $tempFN = '_temp_'; // Temp-foldername. A folder in the root of one of the mounts with this name is regarded a TEMP-folder (used for upload from clipboard)
86
87 // internal
88 var $f_ext = Array(); // See comment in header
89 var $mounts = Array(); // See comment in header
90 var $webPath =''; // Set to DOCUMENT_ROOT.
91 var $isInit = 0; // Set to true after init()/start();
92
93
94
95 /**********************************
96 *
97 * Checking functions
98 *
99 **********************************/
100
101 /**
102 * Constructor
103 * This function should be called to initialise the internal arrays $this->mounts and $this->f_ext
104 *
105 * A typical example of the array $mounts is this:
106 * $mounts[xx][path] = (..a mounted path..)
107 * the 'xx'-keys is just numerical from zero. There are also a [name] and [type] value that just denotes the mountname and type. Not used for athentication here.
108 * $this->mounts is traversed in the function checkPathAgainstMounts($thePath), and it is checked that $thePath is actually below one of the mount-paths
109 * The mountpaths are with a trailing '/'. $thePath must be with a trailing '/' also!
110 * As you can see, $this->mounts is very critical! This is the array that decides where the user will be allowed to copy files!!
111 * Typically the global var $WEBMOUNTS would be passed along as $mounts
112 *
113 * A typical example of the array $f_ext is this:
114 * $f_ext['webspace']['allow']='';
115 * $f_ext['webspace']['deny']= PHP_EXTENSIONS_DEFAULT;
116 * $f_ext['ftpspace']['allow']='*';
117 * $f_ext['ftpspace']['deny']='';
118 * The control of fileextensions goes in two catagories. Webspace and Ftpspace. Webspace is folders accessible from a webbrowser (below TYPO3_DOCUMENT_ROOT) and ftpspace is everything else.
119 * The control is done like this: If an extension matches 'allow' then the check returns true. If not and an extension matches 'deny' then the check return false. If no match at all, returns true.
120 * You list extensions comma-separated. If the value is a '*' every extension is allowed
121 * The list is case-insensitive when used in this class (see init())
122 * Typically TYPO3_CONF_VARS['BE']['fileExtensions'] would be passed along as $f_ext.
123 *
124 * Example:
125 * $basicff->init($GLOBALS['FILEMOUNTS'],$TYPO3_CONF_VARS['BE']['fileExtensions']);
126 *
127 * @param array Contains the paths of the file mounts for the current BE user. Normally $GLOBALS['FILEMOUNTS'] is passed. This variable is set during backend user initialization; $FILEMOUNTS = $BE_USER->returnFilemounts(); (see typo3/init.php)
128 * @param array Array with information about allowed and denied file extensions. Typically passed: $TYPO3_CONF_VARS['BE']['fileExtensions']
129 * @return void
130 * @see typo3/init.php, t3lib_userAuthGroup::returnFilemounts()
131 */
132 function init($mounts, $f_ext) {
133 $this->f_ext['webspace']['allow'] = t3lib_div::uniqueList(strtolower($f_ext['webspace']['allow']));
134 $this->f_ext['webspace']['deny'] = t3lib_div::uniqueList(strtolower($f_ext['webspace']['deny']));
135 $this->f_ext['ftpspace']['allow'] = t3lib_div::uniqueList(strtolower($f_ext['ftpspace']['allow']));
136 $this->f_ext['ftpspace']['deny'] = t3lib_div::uniqueList(strtolower($f_ext['ftpspace']['deny']));
137
138 $this->mounts = $mounts;
139 $this->webPath = t3lib_div::getIndpEnv('TYPO3_DOCUMENT_ROOT');
140 $this->isInit = 1;
141
142 $this->maxInputNameLen = $GLOBALS['TYPO3_CONF_VARS']['SYS']['maxFileNameLength'] ? $GLOBALS['TYPO3_CONF_VARS']['SYS']['maxFileNameLength'] : $this->maxInputNameLen;
143 }
144
145 /**
146 * Returns an array with a whole lot of fileinformation.
147 *
148 * @param string Filepath to existing file. Should probably be absolute. Filefunctions are performed on this value.
149 * @return array Information about the file in the filepath
150 */
151 function getTotalFileInfo($wholePath) {
152 $theuser = getmyuid();
153 $info = t3lib_div::split_fileref($wholePath);
154 $info['tstamp'] = @filemtime($wholePath);
155 $info['size'] = @filesize($wholePath);
156 $info['type'] = @filetype($wholePath);
157 $info['owner'] = @fileowner($wholePath);
158 $info['perms'] = @fileperms($wholePath);
159 $info['writable'] = !@is_writable($wholePath);
160 $info['readable'] = !@is_readable($wholePath);
161 return $info;
162 }
163
164 /**
165 * Checks if a $iconkey (fileextension) is allowed according to $this->f_ext.
166 *
167 * @param string The extension to check, eg. "php" or "html" etc.
168 * @param string Either "webspage" or "ftpspace" - points to a key in $this->f_ext
169 * @return boolean True if file extension is allowed.
170 */
171 function is_allowed($iconkey,$type) {
172 if (isset($this->f_ext[$type])) {
173 $ik = strtolower($iconkey);
174 if ($ik) {
175 // If the extension is found amongst the allowed types, we return true immediately
176 if ($this->f_ext[$type]['allow']=='*' || t3lib_div::inList($this->f_ext[$type]['allow'],$ik)) return true;
177 // If the extension is found amongst the denied types, we return false immediately
178 if ($this->f_ext[$type]['deny']=='*' || t3lib_div::inList($this->f_ext[$type]['deny'],$ik)) return false;
179 // If no match we return true
180 return true;
181 } else { // If no extension:
182 if ($this->f_ext[$type]['allow']=='*') return true;
183 if ($this->f_ext[$type]['deny']=='*') return false;
184 return true;
185 }
186 }
187 return false;
188 }
189
190 /**
191 * Returns true if you can operate of ANY file ('*') in the space $theDest is in ('webspace' / 'ftpspace')
192 *
193 * @param string Absolute path
194 * @return boolean
195 */
196 function checkIfFullAccess($theDest) {
197 $type = $this->is_webpath($theDest)?'webspace':'ftpspace';
198 if (isset($this->f_ext[$type])) {
199 if ((string)$this->f_ext[$type]['deny']=='' || $this->f_ext[$type]['allow']=='*') return true;
200 }
201 }
202
203 /**
204 * Checks if $this->webPath (should be TYPO3_DOCUMENT_ROOT) is in the first part of $path
205 * Returns true also if $this->init is not set or if $path is empty...
206 *
207 * @param string Absolute path to check
208 * @return boolean
209 */
210 function is_webpath($path) {
211 if ($this->isInit) {
212 $testPath = $this->slashPath($path);
213 $testPathWeb = $this->slashPath($this->webPath);
214 if ($testPathWeb && $testPath) {
215 return t3lib_div::isFirstPartOfStr($testPath,$testPathWeb);
216 }
217 }
218 return true; // Its more safe to return true (as the webpath is more restricted) if something went wrong...
219 }
220
221 /**
222 * If the filename is given, check it against the TYPO3_CONF_VARS[BE][fileDenyPattern] +
223 * Checks if the $ext fileextension is allowed in the path $theDest (this is based on whether $theDest is below the $this->webPath)
224 *
225 * @param string File extension, eg. "php" or "html"
226 * @param string Absolute path for which to test
227 * @param string Filename to check against TYPO3_CONF_VARS[BE][fileDenyPattern]
228 * @return boolean True if extension/filename is allowed
229 */
230 function checkIfAllowed($ext, $theDest, $filename='') {
231 return t3lib_div::verifyFilenameAgainstDenyPattern($filename) && $this->is_allowed($ext,($this->is_webpath($theDest)?'webspace':'ftpspace'));
232 }
233
234 /**
235 * Returns true if the input filename string is shorter than $this->maxInputNameLen.
236 *
237 * @param string Filename, eg "somefile.html"
238 * @return boolean
239 */
240 function checkFileNameLen($fileName) {
241 return strlen($fileName) <= $this->maxInputNameLen;
242 }
243
244 /**
245 * Cleans $theDir for slashes in the end of the string and returns the new path, if it exists on the server.
246 *
247 * @param string Directory path to check
248 * @return string Returns the cleaned up directory name if OK, otherwise false.
249 */
250 function is_directory($theDir) {
251 if ($this->isPathValid($theDir)) {
252 $theDir=$this->cleanDirectoryName($theDir);
253 if (@is_dir($theDir)) {
254 return $theDir;
255 }
256 }
257 return false;
258 }
259
260 /**
261 * Wrapper for t3lib_div::validPathStr()
262 *
263 * @param string Filepath to evaluate
264 * @return boolean True, if no '//', '..' or '\' is in the $theFile
265 * @see t3lib_div::validPathStr()
266 */
267 function isPathValid($theFile) {
268 return t3lib_div::validPathStr($theFile);
269 }
270
271 /**
272 * Returns the destination path/filename of a unique filename/foldername in that path.
273 * If $theFile exists in $theDest (directory) the file have numbers appended up to $this->maxNumber. Hereafter a unique string will be appended.
274 * This function is used by fx. TCEmain when files are attached to records and needs to be uniquely named in the uploads/* folders
275 *
276 * @param string The input filename to check
277 * @param string The directory for which to return a unique filename for $theFile. $theDest MUST be a valid directory. Should be absolute.
278 * @param boolean If set the filename is returned with the path prepended without checking whether it already existed!
279 * @return string The destination absolute filepath (not just the name!) of a unique filename/foldername in that path.
280 * @see t3lib_TCEmain::checkValue()
281 */
282 function getUniqueName($theFile, $theDest, $dontCheckForUnique=0) {
283 $theDest = $this->is_directory($theDest); // $theDest is cleaned up
284 $origFileInfo = t3lib_div::split_fileref($theFile); // Fetches info about path, name, extention of $theFile
285 if ($theDest) {
286 if ($this->getUniqueNamePrefix) { // Adds prefix
287 $origFileInfo['file'] = $this->getUniqueNamePrefix.$origFileInfo['file'];
288 $origFileInfo['filebody'] = $this->getUniqueNamePrefix.$origFileInfo['filebody'];
289 }
290
291 // Check if the file exists and if not - return the filename...
292 $fileInfo = $origFileInfo;
293 $theDestFile = $theDest.'/'.$fileInfo['file']; // The destinations file
294 if (!file_exists($theDestFile) || $dontCheckForUnique) { // If the file does NOT exist we return this filename
295 return $theDestFile;
296 }
297
298 // Well the filename in its pure form existed. Now we try to append numbers / unique-strings and see if we can find an available filename...
299 $theTempFileBody = preg_replace('/_[0-9][0-9]$/','',$origFileInfo['filebody']); // This removes _xx if appended to the file
300 $theOrigExt = $origFileInfo['realFileext'] ? '.'.$origFileInfo['realFileext'] : '';
301
302 for ($a=1; $a<=($this->maxNumber+1); $a++) {
303 if ($a<=$this->maxNumber) { // First we try to append numbers
304 $insert = '_'.sprintf('%02d', $a);
305 } else { // .. then we try unique-strings...
306 $insert = '_'.substr(md5(uniqId('')),0,$this->uniquePrecision);
307 }
308 $theTestFile = $theTempFileBody.$insert.$theOrigExt;
309 $theDestFile = $theDest.'/'.$theTestFile; // The destinations file
310 if (!file_exists($theDestFile)) { // If the file does NOT exist we return this filename
311 return $theDestFile;
312 }
313 }
314 }
315 }
316
317 /**
318 * Checks if $thePath is a path under one of the paths in $this->mounts
319 * See comment in the header of this class.
320 *
321 * @param string $thePath MUST HAVE a trailing '/' in order to match correctly with the mounts
322 * @return string The key to the first mount found, otherwise nothing is returned.
323 * @see init()
324 */
325 function checkPathAgainstMounts($thePath) {
326 if ($thePath && $this->isPathValid($thePath) && is_array($this->mounts)) {
327 reset ($this->mounts);
328 while(list($k,$val)=each($this->mounts)) {
329 if (t3lib_div::isFirstPartOfStr($thePath,$val['path'])) {
330 return $k;
331 }
332 }
333 }
334 }
335
336 /**
337 * Find first web folder (relative to PATH_site.'fileadmin') in filemounts array
338 *
339 * @return string The key to the first mount inside PATH_site."fileadmin" found, otherwise nothing is returned.
340 */
341 function findFirstWebFolder() {
342 global $TYPO3_CONF_VARS;
343
344 if (is_array($this->mounts)) {
345 reset ($this->mounts);
346 while(list($k,$val)=each($this->mounts)) {
347 if (t3lib_div::isFirstPartOfStr($val['path'], PATH_site.$TYPO3_CONF_VARS['BE']['fileadminDir'])) {
348 return $k;
349 }
350 }
351 }
352 }
353
354 /**
355 * Removes filemount part of a path, thus blinding the position.
356 * Takes a path, $thePath, and removes the part of the path which equals the filemount.
357 *
358 * @param string $thePath is a path which MUST be found within one of the internally set filemounts, $this->mounts
359 * @return string The processed input path
360 */
361 function blindPath($thePath) {
362 $k=$this->checkPathAgainstMounts($thePath);
363 if ($k) {
364 $name='';
365 $name.='['.$this->mounts[$k]['name'].']: ';
366 $name.=substr($thePath,strlen($this->mounts[$k]['path']));
367 return $name;
368 }
369 }
370
371 /**
372 * Find temporary folder
373 * Finds the first $this->tempFN ('_temp_' usually) -folder in the internal array of filemounts, $this->mounts
374 *
375 * @return string Returns the path if found, otherwise nothing if error.
376 */
377 function findTempFolder() {
378 if ($this->tempFN && is_array($this->mounts)) {
379 reset ($this->mounts);
380 while(list($k,$val)=each($this->mounts)) {
381 $tDir = $val['path'].$this->tempFN;
382 if (@is_dir($tDir)) {
383 return $tDir;
384 }
385 }
386 }
387 }
388
389
390
391
392
393
394
395
396
397
398
399 /*********************
400 *
401 * Cleaning functions
402 *
403 *********************/
404
405 /**
406 * Removes all dots, slashes and spaces after a path...
407 *
408 * @param string Input string
409 * @return string Output string
410 */
411 function cleanDirectoryName($theDir) {
412 return preg_replace('/[\/\. ]*$/','',$this->rmDoubleSlash($theDir));
413 }
414
415 /**
416 * Converts any double slashes (//) to a single slash (/)
417 *
418 * @param string Input value
419 * @return string Returns the converted string
420 */
421 function rmDoubleSlash($string) {
422 return str_replace('//','/',$string);
423 }
424
425 /**
426 * Returns a string which has a slash '/' appended if it doesn't already have that slash
427 *
428 * @param string Input string
429 * @return string Output string with a slash in the end (if not already there)
430 */
431 function slashPath($path) {
432 if (substr($path,-1)!='/') {
433 return $path.'/';
434 }
435 return $path;
436 }
437
438 /**
439 * Returns a string where any character not matching [.a-zA-Z0-9_-] is substituted by '_'
440 * Trailing dots are removed
441 *
442 * @param string Input string, typically the body of a filename
443 * @param string Charset of the a filename (defaults to current charset; depending on context)
444 * @return string Output string with any characters not matching [.a-zA-Z0-9_-] is substituted by '_' and trailing dots removed
445 */
446 function cleanFileName($fileName, $charset = '') {
447 // Handle UTF-8 characters
448 if ($GLOBALS['TYPO3_CONF_VARS']['BE']['forceCharset'] == 'utf-8' && $GLOBALS['TYPO3_CONF_VARS']['SYS']['UTF8filesystem']) {
449 // allow ".", "-", 0-9, a-z, A-Z and everything beyond U+C0 (latin capital letter a with grave)
450 $cleanFileName = preg_replace('/[\x00-\x2C\/\x3A-\x3F\x5B-\x60\x7B-\xBF]/u', '_', trim($fileName));
451
452 // Handle other character sets
453 } else {
454 // Get conversion object or initialize if needed
455 if (!is_object($this->csConvObj)) {
456 if (TYPO3_MODE=='FE') {
457 $this->csConvObj = $GLOBALS['TSFE']->csConvObj;
458 } elseif (is_object($GLOBALS['LANG'])) { // BE assumed:
459 $this->csConvObj = $GLOBALS['LANG']->csConvObj;
460 } else { // The object may not exist yet, so we need to create it now. Happens in the Install Tool for example.
461 $this->csConvObj = t3lib_div::makeInstance('t3lib_cs');
462 }
463 }
464
465 // Define character set
466 if (!$charset) {
467 if (TYPO3_MODE == 'FE') {
468 $charset = $GLOBALS['TSFE']->renderCharset;
469 } elseif (is_object($GLOBALS['LANG'])) { // BE assumed:
470 $charset = $GLOBALS['LANG']->charSet;
471 } else { // best guess
472 $charset = $GLOBALS['TYPO3_CONF_VARS']['BE']['forceCharset'];
473 }
474 }
475
476 // If a charset was found, convert filename
477 if ($charset) {
478 $fileName = $this->csConvObj->specCharsToASCII($charset, $fileName);
479 }
480
481 // Replace unwanted characters by underscores
482 $cleanFileName = preg_replace('/[^.[:alnum:]_-]/', '_', trim($fileName));
483 }
484 // Strip trailing dots and return
485 return preg_replace('/\.*$/', '', $cleanFileName);
486 }
487
488 /**
489 * Formats an integer, $sizeInBytes, to Mb or Kb or just bytes
490 *
491 * @param integer Bytes to be formated
492 * @return string Formatted with M,K or &nbsp;&nbsp; appended.
493 * @deprecated since at least TYPO3 4.2 - Use t3lib_div::formatSize() instead
494 */
495 function formatSize($sizeInBytes) {
496 t3lib_div::logDeprecatedFunction();
497
498 if ($sizeInBytes>900) {
499 if ($sizeInBytes>900000) { // MB
500 $val = $sizeInBytes/(1024*1024);
501 return number_format($val, (($val<20)?1:0), '.', '').' M';
502 } else { // KB
503 $val = $sizeInBytes/(1024);
504 return number_format($val, (($val<20)?1:0), '.', '').' K';
505 }
506 } else { // Bytes
507 return $sizeInBytes.'&nbsp;&nbsp;';
508 }
509 }
510 }
511
512
513
514 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_basicfilefunc.php']) {
515 include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_basicfilefunc.php']);
516 }
517
518 ?>