oxpicturehandler.php

Go to the documentation of this file.

<?php

class oxPictureHandler extends oxSuperCfg
{
    private static $_instance = null;

    public static function getInstance()
    {
        // disable caching for test modules
        if ( defined( 'OXID_PHP_UNIT' ) ) {
            self::$_instance = modInstances::getMod( __CLASS__ );
        }

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

    public function deleteArticleMasterPicture( $oObject, $iIndex, $blDeleteMasterPicture = true )
    {
        $myConfig   = $this->getConfig();
        $myUtilsPic = oxUtilsPic::getInstance();
        $oUtilsFile = oxUtilsFile::getInstance();
        $blGeneratedImagesOnly = !$blDeleteMasterPicture;

        $sAbsDynImageDir = $myConfig->getPictureDir(false);
        $sMasterImage = basename( $oObject->{"oxarticles__oxpic".$iIndex}->value );
        if ( !$sMasterImage || $sMasterImage == "nopic.jpg" ) {
            return;
        }

        $aPic = array("sField"    => "oxpic".$iIndex,
                      "sDir"      => $oUtilsFile->getImageDirByType( "M".$iIndex, $blGeneratedImagesOnly ),
                      "sFileName" => $sMasterImage);

        $blDeleted = $myUtilsPic->safePictureDelete( $aPic["sFileName"], $sAbsDynImageDir . $aPic["sDir"], "oxarticles", $aPic["sField"] );
        if ( $blDeleted ) {
            $this->deleteZoomPicture( $oObject, $iIndex );

            $aDelPics = array();
            if ( $iIndex == 1 ) {
                // deleting generated main icon picture if custom main icon
                // file name not equal with generated from master picture
                if ( $this->getMainIconName( $sMasterImage ) != basename($oObject->oxarticles__oxicon->value) ) {
                    $aDelPics[] = array("sField"    => "oxpic1",
                                        "sDir"      => $oUtilsFile->getImageDirByType( "ICO", $blGeneratedImagesOnly ),
                                        "sFileName" => $this->getMainIconName( $sMasterImage ));
                }

                // deleting generated thumbnail picture if custom thumbnail
                // file name not equal with generated from master picture
                if ( $this->getThumbName( $sMasterImage ) != basename($oObject->oxarticles__oxthumb->value) ) {
                    $aDelPics[] = array("sField"    => "oxpic1",
                                        "sDir"      => $oUtilsFile->getImageDirByType( "TH", $blGeneratedImagesOnly ),
                                        "sFileName" => $this->getThumbName( $sMasterImage ));
                }
            }

            foreach ( $aDelPics as $aPic ) {
                $myUtilsPic->safePictureDelete( $aPic["sFileName"], $sAbsDynImageDir . $aPic["sDir"], "oxarticles", $aPic["sField"] );
            }
        }

        //deleting custom zoom pic (compatibility mode)
        if ( $oObject->{"oxarticles__oxzoom".$iIndex}->value ) {
            if ( basename($oObject->{"oxarticles__oxzoom".$iIndex}->value) !== "nopic.jpg" ) {
                // deleting old zoom picture
                $this->deleteZoomPicture( $oObject, $iIndex );
            }
        }

    }

    public function deleteMainIcon( $oObject )
    {
        if ( ( $sMainIcon = $oObject->oxarticles__oxicon->value ) ) {
            $sPath = $this->getConfig()->getPictureDir( false ) . oxUtilsFile::getInstance()->getImageDirByType( "ICO" );
            oxUtilsPic::getInstance()->safePictureDelete( $sMainIcon, $sPath, "oxarticles", "oxicon" );
        }
    }

    public function deleteThumbnail( $oObject )
    {
        if ( ( $sThumb = $oObject->oxarticles__oxthumb->value ) ) {
            // deleting article main icon and thumb picture
            $sPath = $this->getConfig()->getPictureDir( false ) . oxUtilsFile::getInstance()->getImageDirByType( "TH" );
            oxUtilsPic::getInstance()->safePictureDelete( $sThumb, $sPath, "oxarticles", "oxthumb" );
        }
    }

    public function deleteZoomPicture( $oObject, $iIndex )
    {
        // checking if oxzoom field exists
        $oDbHandler = oxNew( "oxDbMetaDataHandler" );
        $iZoomPicCount = (int) $this->getConfig()->getConfigParam( 'iZoomPicCount' );

        if ( $iIndex > $iZoomPicCount || !$oDbHandler->fieldExists( "oxzoom".$iIndex, "oxarticles" ) ) {
            if ( $sZoomPicName = $this->getZoomName( $oObject->{"oxarticles__oxpic".$iIndex}->value, $iIndex ) ) {
                $sFieldToCheck = "oxpic".$iIndex;
            } else {
                return;
            }
        } else {
            $sZoomPicName = basename( $oObject->{"oxarticles__oxzoom".$iIndex}->value );
            $sFieldToCheck = "oxzoom".$iIndex;
        }

        if ( $sZoomPicName && $sZoomPicName != "nopic.jpg" ) {
            // deleting zoom picture
            $sPath = $this->getConfig()->getPictureDir( false ) . oxUtilsFile::getInstance()->getImageDirByType( "Z" . $iIndex );
            oxUtilsPic::getInstance()->safePictureDelete( $sZoomPicName, $sPath, "oxarticles", $sFieldToCheck );
        }
    }

    public function getIconName( $sFilename )
    {
        return $sFilename;
    }

    public function getMainIconName( $sMasterImageFile )
    {
        return $this->_getBaseMasterImageFileName( $sMasterImageFile );
    }

    public function getThumbName( $sMasterImageFile )
    {
        return basename( $sMasterImageFile );
    }

    public function getZoomName( $sMasterImageFile, $iIndex )
    {
        return basename( $sMasterImageFile );
    }

    protected function _getBaseMasterImageFileName( $sMasterImageFile )
    {
        return basename( $sMasterImageFile );
    }

    public function getImageSize($aImgSizes, $sIndex = null)
    {
        if (isset($sIndex) && is_array($aImgSizes) && isset($aImgSizes[$sIndex])) {
            $aSize = explode('*', $aImgSizes[$sIndex]);
        } elseif (is_string ($aImgSizes)) {
            $aSize = explode('*', $aImgSizes);
        }
        if (2 == count($aSize)) {
            $x = (int)$aSize[0];
            $y = (int)$aSize[1];
            if ($x && $y) {
                return $aSize;
            }
        }
        return null;
    }

    protected function _getPictureInfo( $sFilePath, $sFile, $blAdmin = false, $blSSL = null, $iLang = null, $iShopId = null )
    {
        // custom server as image storage?
        if ( $sAltUrl = $this->getAltImageUrl($sFilePath, $sFile, $blSSL) ) {
            return array( 'path' => false, 'url'=> $sAltUrl );
        }

        $oConfig = $this->getConfig();
        $sPath = $oConfig->getPicturePath( $sFilePath . $sFile, $blAdmin, $iLang, $iShopId );
        if ( !$sPath ) {
            return array( 'path'=> false, 'url' => false );
        }

        $sDirPrefix = $oConfig->getOutDir();
        $sUrlPrefix = $oConfig->getOutUrl( $blSSL, $blAdmin, $oConfig->getConfigParam( 'blNativeImages' ) );

        return array( 'path' => $sPath, 'url'=> str_replace( $sDirPrefix, $sUrlPrefix, $sPath ) );
    }

    public function getAltImageUrl($sFilePath, $sFile, $blSSL = null)
    {
        $oConfig = $this->getConfig();

        $sAltUrl = $oConfig->getConfigParam('sAltImageUrl');
        if ( !$sAltUrl ) {
            $sAltUrl = $oConfig->getConfigParam('sAltImageDir');
        }

        if ( $sAltUrl ) {
            if ( (is_null($blSSL) && $oConfig->isSsl()) || $blSSL) {

                $sSslAltUrl = $oConfig->getConfigParam('sSSLAltImageUrl');
                if ( !$sSslAltUrl ) {
                    $sSslAltUrl = $oConfig->getConfigParam('sSSLAltImageDir');
                }

                if ( $sSslAltUrl ) {
                    $sAltUrl = $sSslAltUrl;
                }
            }

            if ( !is_null( $sFile ) ) {
                $sAltUrl .= '/'.$sFilePath.$sFile;
            }
        }

        return $sAltUrl;
    }

    public function getPicUrl( $sPath, $sFile, $sSize, $sIndex = null, $sAltPath = false, $bSsl = null )
    {
        $sUrl = null;
        if ( $sPath && $sFile && ( $aSize = $this->getImageSize( $sSize, $sIndex ) ) ) {

            $aPicInfo = $this->_getPictureInfo( "master/" . ( $sAltPath ? $sAltPath : $sPath ), $sFile, $this->isAdmin(), $bSsl );
            if ( $aPicInfo['url'] && $aSize[0] && $aSize[1] ) {
                $sDirName = "{$aSize[0]}_{$aSize[1]}_" . $this->getConfig()->getConfigParam( 'sDefaultImageQuality' );
                $sUrl = str_replace( "/master/" . ( $sAltPath ? $sAltPath : $sPath ), "/generated/{$sPath}{$sDirName}/", $aPicInfo['url'] );
            }
        }
        return $sUrl;
    }

    public function getProductPicUrl( $sPath, $sFile, $sSize, $sIndex = null, $bSsl = null )
    {
        $sUrl = null;
        if ( !$sFile || !( $sUrl = $this->getPicUrl( $sPath, $sFile, $sSize, $sIndex, false, $bSsl ) ) ) {
            $sUrl = $this->getPicUrl( $sPath, "nopic.jpg", $sSize, $sIndex, "/", $bSsl );
        }
        return $sUrl;
    }
}