gnunet-download.c File Reference

downloading for files on GNUnet More...

#include "platform.h"
#include "gnunet_fs_service.h"

Include dependency graph for gnunet-download.c:

Go to the source code of this file.

Functions
static void	cleanup_task (void *cls)
static void	shutdown_task (void *cls)
static void	display_bar (unsigned long long x, unsigned long long n, unsigned int w)
	Display progress bar (if tty). More...
static void *	progress_cb (void *cls, const struct GNUNET_FS_ProgressInfo *info)
	Called by FS client to give information about the progress of an operation. More...
static void	run (void *cls, char *const *args, const char *cfgfile, const struct GNUNET_CONFIGURATION_Handle *c)
	Main function that will be run by the scheduler. More...
int	main (int argc, char *const *argv)
	The main function to download GNUnet. More...

Variables
static int	ret
static unsigned int	verbose
static int	delete_incomplete
static const struct GNUNET_CONFIGURATION_Handle *	cfg
static struct GNUNET_FS_Handle *	ctx
static struct GNUNET_FS_DownloadContext *	dc
static unsigned int	anonymity = 1
static unsigned int	parallelism = 16
static unsigned int	request_parallelism = 4092
static int	do_recursive
static char *	filename
static int	local_only

Detailed Description

downloading for files on GNUnet

Author

Christian Grothoff

Krista Bennett

James Blackwell

Igor Wronsky

Definition in file gnunet-download.c.

Function Documentation

cleanup_task()

static void cleanup_task ( void *  cls )

static

Definition at line 58 of file gnunet-download.c.

{
  GNUNET_FS_stop (ctx);
  ctx = NULL;
}

References ctx, and GNUNET_FS_stop().

Referenced by progress_cb().

Here is the call graph for this function:

Here is the caller graph for this function:

shutdown_task()

static void shutdown_task ( void *  cls )

static

Definition at line 66 of file gnunet-download.c.

{
  if (NULL != dc)
  {
    GNUNET_FS_download_stop (dc, delete_incomplete);
    dc = NULL;
  }
}

References dc, delete_incomplete, and GNUNET_FS_download_stop().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

display_bar()

static void display_bar ( unsigned long long  x, unsigned long long  n, unsigned int  w  )

static

Display progress bar (if tty).

Parameters

x	current position in the download
n	total size of the download
w	desired number of steps in the progress bar

Definition at line 84 of file gnunet-download.c.

{
  char buf[w + 20];
  unsigned int p;
  unsigned int endeq;
  float ratio_complete;
 
  if (0 == isatty (1))
    return;
  ratio_complete = x / (float) n;
  endeq = ratio_complete * w;
  GNUNET_snprintf (buf, sizeof(buf), "%3d%% [", (int) (ratio_complete * 100));
  for (p = 0; p < endeq; p++)
    strcat (buf, "=");
  for (p = endeq; p < w; p++)
    strcat (buf, " ");
  strcat (buf, "]\r");
  printf ("%s", buf);
  fflush (stdout);
}

References buf, GNUNET_snprintf(), and p.

Referenced by progress_cb().

Here is the call graph for this function:

Here is the caller graph for this function:

progress_cb()

static void* progress_cb ( void *  cls, const struct GNUNET_FS_ProgressInfo *  info  )

static

Called by FS client to give information about the progress of an operation.

Parameters

cls	closure
info	details about the event, specifying the event type and various bits about the event

Returns

client-context (for the next progress call for this operation; should be set to NULL for SUSPEND and STOPPED events). The value returned will be passed to future callbacks in the respective field in the struct GNUNET_FS_ProgressInfo

Definition at line 120 of file gnunet-download.c.

