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