branch off v1 as R_1_7
[m6w6/ext-http] / php_http_request_api.h
index 52897b64e4e83300ff6f9f93f7a3c81dfc96c8eb..bebceaebe8f90e49e1305af8c758d18ce2a86697 100644 (file)
@@ -1,16 +1,13 @@
 /*
-   +----------------------------------------------------------------------+
-   | PECL :: http                                                         |
-   +----------------------------------------------------------------------+
-   | This source file is subject to version 3.0 of the PHP license, that  |
-   | is bundled with this package in the file LICENSE, and is available   |
-   | through the world-wide-web at http://www.php.net/license/3_0.txt.    |
-   | If you did not receive a copy of the PHP license and are unable to   |
-   | obtain it through the world-wide-web, please send a note to          |
-   | license@php.net so we can mail you a copy immediately.               |
-   +----------------------------------------------------------------------+
-   | Copyright (c) 2004-2005 Michael Wallner <mike@php.net>               |
-   +----------------------------------------------------------------------+
+    +--------------------------------------------------------------------+
+    | PECL :: http                                                       |
+    +--------------------------------------------------------------------+
+    | Redistribution and use in source and binary forms, with or without |
+    | modification, are permitted provided that the conditions mentioned |
+    | in the accompanying LICENSE file are met.                          |
+    +--------------------------------------------------------------------+
+    | Copyright (c) 2004-2010, Michael Wallner <mike@php.net>            |
+    +--------------------------------------------------------------------+
 */
 
 /* $Id$ */
 #ifndef PHP_HTTP_REQUEST_API_H
 #define PHP_HTTP_REQUEST_API_H
 
-#include "php_http_std_defs.h"
-#include "phpstr/phpstr.h"
+#ifdef HTTP_HAVE_CURL
+
+#include "php_http_request_body_api.h"
+#include "php_http_request_method_api.h"
+
+extern PHP_MINIT_FUNCTION(http_request);
+extern PHP_MSHUTDOWN_FUNCTION(http_request);
+
+typedef struct _http_request_t {
+       CURL *ch;
+       char *url;
+       http_request_method meth;
+       http_request_body *body;
+       
+       struct {
+               curl_infotype last_type;
+               phpstr request;
+               phpstr response;
+       } conv;
+       
+       struct {
+               phpstr cookies;
+               HashTable options;
+               struct curl_slist *headers;
+       } _cache;
+       
+       struct {
+               uint count;
+               double delay;
+       } _retry;
+       
+       char _error[CURL_ERROR_SIZE+1];
+       zval *_progress_callback;
+
+#ifdef ZTS
+       void ***tsrm_ls;
+#endif
+
+       uint _in_progress_cb:1;
+
+} http_request;
 
-#ifdef PHP_WIN32
-#      include <winsock2.h>
+#ifndef pestrndup
+#      define pestrndup(s,l,p) _pestrndup((s),(l),(p))
+static inline void *_pestrndup(const void *s, size_t l, int p)
+{
+       void *d = pemalloc(l+1, p);
+       memcpy(d, s, l);
+       ((char *) d)[l] = '\0';
+       return d;
+}
 #endif
 
