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