Demos/Device/ClassDriver/RNDISEthernet/Lib/Webserver.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 webserver application for demonstrating the RNDIS demo and TCP/IP stack. This
  34  *  application will serve up a static HTTP web page when requested by the host.
  35  */
  36
  37 #include "Webserver.h"
  38
  39 /** HTTP server response header, for transmission before the page contents. This indicates to the host that a page exists at the
  40  *  given location, and gives extra connection information.
  41  */
  42 char PROGMEM HTTP200Header[] = "HTTP/1.1 200 OK\r\n"
  43                                "Server: LUFA RNDIS\r\n"
  44                                "Content-type: text/html\r\n"
  45                                "Connection: close\r\n\r\n";
  46
  47 /** HTTP server response header, for transmission before a resource not found error. This indicates to the host that the given
  48  *  given URL is invalid, and gives extra error information.
  49  */
  50 char PROGMEM HTTP404Header[] = "HTTP/1.1 404 Not Found\r\n"
  51                                "Server: LUFA RNDIS\r\n"
  52                                "Connection: close\r\n\r\n";
  53
  54 /** HTTP page to serve to the host when a HTTP request is made. This page is too long for a single response, thus it is automatically
  55  *  broken up into smaller blocks and sent as a series of packets each time the webserver application callback is run.
  56  */
  57 char PROGMEM HTTPPage[]   =
  58                 "<html>"
  59                 "       <head>"
  60                 "               <title>"
  61                 "                       LUFA Webserver Demo"
  62                 "               </title>"
  63                 "       </head>"
  64                 "       <body>"
  65                 "               <h1>Hello from your USB AVR!</h1>"
  66                 "               <p>"
  67                 "                       Hello! Welcome to the LUFA RNDIS Demo Webserver test page, running on your USB AVR via the LUFA library. This demonstrates the HTTP webserver, TCP/IP stack and RNDIS demo all running atop the LUFA USB stack."
  68                 "                       <br /><br />"
  69                 "                       <small>Project Information: <a href=\"http://www.fourwalledcubicle.com/LUFA.php\">http://www.fourwalledcubicle.com/LUFA.php</a>.</small>"
  70                 "                       <hr />"
  71                 "                       <i>LUFA Version: </i>" LUFA_VERSION_STRING
  72                 "               </p>"
  73                 "       </body>"
  74                 "</html>";
  75
  76
  77 /** Initializes the Webserver application, opening the appropriate HTTP port in the TCP handler and registering the application
  78  *  callback routine for packets sent to the HTTP protocol port.
  79  */
  80 void Webserver_Init(void)
  81 {
  82         /* Open the HTTP port in the TCP protocol so that HTTP connections to the device can be established */
  83         TCP_SetPortState(TCP_PORT_HTTP, TCP_Port_Open, Webserver_ApplicationCallback);
  84 }
  85
  86 /** Indicates if a given request equals the given HTTP command.
  87  *
  88  *  \param[in] RequestHeader  HTTP request made by the host
  89  *  \param[in] Command        HTTP command to compare the request to
  90  *
  91  *  \return Boolean true if the command matches the request, false otherwise
  92  */
  93 static bool IsHTTPCommand(uint8_t* RequestHeader, char* Command)
  94 {
  95         /* Returns true if the non null terminated string in RequestHeader matches the null terminated string Command */
  96         return (strncmp((char*)RequestHeader, Command, strlen(Command)) == 0);
  97 }
  98
  99 /** Application callback routine, executed each time the TCP processing task runs. This callback determines what request
 100  *  has been made (if any), and serves up appropriate responses.
 101  *
 102  *  \param[in] ConnectionState  Pointer to a TCP Connection State structure giving connection information
 103  *  \param[in,out] Buffer       Pointer to the application's send/receive packet buffer
 104  */
 105 void Webserver_ApplicationCallback(TCP_ConnectionState_t* ConnectionState, TCP_ConnectionBuffer_t* Buffer)
 106 {
 107         char*          BufferDataStr = (char*)Buffer->Data;
 108         static uint8_t PageBlock     = 0;
 109
 110         /* Check to see if a packet has been received on the HTTP port from a remote host */
 111         if (TCP_APP_HAS_RECEIVED_PACKET(Buffer))
 112         {
 113                 if (IsHTTPCommand(Buffer->Data, "GET"))
 114                 {
 115                         if (IsHTTPCommand(Buffer->Data, "GET / "))
 116                         {
 117                                 PageBlock = 0;
 118
 119                                 /* Copy the HTTP 200 response header into the packet buffer */
 120                                 strcpy_P(BufferDataStr, HTTP200Header);
 121
 122                                 /* Send the buffer contents to the host */
 123                                 TCP_APP_SEND_BUFFER(Buffer, strlen(BufferDataStr));
 124
 125                                 /* Lock the buffer to Device->Host transmissions only while we send the page contents */
 126                                 TCP_APP_CAPTURE_BUFFER(Buffer);
 127                         }
 128                         else
 129                         {
 130                                 /* Copy the HTTP 404 response header into the packet buffer */
 131                                 strcpy_P(BufferDataStr, HTTP404Header);
 132
 133                                 /* Send the buffer contents to the host */
 134                                 TCP_APP_SEND_BUFFER(Buffer, strlen(BufferDataStr));
 135
 136                                 /* All data sent, close the connection */
 137                                 TCP_APP_CLOSECONNECTION(ConnectionState);
 138                         }
 139                 }
 140                 else if (IsHTTPCommand(Buffer->Data, "HEAD"))
 141                 {
 142                         if (IsHTTPCommand(Buffer->Data, "HEAD / "))
 143                         {
 144                                 /* Copy the HTTP response header into the packet buffer */
 145                                 strcpy_P(BufferDataStr, HTTP200Header);
 146
 147                                 /* Send the buffer contents to the host */
 148                                 TCP_APP_SEND_BUFFER(Buffer, strlen(BufferDataStr));
 149                         }
 150                         else
 151                         {
 152                                 /* Copy the HTTP response header into the packet buffer */
 153                                 strcpy_P(BufferDataStr, HTTP404Header);
 154
 155                                 /* Send the buffer contents to the host */
 156                                 TCP_APP_SEND_BUFFER(Buffer, strlen(BufferDataStr));
 157                         }
 158
 159                         /* All data sent, close the connection */
 160                         TCP_APP_CLOSECONNECTION(ConnectionState);
 161                 }
 162                 else if (IsHTTPCommand(Buffer->Data, "TRACE"))
 163                 {
 164                         /* Echo the host's query back to the host */
 165                         TCP_APP_SEND_BUFFER(Buffer, Buffer->Length);
 166
 167                         /* All data sent, close the connection */
 168                         TCP_APP_CLOSECONNECTION(ConnectionState);
 169                 }
 170                 else
 171                 {
 172                         /* Unknown request, just clear the buffer (drop the packet) */
 173                         TCP_APP_CLEAR_BUFFER(Buffer);
 174                 }
 175         }
 176         else if (TCP_APP_HAVE_CAPTURED_BUFFER(Buffer))
 177         {
 178                 uint16_t RemLength = strlen_P(&HTTPPage[PageBlock * HTTP_REPLY_BLOCK_SIZE]);
 179                 uint16_t Length;
 180
 181                 /* Determine the length of the loaded block */
 182                 Length = ((RemLength > HTTP_REPLY_BLOCK_SIZE) ? HTTP_REPLY_BLOCK_SIZE : RemLength);
 183
 184                 /* Copy the next buffer sized block of the page to the packet buffer */
 185                 strncpy_P(BufferDataStr, &HTTPPage[PageBlock * HTTP_REPLY_BLOCK_SIZE], Length);
 186
 187                 /* Send the buffer contents to the host */
 188                 TCP_APP_SEND_BUFFER(Buffer, Length);
 189
 190                 /* Check to see if the entire page has been sent */
 191                 if (PageBlock++ == (sizeof(HTTPPage) / HTTP_REPLY_BLOCK_SIZE))
 192                 {
 193                         /* Unlock the buffer so that the host can fill it with future packets */
 194                         TCP_APP_RELEASE_BUFFER(Buffer);
 195
 196                         /* Close the connection to the host */
 197                         TCP_APP_CLOSECONNECTION(ConnectionState);
 198                 }
 199         }
 200 }