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