http.h 18.8 KB
Newer Older
Pekka Pessi's avatar
Pekka Pessi committed
1 2 3 4 5 6 7
/*
 * This file is part of the Sofia-SIP package
 *
 * Copyright (C) 2005 Nokia Corporation.
 *
 * Contact: Pekka Pessi <pekka.pessi@nokia.com>
 *
8
 * This library is free software; you can redistribute it and/or
Pekka Pessi's avatar
Pekka Pessi committed
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA
 *
 */

#ifndef HTTP_H /** Defined when http.h has been included. */
Pekka Pessi's avatar
Pekka Pessi committed
26
#define HTTP_H
Pekka Pessi's avatar
Pekka Pessi committed
27 28 29 30 31 32 33 34 35 36

/**@file http.h 
 * 
 * HTTP message, methods, headers.
 * 
 * @sa <a href="http://www.ietf.org/rfc/rfc2616.txt">RFC 2616</a>
 *
 * @author Pekka Pessi <Pekka.Pessi@nokia.com>.
 *
 * @date Created      : Thu Jun  8 19:28:55 2000 ppessi
Pekka Pessi's avatar
Pekka Pessi committed
37
 * @date Last modified: Wed Jul 20 20:35:15 2005 kaiv
Pekka Pessi's avatar
Pekka Pessi committed
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487
 */

#ifndef MSG_H
#include <msg.h>
#endif
#ifndef URL_H
#include <url.h>
#endif
#ifndef MSG_MIME_H
#include <msg_mime.h>
#endif

/* ----------------------------------------------------------------------
 * 1) Constants 
 */

#define HTTP_NONE ((http_header_t *)MSG_HEADER_NONE)
#define HTTP_DEFAULT_PORT (80)
#define HTTP_DEFAULT_SERV "80"

/** HTTP protocol identifier */
#define HTTP_PROTOCOL_TAG   ((void *)0x48545450)	/* 'HTTP' */

/** HTTP parser flags */
enum {
  HTTP_FLG_NO_BODY = (1 << 15)
};

/** IDs for well-known HTTP methods. */
typedef enum {
  http_method_invalid = -1,	/**< Invalid method name */
  http_method_unknown = 0,	/**< Unknown method, use @c method_name */
  http_method_get,		/**< GET */
  http_method_post,		/**< POST */
  http_method_head,		/**< HEAD */
  http_method_options,		/**< OPTIONS */
  http_method_put,		/**< PUT */
  http_method_delete,		/**< DELETE */
  http_method_trace,		/**< TRACE */
  http_method_connect,		/**< CONNECT */
} http_method_t;

#define HTTP_METHOD(s)          http_method_unknown, #s
#define HTTP_NO_METHOD          http_method_unknown, NULL
#define HTTP_METHOD_GET	        http_method_get, "GET"
#define HTTP_METHOD_POST	http_method_post, "POST"
#define HTTP_METHOD_HEAD	http_method_head, "HEAD"
#define HTTP_METHOD_OPTIONS	http_method_options, "OPTIONS"
#define HTTP_METHOD_PUT	        http_method_put, "PUT"
#define HTTP_METHOD_DELETE	http_method_delete, "DELETE"
#define HTTP_METHOD_TRACE	http_method_trace, "TRACE"
#define HTTP_METHOD_CONNECT	http_method_connect, "CONNECT"

/* ----------------------------------------------------------------------
 * 2) Type declarations
 */

/** HTTP message object. */
typedef struct http_s               http_t;

/** Any HTTP header - union of all possible HTTP headers. */
typedef union http_header_u         http_header_t;

