t3lib_basicFileFunctions Class Reference

Inherited by t3lib_extFileFunctions.

List of all members.

Public Member Functions
	init ($mounts, $f_ext)
	Constructor This function should be called to initialise the internal arrays $this->mounts and $this->f_ext.
	getTotalFileInfo ($wholePath)
	Returns an array with a whole lot of fileinformation.
	is_allowed ($iconkey, $type)
	Checks if a $iconkey (fileextension) is allowed according to $this->f_ext.
	checkIfFullAccess ($theDest)
	Returns true if you can operate of ANY file ('*') in the space $theDest is in ('webspace' / 'ftpspace').
	is_webpath ($path)
	Checks if $this->webPath (should be TYPO3_DOCUMENT_ROOT) is in the first part of $path Returns true also if $this->init is not set or if $path is empty...
	checkIfAllowed ($ext, $theDest, $filename='')
	If the filename is given, check it against the TYPO3_CONF_VARS[BE][fileDenyPattern] + Checks if the $ext fileextension is allowed in the path $theDest (this is based on whether $theDest is below the $this->webPath).
	checkFileNameLen ($fileName)
	Returns true if the input filename string is shorter than $this->maxInputNameLen.
	is_directory ($theDir)
	Cleans $theDir for slashes in the end of the string and returns the new path, if it exists on the server.
	isPathValid ($theFile)
	Wrapper for t3lib_div::validPathStr().
	getUniqueName ($theFile, $theDest, $dontCheckForUnique=0)
	Returns the destination path/filename of a unique filename/foldername in that path.
	checkPathAgainstMounts ($thePath)
	Checks if $thePath is a path under one of the paths in $this->mounts See comment in the header of this class.
	blindPath ($thePath)
	Removes filemount part of a path, thus blinding the position.
	findTempFolder ()
	Find temporary folder Finds the first $this->tempFN ('_temp_' usually) -folder in the internal array of filemounts, $this->mounts.
	cleanDirectoryName ($theDir)
	Removes all dots, slashes and spaces after a path...
	rmDoubleSlash ($string)
	Converts any double slashes (//) to a single slash (/).
	slashPath ($path)
	Returns a string which has a slash '/' appended if it doesn't already have that slash.
	cleanFileName ($fileName)
	Returns a string where any character not matching [.a-zA-Z0-9_-] is substituted by '_'.
	formatSize ($sizeInBytes)
	Formats an integer, $sizeInBytes, to Mb or Kb or just bytes.
Public Attributes
	$getUniqueNamePrefix = ''
	$maxNumber = 20
	$uniquePrecision = 6
	$maxInputNameLen = 30
	$tempFN = '_temp_'
	$f_ext = Array()
	$mounts = Array()
	$webPath = ''
	$isInit = 0

---

Member Function Documentation

t3lib_basicFileFunctions::blindPath (  $  thePath  )

Removes filemount part of a path, thus blinding the position. Takes a path, $thePath, and removes the part of the path which equals the filemount. Parameters: string  $thePath is a path which MUST be found within one of the internally set filemounts, $this->mounts Returns: string The processed input path Definition at line 341 of file class.t3lib_basicfilefunc.php. References checkPathAgainstMounts(). { $k=$this->checkPathAgainstMounts($thePath); if ($k) { $name=''; $name.='['.$this->mounts[$k]['name'].']: '; $name.=substr($thePath,strlen($this->mounts[$k]['path'])); return $name; } }

t3lib_basicFileFunctions::checkFileNameLen (  $  fileName  )

Returns true if the input filename string is shorter than $this->maxInputNameLen. Parameters: string  Filename, eg "somefile.html" Returns: boolean Definition at line 238 of file class.t3lib_basicfilefunc.php. Referenced by t3lib_extFileFunctions::func_newfile(), t3lib_extFileFunctions::func_newfolder(), and t3lib_extFileFunctions::func_rename(). { return strlen($fileName) <= $this->maxInputNameLen; }

t3lib_basicFileFunctions::checkIfAllowed (  $  ext, $  theDest, $  filename = '' )

If the filename is given, check it against the TYPO3_CONF_VARS[BE][fileDenyPattern] + Checks if the $ext fileextension is allowed in the path $theDest (this is based on whether $theDest is below the $this->webPath). Parameters: string  File extension, eg. "php" or "html" string  Absolute path for which to test string  Filename to check against TYPO3_CONF_VARS[BE][fileDenyPattern] Returns: boolean True if extension/filename is allowed Definition at line 228 of file class.t3lib_basicfilefunc.php. References is_allowed(). Referenced by t3lib_extFileFunctions::func_copy(), t3lib_extFileFunctions::func_edit(), t3lib_extFileFunctions::func_move(), t3lib_extFileFunctions::func_newfile(), t3lib_extFileFunctions::func_rename(), and t3lib_extFileFunctions::func_upload(). { return t3lib_div::verifyFilenameAgainstDenyPattern($filename) && $this->is_allowed($ext,($this->is_webpath($theDest)?'webspace':'ftpspace')); }

t3lib_basicFileFunctions::checkIfFullAccess (  $  theDest  )

Returns true if you can operate of ANY file ('*') in the space $theDest is in ('webspace' / 'ftpspace'). Parameters: string  Absolute path Returns: boolean Definition at line 194 of file class.t3lib_basicfilefunc.php. References is_webpath(). Referenced by t3lib_extFileFunctions::func_copy(), t3lib_extFileFunctions::func_move(), and t3lib_extFileFunctions::func_unzip(). { $type = $this->is_webpath($theDest)?'webspace':'ftpspace'; if (isset($this->f_ext[$type])) { if ((string)$this->f_ext[$type]['deny']=='' || $this->f_ext[$type]['allow']=='*') return true; } }

t3lib_basicFileFunctions::checkPathAgainstMounts (  $  thePath  )

Checks if $thePath is a path under one of the paths in $this->mounts See comment in the header of this class. Parameters: string  $thePath MUST HAVE a trailing '/' in order to match correctly with the mounts Returns: string The key to the first mount found, otherwise nothing is returned. See also: init() Definition at line 323 of file class.t3lib_basicfilefunc.php. References isPathValid(). Referenced by blindPath(), t3lib_extFileFunctions::findRecycler(), t3lib_extFileFunctions::func_copy(), t3lib_extFileFunctions::func_delete(), t3lib_extFileFunctions::func_edit(), t3lib_extFileFunctions::func_move(), t3lib_extFileFunctions::func_newfile(), t3lib_extFileFunctions::func_newfolder(), t3lib_extFileFunctions::func_rename(), t3lib_extFileFunctions::func_unzip(), and t3lib_extFileFunctions::func_upload(). { if ($thePath && $this->isPathValid($thePath) && is_array($this->mounts)) { reset ($this->mounts); while(list($k,$val)=each($this->mounts)) { if (t3lib_div::isFirstPartOfStr($thePath,$val['path'])) { return $k; } } } }

t3lib_basicFileFunctions::cleanDirectoryName (  $  theDir  )

Removes all dots, slashes and spaces after a path... Parameters: string  Input string Returns: string Output string Definition at line 386 of file class.t3lib_basicfilefunc.php. Referenced by t3lib_extFileFunctions::findRecycler(), and is_directory(). { return ereg_replace('[\/\. ]*$','',$this->rmDoubleSlash($theDir)); }

t3lib_basicFileFunctions::cleanFileName (  $  fileName  )

Returns a string where any character not matching [.a-zA-Z0-9_-] is substituted by '_'. Parameters: string  Input string, typically the body of a filename Returns: string Output string with any characters not matching [.a-zA-Z0-9_-] is substituted by '_' Definition at line 419 of file class.t3lib_basicfilefunc.php. Referenced by t3lib_extFileFunctions::func_newfile(), t3lib_extFileFunctions::func_newfolder(), t3lib_extFileFunctions::func_rename(), and t3lib_extFileFunctions::func_upload(). { $theNewName = ereg_replace('[^.[:alnum:]_-]','_',trim($fileName)); return $theNewName; }

t3lib_basicFileFunctions::findTempFolder (   )

Find temporary folder Finds the first $this->tempFN ('_temp_' usually) -folder in the internal array of filemounts, $this->mounts. Returns: string Returns the path if found, otherwise nothing if error. Definition at line 357 of file class.t3lib_basicfilefunc.php. References $val. { if ($this->tempFN && is_array($this->mounts)) { reset ($this->mounts); while(list($k,$val)=each($this->mounts)) { $tDir = $val['path'].$this->tempFN; if (@is_dir($tDir)) { return $tDir; } } } }

t3lib_basicFileFunctions::formatSize (  $  sizeInBytes  )

Formats an integer, $sizeInBytes, to Mb or Kb or just bytes. Parameters: integer  Bytes to be formated Returns: string Formatted with M,K or    appended. Definition at line 430 of file class.t3lib_basicfilefunc.php. References $val. { if ($sizeInBytes>900) { if ($sizeInBytes>900000) { // MB $val = $sizeInBytes/(1024*1024); return number_format($val, (($val<20)?1:0), '.', '').' M'; } else { // KB $val = $sizeInBytes/(1024); return number_format($val, (($val<20)?1:0), '.', '').' K'; } } else { // Bytes return $sizeInBytes.'&nbsp;&nbsp;'; } }

t3lib_basicFileFunctions::getTotalFileInfo (  $  wholePath  )

Returns an array with a whole lot of fileinformation. Parameters: string  Filepath to existing file. Should probably be absolute. Filefunctions are performed on this value. Returns: array Information about the file in the filepath Definition at line 149 of file class.t3lib_basicfilefunc.php. { $theuser = getmyuid(); $info = t3lib_div::split_fileref($wholePath); $info['tstamp'] = @filectime($wholePath); $info['size'] = @filesize($wholePath); $info['type'] = @filetype($wholePath); $info['owner'] = @fileowner($wholePath); $info['perms'] = @fileperms($wholePath); $info['writeable'] = ($info['perms']&2 || ($theuser==$info['owner'] && $info['perms']&128)); $info['readable'] = ($info['perms']&4 || ($theuser==$info['owner'] && $info['perms']&256)); return $info; }

t3lib_basicFileFunctions::getUniqueName (  $  theFile, $  theDest, $  dontCheckForUnique = 0 )

Returns the destination path/filename of a unique filename/foldername in that path. If $theFile exists in $theDest (directory) the file have numbers appended up to $this->maxNumber. Hereafter a unique string will be appended. This function is used by fx. TCEmain when files are attached to records and needs to be uniquely named in the uploads/* folders Parameters: string  The input filename to check string  The directory for which to return a unique filename for $theFile. $theDest MUST be a valid directory. Should be absolute. boolean  If set the filename is returned with the path prepended without checking whether it already existed! Returns: string The destination absolute filepath (not just the name!) of a unique filename/foldername in that path. See also: t3lib_TCEmain::checkValue() Definition at line 280 of file class.t3lib_basicfilefunc.php. References $a, and is_directory(). Referenced by t3lib_extFileFunctions::func_copy(), t3lib_extFileFunctions::func_move(), and t3lib_extFileFunctions::func_upload(). { $theDest = $this->is_directory($theDest); // $theDest is cleaned up $origFileInfo = t3lib_div::split_fileref($theFile); // Fetches info about path, name, extention of $theFile if ($theDest) { if ($this->getUniqueNamePrefix) { // Adds prefix $origFileInfo['file'] = $this->getUniqueNamePrefix.$origFileInfo['file']; $origFileInfo['filebody'] = $this->getUniqueNamePrefix.$origFileInfo['filebody']; } // Check if the file exists and if not - return the filename... $fileInfo = $origFileInfo; $theDestFile = $theDest.'/'.$fileInfo['file']; // The destinations file if (!@file_exists($theDestFile) || $dontCheckForUnique) { // If the file does NOT exist we return this filename return $theDestFile; } // 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... $theTempFileBody = ereg_replace('_[0-9][0-9]$','',$origFileInfo['filebody']); // This removes _xx if appended to the file $theOrigExt = $origFileInfo['realFileext'] ? '.'.$origFileInfo['realFileext'] : ''; for ($a=1; $a<=($this->maxNumber+1); $a++) { if ($a<=$this->maxNumber) { // First we try to append numbers $insert = '_'.sprintf('%02d', $a); } else { // .. then we try unique-strings... $insert = '_'.substr(md5(uniqId('')),0,$this->uniquePrecision); } $theTestFile = $theTempFileBody.$insert.$theOrigExt; $theDestFile = $theDest.'/'.$theTestFile; // The destinations file if (!@file_exists($theDestFile)) { // If the file does NOT exist we return this filename return $theDestFile; } } } }

t3lib_basicFileFunctions::init (  $  mounts, $  f_ext )

Constructor This function should be called to initialise the internal arrays $this->mounts and $this->f_ext. A typical example of the array $mounts is this: $mounts[xx][path] = (..a mounted path..) 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. $this->mounts is traversed in the function checkPathAgainstMounts($thePath), and it is checked that $thePath is actually below one of the mount-paths The mountpaths are with a trailing '/'. $thePath must be with a trailing '/' also! As you can see, $this->mounts is very critical! This is the array that decides where the user will be allowed to copy files!! Typically the global var $WEBMOUNTS would be passed along as $mounts A typical example of the array $f_ext is this: $f_ext['webspace']['allow']=''; $f_ext['webspace']['deny']='php3,php'; $f_ext['ftpspace']['allow']='*'; $f_ext['ftpspace']['deny']=''; 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. 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. You list extensions comma-separated. If the value is a '*' every extension is allowed The list is case-insensitive when used in this class (see init()) Typically TYPO3_CONF_VARS['BE']['fileExtensions'] would be passed along as $f_ext. Example: $basicff->init($GLOBALS['FILEMOUNTS'],$TYPO3_CONF_VARS['BE']['fileExtensions']); Parameters: 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) array  Array with information about allowed and denied file extensions. Typically passed: $TYPO3_CONF_VARS['BE']['fileExtensions'] Returns: void See also: typo3/init.php, t3lib_userAuthGroup::returnFilemounts() Definition at line 132 of file class.t3lib_basicfilefunc.php. { $this->f_ext['webspace']['allow'] = t3lib_div::uniqueList(strtolower($f_ext['webspace']['allow'])); $this->f_ext['webspace']['deny'] = t3lib_div::uniqueList(strtolower($f_ext['webspace']['deny'])); $this->f_ext['ftpspace']['allow'] = t3lib_div::uniqueList(strtolower($f_ext['ftpspace']['allow'])); $this->f_ext['ftpspace']['deny'] = t3lib_div::uniqueList(strtolower($f_ext['ftpspace']['deny'])); $this->mounts = $mounts; $this->webPath = t3lib_div::getIndpEnv('TYPO3_DOCUMENT_ROOT'); $this->isInit = 1; }

t3lib_basicFileFunctions::is_allowed (  $  iconkey, $  type )

Checks if a $iconkey (fileextension) is allowed according to $this->f_ext. Parameters: string  The extension to check, eg. "php" or "html" etc. string  Either "webspage" or "ftpspace" - points to a key in $this->f_ext Returns: boolean True if file extension is allowed. Definition at line 169 of file class.t3lib_basicfilefunc.php. Referenced by checkIfAllowed(). { if (isset($this->f_ext[$type])) { $ik = strtolower($iconkey); if ($ik) { // If the extension is found amongst the allowed types, we return true immediately if ($this->f_ext[$type]['allow']=='*' || t3lib_div::inList($this->f_ext[$type]['allow'],$ik)) return true; // If the extension is found amongst the denied types, we return false immediately if ($this->f_ext[$type]['deny']=='*' || t3lib_div::inList($this->f_ext[$type]['deny'],$ik)) return false; // If no match we return true return true; } else { // If no extension: if ($this->f_ext[$type]['allow']=='*') return true; if ($this->f_ext[$type]['deny']=='*') return false; return true; } } return false; }

t3lib_basicFileFunctions::is_directory (  $  theDir  )

Cleans $theDir for slashes in the end of the string and returns the new path, if it exists on the server. Parameters: string  Directory path to check Returns: string Returns the cleaned up directory name if OK, otherwise false. Definition at line 248 of file class.t3lib_basicfilefunc.php. References cleanDirectoryName(), and isPathValid(). Referenced by t3lib_extFileFunctions::func_copy(), t3lib_extFileFunctions::func_delete(), t3lib_extFileFunctions::func_move(), t3lib_extFileFunctions::func_newfile(), t3lib_extFileFunctions::func_newfolder(), t3lib_extFileFunctions::func_unzip(), t3lib_extFileFunctions::func_upload(), and getUniqueName(). { if ($this->isPathValid($theDir)) { $theDir=$this->cleanDirectoryName($theDir); if (@is_dir($theDir)) { return $theDir; } } return false; }

t3lib_basicFileFunctions::is_webpath (  $  path  )

Checks if $this->webPath (should be TYPO3_DOCUMENT_ROOT) is in the first part of $path Returns true also if $this->init is not set or if $path is empty... Parameters: string  Absolute path to check Returns: boolean Definition at line 208 of file class.t3lib_basicfilefunc.php. References slashPath(). Referenced by checkIfFullAccess(). { if ($this->isInit) { $testPath = $this->slashPath($path); $testPathWeb = $this->slashPath($this->webPath); if ($testPathWeb && $testPath) { return t3lib_div::isFirstPartOfStr($testPath,$testPathWeb); } } return true; // Its more safe to return true (as the webpath is more restricted) if something went wrong... }

t3lib_basicFileFunctions::isPathValid (  $  theFile  )

Wrapper for t3lib_div::validPathStr(). Parameters: string  Filepath to evaluate Returns: boolean True, if no '//', '..' or '\' is in the $theFile See also: t3lib_div::validPathStr() Definition at line 265 of file class.t3lib_basicfilefunc.php. Referenced by checkPathAgainstMounts(), t3lib_extFileFunctions::findRecycler(), t3lib_extFileFunctions::func_copy(), t3lib_extFileFunctions::func_delete(), t3lib_extFileFunctions::func_move(), and is_directory(). { return t3lib_div::validPathStr($theFile); }

t3lib_basicFileFunctions::rmDoubleSlash (  $  string  )

Converts any double slashes (//) to a single slash (/). Parameters: string  Input value Returns: string Returns the converted string Definition at line 396 of file class.t3lib_basicfilefunc.php. { return str_replace('//','/',$string); }

t3lib_basicFileFunctions::slashPath (  $  path  )

Returns a string which has a slash '/' appended if it doesn't already have that slash. Parameters: string  Input string Returns: string Output string with a slash in the end (if not already there) Definition at line 406 of file class.t3lib_basicfilefunc.php. Referenced by is_webpath(). { if (substr($path,-1)!='/') { return $path.'/'; } return $path; }

---

Member Data Documentation

t3lib_basicFileFunctions::$f_ext = Array()

Definition at line 88 of file class.t3lib_basicfilefunc.php.

t3lib_basicFileFunctions::$getUniqueNamePrefix = ''

Definition at line 81 of file class.t3lib_basicfilefunc.php.

t3lib_basicFileFunctions::$isInit = 0

Definition at line 91 of file class.t3lib_basicfilefunc.php.

t3lib_basicFileFunctions::$maxInputNameLen = 30

Definition at line 84 of file class.t3lib_basicfilefunc.php.

t3lib_basicFileFunctions::$maxNumber = 20

Definition at line 82 of file class.t3lib_basicfilefunc.php.

t3lib_basicFileFunctions::$mounts = Array()

Definition at line 89 of file class.t3lib_basicfilefunc.php.

t3lib_basicFileFunctions::$tempFN = '_temp_'

Definition at line 85 of file class.t3lib_basicfilefunc.php.

t3lib_basicFileFunctions::$uniquePrecision = 6

Definition at line 83 of file class.t3lib_basicfilefunc.php.

t3lib_basicFileFunctions::$webPath = ''

Definition at line 90 of file class.t3lib_basicfilefunc.php.

---

The documentation for this class was generated from the following file:

• t3lib/class.t3lib_basicfilefunc.php

---