blob: 23e974ce702401d2236040aba93fb70fc9f36968 [file] [log] [blame]
/* vi: set sw=4 ts=4: */
/*
* Progress bar code.
*/
/* Original copyright notice which applies to the CONFIG_FEATURE_WGET_STATUSBAR stuff,
* much of which was blatantly stolen from openssh.
*/
/*-
* Copyright (c) 1992, 1993
* The Regents of the University of California. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* 3. BSD Advertising Clause omitted per the July 22, 1999 licensing change
* ftp://ftp.cs.berkeley.edu/pub/4bsd/README.Impt.License.Change
*
* 4. Neither the name of the University nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ''AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
#include "libbb.h"
#include "unicode.h"
enum {
/* Seconds when xfer considered "stalled" */
STALLTIME = 5
};
void FAST_FUNC bb_progress_init(bb_progress_t *p, const char *curfile)
{
#if ENABLE_UNICODE_SUPPORT
init_unicode();
p->curfile = unicode_conv_to_printable_fixedwidth(/*NULL,*/ curfile, 20);
#else
p->curfile = curfile;
#endif
p->start_sec = monotonic_sec();
p->last_update_sec = p->start_sec;
p->last_change_sec = p->start_sec;
p->last_size = 0;
#if 0
p->last_eta = INT_MAX;
#endif
}
/* File already had beg_size bytes.
* Then we started downloading.
* We downloaded "transferred" bytes so far.
* Download is expected to stop when total size (beg_size + transferred)
* will be "totalsize" bytes.
* If totalsize == 0, then it is unknown.
*/
void FAST_FUNC bb_progress_update(bb_progress_t *p,
uoff_t beg_size,
uoff_t transferred,
uoff_t totalsize)
{
char numbuf5[6]; /* 5 + 1 for NUL */
unsigned since_last_update, elapsed;
int notty;
//transferred = 1234; /* use for stall detection testing */
//totalsize = 0; /* use for unknown size download testing */
elapsed = monotonic_sec();
since_last_update = elapsed - p->last_update_sec;
p->last_update_sec = elapsed;
if (totalsize != 0 && transferred >= totalsize - beg_size) {
/* Last call. Do not skip this update */
transferred = totalsize - beg_size; /* sanitize just in case */
}
else if (since_last_update == 0) {
/*
* Do not update on every call
* (we can be called on every network read!)
*/
return;
}
/* Before we lose real, unscaled sizes, produce human-readable size string */
smart_ulltoa5(beg_size + transferred, numbuf5, " kMGTPEZY")[0] = '\0';
/*
* Scale sizes down if they are close to overflowing.
* This allows calculations like (100 * transferred / totalsize)
* without risking overflow: we guarantee 10 highest bits to be 0.
* Introduced error is less than 1 / 2^12 ~= 0.025%
*/
while (totalsize >= (1 << 20)) {
totalsize >>= 8;
beg_size >>= 8;
transferred >>= 8;
}
/* If they were huge, now they are scaled down to [1048575,4096] range.
* (N * totalsize) won't overflow 32 bits for N up to 4096.
*/
#if ULONG_MAX == 0xffffffff
/* 32-bit CPU, uoff_t arithmetic is complex on it, cast variables to narrower types */
# define totalsize ((unsigned)totalsize)
# define beg_size ((unsigned)beg_size)
# define transferred ((unsigned)transferred)
#endif
notty = !isatty(STDERR_FILENO);
if (ENABLE_UNICODE_SUPPORT)
fprintf(stderr, "\r%s " + notty, p->curfile);
else
fprintf(stderr, "\r%-20.20s " + notty, p->curfile);
if (totalsize != 0) {
int barlength;
unsigned beg_and_transferred; /* does not need uoff_t, see scaling code */
unsigned ratio;
beg_and_transferred = beg_size + transferred;
ratio = 100 * beg_and_transferred / totalsize;
/* can't overflow ^^^^^^^^^^^^^^^ */
fprintf(stderr, "%3u%% ", ratio);
barlength = get_terminal_width(2) - 48;
/*
* Must reject barlength <= 0 (terminal too narrow). While at it,
* also reject: 1-char bar (useless), 2-char bar (ridiculous).
*/
if (barlength > 2) {
if (barlength > 999)
barlength = 999;
{
/* god bless gcc for variable arrays :) */
char buf[barlength + 1];
unsigned stars = (unsigned)barlength * beg_and_transferred / totalsize;
/* can't overflow ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ */
memset(buf, ' ', barlength);
buf[barlength] = '\0';
memset(buf, '*', stars);
fprintf(stderr, "|%s| ", buf);
}
}
}
fputs(numbuf5, stderr); /* "NNNNk" */
since_last_update = elapsed - p->last_change_sec;
if ((unsigned)transferred != p->last_size) {
p->last_change_sec = elapsed;
p->last_size = (unsigned)transferred;
if (since_last_update >= STALLTIME) {
/* We "cut out" these seconds from elapsed time
* by adjusting start time */
p->start_sec += since_last_update;
}
since_last_update = 0; /* we are un-stalled now */
}
elapsed -= p->start_sec; /* now it's "elapsed since start" */
if (since_last_update >= STALLTIME) {
fprintf(stderr, " - stalled -");
} else if (!totalsize || !transferred || (int)elapsed < 0) {
fprintf(stderr, " --:--:-- ETA");
} else {
unsigned eta, secs, hours;
unsigned bytes;
bytes = totalsize - beg_size;
/* Estimated remaining time =
* estimated_sec_to_dl_bytes - elapsed_sec =
* bytes / average_bytes_sec_so_far - elapsed =
* bytes / (transferred/elapsed) - elapsed =
* bytes * elapsed / transferred - elapsed
*/
eta = (unsigned long)bytes * elapsed / transferred - elapsed;
/* if 32bit, can overflow ^^^^^^^^^^, but this would only show bad ETA */
if (eta >= 1000*60*60)
eta = 1000*60*60 - 1;
#if 0
/* To prevent annoying "back-and-forth" estimation jitter,
* if new ETA is larger than the last just by a few seconds,
* disregard it, and show last one. The end result is that
* ETA usually only decreases, unless download slows down a lot.
*/
if ((unsigned)(eta - p->last_eta) < 10)
eta = p->last_eta;
p->last_eta = eta;
#endif
secs = eta % 3600;
hours = eta / 3600;
fprintf(stderr, "%3u:%02u:%02u ETA", hours, secs / 60, secs % 60);
}
if (notty)
fputc('\n', stderr);
}