srs/trunk/src/app/srs_app_http.hpp

/*
The MIT License (MIT)

Copyright (c) 2013-2014 winlin

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/

#ifndef SRS_APP_HTTP_HPP
#define SRS_APP_HTTP_HPP

/*
#include <srs_app_http.hpp>
*/
#include <srs_core.hpp>

#ifdef SRS_HTTP_PARSER

#include <string>
#include <vector>
#include <sstream>

#include <http_parser.h>

#include <srs_app_st.hpp>

class SrsBuffer;
class SrsRequest;
class SrsSocket;
class SrsHttpUri;
class SrsHttpMessage;
class SrsHttpHandler;

// http specification
// CR             = <US-ASCII CR, carriage return (13)>
#define __CR "\r" // 0x0D
// LF             = <US-ASCII LF, linefeed (10)>
#define __LF "\n" // 0x0A
// SP             = <US-ASCII SP, space (32)>
#define __SP " " // 0x20
// HT             = <US-ASCII HT, horizontal-tab (9)>
#define __HT "\x09" // 0x09

// HTTP/1.1 defines the sequence CR LF as the end-of-line marker for all
// protocol elements except the entity-body (see appendix 19.3 for
// tolerant applications). 
#define __CRLF "\r\n" // 0x0D0A
#define __CRLFCRLF "\r\n\r\n" // 0x0D0A0D0A

// 6.1.1 Status Code and Reason Phrase
#define HTTP_Continue                       100
#define HTTP_SwitchingProtocols             101
#define HTTP_OK                             200
#define HTTP_Created                        201
#define HTTP_Accepted                       202
#define HTTP_NonAuthoritativeInformation    203
#define HTTP_NoContent                      204
#define HTTP_ResetContent                   205
#define HTTP_PartialContent                 206
#define HTTP_MultipleChoices                300
#define HTTP_MovedPermanently               301
#define HTTP_Found                          302
#define HTTP_SeeOther                       303
#define HTTP_NotModified                    304
#define HTTP_UseProxy                       305
#define HTTP_TemporaryRedirect              307
#define HTTP_BadRequest                     400
#define HTTP_Unauthorized                   401
#define HTTP_PaymentRequired                402
#define HTTP_Forbidden                      403
#define HTTP_NotFound                       404
#define HTTP_MethodNotAllowed               405
#define HTTP_NotAcceptable                  406
#define HTTP_ProxyAuthenticationRequired    407
#define HTTP_RequestTimeout                 408
#define HTTP_Conflict                       409
#define HTTP_Gone                           410
#define HTTP_LengthRequired                 411
#define HTTP_PreconditionFailed             412
#define HTTP_RequestEntityTooLarge          413
#define HTTP_RequestURITooLarge             414
#define HTTP_UnsupportedMediaType           415
#define HTTP_RequestedRangeNotSatisfiable   416
#define HTTP_ExpectationFailed              417
#define HTTP_InternalServerError            500
#define HTTP_NotImplemented                 501
#define HTTP_BadGateway                     502
#define HTTP_ServiceUnavailable             503
#define HTTP_GatewayTimeout                 504
#define HTTP_HTTPVersionNotSupported        505

