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_INFO_EX(ai_HttpHeader_tostring, 0, 0, 0)
 195 ZEND_END_ARG_INFO();
 196 PHP_METHOD(HttpHeader, __toString)
 197 {
 198         if (SUCCESS == zend_parse_parameters_none()) {
 199                 php_http_buffer_t buf;
 200                 zend_string *zs;
 201                 zval name_tmp, value_tmp;
 202
 203                 php_http_buffer_init(&buf);
 204                 zs = zval_get_string(zend_read_property(php_http_header_class_entry, Z_OBJ_P(ZEND_THIS), ZEND_STRL("name"), 0, &name_tmp));
 205                 php_http_buffer_appendz(&buf, zs);
 206                 zend_string_release(zs);
 207
 208                 zs = zval_get_string(zend_read_property(php_http_header_class_entry, Z_OBJ_P(ZEND_THIS), ZEND_STRL("value"), 0, &value_tmp));
 209                 if (zs->len) {
 210                         php_http_buffer_appends(&buf, ": ");
 211                         php_http_buffer_appendz(&buf, zs);
 212                 } else {
 213                         php_http_buffer_appends(&buf, ":");
 214                 }
 215                 zend_string_release(zs);
 216
 217                 RETURN_STR(php_http_cs2zs(buf.data, buf.used));
 218         }
 219         RETURN_EMPTY_STRING();
 220 }
 221
 222 ZEND_BEGIN_ARG_INFO_EX(ai_HttpHeader_serialize, 0, 0, 0)
 223 ZEND_END_ARG_INFO();
 224 PHP_METHOD(HttpHeader, __serialize)
 225 {
 226         zval *val, tmp;
 227
 228         if (SUCCESS != zend_parse_parameters_none()) {
 229                 RETURN_THROWS();
 230         }
 231         array_init(return_value);
 232
 233         val = zend_read_property(php_http_header_class_entry, Z_OBJ_P(ZEND_THIS), ZEND_STRL("name"), 0, &tmp);
 234         zend_hash_next_index_insert(Z_ARRVAL_P(return_value), val);
 235         val = zend_read_property(php_http_header_class_entry, Z_OBJ_P(ZEND_THIS), ZEND_STRL("value"), 0, &tmp);
 236         zend_hash_next_index_insert(Z_ARRVAL_P(return_value), val);
 237 }
 238
 239 ZEND_BEGIN_ARG_INFO_EX(ai_HttpHeader_unserialize, 0, 0, 1)
 240         ZEND_ARG_INFO(0, serialized)
 241 ZEND_END_ARG_INFO();
 242 PHP_METHOD(HttpHeader, __unserialize)
 243 {
 244         zval *serialized;
 245         HashTable *data;
 246
 247         if (zend_parse_parameters(ZEND_NUM_ARGS(), "h", &data) == FAILURE) {
 248                 RETURN_THROWS();
 249         }
 250
 251         ZVAL_NULL(return_value);
 252         serialized = zend_hash_index_find(data, 0);
 253         if (serialized) {
 254                 zend_update_property(php_http_header_class_entry, Z_OBJ_P(ZEND_THIS), ZEND_STRL("name"), serialized);
 255         }
 256         serialized = zend_hash_index_find(data, 1);
 257         if (serialized) {
 258                 zend_update_property(php_http_header_class_entry, Z_OBJ_P(ZEND_THIS), ZEND_STRL("value"), serialized);
 259         }
 260 }
 261
 262 ZEND_BEGIN_ARG_INFO_EX(ai_HttpHeader_match, 0, 0, 1)
 263         ZEND_ARG_INFO(0, value)
 264         ZEND_ARG_INFO(0, flags)
 265 ZEND_END_ARG_INFO();
 266 PHP_METHOD(HttpHeader, match)
 267 {
 268         char *val_str = NULL;
 269         size_t val_len = 0;
 270         zend_long flags = PHP_HTTP_MATCH_LOOSE;
 271         zend_string *zs;
 272         zval value_tmp;
 273
 274         if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS(), "|sl", &val_str, &val_len, &flags)) {
 275                 return;
 276         }
 277
 278         zs = zval_get_string(zend_read_property(php_http_header_class_entry, Z_OBJ_P(ZEND_THIS), ZEND_STRL("value"), 0, &value_tmp));
 279         RETVAL_BOOL(php_http_match(zs->val, val_str, flags));
 280         zend_string_release(zs);
 281 }
 282
 283 ZEND_BEGIN_ARG_INFO_EX(ai_HttpHeader_negotiate, 0, 0, 1)
 284         ZEND_ARG_INFO(0, supported)
 285         ZEND_ARG_INFO(1, result)
 286 ZEND_END_ARG_INFO();
 287 PHP_METHOD(HttpHeader, negotiate)
 288 {
 289         HashTable *supported, *rs;
 290         zval name_tmp, value_tmp, *rs_array = NULL;
 291         zend_string *zs;
 292         char *sep_str = NULL;
 293         size_t sep_len = 0;
 294
 295         if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS(), "H|z", &supported, &rs_array)) {
 296                 return;
 297         }
 298         if (rs_array) {
 299                 ZVAL_DEREF(rs_array);
 300                 zval_dtor(rs_array);
 301                 array_init(rs_array);
 302         }
 303
 304         zs = zval_get_string(zend_read_property(php_http_header_class_entry, Z_OBJ_P(ZEND_THIS), ZEND_STRL("name"), 0, &name_tmp));
 305         if (zend_string_equals_literal(zs, "Accept")) {
 306                 sep_str = "/";
 307                 sep_len = 1;
 308         } else if (zend_string_equals_literal(zs, "Accept-Language")) {
 309                 sep_str = "-";
 310                 sep_len = 1;
 311         }
 312         zend_string_release(zs);
 313
 314         zs = zval_get_string(zend_read_property(php_http_header_class_entry, Z_OBJ_P(ZEND_THIS), ZEND_STRL("value"), 0, &value_tmp));
 315         if ((rs = php_http_negotiate(zs->val, zs->len, supported, sep_str, sep_len))) {
 316                 PHP_HTTP_DO_NEGOTIATE_HANDLE_RESULT(rs, supported, rs_array);
 317         } else {
 318                 PHP_HTTP_DO_NEGOTIATE_HANDLE_DEFAULT(supported, rs_array);
 319         }
 320         zend_string_release(zs);
 321 }
 322
 323 ZEND_BEGIN_ARG_INFO_EX(ai_HttpHeader_getParams, 0, 0, 0)
 324         ZEND_ARG_INFO(0, param_sep)
 325         ZEND_ARG_INFO(0, arg_sep)
 326         ZEND_ARG_INFO(0, val_sep)
 327         ZEND_ARG_INFO(0, flags)
 328 ZEND_END_ARG_INFO();
 329 PHP_METHOD(HttpHeader, getParams)
 330 {
 331         zval value_tmp, zctor, zparams_obj, *zargs = NULL;
 332
 333         ZVAL_STRINGL(&zctor, "__construct", lenof("__construct"));
 334
 335         object_init_ex(&zparams_obj, php_http_params_get_class_entry());
 336
 337         zargs = (zval *) ecalloc(ZEND_NUM_ARGS()+1, sizeof(zval));
 338         ZVAL_COPY_VALUE(&zargs[0], zend_read_property(php_http_header_class_entry, Z_OBJ_P(ZEND_THIS), ZEND_STRL("value"), 0, &value_tmp));
 339         if (ZEND_NUM_ARGS()) {
 340                 zend_get_parameters_array(ZEND_NUM_ARGS(), ZEND_NUM_ARGS(), &zargs[1]);
 341         }
 342
 343         if (SUCCESS == call_user_function(NULL, &zparams_obj, &zctor, return_value, ZEND_NUM_ARGS()+1, zargs)) {
 344                 RETVAL_ZVAL(&zparams_obj, 0, 1);
 345         }
 346
 347         zval_ptr_dtor(&zctor);
 348         if (zargs) {
 349                 efree(zargs);
 350         }
 351 }
 352
 353 ZEND_BEGIN_ARG_INFO_EX(ai_HttpHeader_parse, 0, 0, 1)
 354         ZEND_ARG_INFO(0, string)
 355         ZEND_ARG_INFO(0, header_class)
 356 ZEND_END_ARG_INFO();
 357 PHP_METHOD(HttpHeader, parse)
 358 {
 359         char *header_str;
 360         size_t header_len;
 361         zend_class_entry *ce = NULL;
 362
 363         if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS(), "s|C", &header_str, &header_len, &ce)) {
 364                 array_init(return_value);
 365
 366                 if (SUCCESS != php_http_header_parse(header_str, header_len, Z_ARRVAL_P(return_value), NULL, NULL)) {
 367                         zval_dtor(return_value);
 368                         RETURN_FALSE;
 369                 } else {
 370                         if (ce && instanceof_function(ce, php_http_header_class_entry)) {
 371                                 php_http_arrkey_t key;
 372                                 zval *val;
 373
 374                                 ZEND_HASH_FOREACH_KEY_VAL(Z_ARRVAL_P(return_value), key.h, key.key, val)
 375                                 {
 376                                         zval zkey, zho;
 377
 378                                         if (key.key) {
 379                                                 ZVAL_STR_COPY(&zkey, key.key);
 380                                         } else {
 381                                                 ZVAL_LONG(&zkey, key.h);
 382                                         }
 383
 384                                         object_init_ex(&zho, ce);
 385                                         Z_TRY_ADDREF_P(val);
 386                                         zend_call_method_with_2_params(Z_OBJ(zho), ce, NULL, "__construct", NULL, &zkey, val);
 387                                         zval_ptr_dtor(val);
 388                                         zval_ptr_dtor(&zkey);
 389
 390                                         if (key.key) {
 391                                                 add_assoc_zval_ex(return_value, key.key->val, key.key->len, &zho);
 392                                         } else {
 393                                                 add_index_zval(return_value, key.h, &zho);
 394                                         }
 395                                 }
 396                                 ZEND_HASH_FOREACH_END();
 397                         }
 398                 }
 399         }
 400 }
 401
 402 static zend_function_entry php_http_header_methods[] = {
 403         PHP_ME(HttpHeader, __construct,   ai_HttpHeader___construct, ZEND_ACC_PUBLIC)
 404         PHP_ME(HttpHeader, __serialize,     ai_HttpHeader_serialize, ZEND_ACC_PUBLIC)
 405         PHP_ME(HttpHeader, __toString,      ai_HttpHeader_tostring, ZEND_ACC_PUBLIC)
 406         ZEND_MALIAS(HttpHeader, toString, __toString, ai_HttpHeader_tostring, ZEND_ACC_PUBLIC)
 407         PHP_ME(HttpHeader, __unserialize,   ai_HttpHeader_unserialize, ZEND_ACC_PUBLIC)
 408         PHP_ME(HttpHeader, match,         ai_HttpHeader_match, ZEND_ACC_PUBLIC)
 409         PHP_ME(HttpHeader, negotiate,     ai_HttpHeader_negotiate, ZEND_ACC_PUBLIC)
 410         PHP_ME(HttpHeader, getParams,     ai_HttpHeader_getParams, ZEND_ACC_PUBLIC)
 411         PHP_ME(HttpHeader, parse,         ai_HttpHeader_parse, ZEND_ACC_PUBLIC|ZEND_ACC_STATIC)
 412         EMPTY_FUNCTION_ENTRY
 413 };
 414
 415 PHP_MINIT_FUNCTION(http_header)
 416 {
 417         zend_class_entry ce = {0};
 418
 419         INIT_NS_CLASS_ENTRY(ce, "http", "Header", php_http_header_methods);
 420         php_http_header_class_entry = zend_register_internal_class(&ce);
 421         zend_declare_class_constant_long(php_http_header_class_entry, ZEND_STRL("MATCH_LOOSE"), PHP_HTTP_MATCH_LOOSE);
 422         zend_declare_class_constant_long(php_http_header_class_entry, ZEND_STRL("MATCH_CASE"), PHP_HTTP_MATCH_CASE);
 423         zend_declare_class_constant_long(php_http_header_class_entry, ZEND_STRL("MATCH_WORD"), PHP_HTTP_MATCH_WORD);
 424         zend_declare_class_constant_long(php_http_header_class_entry, ZEND_STRL("MATCH_FULL"), PHP_HTTP_MATCH_FULL);
 425         zend_declare_class_constant_long(php_http_header_class_entry, ZEND_STRL("MATCH_STRICT"), PHP_HTTP_MATCH_STRICT);
 426         zend_declare_property_null(php_http_header_class_entry, ZEND_STRL("name"), ZEND_ACC_PUBLIC);
 427         zend_declare_property_null(php_http_header_class_entry, ZEND_STRL("value"), ZEND_ACC_PUBLIC);
 428
 429         return SUCCESS;
 430 }
 431
 432 /*
 433  * Local variables:
 434  * tab-width: 4
 435  * c-basic-offset: 4
 436  * End:
 437  * vim600: noet sw=4 ts=4 fdm=marker
 438  * vim<600: noet sw=4 ts=4
 439  */
 440