src/dht/gnunet-dht-get.c

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2001, 2002, 2004, 2005, 2006, 2007, 2009 GNUnet e.V.
   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., 51 Franklin Street, Fifth Floor,
  18      Boston, MA 02110-1301, USA.
  19 */
  20 /**
  21  * @file dht/gnunet-dht-get.c
  22  * @brief search for data in DHT
  23  * @author Christian Grothoff
  24  * @author Nathan Evans
  25  */
  26 #include "platform.h"
  27 #include "gnunet_dht_service.h"
  28
  29 #define LOG(kind,...) GNUNET_log_from (kind, "dht-clients",__VA_ARGS__)
  30 /**
  31  * The type of the query
  32  */
  33 static unsigned int query_type;
  34
  35 /**
  36  * Desired replication level
  37  */
  38 static unsigned int replication = 5;
  39
  40 /**
  41  * The key for the query
  42  */
  43 static char *query_key;
  44
  45 /**
  46  * User supplied timeout value
  47  */
  48 static struct GNUNET_TIME_Relative timeout_request = { 60000 };
  49
  50 /**
  51  * Be verbose
  52  */
  53 static int verbose;
  54
  55 /**
  56  * Use DHT demultixplex_everywhere
  57  */
  58 static int demultixplex_everywhere;
  59
  60 /**
  61  * Handle to the DHT
  62  */
  63 static struct GNUNET_DHT_Handle *dht_handle;
  64
  65 /**
  66  * Global handle of the configuration
  67  */
  68 static const struct GNUNET_CONFIGURATION_Handle *cfg;
  69
  70 /**
  71  * Handle for the get request
  72  */
  73 static struct GNUNET_DHT_GetHandle *get_handle;
  74
  75 /**
  76  * Count of results found
  77  */
  78 static unsigned int result_count;
  79
  80 /**
  81  * Global status value
  82  */
  83 static int ret;
  84
  85 /**
  86  * Task scheduled to handle timeout.
  87  */
  88 static struct GNUNET_SCHEDULER_Task *tt;
  89
  90
  91 /**
  92  * Task run to clean up on shutdown.
  93  *
  94  * @param cls unused
  95  */
  96 static void
  97 cleanup_task (void *cls)
  98 {
  99   if (NULL != get_handle)
 100   {
 101     GNUNET_DHT_get_stop (get_handle);
 102     get_handle = NULL;
 103   }
 104   if (NULL != dht_handle)
 105   {
 106     GNUNET_DHT_disconnect (dht_handle);
 107     dht_handle = NULL;
 108   }
 109   if (NULL != tt)
 110   {
 111     GNUNET_SCHEDULER_cancel (tt);
 112     tt = NULL;
 113   }
 114 }
 115
 116
 117 /**
 118  * Task run on timeout. Triggers shutdown.
 119  *
 120  * @param cls unused
 121  */
 122 static void
 123 timeout_task (void *cls)
 124 {
 125   tt = NULL;
 126   GNUNET_SCHEDULER_shutdown ();
 127 }
 128
 129
 130 /**
 131  * Iterator called on each result obtained for a DHT
 132  * operation that expects a reply
 133  *
 134  * @param cls closure
 135  * @param exp when will this value expire
 136  * @param key key of the result
 137  * @param get_path peers on reply path (or NULL if not recorded)
 138  * @param get_path_length number of entries in get_path
 139  * @param put_path peers on the PUT path (or NULL if not recorded)
 140  * @param put_path_length number of entries in get_path
 141  * @param type type of the result
 142  * @param size number of bytes in data
 143  * @param data pointer to the result data
 144  */
 145 static void
 146 get_result_iterator (void *cls, struct GNUNET_TIME_Absolute exp,
 147                      const struct GNUNET_HashCode * key,
 148                      const struct GNUNET_PeerIdentity *get_path,
 149                      unsigned int get_path_length,
 150                      const struct GNUNET_PeerIdentity *put_path,
 151                      unsigned int put_path_length, enum GNUNET_BLOCK_Type type,
 152                      size_t size, const void *data)
 153 {
 154   FPRINTF (stdout,
 155            _("Result %d, type %d:\n%.*s\n"),
 156            result_count, type,
 157            (unsigned int) size, (char *) data);
 158   result_count++;
 159 }
 160
 161
 162 /**
 163  * Main function that will be run by the scheduler.
 164  *
 165  * @param cls closure
 166  * @param args remaining command-line arguments
 167  * @param cfgfile name of the configuration file used (for saving, can be NULL!)
 168  * @param c configuration
 169  */
 170 static void
 171 run (void *cls, char *const *args, const char *cfgfile,
 172      const struct GNUNET_CONFIGURATION_Handle *c)
 173 {
 174   struct GNUNET_HashCode key;
 175
 176
 177
 178   cfg = c;
 179   if (NULL == query_key)
 180   {
 181     FPRINTF (stderr, "%s",  _("Must provide key for DHT GET!\n"));
 182     ret = 1;
 183     return;
 184   }
 185   if (NULL == (dht_handle = GNUNET_DHT_connect (cfg, 1)))
 186   {
 187     FPRINTF (stderr, "%s",  _("Failed to connect to DHT service!\n"));
 188     ret = 1;
 189     return;
 190   }
 191   if (query_type == GNUNET_BLOCK_TYPE_ANY)      /* Type of data not set */
 192     query_type = GNUNET_BLOCK_TYPE_TEST;
 193   GNUNET_CRYPTO_hash (query_key, strlen (query_key), &key);
 194   if (verbose)
 195     FPRINTF (stderr, "%s `%s' \n",  _("Issueing DHT GET with key"), GNUNET_h2s_full (&key));
 196   GNUNET_SCHEDULER_add_shutdown (&cleanup_task, NULL);
 197   tt = GNUNET_SCHEDULER_add_delayed (timeout_request,
 198                                      &timeout_task, NULL);
 199   get_handle =
 200       GNUNET_DHT_get_start (dht_handle, query_type, &key, replication,
 201                             (demultixplex_everywhere) ? GNUNET_DHT_RO_DEMULTIPLEX_EVERYWHERE : GNUNET_DHT_RO_NONE,
 202                             NULL, 0, &get_result_iterator, NULL);
 203
 204 }
 205
 206
 207 /**
 208  * gnunet-dht-get command line options
 209  */
 210 static struct GNUNET_GETOPT_CommandLineOption options[] = {
 211   {'k', "key", "KEY",
 212    gettext_noop ("the query key"),
 213    1, &GNUNET_GETOPT_set_string, &query_key},
 214   {'r', "replication", "LEVEL",
 215    gettext_noop ("how many parallel requests (replicas) to create"),
 216    1, &GNUNET_GETOPT_set_uint, &replication},
 217   {'t', "type", "TYPE",
 218    gettext_noop ("the type of data to look for"),
 219    1, &GNUNET_GETOPT_set_uint, &query_type},
 220   {'T', "timeout", "TIMEOUT",
 221    gettext_noop ("how long to execute this query before giving up?"),
 222    1, &GNUNET_GETOPT_set_relative_time, &timeout_request},
 223   {'x', "demultiplex", NULL,
 224     gettext_noop ("use DHT's demultiplex everywhere option"),
 225     0, &GNUNET_GETOPT_set_one, &demultixplex_everywhere},
 226   {'V', "verbose", NULL,
 227    gettext_noop ("be verbose (print progress information)"),
 228    0, &GNUNET_GETOPT_set_one, &verbose},
 229   GNUNET_GETOPT_OPTION_END
 230 };
 231
 232
 233 /**
 234  * Entry point for gnunet-dht-get
 235  *
 236  * @param argc number of arguments from the command line
 237  * @param argv command line arguments
 238  * @return 0 ok, 1 on error
 239  */
 240 int
 241 main (int argc, char *const *argv)
 242 {
 243   if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
 244     return 2;
 245   return (GNUNET_OK ==
 246           GNUNET_PROGRAM_run (argc, argv, "gnunet-dht-get",
 247                               gettext_noop
 248                               ("Issue a GET request to the GNUnet DHT, prints results."),
 249                               options, &run, NULL)) ? ret : 1;
 250 }
 251
 252 /* end of gnunet-dht-get.c */