]> sjero.net Git - wget/blobdiff - src/retr.c
[svn] Use new function to test filename for common html suffixes.
[wget] / src / retr.c
index dcd812268df40116fc69038b1936da6cae5cf51e..c35dde110483a482fae8bf8b673d3e2ab725cb66 100644 (file)
@@ -44,6 +44,10 @@ Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
 #include "connect.h"
 #include "hash.h"
 
+#ifdef HAVE_SSL
+# include "gen_sslfunc.h"      /* for ssl_iread */
+#endif
+
 #ifndef errno
 extern int errno;
 #endif
@@ -52,6 +56,50 @@ extern int errno;
 int global_download_count;
 
 \f
+static struct {
+  long bytes;
+  long dltime;
+} limit_data;
+
+static void
+limit_bandwidth_reset (void)
+{
+  limit_data.bytes  = 0;
+  limit_data.dltime = 0;
+}
+
+/* Limit the bandwidth by pausing the download for an amount of time.
+   BYTES is the number of bytes received from the network, DELTA is
+   how long it took to receive them, DLTIME the current download time,
+   TIMER the timer, and ADJUSTMENT the previous.  */
+
+static void
+limit_bandwidth (long bytes, long delta)
+{
+  long expected;
+
+  limit_data.bytes += bytes;
+  limit_data.dltime += delta;
+
+  expected = (long)(1000.0 * limit_data.bytes / opt.limit_rate);
+
+  if (expected > limit_data.dltime)
+    {
+      long slp = expected - limit_data.dltime;
+      if (slp < 200)
+       {
+         DEBUGP (("deferring a %ld ms sleep (%ld/%ld) until later.\n",
+                  slp, limit_data.bytes, limit_data.dltime));
+         return;
+       }
+      DEBUGP (("sleeping %ld ms\n", slp));
+      usleep (1000 * slp);
+    }
+
+  limit_data.bytes = 0;
+  limit_data.dltime = 0;
+}
+
 #define MIN(i, j) ((i) <= (j) ? (i) : (j))
 
 /* Reads the contents of file descriptor FD, until it is closed, or a
@@ -77,33 +125,43 @@ int global_download_count;
    from fd immediately, flush or discard the buffer.  */
 int
 get_contents (int fd, FILE *fp, long *len, long restval, long expected,
-             struct rbuf *rbuf, int use_expected)
+             struct rbuf *rbuf, int use_expected, long *elapsed)
 {
   int res = 0;
   static char c[8192];
   void *progress = NULL;
+  struct wget_timer *timer = wtimer_allocate ();
+  long dltime = 0, last_dltime = 0;
 
   *len = restval;
+
   if (opt.verbose)
     progress = progress_create (restval, expected);
 
   if (rbuf && RBUF_FD (rbuf) == fd)
     {
-      int need_flush = 0;
+      int sz = 0;
       while ((res = rbuf_flush (rbuf, c, sizeof (c))) != 0)
        {
-         if (fwrite (c, sizeof (char), res, fp) < res)
-           return -2;
-         if (opt.verbose)
-           progress_update (progress, res);
+         fwrite (c, sizeof (char), res, fp);
          *len += res;
-         need_flush = 1;
+         sz += res;
        }
-      if (need_flush)
+      if (sz)
        fflush (fp);
       if (ferror (fp))
-       return -2;
+       {
+         res = -2;
+         goto out;
+       }
+      if (opt.verbose)
+       progress_update (progress, sz, 0);
     }
+
+  if (opt.limit_rate)
+    limit_bandwidth_reset ();
+  wtimer_reset (timer);
+
   /* Read from fd while there is available data.
 
      Normally, if expected is 0, it means that it is not known how
@@ -115,14 +173,12 @@ get_contents (int fd, FILE *fp, long *len, long restval, long expected,
                            ? MIN (expected - *len, sizeof (c))
                            : sizeof (c));
 #ifdef HAVE_SSL
-               if (rbuf->ssl!=NULL) {
-                 res = ssl_iread (rbuf->ssl, c, amount_to_read);
-               } else {
-#endif /* HAVE_SSL */
-                 res = iread (fd, c, amount_to_read);
-#ifdef HAVE_SSL
-               }
+      if (rbuf->ssl!=NULL)
+       res = ssl_iread (rbuf->ssl, c, amount_to_read);
+      else
 #endif /* HAVE_SSL */
