git.m6w6.name Git - m6w6/ext-http/blob - http_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-2006, Michael Wallner <mike@php.net>            |
  10     +--------------------------------------------------------------------+
  11 */
  12
  13 /* $Id$ */
  14
  15 #define HTTP_WANT_SAPI
  16 #include "php_http.h"
  17
  18 #include "php_output.h"
  19 #include "ext/standard/url.h"
  20
  21 #include "php_http_api.h"
  22 #include "php_http_send_api.h"
  23
  24 #ifdef ZEND_ENGINE_2
  25 #       include "php_http_exception_object.h"
  26 #endif
  27
  28 PHP_MINIT_FUNCTION(http_support)
  29 {
  30         HTTP_LONG_CONSTANT("HTTP_SUPPORT", HTTP_SUPPORT);
  31         HTTP_LONG_CONSTANT("HTTP_SUPPORT_REQUESTS", HTTP_SUPPORT_REQUESTS);
  32         HTTP_LONG_CONSTANT("HTTP_SUPPORT_MAGICMIME", HTTP_SUPPORT_MAGICMIME);
  33         HTTP_LONG_CONSTANT("HTTP_SUPPORT_ENCODINGS", HTTP_SUPPORT_ENCODINGS);
  34         HTTP_LONG_CONSTANT("HTTP_SUPPORT_SSLREQUESTS", HTTP_SUPPORT_SSLREQUESTS);
  35
  36         HTTP_LONG_CONSTANT("HTTP_PARAMS_ALLOW_COMMA", HTTP_PARAMS_ALLOW_COMMA);
  37         HTTP_LONG_CONSTANT("HTTP_PARAMS_ALLOW_FAILURE", HTTP_PARAMS_ALLOW_FAILURE);
  38         HTTP_LONG_CONSTANT("HTTP_PARAMS_RAISE_ERROR", HTTP_PARAMS_RAISE_ERROR);
  39         HTTP_LONG_CONSTANT("HTTP_PARAMS_DEFAULT", HTTP_PARAMS_DEFAULT);
  40
  41         return SUCCESS;
  42 }
  43
  44 PHP_HTTP_API long _http_support(long feature)
  45 {
  46         long support = HTTP_SUPPORT;
  47
  48 #ifdef HTTP_HAVE_CURL
  49         support |= HTTP_SUPPORT_REQUESTS;
  50 #       ifdef HTTP_HAVE_SSL
  51         support |= HTTP_SUPPORT_SSLREQUESTS;
  52 #       endif
  53 #endif
  54 #ifdef HTTP_HAVE_MAGIC
  55         support |= HTTP_SUPPORT_MAGICMIME;
  56 #endif
  57 #ifdef HTTP_HAVE_ZLIB
  58         support |= HTTP_SUPPORT_ENCODINGS;
  59 #endif
  60
  61         if (feature) {
  62                 return (feature == (support & feature));
  63         }
  64         return support;
  65 }
  66
  67 /* char *pretty_key(char *, size_t, zend_bool, zend_bool) */
  68 char *_http_pretty_key(char *key, size_t key_len, zend_bool uctitle, zend_bool xhyphen)
  69 {
  70         size_t i;
  71         int wasalpha;
  72
  73         if (key && key_len) {
  74                 if ((wasalpha = HTTP_IS_CTYPE(alpha, key[0]))) {
  75                         key[0] = (char) (uctitle ? HTTP_TO_CTYPE(upper, key[0]) : HTTP_TO_CTYPE(lower, key[0]));
  76                 }
  77                 for (i = 1; i < key_len; i++) {
  78                         if (HTTP_IS_CTYPE(alpha, key[i])) {
  79                                 key[i] = (char) (((!wasalpha) && uctitle) ? HTTP_TO_CTYPE(upper, key[i]) : HTTP_TO_CTYPE(lower, key[i]));
  80                                 wasalpha = 1;
  81                         } else {
  82                                 if (xhyphen && (key[i] == '_')) {
  83                                         key[i] = '-';
  84                                 }
  85                                 wasalpha = 0;
  86                         }
  87                 }
  88         }
  89         return key;
  90 }
  91 /* }}} */
  92
  93 /* {{{ void http_error(long, long, char*) */
  94 void _http_error_ex(long type TSRMLS_DC, long code, const char *format, ...)
  95 {
  96         va_list args;
  97
  98         va_start(args, format);
  99 #ifdef ZEND_ENGINE_2
 100         if ((type == E_THROW) || (PG(error_handling) == EH_THROW)) {
 101                 char *message;
 102                 zend_class_entry *ce = http_exception_get_for_code(code);
 103
 104                 http_try {
 105                         vspprintf(&message, 0, format, args);
 106                         zend_throw_exception(ce, message, code TSRMLS_CC);
 107                         efree(message);
 108                 } http_catch(PG(exception_class) ? PG(exception_class) : HTTP_EX_DEF_CE);
 109         } else
 110 #endif
 111         php_verror(NULL, "", type, format, args TSRMLS_CC);
 112         va_end(args);
 113 }
 114 /* }}} */
 115
 116 #ifdef ZEND_ENGINE_2
 117 static inline void copy_bt_args(zval *from, zval *to TSRMLS_DC)
 118 {
 119         zval **args, **trace_0, *old_trace_0, *trace = NULL;
 120
 121         if ((trace = zend_read_property(ZEND_EXCEPTION_GET_DEFAULT(), from, "trace", lenof("trace"), 0 TSRMLS_CC))) {
 122                 if (Z_TYPE_P(trace) == IS_ARRAY && SUCCESS == zend_hash_index_find(Z_ARRVAL_P(trace), 0, (void *) &trace_0)) {
 123                         old_trace_0 = *trace_0;
 124                         if (Z_TYPE_PP(trace_0) == IS_ARRAY && SUCCESS == zend_hash_find(Z_ARRVAL_PP(trace_0), "args", sizeof("args"), (void *) &args)) {
 125                                 if ((trace = zend_read_property(ZEND_EXCEPTION_GET_DEFAULT(), to, "trace", lenof("trace"), 0 TSRMLS_CC))) {
 126                                         if (Z_TYPE_P(trace) == IS_ARRAY && SUCCESS == zend_hash_index_find(Z_ARRVAL_P(trace), 0, (void *) &trace_0)) {
 127                                                 ZVAL_ADDREF(*args);
 128                                                 add_assoc_zval(*trace_0, "args", *args);
 129                                         }
 130                                 }
 131                         }
 132                 }
 133         }
 134 }
 135
 136 /* {{{ zval *http_exception_wrap(zval *, zval *, zend_class_entry *) */
 137 zval *_http_exception_wrap(zval *old_exception, zval *new_exception, zend_class_entry *ce TSRMLS_DC)
 138 {
 139         int inner = 1;
 140         char *message;
 141         zval *sub_exception, *tmp_exception;
 142
 143         if (!new_exception) {
 144                 MAKE_STD_ZVAL(new_exception);
 145                 object_init_ex(new_exception, ce);
 146
 147                 zend_update_property(ce, new_exception, "innerException", lenof("innerException"), old_exception TSRMLS_CC);
 148                 copy_bt_args(old_exception, new_exception TSRMLS_CC);
 149
 150                 sub_exception = old_exception;
 151
 152                 while ((sub_exception = zend_read_property(Z_OBJCE_P(sub_exception), sub_exception, "innerException", lenof("innerException"), 0 TSRMLS_CC)) && Z_TYPE_P(sub_exception) == IS_OBJECT) {
 153                         ++inner;
 154                 }
 155
 156                 spprintf(&message, 0, "Exception caused by %d inner exception(s)", inner);
 157                 zend_update_property_string(ZEND_EXCEPTION_GET_DEFAULT(), new_exception, "message", lenof("message"), message TSRMLS_CC);
 158                 efree(message);
 159         } else {
 160                 sub_exception = new_exception;
 161                 tmp_exception = new_exception;
 162
 163                 while ((tmp_exception = zend_read_property(Z_OBJCE_P(tmp_exception), tmp_exception, "innerException", lenof("innerException"), 0 TSRMLS_CC)) && Z_TYPE_P(tmp_exception) == IS_OBJECT) {
 164                         sub_exception = tmp_exception;
 165                 }
 166
 167                 zend_update_property(Z_OBJCE_P(sub_exception), sub_exception, "innerException", lenof("innerException"), old_exception TSRMLS_CC);
 168                 copy_bt_args(old_exception, new_exception TSRMLS_CC);
 169                 copy_bt_args(old_exception, sub_exception TSRMLS_CC);
 170         }
 171
 172         zval_ptr_dtor(&old_exception);
 173         return new_exception;
 174 }
 175 /* }}} */
 176 #endif /* ZEND_ENGINE_2 */
 177
 178 /* {{{ void http_log(char *, char *, char *) */
 179 void _http_log_ex(char *file, const char *ident, const char *message TSRMLS_DC)
 180 {
 181         time_t now;
 182         struct tm nowtm;
 183         char datetime[20] = {0};
 184
 185         now = HTTP_G->request.time;
 186         strftime(datetime, sizeof(datetime), "%Y-%m-%d %H:%M:%S", php_localtime_r(&now, &nowtm));
 187
 188 #define HTTP_LOG_WRITE(file, type, msg) \
 189         if (file && *file) { \
 190                 php_stream *log = php_stream_open_wrapper_ex(file, "ab", REPORT_ERRORS|ENFORCE_SAFE_MODE, NULL, HTTP_DEFAULT_STREAM_CONTEXT); \
 191                  \
 192                 if (log) { \
 193                         php_stream_printf(log TSRMLS_CC, "%s\t[%s]\t%s\t<%s>%s", datetime, type, msg, SG(request_info).request_uri, PHP_EOL); \
 194                         php_stream_close(log); \
 195                 } \
 196          \
 197         }
 198
 199         HTTP_LOG_WRITE(file, ident, message);
 200         HTTP_LOG_WRITE(HTTP_G->log.composite, ident, message);
 201 }
 202 /* }}} */
 203
 204 static void http_ob_blackhole(char *output, uint output_len, char **handled_output, uint *handled_output_len, int mode TSRMLS_DC)
 205 {
 206         *handled_output = ecalloc(1,1);
 207         *handled_output_len = 0;
 208 }
 209
 210 /* {{{ STATUS http_exit(int, char*, char*) */
 211 STATUS _http_exit_ex(int status, char *header, char *body, zend_bool send_header TSRMLS_DC)
 212 {
 213         if (    (send_header && (SUCCESS != http_send_status_header(status, header))) ||
 214                         (status && (SUCCESS != http_send_status(status)))) {
 215                 http_error_ex(HE_WARNING, HTTP_E_HEADER, "Failed to exit with status/header: %d - %s", status, STR_PTR(header));
 216                 STR_FREE(header);
 217                 STR_FREE(body);
 218                 return FAILURE;
 219         }
 220
 221         if (!OG(ob_lock)) {
 222                 php_end_ob_buffers(0 TSRMLS_CC);
 223         }
 224         if ((SUCCESS == sapi_send_headers(TSRMLS_C)) && body) {
 225                 PHPWRITE(body, strlen(body));
 226         }
 227
 228         switch (status) {
 229                 case 301:       http_log(HTTP_G->log.redirect, "301-REDIRECT", header);                 break;
 230                 case 302:       http_log(HTTP_G->log.redirect, "302-REDIRECT", header);                 break;
 231                 case 303:       http_log(HTTP_G->log.redirect, "303-REDIRECT", header);                 break;
 232                 case 305:       http_log(HTTP_G->log.redirect, "305-REDIRECT", header);                 break;
 233                 case 307:       http_log(HTTP_G->log.redirect, "307-REDIRECT", header);                 break;
 234                 case 304:       http_log(HTTP_G->log.cache, "304-CACHE", header);                               break;
 235                 case 404:       http_log(HTTP_G->log.not_found, "404-NOTFOUND", NULL);                  break;
 236                 case 405:       http_log(HTTP_G->log.allowed_methods, "405-ALLOWED", header);   break;
 237                 default:        http_log(NULL, header, body);                                                                   break;
 238         }
 239
 240         STR_FREE(header);
 241         STR_FREE(body);
 242
 243         if (HTTP_G->force_exit) {
 244                 zend_bailout();
 245         } else {
 246                 php_ob_set_internal_handler(http_ob_blackhole, 4096, "blackhole", 0 TSRMLS_CC);
 247         }
 248
 249         return SUCCESS;
 250 }
 251 /* }}} */
 252
 253 /* {{{ STATUS http_check_method(char *) */
 254 STATUS _http_check_method_ex(const char *method, const char *methods)
 255 {
 256         const char *found;
 257
 258         if (    (found = strstr(methods, method)) &&
 259                         (found == method || !HTTP_IS_CTYPE(alpha, found[-1])) &&
 260                         (strlen(found) >= strlen(method) && !HTTP_IS_CTYPE(alpha, found[strlen(method)]))) {
 261                 return SUCCESS;
 262         }
 263         return FAILURE;
 264 }
 265 /* }}} */
 266
 267 /* {{{ zval *http_get_server_var_ex(char *, size_t) */
 268 PHP_HTTP_API zval *_http_get_server_var_ex(const char *key, size_t key_size, zend_bool check TSRMLS_DC)
 269 {
 270         zval **hsv;
 271         zval **var;
 272 #ifdef ZEND_ENGINE_2
 273         zend_is_auto_global("_SERVER", lenof("_SERVER") TSRMLS_CC);
 274 #endif
 275         if ((SUCCESS != zend_hash_find(&EG(symbol_table), "_SERVER", sizeof("_SERVER"), (void *) &hsv)) || (Z_TYPE_PP(hsv) != IS_ARRAY)) {
 276                 return NULL;
 277         }
 278         if ((SUCCESS != zend_hash_find(Z_ARRVAL_PP(hsv), (char *) key, key_size, (void *) &var))) {
 279                 return NULL;
 280         }
 281         if (check && !((Z_TYPE_PP(var) == IS_STRING) && Z_STRVAL_PP(var) && Z_STRLEN_PP(var))) {
 282                 return NULL;
 283         }
 284         return *var;
 285 }
 286 /* }}} */
 287
 288 /* {{{ STATUS http_get_request_body(char **, size_t *) */
 289 PHP_HTTP_API STATUS _http_get_request_body_ex(char **body, size_t *length, zend_bool dup TSRMLS_DC)
 290 {
 291         *length = 0;
 292         *body = NULL;
 293
 294         if (SG(request_info).raw_post_data) {
 295                 *length = SG(request_info).raw_post_data_length;
 296                 *body = SG(request_info).raw_post_data;
 297
 298                 if (dup) {
 299                         *body = estrndup(*body, *length);
 300                 }
 301                 return SUCCESS;
 302         } else if (sapi_module.read_post && !HTTP_G->read_post_data) {
 303                 char buf[4096];
 304                 int len;
 305
 306                 HTTP_G->read_post_data = 1;
 307
 308                 while (0 < (len = sapi_module.read_post(buf, sizeof(buf) TSRMLS_CC))) {
 309                         *body = erealloc(*body, *length + len + 1);
 310                         memcpy(*body + *length, buf, len);
 311                         *length += len;
 312                         (*body)[*length] = '\0';
 313                 }
 314
 315                 /* check for error */
 316                 if (len < 0) {
 317                         STR_FREE(*body);
 318                         *length = 0;
 319                         return FAILURE;
 320                 }
 321
 322                 SG(request_info).raw_post_data = *body;
 323                 SG(request_info).raw_post_data_length = *length;
 324
 325                 if (dup) {
 326                         *body = estrndup(*body, *length);
 327                 }
 328                 return SUCCESS;
 329         }
 330
 331         return FAILURE;
 332 }
 333 /* }}} */
 334
 335 /* {{{ php_stream *http_get_request_body_stream(void) */
 336 PHP_HTTP_API php_stream *_http_get_request_body_stream(TSRMLS_D)
 337 {
 338         php_stream *s = NULL;
 339
 340         if (SG(request_info).raw_post_data) {
 341                 s = php_stream_open_wrapper("php://input", "rb", 0, NULL);
 342         } else if (sapi_module.read_post && !HTTP_G->read_post_data) {
 343                 HTTP_G->read_post_data = 1;
 344
 345                 if ((s = php_stream_temp_new())) {
 346                         char buf[4096];
 347                         int len;
 348
 349                         while (0 < (len = sapi_module.read_post(buf, sizeof(buf) TSRMLS_CC))) {
 350                                 php_stream_write(s, buf, len);
 351                         }
 352
 353                         if (len < 0) {
 354                                 php_stream_close(s);
 355                                 s = NULL;
 356                         } else {
 357                                 php_stream_rewind(s);
 358                         }
 359                 }
 360         }
 361
 362         return s;
 363 }
 364 /* }}} */
 365
 366 /* {{{ void http_parse_params_default_callback(...) */
 367 PHP_HTTP_API void _http_parse_params_default_callback(void *arg, const char *key, int keylen, const char *val, int vallen TSRMLS_DC)
 368 {
 369         char *kdup;
 370         zval tmp, *entry;
 371         HashTable *ht = (HashTable *) arg;
 372
 373         if (ht) {
 374                 INIT_ZARR(tmp, ht);
 375
 376                 if (vallen) {
 377                         MAKE_STD_ZVAL(entry);
 378                         array_init(entry);
 379                         kdup = estrndup(key, keylen);
 380                         add_assoc_stringl_ex(entry, kdup, keylen + 1, (char *) val, vallen, 1);
 381                         efree(kdup);
 382                         add_next_index_zval(&tmp, entry);
 383                 } else {
 384                         add_next_index_stringl(&tmp, (char *) key, keylen, 1);
 385                 }
 386         }
 387 }
 388 /* }}} */
 389
 390 /* {{{ STATUS http_parse_params(const char *, HashTable *) */
 391 PHP_HTTP_API STATUS _http_parse_params_ex(const char *param, int flags, http_parse_params_callback cb, void *cb_arg TSRMLS_DC)
 392 {
 393 #define ST_QUOTE        1
 394 #define ST_VALUE        2
 395 #define ST_KEY          3
 396 #define ST_ASSIGN       4
 397 #define ST_ADD          5
 398
 399         int st = ST_KEY, keylen = 0, vallen = 0;
 400         char *s, *c, *key = NULL, *val = NULL;
 401
 402         for(c = s = estrdup(param);;) {
 403 #if 0
 404                 char *tk = NULL, *tv = NULL;
 405
 406                 if (key) {
 407                         if (keylen) {
 408                                 tk= estrndup(key, keylen);
 409                         } else {
 410                                 tk = ecalloc(1, 7);
 411                                 memcpy(tk, key, 3);
 412                                 tk[3]='.'; tk[4]='.'; tk[5]='.';
 413                         }
 414                 }
 415                 if (val) {
 416                         if (vallen) {
 417                                 tv = estrndup(val, vallen);
 418                         } else {
 419                                 tv = ecalloc(1, 7);
 420                                 memcpy(tv, val, 3);
 421                                 tv[3]='.'; tv[4]='.'; tv[5]='.';
 422                         }
 423                 }
 424                 fprintf(stderr, "[%6s] %c \"%s=%s\"\n",
 425                                 (
 426                                                 st == ST_QUOTE ? "QUOTE" :
 427                                                 st == ST_VALUE ? "VALUE" :
 428                                                 st == ST_KEY ? "KEY" :
 429                                                 st == ST_ASSIGN ? "ASSIGN" :
 430                                                 st == ST_ADD ? "ADD":
 431                                                 "HUH?"
 432                                 ), *c?*c:'0', tk, tv
 433                 );
 434                 STR_FREE(tk); STR_FREE(tv);
 435 #endif
 436         continued:
 437                 switch (st) {
 438                         case ST_QUOTE:
 439                         quote:
 440                                 if (*c == '"') {
 441                                         if (*(c-1) == '\\') {
 442                                                 memmove(c-1, c, strlen(c)+1);
 443                                                 goto quote;
 444                                         } else {
 445                                                 goto add;
 446                                         }
 447                                 } else {
 448                                         if (!val) {
 449                                                 val = c;
 450                                         }
 451                                         if (!*c) {
 452                                                 --val;
 453                                                 st = ST_ADD;
 454                                         }
 455                                 }
 456                                 break;
 457
 458                         case ST_VALUE:
 459                                 switch (*c) {
 460                                         case '"':
 461                                                 if (!val) {
 462                                                         st = ST_QUOTE;
 463                                                 }
 464                                                 break;
 465
 466                                         case ' ':
 467                                                 break;
 468
 469                                         case ';':
 470                                         case '\0':
 471                                                 goto add;
 472                                                 break;
 473                                         case ',':
 474                                                 if (flags & HTTP_PARAMS_ALLOW_COMMA) {
 475                                                         goto add;
 476                                                 }
 477                                         default:
 478                                                 if (!val) {
 479                                                         val = c;
 480                                                 }
 481                                                 break;
 482                                 }
 483                                 break;
 484
 485                         case ST_KEY:
 486                                 switch (*c) {
 487                                         case ',':
 488                                                 if (flags & HTTP_PARAMS_ALLOW_COMMA) {
 489                                                         goto allow_comma;
 490                                                 }
 491                                         case '\r':
 492                                         case '\n':
 493                                         case '\t':
 494                                         case '\013':
 495                                         case '\014':
 496                                                 goto failure;
 497                                                 break;
 498
 499                                         case '=':
 500                                                 if (key) {
 501                                                         keylen = c - key;
 502                                                         st = ST_VALUE;
 503                                                 } else {
 504                                                         goto failure;
 505                                                 }
 506                                                 break;
 507
 508                                         case ' ':
 509                                                 if (key) {
 510                                                         keylen = c - key;
 511                                                         st = ST_ASSIGN;
 512                                                 }
 513                                                 break;
 514
 515                                         case ';':
 516                                         case '\0':
 517                                         allow_comma:
 518                                                 if (key) {
 519                                                         keylen = c-- - key;
 520                                                         st = ST_ADD;
 521                                                 }
 522                                                 break;
 523
 524                                         default:
 525                                                 if (!key) {
 526                                                         key = c;
 527                                                 }
 528                                                 break;
 529                                 }
 530                                 break;
 531
 532                         case ST_ASSIGN:
 533                                 if (*c == '=') {
 534                                         st = ST_VALUE;
 535                                 } else if (!*c || *c == ';' || ((flags & HTTP_PARAMS_ALLOW_COMMA) && *c == ',')) {
 536                                         st = ST_ADD;
 537                                 } else if (*c != ' ') {
 538                                         goto failure;
 539                                 }
 540                                 break;
 541
 542                         case ST_ADD:
 543                         add:
 544                                 if (val) {
 545                                         vallen = c - val;
 546                                         if (st != ST_QUOTE) {
 547                                                 while (val[vallen-1] == ' ') --vallen;
 548                                         }
 549                                 } else {
 550                                         val = "";
 551                                         vallen = 0;
 552                                 }
 553
 554                                 cb(cb_arg, key, keylen, val, vallen TSRMLS_CC);
 555
 556                                 st = ST_KEY;
 557                                 key = val = NULL;
 558                                 keylen = vallen = 0;
 559                                 break;
 560                 }
 561                 if (*c) {
 562                         ++c;
 563                 } else if (st == ST_ADD) {
 564                         goto add;
 565                 } else {
 566                         break;
 567                 }
 568         }
 569
 570         efree(s);
 571         return SUCCESS;
 572
 573 failure:
 574         if (flags & HTTP_PARAMS_RAISE_ERROR) {
 575                 http_error_ex(HE_WARNING, HTTP_E_INVALID_PARAM, "Unexpected character (%c) at pos %tu of %zu", *c, c-s, strlen(s));
 576         }
 577         if (flags & HTTP_PARAMS_ALLOW_FAILURE) {
 578                 --c;
 579                 st = ST_ADD;
 580                 goto continued;
 581         }
 582         efree(s);
 583         return FAILURE;
 584 }
 585 /* }}} */
 586
 587 /*
 588  * Local variables:
 589  * tab-width: 4
 590  * c-basic-offset: 4
 591  * End:
 592  * vim600: noet sw=4 ts=4 fdm=marker
 593  * vim<600: noet sw=4 ts=4
 594  */
 595