<?php

/**

 * Zend Framework

 *

 * LICENSE

 *

 * This source file is subject to the new BSD license that is bundled

 * with this package in the file LICENSE.txt.

 * It is also available through the world-wide-web at this URL:

 * http://framework.zend.com/license/new-bsd

 * If you did not receive a copy of the license and are unable to

 * obtain it through the world-wide-web, please send an email

 * to license@zend.com so we can send you a copy immediately.

 *

 * @category   Zend

 * @package    Zend_Controller

 * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)

 * @license    http://framework.zend.com/license/new-bsd     New BSD License

 * @version    $Id: Http.php 23414 2010-11-20 10:56:11Z bittarman $

 */

/** @see Zend_Controller_Request_Abstract */

require_once 'Zend/Controller/Request/Abstract.php';

/** @see Zend_Uri */

require_once 'Zend/Uri.php';

/**

 * Zend_Controller_Request_Http

 *

 * HTTP request object for use with Zend_Controller family.

 *

 * @uses Zend_Controller_Request_Abstract

 * @package Zend_Controller

 * @subpackage Request

 */

class Zend_Controller_Request_Http extends Zend_Controller_Request_Abstract

{

    /**

     * Scheme for http

     *

     */

    const SCHEME_HTTP  = 'http';

    /**

     * Scheme for https

     *

     */

    const SCHEME_HTTPS = 'https';

    /**

     * Allowed parameter sources

     * @var array

     */

    protected $_paramSources = array('_GET', '_POST');

    /**

     * REQUEST_URI

     * @var string;

     */

    protected $_requestUri;

    /**

     * Base URL of request

     * @var string

     */

    protected $_baseUrl = null;

    /**

     * Base path of request

     * @var string

     */

    protected $_basePath = null;

    /**

     * PATH_INFO

     * @var string

     */

    protected $_pathInfo = '';

    /**

     * Instance parameters

     * @var array

     */

    protected $_params = array();

    /**

     * Raw request body

     * @var string|false

     */

    protected $_rawBody;

    /**

     * Alias keys for request parameters

     * @var array

     */

    protected $_aliases = array();

    /**

     * Constructor

     *

     * If a $uri is passed, the object will attempt to populate itself using

     * that information.

     *

     * @param string|Zend_Uri $uri

     * @return void

     * @throws Zend_Controller_Request_Exception when invalid URI passed

     */

    public function __construct($uri = null)

    {

        if (null !== $uri) {

            if (!$uri instanceof Zend_Uri) {

                $uri = Zend_Uri::factory($uri);

            }

            if ($uri->valid()) {

                $path  = $uri->getPath();

                $query = $uri->getQuery();

                if (!empty($query)) {

                    $path .= '?' . $query;

                }

                $this->setRequestUri($path);

            } else {

                require_once 'Zend/Controller/Request/Exception.php';

                throw new Zend_Controller_Request_Exception('Invalid URI provided to constructor');

            }

        } else {

            $this->setRequestUri();

        }

    }

    /**

     * Access values contained in the superglobals as public members

     * Order of precedence: 1. GET, 2. POST, 3. COOKIE, 4. SERVER, 5. ENV

     *

     * @see http://msdn.microsoft.com/en-us/library/system.web.httprequest.item.aspx

     * @param string $key

     * @return mixed

     */

    public function __get($key)

    {

        switch (true) {

            case isset($this->_params[$key]):

                return $this->_params[$key];

            case isset($_GET[$key]):

                return $_GET[$key];

            case isset($_POST[$key]):

                return $_POST[$key];

            case isset($_COOKIE[$key]):

                return $_COOKIE[$key];

            case ($key == 'REQUEST_URI'):

                return $this->getRequestUri();

            case ($key == 'PATH_INFO'):

                return $this->getPathInfo();

            case isset($_SERVER[$key]):

                return $_SERVER[$key];

            case isset($_ENV[$key]):

                return $_ENV[$key];

            default:

                return null;

        }

    }