{
  char *s;
  const char *s2;
  char *t;
 
  switch (info->status)
  {
  case GNUNET_FS_STATUS_DOWNLOAD_START:
    if (verbose > 1)
      fprintf (stderr,
               _ ("Starting download `%s'.\n"),
               info->value.download.filename);
    break;
 
  case GNUNET_FS_STATUS_DOWNLOAD_PROGRESS:
    if (verbose)
    {
      s = GNUNET_strdup (
        GNUNET_STRINGS_relative_time_to_string (info->value.download.eta,
                                                GNUNET_YES));
      if (info->value.download.specifics.progress.block_download_duration
          .rel_value_us == GNUNET_TIME_UNIT_FOREVER_REL.rel_value_us)
        s2 = _ ("<unknown time>");
      else
        s2 = GNUNET_STRINGS_relative_time_to_string (info->value.download
                                                     .specifics.progress
                                                     .block_download_duration,
                                                     GNUNET_YES);
      t = GNUNET_STRINGS_byte_size_fancy (
        info->value.download.completed * 1000LL
        / (info->value.download.duration.rel_value_us + 1));
      fprintf (
        stdout,
        _ (
          "Downloading `%s' at %llu/%llu (%s remaining, %s/s). Block took %s to download\n"),
        info->value.download.filename,
        (unsigned long long) info->value.download.completed,
        (unsigned long long) info->value.download.size,
        s,
        t,
        s2);
      GNUNET_free (s);
      GNUNET_free (t);
    }
    else
    {
      display_bar (info->value.download.completed,
                   info->value.download.size,
                   60);
    }
    break;
 
  case GNUNET_FS_STATUS_DOWNLOAD_ERROR:
    if (0 != isatty (1))
      fprintf (stdout, "\n");
    fprintf (stderr,
             _ ("Error downloading: %s.\n"),
             info->value.download.specifics.error.message);
    GNUNET_SCHEDULER_shutdown ();
    break;
 
  case GNUNET_FS_STATUS_DOWNLOAD_COMPLETED:
    s = GNUNET_STRINGS_byte_size_fancy (
      info->value.download.completed * 1000
      / (info->value.download.duration.rel_value_us + 1));
    if (0 != isatty (1))
      fprintf (stdout, "\n");
    fprintf (stdout,
             _ ("Downloading `%s' done (%s/s).\n"),
             info->value.download.filename,
             s);
    GNUNET_free (s);
    if (info->value.download.dc == dc)
      GNUNET_SCHEDULER_shutdown ();
    break;
 
  case GNUNET_FS_STATUS_DOWNLOAD_STOPPED:
    if (info->value.download.dc == dc)
      GNUNET_SCHEDULER_add_now (&cleanup_task, NULL);
    break;
 
  case GNUNET_FS_STATUS_DOWNLOAD_ACTIVE:
  case GNUNET_FS_STATUS_DOWNLOAD_INACTIVE:
    break;
 
  default:
    fprintf (stderr, _ ("Unexpected status: %d\n"), info->status);
    break;
  }
  return NULL;
}

References _, cleanup_task(), dc, display_bar(), GNUNET_free, GNUNET_FS_STATUS_DOWNLOAD_ACTIVE, GNUNET_FS_STATUS_DOWNLOAD_COMPLETED, GNUNET_FS_STATUS_DOWNLOAD_ERROR, GNUNET_FS_STATUS_DOWNLOAD_INACTIVE, GNUNET_FS_STATUS_DOWNLOAD_PROGRESS, GNUNET_FS_STATUS_DOWNLOAD_START, GNUNET_FS_STATUS_DOWNLOAD_STOPPED, GNUNET_SCHEDULER_add_now(), GNUNET_SCHEDULER_shutdown(), GNUNET_strdup, GNUNET_STRINGS_byte_size_fancy(), GNUNET_STRINGS_relative_time_to_string(), GNUNET_TIME_UNIT_FOREVER_REL, GNUNET_YES, info, t, and verbose.

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

run()

static void run ( void *  cls, char *const *  args, const char *  cfgfile, const struct GNUNET_CONFIGURATION_Handle *  c  )

static

Main function that will be run by the scheduler.

Parameters

cls	closure
args	remaining command-line arguments
cfgfile	name of the configuration file used (for saving, can be NULL!)
c	configuration

Definition at line 223 of file gnunet-download.c.

