2 This file is part of GNUnet
3 Copyright (C) 2002-2014 GNUnet e.V.
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., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
22 * @file transport/plugin_transport_http_client.c
23 * @brief HTTP/S client transport plugin
24 * @author Matthias Wachs
25 * @author Christian Grothoff
29 #define PLUGIN_NAME "https_client"
30 #define HTTP_STAT_STR_CONNECTIONS "# HTTPS client connections"
31 #define LIBGNUNET_PLUGIN_TRANSPORT_INIT libgnunet_plugin_transport_https_client_init
32 #define LIBGNUNET_PLUGIN_TRANSPORT_DONE libgnunet_plugin_transport_https_client_done
34 #define PLUGIN_NAME "http_client"
35 #define HTTP_STAT_STR_CONNECTIONS "# HTTP client connections"
36 #define LIBGNUNET_PLUGIN_TRANSPORT_INIT libgnunet_plugin_transport_http_client_init
37 #define LIBGNUNET_PLUGIN_TRANSPORT_DONE libgnunet_plugin_transport_http_client_done
40 #define VERBOSE_CURL GNUNET_NO
42 #define PUT_DISCONNECT_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1)
44 #define ENABLE_PUT GNUNET_YES
45 #define ENABLE_GET GNUNET_YES
48 #include "gnunet_util_lib.h"
49 #include "gnunet_protocols.h"
50 #include "gnunet_transport_plugin.h"
51 #include "plugin_transport_http_common.h"
53 #include <curl/curl.h>
54 #elif HAVE_GNURL_CURL_H
55 #include <gnurl/curl.h>
59 #define LOG(kind,...) GNUNET_log_from(kind, PLUGIN_NAME, __VA_ARGS__)
62 * Encapsulation of all of the state of the plugin.
64 struct HTTP_Client_Plugin;
67 * State of a HTTP PUT request
69 enum HTTP_PUT_REQUEST_STATE
72 * Just created, not yet connected
82 * Paused, nothing to send
87 * Temporary disconnect in progress due to inactivity
92 * Send request while temporary disconnect, reconnect
94 H_TMP_RECONNECT_REQUIRED,
97 * Temporarily disconnected
108 * Message to send using http
113 * next pointer for double linked list
115 struct HTTP_Message *next;
118 * previous pointer for double linked list
120 struct HTTP_Message *prev;
123 * buffer containing data to send
128 * Continuation function to call once the transmission buffer
129 * has again space available. NULL if there is no
130 * continuation to call.
132 GNUNET_TRANSPORT_TransmitContinuation transmit_cont;
135 * Closure for @e transmit_cont.
137 void *transmit_cont_cls;
140 * amount of data already sent
153 * Session handle for HTTP(S) connections.
155 struct GNUNET_ATS_Session;
165 * Current state of this request
167 enum HTTP_PUT_REQUEST_STATE state;
170 * The curl easy handle
175 * The related session
177 struct GNUNET_ATS_Session *s;
182 * Session handle for connections.
184 struct GNUNET_ATS_Session
187 * The URL to connect to
194 struct GNUNET_HELLO_Address *address;
197 * Pointer to the global plugin struct.
199 struct HTTP_Client_Plugin *plugin;
202 * Handle for the HTTP PUT request.
204 struct RequestHandle put;
207 * Handle for the HTTP GET request.
209 struct RequestHandle get;
212 * next pointer for double linked list
214 struct HTTP_Message *msg_head;
217 * previous pointer for double linked list
219 struct HTTP_Message *msg_tail;
222 * Message stream tokenizer for incoming data
224 struct GNUNET_SERVER_MessageStreamTokenizer *msg_tk;
227 * Session timeout task
229 struct GNUNET_SCHEDULER_Task *put_disconnect_task;
232 * Session timeout task
234 struct GNUNET_SCHEDULER_Task *timeout_task;
237 * Task to wake up client receive handle when receiving is allowed again
239 struct GNUNET_SCHEDULER_Task *recv_wakeup_task;
242 * Absolute time when to receive data again.
243 * Used for receive throttling.
245 struct GNUNET_TIME_Absolute next_receive;
248 * When does this session time out.
250 struct GNUNET_TIME_Absolute timeout;
253 * Number of bytes waiting for transmission to this peer.
255 unsigned long long bytes_in_queue;
258 * Outbound overhead due to HTTP connection
259 * Add to next message of this session when calling callback
264 * Number of messages waiting for transmission to this peer.
266 unsigned int msgs_in_queue;
271 enum GNUNET_ATS_Network_Type scope;
276 * Encapsulation of all of the state of the plugin.
278 struct HTTP_Client_Plugin
283 struct GNUNET_TRANSPORT_PluginEnvironment *env;
288 struct GNUNET_CONTAINER_MultiPeerMap *sessions;
291 * Function to call about session status changes.
293 GNUNET_TRANSPORT_SessionInfoCallback sic;
296 * Closure for @e sic.
311 * Proxy configuration: hostname or ip of the proxy server
313 char *proxy_hostname;
316 * Username for the proxy server
318 char *proxy_username;
321 * Password for the proxy server
323 char *proxy_password;
328 CURLM *curl_multi_handle;
333 struct GNUNET_SCHEDULER_Task * client_perform_task;
336 * Type of proxy server:
338 * Valid values as supported by curl:
339 * CURLPROXY_HTTP, CURLPROXY_HTTP_1_0 CURLPROXY_SOCKS4, CURLPROXY_SOCKS5,
340 * CURLPROXY_SOCKS4A, CURLPROXY_SOCKS5_HOSTNAME
342 curl_proxytype proxytype;
345 * Use proxy tunneling:
346 * Tunnel all operations through a given HTTP instead of have the proxy
347 * evaluate the HTTP request
349 * Default: #GNUNET_NO, #GNUNET_YES experimental
351 int proxy_use_httpproxytunnel;
354 * My options to be included in the address
359 * Maximum number of sockets the plugin can use
360 * Each http connections are two requests
362 unsigned int max_requests;
365 * Current number of sockets the plugin can use
366 * Each http connections are two requests
368 unsigned int cur_requests;
371 * Last used unique HTTP connection tag
386 * Should we emulate an XHR client for testing?
393 * Disconnect a session
395 * @param cls the `struct HTTP_Client_Plugin *`
397 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
400 http_client_plugin_session_disconnect (void *cls, struct GNUNET_ATS_Session *s);
404 * If a session monitor is attached, notify it about the new
407 * @param plugin our plugin
408 * @param session session that changed state
409 * @param state new state of the session
412 notify_session_monitor (struct HTTP_Client_Plugin *plugin,
413 struct GNUNET_ATS_Session *session,
414 enum GNUNET_TRANSPORT_SessionState state)
416 struct GNUNET_TRANSPORT_SessionInfo info;
418 if (NULL == plugin->sic)
420 memset (&info, 0, sizeof (info));
422 info.is_inbound = GNUNET_NO;
423 info.num_msg_pending = session->msgs_in_queue;
424 info.num_bytes_pending = session->bytes_in_queue;
425 info.receive_delay = session->next_receive;
426 info.session_timeout = session->timeout;
427 info.address = session->address;
428 plugin->sic (plugin->sic_cls,
435 * Delete session @a s.
437 * @param s the session to delete
440 client_delete_session (struct GNUNET_ATS_Session *s)
442 struct HTTP_Client_Plugin *plugin = s->plugin;
443 struct HTTP_Message *pos;
444 struct HTTP_Message *next;
447 if (NULL != s->timeout_task)
449 GNUNET_SCHEDULER_cancel (s->timeout_task);
450 s->timeout_task = NULL;
451 s->timeout = GNUNET_TIME_UNIT_ZERO_ABS;
453 if (NULL != s->put_disconnect_task)
455 GNUNET_SCHEDULER_cancel (s->put_disconnect_task);
456 s->put_disconnect_task = NULL;
458 if (NULL != s->recv_wakeup_task)
460 GNUNET_SCHEDULER_cancel (s->recv_wakeup_task);
461 s->recv_wakeup_task = NULL;
463 GNUNET_assert (GNUNET_OK ==
464 GNUNET_CONTAINER_multipeermap_remove (plugin->sessions,
467 if (NULL != s->put.easyhandle)
469 LOG (GNUNET_ERROR_TYPE_DEBUG,
470 "Session %p/request %p: disconnecting PUT request to peer `%s'\n",
473 GNUNET_i2s (&s->address->peer));
475 /* remove curl handle from multi handle */
476 mret = curl_multi_remove_handle (plugin->curl_multi_handle,
478 GNUNET_break (CURLM_OK == mret);
479 curl_easy_cleanup (s->put.easyhandle);
480 GNUNET_assert (plugin->cur_requests > 0);
481 plugin->cur_requests--;
482 s->put.easyhandle = NULL;
484 if (NULL != s->get.easyhandle)
486 LOG (GNUNET_ERROR_TYPE_DEBUG,
487 "Session %p/request %p: disconnecting GET request to peer `%s'\n",
488 s, s->get.easyhandle,
489 GNUNET_i2s (&s->address->peer));
490 /* remove curl handle from multi handle */
491 mret = curl_multi_remove_handle (plugin->curl_multi_handle,
493 GNUNET_break (CURLM_OK == mret);
494 curl_easy_cleanup (s->get.easyhandle);
495 GNUNET_assert (plugin->cur_requests > 0);
496 plugin->cur_requests--;
497 s->get.easyhandle = NULL;
500 GNUNET_STATISTICS_set (plugin->env->stats,
501 HTTP_STAT_STR_CONNECTIONS,
502 plugin->cur_requests,
505 while (NULL != (pos = next))
508 GNUNET_CONTAINER_DLL_remove (s->msg_head,
511 GNUNET_assert (0 < s->msgs_in_queue);
513 GNUNET_assert (pos->size <= s->bytes_in_queue);
514 s->bytes_in_queue -= pos->size;
515 if (NULL != pos->transmit_cont)
516 pos->transmit_cont (pos->transmit_cont_cls,
520 pos->pos + s->overhead);
524 GNUNET_assert (0 == s->msgs_in_queue);
525 GNUNET_assert (0 == s->bytes_in_queue);
526 notify_session_monitor (plugin,
528 GNUNET_TRANSPORT_SS_DONE);
529 if (NULL != s->msg_tk)
531 GNUNET_SERVER_mst_destroy (s->msg_tk);
534 GNUNET_HELLO_address_free (s->address);
535 GNUNET_free (s->url);
541 * Increment session timeout due to activity for session @a s.
543 * @param s the session
546 client_reschedule_session_timeout (struct GNUNET_ATS_Session *s)
548 GNUNET_assert (NULL != s->timeout_task);
549 s->timeout = GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
554 * Task performing curl operations
556 * @param cls plugin as closure
557 * @param tc gnunet scheduler task context
560 client_run (void *cls);
564 * Function setting up file descriptors and scheduling task to run
566 * @param plugin the plugin as closure
567 * @param now schedule task in 1ms, regardless of what curl may say
568 * @return #GNUNET_SYSERR for hard failure, #GNUNET_OK for ok
571 client_schedule (struct HTTP_Client_Plugin *plugin,
578 struct GNUNET_NETWORK_FDSet *grs;
579 struct GNUNET_NETWORK_FDSet *gws;
582 struct GNUNET_TIME_Relative timeout;
584 /* Cancel previous scheduled task */
585 if (plugin->client_perform_task != NULL)
587 GNUNET_SCHEDULER_cancel (plugin->client_perform_task);
588 plugin->client_perform_task = NULL;
594 mret = curl_multi_fdset (plugin->curl_multi_handle, &rs, &ws, &es, &max);
595 if (mret != CURLM_OK)
597 LOG (GNUNET_ERROR_TYPE_ERROR,
598 _("%s failed at %s:%d: `%s'\n"),
602 curl_multi_strerror (mret));
603 return GNUNET_SYSERR;
605 mret = curl_multi_timeout (plugin->curl_multi_handle, &to);
607 timeout = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1);
609 timeout = GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, to);
610 if (now == GNUNET_YES)
611 timeout = GNUNET_TIME_UNIT_MILLISECONDS;
613 if (CURLM_OK != mret)
615 LOG (GNUNET_ERROR_TYPE_ERROR,
616 _("%s failed at %s:%d: `%s'\n"),
617 "curl_multi_timeout", __FILE__, __LINE__,
618 curl_multi_strerror (mret));
619 return GNUNET_SYSERR;
622 grs = GNUNET_NETWORK_fdset_create ();
623 gws = GNUNET_NETWORK_fdset_create ();
624 GNUNET_NETWORK_fdset_copy_native (grs, &rs, max + 1);
625 GNUNET_NETWORK_fdset_copy_native (gws, &ws, max + 1);
627 /* Schedule task to run when select is ready to read or write */
628 plugin->client_perform_task =
629 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
631 &client_run, plugin);
632 GNUNET_NETWORK_fdset_destroy (gws);
633 GNUNET_NETWORK_fdset_destroy (grs);
642 * @param curl the curl easy handle
643 * @param type message type
644 * @param data data to log, NOT a 0-terminated string
645 * @param size data length
646 * @param cls the closure
650 client_log (CURL *curl,
656 struct RequestHandle *ch = cls;
657 const char *ttype = "UNSPECIFIED";
660 if (! ((CURLINFO_TEXT == type) ||
661 (CURLINFO_HEADER_IN == type) ||
662 (CURLINFO_HEADER_OUT == type)))
669 case CURLINFO_HEADER_IN:
672 case CURLINFO_HEADER_OUT:
673 ttype = "HEADER_OUT";
675 GNUNET_assert (NULL != ch);
676 GNUNET_assert (NULL != ch->easyhandle);
677 GNUNET_assert (NULL != ch->s);
678 ch->s->overhead += size;
681 ttype = "UNSPECIFIED";
684 GNUNET_memcpy (text, data, size);
685 if (text[size - 1] == '\n')
692 text[size + 1] = '\0';
694 LOG (GNUNET_ERROR_TYPE_DEBUG,
704 * Connect GET request
706 * @param s the session to connect
707 * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise
710 client_connect_get (struct GNUNET_ATS_Session *s);
714 * Connect a HTTP put request
716 * @param s the session to connect
717 * @return #GNUNET_SYSERR for hard failure, #GNUNET_OK for success
720 client_connect_put (struct GNUNET_ATS_Session *s);
724 * Function that can be used by the transport service to transmit
725 * a message using the plugin. Note that in the case of a
726 * peer disconnecting, the continuation MUST be called
727 * prior to the disconnect notification itself. This function
728 * will be called with this peer's HELLO message to initiate
729 * a fresh connection to another peer.
732 * @param s which session must be used
733 * @param msgbuf the message to transmit
734 * @param msgbuf_size number of bytes in @a msgbuf
735 * @param priority how important is the message (most plugins will
736 * ignore message priority and just FIFO)
737 * @param to how long to wait at most for the transmission (does not
738 * require plugins to discard the message after the timeout,
739 * just advisory for the desired delay; most plugins will ignore
741 * @param cont continuation to call once the message has
742 * been transmitted (or if the transport is ready
743 * for the next transmission call; or if the
744 * peer disconnected...); can be NULL
745 * @param cont_cls closure for @a cont
746 * @return number of bytes used (on the physical network, with overheads);
747 * -1 on hard errors (i.e. address invalid); 0 is a legal value
748 * and does NOT mean that the message was not transmitted (DV)
751 http_client_plugin_send (void *cls,
752 struct GNUNET_ATS_Session *s,
755 unsigned int priority,
756 struct GNUNET_TIME_Relative to,
757 GNUNET_TRANSPORT_TransmitContinuation cont,
760 struct HTTP_Client_Plugin *plugin = cls;
761 struct HTTP_Message *msg;
764 LOG (GNUNET_ERROR_TYPE_DEBUG,
765 "Session %p/request %p: Sending message with %u to peer `%s' \n",
769 GNUNET_i2s (&s->address->peer));
771 /* create new message and schedule */
772 msg = GNUNET_malloc (sizeof (struct HTTP_Message) + msgbuf_size);
773 msg->size = msgbuf_size;
774 msg->buf = (char *) &msg[1];
775 msg->transmit_cont = cont;
776 msg->transmit_cont_cls = cont_cls;
777 GNUNET_memcpy (msg->buf,
780 GNUNET_CONTAINER_DLL_insert_tail (s->msg_head,
784 s->bytes_in_queue += msg->size;
786 GNUNET_asprintf (&stat_txt,
787 "# bytes currently in %s_client buffers",
789 GNUNET_STATISTICS_update (plugin->env->stats,
790 stat_txt, msgbuf_size, GNUNET_NO);
791 GNUNET_free (stat_txt);
792 notify_session_monitor (plugin,
794 GNUNET_TRANSPORT_SS_UPDATE);
795 if (H_TMP_DISCONNECTING == s->put.state)
797 /* PUT request is currently getting disconnected */
798 s->put.state = H_TMP_RECONNECT_REQUIRED;
799 LOG (GNUNET_ERROR_TYPE_DEBUG,
800 "Session %p/request %p: currently disconnecting, reconnecting immediately\n",
805 if (H_PAUSED == s->put.state)
807 /* PUT request was paused, unpause */
808 GNUNET_assert (s->put_disconnect_task != NULL);
809 GNUNET_SCHEDULER_cancel (s->put_disconnect_task);
810 s->put_disconnect_task = NULL;
811 LOG (GNUNET_ERROR_TYPE_DEBUG,
812 "Session %p/request %p: unpausing request\n",
813 s, s->put.easyhandle);
814 s->put.state = H_CONNECTED;
815 if (NULL != s->put.easyhandle)
816 curl_easy_pause (s->put.easyhandle, CURLPAUSE_CONT);
818 else if (H_TMP_DISCONNECTED == s->put.state)
820 /* PUT request was disconnected, reconnect */
821 LOG (GNUNET_ERROR_TYPE_DEBUG, "Session %p: Reconnecting PUT request\n", s);
822 GNUNET_break (NULL == s->put.easyhandle);
823 if (GNUNET_SYSERR == client_connect_put (s))
825 /* Could not reconnect */
826 http_client_plugin_session_disconnect (plugin, s);
827 return GNUNET_SYSERR;
830 client_schedule (s->plugin, GNUNET_YES);
836 * Disconnect a session
838 * @param cls the `struct HTTP_Client_Plugin *`
840 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
843 http_client_plugin_session_disconnect (void *cls,
844 struct GNUNET_ATS_Session *s)
846 struct HTTP_Client_Plugin *plugin = cls;
848 LOG (GNUNET_ERROR_TYPE_DEBUG,
849 "Session %p: notifying transport about ending session\n",
851 plugin->env->session_end (plugin->env->cls,
854 client_delete_session (s);
856 /* Re-schedule since handles have changed */
857 if (NULL != plugin->client_perform_task)
859 GNUNET_SCHEDULER_cancel (plugin->client_perform_task);
860 plugin->client_perform_task = NULL;
862 client_schedule (plugin, GNUNET_YES);
869 * Function that is called to get the keepalive factor.
870 * #GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT is divided by this number to
871 * calculate the interval between keepalive packets.
873 * @param cls closure with the `struct Plugin`
874 * @return keepalive factor
877 http_client_query_keepalive_factor (void *cls)
884 * Callback to destroys all sessions on exit.
886 * @param cls the `struct HTTP_Client_Plugin *`
887 * @param peer identity of the peer
888 * @param value the `struct GNUNET_ATS_Session *`
889 * @return #GNUNET_OK (continue iterating)
892 destroy_session_cb (void *cls,
893 const struct GNUNET_PeerIdentity *peer,
896 struct HTTP_Client_Plugin *plugin = cls;
897 struct GNUNET_ATS_Session *session = value;
899 http_client_plugin_session_disconnect (plugin, session);
905 * Function that can be used to force the plugin to disconnect
906 * from the given peer and cancel all previous transmissions
907 * (and their continuationc).
910 * @param target peer from which to disconnect
913 http_client_plugin_peer_disconnect (void *cls,
914 const struct GNUNET_PeerIdentity *target)
916 struct HTTP_Client_Plugin *plugin = cls;
918 LOG (GNUNET_ERROR_TYPE_DEBUG,
919 "Transport tells me to disconnect `%s'\n",
920 GNUNET_i2s (target));
921 GNUNET_CONTAINER_multipeermap_get_multiple (plugin->sessions,
929 * Closure for #session_lookup_client_by_address().
931 struct GNUNET_ATS_SessionClientCtx
934 * Address we are looking for.
936 const struct GNUNET_HELLO_Address *address;
939 * Session that was found.
941 struct GNUNET_ATS_Session *ret;
946 * Locate the seession object for a given address.
948 * @param cls the `struct GNUNET_ATS_SessionClientCtx *`
949 * @param key peer identity
950 * @param value the `struct GNUNET_ATS_Session` to check
951 * @return #GNUNET_NO if found, #GNUNET_OK if not
954 session_lookup_client_by_address (void *cls,
955 const struct GNUNET_PeerIdentity *key,
958 struct GNUNET_ATS_SessionClientCtx *sc_ctx = cls;
959 struct GNUNET_ATS_Session *s = value;
961 if (0 == GNUNET_HELLO_address_cmp (sc_ctx->address,
972 * Check if a sessions exists for an specific address
974 * @param plugin the plugin
975 * @param address the address
976 * @return the session or NULL
978 static struct GNUNET_ATS_Session *
979 client_lookup_session (struct HTTP_Client_Plugin *plugin,
980 const struct GNUNET_HELLO_Address *address)
982 struct GNUNET_ATS_SessionClientCtx sc_ctx;
984 sc_ctx.address = address;
986 GNUNET_CONTAINER_multipeermap_iterate (plugin->sessions,
987 &session_lookup_client_by_address,
994 * When we have nothing to transmit, we pause the HTTP PUT
995 * after a while (so that gnurl stops asking). This task
996 * is the delayed task that actually disconnects the PUT.
998 * @param cls the `struct GNUNET_ATS_Session *` with the put
1001 client_put_disconnect (void *cls)
1003 struct GNUNET_ATS_Session *s = cls;
1005 s->put_disconnect_task = NULL;
1006 LOG (GNUNET_ERROR_TYPE_DEBUG,
1007 "Session %p/request %p: will be disconnected due to no activity\n",
1008 s, s->put.easyhandle);
1009 s->put.state = H_TMP_DISCONNECTING;
1010 if (NULL != s->put.easyhandle)
1011 curl_easy_pause (s->put.easyhandle,
1013 client_schedule (s->plugin, GNUNET_YES);
1018 * Callback method used with libcurl
1019 * Method is called when libcurl needs to read data during sending
1021 * @param stream pointer where to write data
1022 * @param size size of an individual element
1023 * @param nmemb count of elements that can be written to the buffer
1024 * @param cls our `struct GNUNET_ATS_Session`
1025 * @return bytes written to stream, returning 0 will terminate request!
1028 client_send_cb (void *stream,
1033 struct GNUNET_ATS_Session *s = cls;
1034 struct HTTP_Client_Plugin *plugin = s->plugin;
1035 struct HTTP_Message *msg = s->msg_head;
1039 if (H_TMP_DISCONNECTING == s->put.state)
1041 LOG (GNUNET_ERROR_TYPE_DEBUG,
1042 "Session %p/request %p: disconnect due to inactivity\n",
1043 s, s->put.easyhandle);
1049 if (GNUNET_YES == plugin->emulate_xhr)
1051 LOG (GNUNET_ERROR_TYPE_DEBUG,
1052 "Session %p/request %p: PUT request finished\n",
1055 s->put.state = H_TMP_DISCONNECTING;
1059 /* We have nothing to send, so pause PUT request */
1060 LOG (GNUNET_ERROR_TYPE_DEBUG,
1061 "Session %p/request %p: nothing to send, suspending\n",
1064 s->put_disconnect_task
1065 = GNUNET_SCHEDULER_add_delayed (PUT_DISCONNECT_TIMEOUT,
1066 &client_put_disconnect,
1068 s->put.state = H_PAUSED;
1069 return CURL_READFUNC_PAUSE;
1072 GNUNET_assert (msg->pos < msg->size);
1073 /* calculate how much fits in buffer */
1074 len = GNUNET_MIN (msg->size - msg->pos,
1076 GNUNET_memcpy (stream,
1077 &msg->buf[msg->pos],
1080 if (msg->pos == msg->size)
1082 LOG (GNUNET_ERROR_TYPE_DEBUG,
1083 "Session %p/request %p: sent message with %u bytes sent, removing message from queue\n",
1088 /* Calling transmit continuation */
1089 GNUNET_CONTAINER_DLL_remove (s->msg_head,
1092 GNUNET_assert (0 < s->msgs_in_queue);
1094 GNUNET_assert (msg->size <= s->bytes_in_queue);
1095 s->bytes_in_queue -= msg->size;
1096 if (NULL != msg->transmit_cont)
1097 msg->transmit_cont (msg->transmit_cont_cls,
1101 msg->size + s->overhead);
1105 notify_session_monitor (plugin,
1107 GNUNET_TRANSPORT_SS_UPDATE);
1108 GNUNET_asprintf (&stat_txt,
1109 "# bytes currently in %s_client buffers",
1111 GNUNET_STATISTICS_update (plugin->env->stats,
1115 GNUNET_free (stat_txt);
1116 GNUNET_asprintf (&stat_txt,
1117 "# bytes transmitted via %s_client",
1119 GNUNET_STATISTICS_update (plugin->env->stats,
1123 GNUNET_free (stat_txt);
1129 * Wake up a curl handle which was suspended
1131 * @param cls the session
1134 client_wake_up (void *cls)
1136 struct GNUNET_ATS_Session *s = cls;
1138 s->recv_wakeup_task = NULL;
1139 LOG (GNUNET_ERROR_TYPE_DEBUG,
1140 "Session %p/request %p: Waking up GET handle\n",
1141 s, s->get.easyhandle);
1142 if (H_PAUSED == s->put.state)
1144 /* PUT request was paused, unpause */
1145 GNUNET_assert (s->put_disconnect_task != NULL);
1146 GNUNET_SCHEDULER_cancel (s->put_disconnect_task);
1147 s->put_disconnect_task = NULL;
1148 s->put.state = H_CONNECTED;
1149 if (NULL != s->put.easyhandle)
1150 curl_easy_pause (s->put.easyhandle, CURLPAUSE_CONT);
1152 if (NULL != s->get.easyhandle)
1153 curl_easy_pause (s->get.easyhandle, CURLPAUSE_CONT);
1158 * Callback for message stream tokenizer
1160 * @param cls the session
1161 * @param client not used
1162 * @param message the message received
1163 * @return always #GNUNET_OK
1166 client_receive_mst_cb (void *cls,
1168 const struct GNUNET_MessageHeader *message)
1170 struct GNUNET_ATS_Session *s = cls;
1171 struct HTTP_Client_Plugin *plugin;
1172 struct GNUNET_TIME_Relative delay;
1176 delay = s->plugin->env->receive (plugin->env->cls,
1180 GNUNET_asprintf (&stat_txt,
1181 "# bytes received via %s_client",
1183 GNUNET_STATISTICS_update (plugin->env->stats,
1185 ntohs (message->size),
1187 GNUNET_free (stat_txt);
1189 s->next_receive = GNUNET_TIME_relative_to_absolute (delay);
1190 if (GNUNET_TIME_absolute_get ().abs_value_us < s->next_receive.abs_value_us)
1192 LOG (GNUNET_ERROR_TYPE_DEBUG,
1193 "Client: peer `%s' address `%s' next read delayed for %s\n",
1194 GNUNET_i2s (&s->address->peer),
1195 http_common_plugin_address_to_string (s->plugin->protocol,
1196 s->address->address,
1197 s->address->address_length),
1198 GNUNET_STRINGS_relative_time_to_string (delay,
1201 client_reschedule_session_timeout (s);
1207 * Callback method used with libcurl when data for a PUT request are
1208 * received. We do not expect data here, so we just discard it.
1210 * @param stream pointer where to write data
1211 * @param size size of an individual element
1212 * @param nmemb count of elements that can be written to the buffer
1213 * @param cls destination pointer, passed to the libcurl handle
1214 * @return bytes read from stream
1217 client_receive_put (void *stream,
1222 return size * nmemb;
1227 * Callback method used with libcurl when data for a GET request are
1228 * received. Forward to MST
1230 * @param stream pointer where to write data
1231 * @param size size of an individual element
1232 * @param nmemb count of elements that can be written to the buffer
1233 * @param cls destination pointer, passed to the libcurl handle
1234 * @return bytes read from stream
1237 client_receive (void *stream,
1242 struct GNUNET_ATS_Session *s = cls;
1243 struct GNUNET_TIME_Absolute now;
1244 size_t len = size * nmemb;
1246 LOG (GNUNET_ERROR_TYPE_DEBUG,
1247 "Session %p / request %p: Received %u bytes from peer `%s'\n",
1251 GNUNET_i2s (&s->address->peer));
1252 now = GNUNET_TIME_absolute_get ();
1253 if (now.abs_value_us < s->next_receive.abs_value_us)
1255 struct GNUNET_TIME_Absolute now = GNUNET_TIME_absolute_get ();
1256 struct GNUNET_TIME_Relative delta
1257 = GNUNET_TIME_absolute_get_difference (now, s->next_receive);
1259 LOG (GNUNET_ERROR_TYPE_DEBUG,
1260 "Session %p / request %p: No inbound bandwidth available! Next read was delayed for %s\n",
1263 GNUNET_STRINGS_relative_time_to_string (delta,
1265 if (s->recv_wakeup_task != NULL)
1267 GNUNET_SCHEDULER_cancel (s->recv_wakeup_task);
1268 s->recv_wakeup_task = NULL;
1271 = GNUNET_SCHEDULER_add_delayed (delta,
1274 return CURL_WRITEFUNC_PAUSE;
1276 if (NULL == s->msg_tk)
1277 s->msg_tk = GNUNET_SERVER_mst_create (&client_receive_mst_cb,
1279 GNUNET_SERVER_mst_receive (s->msg_tk,
1290 * Task performing curl operations
1292 * @param cls plugin as closure
1295 client_run (void *cls)
1297 struct HTTP_Client_Plugin *plugin = cls;
1299 long http_statuscode;
1302 int put_request; /* GNUNET_YES if easy handle is put, GNUNET_NO for get */
1305 plugin->client_perform_task = NULL;
1306 /* While data are available or timeouts occured */
1310 /* Perform operations for all handles */
1311 mret = curl_multi_perform (plugin->curl_multi_handle, &running);
1313 /* Get additional information for all handles */
1314 while (NULL != (msg = curl_multi_info_read (plugin->curl_multi_handle, &msgs_left)))
1316 CURL *easy_h = msg->easy_handle;
1317 struct GNUNET_ATS_Session *s = NULL;
1318 char *d = NULL; /* curl requires 'd' to be a 'char *' */
1320 GNUNET_assert (NULL != easy_h);
1322 /* Obtain session from easy handle */
1323 GNUNET_assert (CURLE_OK == curl_easy_getinfo (easy_h, CURLINFO_PRIVATE, &d));
1324 s = (struct GNUNET_ATS_Session *) d;
1325 GNUNET_assert (NULL != s);
1327 if (msg->msg != CURLMSG_DONE)
1328 continue; /* This should not happen */
1330 /* Get HTTP response code */
1331 GNUNET_break (CURLE_OK == curl_easy_getinfo (easy_h,
1332 CURLINFO_RESPONSE_CODE, &http_statuscode));
1334 if (easy_h == s->put.easyhandle)
1335 put_request = GNUNET_YES;
1337 put_request = GNUNET_NO;
1339 /* Log status of terminated request */
1340 if ((0 != msg->data.result) || (http_statuscode != 200))
1341 LOG (GNUNET_ERROR_TYPE_DEBUG,
1342 "Session %p/request %p: %s request to `%s' ended with status %i reason %i: `%s'\n",
1343 s, msg->easy_handle,
1344 (GNUNET_YES == put_request) ? "PUT" : "GET",
1345 GNUNET_i2s (&s->address->peer),
1348 curl_easy_strerror (msg->data.result));
1350 LOG (GNUNET_ERROR_TYPE_DEBUG,
1351 "Session %p/request %p: %s request to `%s' ended normal\n",
1352 s, msg->easy_handle,
1353 (GNUNET_YES == put_request) ? "PUT" : "GET",
1354 GNUNET_i2s (&s->address->peer));
1356 /* Remove easy handle from multi handle */
1357 curl_multi_remove_handle (plugin->curl_multi_handle, easy_h);
1359 /* Clean up easy handle */
1360 curl_easy_cleanup (easy_h);
1362 /* Remove information */
1363 GNUNET_assert (plugin->cur_requests > 0);
1364 plugin->cur_requests--;
1365 LOG (GNUNET_ERROR_TYPE_INFO,
1366 "%s request to %s done, number of requests decreased to %u\n",
1367 (GNUNET_YES == put_request) ? "PUT" : "GET",
1369 plugin->cur_requests);
1371 if (GNUNET_YES == put_request)
1373 /* Clean up a PUT request */
1374 s->put.easyhandle = NULL;
1377 switch (s->put.state) {
1378 case H_NOT_CONNECTED:
1379 case H_DISCONNECTED:
1380 case H_TMP_DISCONNECTED:
1381 /* This must not happen */
1384 case H_TMP_RECONNECT_REQUIRED:
1385 /* Transport called send while disconnect in progess, reconnect */
1386 if (GNUNET_SYSERR == client_connect_put (s))
1388 /* Reconnect failed, disconnect session */
1389 http_client_plugin_session_disconnect (plugin, s);
1392 case H_TMP_DISCONNECTING:
1393 /* PUT gets temporarily disconnected */
1394 s->put.state = H_TMP_DISCONNECTED;
1398 /* PUT gets permanently disconnected */
1399 s->put.state = H_DISCONNECTED;
1400 http_client_plugin_session_disconnect (plugin, s);
1407 else if (GNUNET_NO == put_request)
1409 /* Clean up a GET request */
1410 s->get.easyhandle = NULL;
1413 /* If we are emulating an XHR client we need to make another GET
1416 if (GNUNET_YES == plugin->emulate_xhr)
1418 if (GNUNET_SYSERR == client_connect_get (s))
1419 http_client_plugin_session_disconnect (plugin, s);
1423 /* GET request was terminated, so disconnect session */
1424 http_client_plugin_session_disconnect (plugin, s);
1428 GNUNET_break (0); /* Must not happen */
1430 GNUNET_STATISTICS_set (plugin->env->stats,
1431 HTTP_STAT_STR_CONNECTIONS,
1432 plugin->cur_requests,
1436 while (mret == CURLM_CALL_MULTI_PERFORM);
1437 client_schedule (plugin, GNUNET_NO);
1443 * Open TCP socket with TCP STEALTH enabled.
1445 * @param clientp our `struct GNUNET_ATS_Session *`
1446 * @param purpose why does curl want to open a socket
1447 * @param address what kind of socket does curl want to have opened?
1448 * @return opened socket
1450 static curl_socket_t
1451 open_tcp_stealth_socket_cb (void *clientp,
1452 curlsocktype purpose,
1453 struct curl_sockaddr *address)
1455 struct GNUNET_ATS_Session *s = clientp;
1460 case CURLSOCKTYPE_IPCXN:
1461 ret = socket (address->family,
1465 return CURL_SOCKET_BAD;
1466 if ( ( (SOCK_STREAM != address->socktype) ||
1467 ( (0 != address->protocol) &&
1468 (IPPROTO_TCP != address->protocol))) )
1469 return (curl_socket_t) ret;
1470 if ( (0 != setsockopt (ret,
1474 sizeof (struct GNUNET_PeerIdentity))) )
1476 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1477 _("TCP_STEALTH not supported on this platform.\n"));
1479 return CURL_SOCKET_BAD;
1481 return (curl_socket_t) ret;
1482 case CURLSOCKTYPE_ACCEPT:
1484 return CURL_SOCKET_BAD;
1486 case CURLSOCKTYPE_LAST:
1488 return CURL_SOCKET_BAD;
1491 return CURL_SOCKET_BAD;
1498 * Connect GET request for a session
1500 * @param s the session to connect
1501 * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise
1504 client_connect_get (struct GNUNET_ATS_Session *s)
1507 struct HttpAddress *ha;
1510 ha = (struct HttpAddress *) s->address->address;
1511 options = ntohl (ha->options);
1512 /* create get request */
1513 s->get.easyhandle = curl_easy_init ();
1515 if (0 != (options & HTTP_OPTIONS_TCP_STEALTH))
1518 curl_easy_setopt (s->get.easyhandle,
1519 CURLOPT_OPENSOCKETFUNCTION,
1520 &open_tcp_stealth_socket_cb);
1521 curl_easy_setopt (s->get.easyhandle,
1522 CURLOPT_OPENSOCKETDATA,
1525 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1526 "Cannot connect, TCP STEALTH needed and not supported by kernel.\n");
1527 curl_easy_cleanup (s->get.easyhandle);
1528 s->get.easyhandle = NULL;
1530 return GNUNET_SYSERR;
1535 curl_easy_setopt (s->get.easyhandle,
1538 curl_easy_setopt (s->get.easyhandle,
1539 CURLOPT_DEBUGFUNCTION,
1541 curl_easy_setopt (s->get.easyhandle,
1546 curl_easy_setopt (s->get.easyhandle, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1);
1548 if (HTTP_OPTIONS_VERIFY_CERTIFICATE ==
1549 (options & HTTP_OPTIONS_VERIFY_CERTIFICATE))
1551 curl_easy_setopt (s->get.easyhandle,
1552 CURLOPT_SSL_VERIFYPEER, 1L);
1553 curl_easy_setopt (s->get.easyhandle,
1554 CURLOPT_SSL_VERIFYHOST,
1559 curl_easy_setopt (s->get.easyhandle,
1560 CURLOPT_SSL_VERIFYPEER,
1562 curl_easy_setopt (s->get.easyhandle,
1563 CURLOPT_SSL_VERIFYHOST,
1567 curl_easy_setopt (s->get.easyhandle,
1570 curl_easy_setopt (s->get.easyhandle,
1571 CURLOPT_REDIR_PROTOCOLS,
1574 curl_easy_setopt (s->get.easyhandle,
1577 curl_easy_setopt (s->get.easyhandle,
1578 CURLOPT_REDIR_PROTOCOLS,
1582 if (NULL != s->plugin->proxy_hostname)
1584 curl_easy_setopt (s->get.easyhandle,
1586 s->plugin->proxy_hostname);
1587 curl_easy_setopt (s->get.easyhandle,
1589 s->plugin->proxytype);
1590 if (NULL != s->plugin->proxy_username)
1591 curl_easy_setopt (s->get.easyhandle,
1592 CURLOPT_PROXYUSERNAME,
1593 s->plugin->proxy_username);
1594 if (NULL != s->plugin->proxy_password)
1595 curl_easy_setopt (s->get.easyhandle,
1596 CURLOPT_PROXYPASSWORD,
1597 s->plugin->proxy_password);
1598 if (GNUNET_YES == s->plugin->proxy_use_httpproxytunnel)
1599 curl_easy_setopt (s->get.easyhandle,
1600 CURLOPT_HTTPPROXYTUNNEL,
1601 s->plugin->proxy_use_httpproxytunnel);
1604 if (GNUNET_YES == s->plugin->emulate_xhr)
1608 GNUNET_asprintf (&url,
1611 curl_easy_setopt (s->get.easyhandle,
1618 curl_easy_setopt (s->get.easyhandle,
1622 curl_easy_setopt (s->get.easyhandle,
1623 CURLOPT_READFUNCTION,
1625 curl_easy_setopt (s->get.easyhandle,
1628 curl_easy_setopt (s->get.easyhandle,
1629 CURLOPT_WRITEFUNCTION,
1631 curl_easy_setopt (s->get.easyhandle,
1634 /* No timeout by default, timeout done with session timeout */
1635 curl_easy_setopt (s->get.easyhandle,
1638 curl_easy_setopt (s->get.easyhandle,
1639 CURLOPT_PRIVATE, s);
1640 curl_easy_setopt (s->get.easyhandle,
1641 CURLOPT_CONNECTTIMEOUT_MS,
1642 (long) (HTTP_CLIENT_NOT_VALIDATED_TIMEOUT.rel_value_us / 1000LL));
1643 curl_easy_setopt (s->get.easyhandle, CURLOPT_BUFFERSIZE,
1644 2 * GNUNET_SERVER_MAX_MESSAGE_SIZE);
1645 #if CURL_TCP_NODELAY
1646 curl_easy_setopt (ps->recv_endpoint,
1647 CURLOPT_TCP_NODELAY,
1650 curl_easy_setopt (s->get.easyhandle,
1651 CURLOPT_FOLLOWLOCATION,
1654 mret = curl_multi_add_handle (s->plugin->curl_multi_handle,
1656 if (CURLM_OK != mret)
1658 LOG (GNUNET_ERROR_TYPE_ERROR,
1659 "Session %p : Failed to add GET handle to multihandle: `%s'\n",
1661 curl_multi_strerror (mret));
1662 curl_easy_cleanup (s->get.easyhandle);
1663 s->get.easyhandle = NULL;
1666 return GNUNET_SYSERR;
1668 s->plugin->cur_requests++;
1669 LOG (GNUNET_ERROR_TYPE_INFO,
1670 "GET request `%s' established, number of requests increased to %u\n",
1672 s->plugin->cur_requests);
1678 * Connect a HTTP put request
1680 * @param s the session to connect
1681 * @return #GNUNET_SYSERR for hard failure, #GNUNET_OK for ok
1684 client_connect_put (struct GNUNET_ATS_Session *s)
1687 struct HttpAddress *ha;
1690 ha = (struct HttpAddress *) s->address->address;
1691 options = ntohl (ha->options);
1692 /* create put request */
1693 LOG (GNUNET_ERROR_TYPE_DEBUG,
1694 "Session %p: Init PUT handle\n",
1696 s->put.easyhandle = curl_easy_init ();
1699 curl_easy_setopt (s->put.easyhandle,
1702 curl_easy_setopt (s->put.easyhandle,
1703 CURLOPT_DEBUGFUNCTION,
1705 curl_easy_setopt (s->put.easyhandle,
1709 if (0 != (options & HTTP_OPTIONS_TCP_STEALTH))
1712 curl_easy_setopt (s->put.easyhandle,
1713 CURLOPT_OPENSOCKETFUNCTION,
1714 &open_tcp_stealth_socket_cb);
1715 curl_easy_setopt (s->put.easyhandle,
1716 CURLOPT_OPENSOCKETDATA,
1719 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1720 "Cannot connect, TCP STEALTH needed and not supported by kernel.\n");
1721 curl_easy_cleanup (s->put.easyhandle);
1722 s->put.easyhandle = NULL;
1724 s->put.state = H_DISCONNECTED;
1725 return GNUNET_SYSERR;
1729 curl_easy_setopt (s->put.easyhandle,
1731 CURL_SSLVERSION_TLSv1);
1733 struct HttpAddress *ha;
1734 ha = (struct HttpAddress *) s->address->address;
1736 if (HTTP_OPTIONS_VERIFY_CERTIFICATE ==
1737 (ntohl (ha->options) & HTTP_OPTIONS_VERIFY_CERTIFICATE))
1739 curl_easy_setopt (s->put.easyhandle,
1740 CURLOPT_SSL_VERIFYPEER,
1742 curl_easy_setopt (s->put.easyhandle,
1743 CURLOPT_SSL_VERIFYHOST,
1748 curl_easy_setopt (s->put.easyhandle,
1749 CURLOPT_SSL_VERIFYPEER,
1751 curl_easy_setopt (s->put.easyhandle,
1752 CURLOPT_SSL_VERIFYHOST,
1756 curl_easy_setopt (s->put.easyhandle,
1759 curl_easy_setopt (s->put.easyhandle,
1760 CURLOPT_REDIR_PROTOCOLS,
1763 curl_easy_setopt (s->put.easyhandle,
1766 curl_easy_setopt (s->put.easyhandle,
1767 CURLOPT_REDIR_PROTOCOLS,
1770 if (NULL != s->plugin->proxy_hostname)
1772 curl_easy_setopt (s->put.easyhandle,
1774 s->plugin->proxy_hostname);
1775 curl_easy_setopt (s->put.easyhandle,
1777 s->plugin->proxytype);
1778 if (NULL != s->plugin->proxy_username)
1779 curl_easy_setopt (s->put.easyhandle,
1780 CURLOPT_PROXYUSERNAME,
1781 s->plugin->proxy_username);
1782 if (NULL != s->plugin->proxy_password)
1783 curl_easy_setopt (s->put.easyhandle,
1784 CURLOPT_PROXYPASSWORD,
1785 s->plugin->proxy_password);
1786 if (GNUNET_YES == s->plugin->proxy_use_httpproxytunnel)
1787 curl_easy_setopt (s->put.easyhandle,
1788 CURLOPT_HTTPPROXYTUNNEL,
1789 s->plugin->proxy_use_httpproxytunnel);
1792 curl_easy_setopt (s->put.easyhandle,
1795 curl_easy_setopt (s->put.easyhandle,
1798 curl_easy_setopt (s->put.easyhandle,
1799 CURLOPT_READFUNCTION,
1801 curl_easy_setopt (s->put.easyhandle,
1804 curl_easy_setopt (s->put.easyhandle,
1805 CURLOPT_WRITEFUNCTION,
1806 &client_receive_put);
1807 curl_easy_setopt (s->put.easyhandle,
1810 /* No timeout by default, timeout done with session timeout */
1811 curl_easy_setopt (s->put.easyhandle,
1814 curl_easy_setopt (s->put.easyhandle,
1817 curl_easy_setopt (s->put.easyhandle,
1818 CURLOPT_CONNECTTIMEOUT_MS,
1819 (long) (HTTP_CLIENT_NOT_VALIDATED_TIMEOUT.rel_value_us / 1000LL));
1820 curl_easy_setopt (s->put.easyhandle, CURLOPT_BUFFERSIZE,
1821 2 * GNUNET_SERVER_MAX_MESSAGE_SIZE);
1822 #if CURL_TCP_NODELAY
1823 curl_easy_setopt (s->put.easyhandle, CURLOPT_TCP_NODELAY, 1);
1825 mret = curl_multi_add_handle (s->plugin->curl_multi_handle,
1827 if (CURLM_OK != mret)
1829 LOG (GNUNET_ERROR_TYPE_ERROR,
1830 "Session %p : Failed to add PUT handle to multihandle: `%s'\n",
1831 s, curl_multi_strerror (mret));
1832 curl_easy_cleanup (s->put.easyhandle);
1833 s->put.easyhandle = NULL;
1835 s->put.state = H_DISCONNECTED;
1836 return GNUNET_SYSERR;
1838 s->put.state = H_CONNECTED;
1839 s->plugin->cur_requests++;
1841 LOG (GNUNET_ERROR_TYPE_INFO,
1842 "PUT request `%s' established, number of requests increased to %u\n",
1843 s->url, s->plugin->cur_requests);
1850 * Connect both PUT and GET request for a session
1852 * @param s the session to connect
1853 * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise
1856 client_connect (struct GNUNET_ATS_Session *s)
1858 struct HTTP_Client_Plugin *plugin = s->plugin;
1859 int res = GNUNET_OK;
1863 http_common_plugin_address_to_string(plugin->protocol,
1864 s->address->address,
1865 s->address->address_length))
1867 LOG (GNUNET_ERROR_TYPE_DEBUG,
1868 "Invalid address peer `%s'\n",
1869 GNUNET_i2s(&s->address->peer));
1870 return GNUNET_SYSERR;
1873 GNUNET_asprintf (&s->url,
1875 http_common_plugin_address_to_url (NULL,
1876 s->address->address,
1877 s->address->address_length),
1878 GNUNET_i2s_full (plugin->env->my_identity),
1882 LOG (GNUNET_ERROR_TYPE_DEBUG,
1883 "Initiating outbound session peer `%s' using address `%s'\n",
1884 GNUNET_i2s (&s->address->peer), s->url);
1886 if (GNUNET_SYSERR == client_connect_get (s))
1887 return GNUNET_SYSERR;
1888 /* If we are emulating an XHR client then delay sending a PUT request until
1889 * there is something to send.
1891 if (GNUNET_YES == plugin->emulate_xhr)
1893 s->put.state = H_TMP_DISCONNECTED;
1895 else if (GNUNET_SYSERR == client_connect_put (s))
1896 return GNUNET_SYSERR;
1898 LOG (GNUNET_ERROR_TYPE_DEBUG,
1899 "Session %p: connected with GET %p and PUT %p\n",
1900 s, s->get.easyhandle,
1902 /* Perform connect */
1903 GNUNET_STATISTICS_set (plugin->env->stats,
1904 HTTP_STAT_STR_CONNECTIONS,
1905 plugin->cur_requests,
1907 /* Re-schedule since handles have changed */
1908 if (NULL != plugin->client_perform_task)
1910 GNUNET_SCHEDULER_cancel (plugin->client_perform_task);
1911 plugin->client_perform_task = NULL;
1914 /* Schedule task to run immediately */
1915 plugin->client_perform_task = GNUNET_SCHEDULER_add_now (client_run,
1922 * Function obtain the network type for a session
1924 * @param cls closure (`struct Plugin*`)
1925 * @param session the session
1926 * @return the network type
1928 static enum GNUNET_ATS_Network_Type
1929 http_client_plugin_get_network (void *cls,
1930 struct GNUNET_ATS_Session *session)
1932 return session->scope;
1937 * Function obtain the network type for an address.
1939 * @param cls closure (`struct Plugin *`)
1940 * @param address the address
1941 * @return the network type
1943 static enum GNUNET_ATS_Network_Type
1944 http_client_plugin_get_network_for_address (void *cls,
1945 const struct GNUNET_HELLO_Address *address)
1947 struct HTTP_Client_Plugin *plugin = cls;
1949 return http_common_get_network_for_address (plugin->env,
1955 * Session was idle, so disconnect it
1957 * @param cls the `struct GNUNET_ATS_Session` of the idle session
1960 client_session_timeout (void *cls)
1962 struct GNUNET_ATS_Session *s = cls;
1963 struct GNUNET_TIME_Relative left;
1965 s->timeout_task = NULL;
1966 left = GNUNET_TIME_absolute_get_remaining (s->timeout);
1967 if (0 != left.rel_value_us)
1969 /* not actually our turn yet, but let's at least update
1970 the monitor, it may think we're about to die ... */
1971 notify_session_monitor (s->plugin,
1973 GNUNET_TRANSPORT_SS_UPDATE);
1974 s->timeout_task = GNUNET_SCHEDULER_add_delayed (left,
1975 &client_session_timeout,
1980 "Session %p was idle for %s, disconnecting\n",
1982 GNUNET_STRINGS_relative_time_to_string (HTTP_CLIENT_SESSION_TIMEOUT,
1984 GNUNET_assert (GNUNET_OK ==
1985 http_client_plugin_session_disconnect (s->plugin,
1991 * Creates a new outbound session the transport service will use to
1992 * send data to the peer
1994 * @param cls the plugin
1995 * @param address the address
1996 * @return the session or NULL of max connections exceeded
1998 static struct GNUNET_ATS_Session *
1999 http_client_plugin_get_session (void *cls,
2000 const struct GNUNET_HELLO_Address *address)
2002 struct HTTP_Client_Plugin *plugin = cls;
2003 struct GNUNET_ATS_Session *s;
2004 struct sockaddr *sa;
2005 enum GNUNET_ATS_Network_Type net_type;
2009 GNUNET_assert (NULL != address->address);
2011 /* find existing session */
2012 s = client_lookup_session (plugin, address);
2016 /* create a new session */
2017 if (plugin->max_requests <= plugin->cur_requests)
2019 LOG (GNUNET_ERROR_TYPE_WARNING,
2020 "Maximum number of requests (%u) reached: "
2021 "cannot connect to peer `%s'\n",
2022 plugin->max_requests,
2023 GNUNET_i2s (&address->peer));
2027 /* Determine network location */
2028 net_type = GNUNET_ATS_NET_UNSPECIFIED;
2029 sa = http_common_socket_from_address (address->address,
2030 address->address_length,
2032 if (GNUNET_SYSERR == res)
2034 if (GNUNET_YES == res)
2036 GNUNET_assert (NULL != sa);
2037 if (AF_INET == sa->sa_family)
2039 salen = sizeof (struct sockaddr_in);
2041 else if (AF_INET6 == sa->sa_family)
2043 salen = sizeof (struct sockaddr_in6);
2045 net_type = plugin->env->get_address_type (plugin->env->cls, sa, salen);
2048 else if (GNUNET_NO == res)
2050 /* Cannot convert to sockaddr -> is external hostname */
2051 net_type = GNUNET_ATS_NET_WAN;
2053 if (GNUNET_ATS_NET_UNSPECIFIED == net_type)
2059 s = GNUNET_new (struct GNUNET_ATS_Session);
2061 s->address = GNUNET_HELLO_address_copy (address);
2062 s->scope = net_type;
2064 s->put.state = H_NOT_CONNECTED;
2065 s->timeout = GNUNET_TIME_relative_to_absolute (HTTP_CLIENT_SESSION_TIMEOUT);
2066 s->timeout_task = GNUNET_SCHEDULER_add_delayed (HTTP_CLIENT_SESSION_TIMEOUT,
2067 &client_session_timeout,
2069 LOG (GNUNET_ERROR_TYPE_DEBUG,
2070 "Created new session %p for `%s' address `%s''\n",
2072 http_common_plugin_address_to_string (plugin->protocol,
2073 s->address->address,
2074 s->address->address_length),
2075 GNUNET_i2s (&s->address->peer));
2077 /* add new session */
2078 (void) GNUNET_CONTAINER_multipeermap_put (plugin->sessions,
2081 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
2082 /* initiate new connection */
2083 if (GNUNET_SYSERR == client_connect (s))
2085 LOG (GNUNET_ERROR_TYPE_ERROR,
2086 "Cannot connect to peer `%s' address `%s''\n",
2087 http_common_plugin_address_to_string (plugin->protocol,
2088 s->address->address, s->address->address_length),
2089 GNUNET_i2s (&s->address->peer));
2090 client_delete_session (s);
2093 notify_session_monitor (plugin,
2095 GNUNET_TRANSPORT_SS_INIT);
2096 notify_session_monitor (plugin,
2098 GNUNET_TRANSPORT_SS_UP); /* or handshake? */
2104 * Setup http_client plugin
2106 * @param plugin the plugin handle
2107 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
2110 client_start (struct HTTP_Client_Plugin *plugin)
2112 curl_global_init (CURL_GLOBAL_ALL);
2113 plugin->curl_multi_handle = curl_multi_init ();
2115 if (NULL == plugin->curl_multi_handle)
2117 LOG (GNUNET_ERROR_TYPE_ERROR,
2118 _("Could not initialize curl multi handle, failed to start %s plugin!\n"),
2120 return GNUNET_SYSERR;
2127 * Another peer has suggested an address for this
2128 * peer and transport plugin. Check that this could be a valid
2129 * address. If so, consider adding it to the list
2132 * @param cls closure with the `struct Plugin`
2133 * @param addr pointer to the address
2134 * @param addrlen length of @a addr
2135 * @return #GNUNET_OK if this is a plausible address for this peer
2136 * and transport; always returns #GNUNET_NO (this is the client!)
2139 http_client_plugin_address_suggested (void *cls,
2143 /* A HTTP/S client does not have any valid address so:*/
2149 * Exit point from the plugin.
2151 * @param cls api as closure
2155 LIBGNUNET_PLUGIN_TRANSPORT_DONE (void *cls)
2157 struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
2158 struct HTTP_Client_Plugin *plugin = api->cls;
2160 if (NULL == api->cls)
2166 LOG (GNUNET_ERROR_TYPE_DEBUG,
2167 _("Shutting down plugin `%s'\n"),
2169 GNUNET_CONTAINER_multipeermap_iterate (plugin->sessions,
2170 &destroy_session_cb,
2172 if (NULL != plugin->client_perform_task)
2174 GNUNET_SCHEDULER_cancel (plugin->client_perform_task);
2175 plugin->client_perform_task = NULL;
2177 if (NULL != plugin->curl_multi_handle)
2179 curl_multi_cleanup (plugin->curl_multi_handle);
2180 plugin->curl_multi_handle = NULL;
2182 curl_global_cleanup ();
2183 LOG (GNUNET_ERROR_TYPE_DEBUG,
2184 _("Shutdown for plugin `%s' complete\n"),
2186 GNUNET_CONTAINER_multipeermap_destroy (plugin->sessions);
2187 GNUNET_free_non_null (plugin->proxy_hostname);
2188 GNUNET_free_non_null (plugin->proxy_username);
2189 GNUNET_free_non_null (plugin->proxy_password);
2190 GNUNET_free (plugin);
2199 * @param plugin the plugin handle
2200 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
2203 client_configure_plugin (struct HTTP_Client_Plugin *plugin)
2205 unsigned long long max_requests;
2208 /* Optional parameters */
2210 GNUNET_CONFIGURATION_get_value_number (plugin->env->cfg,
2215 plugin->max_requests = max_requests;
2217 LOG (GNUNET_ERROR_TYPE_DEBUG,
2218 _("Maximum number of requests is %u\n"),
2219 plugin->max_requests);
2221 /* Read proxy configuration */
2223 GNUNET_CONFIGURATION_get_value_string (plugin->env->cfg,
2226 &plugin->proxy_hostname))
2228 LOG (GNUNET_ERROR_TYPE_DEBUG,
2229 "Found proxy host: `%s'\n",
2230 plugin->proxy_hostname);
2231 /* proxy username */
2233 GNUNET_CONFIGURATION_get_value_string (plugin->env->cfg,
2236 &plugin->proxy_username))
2238 LOG (GNUNET_ERROR_TYPE_DEBUG,
2239 "Found proxy username name: `%s'\n",
2240 plugin->proxy_username);
2243 /* proxy password */
2245 GNUNET_CONFIGURATION_get_value_string (plugin->env->cfg,
2248 &plugin->proxy_password))
2250 LOG (GNUNET_ERROR_TYPE_DEBUG,
2251 "Found proxy password name: `%s'\n",
2252 plugin->proxy_password);
2257 GNUNET_CONFIGURATION_get_value_string (plugin->env->cfg,
2262 GNUNET_STRINGS_utf8_toupper (proxy_type, proxy_type);
2264 if (0 == strcmp(proxy_type, "HTTP"))
2265 plugin->proxytype = CURLPROXY_HTTP;
2266 else if (0 == strcmp(proxy_type, "SOCKS4"))
2267 plugin->proxytype = CURLPROXY_SOCKS4;
2268 else if (0 == strcmp(proxy_type, "SOCKS5"))
2269 plugin->proxytype = CURLPROXY_SOCKS5;
2270 else if (0 == strcmp(proxy_type, "SOCKS4A"))
2271 plugin->proxytype = CURLPROXY_SOCKS4A;
2272 else if (0 == strcmp(proxy_type, "SOCKS5_HOSTNAME "))
2273 plugin->proxytype = CURLPROXY_SOCKS5_HOSTNAME ;
2276 LOG (GNUNET_ERROR_TYPE_ERROR,
2277 _("Invalid proxy type: `%s', disabling proxy! Check configuration!\n"),
2280 GNUNET_free (proxy_type);
2281 GNUNET_free (plugin->proxy_hostname);
2282 plugin->proxy_hostname = NULL;
2283 GNUNET_free_non_null (plugin->proxy_username);
2284 plugin->proxy_username = NULL;
2285 GNUNET_free_non_null (plugin->proxy_password);
2286 plugin->proxy_password = NULL;
2288 return GNUNET_SYSERR;
2291 LOG (GNUNET_ERROR_TYPE_DEBUG,
2292 "Found proxy type: `%s'\n",
2296 /* proxy http tunneling */
2297 plugin->proxy_use_httpproxytunnel
2298 = GNUNET_CONFIGURATION_get_value_yesno (plugin->env->cfg,
2300 "PROXY_HTTP_TUNNELING");
2301 if (GNUNET_SYSERR == plugin->proxy_use_httpproxytunnel)
2302 plugin->proxy_use_httpproxytunnel = GNUNET_NO;
2304 GNUNET_free_non_null (proxy_type);
2307 /* Should we emulate an XHR client for testing? */
2309 = GNUNET_CONFIGURATION_get_value_yesno (plugin->env->cfg,
2317 * Function to convert an address to a human-readable string.
2319 * @param cls closure
2320 * @param addr address to convert
2321 * @param addrlen address length
2322 * @return res string if conversion was successful, NULL otherwise
2325 http_client_plugin_address_to_string (void *cls,
2329 return http_common_plugin_address_to_string (PLUGIN_NAME,
2336 * Function that will be called whenever the transport service wants to
2337 * notify the plugin that a session is still active and in use and
2338 * therefore the session timeout for this session has to be updated
2340 * @param cls closure
2341 * @param peer which peer was the session for
2342 * @param session which session is being updated
2345 http_client_plugin_update_session_timeout (void *cls,
2346 const struct GNUNET_PeerIdentity *peer,
2347 struct GNUNET_ATS_Session *session)
2349 client_reschedule_session_timeout (session);
2354 * Function that will be called whenever the transport service wants to
2355 * notify the plugin that the inbound quota changed and that the plugin
2356 * should update it's delay for the next receive value
2358 * @param cls closure
2359 * @param peer which peer was the session for
2360 * @param s which session is being updated
2361 * @param delay new delay to use for receiving
2364 http_client_plugin_update_inbound_delay (void *cls,
2365 const struct GNUNET_PeerIdentity *peer,
2366 struct GNUNET_ATS_Session *s,
2367 struct GNUNET_TIME_Relative delay)
2369 s->next_receive = GNUNET_TIME_relative_to_absolute (delay);
2370 LOG (GNUNET_ERROR_TYPE_DEBUG,
2371 "New inbound delay %s\n",
2372 GNUNET_STRINGS_relative_time_to_string (delay,
2374 if (s->recv_wakeup_task != NULL)
2376 GNUNET_SCHEDULER_cancel (s->recv_wakeup_task);
2378 = GNUNET_SCHEDULER_add_delayed (delay,
2386 * Return information about the given session to the
2389 * @param cls the `struct Plugin` with the monitor callback (`sic`)
2390 * @param peer peer we send information about
2391 * @param value our `struct GNUNET_ATS_Session` to send information about
2392 * @return #GNUNET_OK (continue to iterate)
2395 send_session_info_iter (void *cls,
2396 const struct GNUNET_PeerIdentity *peer,
2399 struct HTTP_Client_Plugin *plugin = cls;
2400 struct GNUNET_ATS_Session *session = value;
2402 notify_session_monitor (plugin,
2404 GNUNET_TRANSPORT_SS_INIT);
2405 notify_session_monitor (plugin,
2407 GNUNET_TRANSPORT_SS_UP); /* FIXME: or handshake? */
2413 * Begin monitoring sessions of a plugin. There can only
2414 * be one active monitor per plugin (i.e. if there are
2415 * multiple monitors, the transport service needs to
2416 * multiplex the generated events over all of them).
2418 * @param cls closure of the plugin
2419 * @param sic callback to invoke, NULL to disable monitor;
2420 * plugin will being by iterating over all active
2421 * sessions immediately and then enter monitor mode
2422 * @param sic_cls closure for @a sic
2425 http_client_plugin_setup_monitor (void *cls,
2426 GNUNET_TRANSPORT_SessionInfoCallback sic,
2429 struct HTTP_Client_Plugin *plugin = cls;
2432 plugin->sic_cls = sic_cls;
2435 GNUNET_CONTAINER_multipeermap_iterate (plugin->sessions,
2436 &send_session_info_iter,
2438 /* signal end of first iteration */
2439 sic (sic_cls, NULL, NULL);
2445 * Entry point for the plugin.
2448 LIBGNUNET_PLUGIN_TRANSPORT_INIT (void *cls)
2450 struct GNUNET_TRANSPORT_PluginEnvironment *env = cls;
2451 struct GNUNET_TRANSPORT_PluginFunctions *api;
2452 struct HTTP_Client_Plugin *plugin;
2454 if (NULL == env->receive)
2456 /* run in 'stub' mode (i.e. as part of gnunet-peerinfo), don't fully
2457 initialze the plugin or the API */
2458 api = GNUNET_new (struct GNUNET_TRANSPORT_PluginFunctions);
2460 api->address_to_string = &http_client_plugin_address_to_string;
2461 api->string_to_address = &http_common_plugin_string_to_address;
2462 api->address_pretty_printer = &http_common_plugin_address_pretty_printer;
2466 plugin = GNUNET_new (struct HTTP_Client_Plugin);
2468 plugin->sessions = GNUNET_CONTAINER_multipeermap_create (128,
2470 api = GNUNET_new (struct GNUNET_TRANSPORT_PluginFunctions);
2472 api->send = &http_client_plugin_send;
2473 api->disconnect_session = &http_client_plugin_session_disconnect;
2474 api->query_keepalive_factor = &http_client_query_keepalive_factor;
2475 api->disconnect_peer = &http_client_plugin_peer_disconnect;
2476 api->check_address = &http_client_plugin_address_suggested;
2477 api->get_session = &http_client_plugin_get_session;
2478 api->address_to_string = &http_client_plugin_address_to_string;
2479 api->string_to_address = &http_common_plugin_string_to_address;
2480 api->address_pretty_printer = &http_common_plugin_address_pretty_printer;
2481 api->get_network = &http_client_plugin_get_network;
2482 api->get_network_for_address = &http_client_plugin_get_network_for_address;
2483 api->update_session_timeout = &http_client_plugin_update_session_timeout;
2484 api->update_inbound_delay = &http_client_plugin_update_inbound_delay;
2485 api->setup_monitor = &http_client_plugin_setup_monitor;
2487 plugin->name = "transport-https_client";
2488 plugin->protocol = "https";
2490 plugin->name = "transport-http_client";
2491 plugin->protocol = "http";
2493 plugin->last_tag = 1;
2495 if (GNUNET_SYSERR == client_configure_plugin (plugin))
2497 LIBGNUNET_PLUGIN_TRANSPORT_DONE (api);
2502 if (GNUNET_SYSERR == client_start (plugin))
2504 LIBGNUNET_PLUGIN_TRANSPORT_DONE (api);
2510 /* end of plugin_transport_http_client.c */