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;
49 static int local_only;
52 * Type of a function that libextractor calls for each
53 * meta data item found.
55 * @param cls closure (user-defined, unused)
56 * @param plugin_name name of the plugin that produced this value;
57 * special values can be used (i.e. '<zlib>' for zlib being
58 * used in the main libextractor library and yielding
60 * @param type libextractor-type describing the meta data
61 * @param format basic format information about data
62 * @param data_mime_type mime-type of data (not of the original file);
63 * can be NULL (if mime-type is not known)
64 * @param data actual meta-data found
65 * @param data_size number of bytes in data
66 * @return 0 to continue extracting, 1 to abort
69 item_printer (void *cls,
70 const char *plugin_name,
71 enum EXTRACTOR_MetaType type,
72 enum EXTRACTOR_MetaFormat format,
73 const char *data_mime_type,
77 if ( (format != EXTRACTOR_METAFORMAT_UTF8) &&
78 (format != EXTRACTOR_METAFORMAT_C_STRING) )
80 if (type == EXTRACTOR_METATYPE_GNUNET_ORIGINAL_FILENAME)
82 printf ("\t%20s: %s\n",
83 dgettext (LIBEXTRACTOR_GETTEXT_DOMAIN,
84 EXTRACTOR_metatype_to_string (type)),
91 clean_task (void *cls,
92 const struct GNUNET_SCHEDULER_TaskContext *tc)
99 if (output_filename == NULL)
102 GNUNET_FS_directory_builder_finish (db,
107 GNUNET_free (output_filename);
111 GNUNET_DISK_fn_write (output_filename,
114 GNUNET_DISK_PERM_USER_READ | GNUNET_DISK_PERM_USER_WRITE))
117 _("Failed to write directory with search results to `%s'\n"),
120 GNUNET_free_non_null (ddata);
121 GNUNET_free (output_filename);
126 * Called by FS client to give information about the progress of an
130 * @param info details about the event, specifying the event type
131 * and various bits about the event
132 * @return client-context (for the next progress call
133 * for this operation; should be set to NULL for
134 * SUSPEND and STOPPED events). The value returned
135 * will be passed to future callbacks in the respective
136 * field in the GNUNET_FS_ProgressInfo struct.
139 progress_cb (void *cls,
140 const struct GNUNET_FS_ProgressInfo *info)
142 static unsigned int cnt;
147 switch (info->status)
149 case GNUNET_FS_STATUS_SEARCH_START:
151 case GNUNET_FS_STATUS_SEARCH_RESULT:
153 GNUNET_FS_directory_builder_add (db,
154 info->value.search.specifics.result.uri,
155 info->value.search.specifics.result.meta,
157 uri = GNUNET_FS_uri_to_string (info->value.search.specifics.result.uri);
158 printf ("#%u:\n", cnt++);
160 GNUNET_CONTAINER_meta_data_get_by_type (info->value.search.specifics.result.meta,
161 EXTRACTOR_METATYPE_GNUNET_ORIGINAL_FILENAME);
162 if (filename != NULL)
164 while (NULL != (dotdot = strstr (filename, "..")))
165 dotdot[0] = dotdot[1] = '_';
166 printf ("gnunet-download -o \"%s\" %s\n",
171 printf ("gnunet-download %s\n", uri);
173 GNUNET_CONTAINER_meta_data_iterate (info->value.search.specifics.result.meta,
178 GNUNET_free_non_null (filename);
181 case GNUNET_FS_STATUS_SEARCH_UPDATE:
183 case GNUNET_FS_STATUS_SEARCH_RESULT_STOPPED:
186 case GNUNET_FS_STATUS_SEARCH_ERROR:
188 _("Error searching: %s.\n"),
189 info->value.search.specifics.error.message);
190 GNUNET_SCHEDULER_shutdown ();
192 case GNUNET_FS_STATUS_SEARCH_STOPPED:
193 GNUNET_SCHEDULER_add_continuation (&clean_task,
195 GNUNET_SCHEDULER_REASON_PREREQ_DONE);
199 _("Unexpected status: %d\n"),
208 shutdown_task (void *cls,
209 const struct GNUNET_SCHEDULER_TaskContext *tc)
213 GNUNET_FS_search_stop (sc);
220 * Main function that will be run by the scheduler.
223 * @param args remaining command-line arguments
224 * @param cfgfile name of the configuration file used (for saving, can be NULL!)
225 * @param c configuration
231 const struct GNUNET_CONFIGURATION_Handle *c)
233 struct GNUNET_FS_Uri *uri;
235 enum GNUNET_FS_SearchOptions options;
236 struct GNUNET_TIME_Relative delay;
239 while (NULL != args[argc])
241 uri = GNUNET_FS_uri_ksk_create_from_args (argc,
242 (const char **) args);
246 _("Could not create keyword URI from arguments.\n"));
251 ctx = GNUNET_FS_start (cfg,
255 GNUNET_FS_FLAGS_NONE,
256 GNUNET_FS_OPTIONS_END);
260 _("Could not initialize `%s' subsystem.\n"),
262 GNUNET_FS_uri_destroy (uri);
266 if (output_filename != NULL)
267 db = GNUNET_FS_directory_builder_create (NULL);
268 options = GNUNET_FS_SEARCH_OPTION_NONE;
270 options |= GNUNET_FS_SEARCH_OPTION_LOOPBACK_ONLY;
271 sc = GNUNET_FS_search_start (ctx,
276 GNUNET_FS_uri_destroy (uri);
280 _("Could not start searching.\n"));
281 GNUNET_FS_stop (ctx);
287 delay.rel_value = timeout;
288 GNUNET_SCHEDULER_add_delayed (delay,
294 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
302 * The main function to search GNUnet.
304 * @param argc number of arguments from the command line
305 * @param argv command line arguments
306 * @return 0 ok, 1 on error
309 main (int argc, char *const *argv)
311 static const struct GNUNET_GETOPT_CommandLineOption options[] = {
312 {'a', "anonymity", "LEVEL",
313 gettext_noop ("set the desired LEVEL of receiver-anonymity"),
314 1, &GNUNET_GETOPT_set_uint, &anonymity},
315 {'n', "no-network", NULL,
316 gettext_noop ("only search the local peer (no P2P network search)"),
317 0, &GNUNET_GETOPT_set_one, &local_only},
318 {'o', "output", "PREFIX",
320 ("write search results to file starting with PREFIX"),
321 1, &GNUNET_GETOPT_set_string, &output_filename},
322 {'t', "timeout", "VALUE",
324 ("automatically terminate search after VALUE ms"),
325 1, &GNUNET_GETOPT_set_ulong, &timeout},
326 {'V', "verbose", NULL,
327 gettext_noop ("be verbose (print progress information)"),
328 0, &GNUNET_GETOPT_set_one, &verbose},
329 GNUNET_GETOPT_OPTION_END
332 GNUNET_PROGRAM_run (argc,
334 "gnunet-search [OPTIONS] KEYWORD",
336 ("Search GNUnet for files that were published on GNUnet"),
337 options, &run, NULL)) ? ret : 1;
340 /* end of gnunet-search.c */