oxshopcontrol.php

Go to the documentation of this file.

<?php

class oxShopControl extends oxSuperCfg
{
    protected $_dTimeStart = null;

    protected $_dTimeEnd = null;

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

        //perform tasks once per session
        $this->_runOnce();

        $sClass    = oxConfig::getParameter( 'cl' );
        $sFunction = oxConfig::getParameter( 'fnc' );

        if ( !$sClass ) {

            if ( !$this->isAdmin() ) {

                // first start of the shop
                // check wether we have to display mall startscreen or not
                if ( $myConfig->isMall() ) {

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

                    $sMallShopURL = $myConfig->getConfigParam( 'sMallShopURL' );
                    if ( $iShopCount && $iShopCount > 1 && $myConfig->getConfigParam( 'iMallMode' ) != 0 && !$sMallShopURL ) {
                        // no class specified so we need to change back to baseshop
                        $sClass = 'mallstart';
                    }
                }

                if ( !$sClass ) {
                    $sClass = 'start';
                }
            } else {
                $sClass = 'login';
            }

            oxSession::setVar( 'cl', $sClass );
        }

        // baseshop always active if there is no mall
        if ( !oxSession::getVar( 'actshop' ) ) {
            oxSession::setVar( 'actshop', $myConfig->getShopId() );
        }

