git.m6w6.name Git - m6w6/ext-http/blob - php_http_url.h

   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 #ifndef PHP_HTTP_URL_H
  14 #define PHP_HTTP_URL_H
  15
  16 #include <ext/standard/url.h>
  17
  18 #define PHP_HTTP_URL_REPLACE            0x000
  19 #define PHP_HTTP_URL_JOIN_PATH          0x001
  20 #define PHP_HTTP_URL_JOIN_QUERY         0x002
  21 #define PHP_HTTP_URL_STRIP_USER         0x004
  22 #define PHP_HTTP_URL_STRIP_PASS         0x008
  23 #define PHP_HTTP_URL_STRIP_AUTH         (PHP_HTTP_URL_STRIP_USER|PHP_HTTP_URL_STRIP_PASS)
  24 #define PHP_HTTP_URL_STRIP_PORT         0x020
  25 #define PHP_HTTP_URL_STRIP_PATH         0x040
  26 #define PHP_HTTP_URL_STRIP_QUERY        0x080
  27 #define PHP_HTTP_URL_STRIP_FRAGMENT     0x100
  28 #define PHP_HTTP_URL_STRIP_ALL ( \
  29         PHP_HTTP_URL_STRIP_AUTH | \
  30         PHP_HTTP_URL_STRIP_PORT | \
  31         PHP_HTTP_URL_STRIP_PATH | \
  32         PHP_HTTP_URL_STRIP_QUERY | \
  33         PHP_HTTP_URL_STRIP_FRAGMENT \
  34 )
  35 #define PHP_HTTP_URL_FROM_ENV           0x1000
  36 #define PHP_HTTP_URL_SANITIZE_PATH      0x2000
  37
  38 typedef struct php_http_url_part {
  39         char *str;
  40         size_t len;
  41 } php_http_url_part_t;
  42
  43 /* parse multibyte according to locale */
  44 #define PHP_HTTP_URL_PARSE_MBLOC  0x001
  45 /* parse utf8 multibyte sequences */
  46 #define PHP_HTTP_URL_PARSE_MBUTF8 0x002
  47 /* convert multibyte hostnames to IDNA */
  48 #define PHP_HTTP_URL_PARSE_IDN    0x010
  49
  50 typedef struct php_http_url {
  51         /* compatible to php_url, but do not use php_url_free() */
  52         char *scheme;
  53         char *user;
  54         char *pass;
  55         char *host;
  56         unsigned short port;
  57         char *path;
  58         char *query;
  59         char *fragment;
  60         /* our stuff */
  61 #ifdef ZTS
  62         void ***ts;
  63 #endif
  64         const char *ptr;
  65         const char *end;
  66         size_t maxlen;
  67         off_t offset;
  68         unsigned flags;
  69         char buffer[];
  70 } php_http_url_t;
  71
  72 PHP_HTTP_API php_http_url_t *php_http_url_parse(const char *str, size_t len, unsigned flags TSRMLS_DC);
  73 PHP_HTTP_API void php_http_url_free(php_http_url_t **url);
  74
  75 PHP_HTTP_API void php_http_url(int flags, const php_url *old_url, const php_url *new_url, php_url **url_ptr, char **url_str, size_t *url_len TSRMLS_DC);
  76
  77 PHP_HTTP_API STATUS php_http_url_encode_hash(HashTable *hash, const char *pre_encoded_str, size_t pre_encoded_len, char **encoded_str, size_t *encoded_len TSRMLS_DC);
  78 PHP_HTTP_API STATUS php_http_url_encode_hash_ex(HashTable *hash, php_http_buffer_t *qstr, const char *arg_sep_str, size_t arg_sep_len, const char *val_sep_str, size_t val_sep_len, const char *pre_encoded_str, size_t pre_encoded_len TSRMLS_DC);
  79
  80 static inline void php_http_url_argsep(const char **str, size_t *len TSRMLS_DC)
  81 {
  82         if (SUCCESS != php_http_ini_entry(ZEND_STRL("arg_separator.output"), str, len, 0 TSRMLS_CC) || !*len) {
  83                 *str = PHP_HTTP_URL_ARGSEP;
  84                 *len = lenof(PHP_HTTP_URL_ARGSEP);
  85         }
  86 }
  87
  88 static inline void php_http_url_to_string(php_url *url, char **url_str, size_t *url_len TSRMLS_DC)
  89 {
  90         php_http_buffer_t buf;
  91
  92         php_http_buffer_init(&buf);
  93
  94         if (url->scheme && *url->scheme) {
  95                 php_http_buffer_appendl(&buf, url->scheme);
  96                 php_http_buffer_appends(&buf, "://");
  97         } else {
  98                 php_http_buffer_appends(&buf, "//");
  99         }
 100
 101         if (url->user && *url->user) {
 102                 php_http_buffer_appendl(&buf, url->user);
 103                 if (url->pass && *url->pass) {
 104                         php_http_buffer_appends(&buf, ":");
 105                         php_http_buffer_appendl(&buf, url->pass);
 106                 }
 107                 php_http_buffer_appends(&buf, "@");
 108         }
 109
 110         if (url->host && *url->host) {
 111                 php_http_buffer_appendl(&buf, url->host);
 112         } else {
 113                 php_http_buffer_appends(&buf, "localhost");
 114         }
 115
 116         if (url->port) {
 117                 php_http_buffer_appendf(&buf, ":%hu", url->port);
 118         }
 119
 120         if (url->path && *url->path) {
 121                 php_http_buffer_appendl(&buf, url->path);
 122         }
 123
 124         if (url->query && *url->query) {
 125                 php_http_buffer_appends(&buf, "?");
 126                 php_http_buffer_appendl(&buf, url->query);
 127         }
 128
 129         if (url->fragment && *url->fragment) {
 130                 php_http_buffer_appends(&buf, "#");
 131                 php_http_buffer_appendl(&buf, url->fragment);
 132         }
 133
 134         php_http_buffer_shrink(&buf);
 135         php_http_buffer_fix(&buf);
 136
 137         if (url_len) {
 138                 *url_len = buf.used;
 139         }
 140
 141         if (url_str) {
 142                 *url_str = buf.data;
 143         } else {
 144                 php_http_buffer_dtor(&buf);
 145         }
 146 }
 147
 148 static inline php_url *php_http_url_from_struct(php_url *url, HashTable *ht TSRMLS_DC)
 149 {
 150         zval **e;
 151
 152         if (!url) {
 153                 url = emalloc(sizeof(*url));
 154         }
 155         memset(url, 0, sizeof(*url));
 156
 157         if (SUCCESS == zend_hash_find(ht, "scheme", sizeof("scheme"), (void *) &e)) {
 158                 zval *cpy = php_http_ztyp(IS_STRING, *e);
 159                 url->scheme = estrndup(Z_STRVAL_P(cpy), Z_STRLEN_P(cpy));
 160                 zval_ptr_dtor(&cpy);
 161         }
 162         if (SUCCESS == zend_hash_find(ht, "user", sizeof("user"), (void *) &e)) {
 163                 zval *cpy = php_http_ztyp(IS_STRING, *e);
 164                 url->user = estrndup(Z_STRVAL_P(cpy), Z_STRLEN_P(cpy));
 165                 zval_ptr_dtor(&cpy);
 166         }
 167         if (SUCCESS == zend_hash_find(ht, "pass", sizeof("pass"), (void *) &e)) {
 168                 zval *cpy = php_http_ztyp(IS_STRING, *e);
 169                 url->pass = estrndup(Z_STRVAL_P(cpy), Z_STRLEN_P(cpy));
 170                 zval_ptr_dtor(&cpy);
 171         }
 172         if (SUCCESS == zend_hash_find(ht, "host", sizeof("host"), (void *) &e)) {
 173                 zval *cpy = php_http_ztyp(IS_STRING, *e);
 174                 url->host = estrndup(Z_STRVAL_P(cpy), Z_STRLEN_P(cpy));
 175                 zval_ptr_dtor(&cpy);
 176         }
 177         if (SUCCESS == zend_hash_find(ht, "path", sizeof("path"), (void *) &e)) {
 178                 zval *cpy = php_http_ztyp(IS_STRING, *e);
 179                 url->path = estrndup(Z_STRVAL_P(cpy), Z_STRLEN_P(cpy));
 180                 zval_ptr_dtor(&cpy);
 181         }
 182         if (SUCCESS == zend_hash_find(ht, "query", sizeof("query"), (void *) &e)) {
 183                 zval *cpy = php_http_ztyp(IS_STRING, *e);
 184                 url->query = estrndup(Z_STRVAL_P(cpy), Z_STRLEN_P(cpy));
 185                 zval_ptr_dtor(&cpy);
 186         }
 187         if (SUCCESS == zend_hash_find(ht, "fragment", sizeof("fragment"), (void *) &e)) {
 188                 zval *cpy = php_http_ztyp(IS_STRING, *e);
 189                 url->fragment = estrndup(Z_STRVAL_P(cpy), Z_STRLEN_P(cpy));
 190                 zval_ptr_dtor(&cpy);
 191         }
 192         if (SUCCESS == zend_hash_find(ht, "port", sizeof("port"), (void *) &e)) {
 193                 zval *cpy = php_http_ztyp(IS_LONG, *e);
 194                 url->port = (unsigned short) Z_LVAL_P(cpy);
 195                 zval_ptr_dtor(&cpy);
 196         }
 197
 198         return url;
 199 }
 200
 201 static inline HashTable *php_http_url_to_struct(php_url *url, zval *strct TSRMLS_DC)
 202 {
 203         zval arr;
 204
 205         if (strct) {
 206                 switch (Z_TYPE_P(strct)) {
 207                         default:
 208                                 zval_dtor(strct);
 209                                 array_init(strct);
 210                                 /* no break */
 211                         case IS_ARRAY:
 212                         case IS_OBJECT:
 213                                 INIT_PZVAL_ARRAY((&arr), HASH_OF(strct));
 214                                 break;
 215                 }
 216         } else {
 217                 INIT_PZVAL(&arr);
 218                 array_init(&arr);
 219         }
 220
 221         if (url) {
 222                 if (url->scheme) {
 223                         add_assoc_string(&arr, "scheme", url->scheme, 1);
 224                 }
 225                 if (url->user) {
 226                         add_assoc_string(&arr, "user", url->user, 1);
 227                 }
 228                 if (url->pass) {
 229                         add_assoc_string(&arr, "pass", url->pass, 1);
 230                 }
 231                 if (url->host) {
 232                         add_assoc_string(&arr, "host", url->host, 1);
 233                 }
 234                 if (url->port) {
 235                         add_assoc_long(&arr, "port", (long) url->port);
 236                 }
 237                 if (url->path) {
 238                         add_assoc_string(&arr, "path", url->path, 1);
 239                 }
 240                 if (url->query) {
 241                         add_assoc_string(&arr, "query", url->query, 1);
 242                 }
 243                 if (url->fragment) {
 244                         add_assoc_string(&arr, "fragment", url->fragment, 1);
 245                 }
 246         }
 247
 248         return Z_ARRVAL(arr);
 249 }
 250
 251 PHP_HTTP_API zend_class_entry *php_http_url_class_entry;
 252 PHP_MINIT_FUNCTION(http_url);
 253
 254 #define php_http_url_object_new php_http_object_new
 255 #define php_http_url_object_new_ex php_http_object_new_ex
 256
 257 #endif
 258
 259 /*
 260  * Local variables:
 261  * tab-width: 4
 262  * c-basic-offset: 4
 263  * End:
 264  * vim600: noet sw=4 ts=4 fdm=marker
 265  * vim<600: noet sw=4 ts=4
 266  */
 267