- consistent usage of HTTP_G macro (only)
[m6w6/ext-http] / http_api.c
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-2006, Michael Wallner <mike@php.net> |
10 +--------------------------------------------------------------------+
11 */
12
13 /* $Id$ */
14
15 #define HTTP_WANT_SAPI
16 #include "php_http.h"
17
18 #include "php_output.h"
19 #include "ext/standard/url.h"
20
21 #include "php_http_api.h"
22 #include "php_http_send_api.h"
23
24 #ifdef ZEND_ENGINE_2
25 # include "php_http_exception_object.h"
26 #endif
27
28 PHP_MINIT_FUNCTION(http_support)
29 {
30 HTTP_LONG_CONSTANT("HTTP_SUPPORT", HTTP_SUPPORT);
31 HTTP_LONG_CONSTANT("HTTP_SUPPORT_REQUESTS", HTTP_SUPPORT_REQUESTS);
32 HTTP_LONG_CONSTANT("HTTP_SUPPORT_MAGICMIME", HTTP_SUPPORT_MAGICMIME);
33 HTTP_LONG_CONSTANT("HTTP_SUPPORT_ENCODINGS", HTTP_SUPPORT_ENCODINGS);
34 HTTP_LONG_CONSTANT("HTTP_SUPPORT_SSLREQUESTS", HTTP_SUPPORT_SSLREQUESTS);
35
36 return SUCCESS;
37 }
38
39 PHP_HTTP_API long _http_support(long feature)
40 {
41 long support = HTTP_SUPPORT;
42
43 #ifdef HTTP_HAVE_CURL
44 support |= HTTP_SUPPORT_REQUESTS;
45 # ifdef HTTP_HAVE_SSL
46 support |= HTTP_SUPPORT_SSLREQUESTS;
47 # endif
48 #endif
49 #ifdef HTTP_HAVE_MAGIC
50 support |= HTTP_SUPPORT_MAGICMIME;
51 #endif
52 #ifdef HTTP_HAVE_ZLIB
53 support |= HTTP_SUPPORT_ENCODINGS;
54 #endif
55
56 if (feature) {
57 return (feature == (support & feature));
58 }
59 return support;
60 }
61
62 /* char *pretty_key(char *, size_t, zend_bool, zend_bool) */
63 char *_http_pretty_key(char *key, size_t key_len, zend_bool uctitle, zend_bool xhyphen)
64 {
65 if (key && key_len) {
66 size_t i;
67 int wasalpha;
68 if ((wasalpha = isalpha((int) key[0]))) {
69 key[0] = (char) (uctitle ? toupper((int) key[0]) : tolower((int) key[0]));
70 }
71 for (i = 1; i < key_len; i++) {
72 if (isalpha((int) key[i])) {
73 key[i] = (char) (((!wasalpha) && uctitle) ? toupper((int) key[i]) : tolower((int) key[i]));
74 wasalpha = 1;
75 } else {
76 if (xhyphen && (key[i] == '_')) {
77 key[i] = '-';
78 }
79 wasalpha = 0;
80 }
81 }
82 }
83 return key;
84 }
85 /* }}} */
86
87 /* {{{ */
88 void _http_key_list_default_decoder(const char *encoded, size_t encoded_len, char **decoded, size_t *decoded_len TSRMLS_DC)
89 {
90 *decoded = estrndup(encoded, encoded_len);
91 *decoded_len = (size_t) php_url_decode(*decoded, encoded_len);
92 }
93 /* }}} */
94
95 /* {{{ */
96 STATUS _http_parse_key_list(const char *list, HashTable *items, char separator, http_key_list_decode_t decode, zend_bool first_entry_is_name_value_pair TSRMLS_DC)
97 {
98 const char *key = list, *val = NULL;
99 int vallen = 0, keylen = 0, done = 0;
100 zval array;
101
102 INIT_ZARR(array, items);
103
104 if (!(val = strchr(list, '='))) {
105 return FAILURE;
106 }
107
108 #define HTTP_KEYLIST_VAL(array, k, str, len) \
109 { \
110 char *decoded; \
111 size_t decoded_len; \
112 if (decode) { \
113 decode(str, len, &decoded, &decoded_len TSRMLS_CC); \
114 } else { \
115 decoded_len = len; \
116 decoded = estrndup(str, decoded_len); \
117 } \
118 add_assoc_stringl(array, k, decoded, decoded_len, 0); \
119 }
120 #define HTTP_KEYLIST_FIXKEY() \
121 { \
122 while (isspace(*key)) ++key; \
123 keylen = val - key; \
124 while (isspace(key[keylen - 1])) --keylen; \
125 }
126 #define HTTP_KEYLIST_FIXVAL() \
127 { \
128 ++val; \
129 while (isspace(*val)) ++val; \
130 vallen = key - val; \
131 while (isspace(val[vallen - 1])) --vallen; \
132 }
133
134 HTTP_KEYLIST_FIXKEY();
135
136 if (first_entry_is_name_value_pair) {
137 HTTP_KEYLIST_VAL(&array, "name", key, keylen);
138
139 /* just one name=value */
140 if (!(key = strchr(val, separator))) {
141 key = val + strlen(val);
142 HTTP_KEYLIST_FIXVAL();
143 HTTP_KEYLIST_VAL(&array, "value", val, vallen);
144 return SUCCESS;
145 }
146 /* additional info appended */
147 else {
148 HTTP_KEYLIST_FIXVAL();
149 HTTP_KEYLIST_VAL(&array, "value", val, vallen);
150 }
151 }
152
153 do {
154 char *keydup = NULL;
155
156 if (!(val = strchr(key, '='))) {
157 break;
158 }
159
160 /* start at 0 if first_entry_is_name_value_pair==0 */
161 if (zend_hash_num_elements(items)) {
162 ++key;
163 }
164
165 HTTP_KEYLIST_FIXKEY();
166 keydup = estrndup(key, keylen);
167 if (!(key = strchr(val, separator))) {
168 done = 1;
169 key = val + strlen(val);
170 }
171 HTTP_KEYLIST_FIXVAL();
172 HTTP_KEYLIST_VAL(&array, keydup, val, vallen);
173 efree(keydup);
174 } while (!done);
175
176 return SUCCESS;
177 }
178 /* }}} */
179
180 /* {{{ void http_error(long, long, char*) */
181 void _http_error_ex(long type TSRMLS_DC, long code, const char *format, ...)
182 {
183 va_list args;
184
185 va_start(args, format);
186 #ifdef ZEND_ENGINE_2
187 if ((type == E_THROW) || (PG(error_handling) == EH_THROW)) {
188 char *message;
189
190 vspprintf(&message, 0, format, args);
191 zend_throw_exception(http_exception_get_for_code(code), message, code TSRMLS_CC);
192 efree(message);
193 } else
194 #endif
195 php_verror(NULL, "", type, format, args TSRMLS_CC);
196 va_end(args);
197 }
198 /* }}} */
199
200 /* {{{ void http_log(char *, char *, char *) */
201 void _http_log_ex(char *file, const char *ident, const char *message TSRMLS_DC)
202 {
203 time_t now;
204 struct tm nowtm;
205 char datetime[20] = {0};
206
207 now = HTTP_GET_REQUEST_TIME();
208 strftime(datetime, sizeof(datetime), "%Y-%m-%d %H:%M:%S", php_localtime_r(&now, &nowtm));
209
210 #define HTTP_LOG_WRITE(file, type, msg) \
211 if (file && *file) { \
212 php_stream *log = php_stream_open_wrapper(file, "ab", REPORT_ERRORS|ENFORCE_SAFE_MODE, NULL); \
213 \
214 if (log) { \
215 php_stream_printf(log TSRMLS_CC, "%s\t[%s]\t%s\t<%s>%s", datetime, type, msg, SG(request_info).request_uri, PHP_EOL); \
216 php_stream_close(log); \
217 } \
218 \
219 }
220
221 HTTP_LOG_WRITE(file, ident, message);
222 HTTP_LOG_WRITE(HTTP_G->log.composite, ident, message);
223 }
224 /* }}} */
225
226 static void http_ob_blackhole(char *output, uint output_len, char **handled_output, uint *handled_output_len, int mode TSRMLS_DC)
227 {
228 *handled_output = ecalloc(1,1);
229 *handled_output_len = 0;
230 }
231
232 /* {{{ STATUS http_exit(int, char*, char*) */
233 STATUS _http_exit_ex(int status, char *header, char *body, zend_bool send_header TSRMLS_DC)
234 {
235 if ( (send_header && (SUCCESS != http_send_status_header(status, header))) ||
236 (!send_header && status && (SUCCESS != http_send_status(status)))) {
237 http_error_ex(HE_WARNING, HTTP_E_HEADER, "Failed to exit with status/header: %d - %s", status, header ? header : "");
238 STR_FREE(header);
239 STR_FREE(body);
240 return FAILURE;
241 }
242
243 php_end_ob_buffers(0 TSRMLS_CC);
244 if ((SUCCESS == sapi_send_headers(TSRMLS_C)) && body) {
245 PHPWRITE(body, strlen(body));
246 }
247
248 switch (status)
249 {
250 case 301: http_log(HTTP_G->log.redirect, "301-REDIRECT", header); break;
251 case 302: http_log(HTTP_G->log.redirect, "302-REDIRECT", header); break;
252 case 303: http_log(HTTP_G->log.redirect, "303-REDIRECT", header); break;
253 case 305: http_log(HTTP_G->log.redirect, "305-REDIRECT", header); break;
254 case 307: http_log(HTTP_G->log.redirect, "307-REDIRECT", header); break;
255 case 304: http_log(HTTP_G->log.cache, "304-CACHE", header); break;
256 case 405: http_log(HTTP_G->log.allowed_methods, "405-ALLOWED", header); break;
257 default: http_log(NULL, header, body); break;
258 }
259
260 STR_FREE(header);
261 STR_FREE(body);
262
263 if (HTTP_G->force_exit) {
264 zend_bailout();
265 } else {
266 php_ob_set_internal_handler(http_ob_blackhole, 4096, "blackhole", 0 TSRMLS_CC);
267 }
268
269 return SUCCESS;
270 }
271 /* }}} */
272
273 /* {{{ STATUS http_check_method(char *) */
274 STATUS _http_check_method_ex(const char *method, const char *methods)
275 {
276 const char *found;
277
278 if ( (found = strstr(methods, method)) &&
279 (found == method || !isalpha(found[-1])) &&
280 (strlen(found) >= strlen(method) && !isalpha(found[strlen(method)]))) {
281 return SUCCESS;
282 }
283 return FAILURE;
284 }
285 /* }}} */
286
287 /* {{{ zval *http_get_server_var_ex(char *, size_t) */
288 PHP_HTTP_API zval *_http_get_server_var_ex(const char *key, size_t key_size, zend_bool check TSRMLS_DC)
289 {
290 zval **hsv;
291 zval **var;
292
293 if ((SUCCESS != zend_hash_find(&EG(symbol_table), "_SERVER", sizeof("_SERVER"), (void **) &hsv)) || (Z_TYPE_PP(hsv) != IS_ARRAY)) {
294 return NULL;
295 }
296 if ((SUCCESS != zend_hash_find(Z_ARRVAL_PP(hsv), (char *) key, key_size, (void **) &var)) || (Z_TYPE_PP(var) != IS_STRING)) {
297 return NULL;
298 }
299 if (check && !(Z_STRVAL_PP(var) && Z_STRLEN_PP(var))) {
300 return NULL;
301 }
302 return *var;
303 }
304 /* }}} */
305
306 /* {{{ STATUS http_get_request_body(char **, size_t *) */
307 PHP_HTTP_API STATUS _http_get_request_body_ex(char **body, size_t *length, zend_bool dup TSRMLS_DC)
308 {
309 *length = 0;
310 *body = NULL;
311
312 if (SG(request_info).raw_post_data) {
313 *length = SG(request_info).raw_post_data_length;
314 *body = SG(request_info).raw_post_data;
315
316 if (dup) {
317 *body = estrndup(*body, *length);
318 }
319 return SUCCESS;
320 } else if (sapi_module.read_post && !HTTP_G->read_post_data) {
321 char buf[4096];
322 int len;
323
324 HTTP_G->read_post_data = 1;
325
326 while (0 < (len = sapi_module.read_post(buf, sizeof(buf) TSRMLS_CC))) {
327 *body = erealloc(*body, *length + len + 1);
328 memcpy(*body + *length, buf, len);
329 *length += len;
330 (*body)[*length] = '\0';
331 }
332
333 /* check for error */
334 if (len < 0) {
335 STR_FREE(*body);
336 *length = 0;
337 return FAILURE;
338 }
339
340 SG(request_info).raw_post_data = *body;
341 SG(request_info).raw_post_data_length = *length;
342
343 if (dup) {
344 *body = estrndup(*body, *length);
345 }
346 return SUCCESS;
347 }
348
349 return FAILURE;
350 }
351 /* }}} */
352
353 /* {{{ php_stream *_http_get_request_body_stream(void) */
354 PHP_HTTP_API php_stream *_http_get_request_body_stream(TSRMLS_D)
355 {
356 php_stream *s = NULL;
357
358 if (SG(request_info).raw_post_data) {
359 s = php_stream_open_wrapper("php://input", "rb", 0, NULL);
360 } else if (sapi_module.read_post && !HTTP_G->read_post_data) {
361 HTTP_G->read_post_data = 1;
362
363 if ((s = php_stream_temp_new())) {
364 char buf[4096];
365 int len;
366
367 while (0 < (len = sapi_module.read_post(buf, sizeof(buf) TSRMLS_CC))) {
368 php_stream_write(s, buf, len);
369 }
370
371 if (len < 0) {
372 php_stream_close(s);
373 s = NULL;
374 } else {
375 php_stream_rewind(s);
376 }
377 }
378 }
379
380 return s;
381 }
382 /* }}} */
383
384 /*
385 * Local variables:
386 * tab-width: 4
387 * c-basic-offset: 4
388 * End:
389 * vim600: noet sw=4 ts=4 fdm=marker
390 * vim<600: noet sw=4 ts=4
391 */
392