git.m6w6.name Git - m6w6/ext-http/blob - http_request_object.c

   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
  19 #ifdef HAVE_CONFIG_H
  20 #       include "config.h"
  21 #endif
  22 #include "php.h"
  23
  24 #if defined(ZEND_ENGINE_2) && defined(HTTP_HAVE_CURL)
  25
  26 #include "php_http_std_defs.h"
  27 #include "php_http_request_object.h"
  28 #include "php_http_request_api.h"
  29 #include "php_http_request_pool_api.h"
  30 #include "php_http_api.h"
  31 #include "php_http_url_api.h"
  32 #include "php_http_message_api.h"
  33 #include "php_http_message_object.h"
  34
  35 #ifdef PHP_WIN32
  36 #       include <winsock2.h>
  37 #endif
  38 #include <curl/curl.h>
  39
  40 #define HTTP_BEGIN_ARGS(method, req_args)               HTTP_BEGIN_ARGS_EX(HttpRequest, method, ZEND_RETURN_REFERENCE_AGNOSTIC, req_args)
  41 #define HTTP_EMPTY_ARGS(method, ret_ref)                HTTP_EMPTY_ARGS_EX(HttpRequest, method, ret_ref)
  42 #define HTTP_REQUEST_ME(method, visibility)             PHP_ME(HttpRequest, method, HTTP_ARGS(HttpRequest, method), visibility)
  43
  44 HTTP_EMPTY_ARGS(__destruct, 0);
  45 HTTP_BEGIN_ARGS(__construct, 0)
  46         HTTP_ARG_VAL(url, 0)
  47         HTTP_ARG_VAL(method, 0)
  48 HTTP_END_ARGS;
  49
  50 HTTP_EMPTY_ARGS(getOptions, 0);
  51 HTTP_EMPTY_ARGS(unsetOptions, 0);
  52 HTTP_BEGIN_ARGS(setOptions, 1)
  53         HTTP_ARG_VAL(options, 0)
  54 HTTP_END_ARGS;
  55
  56 HTTP_EMPTY_ARGS(getSslOptions, 0);
  57 HTTP_EMPTY_ARGS(unsetSslOptions, 0);
  58 HTTP_BEGIN_ARGS(setSslOptions, 1)
  59         HTTP_ARG_VAL(ssl_options, 0)
  60 HTTP_END_ARGS;
  61
  62 HTTP_EMPTY_ARGS(getHeaders, 0);
  63 HTTP_EMPTY_ARGS(unsetHeaders, 0);
  64 HTTP_BEGIN_ARGS(addHeaders, 1)
  65         HTTP_ARG_VAL(headers, 0)
  66 HTTP_END_ARGS;
  67
  68 HTTP_EMPTY_ARGS(getCookies, 0);
  69 HTTP_EMPTY_ARGS(unsetCookies, 0);
  70 HTTP_BEGIN_ARGS(addCookies, 1)
  71         HTTP_ARG_VAL(cookies, 0)
  72 HTTP_END_ARGS;
  73
  74 HTTP_EMPTY_ARGS(getUrl, 0);
  75 HTTP_BEGIN_ARGS(setUrl, 1)
  76         HTTP_ARG_VAL(url, 0)
  77 HTTP_END_ARGS;
  78
  79 HTTP_EMPTY_ARGS(getMethod, 0);
  80 HTTP_BEGIN_ARGS(setMethod, 1)
  81         HTTP_ARG_VAL(request_method, 0)
  82 HTTP_END_ARGS;
  83
  84 HTTP_EMPTY_ARGS(getContentType, 0);
  85 HTTP_BEGIN_ARGS(setContentType, 1)
  86         HTTP_ARG_VAL(content_type, 0)
  87 HTTP_END_ARGS;
  88
  89 HTTP_EMPTY_ARGS(getQueryData, 0);
  90 HTTP_EMPTY_ARGS(unsetQueryData, 0);
  91 HTTP_BEGIN_ARGS(setQueryData, 1)
  92         HTTP_ARG_VAL(query_data, 0)
  93 HTTP_END_ARGS;
  94
  95 HTTP_BEGIN_ARGS(addQueryData, 1)
  96         HTTP_ARG_VAL(query_data, 0)
  97 HTTP_END_ARGS;
  98
  99 HTTP_EMPTY_ARGS(getPostFields, 0);
 100 HTTP_EMPTY_ARGS(unsetPostFields, 0);
 101 HTTP_BEGIN_ARGS(setPostFields, 1)
 102         HTTP_ARG_VAL(post_fields, 0)
 103 HTTP_END_ARGS;
 104
 105 HTTP_BEGIN_ARGS(addPostFields, 1)
 106         HTTP_ARG_VAL(post_fields, 0)
 107 HTTP_END_ARGS;
 108
 109 HTTP_EMPTY_ARGS(getPostFiles, 0);
 110 HTTP_EMPTY_ARGS(unsetPostFiles, 0);
 111 HTTP_BEGIN_ARGS(setPostFiles, 1)
 112         HTTP_ARG_VAL(post_files, 0)
 113 HTTP_END_ARGS;
 114
 115 HTTP_BEGIN_ARGS(addPostFile, 2)
 116         HTTP_ARG_VAL(formname, 0)
 117         HTTP_ARG_VAL(filename, 0)
 118         HTTP_ARG_VAL(content_type, 0)
 119 HTTP_END_ARGS;
 120
 121 HTTP_EMPTY_ARGS(getPutFile, 0);
 122 HTTP_EMPTY_ARGS(unsetPutFile, 0);
 123 HTTP_BEGIN_ARGS(setPutFile, 1)
 124         HTTP_ARG_VAL(filename, 0)
 125 HTTP_END_ARGS;
 126
 127 HTTP_EMPTY_ARGS(getResponseData, 0);
 128 HTTP_BEGIN_ARGS(getResponseHeader, 0)
 129         HTTP_ARG_VAL(name, 0)
 130 HTTP_END_ARGS;
 131
 132 HTTP_BEGIN_ARGS(getResponseCookie, 0)
 133         HTTP_ARG_VAL(name, 0)
 134 HTTP_END_ARGS;
 135
 136 HTTP_EMPTY_ARGS(getResponseBody, 0);
 137 HTTP_EMPTY_ARGS(getResponseCode, 0);
 138 HTTP_BEGIN_ARGS(getResponseInfo, 0)
 139         HTTP_ARG_VAL(name, 0)
 140 HTTP_END_ARGS;
 141
 142 HTTP_EMPTY_ARGS(getResponseMessage, 1);
 143 HTTP_EMPTY_ARGS(send, 0);
 144
 145 #define http_request_object_declare_default_properties() _http_request_object_declare_default_properties(TSRMLS_C)
 146 static inline void _http_request_object_declare_default_properties(TSRMLS_D);
 147
 148 zend_class_entry *http_request_object_ce;
 149 zend_function_entry http_request_object_fe[] = {
 150         HTTP_REQUEST_ME(__construct, ZEND_ACC_PUBLIC|ZEND_ACC_CTOR)
 151         HTTP_REQUEST_ME(__destruct, ZEND_ACC_PUBLIC|ZEND_ACC_DTOR)
 152
 153         HTTP_REQUEST_ME(setOptions, ZEND_ACC_PUBLIC)
 154         HTTP_REQUEST_ME(getOptions, ZEND_ACC_PUBLIC)
 155         HTTP_REQUEST_ME(unsetOptions, ZEND_ACC_PUBLIC)
 156         HTTP_REQUEST_ME(setSslOptions, ZEND_ACC_PUBLIC)
 157         HTTP_REQUEST_ME(getSslOptions, ZEND_ACC_PUBLIC)
 158         HTTP_REQUEST_ME(unsetSslOptions, ZEND_ACC_PUBLIC)
 159
 160         HTTP_REQUEST_ME(addHeaders, ZEND_ACC_PUBLIC)
 161         HTTP_REQUEST_ME(getHeaders, ZEND_ACC_PUBLIC)
 162         HTTP_REQUEST_ME(unsetHeaders, ZEND_ACC_PUBLIC)
 163         HTTP_REQUEST_ME(addCookies, ZEND_ACC_PUBLIC)
 164         HTTP_REQUEST_ME(getCookies, ZEND_ACC_PUBLIC)
 165         HTTP_REQUEST_ME(unsetCookies, ZEND_ACC_PUBLIC)
 166
 167         HTTP_REQUEST_ME(setMethod, ZEND_ACC_PUBLIC)
 168         HTTP_REQUEST_ME(getMethod, ZEND_ACC_PUBLIC)
 169
 170         HTTP_REQUEST_ME(setUrl, ZEND_ACC_PUBLIC)
 171         HTTP_REQUEST_ME(getUrl, ZEND_ACC_PUBLIC)
 172
 173         HTTP_REQUEST_ME(setContentType, ZEND_ACC_PUBLIC)
 174         HTTP_REQUEST_ME(getContentType, ZEND_ACC_PUBLIC)
 175
 176         HTTP_REQUEST_ME(setQueryData, ZEND_ACC_PUBLIC)
 177         HTTP_REQUEST_ME(getQueryData, ZEND_ACC_PUBLIC)
 178         HTTP_REQUEST_ME(addQueryData, ZEND_ACC_PUBLIC)
 179         HTTP_REQUEST_ME(unsetQueryData, ZEND_ACC_PUBLIC)
 180
 181         HTTP_REQUEST_ME(setPostFields, ZEND_ACC_PUBLIC)
 182         HTTP_REQUEST_ME(getPostFields, ZEND_ACC_PUBLIC)
 183         HTTP_REQUEST_ME(addPostFields, ZEND_ACC_PUBLIC)
 184         HTTP_REQUEST_ME(unsetPostFields, ZEND_ACC_PUBLIC)
 185
 186         HTTP_REQUEST_ME(setPostFiles, ZEND_ACC_PUBLIC)
 187         HTTP_REQUEST_ME(addPostFile, ZEND_ACC_PUBLIC)
 188         HTTP_REQUEST_ME(getPostFiles, ZEND_ACC_PUBLIC)
 189         HTTP_REQUEST_ME(unsetPostFiles, ZEND_ACC_PUBLIC)
 190
 191         HTTP_REQUEST_ME(setPutFile, ZEND_ACC_PUBLIC)
 192         HTTP_REQUEST_ME(getPutFile, ZEND_ACC_PUBLIC)
 193         HTTP_REQUEST_ME(unsetPutFile, ZEND_ACC_PUBLIC)
 194
 195         HTTP_REQUEST_ME(send, ZEND_ACC_PUBLIC)
 196
 197         HTTP_REQUEST_ME(getResponseData, ZEND_ACC_PUBLIC)
 198         HTTP_REQUEST_ME(getResponseHeader, ZEND_ACC_PUBLIC)
 199         HTTP_REQUEST_ME(getResponseCookie, ZEND_ACC_PUBLIC)
 200         HTTP_REQUEST_ME(getResponseCode, ZEND_ACC_PUBLIC)
 201         HTTP_REQUEST_ME(getResponseBody, ZEND_ACC_PUBLIC)
 202         HTTP_REQUEST_ME(getResponseInfo, ZEND_ACC_PUBLIC)
 203         HTTP_REQUEST_ME(getResponseMessage, ZEND_ACC_PUBLIC)
 204
 205         {NULL, NULL, NULL}
 206 };
 207 static zend_object_handlers http_request_object_handlers;
 208
 209 void _http_request_object_init(INIT_FUNC_ARGS)
 210 {
 211         HTTP_REGISTER_CLASS_EX(HttpRequest, http_request_object, NULL, 0);
 212
 213         /* HTTP/1.1 */
 214         HTTP_LONG_CONSTANT("HTTP_GET", HTTP_GET);
 215         HTTP_LONG_CONSTANT("HTTP_HEAD", HTTP_HEAD);
 216         HTTP_LONG_CONSTANT("HTTP_POST", HTTP_POST);
 217         HTTP_LONG_CONSTANT("HTTP_PUT", HTTP_PUT);
 218         HTTP_LONG_CONSTANT("HTTP_DELETE", HTTP_DELETE);
 219         HTTP_LONG_CONSTANT("HTTP_OPTIONS", HTTP_OPTIONS);
 220         HTTP_LONG_CONSTANT("HTTP_TRACE", HTTP_TRACE);
 221         HTTP_LONG_CONSTANT("HTTP_CONNECT", HTTP_CONNECT);
 222         /* WebDAV - RFC 2518 */
 223         HTTP_LONG_CONSTANT("HTTP_PROPFIND", HTTP_PROPFIND);
 224         HTTP_LONG_CONSTANT("HTTP_PROPPATCH", HTTP_PROPPATCH);
 225         HTTP_LONG_CONSTANT("HTTP_MKCOL", HTTP_MKCOL);
 226         HTTP_LONG_CONSTANT("HTTP_COPY", HTTP_COPY);
 227         HTTP_LONG_CONSTANT("HTTP_MOVE", HTTP_MOVE);
 228         HTTP_LONG_CONSTANT("HTTP_LOCK", HTTP_LOCK);
 229         HTTP_LONG_CONSTANT("HTTP_UNLOCK", HTTP_UNLOCK);
 230         /* WebDAV Versioning - RFC 3253 */
 231         HTTP_LONG_CONSTANT("HTTP_VERSION_CONTROL", HTTP_VERSION_CONTROL);
 232         HTTP_LONG_CONSTANT("HTTP_REPORT", HTTP_REPORT);
 233         HTTP_LONG_CONSTANT("HTTP_CHECKOUT", HTTP_CHECKOUT);
 234         HTTP_LONG_CONSTANT("HTTP_CHECKIN", HTTP_CHECKIN);
 235         HTTP_LONG_CONSTANT("HTTP_UNCHECKOUT", HTTP_UNCHECKOUT);
 236         HTTP_LONG_CONSTANT("HTTP_MKWORKSPACE", HTTP_MKWORKSPACE);
 237         HTTP_LONG_CONSTANT("HTTP_UPDATE", HTTP_UPDATE);
 238         HTTP_LONG_CONSTANT("HTTP_LABEL", HTTP_LABEL);
 239         HTTP_LONG_CONSTANT("HTTP_MERGE", HTTP_MERGE);
 240         HTTP_LONG_CONSTANT("HTTP_BASELINE_CONTROL", HTTP_BASELINE_CONTROL);
 241         HTTP_LONG_CONSTANT("HTTP_MKACTIVITY", HTTP_MKACTIVITY);
 242         /* WebDAV Access Control - RFC 3744 */
 243         HTTP_LONG_CONSTANT("HTTP_ACL", HTTP_ACL);
 244
 245
 246 #       if LIBCURL_VERSION_NUM >= 0x070a05
 247         HTTP_LONG_CONSTANT("HTTP_AUTH_BASIC", CURLAUTH_BASIC);
 248         HTTP_LONG_CONSTANT("HTTP_AUTH_DIGEST", CURLAUTH_DIGEST);
 249         HTTP_LONG_CONSTANT("HTTP_AUTH_NTLM", CURLAUTH_NTLM);
 250 #       endif /* LIBCURL_VERSION_NUM */
 251 }
 252
 253 zend_object_value _http_request_object_new(zend_class_entry *ce TSRMLS_DC)
 254 {
 255         zend_object_value ov;
 256         http_request_object *o;
 257
 258         o = ecalloc(1, sizeof(http_request_object));
 259         o->zo.ce = ce;
 260         o->ch = curl_easy_init();
 261         o->pool = NULL;
 262
 263         phpstr_init_ex(&o->response, HTTP_CURLBUF_SIZE, 0);
 264
 265         ALLOC_HASHTABLE(OBJ_PROP(o));
 266         zend_hash_init(OBJ_PROP(o), 0, NULL, ZVAL_PTR_DTOR, 0);
 267         zend_hash_copy(OBJ_PROP(o), &ce->default_properties, (copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval *));
 268
 269         ov.handle = zend_objects_store_put(o, (zend_objects_store_dtor_t) zend_objects_destroy_object, http_request_object_free, NULL TSRMLS_CC);
 270         ov.handlers = &http_request_object_handlers;
 271
 272         return ov;
 273 }
 274
 275 static inline void _http_request_object_declare_default_properties(TSRMLS_D)
 276 {
 277         zend_class_entry *ce = http_request_object_ce;
 278
 279         DCL_PROP_N(PROTECTED, options);
 280         DCL_PROP_N(PROTECTED, responseInfo);
 281         DCL_PROP_N(PROTECTED, responseData);
 282         DCL_PROP_N(PROTECTED, responseCode);
 283         DCL_PROP_N(PROTECTED, responseMessage);
 284         DCL_PROP_N(PROTECTED, postFields);
 285         DCL_PROP_N(PROTECTED, postFiles);
 286
 287         DCL_PROP(PROTECTED, long, method, HTTP_GET);
 288
 289         DCL_PROP(PROTECTED, string, url, "");
 290         DCL_PROP(PROTECTED, string, contentType, "");
 291         DCL_PROP(PROTECTED, string, queryData, "");
 292         DCL_PROP(PROTECTED, string, putFile, "");
 293 }
 294
 295 void _http_request_object_free(zend_object *object TSRMLS_DC)
 296 {
 297         http_request_object *o = (http_request_object *) object;
 298
 299         if (OBJ_PROP(o)) {
 300                 zend_hash_destroy(OBJ_PROP(o));
 301                 FREE_HASHTABLE(OBJ_PROP(o));
 302         }
 303         if (o->ch) {
 304                 curl_easy_cleanup(o->ch);
 305         }
 306         phpstr_dtor(&o->response);
 307         efree(o);
 308 }
 309
 310 STATUS _http_request_object_requesthandler(http_request_object *obj, zval *this_ptr, http_request_body *body TSRMLS_DC)
 311 {
 312         zval *meth, *URL, *qdata, *opts;
 313         char *request_uri;
 314         STATUS status;
 315
 316         if (!body) {
 317                 return FAILURE;
 318         }
 319         if ((!obj->ch) && (!(obj->ch = curl_easy_init()))) {
 320                 http_error(E_WARNING, HTTP_E_CURL, "Could not initilaize curl");
 321                 return FAILURE;
 322         }
 323
 324         meth  = GET_PROP(obj, method);
 325         URL   = GET_PROP(obj, url);
 326         qdata = GET_PROP(obj, queryData);
 327         opts  = GET_PROP(obj, options);
 328
 329         // HTTP_URI_MAXLEN+1 long char *
 330         if (!(request_uri = http_absolute_uri_ex(Z_STRVAL_P(URL), Z_STRLEN_P(URL), NULL, 0, NULL, 0, 0))) {
 331                 return FAILURE;
 332         }
 333
 334         if (Z_STRLEN_P(qdata) && (strlen(request_uri) < HTTP_URI_MAXLEN)) {
 335                 if (!strchr(request_uri, '?')) {
 336                         strcat(request_uri, "?");
 337                 } else {
 338                         strcat(request_uri, "&");
 339                 }
 340                 strncat(request_uri, Z_STRVAL_P(qdata), HTTP_URI_MAXLEN - strlen(request_uri));
 341         }
 342
 343         switch (Z_LVAL_P(meth))
 344         {
 345                 case HTTP_GET:
 346                 case HTTP_HEAD:
 347                         body->type = -1;
 348                         status = http_request_init(obj->ch, Z_LVAL_P(meth), request_uri, NULL, Z_ARRVAL_P(opts), &obj->response);
 349                 break;
 350
 351                 case HTTP_PUT:
 352                 {
 353                         php_stream *stream;
 354                         php_stream_statbuf ssb;
 355                         zval *file = GET_PROP(obj, putFile);
 356
 357                         if (    (stream = php_stream_open_wrapper(Z_STRVAL_P(file), "rb", REPORT_ERRORS|ENFORCE_SAFE_MODE, NULL)) &&
 358                                         !php_stream_stat(stream, &ssb)) {
 359                                 body->type = HTTP_REQUEST_BODY_UPLOADFILE;
 360                                 body->data = stream;
 361                                 body->size = ssb.sb.st_size;
 362
 363                                 status = http_request_init(obj->ch, HTTP_PUT, request_uri, body, Z_ARRVAL_P(opts), &obj->response);
 364                         } else {
 365                                 status = FAILURE;
 366                         }
 367                 }
 368                 break;
 369
 370                 case HTTP_POST:
 371                 {
 372                         zval *fields = GET_PROP(obj, postFields), *files = GET_PROP(obj, postFiles);
 373
 374                         if (SUCCESS == (status = http_request_body_fill(body, Z_ARRVAL_P(fields), Z_ARRVAL_P(files)))) {
 375                                 status = http_request_init(obj->ch, HTTP_POST, request_uri, body, Z_ARRVAL_P(opts), &obj->response);
 376                         }
 377                 }
 378                 break;
 379
 380                 default:
 381                 {
 382                         zval *post = GET_PROP(obj, postData);
 383
 384                         body->type = HTTP_REQUEST_BODY_CSTRING;
 385                         body->data = Z_STRVAL_P(post);
 386                         body->size = Z_STRLEN_P(post);
 387
 388                         status = http_request_init(obj->ch, Z_LVAL_P(meth), request_uri, body, Z_ARRVAL_P(opts), &obj->response);
 389                 }
 390                 break;
 391         }
 392
 393         efree(request_uri);
 394         return status;
 395 }
 396
 397 STATUS _http_request_object_responsehandler(http_request_object *obj, zval *this_ptr TSRMLS_DC)
 398 {
 399         http_message *msg;
 400
 401         phpstr_fix(&obj->response);
 402
 403         if (msg = http_message_parse(PHPSTR_VAL(&obj->response), PHPSTR_LEN(&obj->response))) {
 404                 char *body;
 405                 size_t body_len;
 406                 zval *headers, *message, *resp = GET_PROP(obj, responseData), *info = GET_PROP(obj, responseInfo);
 407
 408                 UPD_PROP(obj, long, responseCode, msg->info.response.code);
 409
 410                 MAKE_STD_ZVAL(headers)
 411                 array_init(headers);
 412
 413                 zend_hash_copy(Z_ARRVAL_P(headers), &msg->hdrs, (copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval *));
 414                 phpstr_data(PHPSTR(msg), &body, &body_len);
 415
 416                 add_assoc_zval(resp, "headers", headers);
 417                 add_assoc_stringl(resp, "body", body, body_len, 0);
 418
 419                 MAKE_STD_ZVAL(message);
 420                 message->type = IS_OBJECT;
 421                 message->is_ref = 1;
 422                 message->value.obj = http_message_object_from_msg(msg);
 423                 SET_PROP(obj, responseMessage, message);
 424                 zval_ptr_dtor(&message);
 425
 426                 http_request_info(obj->ch, Z_ARRVAL_P(info));
 427                 SET_PROP(obj, responseInfo, info);
 428
 429                 return SUCCESS;
 430         }
 431         return FAILURE;
 432 }
 433
 434 #endif /* ZEND_ENGINE_2 && HTTP_HAVE_CURL */
 435
 436 /*
 437  * Local variables:
 438  * tab-width: 4
 439  * c-basic-offset: 4
 440  * End:
 441  * vim600: noet sw=4 ts=4 fdm=marker
 442  * vim<600: noet sw=4 ts=4
 443  */
 444