httpparser.hpp

Go to the documentation of this file.

#ifndef COMPA_GENLIB_NET_HTTP_HTTPPARSER_HPP
#define COMPA_GENLIB_NET_HTTP_HTTPPARSER_HPP
/*******************************************************************************
 *
 * Copyright (c) 2000-2003 Intel Corporation
 * All rights reserved.
 * Copyright (c) 2012 France Telecom All rights reserved.
 * Copyright (C) 2021+ GPL 3 and higher by Ingo Höft, <Ingo@Hoeft-online.de>
 * Redistribution only with this Copyright remark. Last modified: 2025-06-12
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * - Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 * - Neither name of Intel Corporation nor the names of its contributors
 * may be used to endorse or promote products derived from this software
 * without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INTEL OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 ******************************************************************************/
// Last verify with this project pupnp source file on 2023-07-20, ver 1.14.17
#include <LinkedList.hpp>
#include <membuffer.hpp>
#include <upnp.hpp>
#include <uri.hpp>
 
#include <UPnPsdk/strintmap.hpp>
 
#include <array>
 
 
#define ENTREAD_DETERMINE_READ_METHOD 1
#define ENTREAD_USING_CLEN 2
#define ENTREAD_USING_CHUNKED 3
#define ENTREAD_UNTIL_CLOSE 4
#define ENTREAD_CHUNKY_BODY 5
#define ENTREAD_CHUNKY_HEADERS 6
 
enum parser_pos_t {
    POS_REQUEST_LINE,  
    POS_RESPONSE_LINE, 
    POS_HEADERS,       
    POS_ENTITY,        
    POS_COMPLETE       
};
 
struct scanner_t {
    membuffer* msg;
    size_t cursor;
    int entire_msg_loaded;
};
 
// The enum values of the standard HTTP method should match those of
// Upnp_HttpMethod enum defined in Compa/inc/API.hpp
enum http_method_t {
    HTTPMETHOD_PUT = UPNP_HTTPMETHOD_PUT,
    HTTPMETHOD_DELETE = UPNP_HTTPMETHOD_DELETE,
    HTTPMETHOD_GET = UPNP_HTTPMETHOD_GET,
    HTTPMETHOD_HEAD = UPNP_HTTPMETHOD_HEAD,
    HTTPMETHOD_POST = UPNP_HTTPMETHOD_POST,
    HTTPMETHOD_MPOST,
    HTTPMETHOD_SUBSCRIBE,
    HTTPMETHOD_UNSUBSCRIBE,
    HTTPMETHOD_NOTIFY,
    HTTPMETHOD_MSEARCH,
    HTTPMETHOD_UNKNOWN,
    SOAPMETHOD_POST,
    HTTPMETHOD_SIMPLEGET
};
 
#define HDR_UNKNOWN -1
#define HDR_CACHE_CONTROL 1
#define HDR_CALLBACK 2
#define HDR_CONTENT_LENGTH 3
#define HDR_CONTENT_TYPE 4
#define HDR_DATE 5
#define HDR_EXT 6
#define HDR_HOST 7
/*define HDR_IF_MODIFIED_SINCE      8 */
/*define HDR_IF_UNMODIFIED_SINCE    9 */
/*define HDR_LAST_MODIFIED      10 */
#define HDR_LOCATION 11
#define HDR_MAN 12
#define HDR_MX 13
#define HDR_NT 14
#define HDR_NTS 15
#define HDR_SERVER 16
#define HDR_SEQ 17
#define HDR_SID 18
#define HDR_SOAPACTION 19
#define HDR_ST 20
#define HDR_TIMEOUT 21
#define HDR_TRANSFER_ENCODING 22
#define HDR_USN 23
#define HDR_USER_AGENT 24
 
#define HDR_ACCEPT 25
#define HDR_ACCEPT_ENCODING 26
#define HDR_ACCEPT_CHARSET 27
#define HDR_ACCEPT_LANGUAGE 28
#define HDR_ACCEPT_RANGE 29
#define HDR_CONTENT_ENCODING 30
#define HDR_CONTENT_LANGUAGE 31
#define HDR_CONTENT_LOCATION 32
#define HDR_CONTENT_RANGE 33
#define HDR_IF_RANGE 34
#define HDR_RANGE 35
#define HDR_TE 36
 
