2 This file is part of GNUnet.
3 (C) 2001, 2002, 2004, 2005, 2006, 2007, 2009 Christian Grothoff (and other contributing authors)
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.
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.
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.
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
29 #include "gnunet_fs_service.h"
33 static const struct GNUNET_CONFIGURATION_Handle *cfg;
35 static struct GNUNET_FS_Handle *ctx;
37 static struct GNUNET_FS_SearchContext *sc;
39 static char *output_filename;
41 static struct GNUNET_FS_DirectoryBuilder *db;
43 static unsigned int anonymity = 1;
45 static unsigned long long timeout;
47 static unsigned int results_limit;
49 static unsigned int results = 0;
53 static int local_only;
56 * Type of a function that libextractor calls for each
57 * meta data item found.
59 * @param cls closure (user-defined, unused)
60 * @param plugin_name name of the plugin that produced this value;
61 * special values can be used (i.e. '<zlib>' for zlib being
62 * used in the main libextractor library and yielding
64 * @param type libextractor-type describing the meta data
65 * @param format basic format information about data
66 * @param data_mime_type mime-type of data (not of the original file);
67 * can be NULL (if mime-type is not known)
68 * @param data actual meta-data found
69 * @param data_size number of bytes in data
70 * @return 0 to continue extracting, 1 to abort
73 item_printer (void *cls,
74 const char *plugin_name,
75 enum EXTRACTOR_MetaType type,
76 enum EXTRACTOR_MetaFormat format,
77 const char *data_mime_type,
81 if ( (format != EXTRACTOR_METAFORMAT_UTF8) &&
82 (format != EXTRACTOR_METAFORMAT_C_STRING) )
84 if (type == EXTRACTOR_METATYPE_GNUNET_ORIGINAL_FILENAME)
86 printf ("\t%20s: %s\n",
87 dgettext (LIBEXTRACTOR_GETTEXT_DOMAIN,
88 EXTRACTOR_metatype_to_string (type)),
95 clean_task (void *cls,
96 const struct GNUNET_SCHEDULER_TaskContext *tc)
101 GNUNET_FS_stop (ctx);
103 if (output_filename == NULL)
106 GNUNET_FS_directory_builder_finish (db,
111 GNUNET_free (output_filename);
115 GNUNET_DISK_fn_write (output_filename,
118 GNUNET_DISK_PERM_USER_READ | GNUNET_DISK_PERM_USER_WRITE))
121 _("Failed to write directory with search results to `%s'\n"),
124 GNUNET_free_non_null (ddata);
125 GNUNET_free (output_filename);
130 * Called by FS client to give information about the progress of an
134 * @param info details about the event, specifying the event type
135 * and various bits about the event
136 * @return client-context (for the next progress call
137 * for this operation; should be set to NULL for
138 * SUSPEND and STOPPED events). The value returned
139 * will be passed to future callbacks in the respective
140 * field in the GNUNET_FS_ProgressInfo struct.
143 progress_cb (void *cls,
144 const struct GNUNET_FS_ProgressInfo *info)
146 static unsigned int cnt;
151 switch (info->status)
153 case GNUNET_FS_STATUS_SEARCH_START:
155 case GNUNET_FS_STATUS_SEARCH_RESULT:
157 GNUNET_FS_directory_builder_add (db,
158 info->value.search.specifics.result.uri,
159 info->value.search.specifics.result.meta,
161 uri = GNUNET_FS_uri_to_string (info->value.search.specifics.result.uri);
162 printf ("#%u:\n", cnt++);
164 GNUNET_CONTAINER_meta_data_get_by_type (info->value.search.specifics.result.meta,
165 EXTRACTOR_METATYPE_GNUNET_ORIGINAL_FILENAME);
166 if (filename != NULL)
168 while (NULL != (dotdot = strstr (filename, "..")))
169 dotdot[0] = dotdot[1] = '_';
170 printf ("gnunet-download -o \"%s\" %s\n",
175 printf ("gnunet-download %s\n", uri);
177 GNUNET_CONTAINER_meta_data_iterate (info->value.search.specifics.result.meta,
182 GNUNET_free_non_null (filename);
185 if (results_limit > 0 && results >= results_limit)
186 GNUNET_SCHEDULER_shutdown ();
188 case GNUNET_FS_STATUS_SEARCH_UPDATE:
190 case GNUNET_FS_STATUS_SEARCH_RESULT_STOPPED:
193 case GNUNET_FS_STATUS_SEARCH_ERROR:
195 _("Error searching: %s.\n"),
196 info->value.search.specifics.error.message);
197 GNUNET_SCHEDULER_shutdown ();
199 case GNUNET_FS_STATUS_SEARCH_STOPPED:
200 GNUNET_SCHEDULER_add_continuation (&clean_task,
202 GNUNET_SCHEDULER_REASON_PREREQ_DONE);
206 _("Unexpected status: %d\n"),
215 shutdown_task (void *cls,
216 const struct GNUNET_SCHEDULER_TaskContext *tc)
220 GNUNET_FS_search_stop (sc);
227 * Main function that will be run by the scheduler.
230 * @param args remaining command-line arguments
231 * @param cfgfile name of the configuration file used (for saving, can be NULL!)
232 * @param c configuration
238 const struct GNUNET_CONFIGURATION_Handle *c)
240 struct GNUNET_FS_Uri *uri;
242 enum GNUNET_FS_SearchOptions options;
243 struct GNUNET_TIME_Relative delay;
246 while (NULL != args[argc])
248 uri = GNUNET_FS_uri_ksk_create_from_args (argc,
249 (const char **) args);
253 _("Could not create keyword URI from arguments.\n"));
258 ctx = GNUNET_FS_start (cfg,
262 GNUNET_FS_FLAGS_NONE,
263 GNUNET_FS_OPTIONS_END);
267 _("Could not initialize `%s' subsystem.\n"),
269 GNUNET_FS_uri_destroy (uri);
273 if (output_filename != NULL)
274 db = GNUNET_FS_directory_builder_create (NULL);
275 options = GNUNET_FS_SEARCH_OPTION_NONE;
277 options |= GNUNET_FS_SEARCH_OPTION_LOOPBACK_ONLY;
278 sc = GNUNET_FS_search_start (ctx,
283 GNUNET_FS_uri_destroy (uri);
287 _("Could not start searching.\n"));
288 GNUNET_FS_stop (ctx);
294 delay.rel_value = timeout;
295 GNUNET_SCHEDULER_add_delayed (delay,
301 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
309 * The main function to search GNUnet.
311 * @param argc number of arguments from the command line
312 * @param argv command line arguments
313 * @return 0 ok, 1 on error
316 main (int argc, char *const *argv)
318 static const struct GNUNET_GETOPT_CommandLineOption options[] = {
319 {'a', "anonymity", "LEVEL",
320 gettext_noop ("set the desired LEVEL of receiver-anonymity"),
321 1, &GNUNET_GETOPT_set_uint, &anonymity},
322 {'n', "no-network", NULL,
323 gettext_noop ("only search the local peer (no P2P network search)"),
324 0, &GNUNET_GETOPT_set_one, &local_only},
325 {'o', "output", "PREFIX",
327 ("write search results to file starting with PREFIX"),
328 1, &GNUNET_GETOPT_set_string, &output_filename},
329 {'t', "timeout", "VALUE",
331 ("automatically terminate search after VALUE ms"),
332 1, &GNUNET_GETOPT_set_ulong, &timeout},
333 {'V', "verbose", NULL,
334 gettext_noop ("be verbose (print progress information)"),
335 0, &GNUNET_GETOPT_set_one, &verbose},
336 {'N', "results", "VALUE",
338 ("automatically terminate search after VALUE results are found"),
339 1, &GNUNET_GETOPT_set_ulong, &results_limit},
340 GNUNET_GETOPT_OPTION_END
343 GNUNET_PROGRAM_run (argc,
345 "gnunet-search [OPTIONS] KEYWORD",
347 ("Search GNUnet for files that were published on GNUnet"),
348 options, &run, NULL)) ? ret : 1;
351 /* end of gnunet-search.c */