src/fs/gnunet-search.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 it
   6      under the terms of the GNU Affero General Public License as published
   7      by the Free Software Foundation, either version 3 of the License,
   8      or (at your 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      Affero General Public License for more details.
  14
  15      You should have received a copy of the GNU Affero General Public License
  16      along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17
  18      SPDX-License-Identifier: AGPL3.0-or-later
  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 /**
  46  * Timeout for the search, 0 means to wait for CTRL-C.
  47  */
  48 static struct GNUNET_TIME_Relative timeout;
  49
  50 static unsigned int results_limit;
  51
  52 static unsigned int results;
  53
  54 static unsigned int verbose;
  55
  56 static int local_only;
  57
  58 static struct GNUNET_SCHEDULER_Task *tt;
  59
  60
  61 /**
  62  * Type of a function that libextractor calls for each
  63  * meta data item found.
  64  *
  65  * @param cls closure (user-defined, unused)
  66  * @param plugin_name name of the plugin that produced this value;
  67  *        special values can be used (i.e. '&lt;zlib&gt;' for zlib being
  68  *        used in the main libextractor library and yielding
  69  *        meta data).
  70  * @param type libextractor-type describing the meta data
  71  * @param format basic format information about data
  72  * @param data_mime_type mime-type of data (not of the original file);
  73  *        can be NULL (if mime-type is not known)
  74  * @param data actual meta-data found
  75  * @param data_size number of bytes in @a data
  76  * @return 0 to continue extracting, 1 to abort
  77  */
  78 static int
  79 item_printer(void *cls,
  80              const char *plugin_name,
  81              enum EXTRACTOR_MetaType type,
  82              enum EXTRACTOR_MetaFormat format,
  83              const char *data_mime_type,
  84              const char *data,
  85              size_t data_size)
  86 {
  87   if ((format != EXTRACTOR_METAFORMAT_UTF8) &&
  88       (format != EXTRACTOR_METAFORMAT_C_STRING))
  89     return 0;
  90   if (type == EXTRACTOR_METATYPE_GNUNET_ORIGINAL_FILENAME)
  91     return 0;
  92 #if HAVE_LIBEXTRACTOR
  93   printf("\t%20s: %s\n",
  94          dgettext(LIBEXTRACTOR_GETTEXT_DOMAIN,
  95                   EXTRACTOR_metatype_to_string(type)),
  96          data);
  97 #else
  98   printf("\t%20d: %s\n", type, data);
  99 #endif
 100   return 0;
 101 }
 102
 103
 104 static void
 105 clean_task(void *cls)
 106 {
 107   size_t dsize;
 108   void *ddata;
 109
 110   GNUNET_FS_stop(ctx);
 111   ctx = NULL;
 112   if (output_filename == NULL)
 113     return;
 114   if (GNUNET_OK != GNUNET_FS_directory_builder_finish(db, &dsize, &ddata))
 115     {
 116       GNUNET_break(0);
 117       GNUNET_free(output_filename);
 118       return;
 119     }
 120   if (dsize != GNUNET_DISK_fn_write(output_filename,
 121                                     ddata,
 122                                     dsize,
 123                                     GNUNET_DISK_PERM_USER_READ |
 124                                     GNUNET_DISK_PERM_USER_WRITE))
 125     {
 126       fprintf(stderr,
 127               _("Failed to write directory with search results to `%s'\n"),
 128               output_filename);
 129     }
 130   GNUNET_free_non_null(ddata);
 131   GNUNET_free(output_filename);
 132 }
 133
 134
 135 /**
 136  * Called by FS client to give information about the progress of an
 137  * operation.
 138  *
 139  * @param cls closure
 140  * @param info details about the event, specifying the event type
 141  *        and various bits about the event
 142  * @return client-context (for the next progress call
 143  *         for this operation; should be set to NULL for
 144  *         SUSPEND and STOPPED events).  The value returned
 145  *         will be passed to future callbacks in the respective
 146  *         field in the GNUNET_FS_ProgressInfo struct.
 147  */
 148 static void *
 149 progress_cb(void *cls, const struct GNUNET_FS_ProgressInfo *info)
 150 {
 151   static unsigned int cnt;
 152   int is_directory;
 153   char *uri;
 154   char *filename;
 155
 156   switch (info->status)
 157     {
 158     case GNUNET_FS_STATUS_SEARCH_START:
 159       break;
 160
 161     case GNUNET_FS_STATUS_SEARCH_RESULT:
 162       if (db != NULL)
 163         GNUNET_FS_directory_builder_add(db,
 164                                         info->value.search.specifics.result.uri,
 165                                         info->value.search.specifics.result.meta,
 166                                         NULL);
 167       uri = GNUNET_FS_uri_to_string(info->value.search.specifics.result.uri);
 168       printf("#%u:\n", ++cnt);
 169       filename = GNUNET_CONTAINER_meta_data_get_by_type(
 170         info->value.search.specifics.result.meta,
 171         EXTRACTOR_METATYPE_GNUNET_ORIGINAL_FILENAME);
 172       is_directory = GNUNET_FS_meta_data_test_for_directory(
 173         info->value.search.specifics.result.meta);
 174       if (NULL != filename)
 175         {
 176           while ((filename[0] != '\0') && ('/' == filename[strlen(filename) - 1]))
 177             filename[strlen(filename) - 1] = '\0';
 178           GNUNET_DISK_filename_canonicalize(filename);
 179           if (GNUNET_YES == is_directory)
 180             printf("gnunet-download -o \"%s%s\" -R %s\n",
 181                    filename,
 182                    GNUNET_FS_DIRECTORY_EXT,
 183                    uri);
 184           else
 185             printf("gnunet-download -o \"%s\" %s\n", filename, uri);
 186         }
 187       else if (GNUNET_YES == is_directory)
 188         printf("gnunet-download -o \"collection%s\" -R %s\n",
 189                GNUNET_FS_DIRECTORY_EXT,
 190                uri);
 191       else
 192         printf("gnunet-download %s\n", uri);
 193       if (verbose)
 194         GNUNET_CONTAINER_meta_data_iterate(info->value.search.specifics.result
 195                                            .meta,
 196                                            &item_printer,
 197                                            NULL);
 198       printf("\n");
 199       fflush(stdout);
 200       GNUNET_free_non_null(filename);
 201       GNUNET_free(uri);
 202       results++;
 203       if ((results_limit > 0) && (results >= results_limit))
 204         GNUNET_SCHEDULER_shutdown();
 205       break;
 206
 207     case GNUNET_FS_STATUS_SEARCH_UPDATE:
 208       break;
 209
 210     case GNUNET_FS_STATUS_SEARCH_RESULT_STOPPED:
 211       /* ignore */
 212       break;
 213
 214     case GNUNET_FS_STATUS_SEARCH_ERROR:
 215       fprintf(stderr,
 216               _("Error searching: %s.\n"),
 217               info->value.search.specifics.error.message);
 218       GNUNET_SCHEDULER_shutdown();
 219       break;
 220
 221     case GNUNET_FS_STATUS_SEARCH_STOPPED:
 222       GNUNET_SCHEDULER_add_now(&clean_task, NULL);
 223       break;
 224
 225     default:
 226       fprintf(stderr, _("Unexpected status: %d\n"), info->status);
 227       break;
 228     }
 229   return NULL;
 230 }
 231
 232
 233 static void
 234 shutdown_task(void *cls)
 235 {
 236   if (sc != NULL)
 237     {
 238       GNUNET_FS_search_stop(sc);
 239       sc = NULL;
 240     }
 241 }
 242
 243
 244 static void
 245 timeout_task(void *cls)
 246 {
 247   tt = NULL;
 248   GNUNET_SCHEDULER_shutdown();
 249 }
 250
 251
 252 /**
 253  * Main function that will be run by the scheduler.
 254  *
 255  * @param cls closure
 256  * @param args remaining command-line arguments
 257  * @param cfgfile name of the configuration file used (for saving, can be NULL!)
 258  * @param c configuration
 259  */
 260 static void
 261 run(void *cls,
 262     char *const *args,
 263     const char *cfgfile,
 264     const struct GNUNET_CONFIGURATION_Handle *c)
 265 {
 266   struct GNUNET_FS_Uri *uri;
 267   unsigned int argc;
 268   enum GNUNET_FS_SearchOptions options;
 269
 270   argc = 0;
 271   while (NULL != args[argc])
 272     argc++;
 273   uri = GNUNET_FS_uri_ksk_create_from_args(argc, (const char **)args);
 274   if (NULL == uri)
 275     {
 276       fprintf(stderr,
 277               "%s",
 278               _("Could not create keyword URI from arguments.\n"));
 279       ret = 1;
 280       return;
 281     }
 282   cfg = c;
 283   ctx = GNUNET_FS_start(cfg,
 284                         "gnunet-search",
 285                         &progress_cb,
 286                         NULL,
 287                         GNUNET_FS_FLAGS_NONE,
 288                         GNUNET_FS_OPTIONS_END);
 289   if (NULL == ctx)
 290     {
 291       fprintf(stderr, _("Could not initialize `%s' subsystem.\n"), "FS");
 292       GNUNET_FS_uri_destroy(uri);
 293       ret = 1;
 294       return;
 295     }
 296   if (output_filename != NULL)
 297     db = GNUNET_FS_directory_builder_create(NULL);
 298   options = GNUNET_FS_SEARCH_OPTION_NONE;
 299   if (local_only)
 300     options |= GNUNET_FS_SEARCH_OPTION_LOOPBACK_ONLY;
 301   sc = GNUNET_FS_search_start(ctx, uri, anonymity, options, NULL);
 302   GNUNET_FS_uri_destroy(uri);
 303   if (NULL == sc)
 304     {
 305       fprintf(stderr, "%s", _("Could not start searching.\n"));
 306       GNUNET_FS_stop(ctx);
 307       ret = 1;
 308       return;
 309     }
 310   if (0 != timeout.rel_value_us)
 311     tt = GNUNET_SCHEDULER_add_delayed(timeout, &timeout_task, NULL);
 312   GNUNET_SCHEDULER_add_shutdown(&shutdown_task, NULL);
 313 }
 314
 315
 316 /**
 317  * The main function to search GNUnet.
 318  *
 319  * @param argc number of arguments from the command line
 320  * @param argv command line arguments
 321  * @return 0 ok, 1 on error
 322  */
 323 int
 324 main(int argc, char *const *argv)
 325 {
 326   struct GNUNET_GETOPT_CommandLineOption options[] =
 327   { GNUNET_GETOPT_option_uint('a',
 328                               "anonymity",
 329                               "LEVEL",
 330                               gettext_noop(
 331                                 "set the desired LEVEL of receiver-anonymity"),
 332                               &anonymity),
 333     GNUNET_GETOPT_option_flag(
 334       'n',
 335       "no-network",
 336       gettext_noop("only search the local peer (no P2P network search)"),
 337       &local_only),
 338     GNUNET_GETOPT_option_string(
 339       'o',
 340       "output",
 341       "PREFIX",
 342       gettext_noop("write search results to file starting with PREFIX"),
 343       &output_filename),
 344     GNUNET_GETOPT_option_relative_time(
 345       't',
 346       "timeout",
 347       "DELAY",
 348       gettext_noop("automatically terminate search after DELAY"),
 349       &timeout),
 350     GNUNET_GETOPT_option_verbose(&verbose),
 351     GNUNET_GETOPT_option_uint('N',
 352                               "results",
 353                               "VALUE",
 354                               gettext_noop("automatically terminate search "
 355                                            "after VALUE results are found"),
 356                               &results_limit),
 357     GNUNET_GETOPT_OPTION_END };
 358
 359   if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args(argc, argv, &argc, &argv))
 360     return 2;
 361
 362   ret =
 363     (GNUNET_OK ==
 364      GNUNET_PROGRAM_run(argc,
 365                         argv,
 366                         "gnunet-search [OPTIONS] KEYWORD",
 367                         gettext_noop(
 368                           "Search GNUnet for files that were published on GNUnet"),
 369                         options,
 370                         &run,
 371                         NULL))
 372     ? ret
 373     : 1;
 374   GNUNET_free((void *)argv);
 375   return ret;
 376 }
 377
 378 /* end of gnunet-search.c */