2 This file is part of GNUnet.
3 (C) 2001, 2002, 2004, 2005, 2006, 2007, 2009 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 2, 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 * - support for some options is still missing (uri argument)
32 #include "gnunet_fs_service.h"
34 #define DEFAULT_EXPIRATION GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_YEARS, 2)
40 static const struct GNUNET_CONFIGURATION_Handle *cfg;
42 static struct GNUNET_FS_Handle *ctx;
44 static struct GNUNET_FS_PublishContext *pc;
46 static struct GNUNET_CONTAINER_MetaData *meta;
48 static struct GNUNET_FS_Uri *topKeywords;
50 static unsigned int anonymity = 1;
52 static unsigned int priority = 365;
54 static char *uri_string;
60 static char *pseudonym;
64 static int disable_extractor;
66 static int do_simulate;
68 static int extract_only;
70 static int do_disable_creation_time;
74 * Called by FS client to give information about the progress of an
78 * @param info details about the event, specifying the event type
79 * and various bits about the event
80 * @return client-context (for the next progress call
81 * for this operation; should be set to NULL for
82 * SUSPEND and STOPPED events). The value returned
83 * will be passed to future callbacks in the respective
84 * field in the GNUNET_FS_ProgressInfo struct.
87 progress_cb (void *cls,
88 const struct GNUNET_FS_ProgressInfo *info)
94 case GNUNET_FS_STATUS_PUBLISH_START:
96 case GNUNET_FS_STATUS_PUBLISH_PROGRESS:
99 s = GNUNET_STRINGS_relative_time_to_string(info->value.publish.eta);
101 _("Publishing `%s' at %llu/%llu (%s remaining)\n"),
102 info->value.publish.filename,
103 (unsigned long long) info->value.publish.completed,
104 (unsigned long long) info->value.publish.size,
109 case GNUNET_FS_STATUS_PUBLISH_ERROR:
111 _("Error publishing: %s.\n"),
112 info->value.publish.specifics.error.message);
113 GNUNET_FS_publish_stop (pc);
115 case GNUNET_FS_STATUS_PUBLISH_COMPLETED:
117 _("Publishing `%s' done.\n"),
118 info->value.publish.filename);
119 if (info->value.publish.pctx == NULL)
120 GNUNET_FS_publish_stop (pc);
122 case GNUNET_FS_STATUS_PUBLISH_STOPPED:
123 if (info->value.publish.sc == pc)
124 GNUNET_FS_stop (ctx);
128 _("Unexpected status: %d\n"),
132 return ""; /* non-null */
137 * Print metadata entries (except binary
138 * metadata and the filename).
141 * @param type type of the meta data
142 * @param data value of the meta data
143 * @return GNUNET_OK to continue to iterate, GNUNET_SYSERR to abort
146 meta_printer (void *cls,
147 EXTRACTOR_KeywordType type,
150 if ( (type == EXTRACTOR_FILENAME) ||
151 (EXTRACTOR_isBinaryType (type)) )
155 EXTRACTOR_getKeywordTypeAsString (type),
162 * Merge metadata entries (except binary
165 * @param cls closure, target metadata structure
166 * @param type type of the meta data
167 * @param data value of the meta data
168 * @return GNUNET_OK to continue to iterate, GNUNET_SYSERR to abort
171 meta_merger (void *cls,
172 EXTRACTOR_KeywordType type,
175 struct GNUNET_CONTAINER_MetaData *m = cls;
176 GNUNET_CONTAINER_meta_data_insert (m,
184 * Function called on all entries before the
185 * publication. This is where we perform
186 * modifications to the default based on
187 * command-line options.
190 * @param fi the entry in the publish-structure
191 * @param length length of the file or directory
192 * @param m metadata for the file or directory (can be modified)
193 * @param uri pointer to the keywords that will be used for this entry (can be modified)
194 * @param anonymity pointer to selected anonymity level (can be modified)
195 * @param priority pointer to selected priority (can be modified)
196 * @param expirationTime pointer to selected expiration time (can be modified)
197 * @param client_info pointer to client context set upon creation (can be modified)
198 * @return GNUNET_OK to continue, GNUNET_NO to remove
199 * this entry from the directory, GNUNET_SYSERR
200 * to abort the iteration
203 publish_inspector (void *cls,
204 struct GNUNET_FS_FileInformation *fi,
206 struct GNUNET_CONTAINER_MetaData *m,
207 struct GNUNET_FS_Uri **uri,
208 unsigned int *anonymity,
209 unsigned int *priority,
210 struct GNUNET_TIME_Absolute *expirationTime,
215 struct GNUNET_FS_Uri *new_uri;
217 if (! do_disable_creation_time)
218 GNUNET_CONTAINER_meta_data_add_publication_date (meta);
219 if (NULL != topKeywords)
221 new_uri = GNUNET_FS_uri_ksk_merge (topKeywords,
223 GNUNET_FS_uri_destroy (*uri);
225 GNUNET_FS_uri_destroy (topKeywords);
230 GNUNET_CONTAINER_meta_data_get_contents (meta,
233 GNUNET_CONTAINER_meta_data_destroy (meta);
238 fn = GNUNET_CONTAINER_meta_data_get_by_type (meta,
240 fs = GNUNET_STRINGS_byte_size_fancy (length);
242 _("Keywords for file `%s' (%s)\n"),
247 GNUNET_CONTAINER_meta_data_get_contents (meta,
250 fprintf (stdout, "\n");
252 if (GNUNET_FS_meta_data_test_for_directory (meta))
253 GNUNET_FS_file_information_inspect (fi,
261 * Main function that will be run by the scheduler.
264 * @param sched the scheduler to use
265 * @param args remaining command-line arguments
266 * @param cfgfile name of the configuration file used (for saving, can be NULL!)
267 * @param c configuration
271 struct GNUNET_SCHEDULER_Handle *sched,
274 const struct GNUNET_CONFIGURATION_Handle *c)
276 struct GNUNET_FS_FileInformation *fi;
277 struct GNUNET_FS_Namespace *namespace;
278 EXTRACTOR_ExtractorList *l;
282 /* check arguments */
283 if ( ( (uri_string == NULL) || (extract_only) )
284 && ( (args[0] == NULL) || (args[1] != NULL) ) )
287 ("You must specify one and only one filename for insertion.\n"));
291 if ((uri_string != NULL) && (args[0] != NULL))
293 printf (_("You must NOT specify an URI and a filename.\n"));
297 if ((uri_string != NULL) && (extract_only))
299 printf (_("Cannot extract metadata from a URI!\n"));
303 if (pseudonym != NULL)
308 _("Option `%s' is required when using option `%s'.\n"),
315 { /* ordinary insertion checks */
319 _("Option `%s' makes no sense without option `%s'.\n"),
327 _("Option `%s' makes no sense without option `%s'.\n"),
336 _("Need the name of a file to publish!\n"));
341 ctx = GNUNET_FS_start (sched,
346 GNUNET_FS_FLAGS_NONE,
347 GNUNET_FS_OPTIONS_END);
351 _("Could not initialize `%s' subsystem.\n"),
357 if (NULL != pseudonym)
359 namespace = GNUNET_FS_namespace_create (ctx,
361 if (NULL == namespace)
364 _("Could not create namespace `%s'\n"),
366 GNUNET_FS_stop (ctx);
371 if (NULL != uri_string)
373 // FIXME -- implement!
378 if (! disable_extractor)
380 l = EXTRACTOR_loadDefaultLibraries ();
382 GNUNET_CONFIGURATION_get_value_string (cfg, "FS", "EXTRACTORS",
386 l = EXTRACTOR_loadConfigLibraries (l, ex);
390 fi = GNUNET_FS_file_information_create_from_directory (NULL,
392 &GNUNET_FS_directory_scanner_default,
397 GNUNET_TIME_relative_to_absolute (DEFAULT_EXPIRATION),
399 EXTRACTOR_removeAll (l);
403 _("Could not publish `%s': %s\n"),
407 if (namespace != NULL)
408 GNUNET_FS_namespace_delete (namespace, GNUNET_NO);
409 GNUNET_FS_stop (ctx);
413 GNUNET_FS_file_information_inspect (fi,
418 if (namespace != NULL)
419 GNUNET_FS_namespace_delete (namespace, GNUNET_NO);
420 GNUNET_FS_file_information_destroy (fi, NULL, NULL);
421 GNUNET_FS_stop (ctx);
424 pc = GNUNET_FS_publish_start (ctx,
430 ? GNUNET_FS_PUBLISH_OPTION_SIMULATE_ONLY
431 : GNUNET_FS_PUBLISH_OPTION_NONE);
435 _("Could not start publishing.\n"));
436 GNUNET_FS_stop (ctx);
444 * gnunet-publish command line options
446 static struct GNUNET_GETOPT_CommandLineOption options[] = {
447 {'a', "anonymity", "LEVEL",
448 gettext_noop ("set the desired LEVEL of sender-anonymity"),
449 1, &GNUNET_GETOPT_set_uint, &anonymity},
450 {'d', "disable-creation-time", NULL,
452 ("disable adding the creation time to the metadata of the uploaded file"),
453 0, &GNUNET_GETOPT_set_one, &do_disable_creation_time},
454 {'D', "disable-extractor", NULL,
456 ("do not use libextractor to add keywords or metadata"),
457 0, &GNUNET_GETOPT_set_one, &disable_extractor},
458 {'e', "extract", NULL,
460 ("print list of extracted keywords that would be used, but do not perform upload"),
461 0, &GNUNET_GETOPT_set_one, &extract_only},
462 {'k', "key", "KEYWORD",
464 ("add an additional keyword for the top-level file or directory"
465 " (this option can be specified multiple times)"),
466 1, &GNUNET_FS_getopt_set_keywords, &topKeywords},
467 // *: option not yet used... (can handle in a pass over FI)
468 {'m', "meta", "TYPE:VALUE",
469 gettext_noop ("set the meta-data for the given TYPE to the given VALUE"),
470 1, &GNUNET_FS_getopt_set_metadata, &meta},
471 {'n', "noindex", NULL,
472 gettext_noop ("do not index, perform full insertion (stores entire "
473 "file in encrypted form in GNUnet database)"),
474 0, &GNUNET_GETOPT_set_one, &do_insert},
477 ("specify ID of an updated version to be published in the future"
478 " (for namespace insertions only)"),
479 1, &GNUNET_GETOPT_set_string, &next_id},
480 {'p', "priority", "PRIORITY",
481 gettext_noop ("specify the priority of the content"),
482 1, &GNUNET_GETOPT_set_uint, &priority},
483 {'P', "pseudonym", "NAME",
485 ("publish the files under the pseudonym NAME (place file into namespace)"),
486 1, &GNUNET_GETOPT_set_string, &pseudonym},
487 // *: option not yet used... (need FS API support!)
488 {'s', "simulate-only", NULL,
489 gettext_noop ("only simulate the process but do not do any "
490 "actual publishing (useful to compute URIs)"),
491 0, &GNUNET_GETOPT_set_one, &do_simulate},
493 gettext_noop ("set the ID of this version of the publication"
494 " (for namespace insertions only)"),
495 1, &GNUNET_GETOPT_set_string, &this_id},
496 // *: option not yet used... (need FS API support!)
498 gettext_noop ("URI to be published (can be used instead of passing a "
499 "file to add keywords to the file with the respective URI)"),
500 1, &GNUNET_GETOPT_set_string, &uri_string},
501 {'V', "verbose", NULL,
502 gettext_noop ("be verbose (print progress information)"),
503 0, &GNUNET_GETOPT_set_one, &verbose},
504 GNUNET_GETOPT_OPTION_END
509 * The main function to publish content to GNUnet.
511 * @param argc number of arguments from the command line
512 * @param argv command line arguments
513 * @return 0 ok, 1 on error
516 main (int argc, char *const *argv)
519 GNUNET_PROGRAM_run (argc,
523 ("Publish files on GNUnet."),
524 options, &run, NULL)) ? ret : 1;
527 /* end of gnunet-publish.c */
529 ////////////////////////////////////////////////////////////////
533 * Print progess message.
536 printstatus (void *ctx, const GNUNET_FSUI_Event * event)
538 unsigned long long delta;
543 case GNUNET_FSUI_upload_progress:
549 now = GNUNET_get_time ();
550 delta = event->data.UploadProgress.eta - now;
551 if (event->data.UploadProgress.eta < now)
553 ret = GNUNET_get_time_interval_as_fancy_string (delta);
554 PRINTF (_("%16llu of %16llu bytes inserted "
555 "(estimating %6s to completion) - %s\n"),
556 event->data.UploadProgress.completed,
557 event->data.UploadProgress.total,
558 ret, event->data.UploadProgress.filename);
562 case GNUNET_FSUI_upload_completed:
565 delta = GNUNET_get_time () - start_time;
566 PRINTF (_("Upload of `%s' complete, "
567 "%llu bytes took %llu seconds (%8.3f KiB/s).\n"),
568 event->data.UploadCompleted.filename,
569 event->data.UploadCompleted.total,
570 delta / GNUNET_CRON_SECONDS,
573 : (double) (event->data.UploadCompleted.total
574 / 1024.0 * GNUNET_CRON_SECONDS / delta));
576 fstring = GNUNET_ECRS_uri_to_string (event->data.UploadCompleted.uri);
577 printf (_("File `%s' has URI: %s\n"),
578 event->data.UploadCompleted.filename, fstring);
579 GNUNET_free (fstring);
580 if (ul == event->data.UploadCompleted.uc.pos)
582 postProcess (event->data.UploadCompleted.uri);
584 GNUNET_shutdown_initiate ();
587 case GNUNET_FSUI_upload_aborted:
588 printf (_("\nUpload aborted.\n"));
590 GNUNET_shutdown_initiate ();
592 case GNUNET_FSUI_upload_error:
593 printf (_("\nError uploading file: %s"),
594 event->data.UploadError.message);
596 GNUNET_shutdown_initiate ();
598 case GNUNET_FSUI_upload_started:
599 case GNUNET_FSUI_upload_stopped:
602 printf (_("\nUnexpected event: %d\n"), event->type);
603 GNUNET_GE_BREAK (ectx, 0);
610 /* end of gnunet-publish.c */