    /**

     * Alias to __get

     *

     * @param string $key

     * @return mixed

     */

    public function get($key)

    {

        return $this->__get($key);

    }

    /**

     * Set values

     *

     * In order to follow {@link __get()}, which operates on a number of

     * superglobals, setting values through overloading is not allowed and will

     * raise an exception. Use setParam() instead.

     *

     * @param string $key

     * @param mixed $value

     * @return void

     * @throws Zend_Controller_Request_Exception

     */

    public function __set($key, $value)

    {

        require_once 'Zend/Controller/Request/Exception.php';

        throw new Zend_Controller_Request_Exception('Setting values in superglobals not allowed; please use setParam()');

    }

    /**

     * Alias to __set()

     *

     * @param string $key

     * @param mixed $value

     * @return void

     */

    public function set($key, $value)

    {

        return $this->__set($key, $value);

    }

    /**

     * Check to see if a property is set

     *

     * @param string $key

     * @return boolean

     */

    public function __isset($key)

    {

        switch (true) {

            case isset($this->_params[$key]):

                return true;

            case isset($_GET[$key]):

                return true;

            case isset($_POST[$key]):

                return true;

            case isset($_COOKIE[$key]):

                return true;

            case isset($_SERVER[$key]):

                return true;

            case isset($_ENV[$key]):

                return true;

            default:

                return false;

        }

    }

    /**

     * Alias to __isset()

     *

     * @param string $key

     * @return boolean

     */

    public function has($key)

    {

        return $this->__isset($key);

    }

    /**

     * Set GET values

     *

     * @param  string|array $spec

     * @param  null|mixed $value

     * @return Zend_Controller_Request_Http

     */

    public function setQuery($spec, $value = null)

    {

        if ((null === $value) && !is_array($spec)) {

            require_once 'Zend/Controller/Exception.php';

            throw new Zend_Controller_Exception('Invalid value passed to setQuery(); must be either array of values or key/value pair');

        }

        if ((null === $value) && is_array($spec)) {

            foreach ($spec as $key => $value) {

                $this->setQuery($key, $value);

            }

            return $this;

        }

        $_GET[(string) $spec] = $value;

        return $this;

    }

    /**

     * Retrieve a member of the $_GET superglobal

     *

     * If no $key is passed, returns the entire $_GET array.

     *

     * @todo How to retrieve from nested arrays

     * @param string $key

     * @param mixed $default Default value to use if key not found

     * @return mixed Returns null if key does not exist

     */

    public function getQuery($key = null, $default = null)

    {

        if (null === $key) {

            return $_GET;

        }

        return (isset($_GET[$key])) ? $_GET[$key] : $default;

    }

    /**

     * Set POST values

     *

     * @param  string|array $spec

     * @param  null|mixed $value

     * @return Zend_Controller_Request_Http

     */

    public function setPost($spec, $value = null)

    {

        if ((null === $value) && !is_array($spec)) {

            require_once 'Zend/Controller/Exception.php';

            throw new Zend_Controller_Exception('Invalid value passed to setPost(); must be either array of values or key/value pair');

        }

        if ((null === $value) && is_array($spec)) {

            foreach ($spec as $key => $value) {

                $this->setPost($key, $value);

            }

            return $this;

        }

        $_POST[(string) $spec] = $value;

        return $this;

    }

    /**

     * Retrieve a member of the $_POST superglobal

     *

     * If no $key is passed, returns the entire $_POST array.

     *

     * @todo How to retrieve from nested arrays

     * @param string $key

     * @param mixed $default Default value to use if key not found

     * @return mixed Returns null if key does not exist

     */

    public function getPost($key = null, $default = null)

    {

        if (null === $key) {

            return $_POST;

        }

        return (isset($_POST[$key])) ? $_POST[$key] : $default;

    }

