oxconfig.php

Go to the documentation of this file.

<?php

define( 'MAX_64BIT_INTEGER', '18446744073709551615' );

class oxConfig extends oxSuperCfg
{
    // this column of params are defined in config.inc.php file,
    // so for backwards compat. names starts without underscore

    protected $dbHost = null;

    protected $dbName = null;

    protected $dbUser = null;

    protected $dbPwd  = null;

    protected $dbType = null;

    protected $sShopURL = null;

    protected $sSSLShopURL = null;

    protected $sAdminSSLURL = null;

    protected $sShopDir = null;

    protected $sCompileDir = null;

    protected $iDebug = 0;

    protected $sAdminEmail = null;

    protected $blSessionUseCookies = null;

    //protected $iMaxArticles = 6000;

    protected $blNativeImages = true;

    protected $aMultiShopTables = array( 'oxarticles', 'oxdiscount', 'oxcategories', 'oxattribute',
                                         'oxlinks', 'oxvoucherseries', 'oxmanufacturers',
                                         'oxnews', 'oxselectlist', 'oxwrapping',
                                         'oxdeliveryset', 'oxdelivery', 'oxvendor', 'oxobject2category');

    private static $_instance = null;

    private $_oStart = null;


    protected $_oActShop       = null;

    protected $_oActView       = null;

    protected $_aGlobalParams = array();

    protected $_aConfigParams = array();

    protected $_iLanguageId = null;

    protected $_iShopId = null;


    protected $_sOutDir = 'out';

    protected $_sImageDir = 'img';

    protected $_sPictureDir = 'pictures';

    protected $_sMasterPictureDir = 'master';

    protected $_sTemplateDir = 'tpl';

    protected $_sResourceDir = 'src';

    protected $_blIsSsl = null;

    protected $_aAbsDynImageDir = array();

    protected $_oActCurrencyObject = null;

    public function getConfigParam( $sName )
    {
        if ( isset( $this->$sName ) ) {
            return $this->$sName;
        } elseif ( isset ( $this->_aConfigParams[$sName] ) ) {
            return $this->_aConfigParams[$sName];
        }
    }

    public function setConfigParam( $sName, $sValue )
    {
        if ( isset( $this->$sName ) ) {
            $this->$sName = $sValue;
        } else {
            $this->_aConfigParams[$sName] = $sValue;
        }
    }

    public function init()
    {
        include getShopBasePath().'config.inc.php';
        include getShopBasePath().'core/oxconfk.php';

        //adding trailing slashes
        $oFileUtils = oxUtilsFile::getInstance();
        $this->sShopDir     = $oFileUtils->normalizeDir($this->sShopDir);
        $this->sCompileDir  = $oFileUtils->normalizeDir($this->sCompileDir);
        $this->sShopURL     = $oFileUtils->normalizeDir($this->sShopURL);
        $this->sSSLShopURL  = $oFileUtils->normalizeDir($this->sSSLShopURL);
        $this->sAdminSSLURL = $oFileUtils->normalizeDir($this->sAdminSSLURL);


        // some important defaults
        if( !$this->getConfigParam( 'sDefaultLang' ) )
            $this->setConfigParam( 'sDefaultLang', 0 );

        $blLogChangesInAdmin = $this->getConfigParam( 'blLogChangesInAdmin' );
        if( !isset( $blLogChangesInAdmin ) )
            $this->setConfigParam( 'blLogChangesInAdmin', false );

        $blCheckTemplates = $this->getConfigParam( 'blCheckTemplates' );
        if( !isset( $blCheckTemplates ) )
            $this->setConfigParam( 'blCheckTemplates', false );

        $blAllowArticlesubclass = $this->getConfigParam( 'blAllowArticlesubclass' );
        if( !isset( $blAllowArticlesubclass ) )
            $this->setConfigParam( 'blAllowArticlesubclass', false );

        $iAdminListSize = $this->getConfigParam( 'iAdminListSize' );
        if( !isset( $iAdminListSize ) )
            $this->setConfigParam( 'iAdminListSize', 9 );

        // #1173M  for EE - not all pic are deleted
        $iPicCount = $this->getConfigParam( 'iPicCount' );
        if( !isset( $iPicCount ) )
            $this->setConfigParam( 'iPicCount', 7 );

        $iZoomPicCount = $this->getConfigParam( 'iZoomPicCount' );
        if( !isset( $iZoomPicCount ) )
            $this->setConfigParam( 'iZoomPicCount', 4 );

        //max shop id default value
        $iMaxShopId = $this->getConfigParam( 'iMaxShopId' );
        if( !isset( $iMaxShopId ) )
            $this->setConfigParam( 'iMaxShopId', 64 );

        // disabling caching according to DODGER #655 : disable Caching as it doesnt work good enought
        $this->setConfigParam( 'blTemplateCaching', false );

        //setting ADODB timeout
        global  $ADODB_SESS_LIFE;
        $ADODB_SESS_LIFE  = 1;


            /*
        $iSessionTimeout = null;
        if ( $this->isAdmin())
            $iSessionTimeout = $this->getConfigParam( 'iSessionTimeoutAdmin' );
        if ( !$this->isAdmin() || !$iSessionTimeout )
            $iSessionTimeout = $this->getConfigParam( 'iSessionTimeout' );
        if (!$iSessionTimeout)
            $iSessionTimeout = 60;*/

        // ADODB cachelifetime
        $iDBCacheLifeTime = $this->getConfigParam( 'iDBCacheLifeTime' );
        if( !isset( $iDBCacheLifeTime ) )
            $this->setConfigParam( 'iDBCacheLifeTime', 3600 ); // 1 hour

        $sCoreDir = $this->getConfigParam( 'sShopDir' );
        $this->setConfigParam( 'sCoreDir', $sCoreDir.'/core/' );

        try {
            //starting up the session
            $this->getSession()->start();

            $sShopID = $this->getShopId();

            // load now
            $this->_loadVarsFromDb( $sShopID );

        } catch ( oxConnectionException $oEx ) {
            $oEx->debugOut();
            if ( defined( 'OXID_PHP_UNIT' ) ) {
                return false;
            } elseif ( 0 != $this->iDebug ) {
                oxUtils::getInstance()->showMessageAndExit( $oEx->getString() );
            } else {
                header( "HTTP/1.1 500 Internal Server Error");
                header( "Location: offline.html");
                header( "Connection: close");
            }
        } catch ( oxCookieException $oEx ) {
            // redirect to start page and display the error
            oxUtilsView::getInstance()->addErrorToDisplay( $oEx );
            oxUtils::getInstance()->redirect( $this->getShopHomeURL() .'cl=start', true, 302 );
        }

        //application initialization
        $this->_oStart = new oxStart();
        $this->_oStart->appInit();
    }

