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
php_http_locate_eol(const char * line,int * eol_len)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
php_http_locate_bin_eol(const char * bin,size_t len,int * eol_len)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 # if PHP_VERSION_ID >= 70500
103 # 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(Z_OBJ_P(p)) : NULL))))
104 # else
105 # 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))))
106 # endif
107 #endif
108
109 #ifndef GC_SET_REFCOUNT
110 # define GC_SET_REFCOUNT(gc, rc) GC_REFCOUNT(gc) = rc
111 #endif
112 #ifndef GC_ADDREF
113 # define GC_ADDREF(gc) ++GC_REFCOUNT(gc)
114 #endif
115 #ifndef GC_DELREF
116 # define GC_DELREF(gc) --GC_REFCOUNT(gc)
117 #endif
118
119 #ifdef ZEND_HASH_GET_APPLY_COUNT
120 # define HT_IS_RECURSIVE(ht) (ZEND_HASH_GET_APPLY_COUNT(ht) > 0)
121 #else
122 # define HT_IS_RECURSIVE(ht) GC_IS_RECURSIVE(ht)
123 #endif
124 #ifdef ZEND_HASH_INC_APPLY_COUNT
125 # define HT_PROTECT_RECURSION(ht) ZEND_HASH_INC_APPLY_COUNT(ht)
126 #else
127 # define HT_PROTECT_RECURSION(ht) GC_PROTECT_RECURSION(ht)
128 #endif
129 #ifdef ZEND_HASH_DEC_APPLY_COUNT
130 # define HT_UNPROTECT_RECURSION(ht) ZEND_HASH_DEC_APPLY_COUNT(ht)
131 #else
132 # define HT_UNPROTECT_RECURSION(ht) GC_UNPROTECT_RECURSION(ht)
133 #endif
134
135 #if PHP_VERSION_ID >= 70400
136 # define PHP_WRITE_PROP_HANDLER_TYPE zval *
137 # define PHP_WRITE_PROP_HANDLER_RETURN(v) return v
138 #else
139 # define PHP_WRITE_PROP_HANDLER_TYPE void
140 # define PHP_WRITE_PROP_HANDLER_RETURN(v)
141 #endif
142
PHP_HTTP_OBJ(zend_object * zo,zval * zv)143 static inline void *PHP_HTTP_OBJ(zend_object *zo, zval *zv)
144 {
145 if (!zo) {
146 zo = Z_OBJ_P(zv);
147 }
148 return (char *) zo - zo->handlers->offset;
149 }
150
php_http_cs2zs(char * s,size_t l)151 static inline zend_string *php_http_cs2zs(char *s, size_t l)
152 {
153 zend_string *str = erealloc(s, sizeof(*str) + l);
154
155 memmove(str->val, str, l);
156 str->val[l] = 0;
157 str->len = l;
158 str->h = 0;
159
160 GC_SET_REFCOUNT(str, 1);
161 GC_TYPE_INFO(str) = IS_STRING;
162
163 return str;
164 }
165
php_http_ini_entry(const char * name_str,size_t name_len,const char ** val_str,size_t * val_len,zend_bool orig)166 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)
167 {
168 zend_ini_entry *ini_entry;
169
170 if ((ini_entry = zend_hash_str_find_ptr(EG(ini_directives), name_str, name_len))) {
171 if (orig && ini_entry->modified) {
172 *val_str = ini_entry->orig_value->val;
173 *val_len = ini_entry->orig_value->len;
174 } else {
175 *val_str = ini_entry->value->val;
176 *val_len = ini_entry->value->len;
177 }
178 return SUCCESS;
179 }
180 return FAILURE;
181 }
182
183 #define Z_ISUSER(zv) (Z_TYPE(zv) <= 10)
184 #define Z_ISUSER_P(zvp) Z_ISUSER(*(zvp))
185
186 /* return object(values) */
187 #define ZVAL_OBJECT(z, o, addref) \
188 ZVAL_OBJ(z, o); \
189 if (addref) { \
190 Z_ADDREF_P(z); \
191 }
192 #define RETVAL_OBJECT(o, addref) \
193 ZVAL_OBJECT(return_value, o, addref)
194 #define RETURN_OBJECT(o, addref) \
195 RETVAL_OBJECT(o, addref); \
196 return
197
198 #define EMPTY_FUNCTION_ENTRY {NULL, NULL, NULL, 0, 0}
199
200 #define PHP_MINIT_CALL(func) PHP_MINIT(func)(INIT_FUNC_ARGS_PASSTHRU)
201 #define PHP_RINIT_CALL(func) PHP_RINIT(func)(INIT_FUNC_ARGS_PASSTHRU)
202 #define PHP_MSHUTDOWN_CALL(func) PHP_MSHUTDOWN(func)(SHUTDOWN_FUNC_ARGS_PASSTHRU)
203 #define PHP_RSHUTDOWN_CALL(func) PHP_RSHUTDOWN(func)(SHUTDOWN_FUNC_ARGS_PASSTHRU)
204
205 /* ARRAYS */
206
207 PHP_HTTP_API unsigned php_http_array_list(HashTable *ht, unsigned argc, ...);
208
209 typedef struct php_http_arrkey {
210 zend_ulong h;
211 zend_string *key;
212 unsigned allocated:1;
213 unsigned stringified:1;
214 } php_http_arrkey_t;
215
php_http_arrkey_stringify(php_http_arrkey_t * arrkey,zend_hash_key * key)216 static inline void *php_http_arrkey_stringify(php_http_arrkey_t *arrkey, zend_hash_key *key)
217 {
218 if (arrkey) {
219 arrkey->allocated = 0;
220 } else {
221 arrkey = emalloc(sizeof(*arrkey));
222 arrkey->allocated = 1;
223 }
224
225 if (key) {
226 memcpy(arrkey, key, sizeof(*key));
227 }
228 if ((arrkey->stringified = !arrkey->key)) {
229 arrkey->key = zend_long_to_str(arrkey->h);
230 }
231 return arrkey;
232 }
233
php_http_arrkey_dtor(php_http_arrkey_t * arrkey)234 static inline void php_http_arrkey_dtor(php_http_arrkey_t *arrkey)
235 {
236 if (arrkey->stringified) {
237 zend_string_release(arrkey->key);
238 }
239 if (arrkey->allocated) {
240 efree(arrkey);
241 }
242 }
243
244 #define array_copy(src, dst) zend_hash_copy(dst, src, (copy_ctor_func_t) zval_add_ref)
245 #define array_copy_strings(src, dst) zend_hash_copy(dst, src, php_http_array_copy_strings)
246 #define ARRAY_JOIN_STRONLY 0x01
247 #define ARRAY_JOIN_PRETTIFY 0x02
248 #define ARRAY_JOIN_STRINGIFY 0x04
249 #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)
250
251 void php_http_array_copy_strings(zval *zp);
252 int php_http_array_apply_append_func(zval *pDest, int num_args, va_list args, zend_hash_key *hash_key);
253 int php_http_array_apply_merge_func(zval *pDest, int num_args, va_list args, zend_hash_key *hash_key);
254
255 /* PASS CALLBACK */
256
257 typedef size_t (*php_http_pass_callback_t)(void *cb_arg, const char *str, size_t len);
258 typedef size_t (*php_http_pass_php_http_buffer_callback_t)(void *cb_arg, php_http_buffer_t *str);
259 typedef size_t (*php_http_pass_format_callback_t)(void *cb_arg, const char *fmt, ...);
260
261 typedef struct php_http_pass_fcall_arg {
262 zval fcz;
263 zend_fcall_info fci;
264 zend_fcall_info_cache fcc;
265 } php_http_pass_fcall_arg_t;
266
267 PHP_HTTP_API size_t php_http_pass_fcall_callback(void *cb_arg, const char *str, size_t len);
268
269 #endif
270
271 /*
272 * Local variables:
273 * tab-width: 4
274 * c-basic-offset: 4
275 * End:
276 * vim600: noet sw=4 ts=4 fdm=marker
277 * vim<600: noet sw=4 ts=4
278 */
279