2 Copyright (C) 2001, 2002 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
18 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, 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 in milliseconds 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 secs_sofar = dltime / 1000;
324 int eta = (int) (secs_sofar * bytes_remaining / bytes_sofar + 0.5);
325 logprintf (LOG_VERBOSE, " %s", eta_to_human_short (eta, true));
330 /* When done, print the total download time */
331 double secs = dltime / 1000;
333 logprintf (LOG_VERBOSE, "=%s",
334 eta_to_human_short ((int) (secs + 0.5), true));
336 logprintf (LOG_VERBOSE, "=%ss", print_decimal (secs));
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 150
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 5000
488 struct bar_progress {
489 wgint initial_length; /* how many bytes have been downloaded
491 wgint total_length; /* expected total byte count when the
493 wgint count; /* bytes downloaded so far */
495 double last_screen_update; /* time of the last screen update,
496 measured since the beginning of
499 int width; /* screen width we're using at the
500 time the progress gauge was
501 created. this is different from
502 the screen_width global variable in
503 that the latter can be changed by a
505 char *buffer; /* buffer where the bar "image" is
507 int tick; /* counter used for drawing the
508 progress bar where the total size
511 /* The following variables (kept in a struct for namespace reasons)
512 keep track of recent download speeds. See bar_update() for
514 struct bar_progress_hist {
516 wgint times[DLSPEED_HISTORY_SIZE];
517 wgint bytes[DLSPEED_HISTORY_SIZE];
519 /* The sum of times and bytes respectively, maintained for
525 double recent_start; /* timestamp of beginning of current
527 wgint recent_bytes; /* bytes downloaded so far. */
529 bool stalled; /* set when no data arrives for longer
530 than STALL_START_TIME, then reset
531 when new data arrives. */
533 /* create_image() uses these to make sure that ETA information
535 double last_eta_time; /* time of the last update to download
536 speed and ETA, measured since the
537 beginning of download. */
541 static void create_image (struct bar_progress *, double, bool);
542 static void display_image (char *);
545 bar_create (wgint initial, wgint total)
547 struct bar_progress *bp = xnew0 (struct bar_progress);
549 /* In theory, our callers should take care of this pathological
550 case, but it can sometimes happen. */
554 bp->initial_length = initial;
555 bp->total_length = total;
557 /* Initialize screen_width if this hasn't been done or if it might
558 have changed, as indicated by receiving SIGWINCH. */
559 if (!screen_width || received_sigwinch)
561 screen_width = determine_screen_width ();
563 screen_width = DEFAULT_SCREEN_WIDTH;
564 else if (screen_width < MINIMUM_SCREEN_WIDTH)
565 screen_width = MINIMUM_SCREEN_WIDTH;
566 received_sigwinch = 0;
569 /* - 1 because we don't want to use the last screen column. */
570 bp->width = screen_width - 1;
571 /* + 1 for the terminating zero. */
572 bp->buffer = xmalloc (bp->width + 1);
574 logputs (LOG_VERBOSE, "\n");
576 create_image (bp, 0, false);
577 display_image (bp->buffer);
582 static void update_speed_ring (struct bar_progress *, wgint, double);
585 bar_update (void *progress, wgint howmuch, double dltime)
587 struct bar_progress *bp = progress;
588 bool force_screen_update = false;
590 bp->count += howmuch;
591 if (bp->total_length > 0
592 && bp->count + bp->initial_length > bp->total_length)
593 /* We could be downloading more than total_length, e.g. when the
594 server sends an incorrect Content-Length header. In that case,
595 adjust bp->total_length to the new reality, so that the code in
596 create_image() that depends on total size being smaller or
597 equal to the expected size doesn't abort. */
598 bp->total_length = bp->initial_length + bp->count;
600 update_speed_ring (bp, howmuch, dltime);
602 /* If SIGWINCH (the window size change signal) been received,
603 determine the new screen size and update the screen. */
604 if (received_sigwinch)
606 int old_width = screen_width;
607 screen_width = determine_screen_width ();
609 screen_width = DEFAULT_SCREEN_WIDTH;
610 else if (screen_width < MINIMUM_SCREEN_WIDTH)
611 screen_width = MINIMUM_SCREEN_WIDTH;
612 if (screen_width != old_width)
614 bp->width = screen_width - 1;
615 bp->buffer = xrealloc (bp->buffer, bp->width + 1);
616 force_screen_update = true;
618 received_sigwinch = 0;
621 if (dltime - bp->last_screen_update < 200 && !force_screen_update)
622 /* Don't update more often than five times per second. */
625 create_image (bp, dltime, false);
626 display_image (bp->buffer);
627 bp->last_screen_update = dltime;
631 bar_finish (void *progress, double dltime)
633 struct bar_progress *bp = progress;
635 if (bp->total_length > 0
636 && bp->count + bp->initial_length > bp->total_length)
637 /* See bar_update() for explanation. */
638 bp->total_length = bp->initial_length + bp->count;
640 create_image (bp, dltime, true);
641 display_image (bp->buffer);
643 logputs (LOG_VERBOSE, "\n\n");
649 /* This code attempts to maintain the notion of a "current" download
650 speed, over the course of no less than 3s. (Shorter intervals
651 produce very erratic results.)
653 To do so, it samples the speed in 150ms intervals and stores the
654 recorded samples in a FIFO history ring. The ring stores no more
655 than 20 intervals, hence the history covers the period of at least
656 three seconds and at most 20 reads into the past. This method
657 should produce reasonable results for downloads ranging from very
660 The idea is that for fast downloads, we get the speed over exactly
661 the last three seconds. For slow downloads (where a network read
662 takes more than 150ms to complete), we get the speed over a larger
663 time period, as large as it takes to complete thirty reads. This
664 is good because slow downloads tend to fluctuate more and a
665 3-second average would be too erratic. */
668 update_speed_ring (struct bar_progress *bp, wgint howmuch, double dltime)
670 struct bar_progress_hist *hist = &bp->hist;
671 double recent_age = dltime - bp->recent_start;
673 /* Update the download count. */
674 bp->recent_bytes += howmuch;
676 /* For very small time intervals, we return after having updated the
677 "recent" download count. When its age reaches or exceeds minimum
678 sample time, it will be recorded in the history ring. */
679 if (recent_age < DLSPEED_SAMPLE_MIN)
684 /* If we're not downloading anything, we might be stalling,
685 i.e. not downloading anything for an extended period of time.
686 Since 0-reads do not enter the history ring, recent_age
687 effectively measures the time since last read. */
688 if (recent_age >= STALL_START_TIME)
690 /* If we're stalling, reset the ring contents because it's
691 stale and because it will make bar_update stop printing
692 the (bogus) current bandwidth. */
695 bp->recent_bytes = 0;
700 /* We now have a non-zero amount of to store to the speed ring. */
702 /* If the stall status was acquired, reset it. */
706 /* "recent_age" includes the the entired stalled period, which
707 could be very long. Don't update the speed ring with that
708 value because the current bandwidth would start too small.
709 Start with an arbitrary (but more reasonable) time value and
714 /* Store "recent" bytes and download time to history ring at the
717 /* To correctly maintain the totals, first invalidate existing data
718 (least recent in time) at this position. */
719 hist->total_time -= hist->times[hist->pos];
720 hist->total_bytes -= hist->bytes[hist->pos];
722 /* Now store the new data and update the totals. */
723 hist->times[hist->pos] = recent_age;
724 hist->bytes[hist->pos] = bp->recent_bytes;
725 hist->total_time += recent_age;
726 hist->total_bytes += bp->recent_bytes;
728 /* Start a new "recent" period. */
729 bp->recent_start = dltime;
730 bp->recent_bytes = 0;
732 /* Advance the current ring position. */
733 if (++hist->pos == DLSPEED_HISTORY_SIZE)
737 /* Sledgehammer check to verify that the totals are accurate. */
740 double sumt = 0, sumb = 0;
741 for (i = 0; i < DLSPEED_HISTORY_SIZE; i++)
743 sumt += hist->times[i];
744 sumb += hist->bytes[i];
746 assert (sumt == hist->total_time);
747 assert (sumb == hist->total_bytes);
752 #define APPEND_LITERAL(s) do { \
753 memcpy (p, s, sizeof (s) - 1); \
754 p += sizeof (s) - 1; \
757 /* Use move_to_end (s) to get S to point the end of the string (the
758 terminating \0). This is faster than s+=strlen(s), but some people
759 are confused when they see strchr (s, '\0') in the code. */
760 #define move_to_end(s) s = strchr (s, '\0');
763 # define MAX(a, b) ((a) >= (b) ? (a) : (b))
767 create_image (struct bar_progress *bp, double dl_total_time, bool done)
769 char *p = bp->buffer;
770 wgint size = bp->initial_length + bp->count;
772 const char *size_grouped = with_thousand_seps (size);
773 int size_grouped_len = strlen (size_grouped);
775 struct bar_progress_hist *hist = &bp->hist;
777 /* The progress bar should look like this:
778 xx% [=======> ] nn,nnn 12.34K/s eta 36m 51s
780 Calculate the geometry. The idea is to assign as much room as
781 possible to the progress bar. The other idea is to never let
782 things "jitter", i.e. pad elements that vary in size so that
783 their variance does not affect the placement of other elements.
784 It would be especially bad for the progress bar to be resized
787 "xx% " or "100%" - percentage - 4 chars
788 "[]" - progress bar decorations - 2 chars
789 " nnn,nnn,nnn" - downloaded bytes - 12 chars or very rarely more
790 " 12.5K/s" - download rate - 8 chars
791 " eta 36m 51s" - ETA - 13 chars
793 "=====>..." - progress bar - the rest
795 int dlbytes_size = 1 + MAX (size_grouped_len, 11);
796 int progress_size = bp->width - (4 + 2 + dlbytes_size + 8 + 13);
798 if (progress_size < 5)
802 if (bp->total_length > 0)
804 int percentage = 100.0 * size / bp->total_length;
805 assert (percentage <= 100);
807 if (percentage < 100)
808 sprintf (p, "%2d%% ", percentage);
814 APPEND_LITERAL (" ");
816 /* The progress bar: "[====> ]" or "[++==> ]". */
817 if (progress_size && bp->total_length > 0)
819 /* Size of the initial portion. */
820 int insz = (double)bp->initial_length / bp->total_length * progress_size;
822 /* Size of the downloaded portion. */
823 int dlsz = (double)size / bp->total_length * progress_size;
828 assert (dlsz <= progress_size);
829 assert (insz <= dlsz);
834 /* Print the initial portion of the download with '+' chars, the
835 rest with '=' and one '>'. */
836 for (i = 0; i < insz; i++)
841 for (i = 0; i < dlsz - 1; i++)
846 while (p - begin < progress_size)
850 else if (progress_size)
852 /* If we can't draw a real progress bar, then at least show
853 *something* to the user. */
854 int ind = bp->tick % (progress_size * 2 - 6);
857 /* Make the star move in two directions. */
858 if (ind < progress_size - 2)
861 pos = progress_size - (ind - progress_size + 5);
864 for (i = 0; i < progress_size; i++)
866 if (i == pos - 1) *p++ = '<';
867 else if (i == pos ) *p++ = '=';
868 else if (i == pos + 1) *p++ = '>';
878 sprintf (p, " %-11s", size_grouped);
882 if (hist->total_time && hist->total_bytes)
884 static const char *short_units[] = { "B/s", "K/s", "M/s", "G/s" };
886 /* Calculate the download speed using the history ring and
887 recent data that hasn't made it to the ring yet. */
888 wgint dlquant = hist->total_bytes + bp->recent_bytes;
889 double dltime = hist->total_time + (dl_total_time - bp->recent_start);
890 double dlspeed = calc_rate (dlquant, dltime, &units);
891 sprintf (p, " %4.*f%s", dlspeed >= 99.95 ? 0 : dlspeed >= 9.995 ? 1 : 2,
892 dlspeed, short_units[units]);
896 APPEND_LITERAL (" --.-K/s");
900 /* " eta ..m ..s"; wait for three seconds before displaying the ETA.
901 That's because the ETA value needs a while to become
903 if (bp->total_length > 0 && bp->count > 0 && dl_total_time > 3000)
907 /* Don't change the value of ETA more than approximately once
908 per second; doing so would cause flashing without providing
909 any value to the user. */
910 if (bp->total_length != size
911 && bp->last_eta_value != 0
912 && dl_total_time - bp->last_eta_time < 900)
913 eta = bp->last_eta_value;
916 /* Calculate ETA using the average download speed to predict
917 the future speed. If you want to use a speed averaged
918 over a more recent period, replace dl_total_time with
919 hist->total_time and bp->count with hist->total_bytes.
920 I found that doing that results in a very jerky and
921 ultimately unreliable ETA. */
922 double time_sofar = (double) dl_total_time / 1000;
923 wgint bytes_remaining = bp->total_length - size;
924 eta = (int) (time_sofar * bytes_remaining / bp->count + 0.5);
925 bp->last_eta_value = eta;
926 bp->last_eta_time = dl_total_time;
929 /* Translation note: "ETA" is English-centric, but this must
930 be short, ideally 3 chars. Abbreviate if necessary. */
931 sprintf (p, _(" eta %s"), eta_to_human_short (eta, false));
934 else if (bp->total_length > 0)
936 APPEND_LITERAL (" ");
941 /* When the download is done, print the elapsed time. */
942 double secs = dl_total_time / 1000;
943 /* Note to translators: this should not take up more room than
944 available here. Abbreviate if necessary. */
945 strcpy (p, _(" in "));
946 move_to_end (p); /* not p+=6, think translations! */
948 strcpy (p, eta_to_human_short ((int) (secs + 0.5), false));
950 sprintf (p, "%ss", print_decimal (secs));
954 assert (p - bp->buffer <= bp->width);
956 while (p < bp->buffer + bp->width)
961 /* Print the contents of the buffer as a one-line ASCII "image" so
962 that it can be overwritten next time. */
965 display_image (char *buf)
967 bool old = log_set_save_context (false);
968 logputs (LOG_VERBOSE, "\r");
969 logputs (LOG_VERBOSE, buf);
970 log_set_save_context (old);
974 bar_set_params (const char *params)
976 char *term = getenv ("TERM");
979 && 0 == strcmp (params, "force"))
980 current_impl_locked = 1;
984 /* The progress bar doesn't make sense if the output is not a
985 TTY -- when logging to file, it is better to review the
987 || !isatty (fileno (stderr))
989 /* Normally we don't depend on terminal type because the
990 progress bar only uses ^M to move the cursor to the
991 beginning of line, which works even on dumb terminals. But
992 Jamie Zawinski reports that ^M and ^H tricks don't work in
993 Emacs shell buffers, and only make a mess. */
994 || (term && 0 == strcmp (term, "emacs"))
996 && !current_impl_locked)
998 /* We're not printing to a TTY, so revert to the fallback
999 display. #### We're recursively calling
1000 set_progress_implementation here, which is slightly kludgy.
1001 It would be nicer if we provided that function a return value
1002 indicating a failure of some sort. */
1003 set_progress_implementation (FALLBACK_PROGRESS_IMPLEMENTATION);
1010 progress_handle_sigwinch (int sig)
1012 received_sigwinch = 1;
1013 signal (SIGWINCH, progress_handle_sigwinch);
1017 /* Provide a short human-readable rendition of the ETA. This is like
1018 secs_to_human_time in main.c, except the output doesn't include
1019 fractions (which would look silly in by nature imprecise ETA) and
1020 takes less room. If the time is measured in hours, hours and
1021 minutes (but not seconds) are shown; if measured in days, then days
1022 and hours are shown. This ensures brevity while still displaying
1023 as much as possible.
1025 If CONDENSED is true, the separator between minutes and seconds
1026 (and hours and minutes, etc.) is not included, shortening the
1027 display by one additional character. This is used for dot
1030 The display never occupies more than 7 characters of screen
1034 eta_to_human_short (int secs, bool condensed)
1036 static char buf[10]; /* 8 should be enough, but just in case */
1037 static int last = -1;
1038 const char *space = condensed ? "" : " ";
1040 /* Trivial optimization. create_image can call us every 200 msecs
1041 (see bar_update) for fast downloads, but ETA will only change
1042 once per 900 msecs. */
1048 sprintf (buf, "%ds", secs);
1049 else if (secs < 100 * 60)
1050 sprintf (buf, "%dm%s%ds", secs / 60, space, secs % 60);
1051 else if (secs < 100 * 3600)
1052 sprintf (buf, "%dh%s%dm", secs / 3600, space, (secs / 60) % 60);
1053 else if (secs < 100 * 86400)
1054 sprintf (buf, "%dd%s%dh", secs / 86400, space, (secs / 3600) % 60);
1056 /* even (2^31-1)/86400 doesn't overflow BUF. */
1057 sprintf (buf, "%dd", secs / 86400);