You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1529 lines
48 KiB
1529 lines
48 KiB
/* |
|
* Copyright (c) 2001-2003 Swedish Institute of Computer Science. |
|
* All rights reserved. |
|
* |
|
* Redistribution and use in source and binary forms, with or without modification, |
|
* are permitted provided that the following conditions are met: |
|
* |
|
* 1. Redistributions of source code must retain the above copyright notice, |
|
* this list of conditions and the following disclaimer. |
|
* 2. Redistributions in binary form must reproduce the above copyright notice, |
|
* this list of conditions and the following disclaimer in the documentation |
|
* and/or other materials provided with the distribution. |
|
* 3. The name of the author may not be used to endorse or promote products |
|
* derived from this software without specific prior written permission. |
|
* |
|
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED |
|
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF |
|
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT |
|
* SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, |
|
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT |
|
* OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
|
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
|
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING |
|
* IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY |
|
* OF SUCH DAMAGE. |
|
* |
|
* This file is part of the lwIP TCP/IP stack. |
|
* |
|
* Author: Adam Dunkels <adam@sics.se> |
|
* |
|
*/ |
|
|
|
/* This httpd supports for a |
|
* rudimentary server-side-include facility which will replace tags of the form |
|
* <!--#tag--> in any file whose extension is .shtml, .shtm or .ssi with |
|
* strings provided by an include handler whose pointer is provided to the |
|
* module via function http_set_ssi_handler(). |
|
* Additionally, a simple common |
|
* gateway interface (CGI) handling mechanism has been added to allow clients |
|
* to hook functions to particular request URIs. |
|
* |
|
* To enable SSI support, define label LWIP_HTTPD_SSI in lwipopts.h. |
|
* To enable CGI support, define label LWIP_HTTPD_CGI in lwipopts.h. |
|
* |
|
* By default, the server assumes that HTTP headers are already present in |
|
* each file stored in the file system. By defining LWIP_HTTPD_DYNAMIC_HEADERS in |
|
* lwipopts.h, this behavior can be changed such that the server inserts the |
|
* headers automatically based on the extension of the file being served. If |
|
* this mode is used, be careful to ensure that the file system image used |
|
* does not already contain the header information. |
|
* |
|
* File system images without headers can be created using the makefsfile |
|
* tool with the -h command line option. |
|
* |
|
* |
|
* Notes about valid SSI tags |
|
* -------------------------- |
|
* |
|
* The following assumptions are made about tags used in SSI markers: |
|
* |
|
* 1. No tag may contain '-' or whitespace characters within the tag name. |
|
* 2. Whitespace is allowed between the tag leadin "<!--#" and the start of |
|
* the tag name and between the tag name and the leadout string "-->". |
|
* 3. The maximum tag name length is LWIP_HTTPD_MAX_TAG_NAME_LEN, currently 8 characters. |
|
* |
|
* Notes on CGI usage |
|
* ------------------ |
|
* |
|
* The simple CGI support offered here works with GET method requests only |
|
* and can handle up to 16 parameters encoded into the URI. The handler |
|
* function may not write directly to the HTTP output but must return a |
|
* filename that the HTTP server will send to the browser as a response to |
|
* the incoming CGI request. |
|
* |
|
* @todo: |
|
* - don't use mem_malloc() |
|
* - use pbuf_strstr() where applicable |
|
* - support the request coming in in chained pbufs or multiple packets |
|
* - support POST! - to receive larger amounts of data (e.g. firmware update) |
|
* - replace sprintf() by using other calls |
|
* - split too long functions into multiple smaller functions |
|
* - implement 501 - not implemented page |
|
* - support more file types? |
|
* - review the code in terms of "lw"... -> for pure static pages, it should be as tiny as before... |
|
*/ |
|
#include "lwip/debug.h" |
|
#include "lwip/stats.h" |
|
#include "httpd.h" |
|
#include "httpd_structs.h" |
|
#include "lwip/tcp.h" |
|
#include "fs.h" |
|
|
|
#include <string.h> |
|
|
|
#ifndef HTTPD_DEBUG |
|
#define HTTPD_DEBUG LWIP_DBG_OFF |
|
#endif |
|
|
|
/** Set this to 1 and add the next line to lwippools.h to use a memp pool |
|
* for allocating struct http_state instead of the heap: |
|
* |
|
* LWIP_MEMPOOL(HTTPD_STATE, 20, 100, "HTTPD_STATE") |
|
*/ |
|
#ifndef HTTPD_USE_MEM_POOL |
|
#define HTTPD_USE_MEM_POOL 0 |
|
#endif |
|
|
|
/** The server port for HTTPD to use */ |
|
#ifndef HTTPD_SERVER_PORT |
|
#define HTTPD_SERVER_PORT 80 |
|
#endif |
|
|
|
/** Maximum retries before the connection is aborted/closed. |
|
* - number of times pcb->poll is called -> default is 4*500ms = 2s; |
|
* - reset when pcb->sent is called |
|
*/ |
|
#ifndef HTTPD_MAX_RETRIES |
|
#define HTTPD_MAX_RETRIES 4 |
|
#endif |
|
|
|
/** The poll delay is X*500ms */ |
|
#ifndef HTTPD_POLL_INTERVAL |
|
#define HTTPD_POLL_INTERVAL 4 |
|
#endif |
|
|
|
/** Priority for tcp pcbs created by HTTPD (very low by default). |
|
* Lower priorities get killed first when running out of memroy. |
|
*/ |
|
#ifndef HTTPD_TCP_PRIO |
|
#define HTTPD_TCP_PRIO TCP_PRIO_MIN |
|
#endif |
|
|
|
/** Set this to 1 to enabled timing each file sent */ |
|
#ifndef LWIP_HTTPD_TIMING |
|
#define LWIP_HTTPD_TIMING 0 |
|
#endif |
|
#ifndef HTTPD_DEBUG_TIMING |
|
#define HTTPD_DEBUG_TIMING LWIP_DBG_OFF |
|
#endif |
|
|
|
#ifndef true |
|
#define true ((u8_t)1) |
|
#endif |
|
|
|
#ifndef false |
|
#define false ((u8_t)0) |
|
#endif |
|
|
|
/** This checks whether tcp_write has to copy data or not */ |
|
#ifndef HTTP_IS_DATA_VOLATILE |
|
/** This was TI's check whether to let TCP copy data or not |
|
#define HTTP_IS_DATA_VOLATILE(hs) ((hs->file < (char *)0x20000000) ? 0 : TCP_WRITE_FLAG_COPY)*/ |
|
#if LWIP_HTTPD_SSI |
|
#define HTTP_IS_DATA_VOLATILE(hs) TCP_WRITE_FLAG_COPY |
|
#else /* LWIP_HTTPD_SSI */ |
|
/** Default: don't copy if the data is sent from file-system directly */ |
|
#define HTTP_IS_DATA_VOLATILE(hs) (((hs->file != NULL) && (hs->handle != NULL) && (hs->file == \ |
|
(char*)hs->handle->data + hs->handle->len - hs->left)) \ |
|
? 0 : TCP_WRITE_FLAG_COPY) |
|
#endif /* LWIP_HTTPD_SSI */ |
|
#endif |
|
|
|
typedef struct |
|
{ |
|
const char *name; |
|
u8_t shtml; |
|
} default_filename; |
|
|
|
const default_filename g_psDefaultFilenames[] = { |
|
{"/index.shtml", true }, |
|
{"/index.ssi", true }, |
|
{"/index.shtm", true }, |
|
{"/index.html", false }, |
|
{"/index.htm", false } |
|
}; |
|
|
|
#define NUM_DEFAULT_FILENAMES (sizeof(g_psDefaultFilenames) / \ |
|
sizeof(default_filename)) |
|
|
|
#if LWIP_HTTPD_DYNAMIC_HEADERS |
|
/* The number of individual strings that comprise the headers sent before each |
|
* requested file. |
|
*/ |
|
#define NUM_FILE_HDR_STRINGS 3 |
|
#endif /* LWIP_HTTPD_DYNAMIC_HEADERS */ |
|
|
|
#if LWIP_HTTPD_SSI |
|
|
|
const char *g_pcSSIExtensions[] = { |
|
".shtml", ".shtm", ".ssi", ".xml" |
|
}; |
|
|
|
#define NUM_SHTML_EXTENSIONS (sizeof(g_pcSSIExtensions) / sizeof(const char *)) |
|
|
|
enum tag_check_state { |
|
TAG_NONE, /* Not processing an SSI tag */ |
|
TAG_LEADIN, /* Tag lead in "<!--#" being processed */ |
|
TAG_FOUND, /* Tag name being read, looking for lead-out start */ |
|
TAG_LEADOUT, /* Tag lead out "-->" being processed */ |
|
TAG_SENDING /* Sending tag replacement string */ |
|
}; |
|
#endif /* LWIP_HTTPD_SSI */ |
|
|
|
struct http_state { |
|
struct fs_file *handle; |
|
char *file; /* Pointer to first unsent byte in buf. */ |
|
#if LWIP_HTTPD_SSI || LWIP_HTTPD_DYNAMIC_HEADERS |
|
char *buf; /* File read buffer. */ |
|
int buf_len; /* Size of file read buffer, buf. */ |
|
#endif /* LWIP_HTTPD_SSI || LWIP_HTTPD_DYNAMIC_HEADERS */ |
|
u32_t left; /* Number of unsent bytes in buf. */ |
|
u8_t retries; |
|
#if LWIP_HTTPD_SSI |
|
const char *parsed; /* Pointer to the first unparsed byte in buf. */ |
|
const char *tag_end; /* Pointer to char after the closing '>' of the tag. */ |
|
u32_t parse_left; /* Number of unparsed bytes in buf. */ |
|
u8_t tag_check; /* true if we are processing a .shtml file else false */ |
|
u16_t tag_index; /* Counter used by tag parsing state machine */ |
|
u16_t tag_insert_len; /* Length of insert in string tag_insert */ |
|
u8_t tag_name_len; /* Length of the tag name in string tag_name */ |
|
char tag_name[LWIP_HTTPD_MAX_TAG_NAME_LEN + 1]; /* Last tag name extracted */ |
|
char tag_insert[LWIP_HTTPD_MAX_TAG_INSERT_LEN + 1]; /* Insert string for tag_name */ |
|
enum tag_check_state tag_state; /* State of the tag processor */ |
|
#endif /* LWIP_HTTPD_SSI */ |
|
#if LWIP_HTTPD_CGI |
|
char *params[LWIP_HTTPD_MAX_CGI_PARAMETERS]; /* Params extracted from the request URI */ |
|
char *param_vals[LWIP_HTTPD_MAX_CGI_PARAMETERS]; /* Values for each extracted param */ |
|
#endif /* LWIP_HTTPD_CGI */ |
|
#if LWIP_HTTPD_DYNAMIC_HEADERS |
|
const char *hdrs[NUM_FILE_HDR_STRINGS]; /* HTTP headers to be sent. */ |
|
u16_t hdr_pos; /* The position of the first unsent header byte in the |
|
current string */ |
|
u16_t hdr_index; /* The index of the hdr string currently being sent. */ |
|
#endif /* LWIP_HTTPD_DYNAMIC_HEADERS */ |
|
#if LWIP_HTTPD_TIMING |
|
u32_t time_started; |
|
#endif /* LWIP_HTTPD_TIMING */ |
|
}; |
|
|
|
#if LWIP_HTTPD_SSI |
|
/* SSI insert handler function pointer. */ |
|
tSSIHandler g_pfnSSIHandler = NULL; |
|
int g_iNumTags = 0; |
|
const char **g_ppcTags = NULL; |
|
|
|
#define LEN_TAG_LEAD_IN 5 |
|
const char * const g_pcTagLeadIn = "<!--#"; |
|
|
|
#define LEN_TAG_LEAD_OUT 3 |
|
const char * const g_pcTagLeadOut = "-->"; |
|
#endif /* LWIP_HTTPD_SSI */ |
|
|
|
#if LWIP_HTTPD_CGI |
|
/* CGI handler information */ |
|
const tCGI *g_pCGIs = NULL; |
|
int g_iNumCGIs = 0; |
|
#endif /* LWIP_HTTPD_CGI */ |
|
|
|
/** Allocate a struct http_state. */ |
|
static struct http_state* |
|
http_state_alloc() |
|
{ |
|
struct http_state *ret; |
|
#if HTTPD_USE_MEM_POOL |
|
ret = (struct http_state *)memp_malloc(MEMP_HTTPD_STATE); |
|
#else /* HTTPD_USE_MEM_POOL */ |
|
ret = (struct http_state *)mem_malloc(sizeof(struct http_state)); |
|
#endif /* HTTPD_USE_MEM_POOL */ |
|
if (ret != NULL) { |
|
/* Initialize the structure. */ |
|
memset(ret, 0, sizeof(struct http_state)); |
|
#if LWIP_HTTPD_DYNAMIC_HEADERS |
|
/* Indicate that the headers are not yet valid */ |
|
ret->hdr_index = NUM_FILE_HDR_STRINGS; |
|
#endif /* LWIP_HTTPD_DYNAMIC_HEADERS */ |
|
} |
|
return ret; |
|
} |
|
|
|
/** Free a struct http_state. |
|
* Also frees the file data if dynamic. |
|
*/ |
|
static void |
|
http_state_free(struct http_state *hs) |
|
{ |
|
if (hs != NULL) { |
|
if(hs->handle) { |
|
#if LWIP_HTTPD_TIMING |
|
u32_t ms_needed = sys_now() - hs->time_started; |
|
u32_t needed = LWIP_MAX(1, (ms_needed/100)); |
|
LWIP_DEBUGF(HTTPD_DEBUG_TIMING, ("httpd: needed %"U32_F" ms to send file of %d bytes -> %"U32_F" bytes/sec\n", |
|
ms_needed, hs->handle->len, ((((u32_t)hs->handle->len) * 10) / needed))); |
|
#endif /* LWIP_HTTPD_TIMING */ |
|
fs_close(hs->handle); |
|
hs->handle = NULL; |
|
} |
|
#if LWIP_HTTPD_SSI || LWIP_HTTPD_DYNAMIC_HEADERS |
|
if (hs->buf != NULL) { |
|
mem_free(hs->buf); |
|
hs->buf = NULL; |
|
} |
|
#endif /* LWIP_HTTPD_SSI || LWIP_HTTPD_DYNAMIC_HEADERS */ |
|
#if HTTPD_USE_MEM_POOL |
|
memp_free(MEMP_HTTPD_STATE, hs); |
|
#else /* HTTPD_USE_MEM_POOL */ |
|
mem_free(hs); |
|
#endif /* HTTPD_USE_MEM_POOL */ |
|
} |
|
} |
|
|
|
/** |
|
* The connection shall be actively closed. |
|
* Reset the sent- and recv-callbacks. |
|
* |
|
* @param pcb the tcp pcb to reset callbacks |
|
* @param hs connection state to free |
|
*/ |
|
static void |
|
http_close_conn(struct tcp_pcb *pcb, struct http_state *hs) |
|
{ |
|
err_t err; |
|
LWIP_DEBUGF(HTTPD_DEBUG, ("Closing connection %p\n", (void*)pcb)); |
|
|
|
tcp_arg(pcb, NULL); |
|
tcp_sent(pcb, NULL); |
|
tcp_recv(pcb, NULL); |
|
http_state_free(hs); |
|
err = tcp_close(pcb); |
|
if (err != ERR_OK) { |
|
LWIP_DEBUGF(HTTPD_DEBUG, ("Error %d closing %p\n", err, (void*)pcb)); |
|
} |
|
} |
|
#if LWIP_HTTPD_CGI |
|
/** |
|
* Extract URI parameters from the parameter-part of an URI in the form |
|
* "test.cgi?x=y" @todo: better explanation! |
|
* Pointers to the parameters are stored in hs->param_vals. |
|
* |
|
* @param hs http connection state |
|
* @param params pointer to the NULL-terminated parameter string from the URI |
|
* @return number of parameters extracted |
|
*/ |
|
static int |
|
extract_uri_parameters(struct http_state *hs, char *params) |
|
{ |
|
char *pair; |
|
char *equals; |
|
int loop; |
|
|
|
/* If we have no parameters at all, return immediately. */ |
|
if(!params || (params[0] == '\0')) { |
|
return(0); |
|
} |
|
|
|
/* Get a pointer to our first parameter */ |
|
pair = params; |
|
|
|
/* |
|
* Parse up to LWIP_HTTPD_MAX_CGI_PARAMETERS from the passed string and ignore the |
|
* remainder (if any) |
|
*/ |
|
for(loop = 0; (loop < LWIP_HTTPD_MAX_CGI_PARAMETERS) && pair; loop++) { |
|
|
|
/* Save the name of the parameter */ |
|
hs->params[loop] = pair; |
|
|
|
/* Remember the start of this name=value pair */ |
|
equals = pair; |
|
|
|
/* Find the start of the next name=value pair and replace the delimiter |
|
* with a 0 to terminate the previous pair string. |
|
*/ |
|
pair = strchr(pair, '&'); |
|
if(pair) { |
|
*pair = '\0'; |
|
pair++; |
|
} else { |
|
/* We didn't find a new parameter so find the end of the URI and |
|
* replace the space with a '\0' |
|
*/ |
|
pair = strchr(equals, ' '); |
|
if(pair) { |
|
*pair = '\0'; |
|
} |
|
|
|
/* Revert to NULL so that we exit the loop as expected. */ |
|
pair = NULL; |
|
} |
|
|
|
/* Now find the '=' in the previous pair, replace it with '\0' and save |
|
* the parameter value string. |
|
*/ |
|
equals = strchr(equals, '='); |
|
if(equals) { |
|
*equals = '\0'; |
|
hs->param_vals[loop] = equals + 1; |
|
} else { |
|
hs->param_vals[loop] = NULL; |
|
} |
|
} |
|
|
|
return loop; |
|
} |
|
#endif /* LWIP_HTTPD_CGI */ |
|
|
|
#if LWIP_HTTPD_SSI |
|
/** |
|
* Insert a tag (found in an shtml in the form of "<!--#tagname-->" into the file. |
|
* The tag's name is stored in hs->tag_name (NULL-terminated), the replacement |
|
* should be written to hs->tag_insert (up to a length of LWIP_HTTPD_MAX_TAG_INSERT_LEN). |
|
* The amount of data written is stored to hs->tag_insert_len. |
|
* |
|
* @todo: return tag_insert_len - maybe it can be removed from struct http_state? |
|
* |
|
* @param hs http connection state |
|
*/ |
|
static void |
|
get_tag_insert(struct http_state *hs) |
|
{ |
|
int loop; |
|
size_t len; |
|
|
|
if(g_pfnSSIHandler && g_ppcTags && g_iNumTags) { |
|
|
|
/* Find this tag in the list we have been provided. */ |
|
for(loop = 0; loop < g_iNumTags; loop++) { |
|
if(strcmp(hs->tag_name, g_ppcTags[loop]) == 0) { |
|
hs->tag_insert_len = g_pfnSSIHandler(loop, hs->tag_insert, |
|
LWIP_HTTPD_MAX_TAG_INSERT_LEN); |
|
return; |
|
} |
|
} |
|
} |
|
|
|
/* If we drop out, we were asked to serve a page which contains tags that |
|
* we don't have a handler for. Merely echo back the tags with an error |
|
* marker. |
|
* |
|
* @todo: replace with multiple calls to strcat() or memcpy() |
|
*/ |
|
/*u*/snprintf(hs->tag_insert, (LWIP_HTTPD_MAX_TAG_INSERT_LEN + 1), |
|
"<b>***UNKNOWN TAG %s***</b>", hs->tag_name); |
|
len = strlen(hs->tag_insert); |
|
LWIP_ASSERT("len <= 0xffff", len <= 0xffff); |
|
hs->tag_insert_len = (u16_t)len; |
|
} |
|
#endif /* LWIP_HTTPD_SSI */ |
|
|
|
#if LWIP_HTTPD_DYNAMIC_HEADERS |
|
/** |
|
* Generate the relevant HTTP headers for the given filename and write |
|
* them into the supplied buffer. Returns true on success or false on failure. |
|
* @todo: this returns void, not true or false! |
|
*/ |
|
static void |
|
get_http_headers(struct http_state *pState, char *pszURI) |
|
{ |
|
int iLoop; |
|
char *pszWork; |
|
char *pszExt; |
|
char *pszVars; |
|
|
|
/* Ensure that we initialize the loop counter. */ |
|
iLoop = 0; |
|
|
|
/* In all cases, the second header we send is the server identification |
|
so set it here. */ |
|
pState->hdrs[1] = g_psHTTPHeaderStrings[HTTP_HDR_SERVER]; |
|
|
|
/* Is this a normal file or the special case we use to send back the |
|
default "404: Page not found" response? */ |
|
if(pszURI == NULL) { |
|
pState->hdrs[0] = g_psHTTPHeaderStrings[HTTP_HDR_NOT_FOUND]; |
|
pState->hdrs[2] = g_psHTTPHeaderStrings[DEFAULT_404_HTML]; |
|
|
|
/* Set up to send the first header string. */ |
|
pState->hdr_index = 0; |
|
pState->hdr_pos = 0; |
|
return; |
|
} else { |
|
/* We are dealing with a particular filename. Look for one other |
|
special case. We assume that any filename with "404" in it must be |
|
indicative of a 404 server error whereas all other files require |
|
the 200 OK header. */ |
|
if(strstr(pszURI, "404")) { |
|
pState->hdrs[0] = g_psHTTPHeaderStrings[HTTP_HDR_NOT_FOUND]; |
|
} else { |
|
pState->hdrs[0] = g_psHTTPHeaderStrings[HTTP_HDR_OK]; |
|
} |
|
|
|
/* Determine if the URI has any variables and, if so, temporarily remove |
|
them. */ |
|
pszVars = strchr(pszURI, '?'); |
|
if(pszVars) { |
|
*pszVars = '\0'; |
|
} |
|
|
|
/* Get a pointer to the file extension. We find this by looking for the |
|
last occurrence of "." in the filename passed. */ |
|
pszExt = NULL; |
|
pszWork = strchr(pszURI, '.'); |
|
while(pszWork) { |
|
pszExt = pszWork + 1; |
|
pszWork = strchr(pszExt, '.'); |
|
} |
|
|
|
/* Now determine the content type and add the relevant header for that. */ |
|
for(iLoop = 0; (iLoop < NUM_HTTP_HEADERS) && pszExt; iLoop++) { |
|
/* Have we found a matching extension? */ |
|
if(!strcmp(g_psHTTPHeaders[iLoop].extension, pszExt)) { |
|
pState->hdrs[2] = |
|
g_psHTTPHeaderStrings[g_psHTTPHeaders[iLoop].headerIndex]; |
|
break; |
|
} |
|
} |
|
|
|
/* Reinstate the parameter marker if there was one in the original URI. */ |
|
if(pszVars) { |
|
*pszVars = '?'; |
|
} |
|
} |
|
|
|
/* Does the URL passed have any file extension? If not, we assume it |
|
is a special-case URL used for control state notification and we do |
|
not send any HTTP headers with the response. */ |
|
if(!pszExt) { |
|
/* Force the header index to a value indicating that all headers |
|
have already been sent. */ |
|
pState->hdr_index = NUM_FILE_HDR_STRINGS; |
|
} |
|
else |
|
{ |
|
/* Did we find a matching extension? */ |
|
if(iLoop == NUM_HTTP_HEADERS) { |
|
/* No - use the default, plain text file type. */ |
|
pState->hdrs[2] = g_psHTTPHeaderStrings[HTTP_HDR_DEFAULT_TYPE]; |
|
} |
|
|
|
/* Set up to send the first header string. */ |
|
pState->hdr_index = 0; |
|
pState->hdr_pos = 0; |
|
} |
|
} |
|
#endif /* LWIP_HTTPD_DYNAMIC_HEADERS */ |
|
|
|
/** |
|
* Try to send more data on this pcb. |
|
* |
|
* @param pcb the pcb to send data |
|
* @param hs connection state |
|
*/ |
|
static u8_t |
|
http_send_data(struct tcp_pcb *pcb, struct http_state *hs) |
|
{ |
|
err_t err; |
|
u16_t len; |
|
u16_t mss; |
|
u8_t data_to_send = false; |
|
#if LWIP_HTTPD_DYNAMIC_HEADERS |
|
u16_t hdrlen, sendlen; |
|
#endif /* LWIP_HTTPD_DYNAMIC_HEADERS */ |
|
|
|
LWIP_DEBUGF(HTTPD_DEBUG, ("http_send_data: pcb=%p hs=%p left=%d\n", (void*)pcb, |
|
(void*)hs, hs != NULL ? hs->left : 0)); |
|
|
|
#if LWIP_HTTPD_DYNAMIC_HEADERS |
|
/* If we were passed a NULL state structure pointer, ignore the call. */ |
|
if (hs == NULL) { |
|
return 0; |
|
} |
|
|
|
/* Assume no error until we find otherwise */ |
|
err = ERR_OK; |
|
|
|
/* Do we have any more header data to send for this file? */ |
|
if(hs->hdr_index < NUM_FILE_HDR_STRINGS) |
|
{ |
|
/* How much data can we send? */ |
|
len = tcp_sndbuf(pcb); |
|
sendlen = len; |
|
|
|
while(len && (hs->hdr_index < NUM_FILE_HDR_STRINGS) && sendlen) |
|
{ |
|
/* How much do we have to send from the current header? */ |
|
hdrlen = (u16_t)strlen(hs->hdrs[hs->hdr_index]); |
|
|
|
/* How much of this can we send? */ |
|
sendlen = (len < (hdrlen - hs->hdr_pos)) ? |
|
len : (hdrlen - hs->hdr_pos); |
|
|
|
/* Send this amount of data or as much as we can given memory |
|
* constraints. */ |
|
do { |
|
err = tcp_write(pcb, (const void *)(hs->hdrs[hs->hdr_index] + |
|
hs->hdr_pos), sendlen, 0); |
|
if (err == ERR_MEM) { |
|
sendlen /= 2; |
|
} |
|
else if (err == ERR_OK) { |
|
/* Remember that we added some more data to be transmitted. */ |
|
data_to_send = true; |
|
} |
|
} while ((err == ERR_MEM) && sendlen); |
|
|
|
/* Fix up the header position for the next time round. */ |
|
hs->hdr_pos += sendlen; |
|
len -= sendlen; |
|
|
|
/* Have we finished sending this string? */ |
|
if(hs->hdr_pos == hdrlen) { |
|
/* Yes - move on to the next one */ |
|
hs->hdr_index++; |
|
hs->hdr_pos = 0; |
|
} |
|
} |
|
|
|
/* If we get here and there are still header bytes to send, we send |
|
* the header information we just wrote immediately. If there are no |
|
* more headers to send, but we do have file data to send, drop through |
|
* to try to send some file data too. |
|
*/ |
|
if((hs->hdr_index < NUM_FILE_HDR_STRINGS) || !hs->file) { |
|
LWIP_DEBUGF(HTTPD_DEBUG, ("tcp_output\n")); |
|
return 1; |
|
} |
|
} |
|
#else /* LWIP_HTTPD_DYNAMIC_HEADERS */ |
|
/* Assume no error until we find otherwise */ |
|
err = ERR_OK; |
|
#endif /* LWIP_HTTPD_DYNAMIC_HEADERS */ |
|
|
|
/* Have we run out of file data to send? If so, we need to read the next |
|
* block from the file. */ |
|
if (hs->left == 0) { |
|
#if LWIP_HTTPD_SSI || LWIP_HTTPD_DYNAMIC_HEADERS |
|
int count; |
|
#endif /* LWIP_HTTPD_SSI || LWIP_HTTPD_DYNAMIC_HEADERS */ |
|
|
|
/* Do we have a valid file handle? */ |
|
if (hs->handle == NULL) { |
|
/* No - close the connection. */ |
|
http_close_conn(pcb, hs); |
|
return 0; |
|
} |
|
if(fs_bytes_left(hs->handle) <= 0) { |
|
/* We reached the end of the file so this request is done */ |
|
LWIP_DEBUGF(HTTPD_DEBUG, ("End of file.\n")); |
|
http_close_conn(pcb, hs); |
|
return 0; |
|
} |
|
#if LWIP_HTTPD_SSI || LWIP_HTTPD_DYNAMIC_HEADERS |
|
/* Do we already have a send buffer allocated? */ |
|
if(hs->buf) { |
|
/* Yes - get the length of the buffer */ |
|
count = hs->buf_len; |
|
} else { |
|
/* We don't have a send buffer so allocate one up to 2mss bytes long. */ |
|
count = 2 * tcp_mss(pcb); |
|
do { |
|
hs->buf = (char*)mem_malloc((mem_size_t)count); |
|
if (hs->buf != NULL) { |
|
hs->buf_len = count; |
|
break; |
|
} |
|
count = count / 2; |
|
} while (count > 100); |
|
|
|
/* Did we get a send buffer? If not, return immediately. */ |
|
if (hs->buf == NULL) { |
|
LWIP_DEBUGF(HTTPD_DEBUG, ("No buff\n")); |
|
return 0; |
|
} |
|
} |
|
|
|
/* Read a block of data from the file. */ |
|
LWIP_DEBUGF(HTTPD_DEBUG, ("Trying to read %d bytes.\n", count)); |
|
|
|
count = fs_read(hs->handle, hs->buf, count); |
|
if(count < 0) { |
|
/* We reached the end of the file so this request is done */ |
|
LWIP_DEBUGF(HTTPD_DEBUG, ("End of file.\n")); |
|
http_close_conn(pcb, hs); |
|
return 1; |
|
} |
|
|
|
/* Set up to send the block of data we just read */ |
|
LWIP_DEBUGF(HTTPD_DEBUG, ("Read %d bytes.\n", count)); |
|
hs->left = count; |
|
hs->file = hs->buf; |
|
#if LWIP_HTTPD_SSI |
|
hs->parse_left = count; |
|
hs->parsed = hs->buf; |
|
#endif /* LWIP_HTTPD_SSI */ |
|
#else /* LWIP_HTTPD_SSI || LWIP_HTTPD_DYNAMIC_HEADERS */ |
|
LWIP_ASSERT("SSI and DYNAMIC_HEADERS turned off but eof not reached", 0); |
|
#endif /* LWIP_HTTPD_SSI || LWIP_HTTPD_DYNAMIC_HEADERS */ |
|
} |
|
|
|
#if LWIP_HTTPD_SSI |
|
if(!hs->tag_check) { |
|
#endif /* LWIP_HTTPD_SSI */ |
|
/* We are not processing an SHTML file so no tag checking is necessary. |
|
* Just send the data as we received it from the file. |
|
*/ |
|
|
|
/* We cannot send more data than space available in the send |
|
buffer. */ |
|
if (tcp_sndbuf(pcb) < hs->left) { |
|
len = tcp_sndbuf(pcb); |
|
} else { |
|
len = (u16_t)hs->left; |
|
LWIP_ASSERT("hs->left did not fit into u16_t!", (len == hs->left)); |
|
} |
|
mss = tcp_mss(pcb); |
|
if(len > (2 * mss)) { |
|
len = 2 * mss; |
|
} |
|
|
|
do { |
|
LWIP_DEBUGF(HTTPD_DEBUG, ("Sending %d bytes\n", len)); |
|
|
|
/* If the data is being read from a buffer in RAM, we need to copy it |
|
* into the PCB. If it's in flash, however, we can avoid the copy since |
|
* the data is obviously not going to be overwritten during the life |
|
* of the connection. |
|
*/ |
|
err = tcp_write(pcb, hs->file, len, HTTP_IS_DATA_VOLATILE(hs)); |
|
if (err == ERR_MEM) { |
|
len /= 2; |
|
} |
|
} while ((err == ERR_MEM) && (len > 1)); |
|
|
|
if (err == ERR_OK) { |
|
data_to_send = true; |
|
hs->file += len; |
|
hs->left -= len; |
|
} |
|
#if LWIP_HTTPD_SSI |
|
} else { |
|
/* We are processing an SHTML file so need to scan for tags and replace |
|
* them with insert strings. We need to be careful here since a tag may |
|
* straddle the boundary of two blocks read from the file and we may also |
|
* have to split the insert string between two tcp_write operations. |
|
*/ |
|
|
|
/* How much data could we send? */ |
|
len = tcp_sndbuf(pcb); |
|
|
|
/* Do we have remaining data to send before parsing more? */ |
|
if(hs->parsed > hs->file) { |
|
/* We cannot send more data than space available in the send |
|
buffer. */ |
|
if (tcp_sndbuf(pcb) < (hs->parsed - hs->file)) { |
|
len = tcp_sndbuf(pcb); |
|
} else { |
|
LWIP_ASSERT("Data size does not fit into u16_t!", |
|
(hs->parsed - hs->file) <= 0xffff); |
|
len = (u16_t)(hs->parsed - hs->file); |
|
} |
|
mss = tcp_mss(pcb); |
|
if(len > (2 * mss)) { |
|
len = 2 * mss; |
|
} |
|
|
|
do { |
|
LWIP_DEBUGF(HTTPD_DEBUG, ("Sending %d bytes\n", len)); |
|
err = tcp_write(pcb, hs->file, len, 0); |
|
if (err == ERR_MEM) { |
|
len /= 2; |
|
} |
|
} while (err == ERR_MEM && len > 1); |
|
|
|
if (err == ERR_OK) { |
|
data_to_send = true; |
|
hs->file += len; |
|
hs->left -= len; |
|
} |
|
|
|
/* If the send buffer is full, return now. */ |
|
if(tcp_sndbuf(pcb) == 0) { |
|
return data_to_send; |
|
} |
|
} |
|
|
|
LWIP_DEBUGF(HTTPD_DEBUG, ("State %d, %d left\n", hs->tag_state, hs->parse_left)); |
|
|
|
/* We have sent all the data that was already parsed so continue parsing |
|
* the buffer contents looking for SSI tags. |
|
*/ |
|
while((hs->parse_left) && (err == ERR_OK)) { |
|
switch(hs->tag_state) { |
|
case TAG_NONE: |
|
/* We are not currently processing an SSI tag so scan for the |
|
* start of the lead-in marker. |
|
*/ |
|
if(*hs->parsed == g_pcTagLeadIn[0]) |
|
{ |
|
/* We found what could be the lead-in for a new tag so change |
|
* state appropriately. |
|
*/ |
|
hs->tag_state = TAG_LEADIN; |
|
hs->tag_index = 1; |
|
} |
|
|
|
/* Move on to the next character in the buffer */ |
|
hs->parse_left--; |
|
hs->parsed++; |
|
break; |
|
|
|
case TAG_LEADIN: |
|
/* We are processing the lead-in marker, looking for the start of |
|
* the tag name. |
|
*/ |
|
|
|
/* Have we reached the end of the leadin? */ |
|
if(hs->tag_index == LEN_TAG_LEAD_IN) { |
|
hs->tag_index = 0; |
|
hs->tag_state = TAG_FOUND; |
|
} else { |
|
/* Have we found the next character we expect for the tag leadin? |
|
*/ |
|
if(*hs->parsed == g_pcTagLeadIn[hs->tag_index]) { |
|
/* Yes - move to the next one unless we have found the complete |
|
* leadin, in which case we start looking for the tag itself |
|
*/ |
|
hs->tag_index++; |
|
} else { |
|
/* We found an unexpected character so this is not a tag. Move |
|
* back to idle state. |
|
*/ |
|
hs->tag_state = TAG_NONE; |
|
} |
|
|
|
/* Move on to the next character in the buffer */ |
|
hs->parse_left--; |
|
hs->parsed++; |
|
} |
|
break; |
|
|
|
case TAG_FOUND: |
|
/* We are reading the tag name, looking for the start of the |
|
* lead-out marker and removing any whitespace found. |
|
*/ |
|
|
|
/* Remove leading whitespace between the tag leading and the first |
|
* tag name character. |
|
*/ |
|
if((hs->tag_index == 0) && ((*hs->parsed == ' ') || |
|
(*hs->parsed == '\t') || (*hs->parsed == '\n') || |
|
(*hs->parsed == '\r'))) |
|
{ |
|
/* Move on to the next character in the buffer */ |
|
hs->parse_left--; |
|
hs->parsed++; |
|
break; |
|
} |
|
|
|
/* Have we found the end of the tag name? This is signalled by |
|
* us finding the first leadout character or whitespace */ |
|
if((*hs->parsed == g_pcTagLeadOut[0]) || |
|
(*hs->parsed == ' ') || (*hs->parsed == '\t') || |
|
(*hs->parsed == '\n') || (*hs->parsed == '\r')) { |
|
|
|
if(hs->tag_index == 0) { |
|
/* We read a zero length tag so ignore it. */ |
|
hs->tag_state = TAG_NONE; |
|
} else { |
|
/* We read a non-empty tag so go ahead and look for the |
|
* leadout string. |
|
*/ |
|
hs->tag_state = TAG_LEADOUT; |
|
LWIP_ASSERT("hs->tag_index <= 0xff", hs->tag_index <= 0xff); |
|
hs->tag_name_len = (u8_t)hs->tag_index; |
|
hs->tag_name[hs->tag_index] = '\0'; |
|
if(*hs->parsed == g_pcTagLeadOut[0]) { |
|
hs->tag_index = 1; |
|
} else { |
|
hs->tag_index = 0; |
|
} |
|
} |
|
} else { |
|
/* This character is part of the tag name so save it */ |
|
if(hs->tag_index < LWIP_HTTPD_MAX_TAG_NAME_LEN) { |
|
hs->tag_name[hs->tag_index++] = *hs->parsed; |
|
} else { |
|
/* The tag was too long so ignore it. */ |
|
hs->tag_state = TAG_NONE; |
|
} |
|
} |
|
|
|
/* Move on to the next character in the buffer */ |
|
hs->parse_left--; |
|
hs->parsed++; |
|
|
|
break; |
|
|
|
/* |
|
* We are looking for the end of the lead-out marker. |
|
*/ |
|
case TAG_LEADOUT: |
|
/* Remove leading whitespace between the tag leading and the first |
|
* tag leadout character. |
|
*/ |
|
if((hs->tag_index == 0) && ((*hs->parsed == ' ') || |
|
(*hs->parsed == '\t') || (*hs->parsed == '\n') || |
|
(*hs->parsed == '\r'))) |
|
{ |
|
/* Move on to the next character in the buffer */ |
|
hs->parse_left--; |
|
hs->parsed++; |
|
break; |
|
} |
|
|
|
/* Have we found the next character we expect for the tag leadout? |
|
*/ |
|
if(*hs->parsed == g_pcTagLeadOut[hs->tag_index]) { |
|
/* Yes - move to the next one unless we have found the complete |
|
* leadout, in which case we need to call the client to process |
|
* the tag. |
|
*/ |
|
|
|
/* Move on to the next character in the buffer */ |
|
hs->parse_left--; |
|
hs->parsed++; |
|
|
|
if(hs->tag_index == (LEN_TAG_LEAD_OUT - 1)) { |
|
/* Call the client to ask for the insert string for the |
|
* tag we just found. |
|
*/ |
|
get_tag_insert(hs); |
|
|
|
/* Next time through, we are going to be sending data |
|
* immediately, either the end of the block we start |
|
* sending here or the insert string. |
|
*/ |
|
hs->tag_index = 0; |
|
hs->tag_state = TAG_SENDING; |
|
hs->tag_end = hs->parsed; |
|
|
|
/* If there is any unsent data in the buffer prior to the |
|
* tag, we need to send it now. |
|
*/ |
|
if(hs->tag_end > hs->file) |
|
{ |
|
/* How much of the data can we send? */ |
|
if(len > hs->tag_end - hs->file) { |
|
len = (u16_t)(hs->tag_end - hs->file); |
|
} |
|
|
|
do { |
|
LWIP_DEBUGF(HTTPD_DEBUG, ("Sending %d bytes\n", len)); |
|
err = tcp_write(pcb, hs->file, len, 0); |
|
if (err == ERR_MEM) { |
|
len /= 2; |
|
} |
|
} while (err == ERR_MEM && (len > 1)); |
|
|
|
if (err == ERR_OK) { |
|
data_to_send = true; |
|
hs->file += len; |
|
hs->left -= len; |
|
} |
|
} |
|
} else { |
|
hs->tag_index++; |
|
} |
|
} else { |
|
/* We found an unexpected character so this is not a tag. Move |
|
* back to idle state. |
|
*/ |
|
hs->parse_left--; |
|
hs->parsed++; |
|
hs->tag_state = TAG_NONE; |
|
} |
|
break; |
|
|
|
/* |
|
* We have found a valid tag and are in the process of sending |
|
* data as a result of that discovery. We send either remaining data |
|
* from the file prior to the insert point or the insert string itself. |
|
*/ |
|
case TAG_SENDING: |
|
/* Do we have any remaining file data to send from the buffer prior |
|
* to the tag? |
|
*/ |
|
if(hs->tag_end > hs->file) |
|
{ |
|
/* How much of the data can we send? */ |
|
if(len > hs->tag_end - hs->file) { |
|
len = (u16_t)(hs->tag_end - hs->file); |
|
} |
|
|
|
do { |
|
LWIP_DEBUGF(HTTPD_DEBUG, ("Sending %d bytes\n", len)); |
|
err = tcp_write(pcb, hs->file, len, 0); |
|
if (err == ERR_MEM) { |
|
len /= 2; |
|
} |
|
} while (err == ERR_MEM && (len > 1)); |
|
|
|
if (err == ERR_OK) { |
|
data_to_send = true; |
|
hs->file += len; |
|
hs->left -= len; |
|
} |
|
} else { |
|
/* Do we still have insert data left to send? */ |
|
if(hs->tag_index < hs->tag_insert_len) { |
|
/* We are sending the insert string itself. How much of the |
|
* insert can we send? */ |
|
if(len > (hs->tag_insert_len - hs->tag_index)) { |
|
len = (hs->tag_insert_len - hs->tag_index); |
|
} |
|
|
|
do { |
|
LWIP_DEBUGF(HTTPD_DEBUG, ("Sending %d bytes\n", len)); |
|
/* |
|
* Note that we set the copy flag here since we only have a |
|
* single tag insert buffer per connection. If we don't do |
|
* this, insert corruption can occur if more than one insert |
|
* is processed before we call tcp_output. |
|
*/ |
|
err = tcp_write(pcb, &(hs->tag_insert[hs->tag_index]), len, 1); |
|
if (err == ERR_MEM) { |
|
len /= 2; |
|
} |
|
} while (err == ERR_MEM && (len > 1)); |
|
|
|
if (err == ERR_OK) { |
|
data_to_send = true; |
|
hs->tag_index += len; |
|
return 1; |
|
} |
|
} else { |
|
/* We have sent all the insert data so go back to looking for |
|
* a new tag. |
|
*/ |
|
LWIP_DEBUGF(HTTPD_DEBUG, ("Everything sent.\n")); |
|
hs->tag_index = 0; |
|
hs->tag_state = TAG_NONE; |
|
} |
|
} |
|
} |
|
} |
|
|
|
/* |
|
* If we drop out of the end of the for loop, this implies we must have |
|
* file data to send so send it now. In TAG_SENDING state, we've already |
|
* handled this so skip the send if that's the case. |
|
*/ |
|
if((hs->tag_state != TAG_SENDING) && (hs->parsed > hs->file)) { |
|
/* We cannot send more data than space available in the send |
|
buffer. */ |
|
if (tcp_sndbuf(pcb) < (hs->parsed - hs->file)) { |
|
len = tcp_sndbuf(pcb); |
|
} else { |
|
LWIP_ASSERT("Data size does not fit into u16_t!", |
|
(hs->parsed - hs->file) <= 0xffff); |
|
len = (u16_t)(hs->parsed - hs->file); |
|
} |
|
if(len > (2 * tcp_mss(pcb))) { |
|
len = 2 * tcp_mss(pcb); |
|
} |
|
|
|
do { |
|
LWIP_DEBUGF(HTTPD_DEBUG, ("Sending %d bytes\n", len)); |
|
err = tcp_write(pcb, hs->file, len, 0); |
|
if (err == ERR_MEM) { |
|
len /= 2; |
|
} |
|
} while (err == ERR_MEM && len > 1); |
|
|
|
if (err == ERR_OK) { |
|
data_to_send = true; |
|
hs->file += len; |
|
hs->left -= len; |
|
} |
|
} |
|
} |
|
#endif /* LWIP_HTTPD_SSI */ |
|
|
|
LWIP_DEBUGF(HTTPD_DEBUG, ("send_data end.\n")); |
|
return data_to_send; |
|
} |
|
|
|
/** |
|
* Get the file struct for a 404 error page. |
|
* Tries some file names and returns NULL if none found. |
|
* |
|
* @param uri pointer that receives the actual file name URI |
|
* @return file struct for the error page or NULL no matching file was found |
|
*/ |
|
static struct fs_file * |
|
http_get_404_file(char **uri) |
|
{ |
|
struct fs_file *file; |
|
|
|
*uri = "/404.html"; |
|
file = fs_open(*uri); |
|
if(file == NULL) { |
|
/* 404.html doesn't exist. Try 404.htm instead. */ |
|
*uri = "/404.htm"; |
|
file = fs_open(*uri); |
|
if(file == NULL) { |
|
/* 404.htm doesn't exist either. Indicate to the caller that it should |
|
* send back a default 404 page. |
|
*/ |
|
*uri = NULL; |
|
} |
|
} |
|
|
|
return file; |
|
} |
|
|
|
/** |
|
* When data has been received in the correct state, try to parse it |
|
* as a HTTP request. |
|
* |
|
* @param p the received pbuf |
|
* @param hs the connection state |
|
* @return ERR_OK if request was OK and hs has been initialized correctly |
|
* another err_t otherwise |
|
*/ |
|
static err_t |
|
http_parse_request(struct pbuf *p, struct http_state *hs) |
|
{ |
|
int i; |
|
/* default is request not supported, until it can be parsed */ |
|
err_t request_supported = ERR_ARG; |
|
size_t loop; |
|
char *data; |
|
char *uri; |
|
struct fs_file *file = NULL; |
|
#if LWIP_HTTPD_CGI |
|
int count; |
|
char *params; |
|
#endif /* LWIP_HTTPD_CGI */ |
|
|
|
data = (char*)p->payload; |
|
/* @todo: using 'data' as string here is kind of unsafe... */ |
|
LWIP_DEBUGF(HTTPD_DEBUG, ("Request:\n%s\n", data)); |
|
/* @todo: support POST, check p->len, correctly handle multi-packet requests */ |
|
if (strncmp(data, "GET ", 4) == 0) { |
|
/* GET is 3 characters plus one space */ |
|
uri = &data[4]; |
|
/* |
|
* We have a GET request. Find the end of the URI by looking for the |
|
* HTTP marker. We can't just use strstr to find this since the request |
|
* came from an outside source and we can't be sure that it is |
|
* correctly formed. We need to make sure that our search is bounded |
|
* by the packet length so we do it manually. If we don't find " HTTP", |
|
* assume the request is invalid and close the connection. |
|
* @todo: use pbuf_strstr() |
|
*/ |
|
for(i = 4; i <= (p->len - 5); i++) { |
|
if ((data[i] == ' ') && (data[i + 1] == 'H') && |
|
(data[i + 2] == 'T') && (data[i + 3] == 'T') && |
|
(data[i + 4] == 'P')) { |
|
/* this NULL-terminates the URI string */ |
|
data[i] = 0; |
|
break; |
|
} |
|
} |
|
if(i > (p->len - 5)) { |
|
/* We failed to find " HTTP" in the request so assume it is invalid */ |
|
LWIP_DEBUGF(HTTPD_DEBUG, ("Invalid GET request. Closing.\n")); |
|
return ERR_ARG; |
|
} |
|
|
|
#if LWIP_HTTPD_SSI |
|
/* |
|
* By default, assume we will not be processing server-side-includes |
|
* tags |
|
*/ |
|
hs->tag_check = false; |
|
#endif /* LWIP_HTTPD_SSI */ |
|
|
|
/* Have we been asked for the default root file? */ |
|
if((uri[0] == '/') && (uri[1] == 0)) { |
|
/* Try each of the configured default filenames until we find one |
|
that exists. */ |
|
for (loop = 0; loop < NUM_DEFAULT_FILENAMES; loop++) { |
|
LWIP_DEBUGF(HTTPD_DEBUG, ("Looking for %s...\n", g_psDefaultFilenames[loop].name)); |
|
file = fs_open((char *)g_psDefaultFilenames[loop].name); |
|
uri = (char *)g_psDefaultFilenames[loop].name; |
|
if(file != NULL) { |
|
LWIP_DEBUGF(HTTPD_DEBUG, ("Opened.\n")); |
|
#if LWIP_HTTPD_SSI |
|
hs->tag_check = g_psDefaultFilenames[loop].shtml; |
|
#endif /* LWIP_HTTPD_SSI */ |
|
break; |
|
} |
|
} |
|
if (file == NULL) { |
|
/* None of the default filenames exist so send back a 404 page */ |
|
file = http_get_404_file(&uri); |
|
#if LWIP_HTTPD_SSI |
|
hs->tag_check = false; |
|
#endif /* LWIP_HTTPD_SSI */ |
|
} |
|
} else { |
|
/* No - we've been asked for a specific file. */ |
|
#if LWIP_HTTPD_CGI |
|
/* First, isolate the base URI (without any parameters) */ |
|
params = strchr(uri, '?'); |
|
if (params != NULL) { |
|
/* URI contains parameters. NULL-terminate the base URI */ |
|
*params = '\0'; |
|
params++; |
|
} |
|
|
|
/* Does the base URI we have isolated correspond to a CGI handler? */ |
|
if (g_iNumCGIs && g_pCGIs) { |
|
for (i = 0; i < g_iNumCGIs; i++) { |
|
if (strcmp(uri, g_pCGIs[i].pcCGIName) == 0) { |
|
/* |
|
* We found a CGI that handles this URI so extract the |
|
* parameters and call the handler. |
|
*/ |
|
count = extract_uri_parameters(hs, params); |
|
uri = g_pCGIs[i].pfnCGIHandler(i, count, hs->params, |
|
hs->param_vals); |
|
break; |
|
} |
|
} |
|
|
|
/* Did we handle this URL as a CGI? If not, reinstate the |
|
* original URL and pass it to the file system directly. */ |
|
if (i == g_iNumCGIs) { |
|
/* Replace the ? marker at the beginning of the parameters */ |
|
if (params != NULL) { |
|
params--; |
|
*params = '?'; |
|
} |
|
} |
|
} |
|
#endif /* LWIP_HTTPD_CGI */ |
|
|
|
LWIP_DEBUGF(HTTPD_DEBUG, ("Opening %s\n", uri)); |
|
|
|
file = fs_open(uri); |
|
if (file == NULL) { |
|
file = http_get_404_file(&uri); |
|
} |
|
#if LWIP_HTTPD_SSI |
|
else { |
|
/* |
|
* See if we have been asked for an shtml file and, if so, |
|
* enable tag checking. |
|
*/ |
|
hs->tag_check = false; |
|
for (loop = 0; loop < NUM_SHTML_EXTENSIONS; loop++) { |
|
if (strstr(uri, g_pcSSIExtensions[loop])) { |
|
hs->tag_check = true; |
|
break; |
|
} |
|
} |
|
} |
|
#endif /* LWIP_HTTPD_SSI */ |
|
} |
|
|
|
if (file != NULL) { |
|
/* file opened, initialise struct http_state */ |
|
#if LWIP_HTTPD_SSI |
|
hs->tag_index = 0; |
|
hs->tag_state = TAG_NONE; |
|
hs->parsed = file->data; |
|
hs->parse_left = file->len; |
|
hs->tag_end = file->data; |
|
#endif /* LWIP_HTTPD_SSI */ |
|
hs->handle = file; |
|
hs->file = (char*)file->data; |
|
LWIP_ASSERT("File length must be positive!", (file->len >= 0)); |
|
hs->left = file->len; |
|
hs->retries = 0; |
|
request_supported = ERR_OK; |
|
#if LWIP_HTTPD_TIMING |
|
hs->time_started = sys_now(); |
|
#endif /* LWIP_HTTPD_TIMING */ |
|
} else { |
|
hs->handle = NULL; |
|
hs->file = NULL; |
|
hs->left = 0; |
|
hs->retries = 0; |
|
} |
|
|
|
#if LWIP_HTTPD_DYNAMIC_HEADERS |
|
/* Determine the HTTP headers to send based on the file extension of |
|
* the requested URI. */ |
|
if (!hs->handle->http_header_included) { |
|
get_http_headers(hs, uri); |
|
} |
|
#endif /* LWIP_HTTPD_DYNAMIC_HEADERS */ |
|
} else { |
|
/* @todo: return HTTP error 501 */ |
|
LWIP_DEBUGF(HTTPD_DEBUG, ("Invalid request/not implemented. Closing.\n")); |
|
} |
|
return request_supported; |
|
} |
|
|
|
/** |
|
* The pcb had an error and is already deallocated. |
|
* The argument might still be valid (if != NULL). |
|
*/ |
|
static void |
|
http_err(void *arg, err_t err) |
|
{ |
|
struct http_state *hs = (struct http_state *)arg; |
|
LWIP_UNUSED_ARG(err); |
|
|
|
LWIP_DEBUGF(HTTPD_DEBUG, ("http_err: %s", lwip_strerr(err))); |
|
|
|
if (hs != NULL) { |
|
http_state_free(hs); |
|
} |
|
} |
|
|
|
/** |
|
* Data has been sent and acknowledged by the remote host. |
|
* This means that more data can be sent. |
|
*/ |
|
static err_t |
|
http_sent(void *arg, struct tcp_pcb *pcb, u16_t len) |
|
{ |
|
struct http_state *hs = (struct http_state *)arg; |
|
|
|
LWIP_DEBUGF(HTTPD_DEBUG, ("http_sent %p\n", (void*)pcb)); |
|
|
|
LWIP_UNUSED_ARG(len); |
|
|
|
if (hs == NULL) { |
|
return ERR_OK; |
|
} |
|
|
|
hs->retries = 0; |
|
|
|
http_send_data(pcb, hs); |
|
|
|
return ERR_OK; |
|
} |
|
|
|
/** |
|
* The poll function is called every 2nd second. |
|
* If there has been no data sent (which resets the retries) in 8 seconds, close. |
|
* If the last portion of a file has not been sent in 2 seconds, close. |
|
* |
|
* This could be increased, but we don't want to waste resources for bad connections. |
|
*/ |
|
static err_t |
|
http_poll(void *arg, struct tcp_pcb *pcb) |
|
{ |
|
struct http_state *hs = (struct http_state *)arg; |
|
LWIP_DEBUGF(HTTPD_DEBUG, ("http_poll: pcb=%p hs=%p pcb_state=%s\n", |
|
(void*)pcb, (void*)hs, tcp_debug_state_str(pcb->state))); |
|
|
|
if (hs == NULL) { |
|
if (pcb->state == ESTABLISHED) { |
|
/* arg is null, close. */ |
|
LWIP_DEBUGF(HTTPD_DEBUG, ("http_poll: arg is NULL, close\n")); |
|
http_close_conn(pcb, hs); |
|
return ERR_OK; |
|
} |
|
} else { |
|
hs->retries++; |
|
if (hs->retries == HTTPD_MAX_RETRIES) { |
|
LWIP_DEBUGF(HTTPD_DEBUG, ("http_poll: too many retries, close\n")); |
|
http_close_conn(pcb, hs); |
|
return ERR_OK; |
|
} |
|
|
|
/* If this connection has a file open, try to send some more data. If |
|
* it has not yet received a GET request, don't do this since it will |
|
* cause the connection to close immediately. */ |
|
if(hs && (hs->handle)) { |
|
LWIP_DEBUGF(HTTPD_DEBUG, ("http_poll: try to send more data\n")); |
|
if(http_send_data(pcb, hs)) { |
|
/* If we wrote anything to be sent, go ahead and send it now. */ |
|
LWIP_DEBUGF(HTTPD_DEBUG, ("tcp_output\n")); |
|
tcp_output(pcb); |
|
} |
|
} |
|
} |
|
|
|
return ERR_OK; |
|
} |
|
|
|
/** |
|
* Data has been received on this pcb. |
|
* For HTTP 1.0, this should normally only happen once (if the request fits in one packet). |
|
*/ |
|
static err_t |
|
http_recv(void *arg, struct tcp_pcb *pcb, struct pbuf *p, err_t err) |
|
{ |
|
err_t parsed = ERR_ABRT; |
|
struct http_state *hs = (struct http_state *)arg; |
|
LWIP_DEBUGF(HTTPD_DEBUG, ("http_recv: pcb=%p pbuf=%p err=%s\n", (void*)pcb, |
|
(void*)p, lwip_strerr(err))); |
|
|
|
if (p != NULL) { |
|
/* Inform TCP that we have taken the data. */ |
|
tcp_recved(pcb, p->tot_len); |
|
} |
|
if ((err != ERR_OK) || (p == NULL) || (hs == NULL)) { |
|
/* error or closed by other side? */ |
|
if (p != NULL) { |
|
pbuf_free(p); |
|
} |
|
if (hs == NULL) { |
|
/* this should not happen, only to be robust */ |
|
LWIP_DEBUGF(HTTPD_DEBUG, ("Error, http_recv: hs is NULL, abort\n")); |
|
} |
|
http_close_conn(pcb, hs); |
|
return ERR_OK; |
|
} |
|
|
|
if (hs->handle == NULL) { |
|
parsed = http_parse_request(p, hs); |
|
} else { |
|
LWIP_DEBUGF(HTTPD_DEBUG, ("http_recv: already sending data\n")); |
|
} |
|
pbuf_free(p); |
|
if (parsed == ERR_OK) { |
|
LWIP_DEBUGF(HTTPD_DEBUG, ("http_recv: data %p len %"S32_F"\n", hs->file, hs->left)); |
|
http_send_data(pcb, hs); |
|
} else if (parsed == ERR_ABRT) { |
|
http_close_conn(pcb, hs); |
|
} |
|
return ERR_OK; |
|
} |
|
|
|
/** |
|
* A new incoming connection has been accepted. |
|
*/ |
|
static err_t |
|
http_accept(void *arg, struct tcp_pcb *pcb, err_t err) |
|
{ |
|
struct http_state *hs; |
|
struct tcp_pcb_listen *lpcb = (struct tcp_pcb_listen*)arg; |
|
LWIP_UNUSED_ARG(err); |
|
LWIP_DEBUGF(HTTPD_DEBUG, ("http_accept %p / %p\n", (void*)pcb, arg)); |
|
|
|
/* Decrease the listen backlog counter */ |
|
tcp_accepted(lpcb); |
|
/* Set priority */ |
|
tcp_setprio(pcb, HTTPD_TCP_PRIO); |
|
|
|
/* Allocate memory for the structure that holds the state of the |
|
connection - initialized by that function. */ |
|
hs = http_state_alloc(); |
|
if (hs == NULL) { |
|
LWIP_DEBUGF(HTTPD_DEBUG, ("http_accept: Out of memory, RST\n")); |
|
return ERR_MEM; |
|
} |
|
|
|
/* Tell TCP that this is the structure we wish to be passed for our |
|
callbacks. */ |
|
tcp_arg(pcb, hs); |
|
|
|
/* Set up the various callback functions */ |
|
tcp_recv(pcb, http_recv); |
|
tcp_err(pcb, http_err); |
|
tcp_poll(pcb, http_poll, HTTPD_POLL_INTERVAL); |
|
tcp_sent(pcb, http_sent); |
|
|
|
return ERR_OK; |
|
} |
|
|
|
/** |
|
* Initialize the httpd: set up a listening PCB and bind it to the defined port |
|
*/ |
|
void |
|
httpd_init(void) |
|
{ |
|
struct tcp_pcb *pcb; |
|
err_t err; |
|
|
|
LWIP_DEBUGF(HTTPD_DEBUG, ("httpd_init\n")); |
|
|
|
pcb = tcp_new(); |
|
LWIP_ASSERT("httpd_init: tcp_new failed", pcb != NULL); |
|
err = tcp_bind(pcb, IP_ADDR_ANY, HTTPD_SERVER_PORT); |
|
LWIP_ASSERT("httpd_init: tcp_bind failed", err == ERR_OK); |
|
pcb = tcp_listen(pcb); |
|
LWIP_ASSERT("httpd_init: tcp_listen failed", pcb != NULL); |
|
/* initialize callback arg and accept callback */ |
|
tcp_arg(pcb, pcb); |
|
tcp_accept(pcb, http_accept); |
|
} |
|
|
|
#if LWIP_HTTPD_SSI |
|
/** |
|
* Set the SSI handler function. |
|
* |
|
* @param ssi_handler the SSI handler function |
|
* @param tags an array of SSI tag strings to search for in SSI-enabled files |
|
* @param num_tags number of tags in the 'tags' array |
|
*/ |
|
void |
|
http_set_ssi_handler(tSSIHandler ssi_handler, const char **tags, int num_tags) |
|
{ |
|
LWIP_DEBUGF(HTTPD_DEBUG, ("http_set_ssi_handler\n")); |
|
|
|
LWIP_ASSERT("no ssi_handler given", ssi_handler != NULL); |
|
LWIP_ASSERT("no tags given", tags != NULL); |
|
LWIP_ASSERT("invalid number of tags", num_tags > 0); |
|
|
|
g_pfnSSIHandler = ssi_handler; |
|
g_ppcTags = tags; |
|
g_iNumTags = num_tags; |
|
} |
|
#endif /* LWIP_HTTPD_SSI */ |
|
|
|
#if LWIP_HTTPD_CGI |
|
/** |
|
* Set an array of CGI filenames/handler functions |
|
* |
|
* @param cgis an array of CGI filenames/handler functions |
|
* @param num_handlers number of elements in the 'cgis' array |
|
*/ |
|
void |
|
http_set_cgi_handlers(const tCGI *cgis, int num_handlers) |
|
{ |
|
LWIP_ASSERT("no cgis given", cgis != NULL); |
|
LWIP_ASSERT("invalid number of handlers", num_handlers > 0); |
|
|
|
g_pCGIs = cgis; |
|
g_iNumCGIs = num_handlers; |
|
} |
|
#endif /* LWIP_HTTPD_CGI */
|
|
|