{
  struct GNUNET_FS_Uri *uri;
  char *emsg;
  enum GNUNET_FS_DownloadOptions options;
 
  if (NULL == args[0])
  {
    fprintf (stderr, "%s", _ ("You need to specify a URI argument.\n"));
    return;
  }
  uri = GNUNET_FS_uri_parse (args[0], &emsg);
  if (NULL == uri)
  {
    fprintf (stderr, _ ("Failed to parse URI: %s\n"), emsg);
    GNUNET_free (emsg);
    ret = 1;
    return;
  }
  if ((! GNUNET_FS_uri_test_chk (uri)) && (! GNUNET_FS_uri_test_loc (uri)))
  {
    fprintf (stderr, "%s", _ ("Only CHK or LOC URIs supported.\n"));
    ret = 1;
    GNUNET_FS_uri_destroy (uri);
    return;
  }
  if (NULL == filename)
  {
    fprintf (stderr, "%s", _ ("Target filename must be specified.\n"));
    ret = 1;
    GNUNET_FS_uri_destroy (uri);
    return;
  }
  cfg = c;
  ctx = GNUNET_FS_start (cfg,
                         "gnunet-download",
                         &progress_cb,
                         NULL,
                         GNUNET_FS_FLAGS_NONE,
                         GNUNET_FS_OPTIONS_DOWNLOAD_PARALLELISM,
                         parallelism,
                         GNUNET_FS_OPTIONS_REQUEST_PARALLELISM,
                         request_parallelism,
                         GNUNET_FS_OPTIONS_END);
  if (NULL == ctx)
  {
    fprintf (stderr, _ ("Could not initialize `%s' subsystem.\n"), "FS");
    GNUNET_FS_uri_destroy (uri);
    ret = 1;
    return;
  }
  options = GNUNET_FS_DOWNLOAD_OPTION_NONE;
  if (do_recursive)
    options |= GNUNET_FS_DOWNLOAD_OPTION_RECURSIVE;
  if (local_only)
    options |= GNUNET_FS_DOWNLOAD_OPTION_LOOPBACK_ONLY;
  dc = GNUNET_FS_download_start (ctx,
                                 uri,
                                 NULL,
                                 filename,
                                 NULL,
                                 0,
                                 GNUNET_FS_uri_chk_get_file_size (uri),
                                 anonymity,
                                 options,
                                 NULL,
                                 NULL);
  GNUNET_FS_uri_destroy (uri);
  if (dc == NULL)
  {
    GNUNET_FS_stop (ctx);
    ctx = NULL;
    return;
  }
  GNUNET_SCHEDULER_add_shutdown (&shutdown_task, NULL);
}

References _, anonymity, consensus-simulation::args, cfg, ctx, dc, do_recursive, filename, GNUNET_free, GNUNET_FS_DOWNLOAD_OPTION_LOOPBACK_ONLY, GNUNET_FS_DOWNLOAD_OPTION_NONE, GNUNET_FS_DOWNLOAD_OPTION_RECURSIVE, GNUNET_FS_download_start(), GNUNET_FS_FLAGS_NONE, GNUNET_FS_OPTIONS_DOWNLOAD_PARALLELISM, GNUNET_FS_OPTIONS_END, GNUNET_FS_OPTIONS_REQUEST_PARALLELISM, GNUNET_FS_start(), GNUNET_FS_stop(), GNUNET_FS_uri_chk_get_file_size(), GNUNET_FS_uri_destroy(), GNUNET_FS_uri_parse(), GNUNET_FS_uri_test_chk(), GNUNET_FS_uri_test_loc(), GNUNET_SCHEDULER_add_shutdown(), local_only, options, parallelism, progress_cb(), request_parallelism, ret, shutdown_task(), and uri.

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

main()

int main	(	int	argc,
		char *const *	argv
	)

The main function to download GNUnet.

Parameters

argc	number of arguments from the command line
argv	command line arguments

Returns

0 ok, 1 on error

Definition at line 312 of file gnunet-download.c.

