oxutilsfile.php

Go to the documentation of this file.

<?php

class oxUtilsFile extends oxSuperCfg
{
    const PROMO_PICTURE_DIR = 'promo';

    private static $_instance = null;

    protected $_iMaxPicImgCount  = 12;

    protected $_iMaxZoomImgCount = 12;

    protected $_aTypeToPath = array( 'TC'   => 'master/category/thumb',
                                     'CICO' => 'master/category/icon',
                                     'PICO' => 'master/category/promo_icon',
                                     'MICO' => 'master/manufacturer/icon',
                                     'VICO' => 'master/vendor/icon',
                                     'PROMO'=> self::PROMO_PICTURE_DIR,
                                     'ICO'  => 'master/product/icon',
                                     'TH'   => 'master/product/thumb',
                                     'M1'   => 'master/product/1',
                                     'M2'   => 'master/product/2',
                                     'M3'   => 'master/product/3',
                                     'M4'   => 'master/product/4',
                                     'M5'   => 'master/product/5',
                                     'M6'   => 'master/product/6',
                                     'M7'   => 'master/product/7',
                                     'M8'   => 'master/product/8',
                                     'M9'   => 'master/product/9',
                                     'M10'  => 'master/product/10',
                                     'M11'  => 'master/product/11',
                                     'M12'  => 'master/product/12',
                                     //
                                     'P1'   => '1',
                                     'P2'   => '2',
                                     'P3'   => '3',
                                     'P4'   => '4',
                                     'P5'   => '5',
                                     'P6'   => '6',
                                     'P7'   => '7',
                                     'P8'   => '8',
                                     'P9'   => '9',
                                     'P10'  => '10',
                                     'P11'  => '11',
                                     'P12'  => '12',
                                     'Z1'   => 'z1',
                                     'Z2'   => 'z2',
                                     'Z3'   => 'z3',
                                     'Z4'   => 'z4',
                                     'Z5'   => 'z5',
                                     'Z6'   => 'z6',
                                     'Z7'   => 'z7',
                                     'Z8'   => 'z8',
                                     'Z9'   => 'z9',
                                     'Z10'  => 'z10',
                                     'Z11'  => 'z11',
                                     'Z12'  => 'z12',
                                     //
                                     'WP'   => 'master/wrapping',
                                     'FL'   => 'media',
    );

    protected $_aBadFiles = array( 'php', 'php3', 'php4', 'php5', 'phps', 'php6', 'jsp', 'cgi', 'cmf', 'exe' );

    protected $_aAllowedFiles = array( 'gif', 'jpg', 'jpeg', 'png', 'pdf' );
    
    protected $_iNewFilesCounter = 0;
    
    public static function getInstance()
    {
        // disable caching for test modules
        if ( defined( 'OXID_PHP_UNIT' ) ) {
            self::$_instance = modInstances::getMod( __CLASS__ );
        }

        if ( !self::$_instance instanceof oxUtilsFile ) {

            self::$_instance = oxNew( 'oxUtilsFile' );
            if ( defined( 'OXID_PHP_UNIT' ) ) {
                modInstances::addMod( __CLASS__, self::$_instance);
            }
        }
        return self::$_instance;
    }

    public function __construct()
    {
        $myConfig = $this->getConfig();

        if ( $iPicCount = $myConfig->getConfigParam( 'iPicCount' ) ) {
            $this->_iMaxPicImgCount = $iPicCount;
        }

        $this->_iMaxZoomImgCount = $this->_iMaxPicImgCount;
    }

    public function getNewFilesCounter()
    {
        return $this->_iNewFilesCounter;
    }
    
    protected function _setNewFilesCounter( $iNewFilesCounter )
    {
        $this->_iNewFilesCounter = (int) $iNewFilesCounter;
    }

    public function normalizeDir( $sDir )
    {
        if ( isset($sDir) && $sDir != "" && substr($sDir, -1) !== '/' ) {
            $sDir .= "/";
        }

        return $sDir;
    }

    public function copyDir( $sSourceDir, $sTargetDir )
    {
        $oStr = getStr();
        $handle = opendir( $sSourceDir );
        while ( false !== ( $file = readdir( $handle ) ) ) {
            if ( $file != '.' && $file != '..' ) {
                if ( is_dir( $sSourceDir.'/'.$file ) ) {

                    // recursive
                    $sNewSourceDir = $sSourceDir.'/'.$file;
                    $sNewTargetDir = $sTargetDir.'/'.$file;
                    if ( strcasecmp( $file, 'CVS' ) &&  strcasecmp( $file, '.svn' )) {
                        @mkdir( $sNewTargetDir, 0777 );
                        $this->copyDir( $sNewSourceDir, $sNewTargetDir );
                    }
                } else {
                    $sSourceFile = $sSourceDir.'/'.$file;
                    $sTargetFile = $sTargetDir.'/'.$file;

                    //do not copy files within dyn_images
                    if ( !$oStr->strstr( $sSourceDir, 'dyn_images' ) ||  $file == 'nopic.jpg' || $file == 'nopic_ico.jpg' ) {
                        @copy( $sSourceFile, $sTargetFile );
                    }
                }
            }
        }
        closedir($handle);
    }

