2 This file is part of GNUnet.
3 (C) 2001, 2002, 2004, 2005, 2006, 2007, 2009, 2010, 2011 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-publish.c
22 * @brief publishing 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"
35 static const struct GNUNET_CONFIGURATION_Handle *cfg;
37 static struct GNUNET_FS_Handle *ctx;
39 static struct GNUNET_FS_PublishContext *pc;
41 static struct GNUNET_CONTAINER_MetaData *meta;
43 static struct GNUNET_FS_Uri *topKeywords;
45 static struct GNUNET_FS_Uri *uri;
47 static struct GNUNET_FS_BlockOptions bo = { {0LL}, 1, 365, 1 };
49 static char *uri_string;
55 static char *pseudonym;
59 static int disable_extractor;
61 static int do_simulate;
63 static int extract_only;
65 static int do_disable_creation_time;
67 static GNUNET_SCHEDULER_TaskIdentifier kill_task;
74 do_stop_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
76 struct GNUNET_FS_PublishContext *p;
82 GNUNET_FS_publish_stop (p);
85 GNUNET_CONTAINER_meta_data_destroy (meta);
93 * Called by FS client to give information about the progress of an
97 * @param info details about the event, specifying the event type
98 * and various bits about the event
99 * @return client-context (for the next progress call
100 * for this operation; should be set to NULL for
101 * SUSPEND and STOPPED events). The value returned
102 * will be passed to future callbacks in the respective
103 * field in the GNUNET_FS_ProgressInfo struct.
106 progress_cb (void *cls, const struct GNUNET_FS_ProgressInfo *info)
110 switch (info->status)
112 case GNUNET_FS_STATUS_PUBLISH_START:
114 case GNUNET_FS_STATUS_PUBLISH_PROGRESS:
117 s = GNUNET_STRINGS_relative_time_to_string (info->value.publish.eta);
118 fprintf (stdout, _("Publishing `%s' at %llu/%llu (%s remaining)\n"),
119 info->value.publish.filename,
120 (unsigned long long) info->value.publish.completed,
121 (unsigned long long) info->value.publish.size, s);
125 case GNUNET_FS_STATUS_PUBLISH_ERROR:
126 fprintf (stderr, _("Error publishing: %s.\n"),
127 info->value.publish.specifics.error.message);
128 if (kill_task != GNUNET_SCHEDULER_NO_TASK)
130 GNUNET_SCHEDULER_cancel (kill_task);
131 kill_task = GNUNET_SCHEDULER_NO_TASK;
133 GNUNET_SCHEDULER_add_continuation (&do_stop_task, NULL,
134 GNUNET_SCHEDULER_REASON_PREREQ_DONE);
136 case GNUNET_FS_STATUS_PUBLISH_COMPLETED:
137 fprintf (stdout, _("Publishing `%s' done.\n"),
138 info->value.publish.filename);
139 s = GNUNET_FS_uri_to_string (info->value.publish.specifics.
141 fprintf (stdout, _("URI is `%s'.\n"), s);
143 if (info->value.publish.pctx == NULL)
145 if (kill_task != GNUNET_SCHEDULER_NO_TASK)
147 GNUNET_SCHEDULER_cancel (kill_task);
148 kill_task = GNUNET_SCHEDULER_NO_TASK;
150 GNUNET_SCHEDULER_add_continuation (&do_stop_task, NULL,
151 GNUNET_SCHEDULER_REASON_PREREQ_DONE);
154 case GNUNET_FS_STATUS_PUBLISH_STOPPED:
155 GNUNET_break (NULL == pc);
158 fprintf (stderr, _("Unexpected status: %d\n"), info->status);
161 return ""; /* non-null */
166 * Print metadata entries (except binary
167 * metadata and the filename).
170 * @param plugin_name name of the plugin that generated the meta data
171 * @param type type of the meta data
172 * @param format format of data
173 * @param data_mime_type mime type of data
174 * @param data value of the meta data
175 * @param data_size number of bytes in data
179 meta_printer (void *cls, const char *plugin_name, enum EXTRACTOR_MetaType type,
180 enum EXTRACTOR_MetaFormat format, const char *data_mime_type,
181 const char *data, size_t data_size)
183 if ((format != EXTRACTOR_METAFORMAT_UTF8) &&
184 (format != EXTRACTOR_METAFORMAT_C_STRING))
186 if (type == EXTRACTOR_METATYPE_GNUNET_ORIGINAL_FILENAME)
188 fprintf (stdout, "\t%s - %s\n", EXTRACTOR_metatype_to_string (type), data);
194 * Iterator printing keywords
197 * @param keyword the keyword
198 * @param is_mandatory is the keyword mandatory (in a search)
199 * @return GNUNET_OK to continue to iterate, GNUNET_SYSERR to abort
202 keyword_printer (void *cls, const char *keyword, int is_mandatory)
204 fprintf (stdout, "\t%s\n", keyword);
210 * Function called on all entries before the publication. This is
211 * where we perform modifications to the default based on command-line
215 * @param fi the entry in the publish-structure
216 * @param length length of the file or directory
217 * @param m metadata for the file or directory (can be modified)
218 * @param uri pointer to the keywords that will be used for this entry (can be modified)
219 * @param bo block options
220 * @param do_index should we index?
221 * @param client_info pointer to client context set upon creation (can be modified)
222 * @return GNUNET_OK to continue, GNUNET_NO to remove
223 * this entry from the directory, GNUNET_SYSERR
224 * to abort the iteration
227 publish_inspector (void *cls, struct GNUNET_FS_FileInformation *fi,
228 uint64_t length, struct GNUNET_CONTAINER_MetaData *m,
229 struct GNUNET_FS_Uri **uri,
230 struct GNUNET_FS_BlockOptions *bo, int *do_index,
235 struct GNUNET_FS_Uri *new_uri;
239 if (NULL != topKeywords)
243 new_uri = GNUNET_FS_uri_ksk_merge (topKeywords, *uri);
244 GNUNET_FS_uri_destroy (*uri);
246 GNUNET_FS_uri_destroy (topKeywords);
256 GNUNET_CONTAINER_meta_data_merge (m, meta);
257 GNUNET_CONTAINER_meta_data_destroy (meta);
260 if (!do_disable_creation_time)
261 GNUNET_CONTAINER_meta_data_add_publication_date (m);
264 fn = GNUNET_CONTAINER_meta_data_get_by_type (m,
265 EXTRACTOR_METATYPE_GNUNET_ORIGINAL_FILENAME);
266 fs = GNUNET_STRINGS_byte_size_fancy (length);
267 fprintf (stdout, _("Meta data for file `%s' (%s)\n"), fn, fs);
268 GNUNET_CONTAINER_meta_data_iterate (m, &meta_printer, NULL);
269 fprintf (stdout, _("Keywords for file `%s' (%s)\n"), fn, fs);
273 GNUNET_FS_uri_ksk_get_keywords (*uri, &keyword_printer, NULL);
274 fprintf (stdout, "\n");
276 if (GNUNET_YES == GNUNET_FS_meta_data_test_for_directory (m))
277 GNUNET_FS_file_information_inspect (fi, &publish_inspector, fi);
286 uri_sks_continuation (void *cls, const struct GNUNET_FS_Uri *ksk_uri,
291 fprintf (stderr, "%s\n", emsg);
294 GNUNET_FS_uri_destroy (uri);
296 GNUNET_FS_stop (ctx);
305 uri_ksk_continuation (void *cls, const struct GNUNET_FS_Uri *ksk_uri,
308 struct GNUNET_FS_Namespace *ns;
312 fprintf (stderr, "%s\n", emsg);
315 if (pseudonym != NULL)
317 ns = GNUNET_FS_namespace_create (ctx, pseudonym);
320 fprintf (stderr, _("Failed to create namespace `%s'\n"), pseudonym);
325 GNUNET_FS_publish_sks (ctx, ns, this_id, next_id, meta, uri, &bo,
326 GNUNET_FS_PUBLISH_OPTION_NONE,
327 uri_sks_continuation, NULL);
328 GNUNET_assert (GNUNET_OK == GNUNET_FS_namespace_delete (ns, GNUNET_NO));
332 GNUNET_FS_uri_destroy (uri);
334 GNUNET_FS_stop (ctx);
340 * Main function that will be run by the scheduler.
343 * @param args remaining command-line arguments
344 * @param cfgfile name of the configuration file used (for saving, can be NULL!)
345 * @param c configuration
348 run (void *cls, char *const *args, const char *cfgfile,
349 const struct GNUNET_CONFIGURATION_Handle *c)
351 struct GNUNET_FS_FileInformation *fi;
352 struct GNUNET_FS_Namespace *namespace;
353 struct EXTRACTOR_PluginList *plugins;
354 struct GNUNET_FS_Uri *keywords;
359 /* check arguments */
360 if ((uri_string != NULL) && (extract_only))
362 printf (_("Cannot extract metadata from a URI!\n"));
366 if (((uri_string == NULL) || (extract_only)) &&
367 ((args[0] == NULL) || (args[1] != NULL)))
369 printf (_("You must specify one and only one filename for insertion.\n"));
373 if ((uri_string != NULL) && (args[0] != NULL))
375 printf (_("You must NOT specify an URI and a filename.\n"));
379 if (pseudonym != NULL)
383 fprintf (stderr, _("Option `%s' is required when using option `%s'.\n"),
390 { /* ordinary insertion checks */
393 fprintf (stderr, _("Option `%s' makes no sense without option `%s'.\n"),
400 fprintf (stderr, _("Option `%s' makes no sense without option `%s'.\n"),
408 GNUNET_FS_start (cfg, "gnunet-publish", &progress_cb, NULL,
409 GNUNET_FS_FLAGS_NONE, GNUNET_FS_OPTIONS_END);
412 fprintf (stderr, _("Could not initialize `%s' subsystem.\n"), "FS");
417 if (NULL != pseudonym)
419 namespace = GNUNET_FS_namespace_create (ctx, pseudonym);
420 if (NULL == namespace)
422 fprintf (stderr, _("Could not create namespace `%s'\n"), pseudonym);
423 GNUNET_FS_stop (ctx);
428 if (NULL != uri_string)
431 uri = GNUNET_FS_uri_parse (uri_string, &emsg);
434 fprintf (stderr, _("Failed to parse URI: %s\n"), emsg);
436 if (namespace != NULL)
437 GNUNET_FS_namespace_delete (namespace, GNUNET_NO);
438 GNUNET_FS_stop (ctx);
442 GNUNET_FS_publish_ksk (ctx, topKeywords, meta, uri, &bo,
443 GNUNET_FS_PUBLISH_OPTION_NONE, &uri_ksk_continuation,
445 if (namespace != NULL)
446 GNUNET_FS_namespace_delete (namespace, GNUNET_NO);
450 if (!disable_extractor)
452 plugins = EXTRACTOR_plugin_add_defaults (EXTRACTOR_OPTION_DEFAULT_POLICY);
454 GNUNET_CONFIGURATION_get_value_string (cfg, "FS", "EXTRACTORS", &ex))
458 EXTRACTOR_plugin_add_config (plugins, ex,
459 EXTRACTOR_OPTION_DEFAULT_POLICY);
464 GNUNET_assert (NULL != args[0]);
465 if (0 != STAT (args[0], &sbuf))
467 GNUNET_asprintf (&emsg, _("Could not access file: %s\n"), STRERROR (errno));
470 else if (S_ISDIR (sbuf.st_mode))
472 fi = GNUNET_FS_file_information_create_from_directory (ctx, NULL, args[0],
473 &GNUNET_FS_directory_scanner_default,
480 meta = GNUNET_CONTAINER_meta_data_create ();
481 GNUNET_FS_meta_data_extract_from_file (meta, args[0], plugins);
482 keywords = GNUNET_FS_uri_ksk_create_from_meta_data (meta);
483 fi = GNUNET_FS_file_information_create_from_file (ctx, NULL, args[0],
486 GNUNET_break (fi != NULL);
487 GNUNET_FS_uri_destroy (keywords);
489 EXTRACTOR_plugin_remove_all (plugins);
492 fprintf (stderr, _("Could not publish `%s': %s\n"), args[0], emsg);
494 if (namespace != NULL)
495 GNUNET_FS_namespace_delete (namespace, GNUNET_NO);
496 GNUNET_FS_stop (ctx);
500 GNUNET_FS_file_information_inspect (fi, &publish_inspector, NULL);
503 if (namespace != NULL)
504 GNUNET_FS_namespace_delete (namespace, GNUNET_NO);
505 GNUNET_FS_file_information_destroy (fi, NULL, NULL);
506 GNUNET_FS_stop (ctx);
509 pc = GNUNET_FS_publish_start (ctx, fi, namespace, this_id, next_id,
511 GNUNET_FS_PUBLISH_OPTION_SIMULATE_ONLY :
512 GNUNET_FS_PUBLISH_OPTION_NONE);
515 fprintf (stderr, _("Could not start publishing.\n"));
516 GNUNET_FS_stop (ctx);
521 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &do_stop_task,
527 * The main function to publish content to GNUnet.
529 * @param argc number of arguments from the command line
530 * @param argv command line arguments
531 * @return 0 ok, 1 on error
534 main (int argc, char *const *argv)
536 static const struct GNUNET_GETOPT_CommandLineOption options[] = {
537 {'a', "anonymity", "LEVEL",
538 gettext_noop ("set the desired LEVEL of sender-anonymity"),
539 1, &GNUNET_GETOPT_set_uint, &bo.anonymity_level},
540 {'d', "disable-creation-time", NULL,
542 ("disable adding the creation time to the metadata of the uploaded file"),
543 0, &GNUNET_GETOPT_set_one, &do_disable_creation_time},
544 {'D', "disable-extractor", NULL,
545 gettext_noop ("do not use libextractor to add keywords or metadata"),
546 0, &GNUNET_GETOPT_set_one, &disable_extractor},
547 {'e', "extract", NULL,
549 ("print list of extracted keywords that would be used, but do not perform upload"),
550 0, &GNUNET_GETOPT_set_one, &extract_only},
551 {'k', "key", "KEYWORD",
553 ("add an additional keyword for the top-level file or directory"
554 " (this option can be specified multiple times)"),
555 1, &GNUNET_FS_getopt_set_keywords, &topKeywords},
556 {'m', "meta", "TYPE:VALUE",
557 gettext_noop ("set the meta-data for the given TYPE to the given VALUE"),
558 1, &GNUNET_FS_getopt_set_metadata, &meta},
559 {'n', "noindex", NULL,
560 gettext_noop ("do not index, perform full insertion (stores entire "
561 "file in encrypted form in GNUnet database)"),
562 0, &GNUNET_GETOPT_set_one, &do_insert},
565 ("specify ID of an updated version to be published in the future"
566 " (for namespace insertions only)"),
567 1, &GNUNET_GETOPT_set_string, &next_id},
568 {'p', "priority", "PRIORITY",
569 gettext_noop ("specify the priority of the content"),
570 1, &GNUNET_GETOPT_set_uint, &bo.content_priority},
571 {'P', "pseudonym", "NAME",
573 ("publish the files under the pseudonym NAME (place file into namespace)"),
574 1, &GNUNET_GETOPT_set_string, &pseudonym},
575 {'r', "replication", "LEVEL",
576 gettext_noop ("set the desired replication LEVEL"),
577 1, &GNUNET_GETOPT_set_uint, &bo.replication_level},
578 {'s', "simulate-only", NULL,
579 gettext_noop ("only simulate the process but do not do any "
580 "actual publishing (useful to compute URIs)"),
581 0, &GNUNET_GETOPT_set_one, &do_simulate},
583 gettext_noop ("set the ID of this version of the publication"
584 " (for namespace insertions only)"),
585 1, &GNUNET_GETOPT_set_string, &this_id},
587 gettext_noop ("URI to be published (can be used instead of passing a "
588 "file to add keywords to the file with the respective URI)"),
589 1, &GNUNET_GETOPT_set_string, &uri_string},
590 {'V', "verbose", NULL,
591 gettext_noop ("be verbose (print progress information)"),
592 0, &GNUNET_GETOPT_set_one, &verbose},
593 GNUNET_GETOPT_OPTION_END
596 GNUNET_FS_year_to_time (GNUNET_FS_get_current_year () + 2);
598 GNUNET_PROGRAM_run (argc, argv, "gnunet-publish [OPTIONS] FILENAME",
600 ("Publish a file or directory on GNUnet"),
601 options, &run, NULL)) ? ret : 1;
604 /* end of gnunet-publish.c */