#define HTTP_Continue_str                           "Continue"
#define HTTP_SwitchingProtocols_str                 "Switching Protocols"
#define HTTP_OK_str                                 "OK"
#define HTTP_Created_str                            "Created "
#define HTTP_Accepted_str                           "Accepted"
#define HTTP_NonAuthoritativeInformation_str        "Non Authoritative Information "
#define HTTP_NoContent_str                          "No Content "
#define HTTP_ResetContent_str                       "Reset Content"
#define HTTP_PartialContent_str                     "Partial Content"
#define HTTP_MultipleChoices_str                    "Multiple Choices "
#define HTTP_MovedPermanently_str                   "Moved Permanently"
#define HTTP_Found_str                              "Found"
#define HTTP_SeeOther_str                           "See Other"
#define HTTP_NotModified_str                        "Not Modified "
#define HTTP_UseProxy_str                           "Use Proxy"
#define HTTP_TemporaryRedirect_str                  "Temporary Redirect "
#define HTTP_BadRequest_str                         "Bad Request"
#define HTTP_Unauthorized_str                       "Unauthorized"
#define HTTP_PaymentRequired_str                    "Payment Required "
#define HTTP_Forbidden_str                          "Forbidden "
#define HTTP_NotFound_str                           "Not Found"
#define HTTP_MethodNotAllowed_str                   "Method Not Allowed"
#define HTTP_NotAcceptable_str                      "Not Acceptable "
#define HTTP_ProxyAuthenticationRequired_str        "Proxy Authentication Required "
#define HTTP_RequestTimeout_str                     "Request Timeout"
#define HTTP_Conflict_str                           "Conflict"
#define HTTP_Gone_str                               "Gone"
#define HTTP_LengthRequired_str                     "Length Required"
#define HTTP_PreconditionFailed_str                 "Precondition Failed"
#define HTTP_RequestEntityTooLarge_str              "Request Entity Too Large "
#define HTTP_RequestURITooLarge_str                 "Request URI Too Large"
#define HTTP_UnsupportedMediaType_str               "Unsupported Media Type"
#define HTTP_RequestedRangeNotSatisfiable_str       "Requested Range Not Satisfiable"
#define HTTP_ExpectationFailed_str                  "Expectation Failed "
#define HTTP_InternalServerError_str                "Internal Server Error "
#define HTTP_NotImplemented_str                     "Not Implemented"
#define HTTP_BadGateway_str                         "Bad Gateway"
#define HTTP_ServiceUnavailable_str                 "Service Unavailable"
#define HTTP_GatewayTimeout_str                     "Gateway Timeout"
#define HTTP_HTTPVersionNotSupported_str            "HTTP Version Not Supported"

// linux path seprator
#define __PATH_SEP '/'
// query string seprator
#define __QUERY_SEP '?'

// compare the path.
// full compare, extractly match.
extern bool srs_path_equals(const char* expect, const char* path, int nb_path);

// state of message
enum SrsHttpParseState {
    SrsHttpParseStateInit = 0, 
    SrsHttpParseStateStart, 
    SrsHttpParseStateComplete
};

/**
* the matched handler info.
*/
class SrsHttpHandlerMatch
{
public:
    SrsHttpHandler* handler;
    std::string matched_url;
    std::string unmatched_url;
public:
    SrsHttpHandlerMatch();
};

/**
* resource handler for HTTP RESTful api.
*/
class SrsHttpHandler
{
protected:
    /**
    * we use handler chain to process request.
    */
    std::vector<SrsHttpHandler*> handlers;
public:
    SrsHttpHandler();
    virtual ~SrsHttpHandler();
public:
    /**
    * initialize the handler.
    */
    virtual int initialize();
    /**
    * whether current handler can handle the specified path.
    * @pchild set the next child path, if needed.
    *       for example, the root handler will reset pchild to path,
    *       to reparse the path use child handlers.
    */
    virtual bool can_handle(const char* path, int length, const char** pchild);
    /**
    * use the handler to process the request.
    * @remark sub classes should override the do_process_request.
    */
    virtual int process_request(SrsSocket* skt, SrsHttpMessage* req);
public:
    /**
    * find the best matched handler
    */
    virtual int best_match(const char* path, int length, SrsHttpHandlerMatch** ppmatch);
// factory methods
protected:
    /**
    * check whether the handler is valid.
    * for example, user access /apis, actually it's not found,
    * we will find the root handler to process it.
    * @remark user can override this method, and should invoke it first.
    * @see SrsApiRoot::is_handler_valid
    */
    virtual bool is_handler_valid(SrsHttpMessage* req, int& status_code, std::string& reason_phrase);
    /**
    * do the actual process of request.
    */
    virtual int do_process_request(SrsSocket* skt, SrsHttpMessage* req);
// response writer
public:
    virtual SrsHttpHandler* res_status_line(std::stringstream& ss);
    virtual SrsHttpHandler* res_status_line_error(std::stringstream& ss, int code, std::string reason_phrase);
    virtual SrsHttpHandler* res_content_type(std::stringstream& ss);
    virtual SrsHttpHandler* res_content_type_json(std::stringstream& ss);
    virtual SrsHttpHandler* res_content_length(std::stringstream& ss, int64_t length);
    virtual SrsHttpHandler* res_enable_crossdomain(std::stringstream& ss);
    virtual SrsHttpHandler* res_header_eof(std::stringstream& ss);
    virtual SrsHttpHandler* res_body(std::stringstream& ss, std::string body);
    virtual int res_flush(SrsSocket* skt, std::stringstream& ss);
public:
    virtual int res_options(SrsSocket* skt);
    virtual int res_text(SrsSocket* skt, std::string body);
    virtual int res_json(SrsSocket* skt, std::string json);
    virtual int res_error(SrsSocket* skt, int code, std::string reason_phrase, std::string body);
// object creator
public:
    /**
    * create http api resource handler.
    */
    static SrsHttpHandler* create_http_api();
    /**
    * create http stream resource handler.
    */
    static SrsHttpHandler* create_http_stream();
};

