2 This file is part of GNUnet.
3 Copyright (C) 2001, 2002, 2004, 2005, 2006, 2007, 2009 GNUnet e.V.
5 GNUnet is free software: you can redistribute it and/or modify it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your 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 Affero General Public License for more details.
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
21 * @file fs/gnunet-download.c
22 * @brief downloading for 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"
33 static unsigned int verbose;
35 static int delete_incomplete;
37 static const struct GNUNET_CONFIGURATION_Handle *cfg;
39 static struct GNUNET_FS_Handle *ctx;
41 static struct GNUNET_FS_DownloadContext *dc;
43 static unsigned int anonymity = 1;
45 static unsigned int parallelism = 16;
47 static unsigned int request_parallelism = 4092;
49 static int do_recursive;
51 static char *filename;
53 static int local_only;
57 cleanup_task (void *cls)
65 shutdown_task (void *cls)
69 GNUNET_FS_download_stop (dc, delete_incomplete);
76 * Display progress bar (if tty).
78 * @param x current position in the download
79 * @param n total size of the download
80 * @param w desired number of steps in the progress bar
83 display_bar (unsigned long long x, unsigned long long n, unsigned int w)
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++)
97 for (p = endeq; p < w; p++)
106 * Called by FS client to give information about the progress of an
110 * @param info details about the event, specifying the event type
111 * and various bits about the event
112 * @return client-context (for the next progress call
113 * for this operation; should be set to NULL for
114 * SUSPEND and STOPPED events). The value returned
115 * will be passed to future callbacks in the respective
116 * field in the `struct GNUNET_FS_ProgressInfo`
119 progress_cb (void *cls, const struct GNUNET_FS_ProgressInfo *info)
125 switch (info->status)
127 case GNUNET_FS_STATUS_DOWNLOAD_START:
130 _ ("Starting download `%s'.\n"),
131 info->value.download.filename);
134 case GNUNET_FS_STATUS_DOWNLOAD_PROGRESS:
138 GNUNET_STRINGS_relative_time_to_string (info->value.download.eta,
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>");
144 s2 = GNUNET_STRINGS_relative_time_to_string (info->value.download
146 .block_download_duration,
148 t = GNUNET_STRINGS_byte_size_fancy (
149 info->value.download.completed * 1000LL
150 / (info->value.download.duration.rel_value_us + 1));
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,
166 display_bar (info->value.download.completed,
167 info->value.download.size,
172 case GNUNET_FS_STATUS_DOWNLOAD_ERROR:
174 fprintf (stdout, "\n");
176 _ ("Error downloading: %s.\n"),
177 info->value.download.specifics.error.message);
178 GNUNET_SCHEDULER_shutdown ();
181 case GNUNET_FS_STATUS_DOWNLOAD_COMPLETED:
182 s = GNUNET_STRINGS_byte_size_fancy (
183 info->value.download.completed * 1000
184 / (info->value.download.duration.rel_value_us + 1));
186 fprintf (stdout, "\n");
188 _ ("Downloading `%s' done (%s/s).\n"),
189 info->value.download.filename,
192 if (info->value.download.dc == dc)
193 GNUNET_SCHEDULER_shutdown ();
196 case GNUNET_FS_STATUS_DOWNLOAD_STOPPED:
197 if (info->value.download.dc == dc)
198 GNUNET_SCHEDULER_add_now (&cleanup_task, NULL);
201 case GNUNET_FS_STATUS_DOWNLOAD_ACTIVE:
202 case GNUNET_FS_STATUS_DOWNLOAD_INACTIVE:
206 fprintf (stderr, _ ("Unexpected status: %d\n"), info->status);
214 * Main function that will be run by the scheduler.
217 * @param args remaining command-line arguments
218 * @param cfgfile name of the configuration file used (for saving, can be NULL!)
219 * @param c configuration
225 const struct GNUNET_CONFIGURATION_Handle *c)
227 struct GNUNET_FS_Uri *uri;
229 enum GNUNET_FS_DownloadOptions options;
233 fprintf (stderr, "%s", _ ("You need to specify a URI argument.\n"));
236 uri = GNUNET_FS_uri_parse (args[0], &emsg);
239 fprintf (stderr, _ ("Failed to parse URI: %s\n"), emsg);
244 if ((! GNUNET_FS_uri_test_chk (uri)) && (! GNUNET_FS_uri_test_loc (uri)))
246 fprintf (stderr, "%s", _ ("Only CHK or LOC URIs supported.\n"));
248 GNUNET_FS_uri_destroy (uri);
251 if (NULL == filename)
253 fprintf (stderr, "%s", _ ("Target filename must be specified.\n"));
255 GNUNET_FS_uri_destroy (uri);
259 ctx = GNUNET_FS_start (cfg,
263 GNUNET_FS_FLAGS_NONE,
264 GNUNET_FS_OPTIONS_DOWNLOAD_PARALLELISM,
266 GNUNET_FS_OPTIONS_REQUEST_PARALLELISM,
268 GNUNET_FS_OPTIONS_END);
271 fprintf (stderr, _ ("Could not initialize `%s' subsystem.\n"), "FS");
272 GNUNET_FS_uri_destroy (uri);
276 options = GNUNET_FS_DOWNLOAD_OPTION_NONE;
278 options |= GNUNET_FS_DOWNLOAD_OPTION_RECURSIVE;
280 options |= GNUNET_FS_DOWNLOAD_OPTION_LOOPBACK_ONLY;
281 dc = GNUNET_FS_download_start (ctx,
287 GNUNET_FS_uri_chk_get_file_size (uri),
292 GNUNET_FS_uri_destroy (uri);
295 GNUNET_FS_stop (ctx);
299 GNUNET_SCHEDULER_add_shutdown (&shutdown_task, NULL);
304 * The main function to download GNUnet.
306 * @param argc number of arguments from the command line
307 * @param argv command line arguments
308 * @return 0 ok, 1 on error
311 main (int argc, char *const *argv)
313 struct GNUNET_GETOPT_CommandLineOption options[] =
314 { GNUNET_GETOPT_option_uint ('a',
318 "set the desired LEVEL of receiver-anonymity"),
321 GNUNET_GETOPT_option_flag (
324 gettext_noop ("delete incomplete downloads (when aborted with CTRL-C)"),
327 GNUNET_GETOPT_option_flag (
330 gettext_noop ("only search the local peer (no P2P network search)"),
332 GNUNET_GETOPT_option_string ('o',
335 gettext_noop ("write the file to FILENAME"),
337 GNUNET_GETOPT_option_uint (
342 "set the maximum number of parallel downloads that is allowed"),
344 GNUNET_GETOPT_option_uint (
346 "request-parallelism",
349 "set the maximum number of parallel requests for blocks that is allowed"),
350 &request_parallelism),
351 GNUNET_GETOPT_option_flag ('R',
354 "download a GNUnet directory recursively"),
356 GNUNET_GETOPT_option_increment_uint (
359 gettext_noop ("be verbose (print progress information)"),
361 GNUNET_GETOPT_OPTION_END };
363 if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
371 "gnunet-download [OPTIONS] URI",
373 "Download files from GNUnet using a GNUnet CHK or LOC URI (gnunet://fs/chk/...)"),
379 GNUNET_free ((void *) argv);
384 /* end of gnunet-download.c */