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 * @return GNUNET_SYSERR for hard failure, GNUNET_OK for ok
81 client_schedule (struct Plugin *plugin, int now)
87 struct GNUNET_NETWORK_FDSet *grs;
88 struct GNUNET_NETWORK_FDSet *gws;
91 struct GNUNET_TIME_Relative timeout;
93 /* Cancel previous scheduled task */
94 if (plugin->client_perform_task != GNUNET_SCHEDULER_NO_TASK)
96 GNUNET_SCHEDULER_cancel (plugin->client_perform_task);
97 plugin->client_perform_task = GNUNET_SCHEDULER_NO_TASK;
104 mret = curl_multi_fdset (plugin->client_mh, &rs, &ws, &es, &max);
105 if (mret != CURLM_OK)
107 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("%s failed at %s:%d: `%s'\n"),
108 "curl_multi_fdset", __FILE__, __LINE__,
109 curl_multi_strerror (mret));
110 return GNUNET_SYSERR;
112 mret = curl_multi_timeout (plugin->client_mh, &to);
114 timeout = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1);
116 timeout = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, to);
117 if (now == GNUNET_YES)
118 timeout = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, 1);
120 if (mret != CURLM_OK)
122 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("%s failed at %s:%d: `%s'\n"),
123 "curl_multi_timeout", __FILE__, __LINE__,
124 curl_multi_strerror (mret));
125 return GNUNET_SYSERR;
128 grs = GNUNET_NETWORK_fdset_create ();
129 gws = GNUNET_NETWORK_fdset_create ();
130 GNUNET_NETWORK_fdset_copy_native (grs, &rs, max + 1);
131 GNUNET_NETWORK_fdset_copy_native (gws, &ws, max + 1);
133 plugin->client_perform_task =
134 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
135 GNUNET_SCHEDULER_NO_TASK, timeout, grs, gws,
136 &client_run, plugin);
137 GNUNET_NETWORK_fdset_destroy (gws);
138 GNUNET_NETWORK_fdset_destroy (grs);
144 client_send (struct Session *s, struct HTTP_Message *msg)
146 GNUNET_CONTAINER_DLL_insert (s->msg_head, s->msg_tail, msg);
148 if ((s != NULL) && (s->client_put_paused == GNUNET_YES))
151 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, s->plugin->name,
152 "Client: %X was suspended, unpausing\n", s->client_put);
154 s->client_put_paused = GNUNET_NO;
155 curl_easy_pause (s->client_put, CURLPAUSE_CONT);
158 client_schedule (s->plugin, GNUNET_YES);
166 * Task performing curl operations
167 * @param cls plugin as closure
168 * @param tc gnunet scheduler task context
171 client_run (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
173 struct Plugin *plugin = cls;
177 GNUNET_assert (cls != NULL);
179 plugin->client_perform_task = GNUNET_SCHEDULER_NO_TASK;
180 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
186 mret = curl_multi_perform (plugin->client_mh, &running);
191 while ((msg = curl_multi_info_read (plugin->client_mh, &msgs_left)))
193 CURL *easy_h = msg->easy_handle;
194 struct Session *s = NULL;
195 char *d = (char *) s;
198 //GNUNET_assert (easy_h != NULL);
201 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
202 "Client: connection to ended with reason %i: `%s', %i handles running\n",
204 curl_easy_strerror (msg->data.result), running);
208 GNUNET_assert (CURLE_OK ==
209 curl_easy_getinfo (easy_h, CURLINFO_PRIVATE, &d));
210 s = (struct Session *) d;
211 GNUNET_assert (s != NULL);
213 if (msg->msg == CURLMSG_DONE)
215 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
216 "Client: %X connection to '%s' %s ended with reason %i: `%s'\n",
217 msg->easy_handle, GNUNET_i2s (&s->target),
218 http_plugin_address_to_string (NULL, s->addr,
221 curl_easy_strerror (msg->data.result));
223 client_disconnect (s);
224 //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));
225 notify_session_end (plugin, &s->target, s);
229 while (mret == CURLM_CALL_MULTI_PERFORM);
230 client_schedule (plugin, GNUNET_NO);
234 client_disconnect (struct Session *s)
238 struct Plugin *plugin = s->plugin;
239 struct HTTP_Message *msg;
240 struct HTTP_Message *t;
244 if (s->client_put != NULL)
247 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
248 "Client: %X Deleting outbound PUT session to peer `%s'\n",
249 s->client_put, GNUNET_i2s (&s->target));
252 mret = curl_multi_remove_handle (plugin->client_mh, s->client_put);
253 if (mret != CURLM_OK)
255 curl_easy_cleanup (s->client_put);
259 curl_easy_cleanup (s->client_put);
260 s->client_put = NULL;
264 if (s->recv_wakeup_task != GNUNET_SCHEDULER_NO_TASK)
266 GNUNET_SCHEDULER_cancel (s->recv_wakeup_task);
267 s->recv_wakeup_task = GNUNET_SCHEDULER_NO_TASK;
270 if (s->client_get != NULL)
273 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
274 "Client: %X Deleting outbound GET session to peer `%s'\n",
275 s->client_get, GNUNET_i2s (&s->target));
278 mret = curl_multi_remove_handle (plugin->client_mh, s->client_get);
279 if (mret != CURLM_OK)
281 curl_easy_cleanup (s->client_get);
285 curl_easy_cleanup (s->client_get);
286 s->client_get = NULL;
293 if (NULL != msg->transmit_cont)
294 msg->transmit_cont (msg->transmit_cont_cls, &s->target, GNUNET_SYSERR);
295 GNUNET_CONTAINER_DLL_remove (s->msg_head, s->msg_tail, msg);
300 plugin->cur_connections -= 2;
301 /* Re-schedule since handles have changed */
302 if (plugin->client_perform_task != GNUNET_SCHEDULER_NO_TASK)
304 GNUNET_SCHEDULER_cancel (plugin->client_perform_task);
305 plugin->client_perform_task = GNUNET_SCHEDULER_NO_TASK;
308 client_schedule (plugin, GNUNET_YES);
314 client_receive_mst_cb (void *cls, void *client,
315 const struct GNUNET_MessageHeader *message)
317 struct Session *s = cls;
318 struct GNUNET_TIME_Relative delay;
320 delay = http_plugin_receive (s, &s->target, message, s, s->addr, s->addrlen);
322 GNUNET_TIME_absolute_add (GNUNET_TIME_absolute_get (), delay);
324 if (GNUNET_TIME_absolute_get ().abs_value < s->next_receive.abs_value)
327 struct Plugin *plugin = s->plugin;
329 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
330 "Client: peer `%s' address `%s' next read delayed for %llu ms\n",
331 GNUNET_i2s (&s->target), GNUNET_a2s (s->addr, s->addrlen),
338 client_wake_up (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
340 struct Session *s = cls;
342 s->recv_wakeup_task = GNUNET_SCHEDULER_NO_TASK;
344 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
347 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, s->plugin->name,
348 "Client: %X Waking up receive handle\n", s->client_get);
350 if (s->client_get != NULL)
351 curl_easy_pause (s->client_get, CURLPAUSE_CONT);
356 * Callback method used with libcurl
357 * Method is called when libcurl needs to write data during sending
358 * @param stream pointer where to write data
359 * @param size size of an individual element
360 * @param nmemb count of elements that can be written to the buffer
361 * @param ptr destination pointer, passed to the libcurl handle
362 * @return bytes read from stream
365 client_receive (void *stream, size_t size, size_t nmemb, void *cls)
367 struct Session *s = cls;
368 struct GNUNET_TIME_Absolute now;
369 size_t len = size * nmemb;
373 struct Plugin *plugin = s->plugin;
375 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
376 "Client: Received %Zu bytes from peer `%s'\n", len,
377 GNUNET_i2s (&s->target));
380 now = GNUNET_TIME_absolute_get ();
381 if (now.abs_value < s->next_receive.abs_value)
383 struct GNUNET_TIME_Absolute now = GNUNET_TIME_absolute_get ();
384 struct GNUNET_TIME_Relative delta =
385 GNUNET_TIME_absolute_get_difference (now, s->next_receive);
387 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
388 "Client: %X No inbound bandwidth available! Next read was delayed for %llu ms\n",
389 s->client_get, delta.rel_value);
391 if (s->recv_wakeup_task != GNUNET_SCHEDULER_NO_TASK)
393 GNUNET_SCHEDULER_cancel (s->recv_wakeup_task);
394 s->recv_wakeup_task = GNUNET_SCHEDULER_NO_TASK;
396 s->recv_wakeup_task =
397 GNUNET_SCHEDULER_add_delayed (delta, &client_wake_up, s);
398 return CURLPAUSE_ALL;
402 if (s->msg_tk == NULL)
403 s->msg_tk = GNUNET_SERVER_mst_create (&client_receive_mst_cb, s);
405 GNUNET_SERVER_mst_receive (s->msg_tk, s, stream, len, GNUNET_NO, GNUNET_NO);
411 * Callback method used with libcurl
412 * Method is called when libcurl needs to read data during sending
413 * @param stream pointer where to write data
414 * @param size size of an individual element
415 * @param nmemb count of elements that can be written to the buffer
416 * @param ptr source pointer, passed to the libcurl handle
417 * @return bytes written to stream, returning 0 will terminate connection!
420 client_send_cb (void *stream, size_t size, size_t nmemb, void *cls)
422 struct Session *s = cls;
425 struct Plugin *plugin = s->plugin;
427 size_t bytes_sent = 0;
430 struct HTTP_Message *msg = s->msg_head;
435 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
436 "Client: %X Nothing to send! Suspending PUT handle!\n",
439 s->client_put_paused = GNUNET_YES;
440 return CURL_READFUNC_PAUSE;
443 GNUNET_assert (msg != NULL);
445 if (msg->pos < msg->size)
447 /* data fit in buffer */
448 if ((msg->size - msg->pos) <= (size * nmemb))
450 len = (msg->size - msg->pos);
451 memcpy (stream, &msg->buf[msg->pos], len);
458 memcpy (stream, &msg->buf[msg->pos], len);
463 /* no data to send */
470 if (msg->pos == msg->size)
473 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
474 "Client: %X Message with %u bytes sent, removing message from queue\n",
475 s->client_put, msg->size, msg->pos);
477 /* Calling transmit continuation */
478 if (NULL != msg->transmit_cont)
479 msg->transmit_cont (msg->transmit_cont_cls, &s->target, GNUNET_OK);
480 GNUNET_CONTAINER_DLL_remove (s->msg_head, s->msg_tail, msg);
487 client_connect (struct Session *s)
489 struct Plugin *plugin = s->plugin;
496 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
497 "Initiating outbound session peer `%s'\n",
498 GNUNET_i2s (&s->target));
501 s->inbound = GNUNET_NO;
505 GNUNET_asprintf (&url, "%s%s;%u",
506 http_plugin_address_to_string (plugin, s->addr, s->addrlen),
507 GNUNET_h2s_full (&plugin->env->my_identity->hashPubKey),
510 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, plugin->name, "URL `%s'\n", url);
512 /* create get connection */
513 s->client_get = curl_easy_init ();
515 curl_easy_setopt (s->client_get, CURLOPT_VERBOSE, 1L);
516 curl_easy_setopt (s->client_get, CURLOPT_DEBUGFUNCTION, &client_log);
517 curl_easy_setopt (s->client_get, CURLOPT_DEBUGDATA, s->client_get);
520 curl_easy_setopt (s->client_get, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1);
521 curl_easy_setopt (s->client_get, CURLOPT_SSL_VERIFYPEER, 0);
522 curl_easy_setopt (s->client_get, CURLOPT_SSL_VERIFYHOST, 0);
524 curl_easy_setopt (s->client_get, CURLOPT_URL, url);
525 //curl_easy_setopt (s->client_get, CURLOPT_HEADERFUNCTION, &curl_get_header_cb);
526 //curl_easy_setopt (s->client_get, CURLOPT_WRITEHEADER, ps);
527 curl_easy_setopt (s->client_get, CURLOPT_READFUNCTION, client_send_cb);
528 curl_easy_setopt (s->client_get, CURLOPT_READDATA, s);
529 curl_easy_setopt (s->client_get, CURLOPT_WRITEFUNCTION, client_receive);
530 curl_easy_setopt (s->client_get, CURLOPT_WRITEDATA, s);
531 curl_easy_setopt (s->client_get, CURLOPT_TIMEOUT_MS,
532 (long) GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT.rel_value);
533 curl_easy_setopt (s->client_get, CURLOPT_PRIVATE, s);
534 curl_easy_setopt (s->client_get, CURLOPT_CONNECTTIMEOUT_MS,
535 (long) HTTP_NOT_VALIDATED_TIMEOUT.rel_value);
536 curl_easy_setopt (s->client_get, CURLOPT_BUFFERSIZE,
537 2 * GNUNET_SERVER_MAX_MESSAGE_SIZE);
539 curl_easy_setopt (ps->recv_endpoint, CURLOPT_TCP_NODELAY, 1);
542 /* create put connection */
543 s->client_put = curl_easy_init ();
545 curl_easy_setopt (s->client_put, CURLOPT_VERBOSE, 1L);
546 curl_easy_setopt (s->client_put, CURLOPT_DEBUGFUNCTION, &client_log);
547 curl_easy_setopt (s->client_put, CURLOPT_DEBUGDATA, s->client_put);
550 curl_easy_setopt (s->client_put, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1);
551 curl_easy_setopt (s->client_put, CURLOPT_SSL_VERIFYPEER, 0);
552 curl_easy_setopt (s->client_put, CURLOPT_SSL_VERIFYHOST, 0);
554 curl_easy_setopt (s->client_put, CURLOPT_URL, url);
555 curl_easy_setopt (s->client_put, CURLOPT_PUT, 1L);
556 //curl_easy_setopt (s->client_put, CURLOPT_HEADERFUNCTION, &curl_put_header_cb);
557 //curl_easy_setopt (s->client_put, CURLOPT_WRITEHEADER, ps);
558 curl_easy_setopt (s->client_put, CURLOPT_READFUNCTION, client_send_cb);
559 curl_easy_setopt (s->client_put, CURLOPT_READDATA, s);
560 curl_easy_setopt (s->client_put, CURLOPT_WRITEFUNCTION, client_receive);
561 curl_easy_setopt (s->client_put, CURLOPT_WRITEDATA, s);
562 curl_easy_setopt (s->client_put, CURLOPT_TIMEOUT_MS,
563 (long) GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT.rel_value);
564 curl_easy_setopt (s->client_put, CURLOPT_PRIVATE, s);
565 curl_easy_setopt (s->client_put, CURLOPT_CONNECTTIMEOUT_MS,
566 (long) HTTP_NOT_VALIDATED_TIMEOUT.rel_value);
567 curl_easy_setopt (s->client_put, CURLOPT_BUFFERSIZE,
568 2 * GNUNET_SERVER_MAX_MESSAGE_SIZE);
570 curl_easy_setopt (s->client_put, CURLOPT_TCP_NODELAY, 1);
575 mret = curl_multi_add_handle (plugin->client_mh, s->client_get);
576 if (mret != CURLM_OK)
578 curl_easy_cleanup (s->client_get);
583 mret = curl_multi_add_handle (plugin->client_mh, s->client_put);
584 if (mret != CURLM_OK)
586 curl_multi_remove_handle (plugin->client_mh, s->client_get);
587 curl_easy_cleanup (s->client_get);
588 curl_easy_cleanup (s->client_put);
593 /* Perform connect */
594 plugin->cur_connections += 2;
596 /* Re-schedule since handles have changed */
597 if (plugin->client_perform_task != GNUNET_SCHEDULER_NO_TASK)
599 GNUNET_SCHEDULER_cancel (plugin->client_perform_task);
600 plugin->client_perform_task = GNUNET_SCHEDULER_NO_TASK;
602 plugin->client_perform_task = GNUNET_SCHEDULER_add_now (client_run, plugin);
608 client_start (struct Plugin *plugin)
612 curl_global_init (CURL_GLOBAL_ALL);
613 plugin->client_mh = curl_multi_init ();
615 if (NULL == plugin->client_mh)
617 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, plugin->name,
619 ("Could not initialize curl multi handle, failed to start %s plugin!\n"),
627 client_stop (struct Plugin *plugin)
629 if (plugin->client_perform_task != GNUNET_SCHEDULER_NO_TASK)
631 GNUNET_SCHEDULER_cancel (plugin->client_perform_task);
632 plugin->client_perform_task = GNUNET_SCHEDULER_NO_TASK;
635 curl_multi_cleanup (plugin->client_mh);
636 curl_global_cleanup ();
641 /* end of plugin_transport_http_client.c */