tighten formatting rules
[oweals/gnunet.git] / src / fs / gnunet-download.c
index 6f7854756b588ebd7a75bc8368b452cf5cc34b75..63bb02958ff738622307a8a31069cce35419c89a 100644 (file)
@@ -1,22 +1,22 @@
 /*
      This file is part of GNUnet.
-     (C) 2001, 2002, 2004, 2005, 2006, 2007, 2009 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2001, 2002, 2004, 2005, 2006, 2007, 2009 GNUnet e.V.
 
-     GNUnet is free software; you can redistribute it and/or modify
-     it under the terms of the GNU General Public License as published
-     by the Free Software Foundation; either version 3, or (at your
-     option) any later version.
+     GNUnet is free software: you can redistribute it and/or modify it
+     under the terms of the GNU Affero General Public License as published
+     by the Free Software Foundation, either version 3 of the License,
+     or (at your option) any later version.
 
      GNUnet is distributed in the hope that it will be useful, but
      WITHOUT ANY WARRANTY; without even the implied warranty of
      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-     General Public License for more details.
+     Affero General Public License for more details.
 
-     You should have received a copy of the GNU General Public License
-     along with GNUnet; see the file COPYING.  If not, write to the
-     Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-     Boston, MA 02111-1307, USA.
-*/
+     You should have received a copy of the GNU Affero General Public License
+     along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+     SPDX-License-Identifier: AGPL3.0-or-later
+ */
 /**
  * @file fs/gnunet-download.c
  * @brief downloading for files on GNUnet
@@ -30,7 +30,7 @@
 
 static int ret;
 
-static int verbose;
+static unsigned int verbose;
 
 static int delete_incomplete;
 
@@ -38,8 +38,6 @@ static const struct GNUNET_CONFIGURATION_Handle *cfg;
 
 static struct GNUNET_FS_Handle *ctx;
 
-static struct GNUNET_SCHEDULER_Handle *sched;
-
 static struct GNUNET_FS_DownloadContext *dc;
 
 static unsigned int anonymity = 1;
@@ -54,9 +52,9 @@ static char *filename;
 
 static int local_only;
 
+
 static void
-cleanup_task (void *cls,
-             const struct GNUNET_SCHEDULER_TaskContext *tc)
+cleanup_task (void *cls)
 {
   GNUNET_FS_stop (ctx);
   ctx = NULL;
@@ -64,22 +62,48 @@ cleanup_task (void *cls,
 
 
 static void
-shutdown_task (void *cls,
-             const struct GNUNET_SCHEDULER_TaskContext *tc)
+shutdown_task (void *cls)
 {
-  struct GNUNET_FS_DownloadContext *d;
+  if (NULL != dc)
+  {
+    GNUNET_FS_download_stop (dc, delete_incomplete);
+    dc = NULL;
+  }
+}
 
-  if (dc != NULL)
-    {
-      d = dc;
-      dc = NULL;
-      GNUNET_FS_download_stop (d, delete_incomplete);
-    }
+
+/**
+ * Display progress bar (if tty).
+ *
+ * @param x current position in the download
+ * @param n total size of the download
+ * @param w desired number of steps in the progress bar
+ */
+static void
+display_bar (unsigned long long x, unsigned long long n, unsigned int w)
+{
+  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);
 }
 
 
 /**
- * Called by FS client to give information about the progress of an 
+ * Called by FS client to give information about the progress of an
  * operation.
  *
  * @param cls closure
@@ -89,67 +113,99 @@ shutdown_task (void *cls,
  *         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 GNUNET_FS_ProgressInfo struct.
+ *         field in the `struct GNUNET_FS_ProgressInfo`
  */
 static void *
