git.m6w6.name Git - m6w6/ext-http/blob - php_http_headers.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-2011, Michael Wallner <mike@php.net>            |
  10     +--------------------------------------------------------------------+
  11 */
  12
  13 #include "php_http_api.h"
  14
  15 PHP_HTTP_API STATUS php_http_headers_parse(const char *header, size_t length, HashTable *headers, php_http_info_callback_t callback_func, void **callback_data TSRMLS_DC)
  16 {
  17         php_http_header_parser_t ctx;
  18         php_http_buffer_t buf;
  19         php_http_header_parser_state_t rs;
  20
  21         if (!php_http_buffer_from_string_ex(&buf, header, length)) {
  22                 php_http_error(HE_WARNING, PHP_HTTP_E_RUNTIME, "Could not allocate buffer");
  23                 return FAILURE;
  24         }
  25
  26         if (!php_http_header_parser_init(&ctx TSRMLS_CC)) {
  27                 php_http_buffer_dtor(&buf);
  28                 php_http_error(HE_WARNING, PHP_HTTP_E_HEADER, "Could not initialize header parser");
  29                 return FAILURE;
  30         }
  31
  32         rs = php_http_header_parser_parse(&ctx, &buf, PHP_HTTP_HEADER_PARSER_CLEANUP, headers, callback_func, callback_data);
  33         php_http_header_parser_dtor(&ctx);
  34         php_http_buffer_dtor(&buf);
  35
  36         if (rs == PHP_HTTP_HEADER_PARSER_STATE_FAILURE) {
  37                 php_http_error(HE_WARNING, PHP_HTTP_E_MALFORMED_HEADERS, "Could not parse headers");
  38                 return FAILURE;
  39         }
  40
  41         return SUCCESS;
  42 }
  43
  44 PHP_HTTP_API void php_http_headers_to_callback(HashTable *headers, zend_bool crlf, php_http_pass_format_callback_t cb, void *cb_arg TSRMLS_DC)
  45 {
  46         HashPosition pos1, pos2;
  47         php_http_array_hashkey_t key = php_http_array_hashkey_init(0);
  48         zval **header, **single_header;
  49
  50         FOREACH_HASH_KEYVAL(pos1, headers, key, header) {
  51                 if (key.type == HASH_KEY_IS_STRING) {
  52                         if (key.len == sizeof("Set-Cookie") && !strcasecmp(key.str, "Set-Cookie") && Z_TYPE_PP(header) == IS_ARRAY) {
  53                                 FOREACH_VAL(pos2, *header, single_header) {
  54                                         if (Z_TYPE_PP(single_header) == IS_ARRAY) {
  55                                                 php_http_cookie_list_t *cookie = php_http_cookie_list_from_struct(NULL, *single_header TSRMLS_CC);
  56
  57                                                 if (cookie) {
  58                                                         char *buf;
  59                                                         size_t len;
  60
  61                                                         php_http_cookie_list_to_string(cookie, &buf, &len);
  62                                                         cb(cb_arg, crlf ? "Set-Cookie: %s" PHP_HTTP_CRLF : "Set-Cookie: %s", buf);
  63                                                         php_http_cookie_list_free(&cookie);
  64                                                         efree(buf);
  65                                                 }
  66                                         } else {
  67                                                 zval *strval = php_http_header_value_to_string(*single_header TSRMLS_CC);
  68
  69                                                 cb(cb_arg, crlf ? "Set-Cookie: %s" PHP_HTTP_CRLF : "Set-Cookie: %s", Z_STRVAL_P(strval));
  70                                                 zval_ptr_dtor(&strval);
  71                                         }
  72                                 }
  73                         } else {
  74                                 zval *strval = php_http_header_value_to_string(*header TSRMLS_CC);
  75
  76                                 cb(cb_arg, crlf ? "%s: %s" PHP_HTTP_CRLF : "%s: %s", key.str, Z_STRVAL_P(strval));
  77                                 zval_ptr_dtor(&strval);
  78                         }
  79                 }
  80         }
  81 }
  82
  83 PHP_HTTP_API void php_http_headers_to_string(php_http_buffer_t *str, HashTable *headers TSRMLS_DC)
  84 {
  85         php_http_headers_to_callback(headers, 1, (php_http_pass_format_callback_t) php_http_buffer_appendf, str TSRMLS_CC);
  86 }
  87
  88 PHP_HTTP_API zval *php_http_header_value_to_string(zval *header TSRMLS_DC)
  89 {
  90         zval *ret;
  91
  92         if (Z_TYPE_P(header) == IS_BOOL) {
  93                 MAKE_STD_ZVAL(ret);
  94                 ZVAL_STRING(ret, Z_BVAL_P(header) ? "true" : "false", 1);
  95         } else if (Z_TYPE_P(header) == IS_ARRAY) {
  96                 zval **val;
  97                 HashPosition pos;
  98                 php_http_buffer_t str;
  99
 100                 php_http_buffer_init(&str);
 101                 MAKE_STD_ZVAL(ret);
 102                 FOREACH_VAL(pos,header, val) {
 103                         zval *strval = php_http_header_value_to_string(*val TSRMLS_CC);
 104
 105                         php_http_buffer_appendf(&str, str.used ? ", %s":"%s", Z_STRVAL_P(strval));
 106                         zval_ptr_dtor(&strval);
 107                 }
 108                 php_http_buffer_fix(&str);
 109                 ZVAL_STRINGL(ret, str.data, str.used, 0);
 110         } else  {
 111                 ret = php_http_zsep(1, IS_STRING, header);
 112         }
 113
 114         return ret;
 115 }
 116
 117 #define PHP_HTTP_BEGIN_ARGS(method, req_args)   PHP_HTTP_BEGIN_ARGS_EX(HttpHeader, method, 0, req_args)
 118 #define PHP_HTTP_EMPTY_ARGS(method)                             PHP_HTTP_EMPTY_ARGS_EX(HttpHeader, method, 0)
 119 #define PHP_HTTP_HEADER_ME(method, v)                   PHP_ME(HttpHeader, method, PHP_HTTP_ARGS(HttpHeader, method), v)
 120
 121 PHP_HTTP_BEGIN_ARGS(__construct, 0)
 122         PHP_HTTP_ARG_VAL(name, 0)
 123         PHP_HTTP_ARG_VAL(value, 0)
 124 PHP_HTTP_END_ARGS;
 125
 126 PHP_HTTP_EMPTY_ARGS(serialize);
 127 PHP_HTTP_BEGIN_ARGS(unserialize, 1)
 128         PHP_HTTP_ARG_VAL(serialized, 0)
 129 PHP_HTTP_END_ARGS;
 130
 131 PHP_HTTP_BEGIN_ARGS(match, 1)
 132         PHP_HTTP_ARG_VAL(value, 0)
 133         PHP_HTTP_ARG_VAL(flags, 0)
 134 PHP_HTTP_END_ARGS;
 135
 136 PHP_HTTP_BEGIN_ARGS(negotiate, 1)
 137         PHP_HTTP_ARG_VAL(supported, 0)
 138         PHP_HTTP_ARG_VAL(result, 1)
 139 PHP_HTTP_END_ARGS;
 140
 141 PHP_HTTP_BEGIN_ARGS(parse, 1)
 142         PHP_HTTP_ARG_VAL(string, 0)
 143         PHP_HTTP_ARG_VAL(flags, 0)
 144 PHP_HTTP_END_ARGS;
 145
 146 PHP_HTTP_BEGIN_ARGS(getParams, 0)
 147         PHP_HTTP_ARG_VAL(param_sep, 0)
 148         PHP_HTTP_ARG_VAL(arg_sep, 0)
 149         PHP_HTTP_ARG_VAL(val_sep, 0)
 150         PHP_HTTP_ARG_VAL(flags, 0)
 151 PHP_HTTP_END_ARGS;
 152
 153 static zend_class_entry *php_http_header_class_entry;
 154
 155 zend_class_entry *php_http_header_get_class_entry(void)
 156 {
 157         return php_http_header_class_entry;
 158 }
 159
 160 static zend_function_entry php_http_header_method_entry[] = {
 161         PHP_HTTP_HEADER_ME(__construct, ZEND_ACC_PUBLIC|ZEND_ACC_CTOR)
 162         PHP_HTTP_HEADER_ME(serialize, ZEND_ACC_PUBLIC)
 163         ZEND_MALIAS(HttpHeader, __toString, serialize, PHP_HTTP_ARGS(HttpHeader, serialize), ZEND_ACC_PUBLIC)
 164         ZEND_MALIAS(HttpHeader, toString, serialize, PHP_HTTP_ARGS(HttpHeader, serialize), ZEND_ACC_PUBLIC)
 165         PHP_HTTP_HEADER_ME(unserialize, ZEND_ACC_PUBLIC)
 166         PHP_HTTP_HEADER_ME(match, ZEND_ACC_PUBLIC)
 167         PHP_HTTP_HEADER_ME(negotiate, ZEND_ACC_PUBLIC)
 168         PHP_HTTP_HEADER_ME(getParams, ZEND_ACC_PUBLIC)
 169         PHP_HTTP_HEADER_ME(parse, ZEND_ACC_PUBLIC|ZEND_ACC_STATIC)
 170         EMPTY_FUNCTION_ENTRY
 171 };
 172
 173 PHP_METHOD(HttpHeader, __construct)
 174 {
 175         char *name_str = NULL, *value_str = NULL;
 176         int name_len = 0, value_len = 0;
 177
 178         with_error_handling(EH_THROW, php_http_exception_get_class_entry()) {
 179                 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|s!s!", &name_str, &name_len, &value_str, &value_len)) {
 180                         if (name_str && name_len) {
 181                                 char *pretty_str = estrndup(name_str, name_len);
 182                                 zend_update_property_stringl(php_http_header_class_entry, getThis(), ZEND_STRL("name"), php_http_pretty_key(pretty_str, name_len, 1, 1), name_len TSRMLS_CC);
 183                                 efree(pretty_str);
 184                         }
 185                         if (value_str && value_len) {
 186                                 zend_update_property_stringl(php_http_header_class_entry, getThis(), ZEND_STRL("value"), value_str, value_len TSRMLS_CC);
 187                         }
 188                 }
 189         } end_error_handling();
 190 }
 191
 192 PHP_METHOD(HttpHeader, serialize)
 193 {
 194         php_http_buffer_t buf;
 195         zval *zname, *zvalue;
 196
 197         php_http_buffer_init(&buf);
 198         zname = php_http_ztyp(IS_STRING, zend_read_property(php_http_header_class_entry, getThis(), ZEND_STRL("name"), 0 TSRMLS_CC));
 199         php_http_buffer_append(&buf, Z_STRVAL_P(zname), Z_STRLEN_P(zname));
 200         zval_ptr_dtor(&zname);
 201         zvalue = php_http_ztyp(IS_STRING, zend_read_property(php_http_header_class_entry, getThis(), ZEND_STRL("value"), 0 TSRMLS_CC));
 202         if (Z_STRLEN_P(zvalue)) {
 203                 php_http_buffer_appends(&buf, ": ");
 204                 php_http_buffer_append(&buf, Z_STRVAL_P(zvalue), Z_STRLEN_P(zvalue));
 205         } else {
 206                 php_http_buffer_appends(&buf, ":");
 207         }
 208         zval_ptr_dtor(&zvalue);
 209
 210         RETURN_PHP_HTTP_BUFFER_VAL(&buf);
 211 }
 212
 213 PHP_METHOD(HttpHeader, unserialize)
 214 {
 215         char *serialized_str;
 216         int serialized_len;
 217
 218         if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &serialized_str, &serialized_len)) {
 219                 HashTable ht;
 220
 221                 zend_hash_init(&ht, 1, NULL, ZVAL_PTR_DTOR, 0);
 222                 if (SUCCESS == php_http_headers_parse(serialized_str, serialized_len, &ht, NULL, NULL TSRMLS_CC)) {
 223                         if (zend_hash_num_elements(&ht)) {
 224                                 zval **val, *cpy;
 225                                 char *str;
 226                                 uint len;
 227                                 ulong idx;
 228
 229                                 zend_hash_internal_pointer_reset(&ht);
 230                                 switch (zend_hash_get_current_key_ex(&ht, &str, &len, &idx, 0, NULL)) {
 231                                         case HASH_KEY_IS_STRING:
 232                                                 zend_update_property_stringl(php_http_header_class_entry, getThis(), ZEND_STRL("name"), str, len - 1 TSRMLS_CC);
 233                                                 break;
 234                                         case HASH_KEY_IS_LONG:
 235                                                 zend_update_property_long(php_http_header_class_entry, getThis(), ZEND_STRL("name"), idx TSRMLS_CC);
 236                                                 break;
 237                                         default:
 238                                                 break;
 239                                 }
 240                                 zend_hash_get_current_data(&ht, (void *) &val);
 241                                 cpy = php_http_zsep(1, IS_STRING, *val);
 242                                 zend_update_property(php_http_header_class_entry, getThis(), ZEND_STRL("value"), cpy TSRMLS_CC);
 243                                 zval_ptr_dtor(&cpy);
 244                         }
 245                 }
 246                 zend_hash_destroy(&ht);
 247         }
 248
 249 }
 250
 251 PHP_METHOD(HttpHeader, match)
 252 {
 253         char *val_str;
 254         int val_len;
 255         long flags = 0;
 256         zval *zvalue;
 257
 258         if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|sl", &val_str, &val_len, &flags)) {
 259                 RETURN_NULL();
 260         }
 261
 262         zvalue = php_http_ztyp(IS_STRING, zend_read_property(php_http_header_class_entry, getThis(), ZEND_STRL("value"), 0 TSRMLS_CC));
 263         RETVAL_BOOL(php_http_match(Z_STRVAL_P(zvalue), val_str, flags));
 264         zval_ptr_dtor(&zvalue);
 265 }
 266
 267 PHP_METHOD(HttpHeader, negotiate)
 268 {
 269         HashTable *supported, *rs;
 270         zval *zname, *zvalue, *rs_array = NULL;
 271         char *sep_str = NULL;
 272         size_t sep_len = 0;
 273
 274         if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "H|z", &supported, &rs_array)) {
 275                 if (rs_array) {
 276                         zval_dtor(rs_array);
 277                         array_init(rs_array);
 278                 }
 279
 280                 zname = php_http_ztyp(IS_STRING, zend_read_property(php_http_header_class_entry, getThis(), ZEND_STRL("name"), 0 TSRMLS_CC));
 281                 if (!strcasecmp(Z_STRVAL_P(zname), "Accept")) {
 282                         sep_str = "/";
 283                         sep_len = 1;
 284                 } else if (!strcasecmp(Z_STRVAL_P(zname), "Accept-Language")) {
 285                         sep_str = "-";
 286                         sep_len = 1;
 287                 }
 288                 zval_ptr_dtor(&zname);
 289
 290                 zvalue = php_http_ztyp(IS_STRING, zend_read_property(php_http_header_class_entry, getThis(), ZEND_STRL("value"), 0 TSRMLS_CC));
 291                 if ((rs = php_http_negotiate(Z_STRVAL_P(zvalue), Z_STRLEN_P(zvalue), supported, sep_str, sep_len TSRMLS_CC))) {
 292                         PHP_HTTP_DO_NEGOTIATE_HANDLE_RESULT(rs, supported, rs_array);
 293                 } else {
 294                         PHP_HTTP_DO_NEGOTIATE_HANDLE_DEFAULT(supported, rs_array);
 295                 }
 296                 zval_ptr_dtor(&zvalue);
 297         } else {
 298                 RETURN_FALSE;
 299         }
 300 }
 301
 302 PHP_METHOD(HttpHeader, getParams)
 303 {
 304         zval zctor, *zparams_obj, **zargs = NULL;
 305
 306         INIT_PZVAL(&zctor);
 307         ZVAL_STRINGL(&zctor, "__construct", lenof("__construct"), 0);
 308
 309         MAKE_STD_ZVAL(zparams_obj);
 310         object_init_ex(zparams_obj, php_http_params_get_class_entry());
 311
 312         zargs = (zval **) ecalloc(ZEND_NUM_ARGS()+1, sizeof(zval *));
 313         zargs[0] = zend_read_property(Z_OBJCE_P(getThis()), getThis(), ZEND_STRL("value"), 0 TSRMLS_CC);
 314         if (ZEND_NUM_ARGS()) {
 315                 zend_get_parameters_array(ZEND_NUM_ARGS(), ZEND_NUM_ARGS(), &zargs[1]);
 316         }
 317
 318         if (SUCCESS == call_user_function(NULL, &zparams_obj, &zctor, return_value, ZEND_NUM_ARGS()+1, zargs TSRMLS_CC)) {
 319                 RETVAL_ZVAL(zparams_obj, 0, 1);
 320         }
 321
 322         if (zargs) {
 323                 efree(zargs);
 324         }
 325 }
 326
 327 PHP_METHOD(HttpHeader, parse)
 328 {
 329         char *header_str;
 330         int header_len;
 331         zend_class_entry *ce = NULL;
 332
 333         if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|C", &header_str, &header_len, &ce)) {
 334                 array_init(return_value);
 335
 336                 if (SUCCESS != php_http_headers_parse(header_str, header_len, Z_ARRVAL_P(return_value), NULL, NULL TSRMLS_CC)) {
 337                         php_http_error(HE_WARNING, PHP_HTTP_E_MALFORMED_HEADERS, "Could not parse headers");
 338                         zval_dtor(return_value);
 339                         RETVAL_NULL();
 340                 } else {
 341                         if (ce && instanceof_function(ce, php_http_header_class_entry TSRMLS_CC)) {
 342                                 HashPosition pos;
 343                                 php_http_array_hashkey_t key = php_http_array_hashkey_init(0);
 344                                 zval **val;
 345
 346                                 FOREACH_KEYVAL(pos, return_value, key, val) {
 347                                         zval *zho, *zkey, *zvalue;
 348
 349                                         Z_ADDREF_PP(val);
 350                                         zvalue = *val;
 351
 352                                         MAKE_STD_ZVAL(zkey);
 353                                         if (key.type == HASH_KEY_IS_LONG) {
 354                                                 ZVAL_LONG(zkey, key.num);
 355                                         } else {
 356                                                 ZVAL_STRINGL(zkey, key.str, key.len - 1, 1);
 357                                         }
 358
 359                                         MAKE_STD_ZVAL(zho);
 360                                         object_init_ex(zho, ce);
 361                                         zend_call_method_with_2_params(&zho, ce, NULL, "__construct", NULL, zkey, zvalue);
 362
 363                                         if (key.type == HASH_KEY_IS_LONG) {
 364                                                 zend_hash_index_update(Z_ARRVAL_P(return_value), key.num, (void *) &zho, sizeof(zval *), NULL);
 365                                         } else {
 366                                                 zend_hash_update(Z_ARRVAL_P(return_value), key.str, key.len, (void *) &zho, sizeof(zval *), NULL);
 367                                         }
 368
 369                                         zval_ptr_dtor(&zvalue);
 370                                         zval_ptr_dtor(&zkey);
 371                                 }
 372                         }
 373                 }
 374         }
 375 }
 376
 377 PHP_MINIT_FUNCTION(http_header)
 378 {
 379         PHP_HTTP_REGISTER_CLASS(http, Header, http_header, php_http_object_get_class_entry(), 0);
 380         zend_class_implements(php_http_header_class_entry TSRMLS_CC, 1, zend_ce_serializable);
 381         zend_declare_class_constant_long(php_http_header_class_entry, ZEND_STRL("MATCH_LOOSE"), PHP_HTTP_MATCH_LOOSE TSRMLS_CC);
 382         zend_declare_class_constant_long(php_http_header_class_entry, ZEND_STRL("MATCH_CASE"), PHP_HTTP_MATCH_CASE TSRMLS_CC);
 383         zend_declare_class_constant_long(php_http_header_class_entry, ZEND_STRL("MATCH_WORD"), PHP_HTTP_MATCH_WORD TSRMLS_CC);
 384         zend_declare_class_constant_long(php_http_header_class_entry, ZEND_STRL("MATCH_FULL"), PHP_HTTP_MATCH_FULL TSRMLS_CC);
 385         zend_declare_class_constant_long(php_http_header_class_entry, ZEND_STRL("MATCH_STRICT"), PHP_HTTP_MATCH_STRICT TSRMLS_CC);
 386         zend_declare_property_null(php_http_header_class_entry, ZEND_STRL("name"), ZEND_ACC_PUBLIC TSRMLS_CC);
 387         zend_declare_property_null(php_http_header_class_entry, ZEND_STRL("value"), ZEND_ACC_PUBLIC TSRMLS_CC);
 388
 389         return SUCCESS;
 390 }
 391
 392 /*
 393  * Local variables:
 394  * tab-width: 4
 395  * c-basic-offset: 4
 396  * End:
 397  * vim600: noet sw=4 ts=4 fdm=marker
 398  * vim<600: noet sw=4 ts=4
 399  */
 400