oxutilsview.php

Go to the documentation of this file.

<?php

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

    protected static $_oSmarty = null;

    protected $_aTemplateDir = array();

    protected $_blIsTplBlocks = null;

    protected $_aActiveModuleInfo = null;

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

        if ( !self::$_instance instanceof oxUtilsView ) {


            self::$_instance = oxNew( 'oxUtilsView' );

            if ( defined( 'OXID_PHP_UNIT' ) ) {
                modInstances::addMod( __CLASS__, self::$_instance);
            }
        }
        return self::$_instance;
    }

    public function getSmarty( $blReload = false )
    {
        if ( !self::$_oSmarty || $blReload ) {
            self::$_oSmarty = new Smarty();
            $this->_fillCommonSmartyProperties( self::$_oSmarty );
            $this->_smartyCompileCheck( self::$_oSmarty );
        }

        return self::$_oSmarty;
    }

    public function getTemplateOutput( $sTemplate, $oObject )
    {
        $oSmarty = $this->getSmarty();
        $iDebug  = $this->getConfig()->getConfigParam( 'iDebug' );

        // assign
        $aViewData = $oObject->getViewData();
        if ( is_array( $aViewData ) ) {
            foreach ( array_keys( $aViewData ) as $sViewName ) {
                // show debbuging information
                if ( $iDebug == 4 ) {
                    echo( "TemplateData[$sViewName] : \n");
                    print_r( $aViewData[$sViewName] );
                }
                $oSmarty->assign_by_ref( $sViewName, $aViewData[$sViewName] );
            }
        }

        return $oSmarty->fetch( $sTemplate );
    }

    public function passAllErrorsToView( &$aView, $aErrors )
    {
        if ( count( $aErrors ) > 0 ) {
            foreach ( $aErrors as $sLocation => $aEx2 ) {
                foreach ( $aEx2 as $sKey => $oEr ) {
                    $aView['Errors'][$sLocation][$sKey] = unserialize( $oEr );
                }
            }
        }
    }

    public function addErrorToDisplay( $oEr, $blFull = false, $blCustomDestination = false, $sCustomDestination = "" )
    {
        if ( $blCustomDestination && ( oxConfig::getParameter( 'CustomError' ) || $sCustomDestination!= '' ) ) {
            // check if the current request wants do display exceptions on its own
            $sDestination = oxConfig::getParameter( 'CustomError' );
            if ( $sCustomDestination != '' ) {
                $sDestination = $sCustomDestination;
            }
        } else {
            //default
            $sDestination = 'default';
        }

        //starting session if not yet started as all exception
        //messages are stored in session
        $oSession = $this->getSession();
        if ( !$oSession->getId() && !$oSession->isHeaderSent() ) {
            $oSession->setForceNewSession();
            $oSession->start();
        }

        $aEx = oxSession::getVar( 'Errors' );
        if ( $oEr instanceof oxException ) {
             $oEx = oxNew( 'oxExceptionToDisplay' );
             $oEx->setMessage( $oEr->getMessage() );
             $oEx->setExceptionType( get_class( $oEr ) );

             if ( $oEr instanceof oxSystemComponentException ) {
                $oEx->setMessageArgs( $oEr->getComponent() );
             }

             $oEx->setValues( $oEr->getValues() );
             $oEx->setStackTrace( $oEr->getTraceAsString() );
             $oEx->setDebug( $blFull );
             $oEr = $oEx;
        } elseif ( $oEr && ! ( $oEr instanceof oxIDisplayError ) ) {
            // assuming that a string was given
            $sTmp = $oEr;
            $oEr = oxNew( 'oxDisplayError' );
            $oEr->setMessage( $sTmp );
        } elseif ( $oEr instanceof oxIDisplayError ) {
            // take the object
        } else {
            $oEr = null;
        }

        if ( $oEr ) {
            $aEx[$sDestination][] = serialize( $oEr );
            oxSession::setVar( 'Errors', $aEx );
        }
    }

    public function parseThroughSmarty( $sDesc, $sOxid = null, $oActView = null, $blRecompile = false )
    {
        startProfile("parseThroughSmarty");

        if (!is_array($sDesc) && strpos($sDesc, "[{") === false) {
            stopProfile("parseThroughSmarty");
            return $sDesc;
        }


        $iLang = oxLang::getInstance()->getTplLanguage();

        // now parse it through smarty
        $oSmarty = clone $this->getSmarty();

        // save old tpl data
        $sTplVars = $oSmarty->_tpl_vars;
        $blForceRecompile = $oSmarty->force_compile;

        $oSmarty->force_compile = $blRecompile;

        if ( !$oActView ) {
            $oActView = oxNew( 'oxubase' );
            $oActView->addGlobalParams();
        }

        $aViewData = $oActView->getViewData();
        foreach ( array_keys( $aViewData ) as $sName ) {
            $oSmarty->assign_by_ref( $sName, $aViewData[$sName] );
        }

        if ( is_array( $sDesc ) ) {
            foreach ( $sDesc as $sName => $aData ) {
                $oSmarty->oxidcache = new oxField( $aData[1], oxField::T_RAW );
                $sRes[$sName] = $oSmarty->fetch( "ox:".$aData[0].$iLang );
            }
        } else {
            $oSmarty->oxidcache = new oxField($sDesc, oxField::T_RAW);
            $sRes = $oSmarty->fetch( "ox:{$sOxid}{$iLang}" );
        }

        // restore tpl vars for continuing smarty processing if it is in one
        $oSmarty->_tpl_vars = $sTplVars;
        $oSmarty->force_compile = $blForceRecompile;

        stopProfile("parseThroughSmarty");

        return $sRes;
    }

    public function setTemplateDir( $sTplDir )
    {
        if ( $sTplDir && !in_array( $sTplDir, $this->_aTemplateDir ) ) {
            $this->_aTemplateDir[] = $sTplDir;
        }
    }

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

        //T2010-01-13
        //#1531
        $this->setTemplateDir( $myConfig->getTemplateDir( $this->isAdmin() ) );

        if ( !$this->isAdmin() ) {
            $this->setTemplateDir( $myConfig->getOutDir( true ) . $myConfig->getConfigParam( 'sTheme' ) . "/tpl/" );
        }

        return $this->_aTemplateDir;
    }

    public function getTemplateCompileId()
    {
        $sShopId = $this->getConfig()->getShopId();
        $aDirs   = $this->getTemplateDirs();
        $sDir    = reset($aDirs);
        return md5( $sDir.'__'.$sShopId );
    }

    protected function _fillCommonSmartyProperties( $oSmarty )
    {
        $myConfig = $this->getConfig();
        $oSmarty->left_delimiter  = '[{';
        $oSmarty->right_delimiter = '}]';

        $oSmarty->register_resource( 'ox', array( 'ox_get_template',
                                                  'ox_get_timestamp',
                                                  'ox_get_secure',
                                                  'ox_get_trusted' ) );

        // $myConfig->blTemplateCaching; // DODGER #655 : permanently switched off as it doesnt work good enough
        $oSmarty->caching      = false;
        $oSmarty->compile_dir  = $myConfig->getConfigParam( 'sCompileDir' );
        $oSmarty->cache_dir    = $myConfig->getConfigParam( 'sCompileDir' );
        $oSmarty->template_dir = $this->getTemplateDirs();
        $oSmarty->compile_id   = $this->getTemplateCompileId();

        $oSmarty->default_template_handler_func = array(oxUtilsView::getInstance(),'_smartyDefaultTemplateHandler');

        include_once dirname(__FILE__).'/smarty/plugins/prefilter.oxblock.php';
        $oSmarty->register_prefilter('smarty_prefilter_oxblock');

        $iDebug = $myConfig->getConfigParam( 'iDebug' );
        if (  $iDebug == 1 || $iDebug == 3 || $iDebug == 4 ) {
            $oSmarty->debugging = true;
        }

        if ($iDebug == 8 && !$myConfig->isAdmin()) {
            include_once getShopBasePath().'core/smarty/plugins/prefilter.oxtpldebug.php';
            $oSmarty->register_prefilter('smarty_prefilter_oxtpldebug');
        }

        //demoshop security
        if ( !$myConfig->isDemoShop() ) {
            $oSmarty->php_handling = (int) $myConfig->getConfigParam( 'iSmartyPhpHandling' );
            $oSmarty->security     = false;
        } else {
            $oSmarty->php_handling = SMARTY_PHP_REMOVE;
            $oSmarty->security     = true;
            $oSmarty->security_settings['IF_FUNCS'][] = 'XML_ELEMENT_NODE';
            $oSmarty->security_settings['MODIFIER_FUNCS'][] = 'round';
            $oSmarty->security_settings['MODIFIER_FUNCS'][] = 'floor';
            $oSmarty->security_settings['MODIFIER_FUNCS'][] = 'trim';
            $oSmarty->security_settings['MODIFIER_FUNCS'][] = 'implode';
            $oSmarty->security_settings['MODIFIER_FUNCS'][] = 'is_array';
            $oSmarty->security_settings['ALLOW_CONSTANTS'] = true;
            $oSmarty->secure_dir = $oSmarty->template_dir;
        }
    }

    protected function _smartyCompileCheck( $oSmarty )
    {
        $myConfig = $this->getConfig();
        $oSmarty->compile_check  = $myConfig->getConfigParam( 'blCheckTemplates' );

    }

    public function _smartyDefaultTemplateHandler($sResourceType, $sResourceName, $sResourceContent, $sResourceTimestamp, $oSmarty)
    {
        $myConfig = oxConfig::getInstance();
        if ( $sResourceType == 'file' && !is_readable($sResourceName) ) {
            $sResourceName      = $myConfig->getTemplatePath($sResourceName, $myConfig->isAdmin());
            $sResourceContent   = $oSmarty->_read_file($sResourceName);
            $sResourceTimestamp = filemtime($sResourceName);
            return is_file($sResourceName) && is_readable($sResourceName);
        }
        return false;
    }

    protected function _getTemplateBlock($sModule, $sFile)
    {
        $aModuleInfo = $this->_getActiveModuleInfo();
        $sModulePath = $aModuleInfo[$sModule];
        // for 4.5 modules, since 4.6 insert in oxtplblocks the full file name
        if (substr($sFile, -4) != '.tpl') {
            $sFile = $sFile . ".tpl";
        }
        $sFileName   = $this->getConfig()->getConfigParam( 'sShopDir' )."/modules/$sModulePath/out/blocks/$sFile";
        if (file_exists($sFileName) && is_readable($sFileName)) {
            return file_get_contents($sFileName);
        } else {
            throw oxNew( "oxException", "Template block file ($sFileName) not found for '$sModule' module." );
        }
    }

    public function getTemplateBlocks($sFile)
    {
        $oConfig = $this->getConfig();

        $sTplDir = trim($oConfig->getConfigParam('_sTemplateDir'), '/\\');
        $sFile = str_replace(array('\\', '//'), '/', $sFile);
        if (preg_match('@/'.preg_quote($sTplDir, '@').'/(.*)$@', $sFile, $m)) {
            $sFile = $m[1];
        }

        $oDb = oxDb::getDb( oxDb::FETCH_MODE_ASSOC );
        $sFileParam = $oDb->quote($sFile);
        $sShpIdParam = $oDb->quote($oConfig->getShopId());
        $aRet = array();
        $aIds = array();

        if ( $this->_blIsTplBlocks === null ) {
            $this->_blIsTplBlocks = false;
            $aIds = $this->_getActiveModuleInfo();
            if (count($aIds)) {
                $sSql = "select COUNT(*) from oxtplblocks where oxactive=1 and oxshopid=$sShpIdParam and oxmodule in ( " . implode(", ", oxDb::getInstance()->quoteArray(array_keys($aIds)) ) . " ) ";
                $rs = $oDb->getOne( $sSql );
                if ( $rs ) {
                    $this->_blIsTplBlocks = true;
                }
            }
        }

        if ( $this->_blIsTplBlocks ) {
            $aIds = $this->_getActiveModuleInfo();
            if (count($aIds)) {
                $sSql = "select * from oxtplblocks where oxactive=1 and oxshopid=$sShpIdParam and oxtemplate=$sFileParam and oxmodule in ( " . implode(", ", oxDb::getInstance()->quoteArray(array_keys($aIds)) ) . " ) order by oxpos asc";
                $oDb->setFetchMode( oxDb::FETCH_MODE_ASSOC );
                $rs = $oDb->select( $sSql );

                if ($rs != false && $rs->recordCount() > 0) {
                    while (!$rs->EOF) {
                        try {
                            if (!is_array($aRet[$rs->fields['OXBLOCKNAME']])) {
                                $aRet[$rs->fields['OXBLOCKNAME']] = array();
                            }
                            $aRet[$rs->fields['OXBLOCKNAME']][] = $this->_getTemplateBlock($rs->fields['OXMODULE'], $rs->fields['OXFILE']);
                        } catch (oxException $oE) {
                            $oE->debugOut();
                        }
                        $rs->moveNext();
                    }
                }
            }
        }

        return $aRet;
    }

    protected function _getActiveModuleInfo()
    {
        if ($this->_aActiveModuleInfo === null) {
            $oModulelist = oxNew('oxmodulelist');
            $this->_aActiveModuleInfo = $oModulelist->getActiveModuleInfo();
        }
        return $this->_aActiveModuleInfo;
    }

}