typedef struct http_request_s 	    http_request_t;
typedef struct http_status_s  	    http_status_t;
typedef msg_accept_t                http_accept_t;
typedef msg_accept_charset_t        http_accept_charset_t;
typedef msg_accept_encoding_t       http_accept_encoding_t;
typedef msg_accept_language_t       http_accept_language_t;
typedef msg_list_t                  http_accept_ranges_t;
typedef msg_numeric_t               http_age_t;
typedef msg_list_t                  http_allow_t;
typedef 
struct http_authentication_info_s   http_authentication_info_t;
typedef msg_auth_t                  http_authorization_t;
typedef msg_list_t                  http_cache_control_t;
typedef msg_list_t                  http_connection_t;
typedef msg_content_encoding_t      http_content_encoding_t;
typedef msg_content_language_t      http_content_language_t;
typedef msg_content_length_t        http_content_length_t;
typedef msg_content_location_t      http_content_location_t;
typedef msg_generic_t               http_content_md5_t;
typedef struct http_content_range_s http_content_range_t;
typedef msg_content_type_t          http_content_type_t;
typedef struct http_date_s          http_date_t;
typedef msg_generic_t               http_etag_t;
typedef msg_generic_t               http_expect_t;
typedef http_date_t                 http_expires_t;
typedef msg_generic_t               http_from_t;
typedef struct http_host_s          http_host_t;
typedef msg_list_t                  http_if_match_t;
typedef http_date_t                 http_if_modified_since_t;
typedef msg_list_t                  http_if_none_match_t;
typedef struct http_if_range_s      http_if_range_t;
typedef http_date_t                 http_if_unmodified_since_t;
typedef http_date_t                 http_last_modified_t;
typedef struct http_location_s      http_location_t;
typedef struct http_max_forwards_s  http_max_forwards_t;
typedef msg_generic_t               http_mime_version_t;
typedef msg_list_t                  http_pragma_t;
typedef msg_auth_t                  http_proxy_authenticate_t;
typedef msg_auth_t                  http_proxy_authorization_t;
typedef struct http_range_s         http_range_t;
typedef struct http_location_s      http_referer_t;
typedef struct http_retry_after_s   http_retry_after_t;
typedef msg_generic_t               http_server_t;
typedef struct http_te_s            http_te_t;
typedef msg_list_t                  http_trailer_t;
typedef msg_list_t                  http_transfer_encoding_t;
typedef msg_list_t                  http_upgrade_t;
typedef msg_generic_t               http_user_agent_t;
typedef msg_list_t                  http_vary_t;
typedef struct http_via_s           http_via_t;
typedef msg_warning_t               http_warning_t;
typedef msg_auth_t                  http_www_authenticate_t;

typedef msg_list_t                  http_proxy_connection_t;

typedef struct http_set_cookie_s    http_set_cookie_t;
typedef struct http_cookie_s        http_cookie_t;

/** Erroneous header. */
typedef msg_error_t                 http_error_t;
/** Unknown header. */
typedef msg_generic_t               http_unknown_t;
/** Separator line between headers and message contents */ 
typedef msg_separator_t             http_separator_t;
/** Entity-body */ 
typedef msg_payload_t               http_payload_t;
/** Time in seconds since 01-Jan-1900. */
typedef unsigned long               http_time_t;
/** Range offset. */
typedef unsigned long               http_off_t;


/* ----------------------------------------------------------------------
 * 3) Structure definitions
 */

/** HTTP request line */
struct http_request_s {
  msg_common_t      rq_common[1];
  http_error_t     *rq_next;
  http_method_t     rq_method;	    	/** Method enum. */
  char const       *rq_method_name; 	/** Method name. */
  url_t             rq_url[1];	    	/** URL. */
  char const       *rq_version;     	/** Protocol version. */
};

/** HTTP status line */
struct http_status_s {
  msg_common_t      st_common[1];
  http_error_t     *st_next;
  char const       *st_version;
  int               st_status;
  char const       *st_phrase;
};

/**@ingroup http_authentication_info
 * @brief Structure for @b Authentication-Info header.
 */
struct http_authentication_info_s
{
  msg_common_t        ai_common[1]; /**< Common fragment info */
  msg_error_t        *ai_next;	    /**< Dummy link to next */
  msg_param_t const  *ai_params;    /**< List of authentication info */
};

/** Content-Range */
struct http_content_range_s {
  msg_common_t      cr_common[1];
  http_error_t     *cr_next;
  http_off_t        cr_first;	/**< First-byte-pos */
  http_off_t        cr_last;	/**< Last-byte-pos */
  http_off_t        cr_length;	/**< Instance-length */
};

/** Date, Expires, If-Modified-Since, If-Unmodified-Since, Last-Modified */
struct http_date_s {
  msg_common_t      d_common[1];
  http_error_t     *d_next;
  http_time_t       d_time;	/**< Seconds since Jan 1, 1900 */
};

/** Host */
struct http_host_s {
  msg_common_t         h_common[1];
  http_error_t        *h_next;
  char const          *h_host;
  char const          *h_port;
};

/** If-Range */
struct http_if_range_s {
  msg_common_t         ifr_common[1];
  http_error_t        *ifr_next;
  char const          *ifr_tag;	 /**< Tag */
  http_time_t          ifr_time; /**< Timestamp */
};

/** Location, Referer */
struct http_location_s {
  msg_common_t         loc_common[1];
  http_error_t        *loc_next;
  url_t                loc_url[1];
};

/** Max-Forwards */
struct http_max_forwards_s {
  msg_common_t         mf_common[1];
  http_error_t        *mf_next;
  unsigned long        mf_count;
};

/** Range */
struct http_range_s
{
  msg_common_t         rng_common[1];
  http_error_t        *rng_next;
  char const          *rng_unit;
  char const         **rng_specs;
};

/** Retry-After. */
struct http_retry_after_s {
  msg_common_t         ra_common[1];  	/**< Common fragment info */
  http_error_t        *ra_next;	      	/**< Link to next (dummy) */
  http_time_t          ra_date;       	/**< When to retry */
  http_time_t          ra_delta;        /**< Seconds to before retry */
};

