oxconfig.php

Go to the documentation of this file.

<?php

//max integer
define('MAX_64BIT_INTEGER', '18446744073709551615');

class oxConfig extends oxSuperCfg
{

    // this column of params are defined in config.inc.php file,
    // so for backwards compatibility. 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 = null;

    protected $sAdminEmail = null;

    protected $blSessionUseCookies = null;

    protected $blNativeImages = true;

    protected $aMultiShopTables = array('oxarticles', 'oxdiscount', 'oxcategories', 'oxattribute',
                                        'oxlinks', 'oxvoucherseries', 'oxmanufacturers',
                                        // @deprecated since v.5.3.0 (2016-06-17); The Admin Menu: Customer Info -> News feature will be moved to a module in v6.0.0
                                        'oxnews',
                                        // END deprecated
                                        'oxselectlist', 'oxwrapping',
                                        'oxdeliveryset', 'oxdelivery', 'oxvendor', 'oxobject2category');

    private $_oStart = null;


    protected $_oActShop = null;

    protected $_aActiveViews = array();

    protected $_aGlobalParams = array();

    protected $_aConfigParams = array();

    protected $_aThemeConfigParams = 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 $_sModulesDir = 'modules';

    protected $_blIsSsl = null;

    protected $_aAbsDynImageDir = array();

    protected $_oActCurrencyObject = null;

    protected $_blInit = false;

    const OXMODULE_THEME_PREFIX = 'theme:';

    const OXMODULE_MODULE_PREFIX = 'module:';

    public function getConfigParam($sName)
    {
        if (defined('OXID_PHP_UNIT')) {
            if (isset(modConfig::$unitMOD) && is_object(modConfig::$unitMOD)) {
                $sValue = modConfig::$unitMOD->getModConfigParam($sName);
                if ($sValue !== null) {
                    return $sValue;
                }
            }
        }

        $this->init();

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

        if (isset($this->$sName)) {
            return $this->$sName;
        }
    }

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

    protected function _processSeoCall()
    {
        // TODO: refactor shop bootstrap and parse url params as soon as possible
        if (isSearchEngineUrl()) {
            oxNew('oxSeoDecoder')->processSeoCall();
        }
    }

    public function init()
    {
        // Duplicated init protection
        if ($this->_blInit) {
            return;
        }
        $this->_blInit = true;

        $this->_loadVarsFromFile();

        include getShopBasePath() . 'core/oxconfk.php';

        // @deprecated since v5.3 (2016-05-24); Adodblite will be removed.
        // setting ADODB timeout
        global $ADODB_SESS_LIFE;
        $ADODB_SESS_LIFE = 1;
        // END deprecated

        $this->_setDefaults();

        try {
            $sShopID = $this->getShopId();


            $blConfigLoaded = $this->_loadVarsFromDb($sShopID);
            // loading shop config
            if (empty($sShopID) || !$blConfigLoaded) {
                // if no config values where loaded (some problems with DB), throwing an exception
                $oEx = new oxConnectionException();
                $oEx->setMessage("Unable to load shop config values from database");
                throw $oEx;
            }

            // loading theme config options
            $this->_loadVarsFromDb($sShopID, null, oxConfig::OXMODULE_THEME_PREFIX . $this->getConfigParam('sTheme'));

            // checking if custom theme (which has defined parent theme) config options should be loaded over parent theme (#3362)
            if ($this->getConfigParam('sCustomTheme')) {
                $this->_loadVarsFromDb($sShopID, null, oxConfig::OXMODULE_THEME_PREFIX . $this->getConfigParam('sCustomTheme'));
            }

            // loading modules config
            $this->_loadVarsFromDb($sShopID, null, oxConfig::OXMODULE_MODULE_PREFIX);


            $this->_processSeoCall();

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


            // Admin handling
            $this->setConfigParam('blAdmin', isAdmin());

            if (defined('OX_ADMIN_DIR')) {
                $this->setConfigParam('sAdminDir', OX_ADMIN_DIR);
            }

            $this->_loadVarsFromFile();

            //application initialization
            $this->_oStart = new oxStart();
            $this->_oStart->appInit();
        } catch (oxConnectionException $oEx) {
            return $this->_handleDbConnectionException($oEx);
        } catch (oxCookieException $oEx) {
            return $this->_handleCookieException($oEx);
        }
    }

    protected function _loadVarsFromFile()
    {
        //config variables from config.inc.php takes priority over the ones loaded from db
        include getShopBasePath() . '/config.inc.php';

        //adding trailing slashes
        $oFileUtils = oxRegistry::get("oxUtilsFile");
        $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);

