src/hostlist/gnunet-daemon-hostlist.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2007, 2008, 2009 Christian Grothoff (and other contributing authors)
   4
   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.
   9
  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.
  14
  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.
  19 */
  20
  21 /**
  22  * @file hostlist/gnunet-daemon-hostlist.c
  23  * @brief code for bootstrapping via hostlist servers
  24  * @author Christian Grothoff
  25  */
  26
  27 #include <stdlib.h>
  28 #include "platform.h"
  29 #include "hostlist-client.h"
  30 #include "gnunet_core_service.h"
  31 #include "gnunet_getopt_lib.h"
  32 #include "gnunet_protocols.h"
  33 #include "gnunet_program_lib.h"
  34 #include "gnunet_statistics_service.h"
  35 #include "gnunet_strings_lib.h"
  36 #include "gnunet_time_lib.h"
  37 #include "gnunet_util_lib.h"
  38
  39 #if HAVE_MHD
  40
  41 #include "hostlist-server.h"
  42
  43 /**
  44  * Set if we are allowed to advertise our hostlist to others.
  45  */
  46 static int advertising;
  47
  48 /**
  49  * Set if the user wants us to run a hostlist server.
  50  */
  51 static int provide_hostlist;
  52
  53 /**
  54  * Handle to hostlist server's connect handler
  55  */
  56 static GNUNET_CORE_ConnectEventHandler server_ch;
  57
  58 /**
  59  * Handle to hostlist server's disconnect handler
  60  */
  61 static GNUNET_CORE_DisconnectEventHandler server_dh;
  62
  63 #endif
  64
  65 /**
  66  * Set if we are allowed to learn about peers by accessing
  67  * hostlist servers.
  68  */
  69 static int bootstrapping;
  70
  71 /**
  72  * Set if the user allows us to learn about new hostlists
  73  * from the network.
  74  */
  75 static int learning;
  76
  77 /**
  78  * Statistics handle.
  79  */
  80 static struct GNUNET_STATISTICS_Handle *stats;
  81
  82 /**
  83  * Handle to the core service (NULL until we've connected to it).
  84  */
  85 static struct GNUNET_CORE_Handle *core;
  86
  87 /**
  88  * Handle to the hostlist client's advertisement handler
  89  */
  90 static GNUNET_CORE_MessageCallback client_adv_handler;
  91
  92 /**
  93  * Handle to hostlist client's connect handler
  94  */
  95 static GNUNET_CORE_ConnectEventHandler client_ch;
  96
  97 /**
  98  * Handle to hostlist client's disconnect handler
  99  */
 100 static GNUNET_CORE_DisconnectEventHandler client_dh;
 101
 102 /**
 103  * A HOSTLIST_ADV message is used to exchange information about
 104  * hostlist advertisements.  This struct is always
 105  * followed by the actual url under which the hostlist can be obtained:
 106  *
 107  * 1) transport-name (0-terminated)
 108  * 2) address-length (uint32_t, network byte order; possibly
 109  *    unaligned!)
 110  * 3) address expiration (GNUNET_TIME_AbsoluteNBO); possibly
 111  *    unaligned!)
 112  * 4) address (address-length bytes; possibly unaligned!)
 113  */
 114 struct GNUNET_HOSTLIST_ADV_Message
 115 {
 116   /**
 117    * Type will be GNUNET_MESSAGE_TYPE_HOSTLIST_ADVERTISEMENT.
 118    */
 119   struct GNUNET_MessageHeader header;
 120
 121   /**
 122    * Always zero (for alignment).
 123    */
 124   uint32_t reserved GNUNET_PACKED;
 125 };
 126
 127
 128 static struct GNUNET_PeerIdentity me;
 129
 130 static void
 131 core_init (void *cls, struct GNUNET_CORE_Handle *server,
 132            const struct GNUNET_PeerIdentity *my_identity)
 133 {
 134   me = *my_identity;
 135 }
 136
 137 /**
 138  * Core handler for p2p hostlist advertisements
 139  *
 140  * @param atsi_count number of records in 'atsi'
 141  */
 142 static int
 143 advertisement_handler (void *cls, const struct GNUNET_PeerIdentity *peer,
 144                        const struct GNUNET_MessageHeader *message,
 145                        const struct GNUNET_ATS_Information *atsi,
 146                        unsigned int atsi_count)
 147 {
 148   GNUNET_assert (NULL != client_adv_handler);
 149   return (*client_adv_handler) (cls, peer, message, atsi, atsi_count);
 150 }
 151
 152
 153 /**
 154  * Method called whenever a given peer connects.  Wrapper to call both client's and server's functions
 155  *
 156  * @param cls closure
 157  * @param peer peer identity this notification is about
 158  * @param atsi performance data
 159  * @param atsi_count number of records in 'atsi'
 160  */
 161 static void
 162 connect_handler (void *cls, const struct GNUNET_PeerIdentity *peer,
 163                  const struct GNUNET_ATS_Information *atsi,
 164                  unsigned int atsi_count)
 165 {
 166   if (0 == memcmp (&me, peer, sizeof (struct GNUNET_PeerIdentity)))
 167     return;
 168   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 169               "A new peer connected, notifying client and server\n");
 170   if (NULL != client_ch)
 171     (*client_ch) (cls, peer, atsi, atsi_count);
 172 #if HAVE_MHD
 173   if (NULL != server_ch)
 174     (*server_ch) (cls, peer, atsi, atsi_count);
 175 #endif
 176 }
 177
 178 /**
 179  * Method called whenever a given peer disconnects. Wrapper to call both client's and server's functions
 180  *
 181  * @param cls closure
 182  * @param peer peer identity this notification is about
 183  */
 184 static void
 185 disconnect_handler (void *cls, const struct GNUNET_PeerIdentity *peer)
 186 {
 187   if (0 == memcmp (&me, peer, sizeof (struct GNUNET_PeerIdentity)))
 188     return;
 189   /* call hostlist client disconnect handler */
 190   if (NULL != client_dh)
 191     (*client_dh) (cls, peer);
 192 #if HAVE_MHD
 193   /* call hostlist server disconnect handler */
 194   if (NULL != server_dh)
 195     (*server_dh) (cls, peer);
 196 #endif
 197 }
 198
 199 /**
 200  * Last task run during shutdown.  Disconnects us from
 201  * the other services.
 202  */
 203 static void
 204 cleaning_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 205 {
 206   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Hostlist daemon is shutting down\n");
 207   if (core != NULL)
 208   {
 209     GNUNET_CORE_disconnect (core);
 210     core = NULL;
 211   }
 212   if (bootstrapping)
 213   {
 214     GNUNET_HOSTLIST_client_stop ();
 215   }
 216 #if HAVE_MHD
 217   if (provide_hostlist)
 218   {
 219     GNUNET_HOSTLIST_server_stop ();
 220   }
 221 #endif
 222   if (stats != NULL)
 223   {
 224     GNUNET_STATISTICS_destroy (stats, GNUNET_NO);
 225     stats = NULL;
 226   }
 227 }
 228
 229
 230 /**
 231  * Main function that will be run.
 232  *
 233  * @param cls closure
 234  * @param args remaining command-line arguments
 235  * @param cfgfile name of the configuration file used (for saving, can be NULL!)
 236  * @param cfg configuration
 237  */
 238 static void
 239 run (void *cls, char *const *args, const char *cfgfile,
 240      const struct GNUNET_CONFIGURATION_Handle *cfg)
 241 {
 242   static const struct GNUNET_CORE_MessageHandler learn_handlers[] = {
 243     {&advertisement_handler, GNUNET_MESSAGE_TYPE_HOSTLIST_ADVERTISEMENT, 0},
 244     {NULL, 0, 0}
 245   };
 246   static const struct GNUNET_CORE_MessageHandler no_learn_handlers[] = {
 247     {NULL, 0, 0}
 248   };
 249   if ((!bootstrapping) && (!learning)
 250 #if HAVE_MHD
 251       && (!provide_hostlist)
 252 #endif
 253       )
 254   {
 255     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 256                 _
 257                 ("None of the functions for the hostlist daemon were enabled.  I have no reason to run!\n"));
 258     return;
 259   }
 260
 261
 262
 263   stats = GNUNET_STATISTICS_create ("hostlist", cfg);
 264
 265   core =
 266       GNUNET_CORE_connect (cfg, 1, NULL, &core_init, &connect_handler,
 267                            &disconnect_handler, NULL, GNUNET_NO, NULL,
 268                            GNUNET_NO,
 269                            learning ? learn_handlers : no_learn_handlers);
 270
 271   if (bootstrapping)
 272   {
 273     GNUNET_HOSTLIST_client_start (cfg, stats, &client_ch, &client_dh,
 274                                   &client_adv_handler, learning);
 275   }
 276
 277 #if HAVE_MHD
 278   if (provide_hostlist)
 279   {
 280     GNUNET_HOSTLIST_server_start (cfg, stats, core, &server_ch, &server_dh,
 281                                   advertising);
 282   }
 283 #endif
 284   GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &cleaning_task,
 285                                 NULL);
 286
 287   if (NULL == core)
 288   {
 289     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 290                 _("Failed to connect to `%s' service.\n"), "core");
 291     GNUNET_SCHEDULER_shutdown ();
 292     return;
 293   }
 294 }
 295
 296
 297 /**
 298  * The main function for the hostlist daemon.
 299  *
 300  * @param argc number of arguments from the command line
 301  * @param argv command line arguments
 302  * @return 0 ok, 1 on error
 303  */
 304 int
 305 main (int argc, char *const *argv)
 306 {
 307   static const struct GNUNET_GETOPT_CommandLineOption options[] = {
 308 #if HAVE_MHD
 309     {'a', "advertise", NULL,
 310      gettext_noop ("advertise our hostlist to other peers"),
 311      GNUNET_NO, &GNUNET_GETOPT_set_one, &advertising},
 312 #endif
 313     {'b', "bootstrap", NULL,
 314      gettext_noop
 315      ("bootstrap using hostlists (it is highly recommended that you always use this option)"),
 316      GNUNET_NO, &GNUNET_GETOPT_set_one, &bootstrapping},
 317     {'e', "enable-learning", NULL,
 318      gettext_noop ("enable learning about hostlist servers from other peers"),
 319      GNUNET_NO, &GNUNET_GETOPT_set_one, &learning},
 320 #if HAVE_MHD
 321     {'p', "provide-hostlist", NULL,
 322      gettext_noop ("provide a hostlist server"),
 323      GNUNET_NO, &GNUNET_GETOPT_set_one, &provide_hostlist},
 324 #endif
 325     GNUNET_GETOPT_OPTION_END
 326   };
 327
 328   int ret;
 329
 330   GNUNET_log_setup ("hostlist", "WARNING", NULL);
 331   ret =
 332       (GNUNET_OK ==
 333        GNUNET_PROGRAM_run (argc, argv, "hostlist",
 334                            _("GNUnet hostlist server and client"), options,
 335                            &run, NULL)) ? 0 : 1;
 336
 337   return ret;
 338 }
 339
 340 /* end of gnunet-daemon-hostlist.c */