GNUnet  0.11.x
Functions | Variables
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_Handlecfg
 
static struct GNUNET_FS_Handlectx
 
static struct GNUNET_FS_DownloadContextdc
 
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 57 of file gnunet-download.c.

References GNUNET_FS_stop().

Referenced by progress_cb().

58 {
60  ctx = NULL;
61 }
static struct GNUNET_FS_Handle * ctx
void GNUNET_FS_stop(struct GNUNET_FS_Handle *h)
Close our connection with the file-sharing service.
Definition: fs_api.c:3216
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 65 of file gnunet-download.c.

References delete_incomplete, and GNUNET_FS_download_stop().

Referenced by run().

66 {
67  if (NULL != dc)
68  {
70  dc = NULL;
71  }
72 }
void GNUNET_FS_download_stop(struct GNUNET_FS_DownloadContext *dc, int do_delete)
Stop a download (aborts if download is incomplete).
Definition: fs_download.c:2333
static int delete_incomplete
static struct GNUNET_FS_DownloadContext * dc
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
xcurrent position in the download
ntotal size of the download
wdesired number of steps in the progress bar

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

References buf, GNUNET_snprintf(), and p.

Referenced by progress_cb().

84 {
85  char buf[w + 20];
86  unsigned int p;
87  unsigned int endeq;
88  float ratio_complete;
89 
90  if (0 == isatty (1))
91  return;
92  ratio_complete = x / (float) n;
93  endeq = ratio_complete * w;
94  GNUNET_snprintf (buf, sizeof(buf), "%3d%% [", (int) (ratio_complete * 100));
95  for (p = 0; p < endeq; p++)
96  strcat (buf, "=");
97  for (p = endeq; p < w; p++)
98  strcat (buf, " ");
99  strcat (buf, "]\r");
100  printf ("%s", buf);
101  fflush (stdout);
102 }
int GNUNET_snprintf(char *buf, size_t size, const char *format,...)
Like snprintf, just aborts if the buffer is of insufficient size.
static struct GNUNET_OS_Process * p
Helper process we started.
Definition: gnunet-qr.c:59
static char buf[2048]
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
clsclosure
infodetails 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 119 of file gnunet-download.c.

References _, cleanup_task(), display_bar(), GNUNET_FS_ProgressInfo::download, 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, GNUNET_FS_ProgressInfo::status, t, GNUNET_FS_ProgressInfo::value, and verbose.

Referenced by run().

