oxfunctions.php

Go to the documentation of this file.

<?php

function oxAutoload( $sClass )
{
    startProfile("oxAutoload");
    $sClass = basename( $sClass );
    $sClass = strtolower($sClass);

    static $sBasePath  = null;
    static $aClassDirs = null;

    // preventing infinite loop
    static $aTriedClasses = array();

    //loading very base classes. We can do this as we know they exists,
    //moreover even further method code could not execute without them
    $sBaseClassLocation = null;
    $aBaseClasses = array("oxutils", "oxsupercfg", "oxutilsobject");
    if (in_array($sClass, $aBaseClasses)) {
        $sFilename = getShopBasePath() ."core/" . $sClass . ".php" ;
        include $sFilename;
        return;
    }

    static $aClassPaths;

    if (isset($aClassPaths[$sClass])) {
        stopProfile("oxAutoload");
        include $aClassPaths[$sClass];
        return;
    }

   $sBasePath = getShopBasePath();


    // initializing paths
    if ( $aClassDirs == null ) {
        $aClassDirs = getClassDirs ( $sBasePath );
    }

    foreach ( $aClassDirs as $sDir ) {
        $sFilename = $sDir .  $sClass . '.php';
        if ( file_exists( $sFilename ) ) {
            if (!isset($aClassPaths[$sClass])) {
                $aClassPaths[$sClass] = $sFilename;
                //oxRegistry::getUtils()->toPhpFileCache("class_file_paths", $aClassPaths);
            }
            stopProfile("oxAutoload");
            include $sFilename;
            return;
        }
    }



    // Files registered by modules
    //$aModuleFiles = oxRegistry::getConfig()->getConfigParam( 'aModuleFiles' );
    $aModuleFiles = oxUtilsObject::getInstance()->getModuleVar( 'aModuleFiles' );
    if ( is_array( $aModuleFiles ) ) {
        $sBasePath   = getShopBasePath();
        $oModulelist = oxNew('oxmodulelist');
        $aActiveModuleInfo = $oModulelist->getActiveModuleInfo();
        if (is_array($aActiveModuleInfo)) {
            foreach ($aModuleFiles as $sModuleId => $aModules) {
                if (isset($aModules[$sClass]) && isset($aActiveModuleInfo[$sModuleId])) {
                    $sPath = $aModules[$sClass];
                    $sFilename = $sBasePath. 'modules/'.  $sPath;
                    if ( file_exists( $sFilename ) ) {
                        if (!isset($aClassPaths[$sClass])) {
                            $aClassPaths[$sClass] = $sFilename;
                            oxRegistry::getUtils()->toPhpFileCache("class_file_paths", $aClassPaths);
                        }
                        stopProfile("oxAutoload");
                        include $sFilename;
                        return;
                    }
                }
            }
        }
    }

    // in case module parent class (*_parent) is required
    $sClass = preg_replace( '/_parent$/i', '', $sClass );

    // special case
    if ( !in_array( $sClass, $aTriedClasses ) && is_array( $aModules = oxUtilsObject::getInstance()->getModuleVar( 'aModules' ) ) ) {

        $myUtilsObject = oxUtilsObject::getInstance();
        foreach ( $aModules as $sParentName => $sModuleName ) {
            // looking for module parent class
            if (  preg_match('/\b'.$sClass.'($|\&)/i', $sModuleName )  ) {
                $myUtilsObject->getClassName( $sParentName );
                break;
            }
            $aTriedClasses[] = $sClass;
        }
    }

    stopProfile("oxAutoload");
}

function getClassDirs($sBasePath)
{
    $aClassDirs = array( $sBasePath . 'core/',
                         $sBasePath . 'application/components/widgets/',
                         $sBasePath . 'application/components/',
                         $sBasePath . 'application/models/',
                         $sBasePath . 'application/controllers/',
                         $sBasePath . 'application/controllers/admin/',
                         $sBasePath . 'application/controllers/admin/reports/',
                         $sBasePath . 'views/',
                         $sBasePath . 'core/exception/',
                         $sBasePath . 'core/interface/',
                         $sBasePath . 'core/cache/',
                         $sBasePath . 'core/cache/connectors/',
                         $sBasePath . 'core/wysiwigpro/',
                         $sBasePath . 'admin/reports/',
                         $sBasePath . 'admin/',
                         $sBasePath . 'modules/',
                         $sBasePath
                        );
    return $aClassDirs;
}


