Fix comments.
[bertos.git] / bertos / net / http.h
1 /**
2  * \file
3  * <!--
4  * This file is part of BeRTOS.
5  *
6  * Bertos is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
19  *
20  * As a special exception, you may use this file as part of a free software
21  * library without restriction.  Specifically, if other files instantiate
22  * templates or use macros or inline functions from this file, or you compile
23  * this file and link it with other files to produce an executable, this
24  * file does not by itself cause the resulting executable to be covered by
25  * the GNU General Public License.  This exception does not however
26  * invalidate any other reasons why the executable file might be covered by
27  * the GNU General Public License.
28  *
29  * Copyright 2011 Develer S.r.l. (http://www.develer.com/)
30  *
31  * -->
32  *
33  * \brief Simple HTTP server
34  *
35  * \author Daniele Basile <asterix@develer.com>
36  *
37  * $WIZ$ module_name = "http"
38  * $WIZ$ module_configuration = "bertos/cfg/cfg_http.h"
39  * $WIZ$ module_depends = "lwip", "kfile", "sd"
40  * $WIZ$ module_hw = "bertos/hw/hw_http.h", "bertos/hw/hw_http.c"
41  */
42
43 #ifndef NET_HTTP_H
44 #define NET_HTTP_H
45
46 #include <lwip/tcpip.h>
47 #include <lwip/api.h>
48
49 typedef int (*http_handler_t)(struct netconn *client, const char *name, char *revc_buf, size_t revc_len);
50
51 typedef struct HttpCGI
52 {
53         unsigned type;          ///< Strategy to find string in the cgi table.
54         const char *name;       ///< Request string from GET request
55         http_handler_t handler; ///< Callback to process the special request
56 } HttpCGI;
57
58 enum
59 {
60         HTTP_CONTENT_JSON = 0,
61         HTTP_CONTENT_HTML,
62         HTTP_CONTENT_CSS,
63         HTTP_CONTENT_JS,
64         HTTP_CONTENT_PNG,
65         HTTP_CONTENT_JPEG,
66         HTTP_CONTENT_GIF,
67         HTTP_CONTENT_PLAIN,
68
69         HTTP_CONTENT_CNT
70 };
71
72 #define CGI_MATCH_NONE   0
73 #define CGI_MATCH_WORD   1  ///< Select item in table only if string match
74 #define CGI_MATCH_EXT    2  ///< Select item in table if the extention match
75 #define CGI_MATCH_NAME   3  ///< Select item in table if the string is content
76
77 int http_getValue(char *tolenized_buf, size_t tolenized_buf_len, const char *key, char *value, size_t len);
78 int http_tokenizeGetRequest(char *raw_buf, size_t raw_len);
79 void http_getPageName(const char *recv_buf, size_t recv_len, char *page_name, size_t len);
80 void http_decodeUrl(const char *raw_buf, size_t raw_len, char *decodec_buf, size_t len);
81 int http_searchContentType(const char *name);
82
83 void http_sendOk(struct netconn *client, int content_type);
84 void http_sendFileNotFound(struct netconn *client, int content_type);
85 void http_sendInternalErr(struct netconn *client, int content_type);
86
87 void http_poll(struct netconn *server);
88 void http_init(http_handler_t default_callback, struct HttpCGI *table);
89
90 int http_testSetup(void);
91 int http_testRun(void);
92 int http_testTearDown(void);
93
94 #endif /* NET_HTTP_H */