oxutilsserver.php

Go to the documentation of this file.

<?php

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

    protected $_aUserCookie = 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 )
    {
        //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 ( defined('OXID_PHP_UNIT')) {
            // do NOT set cookies in php unit.
            return;
        }

        return setcookie( $sName, $sValue, $iExpire, $this->_getCookiePath( $sPath ), $this->_getCookieDomain( $sDomain ) );
    }

    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 = 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;
    }
}