oxshopcontrol.php

Go to the documentation of this file.

<?php

class oxShopControl extends oxSuperCfg
{


    protected $_blHandlerSet = null;

    protected $_blMainTasksExecuted = null;

    protected $_dTimeStart = null;

    protected $_dTimeEnd = null;

    protected $_aErrors = null;

    protected $_aAllErrors = null;

    protected $_aControllerErrors = null;


    protected $_oOutput = null;

    protected $_oCache = null;

    public function start($sClass = null, $sFunction = null, $aParams = null, $aViewsChain = null)
    {
        //sets default exception handler
        $this->_setDefaultExceptionHandler();

        try {
            $this->_runOnce();

            $sFunction = !is_null($sFunction) ? $sFunction : oxRegistry::getConfig()->getRequestParameter('fnc');
            $sClass = !is_null($sClass) ? $sClass : $this->_getStartController($sClass);

            $this->_process($sClass, $sFunction, $aParams, $aViewsChain);
        } catch (oxSystemComponentException $oEx) {
            $this->_handleSystemException($oEx);
        } catch (oxCookieException $oEx) {
            $this->_handleCookieException($oEx);

        }
        catch (oxConnectionException $oEx) {
            $this->_handleDbConnectionException($oEx);
        } catch (oxException $oEx) {
            $this->_handleBaseException($oEx);
        }
    }

    protected function _setDefaultExceptionHandler()
    {
        if (isset($this->_blHandlerSet)) {
            return;
        }

        set_exception_handler(array(oxNew('oxexceptionhandler', $this->_isDebugMode()), 'handleUncaughtException'));
    }

    protected function _log($sClass, $sFnc)
    {
        $oDb = oxDb::getDb();
        $oConfig = $this->getConfig();
        $oSession = $this->getSession();

        $sShopID = $oSession->getVariable('actshop');
        $sTime = date('Y-m-d H:i:s');
        $sSidQuoted = $oDb->quote($oSession->getId());
        $sUserIDQuoted = $oDb->quote($oSession->getVariable('usr'));

        $sCnid = $oConfig->getRequestParameter('cnid');
        $sAnid = $oConfig->getRequestParameter('aid') ? $oConfig->getRequestParameter('aid') : $oConfig->getRequestParameter('anid');

        $sParameter = '';

        if ($sClass == 'content') {
            $sParameter = str_replace('.tpl', '', $oConfig->getRequestParameter('tpl'));
        } elseif ($sClass == 'search') {
            $sParameter = $oConfig->getRequestParameter('searchparam');
        }

        $sFncQuoted = $oDb->quote($sFnc);
        $sClassQuoted = $oDb->quote($sClass);
        $sParameterQuoted = $oDb->quote($sParameter);

        $sQ = "insert into oxlogs (oxtime, oxshopid, oxuserid, oxsessid, oxclass, oxfnc, oxcnid, oxanid, oxparameter) " .
              "values( '$sTime', '$sShopID', $sUserIDQuoted, $sSidQuoted, $sClassQuoted, $sFncQuoted, " . $oDb->quote($sCnid) . ", " . $oDb->quote($sAnid) . ", $sParameterQuoted )";

        $oDb->execute($sQ);
    }

    // OXID : add timing
    protected function _startMonitor()
    {
        if ($this->_isDebugMode()) {
            $this->_dTimeStart = microtime(true);
        }
    }

