MvcTools/src/request_parsers/http.php

<?php
/**
 * File containing the ezcMvcHttpRequestParser class
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
 * @version //autogentag//
 * @filesource
 * @package MvcTools
 */

/**
 * Request parser that uses HTTP headers to populate an ezcMvcRequest object.
 *
 * @package MvcTools
 * @version //autogentag//
 * @mainclass
 */
class ezcMvcHttpRequestParser extends ezcMvcRequestParser
{
    /**
     * Uses the data from the superglobals.
     *
     * @return ezcMvcRequest
     */
    public function createRequest()
    {
        $this->request = $this->createRequestObject();
        $this->processStandardHeaders();
        $this->processAcceptHeaders();
        $this->processUserAgentHeaders();
        $this->processFiles();
        $this->processAuthVars();
        $this->processCookies();

        $this->request->raw = &$_SERVER;

        return $this->request;
    }

    /**
     * Creates and returns an ezcMvcRequest object.
     *
     * @return ezcMvcRequest
     */
    protected function createRequestObject()
    {
        return new ezcMvcRequest();
    }

    /**
     * Processes the basic HTTP auth variables is set
     */
    protected function processAuthVars()
    {
        $req = $this->request;
        if ( isset( $_SERVER['PHP_AUTH_USER'] ) && isset( $_SERVER['PHP_AUTH_PW'] ) )
        {
            $req->authentication = new ezcMvcRequestAuthentication( $_SERVER['PHP_AUTH_USER'], $_SERVER['PHP_AUTH_PW'] );
        }
    }

    /**
     * Processes the standard headers that are not subdivided into other structs.
     */
    protected function processStandardHeaders()
    {
        $this->processProtocol();
        $this->processHost();
        $this->processDate();
        $this->processVariables();
        $this->processReferrer();
        $this->processUri();
        $this->processBody();
        $this->processRequestId();
    }

    /**
     * Processes the request protocol. 
     */
    protected function processProtocol()
    {
        $req = $this->request;

        if ( isset( $_SERVER['REQUEST_METHOD'] ) )
        {
            switch ( $_SERVER['REQUEST_METHOD'] )
            {
                case 'POST':
                    $req->protocol = 'http-post';
                    break;
                case 'PUT':
                    $req->protocol = 'http-put';
                    break;
                case 'DELETE':
                    $req->protocol = 'http-delete';
                    break;
                default:
                    $req->protocol = 'http-get';
            }
        }
    }

    /**
     * Processes the request host.
     */
    protected function processHost()
    {
        $this->request->host = isset( $_SERVER['HTTP_HOST'] )
            ? $_SERVER['HTTP_HOST']
            : (
                isset( $_SERVER['SERVER_NAME'] )
                    ? $_SERVER['SERVER_NAME']
                    : 'localhost.localdomain'
            );
    }

    /**
     * Processes the request date.
     */
    protected function processDate()
    {
        $this->request->date = isset( $_SERVER['REQUEST_TIME'] )
            ? new DateTime( "@{$_SERVER['REQUEST_TIME']}" )
            : new DateTime();
    }

    /**
     * Processes the request variables.
     */
    protected function processVariables()
    {
        $this->request->variables =& $_REQUEST;
    }

    /**
     * Processes the referrer.
     */
    protected function processReferrer()
    {
        $this->request->referrer = isset( $_SERVER['HTTP_REFERER'] )
            ? $_SERVER['HTTP_REFERER']
            : null;
    }

    /**
     * Processes the request URI.
     */
    protected function processUri()
    {
        $req = $this->request;

        $req->uri = isset( $_SERVER['REQUEST_URI'] )
            ? $_SERVER['REQUEST_URI']
            : '';
        // remove the query string from the URI
        $req->uri = preg_replace( '@\?.*$@', '', $req->uri );
        // url decode the uri
        $req->uri = urldecode( $req->uri );
        // remove the prefix from the URI
        $req->uri = preg_replace( '@^' . preg_quote( $this->properties['prefix'] ) . '@', '', $req->uri );
    }

    /**
     * Processes the request ID from host and URI.
     */
    protected function processRequestId()
    {
        $this->request->requestId = $this->request->host . $this->request->uri;
    }

    /**
     * Processes the request body for PUT requests.
     */
    protected function processBody()
    {
        $req = $this->request;

        if ( $req->protocol == 'http-put' )
        {
            $req->body = file_get_contents( "php://input" );
        }
    }

    /**
     * Proccesses the HTTP Accept headers into the ezcMvcRequestAccept struct.
     */
    protected function processAcceptHeaders()
    {
        $this->request->accept = new ezcMvcRequestAccept;
        $accept = $this->request->accept;

        $map = array(
            'HTTP_ACCEPT' => 'types',
            'HTTP_ACCEPT_CHARSET' => 'charsets',
            'HTTP_ACCEPT_ENCODING' => 'encodings',
            'HTTP_ACCEPT_LANGUAGE' => 'languages',
        );

        foreach ( $map as $var => $property )
        {
            if ( !isset( $_SERVER[$var] ) )
            {
                $accept->$property = array();
                continue;
            }
            $parts = explode( ',', $_SERVER[$var] );
            $tmpPriorities = array();
            foreach ( $parts as $part )
            {
                $priPart = explode( ';q=', $part );
                if ( count( $priPart ) == 2 )
                {
                    $tmpPriorities[$priPart[0]] = $priPart[1];
                }
                else
                {
                    $tmpPriorities[$part] = 1;
                }
            }
            asort( $tmpPriorities );
            $accept->$property = array_keys( array_reverse( $tmpPriorities ) );
        }
    }

    /**
     * Proccesses the User Agent header into the ezcMvcRequestUserAgent struct.
     */
    protected function processUserAgentHeaders()
    {
        $this->request->agent = new ezcMvcRequestUserAgent;
        $agent = $this->request->agent;

        $agent->agent = isset( $_SERVER['HTTP_USER_AGENT'] )
            ? $_SERVER['HTTP_USER_AGENT']
            : null;
    }

    /**
     * Processes uploaded files.
     */
    protected function processFiles()
    {
        foreach ( $_FILES as $name => $info )
        {
            $file = new ezcMvcRequestFile;
            $file->mimeType = $info['type'];
            $file->name = $info['name'];
            $file->size = $info['size'];
            $file->status = $info['error'];
            $file->tmpPath = $info['tmp_name'];

            $this->request->files[] = $file;
        }
    }

    /**
     * Process cookies
     */
    protected function processCookies()
    {
        foreach ( $_COOKIE as $name => $value )
        {
            $cookie = new ezcMvcRequestCookie( $name, $value );
            $this->request->cookies[] = $cookie;
        }
    }
}
?>