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, 2)
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;
102 * Session handle for connections.
107 * To whom are we talking to (set to our identity
108 * if we are still waiting for the welcome message)
110 struct GNUNET_PeerIdentity target;
113 * Stored in a linked list.
115 struct Session *next;
118 * Stored in a linked list.
120 struct Session *prev;
123 * The URL to connect to
138 * ATS network type in NBO
140 uint32_t ats_address_network_type;
143 * Pointer to the global plugin struct.
145 struct HTTP_Client_Plugin *plugin;
148 * Is client send handle paused since there are no data to send?
151 int client_put_paused;
154 * Is client send handle to be disconnected due to inactivity
156 int client_put_disconnect;
159 * Was session given to transport service?
161 // int session_passed;
169 * Client receive handle
174 * next pointer for double linked list
176 struct HTTP_Message *msg_head;
179 * previous pointer for double linked list
181 struct HTTP_Message *msg_tail;
184 * Message stream tokenizer for incoming data
186 struct GNUNET_SERVER_MessageStreamTokenizer *msg_tk;
189 * Session timeout task
191 GNUNET_SCHEDULER_TaskIdentifier put_disconnect_task;
194 * Session timeout task
196 GNUNET_SCHEDULER_TaskIdentifier timeout_task;
199 * Task to wake up client receive handle when receiving is allowed again
201 GNUNET_SCHEDULER_TaskIdentifier recv_wakeup_task;
204 * Absolute time when to receive data again
205 * Used for receive throttling
207 struct GNUNET_TIME_Absolute next_receive;
212 * Encapsulation of all of the state of the plugin.
214 struct HTTP_Client_Plugin
219 struct GNUNET_TRANSPORT_PluginEnvironment *env;
222 * Linked list head of open sessions.
224 struct Session *head;
227 * Linked list tail of open sessions.
229 struct Session *tail;
242 * Maximum number of sockets the plugin can use
243 * Each http inbound /outbound connections are two connections
245 unsigned int max_connections;
248 * Current number of sockets the plugin can use
249 * Each http inbound /outbound connections are two connections
251 unsigned int cur_connections;
254 * Last used unique HTTP connection tag
271 CURLM *curl_multi_handle;
276 GNUNET_SCHEDULER_TaskIdentifier client_perform_task;
281 * Encapsulation of all of the state of the plugin.
283 struct HTTP_Client_Plugin *p;
287 * Start session timeout for a session
288 * @param s the session
291 client_start_session_timeout (struct Session *s);
295 * Increment session timeout due to activity for a session
296 * @param s the session
299 client_reschedule_session_timeout (struct Session *s);
303 * Cancel timeout for a session
304 * @param s the session
307 client_stop_session_timeout (struct Session *s);
311 * Function setting up file descriptors and scheduling task to run
313 * @param plugin plugin as closure
314 * @param now schedule task in 1ms, regardless of what curl may say
315 * @return GNUNET_SYSERR for hard failure, GNUNET_OK for ok
318 client_schedule (struct HTTP_Client_Plugin *plugin, int now);
321 client_connect_put (struct Session *s);
324 * Does a session s exists?
326 * @param plugin the plugin
327 * @param s desired session
328 * @return GNUNET_YES or GNUNET_NO
331 client_exist_session (struct HTTP_Client_Plugin *plugin, struct Session *s)
333 struct Session * head;
335 GNUNET_assert (NULL != plugin);
336 GNUNET_assert (NULL != s);
338 for (head = plugin->head; head != NULL; head = head->next)
348 * Function to log curl debug messages with GNUNET_log
351 * @param type curl_infotype
358 client_log (CURL * curl, curl_infotype type, char *data, size_t size, void *cls)
361 if ((type == CURLINFO_TEXT) || (type == CURLINFO_HEADER_IN) || (type == CURLINFO_HEADER_OUT))
369 case CURLINFO_HEADER_IN:
372 case CURLINFO_HEADER_OUT:
373 ttype = "HEADER_OUT";
379 memcpy (text, data, size);
380 if (text[size - 1] == '\n')
385 text[size + 1] = '\0';
388 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "transport-https_client",
389 "Connection %p %s: %s", cls, ttype, text);
391 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "transport-http_client",
392 "Connection %p %s: %s", cls, ttype, text);
401 * Function that can be used by the transport service to transmit
402 * a message using the plugin. Note that in the case of a
403 * peer disconnecting, the continuation MUST be called
404 * prior to the disconnect notification itself. This function
405 * will be called with this peer's HELLO message to initiate
406 * a fresh connection to another peer.
409 * @param session which session must be used
410 * @param msgbuf the message to transmit
411 * @param msgbuf_size number of bytes in 'msgbuf'
412 * @param priority how important is the message (most plugins will
413 * ignore message priority and just FIFO)
414 * @param to how long to wait at most for the transmission (does not
415 * require plugins to discard the message after the timeout,
416 * just advisory for the desired delay; most plugins will ignore
418 * @param cont continuation to call once the message has
419 * been transmitted (or if the transport is ready
420 * for the next transmission call; or if the
421 * peer disconnected...); can be NULL
422 * @param cont_cls closure for cont
423 * @return number of bytes used (on the physical network, with overheads);
424 * -1 on hard errors (i.e. address invalid); 0 is a legal value
425 * and does NOT mean that the message was not transmitted (DV)
428 http_client_plugin_send (void *cls,
429 struct Session *session,
430 const char *msgbuf, size_t msgbuf_size,
431 unsigned int priority,
432 struct GNUNET_TIME_Relative to,
433 GNUNET_TRANSPORT_TransmitContinuation cont, void *cont_cls)
435 struct HTTP_Client_Plugin *plugin = cls;
436 struct HTTP_Message *msg;
438 GNUNET_assert (plugin != NULL);
439 GNUNET_assert (session != NULL);
441 /* lookup if session is really existing */
442 if (GNUNET_YES != client_exist_session (plugin, session))
445 return GNUNET_SYSERR;
448 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, session->plugin->name,
449 "Session %p/connection %p: Sending message with %u to peer `%s' with \n",
450 session, session->client_put,
451 msgbuf_size, GNUNET_i2s (&session->target));
453 /* create new message and schedule */
454 msg = GNUNET_malloc (sizeof (struct HTTP_Message) + msgbuf_size);
456 msg->size = msgbuf_size;
458 msg->buf = (char *) &msg[1];
459 msg->transmit_cont = cont;
460 msg->transmit_cont_cls = cont_cls;
461 memcpy (msg->buf, msgbuf, msgbuf_size);
462 GNUNET_CONTAINER_DLL_insert_tail (session->msg_head, session->msg_tail, msg);
464 if (GNUNET_YES == session->client_put_disconnect)
466 session->client_put_disconnect = GNUNET_NO;
467 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, session->plugin->name,
468 "Session %p: Reconnecting PUT connection\n",
470 client_connect_put (session);
473 if (GNUNET_YES == session->client_put_paused)
475 GNUNET_assert (session->put_disconnect_task != GNUNET_SCHEDULER_NO_TASK);
476 GNUNET_SCHEDULER_cancel (session->put_disconnect_task);
477 session->put_disconnect_task = GNUNET_SCHEDULER_NO_TASK;
478 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, session->plugin->name,
479 "Session %p/connection %p: unpausing connection\n",
480 session, session->client_put);
481 session->client_put_paused = GNUNET_NO;
482 curl_easy_pause (session->client_put, CURLPAUSE_CONT);
484 client_schedule (session->plugin, GNUNET_YES);
485 client_reschedule_session_timeout (session);
493 * @param s the session to delete
496 client_delete_session (struct Session *s)
498 struct HTTP_Client_Plugin *plugin = s->plugin;
499 struct HTTP_Message *pos;
500 struct HTTP_Message *next;
502 client_stop_session_timeout (s);
504 if (GNUNET_SCHEDULER_NO_TASK != s->put_disconnect_task)
506 GNUNET_SCHEDULER_cancel (s->put_disconnect_task);
507 s->put_disconnect_task = GNUNET_SCHEDULER_NO_TASK;
510 GNUNET_CONTAINER_DLL_remove (plugin->head, plugin->tail, s);
513 while (NULL != (pos = next))
516 GNUNET_CONTAINER_DLL_remove (s->msg_head, s->msg_tail, pos);
517 if (pos->transmit_cont != NULL)
518 pos->transmit_cont (pos->transmit_cont_cls, &s->target, GNUNET_SYSERR);
522 if (s->msg_tk != NULL)
524 GNUNET_SERVER_mst_destroy (s->msg_tk);
527 GNUNET_free (s->addr);
528 GNUNET_free (s->url);
535 * Disconnect a session
538 * @return GNUNET_OK on success, GNUNET_SYSERR on error
541 client_disconnect (struct Session *s)
543 struct HTTP_Client_Plugin *plugin = s->plugin;
544 struct HTTP_Message *msg;
545 struct HTTP_Message *t;
549 if (GNUNET_YES != client_exist_session (plugin, s))
552 return GNUNET_SYSERR;
555 if (s->client_put != NULL)
557 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
558 "Session %p/connection %p: disconnecting PUT connection to peer `%s'\n",
559 s, s->client_put, GNUNET_i2s (&s->target));
561 /* remove curl handle from multi handle */
562 mret = curl_multi_remove_handle (plugin->curl_multi_handle, s->client_put);
563 if (mret != CURLM_OK)
565 /* clean up easy handle, handle is now invalid and free'd */
569 curl_easy_cleanup (s->client_put);
570 s->client_put = NULL;
574 if (s->recv_wakeup_task != GNUNET_SCHEDULER_NO_TASK)
576 GNUNET_SCHEDULER_cancel (s->recv_wakeup_task);
577 s->recv_wakeup_task = GNUNET_SCHEDULER_NO_TASK;
580 if (s->client_get != NULL)
582 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
583 "Session %p/connection %p: disconnecting GET connection to peer `%s'\n",
584 s, s->client_get, GNUNET_i2s (&s->target));
586 /* remove curl handle from multi handle */
587 mret = curl_multi_remove_handle (plugin->curl_multi_handle, s->client_get);
588 if (mret != CURLM_OK)
590 /* clean up easy handle, handle is now invalid and free'd */
594 curl_easy_cleanup (s->client_get);
595 s->client_get = NULL;
602 if (NULL != msg->transmit_cont)
603 msg->transmit_cont (msg->transmit_cont_cls, &s->target, GNUNET_SYSERR);
604 GNUNET_CONTAINER_DLL_remove (s->msg_head, s->msg_tail, msg);
609 GNUNET_assert (plugin->cur_connections >= 2);
610 plugin->cur_connections -= 2;
611 GNUNET_STATISTICS_set (plugin->env->stats,
612 "# HTTP client sessions",
613 plugin->cur_connections,
616 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
617 "Session %p: notifying transport about ending session\n",s);
619 plugin->env->session_end (plugin->env->cls, &s->target, s);
620 client_delete_session (s);
622 /* Re-schedule since handles have changed */
623 if (plugin->client_perform_task != GNUNET_SCHEDULER_NO_TASK)
625 GNUNET_SCHEDULER_cancel (plugin->client_perform_task);
626 plugin->client_perform_task = GNUNET_SCHEDULER_NO_TASK;
628 client_schedule (plugin, GNUNET_YES);
635 * Function that can be used to force the plugin to disconnect
636 * from the given peer and cancel all previous transmissions
637 * (and their continuationc).
640 * @param target peer from which to disconnect
643 http_client_plugin_disconnect (void *cls, const struct GNUNET_PeerIdentity *target)
645 struct HTTP_Client_Plugin *plugin = cls;
646 struct Session *next = NULL;
647 struct Session *pos = NULL;
649 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
650 "Transport tells me to disconnect `%s'\n",
651 GNUNET_i2s (target));
654 while (NULL != (pos = next))
657 if (0 == memcmp (target, &pos->target, sizeof (struct GNUNET_PeerIdentity)))
659 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
660 "Disconnecting session %p to `%pos'\n",
661 pos, GNUNET_i2s (target));
662 GNUNET_assert (GNUNET_OK == client_disconnect (pos));
669 static struct Session *
670 client_lookup_session (struct HTTP_Client_Plugin *plugin,
671 const struct GNUNET_HELLO_Address *address)
675 for (pos = plugin->head; NULL != pos; pos = pos->next)
676 if ((0 == memcmp (&address->peer, &pos->target, sizeof (struct GNUNET_PeerIdentity))) &&
677 (address->address_length == pos->addrlen) &&
678 (0 == memcmp (address->address, pos->addr, pos->addrlen)))
684 client_put_disconnect (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
686 struct Session *s = cls;
687 s->put_disconnect_task = GNUNET_SCHEDULER_NO_TASK;
688 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, s->plugin->name,
689 "Session %p/connection %p: will be disconnected due to no activity\n",
691 s->client_put_disconnect = GNUNET_YES;
692 s->client_put_paused = GNUNET_NO;
693 curl_easy_pause (s->client_put, CURLPAUSE_CONT);
694 client_schedule (s->plugin, GNUNET_YES);
698 * Callback method used with libcurl
699 * Method is called when libcurl needs to read data during sending
701 * @param stream pointer where to write data
702 * @param size size of an individual element
703 * @param nmemb count of elements that can be written to the buffer
704 * @param cls source pointer, passed to the libcurl handle
705 * @return bytes written to stream, returning 0 will terminate connection!
708 client_send_cb (void *stream, size_t size, size_t nmemb, void *cls)
710 struct Session *s = cls;
711 struct HTTP_Client_Plugin *plugin = s->plugin;
712 struct HTTP_Message *msg = s->msg_head;
715 if (GNUNET_YES != client_exist_session (plugin, s))
720 if (GNUNET_YES == s->client_put_disconnect)
722 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, s->plugin->name,
723 "Session %p/connection %p: disconnect due to inactivity\n",
730 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
731 "Session %p/connection %p: nothing to send, suspending\n",
733 s->put_disconnect_task = GNUNET_SCHEDULER_add_delayed (PUT_DISCONNECT_TIMEOUT, &client_put_disconnect, s);
734 s->client_put_disconnect = GNUNET_NO;
735 s->client_put_paused = GNUNET_YES;
736 return CURL_READFUNC_PAUSE;
739 GNUNET_assert (msg->pos < msg->size);
740 /* calculate how much fits in buffer */
741 len = GNUNET_MIN (msg->size - msg->pos,
743 memcpy (stream, &msg->buf[msg->pos], len);
745 if (msg->pos == msg->size)
747 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
748 "Session %p/connection %p: sent message with %u bytes sent, removing message from queue\n",
749 s, s->client_put, msg->size, msg->pos);
750 /* Calling transmit continuation */
751 GNUNET_CONTAINER_DLL_remove (s->msg_head, s->msg_tail, msg);
752 if (NULL != msg->transmit_cont)
753 msg->transmit_cont (msg->transmit_cont_cls, &s->target, GNUNET_OK);
756 client_reschedule_session_timeout (s);
762 * Wake up a curl handle which was suspended
764 * @param cls the session
765 * @param tc task context
768 client_wake_up (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
770 struct Session *s = cls;
772 if (GNUNET_YES != client_exist_session(p, s))
777 s->recv_wakeup_task = GNUNET_SCHEDULER_NO_TASK;
778 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
780 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, s->plugin->name,
781 "Session %p/connection %p: Waking up GET handle\n", s, s->client_get);
782 if (s->client_get != NULL)
783 curl_easy_pause (s->client_get, CURLPAUSE_CONT);
788 * Callback for message stream tokenizer
790 * @param cls the session
791 * @param client not used
792 * @param message the message received
793 * @return always GNUNET_OK
796 client_receive_mst_cb (void *cls, void *client,
797 const struct GNUNET_MessageHeader *message)
799 struct Session *s = cls;
800 struct HTTP_Client_Plugin *plugin;
801 struct GNUNET_TIME_Relative delay;
802 struct GNUNET_ATS_Information atsi[2];
804 if (GNUNET_YES != client_exist_session(p, s))
811 atsi[0].type = htonl (GNUNET_ATS_QUALITY_NET_DISTANCE);
812 atsi[0].value = htonl (1);
813 atsi[1].type = htonl (GNUNET_ATS_NETWORK_TYPE);
814 atsi[1].value = s->ats_address_network_type;
815 GNUNET_break (s->ats_address_network_type != ntohl (GNUNET_ATS_NET_UNSPECIFIED));
817 delay = s->plugin->env->receive (plugin->env->cls, &s->target, message,
818 (const struct GNUNET_ATS_Information *) &atsi, 2,
819 s, s->addr, s->addrlen);
821 GNUNET_TIME_absolute_add (GNUNET_TIME_absolute_get (), delay);
823 if (GNUNET_TIME_absolute_get ().abs_value < s->next_receive.abs_value)
826 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
827 "Client: peer `%s' address `%s' next read delayed for %llu ms\n",
828 GNUNET_i2s (&s->target), GNUNET_a2s (s->addr, s->addrlen),
831 client_reschedule_session_timeout (s);
838 * Callback method used with libcurl
839 * Method is called when libcurl needs to write data during sending
841 * @param stream pointer where to write data
842 * @param size size of an individual element
843 * @param nmemb count of elements that can be written to the buffer
844 * @param cls destination pointer, passed to the libcurl handle
845 * @return bytes read from stream
848 client_receive (void *stream, size_t size, size_t nmemb, void *cls)
850 struct Session *s = cls;
851 struct GNUNET_TIME_Absolute now;
852 size_t len = size * nmemb;
853 struct HTTP_Client_Plugin *plugin = s->plugin;
855 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
856 "Received %u bytes from peer `%s'\n", len,
857 GNUNET_i2s (&s->target));
858 now = GNUNET_TIME_absolute_get ();
859 if (now.abs_value < s->next_receive.abs_value)
861 struct GNUNET_TIME_Absolute now = GNUNET_TIME_absolute_get ();
862 struct GNUNET_TIME_Relative delta =
863 GNUNET_TIME_absolute_get_difference (now, s->next_receive);
864 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
865 "No inbound bandwidth for session %p available! Next read was delayed for %llu ms\n",
867 if (s->recv_wakeup_task != GNUNET_SCHEDULER_NO_TASK)
869 GNUNET_SCHEDULER_cancel (s->recv_wakeup_task);
870 s->recv_wakeup_task = GNUNET_SCHEDULER_NO_TASK;
872 s->recv_wakeup_task =
873 GNUNET_SCHEDULER_add_delayed (delta, &client_wake_up, s);
874 return CURLPAUSE_ALL;
876 if (NULL == s->msg_tk)
877 s->msg_tk = GNUNET_SERVER_mst_create (&client_receive_mst_cb, s);
879 int res = GNUNET_SERVER_mst_receive (s->msg_tk, s, stream, len, GNUNET_NO, GNUNET_NO);
880 //GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "MST RESULT : %u \n" , res);
888 * Task performing curl operations
890 * @param cls plugin as closure
891 * @param tc gnunet scheduler task context
894 client_run (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
898 * Function setting up file descriptors and scheduling task to run
900 * @param plugin plugin as closure
901 * @param now schedule task in 1ms, regardless of what curl may say
902 * @return GNUNET_SYSERR for hard failure, GNUNET_OK for ok
905 client_schedule (struct HTTP_Client_Plugin *plugin, int now)
911 struct GNUNET_NETWORK_FDSet *grs;
912 struct GNUNET_NETWORK_FDSet *gws;
915 struct GNUNET_TIME_Relative timeout;
917 /* Cancel previous scheduled task */
918 if (plugin->client_perform_task != GNUNET_SCHEDULER_NO_TASK)
920 GNUNET_SCHEDULER_cancel (plugin->client_perform_task);
921 plugin->client_perform_task = GNUNET_SCHEDULER_NO_TASK;
927 mret = curl_multi_fdset (plugin->curl_multi_handle, &rs, &ws, &es, &max);
928 if (mret != CURLM_OK)
930 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("%s failed at %s:%d: `%s'\n"),
931 "curl_multi_fdset", __FILE__, __LINE__,
932 curl_multi_strerror (mret));
933 return GNUNET_SYSERR;
935 mret = curl_multi_timeout (plugin->curl_multi_handle, &to);
937 timeout = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1);
939 timeout = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, to);
940 if (now == GNUNET_YES)
941 timeout = GNUNET_TIME_UNIT_MILLISECONDS;
943 if (mret != CURLM_OK)
945 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, _("%s failed at %s:%d: `%s'\n"),
946 "curl_multi_timeout", __FILE__, __LINE__,
947 curl_multi_strerror (mret));
948 return GNUNET_SYSERR;
951 grs = GNUNET_NETWORK_fdset_create ();
952 gws = GNUNET_NETWORK_fdset_create ();
953 GNUNET_NETWORK_fdset_copy_native (grs, &rs, max + 1);
954 GNUNET_NETWORK_fdset_copy_native (gws, &ws, max + 1);
956 plugin->client_perform_task =
957 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
959 &client_run, plugin);
960 GNUNET_NETWORK_fdset_destroy (gws);
961 GNUNET_NETWORK_fdset_destroy (grs);
967 * Task performing curl operations
969 * @param cls plugin as closure
970 * @param tc gnunet scheduler task context
973 client_run (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
975 struct HTTP_Client_Plugin *plugin = cls;
979 GNUNET_assert (cls != NULL);
981 plugin->client_perform_task = GNUNET_SCHEDULER_NO_TASK;
982 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
988 mret = curl_multi_perform (plugin->curl_multi_handle, &running);
993 while ((msg = curl_multi_info_read (plugin->curl_multi_handle, &msgs_left)))
995 CURL *easy_h = msg->easy_handle;
996 struct Session *s = NULL;
997 char *d = (char *) s;
1002 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
1003 "Client: connection to ended with reason %i: `%s', %i handles running\n",
1005 curl_easy_strerror (msg->data.result), running);
1009 GNUNET_assert (CURLE_OK ==
1010 curl_easy_getinfo (easy_h, CURLINFO_PRIVATE, &d));
1011 s = (struct Session *) d;
1013 if (GNUNET_YES != client_exist_session(plugin, s))
1019 GNUNET_assert (s != NULL);
1020 if (msg->msg == CURLMSG_DONE)
1022 if (easy_h == s->client_put)
1024 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
1025 "Session %p/connection %p: PUT connection to `%s' ended with reason %i: `%s'\n",
1026 s, msg->easy_handle, GNUNET_i2s (&s->target),
1028 curl_easy_strerror (msg->data.result));
1029 if (s->client_get == NULL)
1031 /* Disconnect other transmission direction and tell transport */
1032 //client_disconnect (s);
1035 if (easy_h == s->client_get)
1037 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
1038 "Session %p/connection %p: GET connection to `%s' ended with reason %i: `%s'\n",
1039 s, msg->easy_handle, GNUNET_i2s (&s->target),
1041 curl_easy_strerror (msg->data.result));
1043 /* Disconnect other transmission direction and tell transport */
1044 client_disconnect (s);
1049 while (mret == CURLM_CALL_MULTI_PERFORM);
1050 client_schedule (plugin, GNUNET_NO);
1054 client_connect_get (struct Session *s)
1057 /* create get connection */
1058 s->client_get = curl_easy_init ();
1060 curl_easy_setopt (s->client_get, CURLOPT_VERBOSE, 1L);
1061 curl_easy_setopt (s->client_get, CURLOPT_DEBUGFUNCTION, &client_log);
1062 curl_easy_setopt (s->client_get, CURLOPT_DEBUGDATA, s->client_get);
1065 curl_easy_setopt (s->client_get, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1);
1066 curl_easy_setopt (s->client_get, CURLOPT_SSL_VERIFYPEER, 0);
1067 curl_easy_setopt (s->client_get, CURLOPT_SSL_VERIFYHOST, 0);
1069 curl_easy_setopt (s->client_get, CURLOPT_URL, s->url);
1070 //curl_easy_setopt (s->client_get, CURLOPT_HEADERFUNCTION, &curl_get_header_cb);
1071 //curl_easy_setopt (s->client_get, CURLOPT_WRITEHEADER, ps);
1072 curl_easy_setopt (s->client_get, CURLOPT_READFUNCTION, client_send_cb);
1073 curl_easy_setopt (s->client_get, CURLOPT_READDATA, s);
1074 curl_easy_setopt (s->client_get, CURLOPT_WRITEFUNCTION, client_receive);
1075 curl_easy_setopt (s->client_get, CURLOPT_WRITEDATA, s);
1076 /* No timeout by default, timeout done with session timeout */
1077 curl_easy_setopt (s->client_get, CURLOPT_TIMEOUT, 0);
1078 curl_easy_setopt (s->client_get, CURLOPT_PRIVATE, s);
1079 curl_easy_setopt (s->client_get, CURLOPT_CONNECTTIMEOUT_MS,
1080 (long) HTTP_CLIENT_NOT_VALIDATED_TIMEOUT.rel_value);
1081 curl_easy_setopt (s->client_get, CURLOPT_BUFFERSIZE,
1082 2 * GNUNET_SERVER_MAX_MESSAGE_SIZE);
1083 #if CURL_TCP_NODELAY
1084 curl_easy_setopt (ps->recv_endpoint, CURLOPT_TCP_NODELAY, 1);
1086 mret = curl_multi_add_handle (s->plugin->curl_multi_handle, s->client_get);
1087 if (mret != CURLM_OK)
1089 curl_easy_cleanup (s->client_get);
1091 return GNUNET_SYSERR;
1098 client_connect_put (struct Session *s)
1101 /* create put connection */
1102 s->client_put = curl_easy_init ();
1104 curl_easy_setopt (s->client_put, CURLOPT_VERBOSE, 1L);
1105 curl_easy_setopt (s->client_put, CURLOPT_DEBUGFUNCTION, &client_log);
1106 curl_easy_setopt (s->client_put, CURLOPT_DEBUGDATA, s->client_put);
1109 curl_easy_setopt (s->client_put, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1);
1110 curl_easy_setopt (s->client_put, CURLOPT_SSL_VERIFYPEER, 0);
1111 curl_easy_setopt (s->client_put, CURLOPT_SSL_VERIFYHOST, 0);
1113 curl_easy_setopt (s->client_put, CURLOPT_URL, s->url);
1114 curl_easy_setopt (s->client_put, CURLOPT_UPLOAD, 1L);
1116 struct curl_slist *m_headerlist;
1117 m_headerlist = NULL;
1118 m_headerlist = curl_slist_append(m_headerlist, "Transfer-Encoding: chunked");
1119 curl_easy_setopt(s->client_put, CURLOPT_HTTPHEADER, m_headerlist);*/
1120 //curl_easy_setopt (s->client_put, CURLOPT_HEADERFUNCTION, &client_curl_header);
1121 //curl_easy_setopt (s->client_put, CURLOPT_WRITEHEADER, ps);
1122 curl_easy_setopt (s->client_put, CURLOPT_READFUNCTION, client_send_cb);
1123 curl_easy_setopt (s->client_put, CURLOPT_READDATA, s);
1124 curl_easy_setopt (s->client_put, CURLOPT_WRITEFUNCTION, client_receive);
1125 curl_easy_setopt (s->client_put, CURLOPT_WRITEDATA, s);
1126 /* No timeout by default, timeout done with session timeout */
1127 curl_easy_setopt (s->client_put, CURLOPT_TIMEOUT, 0);
1128 curl_easy_setopt (s->client_put, CURLOPT_PRIVATE, s);
1129 curl_easy_setopt (s->client_put, CURLOPT_CONNECTTIMEOUT_MS,
1130 (long) HTTP_CLIENT_NOT_VALIDATED_TIMEOUT.rel_value);
1131 curl_easy_setopt (s->client_put, CURLOPT_BUFFERSIZE,
1132 2 * GNUNET_SERVER_MAX_MESSAGE_SIZE);
1133 #if CURL_TCP_NODELAY
1134 curl_easy_setopt (s->client_put, CURLOPT_TCP_NODELAY, 1);
1137 mret = curl_multi_add_handle (s->plugin->curl_multi_handle, s->client_put);
1138 if (mret != CURLM_OK)
1140 curl_easy_cleanup (s->client_put);
1142 return GNUNET_SYSERR;
1148 client_connect (struct Session *s)
1151 struct HTTP_Client_Plugin *plugin = s->plugin;
1152 int res = GNUNET_OK;
1156 if (NULL == http_common_plugin_address_to_string (NULL, s->addr, s->addrlen))
1158 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
1159 "Invalid address peer `%s'\n",
1160 GNUNET_i2s (&s->target));
1161 return GNUNET_SYSERR;
1164 GNUNET_asprintf (&s->url, "%s/%s;%u",
1165 http_common_plugin_address_to_string (plugin, s->addr, s->addrlen),
1166 GNUNET_h2s_full (&plugin->env->my_identity->hashPubKey),
1171 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
1172 "Initiating outbound session peer `%s' using address `%s'\n",
1173 GNUNET_i2s (&s->target), s->url);
1175 if ((GNUNET_SYSERR == client_connect_get (s)) ||
1176 (GNUNET_SYSERR == client_connect_put (s)))
1179 return GNUNET_SYSERR;
1182 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
1183 "Session %p: connected with connections GET %p and PUT %p\n",
1184 s, s->client_get, s->client_put);
1186 /* Perform connect */
1187 plugin->cur_connections += 2;
1188 GNUNET_STATISTICS_set (plugin->env->stats,
1189 "# HTTP client connections",
1190 plugin->cur_connections,
1193 /* Re-schedule since handles have changed */
1194 if (plugin->client_perform_task != GNUNET_SCHEDULER_NO_TASK)
1196 GNUNET_SCHEDULER_cancel (plugin->client_perform_task);
1197 plugin->client_perform_task = GNUNET_SCHEDULER_NO_TASK;
1199 plugin->client_perform_task = GNUNET_SCHEDULER_add_now (client_run, plugin);
1205 * Creates a new outbound session the transport service will use to send data to the
1208 * @param cls the plugin
1209 * @param address the address
1210 * @return the session or NULL of max connections exceeded
1212 static struct Session *
1213 http_client_plugin_get_session (void *cls,
1214 const struct GNUNET_HELLO_Address *address)
1216 struct HTTP_Client_Plugin *plugin = cls;
1217 struct Session * s = NULL;
1218 struct sockaddr *sa;
1219 struct GNUNET_ATS_Information ats;
1223 GNUNET_assert (plugin != NULL);
1224 GNUNET_assert (address != NULL);
1225 GNUNET_assert (address->address != NULL);
1227 /* find existing session */
1228 s = client_lookup_session (plugin, address);
1232 if (plugin->max_connections <= plugin->cur_connections)
1234 GNUNET_log_from (GNUNET_ERROR_TYPE_WARNING, plugin->name,
1235 "Maximum number of connections (%u) reached: "
1236 "cannot connect to peer `%s'\n",
1237 plugin->max_connections,
1238 GNUNET_i2s (&address->peer));
1242 ats.type = htonl (GNUNET_ATS_NETWORK_TYPE);
1243 ats.value = htonl (GNUNET_ATS_NET_UNSPECIFIED);
1244 sa = http_common_socket_from_address (address->address, address->address_length, &res);
1246 if (GNUNET_SYSERR == res)
1250 else if (GNUNET_YES == res)
1252 GNUNET_assert (NULL != sa);
1253 if (AF_INET == sa->sa_family)
1255 salen = sizeof (struct sockaddr_in);
1257 else if (AF_INET == sa->sa_family)
1259 salen = sizeof (struct sockaddr_in6);
1261 ats = plugin->env->get_address_type (plugin->env->cls, sa, salen);
1264 else if (GNUNET_NO == res)
1266 ats.value = htonl (GNUNET_ATS_COST_WAN);
1269 if (GNUNET_ATS_NET_UNSPECIFIED == ntohl(ats.value))
1275 s = GNUNET_malloc (sizeof (struct Session));
1276 memcpy (&s->target, &address->peer, sizeof (struct GNUNET_PeerIdentity));
1278 s->addr = GNUNET_malloc (address->address_length);
1279 memcpy (s->addr, address->address, address->address_length);
1280 s->addrlen = address->address_length;
1281 s->ats_address_network_type = ats.value;
1283 client_start_session_timeout (s);
1285 /* add new session */
1286 GNUNET_CONTAINER_DLL_insert (plugin->head, plugin->tail, s);
1288 /* initiate new connection */
1289 if (GNUNET_SYSERR == client_connect (s))
1291 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, plugin->name,
1292 "Cannot connect to peer `%s' address `%s''\n",
1293 http_common_plugin_address_to_string (NULL, s->addr, s->addrlen),
1294 GNUNET_i2s (&s->target));
1295 client_delete_session (s);
1303 * Setup http_client plugin
1305 * @param plugin the plugin handle
1306 * @return GNUNET_OK on success, GNUNET_SYSERR on error
1309 client_start (struct HTTP_Client_Plugin *plugin)
1311 curl_global_init (CURL_GLOBAL_ALL);
1312 plugin->curl_multi_handle = curl_multi_init ();
1314 if (NULL == plugin->curl_multi_handle)
1316 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, plugin->name,
1317 _("Could not initialize curl multi handle, failed to start %s plugin!\n"),
1319 return GNUNET_SYSERR;
1325 * Session was idle, so disconnect it
1328 client_session_timeout (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1330 GNUNET_assert (NULL != cls);
1331 struct Session *s = cls;
1333 s->timeout_task = GNUNET_SCHEDULER_NO_TASK;
1334 GNUNET_log (TIMEOUT_LOG,
1335 "Session %p was idle for %llu ms, disconnecting\n",
1336 s, (unsigned long long) CLIENT_SESSION_TIMEOUT.rel_value);
1338 /* call session destroy function */
1339 GNUNET_assert (GNUNET_OK == client_disconnect (s));
1344 * Start session timeout for session s
1346 * @param s the session
1349 client_start_session_timeout (struct Session *s)
1352 GNUNET_assert (NULL != s);
1353 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == s->timeout_task);
1354 s->timeout_task = GNUNET_SCHEDULER_add_delayed (CLIENT_SESSION_TIMEOUT,
1355 &client_session_timeout,
1357 GNUNET_log (TIMEOUT_LOG,
1358 "Timeout for session %p set to %llu ms\n",
1359 s, (unsigned long long) CLIENT_SESSION_TIMEOUT.rel_value);
1364 * Increment session timeout due to activity for session s
1366 * param s the session
1369 client_reschedule_session_timeout (struct Session *s)
1372 GNUNET_assert (NULL != s);
1373 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK != s->timeout_task);
1375 GNUNET_SCHEDULER_cancel (s->timeout_task);
1376 s->timeout_task = GNUNET_SCHEDULER_add_delayed (CLIENT_SESSION_TIMEOUT,
1377 &client_session_timeout,
1379 GNUNET_log (TIMEOUT_LOG,
1380 "Timeout rescheduled for session %p set to %llu ms\n",
1381 s, (unsigned long long) CLIENT_SESSION_TIMEOUT.rel_value);
1386 * Cancel timeout due to activity for session s
1388 * param s the session
1391 client_stop_session_timeout (struct Session *s)
1393 GNUNET_assert (NULL != s);
1395 if (GNUNET_SCHEDULER_NO_TASK != s->timeout_task)
1397 GNUNET_SCHEDULER_cancel (s->timeout_task);
1398 s->timeout_task = GNUNET_SCHEDULER_NO_TASK;
1399 GNUNET_log (TIMEOUT_LOG, "Timeout stopped for session %p\n", s);
1405 * Another peer has suggested an address for this
1406 * peer and transport plugin. Check that this could be a valid
1407 * address. If so, consider adding it to the list
1410 * @param cls closure
1411 * @param addr pointer to the address
1412 * @param addrlen length of addr
1413 * @return GNUNET_OK if this is a plausible address for this peer
1417 http_client_plugin_address_suggested (void *cls, const void *addr, size_t addrlen)
1419 /* struct Plugin *plugin = cls; */
1421 /* A HTTP/S client does not have any valid address so:*/
1427 * Exit point from the plugin.
1429 * @param cls api as closure
1433 LIBGNUNET_PLUGIN_TRANSPORT_DONE (void *cls)
1435 struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
1436 struct HTTP_Client_Plugin *plugin = api->cls;
1437 struct Session *pos;
1438 struct Session *next;
1440 if (NULL == api->cls)
1447 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
1448 _("Shutting down plugin `%s'\n"),
1452 next = plugin->head;
1453 while (NULL != (pos = next))
1456 client_disconnect (pos);
1458 if (GNUNET_SCHEDULER_NO_TASK != plugin->client_perform_task)
1460 GNUNET_SCHEDULER_cancel (plugin->client_perform_task);
1461 plugin->client_perform_task = GNUNET_SCHEDULER_NO_TASK;
1465 if (NULL != plugin->curl_multi_handle)
1467 curl_multi_cleanup (plugin->curl_multi_handle);
1468 plugin->curl_multi_handle = NULL;
1470 curl_global_cleanup ();
1472 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
1473 _("Shutdown for plugin `%s' complete\n"),
1476 GNUNET_free (plugin);
1485 * @param plugin the plugin handle
1486 * @return GNUNET_OK on success, GNUNET_SYSERR on failure
1489 client_configure_plugin (struct HTTP_Client_Plugin *plugin)
1491 unsigned long long max_connections;
1493 /* Optional parameters */
1494 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_number (plugin->env->cfg,
1496 "MAX_CONNECTIONS", &max_connections))
1497 max_connections = 128;
1498 plugin->max_connections = max_connections;
1500 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, plugin->name,
1501 _("Maximum number of connections is %u\n"),
1502 plugin->max_connections);
1507 * Entry point for the plugin.
1510 LIBGNUNET_PLUGIN_TRANSPORT_INIT (void *cls)
1512 struct GNUNET_TRANSPORT_PluginEnvironment *env = cls;
1513 struct GNUNET_TRANSPORT_PluginFunctions *api;
1514 struct HTTP_Client_Plugin *plugin;
1516 if (NULL == env->receive)
1518 /* run in 'stub' mode (i.e. as part of gnunet-peerinfo), don't fully
1519 initialze the plugin or the API */
1520 api = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_PluginFunctions));
1522 api->address_to_string = &http_common_plugin_address_to_string;
1523 api->string_to_address = &http_common_plugin_string_to_address;
1524 api->address_pretty_printer = &http_common_plugin_address_pretty_printer;
1528 plugin = GNUNET_malloc (sizeof (struct HTTP_Client_Plugin));
1531 api = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_PluginFunctions));
1533 api->send = &http_client_plugin_send;
1534 api->disconnect = &http_client_plugin_disconnect;
1535 api->check_address = &http_client_plugin_address_suggested;
1536 api->get_session = &http_client_plugin_get_session;
1537 api->address_to_string = &http_common_plugin_address_to_string;
1538 api->string_to_address = &http_common_plugin_string_to_address;
1539 api->address_pretty_printer = &http_common_plugin_address_pretty_printer;
1543 plugin->name = "transport-https_client";
1544 plugin->protocol = "https";
1546 plugin->name = "transport-http_client";
1547 plugin->protocol = "http";
1549 plugin->last_tag = 1;
1551 if (GNUNET_SYSERR == client_configure_plugin (plugin))
1553 LIBGNUNET_PLUGIN_TRANSPORT_DONE (api);
1558 if (GNUNET_SYSERR == client_start (plugin))
1560 LIBGNUNET_PLUGIN_TRANSPORT_DONE (api);
1566 /* end of plugin_transport_http_client.c */