    public static function getInstance()
    {

        if ( defined( 'OXID_PHP_UNIT' ) ) {
            if ( isset( modConfig::$unitMOD ) && is_object( modConfig::$unitMOD ) ) {
                return modConfig::$unitMOD;
            }
        }

        if ( !self::$_instance instanceof oxConfig ) {
                //exceptions from here go directly to global exception handler
                //if no init is possible whole application has to die!
                self::$_instance = new oxConfig();
                self::$_instance->init();
        }
        return self::$_instance;
    }

    protected function _loadVarsFromDb( $sShopID, $aOnlyVars = null )
    {

        $sQ = "select oxvarname, oxvartype, DECODE( oxvarvalue, '".$this->getConfigParam( 'sConfigKey' )."') as oxvarvalue from oxconfig where oxshopid = '$sShopID'";
        // dodger, allow loading from some vars only from baseshop
        if ( $aOnlyVars !== null ) {
            $blSep = false;
            $sIn  = '';
            foreach ( $aOnlyVars as $sField ) {
                if ( $blSep ) {
                    $sIn .= ', ';
                }
                $sIn .= '"'.$sField.'"';
                $blSep = true;
            }
            $sQ .= ' and oxvarname in ( '.$sIn.' ) ';
        }

        $oRs = oxDb::getDb()->execute( $sQ );
        if ( $oRs != false && $oRs->recordCount() > 0 ) {
            while ( !$oRs->EOF ) {
                $sVarName = $oRs->fields[0];
                $sVarType = $oRs->fields[1];
                $sVarVal  = $oRs->fields[2];

                //in sShopURL and sSSLShopURL cases we skip (for admin or when URL values are not set)
                if ( ( $sVarName == 'sShopURL' || $sVarName == 'sSSLShopURL' ) &&
                    ( !$sVarVal || $this->isAdmin() === true ) ) {
                    $oRs->moveNext();
                    continue;
                }

                switch ( $sVarType ) {
                    case 'arr':
                    case 'aarr':
                        $this->setConfigParam( $sVarName, unserialize( $sVarVal ) );
                        break;
                    case 'bool':
                        $this->setConfigParam( $sVarName, ( $sVarVal == 'true' || $sVarVal == '1' ) );
                        break;
                    default:
                        $this->setConfigParam( $sVarName, $sVarVal );
                        break;
                }

                $oRs->moveNext();
            }
        }

    }

    public function pageClose()
    {
        return $this->_oStart->pageClose();
    }

    public static function getParameter(  $sName, $blRaw = false )
    {
        if ( defined( 'OXID_PHP_UNIT' ) ) {
            if ( isset( modConfig::$unitMOD ) && is_object( modConfig::$unitMOD ) ) {
                try{
                    return modConfig::getParameter(  $sName, $blRaw );
                } catch( Exception $e ) {
                    // if exception is thrown, use default
                }
            }
        }

        $sValue = null;
        if ( isset( $_SERVER['REQUEST_METHOD'] ) && $_SERVER['REQUEST_METHOD'] == 'POST' && isset( $_POST[$sName] ) ) {
            $sValue = $_POST[$sName];
        } elseif ( isset( $_SERVER['REQUEST_METHOD'] ) && $_SERVER['REQUEST_METHOD'] == 'GET' && isset( $_GET[$sName] ) ) {
            $sValue = $_GET[$sName];
            //<deprecated>
        } elseif ( oxSession::hasVar( $sName ) ) {
            $sValue = oxSession::getVar( $sName );
            //</deprecated>
        } else {
            $sValue = null;
        }

        // TODO: remove this after special charts concept implementation
        $blIsAdmin = oxConfig::getInstance()->isAdmin() && oxSession::getVar("blIsAdmin");
        if ( $sValue != null && !$blIsAdmin && (!$blRaw || is_array($blRaw))) {
            self::checkSpecialChars( $sValue, $blRaw );
        }

        return $sValue;
    }