/** TE */
struct http_te_s {
  msg_common_t         te_common[1];	/**< Common fragment info */
  http_te_t           *te_next;		/**< Link to next t-coding */
  char const          *te_extension;	/**< Transfer-Extension */
  msg_param_t const   *te_params;	/**< List of parameters */
  char const          *te_q;		/**< Q-value */
};

/** Via */
struct http_via_s {
  msg_common_t         v_common[1];
  http_via_t          *v_next;
  char const          *v_version;
  char const          *v_host;
  char const          *v_port;
  char const          *v_comment;
};

/** Cookie */
struct http_cookie_s {
  msg_common_t         c_common[1];
  http_cookie_t       *c_next;
  msg_param_t const   *c_params;
  char const          *c_version;
  char const          *c_name;
  char const          *c_domain;
  char const          *c_path;
};

/** Set-Cookie */
struct http_set_cookie_s {
  msg_common_t         sc_common[1];
  http_set_cookie_t   *sc_next;
  msg_param_t const   *sc_params;
  char const          *sc_name;
  char const          *sc_version;
  char const          *sc_domain;
  char const          *sc_path;
  char const          *sc_comment;
  char const          *sc_max_age;
  unsigned             sc_secure;
};

/**HTTP message object.
 *
 * This structure contains a HTTP message object.  It is used to access the
 * headers and payload within the message.  The generic transport aspects of
 * the message, like network address, is accessed using a @b msg_t object
 * directly.
 */
struct http_s {
  msg_common_t               http_common[1];    /**< For recursive inclusion */
  msg_pub_t                 *http_next;	     /**< Dummy pointer to next part */
  void                      *http_user;	               /**< Application data */
  unsigned                   http_size;	         /**< Size of this structure */
  int                        http_flags;                          /**< Flags */
  http_error_t              *http_error;              /**< Erroneous headers */
  
  http_request_t            *http_request;                /**< Request line  */
  http_status_t             *http_status;                   /**< Status line */

  /* === Headers start here */
  http_accept_t             *http_accept;                        /**< Accept */
  http_accept_charset_t     *http_accept_charset;        /**< Accept-Charset */
  http_accept_encoding_t    *http_accept_encoding;      /**< Accept-Encoding */
  http_accept_language_t    *http_accept_language;      /**< Accept-Language */
  http_accept_ranges_t      *http_accept_ranges;          /**< Accept-Ranges */
  http_allow_t              *http_allow;                          /**< Allow */
  http_authentication_info_t*http_authentication_info;/**<Authentication-Info*/
  http_authorization_t      *http_authorization;          /**< Authorization */
  http_age_t                *http_age;                              /**< Age */
  http_cache_control_t      *http_cache_control;          /**< Cache-Control */
  http_connection_t         *http_connection;                /**< Connection */
  http_date_t               *http_date;                            /**< Date */
  http_etag_t               *http_etag;                            /**< ETag */
  http_expect_t             *http_expect;                        /**< Expect */
  http_expires_t            *http_expires;                      /**< Expires */
  http_from_t               *http_from;                            /**< From */
  http_host_t               *http_host;                            /**< Host */
  http_if_match_t           *http_if_match;                    /**< If-Match */
  http_if_modified_since_t  *http_if_modified_since;  /**< If-Modified-Since */
  http_if_none_match_t      *http_if_none_match;          /**< If-None-Match */
  http_if_range_t           *http_if_range;                    /**< If-Range */
  http_if_unmodified_since_t*http_if_unmodified_since;/**<If-Unmodified-Since*/
  http_last_modified_t      *http_last_modified;          /**< Last-Modified */
  http_location_t           *http_location;                    /**< Location */
  http_max_forwards_t       *http_max_forwards;            /**< Max-Forwards */
  http_pragma_t             *http_pragma;                        /**< Pragma */
  http_proxy_authenticate_t *http_proxy_authenticate;/**< Proxy-Authenticate */
  http_proxy_authorization_t*http_proxy_authorization;/**<Proxy-Authorization*/
  http_range_t              *http_range;                          /**< Range */
  http_referer_t            *http_referer;                      /**< Referer */
  http_retry_after_t        *http_retry_after;              /**< Retry-After */
  http_server_t             *http_server;                        /**< Server */
  http_te_t                 *http_te;                                /**< TE */
  http_trailer_t            *http_trailer;                      /**< Trailer */
  http_transfer_encoding_t  *http_transfer_encoding;  /**< Transfer-Encoding */
  http_upgrade_t            *http_upgrade;                      /**< Upgrade */
  http_user_agent_t         *http_user_agent;                /**< User-Agent */
  http_vary_t               *http_vary;                            /**< Vary */
  http_via_t                *http_via;                              /**< Via */
  http_warning_t            *http_warning;                      /**< Warning */
  http_www_authenticate_t   *http_www_authenticate;    /**< WWW-Authenticate */