        try {
            $this->_process( $sClass, $sFunction );
        } catch( oxSystemComponentException $oEx ) {
            //possible reason: class does not exist etc. --> just redirect to start page
            oxUtilsView::getInstance()->addErrorToDisplay( $oEx );
            oxUtils::getInstance()->redirect( $myConfig->getShopHomeUrl() .'cl=start' );
        } catch ( oxCookieException $oEx ) {
            // redirect to start page and display the error
            oxUtilsView::getInstance()->addErrorToDisplay( $oEx );
            oxUtils::getInstance()->redirect( $myConfig->getShopHomeUrl() .'cl=start' );
        }
    }

    protected function _log( $sClass, $sFnc )
    {
        $oDb = oxDb::getDb();
        $sShopID = oxSession::getVar( 'actshop' );
        $sTime   = date( 'Y-m-d H:i:s' );
        $sSidQuoted    = $oDb->quote( $this->getSession()->getId() );
        $sUserIDQuoted = $oDb->quote( oxSession::getVar( 'usr' ) );
        $sCnid = oxConfig::getParameter( 'cnid' );
        $sAnid = oxConfig::getParameter( 'aid' ) ? oxConfig::getParameter( 'aid' ) : oxConfig::getParameter( 'anid' );
        $sParameter = '';

        if ( $sClass == 'info' ) {
            $sParameter = str_replace( '.tpl', '', oxConfig::getParameter('tpl') );
        } elseif ( $sClass == 'search' ) {
            $sParameter = oxConfig::getParameter( '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, '$sCnid', '$sAnid', $sParameterQuoted )";
        $oDb->execute( $sQ );
    }

    // OXID : add timing
    protected function _startMonitor()
    {
        if ( !$this->isAdmin() && $this->getConfig()->getConfigParam( 'iDebug' ) ) {
            list ( $sUsec, $sSec ) = explode( ' ', microtime() );
            $this->_dTimeStart = ( ( float ) $sUsec + ( float ) $sSec );
        }
    }

    protected function _stopMonitor( $blIsCache = false, $blIsCached = false, $sViewID = null, $aViewData = array() )
    {
        $myConfig = $this->getConfig();
        if ( !$this->isAdmin() && $myConfig->getConfigParam( 'iDebug' ) != 0 ) {
            $sLog = '<div align="left">';

            // outputting template params
            if ( $myConfig->getConfigParam( 'iDebug' ) == 4 ) {

                reset( $aViewData );
                while ( list( $sViewName, $oViewData ) = each( $aViewData ) ) {
                    // show debbuging information
                        $sLog .= "TemplateData[$sViewName] : <br />\n";
                        print_r( $oViewData );
                }
            }

            // output timing
            list( $sUsec, $sSec ) = explode( ' ', microtime() );
            $this->_dTimeEnd = ( ( float ) $sUsec + ( float ) $sSec );
            //getting rid of float precission shift
            $dTimeSpent = ((int)( $this->_dTimeEnd * 10000 - $this->_dTimeStart * 10000 ) ) / 10000;

            $sLog .= 'Execution time :'.$dTimeSpent.'<br />';

            // memory usage info
            if ( function_exists( 'memory_get_usage' ) ) {
                $iKb = ( int ) ( memory_get_usage() / 1024 );
                $iMb = round($iKb / 1024, 3);
                $sLog .= 'Memory usage: '.$iMb.' MB';

                if ( function_exists( 'memory_get_peak_usage' ) ) {
                    $iPeakKb = ( int ) ( memory_get_peak_usage() / 1024 );
                    $iPeakMb = round($iPeakKb / 1024, 3);
                    $sLog .= ' (peak: '.$iPeakMb.' MB)';
                }
                $sLog .= '<br />';

                if ( version_compare( PHP_VERSION, '5.2.0', '>=' ) ) {
                    $iKb = ( int ) ( memory_get_usage( true ) / 1024 );
                    $iMb = round($iKb / 1024, 3);
                    $sLog .= 'System memory usage: '.$iMb.' MB';

                    if ( function_exists( 'memory_get_peak_usage' ) ) {
                        $iPeakKb = ( int ) ( memory_get_peak_usage( true ) / 1024 );
                        $iPeakMb = round($iPeakKb / 1024, 3);
                        $sLog .= ' (peak: '.$iPeakMb.' MB)';
                    }
                    $sLog .= '<br />';
                }
            }

            $sLog .= '</div>';
            $this->_output( $sLog );
        }
    }

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

        return 0;
    }

    protected function _process( $sClass, $sFunction )
    {
        $myConfig = $this->getConfig();
        $myUtils  = oxUtils::getInstance();
        $sViewID = null;

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

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

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

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

        $myConfig->setActiveView( $oViewObject );

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


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

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


        // get Smarty is important here as it sets template directory correct
        $oSmarty = oxUtilsView::getInstance()->getSmarty();

        // if no cache was stored before we should generate it
        if ( !$blIsCached ) {

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

            // check if template dir exists
            $sTemplateFile = $myConfig->getTemplatePath( $sTemplateName, $this->isAdmin() ) ;
            if ( !file_exists( $sTemplateFile)) {
                $oEx = oxNew( 'oxSystemComponentException' );
                $oLang = oxLang::getInstance();
                $oEx->setMessage( sprintf($oLang->translateString( 'EXCEPTION_SYSTEMCOMPONENT_TEMPLATENOTFOUND', $oLang->getBaseLanguage() ), $sTemplateFile) );
                $oEx->setComponent( $sTemplateName );
                throw $oEx;
            }
            $aViewData = $oViewObject->getViewData();

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

            //add all exceptions to display
            if ( ( $aErrors = oxSession::getVar( 'Errors' ) ) ) {
                oxUtilsView::getInstance()->passAllErrorsToView( $aViewData, $aErrors );

                // resetting errors after displaying them
                oxSession::setVar( 'Errors', array() );
            }

            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() );
            $sOutput = $oOutput->addVersionTags( $sOutput );
        }


        // #M1047 Firefox duplicated GET fix
        $myUtils->setHeader( "Content-Type: text/html; charset=".oxLang::getInstance()->translateString( 'charset' ) );

        // show output
        $this->_output( $sOutput );

        $myConfig->pageClose();

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

    protected function _output( $sOutput )
    {
        echo $sOutput;
    }

    protected function _runOnce()
    {
        $myConfig = $this->getConfig();
        $blProductive = true;
        $blRunOnceExecuted = oxSession::getVar( 'blRunOnceExecuted' );

            $iErrorReporting = error_reporting();
            if ( version_compare(PHP_VERSION, '5.3.0', '>=') ) {
                // some 3rd party libraries still use deprecated functions
                $iErrorReporting = E_ALL ^ E_NOTICE ^ E_DEPRECATED;
            } else {
                $iErrorReporting = E_ALL ^ E_NOTICE;
            }
            // A. is it the right place for this code ?
            // productive mode ?
            if ( ! ( $blProductive = $myConfig->isProductiveMode() ) ) {
                if ( is_null($myConfig->getConfigParam( 'iDebug' )) ) {
                    $myConfig->setConfigParam( 'iDebug', -1 );
                }
            } else {
                // disable error logging if server is misconfigured
                if ( !ini_get( 'log_errors' ) ) {
                    $iErrorReporting = E_NONE;
                }
            }
            error_reporting($iErrorReporting);


        if ( !$blRunOnceExecuted && !$this->isAdmin() && $blProductive ) {

            $sTpl = false;
            // perform stuff - check if setup is still there
            if ( file_exists( $myConfig->getConfigParam( 'sShopDir' ) . '/setup/index.php' ) ) {
                $sTpl = 'err_setup.tpl';
            }

            if ( $sTpl ) {
                $oActView = oxNew( 'oxubase' );
                $oSmarty = oxUtilsView::getInstance()->getSmarty();
                $oSmarty->assign('oView', $oActView );
                $oSmarty->assign('oViewConf', $oActView->getViewConfig() );
                oxUtils::getInstance()->showMessageAndExit( $oSmarty->fetch( $sTpl ) );
            }

            oxSession::setVar( 'blRunOnceExecuted', true );
        }
    }
}