1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
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
|
/******************************************************************
* $Id: nanohttp-server.h,v 1.40 2007/11/04 06:57:32 m0gg Exp $
*
* CSOAP Project: A http client/server library in C
* Copyright (C) 2003 Ferhat Ayaz
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 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
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*
* Email: ferhatayaz@yahoo.com
******************************************************************/
#ifndef __nanohttp_server_h
#define __nanohttp_server_h
/* XXX: Clean up nanohttp to make this unnecessary */
#ifndef __NHTTP_INTERNAL
#include <nanohttp/nanohttp-error.h>
#include <nanohttp/nanohttp-common.h>
#include <nanohttp/nanohttp-stream.h>
#include <nanohttp/nanohttp-request.h>
#include <nanohttp/nanohttp-response.h>
#endif
/** @page nanohttp_server_page Howto write an HTTP server
*
* @section server_sec Table of contents
*
* - @ref nanohttp_server_init_sec
* - @ref nanohttp_server_service_sec
* - @ref nanohttp_server_running_sec
* - @ref nanohttp_server_cleanup_sec
* - @ref nanohttp_server_function_sec
*
* @section nanohttp_server_init_sec Server initialization
*
* @code
* int main(int argc, char **argv)
* {
* herror_t status;
* nanohttp_set_level(NANOHTTP_LOG_INFO);
*
* if (httpd_init(argc, argv))
* {
* fprintf(stderr, "Cannot init httpd\n");
* exit(1);
* }
* @endcode
*
* @section nanohttp_server_service_sec Service registration
*
* @code
* if ((status = httpd_register("/", root_service)) != H_OK)
* {
* fprintf(stderr, "Cannot register service (%s)\n", herror_message(status));
* herror_release(status);
* httpd_destroy();
* exit(1);
* }
* @endcode
*
* @code
* if ((status = httpd_register_secure("/secure", secure_service, simple_authenticator)) != H_OK)
* {
* fprintf(stderr, "Cannot register secure service (%s)\n", herror_message(status));
* herror_release(status);
* httpd_destroy();
* exit(1);
* }
* @endcode
*
* @code
* if ((status = httpd_register("/headers", headers_service)) != H_OK)
* {
* fprintf(stderr, "Cannot register headers service (%s)\n", herror_message(status));
* herror_release(status);
* httpd_destroy();
* exit(1);
* }
* @endcode
*
* @code
* if ((status = httpd_register_default("/error", default_service)) != H_OK)
* {
* fprintf(stderr, "Cannot register default service (%s)\n", herror_message(status));
* herror_release(status);
* httpd_destroy();
* exit(1);
* }
* @endcode
*
* @section nanohttp_server_running_sec Running the server
*
* @code
* if ((status = httpd_run()) != H_OK)
* {
* fprintf(stderr, "Cannot run httpd (%s)\n", herror_message(status));
* herror_release(status);
* httpd_destroy();
* exit(1);
* }
* @endcode
*
* @section nanohttp_server_cleanup_sec Server cleanup
*
* @code
* httpd_destroy();
*
* exit(0);
* }
* @endcode
*
* @section nanohttp_server_function_sec Sample service function
*
* @code
* static void headers_service(httpd_conn_t *conn, struct hrequest_t *req)
* {
* hpair_t *walker;
*
* httpd_send_header(conn, 200, HTTP_STATUS_200_REASON_PHRASE);
* http_output_stream_write_string(conn->out,
* "<html>"
* "<head>"
* "<title>Request headers</title>"
* "</head>"
* "<body>"
* "<h1>Request headers</h1>"
* "<ul>");
*
* for (walker=req->header; walker; walker=walker->next)
* {
* http_output_stream_write_string(conn->out, "<li>");
* http_output_stream_write_string(conn->out, walker->key);
* http_output_stream_write_string(conn->out, " = ");
* http_output_stream_write_string(conn->out, walker->value);
* http_output_stream_write_string(conn->out, "</li>");
* }
*
* http_output_stream_write_string(conn->out,
* "</ul>"
* "</body>"
* "</html>");
*
* return;
* }
* @endcode
*
*/
/** @file nanohttp-server.h HTTP server interface
*
* @defgroup NANOHTTP nanoHTTP
*/
/**@{*/
/** @defgroup NAONHTTP_CMDLINE_FLAGS Command line flags
*/
/**@{*/
/** @defgroup NANOHTTP_SERVER_CMDLINE_FLAGS Server command line flags
*/
/**@{*/
#define NHTTPD_ARG_PORT "-NHTTPport" /**< Port the server is
listening on */
#define NHTTPD_ARG_TERMSIG "-NHTTPtsig" /**< Signal which may used
to terminate the server */
#define NHTTPD_ARG_MAXCONN "-NHTTPmaxconn" /**< Maximum number of
simultanous connections */
#define NHTTPD_ARG_TIMEOUT "-NHTTPtimeout" /**< Timeout on reads */
/**@}*/
/**@}*/
/** @defgroup NANOHTTP_CLIENT Client */
/** @defgroup NANOHTTP_SERVER Server */
/**@{*/
typedef struct httpd_conn
{
struct hsocket_t *sock;
char content_type[25];
struct http_output_stream_t *out;
hpair_t *header;
}
httpd_conn_t;
/** Service callback function for a nanoHTTP service. */
typedef void (*httpd_service) (httpd_conn_t *conn, struct hrequest_t *req);
/** Authentication callback function for a nanoHTTP service. */
typedef int (*httpd_auth) (struct hrequest_t *req, const char *user, const char *pass);
#ifdef __NHTTP_INTERNAL
/** Service statistics per nanoHTTP service. */
struct service_statistics
{
unsigned long requests;
unsigned long bytes_transmitted;
unsigned long bytes_received;
struct timeval time;
pthread_rwlock_t lock;
};
#endif
/** @defgroup NANOHTTP_SERVICE_STATUS Service status
*/
/**@{*/
/**
* @see hservice_t
* @see http://www.w3.org/TR/wslc/
*/
#define NHTTPD_SERVICE_DOWN 0
/**
* @see hservice_t
* @see http://www.w3.org/TR/wslc/
*/
#define NHTTPD_SERVICE_UP 1
/**@}*/
/** Service representation object
*/
typedef struct tag_hservice
{
char *context; /**< Path where service is connected */
int status; /**< Current status of this service */
httpd_service func; /**< Service function */
httpd_auth auth; /**< Authentication function */
struct tag_hservice *next; /**< Next service in service list */
struct service_statistics *statistics; /**< Service statistics */
}
hservice_t;
#ifdef __cplusplus
extern "C"
{
#endif
/** This function initializes the nanoHTTP server.
*
* @see httpd_destroy()
*/
extern herror_t httpd_init(int argc, char *argv[]);
/** This function destroys the nanoHTTP server.
*
* @see httpd_init()
*/
extern void httpd_destroy(void);
/** This function executes the nanoHTTP server in an endless loop.
*
* @return H_OK on success.
*/
extern herror_t httpd_run(void);
/** This function registers a service routine.
*
* @return H_OK on success.
*/
extern herror_t httpd_register(const char *context, httpd_service service);
/** This function registers a service routing which is secured by
* a password (HTTP basic authentication).
*
* @return H_OK on success.
*/
extern herror_t httpd_register_secure(const char *context, httpd_service service, httpd_auth auth);
/** This function registers a service routing which is executed if
* no matching service is found.
*
* @return H_OK on success.
*/
extern herror_t httpd_register_default(const char *context, httpd_service service);
/** This function registers a serivce routing which is executed if
* no matching service is found, it is protected by a password.
*
* @return H_OK on success.
*/
extern herror_t httpd_register_default_secure(const char *context, httpd_service service, httpd_auth auth);
/** This function returns the port the service is listening on.
*
* @return The port the service is listening on.
*/
extern short httpd_get_port(void);
/** This function returns the timeout which is used for read's.
*
* @return The read timeout used.
*/
extern int httpd_get_timeout(void);
/** This function sets the timeout which is used for read.
*/
extern void httpd_set_timeout(int secs);
/** This function returns a string representation of the underlying
* protocol used.
*
* @return "http" or "https"
*/
extern const char *httpd_get_protocol(void);
/** This function returns the actual connection count.
*/
extern int httpd_get_conncount(void);
extern hservice_t *httpd_get_services(void);
extern hservice_t *httpd_find_service(const char *name);
extern int httpd_enable_service(hservice_t *service);
extern int httpd_disable_service(hservice_t *service);
extern void httpd_response_set_content_type(httpd_conn_t * res, const char *content_type);
extern herror_t httpd_send_header(httpd_conn_t * res, int code, const char *text);
extern int httpd_set_header(httpd_conn_t * conn, const char *key, const char *value);
extern void httpd_set_headers(httpd_conn_t * conn, hpair_t * header);
extern int httpd_add_header(httpd_conn_t * conn, const char *key, const char *value);
extern void httpd_add_headers(httpd_conn_t * conn, const hpair_t * values);
/**
*
* @todo move to nanohttp-mime.c merge with httpc_mime_* functions
*
* MIME multipart/related POST
* @returns H_OK on success or error flag
*
*/
extern herror_t httpd_mime_send_header(httpd_conn_t * conn, const char *related_start, const char *related_start_info, const char *related_type, int code, const char *text);
/**
*
* Send boundary and part header and continue with next part
*
*/
extern herror_t httpd_mime_next(httpd_conn_t * conn, const char *content_id, const char *content_type, const char *transfer_encoding);
/**
*
* Send boundary and part header and continue with next part
*
*/
extern herror_t httpd_mime_send_file(httpd_conn_t * conn, const char *content_id, const char *content_type, const char *transfer_encoding, const char *filename);
/** This function finishes a MIME request.
*
* @return H_OK on success.
*/
extern herror_t httpd_mime_end(httpd_conn_t * conn);
/** This function sends a minimalistic HTML error document with HTTP
* status 400.
*
* @see HTTP_STATUS_400_REASON_PHRASE
*
* @return H_OK on success.
*/
extern herror_t httpd_send_bad_request(httpd_conn_t *conn, const char *msg);
/** This function sends a minimalistc HTML error document with HTTP
* status 401.
*
* @see HTTP_STATUS_401_REASON_PHRASE
*
* @return H_OK on success.
*/
extern herror_t httpd_send_unauthorized(httpd_conn_t *conn, const char *realm);
/** This function sends a minimalistic HTML error document with HTTP
* status 404.
*
* @see HTTP_STATUS_404_REASON_PHRASE
*
* @return H_OK on success.
*/
extern herror_t httpd_send_not_found(httpd_conn_t *conn, const char *msg);
/** This function sends a minimalistic HTML error document with HTTP
* status 500.
*
* @see HTTP_STATUS_500_REASON_PHRASE
*
* @return H_OK on success.
*/
extern herror_t httpd_send_internal_error(httpd_conn_t * conn, const char *msg);
/** This functions sends a minimalistic HTML error document with HTTP
* status 501.
*
* @see HTTP_STATUS_501_REASON_PHRASE
*
* @return H_OK on success.
*/
extern herror_t httpd_send_not_implemented(httpd_conn_t *conn, const char *msg);
#ifdef __cplusplus
}
#endif
/**@}*/
/**@}*/
#endif
|
