nologin: make it possible to build it as single applet
[oweals/busybox.git] / libbb / progress.c
index e96039042ccdf9378e5a9fa8dae7c8149549e659..d071ce70511b47054be773bf917c1d867f11244d 100644 (file)
@@ -7,7 +7,7 @@
  */
 /*-
  * Copyright (c) 1992, 1993
- *     The Regents of the University of California.  All rights reserved.
+ * 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
  *    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>
+ * 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
+ * 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
@@ -45,109 +45,171 @@ enum {
        STALLTIME = 5
 };
 
-static unsigned int get_tty2_width(void)
-{
-       unsigned width;
-       get_terminal_width_height(2, &width, NULL);
-       return width;
-}
-
-void FAST_FUNC bb_progress_init(bb_progress_t *p)
+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->lastupdate_sec = p->start_sec;
-       p->lastsize = 0;
-       p->inited = 1;
+       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
 }
 
-void FAST_FUNC bb_progress_update(bb_progress_t *p,
-               const char *curfile,
-               off_t beg_range,
-               off_t transferred,
-               off_t totalsize)
+/* 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.
+ */
+int FAST_FUNC bb_progress_update(bb_progress_t *p,
+               uoff_t beg_size,
+               uoff_t transferred,
+               uoff_t totalsize)
 {
-       off_t abbrevsize;
+       char numbuf5[6]; /* 5 + 1 for NUL */
        unsigned since_last_update, elapsed;
-       unsigned ratio;
-       int barlength, i;
-
-       ratio = 100;
-       if (totalsize) {
-               /* long long helps to have it working even if !LFS */
-               ratio = (unsigned) (100ULL * (transferred+beg_range) / totalsize);
-               if (ratio > 100) ratio = 100;
+       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 -1;
        }
 
-#if ENABLE_UNICODE_SUPPORT
-       init_unicode();
-       /* libbb candidate? */
-       {
-               wchar_t wbuf21[21];
-               char *buf = xstrdup(curfile);
-               unsigned len;
-
-               /* trim to 20 wide chars max (sets wbuf21[20] to 0)
-                * also, in case mbstowcs fails, we at least
-                * dont get garbage */
-               memset(wbuf21, 0, sizeof(wbuf21));
-               /* convert to wide chars, no more than 20 */
-               len = mbstowcs(wbuf21, curfile, 20); /* NB: may return -1 */
-               /* back to multibyte; cant overflow */
-               wcstombs(buf, wbuf21, INT_MAX);
-               len = (len > 20) ? 0 : 20 - len;
-               fprintf(stderr, "\r%s%*s%4d%% ", buf, len, "", ratio);
-               free(buf);
+       /* 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;
        }
-#else
-       fprintf(stderr, "\r%-20.20s%4d%% ", curfile, ratio);
+       /* 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
 
-       barlength = get_tty2_width() - 49;
-       if (barlength > 0) {
-               /* god bless gcc for variable arrays :) */
-               i = barlength * ratio / 100;
-               {
-                       char buf[i+1];
-                       memset(buf, '*', i);
-                       buf[i] = '\0';
-                       fprintf(stderr, "|%s%*s|", buf, barlength - i, "");
+       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);
+                       }
                }
        }
-       i = 0;
-       abbrevsize = transferred + beg_range;
-       while (abbrevsize >= 100000) {
-               i++;
-               abbrevsize >>= 10;
-       }
-       /* see http://en.wikipedia.org/wiki/Tera */
-       fprintf(stderr, "%6d%c ", (int)abbrevsize, " kMGTPEZY"[i]);
 
-       elapsed = monotonic_sec();
-       since_last_update = elapsed - p->lastupdate_sec;
-       if (transferred > p->lastsize) {
-               p->lastupdate_sec = elapsed;
-               p->lastsize = transferred;
+       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 off" these seconds from elapsed time
+                       /* 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 -");
+               fprintf(stderr, "  - stalled -");
+       } else if (!totalsize || !transferred || (int)elapsed < 0) {
+               fprintf(stderr, " --:--:-- ETA");
        } else {
-               off_t to_download = totalsize - beg_range;
-               if (!totalsize || transferred <= 0 || (int)elapsed <= 0 || transferred > to_download) {
-                       fprintf(stderr, "--:--:-- ETA");
-               } else {
-                       /* to_download / (transferred/elapsed) - elapsed: */
-                       int eta = (int) ((unsigned long long)to_download*elapsed/transferred - elapsed);
-                       /* (long long helps to have working ETA even if !LFS) */
-                       i = eta % 3600;
-                       fprintf(stderr, "%02d:%02d:%02d ETA", eta / 3600, i / 60, i % 60);
-               }
+               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);
+       return notty;
 }