git.m6w6.name Git - m6w6/ext-http/blob - src/php_http_misc.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_MISC_H
  14 #define PHP_HTTP_MISC_H
  15
  16 /* DEFAULTS */
  17
  18 /* DATE FORMAT RFC1123 */
  19 #define PHP_HTTP_DATE_FORMAT "D, d M Y H:i:s \\G\\M\\T"
  20
  21 /* CR LF */
  22 #define PHP_HTTP_CRLF "\r\n"
  23
  24 /* def URL arg separator */
  25 #define PHP_HTTP_URL_ARGSEP "&"
  26
  27 /* send buffer size */
  28 #define PHP_HTTP_SENDBUF_SIZE 40960
  29
  30 /* allowed characters of header field names */
  31 #define PHP_HTTP_HEADER_NAME_CHARS "!#$%&'*+-.^_`|~1234567890abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"
  32
  33 /* SLEEP */
  34
  35 #define PHP_HTTP_DIFFSEC (0.001)
  36 #define PHP_HTTP_MLLISEC (1000)
  37 #define PHP_HTTP_MCROSEC (1000 * 1000)
  38 #define PHP_HTTP_NANOSEC (1000 * 1000 * 1000)
  39 #define PHP_HTTP_MSEC(s) ((long)(s * PHP_HTTP_MLLISEC))
  40 #define PHP_HTTP_USEC(s) ((long)(s * PHP_HTTP_MCROSEC))
  41 #define PHP_HTTP_NSEC(s) ((long)(s * PHP_HTTP_NANOSEC))
  42
  43 PHP_HTTP_API void php_http_sleep(double s);
  44
  45 /* STRING UTILITIES */
  46
  47 #ifndef PTR_SET
  48 #       define PTR_SET(STR, SET) \
  49         { \
  50                 PTR_FREE(STR); \
  51                 STR = SET; \
  52         }
  53 #endif
  54
  55 #define STR_PTR(s) (s?s:"")
  56
  57 #define lenof(S) (sizeof(S) - 1)
  58
  59 #define PHP_HTTP_MATCH_LOOSE    0
  60 #define PHP_HTTP_MATCH_CASE             0x01
  61 #define PHP_HTTP_MATCH_WORD             0x10
  62 #define PHP_HTTP_MATCH_FULL             0x20
  63 #define PHP_HTTP_MATCH_STRICT   (PHP_HTTP_MATCH_CASE|PHP_HTTP_MATCH_FULL)
  64
  65 int php_http_match(const char *haystack, const char *needle, int flags);
  66 char *php_http_pretty_key(register char *key, size_t key_len, zend_bool uctitle, zend_bool xhyphen);
  67 size_t php_http_boundary(char *buf, size_t len);
  68 int php_http_select_str(const char *cmp, int argc, ...);
  69
  70 #define php_http_locate_str(h, h_len, n, n_len) zend_memnstr((h), (n), (n_len), (h)+(h_len))
  71
  72 static inline const char *php_http_locate_eol(const char *line, int *eol_len)
  73 {
  74         const char *eol = strpbrk(line, "\r\n");
  75
  76         if (eol_len) {
  77                 *eol_len = eol ? ((eol[0] == '\r' && eol[1] == '\n') ? 2 : 1) : 0;
  78         }
  79         return eol;
  80 }
  81
  82 static inline const char *php_http_locate_bin_eol(const char *bin, size_t len, int *eol_len)
  83 {
  84         register const char *eol = bin;
  85
  86         while (len--) {
  87                 if (UNEXPECTED(*eol == '\r' || *eol == '\n')) {
  88                         if (EXPECTED(eol_len)) {
  89                                 *eol_len = (EXPECTED(eol[0] == '\r' && eol[1] == '\n') ? 2 : 1);
  90                         }
  91                         return eol;
  92                 }
  93                 ++eol;
  94         }
  95         return NULL;
  96 }
  97
  98 /* ZEND */
  99
 100 #if PHP_DEBUG
 101 #       undef  HASH_OF
 102 #       define HASH_OF(p) ((HashTable*)(Z_TYPE_P(p)==IS_ARRAY ? Z_ARRVAL_P(p) : ((Z_TYPE_P(p)==IS_OBJECT ? Z_OBJ_HT_P(p)->get_properties((p)) : NULL))))
 103 #endif
 104
 105 #ifndef GC_SET_REFCOUNT
 106 #       define GC_SET_REFCOUNT(gc, rc) GC_REFCOUNT(gc) = rc
 107 #endif
 108 #ifndef GC_ADDREF
 109 #       define GC_ADDREF(gc) ++GC_REFCOUNT(gc)
 110 #endif
 111 #ifndef GC_DELREF
 112 #       define GC_DELREF(gc) --GC_REFCOUNT(gc)
 113 #endif
 114
 115 #ifdef ZEND_HASH_GET_APPLY_COUNT
 116 #       define HT_IS_RECURSIVE(ht) (ZEND_HASH_GET_APPLY_COUNT(ht) > 0)
 117 #else
 118 #       define HT_IS_RECURSIVE(ht) GC_IS_RECURSIVE(ht)
 119 #endif
 120 #ifdef ZEND_HASH_INC_APPLY_COUNT
 121 #       define HT_PROTECT_RECURSION(ht) ZEND_HASH_INC_APPLY_COUNT(ht)
 122 #else
 123 #       define HT_PROTECT_RECURSION(ht) GC_PROTECT_RECURSION(ht)
 124 #endif
 125 #ifdef ZEND_HASH_DEC_APPLY_COUNT
 126 #       define HT_UNPROTECT_RECURSION(ht) ZEND_HASH_DEC_APPLY_COUNT(ht)
 127 #else
 128 #       define HT_UNPROTECT_RECURSION(ht) GC_UNPROTECT_RECURSION(ht)
 129 #endif
 130
 131 static inline void *PHP_HTTP_OBJ(zend_object *zo, zval *zv)
 132 {
 133         if (!zo) {
 134                 zo = Z_OBJ_P(zv);
 135         }
 136         return (char *) zo - zo->handlers->offset;
 137 }
 138
 139 static inline zend_string *php_http_cs2zs(char *s, size_t l)
 140 {
 141         zend_string *str = erealloc(s, sizeof(*str) + l);
 142
 143         memmove(str->val, str, l);
 144         str->val[l] = 0;
 145         str->len = l;
 146         str->h = 0;
 147
 148         GC_SET_REFCOUNT(str, 1);
 149         GC_TYPE_INFO(str) = IS_STRING;
 150
 151         return str;
 152 }
 153
 154 static inline ZEND_RESULT_CODE php_http_ini_entry(const char *name_str, size_t name_len, const char **val_str, size_t *val_len, zend_bool orig)
 155 {
 156         zend_ini_entry *ini_entry;
 157
 158         if ((ini_entry = zend_hash_str_find_ptr(EG(ini_directives), name_str, name_len))) {
 159                 if (orig && ini_entry->modified) {
 160                         *val_str = ini_entry->orig_value->val;
 161                         *val_len = ini_entry->orig_value->len;
 162                 } else {
 163                         *val_str = ini_entry->value->val;
 164                         *val_len = ini_entry->value->len;
 165                 }
 166                 return SUCCESS;
 167         }
 168         return FAILURE;
 169 }
 170
 171 #define Z_ISUSER(zv) (Z_TYPE(zv) <= 10)
 172 #define Z_ISUSER_P(zvp) Z_ISUSER(*(zvp))
 173
 174 /* return object(values) */
 175 #define ZVAL_OBJECT(z, o, addref) \
 176         ZVAL_OBJ(z, o); \
 177         if (addref) { \
 178                 Z_ADDREF_P(z); \
 179         }
 180 #define RETVAL_OBJECT(o, addref) \
 181         ZVAL_OBJECT(return_value, o, addref)
 182 #define RETURN_OBJECT(o, addref) \
 183         RETVAL_OBJECT(o, addref); \
 184         return
 185
 186 #define EMPTY_FUNCTION_ENTRY {NULL, NULL, NULL, 0, 0}
 187
 188 #define PHP_MINIT_CALL(func) PHP_MINIT(func)(INIT_FUNC_ARGS_PASSTHRU)
 189 #define PHP_RINIT_CALL(func) PHP_RINIT(func)(INIT_FUNC_ARGS_PASSTHRU)
 190 #define PHP_MSHUTDOWN_CALL(func) PHP_MSHUTDOWN(func)(SHUTDOWN_FUNC_ARGS_PASSTHRU)
 191 #define PHP_RSHUTDOWN_CALL(func) PHP_RSHUTDOWN(func)(SHUTDOWN_FUNC_ARGS_PASSTHRU)
 192
 193 /* ARRAYS */
 194
 195 PHP_HTTP_API unsigned php_http_array_list(HashTable *ht, unsigned argc, ...);
 196
 197 typedef struct php_http_arrkey {
 198         zend_ulong h;
 199         zend_string *key;
 200         unsigned allocated:1;
 201         unsigned stringified:1;
 202 } php_http_arrkey_t;
 203
 204 static inline void *php_http_arrkey_stringify(php_http_arrkey_t *arrkey, zend_hash_key *key)
 205 {
 206         if (arrkey) {
 207                 arrkey->allocated = 0;
 208         } else {
 209                 arrkey = emalloc(sizeof(*arrkey));
 210                 arrkey->allocated = 1;
 211         }
 212
 213         if (key) {
 214                 memcpy(arrkey, key, sizeof(*key));
 215         }
 216         if ((arrkey->stringified = !arrkey->key)) {
 217                 arrkey->key = zend_long_to_str(arrkey->h);
 218         }
 219         return arrkey;
 220 }
 221
 222 static inline void php_http_arrkey_dtor(php_http_arrkey_t *arrkey)
 223 {
 224         if (arrkey->stringified) {
 225                 zend_string_release(arrkey->key);
 226         }
 227         if (arrkey->allocated) {
 228                 efree(arrkey);
 229         }
 230 }
 231
 232 #define array_copy(src, dst) zend_hash_copy(dst, src, (copy_ctor_func_t) zval_add_ref)
 233 #define array_copy_strings(src, dst) zend_hash_copy(dst, src, php_http_array_copy_strings)
 234 #define ARRAY_JOIN_STRONLY   0x01
 235 #define ARRAY_JOIN_PRETTIFY  0x02
 236 #define ARRAY_JOIN_STRINGIFY 0x04
 237 #define array_join(src, dst, append, flags) zend_hash_apply_with_arguments(src, (append)?php_http_array_apply_append_func:php_http_array_apply_merge_func, 2, dst, (int)flags)
 238
 239 void php_http_array_copy_strings(zval *zp);
 240 int php_http_array_apply_append_func(zval *pDest, int num_args, va_list args, zend_hash_key *hash_key);
 241 int php_http_array_apply_merge_func(zval *pDest, int num_args, va_list args, zend_hash_key *hash_key);
 242
 243 /* PASS CALLBACK */
 244
 245 typedef size_t (*php_http_pass_callback_t)(void *cb_arg, const char *str, size_t len);
 246 typedef size_t (*php_http_pass_php_http_buffer_callback_t)(void *cb_arg, php_http_buffer_t *str);
 247 typedef size_t (*php_http_pass_format_callback_t)(void *cb_arg, const char *fmt, ...);
 248
 249 typedef struct php_http_pass_fcall_arg {
 250         zval fcz;
 251         zend_fcall_info fci;
 252         zend_fcall_info_cache fcc;
 253 } php_http_pass_fcall_arg_t;
 254
 255 PHP_HTTP_API size_t php_http_pass_fcall_callback(void *cb_arg, const char *str, size_t len);
 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  */