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, const char *plugin_name, enum EXTRACTOR_MetaType type,
74 enum EXTRACTOR_MetaFormat format, const char *data_mime_type,
75 const char *data, size_t data_size)
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)), data);
90 clean_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
97 if (output_filename == NULL)
99 if (GNUNET_OK != GNUNET_FS_directory_builder_finish (db, &dsize, &ddata))
102 GNUNET_free (output_filename);
106 GNUNET_DISK_fn_write (output_filename, ddata, dsize,
107 GNUNET_DISK_PERM_USER_READ |
108 GNUNET_DISK_PERM_USER_WRITE))
111 _("Failed to write directory with search results to `%s'\n"),
114 GNUNET_free_non_null (ddata);
115 GNUNET_free (output_filename);
120 * Called by FS client to give information about the progress of an
124 * @param info details about the event, specifying the event type
125 * and various bits about the event
126 * @return client-context (for the next progress call
127 * for this operation; should be set to NULL for
128 * SUSPEND and STOPPED events). The value returned
129 * will be passed to future callbacks in the respective
130 * field in the GNUNET_FS_ProgressInfo struct.
133 progress_cb (void *cls, const struct GNUNET_FS_ProgressInfo *info)
135 static unsigned int cnt;
140 switch (info->status)
142 case GNUNET_FS_STATUS_SEARCH_START:
144 case GNUNET_FS_STATUS_SEARCH_RESULT:
146 GNUNET_FS_directory_builder_add (db,
147 info->value.search.specifics.result.uri,
148 info->value.search.specifics.result.meta,
150 uri = GNUNET_FS_uri_to_string (info->value.search.specifics.result.uri);
151 printf ("#%u:\n", cnt++);
153 GNUNET_CONTAINER_meta_data_get_by_type (info->value.search.
154 specifics.result.meta,
155 EXTRACTOR_METATYPE_GNUNET_ORIGINAL_FILENAME);
156 if (filename != NULL)
158 while (NULL != (dotdot = strstr (filename, "..")))
159 dotdot[0] = dotdot[1] = '_';
160 printf ("gnunet-download -o \"%s\" %s\n", filename, uri);
163 printf ("gnunet-download %s\n", uri);
165 GNUNET_CONTAINER_meta_data_iterate (info->value.search.specifics.
166 result.meta, &item_printer, NULL);
169 GNUNET_free_non_null (filename);
172 if ((results_limit > 0) && (results >= results_limit))
173 GNUNET_SCHEDULER_shutdown ();
175 case GNUNET_FS_STATUS_SEARCH_UPDATE:
177 case GNUNET_FS_STATUS_SEARCH_RESULT_STOPPED:
180 case GNUNET_FS_STATUS_SEARCH_ERROR:
181 fprintf (stderr, _("Error searching: %s.\n"),
182 info->value.search.specifics.error.message);
183 GNUNET_SCHEDULER_shutdown ();
185 case GNUNET_FS_STATUS_SEARCH_STOPPED:
186 GNUNET_SCHEDULER_add_continuation (&clean_task, NULL,
187 GNUNET_SCHEDULER_REASON_PREREQ_DONE);
190 fprintf (stderr, _("Unexpected status: %d\n"), info->status);
198 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
202 GNUNET_FS_search_stop (sc);
209 * Main function that will be run by the scheduler.
212 * @param args remaining command-line arguments
213 * @param cfgfile name of the configuration file used (for saving, can be NULL!)
214 * @param c configuration
217 run (void *cls, char *const *args, const char *cfgfile,
218 const struct GNUNET_CONFIGURATION_Handle *c)
220 struct GNUNET_FS_Uri *uri;
222 enum GNUNET_FS_SearchOptions options;
223 struct GNUNET_TIME_Relative delay;
226 while (NULL != args[argc])
228 uri = GNUNET_FS_uri_ksk_create_from_args (argc, (const char **) args);
231 fprintf (stderr, _("Could not create keyword URI from arguments.\n"));
237 GNUNET_FS_start (cfg, "gnunet-search", &progress_cb, NULL,
238 GNUNET_FS_FLAGS_NONE, GNUNET_FS_OPTIONS_END);
241 fprintf (stderr, _("Could not initialize `%s' subsystem.\n"), "FS");
242 GNUNET_FS_uri_destroy (uri);
246 if (output_filename != NULL)
247 db = GNUNET_FS_directory_builder_create (NULL);
248 options = GNUNET_FS_SEARCH_OPTION_NONE;
250 options |= GNUNET_FS_SEARCH_OPTION_LOOPBACK_ONLY;
251 sc = GNUNET_FS_search_start (ctx, uri, anonymity, options, NULL);
252 GNUNET_FS_uri_destroy (uri);
255 fprintf (stderr, _("Could not start searching.\n"));
256 GNUNET_FS_stop (ctx);
262 delay.rel_value = timeout;
263 GNUNET_SCHEDULER_add_delayed (delay, &shutdown_task, NULL);
267 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &shutdown_task,
274 * The main function to search GNUnet.
276 * @param argc number of arguments from the command line
277 * @param argv command line arguments
278 * @return 0 ok, 1 on error
281 main (int argc, char *const *argv)
283 static const struct GNUNET_GETOPT_CommandLineOption options[] = {
284 {'a', "anonymity", "LEVEL",
285 gettext_noop ("set the desired LEVEL of receiver-anonymity"),
286 1, &GNUNET_GETOPT_set_uint, &anonymity},
287 {'n', "no-network", NULL,
288 gettext_noop ("only search the local peer (no P2P network search)"),
289 0, &GNUNET_GETOPT_set_one, &local_only},
290 {'o', "output", "PREFIX",
291 gettext_noop ("write search results to file starting with PREFIX"),
292 1, &GNUNET_GETOPT_set_string, &output_filename},
293 {'t', "timeout", "VALUE",
294 gettext_noop ("automatically terminate search after VALUE ms"),
295 1, &GNUNET_GETOPT_set_ulong, &timeout},
296 {'V', "verbose", NULL,
297 gettext_noop ("be verbose (print progress information)"),
298 0, &GNUNET_GETOPT_set_one, &verbose},
299 {'N', "results", "VALUE",
301 ("automatically terminate search after VALUE results are found"),
302 1, &GNUNET_GETOPT_set_ulong, &results_limit},
303 GNUNET_GETOPT_OPTION_END
306 GNUNET_PROGRAM_run (argc, argv, "gnunet-search [OPTIONS] KEYWORD",
308 ("Search GNUnet for files that were published on GNUnet"),
309 options, &run, NULL)) ? ret : 1;
312 /* end of gnunet-search.c */