    protected function _stopMonitor($blIsCache = false, $blIsCached = false, $sViewID = null, $aViewData = array())
    {
        if ($this->_isDebugMode() && !$this->isAdmin()) {
            /* @var $oDebugInfo oxDebugInfo */
            $iDebug = $this->getConfig()->getConfigParam('iDebug');
            $oDebugInfo = oxNew('oxDebugInfo');

            $blHidden = ($iDebug == -1);

            $sLog = '';
            $sLogId = md5(time() . rand() . rand());
            $sLog .= "<div id='oxidDebugInfo_$sLogId'>";

            $sLog .= "<div style='color:#630;margin:15px 0 0;cursor:pointer' onclick='var el=document.getElementById(\"debugInfoBlock_$sLogId\"); if (el.style.display==\"block\")el.style.display=\"none\"; else el.style.display = \"block\";'> " . $oDebugInfo->formatGeneralInfo() . "(show/hide)</div>";
            $sLog .= "<div id='debugInfoBlock_$sLogId' style='display:" . ($blHidden ? 'none' : 'block') . "' class='debugInfoBlock' align='left'>";


            // outputting template params
            if ($iDebug == 4) {
                $sLog .= $oDebugInfo->formatTemplateData($aViewData);
            }

            // output timing
            $this->_dTimeEnd = microtime(true);


            $sLog .= $oDebugInfo->formatMemoryUsage();

            $sLog .= $oDebugInfo->formatTimeStamp();


            $sLog .= $oDebugInfo->formatExecutionTime($this->getTotalTime());

            // @deprecated since v5.3.0 (2016-06-07).
            // The SQL logging feature is deprecated. This feature will be removed.
            if ($iDebug == 7) {
                $sLog .= $oDebugInfo->formatDbInfo();
            }
            // END deprecated

            // @deprecated since v5.3.0 (2016-06-07).
            // The SQL performance monitor feature is deprecated. This feature will be removed.
            if ($iDebug == 2 || $iDebug == 3 || $iDebug == 4) {
                $sLog .= $oDebugInfo->formatAdoDbPerf();
            }
            // END deprecated

            $sLog .= '</div>';

            $sLog .= "<script type='text/javascript'>
                var b = document.getElementById('oxidDebugInfo_$sLogId');
                var c = document.body;
                if (c) { c.appendChild(b.parentNode.removeChild(b));}
            </script>";

            $sLog .= "</div>";

            $this->_getOutputManager()->output('debuginfo', $sLog);
        }
    }

    public function getTotalTime()
    {
        if ($this->_dTimeEnd && $this->_dTimeStart) {
            return $this->_dTimeEnd - $this->_dTimeStart;
        }

        return 0;
    }

    protected function _executeMaintenanceTasks()
    {
        if (isset($this->_blMainTasksExecuted)) {
            return;
        }

        startProfile('executeMaintenanceTasks');
        oxNew("oxArticleList")->updateUpcomingPrices();
        stopProfile('executeMaintenanceTasks');
    }

    protected function _process($sClass, $sFunction, $aParams = null, $aViewsChain = null)
    {
        startProfile('process');
        $myConfig = $this->getConfig();

        // executing maintenance tasks
        $this->_executeMaintenanceTasks();

        $oUtils = oxRegistry::getUtils();
        $sViewID = null;

        if (!$oUtils->isSearchEngine() &&
            !($this->isAdmin() || !$myConfig->getConfigParam('blLogging'))
        ) {
            $this->_log($sClass, $sFunction);
        }

        // starting resource monitor
        $this->_startMonitor();

        // caching params ...
        $sOutput = null;
        $blIsCached = false;

        // Initialize view object and it's components.
        $oViewObject = $this->_initializeViewObject($sClass, $sFunction, $aParams, $aViewsChain);

        if (!$this->_canExecuteFunction($oViewObject, $oViewObject->getFncName())) {
            $oException = oxNew('oxSystemComponentException', 'Non public method cannot be accessed');
            throw $oException;
        }

        // executing user defined function
        $oViewObject->executeFunction($oViewObject->getFncName());



        // if no cache was stored before we should generate it
        if (!$blIsCached) {
            $sOutput = $this->_render($oViewObject);
        }


        $oOutput = $this->_getOutputManager();
        $oOutput->setCharset($oViewObject->getCharSet());

        if (oxRegistry::getConfig()->getRequestParameter('renderPartial')) {
            $oOutput->setOutputFormat(oxOutput::OUTPUT_FORMAT_JSON);
            $oOutput->output('errors', $this->_getFormattedErrors($oViewObject->getClassName()));
        }

        $oOutput->sendHeaders();


        $oOutput->output('content', $sOutput);

        $myConfig->pageClose();

        stopProfile('process');

        // stopping resource monitor
        $this->_stopMonitor($oViewObject->getIsCallForCache(), $blIsCached, $sViewID, $oViewObject->getViewData());

        // flush output (finalize)
        $oOutput->flushOutput();
    }

    protected function _initializeViewObject($sClass, $sFunction, $aParams = null, $aViewsChain = null)
    {
        $myConfig = $this->getConfig();

        // creating current view object
        $oViewObject = oxNew($sClass);

        // store this call
        $oViewObject->setClassName($sClass);
        $oViewObject->setFncName($sFunction);
        $oViewObject->setViewParameters($aParams);

        $myConfig->setActiveView($oViewObject);


        // init class
        $oViewObject->init();

        return $oViewObject;
    }

