t3lib_extFileFunctions Class Reference

Inherits t3lib_basicFileFunctions.

List of all members.

Public Member Functions
	start ($fileCmds)
	Initialization of the class.
	init_actionPerms ($setup)
	Sets up permission to perform file/directory operations.
	processData ()
	Processing the command array in $this->fileCmdMap.
	printLogErrorMessages ($redirect='')
	Print log error messages from the operations of this script instance.
	findRecycler ($theFile)
	Goes back in the path and checks in each directory if a folder named $this->recyclerFN (usually '_recycler_') is present.
	writeLog ($action, $error, $details_nr, $details, $data)
	Logging file operations.
	func_delete ($cmds)
	Deleting files and folders (action=4).
	func_copy ($cmds)
	Copying files and folders (action=2).
	func_move ($cmds)
	Moving files and folders (action=3).
	func_rename ($cmds)
	Renaming files or foldes (action=5).
	func_newfolder ($cmds)
	This creates a new folder.
	func_newfile ($cmds)
	This creates a new file.
	func_edit ($cmds)
	Editing textfiles or foldes (action=9).
	func_upload ($cmds)
	Upload of files (action=1).
	func_unzip ($cmds)
	Unzipping file (action=7) This is permitted only if the user has fullAccess or if the file resides.
Public Attributes
	$maxCopyFileSize = 10000
	$maxMoveFileSize = 10000
	$maxUploadFileSize = 10000
	$unzipPath = ''
	$dontCheckForUnique = 0
	$actionPerms
	$recyclerFN = '_recycler_'
	$useRecycler = 1
	$PHPFileFunctions = 0
	$dont_use_exec_commands = 0

---

Member Function Documentation

t3lib_extFileFunctions::findRecycler (  $  theFile  )

