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