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"
29 static struct Plugin * p;
33 * Function to log curl debug messages with GNUNET_log
35 * @param type curl_infotype
42 client_log (CURL * curl, curl_infotype type, char *data, size_t size, void *cls)
44 if (type == CURLINFO_TEXT)
48 memcpy (text, data, size);
49 if (text[size - 1] == '\n')
54 text[size + 1] = '\0';
57 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "transport-https",
58 "Client: %X - %s", cls, text);
60 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "transport-http",
61 "Client: %X - %s", cls, text);
69 * Task performing curl operations
70 * @param cls plugin as closure
71 * @param tc gnunet scheduler task context
74 client_run (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
77 * Function setting up file descriptors and scheduling task to run
79 * @param plugin plugin as closure
80 * @param now schedule task in 1ms, regardless of what curl may say
81 * @return GNUNET_SYSERR for hard failure, GNUNET_OK for ok
84 client_schedule (struct Plugin *plugin, int now)
90 struct GNUNET_NETWORK_FDSet *grs;
91 struct GNUNET_NETWORK_FDSet *gws;
94 struct GNUNET_TIME_Relative timeout;
96 /* Cancel previous scheduled task */
97 if (plugin->client_perform_task != GNUNET_SCHEDULER_NO_TASK)
99 GNUNET_SCHEDULER_cancel (plugin->client_perform_task);
100 plugin->client_perform_task = GNUNET_SCHEDULER_NO_TASK;
107 mret = curl_multi_fdset (plugin->client_mh, &rs, &ws, &es, &max);
108 if (mret != CURLM_OK)
110 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("%s failed at %s:%d: `%s'\n"),
111 "curl_multi_fdset", __FILE__, __LINE__,
112 curl_multi_strerror (mret));
113 return GNUNET_SYSERR;
115 mret = curl_multi_timeout (plugin->client_mh, &to);
117 timeout = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1);
119 timeout = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, to);
120 if (now == GNUNET_YES)
121 timeout = GNUNET_TIME_UNIT_MILLISECONDS;
123 if (mret != CURLM_OK)
125 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("%s failed at %s:%d: `%s'\n"),
126 "curl_multi_timeout", __FILE__, __LINE__,
127 curl_multi_strerror (mret));
128 return GNUNET_SYSERR;
131 grs = GNUNET_NETWORK_fdset_create ();
132 gws = GNUNET_NETWORK_fdset_create ();
133 GNUNET_NETWORK_fdset_copy_native (grs, &rs, max + 1);
134 GNUNET_NETWORK_fdset_copy_native (gws, &ws, max + 1);
136 plugin->client_perform_task =
137 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
139 &client_run, plugin);
140 GNUNET_NETWORK_fdset_destroy (gws);
141 GNUNET_NETWORK_fdset_destroy (grs);
147 client_send (struct Session *s, struct HTTP_Message *msg)
149 GNUNET_assert (s != NULL);
150 GNUNET_CONTAINER_DLL_insert (s->msg_head, s->msg_tail, msg);
152 if (GNUNET_YES != exist_session(p, s))
155 return GNUNET_SYSERR;
158 if (s->client_put_paused == GNUNET_YES)
161 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, s->plugin->name,
162 "Client: %X was suspended, unpausing\n", s->client_put);
164 s->client_put_paused = GNUNET_NO;
165 curl_easy_pause (s->client_put, CURLPAUSE_CONT);
168 client_schedule (s->plugin, GNUNET_YES);
176 * Task performing curl operations
177 * @param cls plugin as closure
178 * @param tc gnunet scheduler task context
181 client_run (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
183 struct Plugin *plugin = cls;
187 GNUNET_assert (cls != NULL);
189 plugin->client_perform_task = GNUNET_SCHEDULER_NO_TASK;
190 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
196 mret = curl_multi_perform (plugin->client_mh, &running);
201 while ((msg = curl_multi_info_read (plugin->client_mh, &msgs_left)))
203 CURL *easy_h = msg->easy_handle;
204 struct Session *s = NULL;
205 char *d = (char *) s;
208 //GNUNET_assert (easy_h != NULL);
211 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
212 "Client: connection to ended with reason %i: `%s', %i handles running\n",
214 curl_easy_strerror (msg->data.result), running);
218 GNUNET_assert (CURLE_OK ==
219 curl_easy_getinfo (easy_h, CURLINFO_PRIVATE, &d));
220 s = (struct Session *) d;
222 if (GNUNET_YES != exist_session(plugin, s))
228 GNUNET_assert (s != NULL);
230 if (msg->msg == CURLMSG_DONE)
232 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
233 "Client: %X connection to '%s' %s ended with reason %i: `%s'\n",
234 msg->easy_handle, GNUNET_i2s (&s->target),
235 http_plugin_address_to_string (NULL, s->addr,
238 curl_easy_strerror (msg->data.result));
240 client_disconnect (s);
241 //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));
242 notify_session_end (plugin, &s->target, s);
246 while (mret == CURLM_CALL_MULTI_PERFORM);
247 client_schedule (plugin, GNUNET_NO);
251 client_disconnect (struct Session *s)
255 struct Plugin *plugin = s->plugin;
256 struct HTTP_Message *msg;
257 struct HTTP_Message *t;
259 if (GNUNET_YES != exist_session(plugin, s))
262 return GNUNET_SYSERR;
265 if (s->client_put != NULL)
267 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
268 "Client: %X Deleting outbound PUT session to peer `%s'\n",
269 s->client_put, GNUNET_i2s (&s->target));
271 mret = curl_multi_remove_handle (plugin->client_mh, s->client_put);
272 if (mret != CURLM_OK)
274 curl_easy_cleanup (s->client_put);
278 curl_easy_cleanup (s->client_put);
279 s->client_put = NULL;
283 if (s->recv_wakeup_task != GNUNET_SCHEDULER_NO_TASK)
285 GNUNET_SCHEDULER_cancel (s->recv_wakeup_task);
286 s->recv_wakeup_task = GNUNET_SCHEDULER_NO_TASK;
289 if (s->client_get != NULL)
291 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
292 "Client: %X Deleting outbound GET session to peer `%s'\n",
293 s->client_get, GNUNET_i2s (&s->target));
295 mret = curl_multi_remove_handle (plugin->client_mh, s->client_get);
296 if (mret != CURLM_OK)
298 curl_easy_cleanup (s->client_get);
302 curl_easy_cleanup (s->client_get);
303 s->client_get = NULL;
310 if (NULL != msg->transmit_cont)
311 msg->transmit_cont (msg->transmit_cont_cls, &s->target, GNUNET_SYSERR);
312 GNUNET_CONTAINER_DLL_remove (s->msg_head, s->msg_tail, msg);
317 plugin->cur_connections -= 2;
319 GNUNET_assert (plugin->outbound_sessions > 0);
320 plugin->outbound_sessions --;
321 GNUNET_STATISTICS_set (plugin->env->stats,
322 "# HTTP outbound sessions",
323 plugin->outbound_sessions,
326 /* Re-schedule since handles have changed */
327 if (plugin->client_perform_task != GNUNET_SCHEDULER_NO_TASK)
329 GNUNET_SCHEDULER_cancel (plugin->client_perform_task);
330 plugin->client_perform_task = GNUNET_SCHEDULER_NO_TASK;
333 client_schedule (plugin, GNUNET_YES);
339 client_receive_mst_cb (void *cls, void *client,
340 const struct GNUNET_MessageHeader *message)
342 struct Session *s = cls;
343 struct GNUNET_TIME_Relative delay;
345 if (GNUNET_YES != exist_session(p, s))
351 delay = http_plugin_receive (s, &s->target, message, s, s->addr, s->addrlen);
353 GNUNET_TIME_absolute_add (GNUNET_TIME_absolute_get (), delay);
355 if (GNUNET_TIME_absolute_get ().abs_value < s->next_receive.abs_value)
358 struct Plugin *plugin = s->plugin;
360 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
361 "Client: peer `%s' address `%s' next read delayed for %llu ms\n",
362 GNUNET_i2s (&s->target), GNUNET_a2s (s->addr, s->addrlen),
369 client_wake_up (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
371 struct Session *s = cls;
373 if (GNUNET_YES != exist_session(p, s))
379 s->recv_wakeup_task = GNUNET_SCHEDULER_NO_TASK;
381 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
384 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, s->plugin->name,
385 "Client: %X Waking up receive handle\n", s->client_get);
387 if (s->client_get != NULL)
388 curl_easy_pause (s->client_get, CURLPAUSE_CONT);
393 * Callback method used with libcurl
394 * Method is called when libcurl needs to write data during sending
395 * @param stream pointer where to write data
396 * @param size size of an individual element
397 * @param nmemb count of elements that can be written to the buffer
398 * @param cls destination pointer, passed to the libcurl handle
399 * @return bytes read from stream
402 client_receive (void *stream, size_t size, size_t nmemb, void *cls)
404 struct Session *s = cls;
405 struct GNUNET_TIME_Absolute now;
406 size_t len = size * nmemb;
412 struct Plugin *plugin = s->plugin;
414 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
415 "Client: Received %Zu bytes from peer `%s'\n", len,
416 GNUNET_i2s (&s->target));
419 now = GNUNET_TIME_absolute_get ();
420 if (now.abs_value < s->next_receive.abs_value)
422 struct GNUNET_TIME_Absolute now = GNUNET_TIME_absolute_get ();
423 struct GNUNET_TIME_Relative delta =
424 GNUNET_TIME_absolute_get_difference (now, s->next_receive);
426 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
427 "Client: %X No inbound bandwidth available! Next read was delayed for %llu ms\n",
428 s->client_get, delta.rel_value);
430 if (s->recv_wakeup_task != GNUNET_SCHEDULER_NO_TASK)
432 GNUNET_SCHEDULER_cancel (s->recv_wakeup_task);
433 s->recv_wakeup_task = GNUNET_SCHEDULER_NO_TASK;
435 s->recv_wakeup_task =
436 GNUNET_SCHEDULER_add_delayed (delta, &client_wake_up, s);
437 return CURLPAUSE_ALL;
441 if (s->msg_tk == NULL)
442 s->msg_tk = GNUNET_SERVER_mst_create (&client_receive_mst_cb, s);
444 GNUNET_SERVER_mst_receive (s->msg_tk, s, stream, len, GNUNET_NO, GNUNET_NO);
450 * Callback method used with libcurl
451 * Method is called when libcurl needs to read data during sending
452 * @param stream pointer where to write data
453 * @param size size of an individual element
454 * @param nmemb count of elements that can be written to the buffer
455 * @param cls source pointer, passed to the libcurl handle
456 * @return bytes written to stream, returning 0 will terminate connection!
459 client_send_cb (void *stream, size_t size, size_t nmemb, void *cls)
461 struct Session *s = cls;
464 struct Plugin *plugin = s->plugin;
466 size_t bytes_sent = 0;
469 if (GNUNET_YES != exist_session(plugin, s))
472 return GNUNET_SYSERR;
475 struct HTTP_Message *msg = s->msg_head;
480 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
481 "Client: %X Nothing to send! Suspending PUT handle!\n",
484 s->client_put_paused = GNUNET_YES;
485 return CURL_READFUNC_PAUSE;
488 GNUNET_assert (msg != NULL);
490 if (msg->pos < msg->size)
492 /* data fit in buffer */
493 if ((msg->size - msg->pos) <= (size * nmemb))
495 len = (msg->size - msg->pos);
496 memcpy (stream, &msg->buf[msg->pos], len);
503 memcpy (stream, &msg->buf[msg->pos], len);
508 /* no data to send */
515 if (msg->pos == msg->size)
518 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
519 "Client: %X Message with %u bytes sent, removing message from queue\n",
520 s->client_put, msg->size, msg->pos);
522 /* Calling transmit continuation */
523 if (NULL != msg->transmit_cont)
524 msg->transmit_cont (msg->transmit_cont_cls, &s->target, GNUNET_OK);
525 GNUNET_CONTAINER_DLL_remove (s->msg_head, s->msg_tail, msg);
532 client_connect (struct Session *s)
534 struct Plugin *plugin = s->plugin;
541 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
542 "Initiating outbound session peer `%s'\n",
543 GNUNET_i2s (&s->target));
546 s->inbound = GNUNET_NO;
550 GNUNET_asprintf (&url, "%s%s;%u",
551 http_plugin_address_to_string (plugin, s->addr, s->addrlen),
552 GNUNET_h2s_full (&plugin->env->my_identity->hashPubKey),
555 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, plugin->name, "URL `%s'\n", url);
557 /* create get connection */
558 s->client_get = curl_easy_init ();
560 curl_easy_setopt (s->client_get, CURLOPT_VERBOSE, 1L);
561 curl_easy_setopt (s->client_get, CURLOPT_DEBUGFUNCTION, &client_log);
562 curl_easy_setopt (s->client_get, CURLOPT_DEBUGDATA, s->client_get);
565 curl_easy_setopt (s->client_get, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1);
566 curl_easy_setopt (s->client_get, CURLOPT_SSL_VERIFYPEER, 0);
567 curl_easy_setopt (s->client_get, CURLOPT_SSL_VERIFYHOST, 0);
569 curl_easy_setopt (s->client_get, CURLOPT_URL, url);
570 //curl_easy_setopt (s->client_get, CURLOPT_HEADERFUNCTION, &curl_get_header_cb);
571 //curl_easy_setopt (s->client_get, CURLOPT_WRITEHEADER, ps);
572 curl_easy_setopt (s->client_get, CURLOPT_READFUNCTION, client_send_cb);
573 curl_easy_setopt (s->client_get, CURLOPT_READDATA, s);
574 curl_easy_setopt (s->client_get, CURLOPT_WRITEFUNCTION, client_receive);
575 curl_easy_setopt (s->client_get, CURLOPT_WRITEDATA, s);
576 curl_easy_setopt (s->client_get, CURLOPT_TIMEOUT_MS,
577 (long) GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT.rel_value);
578 curl_easy_setopt (s->client_get, CURLOPT_PRIVATE, s);
579 curl_easy_setopt (s->client_get, CURLOPT_CONNECTTIMEOUT_MS,
580 (long) HTTP_NOT_VALIDATED_TIMEOUT.rel_value);
581 curl_easy_setopt (s->client_get, CURLOPT_BUFFERSIZE,
582 2 * GNUNET_SERVER_MAX_MESSAGE_SIZE);
584 curl_easy_setopt (ps->recv_endpoint, CURLOPT_TCP_NODELAY, 1);
587 /* create put connection */
588 s->client_put = curl_easy_init ();
590 curl_easy_setopt (s->client_put, CURLOPT_VERBOSE, 1L);
591 curl_easy_setopt (s->client_put, CURLOPT_DEBUGFUNCTION, &client_log);
592 curl_easy_setopt (s->client_put, CURLOPT_DEBUGDATA, s->client_put);
595 curl_easy_setopt (s->client_put, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1);
596 curl_easy_setopt (s->client_put, CURLOPT_SSL_VERIFYPEER, 0);
597 curl_easy_setopt (s->client_put, CURLOPT_SSL_VERIFYHOST, 0);
599 curl_easy_setopt (s->client_put, CURLOPT_URL, url);
600 curl_easy_setopt (s->client_put, CURLOPT_PUT, 1L);
601 //curl_easy_setopt (s->client_put, CURLOPT_HEADERFUNCTION, &curl_put_header_cb);
602 //curl_easy_setopt (s->client_put, CURLOPT_WRITEHEADER, ps);
603 curl_easy_setopt (s->client_put, CURLOPT_READFUNCTION, client_send_cb);
604 curl_easy_setopt (s->client_put, CURLOPT_READDATA, s);
605 curl_easy_setopt (s->client_put, CURLOPT_WRITEFUNCTION, client_receive);
606 curl_easy_setopt (s->client_put, CURLOPT_WRITEDATA, s);
607 curl_easy_setopt (s->client_put, CURLOPT_TIMEOUT_MS,
608 (long) GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT.rel_value);
609 curl_easy_setopt (s->client_put, CURLOPT_PRIVATE, s);
610 curl_easy_setopt (s->client_put, CURLOPT_CONNECTTIMEOUT_MS,
611 (long) HTTP_NOT_VALIDATED_TIMEOUT.rel_value);
612 curl_easy_setopt (s->client_put, CURLOPT_BUFFERSIZE,
613 2 * GNUNET_SERVER_MAX_MESSAGE_SIZE);
615 curl_easy_setopt (s->client_put, CURLOPT_TCP_NODELAY, 1);
620 mret = curl_multi_add_handle (plugin->client_mh, s->client_get);
621 if (mret != CURLM_OK)
623 curl_easy_cleanup (s->client_get);
628 mret = curl_multi_add_handle (plugin->client_mh, s->client_put);
629 if (mret != CURLM_OK)
631 curl_multi_remove_handle (plugin->client_mh, s->client_get);
632 curl_easy_cleanup (s->client_get);
633 curl_easy_cleanup (s->client_put);
638 /* Perform connect */
639 plugin->cur_connections += 2;
641 plugin->outbound_sessions ++;
642 GNUNET_STATISTICS_set (plugin->env->stats,
643 "# HTTP outbound sessions",
644 plugin->outbound_sessions,
647 /* Re-schedule since handles have changed */
648 if (plugin->client_perform_task != GNUNET_SCHEDULER_NO_TASK)
650 GNUNET_SCHEDULER_cancel (plugin->client_perform_task);
651 plugin->client_perform_task = GNUNET_SCHEDULER_NO_TASK;
653 plugin->client_perform_task = GNUNET_SCHEDULER_add_now (client_run, plugin);
659 client_start (struct Plugin *plugin)
664 curl_global_init (CURL_GLOBAL_ALL);
665 plugin->client_mh = curl_multi_init ();
667 if (NULL == plugin->client_mh)
669 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, plugin->name,
671 ("Could not initialize curl multi handle, failed to start %s plugin!\n"),
679 client_stop (struct Plugin *plugin)
682 if (plugin->client_perform_task != GNUNET_SCHEDULER_NO_TASK)
684 GNUNET_SCHEDULER_cancel (plugin->client_perform_task);
685 plugin->client_perform_task = GNUNET_SCHEDULER_NO_TASK;
688 curl_multi_cleanup (plugin->client_mh);
689 curl_global_cleanup ();
694 /* end of plugin_transport_http_client.c */