HTTPServerApp.c 10.9 KB
Newer Older
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
/*
             LUFA Library
     Copyright (C) Dean Camera, 2010.
              
  dean [at] fourwalledcubicle [dot] com
      www.fourwalledcubicle.com
*/

/*
  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)

  Permission to use, copy, modify, distribute, and sell this 
  software and its documentation for any purpose is hereby granted
  without fee, provided that the above copyright notice appear in 
  all copies and that both that the copyright notice and this
  permission notice and warranty disclaimer appear in supporting 
  documentation, and that the name of the author not be used in 
  advertising or publicity pertaining to distribution of the 
  software without specific, written prior permission.

  The author disclaim all warranties with regard to this
  software, including all implied warranties of merchantability
  and fitness.  In no event shall the author be liable for any
  special, indirect or consequential damages or any damages
  whatsoever resulting from loss of use, data or profits, whether
  in an action of contract, negligence or other tortious action,
  arising out of or in connection with the use or performance of
  this software.
*/

/** \file
 *
 *  Simple HTTP Webserver Application. When connected to the uIP stack,
34
 *  this will serve out files to HTTP clients on port 80.
35
36
 */
 
37
#define  INCLUDE_FROM_HTTPSERVERAPP_C
38
39
40
41
42
#include "HTTPServerApp.h"

/** HTTP server response header, for transmission before the page contents. This indicates to the host that a page exists at the
 *  given location, and gives extra connection information.
 */
43
44
45
46
47
const char PROGMEM HTTP200Header[] = "HTTP/1.1 200 OK\r\n"
                                     "Server: LUFA " LUFA_VERSION_STRING "\r\n"
                                     "Connection: close\r\n"
                                     "MIME-version: 1.0\r\n"
                                     "Content-Type: ";
48
49
50
51

/** HTTP server response header, for transmission before a resource not found error. This indicates to the host that the given
 *  given URL is invalid, and gives extra error information.
 */
52
53
54
55
56
const char PROGMEM HTTP404Header[] = "HTTP/1.1 404 Not Found\r\n"
                                     "Server: LUFA " LUFA_VERSION_STRING "\r\n"
                                     "Connection: close\r\n"
                                     "MIME-version: 1.0\r\n"
                                     "Content-Type: text/plain\r\n\r\n"
57
                                     "Error 404: File Not Found: /";
58

59
60
/** Default MIME type sent if no other MIME type can be determined. */
const char PROGMEM DefaultMIMEType[] = "text/plain";
61

62
63
64
/** Default filename to fetch when a directory is requested */
const char PROGMEM DefaultDirFileName[] = "index.htm";

65
/** List of MIME types for each supported file extension. */
66
const MIME_Type_t MIMETypes[] =
67
68
69
70
71
72
	{
		{.Extension = "htm", .MIMEType = "text/html"},
		{.Extension = "jpg", .MIMEType = "image/jpeg"},
		{.Extension = "gif", .MIMEType = "image/gif"},
		{.Extension = "bmp", .MIMEType = "image/bmp"},
		{.Extension = "png", .MIMEType = "image/png"},
73
		{.Extension = "ico", .MIMEType = "image/x-icon"},
74
75
76
77
78
		{.Extension = "exe", .MIMEType = "application/octet-stream"},
		{.Extension = "gz",  .MIMEType = "application/x-gzip"},
		{.Extension = "zip", .MIMEType = "application/zip"},
		{.Extension = "pdf", .MIMEType = "application/pdf"},
	};
79
80
81
82

/** FAT Fs structure to hold the internal state of the FAT driver for the dataflash contents. */
FATFS DiskFATState;

83

84
/** Initialization function for the simple HTTP webserver. */
85
void HTTPServerApp_Init(void)
86
87
88
89
90
91
92
93
94
95
96
{
	/* Listen on port 80 for HTTP connections from hosts */
	uip_listen(HTONS(HTTP_SERVER_PORT));
	
	/* Mount the dataflash disk via FatFS */
	f_mount(0, &DiskFATState);
}

/** uIP stack application callback for the simple HTTP webserver. This function must be called each time the
 *  TCP/IP stack needs a TCP packet to be processed.
 */