+       res = iread (fd, c, amount_to_read);
+
       if (res > 0)
        {
          fwrite (c, sizeof (char), res, fp);
@@ -131,9 +187,23 @@ get_contents (int fd, FILE *fp, long *len, long restval, long expected,
             packets typically won't be too tiny anyway.  */
          fflush (fp);
          if (ferror (fp))
-           return -2;
+           {
+             res = -2;
+             goto out;
+           }
+
+         /* If bandwidth is not limited, one call to wtimer_elapsed
+            is sufficient.  */
+         dltime = wtimer_elapsed (timer);
+         if (opt.limit_rate)
+           {
+             limit_bandwidth (res, dltime - last_dltime);
+             dltime = wtimer_elapsed (timer);
+             last_dltime = dltime;
+           }
+
          if (opt.verbose)
-           progress_update (progress, res);
+           progress_update (progress, res, dltime);
          *len += res;
        }
       else
@@ -141,22 +211,43 @@ get_contents (int fd, FILE *fp, long *len, long restval, long expected,
     }
   if (res < -1)
     res = -1;
+
+ out:
   if (opt.verbose)
-    progress_finish (progress);
+    progress_finish (progress, dltime);
+  if (elapsed)
+    *elapsed = dltime;
+  wtimer_delete (timer);
+
   return res;
 }
 \f
 /* Return a printed representation of the download rate, as
-   appropriate for the speed.  Appropriate means that if rate is
-   greater than 1K/s, kilobytes are used, and if rate is greater than
-   1MB/s, megabytes are used.
-
-   If PAD is non-zero, strings will be padded to the width of 7
-   characters (xxxx.xx).  */
+   appropriate for the speed.  If PAD is non-zero, strings will be
+   padded to the width of 7 characters (xxxx.xx).  */
 char *
-rate (long bytes, long msecs, int pad)
+retr_rate (long bytes, long msecs, int pad)
+{
+  static char res[20];
+  static char *rate_names[] = {"B/s", "KB/s", "MB/s", "GB/s" };
+  int units = 0;
+
+  double dlrate = calc_rate (bytes, msecs, &units);
+  sprintf (res, pad ? "%7.2f %s" : "%.2f %s", dlrate, rate_names[units]);
+
+  return res;
+}
+
+/* Calculate the download rate and trim it as appropriate for the
+   speed.  Appropriate means that if rate is greater than 1K/s,
+   kilobytes are used, and if rate is greater than 1MB/s, megabytes
+   are used.
+
+   UNITS is zero for B/s, one for KB/s, two for MB/s, and three for
+   GB/s.  */
+double
+calc_rate (long bytes, long msecs, int *units)
 {
-  static char res[15];
   double dlrate;
 
   assert (msecs >= 0);
@@ -170,47 +261,33 @@ rate (long bytes, long msecs, int pad)
 
   dlrate = (double)1000 * bytes / msecs;
   if (dlrate < 1024.0)
-    sprintf (res, pad ? "%7.2f B/s" : "%.2f B/s", dlrate);
+    *units = 0;
   else if (dlrate < 1024.0 * 1024.0)
-    sprintf (res, pad ? "%7.2f K/s" : "%.2f K/s", dlrate / 1024.0);
+    *units = 1, dlrate /= 1024.0;
   else if (dlrate < 1024.0 * 1024.0 * 1024.0)
-    sprintf (res, pad ? "%7.2f M/s" : "%.2f M/s", dlrate / (1024.0 * 1024.0));
+    *units = 2, dlrate /= (1024.0 * 1024.0);
   else
     /* Maybe someone will need this one day.  More realistically, it
        will get tickled by buggy timers. */
-    sprintf (res, pad ? "%7.2f GB/s" : "%.2f GB/s",
-            dlrate / (1024.0 * 1024.0 * 1024.0));
+    *units = 3, dlrate /= (1024.0 * 1024.0 * 1024.0);
 
-  return res;
+  return dlrate;
 }
 \f
-static int
-register_redirections_mapper (void *key, void *value, void *arg)
-{
-  const char *redirected_from = (const char *)key;
-  const char *redirected_to   = (const char *)arg;
-  if (0 != strcmp (redirected_from, redirected_to))
-    register_redirection (redirected_from, redirected_to);
-  return 0;
-}
-
-/* Register the redirections that lead to the successful download of
-   this URL.  This is necessary so that the link converter can convert
-   redirected URLs to the local file.  */
-
-static void
-register_all_redirections (struct hash_table *redirections, const char *final)
-{
-  hash_table_map (redirections, register_redirections_mapper, (void *)final);
-}
-
 #define USE_PROXY_P(u) (opt.use_proxy && getproxy((u)->scheme)         \
                        && no_proxy_match((u)->host,                    \
                                          (const char **)opt.no_proxy))
 
