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/S client transport plugin
24 * @author Matthias Wachs
28 #define LIBGNUNET_PLUGIN_TRANSPORT_INIT libgnunet_plugin_transport_https_client_init
29 #define LIBGNUNET_PLUGIN_TRANSPORT_DONE libgnunet_plugin_transport_https_client_done
31 #define LIBGNUNET_PLUGIN_TRANSPORT_INIT libgnunet_plugin_transport_http_client_init
32 #define LIBGNUNET_PLUGIN_TRANSPORT_DONE libgnunet_plugin_transport_http_client_done
35 #define VERBOSE_CURL GNUNET_YES
37 #define PUT_DISCONNECT_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1)
39 #define ENABLE_PUT GNUNET_YES
40 #define ENABLE_GET GNUNET_YES
43 #include "gnunet_protocols.h"
44 #include "gnunet_common.h"
45 #include "gnunet_server_lib.h"
46 #include "gnunet_transport_plugin.h"
47 #include "plugin_transport_http_common.h"
48 #include <curl/curl.h>
52 * Encapsulation of all of the state of the plugin.
54 struct HTTP_Client_Plugin;
58 * Message to send using http
63 * next pointer for double linked list
65 struct HTTP_Message *next;
68 * previous pointer for double linked list
70 struct HTTP_Message *prev;
73 * buffer containing data to send
78 * amount of data already sent
88 * Continuation function to call once the transmission buffer
89 * has again space available. NULL if there is no
90 * continuation to call.
92 GNUNET_TRANSPORT_TransmitContinuation transmit_cont;
95 * Closure for transmit_cont.
97 void *transmit_cont_cls;
101 * Session handle for connections.
106 * To whom are we talking to (set to our identity
107 * if we are still waiting for the welcome message)
109 struct GNUNET_PeerIdentity target;
112 * Stored in a linked list.
114 struct Session *next;
117 * Stored in a linked list.
119 struct Session *prev;
122 * The URL to connect to
137 * ATS network type in NBO
139 uint32_t ats_address_network_type;
142 * Pointer to the global plugin struct.
144 struct HTTP_Client_Plugin *plugin;
147 * Was session given to transport service?
149 // int session_passed;
158 * Is the client PUT handle currently paused
163 * Is the client PUT handle disconnect in progress?
165 int put_tmp_disconnecting;
168 * Is the client PUT handle temporarily disconnected?
170 int put_tmp_disconnected;
173 * We received data to send while disconnecting, reconnect immediately
175 int put_reconnect_required;
178 * Client receive handle
183 * next pointer for double linked list
185 struct HTTP_Message *msg_head;
188 * previous pointer for double linked list
190 struct HTTP_Message *msg_tail;
193 * Message stream tokenizer for incoming data
195 struct GNUNET_SERVER_MessageStreamTokenizer *msg_tk;
198 * Session timeout task
200 GNUNET_SCHEDULER_TaskIdentifier put_disconnect_task;
203 * Session timeout task
205 GNUNET_SCHEDULER_TaskIdentifier timeout_task;
208 * Task to wake up client receive handle when receiving is allowed again
210 GNUNET_SCHEDULER_TaskIdentifier recv_wakeup_task;
213 * Absolute time when to receive data again
214 * Used for receive throttling
216 struct GNUNET_TIME_Absolute next_receive;
221 * Encapsulation of all of the state of the plugin.
223 struct HTTP_Client_Plugin
228 struct GNUNET_TRANSPORT_PluginEnvironment *env;
231 * Linked list head of open sessions.
233 struct Session *head;
236 * Linked list tail of open sessions.
238 struct Session *tail;
251 * Maximum number of sockets the plugin can use
252 * Each http inbound /outbound connections are two connections
254 unsigned int max_connections;
257 * Current number of sockets the plugin can use
258 * Each http inbound /outbound connections are two connections
260 unsigned int cur_connections;
263 * Last used unique HTTP connection tag
280 CURLM *curl_multi_handle;
285 GNUNET_SCHEDULER_TaskIdentifier client_perform_task;
290 * Encapsulation of all of the state of the plugin.
292 struct HTTP_Client_Plugin *p;
296 * Start session timeout for a session
297 * @param s the session
300 client_start_session_timeout (struct Session *s);
304 * Increment session timeout due to activity for a session
305 * @param s the session
308 client_reschedule_session_timeout (struct Session *s);
312 * Cancel timeout for a session
313 * @param s the session
316 client_stop_session_timeout (struct Session *s);
320 * Function setting up file descriptors and scheduling task to run
322 * @param plugin plugin as closure
323 * @param now schedule task in 1ms, regardless of what curl may say
324 * @return GNUNET_SYSERR for hard failure, GNUNET_OK for ok
327 client_schedule (struct HTTP_Client_Plugin *plugin, int now);
330 client_connect_put (struct Session *s);
333 * Does a session s exists?
335 * @param plugin the plugin
336 * @param s desired session
337 * @return GNUNET_YES or GNUNET_NO
340 client_exist_session (struct HTTP_Client_Plugin *plugin, struct Session *s)
342 struct Session * head;
344 GNUNET_assert (NULL != plugin);
345 GNUNET_assert (NULL != s);
347 for (head = plugin->head; head != NULL; head = head->next)
357 * Function to log curl debug messages with GNUNET_log
360 * @param type curl_infotype
367 client_log (CURL * curl, curl_infotype type, char *data, size_t size, void *cls)
370 if ((type == CURLINFO_TEXT) || (type == CURLINFO_HEADER_IN) || (type == CURLINFO_HEADER_OUT))
378 case CURLINFO_HEADER_IN:
381 case CURLINFO_HEADER_OUT:
382 ttype = "HEADER_OUT";
388 memcpy (text, data, size);
389 if (text[size - 1] == '\n')
394 text[size + 1] = '\0';
397 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "transport-https_client",
398 "Connection %p %s: %s", cls, ttype, text);
400 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "transport-http_client",
401 "Connection %p %s: %s", cls, ttype, text);
410 * Function that can be used by the transport service to transmit
411 * a message using the plugin. Note that in the case of a
412 * peer disconnecting, the continuation MUST be called
413 * prior to the disconnect notification itself. This function
414 * will be called with this peer's HELLO message to initiate
415 * a fresh connection to another peer.
418 * @param session which session must be used
419 * @param msgbuf the message to transmit
420 * @param msgbuf_size number of bytes in 'msgbuf'
421 * @param priority how important is the message (most plugins will
422 * ignore message priority and just FIFO)
423 * @param to how long to wait at most for the transmission (does not
424 * require plugins to discard the message after the timeout,
425 * just advisory for the desired delay; most plugins will ignore
427 * @param cont continuation to call once the message has
428 * been transmitted (or if the transport is ready
429 * for the next transmission call; or if the
430 * peer disconnected...); can be NULL
431 * @param cont_cls closure for cont
432 * @return number of bytes used (on the physical network, with overheads);
433 * -1 on hard errors (i.e. address invalid); 0 is a legal value
434 * and does NOT mean that the message was not transmitted (DV)
437 http_client_plugin_send (void *cls,
439 const char *msgbuf, size_t msgbuf_size,
440 unsigned int priority,
441 struct GNUNET_TIME_Relative to,
442 GNUNET_TRANSPORT_TransmitContinuation cont, void *cont_cls)
444 struct HTTP_Client_Plugin *plugin = cls;
445 struct HTTP_Message *msg;
447 GNUNET_assert (plugin != NULL);
448 GNUNET_assert (s != NULL);
450 /* lookup if session is really existing */
451 if (GNUNET_YES != client_exist_session (plugin, s))
454 return GNUNET_SYSERR;
457 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, s->plugin->name,
458 "Session %p/connection %p: Sending message with %u to peer `%s' \n",
460 msgbuf_size, GNUNET_i2s (&s->target));
462 /* create new message and schedule */
463 msg = GNUNET_malloc (sizeof (struct HTTP_Message) + msgbuf_size);
465 msg->size = msgbuf_size;
467 msg->buf = (char *) &msg[1];
468 msg->transmit_cont = cont;
469 msg->transmit_cont_cls = cont_cls;
470 memcpy (msg->buf, msgbuf, msgbuf_size);
471 GNUNET_CONTAINER_DLL_insert_tail (s->msg_head, s->msg_tail, msg);
473 if (GNUNET_YES == s->put_tmp_disconnecting)
475 /* PUT connection is currently getting disconnected */
476 s->put_reconnect_required = GNUNET_YES;
480 else if (GNUNET_YES == s->put_paused)
482 /* PUT connection was paused, unpause */
483 GNUNET_assert (s->put_disconnect_task != GNUNET_SCHEDULER_NO_TASK);
484 GNUNET_SCHEDULER_cancel (s->put_disconnect_task);
485 s->put_disconnect_task = GNUNET_SCHEDULER_NO_TASK;
486 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, s->plugin->name,
487 "Session %p/connection %p: unpausing connection\n",
489 s->put_paused = GNUNET_NO;
490 curl_easy_pause (s->client_put, CURLPAUSE_CONT);
492 else if (GNUNET_YES == s->put_tmp_disconnected)
494 /* PUT connection was disconnected, reconnect */
495 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, s->plugin->name,
496 "Session %p: Reconnecting PUT connection\n",
498 s->put_tmp_disconnected = GNUNET_NO;
499 GNUNET_break (s->client_put == NULL);
500 if (GNUNET_SYSERR == client_connect_put (s))
502 return GNUNET_SYSERR;
506 client_schedule (s->plugin, GNUNET_YES);
507 client_reschedule_session_timeout (s);
515 * @param s the session to delete
518 client_delete_session (struct Session *s)
520 struct HTTP_Client_Plugin *plugin = s->plugin;
521 struct HTTP_Message *pos;
522 struct HTTP_Message *next;
524 client_stop_session_timeout (s);
526 if (GNUNET_SCHEDULER_NO_TASK != s->put_disconnect_task)
528 GNUNET_SCHEDULER_cancel (s->put_disconnect_task);
529 s->put_disconnect_task = GNUNET_SCHEDULER_NO_TASK;
532 GNUNET_CONTAINER_DLL_remove (plugin->head, plugin->tail, s);
535 while (NULL != (pos = next))
538 GNUNET_CONTAINER_DLL_remove (s->msg_head, s->msg_tail, pos);
539 if (pos->transmit_cont != NULL)
540 pos->transmit_cont (pos->transmit_cont_cls, &s->target, GNUNET_SYSERR);
544 if (s->msg_tk != NULL)
546 GNUNET_SERVER_mst_destroy (s->msg_tk);
549 GNUNET_free (s->addr);
550 GNUNET_free (s->url);
557 * Disconnect a session
560 * @return GNUNET_OK on success, GNUNET_SYSERR on error
563 client_disconnect (struct Session *s)
565 struct HTTP_Client_Plugin *plugin = s->plugin;
566 struct HTTP_Message *msg;
567 struct HTTP_Message *t;
571 if (GNUNET_YES != client_exist_session (plugin, s))
574 return GNUNET_SYSERR;
577 if (s->client_put != NULL)
579 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
580 "Session %p/connection %p: disconnecting PUT connection to peer `%s'\n",
581 s, s->client_put, GNUNET_i2s (&s->target));
583 /* remove curl handle from multi handle */
584 mret = curl_multi_remove_handle (plugin->curl_multi_handle, s->client_put);
585 if (mret != CURLM_OK)
587 /* clean up easy handle, handle is now invalid and free'd */
591 curl_easy_cleanup (s->client_put);
592 s->client_put = NULL;
596 if (s->recv_wakeup_task != GNUNET_SCHEDULER_NO_TASK)
598 GNUNET_SCHEDULER_cancel (s->recv_wakeup_task);
599 s->recv_wakeup_task = GNUNET_SCHEDULER_NO_TASK;
602 if (s->client_get != NULL)
604 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
605 "Session %p/connection %p: disconnecting GET connection to peer `%s'\n",
606 s, s->client_get, GNUNET_i2s (&s->target));
608 /* remove curl handle from multi handle */
609 mret = curl_multi_remove_handle (plugin->curl_multi_handle, s->client_get);
610 if (mret != CURLM_OK)
612 /* clean up easy handle, handle is now invalid and free'd */
616 curl_easy_cleanup (s->client_get);
617 s->client_get = NULL;
624 if (NULL != msg->transmit_cont)
625 msg->transmit_cont (msg->transmit_cont_cls, &s->target, GNUNET_SYSERR);
626 GNUNET_CONTAINER_DLL_remove (s->msg_head, s->msg_tail, msg);
631 GNUNET_assert (plugin->cur_connections >= 2);
632 plugin->cur_connections -= 2;
633 GNUNET_STATISTICS_set (plugin->env->stats,
634 "# HTTP client sessions",
635 plugin->cur_connections,
638 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
639 "Session %p: notifying transport about ending session\n",s);
641 plugin->env->session_end (plugin->env->cls, &s->target, s);
642 client_delete_session (s);
644 /* Re-schedule since handles have changed */
645 if (plugin->client_perform_task != GNUNET_SCHEDULER_NO_TASK)
647 GNUNET_SCHEDULER_cancel (plugin->client_perform_task);
648 plugin->client_perform_task = GNUNET_SCHEDULER_NO_TASK;
650 client_schedule (plugin, GNUNET_YES);
657 * Function that can be used to force the plugin to disconnect
658 * from the given peer and cancel all previous transmissions
659 * (and their continuationc).
662 * @param target peer from which to disconnect
665 http_client_plugin_disconnect (void *cls, const struct GNUNET_PeerIdentity *target)
667 struct HTTP_Client_Plugin *plugin = cls;
668 struct Session *next = NULL;
669 struct Session *pos = NULL;
671 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
672 "Transport tells me to disconnect `%s'\n",
673 GNUNET_i2s (target));
676 while (NULL != (pos = next))
679 if (0 == memcmp (target, &pos->target, sizeof (struct GNUNET_PeerIdentity)))
681 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
682 "Disconnecting session %p to `%pos'\n",
683 pos, GNUNET_i2s (target));
684 GNUNET_assert (GNUNET_OK == client_disconnect (pos));
691 static struct Session *
692 client_lookup_session (struct HTTP_Client_Plugin *plugin,
693 const struct GNUNET_HELLO_Address *address)
697 for (pos = plugin->head; NULL != pos; pos = pos->next)
698 if ((0 == memcmp (&address->peer, &pos->target, sizeof (struct GNUNET_PeerIdentity))) &&
699 (address->address_length == pos->addrlen) &&
700 (0 == memcmp (address->address, pos->addr, pos->addrlen)))
706 client_put_disconnect (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
708 struct Session *s = cls;
709 s->put_disconnect_task = GNUNET_SCHEDULER_NO_TASK;
710 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, s->plugin->name,
711 "Session %p/connection %p: will be disconnected due to no activity\n",
713 s->put_paused = GNUNET_NO;
714 s->put_tmp_disconnecting = GNUNET_YES;
715 curl_easy_pause (s->client_put, CURLPAUSE_CONT);
716 client_schedule (s->plugin, GNUNET_YES);
722 * Callback method used with libcurl
723 * Method is called when libcurl needs to read data during sending
725 * @param stream pointer where to write data
726 * @param size size of an individual element
727 * @param nmemb count of elements that can be written to the buffer
728 * @param cls source pointer, passed to the libcurl handle
729 * @return bytes written to stream, returning 0 will terminate connection!
732 client_send_cb (void *stream, size_t size, size_t nmemb, void *cls)
734 struct Session *s = cls;
735 struct HTTP_Client_Plugin *plugin = s->plugin;
736 struct HTTP_Message *msg = s->msg_head;
739 if (GNUNET_YES != client_exist_session (plugin, s))
744 if (GNUNET_YES == s->put_tmp_disconnecting)
747 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, s->plugin->name,
748 "Session %p/connection %p: disconnect due to inactivity\n",
755 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
756 "Session %p/connection %p: nothing to send, suspending\n",
758 s->put_disconnect_task = GNUNET_SCHEDULER_add_delayed (PUT_DISCONNECT_TIMEOUT, &client_put_disconnect, s);
759 s->put_paused = GNUNET_YES;
760 return CURL_READFUNC_PAUSE;
763 GNUNET_assert (msg->pos < msg->size);
764 /* calculate how much fits in buffer */
765 len = GNUNET_MIN (msg->size - msg->pos,
767 memcpy (stream, &msg->buf[msg->pos], len);
769 if (msg->pos == msg->size)
771 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
772 "Session %p/connection %p: sent message with %u bytes sent, removing message from queue\n",
773 s, s->client_put, msg->size, msg->pos);
774 /* Calling transmit continuation */
775 GNUNET_CONTAINER_DLL_remove (s->msg_head, s->msg_tail, msg);
776 if (NULL != msg->transmit_cont)
777 msg->transmit_cont (msg->transmit_cont_cls, &s->target, GNUNET_OK);
780 client_reschedule_session_timeout (s);
786 * Wake up a curl handle which was suspended
788 * @param cls the session
789 * @param tc task context
792 client_wake_up (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
794 struct Session *s = cls;
796 if (GNUNET_YES != client_exist_session(p, s))
801 s->recv_wakeup_task = GNUNET_SCHEDULER_NO_TASK;
802 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
804 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, s->plugin->name,
805 "Session %p/connection %p: Waking up GET handle\n", s, s->client_get);
806 if (s->client_get != NULL)
807 curl_easy_pause (s->client_get, CURLPAUSE_CONT);
812 * Callback for message stream tokenizer
814 * @param cls the session
815 * @param client not used
816 * @param message the message received
817 * @return always GNUNET_OK
820 client_receive_mst_cb (void *cls, void *client,
821 const struct GNUNET_MessageHeader *message)
823 struct Session *s = cls;
824 struct HTTP_Client_Plugin *plugin;
825 struct GNUNET_TIME_Relative delay;
826 struct GNUNET_ATS_Information atsi[2];
827 if (GNUNET_YES != client_exist_session(p, s))
834 atsi[0].type = htonl (GNUNET_ATS_QUALITY_NET_DISTANCE);
835 atsi[0].value = htonl (1);
836 atsi[1].type = htonl (GNUNET_ATS_NETWORK_TYPE);
837 atsi[1].value = s->ats_address_network_type;
838 GNUNET_break (s->ats_address_network_type != ntohl (GNUNET_ATS_NET_UNSPECIFIED));
840 delay = s->plugin->env->receive (plugin->env->cls, &s->target, message,
841 (const struct GNUNET_ATS_Information *) &atsi, 2,
842 s, s->addr, s->addrlen);
845 GNUNET_TIME_absolute_add (GNUNET_TIME_absolute_get (), delay);
847 if (GNUNET_TIME_absolute_get ().abs_value < s->next_receive.abs_value)
850 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
851 "Client: peer `%s' address `%s' next read delayed for %llu ms\n",
852 GNUNET_i2s (&s->target), GNUNET_a2s (s->addr, s->addrlen),
855 client_reschedule_session_timeout (s);
861 * Callback method used with libcurl when data for a PUT connection are
862 * received. We do not expect data here, so we just dismiss it
864 * @param stream pointer where to write data
865 * @param size size of an individual element
866 * @param nmemb count of elements that can be written to the buffer
867 * @param cls destination pointer, passed to the libcurl handle
868 * @return bytes read from stream
871 client_receive_put (void *stream, size_t size, size_t nmemb, void *cls)
878 * Callback method used with libcurl when data for a GET connection are
879 * received. Forward to MST
881 * @param stream pointer where to write data
882 * @param size size of an individual element
883 * @param nmemb count of elements that can be written to the buffer
884 * @param cls destination pointer, passed to the libcurl handle
885 * @return bytes read from stream
888 client_receive (void *stream, size_t size, size_t nmemb, void *cls)
890 struct Session *s = cls;
891 struct GNUNET_TIME_Absolute now;
892 size_t len = size * nmemb;
893 struct HTTP_Client_Plugin *plugin = s->plugin;
895 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
896 "Session %p / connection %p: Received %u bytes from peer `%s'\n",
898 len, GNUNET_i2s (&s->target));
899 now = GNUNET_TIME_absolute_get ();
900 if (now.abs_value < s->next_receive.abs_value)
902 struct GNUNET_TIME_Absolute now = GNUNET_TIME_absolute_get ();
903 struct GNUNET_TIME_Relative delta =
904 GNUNET_TIME_absolute_get_difference (now, s->next_receive);
905 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
906 "Session %p / connection %p: No inbound bandwidth available! Next read was delayed for %llu ms\n",
907 s, s->client_get, delta.rel_value);
908 if (s->recv_wakeup_task != GNUNET_SCHEDULER_NO_TASK)
910 GNUNET_SCHEDULER_cancel (s->recv_wakeup_task);
911 s->recv_wakeup_task = GNUNET_SCHEDULER_NO_TASK;
913 s->recv_wakeup_task =
914 GNUNET_SCHEDULER_add_delayed (delta, &client_wake_up, s);
915 return CURL_WRITEFUNC_PAUSE;
917 if (NULL == s->msg_tk)
918 s->msg_tk = GNUNET_SERVER_mst_create (&client_receive_mst_cb, s);
919 GNUNET_SERVER_mst_receive (s->msg_tk, s, stream, len, GNUNET_NO, GNUNET_NO);
925 * Task performing curl operations
927 * @param cls plugin as closure
928 * @param tc gnunet scheduler task context
931 client_run (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
935 * Function setting up file descriptors and scheduling task to run
937 * @param plugin plugin as closure
938 * @param now schedule task in 1ms, regardless of what curl may say
939 * @return GNUNET_SYSERR for hard failure, GNUNET_OK for ok
942 client_schedule (struct HTTP_Client_Plugin *plugin, int now)
948 struct GNUNET_NETWORK_FDSet *grs;
949 struct GNUNET_NETWORK_FDSet *gws;
952 struct GNUNET_TIME_Relative timeout;
954 /* Cancel previous scheduled task */
955 if (plugin->client_perform_task != GNUNET_SCHEDULER_NO_TASK)
957 GNUNET_SCHEDULER_cancel (plugin->client_perform_task);
958 plugin->client_perform_task = GNUNET_SCHEDULER_NO_TASK;
964 mret = curl_multi_fdset (plugin->curl_multi_handle, &rs, &ws, &es, &max);
965 if (mret != CURLM_OK)
967 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("%s failed at %s:%d: `%s'\n"),
968 "curl_multi_fdset", __FILE__, __LINE__,
969 curl_multi_strerror (mret));
970 return GNUNET_SYSERR;
972 mret = curl_multi_timeout (plugin->curl_multi_handle, &to);
974 timeout = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1);
976 timeout = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, to);
977 if (now == GNUNET_YES)
978 timeout = GNUNET_TIME_UNIT_MILLISECONDS;
980 if (mret != CURLM_OK)
982 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("%s failed at %s:%d: `%s'\n"),
983 "curl_multi_timeout", __FILE__, __LINE__,
984 curl_multi_strerror (mret));
985 return GNUNET_SYSERR;
988 grs = GNUNET_NETWORK_fdset_create ();
989 gws = GNUNET_NETWORK_fdset_create ();
990 GNUNET_NETWORK_fdset_copy_native (grs, &rs, max + 1);
991 GNUNET_NETWORK_fdset_copy_native (gws, &ws, max + 1);
993 plugin->client_perform_task =
994 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
996 &client_run, plugin);
997 GNUNET_NETWORK_fdset_destroy (gws);
998 GNUNET_NETWORK_fdset_destroy (grs);
1004 * Task performing curl operations
1006 * @param cls plugin as closure
1007 * @param tc gnunet scheduler task context
1010 client_run (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1012 struct HTTP_Client_Plugin *plugin = cls;
1014 int http_statuscode;
1017 GNUNET_assert (cls != NULL);
1019 plugin->client_perform_task = GNUNET_SCHEDULER_NO_TASK;
1020 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
1026 mret = curl_multi_perform (plugin->curl_multi_handle, &running);
1031 while ((msg = curl_multi_info_read (plugin->curl_multi_handle, &msgs_left)))
1033 CURL *easy_h = msg->easy_handle;
1034 struct Session *s = NULL;
1035 char *d = (char *) s;
1040 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
1041 "Client: connection to ended with reason %i: `%s', %i handles running\n",
1043 curl_easy_strerror (msg->data.result), running);
1047 GNUNET_assert (CURLE_OK ==
1048 curl_easy_getinfo (easy_h, CURLINFO_PRIVATE, &d));
1049 s = (struct Session *) d;
1051 if (GNUNET_YES != client_exist_session(plugin, s))
1057 GNUNET_assert (s != NULL);
1058 if (msg->msg == CURLMSG_DONE)
1060 curl_easy_getinfo (easy_h, CURLINFO_RESPONSE_CODE, &http_statuscode);
1061 if (easy_h == s->client_put)
1063 if ((0 != msg->data.result) || (http_statuscode != 200))
1065 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, plugin->name,
1066 "Session %p/connection %p: PUT connection to `%s' ended with status %i reason %i: `%s'\n",
1067 s, msg->easy_handle, GNUNET_i2s (&s->target),
1070 curl_easy_strerror (msg->data.result));
1073 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, plugin->name,
1074 "Session %p/connection %p: PUT connection to `%s' ended normal\n",
1075 s, msg->easy_handle, GNUNET_i2s (&s->target));
1076 if (s->client_get == NULL)
1078 /* Disconnect other transmission direction and tell transport */
1080 curl_multi_remove_handle (plugin->curl_multi_handle, easy_h);
1081 curl_easy_cleanup (easy_h);
1082 s->put_tmp_disconnecting = GNUNET_NO;
1083 s->put_tmp_disconnected = GNUNET_YES;
1084 s->client_put = NULL;
1087 * Handling a rare case:
1088 * plugin_send was called during temporary put disconnect,
1089 * reconnect required after connection was disconnected
1091 if (GNUNET_YES == s->put_reconnect_required)
1093 s->put_reconnect_required = GNUNET_NO;
1094 client_connect_put(s);
1097 if (easy_h == s->client_get)
1099 if ((0 != msg->data.result) || (http_statuscode != 200))
1101 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
1102 "Session %p/connection %p: GET connection to `%s' ended with status %i reason %i: `%s'\n",
1103 s, msg->easy_handle, GNUNET_i2s (&s->target),
1106 curl_easy_strerror (msg->data.result));
1110 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
1111 "Session %p/connection %p: GET connection to `%s' ended normal\n",
1112 s, msg->easy_handle, GNUNET_i2s (&s->target));
1113 /* Disconnect other transmission direction and tell transport */
1114 client_disconnect (s);
1119 while (mret == CURLM_CALL_MULTI_PERFORM);
1120 client_schedule (plugin, GNUNET_NO);
1124 client_connect_get (struct Session *s)
1127 /* create get connection */
1128 s->client_get = curl_easy_init ();
1130 curl_easy_setopt (s->client_get, CURLOPT_VERBOSE, 1L);
1131 curl_easy_setopt (s->client_get, CURLOPT_DEBUGFUNCTION, &client_log);
1132 curl_easy_setopt (s->client_get, CURLOPT_DEBUGDATA, s->client_get);
1135 curl_easy_setopt (s->client_get, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1);
1136 curl_easy_setopt (s->client_get, CURLOPT_SSL_VERIFYPEER, 0);
1137 curl_easy_setopt (s->client_get, CURLOPT_SSL_VERIFYHOST, 0);
1139 curl_easy_setopt (s->client_get, CURLOPT_URL, s->url);
1140 //curl_easy_setopt (s->client_get, CURLOPT_HEADERFUNCTION, &curl_get_header_cb);
1141 //curl_easy_setopt (s->client_get, CURLOPT_WRITEHEADER, ps);
1142 curl_easy_setopt (s->client_get, CURLOPT_READFUNCTION, client_send_cb);
1143 curl_easy_setopt (s->client_get, CURLOPT_READDATA, s);
1144 curl_easy_setopt (s->client_get, CURLOPT_WRITEFUNCTION, client_receive);
1145 curl_easy_setopt (s->client_get, CURLOPT_WRITEDATA, s);
1146 /* No timeout by default, timeout done with session timeout */
1147 curl_easy_setopt (s->client_get, CURLOPT_TIMEOUT, 0);
1148 curl_easy_setopt (s->client_get, CURLOPT_PRIVATE, s);
1149 curl_easy_setopt (s->client_get, CURLOPT_CONNECTTIMEOUT_MS,
1150 (long) HTTP_CLIENT_NOT_VALIDATED_TIMEOUT.rel_value);
1151 curl_easy_setopt (s->client_get, CURLOPT_BUFFERSIZE,
1152 2 * GNUNET_SERVER_MAX_MESSAGE_SIZE);
1153 #if CURL_TCP_NODELAY
1154 curl_easy_setopt (ps->recv_endpoint, CURLOPT_TCP_NODELAY, 1);
1156 mret = curl_multi_add_handle (s->plugin->curl_multi_handle, s->client_get);
1157 if (mret != CURLM_OK)
1159 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, s->plugin->name,
1160 "Session %p : Failed to add GET handle to multihandle: `%s'\n",
1161 s, curl_multi_strerror (mret));
1162 curl_easy_cleanup (s->client_get);
1163 s->client_get = NULL;
1165 return GNUNET_SYSERR;
1172 client_connect_put (struct Session *s)
1175 /* create put connection */
1176 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, s->plugin->name,
1177 "Session %p : Init PUT handle \n", s);
1178 s->client_put = curl_easy_init ();
1180 curl_easy_setopt (s->client_put, CURLOPT_VERBOSE, 1L);
1181 curl_easy_setopt (s->client_put, CURLOPT_DEBUGFUNCTION, &client_log);
1182 curl_easy_setopt (s->client_put, CURLOPT_DEBUGDATA, s->client_put);
1185 curl_easy_setopt (s->client_put, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1);
1186 curl_easy_setopt (s->client_put, CURLOPT_SSL_VERIFYPEER, 0);
1187 curl_easy_setopt (s->client_put, CURLOPT_SSL_VERIFYHOST, 0);
1189 curl_easy_setopt (s->client_put, CURLOPT_URL, s->url);
1190 curl_easy_setopt (s->client_put, CURLOPT_UPLOAD, 1L);
1191 //curl_easy_setopt (s->client_put, CURLOPT_HEADERFUNCTION, &client_curl_header);
1192 //curl_easy_setopt (s->client_put, CURLOPT_WRITEHEADER, ps);
1193 curl_easy_setopt (s->client_put, CURLOPT_READFUNCTION, client_send_cb);
1194 curl_easy_setopt (s->client_put, CURLOPT_READDATA, s);
1195 curl_easy_setopt (s->client_put, CURLOPT_WRITEFUNCTION, client_receive_put);
1196 curl_easy_setopt (s->client_put, CURLOPT_WRITEDATA, s);
1197 /* No timeout by default, timeout done with session timeout */
1198 curl_easy_setopt (s->client_put, CURLOPT_TIMEOUT, 0);
1199 curl_easy_setopt (s->client_put, CURLOPT_PRIVATE, s);
1200 curl_easy_setopt (s->client_put, CURLOPT_CONNECTTIMEOUT_MS,
1201 (long) HTTP_CLIENT_NOT_VALIDATED_TIMEOUT.rel_value);
1202 curl_easy_setopt (s->client_put, CURLOPT_BUFFERSIZE,
1203 2 * GNUNET_SERVER_MAX_MESSAGE_SIZE);
1204 #if CURL_TCP_NODELAY
1205 curl_easy_setopt (s->client_put, CURLOPT_TCP_NODELAY, 1);
1207 mret = curl_multi_add_handle (s->plugin->curl_multi_handle, s->client_put);
1208 if (mret != CURLM_OK)
1210 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, s->plugin->name,
1211 "Session %p : Failed to add PUT handle to multihandle: `%s'\n",
1212 s, curl_multi_strerror (mret));
1213 curl_easy_cleanup (s->client_put);
1214 s->client_put = NULL;
1215 return GNUNET_SYSERR;
1221 client_connect (struct Session *s)
1224 struct HTTP_Client_Plugin *plugin = s->plugin;
1225 int res = GNUNET_OK;
1229 if (NULL == http_common_plugin_address_to_string (NULL, s->addr, s->addrlen))
1231 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
1232 "Invalid address peer `%s'\n",
1233 GNUNET_i2s (&s->target));
1234 return GNUNET_SYSERR;
1237 GNUNET_asprintf (&s->url, "%s/%s;%u",
1238 http_common_plugin_address_to_string (plugin, s->addr, s->addrlen),
1239 GNUNET_h2s_full (&plugin->env->my_identity->hashPubKey),
1244 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
1245 "Initiating outbound session peer `%s' using address `%s'\n",
1246 GNUNET_i2s (&s->target), s->url);
1248 if ((GNUNET_SYSERR == client_connect_get (s)) ||
1249 (GNUNET_SYSERR == client_connect_put (s)))
1252 return GNUNET_SYSERR;
1255 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
1256 "Session %p: connected with connections GET %p and PUT %p\n",
1257 s, s->client_get, s->client_put);
1259 /* Perform connect */
1260 plugin->cur_connections += 2;
1261 GNUNET_STATISTICS_set (plugin->env->stats,
1262 "# HTTP client connections",
1263 plugin->cur_connections,
1266 /* Re-schedule since handles have changed */
1267 if (plugin->client_perform_task != GNUNET_SCHEDULER_NO_TASK)
1269 GNUNET_SCHEDULER_cancel (plugin->client_perform_task);
1270 plugin->client_perform_task = GNUNET_SCHEDULER_NO_TASK;
1272 plugin->client_perform_task = GNUNET_SCHEDULER_add_now (client_run, plugin);
1278 * Creates a new outbound session the transport service will use to send data to the
1281 * @param cls the plugin
1282 * @param address the address
1283 * @return the session or NULL of max connections exceeded
1285 static struct Session *
1286 http_client_plugin_get_session (void *cls,
1287 const struct GNUNET_HELLO_Address *address)
1289 struct HTTP_Client_Plugin *plugin = cls;
1290 struct Session * s = NULL;
1291 struct sockaddr *sa;
1292 struct GNUNET_ATS_Information ats;
1296 GNUNET_assert (plugin != NULL);
1297 GNUNET_assert (address != NULL);
1298 GNUNET_assert (address->address != NULL);
1300 /* find existing session */
1301 s = client_lookup_session (plugin, address);
1305 if (plugin->max_connections <= plugin->cur_connections)
1307 GNUNET_log_from (GNUNET_ERROR_TYPE_WARNING, plugin->name,
1308 "Maximum number of connections (%u) reached: "
1309 "cannot connect to peer `%s'\n",
1310 plugin->max_connections,
1311 GNUNET_i2s (&address->peer));
1315 ats.type = htonl (GNUNET_ATS_NETWORK_TYPE);
1316 ats.value = htonl (GNUNET_ATS_NET_UNSPECIFIED);
1317 sa = http_common_socket_from_address (address->address, address->address_length, &res);
1319 if (GNUNET_SYSERR == res)
1323 else if (GNUNET_YES == res)
1325 GNUNET_assert (NULL != sa);
1326 if (AF_INET == sa->sa_family)
1328 salen = sizeof (struct sockaddr_in);
1330 else if (AF_INET == sa->sa_family)
1332 salen = sizeof (struct sockaddr_in6);
1334 ats = plugin->env->get_address_type (plugin->env->cls, sa, salen);
1337 else if (GNUNET_NO == res)
1339 ats.value = htonl (GNUNET_ATS_COST_WAN);
1342 if (GNUNET_ATS_NET_UNSPECIFIED == ntohl(ats.value))
1348 s = GNUNET_malloc (sizeof (struct Session));
1349 memcpy (&s->target, &address->peer, sizeof (struct GNUNET_PeerIdentity));
1351 s->addr = GNUNET_malloc (address->address_length);
1352 memcpy (s->addr, address->address, address->address_length);
1353 s->addrlen = address->address_length;
1354 s->ats_address_network_type = ats.value;
1355 s->put_paused = GNUNET_NO;
1356 s->put_tmp_disconnecting = GNUNET_NO;
1357 s->put_tmp_disconnected = GNUNET_NO;
1358 client_start_session_timeout (s);
1360 /* add new session */
1361 GNUNET_CONTAINER_DLL_insert (plugin->head, plugin->tail, s);
1363 /* initiate new connection */
1364 if (GNUNET_SYSERR == client_connect (s))
1366 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, plugin->name,
1367 "Cannot connect to peer `%s' address `%s''\n",
1368 http_common_plugin_address_to_string (NULL, s->addr, s->addrlen),
1369 GNUNET_i2s (&s->target));
1370 client_delete_session (s);
1378 * Setup http_client plugin
1380 * @param plugin the plugin handle
1381 * @return GNUNET_OK on success, GNUNET_SYSERR on error
1384 client_start (struct HTTP_Client_Plugin *plugin)
1386 curl_global_init (CURL_GLOBAL_ALL);
1387 plugin->curl_multi_handle = curl_multi_init ();
1389 if (NULL == plugin->curl_multi_handle)
1391 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, plugin->name,
1392 _("Could not initialize curl multi handle, failed to start %s plugin!\n"),
1394 return GNUNET_SYSERR;
1400 * Session was idle, so disconnect it
1403 client_session_timeout (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1405 GNUNET_assert (NULL != cls);
1406 struct Session *s = cls;
1408 s->timeout_task = GNUNET_SCHEDULER_NO_TASK;
1409 GNUNET_log (TIMEOUT_LOG,
1410 "Session %p was idle for %llu ms, disconnecting\n",
1411 s, (unsigned long long) CLIENT_SESSION_TIMEOUT.rel_value);
1413 /* call session destroy function */
1414 GNUNET_assert (GNUNET_OK == client_disconnect (s));
1419 * Start session timeout for session s
1421 * @param s the session
1424 client_start_session_timeout (struct Session *s)
1427 GNUNET_assert (NULL != s);
1428 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == s->timeout_task);
1429 s->timeout_task = GNUNET_SCHEDULER_add_delayed (CLIENT_SESSION_TIMEOUT,
1430 &client_session_timeout,
1432 GNUNET_log (TIMEOUT_LOG,
1433 "Timeout for session %p set to %llu ms\n",
1434 s, (unsigned long long) CLIENT_SESSION_TIMEOUT.rel_value);
1439 * Increment session timeout due to activity for session s
1441 * param s the session
1444 client_reschedule_session_timeout (struct Session *s)
1447 GNUNET_assert (NULL != s);
1448 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK != s->timeout_task);
1450 GNUNET_SCHEDULER_cancel (s->timeout_task);
1451 s->timeout_task = GNUNET_SCHEDULER_add_delayed (CLIENT_SESSION_TIMEOUT,
1452 &client_session_timeout,
1454 GNUNET_log (TIMEOUT_LOG,
1455 "Timeout rescheduled for session %p set to %llu ms\n",
1456 s, (unsigned long long) CLIENT_SESSION_TIMEOUT.rel_value);
1461 * Cancel timeout due to activity for session s
1463 * param s the session
1466 client_stop_session_timeout (struct Session *s)
1468 GNUNET_assert (NULL != s);
1470 if (GNUNET_SCHEDULER_NO_TASK != s->timeout_task)
1472 GNUNET_SCHEDULER_cancel (s->timeout_task);
1473 s->timeout_task = GNUNET_SCHEDULER_NO_TASK;
1474 GNUNET_log (TIMEOUT_LOG, "Timeout stopped for session %p\n", s);
1480 * Another peer has suggested an address for this
1481 * peer and transport plugin. Check that this could be a valid
1482 * address. If so, consider adding it to the list
1485 * @param cls closure
1486 * @param addr pointer to the address
1487 * @param addrlen length of addr
1488 * @return GNUNET_OK if this is a plausible address for this peer
1492 http_client_plugin_address_suggested (void *cls, const void *addr, size_t addrlen)
1494 /* struct Plugin *plugin = cls; */
1496 /* A HTTP/S client does not have any valid address so:*/
1502 * Exit point from the plugin.
1504 * @param cls api as closure
1508 LIBGNUNET_PLUGIN_TRANSPORT_DONE (void *cls)
1510 struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
1511 struct HTTP_Client_Plugin *plugin = api->cls;
1512 struct Session *pos;
1513 struct Session *next;
1515 if (NULL == api->cls)
1522 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
1523 _("Shutting down plugin `%s'\n"),
1527 next = plugin->head;
1528 while (NULL != (pos = next))
1531 client_disconnect (pos);
1533 if (GNUNET_SCHEDULER_NO_TASK != plugin->client_perform_task)
1535 GNUNET_SCHEDULER_cancel (plugin->client_perform_task);
1536 plugin->client_perform_task = GNUNET_SCHEDULER_NO_TASK;
1540 if (NULL != plugin->curl_multi_handle)
1542 curl_multi_cleanup (plugin->curl_multi_handle);
1543 plugin->curl_multi_handle = NULL;
1545 curl_global_cleanup ();
1547 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
1548 _("Shutdown for plugin `%s' complete\n"),
1551 GNUNET_free (plugin);
1560 * @param plugin the plugin handle
1561 * @return GNUNET_OK on success, GNUNET_SYSERR on failure
1564 client_configure_plugin (struct HTTP_Client_Plugin *plugin)
1566 unsigned long long max_connections;
1568 /* Optional parameters */
1569 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_number (plugin->env->cfg,
1571 "MAX_CONNECTIONS", &max_connections))
1572 max_connections = 128;
1573 plugin->max_connections = max_connections;
1575 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
1576 _("Maximum number of connections is %u\n"),
1577 plugin->max_connections);
1582 * Entry point for the plugin.
1585 LIBGNUNET_PLUGIN_TRANSPORT_INIT (void *cls)
1587 struct GNUNET_TRANSPORT_PluginEnvironment *env = cls;
1588 struct GNUNET_TRANSPORT_PluginFunctions *api;
1589 struct HTTP_Client_Plugin *plugin;
1591 if (NULL == env->receive)
1593 /* run in 'stub' mode (i.e. as part of gnunet-peerinfo), don't fully
1594 initialze the plugin or the API */
1595 api = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_PluginFunctions));
1597 api->address_to_string = &http_common_plugin_address_to_string;
1598 api->string_to_address = &http_common_plugin_string_to_address;
1599 api->address_pretty_printer = &http_common_plugin_address_pretty_printer;
1603 plugin = GNUNET_malloc (sizeof (struct HTTP_Client_Plugin));
1606 api = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_PluginFunctions));
1608 api->send = &http_client_plugin_send;
1609 api->disconnect = &http_client_plugin_disconnect;
1610 api->check_address = &http_client_plugin_address_suggested;
1611 api->get_session = &http_client_plugin_get_session;
1612 api->address_to_string = &http_common_plugin_address_to_string;
1613 api->string_to_address = &http_common_plugin_string_to_address;
1614 api->address_pretty_printer = &http_common_plugin_address_pretty_printer;
1618 plugin->name = "transport-https_client";
1619 plugin->protocol = "https";
1621 plugin->name = "transport-http_client";
1622 plugin->protocol = "http";
1624 plugin->last_tag = 1;
1626 if (GNUNET_SYSERR == client_configure_plugin (plugin))
1628 LIBGNUNET_PLUGIN_TRANSPORT_DONE (api);
1633 if (GNUNET_SYSERR == client_start (plugin))
1635 LIBGNUNET_PLUGIN_TRANSPORT_DONE (api);
1641 /* end of plugin_transport_http_client.c */