  http_proxy_connection_t   *http_proxy_connection;    /**< Proxy-Connection */
  http_set_cookie_t         *http_set_cookie;                /**< Set-Cookie */
  http_cookie_t             *http_cookie;                        /**< Cookie */

  http_mime_version_t       *http_mime_version;            /**< MIME-Version */
  http_content_encoding_t   *http_content_encoding;    /**< Content-Encoding */
  http_content_language_t   *http_content_language;    /**< Content-Language */
  http_content_length_t     *http_content_length;        /**< Content-Length */
  http_content_location_t   *http_content_location;    /**< Content-Location */
  http_content_md5_t        *http_content_md5;              /**< Content-MD5 */
  http_content_range_t      *http_content_range;          /**< Content-Range */
  http_content_type_t       *http_content_type;            /**< Content-Type */

  /* === Headers end here */
  http_header_t             *http_unknown;             /**< Unknown headers. */
  http_separator_t          *http_separator;     
				  /**< Separator between message and payload */
  http_payload_t            *http_payload;	    /**< Message entity-body */
};

/**Union representing any HTTP header.
 * 
 * Each different header is an array of size 1.
 * 
 * @deprecated
 */
union http_header_u {
  msg_common_t                sh_common[1]; 
  struct {
    msg_common_t              shn_common;
    http_header_t            *shn_next;
  }                           sh_header_next[1];

  msg_auth_t                  sh_auth[1];
  msg_generic_t               sh_generic[1];
  msg_numeric_t               sh_numeric[1];

  http_request_t              sh_request[1];
  http_status_t               sh_status[1];
  http_error_t                sh_error[1];
  http_unknown_t              sh_unknown[1];
  http_separator_t            sh_separator[1];
  http_payload_t              sh_payload[1];

  /* Proper headers */
  http_via_t                 sh_via[1];
  http_host_t                sh_host[1];
  http_from_t                sh_from[1];
  http_referer_t             sh_referer[1];
  http_connection_t          sh_connection[1];

  http_accept_t              sh_accept[1];
  http_accept_charset_t      sh_accept_charset[1];
  http_accept_encoding_t     sh_accept_encoding[1];
  http_accept_language_t     sh_accept_language[1];
  http_accept_ranges_t       sh_accept_ranges[1];
  http_allow_t               sh_allow[1];
  http_te_t                  sh_te[1];

  http_authentication_info_t sh_authentication_info[1];
  http_authorization_t       sh_authorization[1];
  http_www_authenticate_t    sh_www_authenticate[1];
  http_proxy_authenticate_t  sh_proxy_authenticate[1];
  http_proxy_authorization_t sh_proxy_authorization[1];

  http_age_t                 sh_age[1];
  http_cache_control_t       sh_cache_control[1];
  http_date_t                sh_date[1];
  http_expires_t             sh_expires[1];
  http_if_match_t            sh_if_match[1];
  http_if_modified_since_t   sh_if_modified_since[1];
  http_if_none_match_t       sh_if_none_match[1];
  http_if_range_t            sh_if_range[1];
  http_if_unmodified_since_t sh_if_unmodified_since[1];

  http_etag_t                sh_etag[1];
  http_expect_t              sh_expect[1];
  http_last_modified_t       sh_last_modified[1];
  http_location_t            sh_location[1];
  http_max_forwards_t        sh_max_forwards[1];
  http_pragma_t              sh_pragma[1];
  http_range_t               sh_range[1];
  http_retry_after_t         sh_retry_after[1];
  http_trailer_t             sh_trailer[1];
  http_upgrade_t             sh_upgrade[1];
  http_vary_t                sh_vary[1];
  http_warning_t             sh_warning[1];

  http_user_agent_t          sh_user_agent[1];
  http_server_t              sh_server[1];

  http_mime_version_t        sh_mime_version[1];
  http_content_language_t    sh_content_language[1];
  http_content_location_t    sh_content_location[1];
  http_content_md5_t         sh_content_md5[1];
  http_content_range_t       sh_content_range[1];
  http_content_encoding_t    sh_content_encoding[1];
  http_transfer_encoding_t   sh_transfer_encoding[1];
  http_content_type_t        sh_content_type[1];
  http_content_length_t      sh_content_length[1];

};

/* Define declaration specification for exporting things from a shared lib */

#if !defined(WIN32)
#define HTTP_DLL
#elif defined(HTTP_EXPORTS)
#define HTTP_DLL __declspec(dllexport)
#else
#define HTTP_DLL __declspec(dllimport)
#endif

#endif /* !defined(HTTP_H) */