searching for files on GNUnet More...

#include "platform.h"
#include "gnunet_fs_service.h"

Include dependency graph for gnunet-search.c:

Functions
static int	item_printer (void cls, const char plugin_name, enum EXTRACTOR_MetaType type, enum EXTRACTOR_MetaFormat format, const char data_mime_type, const char data, size_t data_size)
	Type of a function that libextractor calls for each meta data item found. More...

static void	clean_task (void *cls)

static void *	progress_cb (void cls, const struct GNUNET_FS_ProgressInfo info)
	Called by FS client to give information about the progress of an operation. More...

static void	shutdown_task (void *cls)

static void	timeout_task (void *cls)

static void	run (void cls, char const args, const char cfgfile, const struct GNUNET_CONFIGURATION_Handle *c)
	Main function that will be run by the scheduler. More...

int	main (int argc, char const argv)
	The main function to search GNUnet. More...

Variables
static int	ret

static const struct GNUNET_CONFIGURATION_Handle *	cfg

static struct GNUNET_FS_Handle *	ctx

static struct GNUNET_FS_SearchContext *	sc

static char *	output_filename

static struct GNUNET_FS_DirectoryBuilder *	db

static unsigned int	anonymity = 1

static struct GNUNET_TIME_Relative	timeout
	Timeout for the search, 0 means to wait for CTRL-C. More...

static unsigned int	results_limit

static unsigned int	results

static unsigned int	verbose

static int	local_only

static struct GNUNET_SCHEDULER_Task *	tt

Detailed Description

searching for files on GNUnet

Author: Christian Grothoff; Krista Bennett; James Blackwell; Igor Wronsky

Definition in file gnunet-search.c.

Function Documentation

◆ item_printer()

static int item_printer	(	void *	cls,
		const char *	plugin_name,
		enum EXTRACTOR_MetaType	type,
		enum EXTRACTOR_MetaFormat	format,
		const char *	data_mime_type,
		const char *	data,
		size_t	data_size
	)

static

Type of a function that libextractor calls for each meta data item found.

Parameters

cls	closure (user-defined, unused)
plugin_name	name of the plugin that produced this value; special values can be used (i.e. '<zlib>' for zlib being used in the main libextractor library and yielding meta data).
type	libextractor-type describing the meta data
format	basic format information about data
data_mime_type	mime-type of data (not of the original file); can be NULL (if mime-type is not known)
data	actual meta-data found
data_size	number of bytes in data

Returns: 0 to continue extracting, 1 to abort

Definition at line 79 of file gnunet-search.c.

References dgettext, EXTRACTOR_METAFORMAT_C_STRING, EXTRACTOR_METAFORMAT_UTF8, EXTRACTOR_METATYPE_GNUNET_ORIGINAL_FILENAME, and LIBEXTRACTOR_GETTEXT_DOMAIN.

Referenced by progress_cb().

 {
   if ((format != EXTRACTOR_METAFORMAT_UTF8) &&
       (format != EXTRACTOR_METAFORMAT_C_STRING))
     return 0;
   if (type == EXTRACTOR_METATYPE_GNUNET_ORIGINAL_FILENAME)
     return 0;
 #if HAVE_LIBEXTRACTOR
   printf ("\t%20s: %s\n",
           dgettext (LIBEXTRACTOR_GETTEXT_DOMAIN,
                     EXTRACTOR_metatype_to_string (type)), data);
 #else
   printf ("\t%20d: %s\n",
           type,
           data);
 #endif
   return 0;
 }

Here is the caller graph for this function:

◆ clean_task()

static void clean_task ( void * cls )

static

Definition at line 106 of file gnunet-search.c.

References _, FPRINTF, GNUNET_break, GNUNET_DISK_fn_write(), GNUNET_DISK_PERM_USER_READ, GNUNET_DISK_PERM_USER_WRITE, GNUNET_free, GNUNET_free_non_null, GNUNET_FS_directory_builder_finish(), GNUNET_FS_stop(), GNUNET_OK, and output_filename.

