2 This file is part of GNUnet.
3 Copyright (C) 2001-2013 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"
30 #include "gnunet_identity_service.h"
33 * Global return value from 'main'.
38 * Command line option 'verbose' set
43 * Handle to our configuration.
45 static const struct GNUNET_CONFIGURATION_Handle *cfg;
48 * Handle for interaction with file-sharing service.
50 static struct GNUNET_FS_Handle *ctx;
53 * Handle to FS-publishing operation.
55 static struct GNUNET_FS_PublishContext *pc;
58 * Meta-data provided via command-line option.
60 static struct GNUNET_CONTAINER_MetaData *meta;
63 * Keywords provided via command-line option.
65 static struct GNUNET_FS_Uri *topKeywords;
68 * Options we set for published blocks.
70 static struct GNUNET_FS_BlockOptions bo = { {0LL}, 1, 365, 1 };
73 * Value of URI provided on command-line (when not publishing
74 * a file but just creating UBlocks to refer to an existing URI).
76 static char *uri_string;
79 * Value of URI provided on command-line (when not publishing
80 * a file but just creating UBlocks to refer to an existing URI);
81 * parsed version of 'uri_string'.
83 static struct GNUNET_FS_Uri *uri;
86 * Command-line option for namespace publishing: identifier for updates
87 * to this publication.
92 * Command-line option for namespace publishing: identifier for this
98 * Command-line option identifying the pseudonym to use for the publication.
100 static char *pseudonym;
103 * Command-line option for 'inserting'
105 static int do_insert;
108 * Command-line option to disable meta data extraction.
110 static int disable_extractor;
113 * Command-line option to merely simulate publishing operation.
115 static int do_simulate;
118 * Command-line option to only perform meta data extraction, but not publish.
120 static int extract_only;
123 * Command-line option to disable adding creation time.
125 static int do_disable_creation_time;
128 * Task run on CTRL-C to kill everything nicely.
130 static struct GNUNET_SCHEDULER_Task * kill_task;
133 * Handle to the directory scanner (for recursive insertions).
135 static struct GNUNET_FS_DirScanner *ds;
138 * Which namespace do we publish to? NULL if we do not publish to
141 static struct GNUNET_IDENTITY_Ego *namespace;
144 * Handle to identity service.
146 static struct GNUNET_IDENTITY_Handle *identity;
150 * We are finished with the publishing operation, clean up all
154 * @param tc scheduler context
157 do_stop_task (void *cls,
158 const struct GNUNET_SCHEDULER_TaskContext *tc)
160 struct GNUNET_FS_PublishContext *p;
163 if (NULL != identity)
165 GNUNET_IDENTITY_disconnect (identity);
172 GNUNET_FS_publish_stop (p);
176 GNUNET_CONTAINER_meta_data_destroy (meta);
183 * Stop the directory scanner (we had an error).
186 * @param tc scheduler context
189 stop_scanner_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
194 GNUNET_FS_directory_scan_abort (ds);
197 if (NULL != identity)
199 GNUNET_IDENTITY_disconnect (identity);
202 GNUNET_FS_stop (ctx);
209 * Called by FS client to give information about the progress of an
213 * @param info details about the event, specifying the event type
214 * and various bits about the event
215 * @return client-context (for the next progress call
216 * for this operation; should be set to NULL for
217 * SUSPEND and STOPPED events). The value returned
218 * will be passed to future callbacks in the respective
219 * field in the GNUNET_FS_ProgressInfo struct.
222 progress_cb (void *cls,
223 const struct GNUNET_FS_ProgressInfo *info)
228 switch (info->status)
230 case GNUNET_FS_STATUS_PUBLISH_START:
232 case GNUNET_FS_STATUS_PUBLISH_PROGRESS:
235 s = GNUNET_STRINGS_relative_time_to_string (info->value.publish.eta,
238 _("Publishing `%s' at %llu/%llu (%s remaining)\n"),
239 info->value.publish.filename,
240 (unsigned long long) info->value.publish.completed,
241 (unsigned long long) info->value.publish.size, s);
244 case GNUNET_FS_STATUS_PUBLISH_PROGRESS_DIRECTORY:
247 s = GNUNET_STRINGS_relative_time_to_string (info->value.publish.specifics.progress_directory.eta,
250 _("Publishing `%s' at %llu/%llu (%s remaining)\n"),
251 info->value.publish.filename,
252 (unsigned long long) info->value.publish.specifics.progress_directory.completed,
253 (unsigned long long) info->value.publish.specifics.progress_directory.total, s);
256 case GNUNET_FS_STATUS_PUBLISH_ERROR:
257 FPRINTF (stderr, _("Error publishing: %s.\n"),
258 info->value.publish.specifics.error.message);
259 if (kill_task != NULL)
261 GNUNET_SCHEDULER_cancel (kill_task);
264 kill_task = GNUNET_SCHEDULER_add_now (&do_stop_task, NULL);
266 case GNUNET_FS_STATUS_PUBLISH_COMPLETED:
268 _("Publishing `%s' done.\n"),
269 info->value.publish.filename);
270 suri = GNUNET_FS_uri_to_string (info->value.publish.specifics.
276 if (NULL != info->value.publish.specifics.completed.sks_uri)
278 suri = GNUNET_FS_uri_to_string (info->value.publish.specifics.
281 _("Namespace URI is `%s'.\n"),
285 if (NULL == info->value.publish.pctx)
287 if (NULL != kill_task)
288 GNUNET_SCHEDULER_cancel (kill_task);
289 kill_task = GNUNET_SCHEDULER_add_now (&do_stop_task, NULL);
293 case GNUNET_FS_STATUS_PUBLISH_STOPPED:
294 GNUNET_break (NULL == pc);
296 case GNUNET_FS_STATUS_UNINDEX_PROGRESS:
298 case GNUNET_FS_STATUS_UNINDEX_COMPLETED:
301 _("Cleanup after abort complete.\n"));
304 FPRINTF (stderr, _("Unexpected status: %d\n"), info->status);
307 return ""; /* non-null */
312 * Print metadata entries (except binary
313 * metadata and the filename).
316 * @param plugin_name name of the plugin that generated the meta data
317 * @param type type of the meta data
318 * @param format format of data
319 * @param data_mime_type mime type of data
320 * @param data value of the meta data
321 * @param data_size number of bytes in @a data
325 meta_printer (void *cls,
326 const char *plugin_name,
327 enum EXTRACTOR_MetaType type,
328 enum EXTRACTOR_MetaFormat format,
329 const char *data_mime_type,
330 const char *data, size_t data_size)
332 if ((EXTRACTOR_METAFORMAT_UTF8 != format) &&
333 (EXTRACTOR_METAFORMAT_C_STRING != format))
335 if (EXTRACTOR_METATYPE_GNUNET_ORIGINAL_FILENAME == type)
337 FPRINTF (stdout, "\t%s - %s\n", EXTRACTOR_metatype_to_string (type), data);
343 * Iterator printing keywords
346 * @param keyword the keyword
347 * @param is_mandatory is the keyword mandatory (in a search)
348 * @return #GNUNET_OK to continue to iterate, #GNUNET_SYSERR to abort
351 keyword_printer (void *cls,
355 FPRINTF (stdout, "\t%s\n", keyword);
361 * Function called on all entries before the publication. This is
362 * where we perform modifications to the default based on command-line
366 * @param fi the entry in the publish-structure
367 * @param length length of the file or directory
368 * @param m metadata for the file or directory (can be modified)
369 * @param uri pointer to the keywords that will be used for this entry (can be modified)
370 * @param bo block options
371 * @param do_index should we index?
372 * @param client_info pointer to client context set upon creation (can be modified)
373 * @return #GNUNET_OK to continue, #GNUNET_NO to remove
374 * this entry from the directory, #GNUNET_SYSERR
375 * to abort the iteration
378 publish_inspector (void *cls,
379 struct GNUNET_FS_FileInformation *fi,
381 struct GNUNET_CONTAINER_MetaData *m,
382 struct GNUNET_FS_Uri **uri,
383 struct GNUNET_FS_BlockOptions *bo,
389 struct GNUNET_FS_Uri *new_uri;
393 if ( (disable_extractor) &&
396 GNUNET_FS_uri_destroy (*uri);
399 if (NULL != topKeywords)
403 new_uri = GNUNET_FS_uri_ksk_merge (topKeywords, *uri);
404 GNUNET_FS_uri_destroy (*uri);
406 GNUNET_FS_uri_destroy (topKeywords);
416 GNUNET_CONTAINER_meta_data_merge (m, meta);
417 GNUNET_CONTAINER_meta_data_destroy (meta);
420 if (!do_disable_creation_time)
421 GNUNET_CONTAINER_meta_data_add_publication_date (m);
424 fn = GNUNET_CONTAINER_meta_data_get_by_type (m,
425 EXTRACTOR_METATYPE_GNUNET_ORIGINAL_FILENAME);
426 fs = GNUNET_STRINGS_byte_size_fancy (length);
427 FPRINTF (stdout, _("Meta data for file `%s' (%s)\n"), fn, fs);
428 GNUNET_CONTAINER_meta_data_iterate (m, &meta_printer, NULL);
429 FPRINTF (stdout, _("Keywords for file `%s' (%s)\n"), fn, fs);
433 GNUNET_FS_uri_ksk_get_keywords (*uri, &keyword_printer, NULL);
434 FPRINTF (stdout, "%s", "\n");
436 if (GNUNET_YES == GNUNET_FS_meta_data_test_for_directory (m))
437 GNUNET_FS_file_information_inspect (fi, &publish_inspector, fi);
443 * Function called upon completion of the publishing
444 * of the UBLOCK for the SKS URI. As this is the last
445 * step, stop our interaction with FS (clean up).
447 * @param cls NULL (closure)
448 * @param sks_uri URI for the block that was published
449 * @param emsg error message, NULL on success
452 uri_sks_continuation (void *cls,
453 const struct GNUNET_FS_Uri *sks_uri,
458 FPRINTF (stderr, "%s\n", emsg);
461 GNUNET_FS_uri_destroy (uri);
463 GNUNET_FS_stop (ctx);
469 * Function called upon completion of the publishing
470 * of the UBLOCK for the KSK URI. Continue with
471 * publishing the SKS URI (if applicable) or clean up.
473 * @param cls NULL (closure)
474 * @param ksk_uri URI for the block that was published
475 * @param emsg error message, NULL on success
478 uri_ksk_continuation (void *cls,
479 const struct GNUNET_FS_Uri *ksk_uri,
482 const struct GNUNET_CRYPTO_EcdsaPrivateKey *priv;
486 FPRINTF (stderr, "%s\n", emsg);
489 if (NULL != namespace)
491 priv = GNUNET_IDENTITY_ego_get_private_key (namespace);
492 GNUNET_FS_publish_sks (ctx, priv, this_id, next_id, meta, uri, &bo,
493 GNUNET_FS_PUBLISH_OPTION_NONE,
494 &uri_sks_continuation, NULL);
497 GNUNET_FS_uri_destroy (uri);
499 GNUNET_FS_stop (ctx);
505 * Iterate over the results from the directory scan and extract
506 * the desired information for the publishing operation.
508 * @param item root with the data from the directroy scan
509 * @return handle with the information for the publishing operation
511 static struct GNUNET_FS_FileInformation *
512 get_file_information (struct GNUNET_FS_ShareTreeItem *item)
514 struct GNUNET_FS_FileInformation *fi;
515 struct GNUNET_FS_FileInformation *fic;
516 struct GNUNET_FS_ShareTreeItem *child;
518 if (GNUNET_YES == item->is_directory)
520 if (NULL == item->meta)
521 item->meta = GNUNET_CONTAINER_meta_data_create ();
522 GNUNET_CONTAINER_meta_data_delete (item->meta,
523 EXTRACTOR_METATYPE_MIMETYPE,
525 GNUNET_FS_meta_data_make_directory (item->meta);
526 if (NULL == item->ksk_uri)
528 const char *mime = GNUNET_FS_DIRECTORY_MIME;
529 item->ksk_uri = GNUNET_FS_uri_ksk_create_from_args (1, &mime);
532 GNUNET_FS_uri_ksk_add_keyword (item->ksk_uri, GNUNET_FS_DIRECTORY_MIME,
534 fi = GNUNET_FS_file_information_create_empty_directory (ctx, NULL,
537 &bo, item->filename);
538 for (child = item->children_head; child; child = child->next)
540 fic = get_file_information (child);
541 GNUNET_break (GNUNET_OK == GNUNET_FS_file_information_add (fi, fic));
546 fi = GNUNET_FS_file_information_create_from_file (ctx, NULL,
548 item->ksk_uri, item->meta,
557 * We've finished scanning the directory and optimized the meta data.
558 * Begin the publication process.
560 * @param directory_scan_result result from the directory scan, freed in this function
563 directory_trim_complete (struct GNUNET_FS_ShareTreeItem *directory_scan_result)
565 struct GNUNET_FS_FileInformation *fi;
566 const struct GNUNET_CRYPTO_EcdsaPrivateKey *priv;
568 fi = get_file_information (directory_scan_result);
569 GNUNET_FS_share_tree_free (directory_scan_result);
574 _("Could not publish\n"));
575 GNUNET_SCHEDULER_shutdown ();
579 GNUNET_FS_file_information_inspect (fi, &publish_inspector, NULL);
582 GNUNET_FS_file_information_destroy (fi, NULL, NULL);
583 GNUNET_SCHEDULER_shutdown ();
586 if (NULL == namespace)
589 priv = GNUNET_IDENTITY_ego_get_private_key (namespace);
590 pc = GNUNET_FS_publish_start (ctx, fi,
591 priv, this_id, next_id,
593 GNUNET_FS_PUBLISH_OPTION_SIMULATE_ONLY :
594 GNUNET_FS_PUBLISH_OPTION_NONE);
599 _("Could not start publishing.\n"));
600 GNUNET_SCHEDULER_shutdown ();
608 * Function called by the directory scanner as we build the tree
609 * that we will need to publish later.
612 * @param filename which file we are making progress on
613 * @param is_directory #GNUNET_YES if this is a directory,
614 * #GNUNET_NO if this is a file
615 * #GNUNET_SYSERR if it is neither (or unknown)
616 * @param reason kind of progress we are making
619 directory_scan_cb (void *cls,
620 const char *filename,
622 enum GNUNET_FS_DirScannerProgressUpdateReason reason)
624 struct GNUNET_FS_ShareTreeItem *directory_scan_result;
628 case GNUNET_FS_DIRSCANNER_FILE_START:
631 if (is_directory == GNUNET_YES)
633 _("Scanning directory `%s'.\n"),
637 _("Scanning file `%s'.\n"),
641 case GNUNET_FS_DIRSCANNER_FILE_IGNORED:
643 _("There was trouble processing file `%s', skipping it.\n"),
646 case GNUNET_FS_DIRSCANNER_ALL_COUNTED:
650 _("Preprocessing complete.\n"));
652 case GNUNET_FS_DIRSCANNER_EXTRACT_FINISHED:
655 _("Extracting meta data from file `%s' complete.\n"),
658 case GNUNET_FS_DIRSCANNER_FINISHED:
662 _("Meta data extraction has finished.\n"));
663 directory_scan_result = GNUNET_FS_directory_scan_get_result (ds);
665 GNUNET_FS_share_tree_trim (directory_scan_result);
666 directory_trim_complete (directory_scan_result);
668 case GNUNET_FS_DIRSCANNER_INTERNAL_ERROR:
671 _("Internal error scanning directory.\n"));
672 if (kill_task != NULL)
674 GNUNET_SCHEDULER_cancel (kill_task);
677 kill_task = GNUNET_SCHEDULER_add_now (&stop_scanner_task, NULL);
688 * Continuation proceeding with initialization after identity subsystem
689 * has been initialized.
691 * @param args0 filename to publish
694 identity_continuation (const char *args0)
699 if ( (NULL != pseudonym) &&
700 (NULL == namespace) )
703 _("Selected pseudonym `%s' unknown\n"),
705 GNUNET_SCHEDULER_shutdown ();
708 if (NULL != uri_string)
711 if (NULL == (uri = GNUNET_FS_uri_parse (uri_string, &emsg)))
714 _("Failed to parse URI: %s\n"),
717 GNUNET_SCHEDULER_shutdown ();
721 GNUNET_FS_publish_ksk (ctx, topKeywords,
724 GNUNET_FS_PUBLISH_OPTION_NONE,
725 &uri_ksk_continuation,
730 GNUNET_CONFIGURATION_get_value_string (cfg, "FS", "EXTRACTORS", &ex))
732 if (0 != ACCESS (args0, R_OK))
735 _("Failed to access `%s': %s\n"),
738 GNUNET_free_non_null (ex);
741 ds = GNUNET_FS_directory_scan_start (args0,
744 &directory_scan_cb, NULL);
749 _("Failed to start meta directory scanner. Is gnunet-helper-publish-fs installed?\n"));
750 GNUNET_free_non_null (ex);
753 GNUNET_free_non_null (ex);
758 * Function called by identity service with known pseudonyms.
760 * @param cls closure with 'const char *' of filename to publish
761 * @param ego ego handle
762 * @param ctx context for application to store data for this ego
763 * (during the lifetime of this process, initially NULL)
764 * @param name name assigned by the user for this ego,
765 * NULL if the user just deleted the ego and it
766 * must thus no longer be used
769 identity_cb (void *cls,
770 struct GNUNET_IDENTITY_Ego *ego,
774 const char *args0 = cls;
778 identity_continuation (args0);
783 if (0 == strcmp (name, pseudonym))
789 * Main function that will be run by the scheduler.
792 * @param args remaining command-line arguments
793 * @param cfgfile name of the configuration file used (for saving, can be NULL!)
794 * @param c configuration
800 const struct GNUNET_CONFIGURATION_Handle *c)
802 /* check arguments */
803 if ((NULL != uri_string) && (extract_only))
805 printf (_("Cannot extract metadata from a URI!\n"));
809 if (((NULL == uri_string) || (extract_only)) &&
810 ((NULL == args[0]) || (NULL != args[1])))
812 printf (_("You must specify one and only one filename for insertion.\n"));
816 if ((NULL != uri_string) && (NULL != args[0]))
818 printf (_("You must NOT specify an URI and a filename.\n"));
822 if (NULL != pseudonym)
826 FPRINTF (stderr, _("Option `%s' is required when using option `%s'.\n"),
833 { /* ordinary insertion checks */
837 _("Option `%s' makes no sense without option `%s'.\n"),
845 _("Option `%s' makes no sense without option `%s'.\n"),
853 GNUNET_FS_start (cfg, "gnunet-publish", &progress_cb, NULL,
854 GNUNET_FS_FLAGS_NONE, GNUNET_FS_OPTIONS_END);
858 _("Could not initialize `%s' subsystem.\n"),
864 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
867 if (NULL != pseudonym)
868 identity = GNUNET_IDENTITY_connect (cfg,
872 identity_continuation (args[0]);
877 * The main function to publish content to GNUnet.
879 * @param argc number of arguments from the command line
880 * @param argv command line arguments
881 * @return 0 ok, 1 on error
884 main (int argc, char *const *argv)
886 static const struct GNUNET_GETOPT_CommandLineOption options[] = {
887 {'a', "anonymity", "LEVEL",
888 gettext_noop ("set the desired LEVEL of sender-anonymity"),
889 1, &GNUNET_GETOPT_set_uint, &bo.anonymity_level},
890 {'d', "disable-creation-time", NULL,
892 ("disable adding the creation time to the metadata of the uploaded file"),
893 0, &GNUNET_GETOPT_set_one, &do_disable_creation_time},
894 {'D', "disable-extractor", NULL,
895 gettext_noop ("do not use libextractor to add keywords or metadata"),
896 0, &GNUNET_GETOPT_set_one, &disable_extractor},
897 {'e', "extract", NULL,
899 ("print list of extracted keywords that would be used, but do not perform upload"),
900 0, &GNUNET_GETOPT_set_one, &extract_only},
901 {'k', "key", "KEYWORD",
903 ("add an additional keyword for the top-level file or directory"
904 " (this option can be specified multiple times)"),
905 1, &GNUNET_FS_getopt_set_keywords, &topKeywords},
906 {'m', "meta", "TYPE:VALUE",
907 gettext_noop ("set the meta-data for the given TYPE to the given VALUE"),
908 1, &GNUNET_FS_getopt_set_metadata, &meta},
909 {'n', "noindex", NULL,
910 gettext_noop ("do not index, perform full insertion (stores entire "
911 "file in encrypted form in GNUnet database)"),
912 0, &GNUNET_GETOPT_set_one, &do_insert},
915 ("specify ID of an updated version to be published in the future"
916 " (for namespace insertions only)"),
917 1, &GNUNET_GETOPT_set_string, &next_id},
918 {'p', "priority", "PRIORITY",
919 gettext_noop ("specify the priority of the content"),
920 1, &GNUNET_GETOPT_set_uint, &bo.content_priority},
921 {'P', "pseudonym", "NAME",
923 ("publish the files under the pseudonym NAME (place file into namespace)"),
924 1, &GNUNET_GETOPT_set_string, &pseudonym},
925 {'r', "replication", "LEVEL",
926 gettext_noop ("set the desired replication LEVEL"),
927 1, &GNUNET_GETOPT_set_uint, &bo.replication_level},
928 {'s', "simulate-only", NULL,
929 gettext_noop ("only simulate the process but do not do any "
930 "actual publishing (useful to compute URIs)"),
931 0, &GNUNET_GETOPT_set_one, &do_simulate},
933 gettext_noop ("set the ID of this version of the publication"
934 " (for namespace insertions only)"),
935 1, &GNUNET_GETOPT_set_string, &this_id},
937 gettext_noop ("URI to be published (can be used instead of passing a "
938 "file to add keywords to the file with the respective URI)"),
939 1, &GNUNET_GETOPT_set_string, &uri_string},
940 {'V', "verbose", NULL,
941 gettext_noop ("be verbose (print progress information)"),
942 0, &GNUNET_GETOPT_set_one, &verbose},
943 GNUNET_GETOPT_OPTION_END
946 GNUNET_TIME_year_to_time (GNUNET_TIME_get_current_year () + 2);
948 if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
951 GNUNET_PROGRAM_run (argc, argv, "gnunet-publish [OPTIONS] FILENAME",
953 ("Publish a file or directory on GNUnet"),
954 options, &run, NULL)) ? ret : 1;
955 GNUNET_free ((void*) argv);
959 /* end of gnunet-publish.c */