    /**

     * Retrieve a member of the $_COOKIE superglobal

     *

     * If no $key is passed, returns the entire $_COOKIE array.

     *

     * @todo How to retrieve from nested arrays

     * @param string $key

     * @param mixed $default Default value to use if key not found

     * @return mixed Returns null if key does not exist

     */

    public function getCookie($key = null, $default = null)

    {

        if (null === $key) {

            return $_COOKIE;

        }

        return (isset($_COOKIE[$key])) ? $_COOKIE[$key] : $default;

    }

    /**

     * Retrieve a member of the $_SERVER superglobal

     *

     * If no $key is passed, returns the entire $_SERVER array.

     *

     * @param string $key

     * @param mixed $default Default value to use if key not found

     * @return mixed Returns null if key does not exist

     */

    public function getServer($key = null, $default = null)

    {

        if (null === $key) {

            return $_SERVER;

        }

        return (isset($_SERVER[$key])) ? $_SERVER[$key] : $default;

    }

    /**

     * Retrieve a member of the $_ENV superglobal

     *

     * If no $key is passed, returns the entire $_ENV array.

     *

     * @param string $key

     * @param mixed $default Default value to use if key not found

     * @return mixed Returns null if key does not exist

     */

    public function getEnv($key = null, $default = null)

    {

        if (null === $key) {

            return $_ENV;

        }

        return (isset($_ENV[$key])) ? $_ENV[$key] : $default;

    }

    /**

     * Set the REQUEST_URI on which the instance operates

     *

     * If no request URI is passed, uses the value in $_SERVER['REQUEST_URI'],

     * $_SERVER['HTTP_X_REWRITE_URL'], or $_SERVER['ORIG_PATH_INFO'] + $_SERVER['QUERY_STRING'].

     *

     * @param string $requestUri

     * @return Zend_Controller_Request_Http

     */

    public function setRequestUri($requestUri = null)

    {

        if ($requestUri === null) {

            if (isset($_SERVER['HTTP_X_REWRITE_URL'])) { // check this first so IIS will catch

                $requestUri = $_SERVER['HTTP_X_REWRITE_URL'];

            } elseif (

                // IIS7 with URL Rewrite: make sure we get the unencoded url (double slash problem)

                isset($_SERVER['IIS_WasUrlRewritten'])

                && $_SERVER['IIS_WasUrlRewritten'] == '1'

                && isset($_SERVER['UNENCODED_URL'])

                && $_SERVER['UNENCODED_URL'] != ''

                ) {

                $requestUri = $_SERVER['UNENCODED_URL'];

            } elseif (isset($_SERVER['REQUEST_URI'])) {

                $requestUri = $_SERVER['REQUEST_URI'];

                // Http proxy reqs setup request uri with scheme and host [and port] + the url path, only use url path

                $schemeAndHttpHost = $this->getScheme() . '://' . $this->getHttpHost();

                if (strpos($requestUri, $schemeAndHttpHost) === 0) {

                    $requestUri = substr($requestUri, strlen($schemeAndHttpHost));

                }

            } elseif (isset($_SERVER['ORIG_PATH_INFO'])) { // IIS 5.0, PHP as CGI

                $requestUri = $_SERVER['ORIG_PATH_INFO'];

                if (!empty($_SERVER['QUERY_STRING'])) {

                    $requestUri .= '?' . $_SERVER['QUERY_STRING'];

                }

            } else {

                return $this;

            }

        } elseif (!is_string($requestUri)) {

            return $this;

        } else {

            // Set GET items, if available

            if (false !== ($pos = strpos($requestUri, '?'))) {

                // Get key => value pairs and set $_GET

                $query = substr($requestUri, $pos + 1);

                parse_str($query, $vars);

                $this->setQuery($vars);

            }

        }

        $this->_requestUri = $requestUri;

        return $this;

    }

    /**

     * Returns the REQUEST_URI taking into account

     * platform differences between Apache and IIS

     *

     * @return string

     */

    public function getRequestUri()

    {

        if (empty($this->_requestUri)) {

            $this->setRequestUri();

        }