    public function getUploadedFile($sParamName)
    {
        return $_FILES[$sParamName];
    }

    public function setGlobalParameter( $sName, $sValue )
    {
        $this->_aGlobalParams[$sName] = $sValue;
    }

    public function getGlobalParameter( $sName )
    {
        if ( isset( $this->_aGlobalParams[$sName] ) ) {
            return $this->_aGlobalParams[$sName];
        } else {
            return null;
        }
    }

    public static function checkSpecialChars( & $sValue, $aRaw = null )
    {
        if ( is_object( $sValue ) ) {
            return $sValue;
        }

        if ( is_array( $sValue ) ) {
            $newValue = array();
            foreach ( $sValue as $sKey => $sVal ) {
                $sValidKey = $sKey;
                if ( !$aRaw || !in_array($sKey, $aRaw) ) {
                    self::checkSpecialChars( $sValidKey );
                    self::checkSpecialChars( $sVal );
                    if ($sValidKey != $sKey) {
                        unset ($sValue[$sKey]);
                    }
                }
                $newValue[$sValidKey] = $sVal;
            }
            $sValue = $newValue;
        } else {
            $sValue = str_replace( array( '&',     '<',    '>',    '"',      "'",      chr(0), '\\' ),
                                   array( '&amp;', '&lt;', '&gt;', '&quot;', '&#039;', '',     '&#092;' ),
                                   $sValue );
        }
        return $sValue;
    }

    public function getShopId()
    {
        if ( $this->_iShopId !== null )
            return $this->_iShopId;

            $this->_iShopId = $this->getBaseShopId();


        oxSession::setVar( 'actshop', $this->_iShopId );
        return $this->_iShopId;
    }


    public function setShopId( $sShopId )
    {
        oxSession::setVar( 'actshop', $sShopId );
        $this->_iShopId = $sShopId;
    }


    public function isSsl()
    {
        if ( is_null( $this->_blIsSsl ) ) {

            $myUtilsServer   = oxUtilsServer::getInstance();
            $aServerVars     = $myUtilsServer->getServerVar();
            $aHttpsServerVar = $myUtilsServer->getServerVar( 'HTTPS' );

            $this->_blIsSsl = ( isset( $aHttpsServerVar ) && ( $this->getConfigParam( 'sSSLShopURL' ) || $this->getConfigParam( 'sMallSSLShopURL' ) ) &&
                         ( $aHttpsServerVar === 'on' || $aHttpsServerVar == '1' ) ); // "1&1" hoster provides "1"

            //additional special handling for profihost customers
            if ( isset( $aServerVars['HTTP_X_FORWARDED_SERVER'] ) &&
                 ( strpos( $aServerVars['HTTP_X_FORWARDED_SERVER'], 'ssl' ) !== false ||
                 strpos( $aServerVars['HTTP_X_FORWARDED_SERVER'], 'secure-online-shopping.de' ) !== false ) ) {
                $this->_blIsSsl = true;
            }
        }

        return $this->_blIsSsl;
    }

    public function isCurrentUrl( $sURL )
    {
        if ( !$sURL ) {
            return false;
        }

        $oUtilsServer = oxUtilsServer::getInstance();
        $sHost = $oUtilsServer->getServerVar( 'HTTP_HOST' );
        $sScriptName = $oUtilsServer->getServerVar( 'SCRIPT_NAME' );

        $sCurrentHost = preg_replace( '/\/\w*\.php.*/', '', $sHost . $sScriptName );

        //remove double slashes all the way
        $sCurrentHost = str_replace( '/', '', $sCurrentHost );
        $sURL = str_replace( '/', '', $sURL );

        //so far comparing for the host is enought for us
        if ( getStr()->strpos( $sURL, $sCurrentHost ) !== false ) {
            return true;
        }

        return false;
    }

    public function getShopUrl( $iLang = null, $blAdmin = null )
    {
        $blAdmin = isset( $blAdmin ) ? $blAdmin : $this->isAdmin();
        if ( $blAdmin ) {
            return $this->getConfigParam( 'sShopURL' );
        }

        // #680 per language another URL
        $iLang = isset( $iLang ) ? $iLang : oxLang::getInstance()->getBaseLanguage();
        $aLanguageURLs = $this->getConfigParam( 'aLanguageURLs' );
        if ( isset( $iLang ) && isset( $aLanguageURLs[$iLang] ) && !empty( $aLanguageURLs[$iLang] ) ) {
            $aLanguageURLs[$iLang] = oxUtils::getInstance()->checkUrlEndingSlash( $aLanguageURLs[$iLang] );
            return $aLanguageURLs[$iLang];
        }

        //normal section
        $sMallShopURL = $this->getConfigParam( 'sMallShopURL' );
        if ( $sMallShopURL ) {
            $sMallShopURL = oxUtils::getInstance()->checkUrlEndingSlash( $sMallShopURL );
            return $sMallShopURL;
        }

        return $this->getConfigParam( 'sShopURL' );
    }