97
void HTTPServerApp_Callback(void)
98
{
99
	uip_tcp_appstate_t* const AppState = &uip_conn->appstate;
100

101
	if (uip_aborted() || uip_timedout() || uip_closed())
102
	{
103
		/* Connection is being terminated for some reason - close file handle */
104
105
		f_close(&AppState->HTTPServer.FileHandle);
		AppState->HTTPServer.FileOpen = false;
106
107
		
		/* Lock to the closed state so that no further processing will occur on the connection */
108
109
		AppState->HTTPServer.CurrentState  = WEBSERVER_STATE_Closed;
		AppState->HTTPServer.NextState     = WEBSERVER_STATE_Closed;
110
	}
111
112

	if (uip_connected())
113
	{
114
		/* New connection - initialize connection state values */
115
116
117
118
119
		AppState->HTTPServer.CurrentState  = WEBSERVER_STATE_OpenRequestedFile;
		AppState->HTTPServer.NextState     = WEBSERVER_STATE_OpenRequestedFile;
		AppState->HTTPServer.FileOpen      = false;
		AppState->HTTPServer.ACKedFilePos  = 0;
		AppState->HTTPServer.SentChunkSize = 0;
120
	}
121
122

	if (uip_acked())
123
	{
124
		/* Add the amount of ACKed file data to the total sent file bytes counter */
125
		AppState->HTTPServer.ACKedFilePos += AppState->HTTPServer.SentChunkSize;
126
127

		/* Progress to the next state once the current state's data has been ACKed */
128
		AppState->HTTPServer.CurrentState = AppState->HTTPServer.NextState;
129
	}
130

131
132
133
134
135
136
	if (uip_rexmit())
	{
		/* Return file pointer to the last ACKed position */
		f_lseek(&AppState->HTTPServer.FileHandle, AppState->HTTPServer.ACKedFilePos);	
	}

137
	if (uip_rexmit() || uip_acked() || uip_newdata() || uip_connected() || uip_poll())
138
	{
139
		switch (AppState->HTTPServer.CurrentState)
140
141
		{
			case WEBSERVER_STATE_OpenRequestedFile:
142
				HTTPServerApp_OpenRequestedFile();
143
144
				break;
			case WEBSERVER_STATE_SendResponseHeader:
145
				HTTPServerApp_SendResponseHeader();
146
147
				break;
			case WEBSERVER_STATE_SendData:
148
				HTTPServerApp_SendData();
149
150
151
				break;
			case WEBSERVER_STATE_Closing:
				uip_close();
152
				
153
				AppState->HTTPServer.NextState = WEBSERVER_STATE_Closed;
154
155
156
157
				break;
		}		  
	}		
}
158

159
/** HTTP Server State handler for the Request Process state. This state manages the processing of incoming HTTP
160
161
 *  GET requests to the server from the receiving HTTP client.
 */
162
static void HTTPServerApp_OpenRequestedFile(void)
163
164
{
	uip_tcp_appstate_t* const AppState    = &uip_conn->appstate;
165
	char*               const AppData     = (char*)uip_appdata;
166
167
168
169
170
	
	/* No HTTP header received from the client, abort processing */
	if (!(uip_newdata()))
	  return;
	  
171
	char* RequestToken      = strtok(AppData, " ");
172
	char* RequestedFileName = strtok(NULL, " ");
173
			
174
175
176
177
178
179
180
	/* Must be a GET request, abort otherwise */
	if (strcmp(RequestToken, "GET") != 0)
	{
		uip_abort();
		return;
	}
	
181
182
183
	/* Copy over the requested filename */
	strncpy(AppState->HTTPServer.FileName, &RequestedFileName[1], (sizeof(AppState->HTTPServer.FileName) - 1));
	
184
	/* Ensure filename is null-terminated */
185
186
187
188
	AppState->HTTPServer.FileName[sizeof(AppState->HTTPServer.FileName) - 1] = 0x00;
	
	/* Determine the length of the URI so that it can be checked to see if it is a directory */
	uint8_t FileNameLen = strlen(AppState->HTTPServer.FileName);
189
190

	/* If the URI is a directory, append the default filename */
191
	if (AppState->HTTPServer.FileName[FileNameLen - 1] == '/')
192
	{
193
194
		strncpy_P(&AppState->HTTPServer.FileName[FileNameLen], DefaultDirFileName,
		          (sizeof(AppState->HTTPServer.FileName) - FileNameLen));
195
196

		/* Ensure altered filename is still null-terminated */
197
		AppState->HTTPServer.FileName[sizeof(AppState->HTTPServer.FileName) - 1] = 0x00;
198
	}
199
200
	
	/* Try to open the file from the Dataflash disk */
201
202
	AppState->HTTPServer.FileOpen     = (f_open(&AppState->HTTPServer.FileHandle, AppState->HTTPServer.FileName,
	                                            (FA_OPEN_EXISTING | FA_READ)) == FR_OK);
203
204

	/* Lock to the SendResponseHeader state until connection terminated */
205
206
	AppState->HTTPServer.CurrentState = WEBSERVER_STATE_SendResponseHeader;
	AppState->HTTPServer.NextState    = WEBSERVER_STATE_SendResponseHeader;
207
208
209
210
211
}

