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