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