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 plugin_name name of the plugin that generated the meta data
142 * @param type type of the meta data
143 * @param format format of data
144 * @param data_mime_type mime type of data
145 * @param data value of the meta data
146 * @param data_size number of bytes in data
150 meta_printer (void *cls,
151 const char *plugin_name,
152 enum EXTRACTOR_MetaType type,
153 enum EXTRACTOR_MetaFormat format,
154 const char *data_mime_type,
158 if ( (format != EXTRACTOR_METAFORMAT_UTF8) &&
159 (format != EXTRACTOR_METAFORMAT_C_STRING) )
161 if (type == EXTRACTOR_METATYPE_FILENAME)
165 EXTRACTOR_metatype_to_string (type),
172 * Merge metadata entries.
174 * @param cls closure, target metadata structure
175 * @param plugin_name name of the plugin that generated the meta data
176 * @param type type of the meta data
177 * @param format format of data
178 * @param data_mime_type mime type of data
179 * @param data value of the meta data
180 * @param data_size number of bytes in data
184 meta_merger (void *cls,
185 const char *plugin_name,
186 enum EXTRACTOR_MetaType type,
187 enum EXTRACTOR_MetaFormat format,
188 const char *data_mime_type,
192 struct GNUNET_CONTAINER_MetaData *m = cls;
194 GNUNET_CONTAINER_meta_data_insert (m,
206 * Function called on all entries before the
207 * publication. This is where we perform
208 * modifications to the default based on
209 * command-line options.
212 * @param fi the entry in the publish-structure
213 * @param length length of the file or directory
214 * @param m metadata for the file or directory (can be modified)
215 * @param uri pointer to the keywords that will be used for this entry (can be modified)
216 * @param anonymity pointer to selected anonymity level (can be modified)
217 * @param priority pointer to selected priority (can be modified)
218 * @param expirationTime pointer to selected expiration time (can be modified)
219 * @param client_info pointer to client context set upon creation (can be modified)
220 * @return GNUNET_OK to continue, GNUNET_NO to remove
221 * this entry from the directory, GNUNET_SYSERR
222 * to abort the iteration
225 publish_inspector (void *cls,
226 struct GNUNET_FS_FileInformation *fi,
228 struct GNUNET_CONTAINER_MetaData *m,
229 struct GNUNET_FS_Uri **uri,
230 unsigned int *anonymity,
231 unsigned int *priority,
232 struct GNUNET_TIME_Absolute *expirationTime,
237 struct GNUNET_FS_Uri *new_uri;
239 if (! do_disable_creation_time)
240 GNUNET_CONTAINER_meta_data_add_publication_date (meta);
241 if (NULL != topKeywords)
243 new_uri = GNUNET_FS_uri_ksk_merge (topKeywords,
245 GNUNET_FS_uri_destroy (*uri);
247 GNUNET_FS_uri_destroy (topKeywords);
252 GNUNET_CONTAINER_meta_data_iterate (meta,
255 GNUNET_CONTAINER_meta_data_destroy (meta);
260 fn = GNUNET_CONTAINER_meta_data_get_by_type (meta,
261 EXTRACTOR_METATYPE_FILENAME);
262 fs = GNUNET_STRINGS_byte_size_fancy (length);
264 _("Keywords for file `%s' (%s)\n"),
269 GNUNET_CONTAINER_meta_data_iterate (meta,
272 fprintf (stdout, "\n");
274 if (GNUNET_FS_meta_data_test_for_directory (meta))
275 GNUNET_FS_file_information_inspect (fi,
283 * Main function that will be run by the scheduler.
286 * @param sched the scheduler to use
287 * @param args remaining command-line arguments
288 * @param cfgfile name of the configuration file used (for saving, can be NULL!)
289 * @param c configuration
293 struct GNUNET_SCHEDULER_Handle *sched,
296 const struct GNUNET_CONFIGURATION_Handle *c)
298 struct GNUNET_FS_FileInformation *fi;
299 struct GNUNET_FS_Namespace *namespace;
300 struct EXTRACTOR_PluginList *l;
304 /* check arguments */
305 if ( ( (uri_string == NULL) || (extract_only) )
306 && ( (args[0] == NULL) || (args[1] != NULL) ) )
309 ("You must specify one and only one filename for insertion.\n"));
313 if ((uri_string != NULL) && (args[0] != NULL))
315 printf (_("You must NOT specify an URI and a filename.\n"));
319 if ((uri_string != NULL) && (extract_only))
321 printf (_("Cannot extract metadata from a URI!\n"));
325 if (pseudonym != NULL)
330 _("Option `%s' is required when using option `%s'.\n"),
337 { /* ordinary insertion checks */
341 _("Option `%s' makes no sense without option `%s'.\n"),
349 _("Option `%s' makes no sense without option `%s'.\n"),
358 _("Need the name of a file to publish!\n"));
363 ctx = GNUNET_FS_start (sched,
368 GNUNET_FS_FLAGS_NONE,
369 GNUNET_FS_OPTIONS_END);
373 _("Could not initialize `%s' subsystem.\n"),
379 if (NULL != pseudonym)
381 namespace = GNUNET_FS_namespace_create (ctx,
383 if (NULL == namespace)
386 _("Could not create namespace `%s'\n"),
388 GNUNET_FS_stop (ctx);
393 if (NULL != uri_string)
395 // FIXME -- implement!
400 if (! disable_extractor)
402 l = EXTRACTOR_plugin_add_defaults (EXTRACTOR_OPTION_DEFAULT_POLICY);
404 GNUNET_CONFIGURATION_get_value_string (cfg, "FS", "EXTRACTORS",
408 l = EXTRACTOR_plugin_add_config (l, ex, EXTRACTOR_OPTION_DEFAULT_POLICY);
412 fi = GNUNET_FS_file_information_create_from_directory (NULL,
414 &GNUNET_FS_directory_scanner_default,
419 GNUNET_TIME_relative_to_absolute (DEFAULT_EXPIRATION),
421 EXTRACTOR_plugin_remove_all (l);
425 _("Could not publish `%s': %s\n"),
429 if (namespace != NULL)
430 GNUNET_FS_namespace_delete (namespace, GNUNET_NO);
431 GNUNET_FS_stop (ctx);
435 GNUNET_FS_file_information_inspect (fi,
440 if (namespace != NULL)
441 GNUNET_FS_namespace_delete (namespace, GNUNET_NO);
442 GNUNET_FS_file_information_destroy (fi, NULL, NULL);
443 GNUNET_FS_stop (ctx);
446 pc = GNUNET_FS_publish_start (ctx,
452 ? GNUNET_FS_PUBLISH_OPTION_SIMULATE_ONLY
453 : GNUNET_FS_PUBLISH_OPTION_NONE);
457 _("Could not start publishing.\n"));
458 GNUNET_FS_stop (ctx);
466 * gnunet-publish command line options
468 static struct GNUNET_GETOPT_CommandLineOption options[] = {
469 {'a', "anonymity", "LEVEL",
470 gettext_noop ("set the desired LEVEL of sender-anonymity"),
471 1, &GNUNET_GETOPT_set_uint, &anonymity},
472 {'d', "disable-creation-time", NULL,
474 ("disable adding the creation time to the metadata of the uploaded file"),
475 0, &GNUNET_GETOPT_set_one, &do_disable_creation_time},
476 {'D', "disable-extractor", NULL,
478 ("do not use libextractor to add keywords or metadata"),
479 0, &GNUNET_GETOPT_set_one, &disable_extractor},
480 {'e', "extract", NULL,
482 ("print list of extracted keywords that would be used, but do not perform upload"),
483 0, &GNUNET_GETOPT_set_one, &extract_only},
484 {'k', "key", "KEYWORD",
486 ("add an additional keyword for the top-level file or directory"
487 " (this option can be specified multiple times)"),
488 1, &GNUNET_FS_getopt_set_keywords, &topKeywords},
489 // *: option not yet used... (can handle in a pass over FI)
490 {'m', "meta", "TYPE:VALUE",
491 gettext_noop ("set the meta-data for the given TYPE to the given VALUE"),
492 1, &GNUNET_FS_getopt_set_metadata, &meta},
493 {'n', "noindex", NULL,
494 gettext_noop ("do not index, perform full insertion (stores entire "
495 "file in encrypted form in GNUnet database)"),
496 0, &GNUNET_GETOPT_set_one, &do_insert},
499 ("specify ID of an updated version to be published in the future"
500 " (for namespace insertions only)"),
501 1, &GNUNET_GETOPT_set_string, &next_id},
502 {'p', "priority", "PRIORITY",
503 gettext_noop ("specify the priority of the content"),
504 1, &GNUNET_GETOPT_set_uint, &priority},
505 {'P', "pseudonym", "NAME",
507 ("publish the files under the pseudonym NAME (place file into namespace)"),
508 1, &GNUNET_GETOPT_set_string, &pseudonym},
509 // *: option not yet used... (need FS API support!)
510 {'s', "simulate-only", NULL,
511 gettext_noop ("only simulate the process but do not do any "
512 "actual publishing (useful to compute URIs)"),
513 0, &GNUNET_GETOPT_set_one, &do_simulate},
515 gettext_noop ("set the ID of this version of the publication"
516 " (for namespace insertions only)"),
517 1, &GNUNET_GETOPT_set_string, &this_id},
518 // *: option not yet used... (need FS API support!)
520 gettext_noop ("URI to be published (can be used instead of passing a "
521 "file to add keywords to the file with the respective URI)"),
522 1, &GNUNET_GETOPT_set_string, &uri_string},
523 {'V', "verbose", NULL,
524 gettext_noop ("be verbose (print progress information)"),
525 0, &GNUNET_GETOPT_set_one, &verbose},
526 GNUNET_GETOPT_OPTION_END
531 * The main function to publish content to GNUnet.
533 * @param argc number of arguments from the command line
534 * @param argv command line arguments
535 * @return 0 ok, 1 on error
538 main (int argc, char *const *argv)
541 GNUNET_PROGRAM_run (argc,
545 ("Publish files on GNUnet."),
546 options, &run, NULL)) ? ret : 1;
549 /* end of gnunet-publish.c */
551 ////////////////////////////////////////////////////////////////
555 * Print progess message.
558 printstatus (void *ctx, const GNUNET_FSUI_Event * event)
560 unsigned long long delta;
565 case GNUNET_FSUI_upload_progress:
571 now = GNUNET_get_time ();
572 delta = event->data.UploadProgress.eta - now;
573 if (event->data.UploadProgress.eta < now)
575 ret = GNUNET_get_time_interval_as_fancy_string (delta);
576 PRINTF (_("%16llu of %16llu bytes inserted "
577 "(estimating %6s to completion) - %s\n"),
578 event->data.UploadProgress.completed,
579 event->data.UploadProgress.total,
580 ret, event->data.UploadProgress.filename);
584 case GNUNET_FSUI_upload_completed:
587 delta = GNUNET_get_time () - start_time;
588 PRINTF (_("Upload of `%s' complete, "
589 "%llu bytes took %llu seconds (%8.3f KiB/s).\n"),
590 event->data.UploadCompleted.filename,
591 event->data.UploadCompleted.total,
592 delta / GNUNET_CRON_SECONDS,
595 : (double) (event->data.UploadCompleted.total
596 / 1024.0 * GNUNET_CRON_SECONDS / delta));
598 fstring = GNUNET_ECRS_uri_to_string (event->data.UploadCompleted.uri);
599 printf (_("File `%s' has URI: %s\n"),
600 event->data.UploadCompleted.filename, fstring);
601 GNUNET_free (fstring);
602 if (ul == event->data.UploadCompleted.uc.pos)
604 postProcess (event->data.UploadCompleted.uri);
606 GNUNET_shutdown_initiate ();
609 case GNUNET_FSUI_upload_aborted:
610 printf (_("\nUpload aborted.\n"));
612 GNUNET_shutdown_initiate ();
614 case GNUNET_FSUI_upload_error:
615 printf (_("\nError uploading file: %s"),
616 event->data.UploadError.message);
618 GNUNET_shutdown_initiate ();
620 case GNUNET_FSUI_upload_started:
621 case GNUNET_FSUI_upload_stopped:
624 printf (_("\nUnexpected event: %d\n"), event->type);
625 GNUNET_GE_BREAK (ectx, 0);
632 /* end of gnunet-publish.c */