- add "ipresolve" request option
[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, responseMessage);
345 DCL_PROP(PRIVATE, long, responseCode, 0);
346 DCL_PROP(PRIVATE, string, responseStatus, "");
347 DCL_PROP(PRIVATE, long, method, HTTP_GET);
348 DCL_PROP(PRIVATE, string, url, "");
349 DCL_PROP(PRIVATE, string, contentType, "");
350 DCL_PROP(PRIVATE, string, rawPostData, "");
351 DCL_PROP(PRIVATE, string, queryData, "");
352 DCL_PROP(PRIVATE, string, putFile, "");
353 DCL_PROP(PRIVATE, string, putData, "");
354 DCL_PROP_N(PRIVATE, history);
355 DCL_PROP(PUBLIC, bool, recordHistory, 0);
356
357 #ifndef WONKY
358 /*
359 * Request Method Constants
360 */
361 /* HTTP/1.1 */
362 DCL_CONST(long, "METH_GET", HTTP_GET);
363 DCL_CONST(long, "METH_HEAD", HTTP_HEAD);
364 DCL_CONST(long, "METH_POST", HTTP_POST);
365 DCL_CONST(long, "METH_PUT", HTTP_PUT);
366 DCL_CONST(long, "METH_DELETE", HTTP_DELETE);
367 DCL_CONST(long, "METH_OPTIONS", HTTP_OPTIONS);
368 DCL_CONST(long, "METH_TRACE", HTTP_TRACE);
369 DCL_CONST(long, "METH_CONNECT", HTTP_CONNECT);
370 /* WebDAV - RFC 2518 */
371 DCL_CONST(long, "METH_PROPFIND", HTTP_PROPFIND);
372 DCL_CONST(long, "METH_PROPPATCH", HTTP_PROPPATCH);
373 DCL_CONST(long, "METH_MKCOL", HTTP_MKCOL);
374 DCL_CONST(long, "METH_COPY", HTTP_COPY);
375 DCL_CONST(long, "METH_MOVE", HTTP_MOVE);
376 DCL_CONST(long, "METH_LOCK", HTTP_LOCK);
377 DCL_CONST(long, "METH_UNLOCK", HTTP_UNLOCK);
378 /* WebDAV Versioning - RFC 3253 */
379 DCL_CONST(long, "METH_VERSION_CONTROL", HTTP_VERSION_CONTROL);
380 DCL_CONST(long, "METH_REPORT", HTTP_REPORT);
381 DCL_CONST(long, "METH_CHECKOUT", HTTP_CHECKOUT);
382 DCL_CONST(long, "METH_CHECKIN", HTTP_CHECKIN);
383 DCL_CONST(long, "METH_UNCHECKOUT", HTTP_UNCHECKOUT);
384 DCL_CONST(long, "METH_MKWORKSPACE", HTTP_MKWORKSPACE);
385 DCL_CONST(long, "METH_UPDATE", HTTP_UPDATE);
386 DCL_CONST(long, "METH_LABEL", HTTP_LABEL);
387 DCL_CONST(long, "METH_MERGE", HTTP_MERGE);
388 DCL_CONST(long, "METH_BASELINE_CONTROL", HTTP_BASELINE_CONTROL);
389 DCL_CONST(long, "METH_MKACTIVITY", HTTP_MKACTIVITY);
390 /* WebDAV Access Control - RFC 3744 */
391 DCL_CONST(long, "METH_ACL", HTTP_ACL);
392
393 /*
394 * HTTP Protocol Version Constants
395 */
396 DCL_CONST(long, "VERSION_1_0", CURL_HTTP_VERSION_1_0);
397 DCL_CONST(long, "VERSION_1_1", CURL_HTTP_VERSION_1_1);
398 DCL_CONST(long, "VERSION_NONE", CURL_HTTP_VERSION_NONE);
399
400 /*
401 * DNS IPvX resolving
402 */
403 DCL_CONST(long, "IPRESOLVE_V4", CURL_IPRESOLVE_V4);
404 DCL_CONST(long, "IPRESOLVE_V6", CURL_IPRESOLVE_V6);
405 DCL_CONST(long, "IPRESOLVE_ANY", CURL_IPRESOLVE_WHATEVER);
406
407 /*
408 * Auth Constants
409 */
410 DCL_CONST(long, "AUTH_BASIC", CURLAUTH_BASIC);
411 DCL_CONST(long, "AUTH_DIGEST", CURLAUTH_DIGEST);
412 DCL_CONST(long, "AUTH_NTLM", CURLAUTH_NTLM);
413 DCL_CONST(long, "AUTH_ANY", CURLAUTH_ANY);
414
415 /*
416 * Proxy Type Constants
417 */
418 # if HTTP_CURL_VERSION(7,15,2)
419 DCL_CONST(long, "PROXY_SOCKS4", CURLPROXY_SOCKS4);
420 # endif
421 DCL_CONST(long, "PROXY_SOCKS5", CURLPROXY_SOCKS5);
422 DCL_CONST(long, "PROXY_HTTP", CURLPROXY_HTTP);
423 #endif /* WONKY */
424
425 return SUCCESS;
426 }
427
428 zend_object_value _http_request_object_new(zend_class_entry *ce TSRMLS_DC)
429 {
430 return http_request_object_new_ex(ce, NULL, NULL);
431 }
432
433 zend_object_value _http_request_object_new_ex(zend_class_entry *ce, CURL *ch, http_request_object **ptr TSRMLS_DC)
434 {
435 zend_object_value ov;
436 http_request_object *o;
437
438 o = ecalloc(1, sizeof(http_request_object));
439 o->zo.ce = ce;
440 o->request = http_request_init_ex(NULL, ch, 0, NULL);
441
442 if (ptr) {
443 *ptr = o;
444 }
445
446 ALLOC_HASHTABLE(OBJ_PROP(o));
447 zend_hash_init(OBJ_PROP(o), zend_hash_num_elements(&ce->default_properties), NULL, ZVAL_PTR_DTOR, 0);
448 zend_hash_copy(OBJ_PROP(o), &ce->default_properties, (copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval *));
449
450 ov.handle = putObject(http_request_object, o);
451 ov.handlers = &http_request_object_handlers;
452
453 return ov;
454 }
455
456 zend_object_value _http_request_object_clone_obj(zval *this_ptr TSRMLS_DC)
457 {
458 zend_object_value new_ov;
459 http_request_object *new_obj;
460 getObject(http_request_object, old_obj);
461
462 new_ov = http_request_object_new_ex(old_obj->zo.ce, NULL, &new_obj);
463 if (old_obj->request->ch) {
464 http_curl_init_ex(curl_easy_duphandle(old_obj->request->ch), new_obj->request);
465 }
466
467 zend_objects_clone_members(&new_obj->zo, new_ov, &old_obj->zo, Z_OBJ_HANDLE_P(this_ptr) TSRMLS_CC);
468 phpstr_append(&new_obj->request->conv.request, old_obj->request->conv.request.data, old_obj->request->conv.request.used);
469 phpstr_append(&new_obj->request->conv.response, old_obj->request->conv.response.data, old_obj->request->conv.response.used);
470
471 return new_ov;
472 }
473
474 void _http_request_object_free(zend_object *object TSRMLS_DC)
475 {
476 http_request_object *o = (http_request_object *) object;
477
478 http_request_free(&o->request);
479 freeObject(o);
480 }
481
482 #define http_request_object_check_request_content_type(t) _http_request_object_check_request_content_type((t) TSRMLS_CC)
483 static inline void _http_request_object_check_request_content_type(zval *this_ptr TSRMLS_DC)
484 {
485 zval *ctype = GET_PROP(contentType);
486
487 if (Z_STRLEN_P(ctype)) {
488 zval **headers, *opts = GET_PROP(options);
489
490 if ( (Z_TYPE_P(opts) == IS_ARRAY) &&
491 (SUCCESS == zend_hash_find(Z_ARRVAL_P(opts), "headers", sizeof("headers"), (void *) &headers)) &&
492 (Z_TYPE_PP(headers) == IS_ARRAY)) {
493 zval **ct_header;
494
495 /* only override if not already set */
496 if ((SUCCESS != zend_hash_find(Z_ARRVAL_PP(headers), "Content-Type", sizeof("Content-Type"), (void *) &ct_header))) {
497 add_assoc_stringl(*headers, "Content-Type", Z_STRVAL_P(ctype), Z_STRLEN_P(ctype), 1);
498 } else
499 /* or not a string, zero length string or a string of spaces */
500 if ((Z_TYPE_PP(ct_header) != IS_STRING) || !Z_STRLEN_PP(ct_header)) {
501 add_assoc_stringl(*headers, "Content-Type", Z_STRVAL_P(ctype), Z_STRLEN_P(ctype), 1);
502 } else {
503 int i, only_space = 1;
504
505 /* check for spaces only */
506 for (i = 0; i < Z_STRLEN_PP(ct_header); ++i) {
507 if (!HTTP_IS_CTYPE(space, Z_STRVAL_PP(ct_header)[i])) {
508 only_space = 0;
509 break;
510 }
511 }
512 if (only_space) {
513 add_assoc_stringl(*headers, "Content-Type", Z_STRVAL_P(ctype), Z_STRLEN_P(ctype), 1);
514 }
515 }
516 } else {
517 zval *headers;
518
519 MAKE_STD_ZVAL(headers);
520 array_init(headers);
521 add_assoc_stringl(headers, "Content-Type", Z_STRVAL_P(ctype), Z_STRLEN_P(ctype), 1);
522 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL, "addheaders", NULL, headers);
523 zval_ptr_dtor(&headers);
524 }
525 }
526 }
527
528 STATUS _http_request_object_requesthandler(http_request_object *obj, zval *this_ptr TSRMLS_DC)
529 {
530 STATUS status = SUCCESS;
531
532 http_request_reset(obj->request);
533 HTTP_CHECK_CURL_INIT(obj->request->ch, http_curl_init(obj->request), return FAILURE);
534
535 obj->request->url = http_absolute_url(Z_STRVAL_P(GET_PROP(url)));
536
537 switch (obj->request->meth = Z_LVAL_P(GET_PROP(method)))
538 {
539 case HTTP_GET:
540 case HTTP_HEAD:
541 break;
542
543 case HTTP_PUT:
544 {
545 zval *put_data = GET_PROP(putData);
546
547 http_request_object_check_request_content_type(getThis());
548 if (Z_STRLEN_P(put_data)) {
549 obj->request->body = http_request_body_init_ex(obj->request->body, HTTP_REQUEST_BODY_CSTRING,
550 estrndup(Z_STRVAL_P(put_data), Z_STRLEN_P(put_data)), Z_STRLEN_P(put_data), 1);
551 } else {
552 php_stream_statbuf ssb;
553 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);
554
555 if (stream && !php_stream_stat(stream, &ssb)) {
556 obj->request->body = http_request_body_init_ex(obj->request->body, HTTP_REQUEST_BODY_UPLOADFILE, stream, ssb.sb.st_size, 1);
557 } else {
558 status = FAILURE;
559 }
560 }
561 break;
562 }
563
564 case HTTP_POST:
565 default:
566 {
567 /* check for raw post data */
568 zval *raw_data = GET_PROP(rawPostData);
569
570 if (Z_STRLEN_P(raw_data)) {
571 http_request_object_check_request_content_type(getThis());
572 obj->request->body = http_request_body_init_ex(obj->request->body, HTTP_REQUEST_BODY_CSTRING,
573 estrndup(Z_STRVAL_P(raw_data), Z_STRLEN_P(raw_data)), Z_STRLEN_P(raw_data), 1);
574 } else {
575 zval *zfields = GET_PROP(postFields), *zfiles = GET_PROP(postFiles);
576 HashTable *fields;
577 HashTable *files;
578
579 fields = (Z_TYPE_P(zfields) == IS_ARRAY) ? Z_ARRVAL_P(zfields) : NULL;
580 files = (Z_TYPE_P(zfiles) == IS_ARRAY) ? Z_ARRVAL_P(zfiles) : NULL;
581
582 if ((fields && zend_hash_num_elements(fields)) || (files && zend_hash_num_elements(files))) {
583 if (!(obj->request->body = http_request_body_fill(obj->request->body, fields, files))) {
584 status = FAILURE;
585 }
586 }
587 }
588 break;
589 }
590 }
591
592 if (status == SUCCESS) {
593 zval *qdata = GET_PROP(queryData);
594 zval *options = GET_PROP(options);
595
596 if (Z_STRLEN_P(qdata)) {
597 if (!strchr(obj->request->url, '?')) {
598 strlcat(obj->request->url, "?", HTTP_URL_MAXLEN);
599 } else {
600 strlcat(obj->request->url, "&", HTTP_URL_MAXLEN);
601 }
602 strlcat(obj->request->url, Z_STRVAL_P(qdata), HTTP_URL_MAXLEN);
603 }
604
605 http_request_prepare(obj->request, Z_ARRVAL_P(options));
606
607 /* check if there's a onProgress method and add it as progress callback if one isn't already set */
608 if (zend_hash_exists(&Z_OBJCE_P(getThis())->function_table, "onprogress", sizeof("onprogress"))) {
609 zval **entry, *pcb;
610
611 if ( (Z_TYPE_P(options) != IS_ARRAY)
612 || (SUCCESS != zend_hash_find(Z_ARRVAL_P(options), "onprogress", sizeof("onprogress"), (void *) &entry)
613 || (!zval_is_true(*entry)))) {
614 MAKE_STD_ZVAL(pcb);
615 array_init(pcb);
616 ZVAL_ADDREF(getThis());
617 add_next_index_zval(pcb, getThis());
618 add_next_index_stringl(pcb, "onprogress", lenof("onprogress"), 1);
619 http_request_set_progress_callback(obj->request, pcb);
620 zval_ptr_dtor(&pcb);
621 }
622 }
623 }
624
625 return status;
626 }
627
628 STATUS _http_request_object_responsehandler(http_request_object *obj, zval *this_ptr TSRMLS_DC)
629 {
630 STATUS ret;
631 zval *info;
632 http_message *msg;
633
634 /* always fetch info */
635 MAKE_STD_ZVAL(info);
636 array_init(info);
637 http_request_info(obj->request, Z_ARRVAL_P(info));
638 SET_PROP(responseInfo, info);
639 zval_ptr_dtor(&info);
640
641 /* parse response message */
642 phpstr_fix(&obj->request->conv.request);
643 phpstr_fix(&obj->request->conv.response);
644
645 if ((msg = http_message_parse(PHPSTR_VAL(&obj->request->conv.response), PHPSTR_LEN(&obj->request->conv.response)))) {
646 zval *message;
647
648 if (zval_is_true(GET_PROP(recordHistory))) {
649 zval *hist, *history = GET_PROP(history);
650 http_message *response = http_message_parse(PHPSTR_VAL(&obj->request->conv.response), PHPSTR_LEN(&obj->request->conv.response));
651 http_message *request = http_message_parse(PHPSTR_VAL(&obj->request->conv.request), PHPSTR_LEN(&obj->request->conv.request));
652
653 MAKE_STD_ZVAL(hist);
654 ZVAL_OBJVAL(hist, http_message_object_new_ex(http_message_object_ce, http_message_interconnect(response, request), NULL), 0);
655 if (Z_TYPE_P(history) == IS_OBJECT) {
656 http_message_object_prepend(hist, history);
657 }
658 SET_PROP(history, hist);
659 zval_ptr_dtor(&hist);
660 }
661
662 UPD_PROP(long, responseCode, msg->http.info.response.code);
663 UPD_PROP(string, responseStatus, STR_PTR(msg->http.info.response.status));
664
665 MAKE_STD_ZVAL(message);
666 ZVAL_OBJVAL(message, http_message_object_new_ex(http_message_object_ce, msg, NULL), 0);
667 SET_PROP(responseMessage, message);
668 zval_ptr_dtor(&message);
669
670 ret = SUCCESS;
671 } else {
672 /* update properties with empty values*/
673 zval *znull;
674
675 MAKE_STD_ZVAL(znull);
676 ZVAL_NULL(znull);
677 SET_PROP(responseMessage, znull);
678 zval_ptr_dtor(&znull);
679
680 UPD_PROP(long, responseCode, 0);
681 UPD_PROP(string, responseStatus, "");
682
683 /* append request message to history */
684 if (zval_is_true(GET_PROP(recordHistory))) {
685 http_message *request;
686
687 if ((request = http_message_parse(PHPSTR_VAL(&obj->request->conv.request), PHPSTR_LEN(&obj->request->conv.request)))) {
688 zval *hist, *history = GET_PROP(history);
689
690 MAKE_STD_ZVAL(hist);
691 ZVAL_OBJVAL(hist, http_message_object_new_ex(http_message_object_ce, request, NULL), 0);
692 if (Z_TYPE_P(history) == IS_OBJECT) {
693 http_message_object_prepend(hist, history);
694 }
695 SET_PROP(history, hist);
696 zval_ptr_dtor(&hist);
697 }
698 }
699
700 ret = FAILURE;
701 }
702
703 if (!EG(exception) && zend_hash_exists(&Z_OBJCE_P(getThis())->function_table, "onfinish", sizeof("onfinish"))) {
704 zval *param;
705
706 MAKE_STD_ZVAL(param);
707 ZVAL_BOOL(param, ret == SUCCESS);
708 with_error_handling(EH_NORMAL, NULL) {
709 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL, "onfinish", NULL, param);
710 } end_error_handling();
711 zval_ptr_dtor(&param);
712 }
713
714 return ret;
715 }
716
717 static int apply_pretty_key(void *pDest, int num_args, va_list args, zend_hash_key *hash_key)
718 {
719 if (hash_key->nKeyLength > 1) {
720 hash_key->h = zend_get_hash_value(pretty_key(hash_key->arKey, hash_key->nKeyLength - 1, 1, 0), hash_key->nKeyLength);
721 }
722 return ZEND_HASH_APPLY_KEEP;
723 }
724
725 #define http_request_object_set_options_subr(key, ow, pk) \
726 _http_request_object_set_options_subr(INTERNAL_FUNCTION_PARAM_PASSTHRU, (key), sizeof(key), (ow), (pk))
727 static inline void _http_request_object_set_options_subr(INTERNAL_FUNCTION_PARAMETERS, char *key, size_t len, int overwrite, int prettify_keys)
728 {
729 zval *old_opts, *new_opts, *opts = NULL, **entry = NULL;
730
731 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|a/!", &opts)) {
732 RETURN_FALSE;
733 }
734
735 MAKE_STD_ZVAL(new_opts);
736 array_init(new_opts);
737 old_opts = GET_PROP(options);
738 if (Z_TYPE_P(old_opts) == IS_ARRAY) {
739 array_copy(old_opts, new_opts);
740 }
741
742 if (prettify_keys && opts) {
743 zend_hash_apply_with_arguments(Z_ARRVAL_P(opts), apply_pretty_key, 0);
744 }
745 if (SUCCESS == zend_hash_find(Z_ARRVAL_P(new_opts), key, len, (void *) &entry)) {
746 if (overwrite) {
747 zend_hash_clean(Z_ARRVAL_PP(entry));
748 }
749 if (opts && zend_hash_num_elements(Z_ARRVAL_P(opts))) {
750 if (overwrite) {
751 array_copy(opts, *entry);
752 } else {
753 array_merge(opts, *entry);
754 }
755 }
756 } else if (opts) {
757 ZVAL_ADDREF(opts);
758 add_assoc_zval(new_opts, key, opts);
759 }
760 SET_PROP(options, new_opts);
761 zval_ptr_dtor(&new_opts);
762
763 RETURN_TRUE;
764 }
765
766 #define http_request_object_get_options_subr(key) \
767 _http_request_get_options_subr(INTERNAL_FUNCTION_PARAM_PASSTHRU, (key), sizeof(key))
768 static inline void _http_request_get_options_subr(INTERNAL_FUNCTION_PARAMETERS, char *key, size_t len)
769 {
770 NO_ARGS;
771
772 if (return_value_used) {
773 zval *opts, **options;
774
775 opts = GET_PROP(options);
776 array_init(return_value);
777
778 if ( (Z_TYPE_P(opts) == IS_ARRAY) &&
779 (SUCCESS == zend_hash_find(Z_ARRVAL_P(opts), key, len, (void *) &options))) {
780 convert_to_array(*options);
781 array_copy(*options, return_value);
782 }
783 }
784 }
785
786
787 /* ### USERLAND ### */
788
789 /* {{{ proto void HttpRequest::__construct([string url[, int request_method = HTTP_METH_GET[, array options]]])
790 *
791 * Instantiate a new HttpRequest object.
792 *
793 * Accepts a string as optional parameter containing the target request url.
794 * Additionally accepts an optional int parameter specifying the request method
795 * to use and an associative array as optional third parameter which will be
796 * passed to HttpRequest::setOptions().
797 *
798 * Throws HttpException.
799 */
800 PHP_METHOD(HttpRequest, __construct)
801 {
802 char *URL = NULL;
803 int URL_len;
804 long meth = -1;
805 zval *options = NULL;
806
807 SET_EH_THROW_HTTP();
808 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|sla!", &URL, &URL_len, &meth, &options)) {
809 if (URL) {
810 UPD_STRL(url, URL, URL_len);
811 }
812 if (meth > -1) {
813 UPD_PROP(long, method, meth);
814 }
815 if (options) {
816 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL, "setoptions", NULL, options);
817 }
818 }
819 SET_EH_NORMAL();
820 }
821 /* }}} */
822
823 /* {{{ proto bool HttpRequest::setOptions([array options])
824 *
825 * Set the request options to use. See http_get() for a full list of available options.
826 *
827 * Accepts an array as optional parameters, which values will overwrite the
828 * currently set request options. If the parameter is empty or omitted,
829 * the options of the HttpRequest object will be reset.
830 *
831 * Returns TRUE on success, or FALSE on failure.
832 */
833 PHP_METHOD(HttpRequest, setOptions)
834 {
835 char *key = NULL;
836 ulong idx = 0;
837 HashPosition pos;
838 zval *opts = NULL, *old_opts, *new_opts, *add_opts, **opt;
839
840 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|a!/", &opts)) {
841 RETURN_FALSE;
842 }
843
844 MAKE_STD_ZVAL(new_opts);
845 array_init(new_opts);
846
847 if (!opts || !zend_hash_num_elements(Z_ARRVAL_P(opts))) {
848 SET_PROP(options, new_opts);
849 zval_ptr_dtor(&new_opts);
850 RETURN_TRUE;
851 }
852
853 MAKE_STD_ZVAL(add_opts);
854 array_init(add_opts);
855 /* some options need extra attention -- thus cannot use array_merge() directly */
856 FOREACH_KEYVAL(pos, opts, key, idx, opt) {
857 if (key) {
858 if (!strcmp(key, "headers")) {
859 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL, "addheaders", NULL, *opt);
860 } else if (!strcmp(key, "cookies")) {
861 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL, "addcookies", NULL, *opt);
862 } else if (!strcmp(key, "ssl")) {
863 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL, "addssloptions", NULL, *opt);
864 } else if ((!strcasecmp(key, "url")) || (!strcasecmp(key, "uri"))) {
865 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL, "seturl", NULL, *opt);
866 } else if (!strcmp(key, "method")) {
867 zend_call_method_with_1_params(&getThis(), Z_OBJCE_P(getThis()), NULL, "setmethod", NULL, *opt);
868 #if HTTP_CURL_VERSION(7,14,1)
869 } else if (!strcmp(key, "resetcookies")) {
870 getObject(http_request_object, obj);
871 http_request_reset_cookies(obj->request, 0);
872 #endif
873 } else if (!strcmp(key, "enablecookies")) {
874 getObject(http_request_object, obj);
875 http_request_enable_cookies(obj->request);
876 } else if (!strcasecmp(key, "recordHistory")) {
877 UPD_PROP(bool, recordHistory, 1);
878 } else {
879 ZVAL_ADDREF(*opt);
880 add_assoc_zval(add_opts, key, *opt);
881 }
882 /* reset */
883 key = NULL;
884 }
885 }
886
887 old_opts = GET_PROP(options);
888 if (Z_TYPE_P(old_opts) == IS_ARRAY) {
889 array_copy(old_opts, new_opts);
890 }
891 array_merge(add_opts, new_opts);
892 SET_PROP(options, new_opts);
893 zval_ptr_dtor(&new_opts);
894 zval_ptr_dtor(&add_opts);
895
896 RETURN_TRUE;
897 }
898 /* }}} */
899
900 /* {{{ proto array HttpRequest::getOptions()
901 *
902 * Get currently set options.
903 *
904 * Returns an associative array containing currently set options.
905 */
906 PHP_METHOD(HttpRequest, getOptions)
907 {
908 NO_ARGS;
909
910 if (return_value_used) {
911 RETURN_PROP(options);
912 }
913 }
914 /* }}} */
915
916 /* {{{ proto bool HttpRequest::setSslOptions([array options])
917 *
918 * Set SSL options.
919 *
920 * Accepts an associative array as parameter containing any SSL specific options.
921 * If the parameter is empty or omitted, the SSL options will be reset.
922 *
923 * Returns TRUE on success, or FALSE on failure.
924 */
925 PHP_METHOD(HttpRequest, setSslOptions)
926 {
927 http_request_object_set_options_subr("ssl", 1, 0);
928 }
929 /* }}} */
930
931 /* {{{ proto bool HttpRequest::addSslOptions(array options)
932 *
933 * Set additional SSL options.
934 *
935 * Expects an associative array as parameter containing additional SSL specific options.
936 *
937 * Returns TRUE on success, or FALSE on failure.
938 */
939 PHP_METHOD(HttpRequest, addSslOptions)
940 {
941 http_request_object_set_options_subr("ssl", 0, 0);
942 }
943 /* }}} */
944
945 /* {{{ proto array HttpRequest::getSslOtpions()
946 *
947 * Get previously set SSL options.
948 *
949 * Returns an associative array containing any previously set SSL options.
950 */
951 PHP_METHOD(HttpRequest, getSslOptions)
952 {
953 http_request_object_get_options_subr("ssl");
954 }
955 /* }}} */
956
957 /* {{{ proto bool HttpRequest::addHeaders(array headers)
958 *
959 * Add request header name/value pairs.
960 *
961 * Expects an associative array as parameter containing additional header
962 * name/value pairs.
963 *
964 * Returns TRUE on success, or FALSE on failure.
965 */
966 PHP_METHOD(HttpRequest, addHeaders)
967 {
968 http_request_object_set_options_subr("headers", 0, 1);
969 }
970
971 /* {{{ proto bool HttpRequest::setHeaders([array headers])
972 *
973 * Set request header name/value pairs.
974 *
975 * Accepts an associative array as parameter containing header name/value pairs.
976 * If the parameter is empty or omitted, all previously set headers will be unset.
977 *
978 * Returns TRUE on success, or FALSE on failure.
979 */
980 PHP_METHOD(HttpRequest, setHeaders)
981 {
982 http_request_object_set_options_subr("headers", 1, 1);
983 }
984 /* }}} */
985
986 /* {{{ proto array HttpRequest::getHeaders()
987 *
988 * Get previously set request headers.
989 *
990 * Returns an associative array containing all currently set headers.
991 */
992 PHP_METHOD(HttpRequest, getHeaders)
993 {
994 http_request_object_get_options_subr("headers");
995 }
996 /* }}} */
997
998 /* {{{ proto bool HttpRequest::setCookies([array cookies])
999 *
1000 * Set cookies.
1001 *
1002 * Accepts an associative array as parameter containing cookie name/value pairs.
1003 * If the parameter is empty or omitted, all previously set cookies will be unset.
1004 *
1005 * Returns TRUE on success, or FALSE on failure.
1006 */
1007 PHP_METHOD(HttpRequest, setCookies)
1008 {
1009 http_request_object_set_options_subr("cookies", 1, 0);
1010 }
1011 /* }}} */
1012
1013 /* {{{ proto bool HttpRequest::addCookies(array cookies)
1014 *
1015 * Add cookies.
1016 *
1017 * Expects an associative array as parameter containing any cookie name/value
1018 * pairs to add.
1019 *
1020 * Returns TRUE on success, or FALSE on failure.
1021 */
1022 PHP_METHOD(HttpRequest, addCookies)
1023 {
1024 http_request_object_set_options_subr("cookies", 0, 0);
1025 }
1026 /* }}} */
1027
1028 /* {{{ proto array HttpRequest::getCookies()
1029 *
1030 * Get previously set cookies.
1031 *
1032 * Returns an associative array containing any previously set cookies.
1033 */
1034 PHP_METHOD(HttpRequest, getCookies)
1035 {
1036 http_request_object_get_options_subr("cookies");
1037 }
1038 /* }}} */
1039
1040 /* {{{ proto bool HttpRequest::enableCookies()
1041 *
1042 * Enable automatic sending of received cookies.
1043 * Note that cuutomly set cookies will be sent anyway.
1044 */
1045 PHP_METHOD(HttpRequest, enableCookies)
1046 {
1047 NO_ARGS {
1048 getObject(http_request_object, obj);
1049 RETURN_SUCCESS(http_request_enable_cookies(obj->request));
1050 }
1051
1052 }
1053 /* }}} */
1054
1055 /* {{{ proto bool HttpRequest::resetCookies([bool session_only = FALSE])
1056 *
1057 * Reset all automatically received/sent cookies.
1058 * Note that customly set cookies are not affected.
1059 *
1060 * Accepts an optional bool parameter specifying
1061 * whether only session cookies should be reset
1062 * (needs libcurl >= v7.15.4, else libcurl >= v7.14.1).
1063 *
1064 * Returns TRUE on success, or FALSE on failure.
1065 */
1066 PHP_METHOD(HttpRequest, resetCookies)
1067 {
1068 zend_bool session_only = 0;
1069 getObject(http_request_object, obj);
1070
1071 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|b", &session_only)) {
1072 RETURN_FALSE;
1073 }
1074 RETURN_SUCCESS(http_request_reset_cookies(obj->request, session_only));
1075 }
1076 /* }}} */
1077
1078 /* {{{ proto bool HttpRequest::setUrl(string url)
1079 *
1080 * Set the request URL.
1081 *
1082 * Expects a string as parameter specifying the request url.
1083 *
1084 * Returns TRUE on success, or FALSE on failure.
1085 */
1086 PHP_METHOD(HttpRequest, setUrl)
1087 {
1088 char *URL = NULL;
1089 int URL_len;
1090
1091 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &URL, &URL_len)) {
1092 RETURN_FALSE;
1093 }
1094
1095 UPD_STRL(url, URL, URL_len);
1096 RETURN_TRUE;
1097 }
1098 /* }}} */
1099
1100 /* {{{ proto string HttpRequest::getUrl()
1101 *
1102 * Get the previously set request URL.
1103 *
1104 * Returns the currently set request url as string.
1105 */
1106 PHP_METHOD(HttpRequest, getUrl)
1107 {
1108 NO_ARGS;
1109
1110 if (return_value_used) {
1111 RETURN_PROP(url);
1112 }
1113 }
1114 /* }}} */
1115
1116 /* {{{ proto bool HttpRequest::setMethod(int request_method)
1117 *
1118 * Set the request method.
1119 *
1120 * Expects an int as parameter specifying the request method to use.
1121 * In PHP 5.1+ HttpRequest::METH_*, otherwise the HTTP_METH_* constants can be used.
1122 *
1123 * Returns TRUE on success, or FALSE on failure.
1124 */
1125 PHP_METHOD(HttpRequest, setMethod)
1126 {
1127 long meth;
1128
1129 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l", &meth)) {
1130 RETURN_FALSE;
1131 }
1132
1133 UPD_PROP(long, method, meth);
1134 RETURN_TRUE;
1135 }
1136 /* }}} */
1137
1138 /* {{{ proto int HttpRequest::getMethod()
1139 *
1140 * Get the previously set request method.
1141 *
1142 * Returns the currently set request method.
1143 */
1144 PHP_METHOD(HttpRequest, getMethod)
1145 {
1146 NO_ARGS;
1147
1148 if (return_value_used) {
1149 RETURN_PROP(method);
1150 }
1151 }
1152 /* }}} */
1153
1154 /* {{{ proto bool HttpRequest::setContentType(string content_type)
1155 *
1156 * Set the content type the post request should have.
1157 *
1158 * Expects a string as parameters containing the content type of the request
1159 * (primary/secondary).
1160 *
1161 * Returns TRUE on success, or FALSE if the content type does not seem to
1162 * contain a primary and a secondary part.
1163 */
1164 PHP_METHOD(HttpRequest, setContentType)
1165 {
1166 char *ctype;
1167 int ct_len;
1168
1169 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &ctype, &ct_len)) {
1170 RETURN_FALSE;
1171 }
1172
1173 if (ct_len) {
1174 HTTP_CHECK_CONTENT_TYPE(ctype, RETURN_FALSE);
1175 }
1176 UPD_STRL(contentType, ctype, ct_len);
1177 RETURN_TRUE;
1178 }
1179 /* }}} */
1180
1181 /* {{{ proto string HttpRequest::getContentType()
1182 *
1183 * Get the previously content type.
1184 *
1185 * Returns the previously set content type as string.
1186 */
1187 PHP_METHOD(HttpRequest, getContentType)
1188 {
1189 NO_ARGS;
1190
1191 if (return_value_used) {
1192 RETURN_PROP(contentType);
1193 }
1194 }
1195 /* }}} */
1196
1197 /* {{{ proto bool HttpRequest::setQueryData([mixed query_data])
1198 *
1199 * Set the URL query parameters to use, overwriting previously set query parameters.
1200 * Affects any request types.
1201 *
1202 * Accepts a string or associative array parameter containing the pre-encoded
1203 * query string or to be encoded query fields. If the parameter is empty or
1204 * omitted, the query data will be unset.
1205 *
1206 * Returns TRUE on success, or FALSE on failure.
1207 */
1208 PHP_METHOD(HttpRequest, setQueryData)
1209 {
1210 zval *qdata = NULL;
1211
1212 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z!", &qdata)) {
1213 RETURN_FALSE;
1214 }
1215
1216 if ((!qdata) || Z_TYPE_P(qdata) == IS_NULL) {
1217 UPD_STRL(queryData, "", 0);
1218 } else if ((Z_TYPE_P(qdata) == IS_ARRAY) || (Z_TYPE_P(qdata) == IS_OBJECT)) {
1219 char *query_data = NULL;
1220
1221 if (SUCCESS != http_urlencode_hash(HASH_OF(qdata), &query_data)) {
1222 RETURN_FALSE;
1223 }
1224
1225 UPD_PROP(string, queryData, query_data);
1226 efree(query_data);
1227 } else {
1228 zval *orig = qdata;
1229
1230 convert_to_string_ex(&qdata);
1231 UPD_STRL(queryData, Z_STRVAL_P(qdata), Z_STRLEN_P(qdata));
1232 if (orig != qdata) {
1233 zval_ptr_dtor(&qdata);
1234 }
1235 }
1236 RETURN_TRUE;
1237 }
1238 /* }}} */
1239
1240 /* {{{ proto string HttpRequest::getQueryData()
1241 *
1242 * Get the current query data in form of an urlencoded query string.
1243 *
1244 * Returns a string containing the urlencoded query.
1245 */
1246 PHP_METHOD(HttpRequest, getQueryData)
1247 {
1248 NO_ARGS;
1249
1250 if (return_value_used) {
1251 RETURN_PROP(queryData);
1252 }
1253 }
1254 /* }}} */
1255
1256 /* {{{ proto bool HttpRequest::addQueryData(array query_params)
1257 *
1258 * Add parameters to the query parameter list, leaving previously set unchanged.
1259 * Affects any request type.
1260 *
1261 * Expects an associative array as parameter containing the query fields to add.
1262 *
1263 * Returns TRUE on success, or FALSE on failure.
1264 */
1265 PHP_METHOD(HttpRequest, addQueryData)
1266 {
1267 zval *qdata, *old_qdata;
1268 char *query_data = NULL;
1269 size_t query_data_len = 0;
1270
1271 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a/", &qdata)) {
1272 RETURN_FALSE;
1273 }
1274
1275 old_qdata = GET_PROP(queryData);
1276
1277 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)) {
1278 RETURN_FALSE;
1279 }
1280
1281 UPD_STRL(queryData, query_data, query_data_len);
1282 efree(query_data);
1283
1284 RETURN_TRUE;
1285 }
1286 /* }}} */
1287
1288 /* {{{ proto bool HttpRequest::addPostFields(array post_data)
1289 *
1290 * Adds POST data entries, leaving previously set unchanged, unless a
1291 * post entry with the same name already exists.
1292 * Affects only POST and custom requests.
1293 *
1294 * Expects an associative array as parameter containing the post fields.
1295 *
1296 * Returns TRUE on success, or FALSE on failure.
1297 */
1298 PHP_METHOD(HttpRequest, addPostFields)
1299 {
1300 zval *post_data, *old_post, *new_post;
1301
1302 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a/", &post_data)) {
1303 RETURN_FALSE;
1304 }
1305
1306 if (zend_hash_num_elements(Z_ARRVAL_P(post_data))) {
1307 MAKE_STD_ZVAL(new_post);
1308 array_init(new_post);
1309 old_post = GET_PROP(postFields);
1310 if (Z_TYPE_P(old_post) == IS_ARRAY) {
1311 array_copy(old_post, new_post);
1312 }
1313 array_merge(post_data, new_post);
1314 SET_PROP(postFields, new_post);
1315 zval_ptr_dtor(&new_post);
1316 }
1317
1318 RETURN_TRUE;
1319 }
1320 /* }}} */
1321
1322 /* {{{ proto bool HttpRequest::setPostFields([array post_data])
1323 *
1324 * Set the POST data entries, overwriting previously set POST data.
1325 * Affects only POST and custom requests.
1326 *
1327 * Accepts an associative array as parameter containing the post fields.
1328 * If the parameter is empty or omitted, the post data will be unset.
1329 *
1330 * Returns TRUE on success, or FALSE on failure.
1331 */
1332 PHP_METHOD(HttpRequest, setPostFields)
1333 {
1334 zval *post, *post_data = NULL;
1335
1336 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a/!", &post_data)) {
1337 RETURN_FALSE;
1338 }
1339
1340 MAKE_STD_ZVAL(post);
1341 array_init(post);
1342 if (post_data && zend_hash_num_elements(Z_ARRVAL_P(post_data))) {
1343 array_copy(post_data, post);
1344 }
1345 SET_PROP(postFields, post);
1346 zval_ptr_dtor(&post);
1347
1348 RETURN_TRUE;
1349 }
1350 /* }}}*/
1351
1352 /* {{{ proto array HttpRequest::getPostFields()
1353 *
1354 * Get previously set POST data.
1355 *
1356 * Returns the currently set post fields as associative array.
1357 */
1358 PHP_METHOD(HttpRequest, getPostFields)
1359 {
1360 NO_ARGS;
1361
1362 if (return_value_used) {
1363 RETURN_PROP(postFields);
1364 }
1365 }
1366 /* }}} */
1367
1368 /* {{{ proto bool HttpRequest::setRawPostData([string raw_post_data])
1369 *
1370 * Set raw post data to send, overwriting previously set raw post data. Don't
1371 * forget to specify a content type. Affects only POST and custom requests.
1372 * Only either post fields or raw post data can be used for each request.
1373 * Raw post data has higher precedence and will be used even if post fields
1374 * are set.
1375 *
1376 * Accepts a string as parameter containing the *raw* post data.
1377 *
1378 * Returns TRUE on success, or FALSE on failure.
1379 */
1380 PHP_METHOD(HttpRequest, setRawPostData)
1381 {
1382 char *raw_data = NULL;
1383 int data_len = 0;
1384
1385 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|s", &raw_data, &data_len)) {
1386 RETURN_FALSE;
1387 }
1388
1389 if (!raw_data) {
1390 raw_data = "";
1391 }
1392
1393 UPD_STRL(rawPostData, raw_data, data_len);
1394 RETURN_TRUE;
1395 }
1396 /* }}} */
1397
1398 /* {{{ proto bool HttpRequest::addRawPostData(string raw_post_data)
1399 *
1400 * Add raw post data, leaving previously set raw post data unchanged.
1401 * Affects only POST and custom requests.
1402 *
1403 * Expects a string as parameter containing the raw post data to concatenate.
1404 *
1405 * Returns TRUE on success, or FALSE on failure.
1406 */
1407 PHP_METHOD(HttpRequest, addRawPostData)
1408 {
1409 char *raw_data;
1410 int data_len;
1411
1412 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &raw_data, &data_len)) {
1413 RETURN_FALSE;
1414 }
1415
1416 if (data_len) {
1417 zval *data = GET_PROP(rawPostData);
1418
1419 if (Z_STRLEN_P(data)) {
1420 Z_STRVAL_P(data) = erealloc(Z_STRVAL_P(data), (Z_STRLEN_P(data) += data_len) + 1);
1421 Z_STRVAL_P(data)[Z_STRLEN_P(data)] = '\0';
1422 memcpy(Z_STRVAL_P(data) + Z_STRLEN_P(data) - data_len, raw_data, data_len);
1423 } else {
1424 UPD_STRL(putData, raw_data, data_len);
1425 }
1426 }
1427
1428 RETURN_TRUE;
1429 }
1430 /* }}} */
1431
1432 /* {{{ proto string HttpRequest::getRawPostData()
1433 *
1434 * Get previously set raw post data.
1435 *
1436 * Returns a string containing the currently set raw post data.
1437 */
1438 PHP_METHOD(HttpRequest, getRawPostData)
1439 {
1440 NO_ARGS;
1441
1442 if (return_value_used) {
1443 RETURN_PROP(rawPostData);
1444 }
1445 }
1446 /* }}} */
1447
1448 /* {{{ proto bool HttpRequest::addPostFile(string name, string file[, string content_type = "application/x-octetstream"])
1449 *
1450 * Add a file to the POST request, leaving previously set files unchanged.
1451 * Affects only POST and custom requests. Cannot be used with raw post data.
1452 *
1453 * Expects a string parameter containing the form element name, and a string
1454 * paremeter containing the path to the file which should be uploaded.
1455 * Additionally accepts an optional string parameter which should contain
1456 * the content type of the file.
1457 *
1458 * Returns TRUE on success, or FALSE if the content type seems not to contain a
1459 * primary and a secondary content type part.
1460 */
1461 PHP_METHOD(HttpRequest, addPostFile)
1462 {
1463 zval *entry, *old_post, *new_post;
1464 char *name, *file, *type = NULL;
1465 int name_len, file_len, type_len = 0;
1466
1467 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "ss|s", &name, &name_len, &file, &file_len, &type, &type_len)) {
1468 RETURN_FALSE;
1469 }
1470
1471 if (type_len) {
1472 HTTP_CHECK_CONTENT_TYPE(type, RETURN_FALSE);
1473 } else {
1474 type = "application/x-octetstream";
1475 type_len = sizeof("application/x-octetstream") - 1;
1476 }
1477
1478 MAKE_STD_ZVAL(entry);
1479 array_init(entry);
1480
1481 add_assoc_stringl(entry, "name", name, name_len, 1);
1482 add_assoc_stringl(entry, "type", type, type_len, 1);
1483 add_assoc_stringl(entry, "file", file, file_len, 1);
1484
1485 MAKE_STD_ZVAL(new_post);
1486 array_init(new_post);
1487 old_post = GET_PROP(postFiles);
1488 if (Z_TYPE_P(old_post) == IS_ARRAY) {
1489 array_copy(old_post, new_post);
1490 }
1491 add_next_index_zval(new_post, entry);
1492 SET_PROP(postFiles, new_post);
1493 zval_ptr_dtor(&new_post);
1494
1495 RETURN_TRUE;
1496 }
1497 /* }}} */
1498
1499 /* {{{ proto bool HttpRequest::setPostFiles([array post_files])
1500 *
1501 * Set files to post, overwriting previously set post files.
1502 * Affects only POST and requests. Cannot be used with raw post data.
1503 *
1504 * Accepts an array containing the files to post. Each entry should be an
1505 * associative array with "name", "file" and "type" keys. If the parameter
1506 * is empty or omitted the post files will be unset.
1507 *
1508 * Returns TRUE on success, or FALSE on failure.
1509 */
1510 PHP_METHOD(HttpRequest, setPostFiles)
1511 {
1512 zval *files = NULL, *post;
1513
1514 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a!/", &files)) {
1515 RETURN_FALSE;
1516 }
1517
1518 MAKE_STD_ZVAL(post);
1519 array_init(post);
1520 if (files && (Z_TYPE_P(files) == IS_ARRAY)) {
1521 array_copy(files, post);
1522 }
1523 SET_PROP(postFiles, post);
1524 zval_ptr_dtor(&post);
1525
1526 RETURN_TRUE;
1527 }
1528 /* }}} */
1529
1530 /* {{{ proto array HttpRequest::getPostFiles()
1531 *
1532 * Get all previously added POST files.
1533 *
1534 * Returns an array containing currently set post files.
1535 */
1536 PHP_METHOD(HttpRequest, getPostFiles)
1537 {
1538 NO_ARGS;
1539
1540 if (return_value_used) {
1541 RETURN_PROP(postFiles);
1542 }
1543 }
1544 /* }}} */
1545
1546 /* {{{ proto bool HttpRequest::setPutFile([string file])
1547 *
1548 * Set file to put. Affects only PUT requests.
1549 *
1550 * Accepts a string as parameter referencing the path to file.
1551 * If the parameter is empty or omitted the put file will be unset.
1552 *
1553 * Returns TRUE on success, or FALSE on failure.
1554 */
1555 PHP_METHOD(HttpRequest, setPutFile)
1556 {
1557 char *file = "";
1558 int file_len = 0;
1559
1560 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|s", &file, &file_len)) {
1561 RETURN_FALSE;
1562 }
1563
1564 UPD_STRL(putFile, file, file_len);
1565 RETURN_TRUE;
1566 }
1567 /* }}} */
1568
1569 /* {{{ proto string HttpRequest::getPutFile()
1570 *
1571 * Get previously set put file.
1572 *
1573 * Returns a string containing the path to the currently set put file.
1574 */
1575 PHP_METHOD(HttpRequest, getPutFile)
1576 {
1577 NO_ARGS;
1578
1579 if (return_value_used) {
1580 RETURN_PROP(putFile);
1581 }
1582 }
1583 /* }}} */
1584
1585 /* {{{ proto bool HttpRequest::setPutData([string put_data])
1586 *
1587 * Set PUT data to send, overwriting previously set PUT data.
1588 * Affects only PUT requests.
1589 * Only either PUT data or PUT file can be used for each request.
1590 * PUT data has higher precedence and will be used even if a PUT
1591 * file is set.
1592 *
1593 * Accepts a string as parameter containing the data to upload.
1594 *
1595 * Returns TRUE on success, or FALSE on failure.
1596 */
1597 PHP_METHOD(HttpRequest, setPutData)
1598 {
1599 char *put_data = NULL;
1600 int data_len = 0;
1601
1602 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|s", &put_data, &data_len)) {
1603 RETURN_FALSE;
1604 }
1605
1606 if (!put_data) {
1607 put_data = "";
1608 }
1609
1610 UPD_STRL(putData, put_data, data_len);
1611 RETURN_TRUE;
1612 }
1613 /* }}} */
1614
1615 /* {{{ proto bool HttpRequest::addPutData(string put_data)
1616 *
1617 * Add PUT data, leaving previously set PUT data unchanged.
1618 * Affects only PUT requests.
1619 *
1620 * Expects a string as parameter containing the data to concatenate.
1621 *
1622 * Returns TRUE on success, or FALSE on failure.
1623 */
1624 PHP_METHOD(HttpRequest, addPutData)
1625 {
1626 char *put_data;
1627 int data_len;
1628
1629 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &put_data, &data_len)) {
1630 RETURN_FALSE;
1631 }
1632
1633 if (data_len) {
1634 zval *data = GET_PROP(putData);
1635
1636 if (Z_STRLEN_P(data)) {
1637 Z_STRVAL_P(data) = erealloc(Z_STRVAL_P(data), (Z_STRLEN_P(data) += data_len) + 1);
1638 Z_STRVAL_P(data)[Z_STRLEN_P(data)] = '\0';
1639 memcpy(Z_STRVAL_P(data) + Z_STRLEN_P(data) - data_len, put_data, data_len);
1640 } else {
1641 UPD_STRL(putData, put_data, data_len);
1642 }
1643 }
1644
1645 RETURN_TRUE;
1646 }
1647 /* }}} */
1648
1649 /* {{{ proto string HttpRequest::getPutData()
1650 *
1651 * Get previously set PUT data.
1652 *
1653 * Returns a string containing the currently set raw post data.
1654 */
1655 PHP_METHOD(HttpRequest, getPutData)
1656 {
1657 NO_ARGS;
1658
1659 if (return_value_used) {
1660 RETURN_PROP(putData);
1661 }
1662 }
1663 /* }}} */
1664
1665 /* {{{ proto array HttpRequest::getResponseData()
1666 *
1667 * Get all response data after the request has been sent.
1668 *
1669 * Returns an associative array with the key "headers" containing an associative
1670 * array holding all response headers, as well as the key "body" containing a
1671 * string with the response body.
1672 *
1673 * If redirects were allowed and several responses were received, the data
1674 * references the last received response.
1675 */
1676 PHP_METHOD(HttpRequest, getResponseData)
1677 {
1678 NO_ARGS;
1679
1680 if (return_value_used) {
1681 char *body;
1682 size_t body_len;
1683 zval *headers, *message = GET_PROP(responseMessage);
1684
1685 if (Z_TYPE_P(message) == IS_OBJECT) {
1686 getObjectEx(http_message_object, msg, message);
1687
1688 array_init(return_value);
1689
1690 MAKE_STD_ZVAL(headers);
1691 array_init(headers);
1692 zend_hash_copy(Z_ARRVAL_P(headers), &msg->message->hdrs, (copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval *));
1693 add_assoc_zval(return_value, "headers", headers);
1694
1695 phpstr_data(PHPSTR(msg->message), &body, &body_len);
1696 add_assoc_stringl(return_value, "body", body, body_len, 0);
1697 }
1698 }
1699 }
1700 /* }}} */
1701
1702 /* {{{ proto mixed HttpRequest::getResponseHeader([string name])
1703 *
1704 * Get response header(s) after the request has been sent.
1705 *
1706 * Accepts an string as optional parameter specifying a certain header to read.
1707 * If the parameter is empty or omitted all response headers will be returned.
1708 *
1709 * Returns either a string with the value of the header matching name if requested,
1710 * FALSE on failure, or an associative array containing all response headers.
1711 *
1712 * If redirects were allowed and several responses were received, the data
1713 * references the last received response.
1714 */
1715 PHP_METHOD(HttpRequest, getResponseHeader)
1716 {
1717 if (return_value_used) {
1718 zval *header;
1719 char *header_name = NULL;
1720 int header_len = 0;
1721
1722 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|s", &header_name, &header_len)) {
1723 zval *message = GET_PROP(responseMessage);
1724
1725 if (Z_TYPE_P(message) == IS_OBJECT) {
1726 getObjectEx(http_message_object, msg, message);
1727
1728 if (header_len) {
1729 if ((header = http_message_header_ex(msg->message, pretty_key(header_name, header_len, 1, 1), header_len + 1, 0))) {
1730 RETURN_ZVAL(header, 1, 1);
1731 }
1732 } else {
1733 array_init(return_value);
1734 zend_hash_copy(Z_ARRVAL_P(return_value), &msg->message->hdrs, (copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval *));
1735 return;
1736 }
1737 }
1738 }
1739 RETURN_FALSE;
1740 }
1741 }
1742 /* }}} */
1743
1744 /* {{{ proto array HttpRequest::getResponseCookies([int flags[, array allowed_extras]])
1745 *
1746 * Get response cookie(s) after the request has been sent.
1747 *
1748 * Returns an array of stdClass objects like http_parse_cookie would return.
1749 *
1750 * If redirects were allowed and several responses were received, the data
1751 * references the last received response.
1752 */
1753 PHP_METHOD(HttpRequest, getResponseCookies)
1754 {
1755 if (return_value_used) {
1756 long flags = 0;
1757 zval *allowed_extras_array = NULL;
1758
1759 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|la!", &flags, &allowed_extras_array)) {
1760 int i = 0;
1761 ulong idx = 0;
1762 char *key = NULL, **allowed_extras = NULL;
1763 zval **header = NULL, **entry = NULL, *message = GET_PROP(responseMessage);
1764 HashPosition pos, pos1, pos2;
1765
1766 if (Z_TYPE_P(message) == IS_OBJECT) {
1767 getObjectEx(http_message_object, msg, message);
1768
1769 array_init(return_value);
1770
1771 if (allowed_extras_array) {
1772 allowed_extras = ecalloc(zend_hash_num_elements(Z_ARRVAL_P(allowed_extras_array)) + 1, sizeof(char *));
1773 FOREACH_VAL(pos, allowed_extras_array, entry) {
1774 ZVAL_ADDREF(*entry);
1775 convert_to_string_ex(entry);
1776 allowed_extras[i++] = estrndup(Z_STRVAL_PP(entry), Z_STRLEN_PP(entry));
1777 zval_ptr_dtor(entry);
1778 }
1779 }
1780
1781 FOREACH_HASH_KEYVAL(pos1, &msg->message->hdrs, key, idx, header) {
1782 if (key && !strcasecmp(key, "Set-Cookie")) {
1783 http_cookie_list list;
1784
1785 if (Z_TYPE_PP(header) == IS_ARRAY) {
1786 zval **single_header;
1787
1788 FOREACH_VAL(pos2, *header, single_header) {
1789 ZVAL_ADDREF(*single_header);
1790 convert_to_string_ex(single_header);
1791 if (http_parse_cookie_ex(&list, Z_STRVAL_PP(single_header), flags, allowed_extras)) {
1792 zval *cookie;
1793
1794 MAKE_STD_ZVAL(cookie);
1795 object_init(cookie);
1796 http_cookie_list_tostruct(&list, cookie);
1797 add_next_index_zval(return_value, cookie);
1798 http_cookie_list_dtor(&list);
1799 }
1800 zval_ptr_dtor(single_header);
1801 }
1802 } else {
1803 ZVAL_ADDREF(*header);
1804 convert_to_string_ex(header);
1805 if (http_parse_cookie_ex(&list, Z_STRVAL_PP(header), flags, allowed_extras)) {
1806 zval *cookie;
1807
1808 MAKE_STD_ZVAL(cookie);
1809 object_init(cookie);
1810 http_cookie_list_tostruct(&list, cookie);
1811 add_next_index_zval(return_value, cookie);
1812 http_cookie_list_dtor(&list);
1813 }
1814 zval_ptr_dtor(header);
1815 }
1816 }
1817 /* reset key */
1818 key = NULL;
1819 }
1820
1821 if (allowed_extras) {
1822 for (i = 0; allowed_extras[i]; ++i) {
1823 efree(allowed_extras[i]);
1824 }
1825 efree(allowed_extras);
1826 }
1827
1828 return;
1829 }
1830 }
1831 RETURN_FALSE;
1832 }
1833 }
1834 /* }}} */
1835
1836 /* {{{ proto string HttpRequest::getResponseBody()
1837 *
1838 * Get the response body after the request has been sent.
1839 *
1840 * Returns a string containing the response body.
1841 *
1842 * If redirects were allowed and several responses were received, the data
1843 * references the last received response.
1844 */
1845 PHP_METHOD(HttpRequest, getResponseBody)
1846 {
1847 NO_ARGS;
1848
1849 if (return_value_used) {
1850 zval *message = GET_PROP(responseMessage);
1851
1852 if (Z_TYPE_P(message) == IS_OBJECT) {
1853 getObjectEx(http_message_object, msg, message);
1854 RETURN_PHPSTR_DUP(&msg->message->body);
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