David Smart / SW_HTTPServer

A simple web server that can be bound to either the EthernetInterface or the WiflyInterface.

Dependents:   Smart-WiFly-WebServer WattEye X10Svr SSDP_Server

SW_HTTPServer.h@18:6199558632c0, 2013-09-14 (annotated)

Committer:
WiredHome
Date:
Sat Sep 14 20:36:16 2013 +0000
Revision:
18:6199558632c0
Parent:
17:69ff00ce39f4
Child:
21:660143f20b04
Documentation updates only.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
WiredHome 1:54353af0d20a 1
WiredHome 1:54353af0d20a 2 #ifndef SW_HTTPSERVER_H
WiredHome 1:54353af0d20a 3 #define SW_HTTPSERVER_H
WiredHome 1:54353af0d20a 4 #include "mbed.h"
WiredHome 1:54353af0d20a 5 //#include "MODSERIAL.h" // would like to hook in mod serial for higher performance, less blocking
WiredHome 1:54353af0d20a 6 #include "Wifly.h"
WiredHome 1:54353af0d20a 7 #include "TCPSocketServer.h"
WiredHome 1:54353af0d20a 8 #include "TCPSocketConnection.h"
WiredHome 1:54353af0d20a 9
WiredHome 1:54353af0d20a 10 #ifdef MODSERIAL_H
WiredHome 1:54353af0d20a 11 #define PC MODSERIAL
WiredHome 1:54353af0d20a 12 #else
WiredHome 1:54353af0d20a 13 #define PC Serial
WiredHome 1:54353af0d20a 14 #endif
WiredHome 1:54353af0d20a 15
WiredHome 9:2ea342765c9d 16 /// This is the default buffer size used to send files. You might size
WiredHome 9:2ea342765c9d 17 /// this to be equal or less than the payload size of 1460 bytes.
WiredHome 9:2ea342765c9d 18 /// See User Manual 3.6.1.
WiredHome 9:2ea342765c9d 19 #define FILESEND_BUF_SIZE 1460
WiredHome 3:17928786bdb5 20
WiredHome 3:17928786bdb5 21
WiredHome 12:109bf1558300 22 /// MAX_HEADER_SIZE is the default size to contain the largest header.
WiredHome 9:2ea342765c9d 23 /// This is the size of the URL and query string, and also all the
WiredHome 3:17928786bdb5 24 /// other header information about the client. This can be
WiredHome 12:109bf1558300 25 /// a couple of K, larger if you have big forms as it includes the
WiredHome 3:17928786bdb5 26 /// form data that is submitted.
WiredHome 3:17928786bdb5 27 #define MAX_HEADER_SIZE 1000
WiredHome 3:17928786bdb5 28
WiredHome 9:2ea342765c9d 29
WiredHome 1:54353af0d20a 30 /// HTTPServer is a simple web server using the WiFly module.
WiredHome 12:109bf1558300 31 ///
WiredHome 3:17928786bdb5 32 /// While simple, it is a capable, web server. The basic mode
WiredHome 3:17928786bdb5 33 /// of operation is for it to serve static web pages from an available
WiredHome 3:17928786bdb5 34 /// file system.
WiredHome 12:109bf1558300 35 ///
WiredHome 3:17928786bdb5 36 /// The default page is index.htm (compile time defined)
WiredHome 3:17928786bdb5 37 /// standard support to serve a number of standard file types;
WiredHome 3:17928786bdb5 38 /// gif, jpg, jpeg, ico, png, zip, gz, tar, txt, pdf, htm, html
WiredHome 3:17928786bdb5 39 /// (this list is also compile time defined)
WiredHome 3:17928786bdb5 40 ///
WiredHome 3:17928786bdb5 41 /// It can also serve dynamically generated pages, and therefore
WiredHome 3:17928786bdb5 42 /// respond to form submission. Through the dynamic interface it is
WiredHome 3:17928786bdb5 43 /// then quite easy to interact with the hardware, reading the inputs
WiredHome 3:17928786bdb5 44 /// or signaling outputs.
WiredHome 3:17928786bdb5 45 ///
WiredHome 3:17928786bdb5 46 /// @code
WiredHome 13:8975d7928678 47 /// HTTPServer svr(&wifly, HTTP_SERVER_PORT, "/local/", 15, 30, 10, &pc);
WiredHome 3:17928786bdb5 48 /// svr.RegisterHandler("/dyn1", SimpleDynamicPage);
WiredHome 3:17928786bdb5 49 /// while (true)
WiredHome 3:17928786bdb5 50 /// {
WiredHome 3:17928786bdb5 51 /// svr.Poll(); // this is non blocking process, but variable execution
WiredHome 3:17928786bdb5 52 /// }
WiredHome 3:17928786bdb5 53 /// @endcode
WiredHome 3:17928786bdb5 54 ///
WiredHome 3:17928786bdb5 55 /// This web server used nweb as a starting point, but expanded well beyond there.
WiredHome 0:729320f63c5c 56 /// http://www.ibm.com/developerworks/systems/library/es-nweb/sidefile1.html
WiredHome 0:729320f63c5c 57 ///
WiredHome 3:17928786bdb5 58 /// @note This server uses a modified version of the mbed WiflyInterface - there
WiredHome 3:17928786bdb5 59 /// were a number of performance issues identified and resolved in the local version.
WiredHome 0:729320f63c5c 60 ///
WiredHome 3:17928786bdb5 61 /// Given: scheme://server:port/path?query_string#fragment_id
WiredHome 0:729320f63c5c 62 /// @li scheme is "http"
WiredHome 3:17928786bdb5 63 /// @li server is whatever IP the server has
WiredHome 0:729320f63c5c 64 /// @li port is the registered port
WiredHome 0:729320f63c5c 65 /// @li /path is the reference to the file (actual or logical) on the server
WiredHome 0:729320f63c5c 66 /// @li query_string is any combination of name=value pairs
WiredHome 0:729320f63c5c 67 /// @li fragment_id is a reference to an anchor on the page
WiredHome 0:729320f63c5c 68 ///
WiredHome 3:17928786bdb5 69 /// Features:
WiredHome 3:17928786bdb5 70 /// @li Serves static pages from a file system. Many normal filetypes are
WiredHome 3:17928786bdb5 71 /// supported.
WiredHome 3:17928786bdb5 72 /// @li Compile time configurable for the "default" file, typically index.htm.
WiredHome 3:17928786bdb5 73 /// @li Provides a registration interface for dynamically generated pages that
WiredHome 3:17928786bdb5 74 /// can then interact with other hardware.
WiredHome 3:17928786bdb5 75 /// @li Revised to be Non-blocking, however the execution time is variable
WiredHome 7:99ad7a67f05e 76 /// depending on the actions being performed and can span hundreds of msec.
WiredHome 3:17928786bdb5 77 ///
WiredHome 3:17928786bdb5 78 /// Limitations:
WiredHome 3:17928786bdb5 79 /// @li Supports only a single connection at a time.
WiredHome 18:6199558632c0 80 /// A web page with served objects (img src=...) is rarely served properly. It
WiredHome 18:6199558632c0 81 /// might trace to forcing the connection to close, but not yet sure.
WiredHome 18:6199558632c0 82 /// Explore "Set Uart Rx Data Buffer" in WiFly manual 2.3.65.
WiredHome 18:6199558632c0 83 /// This is a limitation of the Wifly module. No solution is forthcoming,
WiredHome 18:6199558632c0 84 /// so a simple workaround is to use javascript to load the images after
WiredHome 18:6199558632c0 85 /// the page loads.
WiredHome 3:17928786bdb5 86 /// @li Rapid requests for page objects (e.g. embedded images) are lost. Still
WiredHome 3:17928786bdb5 87 /// working to understand this issue.
WiredHome 3:17928786bdb5 88 ///
WiredHome 18:6199558632c0 89 /// Improvements:
WiredHome 18:6199558632c0 90 /// @li hunted down several lengthy operations - the speed of the file system
WiredHome 18:6199558632c0 91 /// and the "close" operation which requires <delay 0.25s>$$$<delay>close\r.
WiredHome 18:6199558632c0 92 /// @li parses the header similar to the query string, and then makes
WiredHome 18:6199558632c0 93 /// those parameters accessible.
WiredHome 18:6199558632c0 94 /// @li Added basic password capability to dynamic web pages.
WiredHome 18:6199558632c0 95 ///
WiredHome 3:17928786bdb5 96 /// ToDo:
WiredHome 3:17928786bdb5 97 /// @li move part of the POST method handler to the registered handler, so
WiredHome 0:729320f63c5c 98 /// it can decide if it should allocate the needed memory.
WiredHome 3:17928786bdb5 99 /// @li transform the pc serial interface to a log interface, which might
WiredHome 0:729320f63c5c 100 /// be more useful.
WiredHome 3:17928786bdb5 101 /// @li Add ability to put WiFly in AP mode and then configuration pages
WiredHome 2:a29c32190037 102 /// to find and join a network.
WiredHome 3:17928786bdb5 103 /// @li Add ability to change/update SW in the WiFly module
WiredHome 3:17928786bdb5 104 /// @li Add ability to upload a new application to the mbed
WiredHome 2:a29c32190037 105 ///
WiredHome 2:a29c32190037 106 /// History:
WiredHome 2:a29c32190037 107 /// @li 20130530 Initial version
WiredHome 2:a29c32190037 108 /// @li 20130601 Renamed ip_process to Poll
WiredHome 3:17928786bdb5 109 /// @li 20130617 Cleaned up some of the documentation changes
WiredHome 3:17928786bdb5 110 /// @li 20130623 Make it non-blocking. "Poll" takes a variable amount
WiredHome 3:17928786bdb5 111 /// of time, based on whether it is idle, or how much it
WiredHome 3:17928786bdb5 112 /// has to do.
WiredHome 18:6199558632c0 113 /// @li 20130911 Lots of incremental changes along this way, this update
WiredHome 18:6199558632c0 114 /// refreshes the documentation.
WiredHome 0:729320f63c5c 115 ///
WiredHome 0:729320f63c5c 116 /// @note Copyright &copy; 2013 by Smartware Computing, all rights reserved.
WiredHome 0:729320f63c5c 117 /// Individuals may use this application for evaluation or non-commercial
WiredHome 0:729320f63c5c 118 /// purposes. Within this restriction, changes may be made to this application
WiredHome 0:729320f63c5c 119 /// as long as this copyright notice is retained. The user shall make
WiredHome 0:729320f63c5c 120 /// clear that their work is a derived work, and not the original.
WiredHome 0:729320f63c5c 121 /// Users of this application and sources accept this application "as is" and
WiredHome 0:729320f63c5c 122 /// shall hold harmless Smartware Computing, for any undesired results while
WiredHome 0:729320f63c5c 123 /// using this application - whether real or imagined.
WiredHome 0:729320f63c5c 124 ///
WiredHome 0:729320f63c5c 125 /// @author David Smart, Smartware Computing
WiredHome 0:729320f63c5c 126 ///
WiredHome 0:729320f63c5c 127 class HTTPServer
WiredHome 0:729320f63c5c 128 {
WiredHome 0:729320f63c5c 129 public:
WiredHome 0:729320f63c5c 130 /**
WiredHome 3:17928786bdb5 131 * name-value pairs for parameters
WiredHome 0:729320f63c5c 132 */
WiredHome 3:17928786bdb5 133 typedef struct NAMEVALUE {
WiredHome 0:729320f63c5c 134 char * name;
WiredHome 0:729320f63c5c 135 char * value;
WiredHome 0:729320f63c5c 136 } namevalue;
WiredHome 12:109bf1558300 137
WiredHome 2:a29c32190037 138 /**
WiredHome 3:17928786bdb5 139 * Indicates the purpose of the Handler callback
WiredHome 3:17928786bdb5 140 *
WiredHome 12:109bf1558300 141 * Application code in a dynamic page uses this to determine the state
WiredHome 3:17928786bdb5 142 * and therefore the needed operation to be performed.
WiredHome 3:17928786bdb5 143 *
WiredHome 3:17928786bdb5 144 * @code
WiredHome 13:8975d7928678 145 * bool SimpleDynamicPage(HTTPServer *svr, HTTPServer::CallBackType type,
WiredHome 13:8975d7928678 146 * const char * path, const HTTPServer::namevalue *queryParams,
WiredHome 13:8975d7928678 147 * int queryParamCount) {
WiredHome 3:17928786bdb5 148 * char buf[100];
WiredHome 3:17928786bdb5 149 * bool ret = false;
WiredHome 12:109bf1558300 150 *
WiredHome 3:17928786bdb5 151 * switch (type) {
WiredHome 3:17928786bdb5 152 * case HTTPServer::SEND_PAGE:
WiredHome 3:17928786bdb5 153 * svr->header(200, "OK", "Content-Type: text/html\r\n");
WiredHome 3:17928786bdb5 154 * svr->send("<html><head><title>Dynamic Page</title></head>\r\n");
WiredHome 3:17928786bdb5 155 * svr->send("<body>\r\n");
WiredHome 3:17928786bdb5 156 * svr->send("This page was generated dynamically. Create your own name=value pairs on the URL "
WiredHome 3:17928786bdb5 157 * "which uses the GET method.<br/>\r\n");
WiredHome 13:8975d7928678 158 * sprintf(buf, "%d parameters passed to {%s}:<br/>\r\n", queryParamCount, path);
WiredHome 3:17928786bdb5 159 * svr->send(buf);
WiredHome 13:8975d7928678 160 * for (int i=0; i<queryParamCount; i++) {
WiredHome 13:8975d7928678 161 * sprintf(buf, "%d: %s = %s<br/>\r\n", i, queryParams[i].name, queryParams[i].value);
WiredHome 3:17928786bdb5 162 * svr->send(buf);
WiredHome 3:17928786bdb5 163 * }
WiredHome 3:17928786bdb5 164 * svr->send("<br/><a href='/'>back to main</a></body></html>\r\n");
WiredHome 3:17928786bdb5 165 * ret = true;
WiredHome 3:17928786bdb5 166 * break;
WiredHome 3:17928786bdb5 167 * case HTTPServer::CONTENT_LENGTH_REQUEST:
WiredHome 3:17928786bdb5 168 * ret = true;
WiredHome 3:17928786bdb5 169 * break;
WiredHome 3:17928786bdb5 170 * case HTTPServer::DATA_TRANSFER:
WiredHome 3:17928786bdb5 171 * ret = true;
WiredHome 3:17928786bdb5 172 * break;
WiredHome 3:17928786bdb5 173 * default:
WiredHome 3:17928786bdb5 174 * ret = false;
WiredHome 3:17928786bdb5 175 * break;
WiredHome 3:17928786bdb5 176 * }
WiredHome 3:17928786bdb5 177 * return ret;
WiredHome 3:17928786bdb5 178 * }
WiredHome 3:17928786bdb5 179 * @endcode
WiredHome 2:a29c32190037 180 */
WiredHome 3:17928786bdb5 181 typedef enum CALLBACKTYPE {
WiredHome 14:19c5f6151319 182 CONTENT_LENGTH_REQUEST, ///< ask the client if they wish to accept the data, typically from a POST event
WiredHome 3:17928786bdb5 183 DATA_TRANSFER, ///< not currently used, may allow "chunking" the data to the client
WiredHome 3:17928786bdb5 184 SEND_PAGE, ///< the activated method should now send the page
WiredHome 2:a29c32190037 185 } CallBackType;
WiredHome 0:729320f63c5c 186
WiredHome 12:109bf1558300 187 /**
WiredHome 3:17928786bdb5 188 * This is the prototype for custom handlers that are activated via a callback
WiredHome 0:729320f63c5c 189 *
WiredHome 3:17928786bdb5 190 * This callback gets overloaded for a few purposes, which can be identified by the \see CallBackType parameter
WiredHome 12:109bf1558300 191 * @li SEND_PAGE - the callback should now send the html page, using as many svr->send() as needed.
WiredHome 2:a29c32190037 192 * When the callback returns, it should always indicate true.
WiredHome 2:a29c32190037 193 * @li CONTENT_LENGTH_REQUEST - the server is asking the callback if it wants to receive the message,
WiredHome 2:a29c32190037 194 * which may require significant memory. If the request is accepted, true should be returned.
WiredHome 2:a29c32190037 195 * If the request is denied, false should be returned.
WiredHome 12:109bf1558300 196 *
WiredHome 0:729320f63c5c 197 * @param svr is a handle to this class, so the callback has access to member functions
WiredHome 13:8975d7928678 198 * @param queryParams is a pointer to an array of name value pairs
WiredHome 13:8975d7928678 199 * @queryParamCount is the number of parameters.
WiredHome 2:a29c32190037 200 * @return true if command was accepted
WiredHome 0:729320f63c5c 201 */
WiredHome 13:8975d7928678 202 typedef bool (* Handler)(HTTPServer * svr, CallBackType type, const char *path, const namevalue *queryParams, int queryParamCount);
WiredHome 12:109bf1558300 203
WiredHome 0:729320f63c5c 204 /**
WiredHome 0:729320f63c5c 205 * Create the HTTPServer object.
WiredHome 12:109bf1558300 206 *
WiredHome 0:729320f63c5c 207 * @param wifly is the serial port with the wifly interface.
WiredHome 0:729320f63c5c 208 * @param port is the optional parameter for the port number to use, default is 80.
WiredHome 0:729320f63c5c 209 * @param webroot is a file system path to the root folder for the web space.
WiredHome 13:8975d7928678 210 * @param maxheaderParams defines the maximum number of parameters to extract from a header (Host: 192..\r\nConnection: keep-alive\r\n...)
WiredHome 13:8975d7928678 211 * @param maxqueryParams defines the maximum number of query parameters to a dynamic function (and the memory to support them).
WiredHome 0:729320f63c5c 212 * @param maxdynamicpages defines the maximum number of dynamic pages that can be registered.
WiredHome 0:729320f63c5c 213 * @param pc is the serial port for debug information (I should transform this to a log interface)
WiredHome 3:17928786bdb5 214 * @param allocforheader is the memory allocation to support the largest expected header from a client
WiredHome 12:109bf1558300 215 * @param allocforfile is the memory allocation to support sending a file to the client. This is typically sized to fit
WiredHome 3:17928786bdb5 216 * an ethernet frame.
WiredHome 0:729320f63c5c 217 */
WiredHome 13:8975d7928678 218 HTTPServer(Wifly * wifly, int port = 80, const char * webroot = "/", int maxheaderParams = 15, int maxqueryParams = 30, int maxdynamicpages = 10,
WiredHome 12:109bf1558300 219 PC * pc = NULL, int _allocforheader = MAX_HEADER_SIZE, int _allocforfile = FILESEND_BUF_SIZE);
WiredHome 12:109bf1558300 220
WiredHome 0:729320f63c5c 221 /**
WiredHome 3:17928786bdb5 222 * Destructor, which can clean up memory.
WiredHome 0:729320f63c5c 223 */
WiredHome 0:729320f63c5c 224 ~HTTPServer();
WiredHome 12:109bf1558300 225
WiredHome 0:729320f63c5c 226 /**
WiredHome 3:17928786bdb5 227 * The process to call whenever there is free time, as this basically does
WiredHome 0:729320f63c5c 228 * all the work to monitor for connections and handle replies.
WiredHome 2:a29c32190037 229 *
WiredHome 2:a29c32190037 230 * 20130601 Renamed from ip_process to Poll
WiredHome 0:729320f63c5c 231 */
WiredHome 2:a29c32190037 232 void Poll();
WiredHome 12:109bf1558300 233
WiredHome 0:729320f63c5c 234 /**
WiredHome 12:109bf1558300 235 * Send typical header data, and some optional data back to the client.
WiredHome 3:17928786bdb5 236 *
WiredHome 3:17928786bdb5 237 * This forms and sends the typical header back to the client. It may also send
WiredHome 3:17928786bdb5 238 * optional data (which must end with "\r\n"). It then sends the second newline
WiredHome 3:17928786bdb5 239 * sequence that signals the end of the header.
WiredHome 0:729320f63c5c 240 *
WiredHome 0:729320f63c5c 241 * @param code is the optional return code; 200 = OK, if not provided then 404 = Not found is returned
WiredHome 0:729320f63c5c 242 * @param code_text is the text to align with the code (e.g. 404, "Not Found")
WiredHome 0:729320f63c5c 243 * @param content_type is a pointer to "Content-Type: text/html\r\n" (for example)
WiredHome 3:17928786bdb5 244 * @param optional_text is a pointer to any other text that is part of the header, which must
WiredHome 3:17928786bdb5 245 * have \r\n termination.
WiredHome 0:729320f63c5c 246 */
WiredHome 0:729320f63c5c 247 void header(int code = 404, const char * code_text = "Not Found", const char * content_type = NULL, const char * optional_text = NULL);
WiredHome 0:729320f63c5c 248
WiredHome 0:729320f63c5c 249 /**
WiredHome 0:729320f63c5c 250 * Send text to the client
WiredHome 0:729320f63c5c 251 *
WiredHome 3:17928786bdb5 252 * This sends the specified text to the client. If the number of bytes is not set,
WiredHome 3:17928786bdb5 253 * then it calculates the number of bytes as a string. For binary transfers, the
WiredHome 3:17928786bdb5 254 * number of bytes to send is required for proper operation.
WiredHome 3:17928786bdb5 255 *
WiredHome 0:729320f63c5c 256 * @param msg is the text string to send
WiredHome 0:729320f63c5c 257 * @param bytes is the number of bytes to send. If not set, then strlen is calculated.
WiredHome 0:729320f63c5c 258 */
WiredHome 0:729320f63c5c 259 void send(const char * msg, int bytes = -1);
WiredHome 12:109bf1558300 260
WiredHome 0:729320f63c5c 261 /**
WiredHome 3:17928786bdb5 262 * Send a referenced file to the client, including the header
WiredHome 3:17928786bdb5 263 *
WiredHome 3:17928786bdb5 264 * This sends a file from the filesystem to the client. It must be of a supported type
WiredHome 3:17928786bdb5 265 * in order to properly create the header.
WiredHome 0:729320f63c5c 266 *
WiredHome 0:729320f63c5c 267 * @param filename is the fully qualified path and filename
WiredHome 3:17928786bdb5 268 * @param filetype is the header information (e.g. "Content-Type: application/pdf")
WiredHome 0:729320f63c5c 269 * @return true if it thinks it sent ok, false otherwise.
WiredHome 0:729320f63c5c 270 */
WiredHome 0:729320f63c5c 271 bool SendFile(const char * filename, const char * filetype);
WiredHome 12:109bf1558300 272
WiredHome 12:109bf1558300 273 /**
WiredHome 0:729320f63c5c 274 * register a handler for a specific URL.
WiredHome 0:729320f63c5c 275 *
WiredHome 3:17928786bdb5 276 * This api lets you register a dynamic handler in the web server. This is
WiredHome 3:17928786bdb5 277 * most useful for interactive web pages, rather than simply serving static
WiredHome 3:17928786bdb5 278 * pages.
WiredHome 3:17928786bdb5 279 *
WiredHome 3:17928786bdb5 280 * @code
WiredHome 12:109bf1558300 281 *
WiredHome 3:17928786bdb5 282 * ...
WiredHome 3:17928786bdb5 283 * svr.RegisterHandler("/dyn1", SimpleDynamicPage);svr.RegisterHandler("/dyn1", SimpleDynamicPage);
WiredHome 3:17928786bdb5 284 * ...
WiredHome 3:17928786bdb5 285 *
WiredHome 13:8975d7928678 286 * bool SimpleDynamicPage(HTTPServer *svr, HTTPServer::CallBackType type, const char * path, const HTTPServer::namevalue *queryParams, int queryParamCount) {
WiredHome 3:17928786bdb5 287 * char buf[100];
WiredHome 3:17928786bdb5 288 * bool ret = false;
WiredHome 12:109bf1558300 289 *
WiredHome 3:17928786bdb5 290 * switch (type) {
WiredHome 3:17928786bdb5 291 * case HTTPServer::SEND_PAGE:
WiredHome 3:17928786bdb5 292 * svr->header(200, "OK", "Content-Type: text/html\r\n");
WiredHome 3:17928786bdb5 293 * svr->send("<html><head><title>Dynamic Page</title></head>\r\n");
WiredHome 3:17928786bdb5 294 * svr->send("<body>\r\n");
WiredHome 3:17928786bdb5 295 * svr->send("This page was generated dynamically. Create your own name=value pairs on the URL "
WiredHome 3:17928786bdb5 296 * "which uses the GET method.<br/>\r\n");
WiredHome 13:8975d7928678 297 * sprintf(buf, "%d parameters passed to {%s}:<br/>\r\n", queryParamCount, path);
WiredHome 3:17928786bdb5 298 * svr->send(buf);
WiredHome 13:8975d7928678 299 * for (int i=0; i<queryParamCount; i++) {
WiredHome 13:8975d7928678 300 * sprintf(buf, "%d: %s = %s<br/>\r\n", i, queryParams[i].name, queryParams[i].value);
WiredHome 3:17928786bdb5 301 * svr->send(buf);
WiredHome 3:17928786bdb5 302 * }
WiredHome 3:17928786bdb5 303 * svr->send("Stats:<br/>\r\n");
WiredHome 3:17928786bdb5 304 * sprintf(buf,"Free memory space: %d<br/>\r\n", Free());
WiredHome 3:17928786bdb5 305 * svr->send(buf);
WiredHome 3:17928786bdb5 306 * sprintf(buf,"Max Header size: %d<br/>\r\n", svr->GetMaxHeaderSize());
WiredHome 3:17928786bdb5 307 * svr->send(buf);
WiredHome 3:17928786bdb5 308 * svr->send("<br/><a href='/'>back to main</a></body></html>\r\n");
WiredHome 3:17928786bdb5 309 * ret = true;
WiredHome 3:17928786bdb5 310 * break;
WiredHome 3:17928786bdb5 311 * case HTTPServer::CONTENT_LENGTH_REQUEST:
WiredHome 3:17928786bdb5 312 * ret = true;
WiredHome 3:17928786bdb5 313 * break;
WiredHome 3:17928786bdb5 314 * case HTTPServer::DATA_TRANSFER:
WiredHome 3:17928786bdb5 315 * ret = true;
WiredHome 3:17928786bdb5 316 * break;
WiredHome 3:17928786bdb5 317 * default:
WiredHome 3:17928786bdb5 318 * ret = false;
WiredHome 3:17928786bdb5 319 * break;
WiredHome 3:17928786bdb5 320 * }
WiredHome 3:17928786bdb5 321 * return ret;
WiredHome 3:17928786bdb5 322 * }
WiredHome 3:17928786bdb5 323 * @endcode
WiredHome 3:17928786bdb5 324 *
WiredHome 0:729320f63c5c 325 * @param path to register
WiredHome 0:729320f63c5c 326 * @param callback of type Handler
WiredHome 0:729320f63c5c 327 * @return true if successfully registered
WiredHome 0:729320f63c5c 328 */
WiredHome 0:729320f63c5c 329 bool RegisterHandler(const char * path, Handler callback);
WiredHome 12:109bf1558300 330
WiredHome 0:729320f63c5c 331 /**
WiredHome 16:6ebacf2946d8 332 * determine if the named file is a supported type (htm, html, jpg, etc)
WiredHome 0:729320f63c5c 333 *
WiredHome 3:17928786bdb5 334 * if you pass in a filename, it will attempt to extract the extension
WiredHome 3:17928786bdb5 335 * and compare that to the list of supported file types. If it finds a
WiredHome 3:17928786bdb5 336 * match, then it will return a pointer to the content-type string.
WiredHome 3:17928786bdb5 337 *
WiredHome 3:17928786bdb5 338 * @code
WiredHome 3:17928786bdb5 339 * fType = GetSupportedType("mypix.jpg");
WiredHome 3:17928786bdb5 340 * if (fType) {
WiredHome 3:17928786bdb5 341 * ...
WiredHome 3:17928786bdb5 342 * @endcode
WiredHome 12:109bf1558300 343 *
WiredHome 0:729320f63c5c 344 * @param filename is the filename to test, based on the extension
WiredHome 0:729320f63c5c 345 * @return pointer to a Content-Type string if supported, or NULL if not.
WiredHome 0:729320f63c5c 346 */
WiredHome 0:729320f63c5c 347 const char * GetSupportedType(const char * filename);
WiredHome 0:729320f63c5c 348
WiredHome 0:729320f63c5c 349 /**
WiredHome 0:729320f63c5c 350 * search the available parameters for 'name' and if found, return the 'value'
WiredHome 0:729320f63c5c 351 *
WiredHome 12:109bf1558300 352 * After the querystring is parsed, the server maintains an array of
WiredHome 3:17928786bdb5 353 * name=value pairs. This Get function will search for the passed in name
WiredHome 3:17928786bdb5 354 * and provide access to the value.
WiredHome 3:17928786bdb5 355 *
WiredHome 3:17928786bdb5 356 * @code
WiredHome 3:17928786bdb5 357 * BusOut leds(LED1,LED2,LED3,LED4);
WiredHome 3:17928786bdb5 358 * ...
WiredHome 3:17928786bdb5 359 * leds = atoi(svr->GetParameter("leds"));
WiredHome 3:17928786bdb5 360 * @endcode
WiredHome 3:17928786bdb5 361 *
WiredHome 0:729320f63c5c 362 * @param name is the name to search for
WiredHome 0:729320f63c5c 363 * @return pointer to the value, or NULL
WiredHome 0:729320f63c5c 364 */
WiredHome 0:729320f63c5c 365 const char * GetParameter(const char * name);
WiredHome 0:729320f63c5c 366
WiredHome 0:729320f63c5c 367 /**
WiredHome 12:109bf1558300 368 * Parse the text string into name=value parameters.
WiredHome 3:17928786bdb5 369 *
WiredHome 12:109bf1558300 370 * This will directly modify the referenced string. If there is a
WiredHome 3:17928786bdb5 371 * #fragment_id on the end of the string, it will be removed.
WiredHome 0:729320f63c5c 372 *
WiredHome 0:729320f63c5c 373 * @param pString is a pointer to the string.
WiredHome 0:729320f63c5c 374 */
WiredHome 0:729320f63c5c 375 void ParseParameters(char * pString);
WiredHome 12:109bf1558300 376
WiredHome 0:729320f63c5c 377 /**
WiredHome 16:6ebacf2946d8 378 * Unescape string converts a coded string "in place" into a normal string.
WiredHome 3:17928786bdb5 379 *
WiredHome 3:17928786bdb5 380 * A query string will have a number of characters replaced for communication
WiredHome 3:17928786bdb5 381 * which includes spaces, quotes, question marks and more. Most of them
WiredHome 12:109bf1558300 382 * will be replaced with a %xx format, where xx is the hex code for the
WiredHome 3:17928786bdb5 383 * character. Since the string will only get shorter when this happens
WiredHome 3:17928786bdb5 384 * the operation is performed in place.
WiredHome 3:17928786bdb5 385 *
WiredHome 0:729320f63c5c 386 * this "This%20is%20a%20question%3F%20and%20an%20answer."
WiredHome 12:109bf1558300 387 *
WiredHome 0:729320f63c5c 388 * becomes "This is a question? and an answer."
WiredHome 3:17928786bdb5 389 *
WiredHome 0:729320f63c5c 390 * @note '+' is another form of space, so is converted to a space before the %xx
WiredHome 0:729320f63c5c 391 *
WiredHome 0:729320f63c5c 392 * @param encoded string to be converted
WiredHome 0:729320f63c5c 393 */
WiredHome 0:729320f63c5c 394 void UnescapeString(char * encoded);
WiredHome 12:109bf1558300 395
WiredHome 0:729320f63c5c 396 /**
WiredHome 0:729320f63c5c 397 * Get the IP address of the remote node to which we are connected.
WiredHome 3:17928786bdb5 398 *
WiredHome 3:17928786bdb5 399 * This will get the IP address of the remote node to which we are
WiredHome 12:109bf1558300 400 * currently connected. This is written into the buffer in
WiredHome 3:17928786bdb5 401 * "192.168.100.234" format. If the buffer size is note >= 16 bytes,
WiredHome 3:17928786bdb5 402 * it will set the buffer to null.
WiredHome 12:109bf1558300 403 *
WiredHome 3:17928786bdb5 404 * @note This switches the module into, and out of, command mode
WiredHome 12:109bf1558300 405 * which has quite a time penalty.
WiredHome 3:17928786bdb5 406 *
WiredHome 3:17928786bdb5 407 * @param str is the string to write the address into, which should be at
WiredHome 3:17928786bdb5 408 * least as large as "192.168.100.203" (16-bytes).
WiredHome 4:f34642902056 409 * @param strSize of the str buffer must be >=16, so it will not buffer overrun.
WiredHome 5:c9b27e718054 410 * @returns true if it succeeded, false otherwise
WiredHome 0:729320f63c5c 411 */
WiredHome 5:c9b27e718054 412 bool GetRemoteAddr(char * str, int strSize);
WiredHome 0:729320f63c5c 413
WiredHome 12:109bf1558300 414 /**
WiredHome 16:6ebacf2946d8 415 * This is used to force a connection to close.
WiredHome 3:17928786bdb5 416 *
WiredHome 3:17928786bdb5 417 * This switches the module into command mode, performs the close,
WiredHome 3:17928786bdb5 418 * then switches it back to data mode. So, this is a time-expensive
WiredHome 3:17928786bdb5 419 * command.
WiredHome 7:99ad7a67f05e 420 *
WiredHome 7:99ad7a67f05e 421 * @returns true if successful
WiredHome 0:729320f63c5c 422 */
WiredHome 7:99ad7a67f05e 423 bool close_connection();
WiredHome 12:109bf1558300 424
WiredHome 3:17928786bdb5 425 /**
WiredHome 16:6ebacf2946d8 426 * Diagnostic to get the size of the largest header.
WiredHome 3:17928786bdb5 427 *
WiredHome 12:109bf1558300 428 * This is a diagnostic function, so you can resize the allocated
WiredHome 12:109bf1558300 429 * buffer for your application. With proper sizing, more of the
WiredHome 3:17928786bdb5 430 * system memory is available for your application.
WiredHome 3:17928786bdb5 431 *
WiredHome 3:17928786bdb5 432 * @code
WiredHome 3:17928786bdb5 433 * sprintf(buf,"Max Header size: %d<br/>\r\n", svr->GetMaxHeaderSize());
WiredHome 3:17928786bdb5 434 * svr->send(buf);
WiredHome 3:17928786bdb5 435 * @endcode
WiredHome 12:109bf1558300 436 *
WiredHome 3:17928786bdb5 437 * @returns size in bytes of the larger header measured.
WiredHome 3:17928786bdb5 438 */
WiredHome 3:17928786bdb5 439 int GetMaxHeaderSize();
WiredHome 3:17928786bdb5 440
WiredHome 13:8975d7928678 441 /**
WiredHome 16:6ebacf2946d8 442 * Get a value from the http header, if it exists.
WiredHome 13:8975d7928678 443 *
WiredHome 13:8975d7928678 444 * @param hdr is the string to search for (e.g. "Content-Length")
WiredHome 13:8975d7928678 445 *
WiredHome 13:8975d7928678 446 * @returns pointer to the value associated with that header.
WiredHome 13:8975d7928678 447 * @returns NULL if the header is not found.
WiredHome 13:8975d7928678 448 */
WiredHome 13:8975d7928678 449 const char * GetHeaderValue(const char * hdr);
WiredHome 3:17928786bdb5 450
WiredHome 3:17928786bdb5 451 /**
WiredHome 3:17928786bdb5 452 * Performance parameter
WiredHome 3:17928786bdb5 453 */
WiredHome 3:17928786bdb5 454 typedef struct SW_PERFPARAM {
WiredHome 3:17928786bdb5 455 unsigned long long TotalTime_us;
WiredHome 3:17928786bdb5 456 unsigned long Samples;
WiredHome 3:17928786bdb5 457 unsigned long MaxTime_us;
WiredHome 3:17928786bdb5 458 } SW_PerformanceParam;
WiredHome 12:109bf1558300 459
WiredHome 3:17928786bdb5 460 /**
WiredHome 3:17928786bdb5 461 * Performance metrics
WiredHome 3:17928786bdb5 462 */
WiredHome 3:17928786bdb5 463 typedef struct SW_PERFDATA {
WiredHome 17:69ff00ce39f4 464 SW_PerformanceParam ConnectionAccepted;
WiredHome 17:69ff00ce39f4 465 SW_PerformanceParam HeaderParsed;
WiredHome 17:69ff00ce39f4 466 SW_PerformanceParam ResponseSent;
WiredHome 17:69ff00ce39f4 467 SW_PerformanceParam ConnectionClosed;
WiredHome 3:17928786bdb5 468 //SW_PerformanceParam SendFile;
WiredHome 3:17928786bdb5 469 } SW_PerformanceData;
WiredHome 12:109bf1558300 470
WiredHome 3:17928786bdb5 471 /**
WiredHome 3:17928786bdb5 472 * Get performance metrics from the web server.
WiredHome 3:17928786bdb5 473 *
WiredHome 3:17928786bdb5 474 * This is a diagnostic function, and gathers data on the internal
WiredHome 3:17928786bdb5 475 * performance of the server, as it works various actions.
WiredHome 3:17928786bdb5 476 *
WiredHome 3:17928786bdb5 477 * @param p is a pointer to a SW_PerformanceData structure to be populated
WiredHome 3:17928786bdb5 478 */
WiredHome 3:17928786bdb5 479 void GetPerformanceData(SW_PerformanceData * p);
WiredHome 12:109bf1558300 480
WiredHome 3:17928786bdb5 481 /**
WiredHome 3:17928786bdb5 482 * Reset performance metrics.
WiredHome 3:17928786bdb5 483 */
WiredHome 3:17928786bdb5 484 void ResetPerformanceData();
WiredHome 17:69ff00ce39f4 485
WiredHome 17:69ff00ce39f4 486 /**
WiredHome 17:69ff00ce39f4 487 * Get performance clock
WiredHome 17:69ff00ce39f4 488 */
WiredHome 17:69ff00ce39f4 489 unsigned int GetPerformanceClock();
WiredHome 12:109bf1558300 490
WiredHome 5:c9b27e718054 491 /**
WiredHome 5:c9b27e718054 492 * Get the underlying wifly object.
WiredHome 6:fdce4464d92b 493 *
WiredHome 6:fdce4464d92b 494 * This lets you get to the underlying wifly object in order to
WiredHome 6:fdce4464d92b 495 * interact with it.
WiredHome 6:fdce4464d92b 496 *
WiredHome 6:fdce4464d92b 497 * @code
WiredHome 13:8975d7928678 498 * HTTPServer svr(&wifly, HTTP_SERVER_PORT, "/local/", 15, 30, 10, &pc);
WiredHome 6:fdce4464d92b 499 * ...
WiredHome 6:fdce4464d92b 500 * svr->GetWifly()->getWiflyVerString()
WiredHome 6:fdce4464d92b 501 * @endcode
WiredHome 6:fdce4464d92b 502 *
WiredHome 6:fdce4464d92b 503 * returns the wifly option.
WiredHome 5:c9b27e718054 504 */
WiredHome 12:109bf1558300 505 Wifly * GetWifly() {
WiredHome 12:109bf1558300 506 return wifly;
WiredHome 12:109bf1558300 507 };
WiredHome 0:729320f63c5c 508
WiredHome 0:729320f63c5c 509 private:
WiredHome 0:729320f63c5c 510 Wifly * wifly;
WiredHome 0:729320f63c5c 511 char * webroot;
WiredHome 0:729320f63c5c 512 PC * pc;
WiredHome 0:729320f63c5c 513 TCPSocketServer * server;
WiredHome 0:729320f63c5c 514 TCPSocketConnection client;
WiredHome 0:729320f63c5c 515 char * rewriteWithDefaultFile(char * queryString);
WiredHome 0:729320f63c5c 516 char * rewritePrependWebroot(char * queryString);
WiredHome 13:8975d7928678 517
WiredHome 13:8975d7928678 518 namevalue *queryParams; // Query Parameters from the URL this=that&sky=blue&...
WiredHome 13:8975d7928678 519 int maxqueryParams;
WiredHome 13:8975d7928678 520 int queryParamCount;
WiredHome 13:8975d7928678 521
WiredHome 13:8975d7928678 522 namevalue *headerParams; // Header params Host: 192.168...\r\nConnection: keep-alive\r\n...
WiredHome 13:8975d7928678 523 int maxheaderParams;
WiredHome 13:8975d7928678 524 int headerParamCount;
WiredHome 13:8975d7928678 525
WiredHome 3:17928786bdb5 526 int maxheaderbytes;
WiredHome 3:17928786bdb5 527 char * headerbuffer;
WiredHome 3:17928786bdb5 528 int headerbuffersize;
WiredHome 12:109bf1558300 529
WiredHome 10:9c8d2c6a3469 530 Timer PerformanceTimer;
WiredHome 3:17928786bdb5 531 /**
WiredHome 3:17928786bdb5 532 * Records performance data
WiredHome 12:109bf1558300 533 *
WiredHome 3:17928786bdb5 534 * This will take a pointer to a SW_PerformanceParam, and it will
WiredHome 3:17928786bdb5 535 * take the time when the performance measurement started. It locally
WiredHome 3:17928786bdb5 536 * accesses the current time to measure the elapsed.
WiredHome 3:17928786bdb5 537 *
WiredHome 3:17928786bdb5 538 * @param param is the performance parameter to update
WiredHome 3:17928786bdb5 539 * @param value is the reference time.
WiredHome 3:17928786bdb5 540 * @returns the current time which may be used as the reference time
WiredHome 3:17928786bdb5 541 * for further measurements.
WiredHome 3:17928786bdb5 542 */
WiredHome 16:6ebacf2946d8 543 unsigned int RecordPerformanceData(SW_PerformanceParam * param, unsigned int value);
WiredHome 3:17928786bdb5 544 SW_PerformanceData perfData;
WiredHome 12:109bf1558300 545
WiredHome 3:17928786bdb5 546 typedef struct HANDLER {
WiredHome 0:729320f63c5c 547 char * path;
WiredHome 0:729320f63c5c 548 Handler callback;
WiredHome 0:729320f63c5c 549 } handler;
WiredHome 0:729320f63c5c 550 int maxdynamicpages;
WiredHome 0:729320f63c5c 551 handler *handlers;
WiredHome 0:729320f63c5c 552 int handlercount;
WiredHome 3:17928786bdb5 553
WiredHome 3:17928786bdb5 554 char * queryType;
WiredHome 3:17928786bdb5 555 char * queryString;
WiredHome 13:8975d7928678 556 // char * hostString;
WiredHome 13:8975d7928678 557 // char * contentLength;
WiredHome 13:8975d7928678 558 // char * contentType;
WiredHome 13:8975d7928678 559 // char * authorization;
WiredHome 3:17928786bdb5 560 char * postQueryString;
WiredHome 12:109bf1558300 561
WiredHome 0:729320f63c5c 562 /**
WiredHome 8:262583f054f6 563 * Extract the parameter from the record, by searching for the needle in the haystack.
WiredHome 8:262583f054f6 564 *
WiredHome 8:262583f054f6 565 * The parameter of interest follows the needle, and may be ' ' delimited
WiredHome 0:729320f63c5c 566 * Can damage haystack while processing it.
WiredHome 0:729320f63c5c 567 *
WiredHome 0:729320f63c5c 568 * @param haystack is the record to search
WiredHome 0:729320f63c5c 569 * @param needle is the text to search for, which precedes the text to return
WiredHome 0:729320f63c5c 570 * @param string is the text following the needle
WiredHome 0:729320f63c5c 571 * @return true if it extracted something successfully
WiredHome 0:729320f63c5c 572 */
WiredHome 0:729320f63c5c 573 bool Extract(char * rec, char * needle, char ** string);
WiredHome 0:729320f63c5c 574
WiredHome 3:17928786bdb5 575 void SendResponse();
WiredHome 3:17928786bdb5 576 bool ParseHeader(char * bPtr);
WiredHome 3:17928786bdb5 577 bool CheckDynamicHandlers();
WiredHome 3:17928786bdb5 578
WiredHome 0:729320f63c5c 579 int HexCharToInt(char c);
WiredHome 0:729320f63c5c 580 char HexPairToChar(char * p);
WiredHome 0:729320f63c5c 581 };
WiredHome 0:729320f63c5c 582 #endif //SW_HTTPSERVER_H
WiredHome 4:f34642902056 583
WiredHome 7:99ad7a67f05e 584