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 /* percent encode multibyte sequences in userinfo, path, query and fragment */
  50 #define PHP_HTTP_URL_PARSE_PCTENC 0x020
  51
  52 typedef struct php_http_url {
  53         /* compatible to php_url, but do not use php_url_free() */
  54         char *scheme;
  55         char *user;
  56         char *pass;
  57         char *host;
  58         unsigned short port;
  59         char *path;
  60         char *query;
  61         char *fragment;
  62         /* our stuff */
  63 #ifdef ZTS
  64         void ***ts;
  65 #endif
  66         const char *ptr;
  67         const char *end;
  68         size_t maxlen;
  69         off_t offset;
  70         unsigned flags;
  71         char buffer[];
  72 } php_http_url_t;
  73
  74 PHP_HTTP_API php_http_url_t *php_http_url_parse(const char *str, size_t len, unsigned flags TSRMLS_DC);
  75 PHP_HTTP_API void php_http_url_free(php_http_url_t **url);
  76
  77 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);
  78
  79 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);
  80 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);
  81
  82 static inline void php_http_url_argsep(const char **str, size_t *len TSRMLS_DC)
  83 {
  84         if (SUCCESS != php_http_ini_entry(ZEND_STRL("arg_separator.output"), str, len, 0 TSRMLS_CC) || !*len) {
  85                 *str = PHP_HTTP_URL_ARGSEP;
  86                 *len = lenof(PHP_HTTP_URL_ARGSEP);
  87         }
  88 }
  89
  90 static inline void php_http_url_to_string(php_url *url, char **url_str, size_t *url_len TSRMLS_DC)
  91 {
  92         php_http_buffer_t buf;
  93
  94         php_http_buffer_init(&buf);
  95
  96         if (url->scheme && *url->scheme) {
  97                 php_http_buffer_appendl(&buf, url->scheme);
  98                 php_http_buffer_appends(&buf, "://");
  99         } else {
 100                 php_http_buffer_appends(&buf, "//");
 101         }
 102
 103         if (url->user && *url->user) {
 104                 php_http_buffer_appendl(&buf, url->user);
 105                 if (url->pass && *url->pass) {
 106                         php_http_buffer_appends(&buf, ":");
 107                         php_http_buffer_appendl(&buf, url->pass);
 108                 }
 109                 php_http_buffer_appends(&buf, "@");
 110         }
 111
 112         if (url->host && *url->host) {
 113                 php_http_buffer_appendl(&buf, url->host);
 114         } else {
 115                 php_http_buffer_appends(&buf, "localhost");
 116         }
 117
 118         if (url->port) {
 119                 php_http_buffer_appendf(&buf, ":%hu", url->port);
 120         }
 121
 122         if (url->path && *url->path) {
 123                 php_http_buffer_appendl(&buf, url->path);
 124         }
 125
 126         if (url->query && *url->query) {
 127                 php_http_buffer_appends(&buf, "?");
 128                 php_http_buffer_appendl(&buf, url->query);
 129         }
 130
 131         if (url->fragment && *url->fragment) {
 132                 php_http_buffer_appends(&buf, "#");
 133                 php_http_buffer_appendl(&buf, url->fragment);
 134         }
 135
 136         php_http_buffer_shrink(&buf);
 137         php_http_buffer_fix(&buf);
 138
 139         if (url_len) {
 140                 *url_len = buf.used;
 141         }
 142
 143         if (url_str) {
 144                 *url_str = buf.data;
 145         } else {
 146                 php_http_buffer_dtor(&buf);
 147         }
 148 }
 149
 150 static inline php_url *php_http_url_from_struct(php_url *url, HashTable *ht TSRMLS_DC)
 151 {
 152         zval **e;
 153
 154         if (!url) {
 155                 url = emalloc(sizeof(*url));
 156         }
 157         memset(url, 0, sizeof(*url));
 158
 159         if (SUCCESS == zend_hash_find(ht, "scheme", sizeof("scheme"), (void *) &e)) {
 160                 zval *cpy = php_http_ztyp(IS_STRING, *e);
 161                 url->scheme = estrndup(Z_STRVAL_P(cpy), Z_STRLEN_P(cpy));
 162                 zval_ptr_dtor(&cpy);
 163         }
 164         if (SUCCESS == zend_hash_find(ht, "user", sizeof("user"), (void *) &e)) {
 165                 zval *cpy = php_http_ztyp(IS_STRING, *e);
 166                 url->user = estrndup(Z_STRVAL_P(cpy), Z_STRLEN_P(cpy));
 167                 zval_ptr_dtor(&cpy);
 168         }
 169         if (SUCCESS == zend_hash_find(ht, "pass", sizeof("pass"), (void *) &e)) {
 170                 zval *cpy = php_http_ztyp(IS_STRING, *e);
 171                 url->pass = estrndup(Z_STRVAL_P(cpy), Z_STRLEN_P(cpy));
 172                 zval_ptr_dtor(&cpy);
 173         }
 174         if (SUCCESS == zend_hash_find(ht, "host", sizeof("host"), (void *) &e)) {
 175                 zval *cpy = php_http_ztyp(IS_STRING, *e);
 176                 url->host = estrndup(Z_STRVAL_P(cpy), Z_STRLEN_P(cpy));
 177                 zval_ptr_dtor(&cpy);
 178         }
 179         if (SUCCESS == zend_hash_find(ht, "path", sizeof("path"), (void *) &e)) {
 180                 zval *cpy = php_http_ztyp(IS_STRING, *e);
 181                 url->path = estrndup(Z_STRVAL_P(cpy), Z_STRLEN_P(cpy));
 182                 zval_ptr_dtor(&cpy);
 183         }
 184         if (SUCCESS == zend_hash_find(ht, "query", sizeof("query"), (void *) &e)) {
 185                 zval *cpy = php_http_ztyp(IS_STRING, *e);
 186                 url->query = estrndup(Z_STRVAL_P(cpy), Z_STRLEN_P(cpy));
 187                 zval_ptr_dtor(&cpy);
 188         }
 189         if (SUCCESS == zend_hash_find(ht, "fragment", sizeof("fragment"), (void *) &e)) {
 190                 zval *cpy = php_http_ztyp(IS_STRING, *e);
 191                 url->fragment = estrndup(Z_STRVAL_P(cpy), Z_STRLEN_P(cpy));
 192                 zval_ptr_dtor(&cpy);
 193         }
 194         if (SUCCESS == zend_hash_find(ht, "port", sizeof("port"), (void *) &e)) {
 195                 zval *cpy = php_http_ztyp(IS_LONG, *e);
 196                 url->port = (unsigned short) Z_LVAL_P(cpy);
 197                 zval_ptr_dtor(&cpy);
 198         }
 199
 200         return url;
 201 }
 202
 203 static inline HashTable *php_http_url_to_struct(php_url *url, zval *strct TSRMLS_DC)
 204 {
 205         zval arr;
 206
 207         if (strct) {
 208                 switch (Z_TYPE_P(strct)) {
 209                         default:
 210                                 zval_dtor(strct);
 211                                 array_init(strct);
 212                                 /* no break */
 213                         case IS_ARRAY:
 214                         case IS_OBJECT:
 215                                 INIT_PZVAL_ARRAY((&arr), HASH_OF(strct));
 216                                 break;
 217                 }
 218         } else {
 219                 INIT_PZVAL(&arr);
 220                 array_init(&arr);
 221         }
 222
 223         if (url) {
 224                 if (url->scheme) {
 225                         add_assoc_string(&arr, "scheme", url->scheme, 1);
 226                 }
 227                 if (url->user) {
 228                         add_assoc_string(&arr, "user", url->user, 1);
 229                 }
 230                 if (url->pass) {
 231                         add_assoc_string(&arr, "pass", url->pass, 1);
 232                 }
 233                 if (url->host) {
 234                         add_assoc_string(&arr, "host", url->host, 1);
 235                 }
 236                 if (url->port) {
 237                         add_assoc_long(&arr, "port", (long) url->port);
 238                 }
 239                 if (url->path) {
 240                         add_assoc_string(&arr, "path", url->path, 1);
 241                 }
 242                 if (url->query) {
 243                         add_assoc_string(&arr, "query", url->query, 1);
 244                 }
 245                 if (url->fragment) {
 246                         add_assoc_string(&arr, "fragment", url->fragment, 1);
 247                 }
 248         }
 249
 250         return Z_ARRVAL(arr);
 251 }
 252
 253 PHP_HTTP_API zend_class_entry *php_http_url_class_entry;
 254 PHP_MINIT_FUNCTION(http_url);
 255
 256 #define php_http_url_object_new php_http_object_new
 257 #define php_http_url_object_new_ex php_http_object_new_ex
 258
 259 #endif
 260
 261 /*
 262  * Local variables:
 263  * tab-width: 4
 264  * c-basic-offset: 4
 265  * End:
 266  * vim600: noet sw=4 ts=4 fdm=marker
 267  * vim<600: noet sw=4 ts=4
 268  */
 269