git.m6w6.name Git - m6w6/ext-http/blob - src/php_http_header.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-2014, Michael Wallner <mike@php.net>            |
  10     +--------------------------------------------------------------------+
  11 */
  12
  13 #include "php_http_api.h"
  14
  15 ZEND_RESULT_CODE php_http_header_parse(const char *header, size_t length, HashTable *headers, php_http_info_callback_t callback_func, void **callback_data)
  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_error_docref(NULL, E_WARNING, "Could not allocate buffer");
  23                 return FAILURE;
  24         }
  25
  26         if (!php_http_header_parser_init(&ctx)) {
  27                 php_http_buffer_dtor(&buf);
  28                 php_error_docref(NULL, E_WARNING, "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         return rs == PHP_HTTP_HEADER_PARSER_STATE_FAILURE ? FAILURE : SUCCESS;
  37 }
  38
  39 void php_http_header_to_callback(HashTable *headers, zend_bool crlf, php_http_pass_format_callback_t cb, void *cb_arg)
  40 {
  41         php_http_arrkey_t key;
  42         zval *header;
  43
  44         ZEND_HASH_FOREACH_KEY_VAL(headers, key.h, key.key, header)
  45         {
  46                 if (key.key) {
  47                         php_http_header_to_callback_ex(key.key->val, header, crlf, cb, cb_arg);
  48                 }
  49         }
  50         ZEND_HASH_FOREACH_END();
  51 /*
  52 <<<<<<< HEAD
  53         php_http_arrkey_t key;
  54         zval *header, *single_header;
  55
  56         ZEND_HASH_FOREACH_KEY_VAL(headers, key.h, key.key, header)
  57         {
  58                 if (key.key) {
  59                         if (zend_string_equals_literal(key.key, "Set-Cookie") && Z_TYPE_P(header) == IS_ARRAY) {
  60                                 ZEND_HASH_FOREACH_VAL(Z_ARRVAL_P(header), single_header)
  61                                 {
  62                                         if (Z_TYPE_P(single_header) == IS_ARRAY) {
  63                                                 php_http_cookie_list_t *cookie = php_http_cookie_list_from_struct(NULL, single_header);
  64
  65                                                 if (cookie) {
  66                                                         char *buf;
  67                                                         size_t len;
  68
  69                                                         php_http_cookie_list_to_string(cookie, &buf, &len);
  70                                                         cb(cb_arg, crlf ? "Set-Cookie: %s" PHP_HTTP_CRLF : "Set-Cookie: %s", buf);
  71                                                         php_http_cookie_list_free(&cookie);
  72                                                         efree(buf);
  73                                                 }
  74                                         } else {
  75                                                 zend_string *zs = php_http_header_value_to_string(single_header);
  76
  77                                                 cb(cb_arg, crlf ? "Set-Cookie: %s" PHP_HTTP_CRLF : "Set-Cookie: %s", zs->val);
  78                                                 zend_string_release(zs);
  79                                         }
  80                                 }
  81                                 ZEND_HASH_FOREACH_END();
  82                         } else {
  83                                 zend_string *zs = php_http_header_value_to_string(header);
  84
  85                                 cb(cb_arg, crlf ? "%s: %s" PHP_HTTP_CRLF : "%s: %s", key.key->val, zs->val);
  86                                 zend_string_release(zs);
  87                         }
  88 =======
  89 >>>>>>> 343738ad56eb70017704fdac57cf0d74da3d0f2e
  90 */
  91 }
  92
  93 void php_http_header_to_string(php_http_buffer_t *str, HashTable *headers)
  94 {
  95         php_http_header_to_callback(headers, 1, (php_http_pass_format_callback_t) php_http_buffer_appendf, str);
  96 }
  97
  98 void php_http_header_to_callback_ex(const char *key, zval *val, zend_bool crlf, php_http_pass_format_callback_t cb, void *cb_arg)
  99 {
 100         zval *aval;
 101         zend_string *str;
 102
 103         ZVAL_DEREF(val);
 104         switch (Z_TYPE_P(val)) {
 105         case IS_ARRAY:
 106                 ZEND_HASH_FOREACH_VAL(Z_ARRVAL_P(val), aval)
 107                 {
 108                         php_http_header_to_callback_ex(key, aval, crlf, cb, cb_arg);
 109                 }
 110                 ZEND_HASH_FOREACH_END();
 111                 break;
 112
 113         case IS_TRUE:
 114                 cb(cb_arg, "%s: true%s", key, crlf ? PHP_HTTP_CRLF:"");
 115                 break;
 116
 117         case IS_FALSE:
 118                 cb(cb_arg, "%s: false%s", key, crlf ? PHP_HTTP_CRLF:"");
 119                 break;
 120
 121         default:
 122                 str = zval_get_string(val);
 123                 cb(cb_arg, "%s: %s%s", key, str->val, crlf ? PHP_HTTP_CRLF:"");
 124                 zend_string_release(str);
 125                 break;
 126         }
 127 }
 128
 129 void php_http_header_to_string_ex(php_http_buffer_t *str, const char *key, zval *val)
 130 {
 131         php_http_header_to_callback_ex(key, val, 1, (php_http_pass_format_callback_t) php_http_buffer_appendf, str);
 132 }
 133
 134 zend_string *php_http_header_value_array_to_string(zval *header)
 135 {
 136         zval *val;
 137         php_http_buffer_t str;
 138
 139         php_http_buffer_init(&str);
 140         ZEND_HASH_FOREACH_VAL(Z_ARRVAL_P(header), val)
 141         {
 142                 zend_string *zs = php_http_header_value_to_string(val);
 143
 144                 php_http_buffer_appendf(&str, str.used ? ", %s":"%s", zs->val);
 145                 zend_string_release(zs);
 146         }
 147         ZEND_HASH_FOREACH_END();
 148         php_http_buffer_fix(&str);
 149
 150         return php_http_cs2zs(str.data, str.used);
 151 }
 152
 153 zend_string *php_http_header_value_to_string(zval *header)
 154 {
 155         switch (Z_TYPE_P(header)) {
 156         case IS_TRUE:
 157                 return zend_string_init(ZEND_STRL("true"), 0);
 158         case IS_FALSE:
 159                 return zend_string_init(ZEND_STRL("false"), 0);
 160         case IS_ARRAY:
 161                 return php_http_header_value_array_to_string(header);
 162         default:
 163                 return zval_get_string(header);
 164         }
 165 }
 166
 167 static zend_class_entry *php_http_header_class_entry;
 168 zend_class_entry *php_http_header_get_class_entry(void)
 169 {
 170         return php_http_header_class_entry;
 171 }
 172
 173 ZEND_BEGIN_ARG_INFO_EX(ai_HttpHeader___construct, 0, 0, 0)
 174         ZEND_ARG_INFO(0, name)
 175         ZEND_ARG_INFO(0, value)
 176 ZEND_END_ARG_INFO();
 177 PHP_METHOD(HttpHeader, __construct)
 178 {
 179         char *name_str = NULL, *value_str = NULL;
 180         size_t name_len = 0, value_len = 0;
 181
 182         php_http_expect(SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS(), "|s!s!", &name_str, &name_len, &value_str, &value_len), invalid_arg, return);
 183
 184         if (name_str && name_len) {
 185                 char *pretty_str = estrndup(name_str, name_len);
 186                 zend_update_property_stringl(php_http_header_class_entry, Z_OBJ_P(ZEND_THIS), ZEND_STRL("name"), php_http_pretty_key(pretty_str, name_len, 1, 1), name_len);
 187                 efree(pretty_str);
 188         }
 189         if (value_str && value_len) {
 190                 zend_update_property_stringl(php_http_header_class_entry, Z_OBJ_P(ZEND_THIS), ZEND_STRL("value"), value_str, value_len);
 191         }
 192 }
 193
 194 ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(ai_HttpHeader___serialize, 0, 0, IS_ARRAY, 0)
 195 ZEND_END_ARG_INFO();
 196 PHP_METHOD(HttpHeader, __serialize)
 197 {
 198         zval name, value, *ptr;
 199
 200         zend_parse_parameters_none();
 201
 202         array_init(return_value);
 203         ptr = zend_read_property(php_http_header_class_entry, Z_OBJ_P(ZEND_THIS), ZEND_STRL("name"), 0, &name);
 204         Z_TRY_ADDREF_P(ptr);
 205         add_next_index_zval(return_value, ptr);
 206         ptr = zend_read_property(php_http_header_class_entry, Z_OBJ_P(ZEND_THIS), ZEND_STRL("value"), 0, &value);
 207         Z_TRY_ADDREF_P(ptr);
 208         add_next_index_zval(return_value, ptr);
 209 }
 210
 211 ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(ai_HttpHeader___unserialize, 0, 1, IS_VOID, 0)
 212         ZEND_ARG_TYPE_INFO(0, data, IS_ARRAY, 0)
 213 ZEND_END_ARG_INFO();
 214 PHP_METHOD(HttpHeader, __unserialize)
 215 {
 216         HashTable *ha;
 217         zval *name, *value;
 218
 219         php_http_expect(SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS(), "h", &ha), invalid_arg, return);
 220         name = zend_hash_index_find(ha, 0);
 221         value = zend_hash_index_find(ha, 1);
 222
 223         if (name && value) {
 224                 zend_update_property(php_http_header_class_entry, Z_OBJ_P(ZEND_THIS), ZEND_STRL("name"), name);
 225                 zend_update_property(php_http_header_class_entry, Z_OBJ_P(ZEND_THIS), ZEND_STRL("value"), value);
 226         }
 227 }
 228
 229 ZEND_BEGIN_ARG_INFO_EX(ai_HttpHeader_serialize, 0, 0, 0)
 230 ZEND_END_ARG_INFO();
 231 PHP_METHOD(HttpHeader, serialize)
 232 {
 233         if (SUCCESS == zend_parse_parameters_none()) {
 234                 php_http_buffer_t buf;
 235                 zend_string *zs;
 236                 zval name_tmp, value_tmp;
 237
 238                 php_http_buffer_init(&buf);
 239                 zs = zval_get_string(zend_read_property(php_http_header_class_entry, Z_OBJ_P(ZEND_THIS), ZEND_STRL("name"), 0, &name_tmp));
 240                 php_http_buffer_appendz(&buf, zs);
 241                 zend_string_release(zs);
 242
 243                 zs = zval_get_string(zend_read_property(php_http_header_class_entry, Z_OBJ_P(ZEND_THIS), ZEND_STRL("value"), 0, &value_tmp));
 244                 if (zs->len) {
 245                         php_http_buffer_appends(&buf, ": ");
 246                         php_http_buffer_appendz(&buf, zs);
 247                 } else {
 248                         php_http_buffer_appends(&buf, ":");
 249                 }
 250                 zend_string_release(zs);
 251
 252                 RETURN_STR(php_http_cs2zs(buf.data, buf.used));
 253         }
 254         RETURN_EMPTY_STRING();
 255 }
 256
 257 ZEND_BEGIN_ARG_INFO_EX(ai_HttpHeader_unserialize, 0, 0, 1)
 258         ZEND_ARG_INFO(0, serialized)
 259 ZEND_END_ARG_INFO();
 260 PHP_METHOD(HttpHeader, unserialize)
 261 {
 262         char *serialized_str;
 263         size_t serialized_len;
 264
 265         if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS(), "s", &serialized_str, &serialized_len)) {
 266                 HashTable ht;
 267
 268                 zend_hash_init(&ht, 1, NULL, ZVAL_PTR_DTOR, 0);
 269                 if (SUCCESS == php_http_header_parse(serialized_str, serialized_len, &ht, NULL, NULL)) {
 270                         if (zend_hash_num_elements(&ht)) {
 271                                 zend_string *zs, *key;
 272                                 zend_ulong idx;
 273
 274                                 zend_hash_internal_pointer_reset(&ht);
 275                                 switch (zend_hash_get_current_key(&ht, &key, &idx)) {
 276                                         case HASH_KEY_IS_STRING:
 277                                                 zend_update_property_str(php_http_header_class_entry, Z_OBJ_P(ZEND_THIS), ZEND_STRL("name"), key);
 278                                                 break;
 279                                         case HASH_KEY_IS_LONG:
 280                                                 zend_update_property_long(php_http_header_class_entry, Z_OBJ_P(ZEND_THIS), ZEND_STRL("name"), idx);
 281                                                 break;
 282                                         default:
 283                                                 break;
 284                                 }
 285                                 zs = zval_get_string(zend_hash_get_current_data(&ht));
 286                                 zend_update_property_str(php_http_header_class_entry, Z_OBJ_P(ZEND_THIS), ZEND_STRL("value"), zs);
 287                                 zend_string_release(zs);
 288                         }
 289                 }
 290                 zend_hash_destroy(&ht);
 291         }
 292
 293 }
 294
 295 ZEND_BEGIN_ARG_INFO_EX(ai_HttpHeader_match, 0, 0, 1)
 296         ZEND_ARG_INFO(0, value)
 297         ZEND_ARG_INFO(0, flags)
 298 ZEND_END_ARG_INFO();
 299 PHP_METHOD(HttpHeader, match)
 300 {
 301         char *val_str = NULL;
 302         size_t val_len = 0;
 303         zend_long flags = PHP_HTTP_MATCH_LOOSE;
 304         zend_string *zs;
 305         zval value_tmp;
 306
 307         if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS(), "|sl", &val_str, &val_len, &flags)) {
 308                 return;
 309         }
 310
 311         zs = zval_get_string(zend_read_property(php_http_header_class_entry, Z_OBJ_P(ZEND_THIS), ZEND_STRL("value"), 0, &value_tmp));
 312         RETVAL_BOOL(php_http_match(zs->val, val_str, flags));
 313         zend_string_release(zs);
 314 }
 315
 316 ZEND_BEGIN_ARG_INFO_EX(ai_HttpHeader_negotiate, 0, 0, 1)
 317         ZEND_ARG_INFO(0, supported)
 318         ZEND_ARG_INFO(1, result)
 319 ZEND_END_ARG_INFO();
 320 PHP_METHOD(HttpHeader, negotiate)
 321 {
 322         HashTable *supported, *rs;
 323         zval name_tmp, value_tmp, *rs_array = NULL;
 324         zend_string *zs;
 325         char *sep_str = NULL;
 326         size_t sep_len = 0;
 327
 328         if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS(), "H|z", &supported, &rs_array)) {
 329                 return;
 330         }
 331         if (rs_array) {
 332                 ZVAL_DEREF(rs_array);
 333                 zval_dtor(rs_array);
 334                 array_init(rs_array);
 335         }
 336
 337         zs = zval_get_string(zend_read_property(php_http_header_class_entry, Z_OBJ_P(ZEND_THIS), ZEND_STRL("name"), 0, &name_tmp));
 338         if (zend_string_equals_literal(zs, "Accept")) {
 339                 sep_str = "/";
 340                 sep_len = 1;
 341         } else if (zend_string_equals_literal(zs, "Accept-Language")) {
 342                 sep_str = "-";
 343                 sep_len = 1;
 344         }
 345         zend_string_release(zs);
 346
 347         zs = zval_get_string(zend_read_property(php_http_header_class_entry, Z_OBJ_P(ZEND_THIS), ZEND_STRL("value"), 0, &value_tmp));
 348         if ((rs = php_http_negotiate(zs->val, zs->len, supported, sep_str, sep_len))) {
 349                 PHP_HTTP_DO_NEGOTIATE_HANDLE_RESULT(rs, supported, rs_array);
 350         } else {
 351                 PHP_HTTP_DO_NEGOTIATE_HANDLE_DEFAULT(supported, rs_array);
 352         }
 353         zend_string_release(zs);
 354 }
 355
 356 ZEND_BEGIN_ARG_INFO_EX(ai_HttpHeader_getParams, 0, 0, 0)
 357         ZEND_ARG_INFO(0, param_sep)
 358         ZEND_ARG_INFO(0, arg_sep)
 359         ZEND_ARG_INFO(0, val_sep)
 360         ZEND_ARG_INFO(0, flags)
 361 ZEND_END_ARG_INFO();
 362 PHP_METHOD(HttpHeader, getParams)
 363 {
 364         zval value_tmp, zctor, zparams_obj, *zargs = NULL;
 365
 366         ZVAL_STRINGL(&zctor, "__construct", lenof("__construct"));
 367
 368         object_init_ex(&zparams_obj, php_http_params_get_class_entry());
 369
 370         zargs = (zval *) ecalloc(ZEND_NUM_ARGS()+1, sizeof(zval));
 371         ZVAL_COPY_VALUE(&zargs[0], zend_read_property(php_http_header_class_entry, Z_OBJ_P(ZEND_THIS), ZEND_STRL("value"), 0, &value_tmp));
 372         if (ZEND_NUM_ARGS()) {
 373                 zend_get_parameters_array(ZEND_NUM_ARGS(), ZEND_NUM_ARGS(), &zargs[1]);
 374         }
 375
 376         if (SUCCESS == call_user_function(NULL, &zparams_obj, &zctor, return_value, ZEND_NUM_ARGS()+1, zargs)) {
 377                 RETVAL_ZVAL(&zparams_obj, 0, 1);
 378         }
 379
 380         zval_ptr_dtor(&zctor);
 381         if (zargs) {
 382                 efree(zargs);
 383         }
 384 }
 385
 386 ZEND_BEGIN_ARG_INFO_EX(ai_HttpHeader_parse, 0, 0, 1)
 387         ZEND_ARG_INFO(0, string)
 388         ZEND_ARG_INFO(0, header_class)
 389 ZEND_END_ARG_INFO();
 390 PHP_METHOD(HttpHeader, parse)
 391 {
 392         char *header_str;
 393         size_t header_len;
 394         zend_class_entry *ce = NULL;
 395
 396         if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS(), "s|C", &header_str, &header_len, &ce)) {
 397                 array_init(return_value);
 398
 399                 if (SUCCESS != php_http_header_parse(header_str, header_len, Z_ARRVAL_P(return_value), NULL, NULL)) {
 400                         zval_dtor(return_value);
 401                         RETURN_FALSE;
 402                 } else {
 403                         if (ce && instanceof_function(ce, php_http_header_class_entry)) {
 404                                 php_http_arrkey_t key;
 405                                 zval *val;
 406
 407                                 ZEND_HASH_FOREACH_KEY_VAL(Z_ARRVAL_P(return_value), key.h, key.key, val)
 408                                 {
 409                                         zval zkey, zho;
 410
 411                                         if (key.key) {
 412                                                 ZVAL_STR_COPY(&zkey, key.key);
 413                                         } else {
 414                                                 ZVAL_LONG(&zkey, key.h);
 415                                         }
 416
 417                                         object_init_ex(&zho, ce);
 418                                         Z_TRY_ADDREF_P(val);
 419                                         zend_call_method_with_2_params(Z_OBJ(zho), ce, NULL, "__construct", NULL, &zkey, val);
 420                                         zval_ptr_dtor(val);
 421                                         zval_ptr_dtor(&zkey);
 422
 423                                         if (key.key) {
 424                                                 add_assoc_zval_ex(return_value, key.key->val, key.key->len, &zho);
 425                                         } else {
 426                                                 add_index_zval(return_value, key.h, &zho);
 427                                         }
 428                                 }
 429                                 ZEND_HASH_FOREACH_END();
 430                         }
 431                 }
 432         }
 433 }
 434
 435 static zend_function_entry php_http_header_methods[] = {
 436         PHP_ME(HttpHeader, __construct,   ai_HttpHeader___construct, ZEND_ACC_PUBLIC)
 437         PHP_ME(HttpHeader, __unserialize, ai_HttpHeader___unserialize, ZEND_ACC_PUBLIC)
 438         PHP_ME(HttpHeader, __serialize,   ai_HttpHeader___serialize, ZEND_ACC_PUBLIC)
 439         PHP_ME(HttpHeader, unserialize,   ai_HttpHeader_unserialize, ZEND_ACC_PUBLIC)
 440         PHP_ME(HttpHeader, serialize,     ai_HttpHeader_serialize, ZEND_ACC_PUBLIC)
 441         ZEND_MALIAS(HttpHeader, __toString, serialize, ai_HttpHeader_serialize, ZEND_ACC_PUBLIC)
 442         ZEND_MALIAS(HttpHeader, toString, serialize, ai_HttpHeader_serialize, ZEND_ACC_PUBLIC)
 443         PHP_ME(HttpHeader, match,         ai_HttpHeader_match, ZEND_ACC_PUBLIC)
 444         PHP_ME(HttpHeader, negotiate,     ai_HttpHeader_negotiate, ZEND_ACC_PUBLIC)
 445         PHP_ME(HttpHeader, getParams,     ai_HttpHeader_getParams, ZEND_ACC_PUBLIC)
 446         PHP_ME(HttpHeader, parse,         ai_HttpHeader_parse, ZEND_ACC_PUBLIC|ZEND_ACC_STATIC)
 447         EMPTY_FUNCTION_ENTRY
 448 };
 449
 450 PHP_MINIT_FUNCTION(http_header)
 451 {
 452         zend_class_entry ce = {0};
 453
 454         INIT_NS_CLASS_ENTRY(ce, "http", "Header", php_http_header_methods);
 455         php_http_header_class_entry = zend_register_internal_class(&ce);
 456         zend_class_implements(php_http_header_class_entry, 1, zend_ce_serializable);
 457         zend_declare_class_constant_long(php_http_header_class_entry, ZEND_STRL("MATCH_LOOSE"), PHP_HTTP_MATCH_LOOSE);
 458         zend_declare_class_constant_long(php_http_header_class_entry, ZEND_STRL("MATCH_CASE"), PHP_HTTP_MATCH_CASE);
 459         zend_declare_class_constant_long(php_http_header_class_entry, ZEND_STRL("MATCH_WORD"), PHP_HTTP_MATCH_WORD);
 460         zend_declare_class_constant_long(php_http_header_class_entry, ZEND_STRL("MATCH_FULL"), PHP_HTTP_MATCH_FULL);
 461         zend_declare_class_constant_long(php_http_header_class_entry, ZEND_STRL("MATCH_STRICT"), PHP_HTTP_MATCH_STRICT);
 462         zend_declare_property_null(php_http_header_class_entry, ZEND_STRL("name"), ZEND_ACC_PUBLIC);
 463         zend_declare_property_null(php_http_header_class_entry, ZEND_STRL("value"), ZEND_ACC_PUBLIC);
 464
 465         return SUCCESS;
 466 }
 467
 468 /*
 469  * Local variables:
 470  * tab-width: 4
 471  * c-basic-offset: 4
 472  * End:
 473  * vim600: noet sw=4 ts=4 fdm=marker
 474  * vim<600: noet sw=4 ts=4
 475  */
 476