-#include <curl/curl.h>
-
-typedef enum {
-       HTTP_NO_REQUEST_METHOD  = 0,
-       /* HTTP/1.1 */
-       HTTP_GET                                = 1,
-       HTTP_HEAD                               = 2,
-       HTTP_POST                               = 3,
-       HTTP_PUT                                = 4,
-       HTTP_DELETE                             = 5,
-       HTTP_OPTIONS                    = 6,
-       HTTP_TRACE                              = 7,
-       HTTP_CONNECT                    = 8,
-       /* WebDAV - RFC 2518 */
-       HTTP_PROPFIND                   = 9,
-       HTTP_PROPPATCH                  = 10,
-       HTTP_MKCOL                              = 11,
-       HTTP_COPY                               = 12,
-       HTTP_MOVE                               = 13,
-       HTTP_LOCK                               = 14,
-       HTTP_UNLOCK                             = 15,
-       /* WebDAV Versioning - RFC 3253 */
-       HTTP_VERSION_CONTROL    = 16,
-       HTTP_REPORT                             = 17,
-       HTTP_CHECKOUT                   = 18,
-       HTTP_CHECKIN                    = 19,
-       HTTP_UNCHECKOUT                 = 20,
-       HTTP_MKWORKSPACE                = 21,
-       HTTP_UPDATE                             = 22,
-       HTTP_LABEL                              = 23,
-       HTTP_MERGE                              = 24,
-       HTTP_BASELINE_CONTROL   = 25,
-       HTTP_MKACTIVITY                 = 26,
-       /* WebDAV Access Control - RFC 3744 */
-       HTTP_ACL                                = 27,
-       HTTP_MAX_REQUEST_METHOD = 28
-} http_request_method;
-
-#define HTTP_STD_REQUEST_METHOD(m) ((m > HTTP_NO_REQUEST_METHOD) && (m < HTTP_MAX_REQUEST_METHOD))
-#define HTTP_CUSTOM_REQUEST_METHOD(m) (m - HTTP_MAX_REQUEST_METHOD)
-
-#define HTTP_REQUEST_BODY_CSTRING              1
-#define HTTP_REQUEST_BODY_CURLPOST             2
-#define HTTP_REQUEST_BODY_UPLOADFILE   3
-#define HTTP_REQUEST_BODY_UPLOADDATA   4
-typedef struct {
-       int type;
-       void *data;
-       size_t size;
-} http_request_body;
-
-typedef struct {
-       CURLM *ch;
-       zend_llist handles;
-       zend_llist bodies;
-       int unfinished;
-} http_request_pool;
-
-#define COPY_STRING    1
-#define        COPY_SLIST      2
-#define http_request_data_copy(type, data) _http_request_data_copy((type), (data) TSRMLS_CC)
-extern void *_http_request_data_copy(int type, void *data TSRMLS_DC);
-#define http_request_data_free_string _http_request_data_free_string
-extern void _http_request_data_free_string(void *string);
-#define http_request_data_free_slist _http_request_data_free_slist
-extern void _http_request_data_free_slist(void *list);
-
-#define http_request_global_init _http_request_global_init
-extern STATUS _http_request_global_init(void);
-
-#define http_request_method_name(m) _http_request_method_name((m) TSRMLS_CC)
-PHP_HTTP_API const char *_http_request_method_name(http_request_method m TSRMLS_DC);
-
-#define http_request_method_exists(u, l, c) _http_request_method_exists((u), (l), (c) TSRMLS_CC)
-PHP_HTTP_API unsigned long _http_request_method_exists(zend_bool by_name, unsigned long id, const char *name TSRMLS_DC);
-
-#define http_request_method_register(m) _http_request_method_register((m) TSRMLS_CC)
-PHP_HTTP_API unsigned long _http_request_method_register(const char *method TSRMLS_DC);
-
-#define http_request_method_unregister(mn) _http_request_method_unregister((mn) TSRMLS_CC)
-PHP_HTTP_API STATUS _http_request_method_unregister(unsigned long method TSRMLS_DC);
-
-#define http_request_body_new() _http_request_body_new(TSRMLS_C)
-PHP_HTTP_API http_request_body *_http_request_body_new(TSRMLS_D);
-
-#define http_request_body_fill(b, fields, files) _http_request_body_fill((b), (fields), (files) TSRMLS_CC)
-PHP_HTTP_API STATUS _http_request_body_fill(http_request_body *body, HashTable *fields, HashTable *files TSRMLS_DC);
-
-#define http_request_body_dtor(b) _http_request_body_dtor((b) TSRMLS_CC)
-PHP_HTTP_API void _http_request_body_dtor(http_request_body *body TSRMLS_DC);
-
-#define http_request_body_free(b) _http_request_body_free((b) TSRMLS_CC)
-PHP_HTTP_API void _http_request_body_free(http_request_body *body TSRMLS_DC);
-
-#define http_request_pool_init(p) _http_request_pool_init((p) TSRMLS_CC)
-PHP_HTTP_API http_request_pool *_http_request_pool_init(http_request_pool *pool TSRMLS_DC);
-
-#define http_request_pool_attach(p, r) _http_request_pool_attach((p), (r) TSRMLS_CC)
-PHP_HTTP_API STATUS _http_request_pool_attach(http_request_pool *pool, zval *request TSRMLS_DC);
-
-#define http_request_pool_detach(p, r) _http_request_pool_detach((p), (r) TSRMLS_CC)
-PHP_HTTP_API STATUS _http_request_pool_detach(http_request_pool *pool, zval *request TSRMLS_DC);
-
-#define http_request_pool_send(p) _http_request_pool_send((p) TSRMLS_CC)
-PHP_HTTP_API STATUS _http_request_pool_send(http_request_pool *pool TSRMLS_DC);
-
-#define http_request_pool_dtor(p) _http_request_pool_dtor((p) TSRMLS_CC)
-PHP_HTTP_API void _http_request_pool_dtor(http_request_pool *pool TSRMLS_DC);
-
-#define http_request_init(ch, meth, url, body, options, response) _http_request_init((ch), (meth), (url), (body), (options), (response) TSRMLS_CC)
-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);
-
-#define http_request_exec(ch, i) _http_request_exec((ch), (i) TSRMLS_CC)
-PHP_HTTP_API STATUS _http_request_exec(CURL *ch, HashTable *info TSRMLS_DC);
-
-#define http_request_info(ch, i) _http_request_info((ch), (i) TSRMLS_CC)
-PHP_HTTP_API void _http_request_info(CURL *ch, HashTable *info TSRMLS_DC);
-
-#define http_request(meth, url, body, opt, info, resp) _http_request_ex(NULL, (meth), (url), (body), (opt), (info), (resp) TSRMLS_CC)
-#define http_request_ex(ch, meth, url, body, opt, info, resp) _http_request_ex((ch), (meth), (url), (body), (opt), (info), (resp) TSRMLS_CC)
-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);
-
-#define http_get(u, o, i, r) _http_request_ex(NULL, HTTP_GET, (u), NULL, (o), (i), (r) TSRMLS_CC)
-#define http_get_ex(c, u, o, i, r) _http_request_ex((c), HTTP_GET, (u), NULL, (o), (i), (r) TSRMLS_CC)
+/* CURLOPT_PRIVATE storage living as long as a CURL handle */
+typedef struct _http_request_storage_t {
+       char *url;
+       char *cookiestore;
+       char errorbuffer[CURL_ERROR_SIZE];
+} http_request_storage;
+
+static inline http_request_storage *http_request_storage_get(CURL *ch)
+{
+       http_request_storage *st = NULL;
+       curl_easy_getinfo(ch, CURLINFO_PRIVATE, &st);
+       return st;
+}
+
+#define http_curl_init(r) http_curl_init_ex(NULL, (r))
+#define http_curl_init_ex(c, r) _http_curl_init_ex((c), (r) TSRMLS_CC)
+PHP_HTTP_API CURL *_http_curl_init_ex(CURL *ch, http_request *request TSRMLS_DC);
+
+#define http_curl_free(c) _http_curl_free((c) TSRMLS_CC)
+PHP_HTTP_API void _http_curl_free(CURL **ch TSRMLS_DC);
+
+#define http_curl_copy(c) _http_curl_copy((c) TSRMLS_CC)
+PHP_HTTP_API CURL *_http_curl_copy(CURL *ch TSRMLS_DC);
+
+#define http_request_new() _http_request_init_ex(NULL, NULL, 0, NULL ZEND_FILE_LINE_CC ZEND_FILE_LINE_EMPTY_CC TSRMLS_CC)
+#define http_request_init(r) _http_request_init_ex((r), NULL, 0, NULL ZEND_FILE_LINE_CC ZEND_FILE_LINE_EMPTY_CC TSRMLS_CC)
+#define http_request_init_ex(r, c, m, u) _http_request_init_ex((r), (c), (m), (u) ZEND_FILE_LINE_CC ZEND_FILE_LINE_EMPTY_CC TSRMLS_CC)
+PHP_HTTP_API http_request *_http_request_init_ex(http_request *request, CURL *ch, http_request_method meth, const char *url ZEND_FILE_LINE_DC ZEND_FILE_LINE_ORIG_DC TSRMLS_DC);
+
+#define http_request_dtor(r) _http_request_dtor((r))
+PHP_HTTP_API void _http_request_dtor(http_request *request);
 
