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 /* parse multibyte according to locale */
  39 #define PHP_HTTP_URL_PARSE_MBLOC        0x10000
  40 /* parse utf8 multibyte sequences */
  41 #define PHP_HTTP_URL_PARSE_MBUTF8       0x20000
  42 /* convert multibyte hostnames to IDNA */
  43 #define PHP_HTTP_URL_PARSE_TOIDN        0x100000
  44 /* percent encode multibyte sequences in userinfo, path, query and fragment */
  45 #define PHP_HTTP_URL_PARSE_TOPCT        0x200000
  46
  47 typedef struct php_http_url {
  48         /* compatible to php_url, but do not use php_url_free() */
  49         char *scheme;
  50         char *user;
  51         char *pass;
  52         char *host;
  53         unsigned short port;
  54         char *path;
  55         char *query;
  56         char *fragment;
  57 } php_http_url_t;
  58
  59 PHP_HTTP_API php_http_url_t *php_http_url_parse(const char *str, size_t len, unsigned flags TSRMLS_DC);
  60 /* deprecated */
  61 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);
  62 /* use this instead */
  63 PHP_HTTP_API php_http_url_t *php_http_url_mod(const php_http_url_t *old_url, const php_http_url_t *new_url, unsigned flags TSRMLS_DC);
  64 PHP_HTTP_API php_http_url_t *php_http_url_copy(const php_http_url_t *url, zend_bool persistent);
  65 PHP_HTTP_API php_http_url_t *php_http_url_from_struct(HashTable *ht);
  66 PHP_HTTP_API php_http_url_t *php_http_url_from_zval(zval *value, unsigned flags TSRMLS_DC);
  67 PHP_HTTP_API HashTable *php_http_url_to_struct(const php_http_url_t *url, zval *strct TSRMLS_DC);
  68 PHP_HTTP_API char *php_http_url_to_string(const php_http_url_t *url, char **url_str, size_t *url_len, zend_bool persistent);
  69 PHP_HTTP_API void php_http_url_free(php_http_url_t **url);
  70
  71
  72 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);
  73 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);
  74
  75 static inline void php_http_url_argsep(const char **str, size_t *len TSRMLS_DC)
  76 {
  77         if (SUCCESS != php_http_ini_entry(ZEND_STRL("arg_separator.output"), str, len, 0 TSRMLS_CC) || !*len) {
  78                 *str = PHP_HTTP_URL_ARGSEP;
  79                 *len = lenof(PHP_HTTP_URL_ARGSEP);
  80         }
  81 }
  82
  83 static inline php_url *php_http_url_to_php_url(php_http_url_t *url)
  84 {
  85         php_url *purl = ecalloc(1, sizeof(*purl));
  86
  87         if (url->scheme)   purl->scheme   = estrdup(url->scheme);
  88         if (url->pass)     purl->pass     = estrdup(url->pass);
  89         if (url->user)     purl->user     = estrdup(url->user);
  90         if (url->host)     purl->host     = estrdup(url->host);
  91         if (url->path)     purl->path     = estrdup(url->path);
  92         if (url->query)    purl->query    = estrdup(url->query);
  93         if (url->fragment) purl->fragment = estrdup(url->fragment);
  94
  95         return purl;
  96 }
  97
  98 static inline zend_bool php_http_url_is_empty(const php_http_url_t *url) {
  99         return !(url->scheme || url->pass || url->user || url->host || url->port ||     url->path || url->query || url->fragment);
 100 }
 101
 102 PHP_HTTP_API zend_class_entry *php_http_url_class_entry;
 103 PHP_MINIT_FUNCTION(http_url);
 104
 105 #define php_http_url_object_new php_http_object_new
 106 #define php_http_url_object_new_ex php_http_object_new_ex
 107
 108 #endif
 109
 110 /*
 111  * Local variables:
 112  * tab-width: 4
 113  * c-basic-offset: 4
 114  * End:
 115  * vim600: noet sw=4 ts=4 fdm=marker
 116  * vim<600: noet sw=4 ts=4
 117  */
 118