    public function deleteDir( $sSourceDir )
    {
        if ( is_dir( $sSourceDir ) ) {
            if ( $oDir = dir( $sSourceDir ) ) {

                while ( false !== $sFile = $oDir->read() ) {
                    if ( $sFile == '.' || $sFile == '..' ) {
                        continue;
                    }

                    if ( !$this->deleteDir( $oDir->path . DIRECTORY_SEPARATOR . $sFile ) ) {
                        $oDir->close();
                        return false;
                    }
                }

                $oDir->close();
                return rmdir( $sSourceDir );
            }
        } elseif ( file_exists( $sSourceDir ) ) {
            return unlink ( $sSourceDir );
        }
    }

    public function readRemoteFileAsString( $sPath )
    {
        $sRet  = '';
        $hFile = @fopen( $sPath, 'r' );
        if ( $hFile ) {
            socket_set_timeout( $hFile, 2 );
            while ( !feof( $hFile ) ) {
                $sLine = fgets( $hFile, 4096 );
                $sRet .= $sLine;
            }
            fclose( $hFile );
        }

        return $sRet;
    }

    protected function _prepareImageName( $sValue, $sType, $blDemo, $sImagePath, $blUnique = true )
    {
        if ( $sValue ) {
            // add type to name
            $aFilename = explode( ".", $sValue );

            $sFileType = trim( $aFilename[count( $aFilename )-1] );

            if ( isset( $sFileType ) ) {

                $oStr = getStr();

                // unallowed files ?
                if ( in_array( $sFileType, $this->_aBadFiles ) || ( $blDemo && !in_array( $sFileType, $this->_aAllowedFiles ) ) ) {
                    oxUtils::getInstance()->showMessageAndExit( "We don't play this game, go away" );
                }

                // removing file type
                if ( count( $aFilename ) > 0 ) {
                    unset( $aFilename[count( $aFilename )-1] );
                }

                $sFName = '';
                if ( isset( $aFilename[0] ) ) {
                    $sFName = $oStr->preg_replace( '/[^a-zA-Z0-9()_\.-]/', '', implode( '.', $aFilename ) );
                }

                $sValue = $this->_getUniqueFileName( $sImagePath, "{$sFName}", $sFileType, "", $blUnique );
            }
        }
        return $sValue;
    }

    protected function _getImagePath( $sType )
    {
        $sFolder = array_key_exists( $sType, $this->_aTypeToPath ) ? $this->_aTypeToPath[ $sType ] : '0';
        $sPath = $this->normalizeDir( $this->getConfig()->getPictureDir(false) ) . "{$sFolder}/";
        return $sPath;
    }

    protected function _getImageSize( $sImgType, $iImgNum, $sImgConf )
    {
        $myConfig = $this->getConfig();
        $sSize = false;

        switch ( $sImgConf ) {
            case 'aDetailImageSizes':
                $aDetailImageSizes = $myConfig->getConfigParam( $sImgConf );
                $sSize = $myConfig->getConfigParam( 'sDetailImageSize' );
                if ( isset( $aDetailImageSizes['oxpic'.$iImgNum] ) ) {
                    $sSize = $aDetailImageSizes['oxpic'.$iImgNum];
                }
                break;
            default:
                $sSize = $myConfig->getConfigParam( $sImgConf );
                break;
        }
        if ( $sSize ) {
            return explode( '*', $sSize );
        }
    }

    protected function _copyFile( $sSource, $sTarget )
    {
        $blDone = false;

        if ( $sSource === $sTarget ) {
            $blDone = true;
        } else {
            $blDone = copy( $sSource, $sTarget );
        }

        if ( $blDone ) {
            $blDone = @chmod( $sTarget, 0644 );
        }

        return $blDone;
    }

    protected function _moveImage( $sSource, $sTarget )
    {
        $blDone = false;

        if ( $sSource === $sTarget ) {
            $blDone = true;
        } else {
            $blDone = move_uploaded_file( $sSource, $sTarget );
        }

        if ( $blDone ) {
            $blDone = @chmod( $sTarget, 0644 );
        }

        return $blDone;
    }