-#define http_head(u, o, i, r) _http_request_ex(NULL, HTTP_HEAD, (u), NULL, (o), (i), (r) TSRMLS_CC)
-#define http_head_ex(c, u, o, i, r) _http_request_ex((c), HTTP_HEAD, (u), NULL, (o), (i), (r) TSRMLS_CC)
+#define http_request_free(r) _http_request_free((r))
+PHP_HTTP_API void _http_request_free(http_request **request);
 
-#define http_post(u, b, o, i, r) _http_request_ex(NULL, HTTP_POST, (u), (b), (o), (i), (r) TSRMLS_CC)
-#define http_post_ex(c, u, b, o, i, r) _http_request_ex((c), HTTP_POST, (u), (b), (o), (i), (r) TSRMLS_CC)
+#define http_request_reset(r) _http_request_reset(r)
+PHP_HTTP_API void _http_request_reset(http_request *r);
 
-#define http_put(u, b, o, i, r) _http_request_ex(NULL, HTTP_PUT, (u), (b), (o), (i), (r) TSRMLS_CC)
-#define http_put_ex(c, u, b, o, i, r) _http_request_ex((c), HTTP_PUT, (u), (b), (o), (i), (r) TSRMLS_CC)
+#define http_request_enable_cookies(r) _http_request_enable_cookies(r)
+PHP_HTTP_API STATUS _http_request_enable_cookies(http_request *request);
 
+#define http_request_reset_cookies(r, s) _http_request_reset_cookies((r), (s))
+PHP_HTTP_API STATUS _http_request_reset_cookies(http_request *request, int session_only);
+
+#define http_request_flush_cookies(r) _http_request_flush_cookies(r)
+PHP_HTTP_API STATUS _http_request_flush_cookies(http_request *request);
+
+#define http_request_defaults(r) _http_request_defaults(r)
+PHP_HTTP_API void _http_request_defaults(http_request *request);
+
+#define http_request_prepare(r, o) _http_request_prepare((r), (o))
+PHP_HTTP_API STATUS _http_request_prepare(http_request *request, HashTable *options);
+
+#define http_request_exec(r) _http_request_exec((r))
+PHP_HTTP_API void _http_request_exec(http_request *request);
+
+#define http_request_info(r, i) _http_request_info((r), (i))
+PHP_HTTP_API void _http_request_info(http_request *request, HashTable *info);
+
+#define http_request_set_progress_callback(r, cb) _http_request_set_progress_callback((r), (cb))
+PHP_HTTP_API void _http_request_set_progress_callback(http_request *request, zval *cb);
+
+#endif
 #endif
 
 /*