2 This file is part of GNUnet.
3 (C) 2001, 2002, 2004, 2005, 2006, 2007, 2009, 2010 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 2, 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"
31 #define DEFAULT_EXPIRATION GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_YEARS, 2)
37 static const struct GNUNET_CONFIGURATION_Handle *cfg;
39 static struct GNUNET_FS_Handle *ctx;
41 static struct GNUNET_SCHEDULER_Handle *sched;
43 static struct GNUNET_FS_PublishContext *pc;
45 static struct GNUNET_CONTAINER_MetaData *meta;
47 static struct GNUNET_FS_Uri *topKeywords;
49 static struct GNUNET_FS_Uri *uri;
51 static unsigned int anonymity = 1;
53 static unsigned int priority = 365;
55 static char *uri_string;
61 static char *pseudonym;
65 static int disable_extractor;
67 static int do_simulate;
69 static int extract_only;
71 static int do_disable_creation_time;
73 static GNUNET_SCHEDULER_TaskIdentifier kill_task;
77 do_stop_task (void *cls,
78 const struct GNUNET_SCHEDULER_TaskContext *tc)
80 struct GNUNET_FS_PublishContext *p;
86 GNUNET_FS_publish_stop (p);
89 GNUNET_CONTAINER_meta_data_destroy (meta);
97 * Called by FS client to give information about the progress of an
101 * @param info details about the event, specifying the event type
102 * and various bits about the event
103 * @return client-context (for the next progress call
104 * for this operation; should be set to NULL for
105 * SUSPEND and STOPPED events). The value returned
106 * will be passed to future callbacks in the respective
107 * field in the GNUNET_FS_ProgressInfo struct.
110 progress_cb (void *cls,
111 const struct GNUNET_FS_ProgressInfo *info)
115 switch (info->status)
117 case GNUNET_FS_STATUS_PUBLISH_START:
119 case GNUNET_FS_STATUS_PUBLISH_PROGRESS:
122 s = GNUNET_STRINGS_relative_time_to_string(info->value.publish.eta);
124 _("Publishing `%s' at %llu/%llu (%s remaining)\n"),
125 info->value.publish.filename,
126 (unsigned long long) info->value.publish.completed,
127 (unsigned long long) info->value.publish.size,
132 case GNUNET_FS_STATUS_PUBLISH_ERROR:
134 _("Error publishing: %s.\n"),
135 info->value.publish.specifics.error.message);
136 if (kill_task != GNUNET_SCHEDULER_NO_TASK)
138 GNUNET_SCHEDULER_cancel (sched,
140 kill_task = GNUNET_SCHEDULER_NO_TASK;
142 GNUNET_SCHEDULER_add_continuation (sched,
145 GNUNET_SCHEDULER_REASON_PREREQ_DONE);
147 case GNUNET_FS_STATUS_PUBLISH_COMPLETED:
149 _("Publishing `%s' done.\n"),
150 info->value.publish.filename);
151 s = GNUNET_FS_uri_to_string (info->value.publish.specifics.completed.chk_uri);
156 if (info->value.publish.pctx == NULL)
158 if (kill_task != GNUNET_SCHEDULER_NO_TASK)
160 GNUNET_SCHEDULER_cancel (sched,
162 kill_task = GNUNET_SCHEDULER_NO_TASK;
164 GNUNET_SCHEDULER_add_continuation (sched,
167 GNUNET_SCHEDULER_REASON_PREREQ_DONE);
170 case GNUNET_FS_STATUS_PUBLISH_STOPPED:
171 GNUNET_break (NULL == pc);
175 _("Unexpected status: %d\n"),
179 return ""; /* non-null */
184 * Print metadata entries (except binary
185 * metadata and the filename).
188 * @param plugin_name name of the plugin that generated the meta data
189 * @param type type of the meta data
190 * @param format format of data
191 * @param data_mime_type mime type of data
192 * @param data value of the meta data
193 * @param data_size number of bytes in data
197 meta_printer (void *cls,
198 const char *plugin_name,
199 enum EXTRACTOR_MetaType type,
200 enum EXTRACTOR_MetaFormat format,
201 const char *data_mime_type,
205 if ( (format != EXTRACTOR_METAFORMAT_UTF8) &&
206 (format != EXTRACTOR_METAFORMAT_C_STRING) )
208 if (type == EXTRACTOR_METATYPE_FILENAME)
212 EXTRACTOR_metatype_to_string (type),
219 * Function called on all entries before the publication. This is
220 * where we perform modifications to the default based on command-line
224 * @param fi the entry in the publish-structure
225 * @param length length of the file or directory
226 * @param m metadata for the file or directory (can be modified)
227 * @param uri pointer to the keywords that will be used for this entry (can be modified)
228 * @param anonymity pointer to selected anonymity level (can be modified)
229 * @param priority pointer to selected priority (can be modified)
230 * @param do_index should we index?
231 * @param expirationTime pointer to selected expiration time (can be modified)
232 * @param client_info pointer to client context set upon creation (can be modified)
233 * @return GNUNET_OK to continue, GNUNET_NO to remove
234 * this entry from the directory, GNUNET_SYSERR
235 * to abort the iteration
238 publish_inspector (void *cls,
239 struct GNUNET_FS_FileInformation *fi,
241 struct GNUNET_CONTAINER_MetaData *m,
242 struct GNUNET_FS_Uri **uri,
243 unsigned int *anonymity,
244 unsigned int *priority,
246 struct GNUNET_TIME_Absolute *expirationTime,
251 struct GNUNET_FS_Uri *new_uri;
255 if (NULL != topKeywords)
259 new_uri = GNUNET_FS_uri_ksk_merge (topKeywords,
261 GNUNET_FS_uri_destroy (*uri);
263 GNUNET_FS_uri_destroy (topKeywords);
273 GNUNET_CONTAINER_meta_data_merge (m, meta);
274 GNUNET_CONTAINER_meta_data_destroy (meta);
277 if (! do_disable_creation_time)
278 GNUNET_CONTAINER_meta_data_add_publication_date (m);
281 fn = GNUNET_CONTAINER_meta_data_get_by_type (m,
282 EXTRACTOR_METATYPE_FILENAME);
283 fs = GNUNET_STRINGS_byte_size_fancy (length);
285 _("Keywords for file `%s' (%s)\n"),
290 GNUNET_CONTAINER_meta_data_iterate (m,
293 fprintf (stdout, "\n");
295 if (GNUNET_YES == GNUNET_FS_meta_data_test_for_directory (m))
296 GNUNET_FS_file_information_inspect (fi,
304 uri_sks_continuation (void *cls,
305 const struct GNUNET_FS_Uri *ksk_uri,
315 GNUNET_FS_uri_destroy (uri);
317 GNUNET_FS_stop (ctx);
323 uri_ksk_continuation (void *cls,
324 const struct GNUNET_FS_Uri *ksk_uri,
327 struct GNUNET_FS_Namespace *ns;
336 if (pseudonym != NULL)
338 ns = GNUNET_FS_namespace_create (ctx,
343 _("Failed to create namespace `%s'\n"),
349 GNUNET_FS_publish_sks (ctx,
355 GNUNET_TIME_relative_to_absolute (DEFAULT_EXPIRATION),
358 GNUNET_FS_PUBLISH_OPTION_NONE,
359 uri_sks_continuation,
361 GNUNET_assert (GNUNET_OK ==
362 GNUNET_FS_namespace_delete (ns, GNUNET_NO));
366 GNUNET_FS_uri_destroy (uri);
368 GNUNET_FS_stop (ctx);
374 * Main function that will be run by the scheduler.
377 * @param s the scheduler to use
378 * @param args remaining command-line arguments
379 * @param cfgfile name of the configuration file used (for saving, can be NULL!)
380 * @param c configuration
384 struct GNUNET_SCHEDULER_Handle *s,
387 const struct GNUNET_CONFIGURATION_Handle *c)
389 struct GNUNET_FS_FileInformation *fi;
390 struct GNUNET_FS_Namespace *namespace;
391 struct EXTRACTOR_PluginList *plugins;
397 /* check arguments */
398 if ( ( (uri_string == NULL) || (extract_only) )
399 && ( (args[0] == NULL) || (args[1] != NULL) ) )
402 ("You must specify one and only one filename for insertion.\n"));
406 if ((uri_string != NULL) && (args[0] != NULL))
408 printf (_("You must NOT specify an URI and a filename.\n"));
412 if ((uri_string != NULL) && (extract_only))
414 printf (_("Cannot extract metadata from a URI!\n"));
418 if (pseudonym != NULL)
423 _("Option `%s' is required when using option `%s'.\n"),
430 { /* ordinary insertion checks */
434 _("Option `%s' makes no sense without option `%s'.\n"),
442 _("Option `%s' makes no sense without option `%s'.\n"),
448 if ( (args[0] == NULL) &&
449 (uri_string == NULL) )
452 _("Need the name of a file to publish!\n"));
457 ctx = GNUNET_FS_start (sched,
462 GNUNET_FS_FLAGS_NONE,
463 GNUNET_FS_OPTIONS_END);
467 _("Could not initialize `%s' subsystem.\n"),
473 if (NULL != pseudonym)
475 namespace = GNUNET_FS_namespace_create (ctx,
477 if (NULL == namespace)
480 _("Could not create namespace `%s'\n"),
482 GNUNET_FS_stop (ctx);
487 if (NULL != uri_string)
490 uri = GNUNET_FS_uri_parse (uri_string,
495 _("Failed to parse URI: %s\n"),
498 if (namespace != NULL)
499 GNUNET_FS_namespace_delete (namespace, GNUNET_NO);
500 GNUNET_FS_stop (ctx);
504 GNUNET_FS_publish_ksk (ctx,
508 GNUNET_TIME_relative_to_absolute (DEFAULT_EXPIRATION),
511 GNUNET_FS_PUBLISH_OPTION_NONE,
512 &uri_ksk_continuation,
514 if (namespace != NULL)
515 GNUNET_FS_namespace_delete (namespace, GNUNET_NO);
519 if (! disable_extractor)
521 plugins = EXTRACTOR_plugin_add_defaults (EXTRACTOR_OPTION_DEFAULT_POLICY);
523 GNUNET_CONFIGURATION_get_value_string (cfg, "FS", "EXTRACTORS",
527 plugins = EXTRACTOR_plugin_add_config (plugins, ex, EXTRACTOR_OPTION_DEFAULT_POLICY);
532 if (0 != STAT (args[0], &sbuf))
534 GNUNET_asprintf (&emsg,
535 _("Could not access file: %s\n"),
539 else if (S_ISDIR (sbuf.st_mode))
541 fi = GNUNET_FS_file_information_create_from_directory (ctx,
544 &GNUNET_FS_directory_scanner_default,
549 GNUNET_TIME_relative_to_absolute (DEFAULT_EXPIRATION),
555 meta = GNUNET_CONTAINER_meta_data_create ();
556 GNUNET_FS_meta_data_extract_from_file (meta,
559 fi = GNUNET_FS_file_information_create_from_file (ctx,
567 GNUNET_TIME_relative_to_absolute (DEFAULT_EXPIRATION));
568 GNUNET_break (fi != NULL);
570 EXTRACTOR_plugin_remove_all (plugins);
574 _("Could not publish `%s': %s\n"),
578 if (namespace != NULL)
579 GNUNET_FS_namespace_delete (namespace, GNUNET_NO);
580 GNUNET_FS_stop (ctx);
584 GNUNET_FS_file_information_inspect (fi,
589 if (namespace != NULL)
590 GNUNET_FS_namespace_delete (namespace, GNUNET_NO);
591 GNUNET_FS_file_information_destroy (fi, NULL, NULL);
592 GNUNET_FS_stop (ctx);
595 pc = GNUNET_FS_publish_start (ctx,
601 ? GNUNET_FS_PUBLISH_OPTION_SIMULATE_ONLY
602 : GNUNET_FS_PUBLISH_OPTION_NONE);
606 _("Could not start publishing.\n"));
607 GNUNET_FS_stop (ctx);
611 kill_task = GNUNET_SCHEDULER_add_delayed (sched,
612 GNUNET_TIME_UNIT_FOREVER_REL,
621 * The main function to publish content to GNUnet.
623 * @param argc number of arguments from the command line
624 * @param argv command line arguments
625 * @return 0 ok, 1 on error
628 main (int argc, char *const *argv)
630 static const struct GNUNET_GETOPT_CommandLineOption options[] = {
631 {'a', "anonymity", "LEVEL",
632 gettext_noop ("set the desired LEVEL of sender-anonymity"),
633 1, &GNUNET_GETOPT_set_uint, &anonymity},
634 {'d', "disable-creation-time", NULL,
636 ("disable adding the creation time to the metadata of the uploaded file"),
637 0, &GNUNET_GETOPT_set_one, &do_disable_creation_time},
638 {'D', "disable-extractor", NULL,
640 ("do not use libextractor to add keywords or metadata"),
641 0, &GNUNET_GETOPT_set_one, &disable_extractor},
642 {'e', "extract", NULL,
644 ("print list of extracted keywords that would be used, but do not perform upload"),
645 0, &GNUNET_GETOPT_set_one, &extract_only},
646 {'k', "key", "KEYWORD",
648 ("add an additional keyword for the top-level file or directory"
649 " (this option can be specified multiple times)"),
650 1, &GNUNET_FS_getopt_set_keywords, &topKeywords},
651 {'m', "meta", "TYPE:VALUE",
652 gettext_noop ("set the meta-data for the given TYPE to the given VALUE"),
653 1, &GNUNET_FS_getopt_set_metadata, &meta},
654 {'n', "noindex", NULL,
655 gettext_noop ("do not index, perform full insertion (stores entire "
656 "file in encrypted form in GNUnet database)"),
657 0, &GNUNET_GETOPT_set_one, &do_insert},
660 ("specify ID of an updated version to be published in the future"
661 " (for namespace insertions only)"),
662 1, &GNUNET_GETOPT_set_string, &next_id},
663 {'p', "priority", "PRIORITY",
664 gettext_noop ("specify the priority of the content"),
665 1, &GNUNET_GETOPT_set_uint, &priority},
666 {'P', "pseudonym", "NAME",
668 ("publish the files under the pseudonym NAME (place file into namespace)"),
669 1, &GNUNET_GETOPT_set_string, &pseudonym},
670 {'s', "simulate-only", NULL,
671 gettext_noop ("only simulate the process but do not do any "
672 "actual publishing (useful to compute URIs)"),
673 0, &GNUNET_GETOPT_set_one, &do_simulate},
675 gettext_noop ("set the ID of this version of the publication"
676 " (for namespace insertions only)"),
677 1, &GNUNET_GETOPT_set_string, &this_id},
679 gettext_noop ("URI to be published (can be used instead of passing a "
680 "file to add keywords to the file with the respective URI)"),
681 1, &GNUNET_GETOPT_set_string, &uri_string},
682 {'V', "verbose", NULL,
683 gettext_noop ("be verbose (print progress information)"),
684 0, &GNUNET_GETOPT_set_one, &verbose},
685 GNUNET_GETOPT_OPTION_END
688 GNUNET_PROGRAM_run (argc,
692 ("Publish files on GNUnet."),
693 options, &run, NULL)) ? ret : 1;
696 /* end of gnunet-publish.c */