    public function processFiles( $oObject = null, $aFiles = array(), $blUseMasterImage = false, $blUnique = true )
    {
        $aFiles = $aFiles ? $aFiles : $_FILES;
        if ( isset( $aFiles['myfile']['name'] ) ) {

            $oConfig = $this->getConfig();
            $oStr = getStr();

            // A. protection for demoshops - strictly defining allowed file extensions
            $blDemo = (bool) $oConfig->isDemoShop();

            // folder where images will be processed
            $sTmpFolder = $oConfig->getConfigParam( "sCompileDir" );

            $iNewFilesCounter = 0;
            $aSource   = $aFiles['myfile']['tmp_name'];
            $aError    = $aFiles['myfile']['error'];
            $sErrorsDescription = '';

            $oEx = oxNew( "oxExceptionToDisplay" );
            // process all files
            while ( list( $sKey, $sValue ) = each( $aFiles['myfile']['name'] ) ) {

                $sSource   = $aSource[$sKey];
                $iError    = $aError[$sKey];
                $aFiletype = explode( "@", $sKey );
                $sKey      = $aFiletype[1];
                $sType     = $aFiletype[0];

                $sValue  = strtolower( $sValue );
                $sImagePath = $this->_getImagePath( $sType );
                
                // Should translate error to user if file was uploaded
                if ( UPLOAD_ERR_OK !== $iError && UPLOAD_ERR_NO_FILE !== $iError ) {
                    $sErrorsDescription = $this->translateError( $iError );
                    $oEx->setMessage( $sErrorsDescription );
                    oxUtilsView::getInstance()->addErrorToDisplay( $oEx, false );
                }

                // checking file type and building final file name
                if ( $sSource && ( $sValue = $this->_prepareImageName( $sValue, $sType, $blDemo, $sImagePath, $blUnique ) ) ) {
                    // moving to tmp folder for processing as safe mode or spec. open_basedir setup
                    // usually does not allow file modification in php's temp folder
                    $sProcessPath = $sTmpFolder . basename( $sSource );

                    if ( $sProcessPath ) {

                        if ( $blUseMasterImage ) {
                            //using master image as source, so only copying it to
                            $blMoved = $this->_copyFile( $sSource, $sImagePath . $sValue );
                        } else {
                            $blMoved = $this->_moveImage( $sSource, $sImagePath . $sValue );
                        }

                        if ( $blMoved ) {
                            // New image successfully add.
                            $iNewFilesCounter++;
                            // assign the name
                            if ( $oObject && isset( $oObject->$sKey ) ) {
                                $oObject->{$sKey}->setValue( $sValue );
                            }
                        }
                    }
                }
            }
            
            $this->_setNewFilesCounter( $iNewFilesCounter );
        }

        return $oObject;
    }

    function checkFile( $sFile )
    {
        $aCheckCache = oxSession::getVar("checkcache");

        if ( isset( $aCheckCache[$sFile] ) ) {
            return $aCheckCache[$sFile];
        }

        $blRet = false;

        if (is_readable( $sFile)) {
            $blRet = true;
        } else {
            // try again via socket
            $blRet = $this->urlValidate( $sFile );
        }

        $aCheckCache[$sFile] = $blRet;
        oxSession::setVar( "checkcache", $aCheckCache );

        return $blRet;
    }

    function urlValidate( $sLink )
    {
        $aUrlParts = @parse_url( $sLink );
        $sHost = ( isset( $aUrlParts["host"] ) && $aUrlParts["host"] ) ? $aUrlParts["host"] : null;

        $blValid = false;
        if ( $sHost ) {
            $sDocumentPath  = ( isset( $aUrlParts["path"] ) && $aUrlParts["path"] ) ? $aUrlParts["path"] : '/';
            $sDocumentPath .= ( isset( $aUrlParts["query"] ) && $aUrlParts["query"] ) ? '?' . $aUrlParts["query"] : '';

            $sPort = ( isset( $aUrlParts["port"] ) && $aUrlParts["port"] ) ? $aUrlParts["port"] : '80';

            // Now (HTTP-)GET $documentpath at $sHost";
            if ( ( $oConn = @fsockopen( $sHost, $sPort, $iErrNo, $sErrStr, 30 ) ) ) {
                fwrite ( $oConn, "HEAD {$sDocumentPath} HTTP/1.0\r\nHost: {$sHost}\r\n\r\n" );
                $sResponse = fgets( $oConn, 22 );
                fclose( $oConn );

                if ( preg_match( "/200 OK/", $sResponse ) ) {
                    $blValid = true;
                }
            }
        }

        return $blValid;
    }