120 {
121  char *s;
122  const char *s2;
123  char *t;
124 
125  switch (info->status)
126  {
128  if (verbose > 1)
129  fprintf (stderr,
130  _ ("Starting download `%s'.\n"),
131  info->value.download.filename);
132  break;
133 
135  if (verbose)
136  {
137  s = GNUNET_strdup (
139  GNUNET_YES));
140  if (info->value.download.specifics.progress.block_download_duration
141  .rel_value_us == GNUNET_TIME_UNIT_FOREVER_REL.rel_value_us)
142  s2 = _ ("<unknown time>");
143  else
145  .specifics.progress
146  .block_download_duration,
147  GNUNET_YES);
149  info->value.download.completed * 1000LL
150  / (info->value.download.duration.rel_value_us + 1));
151  fprintf (
152  stdout,
153  _ (
154  "Downloading `%s' at %llu/%llu (%s remaining, %s/s). Block took %s to download\n"),
155  info->value.download.filename,
156  (unsigned long long) info->value.download.completed,
157  (unsigned long long) info->value.download.size,
158  s,
159  t,
160  s2);
161  GNUNET_free (s);
162  GNUNET_free (t);
163  }
164  else
165  {
166  display_bar (info->value.download.completed,
167  info->value.download.size,
168  60);
169  }
170  break;
171 
173  if (0 != isatty (1))
174  fprintf (stdout, "\n");
175  fprintf (stderr,
176  _ ("Error downloading: %s.\n"),
177  info->value.download.specifics.error.message);
179  break;
180 
183  info->value.download.completed * 1000
184  / (info->value.download.duration.rel_value_us + 1));
185  if (0 != isatty (1))
186  fprintf (stdout, "\n");
187  fprintf (stdout,
188  _ ("Downloading `%s' done (%s/s).\n"),
189  info->value.download.filename,
190  s);
191  GNUNET_free (s);
192  if (info->value.download.dc == dc)
194  break;
195 
197  if (info->value.download.dc == dc)
199  break;
200 
203  break;
204 
205  default:
206  fprintf (stderr, _ ("Unexpected status: %d\n"), info->status);
207  break;
208  }
209  return NULL;
210 }
Notification that we have started this download.
struct GNUNET_FS_ProgressInfo::@25::@27 download
Values for all "GNUNET_FS_STATUS_DOWNLOAD_*" events.
static unsigned int verbose
char * GNUNET_STRINGS_byte_size_fancy(unsigned long long size)
Convert a given filesize into a fancy human-readable format.
Definition: strings.c:175
static void cleanup_task(void *cls)
static struct GNUNET_SCHEDULER_Task * t
Main task.
void GNUNET_SCHEDULER_shutdown(void)
Request the shutdown of a scheduler.
Definition: scheduler.c:526
#define GNUNET_strdup(a)
Wrapper around GNUNET_xstrdup_.
#define _(String)
GNU gettext support macro.
Definition: platform.h:181
Notification that this download completed.
union GNUNET_FS_ProgressInfo::@25 value
Values that depend on the event type.
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_now(GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run as soon as possible.
Definition: scheduler.c:1280
enum GNUNET_FS_Status status
Specific status code (determines the event type).
const char * GNUNET_STRINGS_relative_time_to_string(struct GNUNET_TIME_Relative delta, int do_round)
Give relative time in human-readable fancy format.
Definition: strings.c:687
#define GNUNET_TIME_UNIT_FOREVER_REL
Constant used to specify "forever".
Notification that this download is no longer actively being pursued (back in the queue).
Notification about progress with this download.
Notification that this download is now actively being pursued (as opposed to waiting in the queue)...
#define GNUNET_YES
Definition: gnunet_common.h:77
Notification that this download was stopped (final event with respect to this action).
static void display_bar(unsigned long long x, unsigned long long n, unsigned int w)
Display progress bar (if tty).
Notification that this download encountered an error.
static struct GNUNET_FS_DownloadContext * dc
#define GNUNET_free(ptr)
Wrapper around free.
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
clsclosure
argsremaining command-line arguments
cfgfilename of the configuration file used (for saving, can be NULL!)
cconfiguration

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

References _, anonymity, 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().

226 {
227  struct GNUNET_FS_Uri *uri;
228  char *emsg;
230 
231  if (NULL == args[0])
232  {
233  fprintf (stderr, "%s", _ ("You need to specify a URI argument.\n"));
234  return;
235  }
236  uri = GNUNET_FS_uri_parse (args[0], &emsg);
237  if (NULL == uri)
238  {
239  fprintf (stderr, _ ("Failed to parse URI: %s\n"), emsg);
240  GNUNET_free (emsg);
241  ret = 1;
242  return;
243  }
244  if ((! GNUNET_FS_uri_test_chk (uri)) && (! GNUNET_FS_uri_test_loc (uri)))
245  {
246  fprintf (stderr, "%s", _ ("Only CHK or LOC URIs supported.\n"));
247  ret = 1;
248  GNUNET_FS_uri_destroy (uri);
249  return;
250  }
251  if (NULL == filename)
252  {
253  fprintf (stderr, "%s", _ ("Target filename must be specified.\n"));
254  ret = 1;
255  GNUNET_FS_uri_destroy (uri);
256  return;
257  }
258  cfg = c;
260  "gnunet-download",
261  &progress_cb,
262  NULL,
265  parallelism,
269  if (NULL == ctx)
270  {
271  fprintf (stderr, _ ("Could not initialize `%s' subsystem.\n"), "FS");
272  GNUNET_FS_uri_destroy (uri);
273  ret = 1;
274  return;
275  }
277  if (do_recursive)
279  if (local_only)
282  uri,
283  NULL,
284  filename,
285  NULL,
286  0,
288  anonymity,
289  options,
290  NULL,
291  NULL);
292  GNUNET_FS_uri_destroy (uri);
293  if (dc == NULL)
294  {
296  ctx = NULL;
297  return;
298  }
300 }
static unsigned int parallelism
static int ret
static const struct GNUNET_CONFIGURATION_Handle * cfg
struct GNUNET_GETOPT_CommandLineOption options[]
Definition: 002.c:5
struct GNUNET_FS_Uri * GNUNET_FS_uri_parse(const char *uri, char **emsg)
Convert a UTF-8 String to a URI.
Definition: fs_uri.c:644
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_shutdown(GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run on shutdown, that is when a CTRL-C signal is received, or when GNUNET_SCHEDULER_shutdown() is being invoked.
Definition: scheduler.c:1300
static struct GNUNET_FS_Handle * ctx
Last option in the VARARG list.
void GNUNET_FS_stop(struct GNUNET_FS_Handle *h)
Close our connection with the file-sharing service.
Definition: fs_api.c:3216
struct GNUNET_FS_DownloadContext * GNUNET_FS_download_start(struct GNUNET_FS_Handle *h, const struct GNUNET_FS_Uri *uri, const struct GNUNET_CONTAINER_MetaData *meta, const char *filename, const char *tempname, uint64_t offset, uint64_t length, uint32_t anonymity, enum GNUNET_FS_DownloadOptions options, void *cctx, struct GNUNET_FS_DownloadContext *parent)
Download parts of a file.
Definition: fs_download.c:2145
struct GNUNET_FS_Handle * GNUNET_FS_start(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *client_name, GNUNET_FS_ProgressCallback upcb, void *upcb_cls, enum GNUNET_FS_Flags flags,...)
Setup a connection to the file-sharing service.
Definition: fs_api.c:3141
No special flags set.
#define _(String)
GNU gettext support macro.
Definition: platform.h:181
int GNUNET_FS_uri_test_loc(const struct GNUNET_FS_Uri *uri)
Is this a location URI?
Definition: fs_uri.c:1395
static struct GNUNET_FS_Uri * uri
Value of URI provided on command-line (when not publishing a file but just creating UBlocks to refer ...
static unsigned int request_parallelism
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.
Only download from the local host, do not access remote systems (no P2P)
static int local_only
static char * filename
No options (use defaults for everything).
void GNUNET_FS_uri_destroy(struct GNUNET_FS_Uri *uri)
Free URI.
Definition: fs_uri.c:678
int GNUNET_FS_uri_test_chk(const struct GNUNET_FS_Uri *uri)
Is this a file (or directory) URI?
Definition: fs_uri.c:1357
GNUNET_FS_DownloadOptions
Options for downloading.
Select the desired amount of parallelism (this option should be followed by an "unsigned int" giving ...
static void shutdown_task(void *cls)
Maximum number of requests that should be pending at a given point in time (invidivual downloads may ...
Do a recursive download (that is, automatically trigger the download of files in directories).
uint64_t GNUNET_FS_uri_chk_get_file_size(const struct GNUNET_FS_Uri *uri)
What is the size of the file that this URI refers to?
Definition: fs_uri.c:1371
A Universal Resource Identifier (URI), opaque.
Definition: fs_api.h:165
static int do_recursive
static unsigned int anonymity
static struct GNUNET_FS_DownloadContext * dc
#define GNUNET_free(ptr)
Wrapper around free.
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
argcnumber of arguments from the command line
argvcommand line arguments
Returns
0 ok, 1 on error

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

References anonymity, delete_incomplete, do_recursive, filename, gettext_noop, GNUNET_free, 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, parallelism, request_parallelism, ret, run(), and verbose.

312 {
315  "anonymity",
316  "LEVEL",
317  gettext_noop (
318  "set the desired LEVEL of receiver-anonymity"),
319  &anonymity),
320 
322  'D',
323  "delete-incomplete",
324  gettext_noop ("delete incomplete downloads (when aborted with CTRL-C)"),
326 
328  'n',
329  "no-network",
330  gettext_noop ("only search the local peer (no P2P network search)"),
331  &local_only),
333  "output",
334  "FILENAME",
335  gettext_noop ("write the file to FILENAME"),
336  &filename),
338  'p',
339  "parallelism",
340  "DOWNLOADS",
341  gettext_noop (
342  "set the maximum number of parallel downloads that is allowed"),
343  &parallelism),
345  'r',
346  "request-parallelism",
347  "REQUESTS",
348  gettext_noop (
349  "set the maximum number of parallel requests for blocks that is allowed"),
352  "recursive",
353  gettext_noop (
354  "download a GNUnet directory recursively"),
355  &do_recursive),
357  'V',
358  "verbose",
359  gettext_noop ("be verbose (print progress information)"),
360  &verbose),
362 
363  if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
364  return 2;
365 
366  ret =
367  (GNUNET_OK ==
369  argc,
370  argv,
371  "gnunet-download [OPTIONS] URI",
372  gettext_noop (
373  "Download files from GNUnet using a GNUnet CHK or LOC URI (gnunet://fs/chk/...)"),
374  options,
375  &run,
376  NULL))
377  ? ret
378  : 1;
379  GNUNET_free ((void *) argv);
380  return ret;
381 }
static unsigned int parallelism
static int ret
struct GNUNET_GETOPT_CommandLineOption options[]
Definition: 002.c:5
static unsigned int verbose
int GNUNET_STRINGS_get_utf8_args(int argc, char *const *argv, int *u8argc, char *const **u8argv)
Returns utf-8 encoded arguments.
Definition: strings.c:1438
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_increment_uint(char shortName, const char *name, const char *description, unsigned int *val)
Increment val each time the option flag is given by one.
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:75
Definition of a command line option.
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_OPTION_END
Definition: 002.c:13
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_string(char shortName, const char *name, const char *argumentHelp, const char *description, char **str)
Allow user to specify a string.
static unsigned int request_parallelism
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.
static int local_only
static char * filename
static int delete_incomplete
static int do_recursive
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_flag(char shortName, const char *name, const char *description, int *val)
Allow user to specify a flag (which internally means setting an integer to 1/GNUNET_YES/GNUNET_OK.
int GNUNET_PROGRAM_run(int argc, char *const *argv, const char *binaryName, const char *binaryHelp, const struct GNUNET_GETOPT_CommandLineOption *options, GNUNET_PROGRAM_Main task, void *task_cls)
Run a standard GNUnet command startup sequence (initialize loggers and configuration, parse options).
Definition: program.c:367
static unsigned int anonymity
struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_uint(char shortName, const char *name, const char *argumentHelp, const char *description, unsigned int *val)
Allow user to specify an unsigned int.
#define GNUNET_free(ptr)
Wrapper around free.
#define gettext_noop(String)
Definition: gettext.h:69
Here is the call graph for this function:

Variable Documentation

◆ ret

int ret
static

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

Referenced by main(), and run().

◆ verbose

unsigned int verbose
static

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

Referenced by main(), and progress_cb().

◆ delete_incomplete

int delete_incomplete
static

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

Referenced by main(), and shutdown_task().

◆ cfg

const struct GNUNET_CONFIGURATION_Handle* cfg
static

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

◆ ctx

struct GNUNET_FS_Handle* ctx
static

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

◆ dc

struct GNUNET_FS_DownloadContext* dc
static

◆ anonymity

unsigned int anonymity = 1
static

◆ parallelism

unsigned int parallelism = 16
static

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

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

◆ request_parallelism

unsigned int request_parallelism = 4092
static

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

Referenced by main(), and run().

◆ do_recursive

int do_recursive
static

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

Referenced by main(), and run().

◆ filename

char* filename
static

◆ local_only

int local_only
static

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

Referenced by main(), and run().