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_intermediary_result;
73 static struct GNUNET_FS_ShareTreeItem * directory_scan_result;
75 static struct GNUNET_FS_ProcessMetadataContext *pmc;
77 static struct GNUNET_FS_Namespace *namespace;
83 do_stop_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
85 struct GNUNET_FS_PublishContext *p;
91 GNUNET_FS_publish_stop (p);
94 GNUNET_CONTAINER_meta_data_destroy (meta);
102 * Called by FS client to give information about the progress of an
106 * @param info details about the event, specifying the event type
107 * and various bits about the event
108 * @return client-context (for the next progress call
109 * for this operation; should be set to NULL for
110 * SUSPEND and STOPPED events). The value returned
111 * will be passed to future callbacks in the respective
112 * field in the GNUNET_FS_ProgressInfo struct.
115 progress_cb (void *cls, const struct GNUNET_FS_ProgressInfo *info)
119 switch (info->status)
121 case GNUNET_FS_STATUS_PUBLISH_START:
123 case GNUNET_FS_STATUS_PUBLISH_PROGRESS:
126 s = GNUNET_STRINGS_relative_time_to_string (info->value.publish.eta);
127 FPRINTF (stdout, _("Publishing `%s' at %llu/%llu (%s remaining)\n"),
128 info->value.publish.filename,
129 (unsigned long long) info->value.publish.completed,
130 (unsigned long long) info->value.publish.size, s);
134 case GNUNET_FS_STATUS_PUBLISH_ERROR:
135 FPRINTF (stderr, _("Error publishing: %s.\n"),
136 info->value.publish.specifics.error.message);
137 if (kill_task != GNUNET_SCHEDULER_NO_TASK)
139 GNUNET_SCHEDULER_cancel (kill_task);
140 kill_task = GNUNET_SCHEDULER_NO_TASK;
142 GNUNET_SCHEDULER_add_continuation (&do_stop_task, NULL,
143 GNUNET_SCHEDULER_REASON_PREREQ_DONE);
145 case GNUNET_FS_STATUS_PUBLISH_COMPLETED:
146 FPRINTF (stdout, _("Publishing `%s' done.\n"),
147 info->value.publish.filename);
148 s = GNUNET_FS_uri_to_string (info->value.publish.specifics.
150 FPRINTF (stdout, _("URI is `%s'.\n"), s);
152 if (info->value.publish.pctx == NULL)
154 if (kill_task != GNUNET_SCHEDULER_NO_TASK)
156 GNUNET_SCHEDULER_cancel (kill_task);
157 kill_task = GNUNET_SCHEDULER_NO_TASK;
159 GNUNET_SCHEDULER_add_continuation (&do_stop_task, NULL,
160 GNUNET_SCHEDULER_REASON_PREREQ_DONE);
163 case GNUNET_FS_STATUS_PUBLISH_STOPPED:
164 GNUNET_break (NULL == pc);
166 case GNUNET_FS_STATUS_UNINDEX_PROGRESS:
168 case GNUNET_FS_STATUS_UNINDEX_COMPLETED:
169 FPRINTF (stderr, "%s", _("Cleanup after abort complete.\n"));
172 FPRINTF (stderr, _("Unexpected status: %d\n"), info->status);
175 return ""; /* non-null */
180 * Print metadata entries (except binary
181 * metadata and the filename).
184 * @param plugin_name name of the plugin that generated the meta data
185 * @param type type of the meta data
186 * @param format format of data
187 * @param data_mime_type mime type of data
188 * @param data value of the meta data
189 * @param data_size number of bytes in data
193 meta_printer (void *cls, const char *plugin_name, enum EXTRACTOR_MetaType type,
194 enum EXTRACTOR_MetaFormat format, const char *data_mime_type,
195 const char *data, size_t data_size)
197 if ((format != EXTRACTOR_METAFORMAT_UTF8) &&
198 (format != EXTRACTOR_METAFORMAT_C_STRING))
200 if (type == EXTRACTOR_METATYPE_GNUNET_ORIGINAL_FILENAME)
202 FPRINTF (stdout, "\t%s - %s\n", EXTRACTOR_metatype_to_string (type), data);
208 * Iterator printing keywords
211 * @param keyword the keyword
212 * @param is_mandatory is the keyword mandatory (in a search)
213 * @return GNUNET_OK to continue to iterate, GNUNET_SYSERR to abort
216 keyword_printer (void *cls, const char *keyword, int is_mandatory)
218 FPRINTF (stdout, "\t%s\n", keyword);
224 * Function called on all entries before the publication. This is
225 * where we perform modifications to the default based on command-line
229 * @param fi the entry in the publish-structure
230 * @param length length of the file or directory
231 * @param m metadata for the file or directory (can be modified)
232 * @param uri pointer to the keywords that will be used for this entry (can be modified)
233 * @param bo block options
234 * @param do_index should we index?
235 * @param client_info pointer to client context set upon creation (can be modified)
236 * @return GNUNET_OK to continue, GNUNET_NO to remove
237 * this entry from the directory, GNUNET_SYSERR
238 * to abort the iteration
241 publish_inspector (void *cls, struct GNUNET_FS_FileInformation *fi,
242 uint64_t length, struct GNUNET_CONTAINER_MetaData *m,
243 struct GNUNET_FS_Uri **uri,
244 struct GNUNET_FS_BlockOptions *bo, int *do_index,
249 struct GNUNET_FS_Uri *new_uri;
253 if (NULL != topKeywords)
257 new_uri = GNUNET_FS_uri_ksk_merge (topKeywords, *uri);
258 GNUNET_FS_uri_destroy (*uri);
260 GNUNET_FS_uri_destroy (topKeywords);
270 GNUNET_CONTAINER_meta_data_merge (m, meta);
271 GNUNET_CONTAINER_meta_data_destroy (meta);
274 if (!do_disable_creation_time)
275 GNUNET_CONTAINER_meta_data_add_publication_date (m);
278 fn = GNUNET_CONTAINER_meta_data_get_by_type (m,
279 EXTRACTOR_METATYPE_GNUNET_ORIGINAL_FILENAME);
280 fs = GNUNET_STRINGS_byte_size_fancy (length);
281 FPRINTF (stdout, _("Meta data for file `%s' (%s)\n"), fn, fs);
282 GNUNET_CONTAINER_meta_data_iterate (m, &meta_printer, NULL);
283 FPRINTF (stdout, _("Keywords for file `%s' (%s)\n"), fn, fs);
287 GNUNET_FS_uri_ksk_get_keywords (*uri, &keyword_printer, NULL);
288 FPRINTF (stdout, "%s", "\n");
290 if (GNUNET_YES == GNUNET_FS_meta_data_test_for_directory (m))
291 GNUNET_FS_file_information_inspect (fi, &publish_inspector, fi);
300 uri_sks_continuation (void *cls, const struct GNUNET_FS_Uri *ksk_uri,
305 FPRINTF (stderr, "%s\n", emsg);
308 GNUNET_FS_uri_destroy (uri);
310 GNUNET_FS_stop (ctx);
319 uri_ksk_continuation (void *cls, const struct GNUNET_FS_Uri *ksk_uri,
322 struct GNUNET_FS_Namespace *ns;
326 FPRINTF (stderr, "%s\n", emsg);
329 if (pseudonym != NULL)
331 ns = GNUNET_FS_namespace_create (ctx, pseudonym);
334 FPRINTF (stderr, _("Failed to create namespace `%s'\n"), pseudonym);
339 GNUNET_FS_publish_sks (ctx, ns, this_id, next_id, meta, uri, &bo,
340 GNUNET_FS_PUBLISH_OPTION_NONE,
341 uri_sks_continuation, NULL);
342 GNUNET_assert (GNUNET_OK == GNUNET_FS_namespace_delete (ns, GNUNET_NO));
346 GNUNET_FS_uri_destroy (uri);
348 GNUNET_FS_stop (ctx);
352 static struct GNUNET_FS_FileInformation *
353 get_file_information (struct GNUNET_FS_ShareTreeItem *item)
355 struct GNUNET_FS_FileInformation *fi;
356 struct GNUNET_FS_FileInformation *fic;
357 struct GNUNET_FS_ShareTreeItem *child;
359 if (item->is_directory)
361 GNUNET_CONTAINER_meta_data_delete (item->meta,
362 EXTRACTOR_METATYPE_MIMETYPE, NULL, 0);
363 GNUNET_FS_meta_data_make_directory (item->meta);
364 GNUNET_FS_uri_ksk_add_keyword (item->ksk_uri, GNUNET_FS_DIRECTORY_MIME,
366 fi = GNUNET_FS_file_information_create_empty_directory (
367 ctx, NULL, item->ksk_uri,
368 item->meta, &bo, item->filename);
369 for (child = item->children_head; child; child = child->next)
371 fic = get_file_information (child);
372 GNUNET_break (GNUNET_OK == GNUNET_FS_file_information_add (fi, fic));
377 fi = GNUNET_FS_file_information_create_from_file (
378 ctx, NULL, item->filename,
379 item->ksk_uri, item->meta, !do_insert,
382 GNUNET_CONTAINER_meta_data_destroy (item->meta);
383 GNUNET_FS_uri_destroy (item->ksk_uri);
384 GNUNET_free (item->short_filename);
385 GNUNET_free (item->filename);
391 directory_trim_complete (void *cls,
392 const struct GNUNET_SCHEDULER_TaskContext *tc)
394 struct GNUNET_FS_FileInformation *fi;
395 directory_scan_result = directory_scan_intermediary_result;
396 fi = get_file_information (directory_scan_result);
397 directory_scan_result = NULL;
400 FPRINTF (stderr, "%s", _("Could not publish\n"));
401 if (namespace != NULL)
402 GNUNET_FS_namespace_delete (namespace, GNUNET_NO);
403 GNUNET_FS_stop (ctx);
407 GNUNET_FS_file_information_inspect (fi, &publish_inspector, NULL);
410 if (namespace != NULL)
411 GNUNET_FS_namespace_delete (namespace, GNUNET_NO);
412 GNUNET_FS_file_information_destroy (fi, NULL, NULL);
413 GNUNET_FS_stop (ctx);
416 pc = GNUNET_FS_publish_start (ctx, fi, namespace, this_id, next_id,
418 GNUNET_FS_PUBLISH_OPTION_SIMULATE_ONLY :
419 GNUNET_FS_PUBLISH_OPTION_NONE);
422 FPRINTF (stderr, "%s", _("Could not start publishing.\n"));
423 GNUNET_FS_stop (ctx);
430 directory_scan_cb (void *cls, struct GNUNET_FS_DirScanner *ds,
431 const char *filename, char is_directory,
432 enum GNUNET_FS_DirScannerProgressUpdateReason reason)
436 case GNUNET_DIR_SCANNER_NEW_FILE:
437 if (filename != NULL)
440 FPRINTF (stdout, _("Scanning directory `%s'.\n"), filename);
442 FPRINTF (stdout, _("Scanning file `%s'.\n"), filename);
445 case GNUNET_DIR_SCANNER_DOES_NOT_EXIST:
446 if (filename != NULL)
449 _("Failed to scan `%s', because it does not exist.\n"),
453 case GNUNET_DIR_SCANNER_ASKED_TO_STOP:
454 if (filename != NULL)
457 _("Scanner was about to scan `%s', but is now stopping.\n"),
461 FPRINTF (stdout, "%s", _("Scanner is stopping.\n"));
463 case GNUNET_DIR_SCANNER_SHUTDOWN:
464 FPRINTF (stdout, "%s", _("Client is shutting down.\n"));
466 case GNUNET_DIR_SCANNER_FINISHED:
467 FPRINTF (stdout, "%s", _("Scanner has finished.\n"));
469 case GNUNET_DIR_SCANNER_PROTOCOL_ERROR:
470 FPRINTF (stdout, "%s",
471 _("There was a failure communicating with the scanner.\n"));
474 FPRINTF (stdout, _("Got unknown scanner update with filename `%s'.\n"),
478 if ((filename == NULL && GNUNET_DIR_SCANNER_FINISHED)
479 || reason == GNUNET_DIR_SCANNER_PROTOCOL_ERROR
480 || reason == GNUNET_DIR_SCANNER_SHUTDOWN)
482 /* Any of this causes us to try to clean up the scanner */
483 directory_scan_intermediary_result = GNUNET_FS_directory_scan_cleanup (ds);
484 pmc = GNUNET_FS_trim_share_tree (directory_scan_intermediary_result,
485 &directory_trim_complete, NULL);
488 /* FIXME: change the tree processor to be able to free untrimmed trees
489 * right here instead of waiting for trimming to complete, if we need to
498 * Main function that will be run by the scheduler.
501 * @param args remaining command-line arguments
502 * @param cfgfile name of the configuration file used (for saving, can be NULL!)
503 * @param c configuration
506 run (void *cls, char *const *args, const char *cfgfile,
507 const struct GNUNET_CONFIGURATION_Handle *c)
512 /* check arguments */
513 if ((uri_string != NULL) && (extract_only))
515 printf (_("Cannot extract metadata from a URI!\n"));
519 if (((uri_string == NULL) || (extract_only)) &&
520 ((args[0] == NULL) || (args[1] != NULL)))
522 printf (_("You must specify one and only one filename for insertion.\n"));
526 if ((uri_string != NULL) && (args[0] != NULL))
528 printf (_("You must NOT specify an URI and a filename.\n"));
532 if (pseudonym != NULL)
536 FPRINTF (stderr, _("Option `%s' is required when using option `%s'.\n"),
543 { /* ordinary insertion checks */
546 FPRINTF (stderr, _("Option `%s' makes no sense without option `%s'.\n"),
553 FPRINTF (stderr, _("Option `%s' makes no sense without option `%s'.\n"),
561 GNUNET_FS_start (cfg, "gnunet-publish", &progress_cb, NULL,
562 GNUNET_FS_FLAGS_NONE, GNUNET_FS_OPTIONS_END);
565 FPRINTF (stderr, _("Could not initialize `%s' subsystem.\n"), "FS");
570 if (NULL != pseudonym)
572 namespace = GNUNET_FS_namespace_create (ctx, pseudonym);
573 if (NULL == namespace)
575 FPRINTF (stderr, _("Could not create namespace `%s'\n"), pseudonym);
576 GNUNET_FS_stop (ctx);
581 if (NULL != uri_string)
584 uri = GNUNET_FS_uri_parse (uri_string, &emsg);
587 FPRINTF (stderr, _("Failed to parse URI: %s\n"), emsg);
589 if (namespace != NULL)
590 GNUNET_FS_namespace_delete (namespace, GNUNET_NO);
591 GNUNET_FS_stop (ctx);
595 GNUNET_FS_publish_ksk (ctx, topKeywords, meta, uri, &bo,
596 GNUNET_FS_PUBLISH_OPTION_NONE, &uri_ksk_continuation,
598 if (namespace != NULL)
599 GNUNET_FS_namespace_delete (namespace, GNUNET_NO);
603 GNUNET_CONFIGURATION_get_value_string (cfg, "FS", "EXTRACTORS", &ex))
606 ds = GNUNET_FS_directory_scan_start (args[0],
609 &directory_scan_cb, NULL);
611 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &do_stop_task,
617 * The main function to publish content to GNUnet.
619 * @param argc number of arguments from the command line
620 * @param argv command line arguments
621 * @return 0 ok, 1 on error
624 main (int argc, char *const *argv)
626 static const struct GNUNET_GETOPT_CommandLineOption options[] = {
627 {'a', "anonymity", "LEVEL",
628 gettext_noop ("set the desired LEVEL of sender-anonymity"),
629 1, &GNUNET_GETOPT_set_uint, &bo.anonymity_level},
630 {'d', "disable-creation-time", NULL,
632 ("disable adding the creation time to the metadata of the uploaded file"),
633 0, &GNUNET_GETOPT_set_one, &do_disable_creation_time},
634 {'D', "disable-extractor", NULL,
635 gettext_noop ("do not use libextractor to add keywords or metadata"),
636 0, &GNUNET_GETOPT_set_one, &disable_extractor},
637 {'e', "extract", NULL,
639 ("print list of extracted keywords that would be used, but do not perform upload"),
640 0, &GNUNET_GETOPT_set_one, &extract_only},
641 {'k', "key", "KEYWORD",
643 ("add an additional keyword for the top-level file or directory"
644 " (this option can be specified multiple times)"),
645 1, &GNUNET_FS_getopt_set_keywords, &topKeywords},
646 {'m', "meta", "TYPE:VALUE",
647 gettext_noop ("set the meta-data for the given TYPE to the given VALUE"),
648 1, &GNUNET_FS_getopt_set_metadata, &meta},
649 {'n', "noindex", NULL,
650 gettext_noop ("do not index, perform full insertion (stores entire "
651 "file in encrypted form in GNUnet database)"),
652 0, &GNUNET_GETOPT_set_one, &do_insert},
655 ("specify ID of an updated version to be published in the future"
656 " (for namespace insertions only)"),
657 1, &GNUNET_GETOPT_set_string, &next_id},
658 {'p', "priority", "PRIORITY",
659 gettext_noop ("specify the priority of the content"),
660 1, &GNUNET_GETOPT_set_uint, &bo.content_priority},
661 {'P', "pseudonym", "NAME",
663 ("publish the files under the pseudonym NAME (place file into namespace)"),
664 1, &GNUNET_GETOPT_set_string, &pseudonym},
665 {'r', "replication", "LEVEL",
666 gettext_noop ("set the desired replication LEVEL"),
667 1, &GNUNET_GETOPT_set_uint, &bo.replication_level},
668 {'s', "simulate-only", NULL,
669 gettext_noop ("only simulate the process but do not do any "
670 "actual publishing (useful to compute URIs)"),
671 0, &GNUNET_GETOPT_set_one, &do_simulate},
673 gettext_noop ("set the ID of this version of the publication"
674 " (for namespace insertions only)"),
675 1, &GNUNET_GETOPT_set_string, &this_id},
677 gettext_noop ("URI to be published (can be used instead of passing a "
678 "file to add keywords to the file with the respective URI)"),
679 1, &GNUNET_GETOPT_set_string, &uri_string},
680 {'V', "verbose", NULL,
681 gettext_noop ("be verbose (print progress information)"),
682 0, &GNUNET_GETOPT_set_one, &verbose},
683 GNUNET_GETOPT_OPTION_END
686 GNUNET_FS_year_to_time (GNUNET_FS_get_current_year () + 2);
688 GNUNET_PROGRAM_run (argc, argv, "gnunet-publish [OPTIONS] FILENAME",
690 ("Publish a file or directory on GNUnet"),
691 options, &run, NULL)) ? ret : 1;
694 /* end of gnunet-publish.c */