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
  21 #include "php_http_std_defs.h"
  22 #include "phpstr/phpstr.h"
  23
  24 #ifdef PHP_WIN32
  25 #       include <winsock2.h>
  26 #endif
  27
  28 #include <curl/curl.h>
  29
  30 typedef enum {
  31         HTTP_NO_REQUEST_METHOD  = 0,
  32         /* HTTP/1.1 */
  33         HTTP_GET                                = 1,
  34         HTTP_HEAD                               = 2,
  35         HTTP_POST                               = 3,
  36         HTTP_PUT                                = 4,
  37         HTTP_DELETE                             = 5,
  38         HTTP_OPTIONS                    = 6,
  39         HTTP_TRACE                              = 7,
  40         HTTP_CONNECT                    = 8,
  41         /* WebDAV - RFC 2518 */
  42         HTTP_PROPFIND                   = 9,
  43         HTTP_PROPPATCH                  = 10,
  44         HTTP_MKCOL                              = 11,
  45         HTTP_COPY                               = 12,
  46         HTTP_MOVE                               = 13,
  47         HTTP_LOCK                               = 14,
  48         HTTP_UNLOCK                             = 15,
  49         /* WebDAV Versioning - RFC 3253 */
  50         HTTP_VERSION_CONTROL    = 16,
  51         HTTP_REPORT                             = 17,
  52         HTTP_CHECKOUT                   = 18,
  53         HTTP_CHECKIN                    = 19,
  54         HTTP_UNCHECKOUT                 = 20,
  55         HTTP_MKWORKSPACE                = 21,
  56         HTTP_UPDATE                             = 22,
  57         HTTP_LABEL                              = 23,
  58         HTTP_MERGE                              = 24,
  59         HTTP_BASELINE_CONTROL   = 25,
  60         HTTP_MKACTIVITY                 = 26,
  61         /* WebDAV Access Control - RFC 3744 */
  62         HTTP_ACL                                = 27,
  63         HTTP_MAX_REQUEST_METHOD = 28
  64 } http_request_method;
  65
  66 #define HTTP_STD_REQUEST_METHOD(m) ((m > HTTP_NO_REQUEST_METHOD) && (m < HTTP_MAX_REQUEST_METHOD))
  67 #define HTTP_CUSTOM_REQUEST_METHOD(m) (m - HTTP_MAX_REQUEST_METHOD)
  68
  69 #define HTTP_REQUEST_BODY_CSTRING               1
  70 #define HTTP_REQUEST_BODY_CURLPOST              2
  71 #define HTTP_REQUEST_BODY_UPLOADFILE    3
  72 typedef struct {
  73         int type;
  74         void *data;
  75         size_t size;
  76 } http_request_body;
  77
  78 typedef struct {
  79         CURLM *ch;
  80         zend_llist handles;
  81         zend_llist bodies;
  82         int unfinished;
  83 } http_request_pool;
  84
  85 typedef struct {
  86         void ***tsrm_ctx;
  87         void *data;
  88 } http_curl_callback_ctx;
  89
  90 #define COPY_STRING             1
  91 #define COPY_SLIST              2
  92 #define COPY_CONTEXT    3
  93 #define http_request_data_copy(type, data) _http_request_data_copy((type), (data) TSRMLS_CC)
  94 extern void *_http_request_data_copy(int type, void *data TSRMLS_DC);
  95 #define http_request_data_free_string _http_request_data_free_string
  96 extern void _http_request_data_free_string(void *string);
  97 #define http_request_data_free_slist _http_request_data_free_slist
  98 extern void _http_request_data_free_slist(void *list);
  99 #define http_request_data_free_context _http_request_data_free_context
 100 extern void _http_request_data_free_context(void *context);
 101
 102 #define http_request_pool_responsehandler _http_request_pool_responsehandler
 103 extern void _http_request_pool_responsehandler(zval **req TSRMLS_DC);
 104
 105 #define http_request_global_init _http_request_global_init
 106 extern STATUS _http_request_global_init(void);
 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_pool_init(p) _http_request_pool_init((p) TSRMLS_CC)
 133 PHP_HTTP_API http_request_pool *_http_request_pool_init(http_request_pool *pool TSRMLS_DC);
 134
 135 #define http_request_pool_attach(p, r) _http_request_pool_attach((p), (r) TSRMLS_CC)
 136 PHP_HTTP_API STATUS _http_request_pool_attach(http_request_pool *pool, zval *request TSRMLS_DC);
 137
 138 #define http_request_pool_detach(p, r) _http_request_pool_detach((p), (r) TSRMLS_CC)
 139 PHP_HTTP_API STATUS _http_request_pool_detach(http_request_pool *pool, zval *request TSRMLS_DC);
 140
 141 #define http_request_pool_detach_all(p) _http_request_pool_detach_all((p) TSRMLS_CC)
 142 PHP_HTTP_API void _http_request_pool_detach_all(http_request_pool *pool TSRMLS_DC);
 143
 144 #define http_request_pool_send(p) _http_request_pool_send((p) TSRMLS_CC)
 145 PHP_HTTP_API STATUS _http_request_pool_send(http_request_pool *pool TSRMLS_DC);
 146
 147 #define http_request_pool_select _http_request_pool_select
 148 PHP_HTTP_API STATUS _http_request_pool_select(http_request_pool *pool);
 149
 150 #define http_request_pool_perform _http_request_pool_perform
 151 PHP_HTTP_API int _http_request_pool_perform(http_request_pool *pool);
 152
 153 #define http_request_pool_dtor(p) _http_request_pool_dtor((p) TSRMLS_CC)
 154 PHP_HTTP_API void _http_request_pool_dtor(http_request_pool *pool TSRMLS_DC);
 155
 156 #define http_request_init(ch, meth, url, body, options, response) _http_request_init((ch), (meth), (url), (body), (options), (response) TSRMLS_CC)
 157 PHP_HTTP_API STATUS _http_request_init(CURL *ch, http_request_method meth, const char *url, http_request_body *body, HashTable *options, phpstr *response TSRMLS_DC);
 158
 159 #define http_request_exec(ch, i) _http_request_exec((ch), (i) TSRMLS_CC)
 160 PHP_HTTP_API STATUS _http_request_exec(CURL *ch, HashTable *info TSRMLS_DC);
 161
 162 #define http_request_info(ch, i) _http_request_info((ch), (i) TSRMLS_CC)
 163 PHP_HTTP_API void _http_request_info(CURL *ch, HashTable *info TSRMLS_DC);
 164
 165 #define http_request(meth, url, body, opt, info, resp) _http_request_ex(NULL, (meth), (url), (body), (opt), (info), (resp) TSRMLS_CC)
 166 #define http_request_ex(ch, meth, url, body, opt, info, resp) _http_request_ex((ch), (meth), (url), (body), (opt), (info), (resp) TSRMLS_CC)
 167 PHP_HTTP_API STATUS _http_request_ex(CURL *ch, http_request_method meth, const char *URL, http_request_body *body, HashTable *options, HashTable *info, phpstr *response TSRMLS_DC);
 168
 169 #define http_get(u, o, i, r) _http_request_ex(NULL, HTTP_GET, (u), NULL, (o), (i), (r) TSRMLS_CC)
 170 #define http_get_ex(c, u, o, i, r) _http_request_ex((c), HTTP_GET, (u), NULL, (o), (i), (r) TSRMLS_CC)
 171
 172 #define http_head(u, o, i, r) _http_request_ex(NULL, HTTP_HEAD, (u), NULL, (o), (i), (r) TSRMLS_CC)
 173 #define http_head_ex(c, u, o, i, r) _http_request_ex((c), HTTP_HEAD, (u), NULL, (o), (i), (r) TSRMLS_CC)
 174
 175 #define http_post(u, b, o, i, r) _http_request_ex(NULL, HTTP_POST, (u), (b), (o), (i), (r) TSRMLS_CC)
 176 #define http_post_ex(c, u, b, o, i, r) _http_request_ex((c), HTTP_POST, (u), (b), (o), (i), (r) TSRMLS_CC)
 177
 178 #define http_put(u, b, o, i, r) _http_request_ex(NULL, HTTP_PUT, (u), (b), (o), (i), (r) TSRMLS_CC)
 179 #define http_put_ex(c, u, b, o, i, r) _http_request_ex((c), HTTP_PUT, (u), (b), (o), (i), (r) TSRMLS_CC)
 180
 181 #endif
 182
 183 /*
 184  * Local variables:
 185  * tab-width: 4
 186  * c-basic-offset: 4
 187  * End:
 188  * vim600: noet sw=4 ts=4 fdm=marker
 189  * vim<600: noet sw=4 ts=4
 190  */
 191