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

   1 /*
   2     +--------------------------------------------------------------------+
   3     | PECL :: http                                                       |
   4     +--------------------------------------------------------------------+
   5     | Redistribution and use in source and binary forms, with or without |
   6     | modification, are permitted provided that the conditions mentioned |
   7     | in the accompanying LICENSE file are met.                          |
   8     +--------------------------------------------------------------------+
   9     | Copyright (c) 2004-2005, Michael Wallner <mike@php.net>            |
  10     +--------------------------------------------------------------------+
  11 */
  12
  13 /* $Id$ */
  14
  15 #ifdef HAVE_CONFIG_H
  16 #       include "config.h"
  17 #endif
  18 #include "php.h"
  19
  20 #include "php_http.h"
  21 #include "php_http_std_defs.h"
  22 #include "php_http_api.h"
  23 #include "php_http_message_api.h"
  24 #include "php_http_headers_api.h"
  25 #include "php_http_send_api.h"
  26 #include "php_http_request_api.h"
  27 #include "php_http_url_api.h"
  28 #include "php_http_encoding_api.h"
  29
  30 #include "phpstr/phpstr.h"
  31
  32 ZEND_EXTERN_MODULE_GLOBALS(http);
  33
  34 #define http_message_info_callback _http_message_info_callback
  35 static void _http_message_info_callback(http_message **message, HashTable **headers, http_info *info TSRMLS_DC)
  36 {
  37         http_message *old = *message;
  38
  39         /* advance message */
  40         if (old->type || zend_hash_num_elements(&old->hdrs) || PHPSTR_LEN(old)) {
  41                 (*message) = http_message_new();
  42                 (*message)->parent = old;
  43                 (*headers) = &((*message)->hdrs);
  44         }
  45
  46         (*message)->http.version = info->http.version;
  47
  48         switch (info->type)
  49         {
  50                 case IS_HTTP_REQUEST:
  51                         (*message)->type = HTTP_MSG_REQUEST;
  52                         HTTP_INFO(*message).request.URI = estrdup(HTTP_INFO(info).request.URI);
  53                         HTTP_INFO(*message).request.method = estrdup(HTTP_INFO(info).request.method);
  54                 break;
  55
  56                 case IS_HTTP_RESPONSE:
  57                         (*message)->type = HTTP_MSG_RESPONSE;
  58                         HTTP_INFO(*message).response.code = HTTP_INFO(info).response.code;
  59                         HTTP_INFO(*message).response.status = estrdup(HTTP_INFO(info).response.status);
  60                 break;
  61         }
  62 }
  63
  64 #define http_message_init_type _http_message_init_type
  65 static inline void _http_message_init_type(http_message *message, http_message_type type)
  66 {
  67         message->http.version = .0;
  68
  69         switch (message->type = type)
  70         {
  71                 case HTTP_MSG_RESPONSE:
  72                         message->http.info.response.code = 0;
  73                         message->http.info.response.status = NULL;
  74                 break;
  75
  76                 case HTTP_MSG_REQUEST:
  77                         message->http.info.request.method = NULL;
  78                         message->http.info.request.URI = NULL;
  79                 break;
  80
  81                 case HTTP_MSG_NONE:
  82                 default:
  83                 break;
  84         }
  85 }
  86
  87 PHP_HTTP_API http_message *_http_message_init_ex(http_message *message, http_message_type type)
  88 {
  89         if (!message) {
  90                 message = ecalloc(1, sizeof(http_message));
  91         }
  92
  93         http_message_init_type(message, type);
  94         message->parent = NULL;
  95         phpstr_init(&message->body);
  96         zend_hash_init(&message->hdrs, 0, NULL, ZVAL_PTR_DTOR, 0);
  97
  98         return message;
  99 }
 100
 101
 102 PHP_HTTP_API void _http_message_set_type(http_message *message, http_message_type type)
 103 {
 104         /* just act if different */
 105         if (type != message->type) {
 106
 107                 /* free request info */
 108                 switch (message->type)
 109                 {
 110                         case HTTP_MSG_REQUEST:
 111                                 STR_FREE(message->http.info.request.method);
 112                                 STR_FREE(message->http.info.request.URI);
 113                         break;
 114
 115                         case HTTP_MSG_RESPONSE:
 116                                 STR_FREE(message->http.info.response.status);
 117                         break;
 118
 119                         default:
 120                         break;
 121                 }
 122
 123                 /* init */
 124                 http_message_init_type(message, type);
 125         }
 126 }
 127
 128 PHP_HTTP_API http_message *_http_message_parse_ex(http_message *msg, const char *message, size_t message_length TSRMLS_DC)
 129 {
 130         const char *body = NULL;
 131         zend_bool free_msg = msg ? 0 : 1;
 132
 133         if ((!message) || (message_length < HTTP_MSG_MIN_SIZE)) {
 134                 return NULL;
 135         }
 136
 137         msg = http_message_init(msg);
 138
 139         if (SUCCESS != http_parse_headers_cb(message, &msg->hdrs, 1, (http_info_callback) http_message_info_callback, (void **) &msg)) {
 140                 if (free_msg) {
 141                         http_message_free(&msg);
 142                 }
 143                 return NULL;
 144         }
 145
 146         /* header parsing stops at (CR)LF (CR)LF */
 147         if ((body = http_locate_body(message))) {
 148                 zval *c;
 149                 const char *continue_at = NULL;
 150                 size_t remaining = message + message_length - body;
 151
 152                 /* message has chunked transfer encoding */
 153                 if ((c = http_message_header(msg, "Transfer-Encoding")) && (!strcasecmp("chunked", Z_STRVAL_P(c)))) {
 154                         char *decoded;
 155                         size_t decoded_len;
 156
 157                         /* decode and replace Transfer-Encoding with Content-Length header */
 158                         if ((continue_at = http_encoding_dechunk(body, message + message_length - body, &decoded, &decoded_len))) {
 159                                 zval *len;
 160                                 char *tmp;
 161                                 int tmp_len;
 162
 163                                 tmp_len = (int) spprintf(&tmp, 0, "%zu", decoded_len);
 164                                 MAKE_STD_ZVAL(len);
 165                                 ZVAL_STRINGL(len, tmp, tmp_len, 0);
 166
 167                                 zend_hash_del(&msg->hdrs, "Transfer-Encoding", sizeof("Transfer-Encoding"));
 168                                 zend_hash_del(&msg->hdrs, "Content-Length", sizeof("Content-Length"));
 169                                 zend_hash_add(&msg->hdrs, "Content-Length", sizeof("Content-Length"), (void *) &len, sizeof(zval *), NULL);
 170
 171                                 phpstr_from_string_ex(PHPSTR(msg), decoded, decoded_len);
 172                                 efree(decoded);
 173                         }
 174                 } else
 175
 176                 /* message has content-length header */
 177                 if ((c = http_message_header(msg, "Content-Length"))) {
 178                         ulong len = strtoul(Z_STRVAL_P(c), NULL, 10);
 179                         if (len > remaining) {
 180                                 http_error_ex(HE_NOTICE, HTTP_E_MALFORMED_HEADERS, "The Content-Length header pretends a larger body than actually received (expected %lu bytes; got %lu bytes)", len, remaining);
 181                                 len = remaining;
 182                         }
 183                         phpstr_from_string_ex(PHPSTR(msg), body, len);
 184                         continue_at = body + len;
 185                 } else
 186
 187                 /* message has content-range header */
 188                 if ((c = http_message_header(msg, "Content-Range"))) {
 189                         ulong total = 0, start = 0, end = 0, len = 0;
 190
 191                         if (!strncasecmp(Z_STRVAL_P(c), "bytes", lenof("bytes")) &&
 192                                         (Z_STRVAL_P(c)[lenof("bytes")] == ':' || Z_STRVAL_P(c)[lenof("bytes")] == ' ')) {
 193                                 char *total_at = NULL, *end_at = NULL;
 194                                 char *start_at = Z_STRVAL_P(c) + sizeof("bytes");
 195
 196                                 start = strtoul(start_at, &end_at, 10);
 197                                 if (end_at) {
 198                                         end = strtoul(end_at + 1, &total_at, 10);
 199                                         if (total_at && strncmp(total_at + 1, "*", 1)) {
 200                                                 total = strtoul(total_at + 1, NULL, 10);
 201                                         }
 202                                         if ((len = (end + 1 - start)) > remaining) {
 203                                                 http_error_ex(HE_NOTICE, HTTP_E_MALFORMED_HEADERS, "The Content-Range header pretends a larger body than actually received (expected %lu bytes; got %lu bytes)", len, remaining);
 204                                                 len = remaining;
 205                                         }
 206                                         if (end >= start && (!total || end < total)) {
 207                                                 phpstr_from_string_ex(PHPSTR(msg), body, len);
 208                                                 continue_at = body + len;
 209                                         }
 210                                 }
 211                         }
 212
 213                         if (!continue_at) {
 214                                 http_error_ex(HE_WARNING, HTTP_E_MALFORMED_HEADERS, "Invalid Content-Range header: %s", Z_STRVAL_P(c));
 215                         }
 216                 } else
 217
 218                 /* no headers that indicate content length */
 219                 if (HTTP_MSG_TYPE(RESPONSE, msg)) {
 220                         phpstr_from_string_ex(PHPSTR(msg), body, remaining);
 221                 } else {
 222                         continue_at = body;
 223                 }
 224
 225 #if defined(HTTP_HAVE_ZLIB) || defined(HAVE_ZLIB)
 226                 /* check for compressed data */
 227                 if ((c = http_message_header(msg, "Content-Encoding"))) {
 228                         char *decoded = NULL;
 229                         size_t decoded_len = 0;
 230 #       if defined(HAVE_ZLIB) && !defined(HTTP_HAVE_ZLIB)
 231                         zval func, retval, arg, *args[1];
 232                         INIT_PZVAL(&func);
 233                         INIT_PZVAL(&retval);
 234                         INIT_PZVAL(&arg);
 235                         ZVAL_STRINGL(&func, "gzinflate", lenof("gzinflate"), 0);
 236                         args[0] = &arg;
 237 #       endif /* HAVE_ZLIB && !HTTP_HAVE_ZLIB */
 238
 239 #       define DECODE_WITH_EXT_ZLIB() \
 240                                 if (SUCCESS == call_user_function(EG(function_table), NULL, &func, &retval, 1, args TSRMLS_CC)) { \
 241                                         if (Z_TYPE(retval) == IS_STRING) { \
 242                                                 decoded = Z_STRVAL(retval); \
 243                                                 decoded_len = Z_STRLEN(retval); \
 244                                         } \
 245                                 }
 246
 247                         if (!strcasecmp(Z_STRVAL_P(c), "gzip") || !strcasecmp(Z_STRVAL_P(c), "x-gzip")) {
 248 #       ifdef HTTP_HAVE_ZLIB
 249                                 http_encoding_gzdecode(PHPSTR_VAL(msg), PHPSTR_LEN(msg), &decoded, &decoded_len);
 250 #       else
 251                                 ZVAL_STRINGL(&arg, PHPSTR_VAL(msg) + 10, PHPSTR_LEN(msg) - 18, 0);
 252                                 DECODE_WITH_EXT_ZLIB();
 253 #       endif /* HTTP_HAVE_ZLIB */
 254                         } else if (!strcasecmp(Z_STRVAL_P(c), "deflate")) {
 255 #       ifdef HTTP_HAVE_ZLIB
 256                                 http_encoding_inflate(PHPSTR_VAL(msg), PHPSTR_LEN(msg), &decoded, &decoded_len);
 257 #       else
 258                                 ZVAL_STRINGL(&arg, PHPSTR_VAL(msg), PHPSTR_LEN(msg), 0);
 259                                 DECODE_WITH_EXT_ZLIB();
 260 #       endif /* HTTP_HAVE_ZLIB */
 261                         }
 262
 263                         if (decoded) {
 264                                 zval *len;
 265                                 char *tmp;
 266                                 int tmp_len;
 267
 268                                 tmp_len = (int) spprintf(&tmp, 0, "%zu", decoded_len);
 269                                 MAKE_STD_ZVAL(len);
 270                                 ZVAL_STRINGL(len, tmp, tmp_len, 0);
 271
 272                                 zend_hash_del(&msg->hdrs, "Content-Encoding", sizeof("Content-Encoding"));
 273                                 zend_hash_del(&msg->hdrs, "Content-Length", sizeof("Content-Length"));
 274                                 zend_hash_add(&msg->hdrs, "Content-Length", sizeof("Content-Length"), (void *) &len, sizeof(zval *), NULL);
 275
 276                                 phpstr_dtor(PHPSTR(msg));
 277                                 PHPSTR(msg)->data = decoded;
 278                                 PHPSTR(msg)->used = decoded_len;
 279                                 PHPSTR(msg)->free = 1;
 280                         }
 281                 }
 282 #endif /* HTTP_HAVE_ZLIB || HAVE_ZLIB */
 283
 284                 /* check for following messages */
 285                 if (continue_at) {
 286                         while (isspace(*continue_at)) ++continue_at;
 287                         if (continue_at < (message + message_length)) {
 288                                 http_message *next = NULL, *most = NULL;
 289
 290                                 /* set current message to parent of most parent following messages and return deepest */
 291                                 if ((most = next = http_message_parse(continue_at, message + message_length - continue_at))) {
 292                                         while (most->parent) most = most->parent;
 293                                         most->parent = msg;
 294                                         msg = next;
 295                                 }
 296                         }
 297                 }
 298         }
 299
 300         return msg;
 301 }
 302
 303 PHP_HTTP_API void _http_message_tostring(http_message *msg, char **string, size_t *length)
 304 {
 305         phpstr str;
 306         char *key, *data;
 307         ulong idx;
 308         zval **header;
 309         HashPosition pos1;
 310
 311         phpstr_init_ex(&str, 4096, 0);
 312
 313         switch (msg->type)
 314         {
 315                 case HTTP_MSG_REQUEST:
 316                         phpstr_appendf(&str, "%s %s HTTP/%1.1f" HTTP_CRLF,
 317                                 msg->http.info.request.method,
 318                                 msg->http.info.request.URI,
 319                                 msg->http.version);
 320                 break;
 321
 322                 case HTTP_MSG_RESPONSE:
 323                         phpstr_appendf(&str, "HTTP/%1.1f %d%s%s" HTTP_CRLF,
 324                                 msg->http.version,
 325                                 msg->http.info.response.code,
 326                                 *msg->http.info.response.status ? " ":"",
 327                                 msg->http.info.response.status);
 328                 break;
 329
 330                 case HTTP_MSG_NONE:
 331                 default:
 332                 break;
 333         }
 334
 335         FOREACH_HASH_KEYVAL(pos1, &msg->hdrs, key, idx, header) {
 336                 if (key) {
 337                         zval **single_header;
 338
 339                         switch (Z_TYPE_PP(header))
 340                         {
 341                                 case IS_STRING:
 342                                         phpstr_appendf(&str, "%s: %s" HTTP_CRLF, key, Z_STRVAL_PP(header));
 343                                 break;
 344
 345                                 case IS_ARRAY:
 346                                 {
 347                                         HashPosition pos2;
 348                                         FOREACH_VAL(pos2, *header, single_header) {
 349                                                 phpstr_appendf(&str, "%s: %s" HTTP_CRLF, key, Z_STRVAL_PP(single_header));
 350                                         }
 351                                 }
 352                                 break;
 353                         }
 354
 355                         key = NULL;
 356                 }
 357         }
 358
 359         if (PHPSTR_LEN(msg)) {
 360                 phpstr_appends(&str, HTTP_CRLF);
 361                 phpstr_append(&str, PHPSTR_VAL(msg), PHPSTR_LEN(msg));
 362                 phpstr_appends(&str, HTTP_CRLF);
 363         }
 364
 365         data = phpstr_data(&str, string, length);
 366         if (!string) {
 367                 efree(data);
 368         }
 369
 370         phpstr_dtor(&str);
 371 }
 372
 373 PHP_HTTP_API void _http_message_serialize(http_message *message, char **string, size_t *length)
 374 {
 375         char *buf;
 376         size_t len;
 377         phpstr str;
 378
 379         phpstr_init(&str);
 380
 381         do {
 382                 http_message_tostring(message, &buf, &len);
 383                 phpstr_prepend(&str, buf, len);
 384                 efree(buf);
 385         } while ((message = message->parent));
 386
 387         buf = phpstr_data(&str, string, length);
 388         if (!string) {
 389                 efree(buf);
 390         }
 391
 392         phpstr_dtor(&str);
 393 }
 394
 395 PHP_HTTP_API void _http_message_tostruct_recursive(http_message *msg, zval *obj TSRMLS_DC)
 396 {
 397         zval strct;
 398         zval *headers;
 399
 400         INIT_ZARR(strct, HASH_OF(obj));
 401
 402         add_assoc_long(&strct, "type", msg->type);
 403         add_assoc_double(&strct, "httpVersion", msg->http.version);
 404         switch (msg->type)
 405         {
 406                 case HTTP_MSG_RESPONSE:
 407                         add_assoc_long(&strct, "responseCode", msg->http.info.response.code);
 408                         add_assoc_string(&strct, "responseStatus", msg->http.info.response.status, 1);
 409                 break;
 410
 411                 case HTTP_MSG_REQUEST:
 412                         add_assoc_string(&strct, "requestMethod", msg->http.info.request.method, 1);
 413                         add_assoc_string(&strct, "requestUri", msg->http.info.request.URI, 1);
 414                 break;
 415
 416                 case HTTP_MSG_NONE:
 417                         /* avoid compiler warning */
 418                 break;
 419         }
 420
 421         MAKE_STD_ZVAL(headers);
 422         array_init(headers);
 423         zend_hash_copy(Z_ARRVAL_P(headers), &msg->hdrs, (copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval *));
 424         add_assoc_zval(&strct, "headers", headers);
 425
 426         add_assoc_stringl(&strct, "body", PHPSTR_VAL(msg), PHPSTR_LEN(msg), 1);
 427
 428         if (msg->parent) {
 429                 zval *parent;
 430
 431                 MAKE_STD_ZVAL(parent);
 432                 if (Z_TYPE_P(obj) == IS_ARRAY) {
 433                         array_init(parent);
 434                 } else {
 435                         object_init(parent);
 436                 }
 437                 add_assoc_zval(&strct, "parentMessage", parent);
 438                 http_message_tostruct_recursive(msg->parent, parent);
 439         } else {
 440                 add_assoc_null(&strct, "parentMessage");
 441         }
 442 }
 443
 444 PHP_HTTP_API STATUS _http_message_send(http_message *message TSRMLS_DC)
 445 {
 446         STATUS rs = FAILURE;
 447
 448         switch (message->type)
 449         {
 450                 case HTTP_MSG_RESPONSE:
 451                 {
 452                         char *key;
 453                         ulong idx;
 454                         zval **val;
 455                         HashPosition pos1;
 456
 457                         FOREACH_HASH_KEYVAL(pos1, &message->hdrs, key, idx, val) {
 458                                 if (key) {
 459                                         if (Z_TYPE_PP(val) == IS_ARRAY) {
 460                                                 zend_bool first = 1;
 461                                                 zval **data;
 462                                                 HashPosition pos2;
 463
 464                                                 FOREACH_VAL(pos2, *val, data) {
 465                                                         http_send_header_ex(key, strlen(key), Z_STRVAL_PP(data), Z_STRLEN_PP(data), first, NULL);
 466                                                         first = 0;
 467                                                 }
 468                                         } else {
 469                                                 http_send_header_ex(key, strlen(key), Z_STRVAL_PP(val), Z_STRLEN_PP(val), 1, NULL);
 470                                         }
 471                                         key = NULL;
 472                                 }
 473                         }
 474                         rs =    SUCCESS == http_send_status(message->http.info.response.code) &&
 475                                         SUCCESS == http_send_data(PHPSTR_VAL(message), PHPSTR_LEN(message)) ?
 476                                         SUCCESS : FAILURE;
 477                 }
 478                 break;
 479
 480                 case HTTP_MSG_REQUEST:
 481                 {
 482 #ifdef HTTP_HAVE_CURL
 483                         char *uri = NULL;
 484                         zval **zhost, options, headers;
 485
 486                         INIT_PZVAL(&options);
 487                         INIT_PZVAL(&headers);
 488                         array_init(&options);
 489                         array_init(&headers);
 490                         zend_hash_copy(Z_ARRVAL(headers), &message->hdrs, (copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval *));
 491                         add_assoc_zval(&options, "headers", &headers);
 492
 493                         /* check host header */
 494                         if (SUCCESS == zend_hash_find(&message->hdrs, "Host", sizeof("Host"), (void **) &zhost)) {
 495                                 char *colon = NULL, *host = NULL;
 496                                 size_t host_len = 0;
 497                                 int port = 0;
 498
 499                                 /* check for port */
 500                                 if ((colon = strchr(Z_STRVAL_PP(zhost), ':'))) {
 501                                         port = atoi(colon + 1);
 502                                         host = estrndup(Z_STRVAL_PP(zhost), host_len = (Z_STRVAL_PP(zhost) - colon - 1));
 503                                 } else {
 504                                         host = estrndup(Z_STRVAL_PP(zhost), host_len = Z_STRLEN_PP(zhost));
 505                                 }
 506                                 uri = http_absolute_uri_ex(
 507                                         message->http.info.request.URI, strlen(message->http.info.request.URI),
 508                                         NULL, 0, host, host_len, port);
 509                                 efree(host);
 510                         } else {
 511                                 uri = http_absolute_uri(message->http.info.request.URI);
 512                         }
 513
 514                         if (!strcasecmp("POST", message->http.info.request.method)) {
 515                                 http_request_body body = {HTTP_REQUEST_BODY_CSTRING, PHPSTR_VAL(message), PHPSTR_LEN(message)};
 516                                 rs = http_post(uri, &body, Z_ARRVAL(options), NULL, NULL);
 517                         } else
 518                         if (!strcasecmp("GET", message->http.info.request.method)) {
 519                                 rs = http_get(uri, Z_ARRVAL(options), NULL, NULL);
 520                         } else
 521                         if (!strcasecmp("HEAD", message->http.info.request.method)) {
 522                                 rs = http_head(uri, Z_ARRVAL(options), NULL, NULL);
 523                         } else {
 524                                 http_error_ex(HE_WARNING, HTTP_E_REQUEST_METHOD,
 525                                         "Cannot send HttpMessage. Request method %s not supported",
 526                                         message->http.info.request.method);
 527                         }
 528
 529                         efree(uri);
 530 #else
 531                         http_error(HE_WARNING, HTTP_E_RUNTIME, "HTTP requests not supported - ext/http was not linked against libcurl.");
 532 #endif
 533                 }
 534                 break;
 535
 536                 case HTTP_MSG_NONE:
 537                 default:
 538                         http_error(HE_WARNING, HTTP_E_MESSAGE_TYPE, "HttpMessage is neither of type HTTP_MSG_REQUEST nor HTTP_MSG_RESPONSE");
 539                 break;
 540         }
 541
 542         return rs;
 543 }
 544
 545 PHP_HTTP_API http_message *_http_message_dup(http_message *msg TSRMLS_DC)
 546 {
 547         /*
 548          * TODO: unroll
 549          */
 550         http_message *new;
 551         char *serialized_data;
 552         size_t serialized_length;
 553
 554         http_message_serialize(msg, &serialized_data, &serialized_length);
 555         new = http_message_parse(serialized_data, serialized_length);
 556         efree(serialized_data);
 557         return new;
 558 }
 559
 560 PHP_HTTP_API void _http_message_dtor(http_message *message)
 561 {
 562         if (message) {
 563                 zend_hash_destroy(&message->hdrs);
 564                 phpstr_dtor(PHPSTR(message));
 565
 566                 switch (message->type)
 567                 {
 568                         case HTTP_MSG_REQUEST:
 569                                 STR_SET(message->http.info.request.method, NULL);
 570                                 STR_SET(message->http.info.request.URI, NULL);
 571                         break;
 572
 573                         case HTTP_MSG_RESPONSE:
 574                                 STR_SET(message->http.info.response.status, NULL);
 575                         break;
 576
 577                         default:
 578                         break;
 579                 }
 580         }
 581 }
 582
 583 PHP_HTTP_API void _http_message_free(http_message **message)
 584 {
 585         if (*message) {
 586                 if ((*message)->parent) {
 587                         http_message_free(&(*message)->parent);
 588                 }
 589                 http_message_dtor(*message);
 590                 efree(*message);
 591                 *message = NULL;
 592         }
 593 }
 594
 595 /*
 596  * Local variables:
 597  * tab-width: 4
 598  * c-basic-offset: 4
 599  * End:
 600  * vim600: noet sw=4 ts=4 fdm=marker
 601  * vim<600: noet sw=4 ts=4
 602  */
 603