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", "Client: %X - %s", cls, text);
57 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "transport-http", "Client: %X - %s", cls, text);
65 * Task performing curl operations
66 * @param cls plugin as closure
67 * @param tc gnunet scheduler task context
70 client_run (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
73 * Function setting up file descriptors and scheduling task to run
75 * @param plugin plugin as closure
76 * @return GNUNET_SYSERR for hard failure, GNUNET_OK for ok
79 client_schedule (struct Plugin *plugin, int now)
85 struct GNUNET_NETWORK_FDSet *grs;
86 struct GNUNET_NETWORK_FDSet *gws;
89 struct GNUNET_TIME_Relative timeout;
91 /* Cancel previous scheduled task */
92 if (plugin->client_perform_task!= GNUNET_SCHEDULER_NO_TASK)
94 GNUNET_SCHEDULER_cancel (plugin->client_perform_task);
95 plugin->client_perform_task = GNUNET_SCHEDULER_NO_TASK;
102 mret = curl_multi_fdset (plugin->client_mh, &rs, &ws, &es, &max);
103 if (mret != CURLM_OK)
105 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("%s failed at %s:%d: `%s'\n"),
106 "curl_multi_fdset", __FILE__, __LINE__,
107 curl_multi_strerror (mret));
108 return GNUNET_SYSERR;
110 mret = curl_multi_timeout (plugin->client_mh, &to);
112 timeout = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1);
114 timeout = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, to);
115 if (now == GNUNET_YES)
116 timeout = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, 1);
118 if (mret != CURLM_OK)
120 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("%s failed at %s:%d: `%s'\n"),
121 "curl_multi_timeout", __FILE__, __LINE__,
122 curl_multi_strerror (mret));
123 return GNUNET_SYSERR;
126 grs = GNUNET_NETWORK_fdset_create ();
127 gws = GNUNET_NETWORK_fdset_create ();
128 GNUNET_NETWORK_fdset_copy_native (grs, &rs, max + 1);
129 GNUNET_NETWORK_fdset_copy_native (gws, &ws, max + 1);
131 plugin->client_perform_task =
132 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
133 GNUNET_SCHEDULER_NO_TASK,
139 GNUNET_NETWORK_fdset_destroy (gws);
140 GNUNET_NETWORK_fdset_destroy (grs);
146 client_send (struct Session *s, struct HTTP_Message *msg)
148 GNUNET_CONTAINER_DLL_insert (s->msg_head, s->msg_tail, msg);
150 if ((s != NULL) && (s->client_put_paused == GNUNET_YES))
153 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, s->plugin->name, "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);
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;
196 GNUNET_assert (easy_h != NULL);
198 GNUNET_assert (CURLE_OK == curl_easy_getinfo(easy_h, CURLINFO_PRIVATE, &d));
199 s = (struct Session *) d;
200 GNUNET_assert (s != NULL);
202 if (msg->msg == CURLMSG_DONE)
205 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
206 "Client: %X connection to '%s' %s ended\n", msg->easy_handle, GNUNET_i2s(&s->target), GNUNET_a2s (s->addr, s->addrlen));
208 client_disconnect(s);
209 //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));
210 notify_session_end (plugin, &s->target, s);
214 while (mret == CURLM_CALL_MULTI_PERFORM);
215 client_schedule (plugin, GNUNET_NO);
219 client_disconnect (struct Session *s)
223 struct Plugin *plugin = s->plugin;
224 struct HTTP_Message * msg;
225 struct HTTP_Message * t;
229 if (s->client_put != NULL)
232 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
233 "Client: %X Deleting outbound PUT session to peer `%s'\n",
235 GNUNET_i2s (&s->target));
238 mret = curl_multi_remove_handle (plugin->client_mh, s->client_put);
239 if (mret != CURLM_OK)
241 curl_easy_cleanup (s->client_put);
245 curl_easy_cleanup (s->client_put);
246 s->client_put = NULL;
250 if (s->recv_wakeup_task != GNUNET_SCHEDULER_NO_TASK)
252 GNUNET_SCHEDULER_cancel (s->recv_wakeup_task);
253 s->recv_wakeup_task = GNUNET_SCHEDULER_NO_TASK;
256 if (s->client_get != NULL)
259 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
260 "Client: %X Deleting outbound GET session to peer `%s'\n",
262 GNUNET_i2s (&s->target));
265 mret = curl_multi_remove_handle (plugin->client_mh, s->client_get);
266 if (mret != CURLM_OK)
268 curl_easy_cleanup (s->client_get);
272 curl_easy_cleanup (s->client_get);
273 s->client_get = NULL;
280 if (NULL != msg->transmit_cont)
281 msg->transmit_cont (msg->transmit_cont_cls, &s->target, GNUNET_SYSERR);
282 GNUNET_CONTAINER_DLL_remove(s->msg_head, s->msg_tail, msg);
287 plugin->cur_connections -= 2;
288 /* Re-schedule since handles have changed */
289 if (plugin->client_perform_task != GNUNET_SCHEDULER_NO_TASK)
291 GNUNET_SCHEDULER_cancel (plugin->client_perform_task);
292 plugin->client_perform_task = GNUNET_SCHEDULER_NO_TASK;
295 client_schedule (plugin, GNUNET_YES);
301 client_receive_mst_cb (void *cls, void *client,
302 const struct GNUNET_MessageHeader *message)
304 struct Session *s = cls;
305 struct GNUNET_TIME_Relative delay;
307 delay = http_plugin_receive (s, &s->target, message, s, s->addr, s->addrlen);
308 s->next_receive = GNUNET_TIME_absolute_add(GNUNET_TIME_absolute_get(), delay);
310 if (GNUNET_TIME_absolute_get().abs_value < s->next_receive.abs_value)
313 struct Plugin *plugin = s->plugin;
314 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name, "Client: peer `%s' address `%s' next read delayed for %llu ms\n",
315 GNUNET_i2s (&s->target), GNUNET_a2s (s->addr, s->addrlen), delay);
320 client_wake_up (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
322 struct Session *s = cls;
324 s->recv_wakeup_task = GNUNET_SCHEDULER_NO_TASK;
326 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
329 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, s->plugin->name,
330 "Client: %X Waking up receive handle\n",
333 if (s->client_get != NULL)
334 curl_easy_pause(s->client_get, CURLPAUSE_CONT);
339 * Callback method used with libcurl
340 * Method is called when libcurl needs to write data during sending
341 * @param stream pointer where to write data
342 * @param size size of an individual element
343 * @param nmemb count of elements that can be written to the buffer
344 * @param ptr destination pointer, passed to the libcurl handle
345 * @return bytes read from stream
348 client_receive (void *stream, size_t size, size_t nmemb, void *cls)
350 struct Session *s = cls;
351 struct GNUNET_TIME_Absolute now;
352 size_t len = size * nmemb;
356 struct Plugin *plugin = s->plugin;
357 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name, "Client: Received %Zu bytes from peer `%s'\n",
359 GNUNET_i2s (&s->target));
362 now = GNUNET_TIME_absolute_get();
363 if (now.abs_value < s->next_receive.abs_value)
365 struct GNUNET_TIME_Absolute now = GNUNET_TIME_absolute_get();
366 struct GNUNET_TIME_Relative delta = GNUNET_TIME_absolute_get_difference(now, s->next_receive);
368 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
369 "Client: %X No inbound bandwidth available! Next read was delayed for %llu ms\n",
370 s->client_get, delta.rel_value);
372 if (s->recv_wakeup_task != GNUNET_SCHEDULER_NO_TASK)
374 GNUNET_SCHEDULER_cancel (s->recv_wakeup_task);
375 s->recv_wakeup_task = GNUNET_SCHEDULER_NO_TASK;
377 s->recv_wakeup_task = GNUNET_SCHEDULER_add_delayed (delta, &client_wake_up, s);
378 return CURLPAUSE_ALL;
382 if (s->msg_tk == NULL)
383 s->msg_tk = GNUNET_SERVER_mst_create (&client_receive_mst_cb, s);
385 GNUNET_SERVER_mst_receive (s->msg_tk, s, stream, len, GNUNET_NO,
389 client_wake_up(NULL,NULL);
393 * Callback method used with libcurl
394 * Method is called when libcurl needs to read 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 ptr source pointer, passed to the libcurl handle
399 * @return bytes written to stream, returning 0 will terminate connection!
402 client_send_cb (void *stream, size_t size, size_t nmemb, void *cls)
404 struct Session *s = cls;
406 struct Plugin *plugin = s->plugin;
408 size_t bytes_sent = 0;
411 struct HTTP_Message *msg = s->msg_head;
416 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name, "Client: %X Nothing to send! Suspending PUT handle!\n", s->client_put);
418 s->client_put_paused = GNUNET_YES;
419 return CURL_READFUNC_PAUSE;
422 GNUNET_assert (msg != NULL);
424 if (msg->pos < msg->size)
426 /* data fit in buffer */
427 if ((msg->size - msg->pos) <= (size * nmemb))
429 len = (msg->size - msg->pos);
430 memcpy (stream, &msg->buf[msg->pos], len);
437 memcpy (stream, &msg->buf[msg->pos], len);
442 /* no data to send */
449 if (msg->pos == msg->size)
452 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
453 "Client: %X Message with %u bytes sent, removing message from queue\n",
454 s->client_put, msg->size, msg->pos);
456 /* Calling transmit continuation */
457 if (NULL != msg->transmit_cont)
458 msg->transmit_cont (msg->transmit_cont_cls, &s->target, GNUNET_OK);
459 GNUNET_CONTAINER_DLL_remove(s->msg_head, s->msg_tail, msg);
466 client_connect (struct Session *s)
468 struct Plugin *plugin = s->plugin;
474 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
475 "Initiating outbound session peer `%s'\n",
476 GNUNET_i2s (&s->target));
479 s->inbound = GNUNET_NO;
483 GNUNET_asprintf (&url, "%s%s;%u", http_plugin_address_to_string (plugin, s->addr, s->addrlen), GNUNET_h2s_full (&plugin->env->my_identity->hashPubKey),plugin->last_tag);
485 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
489 /* create get connection */
490 s->client_get = curl_easy_init ();
492 curl_easy_setopt (s->client_get, CURLOPT_VERBOSE, 1L);
493 curl_easy_setopt (s->client_get, CURLOPT_DEBUGFUNCTION, &client_log);
494 curl_easy_setopt (s->client_get, CURLOPT_DEBUGDATA, s->client_get);
497 curl_easy_setopt (s->client_get, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1);
498 curl_easy_setopt (s->client_get, CURLOPT_SSL_VERIFYPEER, 0);
499 curl_easy_setopt (s->client_get, CURLOPT_SSL_VERIFYHOST, 0);
501 curl_easy_setopt (s->client_get, CURLOPT_URL, url);
502 //curl_easy_setopt (s->client_get, CURLOPT_HEADERFUNCTION, &curl_get_header_cb);
503 //curl_easy_setopt (s->client_get, CURLOPT_WRITEHEADER, ps);
504 curl_easy_setopt (s->client_get, CURLOPT_READFUNCTION, client_send_cb);
505 curl_easy_setopt (s->client_get, CURLOPT_READDATA, s);
506 curl_easy_setopt (s->client_get, CURLOPT_WRITEFUNCTION, client_receive);
507 curl_easy_setopt (s->client_get, CURLOPT_WRITEDATA, s);
508 curl_easy_setopt (s->client_get, CURLOPT_TIMEOUT_MS,
509 (long) GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT.rel_value);
510 curl_easy_setopt (s->client_get, CURLOPT_PRIVATE, s);
511 curl_easy_setopt (s->client_get, CURLOPT_CONNECTTIMEOUT_MS,
512 (long) HTTP_NOT_VALIDATED_TIMEOUT.rel_value);
513 curl_easy_setopt (s->client_get, CURLOPT_BUFFERSIZE,
514 2 * GNUNET_SERVER_MAX_MESSAGE_SIZE);
516 curl_easy_setopt (ps->recv_endpoint, CURLOPT_TCP_NODELAY, 1);
519 /* create put connection */
520 s->client_put = curl_easy_init ();
522 curl_easy_setopt (s->client_put, CURLOPT_VERBOSE, 1L);
523 curl_easy_setopt (s->client_put, CURLOPT_DEBUGFUNCTION, &client_log);
524 curl_easy_setopt (s->client_put, CURLOPT_DEBUGDATA, s->client_put);
527 curl_easy_setopt (s->client_put, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1);
528 curl_easy_setopt (s->client_put, CURLOPT_SSL_VERIFYPEER, 0);
529 curl_easy_setopt (s->client_put, CURLOPT_SSL_VERIFYHOST, 0);
531 curl_easy_setopt (s->client_put, CURLOPT_URL, url);
532 curl_easy_setopt (s->client_put, CURLOPT_PUT, 1L);
533 //curl_easy_setopt (s->client_put, CURLOPT_HEADERFUNCTION, &curl_put_header_cb);
534 //curl_easy_setopt (s->client_put, CURLOPT_WRITEHEADER, ps);
535 curl_easy_setopt (s->client_put, CURLOPT_READFUNCTION, client_send_cb);
536 curl_easy_setopt (s->client_put, CURLOPT_READDATA, s);
537 curl_easy_setopt (s->client_put, CURLOPT_WRITEFUNCTION, client_receive);
538 curl_easy_setopt (s->client_put, CURLOPT_WRITEDATA, s);
539 curl_easy_setopt (s->client_put, CURLOPT_TIMEOUT_MS,
540 (long) GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT.rel_value);
541 curl_easy_setopt (s->client_put, CURLOPT_PRIVATE, s);
542 curl_easy_setopt (s->client_put, CURLOPT_CONNECTTIMEOUT_MS,
543 (long) HTTP_NOT_VALIDATED_TIMEOUT.rel_value);
544 curl_easy_setopt (s->client_put, CURLOPT_BUFFERSIZE,
545 2 * GNUNET_SERVER_MAX_MESSAGE_SIZE);
547 curl_easy_setopt (s->client_put, CURLOPT_TCP_NODELAY, 1);
552 mret = curl_multi_add_handle (plugin->client_mh, s->client_get);
553 if (mret != CURLM_OK)
555 curl_easy_cleanup (s->client_get);
560 mret = curl_multi_add_handle (plugin->client_mh, s->client_put);
561 if (mret != CURLM_OK)
563 curl_multi_remove_handle (plugin->client_mh, s->client_get);
564 curl_easy_cleanup (s->client_get);
565 curl_easy_cleanup (s->client_put);
570 /* Perform connect */
571 plugin->cur_connections += 2;
573 /* Re-schedule since handles have changed */
574 if (plugin->client_perform_task!= GNUNET_SCHEDULER_NO_TASK)
576 GNUNET_SCHEDULER_cancel (plugin->client_perform_task);
577 plugin->client_perform_task = GNUNET_SCHEDULER_NO_TASK;
579 plugin->client_perform_task = GNUNET_SCHEDULER_add_now (client_run, plugin);
585 client_start (struct Plugin *plugin)
589 curl_global_init (CURL_GLOBAL_ALL);
590 plugin->client_mh = curl_multi_init ();
592 if (NULL == plugin->client_mh)
594 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, plugin->name,
596 ("Could not initialize curl multi handle, failed to start %s plugin!\n"),
604 client_stop (struct Plugin *plugin)
606 if (plugin->client_perform_task != GNUNET_SCHEDULER_NO_TASK)
608 GNUNET_SCHEDULER_cancel (plugin->client_perform_task);
609 plugin->client_perform_task = GNUNET_SCHEDULER_NO_TASK;
612 curl_multi_cleanup (plugin->client_mh);
613 curl_global_cleanup ();
618 /* end of plugin_transport_http_client.c */