git.m6w6.name Git - m6w6/ext-http/blob - 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 /* SLEEP */
  31
  32 #define PHP_HTTP_DIFFSEC (0.001)
  33 #define PHP_HTTP_MLLISEC (1000)
  34 #define PHP_HTTP_MCROSEC (1000 * 1000)
  35 #define PHP_HTTP_NANOSEC (1000 * 1000 * 1000)
  36 #define PHP_HTTP_MSEC(s) ((long)(s * PHP_HTTP_MLLISEC))
  37 #define PHP_HTTP_USEC(s) ((long)(s * PHP_HTTP_MCROSEC))
  38 #define PHP_HTTP_NSEC(s) ((long)(s * PHP_HTTP_NANOSEC))
  39
  40 PHP_HTTP_API void php_http_sleep(double s);
  41
  42 /* STRING UTILITIES */
  43
  44 #ifndef STR_SET
  45 #       define STR_SET(STR, SET) \
  46         { \
  47                 STR_FREE(STR); \
  48                 STR = SET; \
  49         }
  50 #endif
  51
  52 #define STR_PTR(s) (s?s:"")
  53
  54 #define lenof(S) (sizeof(S) - 1)
  55
  56 #define PHP_HTTP_MATCH_LOOSE    0
  57 #define PHP_HTTP_MATCH_CASE             0x01
  58 #define PHP_HTTP_MATCH_WORD             0x10
  59 #define PHP_HTTP_MATCH_FULL             0x20
  60 #define PHP_HTTP_MATCH_STRICT   (PHP_HTTP_MATCH_CASE|PHP_HTTP_MATCH_FULL)
  61
  62 int php_http_match(const char *haystack, const char *needle, int flags);
  63 char *php_http_pretty_key(register char *key, size_t key_len, zend_bool uctitle, zend_bool xhyphen);
  64 size_t php_http_boundary(char *buf, size_t len TSRMLS_DC);
  65 int php_http_select_str(const char *cmp, int argc, ...);
  66
  67 /* See "A Reusable Duff Device" By Ralf Holly, August 01, 2005 */
  68 #define PHP_HTTP_DUFF_BREAK() times_=1
  69 #define PHP_HTTP_DUFF(c, a) do { \
  70         size_t count_ = (c); \
  71         size_t times_ = (count_ + 7) >> 3; \
  72         switch (count_ & 7){ \
  73                 case 0: do { \
  74                         a; \
  75                 case 7: \
  76                         a; \
  77                 case 6: \
  78                         a; \
  79                 case 5: \
  80                         a; \
  81                 case 4: \
  82                         a; \
  83                 case 3: \
  84                         a; \
  85                 case 2: \
  86                         a; \
  87                 case 1: \
  88                         a; \
  89                                         } while (--times_ > 0); \
  90         } \
  91 } while (0)
  92
  93 static inline const char *php_http_locate_str(register const char *h, size_t h_len, const char *n, size_t n_len)
  94 {
  95         if (!n_len || !h_len || h_len < n_len) {
  96                 return NULL;
  97         }
  98
  99         PHP_HTTP_DUFF(h_len - n_len + 1,
 100                 if (*h == *n && !strncmp(h + 1, n + 1, n_len - 1)) {
 101                         return h;
 102                 }
 103                 ++h;
 104         );
 105
 106         return NULL;
 107 }
 108
 109 static inline const char *php_http_locate_eol(const char *line, int *eol_len)
 110 {
 111         const char *eol = strpbrk(line, "\r\n");
 112
 113         if (eol_len) {
 114                 *eol_len = eol ? ((eol[0] == '\r' && eol[1] == '\n') ? 2 : 1) : 0;
 115         }
 116         return eol;
 117 }
 118
 119 static inline const char *php_http_locate_bin_eol(const char *bin, size_t len, int *eol_len)
 120 {
 121         register const char *eol = bin;
 122
 123         if (len > 0) {
 124                 PHP_HTTP_DUFF(len,
 125                         if (*eol == '\r' || *eol == '\n') {
 126                                 if (eol_len) {
 127                                         *eol_len = ((eol[0] == '\r' && eol[1] == '\n') ? 2 : 1);
 128                                 }
 129                                 return eol;
 130                         }
 131                         ++eol;
 132                 );
 133         }
 134         return NULL;
 135 }
 136
 137 /* ZEND */
 138
 139 #if PHP_VERSION_ID < 50400
 140 #       define object_properties_init(o, ce) zend_hash_copy(((zend_object *) o)->properties, &(ce->default_properties), (copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval*))
 141 #       define PHP_HTTP_ZEND_LITERAL_DC
 142 #       define PHP_HTTP_ZEND_LITERAL_CC
 143 #       define PHP_HTTP_ZEND_LITERAL_CCN
 144 #       define ZVAL_COPY_VALUE(zv, arr) do { \
 145                 (zv)->value = (arr)->value; \
 146                 Z_TYPE_P(zv) = Z_TYPE_P(arr); \
 147         } while (0)
 148 #else
 149 #       define PHP_HTTP_ZEND_LITERAL_DC , const zend_literal *literal_key
 150 #       define PHP_HTTP_ZEND_LITERAL_CC , (literal_key)
 151 #       define PHP_HTTP_ZEND_LITERAL_CCN , NULL
 152 #endif
 153
 154 #if PHP_VERSION_ID < 50700
 155 #       define z_is_true zend_is_true
 156 #else
 157 #       define z_is_true(z) zend_is_true(z TSRMLS_CC)
 158 #endif
 159
 160 #define INIT_PZVAL_ARRAY(zv, ht) \
 161         { \
 162                 INIT_PZVAL((zv)); \
 163                 Z_TYPE_P(zv) = IS_ARRAY; \
 164                 Z_ARRVAL_P(zv) = (ht); \
 165         }
 166
 167 static inline zval *php_http_zconv(int type, zval *z)
 168 {
 169         switch (type) {
 170                 case IS_NULL:   convert_to_null_ex(&z);         break;
 171                 case IS_BOOL:   convert_to_boolean_ex(&z);      break;
 172                 case IS_LONG:   convert_to_long_ex(&z);         break;
 173                 case IS_DOUBLE: convert_to_double_ex(&z);       break;
 174                 case IS_STRING: convert_to_string_ex(&z);       break;
 175                 case IS_ARRAY:  convert_to_array_ex(&z);        break;
 176                 case IS_OBJECT: convert_to_object_ex(&z);       break;
 177         }
 178         return z;
 179 }
 180
 181 static inline zval *php_http_ztyp(int type, zval *z)
 182 {
 183         SEPARATE_ARG_IF_REF(z);
 184         return (Z_TYPE_P(z) == type) ? z : php_http_zconv(type, z);
 185 }
 186
 187 static inline zval *php_http_zsep(zend_bool add_ref, int type, zval *z)
 188 {
 189         if (add_ref) {
 190                 Z_ADDREF_P(z);
 191         }
 192         if (Z_TYPE_P(z) != type) {
 193                 return php_http_zconv(type, z);
 194         } else {
 195                 SEPARATE_ZVAL_IF_NOT_REF(&z);
 196                 return z;
 197         }
 198 }
 199
 200 static inline STATUS php_http_ini_entry(const char *name_str, size_t name_len, const char **value_str, size_t *value_len, zend_bool orig TSRMLS_DC)
 201 {
 202         zend_ini_entry *ini_entry;
 203
 204         if (SUCCESS == zend_hash_find(EG(ini_directives), name_str, name_len + 1, (void *) &ini_entry)) {
 205                 if (orig && ini_entry->modified) {
 206                         *value_str = ini_entry->orig_value;
 207                         *value_len = (size_t) ini_entry->orig_value_length;
 208                 } else {
 209                         *value_str = ini_entry->value;
 210                         *value_len = (size_t) ini_entry->value_length;
 211                 }
 212                 return SUCCESS;
 213         }
 214         return FAILURE;
 215 }
 216
 217 /* return object(values) */
 218 #define RETVAL_OBJECT(o, addref) \
 219         RETVAL_OBJVAL((o)->value.obj, addref)
 220 #define RETURN_OBJECT(o, addref) \
 221         RETVAL_OBJECT(o, addref); \
 222         return
 223 #define RETVAL_OBJVAL(ov, addref) \
 224         ZVAL_OBJVAL(return_value, ov, addref)
 225 #define RETURN_OBJVAL(ov, addref) \
 226         RETVAL_OBJVAL(ov, addref); \
 227         return
 228 #define ZVAL_OBJVAL(zv, ov, addref) \
 229         (zv)->type = IS_OBJECT; \
 230         (zv)->value.obj = (ov);\
 231         if (addref && Z_OBJ_HT_P(zv)->add_ref) { \
 232                 Z_OBJ_HT_P(zv)->add_ref((zv) TSRMLS_CC); \
 233         }
 234
 235 #define Z_OBJ_DELREF(z) \
 236         if (Z_OBJ_HT(z)->del_ref) { \
 237                 Z_OBJ_HT(z)->del_ref(&(z) TSRMLS_CC); \
 238         }
 239 #define Z_OBJ_ADDREF(z) \
 240         if (Z_OBJ_HT(z)->add_ref) { \
 241                 Z_OBJ_HT(z)->add_ref(&(z) TSRMLS_CC); \
 242         }
 243 #define Z_OBJ_DELREF_P(z) \
 244         if (Z_OBJ_HT_P(z)->del_ref) { \
 245                 Z_OBJ_HT_P(z)->del_ref((z) TSRMLS_CC); \
 246         }
 247 #define Z_OBJ_ADDREF_P(z) \
 248         if (Z_OBJ_HT_P(z)->add_ref) { \
 249                 Z_OBJ_HT_P(z)->add_ref((z) TSRMLS_CC); \
 250         }
 251 #define Z_OBJ_DELREF_PP(z) \
 252         if (Z_OBJ_HT_PP(z)->del_ref) { \
 253                 Z_OBJ_HT_PP(z)->del_ref(*(z) TSRMLS_CC); \
 254         }
 255 #define Z_OBJ_ADDREF_PP(z) \
 256         if (Z_OBJ_HT_PP(z)->add_ref) { \
 257                 Z_OBJ_HT_PP(z)->add_ref(*(z) TSRMLS_CC); \
 258         }
 259
 260 #define EMPTY_FUNCTION_ENTRY {NULL, NULL, NULL, 0, 0}
 261
 262 #define PHP_MINIT_CALL(func) PHP_MINIT(func)(INIT_FUNC_ARGS_PASSTHRU)
 263 #define PHP_RINIT_CALL(func) PHP_RINIT(func)(INIT_FUNC_ARGS_PASSTHRU)
 264 #define PHP_MSHUTDOWN_CALL(func) PHP_MSHUTDOWN(func)(SHUTDOWN_FUNC_ARGS_PASSTHRU)
 265 #define PHP_RSHUTDOWN_CALL(func) PHP_RSHUTDOWN(func)(SHUTDOWN_FUNC_ARGS_PASSTHRU)
 266
 267 /* ARRAYS */
 268
 269 #ifndef HASH_KEY_NON_EXISTENT
 270 #       define HASH_KEY_NON_EXISTENT HASH_KEY_NON_EXISTANT
 271 #endif
 272
 273 PHP_HTTP_API unsigned php_http_array_list(HashTable *ht TSRMLS_DC, unsigned argc, ...);
 274
 275 typedef struct php_http_array_hashkey {
 276         char *str;
 277         uint len;
 278         ulong num;
 279         uint dup:1;
 280         uint type:31;
 281 } php_http_array_hashkey_t;
 282 #define php_http_array_hashkey_init(dup) {NULL, 0, 0, (dup), 0}
 283
 284 static inline void php_http_array_hashkey_stringify(php_http_array_hashkey_t *key)
 285 {
 286         if (key->type != HASH_KEY_IS_STRING) {
 287                 key->len = spprintf(&key->str, 0, "%lu", key->num) + 1;
 288         }
 289 }
 290
 291 static inline void php_http_array_hashkey_stringfree(php_http_array_hashkey_t *key)
 292 {
 293         if (key->type != HASH_KEY_IS_STRING || key->dup) {
 294                 STR_FREE(key->str);
 295         }
 296 }
 297
 298 #define FOREACH_VAL(pos, array, val) FOREACH_HASH_VAL(pos, HASH_OF(array), val)
 299 #define FOREACH_HASH_VAL(pos, hash, val) \
 300         for (   zend_hash_internal_pointer_reset_ex(hash, &pos); \
 301                         zend_hash_get_current_data_ex(hash, (void *) &val, &pos) == SUCCESS; \
 302                         zend_hash_move_forward_ex(hash, &pos))
 303
 304 #define FOREACH_KEY(pos, array, key) FOREACH_HASH_KEY(pos, HASH_OF(array), key)
 305 #define FOREACH_HASH_KEY(pos, hash, _key) \
 306         for (   zend_hash_internal_pointer_reset_ex(hash, &pos); \
 307                         ((_key).type = zend_hash_get_current_key_ex(hash, &(_key).str, &(_key).len, &(_key).num, (zend_bool) (_key).dup, &pos)) != HASH_KEY_NON_EXISTANT; \
 308                         zend_hash_move_forward_ex(hash, &pos)) \
 309
 310 #define FOREACH_KEYVAL(pos, array, key, val) FOREACH_HASH_KEYVAL(pos, HASH_OF(array), key, val)
 311 #define FOREACH_HASH_KEYVAL(pos, hash, _key, val) \
 312         for (   zend_hash_internal_pointer_reset_ex(hash, &pos); \
 313                         ((_key).type = zend_hash_get_current_key_ex(hash, &(_key).str, &(_key).len, &(_key).num, (zend_bool) (_key).dup, &pos)) != HASH_KEY_NON_EXISTANT && \
 314                         zend_hash_get_current_data_ex(hash, (void *) &val, &pos) == SUCCESS; \
 315                         zend_hash_move_forward_ex(hash, &pos))
 316
 317 #define array_copy(src, dst) zend_hash_copy(dst, src, (copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval *))
 318 #define array_copy_strings(src, dst) zend_hash_copy(dst, src, php_http_array_copy_strings, NULL, sizeof(zval *))
 319 #define ARRAY_JOIN_STRONLY   0x01
 320 #define ARRAY_JOIN_PRETTIFY  0x02
 321 #define ARRAY_JOIN_STRINGIFY 0x04
 322 #define array_join(src, dst, append, flags) zend_hash_apply_with_arguments(src TSRMLS_CC, (append)?php_http_array_apply_append_func:php_http_array_apply_merge_func, 2, dst, (int)flags)
 323
 324 void php_http_array_copy_strings(void *zpp);
 325 int php_http_array_apply_append_func(void *pDest TSRMLS_DC, int num_args, va_list args, zend_hash_key *hash_key);
 326 int php_http_array_apply_merge_func(void *pDest TSRMLS_DC, int num_args, va_list args, zend_hash_key *hash_key);
 327
 328 /* PASS CALLBACK */
 329
 330 typedef size_t (*php_http_pass_callback_t)(void *cb_arg, const char *str, size_t len);
 331 typedef size_t (*php_http_pass_php_http_buffer_callback_t)(void *cb_arg, php_http_buffer_t *str);
 332 typedef size_t (*php_http_pass_format_callback_t)(void *cb_arg, const char *fmt, ...);
 333
 334 typedef struct php_http_pass_fcall_arg {
 335         zval *fcz;
 336         zend_fcall_info fci;
 337         zend_fcall_info_cache fcc;
 338 #ifdef ZTS
 339         void ***ts;
 340 #endif
 341 } php_http_pass_fcall_arg_t;
 342
 343 PHP_HTTP_API size_t php_http_pass_fcall_callback(void *cb_arg, const char *str, size_t len);
 344
 345 #endif
 346
 347 /*
 348  * Local variables:
 349  * tab-width: 4
 350  * c-basic-offset: 4
 351  * End:
 352  * vim600: noet sw=4 ts=4 fdm=marker
 353  * vim<600: noet sw=4 ts=4
 354  */