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 * Stop the directory scanner (we had an error).
102 * @param tc scheduler context
105 stop_scanner_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
107 kill_task = GNUNET_SCHEDULER_NO_TASK;
108 GNUNET_FS_directory_scan_abort (ds);
110 if (namespace != NULL)
112 GNUNET_FS_namespace_delete (namespace, GNUNET_NO);
115 GNUNET_FS_stop (ctx);
122 * Called by FS client to give information about the progress of an
126 * @param info details about the event, specifying the event type
127 * and various bits about the event
128 * @return client-context (for the next progress call
129 * for this operation; should be set to NULL for
130 * SUSPEND and STOPPED events). The value returned
131 * will be passed to future callbacks in the respective
132 * field in the GNUNET_FS_ProgressInfo struct.
135 progress_cb (void *cls, const struct GNUNET_FS_ProgressInfo *info)
139 switch (info->status)
141 case GNUNET_FS_STATUS_PUBLISH_START:
143 case GNUNET_FS_STATUS_PUBLISH_PROGRESS:
146 s = GNUNET_STRINGS_relative_time_to_string (info->value.publish.eta);
147 FPRINTF (stdout, _("Publishing `%s' at %llu/%llu (%s remaining)\n"),
148 info->value.publish.filename,
149 (unsigned long long) info->value.publish.completed,
150 (unsigned long long) info->value.publish.size, s);
154 case GNUNET_FS_STATUS_PUBLISH_ERROR:
155 FPRINTF (stderr, _("Error publishing: %s.\n"),
156 info->value.publish.specifics.error.message);
157 if (kill_task != GNUNET_SCHEDULER_NO_TASK)
159 GNUNET_SCHEDULER_cancel (kill_task);
160 kill_task = GNUNET_SCHEDULER_NO_TASK;
162 kill_task = GNUNET_SCHEDULER_add_now (&do_stop_task, NULL);
164 case GNUNET_FS_STATUS_PUBLISH_COMPLETED:
165 FPRINTF (stdout, _("Publishing `%s' done.\n"),
166 info->value.publish.filename);
167 s = GNUNET_FS_uri_to_string (info->value.publish.specifics.
169 FPRINTF (stdout, _("URI is `%s'.\n"), s);
171 if (info->value.publish.pctx == NULL)
173 if (kill_task != GNUNET_SCHEDULER_NO_TASK)
175 GNUNET_SCHEDULER_cancel (kill_task);
176 kill_task = GNUNET_SCHEDULER_NO_TASK;
178 kill_task = GNUNET_SCHEDULER_add_now (&do_stop_task, NULL);
182 case GNUNET_FS_STATUS_PUBLISH_STOPPED:
183 GNUNET_break (NULL == pc);
185 case GNUNET_FS_STATUS_UNINDEX_PROGRESS:
187 case GNUNET_FS_STATUS_UNINDEX_COMPLETED:
188 FPRINTF (stderr, "%s", _("Cleanup after abort complete.\n"));
191 FPRINTF (stderr, _("Unexpected status: %d\n"), info->status);
194 return ""; /* non-null */
199 * Print metadata entries (except binary
200 * metadata and the filename).
203 * @param plugin_name name of the plugin that generated the meta data
204 * @param type type of the meta data
205 * @param format format of data
206 * @param data_mime_type mime type of data
207 * @param data value of the meta data
208 * @param data_size number of bytes in data
212 meta_printer (void *cls, const char *plugin_name, enum EXTRACTOR_MetaType type,
213 enum EXTRACTOR_MetaFormat format, const char *data_mime_type,
214 const char *data, size_t data_size)
216 if ((format != EXTRACTOR_METAFORMAT_UTF8) &&
217 (format != EXTRACTOR_METAFORMAT_C_STRING))
219 if (type == EXTRACTOR_METATYPE_GNUNET_ORIGINAL_FILENAME)
221 FPRINTF (stdout, "\t%s - %s\n", EXTRACTOR_metatype_to_string (type), data);
227 * Iterator printing keywords
230 * @param keyword the keyword
231 * @param is_mandatory is the keyword mandatory (in a search)
232 * @return GNUNET_OK to continue to iterate, GNUNET_SYSERR to abort
235 keyword_printer (void *cls, const char *keyword, int is_mandatory)
237 FPRINTF (stdout, "\t%s\n", keyword);
243 * Function called on all entries before the publication. This is
244 * where we perform modifications to the default based on command-line
248 * @param fi the entry in the publish-structure
249 * @param length length of the file or directory
250 * @param m metadata for the file or directory (can be modified)
251 * @param uri pointer to the keywords that will be used for this entry (can be modified)
252 * @param bo block options
253 * @param do_index should we index?
254 * @param client_info pointer to client context set upon creation (can be modified)
255 * @return GNUNET_OK to continue, GNUNET_NO to remove
256 * this entry from the directory, GNUNET_SYSERR
257 * to abort the iteration
260 publish_inspector (void *cls, struct GNUNET_FS_FileInformation *fi,
261 uint64_t length, struct GNUNET_CONTAINER_MetaData *m,
262 struct GNUNET_FS_Uri **uri,
263 struct GNUNET_FS_BlockOptions *bo, int *do_index,
268 struct GNUNET_FS_Uri *new_uri;
272 if (NULL != topKeywords)
276 new_uri = GNUNET_FS_uri_ksk_merge (topKeywords, *uri);
277 GNUNET_FS_uri_destroy (*uri);
279 GNUNET_FS_uri_destroy (topKeywords);
289 GNUNET_CONTAINER_meta_data_merge (m, meta);
290 GNUNET_CONTAINER_meta_data_destroy (meta);
293 if (!do_disable_creation_time)
294 GNUNET_CONTAINER_meta_data_add_publication_date (m);
295 if ( (disable_extractor) &&
298 GNUNET_FS_uri_destroy (*uri);
303 fn = GNUNET_CONTAINER_meta_data_get_by_type (m,
304 EXTRACTOR_METATYPE_GNUNET_ORIGINAL_FILENAME);
305 fs = GNUNET_STRINGS_byte_size_fancy (length);
306 FPRINTF (stdout, _("Meta data for file `%s' (%s)\n"), fn, fs);
307 GNUNET_CONTAINER_meta_data_iterate (m, &meta_printer, NULL);
308 FPRINTF (stdout, _("Keywords for file `%s' (%s)\n"), fn, fs);
312 GNUNET_FS_uri_ksk_get_keywords (*uri, &keyword_printer, NULL);
313 FPRINTF (stdout, "%s", "\n");
315 if (GNUNET_YES == GNUNET_FS_meta_data_test_for_directory (m))
316 GNUNET_FS_file_information_inspect (fi, &publish_inspector, fi);
325 uri_sks_continuation (void *cls, const struct GNUNET_FS_Uri *ksk_uri,
330 FPRINTF (stderr, "%s\n", emsg);
333 GNUNET_FS_uri_destroy (uri);
335 GNUNET_FS_stop (ctx);
344 uri_ksk_continuation (void *cls, const struct GNUNET_FS_Uri *ksk_uri,
347 struct GNUNET_FS_Namespace *ns;
351 FPRINTF (stderr, "%s\n", emsg);
354 if (pseudonym != NULL)
356 ns = GNUNET_FS_namespace_create (ctx, pseudonym);
359 FPRINTF (stderr, _("Failed to create namespace `%s' (illegal filename?)\n"), pseudonym);
364 GNUNET_FS_publish_sks (ctx, ns, this_id, next_id, meta, uri, &bo,
365 GNUNET_FS_PUBLISH_OPTION_NONE,
366 &uri_sks_continuation, NULL);
367 GNUNET_assert (GNUNET_OK == GNUNET_FS_namespace_delete (ns, GNUNET_NO));
371 GNUNET_FS_uri_destroy (uri);
373 GNUNET_FS_stop (ctx);
381 static struct GNUNET_FS_FileInformation *
382 get_file_information (struct GNUNET_FS_ShareTreeItem *item)
384 struct GNUNET_FS_FileInformation *fi;
385 struct GNUNET_FS_FileInformation *fic;
386 struct GNUNET_FS_ShareTreeItem *child;
388 if (item->is_directory == GNUNET_YES)
390 GNUNET_CONTAINER_meta_data_delete (item->meta,
391 EXTRACTOR_METATYPE_MIMETYPE, NULL, 0);
392 GNUNET_FS_meta_data_make_directory (item->meta);
393 if (NULL == item->ksk_uri)
395 const char *mime = GNUNET_FS_DIRECTORY_MIME;
396 item->ksk_uri = GNUNET_FS_uri_ksk_create_from_args (1, &mime);
399 GNUNET_FS_uri_ksk_add_keyword (item->ksk_uri, GNUNET_FS_DIRECTORY_MIME,
401 fi = GNUNET_FS_file_information_create_empty_directory (
402 ctx, NULL, item->ksk_uri,
403 item->meta, &bo, item->filename);
404 for (child = item->children_head; child; child = child->next)
406 fic = get_file_information (child);
407 GNUNET_break (GNUNET_OK == GNUNET_FS_file_information_add (fi, fic));
412 fi = GNUNET_FS_file_information_create_from_file (
413 ctx, NULL, item->filename,
414 item->ksk_uri, item->meta, !do_insert,
425 directory_trim_complete ()
427 struct GNUNET_FS_FileInformation *fi;
429 fi = get_file_information (directory_scan_result);
430 GNUNET_FS_share_tree_free (directory_scan_result);
431 directory_scan_result = NULL;
434 FPRINTF (stderr, "%s", _("Could not publish\n"));
435 if (namespace != NULL)
436 GNUNET_FS_namespace_delete (namespace, GNUNET_NO);
437 GNUNET_FS_stop (ctx);
441 GNUNET_FS_file_information_inspect (fi, &publish_inspector, NULL);
444 if (namespace != NULL)
445 GNUNET_FS_namespace_delete (namespace, GNUNET_NO);
446 GNUNET_FS_file_information_destroy (fi, NULL, NULL);
447 GNUNET_FS_stop (ctx);
448 if (kill_task != GNUNET_SCHEDULER_NO_TASK)
450 GNUNET_SCHEDULER_cancel (kill_task);
451 kill_task = GNUNET_SCHEDULER_NO_TASK;
455 pc = GNUNET_FS_publish_start (ctx, fi, namespace, this_id, next_id,
457 GNUNET_FS_PUBLISH_OPTION_SIMULATE_ONLY :
458 GNUNET_FS_PUBLISH_OPTION_NONE);
461 FPRINTF (stderr, "%s", _("Could not start publishing.\n"));
462 GNUNET_FS_stop (ctx);
470 * Function called by the directory scanner as we build the tree
471 * that we will need to publish later.
474 * @param filename which file we are making progress on
475 * @param is_directory GNUNET_YES if this is a directory,
476 * GNUNET_NO if this is a file
477 * GNUNET_SYSERR if it is neither (or unknown)
478 * @param reason kind of progress we are making
481 directory_scan_cb (void *cls,
482 const char *filename,
484 enum GNUNET_FS_DirScannerProgressUpdateReason reason)
488 case GNUNET_FS_DIRSCANNER_FILE_START:
491 if (is_directory == GNUNET_YES)
492 FPRINTF (stdout, _("Scanning directory `%s'.\n"), filename);
494 FPRINTF (stdout, _("Scanning file `%s'.\n"), filename);
497 case GNUNET_FS_DIRSCANNER_FILE_IGNORED:
499 _("There was trouble processing file `%s', skipping it.\n"),
502 case GNUNET_FS_DIRSCANNER_ALL_COUNTED:
504 FPRINTF (stdout, "%s", _("Preprocessing complete.\n"));
506 case GNUNET_FS_DIRSCANNER_EXTRACT_FINISHED:
508 FPRINTF (stdout, _("Extracting meta data from file `%s' complete.\n"), filename);
510 case GNUNET_FS_DIRSCANNER_FINISHED:
512 FPRINTF (stdout, "%s", _("Meta data extraction has finished.\n"));
513 directory_scan_result = GNUNET_FS_directory_scan_get_result (ds);
515 GNUNET_FS_share_tree_trim (directory_scan_result);
516 directory_trim_complete ();
518 case GNUNET_FS_DIRSCANNER_INTERNAL_ERROR:
519 FPRINTF (stdout, "%s", _("Internal error scanning directory.\n"));
520 if (kill_task != GNUNET_SCHEDULER_NO_TASK)
522 GNUNET_SCHEDULER_cancel (kill_task);
523 kill_task = GNUNET_SCHEDULER_NO_TASK;
525 kill_task = GNUNET_SCHEDULER_add_now (&stop_scanner_task, NULL);
536 * Main function that will be run by the scheduler.
539 * @param args remaining command-line arguments
540 * @param cfgfile name of the configuration file used (for saving, can be NULL!)
541 * @param c configuration
544 run (void *cls, char *const *args, const char *cfgfile,
545 const struct GNUNET_CONFIGURATION_Handle *c)
550 /* check arguments */
551 if ((uri_string != NULL) && (extract_only))
553 printf (_("Cannot extract metadata from a URI!\n"));
557 if (((uri_string == NULL) || (extract_only)) &&
558 ((args[0] == NULL) || (args[1] != NULL)))
560 printf (_("You must specify one and only one filename for insertion.\n"));
564 if ((uri_string != NULL) && (args[0] != NULL))
566 printf (_("You must NOT specify an URI and a filename.\n"));
570 if (pseudonym != NULL)
574 FPRINTF (stderr, _("Option `%s' is required when using option `%s'.\n"),
581 { /* ordinary insertion checks */
584 FPRINTF (stderr, _("Option `%s' makes no sense without option `%s'.\n"),
591 FPRINTF (stderr, _("Option `%s' makes no sense without option `%s'.\n"),
599 GNUNET_FS_start (cfg, "gnunet-publish", &progress_cb, NULL,
600 GNUNET_FS_FLAGS_NONE, GNUNET_FS_OPTIONS_END);
603 FPRINTF (stderr, _("Could not initialize `%s' subsystem.\n"), "FS");
608 if (NULL != pseudonym)
610 namespace = GNUNET_FS_namespace_create (ctx, pseudonym);
611 if (NULL == namespace)
613 FPRINTF (stderr, _("Failed to create namespace `%s' (illegal filename?)\n"), pseudonym);
614 GNUNET_FS_stop (ctx);
619 if (NULL != uri_string)
622 uri = GNUNET_FS_uri_parse (uri_string, &emsg);
625 FPRINTF (stderr, _("Failed to parse URI: %s\n"), emsg);
627 if (namespace != NULL)
628 GNUNET_FS_namespace_delete (namespace, GNUNET_NO);
629 GNUNET_FS_stop (ctx);
633 GNUNET_FS_publish_ksk (ctx, topKeywords, meta, uri, &bo,
634 GNUNET_FS_PUBLISH_OPTION_NONE, &uri_ksk_continuation,
636 if (namespace != NULL)
637 GNUNET_FS_namespace_delete (namespace, GNUNET_NO);
641 GNUNET_CONFIGURATION_get_value_string (cfg, "FS", "EXTRACTORS", &ex))
643 if (0 != ACCESS (args[0], R_OK))
646 _("Failed to access `%s': %s\n"),
651 ds = GNUNET_FS_directory_scan_start (args[0],
654 &directory_scan_cb, NULL);
658 "%s", _("Failed to start meta directory scanner. Is gnunet-helper-publish-fs installed?\n"));
662 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &do_stop_task,
668 * The main function to publish content to GNUnet.
670 * @param argc number of arguments from the command line
671 * @param argv command line arguments
672 * @return 0 ok, 1 on error
675 main (int argc, char *const *argv)
677 static const struct GNUNET_GETOPT_CommandLineOption options[] = {
678 {'a', "anonymity", "LEVEL",
679 gettext_noop ("set the desired LEVEL of sender-anonymity"),
680 1, &GNUNET_GETOPT_set_uint, &bo.anonymity_level},
681 {'d', "disable-creation-time", NULL,
683 ("disable adding the creation time to the metadata of the uploaded file"),
684 0, &GNUNET_GETOPT_set_one, &do_disable_creation_time},
685 {'D', "disable-extractor", NULL,
686 gettext_noop ("do not use libextractor to add keywords or metadata"),
687 0, &GNUNET_GETOPT_set_one, &disable_extractor},
688 {'e', "extract", NULL,
690 ("print list of extracted keywords that would be used, but do not perform upload"),
691 0, &GNUNET_GETOPT_set_one, &extract_only},
692 {'k', "key", "KEYWORD",
694 ("add an additional keyword for the top-level file or directory"
695 " (this option can be specified multiple times)"),
696 1, &GNUNET_FS_getopt_set_keywords, &topKeywords},
697 {'m', "meta", "TYPE:VALUE",
698 gettext_noop ("set the meta-data for the given TYPE to the given VALUE"),
699 1, &GNUNET_FS_getopt_set_metadata, &meta},
700 {'n', "noindex", NULL,
701 gettext_noop ("do not index, perform full insertion (stores entire "
702 "file in encrypted form in GNUnet database)"),
703 0, &GNUNET_GETOPT_set_one, &do_insert},
706 ("specify ID of an updated version to be published in the future"
707 " (for namespace insertions only)"),
708 1, &GNUNET_GETOPT_set_string, &next_id},
709 {'p', "priority", "PRIORITY",
710 gettext_noop ("specify the priority of the content"),
711 1, &GNUNET_GETOPT_set_uint, &bo.content_priority},
712 {'P', "pseudonym", "NAME",
714 ("publish the files under the pseudonym NAME (place file into namespace)"),
715 1, &GNUNET_GETOPT_set_string, &pseudonym},
716 {'r', "replication", "LEVEL",
717 gettext_noop ("set the desired replication LEVEL"),
718 1, &GNUNET_GETOPT_set_uint, &bo.replication_level},
719 {'s', "simulate-only", NULL,
720 gettext_noop ("only simulate the process but do not do any "
721 "actual publishing (useful to compute URIs)"),
722 0, &GNUNET_GETOPT_set_one, &do_simulate},
724 gettext_noop ("set the ID of this version of the publication"
725 " (for namespace insertions only)"),
726 1, &GNUNET_GETOPT_set_string, &this_id},
728 gettext_noop ("URI to be published (can be used instead of passing a "
729 "file to add keywords to the file with the respective URI)"),
730 1, &GNUNET_GETOPT_set_string, &uri_string},
731 {'V', "verbose", NULL,
732 gettext_noop ("be verbose (print progress information)"),
733 0, &GNUNET_GETOPT_set_one, &verbose},
734 GNUNET_GETOPT_OPTION_END
736 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
737 "GNUnet publish starts\n");
739 GNUNET_FS_year_to_time (GNUNET_FS_get_current_year () + 2);
741 if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
745 GNUNET_PROGRAM_run (argc, argv, "gnunet-publish [OPTIONS] FILENAME",
747 ("Publish a file or directory on GNUnet"),
748 options, &run, NULL)) ? ret : 1;
751 /* end of gnunet-publish.c */