src/tool_cb_prg.c

   1 /***************************************************************************
   2  *                                  _   _ ____  _
   3  *  Project                     ___| | | |  _ \| |
   4  *                             / __| | | | |_) | |
   5  *                            | (__| |_| |  _ <| |___
   6  *                             \___|\___/|_| \_\_____|
   7  *
   8  * Copyright (C) 1998 - 2018, Daniel Stenberg, <daniel@haxx.se>, et al.
   9  *
  10  * This software is licensed as described in the file COPYING, which
  11  * you should have received as part of this distribution. The terms
  12  * are also available at https://curl.haxx.se/docs/copyright.html.
  13  *
  14  * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  15  * copies of the Software, and permit persons to whom the Software is
  16  * furnished to do so, under the terms of the COPYING file.
  17  *
  18  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  19  * KIND, either express or implied.
  20  *
  21  ***************************************************************************/
  22 #include "tool_setup.h"
  23
  24 #ifdef HAVE_SYS_IOCTL_H
  25 #include <sys/ioctl.h>
  26 #endif
  27
  28 #define ENABLE_CURLX_PRINTF
  29 /* use our own printf() functions */
  30 #include "curlx.h"
  31
  32 #include "tool_cfgable.h"
  33 #include "tool_cb_prg.h"
  34 #include "tool_util.h"
  35
  36 #include "memdebug.h" /* keep this as LAST include */
  37
  38 #ifdef HAVE_TERMIOS_H
  39 #  include <termios.h>
  40 #elif defined(HAVE_TERMIO_H)
  41 #  include <termio.h>
  42 #endif
  43
  44 /* 200 values generated by this perl code:
  45
  46    my $pi = 3.1415;
  47    foreach my $i (1 .. 200) {
  48      printf "%d, ", sin($i/200 * 2 * $pi) * 5000 + 5000;
  49    }
  50 */
  51 static const unsigned int sinus[] = {
  52   5157, 5313, 5470, 5626, 5782, 5936, 6090, 6243, 6394, 6545, 6693, 6840, 6985,
  53   7128, 7269, 7408, 7545, 7679, 7810, 7938, 8064, 8187, 8306, 8422, 8535, 8644,
  54   8750, 8852, 8950, 9045, 9135, 9221, 9303, 9381, 9454, 9524, 9588, 9648, 9704,
  55   9755, 9801, 9842, 9879, 9911, 9938, 9960, 9977, 9990, 9997, 9999, 9997, 9990,
  56   9977, 9960, 9938, 9911, 9879, 9842, 9801, 9755, 9704, 9648, 9588, 9524, 9455,
  57   9381, 9303, 9221, 9135, 9045, 8950, 8852, 8750, 8645, 8535, 8422, 8306, 8187,
  58   8064, 7939, 7810, 7679, 7545, 7409, 7270, 7129, 6986, 6841, 6694, 6545, 6395,
  59   6243, 6091, 5937, 5782, 5627, 5470, 5314, 5157, 5000, 4843, 4686, 4529, 4373,
  60   4218, 4063, 3909, 3757, 3605, 3455, 3306, 3159, 3014, 2871, 2730, 2591, 2455,
  61   2321, 2190, 2061, 1935, 1813, 1693, 1577, 1464, 1355, 1249, 1147, 1049, 955,
  62   864, 778, 696, 618, 545, 476, 411, 351, 295, 244, 198, 157, 120, 88, 61, 39,
  63   22, 9, 2, 0, 2, 9, 22, 39, 61, 88, 120, 156, 198, 244, 295, 350, 410, 475,
  64   544, 618, 695, 777, 864, 954, 1048, 1146, 1248, 1354, 1463, 1576, 1692, 1812,
  65   1934, 2060, 2188, 2320, 2454, 2590, 2729, 2870, 3013, 3158, 3305, 3454, 3604,
  66   3755, 3908, 4062, 4216, 4372, 4528, 4685, 4842, 4999
  67 };
  68
  69 static void fly(struct ProgressData *bar, bool moved)
  70 {
  71   char buf[256];
  72   int pos;
  73   int check = bar->width - 2;
  74
  75   snprintf(buf, sizeof(buf), "%*s\r", bar->width-1, " ");
  76   memcpy(&buf[bar->bar], "-=O=-", 5);
  77
  78   pos = sinus[bar->tick%200] / (10000 / check);
  79   buf[pos] = '#';
  80   pos = sinus[(bar->tick + 5)%200] / (10000 / check);
  81   buf[pos] = '#';
  82   pos = sinus[(bar->tick + 10)%200] / (10000 / check);
  83   buf[pos] = '#';
  84   pos = sinus[(bar->tick + 15)%200] / (10000 / check);
  85   buf[pos] = '#';
  86
  87   fputs(buf, bar->out);
  88   bar->tick += 2;
  89   if(bar->tick >= 200)
  90     bar->tick -= 200;
  91
  92   bar->bar += (moved?bar->barmove:0);
  93   if(bar->bar >= (bar->width - 6)) {
  94     bar->barmove = -1;
  95     bar->bar = bar->width - 6;
  96   }
  97   else if(bar->bar < 0) {
  98     bar->barmove = 1;
  99     bar->bar = 0;
 100   }
 101 }
 102
 103 /*
 104 ** callback for CURLOPT_XFERINFOFUNCTION
 105 */
 106
 107 #define MAX_BARLENGTH 256
 108
 109 int tool_progress_cb(void *clientp,
 110                      curl_off_t dltotal, curl_off_t dlnow,
 111                      curl_off_t ultotal, curl_off_t ulnow)
 112 {
 113   /* The original progress-bar source code was written for curl by Lars Aas,
 114      and this new edition inherits some of his concepts. */
 115
 116   char line[MAX_BARLENGTH + 1];
 117   char format[40];
 118   double frac;
 119   double percent;
 120   int barwidth;
 121   int num;
 122   struct timeval now = tvnow();
 123   struct ProgressData *bar = (struct ProgressData *)clientp;
 124   curl_off_t total;
 125   curl_off_t point;
 126
 127   /* expected transfer size */
 128   total = dltotal + ultotal + bar->initial_size;
 129
 130   /* we've come this far */
 131   point = dlnow + ulnow + bar->initial_size;
 132
 133   if(bar->calls) {
 134     /* after first call... */
 135     if(total) {
 136       /* we know the total data to get... */
 137       if(bar->prev == point)
 138         /* progress didn't change since last invoke */
 139         return 0;
 140       else if((tvdiff(now, bar->prevtime) < 100L) && point < total)
 141         /* limit progress-bar updating to 10 Hz except when we're at 100% */
 142         return 0;
 143     }
 144     else {
 145       /* total is unknown */
 146       if(tvdiff(now, bar->prevtime) < 100L)
 147         /* limit progress-bar updating to 10 Hz */
 148         return 0;
 149       fly(bar, point != bar->prev);
 150     }
 151   }
 152
 153   /* simply count invokes */
 154   bar->calls++;
 155
 156   if((total > 0) && (point != bar->prev)) {
 157     if(point > total)
 158       /* we have got more than the expected total! */
 159       total = point;
 160
 161     frac = (double)point / (double)total;
 162     percent = frac * 100.0;
 163     barwidth = bar->width - 7;
 164     num = (int) (((double)barwidth) * frac);
 165     if(num > MAX_BARLENGTH)
 166       num = MAX_BARLENGTH;
 167     memset(line, '#', num);
 168     line[num] = '\0';
 169     snprintf(format, sizeof(format), "\r%%-%ds %%5.1f%%%%", barwidth);
 170     fprintf(bar->out, format, line, percent);
 171   }
 172   fflush(bar->out);
 173   bar->prev = point;
 174   bar->prevtime = now;
 175
 176   return 0;
 177 }
 178
 179 void progressbarinit(struct ProgressData *bar,
 180                      struct OperationConfig *config)
 181 {
 182   char *colp;
 183   memset(bar, 0, sizeof(struct ProgressData));
 184
 185   /* pass this through to progress function so
 186    * it can display progress towards total file
 187    * not just the part that's left. (21-may-03, dbyron) */
 188   if(config->use_resume)
 189     bar->initial_size = config->resume_from;
 190
 191   colp = curlx_getenv("COLUMNS");
 192   if(colp) {
 193     char *endptr;
 194     long num = strtol(colp, &endptr, 10);
 195     if((endptr != colp) && (endptr == colp + strlen(colp)) && (num > 20))
 196       bar->width = (int)num;
 197     curl_free(colp);
 198   }
 199
 200   if(!bar->width) {
 201     int cols = 0;
 202
 203 #ifdef TIOCGSIZE
 204     struct ttysize ts;
 205     if(!ioctl(STDIN_FILENO, TIOCGSIZE, &ts))
 206       cols = ts.ts_cols;
 207 #elif defined(TIOCGWINSZ)
 208     struct winsize ts;
 209     if(!ioctl(STDIN_FILENO, TIOCGWINSZ, &ts))
 210       cols = ts.ws_col;
 211 #elif defined(_WIN32)
 212     {
 213       HANDLE  stderr_hnd = GetStdHandle(STD_ERROR_HANDLE);
 214       CONSOLE_SCREEN_BUFFER_INFO console_info;
 215
 216       if((stderr_hnd != INVALID_HANDLE_VALUE) &&
 217          GetConsoleScreenBufferInfo(stderr_hnd, &console_info)) {
 218         /*
 219          * Do not use +1 to get the true screen-width since writing a
 220          * character at the right edge will cause a line wrap.
 221          */
 222         cols = (int)
 223           (console_info.srWindow.Right - console_info.srWindow.Left);
 224       }
 225     }
 226 #endif /* TIOCGSIZE */
 227     bar->width = cols;
 228   }
 229
 230   if(!bar->width)
 231     bar->width = 79;
 232   else if(bar->width > MAX_BARLENGTH)
 233     bar->width = MAX_BARLENGTH;
 234
 235   bar->out = config->global->errors;
 236   bar->tick = 150;
 237   bar->barmove = 1;
 238 }