oxutilsurl.php

Go to the documentation of this file.

<?php

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

    protected $_aAddUrlParams = null;

    protected $_aHosts = null;

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

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

    public function getBaseAddUrlParams()
    {
        $aAddUrlParams = array();

        return $aAddUrlParams;
    }

    public function getAddUrlParams()
    {
        if ( $this->_aAddUrlParams === null ) {
            $this->_aAddUrlParams = $this->getBaseAddUrlParams();

            // appending currency
            if ( ( $iCur = $this->getConfig()->getShopCurrency() ) ) {
                $this->_aAddUrlParams['cur'] = $iCur;
            }
        }
        return $this->_aAddUrlParams;
    }

    public function prepareUrlForNoSession( $sUrl )
    {
        if ( oxUtils::getInstance()->seoIsActive() ) {
            return $sUrl;
        }

        $oStr = getStr();
        $sUrl = $oStr->preg_replace('/(\?|&(amp;)?)(force_)?(admin_)?sid=[a-z0-9\._]+&?(amp;)?/i', '\1', $sUrl);

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

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

        $oConfig = $this->getConfig();
        if ( !$oStr->preg_match('/[&?](amp;)?cur=[0-9]+/i', $sUrl)) {
            $iCur = (int) $oConfig->getShopCurrency();
            if ( $iCur ) {
                $sUrl .= "{$sSep}cur=".$iCur;
                $sSep = '&amp;';
            }
        }

        return $sUrl;
    }

    public function prepareCanonicalUrl( $sUrl )
    {
        $oConfig = $this->getConfig();
        $oStr = getStr();

        // cleaning up session id..
        $sUrl = $oStr->preg_replace('/(\?|&(amp;)?)(force_)?(admin_)?sid=[a-z0-9\._]+&?(amp;)?/i', '\1', $sUrl);
        $sUrl = $oStr->preg_replace( '/(&amp;|\?)$/', '', $sUrl );
        $sSep = ( $oStr->strpos( $sUrl, '?' ) === false ) ? '?' : '&amp;';


        if ( !oxUtils::getInstance()->seoIsActive() ) {
            // non seo url has no language identifier..
            $iLang = oxLang::getInstance()->getBaseLanguage();
            if ( !$oStr->preg_match( '/[&?](amp;)?lang=[0-9]+/i', $sUrl ) && $iLang != $oConfig->getConfigParam( 'sDefaultLang' ) ) {
                $sUrl .= "{$sSep}lang=".$iLang;
            }
        }

        return $sUrl;
    }

    public function appendUrl( $sUrl, $aAddParams )
    {
        $oStr = getStr();
        $sSep = '&amp;';
        if ( $oStr->strpos( $sUrl, '?' ) === false ) {
            $sSep = '?';
        }

        if ( count( $aAddParams ) ) {
            foreach ( $aAddParams as $sName => $sValue ) {
                if ( isset( $sValue ) && !$oStr->preg_match("/\?(.*&(amp;)?)?".preg_quote( $sName )."=/", $sUrl ) ) {
                    $sUrl .= $sSep . $sName . "=" . $sValue;
                    $sSep = '&amp;';
                }
            }
        }
        return $sUrl ? $sUrl.$sSep : '';
    }

    public function cleanUrl( $sUrl, $aParams = null )
    {
        $oStr = getStr();
        if ( is_array( $aParams ) ) {
            foreach ( $aParams as $sParam ) {
                $sUrl = $oStr->preg_replace( '/(\?|&(amp;)?)'.preg_quote( $sParam ).'=[a-z0-9\.]+&?(amp;)?/i', '\1', $sUrl );
            }
        } else {
            $sUrl = $oStr->preg_replace( '/(\?|&(amp;)?).+/i', '\1', $sUrl );
        }

        return trim( $sUrl, "?" );
    }

    public function processUrl( $sUrl, $blFinalUrl = true, $aParams = null, $iLang = null )
    {
        $aAddParams = $this->getAddUrlParams();
        if ( is_array($aParams) && count( $aParams ) ) {
            $aAddParams = array_merge( $aAddParams, $aParams );
        }

        $ret = oxSession::getInstance()->processUrl(
                    oxLang::getInstance()->processUrl(
                        $this->appendUrl(
                                $sUrl,
                                $aAddParams
                        ),
                        $iLang
                    )
                );

        if ($blFinalUrl) {
            $ret = getStr()->preg_replace('/(\?|&(amp;)?)$/', '', $ret);
        }
        return $ret;
    }

    protected function _addHost( $sUrl, & $aHosts )
    {
        if ( $sUrl && ( $sHost = @parse_url( $sUrl, PHP_URL_HOST ) ) ) {
            if ( !in_array( $sHost, $aHosts ) ) {
                $aHosts[] = $sHost;
            }
        }
    }

    protected function _getHosts()
    {
        if ( $this->_aHosts === null ) {
            $this->_aHosts = array();
            $oConfig = $this->getConfig();

            // mall (ssl) url
            $this->_addHost( $oConfig->getConfigParam( "sMallShopURL" ), $this->_aHosts );
            $this->_addHost( $oConfig->getConfigParam( "sMallSSLShopURL" ), $this->_aHosts );

            // language url
            $this->_addHost( $oConfig->getConfigParam( 'aLanguageURLs' ), $this->_aHosts );
            $this->_addHost( $oConfig->getConfigParam( 'aLanguageSSLURLs' ), $this->_aHosts );

            if ( !count( $aHosts ) && !$oConfig->mustAddShopIdToRequest() ) {
                // current url
                $this->_addHost( $oConfig->getConfigParam( "sShopURL" ), $this->_aHosts );
                $this->_addHost( $oConfig->getConfigParam( "sSSLShopURL" ), $this->_aHosts );
            }

            if ( $this->isAdmin() ) {
                $this->_addHost( $oConfig->getConfigParam( "sAdminSSLURL" ), $this->_aHosts );
            }
        }

        return $this->_aHosts;
    }

    public function isCurrentShopHost( $sUrl )
    {
        $blCurrent = false;
        if ( $sUrl ) {
            // host of given url
            $sUrlHost = @parse_url( $sUrl, PHP_URL_HOST );

            // configured hosts
            $aHosts = $this->_getHosts();

            foreach ( $aHosts as $sHost ) {
                if ( $sHost === $sUrlHost ) {
                    $blCurrent = true;
                    break;
                }
            }
        }

        return $blCurrent;
    }

    public function processSeoUrl( $sUrl )
    {

        if ( !$this->isAdmin() ) {
            $sUrl = $this->getSession()->processUrl( $this->appendUrl( $sUrl, $this->getAddUrlParams() ) );
        }

        $sUrl = $this->cleanUrlParams($sUrl);
        return getStr()->preg_replace( '/(\?|&(amp;)?)$/', '', $sUrl );
    }

    public function cleanUrlParams($sUrl, $sConnector = '&amp;')
    {
        $aUrlParts = explode('?', $sUrl);

        // check for params part
        if (
            !is_array($aUrlParts)
            || count($aUrlParts) <= 1
            || count($aUrlParts) > 2
        ) {
            return $sUrl;
        }

        $sUrl = $aUrlParts[0];
        $sUrlParams = $aUrlParts[1];

        $oStrUtils = getStr();
        $sUrlParams = $oStrUtils->preg_replace(
            array('@(\&(amp;){1,})@ix', '@\&{1,}@', '@\?&@x'),
            array('&', '&', '?'),
            $sUrlParams
        );

        // remove dublicate entries
        parse_str($sUrlParams, $aUrlParams);
        $sUrl .= '?'.http_build_query($aUrlParams, '', $sConnector);

        return $sUrl;
    }

    public function appendParamSeparator($sUrl)
    {
        $oStr = getStr();
        if ( $oStr->preg_match('/(\?|&(amp;)?)$/i', $sUrl ) ) {
            // it is already ok
            return $sUrl;
        }
        if ( $oStr->strpos($sUrl, '?') === false ) {
            return $sUrl.'?';
        }
        return $sUrl.'&amp;';
    }
}