Documentation TYPO3 par Ameos

class.t3lib_basicfilefunc.php

00001 <?php
00002 /***************************************************************
00003 *  Copyright notice
00004 *
00005 *  (c) 1999-2006 Kasper Skaarhoj (kasperYYYY@typo3.com)
00006 *  All rights reserved
00007 *
00008 *  This script is part of the TYPO3 project. The TYPO3 project is
00009 *  free software; you can redistribute it and/or modify
00010 *  it under the terms of the GNU General Public License as published by
00011 *  the Free Software Foundation; either version 2 of the License, or
00012 *  (at your option) any later version.
00013 *
00014 *  The GNU General Public License can be found at
00015 *  http://www.gnu.org/copyleft/gpl.html.
00016 *  A copy is found in the textfile GPL.txt and important notices to the license
00017 *  from the author is found in LICENSE.txt distributed with these scripts.
00018 *
00019 *
00020 *  This script is distributed in the hope that it will be useful,
00021 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
00022 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00023 *  GNU General Public License for more details.
00024 *
00025 *  This copyright notice MUST APPEAR in all copies of the script!
00026 ***************************************************************/
00070 require_once(PATH_t3lib.'class.t3lib_cs.php');
00071 
00072 
00081 class t3lib_basicFileFunctions  {
00082         var $getUniqueNamePrefix = '';  // Prefix which will be prepended the file when using the getUniqueName-function
00083         var $maxNumber = 20;                    // This number decides the highest allowed appended number used on a filename before we use naming with unique strings
00084         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.
00085         var $maxInputNameLen = 60;              // This is the maximum length of names treated by cleanFileName()
00086         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)
00087 
00088                 // internal
00089         var $f_ext = Array();                   // See comment in header
00090         var $mounts = Array();                  // See comment in header
00091         var $webPath ='';                               // Set to DOCUMENT_ROOT.
00092         var $isInit = 0;                                // Set to true after init()/start();
00093 
00094 
00095 
00096         /**********************************
00097          *
00098          * Checking functions
00099          *
00100          **********************************/
00101 
00133         function init($mounts, $f_ext)  {
00134                 $this->f_ext['webspace']['allow'] = t3lib_div::uniqueList(strtolower($f_ext['webspace']['allow']));
00135                 $this->f_ext['webspace']['deny'] = t3lib_div::uniqueList(strtolower($f_ext['webspace']['deny']));
00136                 $this->f_ext['ftpspace']['allow'] = t3lib_div::uniqueList(strtolower($f_ext['ftpspace']['allow']));
00137                 $this->f_ext['ftpspace']['deny'] = t3lib_div::uniqueList(strtolower($f_ext['ftpspace']['deny']));
00138 
00139                 $this->mounts = $mounts;
00140                 $this->webPath = t3lib_div::getIndpEnv('TYPO3_DOCUMENT_ROOT');
00141                 $this->isInit = 1;
00142 
00143                 $this->maxInputNameLen = $GLOBALS['TYPO3_CONF_VARS']['SYS']['maxFileNameLength'] ? $GLOBALS['TYPO3_CONF_VARS']['SYS']['maxFileNameLength'] : $this->maxInputNameLen;
00144         }
00145 
00152         function getTotalFileInfo($wholePath)   {
00153                 $theuser = getmyuid();
00154                 $info = t3lib_div::split_fileref($wholePath);
00155                 $info['tstamp'] = @filectime($wholePath);
00156                 $info['size'] = @filesize($wholePath);
00157                 $info['type'] = @filetype($wholePath);
00158                 $info['owner'] = @fileowner($wholePath);
00159                 $info['perms'] = @fileperms($wholePath);
00160                 $info['writable'] = !@is_writable($wholePath);
00161                 $info['readable'] = !@is_readable($wholePath);
00162                 return $info;
00163         }
00164 
00172         function is_allowed($iconkey,$type)     {
00173                 if (isset($this->f_ext[$type])) {
00174                         $ik = strtolower($iconkey);
00175                         if ($ik)        {
00176                                         // If the extension is found amongst the allowed types, we return true immediately
00177                                 if ($this->f_ext[$type]['allow']=='*' || t3lib_div::inList($this->f_ext[$type]['allow'],$ik))   return true;
00178                                         // If the extension is found amongst the denied types, we return false immediately
00179                                 if ($this->f_ext[$type]['deny']=='*' || t3lib_div::inList($this->f_ext[$type]['deny'],$ik))     return false;
00180                                         // If no match we return true
00181                                 return true;
00182                         } else {        // If no extension:
00183                                 if ($this->f_ext[$type]['allow']=='*')  return true;
00184                                 if ($this->f_ext[$type]['deny']=='*')   return false;
00185                                 return true;
00186                         }
00187                 }
00188                 return false;
00189         }
00190 
00197         function checkIfFullAccess($theDest)    {
00198                 $type = $this->is_webpath($theDest)?'webspace':'ftpspace';
00199                 if (isset($this->f_ext[$type])) {
00200                         if ((string)$this->f_ext[$type]['deny']=='' || $this->f_ext[$type]['allow']=='*')       return true;
00201                 }
00202         }
00203 
00211         function is_webpath($path)      {
00212                 if ($this->isInit)      {
00213                         $testPath = $this->slashPath($path);
00214                         $testPathWeb = $this->slashPath($this->webPath);
00215                         if ($testPathWeb && $testPath)  {
00216                                 return t3lib_div::isFirstPartOfStr($testPath,$testPathWeb);
00217                         }
00218                 }
00219                 return true;    // Its more safe to return true (as the webpath is more restricted) if something went wrong...
00220         }
00221 
00231         function checkIfAllowed($ext, $theDest, $filename='')   {
00232                 return t3lib_div::verifyFilenameAgainstDenyPattern($filename) && $this->is_allowed($ext,($this->is_webpath($theDest)?'webspace':'ftpspace'));
00233         }
00234 
00241         function checkFileNameLen($fileName)    {
00242                 return strlen($fileName) <= $this->maxInputNameLen;
00243         }
00244 
00251         function is_directory($theDir)  {
00252                 if ($this->isPathValid($theDir))        {
00253                         $theDir=$this->cleanDirectoryName($theDir);
00254                         if (@is_dir($theDir))   {
00255                                 return $theDir;
00256                         }
00257                 }
00258                 return false;
00259         }
00260 
00268         function isPathValid($theFile)  {
00269                 return t3lib_div::validPathStr($theFile);
00270         }
00271 
00283         function getUniqueName($theFile, $theDest, $dontCheckForUnique=0)       {
00284                 $theDest = $this->is_directory($theDest);       // $theDest is cleaned up
00285                 $origFileInfo = t3lib_div::split_fileref($theFile);             // Fetches info about path, name, extention of $theFile
00286                 if ($theDest)   {
00287                         if ($this->getUniqueNamePrefix) {               // Adds prefix
00288                                 $origFileInfo['file']     = $this->getUniqueNamePrefix.$origFileInfo['file'];
00289                                 $origFileInfo['filebody'] = $this->getUniqueNamePrefix.$origFileInfo['filebody'];
00290                         }
00291 
00292                                 // Check if the file exists and if not - return the filename...
00293                         $fileInfo = $origFileInfo;
00294                         $theDestFile = $theDest.'/'.$fileInfo['file'];          // The destinations file
00295                         if (!@file_exists($theDestFile) || $dontCheckForUnique)         {       // If the file does NOT exist we return this filename
00296                                 return $theDestFile;
00297                         }
00298 
00299                                 // 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...
00300                         $theTempFileBody = preg_replace('/_[0-9][0-9]$/','',$origFileInfo['filebody']);         // This removes _xx if appended to the file
00301                         $theOrigExt = $origFileInfo['realFileext'] ? '.'.$origFileInfo['realFileext'] : '';
00302 
00303                         for ($a=1; $a<=($this->maxNumber+1); $a++)      {
00304                                 if ($a<=$this->maxNumber)       {       // First we try to append numbers
00305                                         $insert = '_'.sprintf('%02d', $a);
00306                                 } else {                // .. then we try unique-strings...
00307                                         $insert = '_'.substr(md5(uniqId('')),0,$this->uniquePrecision);
00308                                 }
00309                                 $theTestFile = $theTempFileBody.$insert.$theOrigExt;
00310                                 $theDestFile = $theDest.'/'.$theTestFile;               // The destinations file
00311                                 if (!@file_exists($theDestFile))                {       // If the file does NOT exist we return this filename
00312                                         return $theDestFile;
00313                                 }
00314                         }
00315                 }
00316         }
00317 
00326         function checkPathAgainstMounts($thePath)       {
00327                 if ($thePath && $this->isPathValid($thePath) && is_array($this->mounts))        {
00328                         reset ($this->mounts);
00329                         while(list($k,$val)=each($this->mounts))        {
00330                                 if (t3lib_div::isFirstPartOfStr($thePath,$val['path'])) {
00331                                         return $k;
00332                                 }
00333                         }
00334                 }
00335         }
00336 
00342         function findFirstWebFolder()   {
00343                 global $TYPO3_CONF_VARS;
00344 
00345                 if (is_array($this->mounts))    {
00346                         reset ($this->mounts);
00347                         while(list($k,$val)=each($this->mounts))        {
00348                                 if (t3lib_div::isFirstPartOfStr($val['path'], PATH_site.$TYPO3_CONF_VARS['BE']['fileadminDir']))        {
00349                                         return $k;
00350                                 }
00351                         }
00352                 }
00353         }
00354 
00362         function blindPath($thePath)    {
00363                 $k=$this->checkPathAgainstMounts($thePath);
00364                 if ($k) {
00365                         $name='';
00366                         $name.='['.$this->mounts[$k]['name'].']: ';
00367                         $name.=substr($thePath,strlen($this->mounts[$k]['path']));
00368                         return $name;
00369                 }
00370         }
00371 
00378         function findTempFolder()       {
00379                 if ($this->tempFN && is_array($this->mounts))   {
00380                         reset ($this->mounts);
00381                         while(list($k,$val)=each($this->mounts))        {
00382                                 $tDir = $val['path'].$this->tempFN;
00383                                 if (@is_dir($tDir))     {
00384                                         return $tDir;
00385                                 }
00386                         }
00387                 }
00388         }
00389 
00390 
00391 
00392 
00393 
00394 
00395 
00396 
00397 
00398 
00399 
00400         /*********************
00401          *
00402          * Cleaning functions
00403          *
00404          *********************/
00405 
00412         function cleanDirectoryName($theDir)    {
00413                 return preg_replace('/[\/\. ]*$/','',$this->rmDoubleSlash($theDir));
00414         }
00415 
00422         function rmDoubleSlash($string) {
00423                 return str_replace('//','/',$string);
00424         }
00425 
00432         function slashPath($path)       {
00433                 if (substr($path,-1)!='/')      {
00434                         return $path.'/';
00435                 }
00436                 return $path;
00437         }
00438 
00446         function cleanFileName($fileName,$charset='')   {
00447                 if (!is_object($this->csConvObj))       {
00448                         if (TYPO3_MODE=='FE')   {
00449                                 $this->csConvObj = &$GLOBALS['TSFE']->csConvObj;
00450                         } elseif (is_object($GLOBALS['LANG']))  {       // BE assumed:
00451                                 $this->csConvObj = &$GLOBALS['LANG']->csConvObj;
00452                         } else {        // The object may not exist yet, so we need to create it now. Happens in the Install Tool for example.
00453                                 $this->csConvObj = &t3lib_div::makeInstance('t3lib_cs');
00454                         }
00455                 }
00456 
00457                 if (!$charset)  {
00458                         if (TYPO3_MODE=='FE')   {
00459                                 $charset = $GLOBALS['TSFE']->renderCharset;
00460                         } elseif (is_object($GLOBALS['LANG']))  {       // BE assumed:
00461                                 $charset = $GLOBALS['LANG']->charSet;
00462                         } else {        // best guess
00463                                 $charset = $GLOBALS['TYPO3_CONF_VARS']['BE']['forceCharset'];
00464                         }
00465                 }
00466 
00467                 if ($charset)   {
00468                         $fileName = $this->csConvObj->specCharsToASCII($charset,$fileName);
00469                 }
00470 
00471                 return preg_replace('/[^.[:alnum:]_-]/','_',trim($fileName));
00472         }
00473 
00480         function formatSize($sizeInBytes)       {
00481                 if ($sizeInBytes>900)   {
00482                         if ($sizeInBytes>900000)        {       // MB
00483                                 $val = $sizeInBytes/(1024*1024);
00484                                 return number_format($val, (($val<20)?1:0), '.', '').' M';
00485                         } else {        // KB
00486                                 $val = $sizeInBytes/(1024);
00487                                 return number_format($val, (($val<20)?1:0), '.', '').' K';
00488                         }
00489                 } else {        // Bytes
00490                         return $sizeInBytes.'&nbsp;&nbsp;';
00491                 }
00492         }
00493 }
00494 
00495 
00496 
00497 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_basicfilefunc.php'])     {
00498         include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_basicfilefunc.php']);
00499 }
00500 ?>


Généré par Les experts TYPO3 avec  doxygen 1.4.6