oxutilsserver.php

Go to the documentation of this file.

<?php

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

    protected $_aUserCookie = array();

    protected $_sSessionCookiesName = 'aSessionCookies';

    protected $_sSessionCookies = array();

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

        if ( !self::$_instance instanceof oxUtilsServer ) {
            self::$_instance = oxNew( 'oxUtilsServer');
            if ( defined( 'OXID_PHP_UNIT' ) ) {
                modInstances::addMod( __CLASS__, self::$_instance);
            }
        }
        return self::$_instance;
    }

    public function setOxCookie( $sName, $sValue = "", $iExpire = 0, $sPath = '/', $sDomain = null, $blToSession = true )
    {
        //TODO: since setcookie takes more than just 4 params..
        // would be nice to have it sending through https only, if in https mode
        // or allowing only http access to cookie [no JS access - reduces XSS attack possibility]
        // ref: http://lt.php.net/manual/en/function.setcookie.php

        if ( $blToSession && !$this->isAdmin() ) {
           $this->_saveSessionCookie( $sName, $sValue, $iExpire, $sPath, $sDomain );
        }

        if ( defined('OXID_PHP_UNIT')) {
            // do NOT set cookies in php unit.
            return;
        }

        return setcookie(
            $sName,
            $sValue,
            $iExpire,
            $this->_getCookiePath( $sPath ),
            $this->_getCookieDomain( $sDomain ),
            oxConfig::getInstance()->isSsl(),
            true
        );
    }

    protected $_blSaveToSession = null;

    protected function _mustSaveToSession()
    {
        if ( $this->_blSaveToSession === null ) {
            $this->_blSaveToSession = false;

            $myConfig = $this->getConfig();
            if ( $sSslUrl = $myConfig->getSslShopUrl() ) {
                $sUrl  = $myConfig->getShopUrl();

                $sHost    = parse_url( $sUrl, PHP_URL_HOST );
                $sSslHost = parse_url( $sSslUrl, PHP_URL_HOST );

                // testing if domains matches..
                if ( $sHost != $sSslHost ) {
                    $oUtils = oxUtils::getInstance();
                    $this->_blSaveToSession = $oUtils->extractDomain( $sHost ) != $oUtils->extractDomain( $sSslHost );
                }
            }
        }

        return $this->_blSaveToSession;
    }

    protected function _getSessionCookieKey( $blGet )
    {
        $blSsl = $this->getConfig()->isSsl();
        $sKey  = $blSsl ? 'nossl' : 'ssl';

        if ( $blGet ) {
            $sKey = $blSsl ? 'ssl' : 'nossl';
        }

        return $sKey;
    }

    protected function _saveSessionCookie( $sName, $sValue, $iExpire, $sPath, $sDomain )
    {
        if ( $this->_mustSaveToSession() ) {
            $aCookieData = array( 'value' => $sValue, 'expire' => $iExpire, 'path' => $sPath, 'domain' => $sDomain );

            $aSessionCookies = ( array ) oxSession::getVar( $this->_sSessionCookiesName );
            $aSessionCookies[$this->_getSessionCookieKey( false )][$sName] = $aCookieData;

            oxSession::setVar( $this->_sSessionCookiesName, $aSessionCookies );
        }
    }

    public function loadSessionCookies()
    {
        if ( ( $aSessionCookies = oxSession::getVar( $this->_sSessionCookiesName ) ) ) {
            $sKey = $this->_getSessionCookieKey( true );
            if ( isset( $aSessionCookies[$sKey] ) ) {
                // writing session data to cookies
                foreach ( $aSessionCookies[$sKey] as $sName => $aCookieData ) {
                    $this->setOxCookie( $sName, $aCookieData['value'], $aCookieData['expire'], $aCookieData['path'], $aCookieData['domain'], false );
                    $this->_sSessionCookies[$sName] = $aCookieData['value'];
                }

                // cleanup
                unset( $aSessionCookies[$sKey] );
                oxSession::setVar( $this->_sSessionCookiesName, $aSessionCookies );
            }
        }
    }

    protected function _getCookiePath( $sPath )
    {
        // possibility for users to define cookie path
        // @deprecated use "aCookiePaths" instead
        if ( $sCookiePath = $this->getConfig()->getConfigParam( 'sCookiePath' ) ) {
            $sPath = $sCookiePath;
        } elseif ( $aCookiePaths = $this->getConfig()->getConfigParam( 'aCookiePaths' ) ) {
            // in case user wants to have shop specific setup
            $sShopId = $this->getConfig()->getShopId();
            $sPath = isset( $aCookiePaths[$sShopId] ) ? $aCookiePaths[$sShopId] : $sPath;
        }

        // from php doc: .. You may also replace an argument with an empty string ("") in order to skip that argument..
        return $sPath ? $sPath : "";
    }

    protected function _getCookieDomain( $sDomain )
    {
        $sDomain = $sDomain ? $sDomain : "";

        // on special cases, like separate domain for SSL, cookies must be defined on domain specific path
        // please have a look at
        if ( !$sDomain ) {
            // @deprecated use "aCookieDomains" instead
            if ( $sCookieDomain = $this->getConfig()->getConfigParam( 'sCookieDomain' ) ) {
                $sDomain = $sCookieDomain;
            } elseif ( $aCookieDomains = $this->getConfig()->getConfigParam( 'aCookieDomains' ) ) {
                // in case user wants to have shop specific setup
                $sShopId = $this->getConfig()->getShopId();
                $sDomain = isset( $aCookieDomains[$sShopId] ) ? $aCookieDomains[$sShopId] : $sDomain;
            }
        }
        return $sDomain;
    }

    public function getOxCookie( $sName = null )
    {
        $sValue = null;
        if ( $sName && isset( $_COOKIE[$sName] ) ) {
            $sValue = oxConfig::checkSpecialChars($_COOKIE[$sName]);
        } elseif ( $sName && !isset( $_COOKIE[$sName] ) ) {
            $sValue = isset( $this->_sSessionCookies[$sName] ) ? $this->_sSessionCookies[$sName] : null;
        } elseif ( !$sName && isset( $_COOKIE ) ) {
            $sValue = $_COOKIE;
        }
        return $sValue;
    }

    public function getRemoteAddress()
    {
        if ( isset( $_SERVER["HTTP_X_FORWARDED_FOR"] ) ) {
            $sIP = $_SERVER["HTTP_X_FORWARDED_FOR"];
            $sIP = preg_replace('/,.*$/', '', $sIP);
        } elseif ( isset( $_SERVER["HTTP_CLIENT_IP"] ) ) {
            $sIP = $_SERVER["HTTP_CLIENT_IP"];
        } else {
            $sIP = $_SERVER["REMOTE_ADDR"];
        }
        return $sIP;
    }

    public function getServerVar( $sServVar = null )
    {
        $sValue = null;
        if ( isset( $_SERVER ) ) {
            if ( $sServVar && isset( $_SERVER[$sServVar] ) ) {
                $sValue = $_SERVER[$sServVar];
            } elseif ( !$sServVar ) {
                $sValue = $_SERVER;
            }
        }
        return $sValue;
    }

    public function setUserCookie( $sUser, $sPassword,  $sShopId = null, $iTimeout = 31536000 )
    {
        $sShopId = ( !$sShopId ) ? $this->getConfig()->getShopId() : $sShopId;
        $this->_aUserCookie[$sShopId] = $sUser . '@@@' . crypt( $sPassword, 'ox' );
        $this->setOxCookie( 'oxid_' . $sShopId, $this->_aUserCookie[$sShopId], oxUtilsDate::getInstance()->getTime() + $iTimeout, '/' );
    }

    public function deleteUserCookie( $sShopId = null )
    {
        $sShopId = ( !$sShopId ) ? $this->getConfig()->getShopId() : $sShopId;
        $this->_aUserCookie[$sShopId] = '';
        $this->setOxCookie( 'oxid_'.$sShopId, '', oxUtilsDate::getInstance()->getTime() - 3600, '/' );
    }

    public function getUserCookie( $sShopId = null )
    {
        $sShopId = ( !$sShopId ) ? parent::getConfig()->getShopID() : $sShopId;
        if ( $this->_aUserCookie[$sShopId] !== null ) {
            if ( !$this->_aUserCookie[$sShopId] ) {
                // cookie has been deleted
                return null;
            }
            return $this->_aUserCookie[$sShopId];
        }

        return $this->_aUserCookie[$sShopId] = $this->getOxCookie( 'oxid_'.$sShopId );
    }

    public function isTrustedClientIp()
    {
        $blTrusted = false;
        $aTrustedIPs = ( array ) $this->getConfig()->getConfigParam( "aTrustedIPs" );
        if ( count( $aTrustedIPs ) ) {
            $blTrusted = in_array( $this->getRemoteAddress(), $aTrustedIPs );
        }

        return $blTrusted;
    }

    public function processUserAgentInfo( $sAgent )
    {
        if ( $sAgent ) {
            $sAgent = getStr()->preg_replace( "/MSIE(\s)?(\S)*(\s)/", "", (string) $sAgent );
        }
        return $sAgent;
    }
}