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_START:
299 _("Starting cleanup after abort\n"));
301 case GNUNET_FS_STATUS_UNINDEX_PROGRESS:
303 case GNUNET_FS_STATUS_UNINDEX_COMPLETED:
306 _("Cleanup after abort completed.\n"));
307 GNUNET_FS_unindex_stop (info->value.unindex.uc);
309 case GNUNET_FS_STATUS_UNINDEX_ERROR:
312 _("Cleanup after abort failed.\n"));
313 GNUNET_FS_unindex_stop (info->value.unindex.uc);
317 _("Unexpected status: %d\n"),
321 return ""; /* non-null */
326 * Print metadata entries (except binary
327 * metadata and the filename).
330 * @param plugin_name name of the plugin that generated the meta data
331 * @param type type of the meta data
332 * @param format format of data
333 * @param data_mime_type mime type of @a data
334 * @param data value of the meta data
335 * @param data_size number of bytes in @a data
339 meta_printer (void *cls,
340 const char *plugin_name,
341 enum EXTRACTOR_MetaType type,
342 enum EXTRACTOR_MetaFormat format,
343 const char *data_mime_type,
344 const char *data, size_t data_size)
346 if ((EXTRACTOR_METAFORMAT_UTF8 != format) &&
347 (EXTRACTOR_METAFORMAT_C_STRING != format))
349 if (EXTRACTOR_METATYPE_GNUNET_ORIGINAL_FILENAME == type)
351 #if HAVE_LIBEXTRACTOR
352 FPRINTF (stdout, "\t%s - %s\n", EXTRACTOR_metatype_to_string (type), data);
354 FPRINTF (stdout, "\t%d - %s\n", type, data);
361 * Iterator printing keywords
364 * @param keyword the keyword
365 * @param is_mandatory is the keyword mandatory (in a search)
366 * @return #GNUNET_OK to continue to iterate, #GNUNET_SYSERR to abort
369 keyword_printer (void *cls,
373 FPRINTF (stdout, "\t%s\n", keyword);
379 * Function called on all entries before the publication. This is
380 * where we perform modifications to the default based on command-line
384 * @param fi the entry in the publish-structure
385 * @param length length of the file or directory
386 * @param m metadata for the file or directory (can be modified)
387 * @param uri pointer to the keywords that will be used for this entry (can be modified)
388 * @param bo block options
389 * @param do_index should we index?
390 * @param client_info pointer to client context set upon creation (can be modified)
391 * @return #GNUNET_OK to continue, #GNUNET_NO to remove
392 * this entry from the directory, #GNUNET_SYSERR
393 * to abort the iteration
396 publish_inspector (void *cls,
397 struct GNUNET_FS_FileInformation *fi,
399 struct GNUNET_CONTAINER_MetaData *m,
400 struct GNUNET_FS_Uri **uri,
401 struct GNUNET_FS_BlockOptions *bo,
407 struct GNUNET_FS_Uri *new_uri;
411 if ( (disable_extractor) &&
414 GNUNET_FS_uri_destroy (*uri);
417 if (NULL != topKeywords)
421 new_uri = GNUNET_FS_uri_ksk_merge (topKeywords, *uri);
422 GNUNET_FS_uri_destroy (*uri);
424 GNUNET_FS_uri_destroy (topKeywords);
434 GNUNET_CONTAINER_meta_data_merge (m, meta);
435 GNUNET_CONTAINER_meta_data_destroy (meta);
438 if (!do_disable_creation_time)
439 GNUNET_CONTAINER_meta_data_add_publication_date (m);
442 fn = GNUNET_CONTAINER_meta_data_get_by_type (m,
443 EXTRACTOR_METATYPE_GNUNET_ORIGINAL_FILENAME);
444 fs = GNUNET_STRINGS_byte_size_fancy (length);
445 FPRINTF (stdout, _("Meta data for file `%s' (%s)\n"), fn, fs);
446 GNUNET_CONTAINER_meta_data_iterate (m, &meta_printer, NULL);
447 FPRINTF (stdout, _("Keywords for file `%s' (%s)\n"), fn, fs);
451 GNUNET_FS_uri_ksk_get_keywords (*uri, &keyword_printer, NULL);
452 FPRINTF (stdout, "%s", "\n");
454 if (GNUNET_YES == GNUNET_FS_meta_data_test_for_directory (m))
455 GNUNET_FS_file_information_inspect (fi, &publish_inspector, fi);
461 * Function called upon completion of the publishing
462 * of the UBLOCK for the SKS URI. As this is the last
463 * step, stop our interaction with FS (clean up).
465 * @param cls NULL (closure)
466 * @param sks_uri URI for the block that was published
467 * @param emsg error message, NULL on success
470 uri_sks_continuation (void *cls,
471 const struct GNUNET_FS_Uri *sks_uri,
476 FPRINTF (stderr, "%s\n", emsg);
479 GNUNET_FS_uri_destroy (uri);
481 GNUNET_FS_stop (ctx);
487 * Function called upon completion of the publishing
488 * of the UBLOCK for the KSK URI. Continue with
489 * publishing the SKS URI (if applicable) or clean up.
491 * @param cls NULL (closure)
492 * @param ksk_uri URI for the block that was published
493 * @param emsg error message, NULL on success
496 uri_ksk_continuation (void *cls,
497 const struct GNUNET_FS_Uri *ksk_uri,
500 const struct GNUNET_CRYPTO_EcdsaPrivateKey *priv;
504 FPRINTF (stderr, "%s\n", emsg);
507 if (NULL != namespace)
509 priv = GNUNET_IDENTITY_ego_get_private_key (namespace);
510 GNUNET_FS_publish_sks (ctx, priv, this_id, next_id, meta, uri, &bo,
511 GNUNET_FS_PUBLISH_OPTION_NONE,
512 &uri_sks_continuation, NULL);
515 GNUNET_FS_uri_destroy (uri);
517 GNUNET_FS_stop (ctx);
523 * Iterate over the results from the directory scan and extract
524 * the desired information for the publishing operation.
526 * @param item root with the data from the directroy scan
527 * @return handle with the information for the publishing operation
529 static struct GNUNET_FS_FileInformation *
530 get_file_information (struct GNUNET_FS_ShareTreeItem *item)
532 struct GNUNET_FS_FileInformation *fi;
533 struct GNUNET_FS_FileInformation *fic;
534 struct GNUNET_FS_ShareTreeItem *child;
536 if (GNUNET_YES == item->is_directory)
538 if (NULL == item->meta)
539 item->meta = GNUNET_CONTAINER_meta_data_create ();
540 GNUNET_CONTAINER_meta_data_delete (item->meta,
541 EXTRACTOR_METATYPE_MIMETYPE,
543 GNUNET_FS_meta_data_make_directory (item->meta);
544 if (NULL == item->ksk_uri)
546 const char *mime = GNUNET_FS_DIRECTORY_MIME;
547 item->ksk_uri = GNUNET_FS_uri_ksk_create_from_args (1, &mime);
550 GNUNET_FS_uri_ksk_add_keyword (item->ksk_uri, GNUNET_FS_DIRECTORY_MIME,
552 fi = GNUNET_FS_file_information_create_empty_directory (ctx, NULL,
555 &bo, item->filename);
556 for (child = item->children_head; child; child = child->next)
558 fic = get_file_information (child);
559 GNUNET_break (GNUNET_OK == GNUNET_FS_file_information_add (fi, fic));
564 fi = GNUNET_FS_file_information_create_from_file (ctx, NULL,
566 item->ksk_uri, item->meta,
575 * We've finished scanning the directory and optimized the meta data.
576 * Begin the publication process.
578 * @param directory_scan_result result from the directory scan, freed in this function
581 directory_trim_complete (struct GNUNET_FS_ShareTreeItem *directory_scan_result)
583 struct GNUNET_FS_FileInformation *fi;
584 const struct GNUNET_CRYPTO_EcdsaPrivateKey *priv;
586 fi = get_file_information (directory_scan_result);
587 GNUNET_FS_share_tree_free (directory_scan_result);
592 _("Could not publish\n"));
593 GNUNET_SCHEDULER_shutdown ();
597 GNUNET_FS_file_information_inspect (fi, &publish_inspector, NULL);
600 GNUNET_FS_file_information_destroy (fi, NULL, NULL);
601 GNUNET_SCHEDULER_shutdown ();
604 if (NULL == namespace)
607 priv = GNUNET_IDENTITY_ego_get_private_key (namespace);
608 pc = GNUNET_FS_publish_start (ctx, fi,
609 priv, this_id, next_id,
611 GNUNET_FS_PUBLISH_OPTION_SIMULATE_ONLY :
612 GNUNET_FS_PUBLISH_OPTION_NONE);
617 _("Could not start publishing.\n"));
618 GNUNET_SCHEDULER_shutdown ();
626 * Function called by the directory scanner as we build the tree
627 * that we will need to publish later.
630 * @param filename which file we are making progress on
631 * @param is_directory #GNUNET_YES if this is a directory,
632 * #GNUNET_NO if this is a file
633 * #GNUNET_SYSERR if it is neither (or unknown)
634 * @param reason kind of progress we are making
637 directory_scan_cb (void *cls,
638 const char *filename,
640 enum GNUNET_FS_DirScannerProgressUpdateReason reason)
642 struct GNUNET_FS_ShareTreeItem *directory_scan_result;
646 case GNUNET_FS_DIRSCANNER_FILE_START:
649 if (is_directory == GNUNET_YES)
651 _("Scanning directory `%s'.\n"),
655 _("Scanning file `%s'.\n"),
659 case GNUNET_FS_DIRSCANNER_FILE_IGNORED:
661 _("There was trouble processing file `%s', skipping it.\n"),
664 case GNUNET_FS_DIRSCANNER_ALL_COUNTED:
668 _("Preprocessing complete.\n"));
670 case GNUNET_FS_DIRSCANNER_EXTRACT_FINISHED:
673 _("Extracting meta data from file `%s' complete.\n"),
676 case GNUNET_FS_DIRSCANNER_FINISHED:
680 _("Meta data extraction has finished.\n"));
681 directory_scan_result = GNUNET_FS_directory_scan_get_result (ds);
683 GNUNET_FS_share_tree_trim (directory_scan_result);
684 directory_trim_complete (directory_scan_result);
686 case GNUNET_FS_DIRSCANNER_INTERNAL_ERROR:
689 _("Internal error scanning directory.\n"));
690 if (kill_task != NULL)
692 GNUNET_SCHEDULER_cancel (kill_task);
695 kill_task = GNUNET_SCHEDULER_add_now (&stop_scanner_task, NULL);
706 * Continuation proceeding with initialization after identity subsystem
707 * has been initialized.
709 * @param args0 filename to publish
712 identity_continuation (const char *args0)
717 if ( (NULL != pseudonym) &&
718 (NULL == namespace) )
721 _("Selected pseudonym `%s' unknown\n"),
723 GNUNET_SCHEDULER_shutdown ();
726 if (NULL != uri_string)
729 if (NULL == (uri = GNUNET_FS_uri_parse (uri_string, &emsg)))
732 _("Failed to parse URI: %s\n"),
735 GNUNET_SCHEDULER_shutdown ();
739 GNUNET_FS_publish_ksk (ctx, topKeywords,
742 GNUNET_FS_PUBLISH_OPTION_NONE,
743 &uri_ksk_continuation,
748 GNUNET_CONFIGURATION_get_value_string (cfg, "FS", "EXTRACTORS", &ex))
750 if (0 != ACCESS (args0, R_OK))
753 _("Failed to access `%s': %s\n"),
756 GNUNET_free_non_null (ex);
759 ds = GNUNET_FS_directory_scan_start (args0,
762 &directory_scan_cb, NULL);
767 _("Failed to start meta directory scanner. Is gnunet-helper-publish-fs installed?\n"));
768 GNUNET_free_non_null (ex);
771 GNUNET_free_non_null (ex);
776 * Function called by identity service with known pseudonyms.
778 * @param cls closure with 'const char *' of filename to publish
779 * @param ego ego handle
780 * @param ctx context for application to store data for this ego
781 * (during the lifetime of this process, initially NULL)
782 * @param name name assigned by the user for this ego,
783 * NULL if the user just deleted the ego and it
784 * must thus no longer be used
787 identity_cb (void *cls,
788 struct GNUNET_IDENTITY_Ego *ego,
792 const char *args0 = cls;
796 identity_continuation (args0);
801 if (0 == strcmp (name, pseudonym))
807 * Main function that will be run by the scheduler.
810 * @param args remaining command-line arguments
811 * @param cfgfile name of the configuration file used (for saving, can be NULL!)
812 * @param c configuration
818 const struct GNUNET_CONFIGURATION_Handle *c)
820 /* check arguments */
821 if ((NULL != uri_string) && (extract_only))
823 printf (_("Cannot extract metadata from a URI!\n"));
827 if (((NULL == uri_string) || (extract_only)) &&
828 ((NULL == args[0]) || (NULL != args[1])))
830 printf (_("You must specify one and only one filename for insertion.\n"));
834 if ((NULL != uri_string) && (NULL != args[0]))
836 printf (_("You must NOT specify an URI and a filename.\n"));
840 if (NULL != pseudonym)
844 FPRINTF (stderr, _("Option `%s' is required when using option `%s'.\n"),
851 { /* ordinary insertion checks */
855 _("Option `%s' makes no sense without option `%s'.\n"),
863 _("Option `%s' makes no sense without option `%s'.\n"),
871 GNUNET_FS_start (cfg, "gnunet-publish", &progress_cb, NULL,
872 GNUNET_FS_FLAGS_NONE, GNUNET_FS_OPTIONS_END);
876 _("Could not initialize `%s' subsystem.\n"),
882 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
885 if (NULL != pseudonym)
886 identity = GNUNET_IDENTITY_connect (cfg,
890 identity_continuation (args[0]);
895 * The main function to publish content to GNUnet.
897 * @param argc number of arguments from the command line
898 * @param argv command line arguments
899 * @return 0 ok, 1 on error
902 main (int argc, char *const *argv)
904 static const struct GNUNET_GETOPT_CommandLineOption options[] = {
905 {'a', "anonymity", "LEVEL",
906 gettext_noop ("set the desired LEVEL of sender-anonymity"),
907 1, &GNUNET_GETOPT_set_uint, &bo.anonymity_level},
908 {'d', "disable-creation-time", NULL,
910 ("disable adding the creation time to the metadata of the uploaded file"),
911 0, &GNUNET_GETOPT_set_one, &do_disable_creation_time},
912 {'D', "disable-extractor", NULL,
913 gettext_noop ("do not use libextractor to add keywords or metadata"),
914 0, &GNUNET_GETOPT_set_one, &disable_extractor},
915 {'e', "extract", NULL,
917 ("print list of extracted keywords that would be used, but do not perform upload"),
918 0, &GNUNET_GETOPT_set_one, &extract_only},
919 {'k', "key", "KEYWORD",
921 ("add an additional keyword for the top-level file or directory"
922 " (this option can be specified multiple times)"),
923 1, &GNUNET_FS_getopt_set_keywords, &topKeywords},
924 {'m', "meta", "TYPE:VALUE",
925 gettext_noop ("set the meta-data for the given TYPE to the given VALUE"),
926 1, &GNUNET_FS_getopt_set_metadata, &meta},
927 {'n', "noindex", NULL,
928 gettext_noop ("do not index, perform full insertion (stores entire "
929 "file in encrypted form in GNUnet database)"),
930 0, &GNUNET_GETOPT_set_one, &do_insert},
933 ("specify ID of an updated version to be published in the future"
934 " (for namespace insertions only)"),
935 1, &GNUNET_GETOPT_set_string, &next_id},
936 {'p', "priority", "PRIORITY",
937 gettext_noop ("specify the priority of the content"),
938 1, &GNUNET_GETOPT_set_uint, &bo.content_priority},
939 {'P', "pseudonym", "NAME",
941 ("publish the files under the pseudonym NAME (place file into namespace)"),
942 1, &GNUNET_GETOPT_set_string, &pseudonym},
943 {'r', "replication", "LEVEL",
944 gettext_noop ("set the desired replication LEVEL"),
945 1, &GNUNET_GETOPT_set_uint, &bo.replication_level},
946 {'s', "simulate-only", NULL,
947 gettext_noop ("only simulate the process but do not do any "
948 "actual publishing (useful to compute URIs)"),
949 0, &GNUNET_GETOPT_set_one, &do_simulate},
951 gettext_noop ("set the ID of this version of the publication"
952 " (for namespace insertions only)"),
953 1, &GNUNET_GETOPT_set_string, &this_id},
955 gettext_noop ("URI to be published (can be used instead of passing a "
956 "file to add keywords to the file with the respective URI)"),
957 1, &GNUNET_GETOPT_set_string, &uri_string},
958 {'V', "verbose", NULL,
959 gettext_noop ("be verbose (print progress information)"),
960 0, &GNUNET_GETOPT_set_one, &verbose},
961 GNUNET_GETOPT_OPTION_END
964 GNUNET_TIME_year_to_time (GNUNET_TIME_get_current_year () + 2);
966 if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
969 GNUNET_PROGRAM_run (argc, argv, "gnunet-publish [OPTIONS] FILENAME",
971 ("Publish a file or directory on GNUnet"),
972 options, &run, NULL)) ? ret : 1;
973 GNUNET_free ((void*) argv);
977 /* end of gnunet-publish.c */