httpcli.h

/*
 * Copyright (c) 2014, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _HTTPCli_H_
#define _HTTPCli_H_

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

#include <stdbool.h>
#include <http/client/httpstd.h>
#include <http/client/network.h>
#include <http/client/ssock.h>

#ifndef HTTPCli_BUF_LEN
#define HTTPCli_BUF_LEN 128
#endif /* HTTPCLI_BUF_LEN */

#ifndef HTTPCli_CERT_NAME_LEN
#define HTTPCli_CERT_NAME_LEN 16
#endif

/* HTTP Client Error Codes */
#define HTTPCli_ESOCKETFAIL        (-101)

#define HTTPCli_ECONNECTFAIL       (-102)

#define HTTPCli_ESENDFAIL          (-103)

#define HTTPCli_ERECVFAIL          (-104)

#define HTTPCli_ETLSFAIL           (-105)

#define HTTPCli_EHOSTNAME          (-106)

#define HTTPCli_ESENDBUFSMALL      (-107)

#define HTTPCli_ERECVBUFSMALL      (-108)

#define HTTPCli_EASYNCMODE         (-109)

#define HTTPCli_ETHREADFAIL        (-110)

#define HTTPCli_EPROXYTUNNELFAIL   (-111)

#define HTTPCli_ERESPONSEINVALID   (-112)

#define HTTPCli_ECONTENTLENLARGE   (-114)

#define HTTPCli_EREDIRECTURILONG   (-115)

#define HTTPCli_ECONTENTTYPELONG   (-116)

#define HTTPCli_ENOCONTENTCALLBACK (-117)

#define HTTPCli_ENOTCHUNKDATA      (-118)

#define HTTPCli_EINPROGRESS        (-119)

#define HTTPCli_EINTERNALBUFSMALL  (-120)

#define HTTPCli_ESETNOTIFYFAIL     (-121)

#define HTTPCli_EURILENLONG  (-120)

/* HTTP methods */
#define HTTPCli_METHOD_GET      "GET"
#define HTTPCli_METHOD_POST     "POST"
#define HTTPCli_METHOD_HEAD     "HEAD"
#define HTTPCli_METHOD_OPTIONS  "OPTIONS"
#define HTTPCli_METHOD_PUT      "PUT"
#define HTTPCli_METHOD_DELETE   "DELETE"
#define HTTPCli_METHOD_CONNECT  "CONNECT"