    public function getSslShopUrl( $iLang = null )
    {
        // #680 per language another URL
        $iLang = isset( $iLang ) ? $iLang : oxLang::getInstance()->getBaseLanguage();
        $aLanguageSSLURLs = $this->getConfigParam( 'aLanguageSSLURLs' );
        if ( isset( $iLang ) && isset( $aLanguageSSLURLs[$iLang] ) && !empty( $aLanguageSSLURLs[$iLang] ) ) {
            $aLanguageSSLURLs[$iLang] = oxUtils::getInstance()->checkUrlEndingSlash( $aLanguageSSLURLs[$iLang] );
            return $aLanguageSSLURLs[$iLang];
        }

        //mall mode
        if ( ( $sMallSSLShopURL = $this->getConfigParam( 'sMallSSLShopURL' ) ) ) {
            $sMallSSLShopURL = oxUtils::getInstance()->checkUrlEndingSlash( $sMallSSLShopURL );
            return $sMallSSLShopURL;
        }

        if ( ( $sMallShopURL = $this->getConfigParam( 'sMallShopURL' ) ) ) {
            $sMallShopURL = oxUtils::getInstance()->checkUrlEndingSlash( $sMallShopURL );
            return $sMallShopURL;
        }

        //normal section
        if ( ( $sSSLShopURL = $this->getConfigParam( 'sSSLShopURL' ) ) ) {
            return $sSSLShopURL;
        }

        return $this->getShopUrl( $iLang );
    }

    public function getCoreUtilsUrl()
    {
        return $this->getCurrentShopUrl().'core/utils/';
    }

    public function getCurrentShopUrl()
    {
        if ( $this->isSsl() ) {
            return $this->getSslShopUrl();
        }
        return $this->getShopUrl();
    }

    public function getShopCurrentUrl( $iLang = null )
    {
        if ( $this->isSsl() ) {
            $sURL = $this->getSSLShopURL( $iLang );
        } else {
            $sURL = $this->getShopURL( $iLang );
        }

        return oxUtilsUrl::getInstance()->processUrl( $sURL.'index.php', false );
    }

    public function getShopHomeUrl( $iLang = null, $blAdmin = null )
    {
        return oxUtilsUrl::getInstance()->processUrl($this->getShopUrl( $iLang, $blAdmin).'index.php', false );
    }

    public function getShopSecureHomeUrl()
    {
        return  oxUtilsUrl::getInstance()->processUrl( $this->getSslShopUrl().'index.php', false );
    }

    public function getShopCurrency()
    {
        return (int) oxConfig::getParameter( 'currency' );
    }

    public function getActShopCurrencyObject()
    {
        //caching currency as it does not change through the script
        //but not for unit tests as ther it changes always
        if ( !defined( 'OXID_PHP_UNIT' ) ) {
            if (!is_null($this->_oActCurrencyObject)) {
                return $this->_oActCurrencyObject;
            }
        }

        $iCur = oxConfig::getParameter( 'cur' );
        if ( !isset( $iCur ) ) {
            $iCur = $this->getShopCurrency();
        }

        $aCurrencies = $this->getCurrencyArray();
        if ( !isset( $aCurrencies[$iCur] ) ) {
            return $this->_oActCurrencyObject = reset( $aCurrencies ); // reset() returns the first element
        }

        return $this->_oActCurrencyObject = $aCurrencies[$iCur];
    }

    public function setActShopCurrency( $iCur )
    {
        $aCurrencies = $this->getCurrencyArray();
        if ( isset( $aCurrencies[$iCur] ) ) {
            oxSession::setVar( 'currency', $iCur );
            $this->_oActCurrencyObject = null;
        }
    }


    public function getNoSslImageDir( $blAdmin = false )
    {
        return $this->getImageUrl( $blAdmin, false );
    }

    public function getAbsAdminImageDir()
    {
        return $this->getImageDir( true );

    }

    /* is not used
    public function formatOutDir($sFile, $iLang = null, $blAdmin = false, $blNoThemes = false, $iShop = null)
    {
        //resolving theme and shop dir
        $sThemeDir  = ($blNoThemes || $blAdmin) ? "" : $this->getConfigParam( 'sTheme' );

        if (is_null($iShop))
            $iShop = $this->getShopId();

        $aShopDirs = array();


        if ($sThemeDir)
            $aShopDirs[] = "$sThemeDir/1/";
        else
            $aShopDirs[] = $this->getBaseShopId() . "/";

        //admin dir
        if ( $blAdmin ) {
            $aShopDirs = array('admin/');
        }

        if ($sFile) {
            //language dir
            if (is_null($iLang))
                $iLang = oxLang::getInstance()->getBaseLanguage();

            $aLangs    = oxLang::getInstance()->getLanguageArray();
            //specific language dir and top dir
            $aLangDirs = array();
            if (isset($aLangs[$iLang]))
                $aLangDirs[] = strtolower($aLangs[$iLang]->abbr . "/");
            $aLangDirs[] = "";


            //finally checking dir
            foreach ($aShopDirs as $sShopDir) {
                foreach ($aLangDirs as $sLangDir) {
                    $sOut = "out/" . $sShopDir . $sLangDir . $sFile;
                    if (file_exists($this->getConfigParam('sShopDir'). $sOut))
                        return $sOut;
                }
            }
        }

        //not language specific default dir
        foreach ($aShopDirs as $sShopDir) {
            $sOut = "out/" . $sShopDir;
            if (file_exists($this->getConfigParam('sShopDir'). $sOut))
                return $sOut;
        }
    }*/