if ( !function_exists( 'getShopBasePath' ) ) {
    function getShopBasePath()
    {
        return OX_BASE_PATH;
    }
}

function isAdmin()
{
    if (defined('OX_IS_ADMIN')) {
        return OX_IS_ADMIN;
    }

    return false;
}

function setPhpIniParams()
{
    //setting required PHP configuration parameters
    ini_set('session.name', 'sid');
    ini_set('session.use_cookies', 0);
    ini_set('session.use_trans_sid', 0);
    ini_set('url_rewriter.tags', '');
    ini_set('magic_quotes_runtime', 0);
}

function stripGpcMagicQuotes()
{
    if (!get_magic_quotes_gpc()) {
        return;
    }
    $_REQUEST = _stripMagicQuotes($_REQUEST);
    $_POST = _stripMagicQuotes($_POST);
    $_GET = _stripMagicQuotes($_GET);
    $_COOKIE = _stripMagicQuotes($_COOKIE);
}

function _stripMagicQuotes($mInput)
{
    return is_array($mInput) ? array_map( '_stripMagicQuotes', $mInput ) : stripslashes( $mInput );
}

if ( !function_exists( 'error_404_handler' ) ) {
    function error_404_handler($sUrl = '')
    {
        oxRegistry::getUtils()->handlePageNotFoundError($sUrl);
    }
}

function warningHandler($iErrorNr, $sErrorText)
{
    echo "<div class='error_box'>".oxRegistry::getLang()->translateString('userError')."<code>[$iErrorNr] $sErrorText</code></div>";
}

function dumpVar( $mVar, $blToFile = false )
{
    $myConfig = oxRegistry::getConfig();
    if ( $blToFile ) {
        $out = var_export( $mVar, true );
        $f = fopen( $myConfig->getConfigParam( 'sCompileDir' )."/vardump.txt", "a" );
        fwrite( $f, $out );
        fclose( $f );
    } else {
        echo '<pre>';
        var_export( $mVar );
        echo '</pre>';
    }
}

if ( !function_exists( 'isSearchEngineUrl' ) ) {

    function isSearchEngineUrl()
    {
        return false;
    }
}

function debug( $mVar )
{
    $f = fopen( 'out.txt', 'a' );
    $sString = var_export( $mVar, true );
    fputs( $f, $sString."\n---------------------------------------------\n" );
    fclose( $f );
}

function cmpart( $a, $b )
{
    // sorting for crossselling
    if ( $a->cnt == $b->cnt )
        return 0;
    return ( $a->cnt < $b->cnt ) ? -1 : 1;
}

if ( !function_exists( 'startProfile' ) ) {
    function startProfile( $sProfileName )
    {
        global $aStartTimes;
        global $aExecutionCounts;
        if (!isset($aExecutionCounts[$sProfileName])) {
            $aExecutionCounts[$sProfileName] = 0;
        }
        if (!isset($aStartTimes[$sProfileName])) {
            $aStartTimes[$sProfileName] = 0;
        }
        $aExecutionCounts[$sProfileName]++;
        $aStartTimes[$sProfileName] = microtime(true);
    }
}

if ( !function_exists( 'stopProfile' ) ) {
    function stopProfile( $sProfileName )
    {
        global $aProfileTimes;
        global $aStartTimes;
        if (!isset($aProfileTimes[$sProfileName])) {
            $aProfileTimes[$sProfileName] = 0;
        }
        $aProfileTimes[$sProfileName] += microtime( true ) - $aStartTimes[$sProfileName];
    }
}

function oxNew( $sClassName )
{
    startProfile( 'oxNew' );
    $aArgs = func_get_args();
    $oRes = call_user_func_array( array( oxUtilsObject::getInstance(), "oxNew" ), $aArgs );
    stopProfile( 'oxNew' );
    return $oRes;
}

function oxNewArticle( $sArtId )
{
    return oxUtilsObject::getInstance()->oxNewArticle( $sArtId );
}

function getDb($blAssoc = true)
{
    return oxDb::getDb($blAssoc);
}

function getStr()
{
    return oxStr::getStr();
}

