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@27:90a1f5a5392f, 2013-10-10 (annotated)

Committer:
WiredHome
Date:
Thu Oct 10 20:38:12 2013 +0000
Revision:
27:90a1f5a5392f
Parent:
24:062431453abb
Child:
28:f93ef41b78e1
Diagnostic improvements.

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