/* HTTP Request Field Name */
#define HTTPCli_FIELD_NAME_ACCEPT  "Accept"
#define HTTPCli_FIELD_NAME_ACCEPT_CHARSET  "Accept-Charset"
#define HTTPCli_FIELD_NAME_ACCEPT_ENCODING  "Accept-Encoding"
#define HTTPCli_FIELD_NAME_ACCEPT_LANGUAGE  "Accept-Language"
#define HTTPCli_FIELD_NAME_ACCEPT_RANGES "Accept-Ranges"
#define HTTPCli_FIELD_NAME_AGE "Age"
#define HTTPCli_FIELD_NAME_ALLOW  "Allow"
#define HTTPCli_FIELD_NAME_AUTHORIZATION  "Authorization"
#define HTTPCli_FIELD_NAME_CACHE_CONTROL  "Cache-Control"
#define HTTPCli_FIELD_NAME_CONNECTION  "Connection"
#define HTTPCli_FIELD_NAME_CONTENT_ENCODING  "Content-Encoding"
#define HTTPCli_FIELD_NAME_CONTENT_LANGUAGE  "Content-Language"
#define HTTPCli_FIELD_NAME_CONTENT_LENGTH  "Content-Length"
#define HTTPCli_FIELD_NAME_CONTENT_LOCATION  "Content-Location"
#define HTTPCli_FIELD_NAME_CONTENT_MD5  "Content-MD5"
#define HTTPCli_FIELD_NAME_CONTENT_RANGE  "Content-Range"
#define HTTPCli_FIELD_NAME_CONTENT_TYPE  "Content-Type"
#define HTTPCli_FIELD_NAME_COOKIE  "Cookie"
#define HTTPCli_FIELD_NAME_DATE  "Date"
#define HTTPCli_FIELD_NAME_ETAG "ETag"
#define HTTPCli_FIELD_NAME_EXPECT  "Expect"
#define HTTPCli_FIELD_NAME_EXPIRES  "Expires"
#define HTTPCli_FIELD_NAME_FROM  "From"
#define HTTPCli_FIELD_NAME_HOST  "Host"
#define HTTPCli_FIELD_NAME_IF_MATCH  "If-Match"
#define HTTPCli_FIELD_NAME_IF_MODIFIED_SINCE  "If-Modified-Since"
#define HTTPCli_FIELD_NAME_IF_NONE_MATCH  "If-None-Match"
#define HTTPCli_FIELD_NAME_IF_RANGE  "If-Range"
#define HTTPCli_FIELD_NAME_IF_UNMODIFIED_SINCE  "If-Unmodified-Since"
#define HTTPCli_FIELD_NAME_LAST_MODIFIED  "Last-Modified"
#define HTTPCli_FIELD_NAME_LOCATION  "Location"
#define HTTPCli_FIELD_NAME_MAX_FORWARDS  "Max-Forwards"
#define HTTPCli_FIELD_NAME_ORIGIN  "Origin"
#define HTTPCli_FIELD_NAME_PRAGMA  "Pragma"
#define HTTPCli_FIELD_NAME_PROXY_AUTHENTICATE "Proxy-Authenticate"
#define HTTPCli_FIELD_NAME_PROXY_AUTHORIZATION  "Proxy-Authorization"
#define HTTPCli_FIELD_NAME_RANGE  "Range"
#define HTTPCli_FIELD_NAME_REFERER  "Referer"
#define HTTPCli_FIELD_NAME_RETRY_AFTER "Retry-After"
#define HTTPCli_FIELD_NAME_SERVER "Server"
#define HTTPCli_FIELD_NAME_TE  "TE"
#define HTTPCli_FIELD_NAME_TRAILER  "Trailer"
#define HTTPCli_FIELD_NAME_TRANSFER_ENCODING  "Transfer-Encoding"
#define HTTPCli_FIELD_NAME_UPGRADE  "Upgrade"
#define HTTPCli_FIELD_NAME_USER_AGENT  "User-Agent"
#define HTTPCli_FIELD_NAME_VARY "Vary"
#define HTTPCli_FIELD_NAME_VIA  "Via"
#define HTTPCli_FIELD_NAME_WWW_AUTHENTICATE "WWW-Authenticate"
#define HTTPCli_FIELD_NAME_WARNING  "Warning"
#define HTTPCli_FIELD_NAME_X_FORWARDED_FOR  "X-Forwarded-For"

/* HTTP client instance configuration */
#define HTTPCli_TYPE_TLS   (0x02)
#define HTTPCli_TYPE_IPV6  (0x04)

/* HTTP client getResponseField() special return codes */
#define HTTPCli_FIELD_ID_DUMMY   (-11)
#define HTTPCli_FIELD_ID_END     (-12)

typedef struct HTTPCli_Field {
    const char *name;      
    const char *value;     
} HTTPCli_Field;

typedef void (*HTTPCli_StatusCallback)(void *cli, int status);

typedef struct HTTPCli_StatusHandler {
    HTTPCli_StatusCallback handle1xx;  
    HTTPCli_StatusCallback handle2xx;  
    HTTPCli_StatusCallback handle4xx;  
} HTTPCli_StatusHandler;

typedef int (*HTTPCli_ContentCallback)(void *cli, int status, char *body,
        int len, bool moreFlag);

typedef struct HTTPCli_ContentHandler {
    char *contentType;               
    HTTPCli_ContentCallback handle;  
} HTTPCli_ContentHandler;

typedef void (*HTTPCli_RedirectCallback)(void *cli, int status, char *uri);

