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@38:c8fa31e6fe02, 2014-07-26 (annotated)

Committer:
WiredHome
Date:
Sat Jul 26 19:49:13 2014 +0000
Revision:
38:c8fa31e6fe02
Parent:
37:0cb2774e2410
Child:
39:0427544a5c08
Starting to remove Wifly dependence.; The last is the published stable version, this one is experimental.

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