git.m6w6.name Git - m6w6/ext-http/blob - php_http_headers.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-2011, Michael Wallner <mike@php.net>            |
  10     +--------------------------------------------------------------------+
  11 */
  12
  13 #include "php_http_api.h"
  14
  15 PHP_HTTP_API STATUS php_http_headers_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_http_error(HE_WARNING, PHP_HTTP_E_RUNTIME, "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_http_error(HE_WARNING, PHP_HTTP_E_HEADER, "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_http_error(HE_WARNING, PHP_HTTP_E_MALFORMED_HEADERS, "Could not parse headers");
  38                 return FAILURE;
  39         }
  40
  41         return SUCCESS;
  42 }
  43
  44 #define PHP_HTTP_BEGIN_ARGS(method, req_args)   PHP_HTTP_BEGIN_ARGS_EX(HttpHeader, method, 0, req_args)
  45 #define PHP_HTTP_EMPTY_ARGS(method)                             PHP_HTTP_EMPTY_ARGS_EX(HttpHeader, method, 0)
  46 #define PHP_HTTP_HEADER_ME(method, v)                   PHP_ME(HttpHeader, method, PHP_HTTP_ARGS(HttpHeader, method), v)
  47
  48 PHP_HTTP_BEGIN_ARGS(__construct, 0)
  49         PHP_HTTP_ARG_VAL(name, 0)
  50         PHP_HTTP_ARG_VAL(value, 0)
  51 PHP_HTTP_END_ARGS;
  52
  53 PHP_HTTP_EMPTY_ARGS(serialize);
  54 PHP_HTTP_BEGIN_ARGS(unserialize, 1)
  55         PHP_HTTP_ARG_VAL(serialized, 0)
  56 PHP_HTTP_END_ARGS;
  57
  58 PHP_HTTP_BEGIN_ARGS(match, 1)
  59         PHP_HTTP_ARG_VAL(value, 0)
  60         PHP_HTTP_ARG_VAL(flags, 0)
  61 PHP_HTTP_END_ARGS;
  62
  63 PHP_HTTP_BEGIN_ARGS(negotiate, 1)
  64         PHP_HTTP_ARG_VAL(supported, 0)
  65         PHP_HTTP_ARG_VAL(result, 1)
  66 PHP_HTTP_END_ARGS;
  67
  68 PHP_HTTP_BEGIN_ARGS(parse, 1)
  69         PHP_HTTP_ARG_VAL(string, 0)
  70         PHP_HTTP_ARG_VAL(flags, 0)
  71 PHP_HTTP_END_ARGS;
  72
  73 PHP_HTTP_BEGIN_ARGS(getParams, 0)
  74         PHP_HTTP_ARG_VAL(param_sep, 0)
  75         PHP_HTTP_ARG_VAL(arg_sep, 0)
  76         PHP_HTTP_ARG_VAL(val_sep, 0)
  77         PHP_HTTP_ARG_VAL(flags, 0)
  78 PHP_HTTP_END_ARGS;
  79
  80 static zend_class_entry *php_http_header_class_entry;
  81
  82 zend_class_entry *php_http_header_get_class_entry(void)
  83 {
  84         return php_http_header_class_entry;
  85 }
  86
  87 static zend_function_entry php_http_header_method_entry[] = {
  88         PHP_HTTP_HEADER_ME(__construct, ZEND_ACC_PUBLIC|ZEND_ACC_CTOR)
  89         PHP_HTTP_HEADER_ME(serialize, ZEND_ACC_PUBLIC)
  90         ZEND_MALIAS(HttpHeader, __toString, serialize, PHP_HTTP_ARGS(HttpHeader, serialize), ZEND_ACC_PUBLIC)
  91         ZEND_MALIAS(HttpHeader, toString, serialize, PHP_HTTP_ARGS(HttpHeader, serialize), ZEND_ACC_PUBLIC)
  92         PHP_HTTP_HEADER_ME(unserialize, ZEND_ACC_PUBLIC)
  93         PHP_HTTP_HEADER_ME(match, ZEND_ACC_PUBLIC)
  94         PHP_HTTP_HEADER_ME(negotiate, ZEND_ACC_PUBLIC)
  95         PHP_HTTP_HEADER_ME(getParams, ZEND_ACC_PUBLIC)
  96         PHP_HTTP_HEADER_ME(parse, ZEND_ACC_PUBLIC|ZEND_ACC_STATIC)
  97         EMPTY_FUNCTION_ENTRY
  98 };
  99
 100 PHP_METHOD(HttpHeader, __construct)
 101 {
 102         char *name_str = NULL, *value_str = NULL;
 103         int name_len = 0, value_len = 0;
 104
 105         with_error_handling(EH_THROW, php_http_exception_get_class_entry()) {
 106                 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|s!s!", &name_str, &name_len, &value_str, &value_len)) {
 107                         if (name_str && name_len) {
 108                                 char *pretty_str = estrndup(name_str, name_len);
 109                                 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);
 110                                 efree(pretty_str);
 111                         }
 112                         if (value_str && value_len) {
 113                                 zend_update_property_stringl(php_http_header_class_entry, getThis(), ZEND_STRL("value"), value_str, value_len TSRMLS_CC);
 114                         }
 115                 }
 116         } end_error_handling();
 117 }
 118
 119 PHP_METHOD(HttpHeader, serialize)
 120 {
 121         php_http_buffer_t buf;
 122         zval *zname, *zvalue;
 123
 124         php_http_buffer_init(&buf);
 125         zname = php_http_ztyp(IS_STRING, zend_read_property(php_http_header_class_entry, getThis(), ZEND_STRL("name"), 0 TSRMLS_CC));
 126         php_http_buffer_append(&buf, Z_STRVAL_P(zname), Z_STRLEN_P(zname));
 127         zval_ptr_dtor(&zname);
 128         zvalue = php_http_ztyp(IS_STRING, zend_read_property(php_http_header_class_entry, getThis(), ZEND_STRL("value"), 0 TSRMLS_CC));
 129         if (Z_STRLEN_P(zvalue)) {
 130                 php_http_buffer_appends(&buf, ": ");
 131                 php_http_buffer_append(&buf, Z_STRVAL_P(zvalue), Z_STRLEN_P(zvalue));
 132         } else {
 133                 php_http_buffer_appends(&buf, ":");
 134         }
 135         zval_ptr_dtor(&zvalue);
 136
 137         RETURN_PHP_HTTP_BUFFER_VAL(&buf);
 138 }
 139
 140 PHP_METHOD(HttpHeader, unserialize)
 141 {
 142         char *serialized_str;
 143         int serialized_len;
 144
 145         if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &serialized_str, &serialized_len)) {
 146                 HashTable ht;
 147
 148                 zend_hash_init(&ht, 1, NULL, ZVAL_PTR_DTOR, 0);
 149                 if (SUCCESS == php_http_headers_parse(serialized_str, serialized_len, &ht, NULL, NULL TSRMLS_CC)) {
 150                         if (zend_hash_num_elements(&ht)) {
 151                                 zval **val, *cpy;
 152                                 char *str;
 153                                 uint len;
 154                                 ulong idx;
 155
 156                                 zend_hash_internal_pointer_reset(&ht);
 157                                 switch (zend_hash_get_current_key_ex(&ht, &str, &len, &idx, 0, NULL)) {
 158                                         case HASH_KEY_IS_STRING:
 159                                                 zend_update_property_stringl(php_http_header_class_entry, getThis(), ZEND_STRL("name"), str, len - 1 TSRMLS_CC);
 160                                                 break;
 161                                         case HASH_KEY_IS_LONG:
 162                                                 zend_update_property_long(php_http_header_class_entry, getThis(), ZEND_STRL("name"), idx TSRMLS_CC);
 163                                                 break;
 164                                         default:
 165                                                 break;
 166                                 }
 167                                 zend_hash_get_current_data(&ht, (void *) &val);
 168                                 cpy = php_http_zsep(1, IS_STRING, *val);
 169                                 zend_update_property(php_http_header_class_entry, getThis(), ZEND_STRL("value"), cpy TSRMLS_CC);
 170                                 zval_ptr_dtor(&cpy);
 171                         }
 172                 }
 173                 zend_hash_destroy(&ht);
 174         }
 175
 176 }
 177
 178 PHP_METHOD(HttpHeader, match)
 179 {
 180         char *val_str;
 181         int val_len;
 182         long flags = 0;
 183         zval *zvalue;
 184
 185         if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|sl", &val_str, &val_len, &flags)) {
 186                 RETURN_NULL();
 187         }
 188
 189         zvalue = php_http_ztyp(IS_STRING, zend_read_property(php_http_header_class_entry, getThis(), ZEND_STRL("value"), 0 TSRMLS_CC));
 190         RETVAL_BOOL(php_http_match(Z_STRVAL_P(zvalue), val_str, flags));
 191         zval_ptr_dtor(&zvalue);
 192 }
 193
 194 PHP_METHOD(HttpHeader, negotiate)
 195 {
 196         HashTable *supported, *rs;
 197         zval *zname, *zvalue, *rs_array = NULL;
 198         char *sep_str = NULL;
 199         size_t sep_len = 0;
 200
 201         if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "H|z", &supported, &rs_array)) {
 202                 if (rs_array) {
 203                         zval_dtor(rs_array);
 204                         array_init(rs_array);
 205                 }
 206
 207                 zname = php_http_ztyp(IS_STRING, zend_read_property(php_http_header_class_entry, getThis(), ZEND_STRL("name"), 0 TSRMLS_CC));
 208                 if (!strcasecmp(Z_STRVAL_P(zname), "Accept")) {
 209                         sep_str = "/";
 210                         sep_len = 1;
 211                 } else if (!strcasecmp(Z_STRVAL_P(zname), "Accept-Language")) {
 212                         sep_str = "-";
 213                         sep_len = 1;
 214                 }
 215                 zval_ptr_dtor(&zname);
 216
 217                 zvalue = php_http_ztyp(IS_STRING, zend_read_property(php_http_header_class_entry, getThis(), ZEND_STRL("value"), 0 TSRMLS_CC));
 218                 if ((rs = php_http_negotiate(Z_STRVAL_P(zvalue), Z_STRLEN_P(zvalue), supported, sep_str, sep_len TSRMLS_CC))) {
 219                         PHP_HTTP_DO_NEGOTIATE_HANDLE_RESULT(rs, supported, rs_array);
 220                 } else {
 221                         PHP_HTTP_DO_NEGOTIATE_HANDLE_DEFAULT(supported, rs_array);
 222                 }
 223                 zval_ptr_dtor(&zvalue);
 224         } else {
 225                 RETURN_FALSE;
 226         }
 227 }
 228
 229 PHP_METHOD(HttpHeader, getParams)
 230 {
 231         zval zctor, *zparams_obj, **zargs = NULL;
 232
 233         INIT_PZVAL(&zctor);
 234         ZVAL_STRINGL(&zctor, "__construct", lenof("__construct"), 0);
 235
 236         MAKE_STD_ZVAL(zparams_obj);
 237         object_init_ex(zparams_obj, php_http_params_get_class_entry());
 238
 239         zargs = (zval **) ecalloc(ZEND_NUM_ARGS()+1, sizeof(zval *));
 240         zargs[0] = zend_read_property(Z_OBJCE_P(getThis()), getThis(), ZEND_STRL("value"), 0 TSRMLS_CC);
 241         if (ZEND_NUM_ARGS()) {
 242                 zend_get_parameters_array(ZEND_NUM_ARGS(), ZEND_NUM_ARGS(), &zargs[1]);
 243         }
 244
 245         if (SUCCESS == call_user_function(NULL, &zparams_obj, &zctor, return_value, ZEND_NUM_ARGS()+1, zargs TSRMLS_CC)) {
 246                 RETVAL_ZVAL(zparams_obj, 0, 1);
 247         }
 248
 249         if (zargs) {
 250                 efree(zargs);
 251         }
 252 }
 253
 254 PHP_METHOD(HttpHeader, parse)
 255 {
 256         char *header_str;
 257         int header_len;
 258         zend_class_entry *ce = NULL;
 259
 260         if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|C", &header_str, &header_len, &ce)) {
 261                 array_init(return_value);
 262
 263                 if (SUCCESS != php_http_headers_parse(header_str, header_len, Z_ARRVAL_P(return_value), NULL, NULL TSRMLS_CC)) {
 264                         php_http_error(HE_WARNING, PHP_HTTP_E_MALFORMED_HEADERS, "Could not parse headers");
 265                         zval_dtor(return_value);
 266                         RETVAL_NULL();
 267                 } else {
 268                         if (ce && instanceof_function(ce, php_http_header_class_entry TSRMLS_CC)) {
 269                                 HashPosition pos;
 270                                 php_http_array_hashkey_t key = php_http_array_hashkey_init(0);
 271                                 zval **val;
 272
 273                                 FOREACH_KEYVAL(pos, return_value, key, val) {
 274                                         zval *zho, *zkey, *zvalue;
 275
 276                                         Z_ADDREF_PP(val);
 277                                         zvalue = *val;
 278
 279                                         MAKE_STD_ZVAL(zkey);
 280                                         if (key.type == HASH_KEY_IS_LONG) {
 281                                                 ZVAL_LONG(zkey, key.num);
 282                                         } else {
 283                                                 ZVAL_STRINGL(zkey, key.str, key.len - 1, 1);
 284                                         }
 285
 286                                         MAKE_STD_ZVAL(zho);
 287                                         object_init_ex(zho, ce);
 288                                         zend_call_method_with_2_params(&zho, ce, NULL, "__construct", NULL, zkey, zvalue);
 289
 290                                         if (key.type == HASH_KEY_IS_LONG) {
 291                                                 zend_hash_index_update(Z_ARRVAL_P(return_value), key.num, (void *) &zho, sizeof(zval *), NULL);
 292                                         } else {
 293                                                 zend_hash_update(Z_ARRVAL_P(return_value), key.str, key.len, (void *) &zho, sizeof(zval *), NULL);
 294                                         }
 295
 296                                         zval_ptr_dtor(&zvalue);
 297                                         zval_ptr_dtor(&zkey);
 298                                 }
 299                         }
 300                 }
 301         }
 302 }
 303
 304 PHP_MINIT_FUNCTION(http_header)
 305 {
 306         PHP_HTTP_REGISTER_CLASS(http, Header, http_header, php_http_object_get_class_entry(), 0);
 307         zend_class_implements(php_http_header_class_entry TSRMLS_CC, 1, zend_ce_serializable);
 308         zend_declare_class_constant_long(php_http_header_class_entry, ZEND_STRL("MATCH_LOOSE"), PHP_HTTP_MATCH_LOOSE TSRMLS_CC);
 309         zend_declare_class_constant_long(php_http_header_class_entry, ZEND_STRL("MATCH_CASE"), PHP_HTTP_MATCH_CASE TSRMLS_CC);
 310         zend_declare_class_constant_long(php_http_header_class_entry, ZEND_STRL("MATCH_WORD"), PHP_HTTP_MATCH_WORD TSRMLS_CC);
 311         zend_declare_class_constant_long(php_http_header_class_entry, ZEND_STRL("MATCH_FULL"), PHP_HTTP_MATCH_FULL TSRMLS_CC);
 312         zend_declare_class_constant_long(php_http_header_class_entry, ZEND_STRL("MATCH_STRICT"), PHP_HTTP_MATCH_STRICT TSRMLS_CC);
 313         zend_declare_property_null(php_http_header_class_entry, ZEND_STRL("name"), ZEND_ACC_PUBLIC TSRMLS_CC);
 314         zend_declare_property_null(php_http_header_class_entry, ZEND_STRL("value"), ZEND_ACC_PUBLIC TSRMLS_CC);
 315
 316         return SUCCESS;
 317 }
 318
 319 /*
 320  * Local variables:
 321  * tab-width: 4
 322  * c-basic-offset: 4
 323  * End:
 324  * vim600: noet sw=4 ts=4 fdm=marker
 325  * vim<600: noet sw=4 ts=4
 326  */
 327