Referenced by progress_cb().

 {
   size_t dsize;
   void *ddata;
 
   GNUNET_FS_stop (ctx);
   ctx = NULL;
   if (output_filename == NULL)
     return;
   if (GNUNET_OK != GNUNET_FS_directory_builder_finish (db, &dsize, &ddata))
   {
     GNUNET_break (0);
     GNUNET_free (output_filename);
     return;
   }
   if (dsize !=
       GNUNET_DISK_fn_write (output_filename, ddata, dsize,
                             GNUNET_DISK_PERM_USER_READ |
                             GNUNET_DISK_PERM_USER_WRITE))
   {
     FPRINTF (stderr,
              _("Failed to write directory with search results to `%s'\n"),
              output_filename);
   }
   GNUNET_free_non_null (ddata);
   GNUNET_free (output_filename);
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ progress_cb()

static void* progress_cb	(	void *	cls,
		const struct GNUNET_FS_ProgressInfo *	info
	)

static

Called by FS client to give information about the progress of an operation.

Parameters

cls	closure
info	details about the event, specifying the event type and various bits about the event

Returns: client-context (for the next progress call for this operation; should be set to NULL for SUSPEND and STOPPED events). The value returned will be passed to future callbacks in the respective field in the GNUNET_FS_ProgressInfo struct.

Definition at line 149 of file gnunet-search.c.

References _, clean_task(), EXTRACTOR_METATYPE_GNUNET_ORIGINAL_FILENAME, filename, FPRINTF, GNUNET_CONTAINER_meta_data_get_by_type(), GNUNET_CONTAINER_meta_data_iterate(), GNUNET_DISK_filename_canonicalize(), GNUNET_free, GNUNET_free_non_null, GNUNET_FS_directory_builder_add(), GNUNET_FS_DIRECTORY_EXT, GNUNET_FS_meta_data_test_for_directory(), GNUNET_FS_STATUS_SEARCH_ERROR, GNUNET_FS_STATUS_SEARCH_RESULT, GNUNET_FS_STATUS_SEARCH_RESULT_STOPPED, GNUNET_FS_STATUS_SEARCH_START, GNUNET_FS_STATUS_SEARCH_STOPPED, GNUNET_FS_STATUS_SEARCH_UPDATE, GNUNET_FS_uri_to_string(), GNUNET_SCHEDULER_add_now(), GNUNET_SCHEDULER_shutdown(), GNUNET_YES, item_printer(), result, results, results_limit, GNUNET_FS_ProgressInfo::search, GNUNET_FS_ProgressInfo::status, uri, GNUNET_FS_ProgressInfo::value, and verbose.

Referenced by run().

 {
   static unsigned int cnt;
   int is_directory;
   char *uri;
   char *filename;
 
   switch (info->status)
   {
   case GNUNET_FS_STATUS_SEARCH_START:
     break;
   case GNUNET_FS_STATUS_SEARCH_RESULT:
     if (db != NULL)
       GNUNET_FS_directory_builder_add (db,
                                        info->value.search.specifics.result.uri,
                                        info->value.search.specifics.result.meta,
                                        NULL);
     uri = GNUNET_FS_uri_to_string (info->value.search.specifics.result.uri);
     printf ("#%u:\n", ++cnt);
     filename =
         GNUNET_CONTAINER_meta_data_get_by_type (info->value.search.
                                                 specifics.result.meta,
                                                 EXTRACTOR_METATYPE_GNUNET_ORIGINAL_FILENAME);
     is_directory =
         GNUNET_FS_meta_data_test_for_directory (info->value.search.
                                                 specifics.result.meta);
     if (NULL != filename)
     {
       while ( (filename[0] != '\0') &&
               ('/' == filename[strlen(filename)-1]) )
         filename[strlen(filename)-1] = '\0';
       GNUNET_DISK_filename_canonicalize (filename);
       if (GNUNET_YES == is_directory)
         printf ("gnunet-download -o \"%s%s\" -R %s\n", filename, GNUNET_FS_DIRECTORY_EXT, uri);
       else
         printf ("gnunet-download -o \"%s\" %s\n", filename, uri);
     }
     else if (GNUNET_YES == is_directory)
       printf ("gnunet-download -o \"collection%s\" -R %s\n", GNUNET_FS_DIRECTORY_EXT, uri);
     else
       printf ("gnunet-download %s\n", uri);
     if (verbose)
       GNUNET_CONTAINER_meta_data_iterate (info->value.search.specifics.
                                           result.meta, &item_printer, NULL);
     printf ("\n");
     fflush (stdout);
     GNUNET_free_non_null (filename);
     GNUNET_free (uri);
     results++;
     if ((results_limit > 0) && (results >= results_limit))
       GNUNET_SCHEDULER_shutdown ();
     break;
   case GNUNET_FS_STATUS_SEARCH_UPDATE:
     break;
   case GNUNET_FS_STATUS_SEARCH_RESULT_STOPPED:
     /* ignore */
     break;
   case GNUNET_FS_STATUS_SEARCH_ERROR:
     FPRINTF (stderr, _("Error searching: %s.\n"),
              info->value.search.specifics.error.message);
     GNUNET_SCHEDULER_shutdown ();
     break;
   case GNUNET_FS_STATUS_SEARCH_STOPPED:
     GNUNET_SCHEDULER_add_now (&clean_task, NULL);
     break;
   default:
     FPRINTF (stderr, _("Unexpected status: %d\n"), info->status);
     break;
   }
   return NULL;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ shutdown_task()

static void shutdown_task ( void * cls )

static

Definition at line 223 of file gnunet-search.c.

References GNUNET_FS_search_stop().

Referenced by run().

 {
   if (sc != NULL)
   {
     GNUNET_FS_search_stop (sc);
     sc = NULL;
   }
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ timeout_task()

static void timeout_task ( void * cls )

static

Definition at line 234 of file gnunet-search.c.

References GNUNET_SCHEDULER_shutdown().

Referenced by run().

 {
   tt = NULL;
   GNUNET_SCHEDULER_shutdown ();
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ run()

static void run	(	void *	cls,
		char const	args,
		const char *	cfgfile,
		const struct GNUNET_CONFIGURATION_Handle *	c
	)

static

Main function that will be run by the scheduler.

Parameters

cls	closure
args	remaining command-line arguments
cfgfile	name of the configuration file used (for saving, can be NULL!)
c	configuration

Definition at line 250 of file gnunet-search.c.

References _, anonymity, FPRINTF, GNUNET_FS_directory_builder_create(), GNUNET_FS_FLAGS_NONE, GNUNET_FS_OPTIONS_END, GNUNET_FS_SEARCH_OPTION_LOOPBACK_ONLY, GNUNET_FS_SEARCH_OPTION_NONE, GNUNET_FS_search_start(), GNUNET_FS_start(), GNUNET_FS_stop(), GNUNET_FS_uri_destroy(), GNUNET_FS_uri_ksk_create_from_args(), GNUNET_SCHEDULER_add_delayed(), GNUNET_SCHEDULER_add_shutdown(), local_only, options, output_filename, progress_cb(), GNUNET_TIME_Relative::rel_value_us, ret, shutdown_task(), timeout, timeout_task(), and uri.

Referenced by main().

 {
   struct GNUNET_FS_Uri *uri;
   unsigned int argc;
   enum GNUNET_FS_SearchOptions options;
 
   argc = 0;
   while (NULL != args[argc])
     argc++;
   uri = GNUNET_FS_uri_ksk_create_from_args (argc, (const char **) args);
   if (NULL == uri)
   {
     FPRINTF (stderr, "%s",  _("Could not create keyword URI from arguments.\n"));
     ret = 1;
     return;
   }
   cfg = c;
   ctx =
       GNUNET_FS_start (cfg, "gnunet-search", &progress_cb, NULL,
                        GNUNET_FS_FLAGS_NONE, GNUNET_FS_OPTIONS_END);
   if (NULL == ctx)
   {
     FPRINTF (stderr, _("Could not initialize `%s' subsystem.\n"), "FS");
     GNUNET_FS_uri_destroy (uri);
     ret = 1;
     return;
   }
   if (output_filename != NULL)
     db = GNUNET_FS_directory_builder_create (NULL);
   options = GNUNET_FS_SEARCH_OPTION_NONE;
   if (local_only)
     options |= GNUNET_FS_SEARCH_OPTION_LOOPBACK_ONLY;
   sc = GNUNET_FS_search_start (ctx, uri, anonymity, options, NULL);
   GNUNET_FS_uri_destroy (uri);
   if (NULL == sc)
   {
     FPRINTF (stderr, "%s",  _("Could not start searching.\n"));
     GNUNET_FS_stop (ctx);
     ret = 1;
     return;
   }
   if (0 != timeout.rel_value_us)
     tt = GNUNET_SCHEDULER_add_delayed (timeout,
                                        &timeout_task,
                                        NULL);
   GNUNET_SCHEDULER_add_shutdown (&shutdown_task,
                                  NULL);
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ main()

int main	(	int	argc,
		char const	argv
	)

The main function to search GNUnet.

Parameters

argc	number of arguments from the command line
argv	command line arguments

Returns: 0 ok, 1 on error

Definition at line 309 of file gnunet-search.c.

References anonymity, gettext_noop, GNUNET_free, GNUNET_GETOPT_OPTION_END, GNUNET_GETOPT_option_flag(), GNUNET_GETOPT_option_relative_time(), GNUNET_GETOPT_option_string(), GNUNET_GETOPT_option_uint(), GNUNET_GETOPT_option_verbose(), GNUNET_OK, GNUNET_PROGRAM_run(), GNUNET_STRINGS_get_utf8_args(), local_only, output_filename, results_limit, ret, run(), timeout, and verbose.

 {
   struct GNUNET_GETOPT_CommandLineOption options[] = {
     GNUNET_GETOPT_option_uint ('a',
                                "anonymity",
                                "LEVEL",
                                gettext_noop ("set the desired LEVEL of receiver-anonymity"),
                                &anonymity),
     GNUNET_GETOPT_option_flag ('n',
                                "no-network",
                                gettext_noop ("only search the local peer (no P2P network search)"),
                                &local_only),                                 
     GNUNET_GETOPT_option_string ('o',
                                  "output",
                                  "PREFIX",
                                  gettext_noop ("write search results to file starting with PREFIX"),
                                  &output_filename),                              
     GNUNET_GETOPT_option_relative_time ('t', 
                                         "timeout",
                                         "DELAY",
                                         gettext_noop ("automatically terminate search after DELAY"),
                                         &timeout),
     GNUNET_GETOPT_option_verbose (&verbose),
     GNUNET_GETOPT_option_uint ('N',
                                "results",
                                "VALUE",
                                gettext_noop ("automatically terminate search "
                                              "after VALUE results are found"),
                                &results_limit),
     GNUNET_GETOPT_OPTION_END
   };
 
   if (GNUNET_OK !=
       GNUNET_STRINGS_get_utf8_args (argc, argv,
                                     &argc, &argv))
     return 2;
 
   ret = (GNUNET_OK ==
          GNUNET_PROGRAM_run (argc,
                              argv,
                              "gnunet-search [OPTIONS] KEYWORD",
                              gettext_noop
                              ("Search GNUnet for files that were published on GNUnet"),
                              options, &run, NULL)) ? ret : 1;
   GNUNET_free ((void*) argv);
   return ret;
 }