Goes back in the path and checks in each directory if a folder named $this->recyclerFN (usually '_recycler_') is present. If a folder in the tree happens to be a _recycler_-folder (which means that we're deleting something inside a _recycler_-folder) this is ignored Parameters: string  Takes a valid Path ($theFile) Returns: string Returns the path (without trailing slash) of the closest recycle-folder if found. Else false. Definition at line 326 of file class.t3lib_extfilefunc.php. References t3lib_basicFileFunctions::checkPathAgainstMounts(), t3lib_basicFileFunctions::cleanDirectoryName(), and t3lib_basicFileFunctions::isPathValid(). Referenced by func_delete(). { if ($this->isPathValid($theFile)) { $theFile = $this->cleanDirectoryName($theFile); $fI = t3lib_div::split_fileref($theFile); $c = 0; while($this->checkPathAgainstMounts($fI['path']) && $c<20) { $rDir = $fI['path'].$this->recyclerFN; if (@is_dir($rDir) && $this->recyclerFN!=$fI['file']) { return $rDir; } $theFile = $fI['path']; $theFile = $this->cleanDirectoryName($theFile); $fI = t3lib_div::split_fileref($theFile); $c++; } } }

t3lib_extFileFunctions::func_copy (  $  cmds  )

Copying files and folders (action=2). Parameters: array  $cmds['data'] is the the file/folder to copy. $cmds['target'] is the path where to copy to. $cmds['altName'] (boolean): If set, another filename is found in case the target already exists Returns: string Returns the new filename upon success Definition at line 449 of file class.t3lib_extfilefunc.php. References t3lib_basicFileFunctions::checkIfAllowed(), t3lib_basicFileFunctions::checkIfFullAccess(), t3lib_basicFileFunctions::checkPathAgainstMounts(), t3lib_basicFileFunctions::getUniqueName(), t3lib_basicFileFunctions::is_directory(), t3lib_basicFileFunctions::isPathValid(), and writelog(). Referenced by processData(). { if (!$this->isInit) return FALSE; // Initialize and check basic conditions: $theFile = $cmds['data']; $theDest = $this->is_directory($cmds['target']); // Clean up destination directory $altName = $cmds['altName']; if (!$theDest) { $this->writelog(2,2,100,'Destination "%s" was not a directory',Array($cmds['target'])); return FALSE; } if (!$this->isPathValid($theFile) || !$this->isPathValid($theDest)) { $this->writelog(2,2,101,'Target or destination had invalid path (".." and "//" is not allowed in path). T="%s", D="%s"',Array($theFile,$theDest)); return FALSE; } // Processing of file or directory. if (@is_file($theFile)) { // If we are copying a file... if ($this->actionPerms['copyFile']) { if (filesize($theFile) < ($this->maxCopyFileSize*1024)) { $fI = t3lib_div::split_fileref($theFile); if ($altName) { // If altName is set, we're allowed to create a new filename if the file already existed $theDestFile = $this->getUniqueName($fI['file'], $theDest); $fI = t3lib_div::split_fileref($theDestFile); } else { $theDestFile = $theDest.'/'.$fI['file']; } if ($theDestFile && !@file_exists($theDestFile)) { if ($this->checkIfAllowed($fI['fileext'], $theDest, $fI['file'])) { if ($this->checkPathAgainstMounts($theDestFile) && $this->checkPathAgainstMounts($theFile)) { if ($this->PHPFileFunctions) { copy ($theFile,$theDestFile); } else { $cmd = 'cp "'.$theFile.'" "'.$theDestFile.'"'; exec($cmd); } clearstatcache(); if (@is_file($theDestFile)) { $this->writelog(2,0,1,'File "%s" copied to "%s"',Array($theFile,$theDestFile)); return $theDestFile; } else $this->writelog(2,2,109,'File "%s" WAS NOT copied to "%s"! Write-permission problem?',Array($theFile,$theDestFile)); } else $this->writelog(2,1,110,'Target or destination was not within your mountpoints! T="%s", D="%s"',Array($theFile,$theDestFile)); } else $this->writelog(2,1,111,'Fileextension "%s" is not allowed in "%s"!',Array($fI['fileext'],$theDest.'/')); } else $this->writelog(2,1,112,'File "%s" already exists!',Array($theDestFile)); } else $this->writelog(2,1,113,'File "%s" exceeds the size-limit of %s bytes',Array($theFile,$this->maxCopyFileSize*1024)); } else $this->writelog(2,1,114,'You are not allowed to copy files',''); // FINISHED copying file } elseif (@is_dir($theFile) && !$this->dont_use_exec_commands) { // if we're copying a folder if ($this->actionPerms['copyFolder']) { $theFile = $this->is_directory($theFile); if ($theFile) { $fI = t3lib_div::split_fileref($theFile); if ($altName) { // If altName is set, we're allowed to create a new filename if the file already existed $theDestFile = $this->getUniqueName($fI['file'], $theDest); $fI = t3lib_div::split_fileref($theDestFile); } else { $theDestFile = $theDest.'/'.$fI['file']; } if ($theDestFile && !@file_exists($theDestFile)) { if (!t3lib_div::isFirstPartOfStr($theDestFile.'/',$theFile.'/')) { // Check if the one folder is inside the other or on the same level... to target/dest is the same? if ($this->checkIfFullAccess($theDest) || $this->is_webPath($theDestFile)==$this->is_webPath($theFile)) { // no copy of folders between spaces if ($this->checkPathAgainstMounts($theDestFile) && $this->checkPathAgainstMounts($theFile)) { // No way to do this under windows! $cmd = 'cp -R "'.$theFile.'" "'.$theDestFile.'"'; exec($cmd); clearstatcache(); if (@is_dir($theDestFile)) { $this->writelog(2,0,2,'Directory "%s" copied to "%s"',Array($theFile,$theDestFile)); return $theDestFile; } else $this->writelog(2,2,119,'Directory "%s" WAS NOT copied to "%s"! Write-permission problem?',Array($theFile,$theDestFile)); } else $this->writelog(2,1,120,'Target or destination was not within your mountpoints! T="%s", D="%s"',Array($theFile,$theDestFile)); } else $this->writelog(2,1,121,'You don\'t have full access to the destination directory "%s"!',Array($theDest.'/')); } else $this->writelog(2,1,122,'Destination cannot be inside the target! D="%s", T="%s"',Array($theDestFile.'/',$theFile.'/')); } else $this->writelog(2,1,123,'Target "%s" already exists!',Array($theDestFile)); } else $this->writelog(2,2,124,'Target seemed not to be a directory! (Shouldn\'t happen here!)',''); } else $this->writelog(2,1,125,'You are not allowed to copy directories',''); // FINISHED copying directory } else { $this->writelog(2,2,130,'The item "%s" was not a file or directory!',Array($theFile)); } }

t3lib_extFileFunctions::func_delete (  $  cmds  )

Deleting files and folders (action=4). Parameters: array  $cmds['data'] is the the file/folder to delete Returns: boolean Returns true upon success Definition at line 382 of file class.t3lib_extfilefunc.php. References t3lib_basicFileFunctions::checkPathAgainstMounts(), findRecycler(), func_move(), t3lib_basicFileFunctions::is_directory(), t3lib_basicFileFunctions::isPathValid(), and writelog(). Referenced by processData(). { if (!$this->isInit) return FALSE; // Checking path: $theFile = $cmds['data']; if (!$this->isPathValid($theFile)) { $this->writelog(4,2,101,'Target "%s" had invalid path (".." and "//" is not allowed in path).',Array($theFile)); return FALSE; } // Recycler moving or not? if ($this->useRecycler && $recyclerPath=$this->findRecycler($theFile)) { // If a recycler is found, the deleted items is moved to the recycler and not just deleted. $newCmds=Array(); $newCmds['data']=$theFile; $newCmds['target']=$recyclerPath; $newCmds['altName']=1; $this->func_move($newCmds); $this->writelog(4,0,4,'Item "%s" moved to recycler at "%s"',Array($theFile,$recyclerPath)); return TRUE; } elseif ($this->useRecycler != 2) { // if $this->useRecycler==2 then we cannot delete for real!! if (@is_file($theFile)) { // If we are deleting a file... if ($this->actionPerms['deleteFile']) { if ($this->checkPathAgainstMounts($theFile)) { if (@unlink($theFile)) { $this->writelog(4,0,1,'File "%s" deleted',Array($theFile)); return TRUE; } else $this->writelog(4,1,110,'Could not delete file "%s". Write-permission problem?', Array($theFile)); } else $this->writelog(4,1,111,'Target was not within your mountpoints! T="%s"',Array($theFile)); } else $this->writelog(4,1,112,'You are not allowed to delete files',''); // FINISHED deleting file } elseif (@is_dir($theFile) && !$this->dont_use_exec_commands) { // if we're deleting a folder if ($this->actionPerms['deleteFolder']) { $theFile = $this->is_directory($theFile); if ($theFile) { if ($this->checkPathAgainstMounts($theFile)) { // I choose not to append '/' to $theFile here as this will prevent us from deleting mounts!! (which makes sense to me...) if ($this->actionPerms['deleteFolderRecursively']) { // No way to do this under windows $cmd = 'rm -Rf "'.$theFile.'"'; exec($cmd); // This is a quite critical command... clearstatcache(); if (!@file_exists($theFile)) { $this->writelog(4,0,2,'Directory "%s" deleted recursively!',Array($theFile)); return TRUE; } else $this->writelog(4,2,119,'Directory "%s" WAS NOT deleted recursively! Write-permission problem?',Array($theFile)); } else { if (@rmdir($theFile)) { $this->writelog(4,0,3,'Directory "%s" deleted',Array($theFile)); return TRUE; } else $this->writelog(4,1,120,'Could not delete directory! Write-permission problem? Is directory "%s" empty? (You are not allowed to delete directories recursively).',Array($theFile)); } } else $this->writelog(4,1,121,'Target was not within your mountpoints! T="%s"',Array($theFile)); } else $this->writelog(4,2,122,'Target seemed not to be a directory! (Shouldn\'t happen here!)',''); } else $this->writelog(4,1,123,'You are not allowed to delete directories',''); // FINISHED copying directory } else $this->writelog(4,2,130,'The item was not a file or directory! "%s"',Array($theFile)); } else $this->writelog(4,1,131,'No recycler found!',''); }

t3lib_extFileFunctions::func_edit (  $  cmds  )

Editing textfiles or foldes (action=9). Parameters: array  $cmds['data'] is the new content. $cmds['target'] is the target (file or dir) Returns: boolean Returns true on success Definition at line 745 of file class.t3lib_extfilefunc.php. References $content, $theTarget, t3lib_basicFileFunctions::checkIfAllowed(), t3lib_basicFileFunctions::checkPathAgainstMounts(), and writelog(). Referenced by processData(). { if (!$this->isInit) return FALSE; $theTarget = $cmds['target']; $content = $cmds['data']; $extList = $GLOBALS['TYPO3_CONF_VARS']['SYS']['textfile_ext']; $type = filetype($theTarget); if ($type=='file') { // $type MUST BE file $fileInfo = t3lib_div::split_fileref($theTarget); // Fetches info about path, name, extention of $theTarget $fI =$fileInfo; if ($this->checkPathAgainstMounts($fileInfo['path'])) { if ($this->actionPerms['editFile']) { $fI = t3lib_div::split_fileref($theTarget); if ($this->checkIfAllowed($fI['fileext'], $fileInfo['path'], $fI['file'])) { if (t3lib_div::inList($extList, $fileInfo['fileext'])) { if (t3lib_div::writeFile($theTarget,$content)) { clearstatcache(); $this->writelog(9,0,1,'File saved to "%s", bytes: %s, MD5: %s ',Array($fileInfo['file'],@filesize($theTarget),md5($content))); return TRUE; } else $this->writelog(9,1,100,'File "%s" was not saved! Write-permission problem in "%s"?',Array($theTarget,$fileInfo['path'])); } else $this->writelog(9,1,102,'Fileextension "%s" is not a textfile format! (%s)',Array($fI['fileext'], $extList)); } else $this->writelog(9,1,103,'Fileextension "%s" was not allowed!',Array($fI['fileext'])); } else $this->writelog(9,1,104,'You are not allowed to edit files!',''); } else $this->writelog(9,1,121,'Destination path "%s" was not within your mountpoints!',Array($fileInfo['path'])); } else $this->writelog(9,2,123,'Target "%s" was not a file!',Array($theTarget)); }

t3lib_extFileFunctions::func_move (  $  cmds  )

Moving files and folders (action=3). Parameters: array  $cmds['data'] is the the file/folder to move. $cmds['target'] is the path where to move to. $cmds['altName'] (boolean): If set, another filename is found in case the target already exists Returns: string Returns the new filename upon success Definition at line 539 of file class.t3lib_extfilefunc.php. References t3lib_basicFileFunctions::checkIfAllowed(), t3lib_basicFileFunctions::checkIfFullAccess(), t3lib_basicFileFunctions::checkPathAgainstMounts(), t3lib_basicFileFunctions::getUniqueName(), t3lib_basicFileFunctions::is_directory(), t3lib_basicFileFunctions::isPathValid(), and writelog(). Referenced by func_delete(), and processData(). { if (!$this->isInit) return FALSE; // Initialize and check basic conditions: $theFile = $cmds['data']; $theDest = $this->is_directory($cmds['target']); // Clean up destination directory $altName = $cmds['altName']; if (!$theDest) { $this->writelog(3,2,100,'Destination "%s" was not a directory',Array($cmds['target'])); return FALSE; } if (!$this->isPathValid($theFile) || !$this->isPathValid($theDest)) { $this->writelog(3,2,101,'Target or destination had invalid path (".." and "//" is not allowed in path). T="%s", D="%s"',Array($theFile,$theDest)); return FALSE; } // Processing of file or directory: if (@is_file($theFile)) { // If we are moving a file... if ($this->actionPerms['moveFile']) { if (filesize($theFile) < ($this->maxMoveFileSize*1024)) { $fI = t3lib_div::split_fileref($theFile); if ($altName) { // If altName is set, we're allowed to create a new filename if the file already existed $theDestFile = $this->getUniqueName($fI['file'], $theDest); $fI = t3lib_div::split_fileref($theDestFile); } else { $theDestFile = $theDest.'/'.$fI['file']; } if ($theDestFile && !@file_exists($theDestFile)) { if ($this->checkIfAllowed($fI['fileext'], $theDest, $fI['file'])) { if ($this->checkPathAgainstMounts($theDestFile) && $this->checkPathAgainstMounts($theFile)) { if ($this->PHPFileFunctions) { rename($theFile, $theDestFile); } else { $cmd = 'mv "'.$theFile.'" "'.$theDestFile.'"'; exec($cmd); } clearstatcache(); if (@is_file($theDestFile)) { $this->writelog(3,0,1,'File "%s" moved to "%s"',Array($theFile,$theDestFile)); return $theDestFile; } else $this->writelog(3,2,109,'File "%s" WAS NOT moved to "%s"! Write-permission problem?',Array($theFile,$theDestFile)); } else $this->writelog(3,1,110,'Target or destination was not within your mountpoints! T="%s", D="%s"',Array($theFile,$theDestFile)); } else $this->writelog(3,1,111,'Fileextension "%s" is not allowed in "%s"!',Array($fI['fileext'],$theDest.'/')); } else $this->writelog(3,1,112,'File "%s" already exists!',Array($theDestFile)); } else $this->writelog(3,1,113,'File "%s" exceeds the size-limit of %s bytes',Array($theFile,$this->maxMoveFileSize*1024)); } else $this->writelog(3,1,114,'You are not allowed to move files',''); // FINISHED moving file } elseif (@is_dir($theFile)) { // if we're moving a folder if ($this->actionPerms['moveFolder']) { $theFile = $this->is_directory($theFile); if ($theFile) { $fI = t3lib_div::split_fileref($theFile); if ($altName) { // If altName is set, we're allowed to create a new filename if the file already existed $theDestFile = $this->getUniqueName($fI['file'], $theDest); $fI = t3lib_div::split_fileref($theDestFile); } else { $theDestFile = $theDest.'/'.$fI['file']; } if ($theDestFile && !@file_exists($theDestFile)) { if (!t3lib_div::isFirstPartOfStr($theDestFile.'/',$theFile.'/')) { // Check if the one folder is inside the other or on the same level... to target/dest is the same? if ($this->checkIfFullAccess($theDest) || $this->is_webPath($theDestFile)==$this->is_webPath($theFile)) { // // no moving of folders between spaces if ($this->checkPathAgainstMounts($theDestFile) && $this->checkPathAgainstMounts($theFile)) { if ($this->PHPFileFunctions) { rename($theFile, $theDestFile); } else { $cmd = 'mv "'.$theFile.'" "'.$theDestFile.'"'; exec($cmd,$errArr,$retVar); } clearstatcache(); if (@is_dir($theDestFile)) { $this->writelog(3,0,2,'Directory "%s" moved to "%s"',Array($theFile,$theDestFile)); return $theDestFile; } else $this->writelog(3,2,119,'Directory "%s" WAS NOT moved to "%s"! Write-permission problem?',Array($theFile,$theDestFile)); } else $this->writelog(3,1,120,'Target or destination was not within your mountpoints! T="%s", D="%s"',Array($theFile,$theDestFile)); } else $this->writelog(3,1,121,'You don\'t have full access to the destination directory "%s"!',Array($theDest.'/')); } else $this->writelog(3,1,122,'Destination cannot be inside the target! D="%s", T="%s"',Array($theDestFile.'/',$theFile.'/')); } else $this->writelog(3,1,123,'Target "%s" already exists!',Array($theDestFile)); } else $this->writelog(3,2,124,'Target seemed not to be a directory! (Shouldn\'t happen here!)',''); } else $this->writelog(3,1,125,'You are not allowed to move directories',''); // FINISHED moving directory } else { $this->writelog(3,2,130,'The item "%s" was not a file or directory!',Array($theFile)); } }

t3lib_extFileFunctions::func_newfile (  $  cmds  )

This creates a new file. (action=8) Parameters: array  $cmds['data'] is the new filename. $cmds['target'] is the path where to create it Returns: string Returns the new filename upon success Definition at line 708 of file class.t3lib_extfilefunc.php. References $theTarget, t3lib_basicFileFunctions::checkFileNameLen(), t3lib_basicFileFunctions::checkIfAllowed(), t3lib_basicFileFunctions::checkPathAgainstMounts(), t3lib_basicFileFunctions::cleanFileName(), t3lib_basicFileFunctions::is_directory(), and writelog(). Referenced by processData(). { $extList = $GLOBALS['TYPO3_CONF_VARS']['SYS']['textfile_ext']; if (!$this->isInit) return FALSE; $newName = $this->cleanFileName($cmds['data']); if ($newName) { if ($this->checkFileNameLen($newName)) { $theTarget = $this->is_directory($cmds['target']); // Check the target dir $fileInfo = t3lib_div::split_fileref($theTarget); // Fetches info about path, name, extention of $theTarget if ($theTarget) { if ($this->actionPerms['newFile']) { $theNewFile = $theTarget.'/'.$newName; if ($this->checkPathAgainstMounts($theNewFile)) { if (!@file_exists($theNewFile)) { $fI = t3lib_div::split_fileref($theNewFile); if ($this->checkIfAllowed($fI['fileext'], $fileInfo['path'], $fI['file'])) { if (t3lib_div::inList($extList, $fI['fileext'])) { if (t3lib_div::writeFile($theNewFile,'')) { clearstatcache(); $this->writelog(8,0,1,'File created: "%s"',Array($fI['file'])); return $theNewFile; } else $this->writelog(8,1,100,'File "%s" was not created! Write-permission problem in "%s"?',Array($fI['file'], $theTarget)); } else $this->writelog(8,1,107,'Fileextension "%s" is not a textfile format! (%s)',Array($fI['fileext'], $extList)); } else $this->writelog(8,1,106,'Fileextension "%s" was not allowed!',Array($fI['fileext'])); } else $this->writelog(8,1,101,'File "%s" existed already!',Array($theNewFile)); } else $this->writelog(8,1,102,'Destination path "%s" was not within your mountpoints!',Array($theTarget.'/')); } else $this->writelog(8,1,103,'You are not allowed to create files!',''); } else $this->writelog(8,2,104,'Destination "%s" was not a directory',Array($cmds['target'])); } else $this->writelog(8,1,105,'New name "%s" was too long (max %s characters)',Array($newName,$this->maxInputNameLen)); } }

t3lib_extFileFunctions::func_newfolder (  $  cmds  )

This creates a new folder. (action=6) Parameters: array  $cmds['data'] is the foldername. $cmds['target'] is the path where to create it. Returns: string Returns the new foldername upon success Definition at line 678 of file class.t3lib_extfilefunc.php. References $theTarget, t3lib_basicFileFunctions::checkFileNameLen(), t3lib_basicFileFunctions::checkPathAgainstMounts(), t3lib_basicFileFunctions::cleanFileName(), t3lib_basicFileFunctions::is_directory(), and writelog(). Referenced by processData(). { if (!$this->isInit) return FALSE; $theFolder = $this->cleanFileName($cmds['data']); if ($theFolder) { if ($this->checkFileNameLen($theFolder)) { $theTarget = $this->is_directory($cmds['target']); // Check the target dir if ($theTarget) { if ($this->actionPerms['newFolder']) { $theNewFolder = $theTarget.'/'.$theFolder; if ($this->checkPathAgainstMounts($theNewFolder)) { if (!@file_exists($theNewFolder)) { if (t3lib_div::mkdir($theNewFolder)){ $this->writelog(6,0,1,'Directory "%s" created in "%s"',Array($theFolder,$theTarget.'/')); return $theNewFolder; } else $this->writelog(6,1,100,'Directory "%s" not created. Write-permission problem in "%s"?',Array($theFolder,$theTarget.'/')); } else $this->writelog(6,1,101,'File or directory "%s" existed already!',Array($theNewFolder)); } else $this->writelog(6,1,102,'Destination path "%s" was not within your mountpoints!',Array($theTarget.'/')); } else $this->writelog(6,1,103,'You are not allowed to create directories!',''); } else $this->writelog(6,2,104,'Destination "%s" was not a directory',Array($cmds['target'])); } else $this->writelog(6,1,105,'New name "%s" was too long (max %s characters)',Array($theFolder,$this->maxInputNameLen)); } }

t3lib_extFileFunctions::func_rename (  $  cmds  )

Renaming files or foldes (action=5). Parameters: array  $cmds['data'] is the new name. $cmds['target'] is the target (file or dir). Returns: string Returns the new filename upon success Definition at line 632 of file class.t3lib_extfilefunc.php. References $theTarget, t3lib_basicFileFunctions::checkFileNameLen(), t3lib_basicFileFunctions::checkIfAllowed(), t3lib_basicFileFunctions::checkPathAgainstMounts(), t3lib_basicFileFunctions::cleanFileName(), and writelog(). Referenced by processData(). { if (!$this->isInit) return FALSE; $theNewName = $this->cleanFileName($cmds['data']); if ($theNewName) { if ($this->checkFileNameLen($theNewName)) { $theTarget = $cmds['target']; $type = filetype($theTarget); if ($type=='file' || $type=='dir') { // $type MUST BE file or dir $fileInfo = t3lib_div::split_fileref($theTarget); // Fetches info about path, name, extention of $theTarget if ($fileInfo['file']!=$theNewName) { // The name should be different from the current. And the filetype must be allowed $theRenameName = $fileInfo['path'].$theNewName; if ($this->checkPathAgainstMounts($fileInfo['path'])) { if (!@file_exists($theRenameName)) { if ($type=='file') { if ($this->actionPerms['renameFile']) { $fI = t3lib_div::split_fileref($theRenameName); if ($this->checkIfAllowed($fI['fileext'], $fileInfo['path'], $fI['file'])) { if (@rename($theTarget, $theRenameName)) { $this->writelog(5,0,1,'File renamed from "%s" to "%s"',Array($fileInfo['file'],$theNewName)); return $theRenameName; } else $this->writelog(5,1,100,'File "%s" was not renamed! Write-permission problem in "%s"?',Array($theTarget,$fileInfo['path'])); } else $this->writelog(5,1,101,'Fileextension "%s" was not allowed!',Array($fI['fileext'])); } else $this->writelog(5,1,102,'You are not allowed to rename files!',''); } elseif ($type=='dir') { if ($this->actionPerms['renameFolder']) { if (@rename($theTarget, $theRenameName)) { $this->writelog(5,0,2,'Directory renamed from "%s" to "%s"',Array($fileInfo['file'],$theNewName)); return $theRenameName; } else $this->writelog(5,1,110,'Directory "%s" was not renamed! Write-permission problem in "%s"?',Array($theTarget,$fileInfo['path'])); } else $this->writelog(5,1,111,'You are not allowed to rename directories!',''); } } else $this->writelog(5,1,120,'Destination "%s" existed already!',Array($theRenameName)); } else $this->writelog(5,1,121,'Destination path "%s" was not within your mountpoints!',Array($fileInfo['path'])); } else $this->writelog(5,1,122,'Old and new name is the same (%s)',Array($theNewName)); } else $this->writelog(5,2,123,'Target "%s" was neither a directory nor a file!',Array($theTarget)); } else $this->writelog(5,1,124,'New name "%s" was too long (max %s characters)',Array($theNewName,$this->maxInputNameLen)); } }

t3lib_extFileFunctions::func_unzip (  $  cmds  )

Unzipping file (action=7) This is permitted only if the user has fullAccess or if the file resides. Parameters: array  $cmds['data'] is the zip-file. $cmds['target'] is the target directory. If not set we'll default to the same directory as the file is in. Returns: boolean Returns true on success Definition at line 815 of file class.t3lib_extfilefunc.php. References t3lib_basicFileFunctions::checkIfFullAccess(), t3lib_basicFileFunctions::checkPathAgainstMounts(), t3lib_basicFileFunctions::is_directory(), and writelog(). Referenced by processData(). { if (!$this->isInit || $this->dont_use_exec_commands) return FALSE; $theFile = $cmds['data']; if (@is_file($theFile)) { $fI = t3lib_div::split_fileref($theFile); if (!isset($cmds['target'])) { $cmds['target'] = $fI['path']; } $theDest = $this->is_directory($cmds['target']); // Clean up destination directory if ($theDest) { if ($this->actionPerms['unzipFile']) { if ($fI['fileext']=='zip') { if ($this->checkIfFullAccess($theDest)) { if ($this->checkPathAgainstMounts($theFile) && $this->checkPathAgainstMounts($theDest.'/')) { // No way to do this under windows. $cmd = $this->unzipPath.'unzip -qq "'.$theFile.'" -d "'.$theDest.'"'; exec($cmd); $this->writelog(7,0,1,'Unzipping file "%s" in "%s"',Array($theFile,$theDest)); return TRUE; } else $this->writelog(7,1,100,'File "%s" or destination "%s" was not within your mountpoints!',Array($theFile,$theDest)); } else $this->writelog(7,1,101,'You don\'t have full access to the destination directory "%s"!',Array($theDest)); } else $this->writelog(7,1,102,'Fileextension is not "zip"',''); } else $this->writelog(7,1,103,'You are not allowed to unzip files',''); } else $this->writelog(7,2,104,'Destination "%s" was not a directory',Array($cmds['target'])); } else $this->writelog(7,2,105,'The file "%s" did not exist!',Array($theFile)); }

t3lib_extFileFunctions::func_upload (  $  cmds  )

Upload of files (action=1). Parameters: array  $cmds['data'] is the ID-number (points to the global var that holds the filename-ref ($_FILES['upload_'.$id]['name']). $cmds['target'] is the target directory Returns: string Returns the new filename upon success Definition at line 777 of file class.t3lib_extfilefunc.php. References $theTarget, t3lib_basicFileFunctions::checkIfAllowed(), t3lib_basicFileFunctions::checkPathAgainstMounts(), t3lib_basicFileFunctions::cleanFileName(), t3lib_basicFileFunctions::getUniqueName(), t3lib_basicFileFunctions::is_directory(), and writelog(). Referenced by processData(). { if (!$this->isInit) return FALSE; $id = $cmds['data']; if ($_FILES['upload_'.$id]['name']) { $theFile = $_FILES['upload_'.$id]['tmp_name']; // filename of the uploaded file $theFileSize = $_FILES['upload_'.$id]['size']; // filesize of the uploaded file $theName = $this->cleanFileName(stripslashes($_FILES['upload_'.$id]['name'])); // The original filename if (is_uploaded_file($theFile) && $theName) { // Check the file if ($this->actionPerms['uploadFile']) { if ($theFileSize<($this->maxUploadFileSize*1024)) { $fI = t3lib_div::split_fileref($theName); $theTarget = $this->is_directory($cmds['target']); // Check the target dir if ($theTarget && $this->checkPathAgainstMounts($theTarget.'/')) { if ($this->checkIfAllowed($fI['fileext'], $theTarget, $fI['file'])) { $theNewFile = $this->getUniqueName($theName, $theTarget, $this->dontCheckForUnique); if ($theNewFile) { t3lib_div::upload_copy_move($theFile,$theNewFile); clearstatcache(); if (@is_file($theNewFile)) { $this->writelog(1,0,1,'Uploading file "%s" to "%s"',Array($theName,$theNewFile, $id)); return $theNewFile; } else $this->writelog(1,1,100,'Uploaded file could not be moved! Write-permission problem in "%s"?',Array($theTarget.'/')); } else $this->writelog(1,1,101,'No unique filename available in "%s"!',Array($theTarget.'/')); } else $this->writelog(1,1,102,'Fileextension "%s" is not allowed in "%s"!',Array($fI['fileext'],$theTarget.'/')); } else $this->writelog(1,1,103,'Destination path "%s" was not within your mountpoints!',Array($theTarget.'/')); } else $this->writelog(1,1,104,'The uploaded file exceeds the size-limit of %s bytes',Array($this->maxUploadFileSize*1024)); } else $this->writelog(1,1,105,'You are not allowed to upload files!',''); } else $this->writelog(1,2,106,'The uploaded file did not exist!',''); } }

t3lib_extFileFunctions::init_actionPerms (  $  setup  )

Sets up permission to perform file/directory operations. See below or the be_user-table for the significanse of the various bits in $setup ($BE_USER->user['fileoper_perms']) Parameters: integer  File permission integer from BE_USER object. Returns: void Definition at line 179 of file class.t3lib_extfilefunc.php. { if (($setup&1)==1) { // Files: Upload,Copy,Move,Delete,Rename $this->actionPerms['uploadFile']=1; $this->actionPerms['copyFile']=1; $this->actionPerms['moveFile']=1; $this->actionPerms['deleteFile']=1; $this->actionPerms['renameFile']=1; $this->actionPerms['editFile']=1; $this->actionPerms['newFile']=1; } if (($setup&2)==2) { // Files: Unzip $this->actionPerms['unzipFile']=1; } if (($setup&4)==4) { // Directory: Move,Delete,Rename,New $this->actionPerms['moveFolder']=1; $this->actionPerms['deleteFolder']=1; $this->actionPerms['renameFolder']=1; $this->actionPerms['newFolder']=1; } if (($setup&8)==8) { // Directory: Copy $this->actionPerms['copyFolder']=1; } if (($setup&16)==16) { // Directory: Delete recursively (rm -Rf) $this->actionPerms['deleteFolderRecursively']=1; } }

t3lib_extFileFunctions::printLogErrorMessages (  $  redirect = ''  )

Print log error messages from the operations of this script instance. Parameters: string  Redirect URL (for creating link in message) Returns: void (Will exit on error) Definition at line 268 of file class.t3lib_extfilefunc.php. References $content, error(), and table(). { $res_log = $GLOBALS['TYPO3_DB']->exec_SELECTquery( '*', 'sys_log', 'type=2 AND userid='.intval($GLOBALS['BE_USER']->user['uid']).' AND tstamp='.intval($GLOBALS['EXEC_TIME']).' AND error!=0' ); $errorJS = array(); while ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res_log)) { $log_data = unserialize($row['log_data']); $errorJS[] = $row[error].': '.sprintf($row['details'], $log_data[0],$log_data[1],$log_data[2],$log_data[3],$log_data[4]); } if (count($errorJS)) { $error_doc = t3lib_div::makeInstance('template'); $error_doc->backPath = ''; $content.= $error_doc->startPage('tce_db.php Error output'); $lines[] = ' <tr class="bgColor5"> <td colspan="2" align="center"><strong>Errors:</strong></td> </tr>'; foreach($errorJS as $line) { $lines[] = ' <tr class="bgColor4"> <td valign="top"><img'.t3lib_iconWorks::skinImg('','gfx/icon_fatalerror.gif','width="18" height="16"').' alt="" /></td> <td>'.htmlspecialchars($line).'</td> </tr>'; } $lines[] = ' <tr> <td colspan="2" align="center"><br />'. '<form action=""><input type="submit" value="Continue" onclick="'.htmlspecialchars('document.location=\''.$redirect.'\';return false;').'" /></form>'. '</td> </tr>'; $content.= ' <br /><br /> <table border="0" cellpadding="1" cellspacing="1" width="300" align="center"> '.implode('',$lines).' </table>'; $content.= $error_doc->endPage(); echo $content; exit; } }

t3lib_extFileFunctions::processData (   )

Processing the command array in $this->fileCmdMap. Returns: void Definition at line 211 of file class.t3lib_extfilefunc.php. References func_copy(), func_delete(), func_edit(), func_move(), func_newfile(), func_newfolder(), func_rename(), func_unzip(), and func_upload(). { if (!$this->isInit) return FALSE; if (is_array($this->fileCmdMap)) { // Traverse each set of actions foreach($this->fileCmdMap as $action => $actionData) { // Traverse all action data. More than one file might be affected at the same time. if (is_array($actionData)) { foreach($actionData as $cmdArr) { // Clear file stats clearstatcache(); // Branch out based on command: switch ($action) { case 'delete': $this->func_delete($cmdArr); break; case 'copy': $this->func_copy($cmdArr); break; case 'move': $this->func_move($cmdArr); break; case 'rename': $this->func_rename($cmdArr); break; case 'newfolder': $this->func_newfolder($cmdArr); break; case 'newfile': $this->func_newfile($cmdArr); break; case 'editfile': $this->func_edit($cmdArr); break; case 'upload': $this->func_upload($cmdArr); break; case 'unzip': $this->func_unzip($cmdArr); break; } } } } } }

t3lib_extFileFunctions::start (  $  fileCmds  )

Initialization of the class. Parameters: array  The $file array with the commands to execute. See "TYPO3 Core API" document Returns: void Definition at line 149 of file class.t3lib_extfilefunc.php. References TYPO3_OS. { // Configure settings from TYPO3_CONF_VARS: if (TYPO3_OS=='WIN' || $GLOBALS['TYPO3_CONF_VARS']['BE']['disable_exec_function']) { $this->PHPFileFunctions = 1; $this->dont_use_exec_commands = 1; } else { $this->PHPFileFunctions = $GLOBALS['TYPO3_CONF_VARS']['BE']['usePHPFileFunctions']; } $this->unzipPath = $GLOBALS['TYPO3_CONF_VARS']['BE']['unzip_path']; $maxFileSize = intval($GLOBALS['TYPO3_CONF_VARS']['BE']['maxFileSize']); if ($maxFileSize>0) { $this->maxCopyFileSize = $maxFileSize; $this->maxMoveFileSize = $maxFileSize; $this->maxUploadFileSize = $maxFileSize; } // Initializing file processing commands: $this->fileCmdMap = $fileCmds; }

t3lib_extFileFunctions::writeLog (  $  action, $  error, $  details_nr, $  details, $  data )

Logging file operations. Parameters: integer  The action number. See the functions in the class for a hint. Eg. edit is '9', upload is '1' ... integer  The severity: 0 = message, 1 = error, 2 = System Error, 3 = security notice (admin) integer  This number is unique for every combination of $type and $action. This is the error-message number, which can later be used to translate error messages. string  This is the default, raw error message in english array  Array with special information that may go into $details by "%s" marks / sprintf() when the log is shown Returns: void See also: class.t3lib_userauthgroup.php Definition at line 355 of file class.t3lib_extfilefunc.php. References error(). { $type = 2; // Type value for tce_file.php if (is_object($GLOBALS['BE_USER'])) { $GLOBALS['BE_USER']->writelog($type,$action,$error,$details_nr,$details,$data); } }

---

Member Data Documentation

t3lib_extFileFunctions::$actionPerms

Initial value: Array( // This array is self-explaning (look in the class below). It grants access to the functions. This could be set from outside in order to enabled functions to users. See also the function init_actionPerms() which takes input directly from the user-record 'deleteFile' => 0, // Deleting files physically 'deleteFolder' => 0, // Deleting foldes physically 'deleteFolderRecursively' => 0, // normally folders are deleted by the PHP-function rmdir(), but with this option a user deletes with 'rm -Rf ....' which is pretty wild! 'moveFile' => 0, 'moveFolder' => 0, 'copyFile' => 0, 'copyFolder' => 0, 'newFolder' => 0, 'newFile' => 0, 'editFile' => 0, 'unzipFile' => 0, 'uploadFile' => 0, 'renameFile' => 0, 'renameFolder' => 0 ) Definition at line 115 of file class.t3lib_extfilefunc.php.

t3lib_extFileFunctions::$dont_use_exec_commands = 0

Definition at line 137 of file class.t3lib_extfilefunc.php.

t3lib_extFileFunctions::$dontCheckForUnique = 0

Definition at line 113 of file class.t3lib_extfilefunc.php.

t3lib_extFileFunctions::$maxCopyFileSize = 10000

Definition at line 109 of file class.t3lib_extfilefunc.php.

t3lib_extFileFunctions::$maxMoveFileSize = 10000

Definition at line 110 of file class.t3lib_extfilefunc.php.

t3lib_extFileFunctions::$maxUploadFileSize = 10000

Definition at line 111 of file class.t3lib_extfilefunc.php.

t3lib_extFileFunctions::$PHPFileFunctions = 0

Definition at line 136 of file class.t3lib_extfilefunc.php.

t3lib_extFileFunctions::$recyclerFN = '_recycler_'

Definition at line 132 of file class.t3lib_extfilefunc.php.

t3lib_extFileFunctions::$unzipPath = ''

Definition at line 112 of file class.t3lib_extfilefunc.php.

t3lib_extFileFunctions::$useRecycler = 1

Definition at line 133 of file class.t3lib_extfilefunc.php.

---

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

• t3lib/class.t3lib_extfilefunc.php

---