src/hostlist/gnunet-daemon-hostlist.c

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