    public function getOutDir( $blAbsolute = true)
    {
        if ($blAbsolute) {
            return $this->getConfigParam('sShopDir').$this->_sOutDir.'/';
        } else {
            return $this->_sOutDir.'/';
        }
    }

    public function getOutUrl( $blSSL = null , $blAdmin = null, $blNativeImg = false )
    {
        $blSSL    = is_null($blSSL)?$this->isSsl():$blSSL;
        $blAdmin  = is_null($blAdmin)?$this->isAdmin():$blAdmin;

        if ( $blSSL ) {
            $sUrl = ($blNativeImg && !$blAdmin )?$this->getSslShopUrl():$this->getConfigParam( 'sSSLShopURL');
        } else {
            $sUrl = ($blNativeImg && !$blAdmin )?$this->getShopUrl():$this->getConfigParam( 'sShopURL' );
        }

        return $sUrl.$this->_sOutDir.'/';
    }

    public function getDir($sFile, $sDir, $blAdmin, $iLang = null, $iShop = null, $sTheme = null, $blAbsolute = true, $blIgnoreCust = false )
    {
        if ( is_null($sTheme) ) {
            $sTheme = $this->getConfigParam( 'sTheme' );
        }

        if ( $blAdmin ) {
            $sTheme = 'admin';
        }

        $sBase    = $this->getOutDir( $blAbsolute );
        $sAbsBase = $this->getOutDir();

        $sLang = '-';
        // FALSE means skip language folder check
        if ( $iLang !== false ) {
            $oLang = oxLang::getInstance();

            if ( is_null( $iLang ) ) {
                $iLang = $oLang->getEditLanguage();
            }

            $sLang = $oLang->getLanguageAbbr( $iLang );
        }

        if ( is_null($iShop) ) {
            $iShop = $this->getShopId();
        }

        //Load from
        $sPath = "{$sTheme}/{$iShop}/{$sLang}/{$sDir}/{$sFile}";
        $sCacheKey = $sPath . "_{$blIgnoreCust}{$blAbsolute}";

        if ( ( $sReturn = oxutils::getInstance()->fromStaticCache( $sCacheKey ) ) !== null ) {
            return $sReturn;
        }

        $sReturn = false;

        // Check for custom template
        $sCustomTheme = $this->getConfigParam( 'sCustomTheme' );
        if ( !$blAdmin && !$blIgnoreCust && $sCustomTheme && $sCustomTheme != $sTheme) {
            $sReturn = $this->getDir( $sFile, $sDir, $blAdmin, $iLang, $iShop, $sCustomTheme, $blAbsolute );
        }

        //test lang level ..
        if ( !$sReturn && !$blAdmin && ( is_readable( $sAbsBase.$sPath ) || is_dir( realpath( $sAbsBase.$sPath ) ) ) ) {
            $sReturn = $sBase . $sPath;
        }

        //test shop level ..
        $sPath = "$sTheme/$iShop/$sDir/$sFile";
        if ( !$sReturn && !$blAdmin && ( is_readable( $sAbsBase.$sPath ) || is_dir( realpath( $sAbsBase.$sPath ) ) ) ) {
            $sReturn = $sBase . $sPath;
        }


        //test theme language level ..
        $sPath = "$sTheme/$sLang/$sDir/$sFile";
        if ( !$sReturn && $iLang !== false && ( is_readable( $sAbsBase.$sPath ) || is_dir( realpath( $sAbsBase.$sPath )) ) ) {
            $sReturn = $sBase . $sPath;
        }

        //test theme level ..
        $sPath = "$sTheme/$sDir/$sFile";
        if ( !$sReturn && ( is_readable( $sAbsBase.$sPath ) || is_dir( realpath( $sAbsBase.$sPath )) ) ) {
            $sReturn = $sBase . $sPath;
        }

        //test out language level ..
        $sPath = "$sLang/$sDir/$sFile";
        if ( !$sReturn &&  $iLang !== false && ( is_readable( $sAbsBase.$sPath ) || is_dir( realpath( $sAbsBase.$sPath )) ) ) {
            $sReturn = $sBase . $sPath;
        }

        //test out level ..
        $sPath = "$sDir/$sFile";
        if ( !$sReturn && ( is_readable( $sAbsBase.$sPath ) || is_dir( realpath( $sAbsBase.$sPath )) ) ) {
            $sReturn = $sBase . $sPath;
        }

        if ( !$sReturn ) {
            // TODO: log missing paths...
        }

        // to cache
        oxutils::getInstance()->toStaticCache( $sCacheKey, $sReturn );

        return $sReturn;
    }

    public function getUrl($sFile, $sDir , $blAdmin = null, $blSSL = null, $blNativeImg = false, $iLang = null , $iShop = null , $sTheme = null )
    {
        $sUrl = str_replace(
                                $this->getOutDir(),
                                $this->getOutUrl($blSSL, $blAdmin, $blNativeImg),
                                $this->getDir( $sFile, $sDir, $blAdmin, $iLang, $iShop, $sTheme )
                            );
        return $sUrl;
    }

    public function getImagePath( $sFile, $blAdmin = false )
    {
        return $this->getDir( $sFile, $this->_sImageDir, $blAdmin );
    }