{
  struct GNUNET_GETOPT_CommandLineOption options[] =
  { GNUNET_GETOPT_option_uint ('a',
                               "anonymity",
                               "LEVEL",
                               gettext_noop (
                                 "set the desired LEVEL of receiver-anonymity"),
                               &anonymity),
 
    GNUNET_GETOPT_option_flag (
      'D',
      "delete-incomplete",
      gettext_noop ("delete incomplete downloads (when aborted with CTRL-C)"),
      &delete_incomplete),
 
    GNUNET_GETOPT_option_flag (
      'n',
      "no-network",
      gettext_noop ("only search the local peer (no P2P network search)"),
      &local_only),
    GNUNET_GETOPT_option_string ('o',
                                 "output",
                                 "FILENAME",
                                 gettext_noop ("write the file to FILENAME"),
                                 &filename),
    GNUNET_GETOPT_option_uint (
      'p',
      "parallelism",
      "DOWNLOADS",
      gettext_noop (
        "set the maximum number of parallel downloads that is allowed"),
      &parallelism),
    GNUNET_GETOPT_option_uint (
      'r',
      "request-parallelism",
      "REQUESTS",
      gettext_noop (
        "set the maximum number of parallel requests for blocks that is allowed"),
      &request_parallelism),
    GNUNET_GETOPT_option_flag ('R',
                               "recursive",
                               gettext_noop (
                                 "download a GNUnet directory recursively"),
                               &do_recursive),
    GNUNET_GETOPT_option_increment_uint (
      'V',
      "verbose",
      gettext_noop ("be verbose (print progress information)"),
      &verbose),
    GNUNET_GETOPT_OPTION_END };
 
  if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
    return 2;
 
  ret =
    (GNUNET_OK ==
     GNUNET_PROGRAM_run (
       argc,
       argv,
       "gnunet-download [OPTIONS] URI",
       gettext_noop (
         "Download files from GNUnet using a GNUnet CHK or LOC URI (gnunet://fs/chk/...)"),
       options,
       &run,
       NULL))
    ? ret
    : 1;
  GNUNET_free_nz ((void *) argv);
  return ret;
}

References anonymity, delete_incomplete, do_recursive, filename, gettext_noop, GNUNET_free_nz, GNUNET_GETOPT_OPTION_END, GNUNET_GETOPT_option_flag(), GNUNET_GETOPT_option_increment_uint(), GNUNET_GETOPT_option_string(), GNUNET_GETOPT_option_uint(), GNUNET_OK, GNUNET_PROGRAM_run(), GNUNET_STRINGS_get_utf8_args(), local_only, options, parallelism, request_parallelism, ret, run(), and verbose.

Here is the call graph for this function:

Variable Documentation

ret

int ret

static

Definition at line 32 of file gnunet-download.c.

Referenced by main(), and run().

verbose

unsigned int verbose

static

Definition at line 34 of file gnunet-download.c.

Referenced by main(), and progress_cb().

delete_incomplete

int delete_incomplete

static

Definition at line 36 of file gnunet-download.c.

Referenced by main(), and shutdown_task().

cfg

const struct GNUNET_CONFIGURATION_Handle* cfg

static

Definition at line 38 of file gnunet-download.c.

Referenced by run().

ctx

struct GNUNET_FS_Handle* ctx

static

Definition at line 40 of file gnunet-download.c.

Referenced by cleanup_task(), and run().

dc

struct GNUNET_FS_DownloadContext* dc

static

Definition at line 42 of file gnunet-download.c.

Referenced by activate_fs_download(), check_completed(), create_download_context(), deactivate_fs_download(), delta_match(), deserialize_download(), discard_oldest_mc(), do_reconnect(), download_mq_error_handler(), encrypt_existing_match(), fh_reader(), fragment_msg_proc(), free_download_context(), full_recursive_download(), get_download_sync_filename(), get_next_block(), GNUNET_CRYPTO_ecdsa_private_key_derive(), GNUNET_CRYPTO_eddsa_private_key_derive(), GNUNET_DEFRAGMENT_context_create(), GNUNET_DEFRAGMENT_context_destroy(), GNUNET_FS_download_make_status_(), GNUNET_FS_download_resume(), GNUNET_FS_download_signal_suspend_(), GNUNET_FS_download_start(), GNUNET_FS_download_start_downloading_(), GNUNET_FS_download_start_from_search(), GNUNET_FS_download_start_task_(), GNUNET_FS_download_suspend(), GNUNET_FS_download_sync_(), GNUNET_HELLO_iterate_new_addresses(), handle_put(), handle_verify_result(), is_recursive_download(), match_full_data(), process_result_with_request(), progress_cb(), reconstruct_cb(), reconstruct_cont(), retry_entry(), run(), schedule_block_download(), send_ack(), shutdown_task(), signal_download_resume(), trigger_recursive_download(), try_match_block(), try_reconnect(), and try_top_down_reconstruction().

anonymity

unsigned int anonymity = 1

static

Definition at line 44 of file gnunet-download.c.

