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, *single_header;
  43
  44         ZEND_HASH_FOREACH_KEY_VAL(headers, key.h, key.key, header)
  45         {
  46                 if (key.key) {
  47                         if (zend_string_equals_literal(key.key, "Set-Cookie") && Z_TYPE_P(header) == IS_ARRAY) {
  48                                 ZEND_HASH_FOREACH_VAL(Z_ARRVAL_P(header), single_header)
  49                                 {
  50                                         if (Z_TYPE_P(single_header) == IS_ARRAY) {
  51                                                 php_http_cookie_list_t *cookie = php_http_cookie_list_from_struct(NULL, single_header);
  52
  53                                                 if (cookie) {
  54                                                         char *buf;
  55                                                         size_t len;
  56
  57                                                         php_http_cookie_list_to_string(cookie, &buf, &len);
  58                                                         cb(cb_arg, crlf ? "Set-Cookie: %s" PHP_HTTP_CRLF : "Set-Cookie: %s", buf);
  59                                                         php_http_cookie_list_free(&cookie);
  60                                                         efree(buf);
  61                                                 }
  62                                         } else {
  63                                                 zend_string *zs = php_http_header_value_to_string(single_header);
  64
  65                                                 cb(cb_arg, crlf ? "Set-Cookie: %s" PHP_HTTP_CRLF : "Set-Cookie: %s", zs->val);
  66                                                 zend_string_release(zs);
  67                                         }
  68                                 }
  69                                 ZEND_HASH_FOREACH_END();
  70                         } else {
  71                                 zend_string *zs = php_http_header_value_to_string(header);
  72
  73                                 cb(cb_arg, crlf ? "%s: %s" PHP_HTTP_CRLF : "%s: %s", key.key->val, zs->val);
  74                                 zend_string_release(zs);
  75                         }
  76                 }
  77         }
  78         ZEND_HASH_FOREACH_END();
  79 }
  80
  81 void php_http_header_to_string(php_http_buffer_t *str, HashTable *headers)
  82 {
  83         php_http_header_to_callback(headers, 1, (php_http_pass_format_callback_t) php_http_buffer_appendf, str);
  84 }
  85
  86 zend_string *php_http_header_value_array_to_string(zval *header)
  87 {
  88         zval *val;
  89         php_http_buffer_t str;
  90
  91         php_http_buffer_init(&str);
  92         ZEND_HASH_FOREACH_VAL(Z_ARRVAL_P(header), val)
  93         {
  94                 zend_string *zs = php_http_header_value_to_string(val);
  95
  96                 php_http_buffer_appendf(&str, str.used ? ", %s":"%s", zs->val);
  97                 zend_string_release(zs);
  98         }
  99         ZEND_HASH_FOREACH_END();
 100         php_http_buffer_fix(&str);
 101
 102         return php_http_cs2zs(str.data, str.used);
 103 }
 104
 105 zend_string *php_http_header_value_to_string(zval *header)
 106 {
 107         switch (Z_TYPE_P(header)) {
 108         case IS_TRUE:
 109                 return zend_string_init(ZEND_STRL("true"), 0);
 110         case IS_FALSE:
 111                 return zend_string_init(ZEND_STRL("false"), 0);
 112         case IS_ARRAY:
 113                 return php_http_header_value_array_to_string(header);
 114         default:
 115                 return zval_get_string(header);
 116         }
 117 }
 118
 119 static zend_class_entry *php_http_header_class_entry;
 120 zend_class_entry *php_http_header_get_class_entry(void)
 121 {
 122         return php_http_header_class_entry;
 123 }
 124
 125 ZEND_BEGIN_ARG_INFO_EX(ai_HttpHeader___construct, 0, 0, 0)
 126         ZEND_ARG_INFO(0, name)
 127         ZEND_ARG_INFO(0, value)
 128 ZEND_END_ARG_INFO();
 129 PHP_METHOD(HttpHeader, __construct)
 130 {
 131         char *name_str = NULL, *value_str = NULL;
 132         size_t name_len = 0, value_len = 0;
 133
 134         php_http_expect(SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS(), "|s!s!", &name_str, &name_len, &value_str, &value_len), invalid_arg, return);
 135
 136         if (name_str && name_len) {
 137                 char *pretty_str = estrndup(name_str, name_len);
 138                 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);
 139                 efree(pretty_str);
 140         }
 141         if (value_str && value_len) {
 142                 zend_update_property_stringl(php_http_header_class_entry, getThis(), ZEND_STRL("value"), value_str, value_len);
 143         }
 144 }
 145
 146 ZEND_BEGIN_ARG_INFO_EX(ai_HttpHeader_serialize, 0, 0, 0)
 147 ZEND_END_ARG_INFO();
 148 PHP_METHOD(HttpHeader, serialize)
 149 {
 150         if (SUCCESS == zend_parse_parameters_none()) {
 151                 php_http_buffer_t buf;
 152                 zend_string *zs;
 153                 zval name_tmp, value_tmp;
 154
 155                 php_http_buffer_init(&buf);
 156                 zs = zval_get_string(zend_read_property(php_http_header_class_entry, getThis(), ZEND_STRL("name"), 0, &name_tmp));
 157                 php_http_buffer_appendz(&buf, zs);
 158                 zend_string_release(zs);
 159
 160                 zs = zval_get_string(zend_read_property(php_http_header_class_entry, getThis(), ZEND_STRL("value"), 0, &value_tmp));
 161                 if (zs->len) {
 162                         php_http_buffer_appends(&buf, ": ");
 163                         php_http_buffer_appendz(&buf, zs);
 164                 } else {
 165                         php_http_buffer_appends(&buf, ":");
 166                 }
 167                 zend_string_release(zs);
 168
 169                 RETURN_STR(php_http_cs2zs(buf.data, buf.used));
 170         }
 171         RETURN_EMPTY_STRING();
 172 }
 173
 174 ZEND_BEGIN_ARG_INFO_EX(ai_HttpHeader_unserialize, 0, 0, 1)
 175         ZEND_ARG_INFO(0, serialized)
 176 ZEND_END_ARG_INFO();
 177 PHP_METHOD(HttpHeader, unserialize)
 178 {
 179         char *serialized_str;
 180         size_t serialized_len;
 181
 182         if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS(), "s", &serialized_str, &serialized_len)) {
 183                 HashTable ht;
 184
 185                 zend_hash_init(&ht, 1, NULL, ZVAL_PTR_DTOR, 0);
 186                 if (SUCCESS == php_http_header_parse(serialized_str, serialized_len, &ht, NULL, NULL)) {
 187                         if (zend_hash_num_elements(&ht)) {
 188                                 zend_string *zs, *key;
 189                                 zend_ulong idx;
 190
 191                                 zend_hash_internal_pointer_reset(&ht);
 192                                 switch (zend_hash_get_current_key(&ht, &key, &idx)) {
 193                                         case HASH_KEY_IS_STRING:
 194                                                 zend_update_property_str(php_http_header_class_entry, getThis(), ZEND_STRL("name"), key);
 195                                                 break;
 196                                         case HASH_KEY_IS_LONG:
 197                                                 zend_update_property_long(php_http_header_class_entry, getThis(), ZEND_STRL("name"), idx);
 198                                                 break;
 199                                         default:
 200                                                 break;
 201                                 }
 202                                 zs = zval_get_string(zend_hash_get_current_data(&ht));
 203                                 zend_update_property_str(php_http_header_class_entry, getThis(), ZEND_STRL("value"), zs);
 204                                 zend_string_release(zs);
 205                         }
 206                 }
 207                 zend_hash_destroy(&ht);
 208         }
 209
 210 }
 211
 212 ZEND_BEGIN_ARG_INFO_EX(ai_HttpHeader_match, 0, 0, 1)
 213         ZEND_ARG_INFO(0, value)
 214         ZEND_ARG_INFO(0, flags)
 215 ZEND_END_ARG_INFO();
 216 PHP_METHOD(HttpHeader, match)
 217 {
 218         char *val_str = NULL;
 219         size_t val_len = 0;
 220         zend_long flags = PHP_HTTP_MATCH_LOOSE;
 221         zend_string *zs;
 222         zval value_tmp;
 223
 224         if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS(), "|sl", &val_str, &val_len, &flags)) {
 225                 return;
 226         }
 227
 228         zs = zval_get_string(zend_read_property(php_http_header_class_entry, getThis(), ZEND_STRL("value"), 0, &value_tmp));
 229         RETVAL_BOOL(php_http_match(zs->val, val_str, flags));
 230         zend_string_release(zs);
 231 }
 232
 233 ZEND_BEGIN_ARG_INFO_EX(ai_HttpHeader_negotiate, 0, 0, 1)
 234         ZEND_ARG_INFO(0, supported)
 235         ZEND_ARG_INFO(1, result)
 236 ZEND_END_ARG_INFO();
 237 PHP_METHOD(HttpHeader, negotiate)
 238 {
 239         HashTable *supported, *rs;
 240         zval name_tmp, value_tmp, *rs_array = NULL;
 241         zend_string *zs;
 242         char *sep_str = NULL;
 243         size_t sep_len = 0;
 244
 245         if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS(), "H|z", &supported, &rs_array)) {
 246                 return;
 247         }
 248         if (rs_array) {
 249                 ZVAL_DEREF(rs_array);
 250                 zval_dtor(rs_array);
 251                 array_init(rs_array);
 252         }
 253
 254         zs = zval_get_string(zend_read_property(php_http_header_class_entry, getThis(), ZEND_STRL("name"), 0, &name_tmp));
 255         if (zend_string_equals_literal(zs, "Accept")) {
 256                 sep_str = "/";
 257                 sep_len = 1;
 258         } else if (zend_string_equals_literal(zs, "Accept-Language")) {
 259                 sep_str = "-";
 260                 sep_len = 1;
 261         }
 262         zend_string_release(zs);
 263
 264         zs = zval_get_string(zend_read_property(php_http_header_class_entry, getThis(), ZEND_STRL("value"), 0, &value_tmp));
 265         if ((rs = php_http_negotiate(zs->val, zs->len, supported, sep_str, sep_len))) {
 266                 PHP_HTTP_DO_NEGOTIATE_HANDLE_RESULT(rs, supported, rs_array);
 267         } else {
 268                 PHP_HTTP_DO_NEGOTIATE_HANDLE_DEFAULT(supported, rs_array);
 269         }
 270         zend_string_release(zs);
 271 }
 272
 273 ZEND_BEGIN_ARG_INFO_EX(ai_HttpHeader_getParams, 0, 0, 0)
 274         ZEND_ARG_INFO(0, param_sep)
 275         ZEND_ARG_INFO(0, arg_sep)
 276         ZEND_ARG_INFO(0, val_sep)
 277         ZEND_ARG_INFO(0, flags)
 278 ZEND_END_ARG_INFO();
 279 PHP_METHOD(HttpHeader, getParams)
 280 {
 281         zval value_tmp, zctor, zparams_obj, *zargs = NULL;
 282
 283         ZVAL_STRINGL(&zctor, "__construct", lenof("__construct"));
 284
 285         object_init_ex(&zparams_obj, php_http_params_get_class_entry());
 286
 287         zargs = (zval *) ecalloc(ZEND_NUM_ARGS()+1, sizeof(zval));
 288         ZVAL_COPY_VALUE(&zargs[0], zend_read_property(php_http_header_class_entry, getThis(), ZEND_STRL("value"), 0, &value_tmp));
 289         if (ZEND_NUM_ARGS()) {
 290                 zend_get_parameters_array(ZEND_NUM_ARGS(), ZEND_NUM_ARGS(), &zargs[1]);
 291         }
 292
 293         if (SUCCESS == call_user_function(NULL, &zparams_obj, &zctor, return_value, ZEND_NUM_ARGS()+1, zargs)) {
 294                 RETVAL_ZVAL(&zparams_obj, 0, 1);
 295         }
 296
 297         zval_ptr_dtor(&zctor);
 298         if (zargs) {
 299                 efree(zargs);
 300         }
 301 }
 302
 303 ZEND_BEGIN_ARG_INFO_EX(ai_HttpHeader_parse, 0, 0, 1)
 304         ZEND_ARG_INFO(0, string)
 305         ZEND_ARG_INFO(0, header_class)
 306 ZEND_END_ARG_INFO();
 307 PHP_METHOD(HttpHeader, parse)
 308 {
 309         char *header_str;
 310         size_t header_len;
 311         zend_class_entry *ce = NULL;
 312
 313         if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS(), "s|C", &header_str, &header_len, &ce)) {
 314                 array_init(return_value);
 315
 316                 if (SUCCESS != php_http_header_parse(header_str, header_len, Z_ARRVAL_P(return_value), NULL, NULL)) {
 317                         zval_dtor(return_value);
 318                         RETURN_FALSE;
 319                 } else {
 320                         if (ce && instanceof_function(ce, php_http_header_class_entry)) {
 321                                 php_http_arrkey_t key;
 322                                 zval *val;
 323
 324                                 ZEND_HASH_FOREACH_KEY_VAL(Z_ARRVAL_P(return_value), key.h, key.key, val)
 325                                 {
 326                                         zval zkey, zho;
 327
 328                                         if (key.key) {
 329                                                 ZVAL_STR_COPY(&zkey, key.key);
 330                                         } else {
 331                                                 ZVAL_LONG(&zkey, key.h);
 332                                         }
 333
 334                                         object_init_ex(&zho, ce);
 335                                         Z_TRY_ADDREF_P(val);
 336                                         zend_call_method_with_2_params(&zho, ce, NULL, "__construct", NULL, &zkey, val);
 337                                         zval_ptr_dtor(val);
 338                                         zval_ptr_dtor(&zkey);
 339
 340                                         if (key.key) {
 341                                                 add_assoc_zval_ex(return_value, key.key->val, key.key->len, &zho);
 342                                         } else {
 343                                                 add_index_zval(return_value, key.h, &zho);
 344                                         }
 345                                 }
 346                                 ZEND_HASH_FOREACH_END();
 347                         }
 348                 }
 349         }
 350 }
 351
 352 static zend_function_entry php_http_header_methods[] = {
 353         PHP_ME(HttpHeader, __construct,   ai_HttpHeader___construct, ZEND_ACC_PUBLIC|ZEND_ACC_CTOR)
 354         PHP_ME(HttpHeader, serialize,     ai_HttpHeader_serialize, ZEND_ACC_PUBLIC)
 355         ZEND_MALIAS(HttpHeader, __toString, serialize, ai_HttpHeader_serialize, ZEND_ACC_PUBLIC)
 356         ZEND_MALIAS(HttpHeader, toString, serialize, ai_HttpHeader_serialize, ZEND_ACC_PUBLIC)
 357         PHP_ME(HttpHeader, unserialize,   ai_HttpHeader_unserialize, ZEND_ACC_PUBLIC)
 358         PHP_ME(HttpHeader, match,         ai_HttpHeader_match, ZEND_ACC_PUBLIC)
 359         PHP_ME(HttpHeader, negotiate,     ai_HttpHeader_negotiate, ZEND_ACC_PUBLIC)
 360         PHP_ME(HttpHeader, getParams,     ai_HttpHeader_getParams, ZEND_ACC_PUBLIC)
 361         PHP_ME(HttpHeader, parse,         ai_HttpHeader_parse, ZEND_ACC_PUBLIC|ZEND_ACC_STATIC)
 362         EMPTY_FUNCTION_ENTRY
 363 };
 364
 365 PHP_MINIT_FUNCTION(http_header)
 366 {
 367         zend_class_entry ce = {0};
 368
 369         INIT_NS_CLASS_ENTRY(ce, "http", "Header", php_http_header_methods);
 370         php_http_header_class_entry = zend_register_internal_class(&ce);
 371         zend_class_implements(php_http_header_class_entry, 1, zend_ce_serializable);
 372         zend_declare_class_constant_long(php_http_header_class_entry, ZEND_STRL("MATCH_LOOSE"), PHP_HTTP_MATCH_LOOSE);
 373         zend_declare_class_constant_long(php_http_header_class_entry, ZEND_STRL("MATCH_CASE"), PHP_HTTP_MATCH_CASE);
 374         zend_declare_class_constant_long(php_http_header_class_entry, ZEND_STRL("MATCH_WORD"), PHP_HTTP_MATCH_WORD);
 375         zend_declare_class_constant_long(php_http_header_class_entry, ZEND_STRL("MATCH_FULL"), PHP_HTTP_MATCH_FULL);
 376         zend_declare_class_constant_long(php_http_header_class_entry, ZEND_STRL("MATCH_STRICT"), PHP_HTTP_MATCH_STRICT);
 377         zend_declare_property_null(php_http_header_class_entry, ZEND_STRL("name"), ZEND_ACC_PUBLIC);
 378         zend_declare_property_null(php_http_header_class_entry, ZEND_STRL("value"), ZEND_ACC_PUBLIC);
 379
 380         return SUCCESS;
 381 }
 382
 383 /*
 384  * Local variables:
 385  * tab-width: 4
 386  * c-basic-offset: 4
 387  * End:
 388  * vim600: noet sw=4 ts=4 fdm=marker
 389  * vim<600: noet sw=4 ts=4
 390  */
 391