git.m6w6.name Git - m6w6/ext-http/blob - php_http_request_api.h

   1 /*
   2    +----------------------------------------------------------------------+
   3    | PECL :: http                                                         |
   4    +----------------------------------------------------------------------+
   5    | This source file is subject to version 3.0 of the PHP license, that  |
   6    | is bundled with this package in the file LICENSE, and is available   |
   7    | through the world-wide-web at http://www.php.net/license/3_0.txt.    |
   8    | If you did not receive a copy of the PHP license and are unable to   |
   9    | obtain it through the world-wide-web, please send a note to          |
  10    | license@php.net so we can mail you a copy immediately.               |
  11    +----------------------------------------------------------------------+
  12    | Copyright (c) 2004-2005 Michael Wallner <mike@php.net>               |
  13    +----------------------------------------------------------------------+
  14 */
  15
  16 /* $Id$ */
  17
  18 #ifndef PHP_HTTP_REQUEST_API_H
  19 #define PHP_HTTP_REQUEST_API_H
  20 #ifdef HTTP_HAVE_CURL
  21
  22 #include "php_http_std_defs.h"
  23 #include "phpstr/phpstr.h"
  24
  25 #ifdef PHP_WIN32
  26 #       include <winsock2.h>
  27 #endif
  28
  29 #include <curl/curl.h>
  30
  31 typedef enum {
  32         HTTP_NO_REQUEST_METHOD  = 0,
  33         /* HTTP/1.1 */
  34         HTTP_GET                                = 1,
  35         HTTP_HEAD                               = 2,
  36         HTTP_POST                               = 3,
  37         HTTP_PUT                                = 4,
  38         HTTP_DELETE                             = 5,
  39         HTTP_OPTIONS                    = 6,
  40         HTTP_TRACE                              = 7,
  41         HTTP_CONNECT                    = 8,
  42         /* WebDAV - RFC 2518 */
  43         HTTP_PROPFIND                   = 9,
  44         HTTP_PROPPATCH                  = 10,
  45         HTTP_MKCOL                              = 11,
  46         HTTP_COPY                               = 12,
  47         HTTP_MOVE                               = 13,
  48         HTTP_LOCK                               = 14,
  49         HTTP_UNLOCK                             = 15,
  50         /* WebDAV Versioning - RFC 3253 */
  51         HTTP_VERSION_CONTROL    = 16,
  52         HTTP_REPORT                             = 17,
  53         HTTP_CHECKOUT                   = 18,
  54         HTTP_CHECKIN                    = 19,
  55         HTTP_UNCHECKOUT                 = 20,
  56         HTTP_MKWORKSPACE                = 21,
  57         HTTP_UPDATE                             = 22,
  58         HTTP_LABEL                              = 23,
  59         HTTP_MERGE                              = 24,
  60         HTTP_BASELINE_CONTROL   = 25,
  61         HTTP_MKACTIVITY                 = 26,
  62         /* WebDAV Access Control - RFC 3744 */
  63         HTTP_ACL                                = 27,
  64         HTTP_MAX_REQUEST_METHOD = 28
  65 } http_request_method;
  66
  67 #define HTTP_STD_REQUEST_METHOD(m) ((m > HTTP_NO_REQUEST_METHOD) && (m < HTTP_MAX_REQUEST_METHOD))
  68 #define HTTP_CUSTOM_REQUEST_METHOD(m) (m - HTTP_MAX_REQUEST_METHOD)
  69
  70 #define HTTP_REQUEST_BODY_CSTRING               1
  71 #define HTTP_REQUEST_BODY_CURLPOST              2
  72 #define HTTP_REQUEST_BODY_UPLOADFILE    3
  73 typedef struct {
  74         int type;
  75         void *data;
  76         size_t size;
  77 } http_request_body;
  78
  79 typedef struct {
  80         void ***tsrm_ctx;
  81         void *data;
  82 } http_curl_callback_ctx;
  83
  84 typedef struct {
  85         phpstr *response;
  86         phpstr *request;
  87         curl_infotype last_info;
  88 } http_curl_conv;
  89
  90 #define COPY_STRING             1
  91 #define COPY_SLIST              2
  92 #define COPY_CONTEXT    3
  93 #define COPY_CONV               4
  94 #define http_request_data_copy(type, data) _http_request_data_copy((type), (data) TSRMLS_CC)
  95 extern void *_http_request_data_copy(int type, void *data TSRMLS_DC);
  96 #define http_request_data_free_string _http_request_data_free_string
  97 extern void _http_request_data_free_string(void *string);
  98 #define http_request_data_free_slist _http_request_data_free_slist
  99 extern void _http_request_data_free_slist(void *list);
 100 #define http_request_data_free_context _http_request_data_free_context
 101 extern void _http_request_data_free_context(void *context);
 102 #define http_request_data_free_conv _http_request_data_free_conv
 103 extern void _http_request_data_free_conv(void *conv);
 104
 105 #define http_request_conv(ch, rs, rq) _http_request_conv((ch), (rs), (rq) TSRMLS_CC)
 106 extern void _http_request_conv(CURL *ch, phpstr* response, phpstr *request TSRMLS_DC);
 107
 108 #define http_request_method_name(m) _http_request_method_name((m) TSRMLS_CC)
 109 PHP_HTTP_API const char *_http_request_method_name(http_request_method m TSRMLS_DC);
 110
 111 #define http_request_method_exists(u, l, c) _http_request_method_exists((u), (l), (c) TSRMLS_CC)
 112 PHP_HTTP_API unsigned long _http_request_method_exists(zend_bool by_name, unsigned long id, const char *name TSRMLS_DC);
 113
 114 #define http_request_method_register(m) _http_request_method_register((m) TSRMLS_CC)
 115 PHP_HTTP_API unsigned long _http_request_method_register(const char *method TSRMLS_DC);
 116
 117 #define http_request_method_unregister(mn) _http_request_method_unregister((mn) TSRMLS_CC)
 118 PHP_HTTP_API STATUS _http_request_method_unregister(unsigned long method TSRMLS_DC);
 119
 120 #define http_request_body_new() _http_request_body_new(TSRMLS_C)
 121 PHP_HTTP_API http_request_body *_http_request_body_new(TSRMLS_D);
 122
 123 #define http_request_body_fill(b, fields, files) _http_request_body_fill((b), (fields), (files) TSRMLS_CC)
 124 PHP_HTTP_API STATUS _http_request_body_fill(http_request_body *body, HashTable *fields, HashTable *files TSRMLS_DC);
 125
 126 #define http_request_body_dtor(b) _http_request_body_dtor((b) TSRMLS_CC)
 127 PHP_HTTP_API void _http_request_body_dtor(http_request_body *body TSRMLS_DC);
 128
 129 #define http_request_body_free(b) _http_request_body_free((b) TSRMLS_CC)
 130 PHP_HTTP_API void _http_request_body_free(http_request_body *body TSRMLS_DC);
 131
 132 #define http_request_init(ch, meth, url, body, options) _http_request_init((ch), (meth), (url), (body), (options) TSRMLS_CC)
 133 PHP_HTTP_API STATUS _http_request_init(CURL *ch, http_request_method meth, char *url, http_request_body *body, HashTable *options TSRMLS_DC);
 134
 135 #define http_request_exec(ch, i, response, request) _http_request_exec((ch), (i), (response), (request) TSRMLS_CC)
 136 PHP_HTTP_API STATUS _http_request_exec(CURL *ch, HashTable *info, phpstr *response, phpstr *request TSRMLS_DC);
 137
 138 #define http_request_info(ch, i) _http_request_info((ch), (i) TSRMLS_CC)
 139 PHP_HTTP_API void _http_request_info(CURL *ch, HashTable *info TSRMLS_DC);
 140
 141 #define http_request(meth, url, body, opt, info, resp) _http_request_ex(NULL, (meth), (url), (body), (opt), (info), (resp) TSRMLS_CC)
 142 #define http_request_ex(ch, meth, url, body, opt, info, resp) _http_request_ex((ch), (meth), (url), (body), (opt), (info), (resp) TSRMLS_CC)
 143 PHP_HTTP_API STATUS _http_request_ex(CURL *ch, http_request_method meth, char *URL, http_request_body *body, HashTable *options, HashTable *info, phpstr *response TSRMLS_DC);
 144
 145 #define http_get(u, o, i, r) _http_request_ex(NULL, HTTP_GET, (u), NULL, (o), (i), (r) TSRMLS_CC)
 146 #define http_get_ex(c, u, o, i, r) _http_request_ex((c), HTTP_GET, (u), NULL, (o), (i), (r) TSRMLS_CC)
 147
 148 #define http_head(u, o, i, r) _http_request_ex(NULL, HTTP_HEAD, (u), NULL, (o), (i), (r) TSRMLS_CC)
 149 #define http_head_ex(c, u, o, i, r) _http_request_ex((c), HTTP_HEAD, (u), NULL, (o), (i), (r) TSRMLS_CC)
 150
 151 #define http_post(u, b, o, i, r) _http_request_ex(NULL, HTTP_POST, (u), (b), (o), (i), (r) TSRMLS_CC)
 152 #define http_post_ex(c, u, b, o, i, r) _http_request_ex((c), HTTP_POST, (u), (b), (o), (i), (r) TSRMLS_CC)
 153
 154 #define http_put(u, b, o, i, r) _http_request_ex(NULL, HTTP_PUT, (u), (b), (o), (i), (r) TSRMLS_CC)
 155 #define http_put_ex(c, u, b, o, i, r) _http_request_ex((c), HTTP_PUT, (u), (b), (o), (i), (r) TSRMLS_CC)
 156
 157 #endif
 158 #endif
 159
 160 /*
 161  * Local variables:
 162  * tab-width: 4
 163  * c-basic-offset: 4
 164  * End:
 165  * vim600: noet sw=4 ts=4 fdm=marker
 166  * vim<600: noet sw=4 ts=4
 167  */
 168