2 Copyright (C) 2001-2006 Free Software Foundation, Inc.
4 This file is part of GNU Wget.
6 GNU Wget is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 GNU Wget is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with Wget; if not, write to the Free Software Foundation, Inc.,
18 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 In addition, as a special exception, the Free Software Foundation
21 gives permission to link the code of its release of Wget with the
22 OpenSSL project's "OpenSSL" library (or with modified versions of it
23 that use the same license as the "OpenSSL" library), and distribute
24 the linked executables. You must obey the GNU General Public License
25 in all respects for all of the code used other than "OpenSSL". If you
26 modify this file, you may extend this exception to your version of the
27 file, but you are not obligated to do so. If you do not wish to do
28 so, delete this exception statement from your version. */
46 struct progress_implementation {
49 void *(*create) (wgint, wgint);
50 void (*update) (void *, wgint, double);
51 void (*finish) (void *, double);
52 void (*set_params) (const char *);
55 /* Necessary forward declarations. */
57 static void *dot_create (wgint, wgint);
58 static void dot_update (void *, wgint, double);
59 static void dot_finish (void *, double);
60 static void dot_set_params (const char *);
62 static void *bar_create (wgint, wgint);
63 static void bar_update (void *, wgint, double);
64 static void bar_finish (void *, double);
65 static void bar_set_params (const char *);
67 static struct progress_implementation implementations[] = {
68 { "dot", 0, dot_create, dot_update, dot_finish, dot_set_params },
69 { "bar", 1, bar_create, bar_update, bar_finish, bar_set_params }
71 static struct progress_implementation *current_impl;
72 static int current_impl_locked;
74 /* Progress implementation used by default. Can be overriden in
75 wgetrc or by the fallback one. */
77 #define DEFAULT_PROGRESS_IMPLEMENTATION "bar"
79 /* Fallback progress implementation should be something that works
80 under all display types. If you put something other than "dot"
81 here, remember that bar_set_params tries to switch to this if we're
82 not running on a TTY. So changing this to "bar" could cause
85 #define FALLBACK_PROGRESS_IMPLEMENTATION "dot"
87 /* Return true if NAME names a valid progress bar implementation. The
88 characters after the first : will be ignored. */
91 valid_progress_implementation_p (const char *name)
94 struct progress_implementation *pi = implementations;
95 char *colon = strchr (name, ':');
96 int namelen = colon ? colon - name : strlen (name);
98 for (i = 0; i < countof (implementations); i++, pi++)
99 if (!strncmp (pi->name, name, namelen))
104 /* Set the progress implementation to NAME. */
107 set_progress_implementation (const char *name)
110 struct progress_implementation *pi = implementations;
114 name = DEFAULT_PROGRESS_IMPLEMENTATION;
116 colon = strchr (name, ':');
117 namelen = colon ? colon - name : strlen (name);
119 for (i = 0; i < countof (implementations); i++, pi++)
120 if (!strncmp (pi->name, name, namelen))
123 current_impl_locked = 0;
126 /* We call pi->set_params even if colon is NULL because we
127 want to give the implementation a chance to set up some
128 things it needs to run. */
132 pi->set_params (colon);
138 static int output_redirected;
141 progress_schedule_redirect (void)
143 output_redirected = 1;
146 /* Create a progress gauge. INITIAL is the number of bytes the
147 download starts from (zero if the download starts from scratch).
148 TOTAL is the expected total number of bytes in this download. If
149 TOTAL is zero, it means that the download size is not known in
153 progress_create (wgint initial, wgint total)
155 /* Check if the log status has changed under our feet. */
156 if (output_redirected)
158 if (!current_impl_locked)
159 set_progress_implementation (FALLBACK_PROGRESS_IMPLEMENTATION);
160 output_redirected = 0;
163 return current_impl->create (initial, total);
166 /* Return true if the progress gauge is "interactive", i.e. if it can
167 profit from being called regularly even in absence of data. The
168 progress bar is interactive because it regularly updates the ETA
169 and current update. */
172 progress_interactive_p (void *progress)
174 return current_impl->interactive;
177 /* Inform the progress gauge of newly received bytes. DLTIME is the
178 time since the beginning of the download. */
181 progress_update (void *progress, wgint howmuch, double dltime)
183 current_impl->update (progress, howmuch, dltime);
186 /* Tell the progress gauge to clean up. Calling this will free the
187 PROGRESS object, the further use of which is not allowed. */
190 progress_finish (void *progress, double dltime)
192 current_impl->finish (progress, dltime);
197 struct dot_progress {
198 wgint initial_length; /* how many bytes have been downloaded
200 wgint total_length; /* expected total byte count when the
203 int accumulated; /* number of bytes accumulated after
204 the last printed dot */
206 int rows; /* number of rows printed so far */
207 int dots; /* number of dots printed in this row */
209 double last_timer_value;
212 /* Dot-progress backend for progress_create. */
215 dot_create (wgint initial, wgint total)
217 struct dot_progress *dp = xnew0 (struct dot_progress);
218 dp->initial_length = initial;
219 dp->total_length = total;
221 if (dp->initial_length)
223 int dot_bytes = opt.dot_bytes;
224 const wgint ROW_BYTES = opt.dot_bytes * opt.dots_in_line;
226 int remainder = dp->initial_length % ROW_BYTES;
227 wgint skipped = dp->initial_length - remainder;
231 wgint skipped_k = skipped / 1024; /* skipped amount in K */
232 int skipped_k_len = numdigit (skipped_k);
233 if (skipped_k_len < 6)
236 /* Align the [ skipping ... ] line with the dots. To do
237 that, insert the number of spaces equal to the number of
238 digits in the skipped amount in K. */
239 logprintf (LOG_VERBOSE, _("\n%*s[ skipping %sK ]"),
240 2 + skipped_k_len, "",
241 number_to_static_string (skipped_k));
244 logprintf (LOG_VERBOSE, "\n%6sK",
245 number_to_static_string (skipped / 1024));
246 for (; remainder >= dot_bytes; remainder -= dot_bytes)
248 if (dp->dots % opt.dot_spacing == 0)
249 logputs (LOG_VERBOSE, " ");
250 logputs (LOG_VERBOSE, ",");
253 assert (dp->dots < opt.dots_in_line);
255 dp->accumulated = remainder;
256 dp->rows = skipped / ROW_BYTES;
262 static const char *eta_to_human_short (int, bool);
264 /* Prints the stats (percentage of completion, speed, ETA) for current
265 row. DLTIME is the time spent downloading the data in current
268 #### This function is somewhat uglified by the fact that current
269 row and last row have somewhat different stats requirements. It
270 might be worthwhile to split it to two different functions. */
273 print_row_stats (struct dot_progress *dp, double dltime, bool last)
275 const wgint ROW_BYTES = opt.dot_bytes * opt.dots_in_line;
277 /* bytes_displayed is the number of bytes indicated to the user by
278 dots printed so far, includes the initially "skipped" amount */
279 wgint bytes_displayed = dp->rows * ROW_BYTES + dp->dots * opt.dot_bytes;
282 /* For last row also count bytes accumulated after last dot */
283 bytes_displayed += dp->accumulated;
285 if (dp->total_length)
287 /* Round to floor value to provide gauge how much data *has*
288 been retrieved. 12.8% will round to 12% because the 13% mark
289 has not yet been reached. 100% is only shown when done. */
290 int percentage = 100.0 * bytes_displayed / dp->total_length;
291 logprintf (LOG_VERBOSE, "%3d%%", percentage);
295 static char names[] = {' ', 'K', 'M', 'G'};
298 wgint bytes_this_row;
300 bytes_this_row = ROW_BYTES;
302 /* For last row also include bytes accumulated after last dot. */
303 bytes_this_row = dp->dots * opt.dot_bytes + dp->accumulated;
304 /* Don't count the portion of the row belonging to initial_length */
305 if (dp->rows == dp->initial_length / ROW_BYTES)
306 bytes_this_row -= dp->initial_length % ROW_BYTES;
307 rate = calc_rate (bytes_this_row, dltime - dp->last_timer_value, &units);
308 logprintf (LOG_VERBOSE, " %4.*f%c",
309 rate >= 99.95 ? 0 : rate >= 9.995 ? 1 : 2,
311 dp->last_timer_value = dltime;
316 /* Display ETA based on average speed. Inspired by Vladi
317 Belperchinov-Shabanski's "wget-new-percentage" patch. */
318 if (dp->total_length)
320 wgint bytes_remaining = dp->total_length - bytes_displayed;
321 /* The quantity downloaded in this download run. */
322 wgint bytes_sofar = bytes_displayed - dp->initial_length;
323 double eta = dltime * bytes_remaining / bytes_sofar;
324 if (eta < INT_MAX - 1)
325 logprintf (LOG_VERBOSE, " %s",
326 eta_to_human_short ((int) (eta + 0.5), true));
331 /* When done, print the total download time */
333 logprintf (LOG_VERBOSE, "=%s",
334 eta_to_human_short ((int) (dltime + 0.5), true));
336 logprintf (LOG_VERBOSE, "=%ss", print_decimal (dltime));
340 /* Dot-progress backend for progress_update. */
343 dot_update (void *progress, wgint howmuch, double dltime)
345 struct dot_progress *dp = progress;
346 int dot_bytes = opt.dot_bytes;
347 wgint ROW_BYTES = opt.dot_bytes * opt.dots_in_line;
349 log_set_flush (false);
351 dp->accumulated += howmuch;
352 for (; dp->accumulated >= dot_bytes; dp->accumulated -= dot_bytes)
355 logprintf (LOG_VERBOSE, "\n%6sK",
356 number_to_static_string (dp->rows * ROW_BYTES / 1024));
358 if (dp->dots % opt.dot_spacing == 0)
359 logputs (LOG_VERBOSE, " ");
360 logputs (LOG_VERBOSE, ".");
363 if (dp->dots >= opt.dots_in_line)
368 print_row_stats (dp, dltime, false);
372 log_set_flush (true);
375 /* Dot-progress backend for progress_finish. */
378 dot_finish (void *progress, double dltime)
380 struct dot_progress *dp = progress;
381 wgint ROW_BYTES = opt.dot_bytes * opt.dots_in_line;
384 log_set_flush (false);
387 logprintf (LOG_VERBOSE, "\n%6sK",
388 number_to_static_string (dp->rows * ROW_BYTES / 1024));
389 for (i = dp->dots; i < opt.dots_in_line; i++)
391 if (i % opt.dot_spacing == 0)
392 logputs (LOG_VERBOSE, " ");
393 logputs (LOG_VERBOSE, " ");
396 print_row_stats (dp, dltime, true);
397 logputs (LOG_VERBOSE, "\n\n");
398 log_set_flush (false);
403 /* This function interprets the progress "parameters". For example,
404 if Wget is invoked with --progress=dot:mega, it will set the
405 "dot-style" to "mega". Valid styles are default, binary, mega, and
409 dot_set_params (const char *params)
411 if (!params || !*params)
412 params = opt.dot_style;
417 /* We use this to set the retrieval style. */
418 if (!strcasecmp (params, "default"))
420 /* Default style: 1K dots, 10 dots in a cluster, 50 dots in a
422 opt.dot_bytes = 1024;
423 opt.dot_spacing = 10;
424 opt.dots_in_line = 50;
426 else if (!strcasecmp (params, "binary"))
428 /* "Binary" retrieval: 8K dots, 16 dots in a cluster, 48 dots
430 opt.dot_bytes = 8192;
431 opt.dot_spacing = 16;
432 opt.dots_in_line = 48;
434 else if (!strcasecmp (params, "mega"))
436 /* "Mega" retrieval, for retrieving very long files; each dot is
437 64K, 8 dots in a cluster, 6 clusters (3M) in a line. */
438 opt.dot_bytes = 65536L;
440 opt.dots_in_line = 48;
442 else if (!strcasecmp (params, "giga"))
444 /* "Giga" retrieval, for retrieving very very *very* long files;
445 each dot is 1M, 8 dots in a cluster, 4 clusters (32M) in a
447 opt.dot_bytes = (1L << 20);
449 opt.dots_in_line = 32;
453 _("Invalid dot style specification `%s'; leaving unchanged.\n"),
457 /* "Thermometer" (bar) progress. */
459 /* Assumed screen width if we can't find the real value. */
460 #define DEFAULT_SCREEN_WIDTH 80
462 /* Minimum screen width we'll try to work with. If this is too small,
463 create_image will overflow the buffer. */
464 #define MINIMUM_SCREEN_WIDTH 45
466 /* The last known screen width. This can be updated by the code that
467 detects that SIGWINCH was received (but it's never updated from the
469 static int screen_width;
471 /* A flag that, when set, means SIGWINCH was received. */
472 static volatile sig_atomic_t received_sigwinch;
474 /* Size of the download speed history ring. */
475 #define DLSPEED_HISTORY_SIZE 20
477 /* The minimum time length of a history sample. By default, each
478 sample is at least 150ms long, which means that, over the course of
479 20 samples, "current" download speed spans at least 3s into the
481 #define DLSPEED_SAMPLE_MIN 0.15
483 /* The time after which the download starts to be considered
484 "stalled", i.e. the current bandwidth is not printed and the recent
485 download speeds are scratched. */
486 #define STALL_START_TIME 5
488 /* Time between screen refreshes will not be shorter than this, so
489 that Wget doesn't swamp the TTY with output. */
490 #define REFRESH_INTERVAL 0.2
492 /* Don't refresh the ETA too often to avoid jerkiness in predictions.
493 This allows ETA to change approximately once per second. */
494 #define ETA_REFRESH_INTERVAL 0.99
496 struct bar_progress {
497 wgint initial_length; /* how many bytes have been downloaded
499 wgint total_length; /* expected total byte count when the
501 wgint count; /* bytes downloaded so far */
503 double last_screen_update; /* time of the last screen update,
504 measured since the beginning of
507 int width; /* screen width we're using at the
508 time the progress gauge was
509 created. this is different from
510 the screen_width global variable in
511 that the latter can be changed by a
513 char *buffer; /* buffer where the bar "image" is
515 int tick; /* counter used for drawing the
516 progress bar where the total size
519 /* The following variables (kept in a struct for namespace reasons)
520 keep track of recent download speeds. See bar_update() for
522 struct bar_progress_hist {
524 double times[DLSPEED_HISTORY_SIZE];
525 wgint bytes[DLSPEED_HISTORY_SIZE];
527 /* The sum of times and bytes respectively, maintained for
533 double recent_start; /* timestamp of beginning of current
535 wgint recent_bytes; /* bytes downloaded so far. */
537 bool stalled; /* set when no data arrives for longer
538 than STALL_START_TIME, then reset
539 when new data arrives. */
541 /* create_image() uses these to make sure that ETA information
543 double last_eta_time; /* time of the last update to download
544 speed and ETA, measured since the
545 beginning of download. */
549 static void create_image (struct bar_progress *, double, bool);
550 static void display_image (char *);
553 bar_create (wgint initial, wgint total)
555 struct bar_progress *bp = xnew0 (struct bar_progress);
557 /* In theory, our callers should take care of this pathological
558 case, but it can sometimes happen. */
562 bp->initial_length = initial;
563 bp->total_length = total;
565 /* Initialize screen_width if this hasn't been done or if it might
566 have changed, as indicated by receiving SIGWINCH. */
567 if (!screen_width || received_sigwinch)
569 screen_width = determine_screen_width ();
571 screen_width = DEFAULT_SCREEN_WIDTH;
572 else if (screen_width < MINIMUM_SCREEN_WIDTH)
573 screen_width = MINIMUM_SCREEN_WIDTH;
574 received_sigwinch = 0;
577 /* - 1 because we don't want to use the last screen column. */
578 bp->width = screen_width - 1;
579 /* + 1 for the terminating zero. */
580 bp->buffer = xmalloc (bp->width + 1);
582 logputs (LOG_VERBOSE, "\n");
584 create_image (bp, 0, false);
585 display_image (bp->buffer);
590 static void update_speed_ring (struct bar_progress *, wgint, double);
593 bar_update (void *progress, wgint howmuch, double dltime)
595 struct bar_progress *bp = progress;
596 bool force_screen_update = false;
598 bp->count += howmuch;
599 if (bp->total_length > 0
600 && bp->count + bp->initial_length > bp->total_length)
601 /* We could be downloading more than total_length, e.g. when the
602 server sends an incorrect Content-Length header. In that case,
603 adjust bp->total_length to the new reality, so that the code in
604 create_image() that depends on total size being smaller or
605 equal to the expected size doesn't abort. */
606 bp->total_length = bp->initial_length + bp->count;
608 update_speed_ring (bp, howmuch, dltime);
610 /* If SIGWINCH (the window size change signal) been received,
611 determine the new screen size and update the screen. */
612 if (received_sigwinch)
614 int old_width = screen_width;
615 screen_width = determine_screen_width ();
617 screen_width = DEFAULT_SCREEN_WIDTH;
618 else if (screen_width < MINIMUM_SCREEN_WIDTH)
619 screen_width = MINIMUM_SCREEN_WIDTH;
620 if (screen_width != old_width)
622 bp->width = screen_width - 1;
623 bp->buffer = xrealloc (bp->buffer, bp->width + 1);
624 force_screen_update = true;
626 received_sigwinch = 0;
629 if (dltime - bp->last_screen_update < REFRESH_INTERVAL && !force_screen_update)
630 /* Don't update more often than five times per second. */
633 create_image (bp, dltime, false);
634 display_image (bp->buffer);
635 bp->last_screen_update = dltime;
639 bar_finish (void *progress, double dltime)
641 struct bar_progress *bp = progress;
643 if (bp->total_length > 0
644 && bp->count + bp->initial_length > bp->total_length)
645 /* See bar_update() for explanation. */
646 bp->total_length = bp->initial_length + bp->count;
648 create_image (bp, dltime, true);
649 display_image (bp->buffer);
651 logputs (LOG_VERBOSE, "\n\n");
657 /* This code attempts to maintain the notion of a "current" download
658 speed, over the course of no less than 3s. (Shorter intervals
659 produce very erratic results.)
661 To do so, it samples the speed in 150ms intervals and stores the
662 recorded samples in a FIFO history ring. The ring stores no more
663 than 20 intervals, hence the history covers the period of at least
664 three seconds and at most 20 reads into the past. This method
665 should produce reasonable results for downloads ranging from very
668 The idea is that for fast downloads, we get the speed over exactly
669 the last three seconds. For slow downloads (where a network read
670 takes more than 150ms to complete), we get the speed over a larger
671 time period, as large as it takes to complete thirty reads. This
672 is good because slow downloads tend to fluctuate more and a
673 3-second average would be too erratic. */
676 update_speed_ring (struct bar_progress *bp, wgint howmuch, double dltime)
678 struct bar_progress_hist *hist = &bp->hist;
679 double recent_age = dltime - bp->recent_start;
681 /* Update the download count. */
682 bp->recent_bytes += howmuch;
684 /* For very small time intervals, we return after having updated the
685 "recent" download count. When its age reaches or exceeds minimum
686 sample time, it will be recorded in the history ring. */
687 if (recent_age < DLSPEED_SAMPLE_MIN)
692 /* If we're not downloading anything, we might be stalling,
693 i.e. not downloading anything for an extended period of time.
694 Since 0-reads do not enter the history ring, recent_age
695 effectively measures the time since last read. */
696 if (recent_age >= STALL_START_TIME)
698 /* If we're stalling, reset the ring contents because it's
699 stale and because it will make bar_update stop printing
700 the (bogus) current bandwidth. */
703 bp->recent_bytes = 0;
708 /* We now have a non-zero amount of to store to the speed ring. */
710 /* If the stall status was acquired, reset it. */
714 /* "recent_age" includes the the entired stalled period, which
715 could be very long. Don't update the speed ring with that
716 value because the current bandwidth would start too small.
717 Start with an arbitrary (but more reasonable) time value and
722 /* Store "recent" bytes and download time to history ring at the
725 /* To correctly maintain the totals, first invalidate existing data
726 (least recent in time) at this position. */
727 hist->total_time -= hist->times[hist->pos];
728 hist->total_bytes -= hist->bytes[hist->pos];
730 /* Now store the new data and update the totals. */
731 hist->times[hist->pos] = recent_age;
732 hist->bytes[hist->pos] = bp->recent_bytes;
733 hist->total_time += recent_age;
734 hist->total_bytes += bp->recent_bytes;
736 /* Start a new "recent" period. */
737 bp->recent_start = dltime;
738 bp->recent_bytes = 0;
740 /* Advance the current ring position. */
741 if (++hist->pos == DLSPEED_HISTORY_SIZE)
745 /* Sledgehammer check to verify that the totals are accurate. */
748 double sumt = 0, sumb = 0;
749 for (i = 0; i < DLSPEED_HISTORY_SIZE; i++)
751 sumt += hist->times[i];
752 sumb += hist->bytes[i];
754 assert (sumb == hist->total_bytes);
755 /* We can't use assert(sumt==hist->total_time) because some
756 precision is lost by adding and subtracting floating-point
757 numbers. But during a download this precision should not be
758 detectable, i.e. no larger than 1ns. */
759 double diff = sumt - hist->total_time;
760 if (diff < 0) diff = -diff;
761 assert (diff < 1e-9);
766 #define APPEND_LITERAL(s) do { \
767 memcpy (p, s, sizeof (s) - 1); \
768 p += sizeof (s) - 1; \
771 /* Use move_to_end (s) to get S to point the end of the string (the
772 terminating \0). This is faster than s+=strlen(s), but some people
773 are confused when they see strchr (s, '\0') in the code. */
774 #define move_to_end(s) s = strchr (s, '\0');
777 # define MAX(a, b) ((a) >= (b) ? (a) : (b))
781 create_image (struct bar_progress *bp, double dl_total_time, bool done)
783 char *p = bp->buffer;
784 wgint size = bp->initial_length + bp->count;
786 const char *size_grouped = with_thousand_seps (size);
787 int size_grouped_len = strlen (size_grouped);
789 struct bar_progress_hist *hist = &bp->hist;
791 /* The progress bar should look like this:
792 xx% [=======> ] nn,nnn 12.34K/s eta 36m 51s
794 Calculate the geometry. The idea is to assign as much room as
795 possible to the progress bar. The other idea is to never let
796 things "jitter", i.e. pad elements that vary in size so that
797 their variance does not affect the placement of other elements.
798 It would be especially bad for the progress bar to be resized
801 "xx% " or "100%" - percentage - 4 chars
802 "[]" - progress bar decorations - 2 chars
803 " nnn,nnn,nnn" - downloaded bytes - 12 chars or very rarely more
804 " 12.5K/s" - download rate - 8 chars
805 " eta 36m 51s" - ETA - 13 chars
807 "=====>..." - progress bar - the rest
809 int dlbytes_size = 1 + MAX (size_grouped_len, 11);
810 int progress_size = bp->width - (4 + 2 + dlbytes_size + 8 + 13);
812 if (progress_size < 5)
816 if (bp->total_length > 0)
818 int percentage = 100.0 * size / bp->total_length;
819 assert (percentage <= 100);
821 if (percentage < 100)
822 sprintf (p, "%2d%% ", percentage);
828 APPEND_LITERAL (" ");
830 /* The progress bar: "[====> ]" or "[++==> ]". */
831 if (progress_size && bp->total_length > 0)
833 /* Size of the initial portion. */
834 int insz = (double)bp->initial_length / bp->total_length * progress_size;
836 /* Size of the downloaded portion. */
837 int dlsz = (double)size / bp->total_length * progress_size;
842 assert (dlsz <= progress_size);
843 assert (insz <= dlsz);
848 /* Print the initial portion of the download with '+' chars, the
849 rest with '=' and one '>'. */
850 for (i = 0; i < insz; i++)
855 for (i = 0; i < dlsz - 1; i++)
860 while (p - begin < progress_size)
864 else if (progress_size)
866 /* If we can't draw a real progress bar, then at least show
867 *something* to the user. */
868 int ind = bp->tick % (progress_size * 2 - 6);
871 /* Make the star move in two directions. */
872 if (ind < progress_size - 2)
875 pos = progress_size - (ind - progress_size + 5);
878 for (i = 0; i < progress_size; i++)
880 if (i == pos - 1) *p++ = '<';
881 else if (i == pos ) *p++ = '=';
882 else if (i == pos + 1) *p++ = '>';
892 sprintf (p, " %-11s", size_grouped);
896 if (hist->total_time > 0 && hist->total_bytes)
898 static const char *short_units[] = { "B/s", "K/s", "M/s", "G/s" };
900 /* Calculate the download speed using the history ring and
901 recent data that hasn't made it to the ring yet. */
902 wgint dlquant = hist->total_bytes + bp->recent_bytes;
903 double dltime = hist->total_time + (dl_total_time - bp->recent_start);
904 double dlspeed = calc_rate (dlquant, dltime, &units);
905 sprintf (p, " %4.*f%s", dlspeed >= 99.95 ? 0 : dlspeed >= 9.995 ? 1 : 2,
906 dlspeed, short_units[units]);
910 APPEND_LITERAL (" --.-K/s");
914 /* " eta ..m ..s"; wait for three seconds before displaying the ETA.
915 That's because the ETA value needs a while to become
917 if (bp->total_length > 0 && bp->count > 0 && dl_total_time > 3)
921 /* Don't change the value of ETA more than approximately once
922 per second; doing so would cause flashing without providing
923 any value to the user. */
924 if (bp->total_length != size
925 && bp->last_eta_value != 0
926 && dl_total_time - bp->last_eta_time < ETA_REFRESH_INTERVAL)
927 eta = bp->last_eta_value;
930 /* Calculate ETA using the average download speed to predict
931 the future speed. If you want to use a speed averaged
932 over a more recent period, replace dl_total_time with
933 hist->total_time and bp->count with hist->total_bytes.
934 I found that doing that results in a very jerky and
935 ultimately unreliable ETA. */
936 wgint bytes_remaining = bp->total_length - size;
937 double eta_ = dl_total_time * bytes_remaining / bp->count;
938 if (eta_ >= INT_MAX - 1)
940 eta = (int) (eta_ + 0.5);
941 bp->last_eta_value = eta;
942 bp->last_eta_time = dl_total_time;
945 /* Translation note: "ETA" is English-centric, but this must
946 be short, ideally 3 chars. Abbreviate if necessary. */
947 sprintf (p, _(" eta %s"), eta_to_human_short (eta, false));
950 else if (bp->total_length > 0)
953 APPEND_LITERAL (" ");
958 /* When the download is done, print the elapsed time. */
960 /* Note to translators: this should not take up more room than
961 available here. Abbreviate if necessary. */
962 strcpy (p, _(" in "));
963 move_to_end (p); /* not p+=6, think translations! */
964 if (dl_total_time >= 10)
965 strcpy (p, eta_to_human_short ((int) (dl_total_time + 0.5), false));
967 sprintf (p, "%ss", print_decimal (dl_total_time));
971 assert (p - bp->buffer <= bp->width);
973 while (p < bp->buffer + bp->width)
978 /* Print the contents of the buffer as a one-line ASCII "image" so
979 that it can be overwritten next time. */
982 display_image (char *buf)
984 bool old = log_set_save_context (false);
985 logputs (LOG_VERBOSE, "\r");
986 logputs (LOG_VERBOSE, buf);
987 log_set_save_context (old);
991 bar_set_params (const char *params)
993 char *term = getenv ("TERM");
996 && 0 == strcmp (params, "force"))
997 current_impl_locked = 1;
1001 /* The progress bar doesn't make sense if the output is not a
1002 TTY -- when logging to file, it is better to review the
1004 || !isatty (fileno (stderr))
1006 /* Normally we don't depend on terminal type because the
1007 progress bar only uses ^M to move the cursor to the
1008 beginning of line, which works even on dumb terminals. But
1009 Jamie Zawinski reports that ^M and ^H tricks don't work in
1010 Emacs shell buffers, and only make a mess. */
1011 || (term && 0 == strcmp (term, "emacs"))
1013 && !current_impl_locked)
1015 /* We're not printing to a TTY, so revert to the fallback
1016 display. #### We're recursively calling
1017 set_progress_implementation here, which is slightly kludgy.
1018 It would be nicer if we provided that function a return value
1019 indicating a failure of some sort. */
1020 set_progress_implementation (FALLBACK_PROGRESS_IMPLEMENTATION);
1027 progress_handle_sigwinch (int sig)
1029 received_sigwinch = 1;
1030 signal (SIGWINCH, progress_handle_sigwinch);
1034 /* Provide a short human-readable rendition of the ETA. This is like
1035 secs_to_human_time in main.c, except the output doesn't include
1036 fractions (which would look silly in by nature imprecise ETA) and
1037 takes less room. If the time is measured in hours, hours and
1038 minutes (but not seconds) are shown; if measured in days, then days
1039 and hours are shown. This ensures brevity while still displaying
1040 as much as possible.
1042 If CONDENSED is true, the separator between minutes and seconds
1043 (and hours and minutes, etc.) is not included, shortening the
1044 display by one additional character. This is used for dot
1047 The display never occupies more than 7 characters of screen
1051 eta_to_human_short (int secs, bool condensed)
1053 static char buf[10]; /* 8 should be enough, but just in case */
1054 static int last = -1;
1055 const char *space = condensed ? "" : " ";
1057 /* Trivial optimization. create_image can call us every 200 msecs
1058 (see bar_update) for fast downloads, but ETA will only change
1059 once per 900 msecs. */
1065 sprintf (buf, "%ds", secs);
1066 else if (secs < 100 * 60)
1067 sprintf (buf, "%dm%s%ds", secs / 60, space, secs % 60);
1068 else if (secs < 48 * 3600)
1069 sprintf (buf, "%dh%s%dm", secs / 3600, space, (secs / 60) % 60);
1070 else if (secs < 100 * 86400)
1071 sprintf (buf, "%dd%s%dh", secs / 86400, space, (secs / 3600) % 60);
1073 /* even (2^31-1)/86400 doesn't overflow BUF. */
1074 sprintf (buf, "%dd", secs / 86400);