src/fs/gnunet-search.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2001, 2002, 2004, 2005, 2006, 2007, 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  * @file fs/gnunet-search.c
  22  * @brief searching for files on GNUnet
  23  * @author Christian Grothoff
  24  * @author Krista Bennett
  25  * @author James Blackwell
  26  * @author Igor Wronsky
  27  */
  28 #include "platform.h"
  29 #include "gnunet_fs_service.h"
  30
  31 static int ret;
  32
  33 static const struct GNUNET_CONFIGURATION_Handle *cfg;
  34
  35 static struct GNUNET_FS_Handle *ctx;
  36
  37 static struct GNUNET_FS_SearchContext *sc;
  38
  39 static char *output_filename;
  40
  41 static struct GNUNET_FS_DirectoryBuilder *db;
  42
  43 static unsigned int anonymity = 1;
  44
  45 static int verbose;
  46
  47 static int local_only;
  48
  49 /**
  50  * Type of a function that libextractor calls for each
  51  * meta data item found.
  52  *
  53  * @param cls closure (user-defined, unused)
  54  * @param plugin_name name of the plugin that produced this value;
  55  *        special values can be used (i.e. '&lt;zlib&gt;' for zlib being
  56  *        used in the main libextractor library and yielding
  57  *        meta data).
  58  * @param type libextractor-type describing the meta data
  59  * @param format basic format information about data
  60  * @param data_mime_type mime-type of data (not of the original file);
  61  *        can be NULL (if mime-type is not known)
  62  * @param data actual meta-data found
  63  * @param data_size number of bytes in data
  64  * @return 0 to continue extracting, 1 to abort
  65  */
  66 static int
  67 item_printer (void *cls,
  68               const char *plugin_name,
  69               enum EXTRACTOR_MetaType type,
  70               enum EXTRACTOR_MetaFormat format,
  71               const char *data_mime_type,
  72               const char *data,
  73               size_t data_size)
  74 {
  75   if ( (format != EXTRACTOR_METAFORMAT_UTF8) &&
  76        (format != EXTRACTOR_METAFORMAT_C_STRING) )
  77     return 0;
  78   if (type == EXTRACTOR_METATYPE_GNUNET_ORIGINAL_FILENAME)
  79     return 0;
  80   printf ("\t%20s: %s\n",
  81           dgettext (LIBEXTRACTOR_GETTEXT_DOMAIN,
  82                     EXTRACTOR_metatype_to_string (type)),
  83           data);
  84   return 0;
  85 }
  86
  87
  88 static void
  89 clean_task (void *cls,
  90             const struct GNUNET_SCHEDULER_TaskContext *tc)
  91 {
  92   size_t dsize;
  93   void *ddata;
  94
  95   GNUNET_FS_stop (ctx);
  96   ctx = NULL;
  97   if (output_filename == NULL)
  98     return;
  99   if (GNUNET_OK !=
 100       GNUNET_FS_directory_builder_finish (db,
 101                                           &dsize,
 102                                           &ddata))
 103     {
 104       GNUNET_break (0);
 105       GNUNET_free (output_filename);
 106       return;
 107     }
 108   if (dsize !=
 109       GNUNET_DISK_fn_write (output_filename,
 110                             ddata,
 111                             dsize,
 112                             GNUNET_DISK_PERM_USER_READ | GNUNET_DISK_PERM_USER_WRITE))
 113     {
 114       fprintf (stderr,
 115                _("Failed to write directory with search results to `%s'\n"),
 116                output_filename);
 117     }
 118   GNUNET_free_non_null (ddata);
 119   GNUNET_free (output_filename);
 120 }
 121
 122
 123 /**
 124  * Called by FS client to give information about the progress of an
 125  * operation.
 126  *
 127  * @param cls closure
 128  * @param info details about the event, specifying the event type
 129  *        and various bits about the event
 130  * @return client-context (for the next progress call
 131  *         for this operation; should be set to NULL for
 132  *         SUSPEND and STOPPED events).  The value returned
 133  *         will be passed to future callbacks in the respective
 134  *         field in the GNUNET_FS_ProgressInfo struct.
 135  */
 136 static void *
 137 progress_cb (void *cls,
 138              const struct GNUNET_FS_ProgressInfo *info)
 139 {
 140   static unsigned int cnt;
 141   char *uri;
 142   char *dotdot;
 143   char *filename;
 144
 145   switch (info->status)
 146     {
 147     case GNUNET_FS_STATUS_SEARCH_START:
 148       break;
 149     case GNUNET_FS_STATUS_SEARCH_RESULT:
 150       if (db != NULL)
 151         GNUNET_FS_directory_builder_add (db,
 152                                          info->value.search.specifics.result.uri,
 153                                          info->value.search.specifics.result.meta,
 154                                          NULL);
 155       uri = GNUNET_FS_uri_to_string (info->value.search.specifics.result.uri);
 156       printf ("#%u:\n", cnt++);
 157       filename =
 158         GNUNET_CONTAINER_meta_data_get_by_type (info->value.search.specifics.result.meta,
 159                                                 EXTRACTOR_METATYPE_GNUNET_ORIGINAL_FILENAME);
 160       if (filename != NULL)
 161         {
 162           while (NULL != (dotdot = strstr (filename, "..")))
 163             dotdot[0] = dotdot[1] = '_';
 164           printf ("gnunet-download -o \"%s\" %s\n",
 165                   filename,
 166                   uri);
 167         }
 168       else
 169         printf ("gnunet-download %s\n", uri);
 170       if (verbose)
 171         GNUNET_CONTAINER_meta_data_iterate (info->value.search.specifics.result.meta,
 172                                             &item_printer,
 173                                             NULL);
 174       printf ("\n");
 175       fflush(stdout);
 176       GNUNET_free_non_null (filename);
 177       GNUNET_free (uri);
 178       break;
 179     case GNUNET_FS_STATUS_SEARCH_UPDATE:
 180       break;
 181     case GNUNET_FS_STATUS_SEARCH_RESULT_STOPPED:
 182       /* ignore */
 183       break;
 184     case GNUNET_FS_STATUS_SEARCH_ERROR:
 185       fprintf (stderr,
 186                _("Error searching: %s.\n"),
 187                info->value.search.specifics.error.message);
 188       GNUNET_SCHEDULER_shutdown ();
 189       break;
 190     case GNUNET_FS_STATUS_SEARCH_STOPPED:
 191       GNUNET_SCHEDULER_add_continuation (&clean_task,
 192                                          NULL,
 193                                          GNUNET_SCHEDULER_REASON_PREREQ_DONE);
 194       break;
 195     default:
 196       fprintf (stderr,
 197                _("Unexpected status: %d\n"),
 198                info->status);
 199       break;
 200     }
 201   return NULL;
 202 }
 203
 204
 205 static void
 206 shutdown_task (void *cls,
 207                const struct GNUNET_SCHEDULER_TaskContext *tc)
 208 {
 209   if (sc != NULL)
 210     {
 211       GNUNET_FS_search_stop (sc);
 212       sc = NULL;
 213     }
 214 }
 215
 216
 217 /**
 218  * Main function that will be run by the scheduler.
 219  *
 220  * @param cls closure
 221  * @param args remaining command-line arguments
 222  * @param cfgfile name of the configuration file used (for saving, can be NULL!)
 223  * @param c configuration
 224  */
 225 static void
 226 run (void *cls,
 227      char *const *args,
 228      const char *cfgfile,
 229      const struct GNUNET_CONFIGURATION_Handle *c)
 230 {
 231   struct GNUNET_FS_Uri *uri;
 232   unsigned int argc;
 233   enum GNUNET_FS_SearchOptions options;
 234
 235   argc = 0;
 236   while (NULL != args[argc])
 237     argc++;
 238   uri = GNUNET_FS_uri_ksk_create_from_args (argc,
 239                                             (const char **) args);
 240   if (NULL == uri)
 241     {
 242       fprintf (stderr,
 243                _("Could not create keyword URI from arguments.\n"));
 244       ret = 1;
 245       GNUNET_FS_uri_destroy (uri);
 246       return;
 247     }
 248   cfg = c;
 249   ctx = GNUNET_FS_start (cfg,
 250                          "gnunet-search",
 251                          &progress_cb,
 252                          NULL,
 253                          GNUNET_FS_FLAGS_NONE,
 254                          GNUNET_FS_OPTIONS_END);
 255   if (NULL == ctx)
 256     {
 257       fprintf (stderr,
 258                _("Could not initialize `%s' subsystem.\n"),
 259                "FS");
 260       GNUNET_FS_uri_destroy (uri);
 261       ret = 1;
 262       return;
 263     }
 264   if (output_filename != NULL)
 265     db = GNUNET_FS_directory_builder_create (NULL);
 266   options = GNUNET_FS_SEARCH_OPTION_NONE;
 267   if (local_only)
 268     options |= GNUNET_FS_SEARCH_OPTION_LOOPBACK_ONLY;
 269   sc = GNUNET_FS_search_start (ctx,
 270                                uri,
 271                                anonymity,
 272                                options,
 273                                NULL);
 274   GNUNET_FS_uri_destroy (uri);
 275   if (NULL == sc)
 276     {
 277       fprintf (stderr,
 278                _("Could not start searching.\n"));
 279       GNUNET_FS_stop (ctx);
 280       ret = 1;
 281       return;
 282     }
 283   GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
 284                                 &shutdown_task,
 285                                 NULL);
 286 }
 287
 288
 289 /**
 290  * The main function to search GNUnet.
 291  *
 292  * @param argc number of arguments from the command line
 293  * @param argv command line arguments
 294  * @return 0 ok, 1 on error
 295  */
 296 int
 297 main (int argc, char *const *argv)
 298 {
 299   static const struct GNUNET_GETOPT_CommandLineOption options[] = {
 300     {'a', "anonymity", "LEVEL",
 301      gettext_noop ("set the desired LEVEL of receiver-anonymity"),
 302      1, &GNUNET_GETOPT_set_uint, &anonymity},
 303     {'n', "no-network", NULL,
 304      gettext_noop ("only search the local peer (no P2P network search)"),
 305      0, &GNUNET_GETOPT_set_one, &local_only},
 306     {'o', "output", "PREFIX",
 307      gettext_noop
 308      ("write search results to file starting with PREFIX"),
 309      1, &GNUNET_GETOPT_set_string, &output_filename},
 310     {'V', "verbose", NULL,
 311      gettext_noop ("be verbose (print progress information)"),
 312      0, &GNUNET_GETOPT_set_one, &verbose},
 313     GNUNET_GETOPT_OPTION_END
 314   };
 315   return (GNUNET_OK ==
 316           GNUNET_PROGRAM_run (argc,
 317                               argv,
 318                               "gnunet-search",
 319                               gettext_noop
 320                               ("Search GNUnet."),
 321                               options, &run, NULL)) ? ret : 1;
 322 }
 323
 324 /* end of gnunet-search.c */
 325