    protected function _canExecuteFunction($oClass, $sFunction)
    {
        $blCanExecute = true;

        if (method_exists($oClass, $sFunction)) {
            $oReflectionMethod = new ReflectionMethod($oClass, $sFunction);
            if (!$oReflectionMethod->isPublic()) {
                $blCanExecute = false;
            }
        }

        return $blCanExecute;
    }


    protected function _getFormattedErrors($sControllerName)
    {
        $aErrors = $this->_getErrors($sControllerName);
        $aFmtErrors = array();
        if (is_array($aErrors) && count($aErrors)) {
            foreach ($aErrors as $sLocation => $aEx2) {
                foreach ($aEx2 as $sKey => $oEr) {
                    $oErr = unserialize($oEr);
                    $aFmtErrors[$sLocation][$sKey] = $oErr->getOxMessage();
                }
            }
        }

        return $aFmtErrors;
    }

    protected function _render($oViewObject)
    {
        // get Smarty is important here as it sets template directory correct
        $oSmarty = oxRegistry::get("oxUtilsView")->getSmarty();

        // render it
        $sTemplateName = $oViewObject->render();

        // check if template dir exists
        $sTemplateFile = $this->getConfig()->getTemplatePath($sTemplateName, $this->isAdmin());
        if (!file_exists($sTemplateFile)) {

            $oEx = oxNew('oxSystemComponentException');
            $oEx->setMessage('EXCEPTION_SYSTEMCOMPONENT_TEMPLATENOTFOUND');
            $oEx->setComponent($sTemplateName);

            $sTemplateName = "message/exception.tpl";

            if ($this->_isDebugMode()) {
                oxRegistry::get("oxUtilsView")->addErrorToDisplay($oEx);
            }
            $oEx->debugOut();
        }

        // Output processing. This is useful for modules. As sometimes you may want to process output manually.
        $oOutput = $this->_getOutputManager();
        $aViewData = $oOutput->processViewArray($oViewObject->getViewData(), $oViewObject->getClassName());
        $oViewObject->setViewData($aViewData);

        //add all exceptions to display
        $aErrors = $this->_getErrors($oViewObject->getClassName());
        if (is_array($aErrors) && count($aErrors)) {
            oxRegistry::get("oxUtilsView")->passAllErrorsToView($aViewData, $aErrors);
        }

        foreach (array_keys($aViewData) as $sViewName) {
            $oSmarty->assign_by_ref($sViewName, $aViewData[$sViewName]);
        }

        // passing current view object to smarty
        $oSmarty->oxobject = $oViewObject;


        $sOutput = $oSmarty->fetch($sTemplateName, $oViewObject->getViewId());

        //Output processing - useful for modules as sometimes you may want to process output manually.
        $sOutput = $oOutput->process($sOutput, $oViewObject->getClassName());

        return $oOutput->addVersionTags($sOutput);
    }

    protected function _getOutputManager()
    {
        if (!$this->_oOutput) {
            $this->_oOutput = oxNew('oxOutput');
        }

        return $this->_oOutput;
    }

    protected function _getErrors($sCurrentControllerName)
    {
        if (null === $this->_aErrors) {
            $this->_aErrors = oxRegistry::getSession()->getVariable('Errors');
            $this->_aControllerErrors = oxRegistry::getSession()->getVariable('ErrorController');
            if (null === $this->_aErrors) {
                $this->_aErrors = array();
            }
            $this->_aAllErrors = $this->_aErrors;
        }
        // resetting errors of current controller or widget from session
        if (is_array($this->_aControllerErrors) && !empty($this->_aControllerErrors)) {
            foreach ($this->_aControllerErrors as $sErrorName => $sControllerName) {
                if ($sControllerName == $sCurrentControllerName) {
                    unset($this->_aAllErrors[$sErrorName]);
                    unset($this->_aControllerErrors[$sErrorName]);
                }
            }
        } else {
            $this->_aAllErrors = array();
        }
        oxRegistry::getSession()->setVariable('ErrorController', $this->_aControllerErrors);
        oxRegistry::getSession()->setVariable('Errors', $this->_aAllErrors);

        return $this->_aErrors;
    }

