git.m6w6.name Git - m6w6/ext-http/blob - http_request_method_api.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-2006, Michael Wallner <mike@php.net>            |
  10     +--------------------------------------------------------------------+
  11 */
  12
  13 /* $Id$ */
  14
  15 #define HTTP_WANT_CURL
  16 #include "php_http.h"
  17
  18 #include "php_http_api.h"
  19 #include "php_http_request_api.h"
  20 #include "php_http_request_method_api.h"
  21
  22 #if defined(ZEND_ENGINE_2) && defined(HTTP_HAVE_CURL) && !defined(WONKY)
  23 #       include "php_http_request_object.h"
  24 #endif
  25
  26 /* {{{ char *http_request_methods[] */
  27 static const char *const http_request_methods[] = {
  28         "UNKNOWN",
  29         /* HTTP/1.1 */
  30         "GET",
  31         "HEAD",
  32         "POST",
  33         "PUT",
  34         "DELETE",
  35         "OPTIONS",
  36         "TRACE",
  37         "CONNECT",
  38         /* WebDAV - RFC 2518 */
  39         "PROPFIND",
  40         "PROPPATCH",
  41         "MKCOL",
  42         "COPY",
  43         "MOVE",
  44         "LOCK",
  45         "UNLOCK",
  46         /* WebDAV Versioning - RFC 3253 */
  47         "VERSION-CONTROL",
  48         "REPORT",
  49         "CHECKOUT",
  50         "CHECKIN",
  51         "UNCHECKOUT",
  52         "MKWORKSPACE",
  53         "UPDATE",
  54         "LABEL",
  55         "MERGE",
  56         "BASELINE-CONTROL",
  57         "MKACTIVITY",
  58         /* WebDAV Access Control - RFC 3744 */
  59         "ACL",
  60         NULL
  61 };
  62 /* }}} */
  63
  64 /* {{{ */
  65 PHP_MINIT_FUNCTION(http_request_method)
  66 {
  67         /* HTTP/1.1 */
  68         HTTP_LONG_CONSTANT("HTTP_METH_GET", HTTP_GET);
  69         HTTP_LONG_CONSTANT("HTTP_METH_HEAD", HTTP_HEAD);
  70         HTTP_LONG_CONSTANT("HTTP_METH_POST", HTTP_POST);
  71         HTTP_LONG_CONSTANT("HTTP_METH_PUT", HTTP_PUT);
  72         HTTP_LONG_CONSTANT("HTTP_METH_DELETE", HTTP_DELETE);
  73         HTTP_LONG_CONSTANT("HTTP_METH_OPTIONS", HTTP_OPTIONS);
  74         HTTP_LONG_CONSTANT("HTTP_METH_TRACE", HTTP_TRACE);
  75         HTTP_LONG_CONSTANT("HTTP_METH_CONNECT", HTTP_CONNECT);
  76         /* WebDAV - RFC 2518 */
  77         HTTP_LONG_CONSTANT("HTTP_METH_PROPFIND", HTTP_PROPFIND);
  78         HTTP_LONG_CONSTANT("HTTP_METH_PROPPATCH", HTTP_PROPPATCH);
  79         HTTP_LONG_CONSTANT("HTTP_METH_MKCOL", HTTP_MKCOL);
  80         HTTP_LONG_CONSTANT("HTTP_METH_COPY", HTTP_COPY);
  81         HTTP_LONG_CONSTANT("HTTP_METH_MOVE", HTTP_MOVE);
  82         HTTP_LONG_CONSTANT("HTTP_METH_LOCK", HTTP_LOCK);
  83         HTTP_LONG_CONSTANT("HTTP_METH_UNLOCK", HTTP_UNLOCK);
  84         /* WebDAV Versioning - RFC 3253 */
  85         HTTP_LONG_CONSTANT("HTTP_METH_VERSION_CONTROL", HTTP_VERSION_CONTROL);
  86         HTTP_LONG_CONSTANT("HTTP_METH_REPORT", HTTP_REPORT);
  87         HTTP_LONG_CONSTANT("HTTP_METH_CHECKOUT", HTTP_CHECKOUT);
  88         HTTP_LONG_CONSTANT("HTTP_METH_CHECKIN", HTTP_CHECKIN);
  89         HTTP_LONG_CONSTANT("HTTP_METH_UNCHECKOUT", HTTP_UNCHECKOUT);
  90         HTTP_LONG_CONSTANT("HTTP_METH_MKWORKSPACE", HTTP_MKWORKSPACE);
  91         HTTP_LONG_CONSTANT("HTTP_METH_UPDATE", HTTP_UPDATE);
  92         HTTP_LONG_CONSTANT("HTTP_METH_LABEL", HTTP_LABEL);
  93         HTTP_LONG_CONSTANT("HTTP_METH_MERGE", HTTP_MERGE);
  94         HTTP_LONG_CONSTANT("HTTP_METH_BASELINE_CONTROL", HTTP_BASELINE_CONTROL);
  95         HTTP_LONG_CONSTANT("HTTP_METH_MKACTIVITY", HTTP_MKACTIVITY);
  96         /* WebDAV Access Control - RFC 3744 */
  97         HTTP_LONG_CONSTANT("HTTP_METH_ACL", HTTP_ACL);
  98
  99         return SUCCESS;
 100 }
 101
 102 PHP_RINIT_FUNCTION(http_request_method)
 103 {
 104         HTTP_G->request.methods.custom.entries = ecalloc(1, sizeof(http_request_method_entry *));
 105
 106         if (HTTP_G->request.methods.custom.ini && *HTTP_G->request.methods.custom.ini) {
 107                 HashPosition pos;
 108                 HashTable methods;
 109                 zval **data;
 110
 111                 zend_hash_init(&methods, 0, NULL, ZVAL_PTR_DTOR, 0);
 112                 http_parse_params(HTTP_G->request.methods.custom.ini, HTTP_PARAMS_DEFAULT, &methods);
 113                 FOREACH_HASH_VAL(pos, &methods, data) {
 114                         if (Z_TYPE_PP(data) == IS_STRING) {
 115                                 http_request_method_register(Z_STRVAL_PP(data), Z_STRLEN_PP(data));
 116                         }
 117                 }
 118                 zend_hash_destroy(&methods);
 119         }
 120         return SUCCESS;
 121 }
 122
 123 PHP_RSHUTDOWN_FUNCTION(http_request_method)
 124 {
 125         int i;
 126         http_request_method_entry **ptr = HTTP_G->request.methods.custom.entries;
 127
 128         for (i = 0; i < HTTP_G->request.methods.custom.count; ++i) {
 129                 if (ptr[i]) {
 130                         http_request_method_unregister(HTTP_CUSTOM_REQUEST_METHOD_START + i);
 131                 }
 132         }
 133         efree(HTTP_G->request.methods.custom.entries);
 134
 135         return SUCCESS;
 136 }
 137 /* }}} */
 138
 139 /* {{{ char *http_request_method_name(http_request_method) */
 140 PHP_HTTP_API const char *_http_request_method_name(http_request_method m TSRMLS_DC)
 141 {
 142         http_request_method_entry **ptr = HTTP_G->request.methods.custom.entries;
 143
 144         if (HTTP_STD_REQUEST_METHOD(m)) {
 145                 return http_request_methods[m];
 146         }
 147
 148         if (    (HTTP_CUSTOM_REQUEST_METHOD(m) >= 0) &&
 149                         (HTTP_CUSTOM_REQUEST_METHOD(m) < HTTP_G->request.methods.custom.count) &&
 150                         (ptr[HTTP_CUSTOM_REQUEST_METHOD(m)])) {
 151                 return ptr[HTTP_CUSTOM_REQUEST_METHOD(m)]->name;
 152         }
 153
 154         return http_request_methods[0];
 155 }
 156 /* }}} */
 157
 158 /* {{{ int http_request_method_exists(zend_bool, ulong, char *) */
 159 PHP_HTTP_API int _http_request_method_exists(zend_bool by_name, http_request_method id, const char *name TSRMLS_DC)
 160 {
 161         int i;
 162         http_request_method_entry **ptr = HTTP_G->request.methods.custom.entries;
 163
 164         if (by_name) {
 165                 for (i = HTTP_MIN_REQUEST_METHOD; i < HTTP_MAX_REQUEST_METHOD; ++i) {
 166                         if (!strcasecmp(name, http_request_methods[i])) {
 167                                 return i;
 168                         }
 169                 }
 170                 for (i = 0; i < HTTP_G->request.methods.custom.count; ++i) {
 171                         if (ptr[i] && !strcasecmp(name, ptr[i]->name)) {
 172                                 return HTTP_CUSTOM_REQUEST_METHOD_START + i;
 173                         }
 174                 }
 175         } else if (HTTP_STD_REQUEST_METHOD(id)) {
 176                 return id;
 177         } else if (     (HTTP_CUSTOM_REQUEST_METHOD(id) >= 0) &&
 178                                 (HTTP_CUSTOM_REQUEST_METHOD(id) < HTTP_G->request.methods.custom.count) &&
 179                                 (ptr[HTTP_CUSTOM_REQUEST_METHOD(id)])) {
 180                 return id;
 181         }
 182
 183         return 0;
 184 }
 185 /* }}} */
 186
 187 /* {{{ int http_request_method_register(char *) */
 188 PHP_HTTP_API int _http_request_method_register(const char *method_name, int method_name_len TSRMLS_DC)
 189 {
 190         int i, meth_num;
 191         char *http_method, *method, *mconst;
 192         http_request_method_entry **ptr = HTTP_G->request.methods.custom.entries;
 193
 194         if (!HTTP_IS_CTYPE(alpha, *method_name)) {
 195                 http_error_ex(HE_WARNING, HTTP_E_REQUEST_METHOD, "Request method does not start with a character (%s)", method_name);
 196                 return 0;
 197         }
 198
 199         if (http_request_method_exists(1, 0, method_name)) {
 200                 http_error_ex(HE_WARNING, HTTP_E_REQUEST_METHOD, "Request method does already exist (%s)", method_name);
 201                 return 0;
 202         }
 203
 204         method = emalloc(method_name_len + 1);
 205         mconst = emalloc(method_name_len + 1);
 206         for (i = 0; i < method_name_len; ++i) {
 207                 switch (method_name[i]) {
 208                         case '-':
 209                                 method[i] = '-';
 210                                 mconst[i] = '_';
 211                                 break;
 212
 213                         default:
 214                                 if (!HTTP_IS_CTYPE(alnum, method_name[i])) {
 215                                         efree(method);
 216                                         efree(mconst);
 217                                         http_error_ex(HE_WARNING, HTTP_E_REQUEST_METHOD, "Request method contains illegal characters (%s)", method_name);
 218                                         return 0;
 219                                 }
 220                                 mconst[i] = method[i] = HTTP_TO_CTYPE(upper, method_name[i]);
 221                                 break;
 222                 }
 223         }
 224         method[method_name_len] = '\0';
 225         mconst[method_name_len] = '\0';
 226
 227         ptr = erealloc(ptr, sizeof(http_request_method_entry *) * (HTTP_G->request.methods.custom.count + 1));
 228         HTTP_G->request.methods.custom.entries = ptr;
 229         ptr[HTTP_G->request.methods.custom.count] = emalloc(sizeof(http_request_method_entry));
 230         ptr[HTTP_G->request.methods.custom.count]->name = method;
 231         ptr[HTTP_G->request.methods.custom.count]->cnst = mconst;
 232         meth_num = HTTP_CUSTOM_REQUEST_METHOD_START + HTTP_G->request.methods.custom.count++;
 233
 234         method_name_len = spprintf(&http_method, 0, "HTTP_METH_%s", mconst);
 235         zend_register_long_constant(http_method, method_name_len + 1, meth_num, CONST_CS, http_module_number TSRMLS_CC);
 236         efree(http_method);
 237
 238 #if defined(ZEND_ENGINE_2) && defined(HTTP_HAVE_CURL) && !defined(WONKY)
 239         method_name_len = spprintf(&http_method, 0, "METH_%s", mconst);
 240         zend_declare_class_constant_long(http_request_object_ce, http_method, method_name_len, meth_num TSRMLS_CC);
 241         efree(http_method);
 242 #endif
 243
 244         return meth_num;
 245 }
 246 /* }}} */
 247
 248 /* {{{ STATUS http_request_method_unregister(int) */
 249 PHP_HTTP_API STATUS _http_request_method_unregister(int method TSRMLS_DC)
 250 {
 251         char *http_method;
 252         int method_len;
 253         http_request_method_entry **ptr = HTTP_G->request.methods.custom.entries;
 254
 255         if (HTTP_STD_REQUEST_METHOD(method)) {
 256                 http_error_ex(HE_WARNING, HTTP_E_REQUEST_METHOD, "Standard request methods cannot be unregistered");
 257                 return FAILURE;
 258         }
 259
 260         if (    (HTTP_CUSTOM_REQUEST_METHOD(method) < 0) ||
 261                         (HTTP_CUSTOM_REQUEST_METHOD(method) > HTTP_G->request.methods.custom.count) ||
 262                         (!ptr[HTTP_CUSTOM_REQUEST_METHOD(method)])) {
 263                 http_error_ex(HE_NOTICE, HTTP_E_REQUEST_METHOD, "Custom request method with id %d does not exist", method);
 264                 return FAILURE;
 265         }
 266
 267 #if defined(ZEND_ENGINE_2) && defined(HTTP_HAVE_CURL) && !defined(WONKY)
 268         method_len = spprintf(&http_method, 0, "METH_%s", ptr[HTTP_CUSTOM_REQUEST_METHOD(method)]->cnst);
 269         if (SUCCESS != zend_hash_del(&http_request_object_ce->constants_table, http_method, method_len + 1)) {
 270                 http_error_ex(HE_NOTICE, HTTP_E_REQUEST_METHOD, "Could not unregister request method: HttpRequest::%s", http_method);
 271                 efree(http_method);
 272                 return FAILURE;
 273         }
 274         efree(http_method);
 275 #endif
 276
 277         method_len = spprintf(&http_method, 0, "HTTP_METH_%s", ptr[HTTP_CUSTOM_REQUEST_METHOD(method)]->cnst);
 278         if (SUCCESS != zend_hash_del(EG(zend_constants), http_method, method_len + 1)) {
 279                 http_error_ex(HE_NOTICE, HTTP_E_REQUEST_METHOD, "Could not unregister request method: %s", http_method);
 280                 efree(http_method);
 281                 return FAILURE;
 282         }
 283         efree(http_method);
 284
 285         efree(ptr[HTTP_CUSTOM_REQUEST_METHOD(method)]->name);
 286         efree(ptr[HTTP_CUSTOM_REQUEST_METHOD(method)]->cnst);
 287         efree(ptr[HTTP_CUSTOM_REQUEST_METHOD(method)]);
 288         ptr[HTTP_CUSTOM_REQUEST_METHOD(method)] = NULL;
 289
 290         return SUCCESS;
 291 }
 292 /* }}} */
 293
 294 /*
 295  * Local variables:
 296  * tab-width: 4
 297  * c-basic-offset: 4
 298  * End:
 299  * vim600: noet sw=4 ts=4 fdm=marker
 300  * vim<600: noet sw=4 ts=4
 301  */
 302