git.m6w6.name Git - m6w6/ext-http/blob - http_message_object.c

   1 /*
   2    +----------------------------------------------------------------------+
   3    | PECL :: http                                                         |
   4    +----------------------------------------------------------------------+
   5    | This source file is subject to version 3.0 of the PHP license, that  |
   6    | is bundled with this package in the file LICENSE, and is available   |
   7    | through the world-wide-web at http://www.php.net/license/3_0.txt.    |
   8    | If you did not receive a copy of the PHP license and are unable to   |
   9    | obtain it through the world-wide-web, please send a note to          |
  10    | license@php.net so we can mail you a copy immediately.               |
  11    +----------------------------------------------------------------------+
  12    | Copyright (c) 2004-2005 Michael Wallner <mike@php.net>               |
  13    +----------------------------------------------------------------------+
  14 */
  15
  16 /* $Id$ */
  17
  18
  19 #ifdef HAVE_CONFIG_H
  20 #       include "config.h"
  21 #endif
  22 #include "php.h"
  23
  24 #ifdef ZEND_ENGINE_2
  25
  26 #include "php_http.h"
  27 #include "php_http_std_defs.h"
  28 #include "php_http_message_object.h"
  29
  30 #include "phpstr/phpstr.h"
  31
  32 #define HTTP_BEGIN_ARGS(method, req_args)               HTTP_BEGIN_ARGS_EX(HttpMessage, method, ZEND_RETURN_REFERENCE_AGNOSTIC, req_args)
  33 #define HTTP_EMPTY_ARGS(method, ret_ref)                HTTP_EMPTY_ARGS_EX(HttpMessage, method, ret_ref)
  34 #define HTTP_MESSAGE_ME(method, visibility)             PHP_ME(HttpMessage, method, HTTP_ARGS(HttpMessage, method), visibility)
  35
  36 HTTP_BEGIN_ARGS(__construct, 0)
  37         HTTP_ARG_VAL(message, 0)
  38 HTTP_END_ARGS;
  39
  40 HTTP_BEGIN_ARGS(fromString, 1)
  41         HTTP_ARG_VAL(message, 0)
  42 HTTP_END_ARGS;
  43
  44 HTTP_EMPTY_ARGS(getBody, 0);
  45 HTTP_EMPTY_ARGS(getHeaders, 0);
  46 HTTP_BEGIN_ARGS(setHeaders, 1)
  47         HTTP_ARG_VAL(headers, 0)
  48 HTTP_END_ARGS;
  49
  50 HTTP_BEGIN_ARGS(addHeaders, 1)
  51         HTTP_ARG_VAL(headers, 0)
  52         HTTP_ARG_VAL(append, 0)
  53 HTTP_END_ARGS;
  54
  55 HTTP_EMPTY_ARGS(getType, 0);
  56 HTTP_BEGIN_ARGS(setType, 1)
  57         HTTP_ARG_VAL(type, 0)
  58 HTTP_END_ARGS;
  59
  60 HTTP_EMPTY_ARGS(getResponseCode, 0);
  61 HTTP_BEGIN_ARGS(setResponseCode, 1)
  62         HTTP_ARG_VAL(response_code, 0)
  63 HTTP_END_ARGS;
  64
  65 HTTP_EMPTY_ARGS(getRequestMethod, 0);
  66 HTTP_BEGIN_ARGS(setRequestMethod, 1)
  67         HTTP_ARG_VAL(request_method, 0)
  68 HTTP_END_ARGS;
  69
  70 HTTP_EMPTY_ARGS(getRequestUri, 0);
  71 HTTP_BEGIN_ARGS(setRequestUri, 1)
  72         HTTP_ARG_VAL(uri, 0)
  73 HTTP_END_ARGS;
  74
  75 HTTP_EMPTY_ARGS(getHttpVersion, 0);
  76 HTTP_BEGIN_ARGS(setHttpVersion, 1)
  77         HTTP_ARG_VAL(http_version, 0)
  78 HTTP_END_ARGS;
  79
  80 HTTP_EMPTY_ARGS(getParentMessage, 1);
  81 HTTP_EMPTY_ARGS(send, 0);
  82 HTTP_BEGIN_ARGS(toString, 0)
  83         HTTP_ARG_VAL(include_parent, 0)
  84 HTTP_END_ARGS;
  85
  86 #define http_message_object_declare_default_properties() _http_message_object_declare_default_properties(TSRMLS_C)
  87 static inline void _http_message_object_declare_default_properties(TSRMLS_D);
  88 #define http_message_object_read_prop _http_message_object_read_prop
  89 static zval *_http_message_object_read_prop(zval *object, zval *member, int type TSRMLS_DC);
  90 #define http_message_object_write_prop _http_message_object_write_prop
  91 static void _http_message_object_write_prop(zval *object, zval *member, zval *value TSRMLS_DC);
  92 #define http_message_object_get_props _http_message_object_get_props
  93 static HashTable *_http_message_object_get_props(zval *object TSRMLS_DC);
  94 #define http_message_object_clone_obj _http_message_object_clone_obj
  95 static inline zend_object_value _http_message_object_clone_obj(zval *object TSRMLS_DC);
  96
  97 zend_class_entry *http_message_object_ce;
  98 zend_function_entry http_message_object_fe[] = {
  99         HTTP_MESSAGE_ME(__construct, ZEND_ACC_PUBLIC|ZEND_ACC_CTOR)
 100         HTTP_MESSAGE_ME(getBody, ZEND_ACC_PUBLIC)
 101         HTTP_MESSAGE_ME(getHeaders, ZEND_ACC_PUBLIC)
 102         HTTP_MESSAGE_ME(setHeaders, ZEND_ACC_PUBLIC)
 103         HTTP_MESSAGE_ME(addHeaders, ZEND_ACC_PUBLIC)
 104         HTTP_MESSAGE_ME(getType, ZEND_ACC_PUBLIC)
 105         HTTP_MESSAGE_ME(setType, ZEND_ACC_PUBLIC)
 106         HTTP_MESSAGE_ME(getResponseCode, ZEND_ACC_PUBLIC)
 107         HTTP_MESSAGE_ME(setResponseCode, ZEND_ACC_PUBLIC)
 108         HTTP_MESSAGE_ME(getRequestMethod, ZEND_ACC_PUBLIC)
 109         HTTP_MESSAGE_ME(setRequestMethod, ZEND_ACC_PUBLIC)
 110         HTTP_MESSAGE_ME(getRequestUri, ZEND_ACC_PUBLIC)
 111         HTTP_MESSAGE_ME(setRequestUri, ZEND_ACC_PUBLIC)
 112         HTTP_MESSAGE_ME(getHttpVersion, ZEND_ACC_PUBLIC)
 113         HTTP_MESSAGE_ME(setHttpVersion, ZEND_ACC_PUBLIC)
 114         HTTP_MESSAGE_ME(getParentMessage, ZEND_ACC_PUBLIC)
 115         HTTP_MESSAGE_ME(send, ZEND_ACC_PUBLIC)
 116         HTTP_MESSAGE_ME(toString, ZEND_ACC_PUBLIC)
 117
 118         ZEND_MALIAS(HttpMessage, __toString, toString, HTTP_ARGS(HttpMessage, toString), ZEND_ACC_PUBLIC)
 119
 120         HTTP_MESSAGE_ME(fromString, ZEND_ACC_PUBLIC|ZEND_ACC_STATIC)
 121         {NULL, NULL, NULL}
 122 };
 123 static zend_object_handlers http_message_object_handlers;
 124
 125 void _http_message_object_init(INIT_FUNC_ARGS)
 126 {
 127         HTTP_REGISTER_CLASS_EX(HttpMessage, http_message_object, NULL, 0);
 128
 129         HTTP_LONG_CONSTANT("HTTP_MSG_NONE", HTTP_MSG_NONE);
 130         HTTP_LONG_CONSTANT("HTTP_MSG_REQUEST", HTTP_MSG_REQUEST);
 131         HTTP_LONG_CONSTANT("HTTP_MSG_RESPONSE", HTTP_MSG_RESPONSE);
 132
 133         http_message_object_handlers.clone_obj = http_message_object_clone_obj;
 134         http_message_object_handlers.read_property = http_message_object_read_prop;
 135         http_message_object_handlers.write_property = http_message_object_write_prop;
 136         http_message_object_handlers.get_properties = http_message_object_get_props;
 137 }
 138
 139 zend_object_value _http_message_object_new(zend_class_entry *ce TSRMLS_DC)
 140 {
 141         return http_message_object_new_ex(ce, NULL);
 142 }
 143
 144 zend_object_value _http_message_object_new_ex(zend_class_entry *ce, http_message *msg TSRMLS_DC)
 145 {
 146         zend_object_value ov;
 147         http_message_object *o;
 148
 149         o = ecalloc(1, sizeof(http_message_object));
 150         o->zo.ce = ce;
 151         o->message = NULL;
 152         o->parent.handle = 0;
 153         o->parent.handlers = NULL;
 154
 155         if (msg) {
 156                 o->message = msg;
 157                 if (msg->parent) {
 158                         o->parent = http_message_object_from_msg(msg->parent);
 159                 }
 160         }
 161
 162         ALLOC_HASHTABLE(OBJ_PROP(o));
 163         zend_hash_init(OBJ_PROP(o), 0, NULL, ZVAL_PTR_DTOR, 0);
 164
 165         ov.handle = zend_objects_store_put(o, (zend_objects_store_dtor_t) zend_objects_destroy_object, http_message_object_free, NULL TSRMLS_CC);
 166         ov.handlers = &http_message_object_handlers;
 167
 168         return ov;
 169 }
 170
 171 zend_object_value _http_message_object_clone(zval *this_ptr TSRMLS_DC)
 172 {
 173         return http_message_object_clone_obj(this_ptr TSRMLS_CC);
 174 }
 175
 176 static inline void _http_message_object_declare_default_properties(TSRMLS_D)
 177 {
 178         zend_class_entry *ce = http_message_object_ce;
 179
 180         DCL_PROP(PROTECTED, long, type, HTTP_MSG_NONE);
 181         DCL_PROP(PROTECTED, string, body, "");
 182         DCL_PROP(PROTECTED, string, requestMethod, "");
 183         DCL_PROP(PROTECTED, string, requestUri, "");
 184         DCL_PROP(PROTECTED, long, responseCode, 0);
 185         DCL_PROP_N(PROTECTED, httpVersion);
 186         DCL_PROP_N(PROTECTED, headers);
 187         DCL_PROP_N(PROTECTED, parentMessage);
 188 }
 189
 190 void _http_message_object_free(zend_object *object TSRMLS_DC)
 191 {
 192         http_message_object *o = (http_message_object *) object;
 193
 194         if (OBJ_PROP(o)) {
 195                 zend_hash_destroy(OBJ_PROP(o));
 196                 FREE_HASHTABLE(OBJ_PROP(o));
 197         }
 198         if (o->message) {
 199                 http_message_dtor(o->message);
 200                 efree(o->message);
 201         }
 202         efree(o);
 203 }
 204
 205 static inline zend_object_value _http_message_object_clone_obj(zval *this_ptr TSRMLS_DC)
 206 {
 207         getObject(http_message_object, obj);
 208         return http_message_object_from_msg(http_message_dup(obj->message));
 209 }
 210
 211 static zval *_http_message_object_read_prop(zval *object, zval *member, int type TSRMLS_DC)
 212 {
 213         getObjectEx(http_message_object, obj, object);
 214         http_message *msg = obj->message;
 215         zval *return_value;
 216
 217         /* tmp var */
 218         ALLOC_ZVAL(return_value);
 219         return_value->refcount = 0;
 220
 221         if (!EG(scope) || !instanceof_function(EG(scope), obj->zo.ce TSRMLS_CC)) {
 222                 zend_error(E_WARNING, "Cannot access protected property %s::$%s", obj->zo.ce->name, Z_STRVAL_P(member));
 223                 return EG(uninitialized_zval_ptr);
 224         }
 225
 226         switch (zend_get_hash_value(Z_STRVAL_P(member), Z_STRLEN_P(member) + 1))
 227         {
 228                 case HTTP_MSG_PROPHASH_TYPE:
 229                         RETVAL_LONG(msg->type);
 230                 break;
 231
 232                 case HTTP_MSG_PROPHASH_HTTP_VERSION:
 233                         switch (msg->type)
 234                         {
 235                                 case HTTP_MSG_REQUEST:
 236                                         RETVAL_DOUBLE(msg->info.request.http_version);
 237                                 break;
 238
 239                                 case HTTP_MSG_RESPONSE:
 240                                         RETVAL_DOUBLE(msg->info.response.http_version);
 241                                 break;
 242
 243                                 case HTTP_MSG_NONE:
 244                                 default:
 245                                         RETVAL_NULL();
 246                                 break;
 247                         }
 248                 break;
 249
 250                 case HTTP_MSG_PROPHASH_BODY:
 251                         phpstr_fix(PHPSTR(msg));
 252                         RETVAL_PHPSTR(PHPSTR(msg), 0, 1);
 253                 break;
 254
 255                 case HTTP_MSG_PROPHASH_HEADERS:
 256                         array_init(return_value);
 257                         zend_hash_copy(Z_ARRVAL_P(return_value), &msg->hdrs, (copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval *));
 258                 break;
 259
 260                 case HTTP_MSG_PROPHASH_PARENT_MESSAGE:
 261                         if (msg->parent) {
 262                                 RETVAL_OBJVAL(obj->parent);
 263                                 Z_TYPE_P(return_value)  = IS_OBJECT;
 264                                 return_value->value.obj = obj->parent;
 265                                 zend_objects_store_add_ref(return_value TSRMLS_CC);
 266                         } else {
 267                                 RETVAL_NULL();
 268                         }
 269                 break;
 270
 271                 case HTTP_MSG_PROPHASH_REQUEST_METHOD:
 272                         if (HTTP_MSG_TYPE(REQUEST, msg) && msg->info.request.method) {
 273                                 RETVAL_STRING(msg->info.request.method, 1);
 274                         } else {
 275                                 RETVAL_NULL();
 276                         }
 277                 break;
 278
 279                 case HTTP_MSG_PROPHASH_REQUEST_URI:
 280                         if (HTTP_MSG_TYPE(REQUEST, msg) && msg->info.request.URI) {
 281                                 RETVAL_STRING(msg->info.request.URI, 1);
 282                         } else {
 283                                 RETVAL_NULL();
 284                         }
 285                 break;
 286
 287                 case HTTP_MSG_PROPHASH_RESPONSE_CODE:
 288                         if (HTTP_MSG_TYPE(RESPONSE, msg)) {
 289                                 RETVAL_LONG(msg->info.response.code);
 290                         } else {
 291                                 RETVAL_NULL();
 292                         }
 293                 break;
 294
 295                 default:
 296                         RETVAL_NULL();
 297                 break;
 298         }
 299
 300         return return_value;
 301 }
 302
 303 static void _http_message_object_write_prop(zval *object, zval *member, zval *value TSRMLS_DC)
 304 {
 305         getObjectEx(http_message_object, obj, object);
 306         http_message *msg = obj->message;
 307
 308         if (!EG(scope) || !instanceof_function(EG(scope), obj->zo.ce TSRMLS_CC)) {
 309                 zend_error(E_WARNING, "Cannot access protected property %s::$%s", obj->zo.ce->name, Z_STRVAL_P(member));
 310         }
 311
 312         switch (zend_get_hash_value(Z_STRVAL_P(member), Z_STRLEN_P(member) + 1))
 313         {
 314                 case HTTP_MSG_PROPHASH_TYPE:
 315                         convert_to_long_ex(&value);
 316                         if (Z_LVAL_P(value) != msg->type) {
 317                                 if (HTTP_MSG_TYPE(REQUEST, msg)) {
 318                                         if (msg->info.request.method) {
 319                                                 efree(msg->info.request.method);
 320                                         }
 321                                         if (msg->info.request.URI) {
 322                                                 efree(msg->info.request.URI);
 323                                         }
 324                                 }
 325                                 msg->type = Z_LVAL_P(value);
 326                                 if (HTTP_MSG_TYPE(REQUEST, msg)) {
 327                                         msg->info.request.method = NULL;
 328                                         msg->info.request.URI = NULL;
 329                                 }
 330                         }
 331
 332                 break;
 333
 334                 case HTTP_MSG_PROPHASH_HTTP_VERSION:
 335                         convert_to_double_ex(&value);
 336                         switch (msg->type)
 337                         {
 338                                 case HTTP_MSG_REQUEST:
 339                                         msg->info.request.http_version = Z_DVAL_P(value);
 340                                 break;
 341
 342                                 case HTTP_MSG_RESPONSE:
 343                                         msg->info.response.http_version = Z_DVAL_P(value);
 344                                 break;
 345                         }
 346                 break;
 347
 348                 case HTTP_MSG_PROPHASH_BODY:
 349                         convert_to_string_ex(&value);
 350                         phpstr_dtor(PHPSTR(msg));
 351                         phpstr_from_string_ex(PHPSTR(msg), Z_STRVAL_P(value), Z_STRLEN_P(value));
 352                 break;
 353
 354                 case HTTP_MSG_PROPHASH_HEADERS:
 355                         convert_to_array_ex(&value);
 356                         zend_hash_clean(&msg->hdrs);
 357                         zend_hash_copy(&msg->hdrs, Z_ARRVAL_P(value), (copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval *));
 358                 break;
 359
 360                 case HTTP_MSG_PROPHASH_PARENT_MESSAGE:
 361                         if (msg->parent) {
 362                                 zval tmp;
 363                                 tmp.value.obj = obj->parent;
 364                                 zend_objects_store_del_ref(&tmp TSRMLS_CC);
 365                         }
 366                         zend_objects_store_add_ref(value TSRMLS_CC);
 367                         obj->parent = value->value.obj;
 368                 break;
 369
 370                 case HTTP_MSG_PROPHASH_REQUEST_METHOD:
 371                         convert_to_string_ex(&value);
 372                         if (HTTP_MSG_TYPE(REQUEST, msg)) {
 373                                 if (msg->info.request.method) {
 374                                         efree(msg->info.request.method);
 375                                 }
 376                                 msg->info.request.method = estrndup(Z_STRVAL_P(value), Z_STRLEN_P(value));
 377                         }
 378                 break;
 379
 380                 case HTTP_MSG_PROPHASH_REQUEST_URI:
 381                         convert_to_string_ex(&value);
 382                         if (HTTP_MSG_TYPE(REQUEST, msg)) {
 383                                 if (msg->info.request.URI) {
 384                                         efree(msg->info.request.URI);
 385                                 }
 386                                 msg->info.request.URI = estrndup(Z_STRVAL_P(value), Z_STRLEN_P(value));
 387                         }
 388                 break;
 389
 390                 case HTTP_MSG_PROPHASH_RESPONSE_CODE:
 391                         convert_to_long_ex(&value);
 392                         if (HTTP_MSG_TYPE(RESPONSE, msg)) {
 393                                 msg->info.response.code = Z_LVAL_P(value);
 394                         }
 395                 break;
 396         }
 397 }
 398
 399 static HashTable *_http_message_object_get_props(zval *object TSRMLS_DC)
 400 {
 401         zval *headers;
 402         getObjectEx(http_message_object, obj, object);
 403         http_message *msg = obj->message;
 404
 405 #define ASSOC_PROP(obj, ptype, name, val) \
 406         { \
 407                 zval array; \
 408                 char *m_prop_name; \
 409                 int m_prop_len; \
 410                 Z_ARRVAL(array) = OBJ_PROP(obj); \
 411                 zend_mangle_property_name(&m_prop_name, &m_prop_len, "*", 1, name, lenof(name), 1); \
 412                 add_assoc_ ##ptype## _ex(&array, m_prop_name, sizeof(name)+4, val); \
 413         }
 414 #define ASSOC_STRING(obj, name, val) ASSOC_STRINGL(obj, name, val, strlen(val))
 415 #define ASSOC_STRINGL(obj, name, val, len) \
 416         { \
 417                 zval array; \
 418                 char *m_prop_name; \
 419                 int m_prop_len; \
 420                 Z_ARRVAL(array) = OBJ_PROP(obj); \
 421                 zend_mangle_property_name(&m_prop_name, &m_prop_len, "*", 1, name, lenof(name), 1); \
 422                 add_assoc_stringl_ex(&array, m_prop_name, sizeof(name)+4, val, len, 1); \
 423         }
 424
 425         zend_hash_clean(OBJ_PROP(obj));
 426
 427         ASSOC_PROP(obj, long, "type", msg->type);
 428         ASSOC_STRINGL(obj, "body", PHPSTR_VAL(msg), PHPSTR_LEN(msg));
 429
 430         MAKE_STD_ZVAL(headers);
 431         array_init(headers);
 432
 433         zend_hash_copy(Z_ARRVAL_P(headers), &msg->hdrs, (copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval *));
 434         ASSOC_PROP(obj, zval, "headers", headers);
 435
 436         switch (msg->type)
 437         {
 438                 case HTTP_MSG_REQUEST:
 439                         ASSOC_PROP(obj, double, "httpVersion", msg->info.request.http_version);
 440                         ASSOC_PROP(obj, long, "responseCode", 0);
 441                         ASSOC_STRING(obj, "requestMethod", msg->info.request.method);
 442                         ASSOC_STRING(obj, "requestUri", msg->info.request.URI);
 443                 break;
 444
 445                 case HTTP_MSG_RESPONSE:
 446                         ASSOC_PROP(obj, double, "httpVersion", msg->info.response.http_version);
 447                         ASSOC_PROP(obj, long, "responseCode", msg->info.response.code);
 448                         ASSOC_STRING(obj, "requestMethod", "");
 449                         ASSOC_STRING(obj, "requestUri", "");
 450                 break;
 451
 452                 case HTTP_MSG_NONE:
 453                 default:
 454                         ASSOC_PROP(obj, double, "httpVersion", 0.0);
 455                         ASSOC_PROP(obj, long, "responseCode", 0);
 456                         ASSOC_STRING(obj, "requestMethod", "");
 457                         ASSOC_STRING(obj, "requestUri", "");
 458                 break;
 459         }
 460
 461         return OBJ_PROP(obj);
 462 }
 463
 464 #endif /* ZEND_ENGINE_2 */
 465
 466 /*
 467  * Local variables:
 468  * tab-width: 4
 469  * c-basic-offset: 4
 470  * End:
 471  * vim600: noet sw=4 ts=4 fdm=marker
 472  * vim<600: noet sw=4 ts=4
 473  */
 474