-progress_cb (void *cls,
-            const struct GNUNET_FS_ProgressInfo *info)
+progress_cb (void *cls, const struct GNUNET_FS_ProgressInfo *info)
 {
   char *s;
+  const char *s2;
   char *t;
 
   switch (info->status)
-    {
-    case GNUNET_FS_STATUS_DOWNLOAD_START:
-      break;
-    case GNUNET_FS_STATUS_DOWNLOAD_PROGRESS:
-      if (verbose)
-       {         
-         s = GNUNET_STRINGS_relative_time_to_string(info->value.download.eta);
-         t = GNUNET_STRINGS_byte_size_fancy(info->value.download.completed * 1000LL / (info->value.download.duration.rel_value + 1));
-         fprintf (stdout,
-                  _("Downloading `%s' at %llu/%llu (%s remaining, %s/s)\n"),
-                  info->value.download.filename,
-                  (unsigned long long) info->value.download.completed,
-                  (unsigned long long) info->value.download.size,
-                  s,
-                  t);
-         GNUNET_free (s);
-         GNUNET_free (t);
-       }
-      break;
-    case GNUNET_FS_STATUS_DOWNLOAD_ERROR:
+  {
+  case GNUNET_FS_STATUS_DOWNLOAD_START:
+    if (verbose > 1)
       fprintf (stderr,
-              _("Error downloading: %s.\n"),
-              info->value.download.specifics.error.message);
-      GNUNET_SCHEDULER_shutdown (sched);
-      break;
-    case GNUNET_FS_STATUS_DOWNLOAD_COMPLETED:
-      s = GNUNET_STRINGS_byte_size_fancy(info->value.download.completed * 1000 / (info->value.download.duration.rel_value + 1));
-      fprintf (stdout,
-              _("Downloading `%s' done (%s/s).\n"),
-              info->value.download.filename,
-              s);
+               _ ("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);
-      if (info->value.download.dc == dc)
-       GNUNET_SCHEDULER_shutdown (sched);
-      break;
-    case GNUNET_FS_STATUS_DOWNLOAD_STOPPED: 
-      if (info->value.download.dc == dc)
-       GNUNET_SCHEDULER_add_continuation (sched,
-                                          &cleanup_task,
-                                          NULL,
-                                          GNUNET_SCHEDULER_REASON_PREREQ_DONE);
-      break;      
-    case GNUNET_FS_STATUS_DOWNLOAD_ACTIVE:
-    case GNUNET_FS_STATUS_DOWNLOAD_INACTIVE:
-      break;
-    default:
-      fprintf (stderr,
-              _("Unexpected status: %d\n"),
-              info->status);
-      break;
+      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;
 }
 
@@ -158,14 +214,12 @@ progress_cb (void *cls,
  * Main function that will be run by the scheduler.
  *
  * @param cls closure
- * @param s the scheduler to use
  * @param args remaining command-line arguments
  * @param cfgfile name of the configuration file used (for saving, can be NULL!)
  * @param c configuration
  */
 static void
 run (void *cls,
-     struct GNUNET_SCHEDULER_Handle *s,
      char *const *args,
      const char *cfgfile,
      const struct GNUNET_CONFIGURATION_Handle *c)
@@ -174,81 +228,75 @@ run (void *cls,
   char *emsg;
   enum GNUNET_FS_DownloadOptions options;
 
-  sched = s;
-  uri = GNUNET_FS_uri_parse (args[0],
-                            &emsg);
+  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))
-    {
-      fprintf (stderr,
-              "Only CHK URIs supported right now.\n");
-      ret = 1;
-      GNUNET_FS_uri_destroy (uri);
-      return;           
-    }
+  {
+    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,
-              "Target filename must be specified.\n");
-      ret = 1;
-      GNUNET_FS_uri_destroy (uri);
-      return;           
-    }
+  {
+    fprintf (stderr, "%s", _ ("Target filename must be specified.\n"));
+    ret = 1;
+    GNUNET_FS_uri_destroy (uri);
+    return;
+  }
   cfg = c;
-  ctx = GNUNET_FS_start (sched,
-                        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);
+  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;
-    }
+  {
+    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);
+                                 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_delayed (sched,
-                               GNUNET_TIME_UNIT_FOREVER_REL,
-                               &shutdown_task,
-                               NULL);
+  {
+    GNUNET_FS_stop (ctx);
+    ctx = NULL;
+    return;
+  }
+  GNUNET_SCHEDULER_add_shutdown (&shutdown_task, NULL);
 }
 
 
@@ -262,43 +310,75 @@ run (void *cls,
 int
 main (int argc, char *const *argv)
 {
-  static const struct GNUNET_GETOPT_CommandLineOption options[] = {
-    {'a', "anonymity", "LEVEL",
-     gettext_noop ("set the desired LEVEL of receiver-anonymity"),
-     1, &GNUNET_GETOPT_set_uint, &anonymity},
-    {'D', "delete-incomplete", NULL,
-     gettext_noop ("delete incomplete downloads (when aborted with CTRL-C)"),
-     0, &GNUNET_GETOPT_set_one, &delete_incomplete},
-    {'n', "no-network", NULL,
-     gettext_noop ("only search the local peer (no P2P network search)"),
-     1, &GNUNET_GETOPT_set_uint, &local_only},
-    {'o', "output", "FILENAME",
-     gettext_noop ("write the file to FILENAME"),
-     1, &GNUNET_GETOPT_set_string, &filename},
-    {'p', "parallelism", "DOWNLOADS",
-     gettext_noop
-     ("set the maximum number of parallel downloads that is allowed"),
-     1, &GNUNET_GETOPT_set_uint, &parallelism},
-    {'r', "request-parallelism", "REQUESTS",
-     gettext_noop
-     ("set the maximum number of parallel requests for blocks that is allowed"),
-     1, &GNUNET_GETOPT_set_uint, &request_parallelism},
-    {'R', "recursive", NULL,
-     gettext_noop ("download a GNUnet directory recursively"),
-     0, &GNUNET_GETOPT_set_one, &do_recursive},
-    {'V', "verbose", NULL,
-     gettext_noop ("be verbose (print progress information)"),
-     0, &GNUNET_GETOPT_set_one, &verbose},
-    GNUNET_GETOPT_OPTION_END
-  };
-  return (GNUNET_OK ==
-          GNUNET_PROGRAM_run (argc,
-                              argv,
-                              "gnunet-download",
-                              gettext_noop
-                              ("Download files from GNUnet."),
-                              options, &run, NULL)) ? ret : 1;
+  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 ((void *) argv);
+  return ret;
 }
 
-/* end of gnunet-download.c */
 
+/* end of gnunet-download.c */