        $this->_loadCustomConfig();
    }

    protected function _setDefaults()
    {

        $this->setConfigParam('sTheme', 'azure');

        if (is_null($this->getConfigParam('sDefaultLang'))) {
            $this->setConfigParam('sDefaultLang', 0);
        }

        if (is_null($this->getConfigParam('blLogChangesInAdmin'))) {
            $this->setConfigParam('blLogChangesInAdmin', false);
        }

        if (is_null($this->getConfigParam('blCheckTemplates'))) {
            $this->setConfigParam('blCheckTemplates', false);
        }

        if (is_null($this->getConfigParam('blAllowArticlesubclass'))) {
            $this->setConfigParam('blAllowArticlesubclass', false);
        }

        if (is_null($this->getConfigParam('iAdminListSize'))) {
            $this->setConfigParam('iAdminListSize', 9);
        }

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

        if (is_null($this->getConfigParam('iZoomPicCount'))) {
            $this->setConfigParam('iZoomPicCount', 4);
        }

        // @deprecated since v5.3 (2016-05-24); Adodblite will be removed.
        // ADODB cache life time
        if (is_null($this->getConfigParam('iDBCacheLifeTime'))) {
            $this->setConfigParam('iDBCacheLifeTime', 3600); // 1 hour
        }
        // END deprecated

        if (is_null($this->getConfigParam('iDebug'))) {
            $this->setConfigParam('iDebug', $this->isProductiveMode() ? 0 : -1);
        }

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

    protected function _loadCustomConfig()
    {
        $sCustConfig = getShopBasePath() . '/cust_config.inc.php';
        if (is_readable($sCustConfig)) {
            include $sCustConfig;
        }
    }

    protected function _loadVarsFromDb($sShopID, $aOnlyVars = null, $sModule = '')
    {
        $oDb = oxDb::getDb();

        $sModuleSql = $sModule ? " oxmodule LIKE " . $oDb->quote($sModule . "%") : " oxmodule='' ";
        $sOnlyVarsSql = $this->_getConfigParamsSelectSnippet($aOnlyVars);

        $sSelect = "select
                        oxvarname, oxvartype, " . $this->getDecodeValueQuery() . " as oxvarvalue
                    from oxconfig
                    where oxshopid = '$sShopID' and " . $sModuleSql . $sOnlyVarsSql;

        $aResult = $oDb->getAll($sSelect);

        foreach ($aResult as $aValue) {
            $sVarName = $aValue[0];
            $sVarType = $aValue[1];
            $sVarVal = $aValue[2];

            $this->_setConfVarFromDb($sVarName, $sVarType, $sVarVal);

            //setting theme options array
            if ($sModule) {
                $this->_aThemeConfigParams[$sVarName] = $sModule;
            }
        }

        return (bool) count($aResult);
    }

    protected function _getConfigParamsSelectSnippet($aVars)
    {
        $sSelect = '';
        if (is_array($aVars) && !empty($aVars)) {
            foreach ($aVars as &$sField) {
                $sField = '"' . $sField . '"';
            }
            $sSelect = ' and oxvarname in ( ' . implode(', ', $aVars) . ' ) ';
        }

        return $sSelect;
    }

    protected function _setConfVarFromDb($sVarName, $sVarType, $sVarVal)
    {
        if (($sVarName == 'sShopURL' || $sVarName == 'sSSLShopURL') &&
            (!$sVarVal || $this->isAdmin() === true)
        ) {
            return;
        }

        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;
        }
    }

    public function pageClose()
    {
        if ($this->hasActiveViewsChain()) {
            // do not commit session until active views chain exists
            return;
        }

        return $this->_oStart->pageClose();
    }

    public function getRequestParameter($sName, $blRaw = false)
    {
        if (defined('OXID_PHP_UNIT')) {
            if (isset(modConfig::$unitMOD) && is_object(modConfig::$unitMOD)) {
                try {
                    $sValue = modConfig::getRequestParameter($sName, $blRaw);

                    // TODO: remove this after special chars concept implementation
                    $blIsAdmin = modConfig::getInstance()->isAdmin() || modSession::getInstance()->getVariable("blIsAdmin");
                    if ($sValue !== null && !$blIsAdmin && (!$blRaw || is_array($blRaw))) {
                        $this->checkParamSpecialChars($sValue, $blRaw);
                    }

                    return $sValue;
                } catch (Exception $e) {
                    // if exception is thrown, use default
                }
            }
        }

        $sValue = null;

        if (isset($_POST[$sName])) {
            $sValue = $_POST[$sName];
        } elseif (isset($_GET[$sName])) {
            $sValue = $_GET[$sName];
        }

        // TODO: remove this after special chars concept implementation
        $blIsAdmin = $this->isAdmin() && $this->getSession()->getVariable("blIsAdmin");
        if ($sValue !== null && !$blIsAdmin && (!$blRaw || is_array($blRaw))) {
            $this->checkParamSpecialChars($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 function checkParamSpecialChars(& $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)) {
                    $this->checkParamSpecialChars($sValidKey);
                    $this->checkParamSpecialChars($sVal);
                    if ($sValidKey != $sKey) {
                        unset ($sValue[$sKey]);
                    }
                }
                $newValue[$sValidKey] = $sVal;
            }
            $sValue = $newValue;
        } elseif (is_string($sValue)) {
            $sValue = str_replace(
                array('&', '<', '>', '"', "'", chr(0), '\\', "\n", "\r"),
                array('&amp;', '&lt;', '&gt;', '&quot;', '&#039;', '', '&#092;', '&#10;', '&#13;'),
                $sValue
            );
        }

        return $sValue;
    }

    public function setShopId($sShopId)
    {

        $this->getSession()->setVariable('actshop', $sShopId);
        $this->_iShopId = $sShopId;
    }

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

        $this->setShopId($this->getBaseShopId());


        $this->getSession()->setVariable('actshop', $this->_iShopId);

        return $this->_iShopId;
    }




    public function setIsSsl($blIsSsl = false)
    {
        $this->_blIsSsl = $blIsSsl;
    }

    protected function _checkSsl()
    {
        $myUtilsServer = oxRegistry::get("oxUtilsServer");
        $aServerVars = $myUtilsServer->getServerVar();
        $aHttpsServerVar = $myUtilsServer->getServerVar('HTTPS');

        $this->setIsSsl();
        if (isset($aHttpsServerVar) && ($aHttpsServerVar === 'on' || $aHttpsServerVar === 'ON' || $aHttpsServerVar == '1')) {
            // "1&1" hoster provides "1"
            $this->setIsSsl($this->getConfigParam('sSSLShopURL') || $this->getConfigParam('sMallSSLShopURL'));
            if ($this->isAdmin() && !$this->_blIsSsl) {
                //#4026
                $this->setIsSsl(!is_null($this->getConfigParam('sAdminSSLURL')));
            }
        }

        //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->setIsSsl(true);
        }
    }


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

        return $this->_blIsSsl;
    }

    public function isCurrentUrl($sURL)
    {
        // Missing protocol, cannot proceed, assuming true.
        if (!$sURL || (strpos($sURL, "http") !== 0)) {
            return true;
        }

        return oxRegistry::get("oxUtilsServer")->isCurrentUrl($sURL);
    }

    public function isCurrentProtocol($sURL)
    {
        // Missing protocol, cannot proceed, assuming true.
        if (!$sURL || (strpos($sURL, "http") !== 0)) {
            return true;
        }

        return (strpos($sURL, "https:") === 0) == $this->isSsl();
    }

    public function getShopUrl($iLang = null, $blAdmin = null)
    {
        $sUrl = null;
        $blAdmin = isset($blAdmin) ? $blAdmin : $this->isAdmin();

        if (!$blAdmin) {
            $sUrl = $this->getShopUrlByLanguage($iLang);
            if (!$sUrl) {
                $sUrl = $this->getMallShopUrl();
            }
        }

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

        return $sUrl;
    }

    public function getSslShopUrl($iLang = null)
    {
        $sUrl = null;

        if (!$sUrl) {
            $sUrl = $this->getShopUrlByLanguage($iLang, true);
        }

        if (!$sUrl) {
            $sUrl = $this->getMallShopUrl(true);
        }

        if (!$sUrl) {
            $sUrl = $this->getMallShopUrl();
        }

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

        if (!$sUrl) {
            $sUrl = $this->getShopUrl($iLang);
        }

        return $sUrl;
    }

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

    public function getCurrentShopUrl($blAdmin = null)
    {
        if ($blAdmin === null) {
            $blAdmin = $this->isAdmin();
        }
        if ($blAdmin) {
            if ($this->isSsl()) {

                $sUrl = $this->getConfigParam('sAdminSSLURL');
                if (!$sUrl) {
                    return $this->getSslShopUrl() . $this->getConfigParam('sAdminDir') . '/';
                }

                return $sUrl;
            } else {
                return $this->getShopUrl() . $this->getConfigParam('sAdminDir') . '/';
            }
        } else {
            return $this->isSsl() ? $this->getSslShopUrl() : $this->getShopUrl();
        }
    }

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

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

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

    public function getWidgetUrl($iLang = null, $blAdmin = null)
    {
        $sUrl = $this->isSsl() ? $this->getSslShopUrl($iLang) : $this->getShopUrl($iLang, $blAdmin);

        return oxRegistry::get('oxUtilsUrl')->processUrl($sUrl . 'widget.php', false);
    }

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

    public function getShopCurrency()
    {
        $iCurr = null;
        if ((null === ($iCurr = $this->getRequestParameter('cur')))) {
            if (null === ($iCurr = $this->getRequestParameter('currency'))) {
                $iCurr = $this->getSession()->getVariable('currency');
            }
        }

        return (int) $iCurr;
    }

    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 = $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])) {
            $this->getSession()->setVariable('currency', $iCur);
            $this->_oActCurrencyObject = null;
        }
    }

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

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

    public function getTranslationsDir($sFile, $sDir, $blAbsolute = true)
    {
        $sPath = $blAbsolute ? $this->getConfigParam('sShopDir') : '';
        $sPath .= 'application/translations/';
        if (is_readable($sPath . $sDir . '/' . $sFile)) {
            return $sPath . $sDir . '/' . $sFile;
        }

        return false;
    }

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

    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) {
            if ($blNativeImg && !$blAdmin) {
                $sUrl = $this->getSslShopUrl();
            } else {
                $sUrl = $this->getConfigParam('sSSLShopURL');
                if (!$sUrl && $blAdmin) {
                    $sUrl = $this->getConfigParam('sAdminSSLURL') . '../';
                }
            }
        } 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';
        }

        if ($sDir != $this->_sTemplateDir) {
            $sBase = $this->getOutDir($blAbsolute);
            $sAbsBase = $this->getOutDir();
        } else {
            $sBase = $this->getViewsDir($blAbsolute);
            $sAbsBase = $this->getViewsDir();
        }

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

            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 = oxRegistry::getUtils()->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)) {
            $sReturn = $sBase . $sPath;
        }

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


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

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

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

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

        if (!$sReturn) {
            // TODO: implement logic to log missing paths
        }

        // to cache
        oxRegistry::getUtils()->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, $sFile = null)
    {
        $blNativeImg = is_null($blNativeImg) ? $this->getConfigParam('blNativeImages') : $blNativeImg;

        return $this->getUrl($sFile, $this->_sImageDir, $blAdmin, $blSSL, $blNativeImg);
    }

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

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

    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, $sDefPic = "master/nopic.jpg")
    {
        if ($sAltUrl = oxRegistry::get("oxPictureHandler")->getAltImageUrl('/', $sFile, $blSSL)) {
            return $sAltUrl;
        }

        $blNativeImg = $this->getConfigParam('blNativeImages');
        $sUrl = $this->getUrl($sFile, $this->_sPictureDir, $blAdmin, $blSSL, $blNativeImg, $iLang, $iShopId);

        //anything is better than empty name, because <img src=""> calls shop once more = x2 SLOW.
        if (!$sUrl && $sDefPic) {
            $sUrl = $this->getUrl($sDefPic, $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)
    {
        $sTemplatePath = $this->getDir($sFile, $this->_sTemplateDir, $blAdmin);

        if (!$sTemplatePath) {
            $sBasePath = getShopBasePath();
            $aModuleTemplates = $this->getConfigParam('aModuleTemplates');

            $oModulelist = oxNew('oxmodulelist');
            $aActiveModuleInfo = $oModulelist->getActiveModuleInfo();
            if (is_array($aModuleTemplates) && is_array($aActiveModuleInfo)) {
                foreach ($aModuleTemplates as $sModuleId => $aTemplates) {
                    if (isset($aTemplates[$sFile]) && isset($aActiveModuleInfo[$sModuleId])) {
                        $sPath = $aTemplates[$sFile];
                        $sPath = $sBasePath . 'modules/' . $sPath;
                        if (is_file($sPath) && is_readable($sPath)) {
                            $sTemplatePath = $sPath;
                        }
                    }
                }
            }
        }

        return $sTemplatePath;
    }

    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->getShopMainUrl() . $this->getDir($sFile, $this->_sTemplateDir, $blAdmin, $iLang, null, null, false);
    }

    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 getModulesDir($blAbsolute = true)
    {
        if ($blAbsolute) {
            return $this->getConfigParam('sShopDir') . $this->_sModulesDir . '/';
        } else {
            return $this->_sModulesDir . '/';
        }
    }

    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 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 stdClass();
                $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()
    {
        $sFileName = $this->getConfigParam('sShopDir') . "/pkg.rev";
        $sRev = trim(@file_get_contents($sFileName));

        if (!$sRev) {
            return false;
        }

        return $sRev;
    }

    public function getPackageInfo()
    {
        $sFileName = $this->getConfigParam('sShopDir') . "/pkg.info";
        $sRev = @file_get_contents($sFileName);
        $sRev = str_replace("\n", "<br>", $sRev);

        if (!$sRev) {
            return false;
        }

        return $sRev;
    }

    public function getMandateCount()
    {
        $iShopCount = 1;


        return $iShopCount;
    }

    public function isMall()
    {

        return false;
    }

    public function detectVersion()
    {
    }



    public function saveShopConfVar($sVarType, $sVarName, $sVarVal, $sShopId = null, $sModule = '')
    {
        switch ($sVarType) {
            case 'arr':
            case 'aarr':
                $sValue = serialize($sVarVal);
                break;
            case 'bool':
                //config param
                $sVarVal = (($sVarVal == 'true' || $sVarVal) && $sVarVal && strcasecmp($sVarVal, "false"));
                //db value
                $sValue = $sVarVal ? "1" : "";
                break;
            case 'num':
                //config param
                $sVarVal = $sVarVal != '' ? oxRegistry::getUtils()->string2Float($sVarVal) : '';
                $sValue = $sVarVal;
                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();
        $sShopIdQuoted = $oDb->quote($sShopId);
        $sModuleQuoted = $oDb->quote($sModule);
        $sVarNameQuoted = $oDb->quote($sVarName);
        $sVarTypeQuoted = $oDb->quote($sVarType);
        $sVarValueQuoted = $oDb->quote($sValue);
        $sConfigKeyQuoted = $oDb->quote($this->getConfigParam('sConfigKey'));
        $sNewOXIDdQuoted = $oDb->quote(oxUtilsObject::getInstance()->generateUID());

        $sQ = "delete from oxconfig where oxshopid = $sShopIdQuoted and oxvarname = $sVarNameQuoted and oxmodule = $sModuleQuoted";
        $oDb->execute($sQ);

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


    }


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

        if ($sShopId == $this->getShopId() && (!$sModule || $sModule == oxConfig::OXMODULE_THEME_PREFIX . $this->getConfigParam('sTheme'))) {
            $sVarValue = $this->getConfigParam($sVarName);
            if ($sVarValue !== null) {
                return $sVarValue;
            }
        }

        $oDb = oxDb::getDb(oxDb::FETCH_MODE_ASSOC);

        $sQ = "select oxvartype, " . $this->getDecodeValueQuery() . " as oxvarvalue from oxconfig where oxshopid = '{$sShopId}' and oxmodule = '{$sModule}' and oxvarname = " . $oDb->quote($sVarName);
        $oRs = $oDb->select($sQ);

        $sValue = null;
        if ($oRs != false && $oRs->recordCount() > 0) {
            $sValue = $this->decodeValue($oRs->fields['oxvartype'], $oRs->fields['oxvarvalue']);
        }

        return $sValue;
    }

    public function decodeValue($sType, $mOrigValue)
    {
        $sValue = $mOrigValue;
        switch ($sType) {
            case 'arr':
            case 'aarr':
                $sValue = unserialize($mOrigValue);
                break;
            case 'bool':
                $sValue = ($mOrigValue == 'true' || $mOrigValue == '1');
                break;
        }

        return $sValue;
    }

    public function getDecodeValueQuery($sFieldName = "oxvarvalue")
    {
        return " DECODE( {$sFieldName}, '" . $this->getConfigParam('sConfigKey') . "') ";
    }

    public function isProductiveMode()
    {
        $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() == oxRegistry::getLang()->getBaseLanguage()
        ) {
            return $this->_oActShop;
        }

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

        return $this->_oActShop;
    }

    public function getActiveView()
    {
        if (count($this->_aActiveViews)) {
            $oActView = end($this->_aActiveViews);
        }
        if (!isset($oActView) || $oActView == null) {
            $oActView = oxNew('oxubase');
            $this->_aActiveViews[] = $oActView;
        }

        return $oActView;
    }

    public function getTopActiveView()
    {
        if (count($this->_aActiveViews)) {
            return reset($this->_aActiveViews);
        } else {
            return $this->getActiveView();
        }
    }

    public function getActiveViewsList()
    {
        return $this->_aActiveViews;
    }

    public function setActiveView($oView)
    {
        $this->_aActiveViews[] = $oView;
    }

    public function dropLastActiveView()
    {
        array_pop($this->_aActiveViews);
    }

    public function hasActiveViewsChain()
    {
        return (count($this->_aActiveViews) > 1);
    }

    public function getActiveViewsNames()
    {
        $aNames = array();

        if (is_array($this->getActiveViewsList())) {
            foreach ($this->getActiveViewsList() as $oView) {
                $aNames[] = $oView->getClassName();
            }
        }

        return $aNames;
    }

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

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

    public function isThemeOption($sName)
    {
        return (bool) isset($this->_aThemeConfigParams[$sName]);
    }

    public function getShopMainUrl()
    {
        return $this->_blIsSsl ? $this->getConfigParam('sSSLShopURL') : $this->getConfigParam('sShopURL');
    }

    public function getAllModules()
    {
        return $this->getModulesWithExtendedClass();
    }

    public function getModulesWithExtendedClass()
    {
        return $this->parseModuleChains($this->getConfigParam('aModules'));
    }

    public function parseModuleChains($aModules)
    {
        $aModuleArray = array();

        if (is_array($aModules)) {
            foreach ($aModules as $sClass => $sModuleChain) {
                if (strstr($sModuleChain, '&')) {
                    $aModuleChain = explode('&', $sModuleChain);
                } else {
                    $aModuleChain = array($sModuleChain);
                }
                $aModuleArray[$sClass] = $aModuleChain;
            }
        }

        return $aModuleArray;
    }

    public function getShopIds()
    {
        return oxDb::getDb()->getCol("SELECT `oxid` FROM `oxshops`");
    }

    public function getShopUrlByLanguage($iLang, $blSSL = false)
    {
        $sLanguageUrl = null;
        $sConfigParameter = $blSSL ? 'aLanguageSSLURLs' : 'aLanguageURLs';
        $iLang = isset($iLang) ? $iLang : oxRegistry::getLang()->getBaseLanguage();
        $aLanguageURLs = $this->getConfigParam($sConfigParameter);
        if (isset($iLang) && isset($aLanguageURLs[$iLang]) && !empty($aLanguageURLs[$iLang])) {
            $aLanguageURLs[$iLang] = oxRegistry::getUtils()->checkUrlEndingSlash($aLanguageURLs[$iLang]);
            $sLanguageUrl = $aLanguageURLs[$iLang];
        }

        return $sLanguageUrl;
    }

    public function getMallShopUrl($blSSL = false)
    {
        $sUrl = null;
        $sConfigParameter = $blSSL ? 'sMallSSLShopURL' : 'sMallShopURL';
        $sMallShopURL = $this->getConfigParam($sConfigParameter);
        if ($sMallShopURL) {
            $sMallShopURL = oxRegistry::getUtils()->checkUrlEndingSlash($sMallShopURL);
            $sUrl = $sMallShopURL;
        }

        return $sUrl;
    }

    protected function _handleDbConnectionException($oEx)
    {
        $oEx->debugOut();
        if (defined('OXID_PHP_UNIT')) {
            return false;
        } elseif (0 != $this->iDebug) {
            oxRegistry::getUtils()->showMessageAndExit($oEx->getString());
        } else {
            header("HTTP/1.1 500 Internal Server Error");
            header("Location: offline.html");
            header("Connection: close");
            exit(1);
        }
    }

    protected function _handleCookieException($oEx)
    {
        $this->_processSeoCall();

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

        // redirect to start page and display the error
        oxRegistry::get("oxUtilsView")->addErrorToDisplay($oEx);
        oxRegistry::getUtils()->redirect($this->getShopHomeURL() . 'cl=start', true, 302);
    }

    public function saveSystemConfigParameter($sParameterType, $sParameterName, $sParameterValue)
    {
        $this->saveShopConfVar($sParameterType, $sParameterName, $sParameterValue, $this->getBaseShopId());
    }

    public function getSystemConfigParameter($sParameterName)
    {
        return $this->getShopConfVar($sParameterName, $this->getBaseShopId());
    }
}