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 void
 129 core_init (void *cls,
 130            struct GNUNET_CORE_Handle * server,
 131            const struct GNUNET_PeerIdentity *
 132            my_identity,
 133            const struct
 134            GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *
 135            publicKey)
 136 {
 137  /* Nothing to do here */
 138 }
 139
 140 /**
 141  * Core handler for p2p hostlist advertisements
 142  */
 143 static int advertisement_handler (void *cls,
 144                                   const struct GNUNET_PeerIdentity * peer,
 145                                   const struct GNUNET_MessageHeader * message,
 146                                   const struct GNUNET_TRANSPORT_ATS_Information *atsi)
 147 {
 148   GNUNET_assert (NULL != client_adv_handler);
 149   return (*client_adv_handler) (cls, peer, message, atsi);
 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  */
 160 static void
 161 connect_handler (void *cls,
 162                  const struct
 163                  GNUNET_PeerIdentity * peer,
 164                  const struct GNUNET_TRANSPORT_ATS_Information *atsi)
 165 {
 166   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 167               "A new peer connected, notifying client and server\n");
 168   if ( NULL != client_ch)
 169     (*client_ch) (cls, peer, atsi);
 170 #if HAVE_MHD
 171   if ( NULL != server_ch)
 172     (*server_ch) (cls, peer, atsi);
 173 #endif
 174 }
 175
 176 /**
 177  * Method called whenever a given peer disconnects. Wrapper to call both client's and server's functions
 178  *
 179  * @param cls closure
 180  * @param peer peer identity this notification is about
 181  */
 182 static void
 183 disconnect_handler (void *cls,
 184                     const struct
 185                     GNUNET_PeerIdentity * peer)
 186 {
 187
 188   /* call hostlist client disconnect handler*/
 189   if ( NULL != client_dh)
 190     (*client_dh) (cls, peer);
 191 #if HAVE_MHD
 192   /* call hostlist server disconnect handler*/
 193   if ( NULL != server_dh)
 194     (*server_dh) (cls, peer);
 195 #endif
 196 }
 197
 198 /**
 199  * Last task run during shutdown.  Disconnects us from
 200  * the other services.
 201  */
 202 static void
 203 cleaning_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 204 {
 205   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 206               "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,
 225                                  GNUNET_NO);
 226       stats = NULL;
 227     }
 228 }
 229
 230
 231 /**
 232  * Main function that will be run.
 233  *
 234  * @param cls closure
 235  * @param args remaining command-line arguments
 236  * @param cfgfile name of the configuration file used (for saving, can be NULL!)
 237  * @param cfg configuration
 238  */
 239 static void
 240 run (void *cls,
 241      char *const *args,
 242      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) &&
 253        (! learning)
 254 #if HAVE_MHD
 255        && (! provide_hostlist)
 256 #endif
 257        )
 258     {
 259       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 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 = GNUNET_CORE_connect (cfg,
 269                               1,
 270                               NULL,
 271                               &core_init,
 272                               &connect_handler, &disconnect_handler, NULL,
 273                               NULL, GNUNET_NO,
 274                               NULL, GNUNET_NO,
 275                               learning? learn_handlers : no_learn_handlers);
 276
 277   if (bootstrapping)
 278     {
 279       GNUNET_HOSTLIST_client_start (cfg, stats,
 280                                     &client_ch, &client_dh, &client_adv_handler, learning);
 281     }
 282
 283   #if HAVE_MHD
 284   if (provide_hostlist)
 285     {
 286       GNUNET_HOSTLIST_server_start (cfg, stats, core, &server_ch, &server_dh, advertising );
 287     }
 288 #endif
 289   GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
 290                                 &cleaning_task, NULL);
 291
 292   if (NULL == core)
 293     {
 294       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 295                   _("Failed to connect to `%s' service.\n"),
 296                   "core");
 297       GNUNET_SCHEDULER_shutdown ();
 298       return;
 299     }
 300 }
 301
 302
 303 /**
 304  * The main function for the hostlist daemon.
 305  *
 306  * @param argc number of arguments from the command line
 307  * @param argv command line arguments
 308  * @return 0 ok, 1 on error
 309  */
 310 int
 311 main (int argc, char *const *argv)
 312 {
 313   static const struct GNUNET_GETOPT_CommandLineOption options[] = {
 314 #if HAVE_MHD
 315     { 'a', "advertise", NULL,
 316       gettext_noop ("advertise our hostlist to other peers"),
 317       GNUNET_NO, &GNUNET_GETOPT_set_one, &advertising },
 318 #endif
 319     { 'b', "bootstrap", NULL,
 320       gettext_noop ("bootstrap using hostlists (it is highly recommended that you always use this option)"),
 321       GNUNET_NO, &GNUNET_GETOPT_set_one, &bootstrapping },
 322     { 'e', "enable-learning", NULL,
 323       gettext_noop ("enable learning about hostlist servers from other peers"),
 324       GNUNET_NO, &GNUNET_GETOPT_set_one, &learning},
 325 #if HAVE_MHD
 326     { 'p', "provide-hostlist", NULL,
 327       gettext_noop ("provide a hostlist server"),
 328       GNUNET_NO, &GNUNET_GETOPT_set_one, &provide_hostlist},
 329 #endif
 330     GNUNET_GETOPT_OPTION_END
 331   };
 332
 333   int ret;
 334   GNUNET_log_setup ("hostlist", "WARNING", NULL);
 335   ret = (GNUNET_OK ==
 336          GNUNET_PROGRAM_run (argc,
 337                              argv,
 338                              "hostlist",
 339                              _("GNUnet hostlist server and client"),
 340                              options,
 341                              &run, NULL)) ? 0 : 1;
 342
 343   return ret;
 344 }
 345
 346 /* end of gnunet-daemon-hostlist.c */