    public function getImageUrl( $blAdmin = false, $blSSL = null, $blNativeImg = null )
    {
        $blNativeImg = is_null($blNativeImg)?$this->getConfigParam( 'blNativeImages' ):$blNativeImg;
        return $this->getUrl( null, $this->_sImageDir, $blAdmin, $blSSL, $blNativeImg );
    }

    public function getImageDir( $blAdmin = false )
    {
        return $this->getDir( null, $this->_sImageDir, $blAdmin );
    }

    public function getPicturePath($sFile, $blAdmin = false )
    {
        return $this->getDir( $sFile, $this->_sPictureDir, $blAdmin );
    }

    public function getMasterPictureDir( $blAdmin = false )
    {
        return $this->getDir( null, $this->_sPictureDir . "/" . $this->_sMasterPictureDir, $blAdmin );
    }

    public function getMasterPicturePath( $sFile, $blAdmin = false )
    {
        return $this->getDir( $sFile, $this->_sPictureDir . "/" . $this->_sMasterPictureDir, $blAdmin );
    }

    public function getPictureUrl( $sFile, $blAdmin = false , $blSSL = null , $iLang = null, $iShopId = null )
    {
        if ( $sAltUrl = $this->getConfigParam( 'sAltImageDir' ) ) {

            if ( $this->isSsl() ) {
                $sAltUrl = str_replace( 'http://', 'https://', $sAltUrl );
            }

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

            return $sAltUrl;
        }

        $blNativeImg = $this->getConfigParam( 'blNativeImages' );

        $sUrl = $this->getUrl( $sFile, $this->_sPictureDir, $blAdmin, $blSSL, $blNativeImg, $iLang, $iShopId );
        if ( $sFile && $this->getConfigParam( 'blFormerTplSupport' ) && !$blAdmin ) {
            $sUrl = str_replace( $this->getPictureUrl( null, $blAdmin, $blSSL, $iLang, $iShopId ), '', $sUrl );
        }

        //anything is better than empty name, because <img src=""> calls shop once more = x2 SLOW.
        if ( !$sUrl ) {
            $sUrl = $this->getUrl( "0/nopic.jpg", $this->_sPictureDir, $blAdmin, $blSSL, $blNativeImg, $iLang, $iShopId );
        }
        return $sUrl;
    }

    public function getPictureDir( $blAdmin )
    {
        return $this->getDir( null, $this->_sPictureDir, $blAdmin );
    }

    public function getTemplatePath( $sFile, $blAdmin )
    {
        return $this->getDir( $sFile, $this->_sTemplateDir, $blAdmin );
    }

    public function getTemplateDir( $blAdmin = false )
    {
        return $this->getDir( null, $this->_sTemplateDir, $blAdmin );
    }

    public function getTemplateUrl( $sFile = null, $blAdmin = false, $blSSL = null , $iLang = null )
    {
        return $this->getUrl( $sFile, $this->_sTemplateDir, $blAdmin, $blSSL, false, $iLang );
    }

    public function getTemplateBase( $blAdmin = false )
    {
        // Base template dir is the parent dir of template dir
        return str_replace( $this->_sTemplateDir.'/', '', $this->getDir( null, $this->_sTemplateDir, $blAdmin, null, null, null, false ));
    }

    public function getResourcePath($sFile, $blAdmin = false )
    {
        return $this->getDir( $sFile, $this->_sResourceDir, $blAdmin );
    }

    public function getResourceUrl( $sFile, $blAdmin = false , $blSSL = null , $iLang = null )
    {
        $blNativeImg = $this->getConfigParam( 'blNativeImages' );
        return $this->getUrl( $sFile, $this->_sResourceDir, $blAdmin, $blSSL, $blNativeImg, $iLang );
    }

    public function getResourceDir( $blAdmin )
    {
        return $this->getDir( null, $this->_sResourceDir, $blAdmin );
    }

    public function getLanguagePath( $sFile, $blAdmin, $iLang = null )
    {
        return $this->getDir( $sFile, oxLang::getInstance()->getLanguageAbbr( $iLang ), $blAdmin, $iLang );
    }

    public function getStdLanguagePath( $sFile, $blAdmin, $iLang = null )
    {
        $sDir = null;
        if ( $iLang !== false ) {
            $sDir = oxLang::getInstance()->getLanguageAbbr( $iLang );
        }

        return $this->getDir( $sFile, $sDir, $blAdmin, $iLang, null, $this->getConfigParam( "sTheme" ), true, true );
    }

    public function getLanguageDir( $blAdmin )
    {
        return $this->getDir( null, null, $blAdmin );
    }

    public function getAbsImageDir()
    {
        return $this->getImageDir();
    }