function ox_get_template( $sTplName, &$sTplSource, $oSmarty )
{
    $sTplSource = $oSmarty->oxidcache->value;
    if ( oxRegistry::getConfig()->isDemoShop() ) {
        $oSmarty->security = true;
    }

    return true;
}

function ox_get_timestamp( $sTplName, &$iTplTimestamp, $oSmarty )
{
    if ( isset( $oSmarty->oxidtimecache->value ) ) {
        // use stored timestamp
        $iTplTimestamp = $oSmarty->oxidtimecache->value;
    } else {
        // always compile
        $iTplTimestamp = time();
    }

    return true;
}

function ox_get_secure( $sTplName, $oSmarty )
{
    // assume all templates are secure
    return true;
}

function ox_get_trusted( $sTplName, $oSmarty )
{
    // not used for templates
}


if ( !function_exists( 'getLangTableIdx' ) ) {

    function getLangTableIdx( $iLangId )
    {
        $iLangPerTable = oxRegistry::getConfig()->getConfigParam( "iLangPerTable" );
        //#0002718 min language count per table 2
        $iLangPerTable = ( $iLangPerTable > 1 ) ? $iLangPerTable : 8;

        $iTableIdx = (int) ( $iLangId / $iLangPerTable );
        return $iTableIdx;
    }
}

if ( !function_exists( 'getLangTableName' ) ) {

    function getLangTableName( $sTable, $iLangId )
    {
        $iTableIdx = getLangTableIdx( $iLangId );
        if ( $iTableIdx && in_array($sTable, oxRegistry::getLang()->getMultiLangTables())) {
            $sLangTableSuffix = oxRegistry::getConfig()->getConfigParam( "sLangTableSuffix" );
            $sLangTableSuffix = $sLangTableSuffix ? $sLangTableSuffix : "_set";

            $sTable .= $sLangTableSuffix . $iTableIdx;
        }

        return $sTable;
    }
}

if ( !function_exists( 'getViewName' ) ) {

    function getViewName( $sTable, $iLangId = null, $sShopId = null )
    {
        $myConfig = oxRegistry::getConfig();

        //This config option should only be used in emergency case.
        //Originally it was planned for the case when admin area is not reached due to the broken views.
        if ( !$myConfig->getConfigParam( 'blSkipViewUsage' ) ) {
            $sViewSfx = '';


            $blIsMultiLang = in_array( $sTable, oxRegistry::getLang()->getMultiLangTables() );
            if ( $iLangId != -1 && $blIsMultiLang ) {
                $oLang = oxRegistry::getLang();
                $iLangId = $iLangId !== null ? $iLangId : oxRegistry::getLang()->getBaseLanguage();
                $sAbbr = $oLang->getLanguageAbbr( $iLangId );
                $sViewSfx .= "_{$sAbbr}";
            }

            if ( $sViewSfx || (($iLangId == -1 || $sShopId == -1 ) && $blIsMultiLang)) {
                return "oxv_{$sTable}{$sViewSfx}";
            }

        }

        return $sTable;
    }
}

if ( !function_exists( 'getRequestUrl' ) ) {
    function getRequestUrl( $sParams = '', $blReturnUrl = false )
    {
        if ($_SERVER["REQUEST_METHOD"] != "POST" ) {

            if ( isset( $_SERVER['REQUEST_URI'] ) && $_SERVER['REQUEST_URI'] ) {
                $sRequest = $_SERVER['REQUEST_URI'];
            } else {
                // try something else
                $sRequest = $_SERVER['SCRIPT_URI'];
            }

            // trying to resolve controller file name
            if ( $sRequest && ( $iPos = stripos( $sRequest, '?' ) ) !== false ) {

                $oStr = getStr();
                // formatting request url
                $sRequest = 'index.php' . $oStr->substr( $sRequest, $iPos );

                // removing possible session id
                $sRequest = $oStr->preg_replace( '/(&|\?)(force_)?(admin_)?sid=[^&]*&?/', '$1', $sRequest );
                $sRequest = $oStr->preg_replace( '/(&|\?)stoken=[^&]*&?/', '$1', $sRequest );
                $sRequest = $oStr->preg_replace( '/&$/', '', $sRequest );
                return str_replace( '&', '&amp;', $sRequest );
            }
        }
    }
}

//registering oxAutoload() as autoload handler
spl_autoload_register("oxAutoload");