/* Download progress.
- Copyright (C) 2001-2005 Free Software Foundation, Inc.
+ Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007 Free Software
+ Foundation, Inc.
This file is part of GNU Wget.
GNU Wget 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 2 of the License, or
+the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
GNU Wget is distributed in the hope that it will be useful,
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
-along with Wget; if not, write to the Free Software Foundation, Inc.,
-51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+along with Wget. If not, see <http://www.gnu.org/licenses/>.
In addition, as a special exception, the Free Software Foundation
gives permission to link the code of its release of Wget with the
file, but you are not obligated to do so. If you do not wish to do
so, delete this exception statement from your version. */
-#include <config.h>
+#include "wget.h"
#include <stdio.h>
#include <stdlib.h>
#endif
#include <signal.h>
-#include "wget.h"
#include "progress.h"
#include "utils.h"
#include "retr.h"
for (i = 0; i < countof (implementations); i++, pi++)
if (!strncmp (pi->name, name, namelen))
{
- current_impl = pi;
- current_impl_locked = 0;
-
- if (colon)
- /* We call pi->set_params even if colon is NULL because we
- want to give the implementation a chance to set up some
- things it needs to run. */
- ++colon;
-
- if (pi->set_params)
- pi->set_params (colon);
- return;
+ current_impl = pi;
+ current_impl_locked = 0;
+
+ if (colon)
+ /* We call pi->set_params even if colon is NULL because we
+ want to give the implementation a chance to set up some
+ things it needs to run. */
+ ++colon;
+
+ if (pi->set_params)
+ pi->set_params (colon);
+ return;
}
abort ();
}
if (output_redirected)
{
if (!current_impl_locked)
- set_progress_implementation (FALLBACK_PROGRESS_IMPLEMENTATION);
+ set_progress_implementation (FALLBACK_PROGRESS_IMPLEMENTATION);
output_redirected = 0;
}
/* Dot-printing. */
struct dot_progress {
- wgint initial_length; /* how many bytes have been downloaded
- previously. */
- wgint total_length; /* expected total byte count when the
- download finishes */
+ wgint initial_length; /* how many bytes have been downloaded
+ previously. */
+ wgint total_length; /* expected total byte count when the
+ download finishes */
- int accumulated; /* number of bytes accumulated after
- the last printed dot */
+ int accumulated; /* number of bytes accumulated after
+ the last printed dot */
- int rows; /* number of rows printed so far */
- int dots; /* number of dots printed in this row */
+ int rows; /* number of rows printed so far */
+ int dots; /* number of dots printed in this row */
double last_timer_value;
};
wgint skipped = dp->initial_length - remainder;
if (skipped)
- {
- wgint skipped_k = skipped / 1024; /* skipped amount in K */
- int skipped_k_len = numdigit (skipped_k);
- if (skipped_k_len < 6)
- skipped_k_len = 6;
-
- /* Align the [ skipping ... ] line with the dots. To do
- that, insert the number of spaces equal to the number of
- digits in the skipped amount in K. */
- logprintf (LOG_VERBOSE, _("\n%*s[ skipping %sK ]"),
- 2 + skipped_k_len, "",
- number_to_static_string (skipped_k));
- }
+ {
+ wgint skipped_k = skipped / 1024; /* skipped amount in K */
+ int skipped_k_len = numdigit (skipped_k);
+ if (skipped_k_len < 6)
+ skipped_k_len = 6;
+
+ /* Align the [ skipping ... ] line with the dots. To do
+ that, insert the number of spaces equal to the number of
+ digits in the skipped amount in K. */
+ logprintf (LOG_VERBOSE, _("\n%*s[ skipping %sK ]"),
+ 2 + skipped_k_len, "",
+ number_to_static_string (skipped_k));
+ }
logprintf (LOG_VERBOSE, "\n%6sK",
- number_to_static_string (skipped / 1024));
+ number_to_static_string (skipped / 1024));
for (; remainder >= dot_bytes; remainder -= dot_bytes)
- {
- if (dp->dots % opt.dot_spacing == 0)
- logputs (LOG_VERBOSE, " ");
- logputs (LOG_VERBOSE, ",");
- ++dp->dots;
- }
+ {
+ if (dp->dots % opt.dot_spacing == 0)
+ logputs (LOG_VERBOSE, " ");
+ logputs (LOG_VERBOSE, ",");
+ ++dp->dots;
+ }
assert (dp->dots < opt.dots_in_line);
dp->accumulated = remainder;
if (dp->total_length)
{
/* Round to floor value to provide gauge how much data *has*
- been retrieved. 12.8% will round to 12% because the 13% mark
- has not yet been reached. 100% is only shown when done. */
+ been retrieved. 12.8% will round to 12% because the 13% mark
+ has not yet been reached. 100% is only shown when done. */
int percentage = 100.0 * bytes_displayed / dp->total_length;
logprintf (LOG_VERBOSE, "%3d%%", percentage);
}
bytes_this_row -= dp->initial_length % ROW_BYTES;
rate = calc_rate (bytes_this_row, dltime - dp->last_timer_value, &units);
logprintf (LOG_VERBOSE, " %4.*f%c",
- rate >= 99.95 ? 0 : rate >= 9.995 ? 1 : 2,
- rate, names[units]);
+ rate >= 99.95 ? 0 : rate >= 9.995 ? 1 : 2,
+ rate, names[units]);
dp->last_timer_value = dltime;
}
if (!last)
{
/* Display ETA based on average speed. Inspired by Vladi
- Belperchinov-Shabanski's "wget-new-percentage" patch. */
+ Belperchinov-Shabanski's "wget-new-percentage" patch. */
if (dp->total_length)
- {
- wgint bytes_remaining = dp->total_length - bytes_displayed;
- /* The quantity downloaded in this download run. */
- wgint bytes_sofar = bytes_displayed - dp->initial_length;
- int eta = (int) (dltime * bytes_remaining / bytes_sofar + 0.5);
- logprintf (LOG_VERBOSE, " %s", eta_to_human_short (eta, true));
- }
+ {
+ wgint bytes_remaining = dp->total_length - bytes_displayed;
+ /* The quantity downloaded in this download run. */
+ wgint bytes_sofar = bytes_displayed - dp->initial_length;
+ double eta = dltime * bytes_remaining / bytes_sofar;
+ if (eta < INT_MAX - 1)
+ logprintf (LOG_VERBOSE, " %s",
+ eta_to_human_short ((int) (eta + 0.5), true));
+ }
}
else
{
/* When done, print the total download time */
if (dltime >= 10)
- logprintf (LOG_VERBOSE, "=%s",
- eta_to_human_short ((int) (dltime + 0.5), true));
+ logprintf (LOG_VERBOSE, "=%s",
+ eta_to_human_short ((int) (dltime + 0.5), true));
else
- logprintf (LOG_VERBOSE, "=%ss", print_decimal (dltime));
+ logprintf (LOG_VERBOSE, "=%ss", print_decimal (dltime));
}
}
for (; dp->accumulated >= dot_bytes; dp->accumulated -= dot_bytes)
{
if (dp->dots == 0)
- logprintf (LOG_VERBOSE, "\n%6sK",
- number_to_static_string (dp->rows * ROW_BYTES / 1024));
+ logprintf (LOG_VERBOSE, "\n%6sK",
+ number_to_static_string (dp->rows * ROW_BYTES / 1024));
if (dp->dots % opt.dot_spacing == 0)
- logputs (LOG_VERBOSE, " ");
+ logputs (LOG_VERBOSE, " ");
logputs (LOG_VERBOSE, ".");
++dp->dots;
if (dp->dots >= opt.dots_in_line)
- {
- ++dp->rows;
- dp->dots = 0;
+ {
+ ++dp->rows;
+ dp->dots = 0;
- print_row_stats (dp, dltime, false);
- }
+ print_row_stats (dp, dltime, false);
+ }
}
log_set_flush (true);
if (dp->dots == 0)
logprintf (LOG_VERBOSE, "\n%6sK",
- number_to_static_string (dp->rows * ROW_BYTES / 1024));
+ number_to_static_string (dp->rows * ROW_BYTES / 1024));
for (i = dp->dots; i < opt.dots_in_line; i++)
{
if (i % opt.dot_spacing == 0)
- logputs (LOG_VERBOSE, " ");
+ logputs (LOG_VERBOSE, " ");
logputs (LOG_VERBOSE, " ");
}
if (!strcasecmp (params, "default"))
{
/* Default style: 1K dots, 10 dots in a cluster, 50 dots in a
- line. */
+ line. */
opt.dot_bytes = 1024;
opt.dot_spacing = 10;
opt.dots_in_line = 50;
else if (!strcasecmp (params, "binary"))
{
/* "Binary" retrieval: 8K dots, 16 dots in a cluster, 48 dots
- (384K) in a line. */
+ (384K) in a line. */
opt.dot_bytes = 8192;
opt.dot_spacing = 16;
opt.dots_in_line = 48;
else if (!strcasecmp (params, "mega"))
{
/* "Mega" retrieval, for retrieving very long files; each dot is
- 64K, 8 dots in a cluster, 6 clusters (3M) in a line. */
+ 64K, 8 dots in a cluster, 6 clusters (3M) in a line. */
opt.dot_bytes = 65536L;
opt.dot_spacing = 8;
opt.dots_in_line = 48;
else if (!strcasecmp (params, "giga"))
{
/* "Giga" retrieval, for retrieving very very *very* long files;
- each dot is 1M, 8 dots in a cluster, 4 clusters (32M) in a
- line. */
+ each dot is 1M, 8 dots in a cluster, 4 clusters (32M) in a
+ line. */
opt.dot_bytes = (1L << 20);
opt.dot_spacing = 8;
opt.dots_in_line = 32;
}
else
fprintf (stderr,
- _("Invalid dot style specification `%s'; leaving unchanged.\n"),
- params);
+ _("Invalid dot style specification `%s'; leaving unchanged.\n"),
+ params);
}
\f
/* "Thermometer" (bar) progress. */
download speeds are scratched. */
#define STALL_START_TIME 5
+/* Time between screen refreshes will not be shorter than this, so
+ that Wget doesn't swamp the TTY with output. */
+#define REFRESH_INTERVAL 0.2
+
+/* Don't refresh the ETA too often to avoid jerkiness in predictions.
+ This allows ETA to change approximately once per second. */
+#define ETA_REFRESH_INTERVAL 0.99
+
struct bar_progress {
- wgint initial_length; /* how many bytes have been downloaded
- previously. */
- wgint total_length; /* expected total byte count when the
- download finishes */
- wgint count; /* bytes downloaded so far */
-
- double last_screen_update; /* time of the last screen update,
- measured since the beginning of
- download. */
-
- int width; /* screen width we're using at the
- time the progress gauge was
- created. this is different from
- the screen_width global variable in
- that the latter can be changed by a
- signal. */
- char *buffer; /* buffer where the bar "image" is
- stored. */
- int tick; /* counter used for drawing the
- progress bar where the total size
- is not known. */
+ wgint initial_length; /* how many bytes have been downloaded
+ previously. */
+ wgint total_length; /* expected total byte count when the
+ download finishes */
+ wgint count; /* bytes downloaded so far */
+
+ double last_screen_update; /* time of the last screen update,
+ measured since the beginning of
+ download. */
+
+ int width; /* screen width we're using at the
+ time the progress gauge was
+ created. this is different from
+ the screen_width global variable in
+ that the latter can be changed by a
+ signal. */
+ char *buffer; /* buffer where the bar "image" is
+ stored. */
+ int tick; /* counter used for drawing the
+ progress bar where the total size
+ is not known. */
/* The following variables (kept in a struct for namespace reasons)
keep track of recent download speeds. See bar_update() for
wgint total_bytes;
} hist;
- double recent_start; /* timestamp of beginning of current
- position. */
- wgint recent_bytes; /* bytes downloaded so far. */
+ double recent_start; /* timestamp of beginning of current
+ position. */
+ wgint recent_bytes; /* bytes downloaded so far. */
- bool stalled; /* set when no data arrives for longer
- than STALL_START_TIME, then reset
- when new data arrives. */
+ bool stalled; /* set when no data arrives for longer
+ than STALL_START_TIME, then reset
+ when new data arrives. */
/* create_image() uses these to make sure that ETA information
doesn't flicker. */
- double last_eta_time; /* time of the last update to download
- speed and ETA, measured since the
- beginning of download. */
+ double last_eta_time; /* time of the last update to download
+ speed and ETA, measured since the
+ beginning of download. */
int last_eta_value;
};
{
screen_width = determine_screen_width ();
if (!screen_width)
- screen_width = DEFAULT_SCREEN_WIDTH;
+ screen_width = DEFAULT_SCREEN_WIDTH;
else if (screen_width < MINIMUM_SCREEN_WIDTH)
- screen_width = MINIMUM_SCREEN_WIDTH;
+ screen_width = MINIMUM_SCREEN_WIDTH;
received_sigwinch = 0;
}
int old_width = screen_width;
screen_width = determine_screen_width ();
if (!screen_width)
- screen_width = DEFAULT_SCREEN_WIDTH;
+ screen_width = DEFAULT_SCREEN_WIDTH;
else if (screen_width < MINIMUM_SCREEN_WIDTH)
- screen_width = MINIMUM_SCREEN_WIDTH;
+ screen_width = MINIMUM_SCREEN_WIDTH;
if (screen_width != old_width)
- {
- bp->width = screen_width - 1;
- bp->buffer = xrealloc (bp->buffer, bp->width + 1);
- force_screen_update = true;
- }
+ {
+ bp->width = screen_width - 1;
+ bp->buffer = xrealloc (bp->buffer, bp->width + 1);
+ force_screen_update = true;
+ }
received_sigwinch = 0;
}
- if (dltime - bp->last_screen_update < 0.2 && !force_screen_update)
+ if (dltime - bp->last_screen_update < REFRESH_INTERVAL && !force_screen_update)
/* Don't update more often than five times per second. */
return;
if (howmuch == 0)
{
/* If we're not downloading anything, we might be stalling,
- i.e. not downloading anything for an extended period of time.
- Since 0-reads do not enter the history ring, recent_age
- effectively measures the time since last read. */
+ i.e. not downloading anything for an extended period of time.
+ Since 0-reads do not enter the history ring, recent_age
+ effectively measures the time since last read. */
if (recent_age >= STALL_START_TIME)
- {
- /* If we're stalling, reset the ring contents because it's
- stale and because it will make bar_update stop printing
- the (bogus) current bandwidth. */
- bp->stalled = true;
- xzero (*hist);
- bp->recent_bytes = 0;
- }
+ {
+ /* If we're stalling, reset the ring contents because it's
+ stale and because it will make bar_update stop printing
+ the (bogus) current bandwidth. */
+ bp->stalled = true;
+ xzero (*hist);
+ bp->recent_bytes = 0;
+ }
return;
}
{
bp->stalled = false;
/* "recent_age" includes the the entired stalled period, which
- could be very long. Don't update the speed ring with that
- value because the current bandwidth would start too small.
- Start with an arbitrary (but more reasonable) time value and
- let it level out. */
+ could be very long. Don't update the speed ring with that
+ value because the current bandwidth would start too small.
+ Start with an arbitrary (but more reasonable) time value and
+ let it level out. */
recent_age = 1;
}
double sumt = 0, sumb = 0;
for (i = 0; i < DLSPEED_HISTORY_SIZE; i++)
{
- sumt += hist->times[i];
- sumb += hist->bytes[i];
+ sumt += hist->times[i];
+ sumb += hist->bytes[i];
}
assert (sumb == hist->total_bytes);
/* We can't use assert(sumt==hist->total_time) because some
#endif
}
-#define APPEND_LITERAL(s) do { \
- memcpy (p, s, sizeof (s) - 1); \
- p += sizeof (s) - 1; \
+#define APPEND_LITERAL(s) do { \
+ memcpy (p, s, sizeof (s) - 1); \
+ p += sizeof (s) - 1; \
} while (0)
/* Use move_to_end (s) to get S to point the end of the string (the
assert (percentage <= 100);
if (percentage < 100)
- sprintf (p, "%2d%% ", percentage);
+ sprintf (p, "%2d%% ", percentage);
else
- strcpy (p, "100%");
+ strcpy (p, "100%");
p += 4;
}
else
begin = p;
/* Print the initial portion of the download with '+' chars, the
- rest with '=' and one '>'. */
+ rest with '=' and one '>'. */
for (i = 0; i < insz; i++)
- *p++ = '+';
+ *p++ = '+';
dlsz -= insz;
if (dlsz > 0)
- {
- for (i = 0; i < dlsz - 1; i++)
- *p++ = '=';
- *p++ = '>';
- }
+ {
+ for (i = 0; i < dlsz - 1; i++)
+ *p++ = '=';
+ *p++ = '>';
+ }
while (p - begin < progress_size)
- *p++ = ' ';
+ *p++ = ' ';
*p++ = ']';
}
else if (progress_size)
{
/* If we can't draw a real progress bar, then at least show
- *something* to the user. */
+ *something* to the user. */
int ind = bp->tick % (progress_size * 2 - 6);
int i, pos;
/* Make the star move in two directions. */
if (ind < progress_size - 2)
- pos = ind + 1;
+ pos = ind + 1;
else
- pos = progress_size - (ind - progress_size + 5);
+ pos = progress_size - (ind - progress_size + 5);
*p++ = '[';
for (i = 0; i < progress_size; i++)
- {
- if (i == pos - 1) *p++ = '<';
- else if (i == pos ) *p++ = '=';
- else if (i == pos + 1) *p++ = '>';
- else
- *p++ = ' ';
- }
+ {
+ if (i == pos - 1) *p++ = '<';
+ else if (i == pos ) *p++ = '=';
+ else if (i == pos + 1) *p++ = '>';
+ else
+ *p++ = ' ';
+ }
*p++ = ']';
++bp->tick;
static const char *short_units[] = { "B/s", "K/s", "M/s", "G/s" };
int units = 0;
/* Calculate the download speed using the history ring and
- recent data that hasn't made it to the ring yet. */
+ recent data that hasn't made it to the ring yet. */
wgint dlquant = hist->total_bytes + bp->recent_bytes;
double dltime = hist->total_time + (dl_total_time - bp->recent_start);
double dlspeed = calc_rate (dlquant, dltime, &units);
sprintf (p, " %4.*f%s", dlspeed >= 99.95 ? 0 : dlspeed >= 9.995 ? 1 : 2,
- dlspeed, short_units[units]);
+ dlspeed, short_units[units]);
move_to_end (p);
}
else
if (!done)
{
/* " eta ..m ..s"; wait for three seconds before displaying the ETA.
- That's because the ETA value needs a while to become
- reliable. */
+ That's because the ETA value needs a while to become
+ reliable. */
if (bp->total_length > 0 && bp->count > 0 && dl_total_time > 3)
- {
- int eta;
-
- /* Don't change the value of ETA more than approximately once
- per second; doing so would cause flashing without providing
- any value to the user. */
- if (bp->total_length != size
- && bp->last_eta_value != 0
- && dl_total_time - bp->last_eta_time < 0.9)
- eta = bp->last_eta_value;
- else
- {
- /* Calculate ETA using the average download speed to predict
- the future speed. If you want to use a speed averaged
- over a more recent period, replace dl_total_time with
- hist->total_time and bp->count with hist->total_bytes.
- I found that doing that results in a very jerky and
- ultimately unreliable ETA. */
- wgint bytes_remaining = bp->total_length - size;
- eta = (int) (dl_total_time * bytes_remaining / bp->count + 0.5);
- bp->last_eta_value = eta;
- bp->last_eta_time = dl_total_time;
- }
-
- /* Translation note: "ETA" is English-centric, but this must
- be short, ideally 3 chars. Abbreviate if necessary. */
- sprintf (p, _(" eta %s"), eta_to_human_short (eta, false));
- move_to_end (p);
- }
+ {
+ int eta;
+
+ /* Don't change the value of ETA more than approximately once
+ per second; doing so would cause flashing without providing
+ any value to the user. */
+ if (bp->total_length != size
+ && bp->last_eta_value != 0
+ && dl_total_time - bp->last_eta_time < ETA_REFRESH_INTERVAL)
+ eta = bp->last_eta_value;
+ else
+ {
+ /* Calculate ETA using the average download speed to predict
+ the future speed. If you want to use a speed averaged
+ over a more recent period, replace dl_total_time with
+ hist->total_time and bp->count with hist->total_bytes.
+ I found that doing that results in a very jerky and
+ ultimately unreliable ETA. */
+ wgint bytes_remaining = bp->total_length - size;
+ double eta_ = dl_total_time * bytes_remaining / bp->count;
+ if (eta_ >= INT_MAX - 1)
+ goto skip_eta;
+ eta = (int) (eta_ + 0.5);
+ bp->last_eta_value = eta;
+ bp->last_eta_time = dl_total_time;
+ }
+
+ /* Translation note: "ETA" is English-centric, but this must
+ be short, ideally 3 chars. Abbreviate if necessary. */
+ sprintf (p, _(" eta %s"), eta_to_human_short (eta, false));
+ move_to_end (p);
+ }
else if (bp->total_length > 0)
- {
- APPEND_LITERAL (" ");
- }
+ {
+ skip_eta:
+ APPEND_LITERAL (" ");
+ }
}
else
{
/* When the download is done, print the elapsed time. */
/* Note to translators: this should not take up more room than
- available here. Abbreviate if necessary. */
+ available here. Abbreviate if necessary. */
strcpy (p, _(" in "));
- move_to_end (p); /* not p+=6, think translations! */
+ move_to_end (p); /* not p+=6, think translations! */
if (dl_total_time >= 10)
- strcpy (p, eta_to_human_short ((int) (dl_total_time + 0.5), false));
+ strcpy (p, eta_to_human_short ((int) (dl_total_time + 0.5), false));
else
- sprintf (p, "%ss", print_decimal (dl_total_time));
+ sprintf (p, "%ss", print_decimal (dl_total_time));
move_to_end (p);
}
if ((opt.lfilename
#ifdef HAVE_ISATTY
/* The progress bar doesn't make sense if the output is not a
- TTY -- when logging to file, it is better to review the
- dots. */
+ TTY -- when logging to file, it is better to review the
+ dots. */
|| !isatty (fileno (stderr))
#endif
/* Normally we don't depend on terminal type because the
- progress bar only uses ^M to move the cursor to the
- beginning of line, which works even on dumb terminals. But
- Jamie Zawinski reports that ^M and ^H tricks don't work in
- Emacs shell buffers, and only make a mess. */
+ progress bar only uses ^M to move the cursor to the
+ beginning of line, which works even on dumb terminals. But
+ Jamie Zawinski reports that ^M and ^H tricks don't work in
+ Emacs shell buffers, and only make a mess. */
|| (term && 0 == strcmp (term, "emacs"))
)
&& !current_impl_locked)
{
/* We're not printing to a TTY, so revert to the fallback
- display. #### We're recursively calling
- set_progress_implementation here, which is slightly kludgy.
- It would be nicer if we provided that function a return value
- indicating a failure of some sort. */
+ display. #### We're recursively calling
+ set_progress_implementation here, which is slightly kludgy.
+ It would be nicer if we provided that function a return value
+ indicating a failure of some sort. */
set_progress_implementation (FALLBACK_PROGRESS_IMPLEMENTATION);
return;
}
static const char *
eta_to_human_short (int secs, bool condensed)
{
- static char buf[10]; /* 8 should be enough, but just in case */
+ static char buf[10]; /* 8 should be enough, but just in case */
static int last = -1;
const char *space = condensed ? "" : " ";
projects / wget / blobdiff