    protected function _runOnce()
    {
        $oConfig = $this->getConfig();

        error_reporting($this->_getErrorReportingLevel());


        $blRunOnceExecuted = oxRegistry::getSession()->getVariable('blRunOnceExecuted');
        if (!$blRunOnceExecuted && !$this->isAdmin() && $oConfig->isProductiveMode()) {

            // check if setup is still there
            if (file_exists($oConfig->getConfigParam('sShopDir') . '/setup/index.php')) {
                $sTpl = 'message/err_setup.tpl';
                $oActView = oxNew('oxubase');
                $oSmarty = oxRegistry::get("oxUtilsView")->getSmarty();
                $oSmarty->assign('oView', $oActView);
                $oSmarty->assign('oViewConf', $oActView->getViewConfig());
                oxRegistry::getUtils()->showMessageAndExit($oSmarty->fetch($sTpl));
            }

            oxRegistry::getSession()->setVariable('blRunOnceExecuted', true);
        }
    }

    protected function _getErrorReportingLevel()
    {
        $sOldReporting = error_reporting();

        $iErrorReporting = E_ALL ^ E_NOTICE;
        // some 3rd party libraries still use deprecated functions
        if (defined('E_DEPRECATED')) {
            $iErrorReporting = $iErrorReporting ^ E_DEPRECATED;
        }

        if ($this->getConfig()->isProductiveMode() && !ini_get('log_errors')) {
            $iErrorReporting = 0;
        }


        return $iErrorReporting;
    }

    protected function _isDebugMode()
    {
        if (OxRegistry::get("OxConfigFile")->getVar('iDebug')) {
            return true;
        }

        return false;
    }



    protected function _handleSystemException($oEx)
    {
        $oEx->debugOut();

        if ($this->_isDebugMode()) {
            oxRegistry::get("oxUtilsView")->addErrorToDisplay($oEx);
            $this->_process('exceptionError', 'displayExceptionError');
        } else {
            oxRegistry::getUtils()->redirect($this->getConfig()->getShopHomeUrl() . 'cl=start', true, 302);
        }
    }

    protected function _handleCookieException($oEx)
    {
        if ($this->_isDebugMode()) {
            oxRegistry::get("oxUtilsView")->addErrorToDisplay($oEx);
        }
        oxRegistry::getUtils()->redirect($this->getConfig()->getShopHomeUrl() . 'cl=start', true, 302);
    }

    protected function _handleAccessRightsException($oEx)
    {
        oxRegistry::getUtils()->redirect($this->getConfig()->getShopHomeUrl() . 'cl=content&tpl=err_accessdenied.tpl', true, 302);
    }

    protected function _handleDbConnectionException($oEx)
    {
        $oEx->debugOut();

        if ($this->_isDebugMode()) {
            oxRegistry::getUtils()->showMessageAndExit($oEx->getString());
        }
        oxRegistry::getUtils()->redirectOffline();
    }

    protected function _handleBaseException($oEx)
    {
        $oEx->debugOut();

        if ($this->_isDebugMode()) {
            oxRegistry::get("oxUtilsView")->addErrorToDisplay($oEx);
            $this->_process('exceptionError', 'displayExceptionError');
        }
    }

    protected function _getStartController()
    {
        $sClass = oxRegistry::getConfig()->getRequestParameter('cl');

        if (!$sClass) {
            $sClass = $this->isAdmin() ? 'login' : $this->_getFrontendStartController();
            oxRegistry::getSession()->setVariable('cl', $sClass);
        }

        return $sClass;
    }

    protected function _getFrontendStartController()
    {
        $sClass = 'start';
        if ($this->getConfig()->isMall()) {
            $sClass = $this->_getFrontendMallStartController();
        }

        return $sClass;
    }

    protected function _getFrontendMallStartController()
    {
        $iShopCount = oxDb::getDb()->getOne('select count(*) from oxshops where oxactive = 1');

        $sMallShopURL = $this->getConfig()->getConfigParam('sMallShopURL');

        $sClass = 'start';
        if ($iShopCount && $iShopCount > 1 && $this->getConfig()->getConfigParam('iMallMode') != 0 && !$sMallShopURL) {
            $sClass = 'mallstart';
        }

        return $sClass;
    }
}