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,
56 "transport-https", "Client: %X - %s", cls, text);
58 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
59 "transport-http", "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,
141 GNUNET_NETWORK_fdset_destroy (gws);
142 GNUNET_NETWORK_fdset_destroy (grs);
148 client_send (struct Session *s, struct HTTP_Message *msg)
150 GNUNET_CONTAINER_DLL_insert (s->msg_head, s->msg_tail, msg);
152 if ((s != NULL) && (s->client_put_paused == GNUNET_YES))
155 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, s->plugin->name,
156 "Client: %X was suspended, unpausing\n", s->client_put);
158 s->client_put_paused = GNUNET_NO;
159 curl_easy_pause(s->client_put, CURLPAUSE_CONT);
162 client_schedule (s->plugin, GNUNET_YES);
170 * Task performing curl operations
171 * @param cls plugin as closure
172 * @param tc gnunet scheduler task context
175 client_run (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
177 struct Plugin *plugin = cls;
181 GNUNET_assert (cls != NULL);
183 plugin->client_perform_task = GNUNET_SCHEDULER_NO_TASK;
184 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
190 mret = curl_multi_perform (plugin->client_mh, &running);
194 while ((msg = curl_multi_info_read(plugin->client_mh, &msgs_left)))
196 CURL *easy_h = msg->easy_handle;
197 struct Session *s = NULL;
198 char * d = (char *) s;
201 //GNUNET_assert (easy_h != NULL);
204 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
205 "Client: connection to ended with reason %i: `%s', %i handles running\n",
207 curl_easy_strerror(msg->data.result),
212 GNUNET_assert (CURLE_OK == curl_easy_getinfo(easy_h, CURLINFO_PRIVATE, &d));
213 s = (struct Session *) d;
214 GNUNET_assert (s != NULL);
216 if (msg->msg == CURLMSG_DONE)
218 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
219 "Client: %X connection to '%s' %s ended with reason %i: `%s'\n",
220 msg->easy_handle, GNUNET_i2s(&s->target),
221 http_plugin_address_to_string (NULL, s->addr, s->addrlen),
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",
252 GNUNET_i2s (&s->target));
255 mret = curl_multi_remove_handle (plugin->client_mh, s->client_put);
256 if (mret != CURLM_OK)
258 curl_easy_cleanup (s->client_put);
262 curl_easy_cleanup (s->client_put);
263 s->client_put = NULL;
267 if (s->recv_wakeup_task != GNUNET_SCHEDULER_NO_TASK)
269 GNUNET_SCHEDULER_cancel (s->recv_wakeup_task);
270 s->recv_wakeup_task = GNUNET_SCHEDULER_NO_TASK;
273 if (s->client_get != NULL)
276 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
277 "Client: %X Deleting outbound GET session to peer `%s'\n",
279 GNUNET_i2s (&s->target));
282 mret = curl_multi_remove_handle (plugin->client_mh, s->client_get);
283 if (mret != CURLM_OK)
285 curl_easy_cleanup (s->client_get);
289 curl_easy_cleanup (s->client_get);
290 s->client_get = NULL;
297 if (NULL != msg->transmit_cont)
298 msg->transmit_cont (msg->transmit_cont_cls, &s->target, GNUNET_SYSERR);
299 GNUNET_CONTAINER_DLL_remove(s->msg_head, s->msg_tail, msg);
304 plugin->cur_connections -= 2;
305 /* Re-schedule since handles have changed */
306 if (plugin->client_perform_task != GNUNET_SCHEDULER_NO_TASK)
308 GNUNET_SCHEDULER_cancel (plugin->client_perform_task);
309 plugin->client_perform_task = GNUNET_SCHEDULER_NO_TASK;
312 client_schedule (plugin, GNUNET_YES);
318 client_receive_mst_cb (void *cls, void *client,
319 const struct GNUNET_MessageHeader *message)
321 struct Session *s = cls;
322 struct GNUNET_TIME_Relative delay;
324 delay = http_plugin_receive (s, &s->target, message, s, s->addr, s->addrlen);
325 s->next_receive = GNUNET_TIME_absolute_add(GNUNET_TIME_absolute_get(), delay);
327 if (GNUNET_TIME_absolute_get().abs_value < s->next_receive.abs_value)
330 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), delay);
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",
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 ptr 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;
375 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
376 "Client: Received %Zu bytes from peer `%s'\n",
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 = 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 = GNUNET_SCHEDULER_add_delayed (delta, &client_wake_up, s);
397 return CURLPAUSE_ALL;
401 if (s->msg_tk == NULL)
402 s->msg_tk = GNUNET_SERVER_mst_create (&client_receive_mst_cb, s);
404 GNUNET_SERVER_mst_receive (s->msg_tk, s, stream, len, GNUNET_NO,
408 client_wake_up(NULL,NULL);
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 ptr 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;
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", s->client_put);
438 s->client_put_paused = GNUNET_YES;
439 return CURL_READFUNC_PAUSE;
442 GNUNET_assert (msg != NULL);
444 if (msg->pos < msg->size)
446 /* data fit in buffer */
447 if ((msg->size - msg->pos) <= (size * nmemb))
449 len = (msg->size - msg->pos);
450 memcpy (stream, &msg->buf[msg->pos], len);
457 memcpy (stream, &msg->buf[msg->pos], len);
462 /* no data to send */
469 if (msg->pos == msg->size)
472 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
473 "Client: %X Message with %u bytes sent, removing message from queue\n",
474 s->client_put, msg->size, msg->pos);
476 /* Calling transmit continuation */
477 if (NULL != msg->transmit_cont)
478 msg->transmit_cont (msg->transmit_cont_cls, &s->target, GNUNET_OK);
479 GNUNET_CONTAINER_DLL_remove(s->msg_head, s->msg_tail, msg);
486 client_connect (struct Session *s)
488 struct Plugin *plugin = s->plugin;
494 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
495 "Initiating outbound session peer `%s'\n",
496 GNUNET_i2s (&s->target));
499 s->inbound = GNUNET_NO;
503 GNUNET_asprintf (&url, "%s%s;%u",
504 http_plugin_address_to_string (plugin, s->addr, s->addrlen),
505 GNUNET_h2s_full (&plugin->env->my_identity->hashPubKey),plugin->last_tag);
507 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
511 /* create get connection */
512 s->client_get = curl_easy_init ();
514 curl_easy_setopt (s->client_get, CURLOPT_VERBOSE, 1L);
515 curl_easy_setopt (s->client_get, CURLOPT_DEBUGFUNCTION, &client_log);
516 curl_easy_setopt (s->client_get, CURLOPT_DEBUGDATA, s->client_get);
519 curl_easy_setopt (s->client_get, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1);
520 curl_easy_setopt (s->client_get, CURLOPT_SSL_VERIFYPEER, 0);
521 curl_easy_setopt (s->client_get, CURLOPT_SSL_VERIFYHOST, 0);
523 curl_easy_setopt (s->client_get, CURLOPT_URL, url);
524 //curl_easy_setopt (s->client_get, CURLOPT_HEADERFUNCTION, &curl_get_header_cb);
525 //curl_easy_setopt (s->client_get, CURLOPT_WRITEHEADER, ps);
526 curl_easy_setopt (s->client_get, CURLOPT_READFUNCTION, client_send_cb);
527 curl_easy_setopt (s->client_get, CURLOPT_READDATA, s);
528 curl_easy_setopt (s->client_get, CURLOPT_WRITEFUNCTION, client_receive);
529 curl_easy_setopt (s->client_get, CURLOPT_WRITEDATA, s);
530 curl_easy_setopt (s->client_get, CURLOPT_TIMEOUT_MS,
531 (long) GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT.rel_value);
532 curl_easy_setopt (s->client_get, CURLOPT_PRIVATE, s);
533 curl_easy_setopt (s->client_get, CURLOPT_CONNECTTIMEOUT_MS,
534 (long) HTTP_NOT_VALIDATED_TIMEOUT.rel_value);
535 curl_easy_setopt (s->client_get, CURLOPT_BUFFERSIZE,
536 2 * GNUNET_SERVER_MAX_MESSAGE_SIZE);
538 curl_easy_setopt (ps->recv_endpoint, CURLOPT_TCP_NODELAY, 1);
541 /* create put connection */
542 s->client_put = curl_easy_init ();
544 curl_easy_setopt (s->client_put, CURLOPT_VERBOSE, 1L);
545 curl_easy_setopt (s->client_put, CURLOPT_DEBUGFUNCTION, &client_log);
546 curl_easy_setopt (s->client_put, CURLOPT_DEBUGDATA, s->client_put);
549 curl_easy_setopt (s->client_put, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1);
550 curl_easy_setopt (s->client_put, CURLOPT_SSL_VERIFYPEER, 0);
551 curl_easy_setopt (s->client_put, CURLOPT_SSL_VERIFYHOST, 0);
553 curl_easy_setopt (s->client_put, CURLOPT_URL, url);
554 curl_easy_setopt (s->client_put, CURLOPT_PUT, 1L);
555 //curl_easy_setopt (s->client_put, CURLOPT_HEADERFUNCTION, &curl_put_header_cb);
556 //curl_easy_setopt (s->client_put, CURLOPT_WRITEHEADER, ps);
557 curl_easy_setopt (s->client_put, CURLOPT_READFUNCTION, client_send_cb);
558 curl_easy_setopt (s->client_put, CURLOPT_READDATA, s);
559 curl_easy_setopt (s->client_put, CURLOPT_WRITEFUNCTION, client_receive);
560 curl_easy_setopt (s->client_put, CURLOPT_WRITEDATA, s);
561 curl_easy_setopt (s->client_put, CURLOPT_TIMEOUT_MS,
562 (long) GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT.rel_value);
563 curl_easy_setopt (s->client_put, CURLOPT_PRIVATE, s);
564 curl_easy_setopt (s->client_put, CURLOPT_CONNECTTIMEOUT_MS,
565 (long) HTTP_NOT_VALIDATED_TIMEOUT.rel_value);
566 curl_easy_setopt (s->client_put, CURLOPT_BUFFERSIZE,
567 2 * GNUNET_SERVER_MAX_MESSAGE_SIZE);
569 curl_easy_setopt (s->client_put, CURLOPT_TCP_NODELAY, 1);
574 mret = curl_multi_add_handle (plugin->client_mh, s->client_get);
575 if (mret != CURLM_OK)
577 curl_easy_cleanup (s->client_get);
582 mret = curl_multi_add_handle (plugin->client_mh, s->client_put);
583 if (mret != CURLM_OK)
585 curl_multi_remove_handle (plugin->client_mh, s->client_get);
586 curl_easy_cleanup (s->client_get);
587 curl_easy_cleanup (s->client_put);
592 /* Perform connect */
593 plugin->cur_connections += 2;
595 /* Re-schedule since handles have changed */
596 if (plugin->client_perform_task!= GNUNET_SCHEDULER_NO_TASK)
598 GNUNET_SCHEDULER_cancel (plugin->client_perform_task);
599 plugin->client_perform_task = GNUNET_SCHEDULER_NO_TASK;
601 plugin->client_perform_task = GNUNET_SCHEDULER_add_now (client_run, plugin);
607 client_start (struct Plugin *plugin)
611 curl_global_init (CURL_GLOBAL_ALL);
612 plugin->client_mh = curl_multi_init ();
614 if (NULL == plugin->client_mh)
616 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, plugin->name,
618 ("Could not initialize curl multi handle, failed to start %s plugin!\n"),
626 client_stop (struct Plugin *plugin)
628 if (plugin->client_perform_task != GNUNET_SCHEDULER_NO_TASK)
630 GNUNET_SCHEDULER_cancel (plugin->client_perform_task);
631 plugin->client_perform_task = GNUNET_SCHEDULER_NO_TASK;
634 curl_multi_cleanup (plugin->client_mh);
635 curl_global_cleanup ();
640 /* end of plugin_transport_http_client.c */