// This is prepared for binary search and must be sorted by header-name.
inline constexpr std::array<const UPnPsdk::str_int_entry, 33> Http_Header_Names{
    {{"ACCEPT", HDR_ACCEPT},
     {"ACCEPT-CHARSET", HDR_ACCEPT_CHARSET},
     {"ACCEPT-ENCODING", HDR_ACCEPT_ENCODING},
     {"ACCEPT-LANGUAGE", HDR_ACCEPT_LANGUAGE},
     {"ACCEPT-RANGES", HDR_ACCEPT_RANGE},
     {"CACHE-CONTROL", HDR_CACHE_CONTROL},
     {"CALLBACK", HDR_CALLBACK},
     {"CONTENT-ENCODING", HDR_CONTENT_ENCODING},
     {"CONTENT-LANGUAGE", HDR_CONTENT_LANGUAGE},
     {"CONTENT-LENGTH", HDR_CONTENT_LENGTH},
     {"CONTENT-LOCATION", HDR_CONTENT_LOCATION},
     {"CONTENT-RANGE", HDR_CONTENT_RANGE},
     {"CONTENT-TYPE", HDR_CONTENT_TYPE},
     {"DATE", HDR_DATE},
     {"EXT", HDR_EXT},
     {"HOST", HDR_HOST},
     {"IF-RANGE", HDR_IF_RANGE},
     {"LOCATION", HDR_LOCATION},
     {"MAN", HDR_MAN},
     {"MX", HDR_MX},
     {"NT", HDR_NT},
     {"NTS", HDR_NTS},
     {"RANGE", HDR_RANGE},
     {"SEQ", HDR_SEQ},
     {"SERVER", HDR_SERVER},
     {"SID", HDR_SID},
     {"SOAPACTION", HDR_SOAPACTION},
     {"ST", HDR_ST},
     {"TE", HDR_TE},
     {"TIMEOUT", HDR_TIMEOUT},
     {"TRANSFER-ENCODING", HDR_TRANSFER_ENCODING},
     {"USER-AGENT", HDR_USER_AGENT},
     {"USN", HDR_USN}}};
 
enum parse_status_t {
    PARSE_SUCCESS = 0,
    PARSE_INCOMPLETE,
    PARSE_INCOMPLETE_ENTITY,
    PARSE_FAILURE,
    PARSE_OK,
    PARSE_NO_MATCH,
    PARSE_CONTINUE_1
};
 
struct http_header_t {
    memptr name;
    int name_id;
    membuffer value;
    membuffer name_buf;
};
 
struct http_message_t {
    int initialized;
 
    http_method_t method;
    uri_type uri;
 
    http_method_t request_method;
    int status_code;
    membuffer status_msg;
    size_t amount_discarded;
 
    int is_request;
    int major_version;
    int minor_version;
    LinkedList headers;
    memptr entity;
 
    membuffer msg;
    char* urlbuf;
};
 
struct http_parser_t {
    http_message_t msg;
    int http_error_code;
    int valid_ssdp_notify_hack;
    parser_pos_t position;
    int ent_position;
    unsigned int content_length;
    size_t chunk_size;
 
    size_t entity_start_position;
    scanner_t scanner;
};
 
void httpmsg_destroy(   //
    http_message_t* msg 
);
 
http_header_t* httpmsg_find_hdr_str(
    http_message_t* msg,    
    const char* header_name 
);
 
http_header_t* httpmsg_find_hdr(
    http_message_t* msg, 
    int header_name_id,  
    memptr* value        
);
 
void parser_request_init( //
    http_parser_t* parser 
);
 
void parser_response_init(       //
    http_parser_t* parser,       
    http_method_t request_method 
);
 
parse_status_t parser_parse( //
    http_parser_t* parser    
);
 
/* **********************************************************************
 * Function: matchstr
 *
 * Parameters:
 *  IN char *str ;      String to be matched
 *  IN size_t slen ;    Length of the string
 *  IN const char* fmt ;    Pattern format
 *  ...
 *
 * Description: Matches a variable parameter list with a string
 *  and takes actions based on the data type specified.
 *
 * Returns:
 *   PARSE_OK
 *   PARSE_NO_MATCH -- failure to match pattern 'fmt'
 *   PARSE_FAILURE  -- 'str' is bad input
 *   PARSE_INCOMPLETE
 ************************************************************************/
parse_status_t parser_parse_responseline(
    http_parser_t* parser 
);
 
/* **********************************************************************
 * Function: parser_parse_headers
 *
 * Parameters:
 *  INOUT http_parser_t* parser ; HTTP Parser object
 *
 * Description: Read HTTP header fields.
 *
 * Returns:
 *  PARSE_OK
 *  PARSE_SUCCESS
 *  PARSE_FAILURE
 *  PARSE_INCOMPLETE
 *  PARSE_NO_MATCH
 ************************************************************************/
parse_status_t
parser_parse_headers(http_parser_t* parser 
);
 
/* !
 * \brief Read HTTP entity body.
 *
 * \returns
 *  On success: PARSE_SUCCESS - no more reading to do.\n
 *  On error:
 *  - PARSE_FAILURE
 *  - PARSE_NO_MATCH
 *  - PARSE_INCOMPLETE
 *  - PARSE_INCOMPLETE_ENTITY
 */
parse_status_t
parser_parse_entity(http_parser_t* parser 
);
 
parse_status_t parser_get_entity_read_method(
    http_parser_t* parser 
);
 
parse_status_t
parser_append(http_parser_t* parser, 
              const char* buf,  
              size_t buf_length 
);
 
parse_status_t matchstr( //
    char* str,           
    size_t slen,         
    const char* fmt,     
    ...                  
);
 
int raw_to_int(        //
    memptr* raw_value, 
    int base           
);
 
int raw_find_str(      //
    memptr* raw_value, 
    const char* str    
);
 
const char* method_to_str( //
    http_method_t method   
);
 
void print_http_headers(
    std::string_view log_msg, 
    http_message_t* hmsg      
);
 
#endif /* COMPA_GENLIB_NET_HTTP_HTTPPARSER_HPP */