Projects/Webserver/Lib/HTTPServerApp.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaim all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *
  33  *  Simple HTTP Webserver Application. When connected to the uIP stack,
  34  *  this will serve out files to HTTP clients.
  35  */
  36
  37 #define  INCLUDE_FROM_HTTPSERVERAPP_C
  38 #include "HTTPServerApp.h"
  39
  40 /** HTTP server response header, for transmission before the page contents. This indicates to the host that a page exists at the
  41  *  given location, and gives extra connection information.
  42  */
  43 char PROGMEM HTTP200Header[] = "HTTP/1.1 200 OK\r\n"
  44                                "Server: LUFA RNDIS\r\n"
  45                                "Connection: close\r\n"
  46                                "MIME-version: 1.0\r\n"
  47                                "Content-Type: ";
  48
  49 /** HTTP server response header, for transmission before a resource not found error. This indicates to the host that the given
  50  *  given URL is invalid, and gives extra error information.
  51  */
  52 char PROGMEM HTTP404Header[] = "HTTP/1.1 404 Not Found\r\n"
  53                                "Server: LUFA RNDIS\r\n"
  54                                "Connection: close\r\n"
  55                                "MIME-version: 1.0\r\n"
  56                                "Content-Type: text/plain\r\n\r\n"
  57                                "Error 404: File Not Found";
  58
  59 /** Default MIME type sent if no other MIME type can be determined */
  60 char PROGMEM DefaultMIMEType[] = "text/plain";
  61
  62 /** List of MIME types for each supported file extension. */
  63 MIME_Type_t PROGMEM MIMETypes[] =
  64         {
  65                 {.Extension = "htm", .MIMEType = "text/html"},
  66                 {.Extension = "jpg", .MIMEType = "image/jpeg"},
  67                 {.Extension = "gif", .MIMEType = "image/gif"},
  68                 {.Extension = "bmp", .MIMEType = "image/bmp"},
  69                 {.Extension = "png", .MIMEType = "image/png"},
  70                 {.Extension = "ico", .MIMEType = "image/x-icon"},
  71                 {.Extension = "exe", .MIMEType = "application/octet-stream"},
  72                 {.Extension = "gz",  .MIMEType = "application/x-gzip"},
  73                 {.Extension = "zip", .MIMEType = "application/zip"},
  74                 {.Extension = "pdf", .MIMEType = "application/pdf"},
  75         };
  76
  77 /** FAT Fs structure to hold the internal state of the FAT driver for the dataflash contents. */
  78 FATFS DiskFATState;
  79
  80
  81 /** Initialization function for the simple HTTP webserver. */
  82 void WebserverApp_Init(void)
  83 {
  84         /* Listen on port 80 for HTTP connections from hosts */
  85         uip_listen(HTONS(HTTP_SERVER_PORT));
  86
  87         /* Mount the dataflash disk via FatFS */
  88         f_mount(0, &DiskFATState);
  89 }
  90
  91 /** uIP stack application callback for the simple HTTP webserver. This function must be called each time the
  92  *  TCP/IP stack needs a TCP packet to be processed.
  93  */
  94 void WebserverApp_Callback(void)
  95 {
  96         uip_tcp_appstate_t* const AppState = &uip_conn->appstate;
  97
  98         if (uip_aborted() || uip_timedout() || uip_closed())
  99         {
 100                 /* Connection is being terminated for some reason - close file handle */
 101                 f_close(&AppState->FileHandle);
 102                 AppState->FileOpen = false;
 103
 104                 /* Lock to the closed state so that no further processing will occur on the connection */
 105                 AppState->CurrentState  = WEBSERVER_STATE_Closed;
 106                 AppState->NextState     = WEBSERVER_STATE_Closed;
 107         }
 108
 109         if (uip_connected())
 110         {
 111                 /* New connection - initialize connection state values */
 112                 AppState->CurrentState  = WEBSERVER_STATE_OpenRequestedFile;
 113                 AppState->NextState     = WEBSERVER_STATE_OpenRequestedFile;
 114                 AppState->FileOpen      = false;
 115                 AppState->ACKedFilePos  = 0;
 116                 AppState->SentChunkSize = 0;
 117         }
 118
 119         if (uip_acked())
 120         {
 121                 /* Add the amount of ACKed file data to the total sent file bytes counter */
 122                 AppState->ACKedFilePos += AppState->SentChunkSize;
 123
 124                 /* Progress to the next state once the current state's data has been ACKed */
 125                 AppState->CurrentState = AppState->NextState;
 126         }
 127
 128         if (uip_rexmit() || uip_acked() || uip_newdata() || uip_connected() || uip_poll())
 129         {
 130                 switch (AppState->CurrentState)
 131                 {
 132                         case WEBSERVER_STATE_OpenRequestedFile:
 133                                 Webserver_OpenRequestedFile();
 134                                 break;
 135                         case WEBSERVER_STATE_SendResponseHeader:
 136                                 Webserver_SendResponseHeader();
 137                                 break;
 138                         case WEBSERVER_STATE_SendMIMETypeHeader:
 139                                 Webserver_SendMIMETypeHeader();
 140                                 break;
 141                         case WEBSERVER_STATE_SendData:
 142                                 Webserver_SendData();
 143                                 break;
 144                         case WEBSERVER_STATE_Closing:
 145                                 uip_close();
 146
 147                                 AppState->NextState = WEBSERVER_STATE_Closed;
 148                                 break;
 149                 }
 150         }
 151 }
 152
 153 /** HTTP Server State handler for the Request Process state. This state manages the processing of incomming HTTP
 154  *  GET requests to the server from the receiving HTTP client.
 155  */
 156 static void Webserver_OpenRequestedFile(void)
 157 {
 158         uip_tcp_appstate_t* const AppState    = &uip_conn->appstate;
 159         char*               const AppData     = (char*)uip_appdata;
 160
 161         /* No HTTP header received from the client, abort processing */
 162         if (!(uip_newdata()))
 163           return;
 164
 165         char* RequestToken = strtok(AppData, " ");
 166
 167         /* Must be a GET request, abort otherwise */
 168         if (strcmp(RequestToken, "GET") != 0)
 169         {
 170                 uip_abort();
 171                 return;
 172         }
 173
 174         char* RequestedFileName = strtok(NULL, " ");
 175
 176         /* If the requested filename has more that just the leading '/' path in it, copy it over */
 177         if (strlen(RequestedFileName) > 1)
 178           strncpy(AppState->FileName, &RequestedFileName[1], (sizeof(AppState->FileName) - 1));
 179         else
 180           strcpy(AppState->FileName, "index.htm");
 181
 182         /* Ensure filename is null-terminated */
 183         AppState->FileName[(sizeof(AppState->FileName) - 1)] = 0x00;
 184
 185         /* Try to open the file from the Dataflash disk */
 186         AppState->FileOpen     = (f_open(&AppState->FileHandle, AppState->FileName, FA_OPEN_EXISTING | FA_READ) == FR_OK);
 187
 188         /* Lock to the SendResponseHeader state until connection terminated */
 189         AppState->CurrentState = WEBSERVER_STATE_SendResponseHeader;
 190         AppState->NextState    = WEBSERVER_STATE_SendResponseHeader;
 191 }
 192
 193 /** HTTP Server State handler for the HTTP Response Header Send state. This state manages the transmission of
 194  *  the HTTP response header to the receiving HTTP client.
 195  */
 196 static void Webserver_SendResponseHeader(void)
 197 {
 198         uip_tcp_appstate_t* const AppState    = &uip_conn->appstate;
 199         char*               const AppData     = (char*)uip_appdata;
 200
 201         char*    HeaderToSend;
 202         uint16_t HeaderLength;
 203
 204         /* Determine which HTTP header should be sent to the client */
 205         if (AppState->FileOpen)
 206         {
 207                 HeaderToSend = HTTP200Header;
 208                 AppState->NextState = WEBSERVER_STATE_SendMIMETypeHeader;
 209         }
 210         else
 211         {
 212                 HeaderToSend = HTTP404Header;
 213                 AppState->NextState = WEBSERVER_STATE_Closing;
 214         }
 215
 216         /* Copy over the HTTP response header and send it to the receiving client */
 217         HeaderLength = strlen_P(HeaderToSend);
 218         strncpy_P(AppData, HeaderToSend, HeaderLength);
 219         uip_send(AppData, HeaderLength);
 220 }
 221
 222 /** HTTP Server State handler for the MIME Header Send state. This state manages the transmission of the file
 223  *  MIME type header for the requested file to the receiving HTTP client.
 224  */
 225 static void Webserver_SendMIMETypeHeader(void)
 226 {
 227         uip_tcp_appstate_t* const AppState    = &uip_conn->appstate;
 228         char*               const AppData     = (char*)uip_appdata;
 229
 230         char*    Extension        = strpbrk(AppState->FileName, ".");
 231         uint16_t MIMEHeaderLength = 0;
 232
 233         /* Check to see if a file extension was found for the requested filename */
 234         if (Extension != NULL)
 235         {
 236                 /* Look through the MIME type list, copy over the required MIME type if found */
 237                 for (int i = 0; i < (sizeof(MIMETypes) / sizeof(MIMETypes[0])); i++)
 238                 {
 239                         if (strcmp_P(&Extension[1], MIMETypes[i].Extension) == 0)
 240                         {
 241                                 MIMEHeaderLength = strlen_P(MIMETypes[i].MIMEType);
 242                                 strncpy_P(AppData, MIMETypes[i].MIMEType, MIMEHeaderLength);
 243                                 break;
 244                         }
 245                 }
 246         }
 247
 248         /* Check if a MIME type was found and copied to the output buffer */
 249         if (!(MIMEHeaderLength))
 250         {
 251                 /* MIME type not found - copy over the default MIME type */
 252                 MIMEHeaderLength = strlen_P(DefaultMIMEType);
 253                 strncpy_P(AppData, DefaultMIMEType, MIMEHeaderLength);
 254         }
 255
 256         /* Add the end-of line terminator and end-of-headers terminator after the MIME type */
 257         strncpy(&AppData[MIMEHeaderLength], "\r\n\r\n", sizeof("\r\n\r\n"));
 258         MIMEHeaderLength += (sizeof("\r\n\r\n") - 1);
 259
 260         /* Send the MIME header to the receiving client */
 261         uip_send(AppData, MIMEHeaderLength);
 262
 263         /* When the MIME header is ACKed, progress to the data send stage */
 264         AppState->NextState = WEBSERVER_STATE_SendData;
 265 }
 266
 267 /** HTTP Server State handler for the Data Send state. This state manages the transmission of file chunks
 268  *  to the receiving HTTP client.
 269  */
 270 static void Webserver_SendData(void)
 271 {
 272         uip_tcp_appstate_t* const AppState    = &uip_conn->appstate;
 273         char*               const AppData     = (char*)uip_appdata;
 274
 275         /* Must determine the maximum segment size to determine maximum file chunk size */
 276         uint16_t MaxSegmentSize = uip_mss();
 277
 278         /* Return file pointer to the last ACKed position */
 279         f_lseek(&AppState->FileHandle, AppState->ACKedFilePos);
 280
 281         /* Read the next chunk of data from the open file */
 282         f_read(&AppState->FileHandle, AppData, MaxSegmentSize, &AppState->SentChunkSize);
 283
 284         /* Send the next file chunk to the receiving client */
 285         uip_send(AppData, AppState->SentChunkSize);
 286
 287         /* Check if we are at the last chunk of the file, if so next ACK should close the connection */
 288         AppState->NextState = (MaxSegmentSize != AppState->SentChunkSize) ? WEBSERVER_STATE_Closing : WEBSERVER_STATE_SendData;
 289 }