/**
* the http message, request or response.
*/
class SrsHttpMessage
{
private:
    /**
    * parsed url.
    */
    std::string _url;
    /**
    * parsed http header.
    */
    http_parser _header;
    /**
    * body object, in bytes.
    * @remark, user can get body in string by get_body().
    */
    SrsBuffer* _body;
    /**
    * parser state
    * @remark, user can use is_complete() to determine the state.
    */
    SrsHttpParseState _state;
    /**
    * uri parser
    */
    SrsHttpUri* _uri;
    /**
    * best matched handler.
    */
    SrsHttpHandlerMatch* _match;
public:
    SrsHttpMessage();
    virtual ~SrsHttpMessage();
public:
    virtual void reset();
    virtual int parse_uri();
public:
    virtual bool is_complete();
    virtual u_int8_t method();
    virtual std::string url();
    virtual std::string path();
    virtual std::string query();
    virtual std::string body();
    virtual int64_t body_size();
    virtual int64_t content_length();
    virtual SrsHttpHandlerMatch* match();
    virtual void set_url(std::string url);
    virtual void set_state(SrsHttpParseState state);
    virtual void set_header(http_parser* header);
    virtual void set_match(SrsHttpHandlerMatch* match);
    virtual void append_body(const char* body, int length);
};

/**
* wrapper for http-parser, 
* provides HTTP message originted service.
*/
class SrsHttpParser
{
private:
    http_parser_settings settings;
    http_parser parser;
    SrsHttpMessage* msg;
public:
    SrsHttpParser();
    virtual ~SrsHttpParser();
public:
    /**
    * initialize the http parser with specified type,
    * one parser can only parse request or response messages.
    */
    virtual int initialize(enum http_parser_type type);
    /**
    * always parse a http message,
    * that is, the *ppmsg always NOT-NULL when return success.
    * or error and *ppmsg must be NULL.
    * @remark, if success, *ppmsg always NOT-NULL, *ppmsg always is_complete().
    */
    virtual int parse_message(SrsSocket* skt, SrsHttpMessage** ppmsg);
private:
    /**
    * parse the HTTP message to member field: msg.
    */
    virtual int parse_message_imp(SrsSocket* skt);
private:
    static int on_message_begin(http_parser* parser);
    static int on_headers_complete(http_parser* parser);
    static int on_message_complete(http_parser* parser);
    static int on_url(http_parser* parser, const char* at, size_t length);
    static int on_header_field(http_parser* parser, const char* at, size_t length);
    static int on_header_value(http_parser* parser, const char* at, size_t length);
    static int on_body(http_parser* parser, const char* at, size_t length);
};

/**
* used to resolve the http uri.
*/
class SrsHttpUri
{
private:
    std::string url;
    std::string schema;
    std::string host;
    int port;
    std::string path;
    std::string query;
public:
    SrsHttpUri();
    virtual ~SrsHttpUri();
public:
    /**
    * initialize the http uri.
    */
    virtual int initialize(std::string _url);
public:
    virtual const char* get_url();
    virtual const char* get_schema();
    virtual const char* get_host();
    virtual int get_port();
    virtual const char* get_path();
    virtual const char* get_query();
private:
    /**
    * get the parsed url field.
    * @return return empty string if not set.
    */
    virtual std::string get_uri_field(std::string uri, http_parser_url* hp_u, http_parser_url_fields field);
};

#endif

#endif