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@36:1bb5fa6b109c, 2014-05-02 (annotated)

Committer:
WiredHome
Date:
Fri May 02 00:26:06 2014 +0000
Revision:
36:1bb5fa6b109c
Parent:
33:ef165a67ab22
Child:
37:0cb2774e2410
Small update to disable DEBUG output and to swap from modserial to RawSerial.

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