    public function getDynImageDir( $sOverrideShopId = null, $blNoSsl = null )
    {
        return $this->getPictureUrl(null, false, $this->isSsl() && !$blNoSsl, null, $sOverrideShopId);

        /*

        $sCacheKey = "getDynImageDir_" . $this->isSsl() . "_" . $this->getShopId() . "_" .oxLang::getInstance()->getTplLanguage() . "_" . $sOverrideShopId . "_" . $blNoSsl;
        $sImageDir = oxUtils::getInstance()->fromStaticCache($sCacheKey);

        if ($sImageDir)
            return $sImageDir;

        if ( $sAltImageDir = $this->getConfigParam( 'sAltImageDir' ) ) {
            if ( $this->isSsl() ) {
                $sAltImageDir = str_replace( 'http://', 'https://', $sAltImageDir );
            }
            oxUtils::getInstance()->toStaticCache($sCacheKey, $sAltImageDir);
            return $sAltImageDir;
        }

        //Tomas 2005-01-19
        //now it loads images only from either active shop either from oxbaseshop
        //later to be fixed to load images from any shop according $sOverrideShopId by implementing
        //function oxConfig::getShopURL($sOverrideShopId);

        $blNativeImg = $this->getConfigParam( 'blNativeImages' ) && $sOverrideShopId == $this->getShopId();

        if ( $this->isSsl() && !$blNoSsl ) {
            $sUrl = $blNativeImg ? $this->getSSLShopURL():$this->getConfigParam( 'sSSLShopURL');
        }

        if(!$sUrl) {
            $sUrl = $blNativeImg ? $this->getShopURL():$this->getConfigParam( 'sShopURL' );
        }

        $sLang = $this->getConfigParam( 'blUseDifferentDynDirs' )?oxLang::getInstance()->getTplLanguage():0;
        $sDir  = $this->_sPictureDir;

        $sImageDir = $sUrl . $this->formatOutDir($sDir, $iLang, false, true, $sOverrideShopId);

        oxUtils::getInstance()->toStaticCache($sCacheKey, $sImageDir);


        return $sImageDir;
        */
    }

    public function getAbsDynImageDir( $sOverrideShopId = null )
    {
        return $this->getPictureDir(false);

        /*
        //$sShop = is_null($sOverrideShopId)?$this->getShopId():$sOverrideShopId;

        if (isset($this->_aAbsDynImageDir[$sShop]))
            return $this->_aAbsDynImageDir[$sShop];

        $sRoot = $this->getConfigParam('sShopDir');
        $iLang = $this->getConfigParam( 'blUseDifferentDynDirs' )?oxLang::getInstance()->getTplLanguage():0;
        $sDir  = $this->_sPictureDir;

        $this->_aAbsDynImageDir[$sShop] = $sRoot . $this->formatOutDir($sDir, $iLang, false, true, $sOverrideShopId);
        return $this->_aAbsDynImageDir[$sShop];
        */
    }

    public function getTemplateFile( $sTemplate, $blAdmin = false )
    {
        return $this->getTemplatePath( $sTemplate, $blAdmin );
    }

    public function getBaseTemplateDir( $blAdmin = false )
    {
        return $this->getResourceUrl( null, $blAdmin );
        /*
        $blNativeImg = $this->getConfigParam( 'blNativeImages' ) && !$blAdmin;

        if ( $this->isSsl() ) {
            $sTemplateUrl = $blNativeImg?$this->getSSLShopURL():$this->getConfigParam( 'sSSLShopURL' );
        } else {
            $sTemplateUrl = $blNativeImg?$this->getShopURL():$this->getConfigParam( 'sShopURL' );
        }

        return $this->getResourceUrl( null, $blAdmin, $this->isSsl() );
        */
    }

    public function getBaseTplDir( $blAdmin = false )
    {
        //TODO: check usage
        return $this->getResourceUrl( null, $blAdmin);
    }

    public function getCurrencyArray( $iCurrency = null )
    {
        $aConfCurrencies = $this->getConfigParam( 'aCurrencies' );
        if ( !is_array( $aConfCurrencies ) ) {
            return array();
        }

        if ( defined( 'OXID_PHP_UNIT' ) ) {
            if ( isset( modConfig::$unitMOD ) && is_object( modConfig::$unitMOD ) ) {
                try{
                    $aAltCurrencies = modConfig::getInstance()->getConfigParam( 'modaCurrencies' );
                    if ( isset( $aAltCurrencies ) ) {
                        $aConfCurrencies = $aAltCurrencies;
                    }
                } catch( Exception $e ) {
                    // if exception is thrown, use default
                }
            }
        }

        // processing currency configuration data
        $aCurrencies = array();
        reset( $aConfCurrencies );
        while ( list( $key, $val ) = each( $aConfCurrencies ) ) {
            if ( $val ) {
                $oCur = new oxStdClass();
                $oCur->id      = $key;
                $sCur = explode( '@', $val);
                $oCur->name     = trim( $sCur[0] );
                $oCur->rate     = trim( $sCur[1] );
                $oCur->dec      = trim( $sCur[2] );
                $oCur->thousand = trim( $sCur[3] );
                $oCur->sign     = trim( $sCur[4] );
                $oCur->decimal  = trim( $sCur[5] );

                // change for US version
                if ( isset( $sCur[6] ) ) {
                    $oCur->side = trim($sCur[6]);
                }

                if ( isset( $iCurrency) && $key == $iCurrency ) {
                    $oCur->selected = 1;
                } else {
                    $oCur->selected = 0;
                }
                $aCurrencies[$key]= $oCur;
            }

            // #861C -  performance, do not load other currencies
            if ( !$this->getConfigParam( 'bl_perfLoadCurrency' ) ) {
                break;
            }
        }
        return $aCurrencies;
    }

    public function getCurrencyObject( $sName )
    {
        $aSearch = $this->getCurrencyArray();
        foreach ( $aSearch as $oCur ) {
            if ( $oCur->name == $sName ) {
                return $oCur;
            }
        }
    }

    public function isDemoShop()
    {
        return $this->getConfigParam('blDemoShop');
    }

