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               0
  70 #define HTTP_REQUEST_BODY_CURLPOST              1
  71 #define HTTP_REQUEST_BODY_UPLOADFILE    2
  72 #define HTTP_REQUEST_BODY_UPLOADDATA    3
  73 typedef struct {
  74         int type;
  75         void *data;
  76         size_t size;
  77 } http_request_body;
  78
  79 #define http_request_method_name(m) _http_request_method_name((m) TSRMLS_CC)
  80 PHP_HTTP_API const char *_http_request_method_name(http_request_method m TSRMLS_DC);
  81
  82 #define http_request_method_exists(u, l, c) _http_request_method_exists((u), (l), (c) TSRMLS_CC)
  83 PHP_HTTP_API unsigned long _http_request_method_exists(zend_bool by_name, unsigned long id, const char *name TSRMLS_DC);
  84
  85 #define http_request_method_register(m) _http_request_method_register((m) TSRMLS_CC)
  86 PHP_HTTP_API unsigned long _http_request_method_register(const char *method TSRMLS_DC);
  87
  88 #define http_request_method_unregister(mn) _http_request_method_unregister((mn) TSRMLS_CC)
  89 PHP_HTTP_API STATUS _http_request_method_unregister(unsigned long method TSRMLS_DC);
  90
  91 #define http_request_body_fill(b, fields, files) _http_request_body_fill((b), (fields), (files) TSRMLS_CC)
  92 PHP_HTTP_API STATUS _http_request_body_fill(http_request_body *body, HashTable *fields, HashTable *files TSRMLS_DC);
  93
  94 #define http_request_body_dtor(b) _http_request_body_dtor((b) TSRMLS_CC)
  95 PHP_HTTP_API void _http_request_body_dtor(http_request_body *body TSRMLS_DC);
  96
  97 #define http_request(meth, url, body, opt, info, resp) _http_request_ex(NULL, (meth), (url), (body), (opt), (info), (resp) TSRMLS_CC)
  98 #define http_request_ex(ch, meth, url, body, opt, info, resp) _http_request_ex((ch), (meth), (url), (body), (opt), (info), (resp) TSRMLS_CC)
  99 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);
 100
 101 #define http_get(u, o, i, r) _http_request_ex(NULL, HTTP_GET, (u), NULL, (o), (i), (r) TSRMLS_CC)
 102 #define http_get_ex(c, u, o, i, r) _http_request_ex((c), HTTP_GET, (u), NULL, (o), (i), (r) TSRMLS_CC)
 103
 104 #define http_head(u, o, i, r) _http_request_ex(NULL, HTTP_HEAD, (u), NULL, (o), (i), (r) TSRMLS_CC)
 105 #define http_head_ex(c, u, o, i, r) _http_request_ex((c), HTTP_HEAD, (u), NULL, (o), (i), (r) TSRMLS_CC)
 106
 107 #define http_post(u, b, o, i, r) _http_request_ex(NULL, HTTP_POST, (u), (b), (o), (i), (r) TSRMLS_CC)
 108 #define http_post_ex(c, u, b, o, i, r) _http_request_ex((c), HTTP_POST, (u), (b), (o), (i), (r) TSRMLS_CC)
 109
 110 #define http_put(u, b, o, i, r) _http_request_ex(NULL, HTTP_PUT, (u), (b), (o), (i), (r) TSRMLS_CC)
 111 #define http_put_ex(c, u, b, o, i, r) _http_request_ex((c), HTTP_PUT, (u), (b), (o), (i), (r) TSRMLS_CC)
 112
 113 #endif
 114
 115 /*
 116  * Local variables:
 117  * tab-width: 4
 118  * c-basic-offset: 4
 119  * End:
 120  * vim600: noet sw=4 ts=4 fdm=marker
 121  * vim<600: noet sw=4 ts=4
 122  */
 123