"TYPO3 4.0.1: typo3_src-4.0.1/t3lib/class.t3lib_basicfilefunc.php Source File", "datetime" => "Sat Dec 2 19:22:17 2006", "date" => "2 Dec 2006", "doxygenversion" => "1.4.6", "projectname" => "TYPO3 4.0.1", "projectnumber" => "4.0.1" ); get_header($doxygen_vars); ?>

class.t3lib_basicfilefunc.php

<?php
/***************************************************************
*  Copyright notice
*
*  (c) 1999-2006 Kasper Skaarhoj (kasperYYYY@typo3.com)
*  All rights reserved
*
*  This script is part of the TYPO3 project. The TYPO3 project is
*  free software; you can redistribute it and/or modify
*  it under the terms of the GNU General Public License as published by
*  the Free Software Foundation; either version 2 of the License, or
*  (at your option) any later version.
*
*  The GNU General Public License can be found at
*  http://www.gnu.org/copyleft/gpl.html.
*  A copy is found in the textfile GPL.txt and important notices to the license
*  from the author is found in LICENSE.txt distributed with these scripts.
*
*
*  This script is distributed in the hope that it will be useful,
*  but WITHOUT ANY WARRANTY; without even the implied warranty of
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
*  GNU General Public License for more details.
*
*  This copyright notice MUST APPEAR in all copies of the script!
***************************************************************/
require_once(PATH_t3lib.'class.t3lib_cs.php');


class t3lib_basicFileFunctions  {
        var $getUniqueNamePrefix = '';  // Prefix which will be prepended the file when using the getUniqueName-function
        var $maxNumber = 20;                    // This number decides the highest allowed appended number used on a filename before we use naming with unique strings
        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.
        var $maxInputNameLen = 60;              // This is the maximum length of names treated by cleanFileName()
        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)

                // internal
        var $f_ext = Array();                   // See comment in header
        var $mounts = Array();                  // See comment in header
        var $webPath ='';                               // Set to DOCUMENT_ROOT.
        var $isInit = 0;                                // Set to true after init()/start();



        /**********************************
         *
         * Checking functions
         *
         **********************************/

        function init($mounts, $f_ext)  {
                $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;

                $this->maxInputNameLen = $GLOBALS['TYPO3_CONF_VARS']['SYS']['maxFileNameLength'] ? $GLOBALS['TYPO3_CONF_VARS']['SYS']['maxFileNameLength'] : $this->maxInputNameLen;
        }

        function getTotalFileInfo($wholePath)   {
                $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['writable'] = !@is_writable($wholePath);
                $info['readable'] = !@is_readable($wholePath);
                return $info;
        }

        function is_allowed($iconkey,$type)     {
                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;
        }

        function checkIfFullAccess($theDest)    {
                $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;
                }
        }

        function is_webpath($path)      {
                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...
        }

        function checkIfAllowed($ext, $theDest, $filename='')   {
                return t3lib_div::verifyFilenameAgainstDenyPattern($filename) && $this->is_allowed($ext,($this->is_webpath($theDest)?'webspace':'ftpspace'));
        }

        function checkFileNameLen($fileName)    {
                return strlen($fileName) <= $this->maxInputNameLen;
        }

        function is_directory($theDir)  {
                if ($this->isPathValid($theDir))        {
                        $theDir=$this->cleanDirectoryName($theDir);
                        if (@is_dir($theDir))   {
                                return $theDir;
                        }
                }
                return false;
        }

        function isPathValid($theFile)  {
                return t3lib_div::validPathStr($theFile);
        }

        function getUniqueName($theFile, $theDest, $dontCheckForUnique=0)       {
                $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 = preg_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;
                                }
                        }
                }
        }

        function checkPathAgainstMounts($thePath)       {
                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;
                                }
                        }
                }
        }

        function findFirstWebFolder()   {
                global $TYPO3_CONF_VARS;

                if (is_array($this->mounts))    {
                        reset ($this->mounts);
                        while(list($k,$val)=each($this->mounts))        {
                                if (t3lib_div::isFirstPartOfStr($val['path'], PATH_site.$TYPO3_CONF_VARS['BE']['fileadminDir']))        {
                                        return $k;
                                }
                        }
                }
        }

        function blindPath($thePath)    {
                $k=$this->checkPathAgainstMounts($thePath);
                if ($k) {
                        $name='';
                        $name.='['.$this->mounts[$k]['name'].']: ';
                        $name.=substr($thePath,strlen($this->mounts[$k]['path']));
                        return $name;
                }
        }

        function findTempFolder()       {
                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;
                                }
                        }
                }
        }











        /*********************
         *
         * Cleaning functions
         *
         *********************/

        function cleanDirectoryName($theDir)    {
                return preg_replace('/[\/\. ]*$/','',$this->rmDoubleSlash($theDir));
        }

        function rmDoubleSlash($string) {
                return str_replace('//','/',$string);
        }

        function slashPath($path)       {
                if (substr($path,-1)!='/')      {
                        return $path.'/';
                }
                return $path;
        }

        function cleanFileName($fileName,$charset='')   {
                if (!is_object($this->csConvObj))       {
                        if (TYPO3_MODE=='FE')   {
                                $this->csConvObj = &$GLOBALS['TSFE']->csConvObj;
                        } elseif (is_object($GLOBALS['LANG']))  {       // BE assumed:
                                $this->csConvObj = &$GLOBALS['LANG']->csConvObj;
                        } else {        // The object may not exist yet, so we need to create it now. Happens in the Install Tool for example.
                                $this->csConvObj = &t3lib_div::makeInstance('t3lib_cs');
                        }
                }

                if (!$charset)  {
                        if (TYPO3_MODE=='FE')   {
                                $charset = $GLOBALS['TSFE']->renderCharset;
                        } elseif (is_object($GLOBALS['LANG']))  {       // BE assumed:
                                $charset = $GLOBALS['LANG']->charSet;
                        } else {        // best guess
                                $charset = $GLOBALS['TYPO3_CONF_VARS']['BE']['forceCharset'];
                        }
                }

                if ($charset)   {
                        $fileName = $this->csConvObj->specCharsToASCII($charset,$fileName);
                }

                return preg_replace('/[^.[:alnum:]_-]/','_',trim($fileName));
        }

        function formatSize($sizeInBytes)       {
                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;';
                }
        }
}



if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_basicfilefunc.php'])     {
        include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_basicfilefunc.php']);
}
?>