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 #define HTTP_REQUEST_BODY_UPLOADDATA    4
  73 typedef struct {
  74         int type;
  75         void *data;
  76         size_t size;
  77 } http_request_body;
  78
  79 typedef struct {
  80         CURLM *ch;
  81         zend_llist handles;
  82         zend_llist bodies;
  83         int unfinished;
  84 } http_request_pool;
  85
  86 #define COPY_STRING     1
  87 #define COPY_SLIST      2
  88 #define http_request_data_copy(type, data) _http_request_data_copy((type), (data) TSRMLS_CC)
  89 extern void *_http_request_data_copy(int type, void *data TSRMLS_DC);
  90 #define http_request_data_free_string _http_request_data_free_string
  91 extern void _http_request_data_free_string(void *string);
  92 #define http_request_data_free_slist _http_request_data_free_slist
  93 extern void _http_request_data_free_slist(void *list);
  94
  95 #define http_request_global_init _http_request_global_init
  96 extern STATUS _http_request_global_init(void);
  97
  98 #define http_request_method_name(m) _http_request_method_name((m) TSRMLS_CC)
  99 PHP_HTTP_API const char *_http_request_method_name(http_request_method m TSRMLS_DC);
 100
 101 #define http_request_method_exists(u, l, c) _http_request_method_exists((u), (l), (c) TSRMLS_CC)
 102 PHP_HTTP_API unsigned long _http_request_method_exists(zend_bool by_name, unsigned long id, const char *name TSRMLS_DC);
 103
 104 #define http_request_method_register(m) _http_request_method_register((m) TSRMLS_CC)
 105 PHP_HTTP_API unsigned long _http_request_method_register(const char *method TSRMLS_DC);
 106
 107 #define http_request_method_unregister(mn) _http_request_method_unregister((mn) TSRMLS_CC)
 108 PHP_HTTP_API STATUS _http_request_method_unregister(unsigned long method TSRMLS_DC);
 109
 110 #define http_request_body_new() _http_request_body_new(TSRMLS_C)
 111 PHP_HTTP_API http_request_body *_http_request_body_new(TSRMLS_D);
 112
 113 #define http_request_body_fill(b, fields, files) _http_request_body_fill((b), (fields), (files) TSRMLS_CC)
 114 PHP_HTTP_API STATUS _http_request_body_fill(http_request_body *body, HashTable *fields, HashTable *files TSRMLS_DC);
 115
 116 #define http_request_body_dtor(b) _http_request_body_dtor((b) TSRMLS_CC)
 117 PHP_HTTP_API void _http_request_body_dtor(http_request_body *body TSRMLS_DC);
 118
 119 #define http_request_body_free(b) _http_request_body_free((b) TSRMLS_CC)
 120 PHP_HTTP_API void _http_request_body_free(http_request_body *body TSRMLS_DC);
 121
 122 #define http_request_pool_init(p) _http_request_pool_init((p) TSRMLS_CC)
 123 PHP_HTTP_API http_request_pool *_http_request_pool_init(http_request_pool *pool TSRMLS_DC);
 124
 125 #define http_request_pool_attach(p, r) _http_request_pool_attach((p), (r) TSRMLS_CC)
 126 PHP_HTTP_API STATUS _http_request_pool_attach(http_request_pool *pool, zval *request TSRMLS_DC);
 127
 128 #define http_request_pool_detach(p, r) _http_request_pool_detach((p), (r) TSRMLS_CC)
 129 PHP_HTTP_API STATUS _http_request_pool_detach(http_request_pool *pool, zval *request TSRMLS_DC);
 130
 131 #define http_request_pool_send(p) _http_request_pool_send((p) TSRMLS_CC)
 132 PHP_HTTP_API STATUS _http_request_pool_send(http_request_pool *pool TSRMLS_DC);
 133
 134 #define http_request_pool_dtor(p) _http_request_pool_dtor((p) TSRMLS_CC)
 135 PHP_HTTP_API void _http_request_pool_dtor(http_request_pool *pool TSRMLS_DC);
 136
 137 #define http_request_init(ch, meth, url, body, options, response) _http_request_init((ch), (meth), (url), (body), (options), (response) TSRMLS_CC)
 138 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);
 139
 140 #define http_request_exec(ch, i) _http_request_exec((ch), (i) TSRMLS_CC)
 141 PHP_HTTP_API STATUS _http_request_exec(CURL *ch, HashTable *info TSRMLS_DC);
 142
 143 #define http_request_info(ch, i) _http_request_info((ch), (i) TSRMLS_CC)
 144 PHP_HTTP_API void _http_request_info(CURL *ch, HashTable *info TSRMLS_DC);
 145
 146 #define http_request(meth, url, body, opt, info, resp) _http_request_ex(NULL, (meth), (url), (body), (opt), (info), (resp) TSRMLS_CC)
 147 #define http_request_ex(ch, meth, url, body, opt, info, resp) _http_request_ex((ch), (meth), (url), (body), (opt), (info), (resp) TSRMLS_CC)
 148 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);
 149
 150 #define http_get(u, o, i, r) _http_request_ex(NULL, HTTP_GET, (u), NULL, (o), (i), (r) TSRMLS_CC)
 151 #define http_get_ex(c, u, o, i, r) _http_request_ex((c), HTTP_GET, (u), NULL, (o), (i), (r) TSRMLS_CC)
 152
 153 #define http_head(u, o, i, r) _http_request_ex(NULL, HTTP_HEAD, (u), NULL, (o), (i), (r) TSRMLS_CC)
 154 #define http_head_ex(c, u, o, i, r) _http_request_ex((c), HTTP_HEAD, (u), NULL, (o), (i), (r) TSRMLS_CC)
 155
 156 #define http_post(u, b, o, i, r) _http_request_ex(NULL, HTTP_POST, (u), (b), (o), (i), (r) TSRMLS_CC)
 157 #define http_post_ex(c, u, b, o, i, r) _http_request_ex((c), HTTP_POST, (u), (b), (o), (i), (r) TSRMLS_CC)
 158
 159 #define http_put(u, b, o, i, r) _http_request_ex(NULL, HTTP_PUT, (u), (b), (o), (i), (r) TSRMLS_CC)
 160 #define http_put_ex(c, u, b, o, i, r) _http_request_ex((c), HTTP_PUT, (u), (b), (o), (i), (r) TSRMLS_CC)
 161
 162 #endif
 163
 164 /*
 165  * Local variables:
 166  * tab-width: 4
 167  * c-basic-offset: 4
 168  * End:
 169  * vim600: noet sw=4 ts=4 fdm=marker
 170  * vim<600: noet sw=4 ts=4
 171  */
 172