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 GNUNET_NETWORK_STRUCT_BEGIN
 103
 104 /**
 105  * A HOSTLIST_ADV message is used to exchange information about
 106  * hostlist advertisements.  This struct is always
 107  * followed by the actual url under which the hostlist can be obtained:
 108  *
 109  * 1) transport-name (0-terminated)
 110  * 2) address-length (uint32_t, network byte order; possibly
 111  *    unaligned!)
 112  * 3) address expiration (GNUNET_TIME_AbsoluteNBO); possibly
 113  *    unaligned!)
 114  * 4) address (address-length bytes; possibly unaligned!)
 115  */
 116 struct GNUNET_HOSTLIST_ADV_Message
 117 {
 118   /**
 119    * Type will be GNUNET_MESSAGE_TYPE_HOSTLIST_ADVERTISEMENT.
 120    */
 121   struct GNUNET_MessageHeader header;
 122
 123   /**
 124    * Always zero (for alignment).
 125    */
 126   uint32_t reserved GNUNET_PACKED;
 127 };
 128 GNUNET_NETWORK_STRUCT_END
 129
 130 static struct GNUNET_PeerIdentity me;
 131
 132
 133 static void
 134 core_init (void *cls,
 135            const struct GNUNET_PeerIdentity *my_identity)
 136 {
 137   me = *my_identity;
 138 }
 139
 140
 141 /**
 142  * Core handler for p2p hostlist advertisements
 143  *
 144  * @param cls closure
 145  * @param peer identity of the sender
 146  * @param message advertisement message we got
 147  * @return #GNUNET_OK on success
 148  */
 149 static int
 150 advertisement_handler (void *cls, const struct GNUNET_PeerIdentity *peer,
 151                        const struct GNUNET_MessageHeader *message)
 152 {
 153   GNUNET_assert (NULL != client_adv_handler);
 154   return (*client_adv_handler) (cls, peer, message);
 155 }
 156
 157
 158 /**
 159  * Method called whenever a given peer connects.  Wrapper to call both client's and server's functions
 160  *
 161  * @param cls closure
 162  * @param peer peer identity this notification is about
 163  */
 164 static void
 165 connect_handler (void *cls, const struct GNUNET_PeerIdentity *peer)
 166 {
 167   if (0 == memcmp (&me, peer, sizeof (struct GNUNET_PeerIdentity)))
 168     return;
 169   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 170               "A new peer connected, notifying client and server\n");
 171   if (NULL != client_ch)
 172   {
 173     (*client_ch) (cls, peer);
 174   }
 175 #if HAVE_MHD
 176   if (NULL != server_ch)
 177     (*server_ch) (cls, peer);
 178 #endif
 179 }
 180
 181 /**
 182  * Method called whenever a given peer disconnects. Wrapper to call both client's and server's functions
 183  *
 184  * @param cls closure
 185  * @param peer peer identity this notification is about
 186  */
 187 static void
 188 disconnect_handler (void *cls, const struct GNUNET_PeerIdentity *peer)
 189 {
 190   if (0 == memcmp (&me, peer, sizeof (struct GNUNET_PeerIdentity)))
 191     return;
 192   /* call hostlist client disconnect handler */
 193   if (NULL != client_dh)
 194     (*client_dh) (cls, peer);
 195 #if HAVE_MHD
 196   /* call hostlist server disconnect handler */
 197   if (NULL != server_dh)
 198     (*server_dh) (cls, peer);
 199 #endif
 200 }
 201
 202 /**
 203  * Last task run during shutdown.  Disconnects us from
 204  * the other services.
 205  */
 206 static void
 207 cleaning_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 208 {
 209   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Hostlist daemon is shutting down\n");
 210   if (core != NULL)
 211   {
 212     GNUNET_CORE_disconnect (core);
 213     core = NULL;
 214   }
 215   if (bootstrapping)
 216   {
 217     GNUNET_HOSTLIST_client_stop ();
 218   }
 219 #if HAVE_MHD
 220   if (provide_hostlist)
 221   {
 222     GNUNET_HOSTLIST_server_stop ();
 223   }
 224 #endif
 225   if (stats != NULL)
 226   {
 227     GNUNET_STATISTICS_destroy (stats, GNUNET_NO);
 228     stats = NULL;
 229   }
 230 }
 231
 232
 233 /**
 234  * Main function that will be run.
 235  *
 236  * @param cls closure
 237  * @param args remaining command-line arguments
 238  * @param cfgfile name of the configuration file used (for saving, can be NULL!)
 239  * @param cfg configuration
 240  */
 241 static void
 242 run (void *cls, char *const *args, const char *cfgfile,
 243      const struct GNUNET_CONFIGURATION_Handle *cfg)
 244 {
 245   static const struct GNUNET_CORE_MessageHandler learn_handlers[] = {
 246     {&advertisement_handler, GNUNET_MESSAGE_TYPE_HOSTLIST_ADVERTISEMENT, 0},
 247     {NULL, 0, 0}
 248   };
 249   static const struct GNUNET_CORE_MessageHandler no_learn_handlers[] = {
 250     {NULL, 0, 0}
 251   };
 252   if ((!bootstrapping) && (!learning)
 253 #if HAVE_MHD
 254       && (!provide_hostlist)
 255 #endif
 256       )
 257   {
 258     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 259                 _
 260                 ("None of the functions for the hostlist daemon were enabled.  I have no reason to run!\n"));
 261     return;
 262   }
 263
 264
 265
 266   stats = GNUNET_STATISTICS_create ("hostlist", cfg);
 267
 268   core =
 269       GNUNET_CORE_connect (cfg, NULL, &core_init, &connect_handler,
 270                            &disconnect_handler, NULL, GNUNET_NO, NULL,
 271                            GNUNET_NO,
 272                            learning ? learn_handlers : no_learn_handlers);
 273
 274   if (bootstrapping)
 275   {
 276     GNUNET_HOSTLIST_client_start (cfg, stats, &client_ch, &client_dh,
 277                                   &client_adv_handler, learning);
 278   }
 279
 280 #if HAVE_MHD
 281   if (provide_hostlist)
 282   {
 283     GNUNET_HOSTLIST_server_start (cfg, stats, core, &server_ch, &server_dh,
 284                                   advertising);
 285   }
 286 #endif
 287   GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &cleaning_task,
 288                                 NULL);
 289
 290   if (NULL == core)
 291   {
 292     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 293                 _("Failed to connect to `%s' service.\n"), "core");
 294     GNUNET_SCHEDULER_shutdown ();
 295     return;
 296   }
 297 }
 298
 299
 300 /**
 301  * The main function for the hostlist daemon.
 302  *
 303  * @param argc number of arguments from the command line
 304  * @param argv command line arguments
 305  * @return 0 ok, 1 on error
 306  */
 307 int
 308 main (int argc, char *const *argv)
 309 {
 310   static const struct GNUNET_GETOPT_CommandLineOption options[] = {
 311 #if HAVE_MHD
 312     {'a', "advertise", NULL,
 313      gettext_noop ("advertise our hostlist to other peers"),
 314      GNUNET_NO, &GNUNET_GETOPT_set_one, &advertising},
 315 #endif
 316     {'b', "bootstrap", NULL,
 317      gettext_noop
 318      ("bootstrap using hostlists (it is highly recommended that you always use this option)"),
 319      GNUNET_NO, &GNUNET_GETOPT_set_one, &bootstrapping},
 320     {'e', "enable-learning", NULL,
 321      gettext_noop ("enable learning about hostlist servers from other peers"),
 322      GNUNET_NO, &GNUNET_GETOPT_set_one, &learning},
 323 #if HAVE_MHD
 324     {'p', "provide-hostlist", NULL,
 325      gettext_noop ("provide a hostlist server"),
 326      GNUNET_NO, &GNUNET_GETOPT_set_one, &provide_hostlist},
 327 #endif
 328     GNUNET_GETOPT_OPTION_END
 329   };
 330
 331   int ret;
 332
 333   if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
 334     return 2;
 335
 336   GNUNET_log_setup ("hostlist", "WARNING", NULL);
 337   ret =
 338       (GNUNET_OK ==
 339        GNUNET_PROGRAM_run (argc, argv, "hostlist",
 340                            _("GNUnet hostlist server and client"), options,
 341                            &run, NULL)) ? 0 : 1;
 342   GNUNET_free ((void*) argv);
 343   return ret;
 344 }
 345
 346 /* end of gnunet-daemon-hostlist.c */