src/fs/gnunet-download.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2001, 2002, 2004, 2005, 2006, 2007, 2009 Christian Grothoff (and other contributing authors)
   4
   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 3, or (at your
   8      option) any later version.
   9
  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.
  14
  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.
  19 */
  20 /**
  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
  27  */
  28 #include "platform.h"
  29 #include "gnunet_fs_service.h"
  30
  31 static int ret;
  32
  33 static int verbose;
  34
  35 static int delete_incomplete;
  36
  37 static const struct GNUNET_CONFIGURATION_Handle *cfg;
  38
  39 static struct GNUNET_FS_Handle *ctx;
  40
  41 static struct GNUNET_FS_DownloadContext *dc;
  42
  43 static unsigned int anonymity = 1;
  44
  45 static unsigned int parallelism = 16;
  46
  47 static unsigned int request_parallelism = 4092;
  48
  49 static int do_recursive;
  50
  51 static char *filename;
  52
  53 static int local_only;
  54
  55 static void
  56 cleanup_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
  57 {
  58   GNUNET_FS_stop (ctx);
  59   ctx = NULL;
  60 }
  61
  62
  63 static void
  64 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
  65 {
  66   struct GNUNET_FS_DownloadContext *d;
  67
  68   if (dc != NULL)
  69   {
  70     d = dc;
  71     dc = NULL;
  72     GNUNET_FS_download_stop (d, delete_incomplete);
  73   }
  74 }
  75
  76
  77 /**
  78  * Called by FS client to give information about the progress of an
  79  * operation.
  80  *
  81  * @param cls closure
  82  * @param info details about the event, specifying the event type
  83  *        and various bits about the event
  84  * @return client-context (for the next progress call
  85  *         for this operation; should be set to NULL for
  86  *         SUSPEND and STOPPED events).  The value returned
  87  *         will be passed to future callbacks in the respective
  88  *         field in the GNUNET_FS_ProgressInfo struct.
  89  */
  90 static void *
  91 progress_cb (void *cls, const struct GNUNET_FS_ProgressInfo *info)
  92 {
  93   char *s;
  94   char *t;
  95
  96   switch (info->status)
  97   {
  98   case GNUNET_FS_STATUS_DOWNLOAD_START:
  99     if (verbose > 1)
 100       fprintf (stderr,
 101                _("Starting download `%s'.\n"), info->value.download.filename);
 102     break;
 103   case GNUNET_FS_STATUS_DOWNLOAD_PROGRESS:
 104     if (verbose)
 105     {
 106       s = GNUNET_STRINGS_relative_time_to_string (info->value.download.eta);
 107       t = GNUNET_STRINGS_byte_size_fancy (info->value.download.completed *
 108                                           1000LL /
 109                                           (info->value.download.
 110                                            duration.rel_value + 1));
 111       fprintf (stdout,
 112                _("Downloading `%s' at %llu/%llu (%s remaining, %s/s)\n"),
 113                info->value.download.filename,
 114                (unsigned long long) info->value.download.completed,
 115                (unsigned long long) info->value.download.size, s, t);
 116       GNUNET_free (s);
 117       GNUNET_free (t);
 118     }
 119     break;
 120   case GNUNET_FS_STATUS_DOWNLOAD_ERROR:
 121     fprintf (stderr,
 122              _("Error downloading: %s.\n"),
 123              info->value.download.specifics.error.message);
 124     GNUNET_SCHEDULER_shutdown ();
 125     break;
 126   case GNUNET_FS_STATUS_DOWNLOAD_COMPLETED:
 127     s = GNUNET_STRINGS_byte_size_fancy (info->value.download.completed * 1000 /
 128                                         (info->value.download.
 129                                          duration.rel_value + 1));
 130     fprintf (stdout, _("Downloading `%s' done (%s/s).\n"),
 131              info->value.download.filename, s);
 132     GNUNET_free (s);
 133     if (info->value.download.dc == dc)
 134       GNUNET_SCHEDULER_shutdown ();
 135     break;
 136   case GNUNET_FS_STATUS_DOWNLOAD_STOPPED:
 137     if (info->value.download.dc == dc)
 138       GNUNET_SCHEDULER_add_continuation (&cleanup_task,
 139                                          NULL,
 140                                          GNUNET_SCHEDULER_REASON_PREREQ_DONE);
 141     break;
 142   case GNUNET_FS_STATUS_DOWNLOAD_ACTIVE:
 143   case GNUNET_FS_STATUS_DOWNLOAD_INACTIVE:
 144     break;
 145   default:
 146     fprintf (stderr, _("Unexpected status: %d\n"), info->status);
 147     break;
 148   }
 149   return NULL;
 150 }
 151
 152
 153 /**
 154  * Main function that will be run by the scheduler.
 155  *
 156  * @param cls closure
 157  * @param args remaining command-line arguments
 158  * @param cfgfile name of the configuration file used (for saving, can be NULL!)
 159  * @param c configuration
 160  */
 161 static void
 162 run (void *cls,
 163      char *const *args,
 164      const char *cfgfile, const struct GNUNET_CONFIGURATION_Handle *c)
 165 {
 166   struct GNUNET_FS_Uri *uri;
 167   char *emsg;
 168   enum GNUNET_FS_DownloadOptions options;
 169
 170   if (NULL == args[0])
 171   {
 172     fprintf (stderr, _("You need to specify a URI argument.\n"));
 173     return;
 174   }
 175   uri = GNUNET_FS_uri_parse (args[0], &emsg);
 176   if (NULL == uri)
 177   {
 178     fprintf (stderr, _("Failed to parse URI: %s\n"), emsg);
 179     GNUNET_free (emsg);
 180     ret = 1;
 181     return;
 182   }
 183   if ((!GNUNET_FS_uri_test_chk (uri)) && (!GNUNET_FS_uri_test_loc (uri)))
 184   {
 185     fprintf (stderr, _("Only CHK or LOC URIs supported.\n"));
 186     ret = 1;
 187     GNUNET_FS_uri_destroy (uri);
 188     return;
 189   }
 190   if (NULL == filename)
 191   {
 192     fprintf (stderr, _("Target filename must be specified.\n"));
 193     ret = 1;
 194     GNUNET_FS_uri_destroy (uri);
 195     return;
 196   }
 197   cfg = c;
 198   ctx = GNUNET_FS_start (cfg,
 199                          "gnunet-download",
 200                          &progress_cb,
 201                          NULL,
 202                          GNUNET_FS_FLAGS_NONE,
 203                          GNUNET_FS_OPTIONS_DOWNLOAD_PARALLELISM,
 204                          parallelism,
 205                          GNUNET_FS_OPTIONS_REQUEST_PARALLELISM,
 206                          request_parallelism, GNUNET_FS_OPTIONS_END);
 207   if (NULL == ctx)
 208   {
 209     fprintf (stderr, _("Could not initialize `%s' subsystem.\n"), "FS");
 210     GNUNET_FS_uri_destroy (uri);
 211     ret = 1;
 212     return;
 213   }
 214   options = GNUNET_FS_DOWNLOAD_OPTION_NONE;
 215   if (do_recursive)
 216     options |= GNUNET_FS_DOWNLOAD_OPTION_RECURSIVE;
 217   if (local_only)
 218     options |= GNUNET_FS_DOWNLOAD_OPTION_LOOPBACK_ONLY;
 219   dc = GNUNET_FS_download_start (ctx,
 220                                  uri,
 221                                  NULL,
 222                                  filename, NULL,
 223                                  0,
 224                                  GNUNET_FS_uri_chk_get_file_size (uri),
 225                                  anonymity, options, NULL, NULL);
 226   GNUNET_FS_uri_destroy (uri);
 227   if (dc == NULL)
 228   {
 229     GNUNET_FS_stop (ctx);
 230     ctx = NULL;
 231     return;
 232   }
 233   GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
 234                                 &shutdown_task, NULL);
 235 }
 236
 237
 238 /**
 239  * The main function to download GNUnet.
 240  *
 241  * @param argc number of arguments from the command line
 242  * @param argv command line arguments
 243  * @return 0 ok, 1 on error
 244  */
 245 int
 246 main (int argc, char *const *argv)
 247 {
 248   static const struct GNUNET_GETOPT_CommandLineOption options[] = {
 249     {'a', "anonymity", "LEVEL",
 250      gettext_noop ("set the desired LEVEL of receiver-anonymity"),
 251      1, &GNUNET_GETOPT_set_uint, &anonymity},
 252     {'D', "delete-incomplete", NULL,
 253      gettext_noop ("delete incomplete downloads (when aborted with CTRL-C)"),
 254      0, &GNUNET_GETOPT_set_one, &delete_incomplete},
 255     {'n', "no-network", NULL,
 256      gettext_noop ("only search the local peer (no P2P network search)"),
 257      1, &GNUNET_GETOPT_set_uint, &local_only},
 258     {'o', "output", "FILENAME",
 259      gettext_noop ("write the file to FILENAME"),
 260      1, &GNUNET_GETOPT_set_string, &filename},
 261     {'p', "parallelism", "DOWNLOADS",
 262      gettext_noop
 263      ("set the maximum number of parallel downloads that is allowed"),
 264      1, &GNUNET_GETOPT_set_uint, &parallelism},
 265     {'r', "request-parallelism", "REQUESTS",
 266      gettext_noop
 267      ("set the maximum number of parallel requests for blocks that is allowed"),
 268      1, &GNUNET_GETOPT_set_uint, &request_parallelism},
 269     {'R', "recursive", NULL,
 270      gettext_noop ("download a GNUnet directory recursively"),
 271      0, &GNUNET_GETOPT_set_one, &do_recursive},
 272     {'V', "verbose", NULL,
 273      gettext_noop ("be verbose (print progress information)"),
 274      0, &GNUNET_GETOPT_increment_value, &verbose},
 275     GNUNET_GETOPT_OPTION_END
 276   };
 277   return (GNUNET_OK ==
 278           GNUNET_PROGRAM_run (argc,
 279                               argv,
 280                               "gnunet-download [OPTIONS] URI",
 281                               gettext_noop
 282                               ("Download files from GNUnet using a GNUnet CHK or LOC URI (gnunet://fs/chk/...)"),
 283                               options, &run, NULL)) ? ret : 1;
 284 }
 285
 286 /* end of gnunet-download.c */