This commit was manufactured by cvs2svn to create tag
[Packages/TYPO3.CMS.git] / t3lib / class.t3lib_basicfilefunc.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2004 Kasper Skaarhoj (kasper@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 <kasper@typo3.com>
34 */
35 /**
36 * [CLASS/FUNCTION INDEX of SCRIPT]
37 *
38 *
39 *
40 * 80: class t3lib_basicFileFunctions
41 *
42 * SECTION: Checking functions
43 * 132: function init($mounts, $f_ext)
44 * 149: function getTotalFileInfo($wholePath)
45 * 169: function is_allowed($iconkey,$type)
46 * 194: function checkIfFullAccess($theDest)
47 * 208: function is_webpath($path)
48 * 228: function checkIfAllowed($ext, $theDest, $filename='')
49 * 238: function checkFileNameLen($fileName)
50 * 248: function is_directory($theDir)
51 * 265: function isPathValid($theFile)
52 * 280: function getUniqueName($theFile, $theDest, $dontCheckForUnique=0)
53 * 323: function checkPathAgainstMounts($thePath)
54 * 341: function blindPath($thePath)
55 * 357: function findTempFolder()
56 *
57 * SECTION: Cleaning functions
58 * 386: function cleanDirectoryName($theDir)
59 * 396: function rmDoubleSlash($string)
60 * 406: function slashPath($path)
61 * 419: function cleanFileName($fileName)
62 * 430: function formatSize($sizeInBytes)
63 *
64 * TOTAL FUNCTIONS: 18
65 * (This index is automatically created/updated by the extension "extdeveval")
66 *
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 <kasper@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 = 20; // 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 = 30; // 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 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']='php3,php';
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
143 /**
144 * Returns an array with a whole lot of fileinformation.
145 *
146 * @param string Filepath to existing file. Should probably be absolute. Filefunctions are performed on this value.
147 * @return array Information about the file in the filepath
148 */
149 function getTotalFileInfo($wholePath) {
150 $theuser = getmyuid();
151 $info = t3lib_div::split_fileref($wholePath);
152 $info['tstamp']=@filectime($wholePath);
153 $info['size']=@filesize($wholePath);
154 $info['type']=@filetype($wholePath);
155 $info['owner']=@fileowner($wholePath);
156 $info['perms']=@fileperms($wholePath);
157 $info['writeable'] = ($info['perms']&2 || ($theuser==$info['owner'] && $info['perms']&128));
158 $info['readable'] = ($info['perms']&4 || ($theuser==$info['owner'] && $info['perms']&256));
159 return $info;
160 }
161
162 /**
163 * Checks if a $iconkey (fileextension) is allowed according to $this->f_ext.
164 *
165 * @param string The extension to check, eg. "php" or "html" etc.
166 * @param string Either "webspage" or "ftpspace" - points to a key in $this->f_ext
167 * @return boolean True if file extension is allowed.
168 */
169 function is_allowed($iconkey,$type) {
170 if (isset($this->f_ext[$type])) {
171 $ik = strtolower($iconkey);
172 if ($ik) {
173 // If the extension is found amongst the allowed types, we return true immediately
174 if ($this->f_ext[$type]['allow']=='*' || t3lib_div::inList($this->f_ext[$type]['allow'],$ik)) return true;
175 // If the extension is found amongst the denied types, we return false immediately
176 if ($this->f_ext[$type]['deny']=='*' || t3lib_div::inList($this->f_ext[$type]['deny'],$ik)) return false;
177 // If no match we return true
178 return true;
179 } else { // If no extension:
180 if ($this->f_ext[$type]['allow']=='*') return true;
181 if ($this->f_ext[$type]['deny']=='*') return false;
182 return true;
183 }
184 }
185 return false;
186 }
187
188 /**
189 * Returns true if you can operate of ANY file ('*') in the space $theDest is in ('webspace' / 'ftpspace')
190 *
191 * @param string Absolute path
192 * @return boolean
193 */
194 function checkIfFullAccess($theDest) {
195 $type = $this->is_webpath($theDest)?'webspace':'ftpspace';
196 if (isset($this->f_ext[$type])) {
197 if ((string)$this->f_ext[$type]['deny']=='' || $this->f_ext[$type]['allow']=='*') return true;
198 }
199 }
200
201 /**
202 * Checks if $this->webPath (should be TYPO3_DOCUMENT_ROOT) is in the first part of $path
203 * Returns true also if $this->init is not set or if $path is empty...
204 *
205 * @param string Absolute path to check
206 * @return boolean
207 */
208 function is_webpath($path) {
209 if ($this->isInit) {
210 $testPath = $this->slashPath($path);
211 $testPathWeb = $this->slashPath($this->webPath);
212 if ($testPathWeb && $testPath) {
213 return t3lib_div::isFirstPartOfStr($testPath,$testPathWeb);
214 }
215 }
216 return true; // Its more safe to return true (as the webpath is more restricted) if something went wrong...
217 }
218
219 /**
220 * If the filename is given, check it against the TYPO3_CONF_VARS[BE][fileDenyPattern] +
221 * Checks if the $ext fileextension is allowed in the path $theDest (this is based on whether $theDest is below the $this->webPath)
222 *
223 * @param string File extension, eg. "php" or "html"
224 * @param string Absolute path for which to test
225 * @param string Filename to check against TYPO3_CONF_VARS[BE][fileDenyPattern]
226 * @return boolean True if extension/filename is allowed
227 */
228 function checkIfAllowed($ext, $theDest, $filename='') {
229 return t3lib_div::verifyFilenameAgainstDenyPattern($filename) && $this->is_allowed($ext,($this->is_webpath($theDest)?'webspace':'ftpspace'));
230 }
231
232 /**
233 * Returns true if the input filename string is shorter than $this->maxInputNameLen.
234 *
235 * @param string Filename, eg "somefile.html"
236 * @return boolean
237 */
238 function checkFileNameLen($fileName) {
239 return strlen($fileName) <= $this->maxInputNameLen;
240 }
241
242 /**
243 * Cleans $theDir for slashes in the end of the string and returns the new path, if it exists on the server.
244 *
245 * @param string Directory path to check
246 * @return string Returns the cleaned up directory name if OK, otherwise false.
247 */
248 function is_directory($theDir) {
249 if ($this->isPathValid($theDir)) {
250 $theDir=$this->cleanDirectoryName($theDir);
251 if (@is_dir($theDir)) {
252 return $theDir;
253 }
254 }
255 return false;
256 }
257
258 /**
259 * Wrapper for t3lib_div::validPathStr()
260 *
261 * @param string Filepath to evaluate
262 * @return boolean True, if no '//', '..' or '\' is in the $theFile
263 * @see t3lib_div::validPathStr()
264 */
265 function isPathValid($theFile) {
266 return t3lib_div::validPathStr($theFile);
267 }
268
269 /**
270 * Returns the destination path/filename of a unique filename/foldername in that path.
271 * If $theFile exists in $theDest (directory) the file have numbers appended up to $this->maxNumber. Hereafter a unique string will be appended.
272 * This function is used by fx. TCEmain when files are attached to records and needs to be uniquely named in the uploads/* folders
273 *
274 * @param string The input filename to check
275 * @param string The directory for which to return a unique filename for $theFile. $theDest MUST be a valid directory. Should be absolute.
276 * @param boolean If set the filename is returned with the path prepended without checking whether it already existed!
277 * @return string The destination absolute filepath (not just the name!) of a unique filename/foldername in that path.
278 * @see t3lib_TCEmain::checkValue()
279 */
280 function getUniqueName($theFile, $theDest, $dontCheckForUnique=0) {
281 $theDest = $this->is_directory($theDest); // $theDest is cleaned up
282 $origFileInfo = t3lib_div::split_fileref($theFile); // Fetches info about path, name, extention of $theFile
283 if ($theDest) {
284 if ($this->getUniqueNamePrefix) { // Adds prefix
285 $origFileInfo['file'] = $this->getUniqueNamePrefix.$origFileInfo['file'];
286 $origFileInfo['filebody'] = $this->getUniqueNamePrefix.$origFileInfo['filebody'];
287 }
288
289 // Check if the file exists and if not - return the filename...
290 $fileInfo = $origFileInfo;
291 $theDestFile = $theDest.'/'.$fileInfo['file']; // The destinations file
292 if (!@file_exists($theDestFile) || $dontCheckForUnique) { // If the file does NOT exist we return this filename
293 return $theDestFile;
294 }
295
296 // 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...
297 $theTempFileBody = ereg_replace('_[0-9][0-9]$','',$origFileInfo['filebody']); // This removes _xx if appended to the file
298 $theOrigExt = $origFileInfo['realFileext'] ? '.'.$origFileInfo['realFileext'] : '';
299
300 for ($a=1; $a<=($this->maxNumber+1); $a++) {
301 if ($a<=$this->maxNumber) { // First we try to append numbers
302 $insert = '_'.sprintf('%02d', $a);
303 } else { // .. then we try unique-strings...
304 $insert = '_'.substr(md5(uniqId('')),0,$this->uniquePrecision);
305 }
306 $theTestFile = $theTempFileBody.$insert.$theOrigExt;
307 $theDestFile = $theDest.'/'.$theTestFile; // The destinations file
308 if (!@file_exists($theDestFile)) { // If the file does NOT exist we return this filename
309 return $theDestFile;
310 }
311 }
312 }
313 }
314
315 /**
316 * Checks if $thePath is a path under one of the paths in $this->mounts
317 * See comment in the header of this class.
318 *
319 * @param string $thePath MUST HAVE a trailing '/' in order to match correctly with the mounts
320 * @return string The key to the first mount found, otherwise nothing is returned.
321 * @see init()
322 */
323 function checkPathAgainstMounts($thePath) {
324 if ($thePath && $this->isPathValid($thePath) && is_array($this->mounts)) {
325 reset ($this->mounts);
326 while(list($k,$val)=each($this->mounts)) {
327 if (t3lib_div::isFirstPartOfStr($thePath,$val['path'])) {
328 return $k;
329 }
330 }
331 }
332 }
333
334 /**
335 * Removes filemount part of a path, thus blinding the position.
336 * Takes a path, $thePath, and removes the part of the path which equals the filemount.
337 *
338 * @param string $thePath is a path which MUST be found within one of the internally set filemounts, $this->mounts
339 * @return string The processed input path
340 */
341 function blindPath($thePath) {
342 $k=$this->checkPathAgainstMounts($thePath);
343 if ($k) {
344 $name='';
345 $name.='['.$this->mounts[$k]['name'].']: ';
346 $name.=substr($thePath,strlen($this->mounts[$k]['path']));
347 return $name;
348 }
349 }
350
351 /**
352 * Find temporary folder
353 * Finds the first $this->tempFN ('_temp_' usually) -folder in the internal array of filemounts, $this->mounts
354 *
355 * @return string Returns the path if found, otherwise nothing if error.
356 */
357 function findTempFolder() {
358 if ($this->tempFN && is_array($this->mounts)) {
359 reset ($this->mounts);
360 while(list($k,$val)=each($this->mounts)) {
361 $tDir = $val['path'].$this->tempFN;
362 if (@is_dir($tDir)) {
363 return $tDir;
364 }
365 }
366 }
367 }
368
369
370
371
372
373
374 /*********************
375 *
376 * Cleaning functions
377 *
378 *********************/
379
380 /**
381 * Removes all dots, slashes and spaces after a path...
382 *
383 * @param string Input string
384 * @return string Output string
385 */
386 function cleanDirectoryName($theDir) {
387 return ereg_replace('[\/\. ]*$','',$this->rmDoubleSlash($theDir));
388 }
389
390 /**
391 * Converts any double slashes (//) to a single slash (/)
392 *
393 * @param string Input value
394 * @return string Returns the converted string
395 */
396 function rmDoubleSlash($string) {
397 return str_replace('//','/',$string);
398 }
399
400 /**
401 * Returns a string which has a slash '/' appended if it doesn't already have that slash
402 *
403 * @param string Input string
404 * @return string Output string with a slash in the end (if not already there)
405 */
406 function slashPath($path) {
407 if (substr($path,-1)!='/') {
408 return $path.'/';
409 }
410 return $path;
411 }
412
413 /**
414 * Returns a string where any character not matching [.a-zA-Z0-9_-] is substituted by '_'
415 *
416 * @param string Input string, typically the body of a filename
417 * @return string Output string with any characters not matching [.a-zA-Z0-9_-] is substituted by '_'
418 */
419 function cleanFileName($fileName) {
420 $theNewName = ereg_replace('[^.[:alnum:]_-]','_',trim($fileName));
421 return $theNewName;
422 }
423
424 /**
425 * Formats an integer, $sizeInBytes, to Mb or Kb or just bytes
426 *
427 * @param integer Bytes to be formated
428 * @return string Formatted with M,K or &nbsp;&nbsp; appended.
429 */
430 function formatSize($sizeInBytes) {
431 if ($sizeInBytes>900) {
432 if ($sizeInBytes>900000) { // MB
433 $val = $sizeInBytes/(1024*1024);
434 return number_format($val, (($val<20)?1:0), '.', '').' M';
435 } else { // KB
436 $val = $sizeInBytes/(1024);
437 return number_format($val, (($val<20)?1:0), '.', '').' K';
438 }
439 } else { // Bytes
440 return $sizeInBytes.'&nbsp;&nbsp;';
441 }
442 }
443 }
444
445
446
447 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_basicfilefunc.php']) {
448 include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_basicfilefunc.php']);
449 }
450 ?>