    public function getEdition()
    {
            return "CE";


    }

    public function getFullEdition()
    {
        $sEdition = $this->getEdition();

            if ($sEdition == "CE") {
                return "Community Edition";
            }



        return $sEdition;
    }

    public function getVersion()
    {
        $sVersion = $this->getActiveShop()->oxshops__oxversion->value;
        return $sVersion;
    }

    public function getRevision()
    {
        try {
            $sFileName = getShopBasePath() . "/pkg.rev";
            $iRev = (int) trim(@file_get_contents($sFileName));
        } catch (Exception $e) {
            return false;
        }

        if (!$iRev) {
            return false;
        }

        return $iRev;
    }


    public function isMall()
    {

            return false;
    }

    public function detectVersion()
    {
    }



    public function saveShopConfVar( $sVarType, $sVarName, $sVarVal, $sShopId = null )
    {
        switch ( $sVarType ) {
            case 'arr':
            case 'aarr':
                if (is_array($sVarVal)) {
                    $sValue = serialize( $sVarVal );
                } else {
                    // Deprecated functionality
                    $sValue  = $sVarVal ;
                    $sVarVal = unserialize( $sVarVal );
                }
                break;
            case 'bool':
                //config param
                $sVarVal = (( $sVarVal == 'true' || $sVarVal) && $sVarVal && strcasecmp($sVarVal, "false"));
                //db value
                $sValue  = $sVarVal?"1":"";
                break;
            default:
                $sValue  = $sVarVal;
                break;
        }

        if ( !$sShopId ) {
            $sShopId = $this->getShopId();
        }

        // Update value only for current shop
        if ($sShopId == $this->getShopId()) {
            $this->setConfigParam( $sVarName, $sVarVal );
        }

        $oDb = oxDb::getDb();
        $sQ = "delete from oxconfig where oxshopid = '$sShopId' and oxvarname = '$sVarName'";
        $oDb->execute( $sQ );

        $sNewOXIDdQuoted  = $oDb->quote(oxUtilsObject::getInstance()->generateUID());
        $sShopIdQuoted    = $oDb->quote($sShopId);
        $sVarNameQuoted   = $oDb->quote($sVarName);
        $sVarTypeQuoted   = $oDb->quote($sVarType);
        $sVarValueQuoted  = $oDb->quote($sValue);
        $sConfigKeyQuoted = $oDb->quote($this->getConfigParam('sConfigKey'));

        $sQ = "insert into oxconfig (oxid, oxshopid, oxvarname, oxvartype, oxvarvalue)
               values($sNewOXIDdQuoted, $sShopIdQuoted, $sVarNameQuoted, $sVarTypeQuoted, ENCODE( $sVarValueQuoted, $sConfigKeyQuoted))";

        $oDb->execute( $sQ );
    }

    public function getShopConfVar( $sVarName, $sShopId = null )
    {
        if ( !$sShopId ) {
            $sShopId = $this->getShopId();
        }

        $oDb = oxDb::getDb(true);
        $sQ  = "select oxvartype, DECODE( oxvarvalue, '".$this->getConfigParam( 'sConfigKey' )."') as oxvarvalue from oxconfig where oxshopid = '$sShopId' and oxvarname = ".$oDb->quote($sVarName);
        $oRs = $oDb->Execute( $sQ );

        $sValue = null;
        if ( $oRs != false && $oRs->recordCount() > 0 ) {
            $sVarType = $oRs->fields['oxvartype'];
            $sVarVal  = $oRs->fields['oxvarvalue'];
            switch ( $sVarType ) {
                case 'arr':
                case 'aarr':
                    $sValue =  unserialize( $sVarVal );
                    break;
                case 'bool':
                    $sValue =  ( $sVarVal == 'true' || $sVarVal == '1' );
                    break;
                default:
                    $sValue = $sVarVal;
                    break;
            }
        }
        return $sValue;
    }

    public function isProductiveMode()
    {
        $blProductive = false;

        $blProductive = $this->getConfigParam( 'blProductive' );
        if ( !isset( $blProductive ) ) {
            $sQ = 'select oxproductive from oxshops where oxid = "'.$this->getShopId().'"';
            $blProductive = ( bool ) oxDb::getDb()->getOne( $sQ );
            $this->setConfigParam( 'blProductive', $blProductive );
        }

        return $blProductive;
    }



    public function getBaseShopId()
    {

            return 'oxbaseshop';
    }

    public function getActiveShop()
    {
        if ( $this->_oActShop && $this->_iShopId == $this->_oActShop->getId() &&
             $this->_oActShop->getLanguage() == oxLang::getInstance()->getBaseLanguage() ) {
            return $this->_oActShop;
        }

        $this->_oActShop = oxNew( 'oxshop' );
        $this->_oActShop->load( $this->getShopId() );
        return $this->_oActShop;
    }

    public function getActiveView()
    {
        if ( $this->_oActView != null ) {
            return $this->_oActView;
        }

        $this->_oActView = oxNew( 'oxubase' );
        return $this->_oActView;
    }

    public function setActiveView( $oView )
    {
        $this->_oActView = $oView;
    }

    public function isUtf()
    {
        return ( bool ) $this->getConfigParam( 'iUtfMode' );
    }

    public function getLogsDir()
    {
        return $this->getConfigParam( 'sShopDir' ).'log/';
    }
}