2 This file is part of GNUnet
3 (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file transport/plugin_transport_http_client.c
23 * @brief http transport service plugin
24 * @author Matthias Wachs
27 #include "plugin_transport_http.h"
31 * Function to log curl debug messages with GNUNET_log
33 * @param type curl_infotype
40 client_log (CURL * curl, curl_infotype type, char *data, size_t size, void *cls)
42 if (type == CURLINFO_TEXT)
46 memcpy (text, data, size);
47 if (text[size - 1] == '\n')
52 text[size + 1] = '\0';
55 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "transport-https",
56 "Client: %X - %s", cls, text);
58 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "transport-http",
59 "Client: %X - %s", cls, text);
67 * Task performing curl operations
68 * @param cls plugin as closure
69 * @param tc gnunet scheduler task context
72 client_run (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
75 * Function setting up file descriptors and scheduling task to run
77 * @param plugin plugin as closure
78 * @param now schedule task in 1ms, regardless of what curl may say
79 * @return GNUNET_SYSERR for hard failure, GNUNET_OK for ok
82 client_schedule (struct Plugin *plugin, int now)
88 struct GNUNET_NETWORK_FDSet *grs;
89 struct GNUNET_NETWORK_FDSet *gws;
92 struct GNUNET_TIME_Relative timeout;
94 /* Cancel previous scheduled task */
95 if (plugin->client_perform_task != GNUNET_SCHEDULER_NO_TASK)
97 GNUNET_SCHEDULER_cancel (plugin->client_perform_task);
98 plugin->client_perform_task = GNUNET_SCHEDULER_NO_TASK;
105 mret = curl_multi_fdset (plugin->client_mh, &rs, &ws, &es, &max);
106 if (mret != CURLM_OK)
108 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("%s failed at %s:%d: `%s'\n"),
109 "curl_multi_fdset", __FILE__, __LINE__,
110 curl_multi_strerror (mret));
111 return GNUNET_SYSERR;
113 mret = curl_multi_timeout (plugin->client_mh, &to);
115 timeout = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1);
117 timeout = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, to);
118 if (now == GNUNET_YES)
119 timeout = GNUNET_TIME_UNIT_MILLISECONDS;
121 if (mret != CURLM_OK)
123 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("%s failed at %s:%d: `%s'\n"),
124 "curl_multi_timeout", __FILE__, __LINE__,
125 curl_multi_strerror (mret));
126 return GNUNET_SYSERR;
129 grs = GNUNET_NETWORK_fdset_create ();
130 gws = GNUNET_NETWORK_fdset_create ();
131 GNUNET_NETWORK_fdset_copy_native (grs, &rs, max + 1);
132 GNUNET_NETWORK_fdset_copy_native (gws, &ws, max + 1);
134 plugin->client_perform_task =
135 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
136 GNUNET_SCHEDULER_NO_TASK, timeout, grs, gws,
137 &client_run, plugin);
138 GNUNET_NETWORK_fdset_destroy (gws);
139 GNUNET_NETWORK_fdset_destroy (grs);
145 client_send (struct Session *s, struct HTTP_Message *msg)
147 GNUNET_assert (s != NULL);
148 GNUNET_CONTAINER_DLL_insert (s->msg_head, s->msg_tail, msg);
150 if (s->client_put_paused == GNUNET_YES)
153 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, s->plugin->name,
154 "Client: %X was suspended, unpausing\n", s->client_put);
156 s->client_put_paused = GNUNET_NO;
157 curl_easy_pause (s->client_put, CURLPAUSE_CONT);
160 client_schedule (s->plugin, GNUNET_YES);
168 * Task performing curl operations
169 * @param cls plugin as closure
170 * @param tc gnunet scheduler task context
173 client_run (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
175 struct Plugin *plugin = cls;
179 GNUNET_assert (cls != NULL);
181 plugin->client_perform_task = GNUNET_SCHEDULER_NO_TASK;
182 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
188 mret = curl_multi_perform (plugin->client_mh, &running);
193 while ((msg = curl_multi_info_read (plugin->client_mh, &msgs_left)))
195 CURL *easy_h = msg->easy_handle;
196 struct Session *s = NULL;
197 char *d = (char *) s;
200 //GNUNET_assert (easy_h != NULL);
203 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
204 "Client: connection to ended with reason %i: `%s', %i handles running\n",
206 curl_easy_strerror (msg->data.result), running);
210 GNUNET_assert (CURLE_OK ==
211 curl_easy_getinfo (easy_h, CURLINFO_PRIVATE, &d));
212 s = (struct Session *) d;
213 GNUNET_assert (s != NULL);
215 if (msg->msg == CURLMSG_DONE)
217 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
218 "Client: %X connection to '%s' %s ended with reason %i: `%s'\n",
219 msg->easy_handle, GNUNET_i2s (&s->target),
220 http_plugin_address_to_string (NULL, s->addr,
223 curl_easy_strerror (msg->data.result));
225 client_disconnect (s);
226 //GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,"Notifying about ended session to peer `%s' `%s'\n", GNUNET_i2s (&s->target), http_plugin_address_to_string (plugin, s->addr, s->addrlen));
227 notify_session_end (plugin, &s->target, s);
231 while (mret == CURLM_CALL_MULTI_PERFORM);
232 client_schedule (plugin, GNUNET_NO);
236 client_disconnect (struct Session *s)
240 struct Plugin *plugin = s->plugin;
241 struct HTTP_Message *msg;
242 struct HTTP_Message *t;
246 if (s->client_put != NULL)
249 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
250 "Client: %X Deleting outbound PUT session to peer `%s'\n",
251 s->client_put, GNUNET_i2s (&s->target));
254 mret = curl_multi_remove_handle (plugin->client_mh, s->client_put);
255 if (mret != CURLM_OK)
257 curl_easy_cleanup (s->client_put);
261 curl_easy_cleanup (s->client_put);
262 s->client_put = NULL;
266 if (s->recv_wakeup_task != GNUNET_SCHEDULER_NO_TASK)
268 GNUNET_SCHEDULER_cancel (s->recv_wakeup_task);
269 s->recv_wakeup_task = GNUNET_SCHEDULER_NO_TASK;
272 if (s->client_get != NULL)
275 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
276 "Client: %X Deleting outbound GET session to peer `%s'\n",
277 s->client_get, GNUNET_i2s (&s->target));
280 mret = curl_multi_remove_handle (plugin->client_mh, s->client_get);
281 if (mret != CURLM_OK)
283 curl_easy_cleanup (s->client_get);
287 curl_easy_cleanup (s->client_get);
288 s->client_get = NULL;
295 if (NULL != msg->transmit_cont)
296 msg->transmit_cont (msg->transmit_cont_cls, &s->target, GNUNET_SYSERR);
297 GNUNET_CONTAINER_DLL_remove (s->msg_head, s->msg_tail, msg);
302 plugin->cur_connections -= 2;
303 /* Re-schedule since handles have changed */
304 if (plugin->client_perform_task != GNUNET_SCHEDULER_NO_TASK)
306 GNUNET_SCHEDULER_cancel (plugin->client_perform_task);
307 plugin->client_perform_task = GNUNET_SCHEDULER_NO_TASK;
310 client_schedule (plugin, GNUNET_YES);
316 client_receive_mst_cb (void *cls, void *client,
317 const struct GNUNET_MessageHeader *message)
319 struct Session *s = cls;
320 struct GNUNET_TIME_Relative delay;
322 delay = http_plugin_receive (s, &s->target, message, s, s->addr, s->addrlen);
324 GNUNET_TIME_absolute_add (GNUNET_TIME_absolute_get (), delay);
326 if (GNUNET_TIME_absolute_get ().abs_value < s->next_receive.abs_value)
329 struct Plugin *plugin = s->plugin;
331 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
332 "Client: peer `%s' address `%s' next read delayed for %llu ms\n",
333 GNUNET_i2s (&s->target), GNUNET_a2s (s->addr, s->addrlen),
340 client_wake_up (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
342 struct Session *s = cls;
344 s->recv_wakeup_task = GNUNET_SCHEDULER_NO_TASK;
346 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
349 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, s->plugin->name,
350 "Client: %X Waking up receive handle\n", s->client_get);
352 if (s->client_get != NULL)
353 curl_easy_pause (s->client_get, CURLPAUSE_CONT);
358 * Callback method used with libcurl
359 * Method is called when libcurl needs to write data during sending
360 * @param stream pointer where to write data
361 * @param size size of an individual element
362 * @param nmemb count of elements that can be written to the buffer
363 * @param cls destination pointer, passed to the libcurl handle
364 * @return bytes read from stream
367 client_receive (void *stream, size_t size, size_t nmemb, void *cls)
369 struct Session *s = cls;
370 struct GNUNET_TIME_Absolute now;
371 size_t len = size * nmemb;
375 struct Plugin *plugin = s->plugin;
377 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
378 "Client: Received %Zu bytes from peer `%s'\n", len,
379 GNUNET_i2s (&s->target));
382 now = GNUNET_TIME_absolute_get ();
383 if (now.abs_value < s->next_receive.abs_value)
385 struct GNUNET_TIME_Absolute now = GNUNET_TIME_absolute_get ();
386 struct GNUNET_TIME_Relative delta =
387 GNUNET_TIME_absolute_get_difference (now, s->next_receive);
389 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
390 "Client: %X No inbound bandwidth available! Next read was delayed for %llu ms\n",
391 s->client_get, delta.rel_value);
393 if (s->recv_wakeup_task != GNUNET_SCHEDULER_NO_TASK)
395 GNUNET_SCHEDULER_cancel (s->recv_wakeup_task);
396 s->recv_wakeup_task = GNUNET_SCHEDULER_NO_TASK;
398 s->recv_wakeup_task =
399 GNUNET_SCHEDULER_add_delayed (delta, &client_wake_up, s);
400 return CURLPAUSE_ALL;
404 if (s->msg_tk == NULL)
405 s->msg_tk = GNUNET_SERVER_mst_create (&client_receive_mst_cb, s);
407 GNUNET_SERVER_mst_receive (s->msg_tk, s, stream, len, GNUNET_NO, GNUNET_NO);
413 * Callback method used with libcurl
414 * Method is called when libcurl needs to read data during sending
415 * @param stream pointer where to write data
416 * @param size size of an individual element
417 * @param nmemb count of elements that can be written to the buffer
418 * @param cls source pointer, passed to the libcurl handle
419 * @return bytes written to stream, returning 0 will terminate connection!
422 client_send_cb (void *stream, size_t size, size_t nmemb, void *cls)
424 struct Session *s = cls;
427 struct Plugin *plugin = s->plugin;
429 size_t bytes_sent = 0;
432 struct HTTP_Message *msg = s->msg_head;
437 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
438 "Client: %X Nothing to send! Suspending PUT handle!\n",
441 s->client_put_paused = GNUNET_YES;
442 return CURL_READFUNC_PAUSE;
445 GNUNET_assert (msg != NULL);
447 if (msg->pos < msg->size)
449 /* data fit in buffer */
450 if ((msg->size - msg->pos) <= (size * nmemb))
452 len = (msg->size - msg->pos);
453 memcpy (stream, &msg->buf[msg->pos], len);
460 memcpy (stream, &msg->buf[msg->pos], len);
465 /* no data to send */
472 if (msg->pos == msg->size)
475 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
476 "Client: %X Message with %u bytes sent, removing message from queue\n",
477 s->client_put, msg->size, msg->pos);
479 /* Calling transmit continuation */
480 if (NULL != msg->transmit_cont)
481 msg->transmit_cont (msg->transmit_cont_cls, &s->target, GNUNET_OK);
482 GNUNET_CONTAINER_DLL_remove (s->msg_head, s->msg_tail, msg);
489 client_connect (struct Session *s)
491 struct Plugin *plugin = s->plugin;
498 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
499 "Initiating outbound session peer `%s'\n",
500 GNUNET_i2s (&s->target));
503 s->inbound = GNUNET_NO;
507 GNUNET_asprintf (&url, "%s%s;%u",
508 http_plugin_address_to_string (plugin, s->addr, s->addrlen),
509 GNUNET_h2s_full (&plugin->env->my_identity->hashPubKey),
512 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, plugin->name, "URL `%s'\n", url);
514 /* create get connection */
515 s->client_get = curl_easy_init ();
517 curl_easy_setopt (s->client_get, CURLOPT_VERBOSE, 1L);
518 curl_easy_setopt (s->client_get, CURLOPT_DEBUGFUNCTION, &client_log);
519 curl_easy_setopt (s->client_get, CURLOPT_DEBUGDATA, s->client_get);
522 curl_easy_setopt (s->client_get, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1);
523 curl_easy_setopt (s->client_get, CURLOPT_SSL_VERIFYPEER, 0);
524 curl_easy_setopt (s->client_get, CURLOPT_SSL_VERIFYHOST, 0);
526 curl_easy_setopt (s->client_get, CURLOPT_URL, url);
527 //curl_easy_setopt (s->client_get, CURLOPT_HEADERFUNCTION, &curl_get_header_cb);
528 //curl_easy_setopt (s->client_get, CURLOPT_WRITEHEADER, ps);
529 curl_easy_setopt (s->client_get, CURLOPT_READFUNCTION, client_send_cb);
530 curl_easy_setopt (s->client_get, CURLOPT_READDATA, s);
531 curl_easy_setopt (s->client_get, CURLOPT_WRITEFUNCTION, client_receive);
532 curl_easy_setopt (s->client_get, CURLOPT_WRITEDATA, s);
533 curl_easy_setopt (s->client_get, CURLOPT_TIMEOUT_MS,
534 (long) GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT.rel_value);
535 curl_easy_setopt (s->client_get, CURLOPT_PRIVATE, s);
536 curl_easy_setopt (s->client_get, CURLOPT_CONNECTTIMEOUT_MS,
537 (long) HTTP_NOT_VALIDATED_TIMEOUT.rel_value);
538 curl_easy_setopt (s->client_get, CURLOPT_BUFFERSIZE,
539 2 * GNUNET_SERVER_MAX_MESSAGE_SIZE);
541 curl_easy_setopt (ps->recv_endpoint, CURLOPT_TCP_NODELAY, 1);
544 /* create put connection */
545 s->client_put = curl_easy_init ();
547 curl_easy_setopt (s->client_put, CURLOPT_VERBOSE, 1L);
548 curl_easy_setopt (s->client_put, CURLOPT_DEBUGFUNCTION, &client_log);
549 curl_easy_setopt (s->client_put, CURLOPT_DEBUGDATA, s->client_put);
552 curl_easy_setopt (s->client_put, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1);
553 curl_easy_setopt (s->client_put, CURLOPT_SSL_VERIFYPEER, 0);
554 curl_easy_setopt (s->client_put, CURLOPT_SSL_VERIFYHOST, 0);
556 curl_easy_setopt (s->client_put, CURLOPT_URL, url);
557 curl_easy_setopt (s->client_put, CURLOPT_PUT, 1L);
558 //curl_easy_setopt (s->client_put, CURLOPT_HEADERFUNCTION, &curl_put_header_cb);
559 //curl_easy_setopt (s->client_put, CURLOPT_WRITEHEADER, ps);
560 curl_easy_setopt (s->client_put, CURLOPT_READFUNCTION, client_send_cb);
561 curl_easy_setopt (s->client_put, CURLOPT_READDATA, s);
562 curl_easy_setopt (s->client_put, CURLOPT_WRITEFUNCTION, client_receive);
563 curl_easy_setopt (s->client_put, CURLOPT_WRITEDATA, s);
564 curl_easy_setopt (s->client_put, CURLOPT_TIMEOUT_MS,
565 (long) GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT.rel_value);
566 curl_easy_setopt (s->client_put, CURLOPT_PRIVATE, s);
567 curl_easy_setopt (s->client_put, CURLOPT_CONNECTTIMEOUT_MS,
568 (long) HTTP_NOT_VALIDATED_TIMEOUT.rel_value);
569 curl_easy_setopt (s->client_put, CURLOPT_BUFFERSIZE,
570 2 * GNUNET_SERVER_MAX_MESSAGE_SIZE);
572 curl_easy_setopt (s->client_put, CURLOPT_TCP_NODELAY, 1);
577 mret = curl_multi_add_handle (plugin->client_mh, s->client_get);
578 if (mret != CURLM_OK)
580 curl_easy_cleanup (s->client_get);
585 mret = curl_multi_add_handle (plugin->client_mh, s->client_put);
586 if (mret != CURLM_OK)
588 curl_multi_remove_handle (plugin->client_mh, s->client_get);
589 curl_easy_cleanup (s->client_get);
590 curl_easy_cleanup (s->client_put);
595 /* Perform connect */
596 plugin->cur_connections += 2;
598 /* Re-schedule since handles have changed */
599 if (plugin->client_perform_task != GNUNET_SCHEDULER_NO_TASK)
601 GNUNET_SCHEDULER_cancel (plugin->client_perform_task);
602 plugin->client_perform_task = GNUNET_SCHEDULER_NO_TASK;
604 plugin->client_perform_task = GNUNET_SCHEDULER_add_now (client_run, plugin);
610 client_start (struct Plugin *plugin)
614 curl_global_init (CURL_GLOBAL_ALL);
615 plugin->client_mh = curl_multi_init ();
617 if (NULL == plugin->client_mh)
619 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, plugin->name,
621 ("Could not initialize curl multi handle, failed to start %s plugin!\n"),
629 client_stop (struct Plugin *plugin)
631 if (plugin->client_perform_task != GNUNET_SCHEDULER_NO_TASK)
633 GNUNET_SCHEDULER_cancel (plugin->client_perform_task);
634 plugin->client_perform_task = GNUNET_SCHEDULER_NO_TASK;
637 curl_multi_cleanup (plugin->client_mh);
638 curl_global_cleanup ();
643 /* end of plugin_transport_http_client.c */