blob: e968d5e251f274b72b16076696b0fc157cf67ab8 [file] [log] [blame]
rscf7012582003-11-25 01:40:27 +00001#ifndef _HTTPD_H_
2#define _HTTPD_H_ 1
3#if defined(__cplusplus)
4extern "C" {
5#endif
rsc1a0954a2005-01-04 21:18:08 +00006
7AUTOLIB(httpd)
rsc97a5e5f2003-11-23 18:25:35 +00008/*
9#pragma lib "libhttpd.a"
10#pragma src "/sys/src/libhttpd"
11*/
12
13typedef struct HConnect HConnect;
14typedef struct HContent HContent;
15typedef struct HContents HContents;
16typedef struct HETag HETag;
17typedef struct HFields HFields;
18typedef struct Hio Hio;
19typedef struct Htmlesc Htmlesc;
20typedef struct HttpHead HttpHead;
21typedef struct HttpReq HttpReq;
22typedef struct HRange HRange;
23typedef struct HSPairs HSPairs;
24
25#ifndef _HAVE_BIN
26typedef struct Bin Bin;
27#define _HAVE_BIN
28#endif
29
30enum
31{
32 HMaxWord = 32*1024,
33 HBufSize = 32*1024,
34
35 /*
36 * error messages
37 */
38 HInternal = 0,
39 HTempFail,
40 HUnimp,
41 HBadReq,
42 HBadSearch,
43 HNotFound,
44 HUnauth,
45 HSyntax,
46 HNoSearch,
47 HNoData,
48 HExpectFail,
49 HUnkVers,
50 HBadCont,
51 HOK,
52};
53
54/*
55 * table of html character escape codes
56 */
57struct Htmlesc
58{
59 char *name;
60 Rune value;
61};
62
63struct HContent
64{
65 HContent *next;
66 char *generic;
67 char *specific;
68 float q; /* desirability of this kind of file */
69 int mxb; /* max uchars until worthless */
70};
71
72struct HContents
73{
74 HContent *type;
75 HContent *encoding;
76};
77
78/*
79 * generic http header with a list of tokens,
80 * each with an optional list of parameters
81 */
82struct HFields
83{
84 char *s;
85 HSPairs *params;
86 HFields *next;
87};
88
89/*
90 * list of pairs a strings
91 * used for tag=val pairs for a search or form submission,
92 * and attribute=value pairs in headers.
93 */
94struct HSPairs
95{
96 char *s;
97 char *t;
98 HSPairs *next;
99};
100
101/*
102 * byte ranges within a file
103 */
104struct HRange
105{
106 int suffix; /* is this a suffix request? */
107 ulong start;
108 ulong stop; /* ~0UL -> not given */
109 HRange *next;
110};
111
112/*
113 * list of http/1.1 entity tags
114 */
115struct HETag
116{
117 char *etag;
118 int weak;
119 HETag *next;
120};
121
122/*
123 * HTTP custom IO
124 * supports chunked transfer encoding
125 * and initialization of the input buffer from a string.
126 */
127enum
128{
129 Hnone,
130 Hread,
131 Hend,
132 Hwrite,
133 Herr,
134
135 Hsize = HBufSize
136};
137
138struct Hio {
139 Hio *hh; /* next lower layer Hio, or nil if reads from fd */
140 int fd; /* associated file descriptor */
141 ulong seek; /* of start */
142 uchar state; /* state of the file */
143 uchar xferenc; /* chunked transfer encoding state */
144 uchar *pos; /* current position in the buffer */
145 uchar *stop; /* last character active in the buffer */
146 uchar *start; /* start of data buffer */
147 ulong bodylen; /* remaining length of message body */
148 uchar buf[Hsize+32];
149};
150
151/*
152 * request line
153 */
154struct HttpReq
155{
156 char *meth;
157 char *uri;
158 char *urihost;
159 char *search;
160 int vermaj;
161 int vermin;
162};
163
164/*
165 * header lines
166 */
167struct HttpHead
168{
169 int closeit; /* http1.1 close connection after this request? */
170 uchar persist; /* http/1.1 requests a persistent connection */
171
172 uchar expectcont; /* expect a 100-continue */
173 uchar expectother; /* expect anything else; should reject with ExpectFail */
174 ulong contlen; /* if != ~0UL, length of included message body */
175 HFields *transenc; /* if present, encoding of included message body */
176 char *client;
177 char *host;
178 HContent *okencode;
179 HContent *oklang;
180 HContent *oktype;
181 HContent *okchar;
182 ulong ifmodsince;
183 ulong ifunmodsince;
184 ulong ifrangedate;
185 HETag *ifmatch;
186 HETag *ifnomatch;
187 HETag *ifrangeetag;
188 HRange *range;
189 char *authuser; /* authorization info */
190 char *authpass;
191
192 /*
193 * experimental headers
194 */
195 int fresh_thresh;
196 int fresh_have;
197};
198
199/*
200 * all of the state for a particular connection
201 */
202struct HConnect
203{
204 void *private; /* for the library clients */
205 void (*replog)(HConnect*, char*, ...); /* called when reply sent */
206
207 HttpReq req;
208 HttpHead head;
209
210 Bin *bin;
211
212 ulong reqtime; /* time at start of request */
213 char xferbuf[HBufSize]; /* buffer for making up or transferring data */
214 uchar header[HBufSize + 2]; /* room for \n\0 */
215 uchar *hpos;
216 uchar *hstop;
217 Hio hin;
218 Hio hout;
219};
220
221/*
222 * configuration for all connections within the server
223 */
224extern char* hmydomain;
225extern char* hversion;
226extern Htmlesc htmlesc[];
227
228/*
229 * .+2,/^$/ | sort -bd +1
230 */
231void *halloc(HConnect *c, ulong size);
232Hio *hbodypush(Hio *hh, ulong len, HFields *te);
233int hbuflen(Hio *h, void *p);
234int hcheckcontent(HContent*, HContent*, char*, int);
235void hclose(Hio*);
236ulong hdate2sec(char*);
237int hdatefmt(Fmt*);
238int hfail(HConnect*, int, ...);
239int hflush(Hio*);
rsc678ede72004-12-27 00:14:43 +0000240int hlflush(Hio*);
rsc97a5e5f2003-11-23 18:25:35 +0000241int hgetc(Hio*);
242int hgethead(HConnect *c, int many);
243int hinit(Hio*, int, int);
244int hiserror(Hio *h);
245int hload(Hio*, char*);
246char *hlower(char*);
247HContent *hmkcontent(HConnect *c, char *generic, char *specific, HContent *next);
248HFields *hmkhfields(HConnect *c, char *s, HSPairs *p, HFields *next);
249char *hmkmimeboundary(HConnect *c);
250HSPairs *hmkspairs(HConnect *c, char *s, char *t, HSPairs *next);
251int hmoved(HConnect *c, char *uri);
252void hokheaders(HConnect *c);
253int hparseheaders(HConnect*, int timeout);
254HSPairs *hparsequery(HConnect *c, char *search);
255int hparsereq(HConnect *c, int timeout);
256int hprint(Hio*, char*, ...);
257int hputc(Hio*, int);
258void *hreadbuf(Hio *h, void *vsave);
259int hredirected(HConnect *c, char *how, char *uri);
260void hreqcleanup(HConnect *c);
261HFields *hrevhfields(HFields *hf);
262HSPairs *hrevspairs(HSPairs *sp);
263char *hstrdup(HConnect *c, char *s);
264int http11(HConnect*);
265int httpfmt(Fmt*);
266char *httpunesc(HConnect *c, char *s);
267int hunallowed(HConnect *, char *allowed);
268int hungetc(Hio *h);
269char *hunload(Hio*);
270int hurlfmt(Fmt*);
271char *hurlunesc(HConnect *c, char *s);
272int hwrite(Hio*, void*, int);
273int hxferenc(Hio*, int);
274
275/*
276#pragma varargck argpos hprint 2
277*/
278/*
279 * D is httpd format date conversion
280 * U is url escape convertsion
281 * H is html escape conversion
282 */
283/*
284#pragma varargck type "D" long
285#pragma varargck type "D" ulong
286#pragma varargck type "U" char*
287#pragma varargck type "H" char*
288*/
rscf7012582003-11-25 01:40:27 +0000289
290#if defined(__cplusplus)
291}
292#endif
293#endif