X-Git-Url: http://sjero.net/git/?p=wget;a=blobdiff_plain;f=src%2Fprogress.c;h=27501c6739b044fea6187ba185c606a3e2321e86;hp=28ad27de3a010e27b020e46ab926b9cb3b5a5eff;hb=40f4de9ae9d4e6527b6e04c76f3a309cc94325a6;hpb=908d7a4bcee5adb7d4768499282cc83075d0332e diff --git a/src/progress.c b/src/progress.c index 28ad27de..27501c67 100644 --- a/src/progress.c +++ b/src/progress.c @@ -45,7 +45,7 @@ so, delete this exception statement from your version. */ struct progress_implementation { const char *name; - int interactive; + bool interactive; void *(*create) (wgint, wgint); void (*update) (void *, wgint, double); void (*finish) (void *, double); @@ -76,7 +76,7 @@ static int current_impl_locked; #define DEFAULT_PROGRESS_IMPLEMENTATION "bar" -/* Fallnback progress implementation should be something that works +/* Fallback progress implementation should be something that works under all display types. If you put something other than "dot" here, remember that bar_set_params tries to switch to this if we're not running on a TTY. So changing this to "bar" could cause @@ -84,10 +84,10 @@ static int current_impl_locked; #define FALLBACK_PROGRESS_IMPLEMENTATION "dot" -/* Return non-zero if NAME names a valid progress bar implementation. - The characters after the first : will be ignored. */ +/* Return true if NAME names a valid progress bar implementation. The + characters after the first : will be ignored. */ -int +bool valid_progress_implementation_p (const char *name) { int i; @@ -97,8 +97,8 @@ valid_progress_implementation_p (const char *name) for (i = 0; i < countof (implementations); i++, pi++) if (!strncmp (pi->name, name, namelen)) - return 1; - return 0; + return true; + return false; } /* Set the progress implementation to NAME. */ @@ -108,7 +108,7 @@ set_progress_implementation (const char *name) { int i, namelen; struct progress_implementation *pi = implementations; - char *colon; + const char *colon; if (!name) name = DEFAULT_PROGRESS_IMPLEMENTATION; @@ -163,12 +163,12 @@ progress_create (wgint initial, wgint total) return current_impl->create (initial, total); } -/* Return non-zero if the progress gauge is "interactive", i.e. if it - can profit from being called regularly even in absence of data. - The progress bar is interactive because it regularly updates the - ETA and current update. */ +/* Return true if the progress gauge is "interactive", i.e. if it can + profit from being called regularly even in absence of data. The + progress bar is interactive because it regularly updates the ETA + and current update. */ -int +bool progress_interactive_p (void *progress) { return current_impl->interactive; @@ -200,10 +200,12 @@ struct dot_progress { wgint total_length; /* expected total byte count when the download finishes */ - int accumulated; + 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 */ + double last_timer_value; }; @@ -219,26 +221,28 @@ dot_create (wgint initial, wgint total) if (dp->initial_length) { int dot_bytes = opt.dot_bytes; - wgint row_bytes = opt.dot_bytes * opt.dots_in_line; + const wgint ROW_BYTES = opt.dot_bytes * opt.dots_in_line; - int remainder = (int) (dp->initial_length % row_bytes); + int remainder = dp->initial_length % ROW_BYTES; wgint skipped = dp->initial_length - remainder; if (skipped) { - int skipped_k = (int) (skipped / 1024); /* skipped amount in K */ + wgint skipped_k = skipped / 1024; /* skipped amount in K */ int skipped_k_len = numdigit (skipped_k); - if (skipped_k_len < 5) - skipped_k_len = 5; + 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 %dK ]"), - 2 + skipped_k_len, "", skipped_k); + logprintf (LOG_VERBOSE, _("\n%*s[ skipping %sK ]"), + 2 + skipped_k_len, "", + number_to_static_string (skipped_k)); } - logprintf (LOG_VERBOSE, "\n%5ldK", (long) (skipped / 1024)); + logprintf (LOG_VERBOSE, "\n%6sK", + number_to_static_string (skipped / 1024)); for (; remainder >= dot_bytes; remainder -= dot_bytes) { if (dp->dots % opt.dot_spacing == 0) @@ -249,25 +253,88 @@ dot_create (wgint initial, wgint total) assert (dp->dots < opt.dots_in_line); dp->accumulated = remainder; - dp->rows = skipped / row_bytes; + dp->rows = skipped / ROW_BYTES; } return dp; } -static void -print_percentage (wgint bytes, wgint expected) -{ - int percentage = (int)(100.0 * bytes / expected); - logprintf (LOG_VERBOSE, "%3d%%", percentage); -} +static const char *eta_to_human_short (int, bool); + +/* Prints the stats (percentage of completion, speed, ETA) for current + row. DLTIME is the time spent downloading the data in current + row. + + #### This function is somewhat uglified by the fact that current + row and last row have somewhat different stats requirements. It + might be worthwhile to split it to two different functions. */ static void -print_download_speed (struct dot_progress *dp, wgint bytes, double dltime) +print_row_stats (struct dot_progress *dp, double dltime, bool last) { - logprintf (LOG_VERBOSE, " %s", - retr_rate (bytes, dltime - dp->last_timer_value, 1)); - dp->last_timer_value = dltime; + const wgint ROW_BYTES = opt.dot_bytes * opt.dots_in_line; + + /* bytes_displayed is the number of bytes indicated to the user by + dots printed so far, includes the initially "skipped" amount */ + wgint bytes_displayed = dp->rows * ROW_BYTES + dp->dots * opt.dot_bytes; + + if (last) + /* For last row also count bytes accumulated after last dot */ + bytes_displayed += dp->accumulated; + + 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. */ + int percentage = 100.0 * bytes_displayed / dp->total_length; + logprintf (LOG_VERBOSE, "%3d%%", percentage); + } + + { + static char names[] = {' ', 'K', 'M', 'G'}; + int units; + double rate; + wgint bytes_this_row; + if (!last) + bytes_this_row = ROW_BYTES; + else + /* For last row also include bytes accumulated after last dot. */ + bytes_this_row = dp->dots * opt.dot_bytes + dp->accumulated; + /* Don't count the portion of the row belonging to initial_length */ + if (dp->rows == dp->initial_length / ROW_BYTES) + 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 >= 100 ? 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. */ + 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; + double secs_sofar = dltime / 1000; + int eta = (int) (secs_sofar * bytes_remaining / bytes_sofar + 0.5); + logprintf (LOG_VERBOSE, " %s", eta_to_human_short (eta, true)); + } + } + else + { + /* When done, print the total download time */ + double secs = dltime / 1000; + if (secs >= 10) + logprintf (LOG_VERBOSE, "=%s", + eta_to_human_short ((int) (secs + 0.5), true)); + else + logprintf (LOG_VERBOSE, "=%ss", print_decimal (secs)); + } } /* Dot-progress backend for progress_update. */ @@ -277,15 +344,16 @@ dot_update (void *progress, wgint howmuch, double dltime) { struct dot_progress *dp = progress; int dot_bytes = opt.dot_bytes; - wgint row_bytes = opt.dot_bytes * opt.dots_in_line; + wgint ROW_BYTES = opt.dot_bytes * opt.dots_in_line; - log_set_flush (0); + log_set_flush (false); dp->accumulated += howmuch; for (; dp->accumulated >= dot_bytes; dp->accumulated -= dot_bytes) { if (dp->dots == 0) - logprintf (LOG_VERBOSE, "\n%5ldK", (long) (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, " "); @@ -294,20 +362,18 @@ dot_update (void *progress, wgint howmuch, double dltime) ++dp->dots; if (dp->dots >= opt.dots_in_line) { - wgint row_qty = row_bytes; - if (dp->rows == dp->initial_length / row_bytes) - row_qty -= dp->initial_length % row_bytes; + wgint row_qty = ROW_BYTES; + if (dp->rows == dp->initial_length / ROW_BYTES) + row_qty -= dp->initial_length % ROW_BYTES; ++dp->rows; dp->dots = 0; - if (dp->total_length) - print_percentage (dp->rows * row_bytes, dp->total_length); - print_download_speed (dp, row_qty, dltime); + print_row_stats (dp, dltime, false); } } - log_set_flush (1); + log_set_flush (true); } /* Dot-progress backend for progress_finish. */ @@ -316,37 +382,24 @@ static void dot_finish (void *progress, double dltime) { struct dot_progress *dp = progress; - int dot_bytes = opt.dot_bytes; - wgint row_bytes = opt.dot_bytes * opt.dots_in_line; + wgint ROW_BYTES = opt.dot_bytes * opt.dots_in_line; int i; - log_set_flush (0); + log_set_flush (false); if (dp->dots == 0) - logprintf (LOG_VERBOSE, "\n%5ldK", (long) (dp->rows * row_bytes / 1024)); + logprintf (LOG_VERBOSE, "\n%6sK", + 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, " "); } - if (dp->total_length) - { - print_percentage (dp->rows * row_bytes - + dp->dots * dot_bytes - + dp->accumulated, - dp->total_length); - } - - { - wgint row_qty = dp->dots * dot_bytes + dp->accumulated; - if (dp->rows == dp->initial_length / row_bytes) - row_qty -= dp->initial_length % row_bytes; - print_download_speed (dp, row_qty, dltime); - } + print_row_stats (dp, dltime, true); logputs (LOG_VERBOSE, "\n\n"); - log_set_flush (0); + log_set_flush (false); xfree (dp); } @@ -477,7 +530,7 @@ struct bar_progress { position. */ wgint recent_bytes; /* bytes downloaded so far. */ - int stalled; /* set when no data arrives for longer + bool stalled; /* set when no data arrives for longer than STALL_START_TIME, then reset when new data arrives. */ @@ -486,10 +539,10 @@ struct bar_progress { double last_eta_time; /* time of the last update to download speed and ETA, measured since the beginning of download. */ - wgint last_eta_value; + int last_eta_value; }; -static void create_image (struct bar_progress *, double); +static void create_image (struct bar_progress *, double, bool); static void display_image (char *); static void * @@ -524,7 +577,7 @@ bar_create (wgint initial, wgint total) logputs (LOG_VERBOSE, "\n"); - create_image (bp, 0); + create_image (bp, 0, false); display_image (bp->buffer); return bp; @@ -536,7 +589,7 @@ static void bar_update (void *progress, wgint howmuch, double dltime) { struct bar_progress *bp = progress; - int force_screen_update = 0; + bool force_screen_update = false; bp->count += howmuch; if (bp->total_length > 0 @@ -564,7 +617,7 @@ bar_update (void *progress, wgint howmuch, double dltime) { bp->width = screen_width - 1; bp->buffer = xrealloc (bp->buffer, bp->width + 1); - force_screen_update = 1; + force_screen_update = true; } received_sigwinch = 0; } @@ -573,7 +626,7 @@ bar_update (void *progress, wgint howmuch, double dltime) /* Don't update more often than five times per second. */ return; - create_image (bp, dltime); + create_image (bp, dltime, false); display_image (bp->buffer); bp->last_screen_update = dltime; } @@ -588,7 +641,7 @@ bar_finish (void *progress, double dltime) /* See bar_update() for explanation. */ bp->total_length = bp->initial_length + bp->count; - create_image (bp, dltime); + create_image (bp, dltime, true); display_image (bp->buffer); logputs (LOG_VERBOSE, "\n\n"); @@ -641,7 +694,7 @@ update_speed_ring (struct bar_progress *bp, wgint howmuch, double dltime) /* 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 = 1; + bp->stalled = true; xzero (*hist); bp->recent_bytes = 0; } @@ -653,7 +706,7 @@ update_speed_ring (struct bar_progress *bp, wgint howmuch, double dltime) /* If the stall status was acquired, reset it. */ if (bp->stalled) { - bp->stalled = 0; + 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. @@ -705,23 +758,28 @@ update_speed_ring (struct bar_progress *bp, wgint howmuch, double dltime) p += sizeof (s) - 1; \ } while (0) +/* Use move_to_end (s) to get S to point the end of the string (the + terminating \0). This is faster than s+=strlen(s), but some people + are confused when they see strchr (s, '\0') in the code. */ +#define move_to_end(s) s = strchr (s, '\0'); + #ifndef MAX # define MAX(a, b) ((a) >= (b) ? (a) : (b)) #endif static void -create_image (struct bar_progress *bp, double dl_total_time) +create_image (struct bar_progress *bp, double dl_total_time, bool done) { char *p = bp->buffer; wgint size = bp->initial_length + bp->count; - char *size_legible = with_thousand_seps (size); - int size_legible_len = strlen (size_legible); + const char *size_grouped = with_thousand_seps (size); + int size_grouped_len = strlen (size_grouped); struct bar_progress_hist *hist = &bp->hist; /* The progress bar should look like this: - xx% [=======> ] nn,nnn 12.34K/s ETA 00:00 + xx% [=======> ] nn,nnn 12.34K/s eta 36m 51s Calculate the geometry. The idea is to assign as much room as possible to the progress bar. The other idea is to never let @@ -734,11 +792,11 @@ create_image (struct bar_progress *bp, double dl_total_time) "[]" - progress bar decorations - 2 chars " nnn,nnn,nnn" - downloaded bytes - 12 chars or very rarely more " 1012.56K/s" - dl rate - 11 chars - " ETA xx:xx:xx" - ETA - 13 chars + " eta 36m 51s" - ETA - 13 chars "=====>..." - progress bar - the rest */ - int dlbytes_size = 1 + MAX (size_legible_len, 11); + int dlbytes_size = 1 + MAX (size_grouped_len, 11); int progress_size = bp->width - (4 + 2 + dlbytes_size + 11 + 13); if (progress_size < 5) @@ -747,8 +805,7 @@ create_image (struct bar_progress *bp, double dl_total_time) /* "xx% " */ if (bp->total_length > 0) { - int percentage = (int)(100.0 * size / bp->total_length); - + int percentage = 100.0 * size / bp->total_length; assert (percentage <= 100); if (percentage < 100) @@ -822,8 +879,8 @@ create_image (struct bar_progress *bp, double dl_total_time) } /* " 234,567,890" */ - sprintf (p, " %-11s", with_thousand_seps (size)); - p += strlen (p); + sprintf (p, " %-11s", size_grouped); + move_to_end (p); /* " 1012.45K/s" */ if (hist->total_time && hist->total_bytes) @@ -836,67 +893,65 @@ create_image (struct bar_progress *bp, double dl_total_time) double dltime = hist->total_time + (dl_total_time - bp->recent_start); double dlspeed = calc_rate (dlquant, dltime, &units); sprintf (p, " %7.2f%s", dlspeed, short_units[units]); - p += strlen (p); + move_to_end (p); } else APPEND_LITERAL (" --.--K/s"); - /* " ETA xx:xx:xx"; wait for three seconds before displaying the ETA. - That's because the ETA value needs a while to become - reliable. */ - if (bp->total_length > 0 && bp->count > 0 && dl_total_time > 3000) + if (!done) { - wgint eta; - int eta_hrs, eta_min, eta_sec; - - /* 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 < 900) - 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. */ - double time_sofar = (double)dl_total_time / 1000; - wgint bytes_remaining = bp->total_length - size; - eta = (wgint) (time_sofar * bytes_remaining / bp->count); - bp->last_eta_value = eta; - bp->last_eta_time = dl_total_time; - } - - eta_hrs = eta / 3600, eta %= 3600; - eta_min = eta / 60, eta %= 60; - eta_sec = eta; - - if (eta_hrs > 99) - goto no_eta; - - if (eta_hrs == 0) + /* " eta ..m ..s"; wait for three seconds before displaying the ETA. + That's because the ETA value needs a while to become + reliable. */ + if (bp->total_length > 0 && bp->count > 0 && dl_total_time > 3000) { - /* Hours not printed: pad with three spaces. */ - APPEND_LITERAL (" "); - sprintf (p, " ETA %02d:%02d", eta_min, eta_sec); + 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 < 900) + 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. */ + double time_sofar = (double) dl_total_time / 1000; + wgint bytes_remaining = bp->total_length - size; + eta = (int) (time_sofar * 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); } - else + else if (bp->total_length > 0) { - if (eta_hrs < 10) - /* Hours printed with one digit: pad with one space. */ - *p++ = ' '; - sprintf (p, " ETA %d:%02d:%02d", eta_hrs, eta_min, eta_sec); + APPEND_LITERAL (" "); } - p += strlen (p); } - else if (bp->total_length > 0) + else { - no_eta: - APPEND_LITERAL (" "); + /* When the download is done, print the elapsed time. */ + double secs = dl_total_time / 1000; + /* Note to translators: this should not take up more room than + available here. Abbreviate if necessary. */ + strcpy (p, _(" in ")); + move_to_end (p); /* not p+=6, think translations! */ + if (secs >= 10) + strcpy (p, eta_to_human_short ((int) (secs + 0.5), false)); + else + sprintf (p, "%ss", print_decimal (secs)); + move_to_end (p); } assert (p - bp->buffer <= bp->width); @@ -912,7 +967,7 @@ create_image (struct bar_progress *bp, double dl_total_time) static void display_image (char *buf) { - int old = log_set_save_context (0); + bool old = log_set_save_context (false); logputs (LOG_VERBOSE, "\r"); logputs (LOG_VERBOSE, buf); log_set_save_context (old); @@ -961,3 +1016,48 @@ progress_handle_sigwinch (int sig) signal (SIGWINCH, progress_handle_sigwinch); } #endif + +/* Provide a short human-readable rendition of the ETA. This is like + secs_to_human_time in main.c, except the output doesn't include + fractions (which would look silly in by nature imprecise ETA) and + takes less room. If the time is measured in hours, hours and + minutes (but not seconds) are shown; if measured in days, then days + and hours are shown. This ensures brevity while still displaying + as much as possible. + + If CONDENSED is true, the separator between minutes and seconds + (and hours and minutes, etc.) is not included, shortening the + display by one additional character. This is used for dot + progress. + + The display never occupies more than 7 characters of screen + space. */ + +static const char * +eta_to_human_short (int secs, bool condensed) +{ + static char buf[10]; /* 8 should be enough, but just in case */ + static int last = -1; + const char *space = condensed ? "" : " "; + + /* Trivial optimization. create_image can call us every 200 msecs + (see bar_update) for fast downloads, but ETA will only change + once per 900 msecs. */ + if (secs == last) + return buf; + last = secs; + + if (secs < 100) + sprintf (buf, "%ds", secs); + else if (secs < 100 * 60) + sprintf (buf, "%dm%s%ds", secs / 60, space, secs % 60); + else if (secs < 100 * 3600) + sprintf (buf, "%dh%s%dm", secs / 3600, space, (secs / 60) % 60); + else if (secs < 100 * 86400) + sprintf (buf, "%dd%s%dh", secs / 86400, space, (secs / 3600) % 60); + else + /* even (2^31-1)/86400 doesn't overflow BUF. */ + sprintf (buf, "%dd", secs / 86400); + + return buf; +}