oxutils.php

Go to the documentation of this file.

<?php

require_once getShopBasePath()."core/smarty/Smarty.class.php";

class oxUtils extends oxSuperCfg
{

    private static $_instance = null;

    protected $_iCurPrecision = null;

    protected $_sEmailTpl = "^([-!#\$%&'*+./0-9=?A-Z^_`a-z{|}~\177])+@([-!#\$%&'*+/0-9=?A-Z^_`a-z{|}~\177]+\\.)+[a-zA-Z]{2,6}\$";

    public static function getInstance()
    {
        // disable caching for test modules
        if ( defined( 'OXID_PHP_UNIT' ) ) {
            static $inst = array();
            self::$_instance = $inst[oxClassCacheKey()];

        }

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


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

            if ( defined( 'OXID_PHP_UNIT' ) ) {
                $inst[oxClassCacheKey()] = self::$_instance;
            }
        }
        return self::$_instance;
    }

    protected $_aStaticCache;

    protected $_blSeoIsActive = null;

    public function stripGpcMagicQuotes()
    {
        if (!get_magic_quotes_gpc()) {
            return;
        }
        $_REQUEST = self::_stripQuotes($_REQUEST);
        $_POST = self::_stripQuotes($_POST);
        $_GET = self::_stripQuotes($_GET);
        $_COOKIE = self::_stripQuotes($_COOKIE);
    }

    public function strMan( $sVal, $sKey = null )
    {
        $sKey = $sKey?$sKey:'oxid123456789';
        $sVal = "ox{$sVal}id";

        $sKey = str_repeat( $sKey, strlen( $sVal ) / strlen( $sKey ) + 5 );
        $sVal = $this->strRot13( $sVal );
        $sVal = $sVal ^ $sKey;
        $sVal = base64_encode( $sVal );
        $sVal = str_replace( "=", "!", $sVal );

        return "ox_$sVal";
    }

    public function strRem( $sVal, $sKey = null )
    {
        $sKey = $sKey?$sKey:'oxid123456789';
        $sKey = str_repeat( $sKey, strlen( $sVal ) / strlen( $sKey ) + 5 );

        $sVal = substr( $sVal, 3 );
        $sVal = str_replace( '!', '=', $sVal );
        $sVal = base64_decode( $sVal );
        $sVal = $sVal ^ $sKey;
        $sVal = $this->strRot13( $sVal );

        return substr( $sVal, 2, -2 );
    }

    public function getArrFldName( $sName)
    {
        return str_replace( ".", "__", $sName);
    }

    public function assignValuesFromText( $sIn, $dVat = null)
    {
        $aRet = array();
        $aPieces = explode( '@@', $sIn );
        while ( list( $sKey, $sVal ) = each( $aPieces ) ) {
            if ( $sVal ) {
                $aName = explode( '__', $sVal );
                if ( isset( $aName[0] ) && isset( $aName[1] ) ) {
                    $aRet[] = $this->_fillExplodeArray( $aName, $dVat );
                }
            }
        }
        return $aRet;
    }

    public function assignValuesToText( $aIn)
    {
        $sRet = "";
        reset( $aIn );
        while (list($sKey, $sVal) = each($aIn)) {
            $sRet .= $sKey;
            $sRet .= "__";
            $sRet .= $sVal;
            $sRet .= "@@";
        }
        return $sRet;
    }

    public function formatCurrency( $dValue, $oActCur = null )
    {
        if (!$oActCur) {
            $oActCur = $this->getConfig()->getActShopCurrencyObject();
        }
        $sFormated = number_format( $dValue, $oActCur->decimal, $oActCur->dec, $oActCur->thousand);

        return $sFormated;
    }

    public function currency2Float( $sValue)
    {
        $fRet = $sValue;
        $iPos = strrpos( $sValue, ".");
        if ($iPos && ((strlen($sValue)-1-$iPos) < 2+1)) {
            // replace decimal with ","
            $fRet = substr_replace( $fRet, ",", $iPos, 1);
        }
        // remove thousands
        $fRet = str_replace( array(" ","."), "", $fRet);

        $fRet = str_replace( ",", ".", $fRet);
        return (float) $fRet;
    }

    public function isSearchEngine( $sClient = null )
    {
        $myConfig = $this->getConfig();
        $blIsSe   = false;

        if ( !( $myConfig->getConfigParam( 'iDebug' ) && $this->isAdmin() ) ) {

            // caching
            $blIsSe = $myConfig->getGlobalParameter( 'blIsSearchEngine' );
            if ( !isset( $blIsSe ) ) {

                $aRobots = $myConfig->getConfigParam( 'aRobots' );
                $aRobots = is_array( $aRobots )?$aRobots:array();

                $aRobotsExcept = $myConfig->getConfigParam( 'aRobotsExcept' );
                $aRobotsExcept = is_array( $aRobotsExcept )?$aRobotsExcept:array();

                $sClient = $sClient?$sClient:strtolower( getenv( 'HTTP_USER_AGENT' ) );
                $blIsSe  = false;
                $aRobots = array_merge( $aRobots, $aRobotsExcept );
                foreach ( $aRobots as $sRobot ) {
                    if ( strpos( $sClient, $sRobot ) !== false ) {
                        $blIsSe = true;
                        break;
                    }
                }
                $myConfig->setGlobalParameter( 'blIsSearchEngine', $blIsSe );
            }
        }

        return $blIsSe;
    }

    public function isValidEmail( $sEmail )
    {
        $blValid = true;
        if ( $sEmail != 'admin' ) {
            $blValid = ( eregi( $this->_sEmailTpl, $sEmail ) != 0 );
        }

        return $blValid;
    }

    public function rebuildCache()
    {
        // not needed from 3.0 on and unused <- MK: not correct, its used for example in shop_config.php, oxbase.php

        //$smarty  = & oxUtils::getInstance()->getSmarty();
        //$smarty->clear_all_cache();

        if ( function_exists( "UserdefinedRebuildCache")) {
            UserdefinedRebuildCache();
        }
    }

    public function loadAdminProfile($aInterfaceProfiles)
    {
        // improved #533
        // checking for available profiles list
        $aInterfaceProfiles = $aInterfaceProfiles;
        if ( is_array( $aInterfaceProfiles ) ) {   //checking for previous profiles
            $sPrevProfile = oxUtilsServer::getInstance()->getOxCookie('oxidadminprofile');
            if (isset($sPrevProfile)) {
                $aPrevProfile = @explode("@", trim($sPrevProfile));
            }

            //array to store profiles
            $aProfiles = array();
            foreach ( $aInterfaceProfiles as $iPos => $sProfile) {
                $aProfileSettings = array($iPos, $sProfile);
                $aProfiles[] = $aProfileSettings;
            }
            // setting previous used profile as active
            if (isset($aPrevProfile[0]) && isset($aProfiles[$aPrevProfile[0]])) {
                $aProfiles[$aPrevProfile[0]][2] = 1;
            }

            oxSession::setVar("aAdminProfiles", $aProfiles);
            return $aProfiles;
        }
        return null;
    }

    public function fRound($sVal, $oCur = null)
    {
        startProfile('fround');

        //cached currency precision, this saves about 1% of execution time
        $iCurPrecision = null;
        if (! defined('OXID_PHP_UNIT')) {
            $iCurPrecision = $this->_iCurPrecision;
        }

        if (is_null($iCurPrecision)) {
            if ( !$oCur ) {
                $oCur = $this->getConfig()->getActShopCurrencyObject();
            }

            $iCurPrecision = $oCur->decimal;
            $this->_iCurPrecision = $iCurPrecision;
        }

        // this is a workaround for #36008 bug in php - incorrect round() & number_format() result (R)
        static $dprez = null;
        if (!$dprez) {
            $prez = @ini_get("precision");
            if (!$prez) {
                $prez = 9;
            }
            $dprez = pow(10, -$prez);
        }


        stopProfile('fround');

        return round($sVal + $dprez, $iCurPrecision);
    }

    public function toStaticCache( $sName, $sContent, $sKey = null )
    {
        // if it's an array then we add
        if ( $sKey ) {
            $this->_aStaticCache[$sName][$sKey] = $sContent;
        } else {
            $this->_aStaticCache[$sName] = $sContent;
        }
    }

    public function fromStaticCache( $sName)
    {
        if ( isset( $this->_aStaticCache[$sName])) {
            return $this->_aStaticCache[$sName];
        }
        return null;
    }

    public function cleanStaticCache($sCacheName = null)
    {
        if ($sCacheName) {
            unset($this->_aStaticCache[$sCacheName]);
        } else {
            $this->_aStaticCache = null;
        }
    }

    protected function _oxFileCache( $blMode, $sName, $sInput = null )
    {
        $sFilePath = $this->_getCacheFilePath( $sName );
        $sRet = null;
        if ( $blMode) {
            // write to cache

            //if ( is_writable($sFilePath))
            // dodger: somehow iswriteable always says no on windows machines

            $hFile = fopen( $sFilePath, "w");
            if ( $hFile) {
                fwrite( $hFile, $sInput);
                fclose( $hFile);
            }
        } else {   // read it
            if ( file_exists( $sFilePath) && is_readable($sFilePath)) {
                // read it
                $sRet = file_get_contents( $sFilePath);
            }
        }
        return $sRet;
    }

    public function toFileCache($sKey, $sContents)
    {
        $sStaticCacheKey = 'staticfilecache|' . $sKey;
        $this->toStaticCache($sStaticCacheKey, $sContents);

        $sContents = serialize($sContents);
        return $this->_oxFileCache(true, $sKey, $sContents);
    }

    public function fromFileCache( $sKey )
    {
        $sStaticCacheKey = "staticfilecache|$sKey";

        //using static cache for even faster fetch
        $sRes = $this->fromStaticCache( $sStaticCacheKey );

        if ( is_null( $sRes ) ) {
            $sRes = $this->_oxFileCache( false, $sKey );
            if (!is_null($sRes)) {
                $sRes = unserialize( $sRes );
                $this->toStaticCache( $sStaticCacheKey, $sRes );
            }
        }

        return $sRes;
    }

    public function oxResetFileCache()
    {
        $aPathes = glob( $this->_getCacheFilePath( '*' ) );
        if ( is_array( $aPathes ) ) {
            foreach ( $aPathes as $sFilename ) {
                // delete all the files, except cached tables fieldnames
                if ( strpos($sFilename, "c_fieldnames_") === false ) {
                    @unlink( $sFilename );
                }
            }
        }
    }

    public function getRemoteCachePath($sRemote, $sLocal)
    {
        clearstatcache();
        if ( file_exists( $sLocal ) && filemtime( $sLocal ) && filemtime( $sLocal ) > time() - 86400 ) {
            return $sLocal;
        }
        $hRemote = @fopen( $sRemote, "rb");
        $blSuccess = false;
        if ( isset( $hRemote) && $hRemote ) {
            $hLocal = fopen( $sLocal, "wb");
            stream_copy_to_stream($hRemote, $hLocal);
            fclose($hRemote);
            fclose($hLocal);
            $blSuccess = true;
        } else {
            // try via fsockopen
            $aUrl = @parse_url( $sRemote);
            if ( !empty( $aUrl["host"])) {
                $sPath = $aUrl["path"];
                if ( empty( $sPath ) ) {
                    $sPath = "/";
                }
                $sHost = $aUrl["host"];

                $hSocket = @fsockopen( $sHost, 80, $iErrorNumber, $iErrStr, 5);
                if ( $hSocket) {
                    fputs( $hSocket, "GET ".$sPath." HTTP/1.0\r\nHost: $sHost\r\n\r\n");
                    $headers = stream_get_line($hSocket, 4096, "\r\n\r\n");
                    $hLocal = @fopen( $sLocal, "wb");
                    stream_copy_to_stream($hSocket, $hLocal);
                    fclose( $hSocket);
                    fclose($hLocal);
                    $blSuccess = true;
                }
            }
        }
        if ( $blSuccess || file_exists( $sLocal ) ) {
            return $sLocal;
        } else {
            return false;
        }
    }

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

        $blIsAuth = false;

        $sUserID = oxSession::getVar( "auth");

        // deleting admin marker
        oxSession::setVar( "malladmin", 0);
        oxSession::setVar( "blIsAdmin", 0);
        oxSession::deleteVar( "blIsAdmin" );
        $myConfig->setConfigParam( 'blMallAdmin', false );
        //#1552T
        $myConfig->setConfigParam( 'blAllowInheritedEdit', false );

        if ( $sUserID) {
            // escaping
            $oDb = oxDb::getDb();
            $sUserID = $oDb->quote($sUserID);
            $sRights = $oDb->getOne("select oxrights from oxuser where oxid = $sUserID");

            if ( $sRights != "user") {
                // malladmin ?
                if ( $sRights == "malladmin") {
                    oxSession::setVar( "malladmin", 1);
                    $myConfig->setConfigParam( 'blMallAdmin', true );

                    //#1552T
                    //So far this blAllowSharedEdit is Equal to blMallAdmin but in future to be solved over rights and roles
                    $myConfig->setConfigParam( 'blAllowSharedEdit', true );

                    $sShop = oxSession::getVar( "actshop");
                    if ( !isset($sShop)) {
                        oxSession::setVar( "actshop", $myConfig->getBaseShopId());
                    }
                    $blIsAuth = true;
                } else {   // Shopadmin... check if this shop is valid and exists
                    $sShopID = $oDb->getOne("select oxid from oxshops where oxid = '{$sRights}'");
                    if ( isset( $sShopID) && $sShopID) {   // success, this shop exists

                        oxSession::setVar( "actshop", $sRights);
                        oxSession::setVar( "currentadminshop", $sRights);
                        oxSession::setVar( "shp", $sRights);

                        // check if this subshop admin is evil.
                        if ('chshp' == oxConfig::getParameter( 'fnc' )) {
                            // dont allow this call
                            $blIsAuth = false;
                        } else {
                            $blIsAuth = true;

                            $aShopIdVars = array('actshop', 'shp', 'currentadminshop');
                            foreach ($aShopIdVars as $sShopIdVar) {
                                if ($sGotShop = oxConfig::getParameter( $sShopIdVar )) {
                                    if ($sGotShop != $sRights) {
                                        $blIsAuth = false;
                                        break;
                                    }
                                }
                            }
                        }
                    }
                }
                // marking user as admin
                oxSession::setVar( "blIsAdmin", 1);
            }
        }
        return $blIsAuth;
    }

    public function seoIsActive( $blReset = false, $sShopId = null, $iActLang = null )
    {
        if ( !is_null( $this->_blSeoIsActive ) && !$blReset ) {
            return $this->_blSeoIsActive;
        }

        $myConfig = $this->getConfig();

        if ( $this->isAdmin() ) {
            // allways off in admin
            $this->_blSeoIsActive = false;
        } elseif ( ( $this->_blSeoIsActive = $myConfig->getConfigParam( 'blSeoMode' ) ) === null ) {
            $this->_blSeoIsActive = true;

            $aSeoModes  = $myConfig->getconfigParam( 'aSeoModes' );
            $sActShopId = $sShopId ? $sShopId : $myConfig->getActiveShop()->getId();
            $iActLang   = $iActLang ? $iActLang : (int) oxLang::getInstance()->getBaseLanguage();

            // checking special config param for active shop and language
            if ( is_array( $aSeoModes ) && isset( $aSeoModes[$sActShopId] ) && isset( $aSeoModes[$sActShopId][$iActLang] ) ) {
                $this->_blSeoIsActive = (bool) $aSeoModes[$sActShopId][$iActLang];
            }
        }

        return $this->_blSeoIsActive;
    }

    public function getShopBit( $iShopId )
    {
        $iShopId = (int) $iShopId;
        //this works for large numbers when $sShopNr is up to (inclusive) 64
        $iRes = oxDb::getDb()->getOne( "select 1 << ( $iShopId - 1 ) as shopbit" );

        //as php ints supports only 32 bits, we return string.
        return $iRes;
    }

    public function bitwiseAnd( $iVal1, $iVal2 )
    {
        //this works for large numbers when $sShopNr is up to (inclusive) 64
        $iRes = oxDb::getDb()->getOne( "select ($iVal1 & $iVal2) as bitwiseAnd" );

        //as php ints supports only 32 bits, we return string.
        return $iRes;
    }

    public function bitwiseOr( $iVal1, $iVal2 )
    {
        //this works for large numbers when $sShopNr is up to (inclusive) 64
        $iRes = oxDb::getDb()->getOne( "select ($iVal1 | $iVal2) as bitwiseOr" );

        //as php ints supports only 32 bits, we return string.
        return $iRes;
    }

    public function isValidAlpha( $sField )
    {
        return (boolean) preg_match( "#^[\w]*$#", $sField );
    }

    protected function _simpleRedirect( $sUrl, $sHeaderCode )
    {
        header( $sHeaderCode );
        header( "Location: $sUrl" );
        header( "Connection: close" );
    }

    public function redirect( $sUrl, $blAddRedirectParam = true )
    {
        //preventing possible cyclic redirection
        //#M341 and check only if redirect paramater must be added
        if ( $blAddRedirectParam && oxConfig::getParameter( 'redirected' ) ) {
            return;
        }

        if ( $blAddRedirectParam ) {
            $sUrl = $this->_addUrlParameters( $sUrl, array( 'redirected' => 1 ) );
        }

        $sUrl = str_ireplace( "&amp;", "&", $sUrl );
        $this->_simpleRedirect( $sUrl, "HTTP/1.1 301 Moved Permanently" );

        try {//may occur in case db is lost
            $this->getSession()->freeze();
        } catch( oxException $oEx ) {
            $oEx->debugOut();
            //do nothing else to make sure the redirect takes place
        }

        if ( defined( 'OXID_PHP_UNIT' ) ) {
            return;
        }

        $this->showMessageAndExit( '' );
    }

    public function showMessageAndExit( $sMsg )
    {
        $this->getSession()->freeze();

        if ( defined( 'OXID_PHP_UNIT' ) ) {
            return;
        }

        die( $sMsg );
    }

    protected function _addUrlParameters( $sUrl, $aParams )
    {
        $sDelim = ( ( getStr()->strpos( $sUrl, '?' ) !== false ) )?'&':'?';
        foreach ( $aParams as $sName => $sVal ) {
            $sUrl = $sUrl . $sDelim . $sName . '=' . $sVal;
            $sDelim = '&';
        }

        return $sUrl;
    }

    protected function _fillExplodeArray( $aName, $dVat = null)
    {
        $myConfig = $this->getConfig();
        $oObject = new OxstdClass();
        $aPrice = explode( '!P!', $aName[0]);

        if ( ( $myConfig->getConfigParam( 'bl_perfLoadSelectLists' ) && $myConfig->getConfigParam( 'bl_perfUseSelectlistPrice' ) && isset( $aPrice[0] ) && isset( $aPrice[1] ) ) || $this->isAdmin() ) {

            // yes, price is there
            $oObject->price = $aPrice[1];
            $aName[0] = $aPrice[0];

            $iPercPos = getStr()->strpos( $oObject->price, '%' );
            if ( $iPercPos !== false ) {
                $oObject->priceUnit = '%';
                $oObject->fprice = $oObject->price;
                $oObject->price  = substr( $oObject->price, 0, $iPercPos );
            } else {
                $oCur = $myConfig->getActShopCurrencyObject();
                $oObject->price = str_replace(',', '.', $oObject->price);
                $oObject->fprice = oxLang::getInstance()->formatCurrency( $oObject->price  * $oCur->rate, $oCur);
                $oObject->priceUnit = 'abs';
            }

            // add price info into list
            if ( !$this->isAdmin() && $oObject->price != 0 ) {
                $aName[0] .= " ";
                if ( $oObject->price > 0 ) {
                    $aName[0] .= "+";
                }
                //V FS#2616
                if ( $dVat != null && $oObject->priceUnit == 'abs' ) {
                    $oPrice = oxNew('oxPrice');
                    $oPrice->setPrice($oObject->price, $dVat);
                    $aName[0] .= oxLang::getInstance()->formatCurrency( $oPrice->getBruttoPrice() * $oCur->rate, $oCur);
                } else {
                    $aName[0] .= $oObject->fprice;
                }
                if ( $oObject->priceUnit == 'abs' ) {
                    $aName[0] .= " ".$oCur->sign;
                }
            }
        } elseif ( isset( $aPrice[0] ) && isset($aPrice[1] ) ) {
            // A. removing unused part of information
            $aName[0] = ereg_replace( "!P!.*", "", $aName[0] );
        }

        $oObject->name  = $aName[0];
        $oObject->value = $aName[1];
        return $oObject;
    }

    public function oxMimeContentType( $sFileName )
    {
        $sFileName = strtolower( $sFileName );
        $iLastDot  = strrpos( $sFileName, '.' );

        if ( $iLastDot !== false ) {
            $sType = substr( $sFileName, $iLastDot + 1 );
            switch ( $sType ) {
                case 'gif':
                    $sType = 'image/gif';
                    break;
                case 'jpeg':
                case 'jpg':
                    $sType = 'image/jpeg';
                    break;
                case 'png':
                    $sType = 'image/png';
                    break;
                default:
                    $sType = false;
                    break;
            }
        }
        return $sType;
    }

    public function logger( $sText, $blNewline = false )
    {   $myConfig = $this->getConfig();

        if ( $myConfig->getConfigParam( 'iDebug' ) == -2) {
            if ( gettype( $sText ) != 'string' ) {
                $sText = var_export( $sText, true);
            }
            @error_log("----------------------------------------------\n$sText".( ( $blNewline ) ?"\n":"" )."\n", 3, $myConfig->getConfigParam( 'sCompileDir' ).'/log.txt' );
        }

    }

    protected function _stripQuotes($mInput)
    {
        return is_array($mInput) ? array_map( array( $this, '_stripQuotes' ), $mInput) : stripslashes( $mInput );
    }

    public function strRot13( $sStr )
    {
        $sFrom = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ';
        $sTo   = 'nopqrstuvwxyzabcdefghijklmNOPQRSTUVWXYZABCDEFGHIJKLM';

        return strtr( $sStr, $sFrom, $sTo );
    }


    public function prepareUrlForNoSession($sUrl)
    {
        if ( $this->seoIsActive() ) {
            return $sUrl;
        }

        $sUrl = preg_replace('/(force_)?sid=[a-z0-9\._]*&?(amp;)?/i', '', $sUrl);

        $oStr = getStr();
        if ($qpos = $oStr->strpos($sUrl, '?')) {
            if ($qpos == $oStr->strlen($sUrl)-1) {
                $sSep = '';
            } else {
                $sSep = '&amp;';
            }
        } else {
            $sSep = '?';
        }

        if (!preg_match('/[&?](amp;)?lang=[0-9]+/i', $sUrl)) {
            $sUrl .= "{$sSep}lang=".oxLang::getInstance()->getBaseLanguage();
            $sSep = '&amp;';
        }

        if (!preg_match('/[&?](amp;)?cur=[0-9]+/i', $sUrl)) {
            $iCur = (int) oxConfig::getParameter('currency');
            if ($iCur) {
                $sUrl .= "{$sSep}cur=".$iCur;
                $sSep = '&amp;';
            }
        }

        return $sUrl;
    }

    protected function _getCacheFilePath( $sCacheName )
    {
        $sVersionPrefix = "";


            $sVersionPrefix = 'pe';

        return $this->getConfig()->getConfigParam( 'sCompileDir' ) . "/ox{$sVersionPrefix}c_{$sCacheName}.txt";
    }

    public function getLangCache( $sCacheName )
    {
        $aLangCache = null;
        $sFilePath = $this->_getCacheFilePath( $sCacheName );
        if ( file_exists( $sFilePath ) && is_readable( $sFilePath ) ) {
            include $sFilePath;
        }
        return $aLangCache;
    }

    public function setLangCache( $sCacheName, $aLangCache )
    {
        $sCache = "<?php\n\$aLangCache = ".var_export( $aLangCache, true ).";";
        $this->_oxFileCache( true, $sCacheName, $sCache );
    }

    public function checkUrlEndingSlash( $sUrl )
    {
        if ( !preg_match("/\/$/", $sUrl) ) {
            $sUrl .= '/';
        }

        return $sUrl;
    }

}

---