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     /// Get the text form of the error number
00064     /// 
00065     /// Gets a pointer to a text message that described the result code.
00066     ///
00067     /// @param[in] res is the HTTPResult code to translate to text.
00068     /// @returns a pointer to a text message.
00069     ///
00070     static const char * GetErrorMessage(HTTPResult res);
00071 
00072     /**
00073     Provides a basic authentification feature (Base64 encoded username and password)
00074     Pass two NULL pointers to switch back to no authentication
00075     @param[in] user username to use for authentication, must remain valid durlng the whole HTTP session
00076     @param[in] user password to use for authentication, must remain valid durlng the whole HTTP session
00077     */
00078     void basicAuth(const char* user, const char* password); //Basic Authentification
00079 
00080     /**
00081     Set custom headers for request.
00082     
00083     Pass NULL, 0 to turn off custom headers.
00084     
00085     @code
00086      const char * hdrs[] = 
00087             {
00088             "Connection", "keep-alive",
00089             "Accept", "text/html",
00090             "User-Agent", "Mozilla/5.0 (Windows NT 6.1; WOW64)",
00091             "Accept-Encoding", "gzip,deflate,sdch",
00092             "Accept-Language", "en-US,en;q=0.8",
00093             };
00094 
00095         http.basicAuth("username", "password");
00096         http.customHeaders(hdrs, 5);
00097     @endcode
00098     
00099     @param[in] headers an array (size multiple of two) key-value pairs, must remain valid during the whole HTTP session
00100     @param[in] pairs number of key-value pairs
00101     */
00102     void customHeaders(const char** headers, size_t pairs);
00103 
00104     //High Level setup functions
00105     /** Execute a GET request on the URL
00106     Blocks until completion
00107     @param[in] url : url on which to execute the request
00108     @param[in,out] pDataIn : pointer to an IHTTPDataIn instance that will collect the data returned by the request, can be NULL
00109     @param[in] timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
00110     @return 0 on success, HTTP error (<0) on failure
00111     */
00112     HTTPResult get(const char* url, IHTTPDataIn* pDataIn, int timeout = HTTP_CLIENT_DEFAULT_TIMEOUT); //Blocking
00113 
00114     /** Execute a GET request on the URL
00115     Blocks until completion
00116     This is a helper to directly get a piece of text from a HTTP result
00117     @param[in] url : url on which to execute the request
00118     @param[out] result : pointer to a char array in which the result will be stored
00119     @param[in] maxResultLen : length of the char array (including space for the NULL-terminating char)
00120     @param[in] timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
00121     @return 0 on success, HTTP error (<0) on failure
00122     */
00123     HTTPResult get(const char* url, char* result, size_t maxResultLen, int timeout = HTTP_CLIENT_DEFAULT_TIMEOUT); //Blocking
00124 
00125     /** Execute a POST request on the URL
00126     Blocks until completion
00127     @param[in] url : url on which to execute the request
00128     @param[out] dataOut : a IHTTPDataOut instance that contains the data that will be posted
00129     @param[in,out] pDataIn : pointer to an IHTTPDataIn instance that will collect the data returned by the request, can be NULL
00130     @param[in] timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
00131     @return 0 on success, HTTP error (<0) on failure
00132     */
00133     HTTPResult post(const char* url, const IHTTPDataOut& dataOut, IHTTPDataIn* pDataIn, int timeout = HTTP_CLIENT_DEFAULT_TIMEOUT); //Blocking
00134 
00135     /** Execute a PUT request on the URL
00136     Blocks until completion
00137     @param[in] url : url on which to execute the request
00138     @param[in] dataOut : a IHTTPDataOut instance that contains the data that will be put
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 put(const char* url, const IHTTPDataOut& dataOut, IHTTPDataIn* pDataIn, int timeout = HTTP_CLIENT_DEFAULT_TIMEOUT); //Blocking
00144 
00145     /** Execute a DELETE request on the URL
00146     Blocks until completion
00147     @param[in] url : url on which to execute the request
00148     @param[in,out] pDataIn : pointer to an IHTTPDataIn instance that will collect the data returned by the request, can be NULL
00149     @param[in] timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
00150     @return 0 on success, HTTP error (<0) on failure
00151     */
00152     HTTPResult del(const char* url, IHTTPDataIn* pDataIn, int timeout = HTTP_CLIENT_DEFAULT_TIMEOUT); //Blocking
00153 
00154     /** Get last request's HTTP response code
00155     @return The HTTP response code of the last request
00156     */
00157     int getHTTPResponseCode();
00158 
00159     /** Set the maximum number of automated redirections
00160     @param[in] i is the number of redirections. Values < 1 are
00161         set to 1.
00162     */
00163     void setMaxRedirections(int i = 1);
00164 
00165     /** get the redirect location url
00166     @returns const char pointer to the url.
00167     */
00168     const char * getLocation() {
00169         return m_location;
00170     }
00171 
00172 private:
00173     enum HTTP_METH {
00174         HTTP_GET,
00175         HTTP_POST,
00176         HTTP_PUT,
00177         HTTP_DELETE,
00178         HTTP_HEAD
00179     };
00180 
00181     HTTPResult connect(const char* url, HTTP_METH method, IHTTPDataOut* pDataOut, IHTTPDataIn* pDataIn, int timeout); //Execute request
00182     HTTPResult recv(char* buf, size_t minLen, size_t maxLen, size_t* pReadLen); //0 on success, err code on failure
00183     HTTPResult send(char* buf, size_t len = 0); //0 on success, err code on failure
00184     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
00185     void createauth (const char *user, const char *pwd, char *buf, int len);
00186     int base64enc(const char *input, unsigned int length, char *output, int len);
00187 
00188     //Parameters
00189     TCPSocketConnection m_sock;
00190 
00191     int m_timeout;
00192 
00193     char* m_basicAuthUser;
00194     char* m_basicAuthPassword;
00195     const char** m_customHeaders;
00196     size_t m_nCustomHeaders;
00197     int m_httpResponseCode;
00198     int m_maxredirections;
00199     char * m_location;
00200 
00201 };
00202 
00203 //Including data containers here for more convenience
00204 #include "data/HTTPText.h"
00205 #include "data/HTTPMap.h"
00206 #include "data/HTTPFile.h"
00207 #include "data/HTTPJson.h"
00208 
00209 #endif