- fix overload guards leaks
[m6w6/ext-http] / http_request_object.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_CURL
16 #include "php_http.h"
17
18 #if defined(ZEND_ENGINE_2) && defined(HTTP_HAVE_CURL)
19
20 #include "zend_interfaces.h"
21
22 #include "php_http_api.h"
23 #include "php_http_cookie_api.h"
24 #include "php_http_exception_object.h"
25 #include "php_http_message_api.h"
26 #include "php_http_message_object.h"
27 #include "php_http_request_api.h"
28 #include "php_http_request_object.h"
29 #include "php_http_request_pool_api.h"
30 #include "php_http_url_api.h"
31
32 #define HTTP_BEGIN_ARGS(method, req_args) HTTP_BEGIN_ARGS_EX(HttpRequest, method, 0, req_args)
33 #define HTTP_EMPTY_ARGS(method) HTTP_EMPTY_ARGS_EX(HttpRequest, method, 0)
34 #define HTTP_REQUEST_ME(method, visibility) PHP_ME(HttpRequest, method, HTTP_ARGS(HttpRequest, method), visibility)
35 #define HTTP_REQUEST_ALIAS(method, func) HTTP_STATIC_ME_ALIAS(method, func, HTTP_ARGS(HttpRequest, method))
36
37 HTTP_BEGIN_ARGS(__construct, 0)
38 HTTP_ARG_VAL(url, 0)
39 HTTP_ARG_VAL(method, 0)
40 HTTP_ARG_VAL(options, 0)
41 HTTP_END_ARGS;
42
43 HTTP_EMPTY_ARGS(getOptions);
44 HTTP_BEGIN_ARGS(setOptions, 0)
45 HTTP_ARG_VAL(options, 0)
46 HTTP_END_ARGS;
47
48 HTTP_EMPTY_ARGS(getSslOptions);
49 HTTP_BEGIN_ARGS(setSslOptions, 0)
50 HTTP_ARG_VAL(ssl_options, 0)
51 HTTP_END_ARGS;
52
53 HTTP_BEGIN_ARGS(addSslOptions, 0)
54 HTTP_ARG_VAL(ssl_optins, 0)
55 HTTP_END_ARGS;
56
57 HTTP_EMPTY_ARGS(getHeaders);
58 HTTP_BEGIN_ARGS(setHeaders, 0)
59 HTTP_ARG_VAL(headers, 0)
60 HTTP_END_ARGS;
61
62 HTTP_BEGIN_ARGS(addHeaders, 1)
63 HTTP_ARG_VAL(headers, 0)
64 HTTP_END_ARGS;
65
66 HTTP_EMPTY_ARGS(getCookies);
67 HTTP_BEGIN_ARGS(setCookies, 0)
68 HTTP_ARG_VAL(cookies, 0)
69 HTTP_END_ARGS;
70
71 HTTP_BEGIN_ARGS(addCookies, 1)
72 HTTP_ARG_VAL(cookies, 0)
73 HTTP_END_ARGS;
74
75 HTTP_EMPTY_ARGS(enableCookies);
76 #if HTTP_CURL_VERSION(7,14,1)
77 HTTP_BEGIN_ARGS(resetCookies, 0)
78 HTTP_ARG_VAL(session_only, 0)
79 HTTP_END_ARGS;
80 #endif
81
82 HTTP_EMPTY_ARGS(getUrl);
83 HTTP_BEGIN_ARGS(setUrl, 1)
84 HTTP_ARG_VAL(url, 0)
85 HTTP_END_ARGS;
86
87 HTTP_EMPTY_ARGS(getMethod);
88 HTTP_BEGIN_ARGS(setMethod, 1)
89 HTTP_ARG_VAL(request_method, 0)
90 HTTP_END_ARGS;
91
92 HTTP_EMPTY_ARGS(getContentType);
93 HTTP_BEGIN_ARGS(setContentType, 1)
94 HTTP_ARG_VAL(content_type, 0)
95 HTTP_END_ARGS;
96
97 HTTP_EMPTY_ARGS(getQueryData);
98 HTTP_BEGIN_ARGS(setQueryData, 0)
99 HTTP_ARG_VAL(query_data, 0)
100 HTTP_END_ARGS;
101
102 HTTP_BEGIN_ARGS(addQueryData, 1)
103 HTTP_ARG_VAL(query_data, 0)
104 HTTP_END_ARGS;
105
106 HTTP_EMPTY_ARGS(getPostFields);
107 HTTP_BEGIN_ARGS(setPostFields, 0)
108 HTTP_ARG_VAL(post_fields, 0)
109 HTTP_END_ARGS;
110
111 HTTP_BEGIN_ARGS(addPostFields, 1)
112 HTTP_ARG_VAL(post_fields, 0)
113 HTTP_END_ARGS;
114
115 HTTP_EMPTY_ARGS(getPostFiles);
116 HTTP_BEGIN_ARGS(setPostFiles, 0)
117 HTTP_ARG_VAL(post_files, 0)
118 HTTP_END_ARGS;
119
120 HTTP_BEGIN_ARGS(addPostFile, 2)
121 HTTP_ARG_VAL(formname, 0)
122 HTTP_ARG_VAL(filename, 0)
123 HTTP_ARG_VAL(content_type, 0)
124 HTTP_END_ARGS;
125
126 HTTP_EMPTY_ARGS(getRawPostData);
127 HTTP_BEGIN_ARGS(setRawPostData, 0)
128 HTTP_ARG_VAL(raw_post_data, 0)
129 HTTP_END_ARGS;
130
131 HTTP_BEGIN_ARGS(addRawPostData, 1)
132 HTTP_ARG_VAL(raw_post_data, 0)
133 HTTP_END_ARGS;
134
135 HTTP_EMPTY_ARGS(getPutFile);
136 HTTP_BEGIN_ARGS(setPutFile, 0)
137 HTTP_ARG_VAL(filename, 0)
138 HTTP_END_ARGS;
139
140 HTTP_EMPTY_ARGS(getPutData);
141 HTTP_BEGIN_ARGS(setPutData, 0)
142 HTTP_ARG_VAL(put_data, 0)
143 HTTP_END_ARGS;
144
145 HTTP_BEGIN_ARGS(addPutData, 1)
146 HTTP_ARG_VAL(put_data, 0)
147 HTTP_END_ARGS;
148
149 HTTP_EMPTY_ARGS(getResponseData);
150 HTTP_BEGIN_ARGS(getResponseHeader, 0)
151 HTTP_ARG_VAL(name, 0)
152 HTTP_END_ARGS;
153
154 HTTP_BEGIN_ARGS(getResponseCookies, 0)
155 HTTP_ARG_VAL(flags, 0)
156 HTTP_ARG_VAL(allowed_extras, 0)
157 HTTP_END_ARGS;
158
159 HTTP_EMPTY_ARGS(getResponseBody);
160 HTTP_EMPTY_ARGS(getResponseCode);
161 HTTP_EMPTY_ARGS(getResponseStatus);
162 HTTP_BEGIN_ARGS(getResponseInfo, 0)
163 HTTP_ARG_VAL(name, 0)
164 HTTP_END_ARGS;
165
166 HTTP_EMPTY_ARGS(getResponseMessage);
167 HTTP_EMPTY_ARGS(getRawResponseMessage);
168 HTTP_EMPTY_ARGS(getRequestMessage);
169 HTTP_EMPTY_ARGS(getRawRequestMessage);
170 HTTP_EMPTY_ARGS(getHistory);
171 HTTP_EMPTY_ARGS(clearHistory);
172 HTTP_EMPTY_ARGS(send);
173
174 HTTP_BEGIN_ARGS(get, 1)
175 HTTP_ARG_VAL(url, 0)
176 HTTP_ARG_VAL(options, 0)
177 HTTP_ARG_VAL(info, 1)
178 HTTP_END_ARGS;
179
180 HTTP_BEGIN_ARGS(head, 1)
181 HTTP_ARG_VAL(url, 0)
182 HTTP_ARG_VAL(options, 0)
183 HTTP_ARG_VAL(info, 1)
184 HTTP_END_ARGS;
185
186 HTTP_BEGIN_ARGS(postData, 2)
187 HTTP_ARG_VAL(url, 0)
188 HTTP_ARG_VAL(data, 0)
189 HTTP_ARG_VAL(options, 0)
190 HTTP_ARG_VAL(info, 1)
191 HTTP_END_ARGS;
192
193 HTTP_BEGIN_ARGS(postFields, 2)
194 HTTP_ARG_VAL(url, 0)
195 HTTP_ARG_VAL(data, 0)
196 HTTP_ARG_VAL(options, 0)
197 HTTP_ARG_VAL(info, 1)
198 HTTP_END_ARGS;
199
200 HTTP_BEGIN_ARGS(putData, 2)
201 HTTP_ARG_VAL(url, 0)
202 HTTP_ARG_VAL(data, 0)
203 HTTP_ARG_VAL(options, 0)
204 HTTP_ARG_VAL(info, 1)
205 HTTP_END_ARGS;
206
207 HTTP_BEGIN_ARGS(putFile, 2)
208 HTTP_ARG_VAL(url, 0)
209 HTTP_ARG_VAL(file, 0)
210 HTTP_ARG_VAL(options, 0)
211 HTTP_ARG_VAL(info, 1)
212 HTTP_END_ARGS;
213
214 HTTP_BEGIN_ARGS(putStream, 2)
215 HTTP_ARG_VAL(url, 0)
216 HTTP_ARG_VAL(stream, 0)
217 HTTP_ARG_VAL(options, 0)
218 HTTP_ARG_VAL(info, 1)
219 HTTP_END_ARGS;
220
221 HTTP_BEGIN_ARGS(methodRegister, 1)
222 HTTP_ARG_VAL(method_name, 0)
223 HTTP_END_ARGS;
224
225 HTTP_BEGIN_ARGS(methodUnregister, 1)
226 HTTP_ARG_VAL(method, 0)
227 HTTP_END_ARGS;
228
229 HTTP_BEGIN_ARGS(methodName, 1)
230 HTTP_ARG_VAL(method_id, 0)
231 HTTP_END_ARGS;
232
233 HTTP_BEGIN_ARGS(methodExists, 1)
234 HTTP_ARG_VAL(method, 0)
235 HTTP_END_ARGS;
236
237 #ifdef HAVE_CURL_GETFORMDATA
238 HTTP_BEGIN_ARGS(encodeBody, 2)
239 HTTP_ARG_VAL(fields, 0)
240 HTTP_ARG_VAL(files, 0)
241 HTTP_END_ARGS;
242 #endif
243
244 #define OBJ_PROP_CE http_request_object_ce
245 zend_class_entry *http_request_object_ce;
246 zend_function_entry http_request_object_fe[] = {
247 HTTP_REQUEST_ME(__construct, ZEND_ACC_PUBLIC|ZEND_ACC_CTOR)
248
249 HTTP_REQUEST_ME(setOptions, ZEND_ACC_PUBLIC)
250 HTTP_REQUEST_ME(getOptions, ZEND_ACC_PUBLIC)
251 HTTP_REQUEST_ME(setSslOptions, ZEND_ACC_PUBLIC)
252 HTTP_REQUEST_ME(getSslOptions, ZEND_ACC_PUBLIC)
253 HTTP_REQUEST_ME(addSslOptions, ZEND_ACC_PUBLIC)
254
255 HTTP_REQUEST_ME(addHeaders, ZEND_ACC_PUBLIC)
256 HTTP_REQUEST_ME(getHeaders, ZEND_ACC_PUBLIC)
257 HTTP_REQUEST_ME(setHeaders, ZEND_ACC_PUBLIC)
258
259 HTTP_REQUEST_ME(addCookies, ZEND_ACC_PUBLIC)
260 HTTP_REQUEST_ME(getCookies, ZEND_ACC_PUBLIC)
261 HTTP_REQUEST_ME(setCookies, ZEND_ACC_PUBLIC)
262
263 HTTP_REQUEST_ME(enableCookies, ZEND_ACC_PUBLIC)
264 #if HTTP_CURL_VERSION(7,14,1)
265 HTTP_REQUEST_ME(resetCookies, ZEND_ACC_PUBLIC)
266 #endif
267
268 HTTP_REQUEST_ME(setMethod, ZEND_ACC_PUBLIC)
269 HTTP_REQUEST_ME(getMethod, ZEND_ACC_PUBLIC)
270
271 HTTP_REQUEST_ME(setUrl, ZEND_ACC_PUBLIC)
272 HTTP_REQUEST_ME(getUrl, ZEND_ACC_PUBLIC)
273
274 HTTP_REQUEST_ME(setContentType, ZEND_ACC_PUBLIC)
275 HTTP_REQUEST_ME(getContentType, ZEND_ACC_PUBLIC)
276
277 HTTP_REQUEST_ME(setQueryData, ZEND_ACC_PUBLIC)
278 HTTP_REQUEST_ME(getQueryData, ZEND_ACC_PUBLIC)
279 HTTP_REQUEST_ME(addQueryData, ZEND_ACC_PUBLIC)
280
281 HTTP_REQUEST_ME(setPostFields, ZEND_ACC_PUBLIC)
282 HTTP_REQUEST_ME(getPostFields, ZEND_ACC_PUBLIC)
283 HTTP_REQUEST_ME(addPostFields, ZEND_ACC_PUBLIC)
284
285 HTTP_REQUEST_ME(setRawPostData, ZEND_ACC_PUBLIC)
286 HTTP_REQUEST_ME(getRawPostData, ZEND_ACC_PUBLIC)
287 HTTP_REQUEST_ME(addRawPostData, ZEND_ACC_PUBLIC)
288
289 HTTP_REQUEST_ME(setPostFiles, ZEND_ACC_PUBLIC)
290 HTTP_REQUEST_ME(addPostFile, ZEND_ACC_PUBLIC)
291 HTTP_REQUEST_ME(getPostFiles, ZEND_ACC_PUBLIC)
292
293 HTTP_REQUEST_ME(setPutFile, ZEND_ACC_PUBLIC)
294 HTTP_REQUEST_ME(getPutFile, ZEND_ACC_PUBLIC)
295
296 HTTP_REQUEST_ME(setPutData, ZEND_ACC_PUBLIC)
297 HTTP_REQUEST_ME(getPutData, ZEND_ACC_PUBLIC)
298 HTTP_REQUEST_ME(addPutData, ZEND_ACC_PUBLIC)
299
300 HTTP_REQUEST_ME(send, ZEND_ACC_PUBLIC)
301
302 HTTP_REQUEST_ME(getResponseData, ZEND_ACC_PUBLIC)
303 HTTP_REQUEST_ME(getResponseHeader, ZEND_ACC_PUBLIC)
304 HTTP_REQUEST_ME(getResponseCookies, ZEND_ACC_PUBLIC)
305 HTTP_REQUEST_ME(getResponseCode, ZEND_ACC_PUBLIC)
306 HTTP_REQUEST_ME(getResponseStatus, ZEND_ACC_PUBLIC)
307 HTTP_REQUEST_ME(getResponseBody, ZEND_ACC_PUBLIC)
308 HTTP_REQUEST_ME(getResponseInfo, ZEND_ACC_PUBLIC)
309 HTTP_REQUEST_ME(getResponseMessage, ZEND_ACC_PUBLIC)
310 HTTP_REQUEST_ME(getRawResponseMessage, ZEND_ACC_PUBLIC)
311 HTTP_REQUEST_ME(getRequestMessage, ZEND_ACC_PUBLIC)
312 HTTP_REQUEST_ME(getRawRequestMessage, ZEND_ACC_PUBLIC)
313 HTTP_REQUEST_ME(getHistory, ZEND_ACC_PUBLIC)
314 HTTP_REQUEST_ME(clearHistory, ZEND_ACC_PUBLIC)
315
316 HTTP_REQUEST_ALIAS(get, http_get)
317 HTTP_REQUEST_ALIAS(head, http_head)
318 HTTP_REQUEST_ALIAS(postData, http_post_data)
319 HTTP_REQUEST_ALIAS(postFields, http_post_fields)
320 HTTP_REQUEST_ALIAS(putData, http_put_data)
321 HTTP_REQUEST_ALIAS(putFile, http_put_file)
322 HTTP_REQUEST_ALIAS(putStream, http_put_stream)
323
324 HTTP_REQUEST_ALIAS(methodRegister, http_request_method_register)
325 HTTP_REQUEST_ALIAS(methodUnregister, http_request_method_unregister)
326 HTTP_REQUEST_ALIAS(methodName, http_request_method_name)
327 HTTP_REQUEST_ALIAS(methodExists, http_request_method_exists)
328 #ifdef HAVE_CURL_GETFORMDATA
329 HTTP_REQUEST_ALIAS(encodeBody, http_request_body_encode)
330 #endif
331 EMPTY_FUNCTION_ENTRY
332 };
333 static zend_object_handlers http_request_object_handlers;
334
335 PHP_MINIT_FUNCTION(http_request_object)
336 {
337 HTTP_REGISTER_CLASS_EX(HttpRequest, http_request_object, NULL, 0);
338 http_request_object_handlers.clone_obj = _http_request_object_clone_obj;
339
340 DCL_PROP_N(PRIVATE, options);
341 DCL_PROP_N(PRIVATE, postFields);
342 DCL_PROP_N(PRIVATE, postFiles);
343 DCL_PROP_N(PRIVATE, responseInfo);
344 DCL_PROP_N(PRIVATE, responseData);
345 DCL_PROP_N(PRIVATE, responseMessage);
346 DCL_PROP(PRIVATE, long, responseCode, 0);
347 DCL_PROP(PRIVATE, string, responseStatus, "");
348 DCL_PROP(PRIVATE, long, method, HTTP_GET);
349 DCL_PROP(PRIVATE, string, url, "");
350 DCL_PROP(PRIVATE, string, contentType, "");
351 DCL_PROP(PRIVATE, string, rawPostData, "");
352 DCL_PROP(PRIVATE, string, queryData, "");
353 DCL_PROP(PRIVATE, string, putFile, "");
354 DCL_PROP(PRIVATE, string, putData, "");
355 DCL_PROP_N(PRIVATE, history);
356 DCL_PROP(PUBLIC, bool, recordHistory, 0);
357
358 #ifndef WONKY
359 /*
360 * Request Method Constants
361 */
362 /* HTTP/1.1 */
363 DCL_CONST(long, "METH_GET", HTTP_GET);
364 DCL_CONST(long, "METH_HEAD", HTTP_HEAD);
365 DCL_CONST(long, "METH_POST", HTTP_POST);
366 DCL_CONST(long, "METH_PUT", HTTP_PUT);
367 DCL_CONST(long, "METH_DELETE", HTTP_DELETE);
368 DCL_CONST(long, "METH_OPTIONS", HTTP_OPTIONS);
369 DCL_CONST(long, "METH_TRACE", HTTP_TRACE);
370 DCL_CONST(long, "METH_CONNECT", HTTP_CONNECT);
371 /* WebDAV - RFC 2518 */
372 DCL_CONST(long, "METH_PROPFIND", HTTP_PROPFIND);
373 DCL_CONST(long, "METH_PROPPATCH", HTTP_PROPPATCH);
374 DCL_CONST(long, "METH_MKCOL", HTTP_MKCOL);
375 DCL_CONST(long, "METH_COPY", HTTP_COPY);
376 DCL_CONST(long, "METH_MOVE", HTTP_MOVE);
377 DCL_CONST(long, "METH_LOCK", HTTP_LOCK);
378 DCL_CONST(long, "METH_UNLOCK", HTTP_UNLOCK);
379 /* WebDAV Versioning - RFC 3253 */
380 DCL_CONST(long, "METH_VERSION_CONTROL", HTTP_VERSION_CONTROL);
381 DCL_CONST(long, "METH_REPORT", HTTP_REPORT);
382 DCL_CONST(long, "METH_CHECKOUT", HTTP_CHECKOUT);
383 DCL_CONST(long, "METH_CHECKIN", HTTP_CHECKIN);
384 DCL_CONST(long, "METH_UNCHECKOUT", HTTP_UNCHECKOUT);
385 DCL_CONST(long, "METH_MKWORKSPACE", HTTP_MKWORKSPACE);
386 DCL_CONST(long, "METH_UPDATE", HTTP_UPDATE);
387 DCL_CONST(long, "METH_LABEL", HTTP_LABEL);
388 DCL_CONST(long, "METH_MERGE", HTTP_MERGE);
389 DCL_CONST(long, "METH_BASELINE_CONTROL", HTTP_BASELINE_CONTROL);
390 DCL_CONST(long, "METH_MKACTIVITY", HTTP_MKACTIVITY);
391 /* WebDAV Access Control - RFC 3744 */
392 DCL_CONST(long, "METH_ACL", HTTP_ACL);
393
394 /*
395 * HTTP Protocol Version Constants
396 */
397 DCL_CONST(long, "VERSION_1_0", CURL_HTTP_VERSION_1_0);
398 DCL_CONST(long, "VERSION_1_1", CURL_HTTP_VERSION_1_1);
399 DCL_CONST(long, "VERSION_NONE", CURL_HTTP_VERSION_NONE);
400
401 /*
402 * Auth Constants
403 */
404 DCL_CONST(long, "AUTH_BASIC", CURLAUTH_BASIC);
405 DCL_CONST(long, "AUTH_DIGEST", CURLAUTH_DIGEST);
406 DCL_CONST(long, "AUTH_NTLM", CURLAUTH_NTLM);
407 DCL_CONST(long, "AUTH_ANY", CURLAUTH_ANY);
408
409 /*
410 * Proxy Type Constants
411 */
412 # if HTTP_CURL_VERSION(7,15,2)
413 DCL_CONST(long, "PROXY_SOCKS4", CURLPROXY_SOCKS4);
414 # endif
415 DCL_CONST(long, "PROXY_SOCKS5", CURLPROXY_SOCKS5);
416 DCL_CONST(long, "PROXY_HTTP", CURLPROXY_HTTP);
417 #endif /* WONKY */
418
419 return SUCCESS;
420 }
421
422 zend_object_value _http_request_object_new(zend_class_entry *ce TSRMLS_DC)
423 {
424 return http_request_object_new_ex(ce, NULL, NULL);
425 }
426
427 zend_object_value _http_request_object_new_ex(zend_class_entry *ce, CURL *ch, http_request_object **ptr TSRMLS_DC)
428 {
429 zend_object_value ov;
430 http_request_object *o;
431
432 o = ecalloc(1, sizeof(http_request_object));
433 o->zo.ce = ce;
434 o->request = http_request_init_ex(NULL, ch, 0, NULL);
435
436 if (ptr) {
437 *ptr = o;
438 }
439
440 ALLOC_HASHTABLE(OBJ_PROP(o));
441 zend_hash_init(OBJ_PROP(o), zend_hash_num_elements(&ce->default_properties), NULL, ZVAL_PTR_DTOR, 0);
442 zend_hash_copy(OBJ_PROP(o), &ce->default_properties, (copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval *));
443
444 ov.handle = putObject(http_request_object, o);
445 ov.handlers = &http_request_object_handlers;
446
447 return ov;
448 }
449
450 zend_object_value _http_request_object_clone_obj(zval *this_ptr TSRMLS_DC)
451 {
452 zend_object *old_zo;
453 zend_object_value new_ov;
454 http_request_object *new_obj;
455 getObject(http_request_object, old_obj);
456
457 old_zo = zend_objects_get_address(this_ptr TSRMLS_CC);
458 new_ov = http_request_object_new_ex(old_zo->ce, NULL, &new_obj);
459 if (old_obj->request->ch) {
460 http_curl_init_ex(curl_easy_duphandle(old_obj->request->ch), new_obj->request);
461 }
462
463 zend_objects_clone_members(&new_obj->zo, new_ov, old_zo, Z_OBJ_HANDLE_P(this_ptr) TSRMLS_CC);
464 phpstr_append(&new_obj->request->conv.request, old_obj->request->conv.request.data, old_obj->request->conv.request.used);
465 phpstr_append(&new_obj->request->conv.response, old_obj->request->conv.response.data, old_obj->request->conv.response.used);
466
467 return new_ov;
468 }
469
470 void _http_request_object_free(zend_object *object TSRMLS_DC)
471 {
472 http_request_object *o = (http_request_object *) object;
473
474 http_request_free(&o->request);
475 freeObject(o);
476 }
477
478 #define http_request_object_check_request_content_type(t) _http_request_object_check_request_content_type((t) TSRMLS_CC)
479 static inline void _http_request_object_check_request_content_type(zval *this_ptr TSRMLS_DC)
480 {
481 zval *ctype = GET_PROP(contentType);
482
483 if (Z_STRLEN_P(ctype)) {
484 zval **headers, *opts = GET_PROP(options);
485
486 if ( (Z_TYPE_P(opts) == IS_ARRAY) &&
487 (SUCCESS == zend_hash_find(Z_ARRVAL_P(opts), "headers", sizeof("headers"), (void *) &headers)) &&
488 (Z_TYPE_PP(headers) == IS_ARRAY)) {
489 zval **ct_header;
490
491 /* only override if not already set */
492 if ((SUCCESS != zend_hash_find(Z_ARRVAL_PP(headers), "Content-Type", sizeof("Content-Type"), (void *) &ct_header))) {
493 add_assoc_stringl(*headers, "Content-Type", Z_STRVAL_P(ctype), Z_STRLEN_P(ctype), 1);
494 } else
495 /* or not a string, zero length string or a string of spaces */
496 if ((Z_TYPE_PP(ct_header) != IS_STRING) || !Z_STRLEN_PP(ct_header)) {
497 add_assoc_stringl(*headers, "Content-Type", Z_STRVAL_P(ctype), Z_STRLEN_P(ctype), 1);
498 } else {
499 int i, only_space = 1;
500
501 /* check for spaces only */
502 for (i = 0; i < Z_STRLEN_PP(ct_header); ++i) {
503 if (!isspace(Z_STRVAL_PP(ct_header)[i])) {
504 only_space = 0;
505 break;
506 }
507 }
508 if (only_space) {
509 add_assoc_stringl(*headers, "Content-Type", Z_STRVAL_P(ctype), Z_STRLEN_P(ctype), 1);
510 }
511 }
512 } else {
513 zval *headers;
514
515 MAKE_STD_ZVAL(headers);
516 array_init(headers);
517 add_assoc_stringl(headers, "Content-Type", Z_STRVAL_P(ctype), Z_STRLEN_P(ctype), 1);
518 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL, "addheaders", NULL, headers);
519 zval_ptr_dtor(&headers);
520 }
521 }
522 }
523
524 STATUS _http_request_object_requesthandler(http_request_object *obj, zval *this_ptr TSRMLS_DC)
525 {
526 STATUS status = SUCCESS;
527
528 http_request_reset(obj->request);
529 HTTP_CHECK_CURL_INIT(obj->request->ch, http_curl_init(obj->request), return FAILURE);
530
531 obj->request->url = http_absolute_url(Z_STRVAL_P(GET_PROP(url)));
532
533 switch (obj->request->meth = Z_LVAL_P(GET_PROP(method)))
534 {
535 case HTTP_GET:
536 case HTTP_HEAD:
537 break;
538
539 case HTTP_PUT:
540 {
541 zval *put_data = GET_PROP(putData);
542
543 http_request_object_check_request_content_type(getThis());
544 if (Z_STRLEN_P(put_data)) {
545 obj->request->body = http_request_body_init_ex(obj->request->body, HTTP_REQUEST_BODY_CSTRING,
546 estrndup(Z_STRVAL_P(put_data), Z_STRLEN_P(put_data)), Z_STRLEN_P(put_data), 1);
547 } else {
548 php_stream_statbuf ssb;
549 php_stream *stream = php_stream_open_wrapper_ex(Z_STRVAL_P(GET_PROP(putFile)), "rb", REPORT_ERRORS|ENFORCE_SAFE_MODE, NULL, HTTP_DEFAULT_STREAM_CONTEXT);
550
551 if (stream && !php_stream_stat(stream, &ssb)) {
552 obj->request->body = http_request_body_init_ex(obj->request->body, HTTP_REQUEST_BODY_UPLOADFILE, stream, ssb.sb.st_size, 1);
553 } else {
554 status = FAILURE;
555 }
556 }
557 break;
558 }
559
560 case HTTP_POST:
561 default:
562 {
563 /* check for raw post data */
564 zval *raw_data = GET_PROP(rawPostData);
565
566 if (Z_STRLEN_P(raw_data)) {
567 http_request_object_check_request_content_type(getThis());
568 obj->request->body = http_request_body_init_ex(obj->request->body, HTTP_REQUEST_BODY_CSTRING,
569 estrndup(Z_STRVAL_P(raw_data), Z_STRLEN_P(raw_data)), Z_STRLEN_P(raw_data), 1);
570 } else {
571 zval *zfields = GET_PROP(postFields), *zfiles = GET_PROP(postFiles);
572 HashTable *fields;
573 HashTable *files;
574
575 fields = (Z_TYPE_P(zfields) == IS_ARRAY) ? Z_ARRVAL_P(zfields) : NULL;
576 files = (Z_TYPE_P(zfiles) == IS_ARRAY) ? Z_ARRVAL_P(zfiles) : NULL;
577
578 if ((fields && zend_hash_num_elements(fields)) || (files && zend_hash_num_elements(files))) {
579 if (!(obj->request->body = http_request_body_fill(obj->request->body, fields, files))) {
580 status = FAILURE;
581 }
582 }
583 }
584 break;
585 }
586 }
587
588 if (status == SUCCESS) {
589 zval *qdata = GET_PROP(queryData);
590 zval *options = GET_PROP(options);
591
592 if (Z_STRLEN_P(qdata)) {
593 if (!strchr(obj->request->url, '?')) {
594 strlcat(obj->request->url, "?", HTTP_URL_MAXLEN);
595 } else {
596 strlcat(obj->request->url, "&", HTTP_URL_MAXLEN);
597 }
598 strlcat(obj->request->url, Z_STRVAL_P(qdata), HTTP_URL_MAXLEN);
599 }
600
601 http_request_prepare(obj->request, Z_ARRVAL_P(options));
602
603 /* check if there's a onProgress method and add it as progress callback if one isn't already set */
604 if (zend_hash_exists(&Z_OBJCE_P(getThis())->function_table, "onprogress", sizeof("onprogress"))) {
605 zval **entry, *pcb;
606
607 if ( (Z_TYPE_P(options) != IS_ARRAY)
608 || (SUCCESS != zend_hash_find(Z_ARRVAL_P(options), "onprogress", sizeof("onprogress"), (void *) &entry)
609 || (!zval_is_true(*entry)))) {
610 MAKE_STD_ZVAL(pcb);
611 array_init(pcb);
612 ZVAL_ADDREF(getThis());
613 add_next_index_zval(pcb, getThis());
614 add_next_index_stringl(pcb, "onprogress", lenof("onprogress"), 1);
615 http_request_set_progress_callback(obj->request, pcb);
616 zval_ptr_dtor(&pcb);
617 }
618 }
619 }
620
621 return status;
622 }
623
624 STATUS _http_request_object_responsehandler(http_request_object *obj, zval *this_ptr TSRMLS_DC)
625 {
626 STATUS ret;
627 zval *info;
628 http_message *msg;
629
630 /* always fetch info */
631 MAKE_STD_ZVAL(info);
632 array_init(info);
633 http_request_info(obj->request, Z_ARRVAL_P(info));
634 SET_PROP(responseInfo, info);
635 zval_ptr_dtor(&info);
636
637 /* parse response message */
638 phpstr_fix(&obj->request->conv.request);
639 phpstr_fix(&obj->request->conv.response);
640
641 if ((msg = http_message_parse(PHPSTR_VAL(&obj->request->conv.response), PHPSTR_LEN(&obj->request->conv.response)))) {
642 char *body;
643 size_t body_len;
644 zval *headers, *message, *resp;
645
646 if (zval_is_true(GET_PROP(recordHistory))) {
647 zval *hist, *history = GET_PROP(history);
648 http_message *response = http_message_parse(PHPSTR_VAL(&obj->request->conv.response), PHPSTR_LEN(&obj->request->conv.response));
649 http_message *request = http_message_parse(PHPSTR_VAL(&obj->request->conv.request), PHPSTR_LEN(&obj->request->conv.request));
650
651 MAKE_STD_ZVAL(hist);
652 ZVAL_OBJVAL(hist, http_message_object_new_ex(http_message_object_ce, http_message_interconnect(response, request), NULL), 0);
653 if (Z_TYPE_P(history) == IS_OBJECT) {
654 http_message_object_prepend(hist, history);
655 }
656 SET_PROP(history, hist);
657 zval_ptr_dtor(&hist);
658 }
659
660 UPD_PROP(long, responseCode, msg->http.info.response.code);
661 UPD_PROP(string, responseStatus, msg->http.info.response.status ? msg->http.info.response.status : "");
662
663 MAKE_STD_ZVAL(resp);
664 array_init(resp);
665 MAKE_STD_ZVAL(headers);
666 array_init(headers);
667 zend_hash_copy(Z_ARRVAL_P(headers), &msg->hdrs, (copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval *));
668 add_assoc_zval(resp, "headers", headers);
669 phpstr_data(PHPSTR(msg), &body, &body_len);
670 add_assoc_stringl(resp, "body", body, body_len, 0);
671 SET_PROP(responseData, resp);
672 zval_ptr_dtor(&resp);
673
674 MAKE_STD_ZVAL(message);
675 ZVAL_OBJVAL(message, http_message_object_new_ex(http_message_object_ce, msg, NULL), 0);
676 SET_PROP(responseMessage, message);
677 zval_ptr_dtor(&message);
678
679 ret = SUCCESS;
680 } else {
681 /* update properties with empty values*/
682 zval *resp = GET_PROP(responseData), *znull;
683
684 MAKE_STD_ZVAL(znull);
685 ZVAL_NULL(znull);
686 SET_PROP(responseMessage, znull);
687 zval_ptr_dtor(&znull);
688
689 if (Z_TYPE_P(resp) == IS_ARRAY) {
690 zend_hash_clean(Z_ARRVAL_P(resp));
691 }
692
693 UPD_PROP(long, responseCode, 0);
694 UPD_PROP(string, responseStatus, "");
695
696 /* append request message to history */
697 if (zval_is_true(GET_PROP(recordHistory))) {
698 http_message *request;
699
700 if ((request = http_message_parse(PHPSTR_VAL(&obj->request->conv.request), PHPSTR_LEN(&obj->request->conv.request)))) {
701 zval *hist, *history = GET_PROP(history);
702
703 MAKE_STD_ZVAL(hist);
704 ZVAL_OBJVAL(hist, http_message_object_new_ex(http_message_object_ce, request, NULL), 0);
705 if (Z_TYPE_P(history) == IS_OBJECT) {
706 http_message_object_prepend(hist, history);
707 }
708 SET_PROP(history, hist);
709 zval_ptr_dtor(&hist);
710 }
711 }
712
713 ret = FAILURE;
714 }
715
716 if (!EG(exception) && zend_hash_exists(&Z_OBJCE_P(getThis())->function_table, "onfinish", sizeof("onfinish"))) {
717 zval *param;
718
719 MAKE_STD_ZVAL(param);
720 ZVAL_BOOL(param, ret == SUCCESS);
721 with_error_handling(EH_NORMAL, NULL) {
722 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL, "onfinish", NULL, param);
723 } end_error_handling();
724 zval_ptr_dtor(&param);
725 }
726
727 return ret;
728 }
729
730 static int apply_pretty_key(void *pDest, int num_args, va_list args, zend_hash_key *hash_key)
731 {
732 if (hash_key->nKeyLength > 1) {
733 hash_key->h = zend_get_hash_value(pretty_key(hash_key->arKey, hash_key->nKeyLength - 1, 1, 0), hash_key->nKeyLength);
734 }
735 return ZEND_HASH_APPLY_KEEP;
736 }
737
738 #define http_request_object_set_options_subr(key, ow, pk) \
739 _http_request_object_set_options_subr(INTERNAL_FUNCTION_PARAM_PASSTHRU, (key), sizeof(key), (ow), (pk))
740 static inline void _http_request_object_set_options_subr(INTERNAL_FUNCTION_PARAMETERS, char *key, size_t len, int overwrite, int prettify_keys)
741 {
742 zval *old_opts, *new_opts, *opts = NULL, **entry = NULL;
743
744 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|a/!", &opts)) {
745 RETURN_FALSE;
746 }
747
748 MAKE_STD_ZVAL(new_opts);
749 array_init(new_opts);
750 old_opts = GET_PROP(options);
751 if (Z_TYPE_P(old_opts) == IS_ARRAY) {
752 array_copy(old_opts, new_opts);
753 }
754
755 if (prettify_keys && opts) {
756 zend_hash_apply_with_arguments(Z_ARRVAL_P(opts), apply_pretty_key, 0);
757 }
758 if (SUCCESS == zend_hash_find(Z_ARRVAL_P(new_opts), key, len, (void *) &entry)) {
759 if (overwrite) {
760 zend_hash_clean(Z_ARRVAL_PP(entry));
761 }
762 if (opts && zend_hash_num_elements(Z_ARRVAL_P(opts))) {
763 if (overwrite) {
764 array_copy(opts, *entry);
765 } else {
766 array_merge(opts, *entry);
767 }
768 }
769 } else if (opts) {
770 ZVAL_ADDREF(opts);
771 add_assoc_zval(new_opts, key, opts);
772 }
773 SET_PROP(options, new_opts);
774 zval_ptr_dtor(&new_opts);
775
776 RETURN_TRUE;
777 }
778
779 #define http_request_object_get_options_subr(key) \
780 _http_request_get_options_subr(INTERNAL_FUNCTION_PARAM_PASSTHRU, (key), sizeof(key))
781 static inline void _http_request_get_options_subr(INTERNAL_FUNCTION_PARAMETERS, char *key, size_t len)
782 {
783 NO_ARGS;
784
785 if (return_value_used) {
786 zval *opts, **options;
787
788 opts = GET_PROP(options);
789 array_init(return_value);
790
791 if ( (Z_TYPE_P(opts) == IS_ARRAY) &&
792 (SUCCESS == zend_hash_find(Z_ARRVAL_P(opts), key, len, (void *) &options))) {
793 convert_to_array(*options);
794 array_copy(*options, return_value);
795 }
796 }
797 }
798
799
800 /* ### USERLAND ### */
801
802 /* {{{ proto void HttpRequest::__construct([string url[, int request_method = HTTP_METH_GET[, array options]]])
803 *
804 * Instantiate a new HttpRequest object.
805 *
806 * Accepts a string as optional parameter containing the target request url.
807 * Additionally accepts an optional int parameter specifying the request method
808 * to use and an associative array as optional third parameter which will be
809 * passed to HttpRequest::setOptions().
810 *
811 * Throws HttpException.
812 */
813 PHP_METHOD(HttpRequest, __construct)
814 {
815 char *URL = NULL;
816 int URL_len;
817 long meth = -1;
818 zval *options = NULL;
819
820 SET_EH_THROW_HTTP();
821 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|sla", &URL, &URL_len, &meth, &options)) {
822 if (URL) {
823 UPD_STRL(url, URL, URL_len);
824 }
825 if (meth > -1) {
826 UPD_PROP(long, method, meth);
827 }
828 if (options) {
829 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL, "setoptions", NULL, options);
830 }
831 }
832 SET_EH_NORMAL();
833 }
834 /* }}} */
835
836 /* {{{ proto bool HttpRequest::setOptions([array options])
837 *
838 * Set the request options to use. See http_get() for a full list of available options.
839 *
840 * Accepts an array as optional parameters, which values will overwrite the
841 * currently set request options. If the parameter is empty or omitted,
842 * the options of the HttpRequest object will be reset.
843 *
844 * Returns TRUE on success, or FALSE on failure.
845 */
846 PHP_METHOD(HttpRequest, setOptions)
847 {
848 char *key = NULL;
849 ulong idx = 0;
850 HashPosition pos;
851 zval *opts = NULL, *old_opts, *new_opts, *add_opts, **opt;
852
853 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|a!/", &opts)) {
854 RETURN_FALSE;
855 }
856
857 MAKE_STD_ZVAL(new_opts);
858 array_init(new_opts);
859
860 if (!opts || !zend_hash_num_elements(Z_ARRVAL_P(opts))) {
861 SET_PROP(options, new_opts);
862 zval_ptr_dtor(&new_opts);
863 RETURN_TRUE;
864 }
865
866 MAKE_STD_ZVAL(add_opts);
867 array_init(add_opts);
868 /* some options need extra attention -- thus cannot use array_merge() directly */
869 FOREACH_KEYVAL(pos, opts, key, idx, opt) {
870 if (key) {
871 if (!strcmp(key, "headers")) {
872 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL, "addheaders", NULL, *opt);
873 } else if (!strcmp(key, "cookies")) {
874 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL, "addcookies", NULL, *opt);
875 } else if (!strcmp(key, "ssl")) {
876 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL, "addssloptions", NULL, *opt);
877 } else if ((!strcasecmp(key, "url")) || (!strcasecmp(key, "uri"))) {
878 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL, "seturl", NULL, *opt);
879 } else if (!strcmp(key, "method")) {
880 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL, "setmethod", NULL, *opt);
881 #if HTTP_CURL_VERSION(7,14,1)
882 } else if (!strcmp(key, "resetcookies")) {
883 getObject(http_request_object, obj);
884 http_request_reset_cookies(obj->request, 0);
885 #endif
886 } else if (!strcmp(key, "enablecookies")) {
887 getObject(http_request_object, obj);
888 http_request_enable_cookies(obj->request);
889 } else if (!strcasecmp(key, "recordHistory")) {
890 UPD_PROP(bool, recordHistory, 1);
891 } else {
892 ZVAL_ADDREF(*opt);
893 add_assoc_zval(add_opts, key, *opt);
894 }
895 /* reset */
896 key = NULL;
897 }
898 }
899
900 old_opts = GET_PROP(options);
901 if (Z_TYPE_P(old_opts) == IS_ARRAY) {
902 array_copy(old_opts, new_opts);
903 }
904 array_merge(add_opts, new_opts);
905 SET_PROP(options, new_opts);
906 zval_ptr_dtor(&new_opts);
907 zval_ptr_dtor(&add_opts);
908
909 RETURN_TRUE;
910 }
911 /* }}} */
912
913 /* {{{ proto array HttpRequest::getOptions()
914 *
915 * Get currently set options.
916 *
917 * Returns an associative array containing currently set options.
918 */
919 PHP_METHOD(HttpRequest, getOptions)
920 {
921 NO_ARGS;
922
923 if (return_value_used) {
924 RETURN_PROP(options);
925 }
926 }
927 /* }}} */
928
929 /* {{{ proto bool HttpRequest::setSslOptions([array options])
930 *
931 * Set SSL options.
932 *
933 * Accepts an associative array as parameter containing any SSL specific options.
934 * If the parameter is empty or omitted, the SSL options will be reset.
935 *
936 * Returns TRUE on success, or FALSE on failure.
937 */
938 PHP_METHOD(HttpRequest, setSslOptions)
939 {
940 http_request_object_set_options_subr("ssl", 1, 0);
941 }
942 /* }}} */
943
944 /* {{{ proto bool HttpRequest::addSslOptions(array options)
945 *
946 * Set additional SSL options.
947 *
948 * Expects an associative array as parameter containing additional SSL specific options.
949 *
950 * Returns TRUE on success, or FALSE on failure.
951 */
952 PHP_METHOD(HttpRequest, addSslOptions)
953 {
954 http_request_object_set_options_subr("ssl", 0, 0);
955 }
956 /* }}} */
957
958 /* {{{ proto array HttpRequest::getSslOtpions()
959 *
960 * Get previously set SSL options.
961 *
962 * Returns an associative array containing any previously set SSL options.
963 */
964 PHP_METHOD(HttpRequest, getSslOptions)
965 {
966 http_request_object_get_options_subr("ssl");
967 }
968 /* }}} */
969
970 /* {{{ proto bool HttpRequest::addHeaders(array headers)
971 *
972 * Add request header name/value pairs.
973 *
974 * Expects an associative array as parameter containing additional header
975 * name/value pairs.
976 *
977 * Returns TRUE on success, or FALSE on failure.
978 */
979 PHP_METHOD(HttpRequest, addHeaders)
980 {
981 http_request_object_set_options_subr("headers", 0, 1);
982 }
983
984 /* {{{ proto bool HttpRequest::setHeaders([array headers])
985 *
986 * Set request header name/value pairs.
987 *
988 * Accepts an associative array as parameter containing header name/value pairs.
989 * If the parameter is empty or omitted, all previously set headers will be unset.
990 *
991 * Returns TRUE on success, or FALSE on failure.
992 */
993 PHP_METHOD(HttpRequest, setHeaders)
994 {
995 http_request_object_set_options_subr("headers", 1, 1);
996 }
997 /* }}} */
998
999 /* {{{ proto array HttpRequest::getHeaders()
1000 *
1001 * Get previously set request headers.
1002 *
1003 * Returns an associative array containing all currently set headers.
1004 */
1005 PHP_METHOD(HttpRequest, getHeaders)
1006 {
1007 http_request_object_get_options_subr("headers");
1008 }
1009 /* }}} */
1010
1011 /* {{{ proto bool HttpRequest::setCookies([array cookies])
1012 *
1013 * Set cookies.
1014 *
1015 * Accepts an associative array as parameter containing cookie name/value pairs.
1016 * If the parameter is empty or omitted, all previously set cookies will be unset.
1017 *
1018 * Returns TRUE on success, or FALSE on failure.
1019 */
1020 PHP_METHOD(HttpRequest, setCookies)
1021 {
1022 http_request_object_set_options_subr("cookies", 1, 0);
1023 }
1024 /* }}} */
1025
1026 /* {{{ proto bool HttpRequest::addCookies(array cookies)
1027 *
1028 * Add cookies.
1029 *
1030 * Expects an associative array as parameter containing any cookie name/value
1031 * pairs to add.
1032 *
1033 * Returns TRUE on success, or FALSE on failure.
1034 */
1035 PHP_METHOD(HttpRequest, addCookies)
1036 {
1037 http_request_object_set_options_subr("cookies", 0, 0);
1038 }
1039 /* }}} */
1040
1041 /* {{{ proto array HttpRequest::getCookies()
1042 *
1043 * Get previously set cookies.
1044 *
1045 * Returns an associative array containing any previously set cookies.
1046 */
1047 PHP_METHOD(HttpRequest, getCookies)
1048 {
1049 http_request_object_get_options_subr("cookies");
1050 }
1051 /* }}} */
1052
1053 /* {{{ proto bool HttpRequest::enableCookies()
1054 *
1055 * Enable automatic sending of received cookies.
1056 * Note that cuutomly set cookies will be sent anyway.
1057 */
1058 PHP_METHOD(HttpRequest, enableCookies)
1059 {
1060 NO_ARGS {
1061 getObject(http_request_object, obj);
1062 RETURN_SUCCESS(http_request_enable_cookies(obj->request));
1063 }
1064
1065 }
1066 /* }}} */
1067
1068 /* {{{ proto bool HttpRequest::resetCookies([bool session_only = FALSE])
1069 *
1070 * Reset all automatically received/sent cookies.
1071 * Note that customly set cookies are not affected.
1072 *
1073 * Accepts an optional bool parameter specifying
1074 * whether only session cookies should be reset
1075 * (needs libcurl >= v7.15.4, else libcurl >= v7.14.1).
1076 *
1077 * Returns TRUE on success, or FALSE on failure.
1078 */
1079 PHP_METHOD(HttpRequest, resetCookies)
1080 {
1081 zend_bool session_only = 0;
1082 getObject(http_request_object, obj);
1083
1084 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|b", &session_only)) {
1085 RETURN_FALSE;
1086 }
1087 RETURN_SUCCESS(http_request_reset_cookies(obj->request, session_only));
1088 }
1089 /* }}} */
1090
1091 /* {{{ proto bool HttpRequest::setUrl(string url)
1092 *
1093 * Set the request URL.
1094 *
1095 * Expects a string as parameter specifying the request url.
1096 *
1097 * Returns TRUE on success, or FALSE on failure.
1098 */
1099 PHP_METHOD(HttpRequest, setUrl)
1100 {
1101 char *URL = NULL;
1102 int URL_len;
1103
1104 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &URL, &URL_len)) {
1105 RETURN_FALSE;
1106 }
1107
1108 UPD_STRL(url, URL, URL_len);
1109 RETURN_TRUE;
1110 }
1111 /* }}} */
1112
1113 /* {{{ proto string HttpRequest::getUrl()
1114 *
1115 * Get the previously set request URL.
1116 *
1117 * Returns the currently set request url as string.
1118 */
1119 PHP_METHOD(HttpRequest, getUrl)
1120 {
1121 NO_ARGS;
1122
1123 if (return_value_used) {
1124 RETURN_PROP(url);
1125 }
1126 }
1127 /* }}} */
1128
1129 /* {{{ proto bool HttpRequest::setMethod(int request_method)
1130 *
1131 * Set the request method.
1132 *
1133 * Expects an int as parameter specifying the request method to use.
1134 * In PHP 5.1+ HttpRequest::METH_*, otherwise the HTTP_METH_* constants can be used.
1135 *
1136 * Returns TRUE on success, or FALSE on failure.
1137 */
1138 PHP_METHOD(HttpRequest, setMethod)
1139 {
1140 long meth;
1141
1142 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l", &meth)) {
1143 RETURN_FALSE;
1144 }
1145
1146 UPD_PROP(long, method, meth);
1147 RETURN_TRUE;
1148 }
1149 /* }}} */
1150
1151 /* {{{ proto int HttpRequest::getMethod()
1152 *
1153 * Get the previously set request method.
1154 *
1155 * Returns the currently set request method.
1156 */
1157 PHP_METHOD(HttpRequest, getMethod)
1158 {
1159 NO_ARGS;
1160
1161 if (return_value_used) {
1162 RETURN_PROP(method);
1163 }
1164 }
1165 /* }}} */
1166
1167 /* {{{ proto bool HttpRequest::setContentType(string content_type)
1168 *
1169 * Set the content type the post request should have.
1170 *
1171 * Expects a string as parameters containing the content type of the request
1172 * (primary/secondary).
1173 *
1174 * Returns TRUE on success, or FALSE if the content type does not seem to
1175 * contain a primary and a secondary part.
1176 */
1177 PHP_METHOD(HttpRequest, setContentType)
1178 {
1179 char *ctype;
1180 int ct_len;
1181
1182 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &ctype, &ct_len)) {
1183 RETURN_FALSE;
1184 }
1185
1186 if (ct_len) {
1187 HTTP_CHECK_CONTENT_TYPE(ctype, RETURN_FALSE);
1188 }
1189 UPD_STRL(contentType, ctype, ct_len);
1190 RETURN_TRUE;
1191 }
1192 /* }}} */
1193
1194 /* {{{ proto string HttpRequest::getContentType()
1195 *
1196 * Get the previously content type.
1197 *
1198 * Returns the previously set content type as string.
1199 */
1200 PHP_METHOD(HttpRequest, getContentType)
1201 {
1202 NO_ARGS;
1203
1204 if (return_value_used) {
1205 RETURN_PROP(contentType);
1206 }
1207 }
1208 /* }}} */
1209
1210 /* {{{ proto bool HttpRequest::setQueryData([mixed query_data])
1211 *
1212 * Set the URL query parameters to use, overwriting previously set query parameters.
1213 * Affects any request types.
1214 *
1215 * Accepts a string or associative array parameter containing the pre-encoded
1216 * query string or to be encoded query fields. If the parameter is empty or
1217 * omitted, the query data will be unset.
1218 *
1219 * Returns TRUE on success, or FALSE on failure.
1220 */
1221 PHP_METHOD(HttpRequest, setQueryData)
1222 {
1223 zval *qdata = NULL;
1224
1225 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z!", &qdata)) {
1226 RETURN_FALSE;
1227 }
1228
1229 if ((!qdata) || Z_TYPE_P(qdata) == IS_NULL) {
1230 UPD_STRL(queryData, "", 0);
1231 } else if ((Z_TYPE_P(qdata) == IS_ARRAY) || (Z_TYPE_P(qdata) == IS_OBJECT)) {
1232 char *query_data = NULL;
1233
1234 if (SUCCESS != http_urlencode_hash(HASH_OF(qdata), &query_data)) {
1235 RETURN_FALSE;
1236 }
1237
1238 UPD_PROP(string, queryData, query_data);
1239 efree(query_data);
1240 } else {
1241 zval *orig = qdata;
1242
1243 convert_to_string_ex(&qdata);
1244 UPD_STRL(queryData, Z_STRVAL_P(qdata), Z_STRLEN_P(qdata));
1245 if (orig != qdata) {
1246 zval_ptr_dtor(&qdata);
1247 }
1248 }
1249 RETURN_TRUE;
1250 }
1251 /* }}} */
1252
1253 /* {{{ proto string HttpRequest::getQueryData()
1254 *
1255 * Get the current query data in form of an urlencoded query string.
1256 *
1257 * Returns a string containing the urlencoded query.
1258 */
1259 PHP_METHOD(HttpRequest, getQueryData)
1260 {
1261 NO_ARGS;
1262
1263 if (return_value_used) {
1264 RETURN_PROP(queryData);
1265 }
1266 }
1267 /* }}} */
1268
1269 /* {{{ proto bool HttpRequest::addQueryData(array query_params)
1270 *
1271 * Add parameters to the query parameter list, leaving previously set unchanged.
1272 * Affects any request type.
1273 *
1274 * Expects an associative array as parameter containing the query fields to add.
1275 *
1276 * Returns TRUE on success, or FALSE on failure.
1277 */
1278 PHP_METHOD(HttpRequest, addQueryData)
1279 {
1280 zval *qdata, *old_qdata;
1281 char *query_data = NULL;
1282 size_t query_data_len = 0;
1283
1284 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a/", &qdata)) {
1285 RETURN_FALSE;
1286 }
1287
1288 old_qdata = GET_PROP(queryData);
1289
1290 if (SUCCESS != http_urlencode_hash_ex(HASH_OF(qdata), 1, Z_STRVAL_P(old_qdata), Z_STRLEN_P(old_qdata), &query_data, &query_data_len)) {
1291 RETURN_FALSE;
1292 }
1293
1294 UPD_STRL(queryData, query_data, query_data_len);
1295 efree(query_data);
1296
1297 RETURN_TRUE;
1298 }
1299 /* }}} */
1300
1301 /* {{{ proto bool HttpRequest::addPostFields(array post_data)
1302 *
1303 * Adds POST data entries, leaving previously set unchanged, unless a
1304 * post entry with the same name already exists.
1305 * Affects only POST and custom requests.
1306 *
1307 * Expects an associative array as parameter containing the post fields.
1308 *
1309 * Returns TRUE on success, or FALSE on failure.
1310 */
1311 PHP_METHOD(HttpRequest, addPostFields)
1312 {
1313 zval *post_data, *old_post, *new_post;
1314
1315 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a/", &post_data)) {
1316 RETURN_FALSE;
1317 }
1318
1319 if (zend_hash_num_elements(Z_ARRVAL_P(post_data))) {
1320 MAKE_STD_ZVAL(new_post);
1321 array_init(new_post);
1322 old_post = GET_PROP(postFields);
1323 if (Z_TYPE_P(old_post) == IS_ARRAY) {
1324 array_copy(old_post, new_post);
1325 }
1326 array_merge(post_data, new_post);
1327 SET_PROP(postFields, new_post);
1328 zval_ptr_dtor(&new_post);
1329 }
1330
1331 RETURN_TRUE;
1332 }
1333 /* }}} */
1334
1335 /* {{{ proto bool HttpRequest::setPostFields([array post_data])
1336 *
1337 * Set the POST data entries, overwriting previously set POST data.
1338 * Affects only POST and custom requests.
1339 *
1340 * Accepts an associative array as parameter containing the post fields.
1341 * If the parameter is empty or omitted, the post data will be unset.
1342 *
1343 * Returns TRUE on success, or FALSE on failure.
1344 */
1345 PHP_METHOD(HttpRequest, setPostFields)
1346 {
1347 zval *post, *post_data = NULL;
1348
1349 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a/!", &post_data)) {
1350 RETURN_FALSE;
1351 }
1352
1353 MAKE_STD_ZVAL(post);
1354 array_init(post);
1355 if (post_data && zend_hash_num_elements(Z_ARRVAL_P(post_data))) {
1356 array_copy(post_data, post);
1357 }
1358 SET_PROP(postFields, post);
1359 zval_ptr_dtor(&post);
1360
1361 RETURN_TRUE;
1362 }
1363 /* }}}*/
1364
1365 /* {{{ proto array HttpRequest::getPostFields()
1366 *
1367 * Get previously set POST data.
1368 *
1369 * Returns the currently set post fields as associative array.
1370 */
1371 PHP_METHOD(HttpRequest, getPostFields)
1372 {
1373 NO_ARGS;
1374
1375 if (return_value_used) {
1376 RETURN_PROP(postFields);
1377 }
1378 }
1379 /* }}} */
1380
1381 /* {{{ proto bool HttpRequest::setRawPostData([string raw_post_data])
1382 *
1383 * Set raw post data to send, overwriting previously set raw post data. Don't
1384 * forget to specify a content type. Affects only POST and custom requests.
1385 * Only either post fields or raw post data can be used for each request.
1386 * Raw post data has higher precedence and will be used even if post fields
1387 * are set.
1388 *
1389 * Accepts a string as parameter containing the *raw* post data.
1390 *
1391 * Returns TRUE on success, or FALSE on failure.
1392 */
1393 PHP_METHOD(HttpRequest, setRawPostData)
1394 {
1395 char *raw_data = NULL;
1396 int data_len = 0;
1397
1398 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|s", &raw_data, &data_len)) {
1399 RETURN_FALSE;
1400 }
1401
1402 if (!raw_data) {
1403 raw_data = "";
1404 }
1405
1406 UPD_STRL(rawPostData, raw_data, data_len);
1407 RETURN_TRUE;
1408 }
1409 /* }}} */
1410
1411 /* {{{ proto bool HttpRequest::addRawPostData(string raw_post_data)
1412 *
1413 * Add raw post data, leaving previously set raw post data unchanged.
1414 * Affects only POST and custom requests.
1415 *
1416 * Expects a string as parameter containing the raw post data to concatenate.
1417 *
1418 * Returns TRUE on success, or FALSE on failure.
1419 */
1420 PHP_METHOD(HttpRequest, addRawPostData)
1421 {
1422 char *raw_data;
1423 int data_len;
1424
1425 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &raw_data, &data_len)) {
1426 RETURN_FALSE;
1427 }
1428
1429 if (data_len) {
1430 zval *data = GET_PROP(rawPostData);
1431
1432 if (Z_STRLEN_P(data)) {
1433 Z_STRVAL_P(data) = erealloc(Z_STRVAL_P(data), (Z_STRLEN_P(data) += data_len) + 1);
1434 Z_STRVAL_P(data)[Z_STRLEN_P(data)] = '\0';
1435 memcpy(Z_STRVAL_P(data) + Z_STRLEN_P(data) - data_len, raw_data, data_len);
1436 } else {
1437 UPD_STRL(putData, raw_data, data_len);
1438 }
1439 }
1440
1441 RETURN_TRUE;
1442 }
1443 /* }}} */
1444
1445 /* {{{ proto string HttpRequest::getRawPostData()
1446 *
1447 * Get previously set raw post data.
1448 *
1449 * Returns a string containing the currently set raw post data.
1450 */
1451 PHP_METHOD(HttpRequest, getRawPostData)
1452 {
1453 NO_ARGS;
1454
1455 if (return_value_used) {
1456 RETURN_PROP(rawPostData);
1457 }
1458 }
1459 /* }}} */
1460
1461 /* {{{ proto bool HttpRequest::addPostFile(string name, string file[, string content_type = "application/x-octetstream"])
1462 *
1463 * Add a file to the POST request, leaving previously set files unchanged.
1464 * Affects only POST and custom requests. Cannot be used with raw post data.
1465 *
1466 * Expects a string parameter containing the form element name, and a string
1467 * paremeter containing the path to the file which should be uploaded.
1468 * Additionally accepts an optional string parameter which should contain
1469 * the content type of the file.
1470 *
1471 * Returns TRUE on success, or FALSE if the content type seems not to contain a
1472 * primary and a secondary content type part.
1473 */
1474 PHP_METHOD(HttpRequest, addPostFile)
1475 {
1476 zval *entry, *old_post, *new_post;
1477 char *name, *file, *type = NULL;
1478 int name_len, file_len, type_len = 0;
1479
1480 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "ss|s", &name, &name_len, &file, &file_len, &type, &type_len)) {
1481 RETURN_FALSE;
1482 }
1483
1484 if (type_len) {
1485 HTTP_CHECK_CONTENT_TYPE(type, RETURN_FALSE);
1486 } else {
1487 type = "application/x-octetstream";
1488 type_len = sizeof("application/x-octetstream") - 1;
1489 }
1490
1491 MAKE_STD_ZVAL(entry);
1492 array_init(entry);
1493
1494 add_assoc_stringl(entry, "name", name, name_len, 1);
1495 add_assoc_stringl(entry, "type", type, type_len, 1);
1496 add_assoc_stringl(entry, "file", file, file_len, 1);
1497
1498 MAKE_STD_ZVAL(new_post);
1499 array_init(new_post);
1500 old_post = GET_PROP(postFiles);
1501 if (Z_TYPE_P(old_post) == IS_ARRAY) {
1502 array_copy(old_post, new_post);
1503 }
1504 add_next_index_zval(new_post, entry);
1505 SET_PROP(postFiles, new_post);
1506 zval_ptr_dtor(&new_post);
1507
1508 RETURN_TRUE;
1509 }
1510 /* }}} */
1511
1512 /* {{{ proto bool HttpRequest::setPostFiles([array post_files])
1513 *
1514 * Set files to post, overwriting previously set post files.
1515 * Affects only POST and requests. Cannot be used with raw post data.
1516 *
1517 * Accepts an array containing the files to post. Each entry should be an
1518 * associative array with "name", "file" and "type" keys. If the parameter
1519 * is empty or omitted the post files will be unset.
1520 *
1521 * Returns TRUE on success, or FALSE on failure.
1522 */
1523 PHP_METHOD(HttpRequest, setPostFiles)
1524 {
1525 zval *files = NULL, *post;
1526
1527 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a!/", &files)) {
1528 RETURN_FALSE;
1529 }
1530
1531 MAKE_STD_ZVAL(post);
1532 array_init(post);
1533 if (files && (Z_TYPE_P(files) == IS_ARRAY)) {
1534 array_copy(files, post);
1535 }
1536 SET_PROP(postFiles, post);
1537 zval_ptr_dtor(&post);
1538
1539 RETURN_TRUE;
1540 }
1541 /* }}} */
1542
1543 /* {{{ proto array HttpRequest::getPostFiles()
1544 *
1545 * Get all previously added POST files.
1546 *
1547 * Returns an array containing currently set post files.
1548 */
1549 PHP_METHOD(HttpRequest, getPostFiles)
1550 {
1551 NO_ARGS;
1552
1553 if (return_value_used) {
1554 RETURN_PROP(postFiles);
1555 }
1556 }
1557 /* }}} */
1558
1559 /* {{{ proto bool HttpRequest::setPutFile([string file])
1560 *
1561 * Set file to put. Affects only PUT requests.
1562 *
1563 * Accepts a string as parameter referencing the path to file.
1564 * If the parameter is empty or omitted the put file will be unset.
1565 *
1566 * Returns TRUE on success, or FALSE on failure.
1567 */
1568 PHP_METHOD(HttpRequest, setPutFile)
1569 {
1570 char *file = "";
1571 int file_len = 0;
1572
1573 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|s", &file, &file_len)) {
1574 RETURN_FALSE;
1575 }
1576
1577 UPD_STRL(putFile, file, file_len);
1578 RETURN_TRUE;
1579 }
1580 /* }}} */
1581
1582 /* {{{ proto string HttpRequest::getPutFile()
1583 *
1584 * Get previously set put file.
1585 *
1586 * Returns a string containing the path to the currently set put file.
1587 */
1588 PHP_METHOD(HttpRequest, getPutFile)
1589 {
1590 NO_ARGS;
1591
1592 if (return_value_used) {
1593 RETURN_PROP(putFile);
1594 }
1595 }
1596 /* }}} */
1597
1598 /* {{{ proto bool HttpRequest::setPutData([string put_data])
1599 *
1600 * Set PUT data to send, overwriting previously set PUT data.
1601 * Affects only PUT requests.
1602 * Only either PUT data or PUT file can be used for each request.
1603 * PUT data has higher precedence and will be used even if a PUT
1604 * file is set.
1605 *
1606 * Accepts a string as parameter containing the data to upload.
1607 *
1608 * Returns TRUE on success, or FALSE on failure.
1609 */
1610 PHP_METHOD(HttpRequest, setPutData)
1611 {
1612 char *put_data = NULL;
1613 int data_len = 0;
1614
1615 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|s", &put_data, &data_len)) {
1616 RETURN_FALSE;
1617 }
1618
1619 if (!put_data) {
1620 put_data = "";
1621 }
1622
1623 UPD_STRL(putData, put_data, data_len);
1624 RETURN_TRUE;
1625 }
1626 /* }}} */
1627
1628 /* {{{ proto bool HttpRequest::addPutData(string put_data)
1629 *
1630 * Add PUT data, leaving previously set PUT data unchanged.
1631 * Affects only PUT requests.
1632 *
1633 * Expects a string as parameter containing the data to concatenate.
1634 *
1635 * Returns TRUE on success, or FALSE on failure.
1636 */
1637 PHP_METHOD(HttpRequest, addPutData)
1638 {
1639 char *put_data;
1640 int data_len;
1641
1642 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &put_data, &data_len)) {
1643 RETURN_FALSE;
1644 }
1645
1646 if (data_len) {
1647 zval *data = GET_PROP(putData);
1648
1649 if (Z_STRLEN_P(data)) {
1650 Z_STRVAL_P(data) = erealloc(Z_STRVAL_P(data), (Z_STRLEN_P(data) += data_len) + 1);
1651 Z_STRVAL_P(data)[Z_STRLEN_P(data)] = '\0';
1652 memcpy(Z_STRVAL_P(data) + Z_STRLEN_P(data) - data_len, put_data, data_len);
1653 } else {
1654 UPD_STRL(putData, put_data, data_len);
1655 }
1656 }
1657
1658 RETURN_TRUE;
1659 }
1660 /* }}} */
1661
1662 /* {{{ proto string HttpRequest::getPutData()
1663 *
1664 * Get previously set PUT data.
1665 *
1666 * Returns a string containing the currently set raw post data.
1667 */
1668 PHP_METHOD(HttpRequest, getPutData)
1669 {
1670 NO_ARGS;
1671
1672 if (return_value_used) {
1673 RETURN_PROP(putData);
1674 }
1675 }
1676 /* }}} */
1677
1678 /* {{{ proto array HttpRequest::getResponseData()
1679 *
1680 * Get all response data after the request has been sent.
1681 *
1682 * Returns an associative array with the key "headers" containing an associative
1683 * array holding all response headers, as well as the key "body" containing a
1684 * string with the response body.
1685 *
1686 * If redirects were allowed and several responses were received, the data
1687 * references the last received response.
1688 */
1689 PHP_METHOD(HttpRequest, getResponseData)
1690 {
1691 NO_ARGS;
1692
1693 if (return_value_used) {
1694 RETURN_PROP(responseData);
1695 }
1696 }
1697 /* }}} */
1698
1699 /* {{{ proto mixed HttpRequest::getResponseHeader([string name])
1700 *
1701 * Get response header(s) after the request has been sent.
1702 *
1703 * Accepts an string as optional parameter specifying a certain header to read.
1704 * If the parameter is empty or omitted all response headers will be returned.
1705 *
1706 * Returns either a string with the value of the header matching name if requested,
1707 * FALSE on failure, or an associative array containing all response headers.
1708 *
1709 * If redirects were allowed and several responses were received, the data
1710 * references the last received response.
1711 */
1712 PHP_METHOD(HttpRequest, getResponseHeader)
1713 {
1714 if (return_value_used) {
1715 zval *data, **headers, **header;
1716 char *header_name = NULL;
1717 int header_len = 0;
1718
1719 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|s", &header_name, &header_len)) {
1720 RETURN_FALSE;
1721 }
1722
1723 data = GET_PROP(responseData);
1724 if ( (Z_TYPE_P(data) == IS_ARRAY) &&
1725 (SUCCESS == zend_hash_find(Z_ARRVAL_P(data), "headers", sizeof("headers"), (void *) &headers)) &&
1726 (Z_TYPE_PP(headers) == IS_ARRAY)) {
1727 if (!header_len || !header_name) {
1728 RETVAL_ZVAL(*headers, 1, 0);
1729 } else if (SUCCESS == zend_hash_find(Z_ARRVAL_PP(headers), pretty_key(header_name, header_len, 1, 1), header_len + 1, (void *) &header)) {
1730 RETVAL_ZVAL(*header, 1, 0);
1731 } else {
1732 RETVAL_FALSE;
1733 }
1734 } else {
1735 RETVAL_FALSE;
1736 }
1737 }
1738 }
1739 /* }}} */
1740
1741 /* {{{ proto array HttpRequest::getResponseCookies([int flags[, array allowed_extras]])
1742 *
1743 * Get response cookie(s) after the request has been sent.
1744 *
1745 * Returns an array of stdClass objects like http_parse_cookie would return.
1746 *
1747 * If redirects were allowed and several responses were received, the data
1748 * references the last received response.
1749 */
1750 PHP_METHOD(HttpRequest, getResponseCookies)
1751 {
1752 if (return_value_used) {
1753 long flags = 0;
1754 zval *allowed_extras_array = NULL, *data, **headers;
1755
1756 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|la", &flags, &allowed_extras_array)) {
1757 RETURN_FALSE;
1758 }
1759
1760 data = GET_PROP(responseData);
1761 if ( (Z_TYPE_P(data) == IS_ARRAY) &&
1762 (SUCCESS == zend_hash_find(Z_ARRVAL_P(data), "headers", sizeof("headers"), (void *) &headers)) &&
1763 (Z_TYPE_PP(headers) == IS_ARRAY)) {
1764 int i = 0;
1765 ulong idx = 0;
1766 char *key = NULL, **allowed_extras = NULL;
1767 zval **header = NULL, **entry = NULL;
1768 HashPosition pos, pos1, pos2;
1769
1770 array_init(return_value);
1771
1772 if (allowed_extras_array) {
1773 allowed_extras = ecalloc(zend_hash_num_elements(Z_ARRVAL_P(allowed_extras_array)) + 1, sizeof(char *));
1774 FOREACH_VAL(pos, allowed_extras_array, entry) {
1775 ZVAL_ADDREF(*entry);
1776 convert_to_string_ex(entry);
1777 allowed_extras[i++] = estrndup(Z_STRVAL_PP(entry), Z_STRLEN_PP(entry));
1778 zval_ptr_dtor(entry);
1779 }
1780 }
1781
1782 FOREACH_HASH_KEYVAL(pos1, Z_ARRVAL_PP(headers), key, idx, header) {
1783 if (key && !strcasecmp(key, "Set-Cookie")) {
1784 http_cookie_list list;
1785
1786 if (Z_TYPE_PP(header) == IS_ARRAY) {
1787 zval **single_header;
1788
1789 FOREACH_VAL(pos2, *header, single_header) {
1790 ZVAL_ADDREF(*single_header);
1791 convert_to_string_ex(single_header);
1792 if (http_parse_cookie_ex(&list, Z_STRVAL_PP(single_header), flags, allowed_extras)) {
1793 zval *cookie;
1794
1795 MAKE_STD_ZVAL(cookie);
1796 object_init(cookie);
1797 http_cookie_list_tostruct(&list, cookie);
1798 add_next_index_zval(return_value, cookie);
1799 http_cookie_list_dtor(&list);
1800 }
1801 zval_ptr_dtor(single_header);
1802 }
1803 } else {
1804 ZVAL_ADDREF(*header);
1805 convert_to_string_ex(header);
1806 if (http_parse_cookie_ex(&list, Z_STRVAL_PP(header), flags, allowed_extras)) {
1807 zval *cookie;
1808
1809 MAKE_STD_ZVAL(cookie);
1810 object_init(cookie);
1811 http_cookie_list_tostruct(&list, cookie);
1812 add_next_index_zval(return_value, cookie);
1813 http_cookie_list_dtor(&list);
1814 }
1815 zval_ptr_dtor(header);
1816 }
1817 }
1818 /* reset key */
1819 key = NULL;
1820 }
1821
1822 if (allowed_extras) {
1823 for (i = 0; allowed_extras[i]; ++i) {
1824 efree(allowed_extras[i]);
1825 }
1826 efree(allowed_extras);
1827 }
1828 } else {
1829 RETURN_FALSE;
1830 }
1831 }
1832 }
1833 /* }}} */
1834
1835 /* {{{ proto string HttpRequest::getResponseBody()
1836 *
1837 * Get the response body after the request has been sent.
1838 *
1839 * Returns a string containing the response body.
1840 *
1841 * If redirects were allowed and several responses were received, the data
1842 * references the last received response.
1843 */
1844 PHP_METHOD(HttpRequest, getResponseBody)
1845 {
1846 NO_ARGS;
1847
1848 if (return_value_used) {
1849 zval **body;
1850 zval *data = GET_PROP(responseData);
1851
1852 if ( (Z_TYPE_P(data) == IS_ARRAY) &&
1853 (SUCCESS == zend_hash_find(Z_ARRVAL_P(data), "body", sizeof("body"), (void *) &body))) {
1854 RETURN_ZVAL(*body, 1, 0);
1855 } else {
1856 RETURN_FALSE;
1857 }
1858 }
1859 }
1860 /* }}} */
1861
1862 /* {{{ proto int HttpRequest::getResponseCode()
1863 *
1864 * Get the response code after the request has been sent.
1865 *
1866 * Returns an int representing the response code.
1867 *
1868 * If redirects were allowed and several responses were received, the data
1869 * references the last received response.
1870 */
1871 PHP_METHOD(HttpRequest, getResponseCode)
1872 {
1873 NO_ARGS;
1874
1875 if (return_value_used) {
1876 RETURN_PROP(responseCode);
1877 }
1878 }
1879 /* }}} */
1880
1881 /* {{{ proto string HttpRequest::getResponseStatus()
1882 *
1883 * Get the response status (i.e. the string after the response code) after the message has been sent.
1884 *
1885 * Returns a string containing the response status text.
1886 */
1887 PHP_METHOD(HttpRequest, getResponseStatus)
1888 {
1889 NO_ARGS;
1890
1891 if (return_value_used) {
1892 RETURN_PROP(responseStatus);
1893 }
1894 }
1895 /* }}} */
1896
1897 /* {{{ proto mixed HttpRequest::getResponseInfo([string name])
1898 *
1899 * Get response info after the request has been sent.
1900 * See http_get() for a full list of returned info.
1901 *
1902 * Accepts a string as optional parameter specifying the info to read.
1903 * If the parameter is empty or omitted, an associative array containing
1904 * all available info will be returned.
1905 *
1906 * Returns either a scalar containing the value of the info matching name if
1907 * requested, FALSE on failure, or an associative array containing all
1908 * available info.
1909 *
1910 * If redirects were allowed and several responses were received, the data
1911 * references the last received response.
1912 */
1913 PHP_METHOD(HttpRequest, getResponseInfo)
1914 {
1915 if (return_value_used) {
1916 zval *info, **infop;
1917 char *info_name = NULL;
1918 int info_len = 0;
1919
1920 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|s", &info_name, &info_len)) {
1921 RETURN_FALSE;
1922 }
1923
1924 info = GET_PROP(responseInfo);
1925
1926 if (Z_TYPE_P(info) != IS_ARRAY) {
1927 RETURN_FALSE;
1928 }
1929
1930 if (info_len && info_name) {
1931 if (SUCCESS == zend_hash_find(Z_ARRVAL_P(info), pretty_key(info_name, info_len, 0, 0), info_len + 1, (void *) &infop)) {
1932 RETURN_ZVAL(*infop, 1, 0);
1933 } else {
1934 http_error_ex(HE_NOTICE, HTTP_E_INVALID_PARAM, "Could not find response info named %s", info_name);
1935 RETURN_FALSE;
1936 }
1937 } else {
1938 RETURN_ZVAL(info, 1, 0);
1939 }
1940 }
1941 }
1942 /* }}}*/
1943
1944 /* {{{ proto HttpMessage HttpRequest::getResponseMessage()
1945 *
1946 * Get the full response as HttpMessage object after the request has been sent.
1947 *
1948 * Returns an HttpMessage object of the response.
1949 *
1950 * If redirects were allowed and several responses were received, the data
1951 * references the last received response. Use HttpMessage::getParentMessage()
1952 * to access the data of previously received responses within this request
1953 * cycle.
1954 *
1955 * Throws HttpException, HttpRuntimeException.
1956 */
1957 PHP_METHOD(HttpRequest, getResponseMessage)
1958 {
1959 NO_ARGS {
1960 zval *message;
1961
1962 SET_EH_THROW_HTTP();
1963 message = GET_PROP(responseMessage);
1964 if (Z_TYPE_P(message) == IS_OBJECT) {
1965 RETVAL_OBJECT(message, 1);
1966 } else {
1967 http_error(HE_WARNING, HTTP_E_RUNTIME, "HttpRequest does not contain a response message");
1968 }
1969 SET_EH_NORMAL();
1970 }
1971 }
1972 /* }}} */
1973
1974 /* {{{ proto HttpMessage HttpRequest::getRequestMessage()
1975 *
1976 * Get sent HTTP message.
1977 *
1978 * Returns an HttpMessage object representing the sent request.
1979 *
1980 * If redirects were allowed and several responses were received, the data
1981 * references the last received response. Use HttpMessage::getParentMessage()
1982 * to access the data of previously sent requests within this request
1983 * cycle.
1984 *
1985 * Note that the internal request message is immutable, that means that the
1986 * request message received through HttpRequest::getRequestMessage() will
1987 * always look the same for the same request, regardless of any changes you
1988 * may have made to the returned object.
1989 *
1990 * Throws HttpMalformedHeadersException, HttpEncodingException.
1991 */
1992 PHP_METHOD(HttpRequest, getRequestMessage)
1993 {
1994 NO_ARGS;
1995
1996 if (return_value_used) {
1997 http_message *msg;
1998 getObject(http_request_object, obj);
1999
2000 SET_EH_THROW_HTTP();
2001 if ((msg = http_message_parse(PHPSTR_VAL(&obj->request->conv.request), PHPSTR_LEN(&obj->request->conv.request)))) {
2002 RETVAL_OBJVAL(http_message_object_new_ex(http_message_object_ce, msg, NULL), 0);
2003 }
2004 SET_EH_NORMAL();
2005 }
2006 }
2007 /* }}} */
2008
2009 /* {{{ proto string HttpRequest::getRawRequestMessage()
2010 *
2011 * Get sent HTTP message.
2012 *
2013 * Returns an HttpMessage in a form of a string
2014 */
2015 PHP_METHOD(HttpRequest, getRawRequestMessage)
2016 {
2017 NO_ARGS;
2018
2019 if (return_value_used) {
2020 getObject(http_request_object, obj);
2021
2022 RETURN_PHPSTR_DUP(&obj->request->conv.request);
2023 }
2024 }
2025 /* }}} */
2026
2027 /* {{{ proto string HttpRequest::getRawResponseMessage()
2028 *
2029 * Get the entire HTTP response.
2030 *
2031 * Returns the complete web server response, including the headers in a form of a string.
2032 */
2033 PHP_METHOD(HttpRequest, getRawResponseMessage)
2034 {
2035 NO_ARGS;
2036
2037 if (return_value_used) {
2038 getObject(http_request_object, obj);
2039
2040 RETURN_PHPSTR_DUP(&obj->request->conv.response);
2041 }
2042 }
2043 /* }}} */
2044
2045 /* {{{ proto HttpMessage HttpRequest::getHistory()
2046 *
2047 * Get all sent requests and received responses as an HttpMessage object.
2048 *
2049 * If you want to record history, set the instance variable
2050 * HttpRequest::$recordHistory to TRUE.
2051 *
2052 * Returns an HttpMessage object representing the complete request/response
2053 * history.
2054 *
2055 * The object references the last received response, use HttpMessage::getParentMessage()
2056 * to access the data of previously sent requests and received responses.
2057 *
2058 * Throws HttpRuntimeException.
2059 */
2060 PHP_METHOD(HttpRequest, getHistory)
2061 {
2062 NO_ARGS;
2063
2064 if (return_value_used) {
2065 zval *hist;
2066
2067 SET_EH_THROW_HTTP();
2068 hist = GET_PROP(history);
2069 if (Z_TYPE_P(hist) == IS_OBJECT) {
2070 RETVAL_OBJECT(hist, 1);
2071 } else {
2072 http_error(HE_WARNING, HTTP_E_RUNTIME, "The history is empty");
2073 }
2074 SET_EH_NORMAL();
2075 }
2076 }
2077 /* }}} */
2078
2079 /* {{{ proto void HttpRequest::clearHistory()
2080 *
2081 * Clear the history.
2082 */
2083 PHP_METHOD(HttpRequest, clearHistory)
2084 {
2085 NO_ARGS {
2086 zval *hist;
2087
2088 MAKE_STD_ZVAL(hist);
2089 ZVAL_NULL(hist);
2090 SET_PROP(history, hist);
2091 zval_ptr_dtor(&hist);
2092 }
2093 }
2094 /* }}} */
2095
2096 /* {{{ proto HttpMessage HttpRequest::send()
2097 *
2098 * Send the HTTP request.
2099 *
2100 * Returns the received response as HttpMessage object.
2101 *
2102 * NOTE: While an exception may be thrown, the transfer could have succeeded
2103 * at least partially, so you might want to check the return values of various
2104 * HttpRequest::getResponse*() methods.
2105 *
2106 * Throws HttpRuntimeException, HttpRequestException,
2107 * HttpMalformedHeaderException, HttpEncodingException.
2108 *
2109 * GET example:
2110 * <pre>
2111 * <?php
2112 * $r = new HttpRequest('http://example.com/feed.rss', HttpRequest::METH_GET);
2113 * $r->setOptions(array('lastmodified' => filemtime('local.rss')));
2114 * $r->addQueryData(array('category' => 3));
2115 * try {
2116 * $r->send();
2117 * if ($r->getResponseCode() == 200) {
2118 * file_put_contents('local.rss', $r->getResponseBody());
2119 * }
2120 * } catch (HttpException $ex) {
2121 * echo $ex;
2122 * }
2123 * ?>
2124 * </pre>
2125 *
2126 * POST example:
2127 * <pre>
2128 * <?php
2129 * $r = new HttpRequest('http://example.com/form.php', HttpRequest::METH_POST);
2130 * $r->setOptions(array('cookies' => array('lang' => 'de')));
2131 * $r->addPostFields(array('user' => 'mike', 'pass' => 's3c|r3t'));
2132 * $r->addPostFile('image', 'profile.jpg', 'image/jpeg');
2133 * try {
2134 * echo $r->send()->getBody();
2135 * } catch (HttpException $ex) {
2136 * echo $ex;
2137 * }
2138 * ?>
2139 * </pre>
2140 */
2141 PHP_METHOD(HttpRequest, send)
2142 {
2143 getObject(http_request_object, obj);
2144
2145 NO_ARGS;
2146
2147 SET_EH_THROW_HTTP();
2148
2149 RETVAL_FALSE;
2150
2151 if (obj->pool) {
2152 http_error(HE_WARNING, HTTP_E_RUNTIME, "Cannot perform HttpRequest::send() while attached to an HttpRequestPool");
2153 } else if (SUCCESS == http_request_object_requesthandler(obj, getThis())) {
2154 http_request_exec(obj->request);
2155 if (SUCCESS == http_request_object_responsehandler(obj, getThis())) {
2156 RETVAL_OBJECT(GET_PROP(responseMessage), 1);
2157 }
2158 }
2159
2160 SET_EH_NORMAL();
2161 }
2162 /* }}} */
2163
2164 #endif /* ZEND_ENGINE_2 && HTTP_HAVE_CURL */
2165
2166 /*
2167 * Local variables:
2168 * tab-width: 4
2169 * c-basic-offset: 4
2170 * End:
2171 * vim600: noet sw=4 ts=4 fdm=marker
2172 * vim<600: noet sw=4 ts=4
2173 */
2174