4 * This file is part of BeRTOS.
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.
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.
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
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.
29 * Copyright 2011 Develer S.r.l. (http://www.develer.com/)
33 * \author Daniele Basile <asterix@develer.com>
35 * \brief Simple Http server.
37 * This simple web server read the site's pages from SD card, and manage
38 * the cases where SD is not present or page not found, using embedded pages.
39 * Quering from browser the /status page, the server return a json dictionary where are store
40 * some board status info, like board temperature, up-time, etc.
48 #include "hw/hw_http.h"
50 #include "cfg/cfg_http.h"
52 // Define logging setting (for cfg/log.h module).
53 #define LOG_LEVEL HTTP_LOG_LEVEL
54 #define LOG_VERBOSITY HTTP_LOG_FORMAT
61 static struct { const char *key; const char *content; } http_content_type[] =
63 {"", "Content-type: application/json\r\n\r\n"},
64 {"htm", "Content-type: text/html\r\n\r\n"},
65 {"css", "Content-type: text/css\r\n\r\n"},
66 {"js", "Content-type: text/javascript\r\n\r\n"},
67 {"png", "Content-type: image/png\r\n\r\n"},
68 {"jpg", "Content-type: image/jpeg\r\n\r\n"},
69 {"gif", "Content-type: image/gif\r\n\r\n"},
70 {"txt", "Content-type: text/plain\r\n\r\n"},
73 static const char http_html_hdr_200[] = "HTTP/1.0 200 OK\r\n";
74 static const char http_html_hdr_404[] = "HTTP/1.0 404 Not Found\r\n";
75 static const char http_html_hdr_500[] = "HTTP/1.0 500 Internal Server Error\r\n";
77 static HttpCGI *cgi_table;
78 static http_handler_t http_callback;
79 static char decoded_str[80];
82 * Get key value from tokenized buffer
84 int http_getValue(char *tolenized_buf, size_t tolenized_buf_len, const char *key, char *value, size_t len)
86 if (!tolenized_buf || !key || !value)
89 char *p = tolenized_buf;
92 memset(value, 0, len);
94 for (size_t i = 0; i < tolenized_buf_len; i++)
96 size_t token_len = strlen(p);
97 http_decodeUrl(p, token_len, decoded_str, sizeof(decoded_str));
99 if (!strcmp(key, decoded_str))
104 http_decodeUrl(p, strlen(p), decoded_str, sizeof(decoded_str));
105 value_len = strlen(decoded_str);
107 if (value_len >= len)
110 strcpy(value, decoded_str);
113 /* jump to next pair */
123 int http_tokenizeGetRequest(char *raw_buf, size_t raw_len)
127 for(size_t i = 0; (i < raw_len) && raw_buf; i++)
129 if (raw_buf[i] == '&')
135 if (raw_buf[i] == '=')
142 static char http_hexToAscii(char first, char second)
150 return strtol(hex, &stop, 16);
153 void http_decodeUrl(const char *raw_buf, size_t raw_len, char *decodec_buf, size_t len)
158 memset(decodec_buf, 0, len);
160 for (size_t i = 0; i < raw_len; i++)
165 if (raw_buf[i] == '%')
169 /* convert hex value after % */
170 value = http_hexToAscii(raw_buf[i + 1], raw_buf[i + 2]);
173 *decodec_buf++ = value;
175 /* decoded two digit of hex value, go to next value*/
182 /* Manage special case of '+', that it should be convert in space */
183 *decodec_buf++ = (raw_buf[i] == '+' ? ' ' : raw_buf[i]);
188 void http_getPageName(const char *recv_buf, size_t recv_len, char *page_name, size_t len)
192 const char *p = recv_buf;
193 if (p && (recv_len > sizeof("GET /")))
195 if (*p++ == 'G' && *p++ == 'E' && *p++ == 'T')
198 /* skip the space and "/" */
205 while ((size_t)i < recv_len)
208 if (ch == ' ' || ch == '\t' || ch == '\n')
210 if((size_t)i == len - 1)
219 INLINE const char *get_ext(const char *name)
221 const char *ext = strstr(name, ".");
228 int http_searchContentType(const char *name)
233 const char *ext = get_ext(name);
234 LOG_INFO("Ext: %s\n", !ext ? "none" : ext);
239 if (!strcmp(ext, "ico"))
240 return HTTP_CONTENT_JPEG;
242 for (int i = 0; i < HTTP_CONTENT_CNT; i++)
244 if (!strcmp(ext, http_content_type[i].key))
253 * Send on \param client socket the 200 Ok http header with
254 * select \param content_type
256 void http_sendOk(struct netconn *client, int content_type)
258 ASSERT(content_type < HTTP_CONTENT_CNT);
260 netconn_write(client, http_html_hdr_200, sizeof(http_html_hdr_200) - 1, NETCONN_COPY);
261 netconn_write(client, http_content_type[content_type].content,
262 strlen(http_content_type[content_type].content), NETCONN_COPY);
267 * Send on \param client socket the 404 File not found http header with
268 * select \param content_type
270 void http_sendFileNotFound(struct netconn *client, int content_type)
272 ASSERT(content_type < HTTP_CONTENT_CNT);
274 netconn_write(client, http_html_hdr_404, sizeof(http_html_hdr_404) - 1, NETCONN_COPY);
275 netconn_write(client, http_content_type[content_type].content,
276 strlen(http_content_type[content_type].content), NETCONN_COPY);
280 * Send on \param client socket the 500 internal server error http header with
281 * select \param content_type
283 void http_sendInternalErr(struct netconn *client, int content_type)
285 ASSERT(content_type < HTTP_CONTENT_CNT);
287 netconn_write(client, http_html_hdr_500, sizeof(http_html_hdr_500) - 1, NETCONN_COPY);
288 netconn_write(client, http_content_type[content_type].content,
289 strlen(http_content_type[content_type].content), NETCONN_COPY);
292 static http_handler_t cgi_search(const char *name, HttpCGI *table)
298 const char *ext = get_ext(name);
302 if (ext && table[i].type == CGI_MATCH_EXT)
305 if (!strcmp(table[i].name, ext))
307 LOG_INFO("Match ext: %s\n", ext);
311 else if (table[i].type == CGI_MATCH_NAME)
314 if (strstr(name, table[i].name) != NULL)
316 LOG_INFO("Match string: %s\n", name);
320 else /* (table[i].type == CGI_MATCH_WORD) */
323 if (!strcmp(table[i].name, name))
325 LOG_INFO("Word match: %s\n", name);
333 return table[i].handler;
336 static char req_string[80];
339 * Http polling function.
341 * Call this functions to process each client connections.
344 void http_poll(struct netconn *server)
346 struct netconn *client;
347 struct netbuf *rx_buf_conn;
351 client = netconn_accept(server);
355 rx_buf_conn = netconn_recv(client);
358 netbuf_data(rx_buf_conn, (void **)&rx_buf, &len);
361 memset(req_string, 0, sizeof(req_string));
362 http_getPageName(rx_buf, len, req_string, sizeof(req_string));
364 if (req_string[0] == '\0')
365 strcpy(req_string, HTTP_DEFAULT_PAGE);
367 http_handler_t cgi = cgi_search(req_string, cgi_table);
370 if (cgi(client, req_string, rx_buf, len) < 0)
372 LOG_ERR("Internal server error\n");
373 http_sendInternalErr(client, HTTP_CONTENT_HTML);
374 netconn_write(client, http_server_error, http_server_error_len - 1, NETCONN_NOCOPY);
379 http_callback(client, req_string, rx_buf, len);
382 netconn_close(client);
383 netbuf_delete(rx_buf_conn);
385 netconn_delete(client);
389 * Init the http server.
391 * The simply http server call for each client request the default_callback function. The
392 * user should define this callback to manage the client request, i.e. reading site's page
393 * from SD card. The user can define the cgi_table, where associate one callback to the user string.
394 * In this way the user could filter some client request and redirect they to custom callback, i.e.
395 * the client could request status of the device only loading the particular page name.
397 * \param default_callback fuction that server call for all request, that does'nt match cgi table.
398 * \param table of callcack to call when client request a particular page.
400 void http_init(http_handler_t default_callback, struct HttpCGI *table)
402 ASSERT(default_callback);
405 http_callback = default_callback;