httpclient.h

Go to the documentation of this file.

#ifndef _CP_HTTP_CLIENT_H
#define _CP_HTTP_CLIENT_H

#include "common.h"

#ifdef _WINDOWS
#include <Winsock2.h>
#endif

__BEGIN_DECLS

#include <time.h>

#include "config.h"
#include "hashtable.h"
#include "vector.h"
#include "thread.h"
#include "http.h"
#include "client.h"

#ifdef CP_HAS_POLL
#include <sys/poll.h>
#else
#ifdef CP_HAS_SYS_SELECT_H
#include <sys/select.h>
#endif
#endif /* CP_HAS_POLL */

#ifdef CP_USE_COOKIES
#include "trie.h"

typedef CPROPS_DLL struct _cp_http_cookie
{
    char *content;      
    char *domain;       
    char *path;         
    struct tm expires;  
    int secure;       
    int version;
    int http_only;
    cp_hashtable *fld;  
} cp_http_cookie;

CPROPS_DLL
cp_http_cookie *cp_http_cookie_create(char *content, 
                                      char *domain, 
                                      char *path, 
                                      char *expires, 
                                      int secure,
                                      int version,
                                      int http_only);

CPROPS_DLL
cp_http_cookie *cp_http_cookie_parse(char *src);

CPROPS_DLL
void cp_http_cookie_destroy(cp_http_cookie *c);

CPROPS_DLL
void cp_http_cookie_dump(cp_http_cookie *c);

#endif /* CP_USE_COOKIES */

CPROPS_DLL
int cp_httpclient_init();

CPROPS_DLL
int cp_httpclient_shutdown();


#define DEFAULT_MAX_REDIRECTS 10

typedef CPROPS_DLL struct _cp_httpclient
{
    int id;
    cp_http_version version;
    cp_http_request_type type;
    cp_hashtable *header;
    cp_hashtable *cgi_parameters;
    short auto_drop_parameters;
    short auto_drop_headers;
    cp_string *content;
    char *host; 
    int port;   
    char *proxy_host;
    int proxy_port;
#ifdef CP_USE_SSL
    short proxy_ssl;
#endif /* CP_USE_SSL */
#ifdef CP_USE_COOKIES
    cp_trie *cookie_jar;
#endif /* CP_USE_COOKIES */
    short connected;
    short persistent;
    int keep_alive;
    short pipeline_requests;
    short follow_redirects;
    short max_redirects;

    cp_client *socket;
} cp_httpclient;

CPROPS_DLL
cp_httpclient *cp_httpclient_create(char *host, int port);
CPROPS_DLL
cp_httpclient *
    cp_httpclient_create_proxy(char *host, int port, 
                               char *proxy_host, int proxy_port);
#ifdef CP_USE_SSL

CPROPS_DLL
cp_httpclient *cp_httpclient_create_ssl(char *host, int port, 
                                        char *CA_file, char *CA_path, 
                                        int verification_mode);

CPROPS_DLL
cp_httpclient *
    cp_httpclient_create_proxy_ssl(char *host, int port, 
                                   char *proxy_host, int proxy_port, 
                                   char *CA_file, char *CA_path, 
                                   int verification_mode);
#endif /* CP_USE_SSL */

CPROPS_DLL
void cp_httpclient_destroy(cp_httpclient *client);

CPROPS_DLL
void cp_httpclient_set_http_version(cp_httpclient *client, 
                                    cp_http_version version);
CPROPS_DLL
void cp_httpclient_set_request_type(cp_httpclient *client, 
                                    cp_http_request_type type);
CPROPS_DLL
void cp_httpclient_set_header(cp_httpclient *client, char *header, char *value);
CPROPS_DLL 
void cp_httpclient_set_auto_drop_headers(cp_httpclient *client, short mode);
CPROPS_DLL
void cp_httpclient_drop_headers(cp_httpclient *client);
CPROPS_DLL
void *cp_httpclient_set_parameter(cp_httpclient *client, 
                                  char *name, char *value);
CPROPS_DLL 
void cp_httpclient_set_auto_drop_parameters(cp_httpclient *client, short mode);
CPROPS_DLL
void cp_httpclient_drop_parameters(cp_httpclient *client);
CPROPS_DLL
void cp_httpclient_set_user_agent(cp_httpclient *client, char *agent);
CPROPS_DLL
void cp_httpclient_set_timeout(cp_httpclient *client, 
                                      int sec, int usec);
CPROPS_DLL
void cp_httpclient_set_retry(cp_httpclient *client, int retry_count);
CPROPS_DLL
void cp_httpclient_allow_redirects(cp_httpclient *client, int mode);
CPROPS_DLL
void cp_httpclient_set_max_redirects(cp_httpclient *client, int max);
#ifdef CP_USE_COOKIES

CPROPS_DLL
void cp_httpclient_set_cookie_jar(cp_httpclient *client, cp_trie *jar);
#endif /* CP_USE_COOKIES */

CPROPS_DLL
int cp_httpclient_reopen(cp_httpclient *client, char *host, int port);


typedef CPROPS_DLL struct _cp_url_descriptor
{
    short ssl;
    char *host;
    int port;
    char *uri;
} cp_url_descriptor; 
CPROPS_DLL
cp_url_descriptor *
    cp_url_descriptor_create(char *host, short ssl, int port, char *uri);