Referenced by create_download_context(), execute_get(), get_cb(), GNUNET_DATASTORE_put(), GNUNET_FS_download_start(), GNUNET_FS_download_start_from_search(), GNUNET_FS_handle_on_demand_block(), GNUNET_FS_probe(), GNUNET_FS_search_start(), GNUNET_FS_TEST_download(), GNUNET_FS_TEST_publish(), handle_datastore_reply(), heap_plugin_put(), main(), postgres_plugin_put(), process_local_reply(), process_migration_content(), process_result(), repl_proc(), run(), search_start(), sqlite_plugin_put(), and transmit_item().

parallelism

unsigned int parallelism = 16

static

Definition at line 46 of file gnunet-download.c.

Referenced by adapt_parallelism(), main(), and run().

request_parallelism

unsigned int request_parallelism = 4092

static

Definition at line 48 of file gnunet-download.c.

Referenced by main(), and run().

do_recursive

int do_recursive

static

Definition at line 50 of file gnunet-download.c.

Referenced by main(), and run().

filename

char* filename

static

Definition at line 52 of file gnunet-download.c.

Referenced by add_file(), callback_scan_for_members(), callback_scan_for_operations(), callback_scan_for_rooms(), callback_scan_for_sessions(), check_index_info(), create_download_context(), database_setup(), deserialize_download_file(), deserialize_fi_node(), deserialize_file_information(), deserialize_publish_file(), deserialize_search_file(), deserialize_search_result(), deserialize_subdownload(), deserialize_unindex_file(), determine_id(), directory_scan_cb(), expand_tree(), extract_filename(), file_name_cb(), find_libraries(), gen_topo_from_file(), get_ego_filename(), GNUNET_ATS_solver_logging_write_to_disk(), GNUNET_ATS_solvers_experimentation_load(), GNUNET_CONTAINER_bloomfilter_load(), GNUNET_CRYPTO_hash_file(), GNUNET_FS_add_to_index(), GNUNET_FS_directory_list_contents(), GNUNET_FS_directory_scan_start(), GNUNET_FS_download_start(), GNUNET_FS_download_start_from_search(), GNUNET_FS_file_information_create_empty_directory(), GNUNET_FS_file_information_create_from_file(), GNUNET_FS_file_information_set_filename(), GNUNET_FS_make_file_reader_context_(), GNUNET_FS_remove_sync_file_(), GNUNET_FS_unindex_start(), GNUNET_FS_uri_ksk_create_from_meta_data(), GNUNET_HOSTLIST_client_start(), GNUNET_OS_process_status(), GNUNET_OS_start_process(), GNUNET_OS_start_process_v(), GNUNET_OS_start_process_va(), GNUNET_OS_start_process_vap(), GNUNET_STRINGS_get_short_name(), GNUNET_TESTBED_hosts_load_from_file(), GNUNET_TESTBED_overlay_configure_topology_va(), GNUNET_TESTBED_underlay_construct_(), GNUNET_TESTING_get_topo_from_file(), GNUNET_TRANSPORT_TESTING_get_config_name(), GNUNET_TRANSPORT_TESTING_get_test_name(), GNUNET_TRANSPORT_TESTING_get_test_plugin_name(), GNUNET_TRANSPORT_TESTING_main_(), GNUNET_xgrow_(), GNUNET_xmalloc_(), GNUNET_xmalloc_unchecked_(), GNUNET_xmemdup_(), GNUNET_xnew_array_2d_(), GNUNET_xnew_array_3d_(), GNUNET_xrealloc_(), GNUNET_xstrdup_(), GNUNET_xstrndup_(), handle_index_info(), hosts_directory_scan_callback(), iface_proc(), iter_check_config(), iter_testbed_path(), iterate_save_rooms(), load_file(), load_hostlist_file(), load_message_store(), load_message_store_entries(), load_message_store_links(), load_search_strings(), main(), policy_filename_cb(), preprocess_file(), print_indexed(), print_key(), print_search_result(), process_ego_file(), process_helper_msgs(), progress_cb(), read_from_file(), read_jwk_from_file(), REGEX_TEST_automaton_save_graph(), REGEX_TEST_read_from_file(), remove_sync_file_in_dir(), run(), run_process_and_wait(), save_hostlist_file(), save_message_store(), scan(), scan_callback(), start_process(), trigger_recursive_download(), and write_jwk_to_file().

local_only

int local_only

static

Definition at line 54 of file gnunet-download.c.

Referenced by main(), and run().