// This file is part of BOINC.
// http://boinc.berkeley.edu
// Copyright (C) 2008 University of California
//
// BOINC is free software; you can redistribute it and/or modify it
// under the terms of the GNU Lesser General Public License
// as published by the Free Software Foundation,
// either version 3 of the License, or (at your option) any later version.
//
// BOINC is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
// See the GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with BOINC. If not, see .
// HTTP_OP represents an HTTP operation.
// There are variants for GET and POST,
// and for the data source/sink (see below).
// We use libcurl: http://curl.haxx.se/libcurl
#ifndef _HTTP_
#define _HTTP_
// SOCKS #defines
#define SOCKS_VERSION_4 0x04
#define SOCKS_VERSION_5 0x05
#include
#include "network.h"
#include "proxy_info.h"
extern int curl_init();
extern int curl_cleanup();
#define HTTP_OP_NONE 0
#define HTTP_OP_GET 1
// data sink is a file (used for file download)
#define HTTP_OP_POST 2
// data source and sink are files (used for scheduler op)
#define HTTP_OP_HEAD 4
// no data (used for file upload)
#define HTTP_OP_POST2 5
// a POST operation where the request comes from a combination
// of a string and a file w/offset,
// and the reply goes into a memory buffer.
// Used for file upload
#define HTTP_STATE_IDLE 0
#define HTTP_STATE_CONNECTING 1
#define HTTP_STATE_DONE 2
class HTTP_OP {
public:
HTTP_OP();
~HTTP_OP();
PROXY_INFO pi;
char m_url[256];
/// string needed for ssl support
char m_curl_ca_bundle_location[256];
/// string needed for proxy username/password
char m_curl_user_credentials[128];
int content_length;
double file_offset;
int trace_id;
char request_header[4096];
FILE* fileIn;
/// CMC need an output file for POST responses
FILE* fileOut;
/// the "easy curl" handle for this net_xfer request
CURL* curlEasy;
/// curl slist for http headers
struct curl_slist *pcurlList;
/// a pointer to a form item for POST
struct curl_httppost *pcurlFormStart;
/// a pointer to a form item for POST
struct curl_httppost *pcurlFormEnd;
/// pointer to bytes for reading via libcurl_read function
unsigned char* pByte;
/// offset within the file or memory buffer we're reading,
long lSeek;
char infile[256];
char outfile[256];
/// put Curl error message here
char error_msg[256];
/// CMC -- flag that outfile is really a tempfile we should delete
bool bTempOutfile;
char* req1;
int req1_len;
/// CMC -- a flag that I already sent the header
bool bSentHeader;
/// CMC -- send up curl result code
CURLcode CurlResult;
bool want_download; // at most one should be true
bool want_upload;
/// errno from connect() (not used for anything)
long connect_error;
/// HTTP status code from server
/// the above two MUST be long (not int)
/// otherwise breaks on 64-bit machines
long response;
double start_time;
/// Uncompressed bytes transferred.
/// In the case of "post2" this includes only the file part
/// In the case of restartable ops (file upload/download)
/// this includes previous count (i.e. file offset)
double bytes_xferred;
/// bytes_xferred at the start of this operation;
/// used to compute transfer speed
double start_bytes_xferred;
/// tranfer rate based on elapsed time and bytes_xferred
/// (hence doesn't reflect compression; used only for GUI)
double xfer_speed;
int http_op_state; // values above
/// HTTP_OP_* (see above)
int http_op_type;
/// Either:
/// 0
/// ERR_GETHOSTBYNAME (if no such host)
/// ERR_CONNECT (if server down)
/// ERR_FILE_NOT_FOUND (if 404)
/// ERR_HTTP_ERROR (other failures)
int http_op_retval;
void reset();
void init();
int get_ip_addr(int &ip_addr);
void close_socket();
void close_file();
void update_speed();
void set_speed_limit(bool is_upload, double bytes_sec);
void handle_messages(CURLMsg*);
//int init_head(const char* url);
int init_get(const char* url, const char* outfile, bool del_old_file, double offset=0);
int init_post(const char* url, const char* infile, const char* outfile);
int init_post2(
const char* url,
char* req1, // first part of request. ALSO USED FOR REPLY
int req1_len,
const char* infile, double offset // infile is NULL if no file sent
);
bool http_op_done();
void setup_proxy_session(bool no_proxy);
bool no_proxy_for_url(const char* url);
bool is_active() {
return curlEasy!=NULL;
}
private:
// internal use in the class -- takes an init_get/post/post2 and turns it into
// an appropriate libcurl request
int libcurl_exec(const char* url, const char* in, const char* out,
double offset, bool bPost
);
};
// global function used by libcurl to write http replies to disk
//
size_t libcurl_write(void *ptr, size_t size, size_t nmemb, HTTP_OP* phop);
size_t libcurl_read( void *ptr, size_t size, size_t nmemb, HTTP_OP* phop);
curlioerr libcurl_ioctl(CURL *handle, curliocmd cmd, HTTP_OP* phop);
int libcurl_debugfunction(CURL *handle, curl_infotype type,
unsigned char *data, size_t size, HTTP_OP* phop
);
/// represents a set of HTTP requests in progress
class HTTP_OP_SET {
std::vector http_ops;
public:
HTTP_OP_SET();
void insert(HTTP_OP*);
int remove(HTTP_OP*);
int nops();
/// total bytes transferred
double bytes_up, bytes_down;
void get_fdset(FDSET_GROUP&);
void got_select(FDSET_GROUP&, double);
/// lookup by easycurl handle
HTTP_OP* lookup_curl(CURL* pcurl);
void cleanup_temp_files();
};
#define URL_PROTOCOL_UNKNOWN 0
#define URL_PROTOCOL_HTTP 1
#define URL_PROTOCOL_HTTPS 2
#define URL_PROTOCOL_SOCKS 3
extern char* get_user_agent_string();
extern void parse_url(const char* url, int &protocol, char* host, int &port, char* file);
#endif //__HTTP_H