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 #define HTTP_CLIENT_DEFAULT_TIMEOUT 15000
00028 
00029 class HTTPData;
00030 
00031 #include "IHTTPData.h"
00032 #include "mbed.h"
00033 #include "TCPSocketConnection.h"
00034 
00035 ///HTTP client results
00036 enum HTTPResult {
00037     HTTP_PROCESSING, ///<Processing
00038     HTTP_PARSE, ///<url Parse error
00039     HTTP_DNS, ///<Could not resolve name
00040     HTTP_PRTCL, ///<Protocol error
00041     HTTP_NOTFOUND, ///<HTTP 404 Error
00042     HTTP_REFUSED, ///<HTTP 403 Error
00043     HTTP_ERROR, ///<HTTP xxx error
00044     HTTP_TIMEOUT, ///<Connection timeout
00045     HTTP_CONN, ///<Connection error
00046     HTTP_CLOSED, ///<Connection was closed by remote host
00047     HTTP_REDIRECT, ///<HTTP 300 - 303
00048     HTTP_OK = 0, ///<Success
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 
00065     /**
00066     Provides a OAUTH2 authentification feature 
00067     Pass NULL pointer to switch back to no authentication
00068     @param token OAUTH2 token
00069     */
00070     HTTPResult oauthToken(const char* token); // OAUTH2 Token Authentification
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 user username to use for authentication, must remain valid durlng the whole HTTP session
00076     @param user password to use for authentication, must remain valid durlng the whole HTTP session
00077     */
00078     HTTPResult basicAuth(const char* user, const char* password); //Basic Authentification
00079 
00080     //High Level setup functions
00081     /** Execute a GET request on the URL
00082     Blocks until completion
00083     @param url : url on which to execute the request
00084     @param pDataIn : pointer to an IHTTPDataIn instance that will collect the data returned by the request, can be NULL
00085     @param timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
00086     @return 0 on success, HTTP error (<0) on failure
00087     */
00088     HTTPResult get(const char* url, IHTTPDataIn* pDataIn, int timeout = HTTP_CLIENT_DEFAULT_TIMEOUT); //Blocking
00089 
00090     /** Execute a GET request on the URL
00091     Blocks until completion
00092     This is a helper to directly get a piece of text from a HTTP result
00093     @param url : url on which to execute the request
00094     @param result : pointer to a char array in which the result will be stored
00095     @param maxResultLen : length of the char array (including space for the NULL-terminating char)
00096     @param timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
00097     @return 0 on success, HTTP error (<0) on failure
00098     */
00099     HTTPResult get(const char* url, char* result, size_t maxResultLen, int timeout = HTTP_CLIENT_DEFAULT_TIMEOUT); //Blocking
00100 
00101     /** Execute a POST request on the URL
00102     Blocks until completion
00103     @param url : url on which to execute the request
00104     @param dataOut : a IHTTPDataOut instance that contains the data that will be posted
00105     @param pDataIn : pointer to an IHTTPDataIn instance that will collect the data returned by the request, can be NULL
00106     @param timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
00107     @return 0 on success, HTTP error (<0) on failure
00108     */
00109     HTTPResult post(const char* url, const IHTTPDataOut& dataOut, IHTTPDataIn* pDataIn, int timeout = HTTP_CLIENT_DEFAULT_TIMEOUT); //Blocking
00110 
00111     /** Execute a PUT request on the URL
00112     Blocks until completion
00113     @param url : url on which to execute the request
00114     @param dataOut : a IHTTPDataOut instance that contains the data that will be put
00115     @param pDataIn : pointer to an IHTTPDataIn instance that will collect the data returned by the request, can be NULL
00116     @param timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
00117     @return 0 on success, HTTP error (<0) on failure
00118     */
00119     HTTPResult put(const char* url, const IHTTPDataOut& dataOut, IHTTPDataIn* pDataIn, int timeout = HTTP_CLIENT_DEFAULT_TIMEOUT); //Blocking
00120 
00121     /** Execute a DELETE request on the URL
00122     Blocks until completion
00123     @param url : url on which to execute the request
00124     @param pDataIn : pointer to an IHTTPDataIn instance that will collect the data returned by the request, can be NULL
00125     @param timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
00126     @return 0 on success, HTTP error (<0) on failure
00127     */
00128     HTTPResult del(const char* url, IHTTPDataIn* pDataIn, int timeout = HTTP_CLIENT_DEFAULT_TIMEOUT); //Blocking
00129 
00130     /** Get last request's HTTP response code
00131     @return The HTTP response code of the last request
00132     */
00133     int getHTTPResponseCode();
00134     
00135     void setHeader(const char *header) ;   /* set http headers */
00136     HTTPResult setSSLversion(int minorV) ; /* set SSL/TLS version. 0: SSL3, 1: TLS1.0, 2: TLS1.1, 3: TLS1.2 */
00137     void setLocationBuf(char *url, int size) ; /* set URL buffer for redirection */
00138 
00139 private:
00140     enum HTTP_METH {
00141         HTTP_GET,
00142         HTTP_POST,
00143         HTTP_PUT,
00144         HTTP_DELETE,
00145         HTTP_HEAD
00146     };
00147 
00148     HTTPResult connect(const char* url, HTTP_METH method, IHTTPDataOut* pDataOut, IHTTPDataIn* pDataIn, int timeout); //Execute request
00149     HTTPResult recv(char* buf, size_t minLen, size_t maxLen, size_t* pReadLen); //0 on success, err code on failure
00150     HTTPResult send(char* buf, size_t len = 0); //0 on success, err code on failure
00151     HTTPResult flush(void); //0 on success, err code on failure
00152     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
00153     void cyassl_free(void) ;
00154     HTTPResult bAuth(void) ;
00155     HTTPResult tokenAuth(void) ;
00156     HTTPResult readHeader(void) ;
00157     
00158     //Parameters
00159 
00160     int m_timeout;
00161     const char* m_basicAuthUser;
00162     const char* m_basicAuthPassword;
00163     const char* m_oauthToken;
00164     int m_httpResponseCode;
00165 
00166     TCPSocketConnection m_sock;
00167     
00168     const char * header ;
00169     char * redirect_url ;
00170     int    redirect_url_size ;
00171     int    redirect ;
00172     
00173     /* for CyaSSL */
00174     int    SSLver ;
00175     uint16_t port;
00176     struct CYASSL_CTX* ctx ;
00177     struct CYASSL    * ssl ;
00178 };
00179 
00180 //Including data containers here for more convenience
00181 #include "data/HTTPJson.h"
00182 #include "data/HTTPMap.h"
00183 
00184 #endif