2 +--------------------------------------------------------------------+
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 +--------------------------------------------------------------------+
13 #ifndef PHP_HTTP_MISC_H
14 #define PHP_HTTP_MISC_H
18 /* DATE FORMAT RFC1123 */
19 #define PHP_HTTP_DATE_FORMAT "D, d M Y H:i:s \\G\\M\\T"
22 #define PHP_HTTP_CRLF "\r\n"
24 /* def URL arg separator */
25 #define PHP_HTTP_URL_ARGSEP "&"
27 /* send buffer size */
28 #define PHP_HTTP_SENDBUF_SIZE 40960
30 /* allowed characters of header field names */
31 #define PHP_HTTP_HEADER_NAME_CHARS "!#$%&'*+-.^_`|~1234567890abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"
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))
43 PHP_HTTP_API
void php_http_sleep(double s
);
45 /* STRING UTILITIES */
48 # define PTR_SET(STR, SET) \
55 #define STR_PTR(s) (s?s:"")
57 #define lenof(S) (sizeof(S) - 1)
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)
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 TSRMLS_DC
);
68 int php_http_select_str(const char *cmp
, int argc
, ...);
70 /* See "A Reusable Duff Device" By Ralf Holly, August 01, 2005 */
71 #define PHP_HTTP_DUFF_BREAK() times_=1
72 #define PHP_HTTP_DUFF(c, a) do { \
73 size_t count_ = (c); \
74 size_t times_ = (count_ + 7) >> 3; \
75 switch (count_ & 7){ \
92 } while (--times_ > 0); \
96 static inline const char *php_http_locate_str(register const char *h
, size_t h_len
, const char *n
, size_t n_len
)
98 if (!n_len
|| !h_len
|| h_len
< n_len
) {
102 PHP_HTTP_DUFF(h_len
- n_len
+ 1,
103 if (*h
== *n
&& !strncmp(h
+ 1, n
+ 1, n_len
- 1)) {
112 static inline const char *php_http_locate_eol(const char *line
, int *eol_len
)
114 const char *eol
= strpbrk(line
, "\r\n");
117 *eol_len
= eol
? ((eol
[0] == '\r' && eol
[1] == '\n') ? 2 : 1) : 0;
122 static inline const char *php_http_locate_bin_eol(const char *bin
, size_t len
, int *eol_len
)
124 register const char *eol
= bin
;
128 if (*eol
== '\r' || *eol
== '\n') {
130 *eol_len
= ((eol
[0] == '\r' && eol
[1] == '\n') ? 2 : 1);
142 #if PHP_VERSION_ID < 50400
143 # 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*))
144 # define PHP_HTTP_ZEND_LITERAL_DC
145 # define PHP_HTTP_ZEND_LITERAL_CC
146 # define PHP_HTTP_ZEND_LITERAL_CCN
147 # define ZVAL_COPY_VALUE(zv, arr) do { \
148 (zv)->value = (arr)->value; \
149 Z_TYPE_P(zv) = Z_TYPE_P(arr); \
152 # define PHP_HTTP_ZEND_LITERAL_DC , const zend_literal *literal_key
153 # define PHP_HTTP_ZEND_LITERAL_CC , (literal_key)
154 # define PHP_HTTP_ZEND_LITERAL_CCN , NULL
157 #if PHP_VERSION_ID < 50700
158 # define z_is_true zend_is_true
160 # define z_is_true(z) zend_is_true(z TSRMLS_CC)
163 #define INIT_PZVAL_ARRAY(zv, ht) \
166 Z_TYPE_P(zv) = IS_ARRAY; \
167 Z_ARRVAL_P(zv) = (ht); \
170 static inline zval
*php_http_zconv(int type
, zval
*z
)
173 case IS_NULL
: convert_to_null_ex(&z
); break;
174 case IS_BOOL
: convert_to_boolean_ex(&z
); break;
175 case IS_LONG
: convert_to_long_ex(&z
); break;
176 case IS_DOUBLE
: convert_to_double_ex(&z
); break;
177 case IS_STRING
: convert_to_string_ex(&z
); break;
178 case IS_ARRAY
: convert_to_array_ex(&z
); break;
179 case IS_OBJECT
: convert_to_object_ex(&z
); break;
184 static inline zval
*php_http_ztyp(int type
, zval
*z
)
186 SEPARATE_ARG_IF_REF(z
);
187 return (Z_TYPE_P(z
) == type
) ? z
: php_http_zconv(type
, z
);
190 static inline zval
*php_http_zsep(zend_bool add_ref
, int type
, zval
*z
)
195 if (Z_TYPE_P(z
) != type
) {
196 return php_http_zconv(type
, z
);
198 SEPARATE_ZVAL_IF_NOT_REF(&z
);
203 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
)
205 zend_ini_entry
*ini_entry
;
207 if (SUCCESS
== zend_hash_find(EG(ini_directives
), name_str
, name_len
+ 1, (void *) &ini_entry
)) {
208 if (orig
&& ini_entry
->modified
) {
209 *value_str
= ini_entry
->orig_value
;
210 *value_len
= (size_t) ini_entry
->orig_value_length
;
212 *value_str
= ini_entry
->value
;
213 *value_len
= (size_t) ini_entry
->value_length
;
220 /* return object(values) */
221 #define RETVAL_OBJECT(o, addref) \
222 RETVAL_OBJVAL((o)->value.obj, addref)
223 #define RETURN_OBJECT(o, addref) \
224 RETVAL_OBJECT(o, addref); \
226 #define RETVAL_OBJVAL(ov, addref) \
227 ZVAL_OBJVAL(return_value, ov, addref)
228 #define RETURN_OBJVAL(ov, addref) \
229 RETVAL_OBJVAL(ov, addref); \
231 #define ZVAL_OBJVAL(zv, ov, addref) \
232 (zv)->type = IS_OBJECT; \
233 (zv)->value.obj = (ov);\
234 if (addref && Z_OBJ_HT_P(zv)->add_ref) { \
235 Z_OBJ_HT_P(zv)->add_ref((zv) TSRMLS_CC); \
238 #define Z_OBJ_DELREF(z) \
239 if (Z_OBJ_HT(z)->del_ref) { \
240 Z_OBJ_HT(z)->del_ref(&(z) TSRMLS_CC); \
242 #define Z_OBJ_ADDREF(z) \
243 if (Z_OBJ_HT(z)->add_ref) { \
244 Z_OBJ_HT(z)->add_ref(&(z) TSRMLS_CC); \
246 #define Z_OBJ_DELREF_P(z) \
247 if (Z_OBJ_HT_P(z)->del_ref) { \
248 Z_OBJ_HT_P(z)->del_ref((z) TSRMLS_CC); \
250 #define Z_OBJ_ADDREF_P(z) \
251 if (Z_OBJ_HT_P(z)->add_ref) { \
252 Z_OBJ_HT_P(z)->add_ref((z) TSRMLS_CC); \
254 #define Z_OBJ_DELREF_PP(z) \
255 if (Z_OBJ_HT_PP(z)->del_ref) { \
256 Z_OBJ_HT_PP(z)->del_ref(*(z) TSRMLS_CC); \
258 #define Z_OBJ_ADDREF_PP(z) \
259 if (Z_OBJ_HT_PP(z)->add_ref) { \
260 Z_OBJ_HT_PP(z)->add_ref(*(z) TSRMLS_CC); \
263 #define EMPTY_FUNCTION_ENTRY {NULL, NULL, NULL, 0, 0}
265 #define PHP_MINIT_CALL(func) PHP_MINIT(func)(INIT_FUNC_ARGS_PASSTHRU)
266 #define PHP_RINIT_CALL(func) PHP_RINIT(func)(INIT_FUNC_ARGS_PASSTHRU)
267 #define PHP_MSHUTDOWN_CALL(func) PHP_MSHUTDOWN(func)(SHUTDOWN_FUNC_ARGS_PASSTHRU)
268 #define PHP_RSHUTDOWN_CALL(func) PHP_RSHUTDOWN(func)(SHUTDOWN_FUNC_ARGS_PASSTHRU)
272 #ifndef HASH_KEY_NON_EXISTENT
273 # define HASH_KEY_NON_EXISTENT HASH_KEY_NON_EXISTANT
276 PHP_HTTP_API
unsigned php_http_array_list(HashTable
*ht TSRMLS_DC
, unsigned argc
, ...);
278 typedef struct php_http_array_hashkey
{
284 } php_http_array_hashkey_t
;
285 #define php_http_array_hashkey_init(dup) {NULL, 0, 0, (dup), 0}
287 static inline void php_http_array_hashkey_stringify(php_http_array_hashkey_t
*key
)
289 if (key
->type
!= HASH_KEY_IS_STRING
) {
290 key
->len
= spprintf(&key
->str
, 0, "%lu", key
->num
) + 1;
294 static inline void php_http_array_hashkey_stringfree(php_http_array_hashkey_t
*key
)
296 if (key
->type
!= HASH_KEY_IS_STRING
|| key
->dup
) {
301 #define FOREACH_VAL(pos, array, val) FOREACH_HASH_VAL(pos, HASH_OF(array), val)
302 #define FOREACH_HASH_VAL(pos, hash, val) \
303 for ( zend_hash_internal_pointer_reset_ex(hash, &pos); \
304 zend_hash_get_current_data_ex(hash, (void *) &val, &pos) == SUCCESS; \
305 zend_hash_move_forward_ex(hash, &pos))
307 #define FOREACH_KEY(pos, array, key) FOREACH_HASH_KEY(pos, HASH_OF(array), key)
308 #define FOREACH_HASH_KEY(pos, hash, _key) \
309 for ( zend_hash_internal_pointer_reset_ex(hash, &pos); \
310 ((_key).type = zend_hash_get_current_key_ex(hash, &(_key).str, &(_key).len, &(_key).num, (zend_bool) (_key).dup, &pos)) != HASH_KEY_NON_EXISTANT; \
311 zend_hash_move_forward_ex(hash, &pos)) \
313 #define FOREACH_KEYVAL(pos, array, key, val) FOREACH_HASH_KEYVAL(pos, HASH_OF(array), key, val)
314 #define FOREACH_HASH_KEYVAL(pos, hash, _key, val) \
315 for ( zend_hash_internal_pointer_reset_ex(hash, &pos); \
316 ((_key).type = zend_hash_get_current_key_ex(hash, &(_key).str, &(_key).len, &(_key).num, (zend_bool) (_key).dup, &pos)) != HASH_KEY_NON_EXISTANT && \
317 zend_hash_get_current_data_ex(hash, (void *) &val, &pos) == SUCCESS; \
318 zend_hash_move_forward_ex(hash, &pos))
320 #define array_copy(src, dst) zend_hash_copy(dst, src, (copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval *))
321 #define array_copy_strings(src, dst) zend_hash_copy(dst, src, php_http_array_copy_strings, NULL, sizeof(zval *))
322 #define ARRAY_JOIN_STRONLY 0x01
323 #define ARRAY_JOIN_PRETTIFY 0x02
324 #define ARRAY_JOIN_STRINGIFY 0x04
325 #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)
327 void php_http_array_copy_strings(void *zpp
);
328 int php_http_array_apply_append_func(void *pDest TSRMLS_DC
, int num_args
, va_list args
, zend_hash_key
*hash_key
);
329 int php_http_array_apply_merge_func(void *pDest TSRMLS_DC
, int num_args
, va_list args
, zend_hash_key
*hash_key
);
333 typedef size_t (*php_http_pass_callback_t
)(void *cb_arg
, const char *str
, size_t len
);
334 typedef size_t (*php_http_pass_php_http_buffer_callback_t
)(void *cb_arg
, php_http_buffer_t
*str
);
335 typedef size_t (*php_http_pass_format_callback_t
)(void *cb_arg
, const char *fmt
, ...);
337 typedef struct php_http_pass_fcall_arg
{
340 zend_fcall_info_cache fcc
;
344 } php_http_pass_fcall_arg_t
;
346 PHP_HTTP_API
size_t php_http_pass_fcall_callback(void *cb_arg
, const char *str
, size_t len
);
355 * vim600: noet sw=4 ts=4 fdm=marker
356 * vim<600: noet sw=4 ts=4