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;
69 static struct GNUNET_FS_DirScanner *ds;
71 static struct GNUNET_FS_ShareTreeItem * directory_scan_result;
73 static struct GNUNET_FS_Namespace *namespace;
79 do_stop_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
81 struct GNUNET_FS_PublishContext *p;
83 kill_task = GNUNET_SCHEDULER_NO_TASK;
88 GNUNET_FS_publish_stop (p);
92 GNUNET_CONTAINER_meta_data_destroy (meta);
99 * Called by FS client to give information about the progress of an
103 * @param info details about the event, specifying the event type
104 * and various bits about the event
105 * @return client-context (for the next progress call
106 * for this operation; should be set to NULL for
107 * SUSPEND and STOPPED events). The value returned
108 * will be passed to future callbacks in the respective
109 * field in the GNUNET_FS_ProgressInfo struct.
112 progress_cb (void *cls, const struct GNUNET_FS_ProgressInfo *info)
116 switch (info->status)
118 case GNUNET_FS_STATUS_PUBLISH_START:
120 case GNUNET_FS_STATUS_PUBLISH_PROGRESS:
123 s = GNUNET_STRINGS_relative_time_to_string (info->value.publish.eta);
124 FPRINTF (stdout, _("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, s);
131 case GNUNET_FS_STATUS_PUBLISH_ERROR:
132 FPRINTF (stderr, _("Error publishing: %s.\n"),
133 info->value.publish.specifics.error.message);
134 if (kill_task != GNUNET_SCHEDULER_NO_TASK)
136 GNUNET_SCHEDULER_cancel (kill_task);
137 kill_task = GNUNET_SCHEDULER_NO_TASK;
139 kill_task = GNUNET_SCHEDULER_add_now (&do_stop_task, NULL);
141 case GNUNET_FS_STATUS_PUBLISH_COMPLETED:
142 FPRINTF (stdout, _("Publishing `%s' done.\n"),
143 info->value.publish.filename);
144 s = GNUNET_FS_uri_to_string (info->value.publish.specifics.
146 FPRINTF (stdout, _("URI is `%s'.\n"), s);
148 if (info->value.publish.pctx == NULL)
150 if (kill_task != GNUNET_SCHEDULER_NO_TASK)
152 GNUNET_SCHEDULER_cancel (kill_task);
153 kill_task = GNUNET_SCHEDULER_NO_TASK;
155 kill_task = GNUNET_SCHEDULER_add_now (&do_stop_task, NULL);
158 case GNUNET_FS_STATUS_PUBLISH_STOPPED:
159 GNUNET_break (NULL == pc);
161 case GNUNET_FS_STATUS_UNINDEX_PROGRESS:
163 case GNUNET_FS_STATUS_UNINDEX_COMPLETED:
164 FPRINTF (stderr, "%s", _("Cleanup after abort complete.\n"));
167 FPRINTF (stderr, _("Unexpected status: %d\n"), info->status);
170 return ""; /* non-null */
175 * Print metadata entries (except binary
176 * metadata and the filename).
179 * @param plugin_name name of the plugin that generated the meta data
180 * @param type type of the meta data
181 * @param format format of data
182 * @param data_mime_type mime type of data
183 * @param data value of the meta data
184 * @param data_size number of bytes in data
188 meta_printer (void *cls, const char *plugin_name, enum EXTRACTOR_MetaType type,
189 enum EXTRACTOR_MetaFormat format, const char *data_mime_type,
190 const char *data, size_t data_size)
192 if ((format != EXTRACTOR_METAFORMAT_UTF8) &&
193 (format != EXTRACTOR_METAFORMAT_C_STRING))
195 if (type == EXTRACTOR_METATYPE_GNUNET_ORIGINAL_FILENAME)
197 FPRINTF (stdout, "\t%s - %s\n", EXTRACTOR_metatype_to_string (type), data);
203 * Iterator printing keywords
206 * @param keyword the keyword
207 * @param is_mandatory is the keyword mandatory (in a search)
208 * @return GNUNET_OK to continue to iterate, GNUNET_SYSERR to abort
211 keyword_printer (void *cls, const char *keyword, int is_mandatory)
213 FPRINTF (stdout, "\t%s\n", keyword);
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 bo block options
229 * @param do_index should we index?
230 * @param client_info pointer to client context set upon creation (can be modified)
231 * @return GNUNET_OK to continue, GNUNET_NO to remove
232 * this entry from the directory, GNUNET_SYSERR
233 * to abort the iteration
236 publish_inspector (void *cls, struct GNUNET_FS_FileInformation *fi,
237 uint64_t length, struct GNUNET_CONTAINER_MetaData *m,
238 struct GNUNET_FS_Uri **uri,
239 struct GNUNET_FS_BlockOptions *bo, int *do_index,
244 struct GNUNET_FS_Uri *new_uri;
248 if (NULL != topKeywords)
252 new_uri = GNUNET_FS_uri_ksk_merge (topKeywords, *uri);
253 GNUNET_FS_uri_destroy (*uri);
255 GNUNET_FS_uri_destroy (topKeywords);
265 GNUNET_CONTAINER_meta_data_merge (m, meta);
266 GNUNET_CONTAINER_meta_data_destroy (meta);
269 if (!do_disable_creation_time)
270 GNUNET_CONTAINER_meta_data_add_publication_date (m);
273 fn = GNUNET_CONTAINER_meta_data_get_by_type (m,
274 EXTRACTOR_METATYPE_GNUNET_ORIGINAL_FILENAME);
275 fs = GNUNET_STRINGS_byte_size_fancy (length);
276 FPRINTF (stdout, _("Meta data for file `%s' (%s)\n"), fn, fs);
277 GNUNET_CONTAINER_meta_data_iterate (m, &meta_printer, NULL);
278 FPRINTF (stdout, _("Keywords for file `%s' (%s)\n"), fn, fs);
282 GNUNET_FS_uri_ksk_get_keywords (*uri, &keyword_printer, NULL);
283 FPRINTF (stdout, "%s", "\n");
285 if (GNUNET_YES == GNUNET_FS_meta_data_test_for_directory (m))
286 GNUNET_FS_file_information_inspect (fi, &publish_inspector, fi);
295 uri_sks_continuation (void *cls, const struct GNUNET_FS_Uri *ksk_uri,
300 FPRINTF (stderr, "%s\n", emsg);
303 GNUNET_FS_uri_destroy (uri);
305 GNUNET_FS_stop (ctx);
314 uri_ksk_continuation (void *cls, const struct GNUNET_FS_Uri *ksk_uri,
317 struct GNUNET_FS_Namespace *ns;
321 FPRINTF (stderr, "%s\n", emsg);
324 if (pseudonym != NULL)
326 ns = GNUNET_FS_namespace_create (ctx, pseudonym);
329 FPRINTF (stderr, _("Failed to create namespace `%s'\n"), pseudonym);
334 GNUNET_FS_publish_sks (ctx, ns, this_id, next_id, meta, uri, &bo,
335 GNUNET_FS_PUBLISH_OPTION_NONE,
336 uri_sks_continuation, NULL);
337 GNUNET_assert (GNUNET_OK == GNUNET_FS_namespace_delete (ns, GNUNET_NO));
341 GNUNET_FS_uri_destroy (uri);
343 GNUNET_FS_stop (ctx);
351 static struct GNUNET_FS_FileInformation *
352 get_file_information (struct GNUNET_FS_ShareTreeItem *item)
354 struct GNUNET_FS_FileInformation *fi;
355 struct GNUNET_FS_FileInformation *fic;
356 struct GNUNET_FS_ShareTreeItem *child;
358 if (item->is_directory)
360 GNUNET_CONTAINER_meta_data_delete (item->meta,
361 EXTRACTOR_METATYPE_MIMETYPE, NULL, 0);
362 GNUNET_FS_meta_data_make_directory (item->meta);
363 if (NULL == item->ksk_uri)
365 const char *mime = GNUNET_FS_DIRECTORY_MIME;
366 item->ksk_uri = GNUNET_FS_uri_ksk_create_from_args (1, &mime);
369 GNUNET_FS_uri_ksk_add_keyword (item->ksk_uri, GNUNET_FS_DIRECTORY_MIME,
371 fi = GNUNET_FS_file_information_create_empty_directory (
372 ctx, NULL, item->ksk_uri,
373 item->meta, &bo, item->filename);
374 for (child = item->children_head; child; child = child->next)
376 fic = get_file_information (child);
377 GNUNET_break (GNUNET_OK == GNUNET_FS_file_information_add (fi, fic));
382 fi = GNUNET_FS_file_information_create_from_file (
383 ctx, NULL, item->filename,
384 item->ksk_uri, item->meta, !do_insert,
395 directory_trim_complete ()
397 struct GNUNET_FS_FileInformation *fi;
399 fi = get_file_information (directory_scan_result);
400 GNUNET_FS_share_tree_free (directory_scan_result);
401 directory_scan_result = NULL;
404 FPRINTF (stderr, "%s", _("Could not publish\n"));
405 if (namespace != NULL)
406 GNUNET_FS_namespace_delete (namespace, GNUNET_NO);
407 GNUNET_FS_stop (ctx);
411 GNUNET_FS_file_information_inspect (fi, &publish_inspector, NULL);
414 if (namespace != NULL)
415 GNUNET_FS_namespace_delete (namespace, GNUNET_NO);
416 GNUNET_FS_file_information_destroy (fi, NULL, NULL);
417 GNUNET_FS_stop (ctx);
418 if (kill_task != GNUNET_SCHEDULER_NO_TASK)
420 GNUNET_SCHEDULER_cancel (kill_task);
421 kill_task = GNUNET_SCHEDULER_NO_TASK;
425 pc = GNUNET_FS_publish_start (ctx, fi, namespace, this_id, next_id,
427 GNUNET_FS_PUBLISH_OPTION_SIMULATE_ONLY :
428 GNUNET_FS_PUBLISH_OPTION_NONE);
431 FPRINTF (stderr, "%s", _("Could not start publishing.\n"));
432 GNUNET_FS_stop (ctx);
440 * Function called by the directory scanner as we build the tree
441 * that we will need to publish later.
444 * @param filename which file we are making progress on
445 * @param is_directory GNUNET_YES if this is a directory,
446 * GNUNET_NO if this is a file
447 * GNUNET_SYSERR if it is neither (or unknown)
448 * @param reason kind of progress we are making
451 directory_scan_cb (void *cls,
452 const char *filename,
454 enum GNUNET_FS_DirScannerProgressUpdateReason reason)
458 case GNUNET_FS_DIRSCANNER_FILE_START:
462 FPRINTF (stdout, _("Scanning directory `%s'.\n"), filename);
464 FPRINTF (stdout, _("Scanning file `%s'.\n"), filename);
467 case GNUNET_FS_DIRSCANNER_FILE_IGNORED:
469 _("There was trouble processing file `%s', skipping it.\n"),
472 case GNUNET_FS_DIRSCANNER_ALL_COUNTED:
474 FPRINTF (stdout, "%s", _("Preprocessing complete.\n"));
476 case GNUNET_FS_DIRSCANNER_EXTRACT_FINISHED:
478 FPRINTF (stdout, _("Extracting meta data from file `%s' complete.\n"), filename);
480 case GNUNET_FS_DIRSCANNER_FINISHED:
482 FPRINTF (stdout, "%s", _("Meta data extraction has finished.\n"));
483 directory_scan_result = GNUNET_FS_directory_scan_get_result (ds);
485 GNUNET_FS_share_tree_trim (directory_scan_result);
486 directory_trim_complete ();
488 case GNUNET_FS_DIRSCANNER_INTERNAL_ERROR:
489 FPRINTF (stdout, "%s", _("Internal error scanning directory.\n"));
490 GNUNET_FS_directory_scan_abort (ds);
492 if (namespace != NULL)
493 GNUNET_FS_namespace_delete (namespace, GNUNET_NO);
494 GNUNET_FS_stop (ctx);
495 if (kill_task != GNUNET_SCHEDULER_NO_TASK)
497 GNUNET_SCHEDULER_cancel (kill_task);
498 kill_task = GNUNET_SCHEDULER_NO_TASK;
511 * Main function that will be run by the scheduler.
514 * @param args remaining command-line arguments
515 * @param cfgfile name of the configuration file used (for saving, can be NULL!)
516 * @param c configuration
519 run (void *cls, char *const *args, const char *cfgfile,
520 const struct GNUNET_CONFIGURATION_Handle *c)
525 /* check arguments */
526 if ((uri_string != NULL) && (extract_only))
528 printf (_("Cannot extract metadata from a URI!\n"));
532 if (((uri_string == NULL) || (extract_only)) &&
533 ((args[0] == NULL) || (args[1] != NULL)))
535 printf (_("You must specify one and only one filename for insertion.\n"));
539 if ((uri_string != NULL) && (args[0] != NULL))
541 printf (_("You must NOT specify an URI and a filename.\n"));
545 if (pseudonym != NULL)
549 FPRINTF (stderr, _("Option `%s' is required when using option `%s'.\n"),
556 { /* ordinary insertion checks */
559 FPRINTF (stderr, _("Option `%s' makes no sense without option `%s'.\n"),
566 FPRINTF (stderr, _("Option `%s' makes no sense without option `%s'.\n"),
574 GNUNET_FS_start (cfg, "gnunet-publish", &progress_cb, NULL,
575 GNUNET_FS_FLAGS_NONE, GNUNET_FS_OPTIONS_END);
578 FPRINTF (stderr, _("Could not initialize `%s' subsystem.\n"), "FS");
583 if (NULL != pseudonym)
585 namespace = GNUNET_FS_namespace_create (ctx, pseudonym);
586 if (NULL == namespace)
588 FPRINTF (stderr, _("Could not create namespace `%s'\n"), pseudonym);
589 GNUNET_FS_stop (ctx);
594 if (NULL != uri_string)
597 uri = GNUNET_FS_uri_parse (uri_string, &emsg);
600 FPRINTF (stderr, _("Failed to parse URI: %s\n"), emsg);
602 if (namespace != NULL)
603 GNUNET_FS_namespace_delete (namespace, GNUNET_NO);
604 GNUNET_FS_stop (ctx);
608 GNUNET_FS_publish_ksk (ctx, topKeywords, meta, uri, &bo,
609 GNUNET_FS_PUBLISH_OPTION_NONE, &uri_ksk_continuation,
611 if (namespace != NULL)
612 GNUNET_FS_namespace_delete (namespace, GNUNET_NO);
616 GNUNET_CONFIGURATION_get_value_string (cfg, "FS", "EXTRACTORS", &ex))
618 if (0 != ACCESS (args[0], R_OK))
621 _("Failed to access `%s': %s\n"),
626 ds = GNUNET_FS_directory_scan_start (args[0],
629 &directory_scan_cb, NULL);
633 "%s", _("Failed to start meta directory scanner. Is gnunet-helper-publish-fs installed?\n"));
637 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &do_stop_task,
643 * The main function to publish content to GNUnet.
645 * @param argc number of arguments from the command line
646 * @param argv command line arguments
647 * @return 0 ok, 1 on error
650 main (int argc, char *const *argv)
652 static const struct GNUNET_GETOPT_CommandLineOption options[] = {
653 {'a', "anonymity", "LEVEL",
654 gettext_noop ("set the desired LEVEL of sender-anonymity"),
655 1, &GNUNET_GETOPT_set_uint, &bo.anonymity_level},
656 {'d', "disable-creation-time", NULL,
658 ("disable adding the creation time to the metadata of the uploaded file"),
659 0, &GNUNET_GETOPT_set_one, &do_disable_creation_time},
660 {'D', "disable-extractor", NULL,
661 gettext_noop ("do not use libextractor to add keywords or metadata"),
662 0, &GNUNET_GETOPT_set_one, &disable_extractor},
663 {'e', "extract", NULL,
665 ("print list of extracted keywords that would be used, but do not perform upload"),
666 0, &GNUNET_GETOPT_set_one, &extract_only},
667 {'k', "key", "KEYWORD",
669 ("add an additional keyword for the top-level file or directory"
670 " (this option can be specified multiple times)"),
671 1, &GNUNET_FS_getopt_set_keywords, &topKeywords},
672 {'m', "meta", "TYPE:VALUE",
673 gettext_noop ("set the meta-data for the given TYPE to the given VALUE"),
674 1, &GNUNET_FS_getopt_set_metadata, &meta},
675 {'n', "noindex", NULL,
676 gettext_noop ("do not index, perform full insertion (stores entire "
677 "file in encrypted form in GNUnet database)"),
678 0, &GNUNET_GETOPT_set_one, &do_insert},
681 ("specify ID of an updated version to be published in the future"
682 " (for namespace insertions only)"),
683 1, &GNUNET_GETOPT_set_string, &next_id},
684 {'p', "priority", "PRIORITY",
685 gettext_noop ("specify the priority of the content"),
686 1, &GNUNET_GETOPT_set_uint, &bo.content_priority},
687 {'P', "pseudonym", "NAME",
689 ("publish the files under the pseudonym NAME (place file into namespace)"),
690 1, &GNUNET_GETOPT_set_string, &pseudonym},
691 {'r', "replication", "LEVEL",
692 gettext_noop ("set the desired replication LEVEL"),
693 1, &GNUNET_GETOPT_set_uint, &bo.replication_level},
694 {'s', "simulate-only", NULL,
695 gettext_noop ("only simulate the process but do not do any "
696 "actual publishing (useful to compute URIs)"),
697 0, &GNUNET_GETOPT_set_one, &do_simulate},
699 gettext_noop ("set the ID of this version of the publication"
700 " (for namespace insertions only)"),
701 1, &GNUNET_GETOPT_set_string, &this_id},
703 gettext_noop ("URI to be published (can be used instead of passing a "
704 "file to add keywords to the file with the respective URI)"),
705 1, &GNUNET_GETOPT_set_string, &uri_string},
706 {'V', "verbose", NULL,
707 gettext_noop ("be verbose (print progress information)"),
708 0, &GNUNET_GETOPT_set_one, &verbose},
709 GNUNET_GETOPT_OPTION_END
711 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
712 "GNUnet publish starts\n");
714 GNUNET_FS_year_to_time (GNUNET_FS_get_current_year () + 2);
716 GNUNET_PROGRAM_run (argc, argv, "gnunet-publish [OPTIONS] FILENAME",
718 ("Publish a file or directory on GNUnet"),
719 options, &run, NULL)) ? ret : 1;
722 /* end of gnunet-publish.c */