    public function handleUploadedFile($aFileInfo, $sUploadPath)
    {
        $sBasePath = $this->getConfig()->getConfigParam('sShopDir');

        //checking params
        if ( !isset( $aFileInfo['name'] ) || !isset( $aFileInfo['tmp_name'] ) ) {
            throw oxNew( "oxException", 'EXCEPTION_NOFILE' );
        }

        //wrong chars in file name?
        if ( !getStr()->preg_match('/^[\-_a-z0-9\.]+$/i', $aFileInfo['name'] ) ) {
            throw oxNew( "oxException", 'EXCEPTION_FILENAMEINVALIDCHARS' );
        }

        // error uploading file ?
        if ( isset( $aFileInfo['error'] ) && $aFileInfo['error'] ) {
            throw oxNew( "oxException", 'EXCEPTION_FILEUPLOADERROR_'.( (int) $aFileInfo['error'] ) );
        }

        $aPathInfo = pathinfo($aFileInfo['name']);

        $sExt = $aPathInfo['extension'];
        $sFileName = $aPathInfo['filename'];

        $aAllowedUploadTypes = (array) $this->getConfig()->getConfigParam( 'aAllowedUploadTypes' );
        $aAllowedUploadTypes = array_map( "strtolower", $aAllowedUploadTypes );
        if ( !in_array( strtolower( $sExt ), $aAllowedUploadTypes ) ) {
            throw oxNew( "oxException", 'EXCEPTION_NOTALLOWEDTYPE' );
        }

        $sFileName = $this->_getUniqueFileName( $sBasePath . $sUploadPath, $sFileName, $sExt );
        $this->_moveImage( $aFileInfo['tmp_name'], $sBasePath . $sUploadPath . "/" . $sFileName );

        $sUrl = $this->getConfig()->getShopUrl() . $sUploadPath . "/" . $sFileName;

        //removing dublicate slashes
        $sUrl = str_replace('//', '/', $sUrl);
        $sUrl = str_replace(array('http:/', 'https:/'), array('http://', 'https://'), $sUrl);

        return $sUrl;
    }

    public function processFile( $sFileName, $sUploadPath )
    {
        $aFileInfo = $_FILES[$sFileName];

        $sBasePath = $this->getConfig()->getConfigParam('sShopDir');

        //checking params
        if ( !isset( $aFileInfo['name'] ) || !isset( $aFileInfo['tmp_name'] ) ) {
            throw oxNew( "oxException", 'EXCEPTION_NOFILE' );
        }

        //wrong chars in file name?
        if ( !getStr()->preg_match('/^[\-_a-z0-9\.]+$/i', $aFileInfo['name'] ) ) {
            throw oxNew( "oxException", 'EXCEPTION_FILENAMEINVALIDCHARS' );
        }

        // error uploading file ?
        if ( isset( $aFileInfo['error'] ) && $aFileInfo['error'] ) {
            throw oxNew( "oxException", 'EXCEPTION_FILEUPLOADERROR_'.( (int) $aFileInfo['error'] ) );
        }

        $aPathInfo = pathinfo($aFileInfo['name']);

        $sExt = $aPathInfo['extension'];
        $sFileName = $aPathInfo['filename'];

        $aAllowedUploadTypes = (array) $this->getConfig()->getConfigParam( 'aAllowedUploadTypes' );
        $aAllowedUploadTypes = array_map( "strtolower", $aAllowedUploadTypes );

        if ( !in_array( strtolower( $sExt ), $aAllowedUploadTypes ) ) {
            throw oxNew( "oxException", 'EXCEPTION_NOTALLOWEDTYPE' );
        }

        $sFileName = $this->_getUniqueFileName( $sBasePath . $sUploadPath, $sFileName, $sExt );

        if ( $this->_moveImage( $aFileInfo['tmp_name'], $sBasePath . $sUploadPath . "/" . $sFileName ) ) {
            return $sFileName ;
        } else {
            return false;
        }
    }

    protected function _getUniqueFileName( $sFilePath, $sFileName, $sFileExt, $sSufix = "", $blUnique = true )
    {
        $sFilePath     = $this->normalizeDir( $sFilePath );
        $iFileCounter  = 0;
        $sTempFileName = $sFileName;
        $oStr = getStr();

        //file exists ?
        while ( $blUnique && file_exists( $sFilePath . "/" . $sFileName . $sSufix . "." . $sFileExt ) ) {
            $iFileCounter++;

            //removing "(any digit)" from file name end
            $sTempFileName = $oStr->preg_replace("/\(".$iFileCounter."\)/", "", $sTempFileName );

            $sFileName = $sTempFileName . "($iFileCounter)";
        }

        return $sFileName . $sSufix . "." . $sFileExt;
    }

    public function getImageDirByType( $sType )
    {
        $sFolder = array_key_exists( $sType, $this->_aTypeToPath ) ? $this->_aTypeToPath[ $sType ] : '0';
        return $this->normalizeDir( $sFolder );
    }
    
    function translateError( $iError )
    {
        $message = '';
        // Translate only if translation exist
        if ( $iError > 0 && $iError < 9 && 5 !== $iError ) {
            $message = 'EXCEPTION_FILEUPLOADERROR_'.( (int) $iError );
        }
        
        return $message; 
    }
}