HTTPClient.h

00001 /* HTTPClient.h */
00002 /* Copyright (C) 2012 mbed.org, MIT License
00003  *
00004  * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
00005  * and associated documentation files (the "Software"), to deal in the Software without restriction,
00006  * including without limitation the rights to use, copy, modify, merge, publish, distribute,
00007  * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
00008  * furnished to do so, subject to the following conditions:
00009  *
00010  * The above copyright notice and this permission notice shall be included in all copies or
00011  * substantial portions of the Software.
00012  *
00013  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
00014  * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
00015  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
00016  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00017  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
00018  */
00019 
00020 /** \file
00021 HTTP Client header file
00022 */
00023 
00024 #ifndef HTTP_CLIENT_H
00025 #define HTTP_CLIENT_H
00026 
00027 #include "TCPSocketConnection.h"
00028 
00029 #define HTTP_CLIENT_DEFAULT_TIMEOUT 15000
00030 
00031 class HTTPData;
00032 
00033 #include "IHTTPData.h"
00034 #include "mbed.h"
00035 
00036 ///HTTP client results
00037 enum HTTPResult {
00038     HTTP_OK = 0,        ///<Success
00039     HTTP_PROCESSING,    ///<Processing
00040     HTTP_PARSE,         ///<url Parse error
00041     HTTP_DNS,           ///<Could not resolve name
00042     HTTP_PRTCL,         ///<Protocol error
00043     HTTP_NOTFOUND,      ///<HTTP 404 Error
00044     HTTP_REFUSED,       ///<HTTP 403 Error
00045     HTTP_ERROR,         ///<HTTP xxx error
00046     HTTP_TIMEOUT,       ///<Connection timeout
00047     HTTP_CONN,          ///<Connection error
00048     HTTP_CLOSED,        ///<Connection was closed by remote host
00049 };
00050 
00051 /**A simple HTTP Client
00052 The HTTPClient is composed of:
00053 - The actual client (HTTPClient)
00054 - Classes that act as a data repository, each of which deriving from the HTTPData class (HTTPText for short text content, HTTPFile for file I/O, HTTPMap for key/value pairs, and HTTPStream for streaming purposes)
00055 */
00056 class HTTPClient
00057 {
00058 public:
00059     ///Instantiate the HTTP client
00060     HTTPClient();
00061     ~HTTPClient();
00062 
00063     /**
00064     Provides a basic authentification feature (Base64 encoded username and password)
00065     Pass two NULL pointers to switch back to no authentication
00066     @param[in] user username to use for authentication, must remain valid durlng the whole HTTP session
00067     @param[in] user password to use for authentication, must remain valid durlng the whole HTTP session
00068     */
00069     void basicAuth(const char* user, const char* password); //Basic Authentification
00070 
00071     /**
00072     Set custom headers for request.
00073     
00074     Pass NULL, 0 to turn off custom headers.
00075     
00076     @code
00077      const char * hdrs[] = 
00078             {
00079             "Connection", "keep-alive",
00080             "Accept", "text/html",
00081             "User-Agent", "Mozilla/5.0 (Windows NT 6.1; WOW64)",
00082             "Accept-Encoding", "gzip,deflate,sdch",
00083             "Accept-Language", "en-US,en;q=0.8",
00084             };
00085 
00086         http.basicAuth("username", "password");
00087         http.customHeaders(hdrs, 5);
00088     @endcode
00089     
00090     @param[in] headers an array (size multiple of two) key-value pairs, must remain valid during the whole HTTP session
00091     @param[in] pairs number of key-value pairs
00092     */
00093     void customHeaders(const char** headers, size_t pairs);
00094 
00095     //High Level setup functions
00096     /** Execute a GET request on the URL
00097     Blocks until completion
00098     @param[in] url : url on which to execute the request
00099     @param[in,out] pDataIn : pointer to an IHTTPDataIn instance that will collect the data returned by the request, can be NULL
00100     @param[in] timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
00101     @return 0 on success, HTTP error (<0) on failure
00102     */
00103     HTTPResult get(const char* url, IHTTPDataIn* pDataIn, int timeout = HTTP_CLIENT_DEFAULT_TIMEOUT); //Blocking
00104 
00105     /** Execute a GET request on the URL
00106     Blocks until completion
00107     This is a helper to directly get a piece of text from a HTTP result
00108     @param[in] url : url on which to execute the request
00109     @param[out] result : pointer to a char array in which the result will be stored
00110     @param[in] maxResultLen : length of the char array (including space for the NULL-terminating char)
00111     @param[in] timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
00112     @return 0 on success, HTTP error (<0) on failure
00113     */
00114     HTTPResult get(const char* url, char* result, size_t maxResultLen, int timeout = HTTP_CLIENT_DEFAULT_TIMEOUT); //Blocking
00115 
00116     /** Execute a POST request on the URL
00117     Blocks until completion
00118     @param[in] url : url on which to execute the request
00119     @param[out] dataOut : a IHTTPDataOut instance that contains the data that will be posted
00120     @param[in,out] pDataIn : pointer to an IHTTPDataIn instance that will collect the data returned by the request, can be NULL
00121     @param[in] timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
00122     @return 0 on success, HTTP error (<0) on failure
00123     */
00124     HTTPResult post(const char* url, const IHTTPDataOut& dataOut, IHTTPDataIn* pDataIn, int timeout = HTTP_CLIENT_DEFAULT_TIMEOUT); //Blocking
00125 
00126     /** Execute a PUT request on the URL
00127     Blocks until completion
00128     @param[in] url : url on which to execute the request
00129     @param[in] dataOut : a IHTTPDataOut instance that contains the data that will be put
00130     @param[in,out] pDataIn : pointer to an IHTTPDataIn instance that will collect the data returned by the request, can be NULL
00131     @param[in] timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
00132     @return 0 on success, HTTP error (<0) on failure
00133     */
00134     HTTPResult put(const char* url, const IHTTPDataOut& dataOut, IHTTPDataIn* pDataIn, int timeout = HTTP_CLIENT_DEFAULT_TIMEOUT); //Blocking
00135 
00136     /** Execute a DELETE request on the URL
00137     Blocks until completion
00138     @param[in] url : url on which to execute the request
00139     @param[in,out] pDataIn : pointer to an IHTTPDataIn instance that will collect the data returned by the request, can be NULL
00140     @param[in] timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
00141     @return 0 on success, HTTP error (<0) on failure
00142     */
00143     HTTPResult del(const char* url, IHTTPDataIn* pDataIn, int timeout = HTTP_CLIENT_DEFAULT_TIMEOUT); //Blocking
00144 
00145     /** Get last request's HTTP response code
00146     @return The HTTP response code of the last request
00147     */
00148     int getHTTPResponseCode();
00149 
00150     /** Set the maximum number of automated redirections
00151     @param[in] i is the number of redirections. Values < 1 are
00152         set to 1.
00153     */
00154     void setMaxRedirections(int i = 1);
00155 
00156     /** get the redirect location url
00157     @returns const char pointer to the url.
00158     */
00159     const char * getLocation() {
00160         return m_location;
00161     }
00162 
00163 private:
00164     enum HTTP_METH {
00165         HTTP_GET,
00166         HTTP_POST,
00167         HTTP_PUT,
00168         HTTP_DELETE,
00169         HTTP_HEAD
00170     };
00171 
00172     HTTPResult connect(const char* url, HTTP_METH method, IHTTPDataOut* pDataOut, IHTTPDataIn* pDataIn, int timeout); //Execute request
00173     HTTPResult recv(char* buf, size_t minLen, size_t maxLen, size_t* pReadLen); //0 on success, err code on failure
00174     HTTPResult send(char* buf, size_t len = 0); //0 on success, err code on failure
00175     HTTPResult parseURL(const char* url, char* scheme, size_t maxSchemeLen, char* host, size_t maxHostLen, uint16_t* port, char* path, size_t maxPathLen); //Parse URL
00176     void createauth (const char *user, const char *pwd, char *buf, int len);
00177     int base64enc(const char *input, unsigned int length, char *output, int len);
00178 
00179     //Parameters
00180     TCPSocketConnection m_sock;
00181 
00182     int m_timeout;
00183 
00184     char* m_basicAuthUser;
00185     char* m_basicAuthPassword;
00186     const char** m_customHeaders;
00187     size_t m_nCustomHeaders;
00188     int m_httpResponseCode;
00189     int m_maxredirections;
00190     char * m_location;
00191 
00192 };
00193 
00194 //Including data containers here for more convenience
00195 #include "data/HTTPText.h"
00196 #include "data/HTTPMap.h"
00197 #include "data/HTTPFile.h"
00198 
00199 #endif