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 2, 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.c
23 * @brief Implementation of the HTTP transport service
24 * @author Matthias Wachs
28 #include "gnunet_protocols.h"
29 #include "gnunet_connection_lib.h"
30 #include "gnunet_server_lib.h"
31 #include "gnunet_service_lib.h"
32 #include "gnunet_statistics_service.h"
33 #include "gnunet_transport_service.h"
34 #include "plugin_transport.h"
35 #include "microhttpd.h"
36 #include <curl/curl.h>
38 #define VERBOSE GNUNET_YES
39 #define DEBUG GNUNET_YES
42 * After how long do we expire an address that we
43 * learned from another peer if it is not reconfirmed
46 #define LEARNED_ADDRESS_EXPIRATION GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_HOURS, 6)
48 #define HTTP_TIMEOUT 600
50 #define CURL_EASY_SETOPT(c, a, b) do { ret = curl_easy_setopt(c, a, b); if (ret != CURLE_OK) GNUNET_log(GNUNET_ERROR_TYPE_WARNING, _("%s failed at %s:%d: `%s'\n"), "curl_easy_setopt", __FILE__, __LINE__, curl_easy_strerror(ret)); } while (0);
53 * Text of the response sent back after the last bytes of a PUT
54 * request have been received (just to formally obey the HTTP
57 #define HTTP_PUT_RESPONSE "Thank you!"
60 * Encapsulation of all of the state of the plugin.
66 * Session handle for connections.
72 * Stored in a linked list.
77 * Pointer to the global plugin struct.
79 struct Plugin *plugin;
82 * The client (used to identify this connection)
87 * Continuation function to call once the transmission buffer
88 * has again space available. NULL if there is no
89 * continuation to call.
91 GNUNET_TRANSPORT_TransmitContinuation transmit_cont;
94 * Closure for transmit_cont.
96 void *transmit_cont_cls;
99 * To whom are we talking to (set to our identity
100 * if we are still waiting for the welcome message)
102 struct GNUNET_PeerIdentity sender;
105 * At what time did we reset last_received last?
107 struct GNUNET_TIME_Absolute last_quota_update;
110 * How many bytes have we received since the "last_quota_update"
113 uint64_t last_received;
116 * Number of bytes per ms that this peer is allowed
124 * Encapsulation of all of the state of the plugin.
131 struct GNUNET_TRANSPORT_PluginEnvironment *env;
134 * Handle to the network service.
136 struct GNUNET_SERVICE_Context *service;
139 * List of open sessions.
141 struct Session *sessions;
144 static struct Plugin *plugin;
147 * Daemon for listening for new IPv4 connections.
149 static struct MHD_Daemon *http_daemon_v4;
152 * Daemon for listening for new IPv6connections.
154 static struct MHD_Daemon *http_daemon_v6;
157 * Our primary task for http daemon handling IPv4 connections
159 static GNUNET_SCHEDULER_TaskIdentifier http_task_v4;
162 * Our primary task for http daemon handling IPv6 connections
164 static GNUNET_SCHEDULER_TaskIdentifier http_task_v6;
167 * ID of the task downloading the hostlist
169 static GNUNET_SCHEDULER_TaskIdentifier ti_download;
174 * Curl multi for managing client operations.
176 static CURLM *curl_multi;
178 static char * get_url( const struct GNUNET_PeerIdentity * target)
180 return strdup("http://localhost:12389");
183 static size_t curl_read_function( void *ptr, size_t size, size_t nmemb, void *stream)
185 // strcpy ("Testmessa")
190 * Task that is run when we are ready to receive more data from the hostlist
193 * @param cls closure, unused
194 * @param tc task context, unused
197 task_download (void *cls,
198 const struct GNUNET_SCHEDULER_TaskContext *tc)
200 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Download!!!");
204 * Function that can be used by the transport service to transmit
205 * a message using the plugin.
208 * @param target who should receive this message
209 * @param priority how important is the message
210 * @param msgbuf the message to transmit
211 * @param msgbuf_size number of bytes in 'msgbuf'
212 * @param timeout when should we time out
213 * @param session which session must be used (or NULL for "any")
214 * @param addr the address to use (can be NULL if the plugin
215 * is "on its own" (i.e. re-use existing TCP connection))
216 * @param addrlen length of the address in bytes
217 * @param force_address GNUNET_YES if the plugin MUST use the given address,
218 * otherwise the plugin may use other addresses or
219 * existing connections (if available)
220 * @param cont continuation to call once the message has
221 * been transmitted (or if the transport is ready
222 * for the next transmission call; or if the
223 * peer disconnected...)
224 * @param cont_cls closure for cont
225 * @return number of bytes used (on the physical network, with overheads);
226 * -1 on hard errors (i.e. address invalid); 0 is a legal value
227 * and does NOT mean that the message was not transmitted (DV)
230 http_plugin_send (void *cls,
231 const struct GNUNET_PeerIdentity * target,
234 unsigned int priority,
235 struct GNUNET_TIME_Relative timeout,
236 struct Session *session,
240 GNUNET_TRANSPORT_TransmitContinuation cont,
243 char * peer_url = get_url( target );
249 /* struct Plugin *plugin = cls; */
251 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Sending %u bytes (`%s') to `%s'\n",msgbuf_size, msgbuf,GNUNET_i2s(target));
252 /* Insert code to send using cURL */
253 curl = curl_easy_init ();
255 CURL_EASY_SETOPT (curl, CURLOPT_FOLLOWLOCATION, 1);
256 CURL_EASY_SETOPT (curl, CURLOPT_MAXREDIRS, 4);
258 /* setting put options */
259 CURL_EASY_SETOPT (curl, CURLOPT_UPLOAD, 1L);
260 CURL_EASY_SETOPT (curl, CURLOPT_PUT, 1L);
261 CURL_EASY_SETOPT (curl, CURLOPT_READDATA, msgbuf);
264 /* no need to abort if the above failed */
265 CURL_EASY_SETOPT (curl,
273 CURL_EASY_SETOPT (curl,
277 CURL_EASY_SETOPT (curl,
281 CURL_EASY_SETOPT (curl,
283 GNUNET_SERVER_MAX_MESSAGE_SIZE);
284 if (0 == strncmp (peer_url, "http", 4))
285 CURL_EASY_SETOPT (curl, CURLOPT_USERAGENT, "GNUnet");
286 CURL_EASY_SETOPT (curl,
287 CURLOPT_CONNECTTIMEOUT,
289 CURL_EASY_SETOPT (curl,
293 curl_multi = curl_multi_init ();
294 if (curl_multi == NULL)
300 mret = curl_multi_add_handle (curl_multi, curl);
301 if (mret != CURLM_OK)
303 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
304 _("%s failed at %s:%d: `%s'\n"),
305 "curl_multi_add_handle", __FILE__, __LINE__,
306 curl_multi_strerror (mret));
307 mret = curl_multi_cleanup (curl_multi);
308 if (mret != CURLM_OK)
309 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
310 _("%s failed at %s:%d: `%s'\n"),
311 "curl_multi_cleanup", __FILE__, __LINE__,
312 curl_multi_strerror (mret));
323 struct GNUNET_NETWORK_FDSet *grs;
324 struct GNUNET_NETWORK_FDSet *gws;
325 struct GNUNET_TIME_Relative rtime;
331 mret = curl_multi_fdset (curl_multi, &rs, &ws, &es, &max);
332 if (mret != CURLM_OK)
334 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
335 _("%s failed at %s:%d: `%s'\n"),
336 "curl_multi_fdset", __FILE__, __LINE__,
337 curl_multi_strerror (mret));
341 mret = curl_multi_timeout (curl_multi, &timeout_curl);
342 if (mret != CURLM_OK)
344 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
345 _("%s failed at %s:%d: `%s'\n"),
346 "curl_multi_timeout", __FILE__, __LINE__,
347 curl_multi_strerror (mret));
351 /*rtime = GNUNET_TIME_relative_min (GNUNET_TIME_absolute_get_remaining (end_time),
352 GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS,
354 grs = GNUNET_NETWORK_fdset_create ();
355 gws = GNUNET_NETWORK_fdset_create ();
356 GNUNET_NETWORK_fdset_copy_native (grs, &rs, max + 1);
357 GNUNET_NETWORK_fdset_copy_native (gws, &ws, max + 1);
358 #if DEBUG_HOSTLIST_CLIENT
359 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
360 "Scheduling task for hostlist download using cURL\n");
363 ti_download = GNUNET_SCHEDULER_add_select (plugin->env->sched,
364 GNUNET_SCHEDULER_PRIORITY_DEFAULT,
365 GNUNET_SCHEDULER_NO_TASK,
366 GNUNET_TIME_UNIT_FOREVER_REL,
371 GNUNET_NETWORK_fdset_destroy (gws);
372 GNUNET_NETWORK_fdset_destroy (grs);
374 GNUNET_free(peer_url);
376 bytes_sent = msgbuf_size;
384 * Function that can be used to force the plugin to disconnect
385 * from the given peer and cancel all previous transmissions
386 * (and their continuationc).
389 * @param target peer from which to disconnect
392 http_plugin_disconnect (void *cls,
393 const struct GNUNET_PeerIdentity *target)
395 // struct Plugin *plugin = cls;
402 * Convert the transports address to a nice, human-readable
406 * @param type name of the transport that generated the address
407 * @param addr one of the addresses of the host, NULL for the last address
408 * the specific address format depends on the transport
409 * @param addrlen length of the address
410 * @param numeric should (IP) addresses be displayed in numeric form?
411 * @param timeout after how long should we give up?
412 * @param asc function to call on each string
413 * @param asc_cls closure for asc
416 http_plugin_address_pretty_printer (void *cls,
421 struct GNUNET_TIME_Relative timeout,
422 GNUNET_TRANSPORT_AddressStringCallback
431 * Another peer has suggested an address for this
432 * peer and transport plugin. Check that this could be a valid
433 * address. If so, consider adding it to the list
437 * @param addr pointer to the address
438 * @param addrlen length of addr
439 * @return GNUNET_OK if this is a plausible address for this peer
443 http_plugin_address_suggested (void *cls,
444 void *addr, size_t addrlen)
446 /* struct Plugin *plugin = cls; */
448 /* check if the address is plausible; if so,
449 add it to our list! */
454 * Check if we are allowed to connect to the given IP.
457 acceptPolicyCallback (void *cls,
458 const struct sockaddr *addr, socklen_t addr_len)
460 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Incoming connection \n");
461 /* Currently all incoming connections are accepted, so nothing to do here */
466 * Process GET or PUT request received via MHD. For
467 * GET, queue response that will send back our pending
468 * messages. For PUT, process incoming data and send
469 * to GNUnet core. In either case, check if a session
470 * already exists and create a new one if not.
473 accessHandlerCallback (void *cls,
474 struct MHD_Connection *session,
478 const char *upload_data,
479 size_t * upload_data_size, void **httpSessionCache)
481 struct MHD_Response *response;
483 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"HTTP Daemon has an incoming `%s' request from \n",method);
485 /* Find out if session exists, otherwise create one */
487 /* Is it a PUT or a GET request */
488 if ( 0 == strcmp (MHD_HTTP_METHOD_PUT, method) )
490 /* PUT method here */
491 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Got PUT Request with size %u \n",upload_data_size);
492 GNUNET_STATISTICS_update( plugin->env->stats , gettext_noop("# PUT requests"), 1, GNUNET_NO);
494 if ( 0 == strcmp (MHD_HTTP_METHOD_GET, method) )
496 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Got GET Request with size\n");
497 GNUNET_STATISTICS_update( plugin->env->stats , gettext_noop("# GET requests"), 1, GNUNET_NO);
500 response = MHD_create_response_from_data (strlen (HTTP_PUT_RESPONSE),
501 HTTP_PUT_RESPONSE, MHD_NO, MHD_NO);
502 MHD_queue_response (session, MHD_HTTP_OK, response);
503 MHD_destroy_response (response);
509 * Function that queries MHD's select sets and
510 * starts the task waiting for them.
512 static GNUNET_SCHEDULER_TaskIdentifier prepare_daemon (struct MHD_Daemon *daemon_handle);
514 * Call MHD to process pending requests and then go back
515 * and schedule the next run.
518 run_daemon (void *cls,
519 const struct GNUNET_SCHEDULER_TaskContext *tc)
521 struct MHD_Daemon *daemon_handle = cls;
523 if (daemon_handle == http_daemon_v4)
524 http_task_v4 = GNUNET_SCHEDULER_NO_TASK;
526 if (daemon_handle == http_daemon_v6)
527 http_task_v6 = GNUNET_SCHEDULER_NO_TASK;
530 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
532 GNUNET_assert (MHD_YES == MHD_run (daemon_handle));
533 if (daemon_handle == http_daemon_v4)
534 http_task_v4 = prepare_daemon (daemon_handle);
535 if (daemon_handle == http_daemon_v6)
536 http_task_v6 = prepare_daemon (daemon_handle);
540 * Function that queries MHD's select sets and
541 * starts the task waiting for them.
543 static GNUNET_SCHEDULER_TaskIdentifier
544 prepare_daemon (struct MHD_Daemon *daemon_handle)
546 GNUNET_SCHEDULER_TaskIdentifier ret;
550 struct GNUNET_NETWORK_FDSet *wrs;
551 struct GNUNET_NETWORK_FDSet *wws;
552 struct GNUNET_NETWORK_FDSet *wes;
554 unsigned long long timeout;
556 struct GNUNET_TIME_Relative tv;
561 wrs = GNUNET_NETWORK_fdset_create ();
562 wes = GNUNET_NETWORK_fdset_create ();
563 wws = GNUNET_NETWORK_fdset_create ();
565 GNUNET_assert (MHD_YES ==
566 MHD_get_fdset (daemon_handle,
571 haveto = MHD_get_timeout (daemon_handle, &timeout);
572 if (haveto == MHD_YES)
573 tv.value = (uint64_t) timeout;
575 tv = GNUNET_TIME_UNIT_FOREVER_REL;
576 GNUNET_NETWORK_fdset_copy_native (wrs, &rs, max);
577 GNUNET_NETWORK_fdset_copy_native (wws, &ws, max);
578 GNUNET_NETWORK_fdset_copy_native (wes, &es, max);
579 ret = GNUNET_SCHEDULER_add_select (plugin->env->sched,
580 GNUNET_SCHEDULER_PRIORITY_HIGH,
581 GNUNET_SCHEDULER_NO_TASK,
587 GNUNET_NETWORK_fdset_destroy (wrs);
588 GNUNET_NETWORK_fdset_destroy (wws);
589 GNUNET_NETWORK_fdset_destroy (wes);
594 * Exit point from the plugin.
597 libgnunet_plugin_transport_http_done (void *cls)
599 struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
600 struct Plugin *plugin = api->cls;
602 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Shutting down http plugin...\n");
604 if ( ti_download != GNUNET_SCHEDULER_NO_TASK)
606 GNUNET_SCHEDULER_cancel(plugin->env->sched, ti_download);
607 http_task_v4 = GNUNET_SCHEDULER_NO_TASK;
610 if ( http_task_v4 != GNUNET_SCHEDULER_NO_TASK)
612 GNUNET_SCHEDULER_cancel(plugin->env->sched, http_task_v4);
613 http_task_v4 = GNUNET_SCHEDULER_NO_TASK;
616 if ( http_task_v6 != GNUNET_SCHEDULER_NO_TASK)
618 GNUNET_SCHEDULER_cancel(plugin->env->sched, http_task_v6);
619 http_task_v6 = GNUNET_SCHEDULER_NO_TASK;
622 if (http_daemon_v4 != NULL)
624 MHD_stop_daemon (http_daemon_v4);
625 http_daemon_v4 = NULL;
627 if (http_daemon_v6 != NULL)
629 MHD_stop_daemon (http_daemon_v6);
630 http_daemon_v6 = NULL;
634 if ( NULL != curl_multi)
636 curl_multi_cleanup (curl_multi);
639 GNUNET_free (plugin);
645 * Entry point for the plugin.
648 libgnunet_plugin_transport_http_init (void *cls)
650 struct GNUNET_TRANSPORT_PluginEnvironment *env = cls;
651 struct GNUNET_TRANSPORT_PluginFunctions *api;
652 long long unsigned int port;
654 plugin = GNUNET_malloc (sizeof (struct Plugin));
657 api = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_PluginFunctions));
659 api->send = &http_plugin_send;
660 api->disconnect = &http_plugin_disconnect;
661 api->address_pretty_printer = &http_plugin_address_pretty_printer;
662 api->check_address = &http_plugin_address_suggested;
665 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Starting http plugin...\n");
666 /* Reading port number from config file */
668 GNUNET_CONFIGURATION_get_value_number (env->cfg,
674 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR,
677 ("Require valid port number for service `%s' in configuration!\n"),
679 libgnunet_plugin_transport_http_done (api);
682 if ((http_daemon_v4 == NULL) && (http_daemon_v6 == NULL) && (port != 0))
684 http_daemon_v6 = MHD_start_daemon (MHD_USE_IPv6,
686 &acceptPolicyCallback,
687 NULL, &accessHandlerCallback, NULL,
688 MHD_OPTION_CONNECTION_LIMIT, (unsigned int) 16,
689 MHD_OPTION_PER_IP_CONNECTION_LIMIT, (unsigned int) 1,
690 MHD_OPTION_CONNECTION_TIMEOUT, (unsigned int) 16,
691 MHD_OPTION_CONNECTION_MEMORY_LIMIT, (size_t) (16 * 1024),
693 http_daemon_v4 = MHD_start_daemon (MHD_NO_FLAG,
695 &acceptPolicyCallback,
696 NULL, &accessHandlerCallback, NULL,
697 MHD_OPTION_CONNECTION_LIMIT, (unsigned int) 16,
698 MHD_OPTION_PER_IP_CONNECTION_LIMIT, (unsigned int) 1,
699 MHD_OPTION_CONNECTION_TIMEOUT, (unsigned int) 16,
700 MHD_OPTION_CONNECTION_MEMORY_LIMIT, (size_t) (16 * 1024),
704 curl_multi = curl_multi_init ();
706 if (http_daemon_v4 != NULL)
707 http_task_v4 = prepare_daemon (http_daemon_v4);
708 if (http_daemon_v6 != NULL)
709 http_task_v6 = prepare_daemon (http_daemon_v6);
711 if ((http_daemon_v4 == NULL) || (http_daemon_v6 != NULL))
712 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Starting MHD on port %u\n",port);
715 if (NULL == plugin->env->stats)
717 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
718 _("Failed to retrieve statistics handle\n"));
719 libgnunet_plugin_transport_http_done (api);
723 GNUNET_STATISTICS_set ( env->stats, "# PUT requests", 0, GNUNET_NO);
724 GNUNET_STATISTICS_set ( env->stats, "# GET requests", 0, GNUNET_NO);
726 if ( ((NULL == http_daemon_v4) && (NULL == http_daemon_v6)) || (NULL == curl_multi))
728 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Initializing http plugin failed\n");
729 libgnunet_plugin_transport_http_done (api);
736 /* end of plugin_transport_http.c */