/** HTTP Server State handler for the HTTP Response Header Send state. This state manages the transmission of
 *  the HTTP response header to the receiving HTTP client.
 */
212
static void HTTPServerApp_SendResponseHeader(void)
213
214
{
	uip_tcp_appstate_t* const AppState    = &uip_conn->appstate;
215
	char*               const AppData     = (char*)uip_appdata;
216

217
218
	char* Extension     = strpbrk(AppState->HTTPServer.FileName, ".");
	bool  FoundMIMEType = false;
219

220
221
	/* If the file isn't already open, it wasn't found - send back a 404 error response and abort */
	if (!(AppState->HTTPServer.FileOpen))
222
	{
223
224
225
226
227
		/* Copy over the HTTP 404 response header and send it to the receiving client */
		strcpy_P(AppData, HTTP404Header);
		strcpy(&AppData[strlen(AppData)], AppState->HTTPServer.FileName);		
		uip_send(AppData, strlen(AppData));
		
228
		AppState->HTTPServer.NextState = WEBSERVER_STATE_Closing;
229
		return;
230
	}
231
232
233
	
	/* Copy over the HTTP 200 response header and send it to the receiving client */
	strcpy_P(AppData, HTTP200Header);
234

235
	/* Check to see if a MIME type for the requested file's extension was found */
236
237
238
	if (Extension != NULL)
	{
		/* Look through the MIME type list, copy over the required MIME type if found */
239
		for (uint8_t i = 0; i < (sizeof(MIMETypes) / sizeof(MIMETypes[0])); i++)
240
		{
241
			if (strcmp(&Extension[1], MIMETypes[i].Extension) == 0)
242
			{
243
244
				strcpy(&AppData[strlen(AppData)], MIMETypes[i].MIMEType);						
				FoundMIMEType = true;
245
				break;
246
			}
247
248
		} 
	}
249

250
	/* Check if a MIME type was found and copied to the output buffer */
251
	if (!(FoundMIMEType))
252
253
	{
		/* MIME type not found - copy over the default MIME type */
254
		strcpy_P(&AppData[strlen(AppData)], DefaultMIMEType);
255
	}
256
	
257
	/* Add the end-of-line terminator and end-of-headers terminator after the MIME type */
258
	strcpy(&AppData[strlen(AppData)], "\r\n\r\n");
259
260
	
	/* Send the MIME header to the receiving client */
261
	uip_send(AppData, strlen(AppData));
262
263
	
	/* When the MIME header is ACKed, progress to the data send stage */
264
	AppState->HTTPServer.NextState = WEBSERVER_STATE_SendData;
265
}
266

267
268
269
/** HTTP Server State handler for the Data Send state. This state manages the transmission of file chunks
 *  to the receiving HTTP client.
 */
270
static void HTTPServerApp_SendData(void)
271
272
{
	uip_tcp_appstate_t* const AppState    = &uip_conn->appstate;
273
	char*               const AppData     = (char*)uip_appdata;
274

275
276
	/* Get the maximum segment size for the current packet */
	uint16_t MaxChunkSize = uip_mss();
277
278

	/* Read the next chunk of data from the open file */
279
	f_read(&AppState->HTTPServer.FileHandle, AppData, MaxChunkSize, &AppState->HTTPServer.SentChunkSize);
280
281
	
	/* Send the next file chunk to the receiving client */
282
	uip_send(AppData, AppState->HTTPServer.SentChunkSize);
283
284
			
	/* Check if we are at the last chunk of the file, if so next ACK should close the connection */
285
286
	if (MaxChunkSize != AppState->HTTPServer.SentChunkSize)
	  AppState->HTTPServer.NextState = WEBSERVER_STATE_Closing;
287
}