typedef void (*HTTPCli_Notify)(long skt, void *cli);

typedef struct HTTPCli_Struct {
    char **respFields;
    unsigned int state;
    unsigned long clen;
    Ssock_Struct ssock;
    HTTPCli_Field *fields;

    char buf[HTTPCli_BUF_LEN];
    unsigned int buflen;
    char *bufptr;

#ifndef HTTPCli_LIBTYPE_MIN
    HTTPCli_StatusHandler *shandle;
    HTTPCli_ContentHandler *chandle;
    HTTPCli_RedirectCallback rhandle;
#ifndef __linux__
    unsigned int stackSize;
    unsigned int priority;
#endif /* __linux__ */
#endif /* HTTPCli_LIBTYPE_MIN */

} HTTPCli_Struct;

typedef struct HTTPCli_Params {

#ifndef HTTPCli_LIBTYPE_MIN
    HTTPCli_StatusHandler *shandle;
    HTTPCli_ContentHandler *chandle;
    HTTPCli_RedirectCallback rhandle;
#ifndef __linux__
    unsigned int stackSize; 
    unsigned int priority;  
#endif /* __linux__ */
#endif /* HTTPCli_LIBTYPE_MIN */

#ifdef __SLP__
    HTTPCli_Notify rnotify;   
    HTTPCli_Notify wnotify;   
    HTTPCli_Notify enotify;   
#endif /* __SLP__ */

    int timeout;
} HTTPCli_Params;

typedef struct HTTPCli_SecureParams {
#ifdef __CYASSL__
    CYASSL_CTX *ctx; /* CYASSL context */

#elif defined(__SL__) /* __CYASSL__ */
    SlSockSecureMethod   method;
    SlSockSecureMask     mask;
    char                 cafile[HTTPCli_CERT_NAME_LEN];
    char                 privkey[HTTPCli_CERT_NAME_LEN];
    char                 cert[HTTPCli_CERT_NAME_LEN];
    char                 dhkey[HTTPCli_CERT_NAME_LEN];
#else /* __CYASSL__ */
    char s;

#endif /* __CYASSL__ */
} HTTPCli_SecureParams;

typedef HTTPCli_Struct* HTTPCli_Handle;

extern int HTTPCli_initSockAddr(struct sockaddr *addr, const char *uri,
        int flags);

extern void HTTPCli_construct(HTTPCli_Struct *cli);

extern HTTPCli_Handle HTTPCli_create();

extern int HTTPCli_connect(HTTPCli_Struct *cli, const struct sockaddr *addr,
        int flags, const HTTPCli_Params *params);

extern void HTTPCli_delete(HTTPCli_Handle cli);

extern void HTTPCli_destruct(HTTPCli_Struct *cli);

extern void HTTPCli_disconnect(HTTPCli_Struct *cli);

extern HTTPCli_Field *HTTPCli_setRequestFields(HTTPCli_Handle cli,
        const HTTPCli_Field *fields);

extern char **HTTPCli_setResponseFields(HTTPCli_Handle cli,
        const char *fields[]);

extern int HTTPCli_sendRequest(HTTPCli_Handle cli, const char *method,
        const char *requestURI, bool moreFlag);

extern int HTTPCli_sendField(HTTPCli_Handle cli, const char *name,
        const char *value, bool lastFlag);

extern int HTTPCli_sendRequestBody(HTTPCli_Handle cli, const char *body,
        int len);

extern int HTTPCli_getResponseStatus(HTTPCli_Handle cli);

extern int HTTPCli_getResponseField(HTTPCli_Handle cli, char *value,
        int len, bool *moreFlag);

extern int HTTPCli_readResponseBody(HTTPCli_Handle cli, char *body,
        int len, bool *moreFlag);

extern int HTTPCli_readRawResponseBody(HTTPCli_Handle cli, char *body, int len);

extern void HTTPCli_setSecureParams(HTTPCli_SecureParams *sparams);

extern void HTTPCli_setProxy(const struct sockaddr *addr);

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* _HTTPCli_H_ */