-/* Retrieve the given URL.  Decides which loop to call -- HTTP(S), FTP,
-   or simply copy it with file:// (#### the latter not yet
-   implemented!).  */
+/* Maximum number of allowed redirections.  20 was chosen as a
+   "reasonable" value, which is low enough to not cause havoc, yet
+   high enough to guarantee that normal retrievals will not be hurt by
+   the check.  */
+
+#define MAX_REDIRECTIONS 20
+
+/* Retrieve the given URL.  Decides which loop to call -- HTTP, FTP,
+   FTP, proxy, etc.  */
+
 uerr_t
 retrieve_url (const char *origurl, char **file, char **newloc,
              const char *refurl, int *dt)
@@ -223,7 +300,7 @@ retrieve_url (const char *origurl, char **file, char **newloc,
   struct url *u;
   int up_error_code;           /* url parse error code */
   char *local_file;
-  struct hash_table *redirections = NULL;
+  int redirection_count = 0;
 
   /* If dt is NULL, just ignore it.  */
   if (!dt)
@@ -238,8 +315,6 @@ retrieve_url (const char *origurl, char **file, char **newloc,
   if (!u)
     {
       logprintf (LOG_NOTQUIET, "%s: %s.\n", url, url_error (up_error_code));
-      if (redirections)
-       string_set_free (redirections);
       xfree (url);
       return URLERROR;
     }
@@ -264,8 +339,6 @@ retrieve_url (const char *origurl, char **file, char **newloc,
        {
          logputs (LOG_NOTQUIET, _("Could not find proxy host.\n"));
          url_free (u);
-         if (redirections)
-           string_set_free (redirections);
          xfree (url);
          return PROXERR;
        }
@@ -276,8 +349,6 @@ retrieve_url (const char *origurl, char **file, char **newloc,
        {
          logprintf (LOG_NOTQUIET, _("Error parsing proxy URL %s: %s.\n"),
                     proxy, url_error (up_error_code));
-         if (redirections)
-           string_set_free (redirections);
          xfree (url);
          return PROXERR;
        }
@@ -285,8 +356,6 @@ retrieve_url (const char *origurl, char **file, char **newloc,
        {
          logprintf (LOG_NOTQUIET, _("Error in proxy URL %s: Must be HTTP.\n"), proxy);
          url_free (proxy_url);
-         if (redirections)
-           string_set_free (redirections);
          xfree (url);
          return PROXERR;
        }
@@ -308,23 +377,20 @@ retrieve_url (const char *origurl, char **file, char **newloc,
         retrieval, so we save recursion to oldrec, and restore it
         later.  */
       int oldrec = opt.recursive;
-      if (redirections)
+      if (redirection_count)
        opt.recursive = 0;
       result = ftp_loop (u, dt);
       opt.recursive = oldrec;
-#if 0
+
       /* There is a possibility of having HTTP being redirected to
         FTP.  In these cases we must decide whether the text is HTML
-        according to the suffix.  The HTML suffixes are `.html' and
-        `.htm', case-insensitive.  */
-      if (redirections && u->local && (u->scheme == SCHEME_FTP))
+        according to the suffix.  The HTML suffixes are `.html',
+        `.htm' and a few others, case-insensitive.  */
+      if (redirection_count && local_file && u->scheme == SCHEME_FTP)
        {
-         char *suf = suffix (u->local);
-         if (suf && (!strcasecmp (suf, "html") || !strcasecmp (suf, "htm")))
+         if (has_html_suffix_p (local_file))
            *dt |= TEXTHTML;
-         FREE_MAYBE (suf);
        }
-#endif
     }
   location_changed = (result == NEWLOCATION);
   if (location_changed)
@@ -352,8 +418,6 @@ retrieve_url (const char *origurl, char **file, char **newloc,
          logprintf (LOG_NOTQUIET, "%s: %s.\n", mynewloc,
                     url_error (up_error_code));
          url_free (u);
-         if (redirections)
-           string_set_free (redirections);
          xfree (url);
          xfree (mynewloc);
          return result;
@@ -365,29 +429,17 @@ retrieve_url (const char *origurl, char **file, char **newloc,
       xfree (mynewloc);
       mynewloc = xstrdup (newloc_parsed->url);
 
-      if (!redirections)
+      /* Check for max. number of redirections.  */
+      if (++redirection_count > MAX_REDIRECTIONS)
        {
-         redirections = make_string_hash_table (0);
-         /* Add current URL immediately so we can detect it as soon
-             as possible in case of a cycle. */
-         string_set_add (redirections, u->url);
-       }
-
-      /* The new location is OK.  Check for redirection cycle by
-         peeking through the history of redirections. */
-      if (string_set_contains (redirections, newloc_parsed->url))
-       {
-         logprintf (LOG_NOTQUIET, _("%s: Redirection cycle detected.\n"),
-                    mynewloc);
+         logprintf (LOG_NOTQUIET, _("%d redirections exceeded.\n"),
+                    MAX_REDIRECTIONS);
          url_free (newloc_parsed);
          url_free (u);
-         if (redirections)
-           string_set_free (redirections);
          xfree (url);
          xfree (mynewloc);
          return WRONGCODE;
        }
-      string_set_add (redirections, newloc_parsed->url);
 
       xfree (url);
       url = mynewloc;
@@ -400,11 +452,11 @@ retrieve_url (const char *origurl, char **file, char **newloc,
     {
       if (*dt & RETROKF)
        {
-         register_download (url, local_file);
-         if (redirections)
-           register_all_redirections (redirections, url);
+         register_download (u->url, local_file);
+         if (redirection_count && 0 != strcmp (origurl, u->url))
+           register_redirection (origurl, u->url);
          if (*dt & TEXTHTML)
-           register_html (url, local_file);
+           register_html (u->url, local_file);
        }
     }
 
@@ -414,13 +466,20 @@ retrieve_url (const char *origurl, char **file, char **newloc,
     FREE_MAYBE (local_file);
 
   url_free (u);
-  if (redirections)
-    string_set_free (redirections);
 
-  if (newloc)
-    *newloc = url;
+  if (redirection_count)
+    {
+      if (newloc)
+       *newloc = url;
+      else
+       xfree (url);
+    }
   else
-    xfree (url);
+    {
+      if (newloc)
+       *newloc = NULL;
+      xfree (url);
+    }
 
   ++global_download_count;
 
@@ -438,16 +497,19 @@ retrieve_from_file (const char *file, int html, int *count)
   uerr_t status;
   struct urlpos *url_list, *cur_url;
 
-  url_list = (html ? get_urls_html (file, NULL, FALSE, NULL)
+  url_list = (html ? get_urls_html (file, NULL, NULL)
              : get_urls_file (file));
   status = RETROK;             /* Suppose everything is OK.  */
   *count = 0;                  /* Reset the URL count.  */
 
   for (cur_url = url_list; cur_url; cur_url = cur_url->next, ++*count)
     {
-      char *filename = NULL, *new_file;
+      char *filename = NULL, *new_file = NULL;
       int dt;
 
+      if (cur_url->ignore_when_downloading)
+       continue;
+
       if (downloaded_exceeds_quota ())
        {
          status = QUOTEXC;
@@ -531,22 +593,41 @@ sleep_between_retrievals (int count)
 {
   static int first_retrieval = 1;
 
-  if (!first_retrieval && (opt.wait || opt.waitretry))
+  if (first_retrieval)
+    {
+      /* Don't sleep before the very first retrieval. */
+      first_retrieval = 0;
+      return;
+    }
+
+  if (opt.waitretry && count > 1)
     {
-      if (opt.waitretry && count > 1)
+      /* If opt.waitretry is specified and this is a retry, wait for
+        COUNT-1 number of seconds, or for opt.waitretry seconds.  */
+      if (count <= opt.waitretry)
+       sleep (count - 1);
+      else
+       sleep (opt.waitretry);
+    }
+  else if (opt.wait)
+    {
+      if (!opt.random_wait || count > 1)
+       /* If random-wait is not specified, or if we are sleeping
+          between retries of the same download, sleep the fixed
+          interval.  */
+       sleep (opt.wait);
+      else
        {
-         /* If opt.waitretry is specified and this is a retry, wait
-            for COUNT-1 number of seconds, or for opt.waitretry
-            seconds.  */
-         if (count <= opt.waitretry)
-           sleep (count - 1);
-         else
-           sleep (opt.waitretry);
+         /* Sleep a random amount of time averaging in opt.wait
+            seconds.  The sleeping amount ranges from 0 to
+            opt.wait*2, inclusive.  */
+         int waitsecs = random_number (opt.wait * 2 + 1);
+
+         DEBUGP (("sleep_between_retrievals: norm=%ld,fuzz=%ld,sleep=%d\n",
+                  opt.wait, waitsecs - opt.wait, waitsecs));
+
+         if (waitsecs)
+           sleep (waitsecs);
        }
-      else if (opt.wait)
-       /* Otherwise, check if opt.wait is specified.  If so, sleep.  */
-       sleep (opt.wait);
     }
-  if (first_retrieval)
-    first_retrieval = 0;
 }