xref: /lighttpd1.4/src/http_kv.h (revision d0494fc0)
1 #ifndef INCLUDED_HTTP_KV_H
2 #define INCLUDED_HTTP_KV_H
3 #include "first.h"
4 
5 #include "buffer.h"
6 
7 /* sources:
8  * - [RFC2616], Section 9
9  *   (or http://tools.ietf.org/html/draft-ietf-httpbis-p2-semantics-22)
10  * - http://tools.ietf.org/html/draft-ietf-httpbis-method-registrations-11, Appendix A
11  *
12  * http://tools.ietf.org/html/draft-ietf-httpbis-p2-semantics-22, Section 8.1 defines
13  * a new registry (not available yet):
14  *   http://www.iana.org/assignments/http-methods
15  */
16 
17 typedef enum {
18 	HTTP_METHOD_PRI = -2,          /* [RFC7540], Section 3.5 */
19 	HTTP_METHOD_UNSET = -1,
20 	HTTP_METHOD_GET,               /* [RFC2616], Section 9.3 */
21 	HTTP_METHOD_HEAD,              /* [RFC2616], Section 9.4 */
22 	HTTP_METHOD_QUERY,             /* [RFCxxxx], Section 2 */
23 	HTTP_METHOD_POST,              /* [RFC2616], Section 9.5 */
24 	HTTP_METHOD_PUT,               /* [RFC2616], Section 9.6 */
25 	HTTP_METHOD_DELETE,            /* [RFC2616], Section 9.7 */
26 	HTTP_METHOD_CONNECT,           /* [RFC2616], Section 9.9 */
27 	HTTP_METHOD_OPTIONS,           /* [RFC2616], Section 9.2 */
28 	HTTP_METHOD_TRACE,             /* [RFC2616], Section 9.8 */
29 	HTTP_METHOD_ACL,               /* [RFC3744], Section 8.1 */
30 	HTTP_METHOD_BASELINE_CONTROL,  /* [RFC3253], Section 12.6 */
31 	HTTP_METHOD_BIND,              /* [RFC5842], Section 4 */
32 	HTTP_METHOD_CHECKIN,           /* [RFC3253], Section 4.4 and [RFC3253], Section 9.4 */
33 	HTTP_METHOD_CHECKOUT,          /* [RFC3253], Section 4.3 and [RFC3253], Section 8.8 */
34 	HTTP_METHOD_COPY,              /* [RFC4918], Section 9.8 */
35 	HTTP_METHOD_LABEL,             /* [RFC3253], Section 8.2 */
36 	HTTP_METHOD_LINK,              /* [RFC2068], Section 19.6.1.2 */
37 	HTTP_METHOD_LOCK,              /* [RFC4918], Section 9.10 */
38 	HTTP_METHOD_MERGE,             /* [RFC3253], Section 11.2 */
39 	HTTP_METHOD_MKACTIVITY,        /* [RFC3253], Section 13.5 */
40 	HTTP_METHOD_MKCALENDAR,        /* [RFC4791], Section 5.3.1 */
41 	HTTP_METHOD_MKCOL,             /* [RFC4918], Section 9.3 */
42 	HTTP_METHOD_MKREDIRECTREF,     /* [RFC4437], Section 6 */
43 	HTTP_METHOD_MKWORKSPACE,       /* [RFC3253], Section 6.3 */
44 	HTTP_METHOD_MOVE,              /* [RFC4918], Section 9.9 */
45 	HTTP_METHOD_ORDERPATCH,        /* [RFC3648], Section 7 */
46 	HTTP_METHOD_PATCH,             /* [RFC5789], Section 2 */
47 	HTTP_METHOD_PROPFIND,          /* [RFC4918], Section 9.1 */
48 	HTTP_METHOD_PROPPATCH,         /* [RFC4918], Section 9.2 */
49 	HTTP_METHOD_REBIND,            /* [RFC5842], Section 6 */
50 	HTTP_METHOD_REPORT,            /* [RFC3253], Section 3.6 */
51 	HTTP_METHOD_SEARCH,            /* [RFC5323], Section 2 */
52 	HTTP_METHOD_UNBIND,            /* [RFC5842], Section 5 */
53 	HTTP_METHOD_UNCHECKOUT,        /* [RFC3253], Section 4.5 */
54 	HTTP_METHOD_UNLINK,            /* [RFC2068], Section 19.6.1.3 */
55 	HTTP_METHOD_UNLOCK,            /* [RFC4918], Section 9.11 */
56 	HTTP_METHOD_UPDATE,            /* [RFC3253], Section 7.1 */
57 	HTTP_METHOD_UPDATEREDIRECTREF, /* [RFC4437], Section 7 */
58 	HTTP_METHOD_VERSION_CONTROL    /* [RFC3253], Section 3.5 */
59 } http_method_t;
60 
61 typedef enum { HTTP_VERSION_UNSET = -1, HTTP_VERSION_1_0, HTTP_VERSION_1_1, HTTP_VERSION_2 } http_version_t;
62 
63 #if 0 /*(unused)*/
64 __attribute_pure__
65 const char *get_http_status_name(int i);
66 #endif
67 
68 __attribute_pure__
69 const char *get_http_version_name(int i);
70 
71 /*(deprecated)*/
72 #define get_http_method_name(i) http_method_buf(i)->ptr
73 
74 #if 0 /*(unused)*/
75 __attribute_nonnull__()
76 __attribute_pure__
77 int get_http_version_key(const char *s, size_t slen);
78 #endif
79 
80 __attribute_pure__
81 const buffer *http_method_buf (http_method_t i);
82 
83 __attribute_nonnull__()
84 __attribute_pure__
85 http_method_t get_http_method_key(const char *s, size_t slen);
86 
87 __attribute_nonnull__()
88 void http_status_append(buffer *b, int status);
89 
90 __attribute_nonnull__()
91 void http_version_append(buffer *b, http_version_t version);
92 
93 #define http_method_get_or_head(method)         ((method) <= HTTP_METHOD_HEAD)
94 #define http_method_get_head_query(method)      ((method) <= HTTP_METHOD_QUERY)
95 #define http_method_get_head_query_post(method) ((method) <= HTTP_METHOD_POST)
96 
97 __attribute_nonnull__()
98 static inline void http_method_append (buffer * const b, const http_method_t method);
http_method_append(buffer * const b,const http_method_t method)99 static inline void http_method_append (buffer * const b, const http_method_t method) {
100     const buffer * const kv = http_method_buf(method);
101     buffer_append_string_len(b, BUF_PTR_LEN(kv));
102 }
103 
104 
105 #endif
106