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_CONTAINER_DLL_insert (s->msg_head, s->msg_tail, msg);
149 if ((s != NULL) && (s->client_put_paused == GNUNET_YES))
152 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, s->plugin->name,
153 "Client: %X was suspended, unpausing\n", s->client_put);
155 s->client_put_paused = GNUNET_NO;
156 curl_easy_pause (s->client_put, CURLPAUSE_CONT);
159 client_schedule (s->plugin, GNUNET_YES);
167 * Task performing curl operations
168 * @param cls plugin as closure
169 * @param tc gnunet scheduler task context
172 client_run (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
174 struct Plugin *plugin = cls;
178 GNUNET_assert (cls != NULL);
180 plugin->client_perform_task = GNUNET_SCHEDULER_NO_TASK;
181 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
187 mret = curl_multi_perform (plugin->client_mh, &running);
192 while ((msg = curl_multi_info_read (plugin->client_mh, &msgs_left)))
194 CURL *easy_h = msg->easy_handle;
195 struct Session *s = NULL;
196 char *d = (char *) s;
199 //GNUNET_assert (easy_h != NULL);
202 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
203 "Client: connection to ended with reason %i: `%s', %i handles running\n",
205 curl_easy_strerror (msg->data.result), running);
209 GNUNET_assert (CURLE_OK ==
210 curl_easy_getinfo (easy_h, CURLINFO_PRIVATE, &d));
211 s = (struct Session *) d;
212 GNUNET_assert (s != NULL);
214 if (msg->msg == CURLMSG_DONE)
216 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
217 "Client: %X connection to '%s' %s ended with reason %i: `%s'\n",
218 msg->easy_handle, GNUNET_i2s (&s->target),
219 http_plugin_address_to_string (NULL, s->addr,
222 curl_easy_strerror (msg->data.result));
224 client_disconnect (s);
225 //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));
226 notify_session_end (plugin, &s->target, s);
230 while (mret == CURLM_CALL_MULTI_PERFORM);
231 client_schedule (plugin, GNUNET_NO);
235 client_disconnect (struct Session *s)
239 struct Plugin *plugin = s->plugin;
240 struct HTTP_Message *msg;
241 struct HTTP_Message *t;
245 if (s->client_put != NULL)
248 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
249 "Client: %X Deleting outbound PUT session to peer `%s'\n",
250 s->client_put, GNUNET_i2s (&s->target));
253 mret = curl_multi_remove_handle (plugin->client_mh, s->client_put);
254 if (mret != CURLM_OK)
256 curl_easy_cleanup (s->client_put);
260 curl_easy_cleanup (s->client_put);
261 s->client_put = NULL;
265 if (s->recv_wakeup_task != GNUNET_SCHEDULER_NO_TASK)
267 GNUNET_SCHEDULER_cancel (s->recv_wakeup_task);
268 s->recv_wakeup_task = GNUNET_SCHEDULER_NO_TASK;
271 if (s->client_get != NULL)
274 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
275 "Client: %X Deleting outbound GET session to peer `%s'\n",
276 s->client_get, GNUNET_i2s (&s->target));
279 mret = curl_multi_remove_handle (plugin->client_mh, s->client_get);
280 if (mret != CURLM_OK)
282 curl_easy_cleanup (s->client_get);
286 curl_easy_cleanup (s->client_get);
287 s->client_get = NULL;
294 if (NULL != msg->transmit_cont)
295 msg->transmit_cont (msg->transmit_cont_cls, &s->target, GNUNET_SYSERR);
296 GNUNET_CONTAINER_DLL_remove (s->msg_head, s->msg_tail, msg);
301 plugin->cur_connections -= 2;
302 /* Re-schedule since handles have changed */
303 if (plugin->client_perform_task != GNUNET_SCHEDULER_NO_TASK)
305 GNUNET_SCHEDULER_cancel (plugin->client_perform_task);
306 plugin->client_perform_task = GNUNET_SCHEDULER_NO_TASK;
309 client_schedule (plugin, GNUNET_YES);
315 client_receive_mst_cb (void *cls, void *client,
316 const struct GNUNET_MessageHeader *message)
318 struct Session *s = cls;
319 struct GNUNET_TIME_Relative delay;
321 delay = http_plugin_receive (s, &s->target, message, s, s->addr, s->addrlen);
323 GNUNET_TIME_absolute_add (GNUNET_TIME_absolute_get (), delay);
325 if (GNUNET_TIME_absolute_get ().abs_value < s->next_receive.abs_value)
328 struct Plugin *plugin = s->plugin;
330 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
331 "Client: peer `%s' address `%s' next read delayed for %llu ms\n",
332 GNUNET_i2s (&s->target), GNUNET_a2s (s->addr, s->addrlen),
339 client_wake_up (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
341 struct Session *s = cls;
343 s->recv_wakeup_task = GNUNET_SCHEDULER_NO_TASK;
345 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
348 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, s->plugin->name,
349 "Client: %X Waking up receive handle\n", s->client_get);
351 if (s->client_get != NULL)
352 curl_easy_pause (s->client_get, CURLPAUSE_CONT);
357 * Callback method used with libcurl
358 * Method is called when libcurl needs to write data during sending
359 * @param stream pointer where to write data
360 * @param size size of an individual element
361 * @param nmemb count of elements that can be written to the buffer
362 * @param cls destination pointer, passed to the libcurl handle
363 * @return bytes read from stream
366 client_receive (void *stream, size_t size, size_t nmemb, void *cls)
368 struct Session *s = cls;
369 struct GNUNET_TIME_Absolute now;
370 size_t len = size * nmemb;
374 struct Plugin *plugin = s->plugin;
376 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
377 "Client: Received %Zu bytes from peer `%s'\n", len,
378 GNUNET_i2s (&s->target));
381 now = GNUNET_TIME_absolute_get ();
382 if (now.abs_value < s->next_receive.abs_value)
384 struct GNUNET_TIME_Absolute now = GNUNET_TIME_absolute_get ();
385 struct GNUNET_TIME_Relative delta =
386 GNUNET_TIME_absolute_get_difference (now, s->next_receive);
388 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
389 "Client: %X No inbound bandwidth available! Next read was delayed for %llu ms\n",
390 s->client_get, delta.rel_value);
392 if (s->recv_wakeup_task != GNUNET_SCHEDULER_NO_TASK)
394 GNUNET_SCHEDULER_cancel (s->recv_wakeup_task);
395 s->recv_wakeup_task = GNUNET_SCHEDULER_NO_TASK;
397 s->recv_wakeup_task =
398 GNUNET_SCHEDULER_add_delayed (delta, &client_wake_up, s);
399 return CURLPAUSE_ALL;
403 if (s->msg_tk == NULL)
404 s->msg_tk = GNUNET_SERVER_mst_create (&client_receive_mst_cb, s);
406 GNUNET_SERVER_mst_receive (s->msg_tk, s, stream, len, GNUNET_NO, GNUNET_NO);
412 * Callback method used with libcurl
413 * Method is called when libcurl needs to read data during sending
414 * @param stream pointer where to write data
415 * @param size size of an individual element
416 * @param nmemb count of elements that can be written to the buffer
417 * @param cls source pointer, passed to the libcurl handle
418 * @return bytes written to stream, returning 0 will terminate connection!
421 client_send_cb (void *stream, size_t size, size_t nmemb, void *cls)
423 struct Session *s = cls;
426 struct Plugin *plugin = s->plugin;
428 size_t bytes_sent = 0;
431 struct HTTP_Message *msg = s->msg_head;
436 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
437 "Client: %X Nothing to send! Suspending PUT handle!\n",
440 s->client_put_paused = GNUNET_YES;
441 return CURL_READFUNC_PAUSE;
444 GNUNET_assert (msg != NULL);
446 if (msg->pos < msg->size)
448 /* data fit in buffer */
449 if ((msg->size - msg->pos) <= (size * nmemb))
451 len = (msg->size - msg->pos);
452 memcpy (stream, &msg->buf[msg->pos], len);
459 memcpy (stream, &msg->buf[msg->pos], len);
464 /* no data to send */
471 if (msg->pos == msg->size)
474 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
475 "Client: %X Message with %u bytes sent, removing message from queue\n",
476 s->client_put, msg->size, msg->pos);
478 /* Calling transmit continuation */
479 if (NULL != msg->transmit_cont)
480 msg->transmit_cont (msg->transmit_cont_cls, &s->target, GNUNET_OK);
481 GNUNET_CONTAINER_DLL_remove (s->msg_head, s->msg_tail, msg);
488 client_connect (struct Session *s)
490 struct Plugin *plugin = s->plugin;
497 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
498 "Initiating outbound session peer `%s'\n",
499 GNUNET_i2s (&s->target));
502 s->inbound = GNUNET_NO;
506 GNUNET_asprintf (&url, "%s%s;%u",
507 http_plugin_address_to_string (plugin, s->addr, s->addrlen),
508 GNUNET_h2s_full (&plugin->env->my_identity->hashPubKey),
511 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, plugin->name, "URL `%s'\n", url);
513 /* create get connection */
514 s->client_get = curl_easy_init ();
516 curl_easy_setopt (s->client_get, CURLOPT_VERBOSE, 1L);
517 curl_easy_setopt (s->client_get, CURLOPT_DEBUGFUNCTION, &client_log);
518 curl_easy_setopt (s->client_get, CURLOPT_DEBUGDATA, s->client_get);
521 curl_easy_setopt (s->client_get, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1);
522 curl_easy_setopt (s->client_get, CURLOPT_SSL_VERIFYPEER, 0);
523 curl_easy_setopt (s->client_get, CURLOPT_SSL_VERIFYHOST, 0);
525 curl_easy_setopt (s->client_get, CURLOPT_URL, url);
526 //curl_easy_setopt (s->client_get, CURLOPT_HEADERFUNCTION, &curl_get_header_cb);
527 //curl_easy_setopt (s->client_get, CURLOPT_WRITEHEADER, ps);
528 curl_easy_setopt (s->client_get, CURLOPT_READFUNCTION, client_send_cb);
529 curl_easy_setopt (s->client_get, CURLOPT_READDATA, s);
530 curl_easy_setopt (s->client_get, CURLOPT_WRITEFUNCTION, client_receive);
531 curl_easy_setopt (s->client_get, CURLOPT_WRITEDATA, s);
532 curl_easy_setopt (s->client_get, CURLOPT_TIMEOUT_MS,
533 (long) GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT.rel_value);
534 curl_easy_setopt (s->client_get, CURLOPT_PRIVATE, s);
535 curl_easy_setopt (s->client_get, CURLOPT_CONNECTTIMEOUT_MS,
536 (long) HTTP_NOT_VALIDATED_TIMEOUT.rel_value);
537 curl_easy_setopt (s->client_get, CURLOPT_BUFFERSIZE,
538 2 * GNUNET_SERVER_MAX_MESSAGE_SIZE);
540 curl_easy_setopt (ps->recv_endpoint, CURLOPT_TCP_NODELAY, 1);
543 /* create put connection */
544 s->client_put = curl_easy_init ();
546 curl_easy_setopt (s->client_put, CURLOPT_VERBOSE, 1L);
547 curl_easy_setopt (s->client_put, CURLOPT_DEBUGFUNCTION, &client_log);
548 curl_easy_setopt (s->client_put, CURLOPT_DEBUGDATA, s->client_put);
551 curl_easy_setopt (s->client_put, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1);
552 curl_easy_setopt (s->client_put, CURLOPT_SSL_VERIFYPEER, 0);
553 curl_easy_setopt (s->client_put, CURLOPT_SSL_VERIFYHOST, 0);
555 curl_easy_setopt (s->client_put, CURLOPT_URL, url);
556 curl_easy_setopt (s->client_put, CURLOPT_PUT, 1L);
557 //curl_easy_setopt (s->client_put, CURLOPT_HEADERFUNCTION, &curl_put_header_cb);
558 //curl_easy_setopt (s->client_put, CURLOPT_WRITEHEADER, ps);
559 curl_easy_setopt (s->client_put, CURLOPT_READFUNCTION, client_send_cb);
560 curl_easy_setopt (s->client_put, CURLOPT_READDATA, s);
561 curl_easy_setopt (s->client_put, CURLOPT_WRITEFUNCTION, client_receive);
562 curl_easy_setopt (s->client_put, CURLOPT_WRITEDATA, s);
563 curl_easy_setopt (s->client_put, CURLOPT_TIMEOUT_MS,
564 (long) GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT.rel_value);
565 curl_easy_setopt (s->client_put, CURLOPT_PRIVATE, s);
566 curl_easy_setopt (s->client_put, CURLOPT_CONNECTTIMEOUT_MS,
567 (long) HTTP_NOT_VALIDATED_TIMEOUT.rel_value);
568 curl_easy_setopt (s->client_put, CURLOPT_BUFFERSIZE,
569 2 * GNUNET_SERVER_MAX_MESSAGE_SIZE);
571 curl_easy_setopt (s->client_put, CURLOPT_TCP_NODELAY, 1);
576 mret = curl_multi_add_handle (plugin->client_mh, s->client_get);
577 if (mret != CURLM_OK)
579 curl_easy_cleanup (s->client_get);
584 mret = curl_multi_add_handle (plugin->client_mh, s->client_put);
585 if (mret != CURLM_OK)
587 curl_multi_remove_handle (plugin->client_mh, s->client_get);
588 curl_easy_cleanup (s->client_get);
589 curl_easy_cleanup (s->client_put);
594 /* Perform connect */
595 plugin->cur_connections += 2;
597 /* Re-schedule since handles have changed */
598 if (plugin->client_perform_task != GNUNET_SCHEDULER_NO_TASK)
600 GNUNET_SCHEDULER_cancel (plugin->client_perform_task);
601 plugin->client_perform_task = GNUNET_SCHEDULER_NO_TASK;
603 plugin->client_perform_task = GNUNET_SCHEDULER_add_now (client_run, plugin);
609 client_start (struct Plugin *plugin)
613 curl_global_init (CURL_GLOBAL_ALL);
614 plugin->client_mh = curl_multi_init ();
616 if (NULL == plugin->client_mh)
618 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, plugin->name,
620 ("Could not initialize curl multi handle, failed to start %s plugin!\n"),
628 client_stop (struct Plugin *plugin)
630 if (plugin->client_perform_task != GNUNET_SCHEDULER_NO_TASK)
632 GNUNET_SCHEDULER_cancel (plugin->client_perform_task);
633 plugin->client_perform_task = GNUNET_SCHEDULER_NO_TASK;
636 curl_multi_cleanup (plugin->client_mh);
637 curl_global_cleanup ();
642 /* end of plugin_transport_http_client.c */