progress.c

/*
 *   zsync - client side rsync over http
 *   Copyright (C) 2004,2005,2007,2009 Colin Phipps <cph@moria.org.uk>
 *
 *   This program is free software; you can redistribute it and/or modify
 *   it under the terms of the Artistic License v2 (see the accompanying 
 *   file COPYING for the full license terms), or, at your option, any later 
 *   version of the same license.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   COPYING file for details.
 */

#include "zsglobal.h"

#include <stdlib.h>
#include <stdio.h>
#include <time.h>

#ifdef WITH_DMALLOC
# include <dmalloc.h>
#endif

#include "progress.h"

struct progress {
    time_t starttime;
    time_t lasttime;
    float lastpcnt;
    long long lastdl;
};


/* progbar(chars, percent)
 * (Re)print progress bar with chars out of 20 shown and followed by the given
 * percentage done. */
static void progbar(int j, float pcnt) {
    int i;
    char buf[21];

    for (i = 0; i < j && i < 20; i++)
        buf[i] = '#';
    for (; i < 20; i++)
        buf[i] = '-';
    buf[i] = 0;
    printf("\r%s %.1f%%", buf, pcnt);
}

/* state=start_progress(url)
 * Returns a handle to a progress state used to track progress downloading
 * from the given URL.*/
void *start_progress(const char *url)
{
    struct progress *p = calloc(sizeof(struct progress), 1);
    return p;
}

/* do_progress(progress, percent, total_bytes_retrieved
 * Updates the supplied progress structure with the new % done given, and
 * recalculates the rolling download rate given the supplied
 * total_bytes_retrieved (and the current time) */
void do_progress(void *pv, float pcnt, long long newdl) {
    struct progress *p = pv;
    /* If new or if time has passed, update progress display & data */
    time_t newtime = time(NULL);
    if (p->lasttime != newtime) {
        int passed = p->lasttime ? newtime - p->lasttime : 0;
        if (!p->lasttime)
            p->starttime = newtime;
        p->lasttime = newtime;

        /* Update progress bar displayed */
        progbar(pcnt * (20.0 / 100.0), pcnt);

        /* Each time 1s has passed, we update and redisplay our download rate */
        if (passed) {
            float rate = newdl - p->lastdl;
            int sleft = (100.0f - pcnt) / (pcnt - p->lastpcnt);
            if (passed != 1) {
                rate /= passed;
                sleft *= passed;
            }
            printf(" %.1f kBps ", rate / 1000.0);
            if (sleft < 60 * 1000)
                printf("%d:%02d ETA  ", sleft / 60, sleft % 60);
            else
                puts("        ");
        }
        p->lastdl = newdl;
        p->lastpcnt = pcnt;
        fflush(stdout);
    }
}

/* end_progress(progress, done)
 * Do one final update of the progress display (set to 100% if done is set to
 * true), and then release the progress data structures.
 */
void end_progress(void *pv, int done) {
    struct progress *p = pv;
    if (done == 2)
        progbar(20, 100.0);
    else
        progbar(p->lastpcnt * (20.0 / 100.0), p->lastpcnt);

    {
        float rate = ((float)p->lastdl) / (p->lasttime - p->starttime + 0.5);
        printf(" %.1f kBps ", rate / 1000.0);
    }
    puts(done == 2 ? "DONE    \n" : !done ? "aborted    \n" : "        \n");
    fflush(stdout);
    free(p);
}