CPROPS_DLL
void cp_url_descriptor_destroy(cp_url_descriptor *desc);
CPROPS_DLL
short cp_url_descriptor_ssl(cp_url_descriptor *desc);
CPROPS_DLL
char *cp_url_descriptor_host(cp_url_descriptor *desc);
CPROPS_DLL
int cp_url_descriptor_port(cp_url_descriptor *desc);
CPROPS_DLL
char *cp_url_descriptor_uri(cp_url_descriptor *desc);
CPROPS_DLL
cp_url_descriptor *cp_url_descriptor_parse(char *url);

typedef enum 
    { 
        CP_HTTP_RESULT_SUCCESS,
        CP_HTTP_RESULT_CONNECTION_FAILED,
        CP_HTTP_RESULT_CONNECTION_RESET,
        CP_HTTP_RESULT_TIMED_OUT,
        CP_HTTP_RESULT_WRITE_ERROR,
        CP_HTTP_RESULT_READ_ERROR
    } cp_http_result_status;

typedef CPROPS_DLL struct _cp_httpclient_result
{
    void *id;
    cp_http_result_status result;
    cp_httpclient *client;
    cp_http_response *response;
} cp_httpclient_result;

CPROPS_DLL
cp_httpclient_result * cp_httpclient_result_create(cp_httpclient *client);

CPROPS_DLL
void cp_httpclient_result_destroy(cp_httpclient_result *res);
CPROPS_DLL
void *cp_httpclient_result_id(cp_httpclient_result *res);
CPROPS_DLL 
cp_http_result_status cp_httpclient_result_status(cp_httpclient_result *res);
CPROPS_DLL 
cp_http_response *cp_httpclient_result_get_response(cp_httpclient_result *res);
CPROPS_DLL 
cp_httpclient *cp_httpclient_result_get_client(cp_httpclient_result *res);

CPROPS_DLL
cp_httpclient_result *cp_httpclient_fetch(cp_httpclient *client, char *uri);


/* ------------------------------------------------------------------------ *
 *                             async interface                              *
 * ------------------------------------------------------------------------ */


typedef CPROPS_DLL struct _cp_httpclient_ctl
{
    cp_hashlist *stack;
#ifdef CP_HAS_POLL
    struct pollfd *ufds; /* pollfd allows specifying poll type (r/w etc) */
#else
    fd_set ufds_r; /* select requires separate sets for reading and writing */
    fd_set ufds_w;
    unsigned int fdmax;
#endif /* CP_HAS_POLL */
    void **desc;
    int size;
    int nfds;

    /* background transfers */
    int running;
    cp_thread bg;
    cp_thread_pool *pool;
    cp_mutex bg_lock;
    cp_cond bg_cond;
} cp_httpclient_ctl;

CPROPS_DLL
cp_httpclient_ctl *cp_httpclient_ctl_create(int background);

CPROPS_DLL
void cp_httpclient_ctl_destroy(cp_httpclient_ctl *ctl);

#ifdef CP_HAS_POLL

CPROPS_DLL
struct pollfd *cp_httpclient_ctl_default_get_pollfds(int *num);

CPROPS_DLL
struct pollfd *cp_httpclient_ctl_get_pollfds(cp_httpclient_ctl *ctl, int *num);
#else

CPROPS_DLL
fd_set *cp_httpclient_ctl_default_get_read_fd_set(int *num);

CPROPS_DLL
fd_set *cp_httpclient_ctl_get_read_fd_set(cp_httpclient_ctl *ctl, int *num);

CPROPS_DLL
fd_set *cp_httpclient_ctl_default_get_write_fd_set(int *num);

CPROPS_DLL
fd_set *cp_httpclient_ctl_get_write_fd_set(cp_httpclient_ctl *ctl, int *num);
#endif /* CP_HAS_POLL */
typedef 
void (*cp_httpclient_callback)(cp_httpclient_result *response);

typedef CPROPS_DLL struct _cp_http_transfer_descriptor
{
    void *id;               
    char *uri;              
    cp_httpclient *owner;   
    cp_http_response *res;  
    cp_string *buf;         
    char *read_ptr;         
    int skip;               
    int stage;              
    int read_stage;         
    int transfer;           
    int remaining;          
    int redirects;          
    int status;             
    cp_httpclient_callback callback;
} cp_http_transfer_descriptor;

CPROPS_DLL
cp_http_transfer_descriptor *
    cp_http_transfer_descriptor_create(void *id, 
                                       cp_httpclient *client, 
                                       cp_httpclient_callback callback, 
                                       char *uri);
CPROPS_DLL
void cp_http_transfer_descriptor_destroy(cp_http_transfer_descriptor *desc);

CPROPS_DLL 
int cp_httpclient_fetch_nb(cp_httpclient *client, char *uri, void *id, 
                           cp_httpclient_callback callback, int background);

CPROPS_DLL
int cp_httpclient_fetch_ctl(cp_httpclient_ctl *ctl, cp_httpclient *client, 
                            char *uri, void *id, 
                            cp_httpclient_callback callback);

CPROPS_DLL
int cp_httpclient_fetch_nb_exec();

CPROPS_DLL
int cp_httpclient_fetch_ctl_exec(cp_httpclient_ctl *ctl);

__END_DECLS

#endif /* _CP_HTTP_CLIENT_H */

---