xbps/lib/download.c
Juan RP 992e8c6a14 libxbps::xbps_humanize_number(): use common values and hide implementation details from API.
So now its prototype is the following:

int xbps_humanize_number(char *buf, int64_t bytes)

It is a wrapper around NetBSD's humanize_number(3) which uses 6 digits for max
length, HN_AUTOSCALE and HN_NOSPACE|HN_DECIMAL. All users have been updated.
2011-01-18 23:10:07 +01:00

441 lines
10 KiB
C

/*-
* Copyright (c) 2009-2011 Juan Romero Pardines
* Copyright (c) 2000-2004 Dag-Erling Coïdan Smørgrav
* 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
* in this position and unchanged.
* 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. The name of the author may not be used to endorse or promote products
* derived from this software without specific prior written permission
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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.
*
* From FreeBSD fetch(8):
* $FreeBSD: src/usr.bin/fetch/fetch.c,v 1.84.2.1 2009/08/03 08:13:06 kensmith Exp $
*/
#include <sys/param.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <sys/time.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <errno.h>
#include <fcntl.h>
#include <xbps_api.h>
#include "xbps_api_impl.h"
#include "fetch.h"
/**
* @file lib/download.c
* @brief Download routines
* @defgroup download Internal download functions
*
* These functions allow you to download files.
*/
struct xferstat {
struct timeval start;
struct timeval last;
off_t size;
off_t offset;
off_t rcvd;
const char *name;
};
/*
* Compute and display ETA
*/
static const char *
stat_eta(struct xferstat *xsp)
{
static char str[16];
long elapsed, eta;
off_t received, expected;
elapsed = xsp->last.tv_sec - xsp->start.tv_sec;
received = xsp->rcvd - xsp->offset;
expected = xsp->size - xsp->rcvd;
eta = (long)(elapsed * expected / received);
if (eta > 3600)
snprintf(str, sizeof str, "%02ldh%02ldm",
eta / 3600, (eta % 3600) / 60);
else
snprintf(str, sizeof str, "%02ldm%02lds",
eta / 60, eta % 60);
return str;
}
/** High precision double comparison
* \param[in] a The first double to compare
* \param[in] b The second double to compare
* \return true on equal within precison, false if not equal within defined precision.
*/
static inline bool
compare_double(const double a, const double b)
{
const double precision = 0.00001;
if ((a - precision) < b && (a + precision) > b)
return true;
else
return false;
}
/*
* Compute and display transfer rate
*/
static const char *
stat_bps(struct xferstat *xsp)
{
static char str[16];
char size[8];
double delta, bps;
delta = (xsp->last.tv_sec + (xsp->last.tv_usec / 1.e6))
- (xsp->start.tv_sec + (xsp->start.tv_usec / 1.e6));
if (compare_double(delta, 0.0001)) {
snprintf(str, sizeof str, "-- stalled --");
} else {
bps = ((double)(xsp->rcvd - xsp->offset) / delta);
(void)xbps_humanize_number(size, (int64_t)bps);
snprintf(str, sizeof str, "%s/s", size);
}
return str;
}
/*
* Update the stats display
*/
static void
stat_display(struct xferstat *xsp)
{
struct timeval now;
char totsize[8], recvsize[8];
gettimeofday(&now, NULL);
if (now.tv_sec <= xsp->last.tv_sec)
return;
xsp->last = now;
(void)xbps_humanize_number(totsize, (int64_t)xsp->size);
(void)xbps_humanize_number(recvsize, (int64_t)xsp->rcvd);
fprintf(stderr, "\r%s: %s [%d%% of %s]",
xsp->name, recvsize,
(int)((double)(100.0 * (double)xsp->rcvd) / (double)xsp->size),
totsize);
fprintf(stderr, " %s", stat_bps(xsp));
if (xsp->size > 0 && xsp->rcvd > 0 &&
xsp->last.tv_sec >= xsp->start.tv_sec + 10)
fprintf(stderr, " ETA: %s", stat_eta(xsp));
fprintf(stderr, "\033[K");
}
/*
* Initialize the transfer statistics
*/
static void
stat_start(struct xferstat *xsp, const char *name, off_t *size, off_t *offset)
{
gettimeofday(&xsp->start, NULL);
xsp->last.tv_sec = xsp->last.tv_usec = 0;
xsp->name = name;
xsp->size = *size;
xsp->offset = *offset;
xsp->rcvd = *offset;
}
/*
* Update the transfer statistics
*/
static void
stat_update(struct xferstat *xsp, off_t rcvd)
{
xsp->rcvd = rcvd + xsp->offset;
stat_display(xsp);
}
/*
* Finalize the transfer statistics
*/
static void
stat_end(struct xferstat *xsp)
{
char size[8];
(void)xbps_humanize_number(size, (int64_t)xsp->size);
fprintf(stderr, "\rDownloaded %s for %s [avg rate: %s]",
size, xsp->name, stat_bps(xsp));
fprintf(stderr, "\033[K\n");
}
#ifdef DEBUG
static const char *
print_time(time_t *t)
{
struct tm tm;
static char buf[255];
localtime_r(t, &tm);
strftime(buf, sizeof(buf), "%d %b %Y %H:%M", &tm);
return buf;
}
#endif
const char *
xbps_fetch_error_string(void)
{
return fetchLastErrString;
}
void HIDDEN
xbps_fetch_set_cache_connection(int global, int per_host)
{
if (global == 0)
global = XBPS_FETCH_CACHECONN;
if (per_host == 0)
per_host = XBPS_FETCH_CACHECONN_HOST;
fetchConnectionCacheInit(global, per_host);
}
void HIDDEN
xbps_fetch_unset_cache_connection(void)
{
fetchConnectionCacheClose();
}
int
xbps_fetch_file(const char *uri, const char *outputdir, bool refetch,
const char *flags)
{
struct stat st;
struct xferstat xs;
struct url *url = NULL;
struct url_stat url_st;
struct fetchIO *fio = NULL;
struct timeval tv[2];
ssize_t bytes_read = -1, bytes_written;
off_t bytes_dld = -1;
char buf[4096], *filename, *destfile = NULL;
int fd = -1, rv = 0;
bool restart = false;
fetchLastErrCode = 0;
fetchTimeout = 30; /* 30 seconds of timeout */
/*
* Get the filename specified in URI argument.
*/
filename = strrchr(uri, '/');
if (filename == NULL) {
errno = EINVAL;
return -1;
}
filename++;
/*
* Compute destination file path.
*/
destfile = xbps_xasprintf("%s/%s", outputdir, filename);
if (destfile == NULL) {
rv = -1;
goto out;
}
/*
* Check if we have to resume a transfer.
*/
memset(&st, 0, sizeof(st));
if (stat(destfile, &st) == 0) {
if (st.st_size > 0)
restart = true;
} else {
if (errno != ENOENT) {
rv = -1;
goto out;
}
}
/*
* Prepare stuff for libfetch.
*/
if ((url = fetchParseURL(uri)) == NULL) {
rv = -1;
goto out;
}
/*
* Check if we want to refetch from scratch a file.
*/
if (refetch) {
/*
* Issue a HEAD request to know size and mtime.
*/
if ((rv = fetchStat(url, &url_st, NULL)) == -1)
goto out;
/*
* If mtime and size match do nothing.
*/
if (restart && url_st.size && url_st.mtime &&
url_st.size == st.st_size &&
url_st.mtime == st.st_mtime)
goto out;
/*
* If size match do nothing.
*/
if (restart && url_st.size && url_st.size == st.st_size)
goto out;
/*
* Remove current file (if exists).
*/
if (restart && remove(destfile) == -1) {
rv = -1;
goto out;
}
restart = false;
url->offset = 0;
/*
* Issue the GET request to refetch.
*/
fio = fetchGet(url, flags);
} else {
/*
* Issue a GET and skip the HEAD request, some servers
* (googlecode.com) return a 404 in HEAD requests!
*/
url->offset = st.st_size;
fio = fetchXGet(url, &url_st, flags);
}
#ifdef DEBUG
printf("st.st_size: %zd\n", (ssize_t)st.st_size);
printf("st.st_atime: %s\n", print_time(&st.st_atime));
printf("st.st_mtime: %s\n", print_time(&st.st_mtime));
printf("url->scheme: %s\n", url->scheme);
printf("url->host: %s\n", url->host);
printf("url->port: %d\n", url->port);
printf("url->doc: %s\n", url->doc);
printf("url->offset: %zd\n", (ssize_t)url->offset);
printf("url->length: %zu\n", url->length);
printf("url->last_modified: %s\n", print_time(&url->last_modified));
printf("url_stat.size: %zd\n", (ssize_t)url_st.size);
printf("url_stat.atime: %s\n", print_time(&url_st.atime));
printf("url_stat.mtime: %s\n", print_time(&url_st.mtime));
#endif
if (fio == NULL && fetchLastErrCode != FETCH_OK) {
if (!refetch && restart && fetchLastErrCode == FETCH_UNAVAIL) {
/*
* In HTTP when 416 is returned and length==0
* means that local and remote file size match.
* Because we are requesting offset==st_size! grr,
* stupid http servers...
*/
if (url->length == 0)
goto out;
}
rv = -1;
goto out;
}
if (url_st.size == -1) {
printf("Remote file size is unknown!\n");
errno = EINVAL;
rv = -1;
goto out;
} else if (st.st_size > url_st.size) {
printf("Local file %s is greater than remote file!\n",
filename);
errno = EFBIG;
rv = -1;
goto out;
} else if (restart && url_st.mtime && url_st.size &&
url_st.size == st.st_size && url_st.mtime == st.st_mtime) {
/* Local and remote size/mtime match, do nothing. */
goto out;
}
fprintf(stderr, "Connected to %s.\n", url->host);
/*
* If restarting, open the file for appending otherwise create it.
*/
if (restart)
fd = open(destfile, O_WRONLY|O_APPEND);
else
fd = open(destfile, O_WRONLY|O_CREAT|O_TRUNC, 0644);
if (fd == -1) {
rv = -1;
goto out;
}
/*
* Start fetching requested file.
*/
stat_start(&xs, filename, &url_st.size, &url->offset);
while ((bytes_read = fetchIO_read(fio, buf, sizeof(buf))) > 0) {
bytes_written = write(fd, buf, (size_t)bytes_read);
if (bytes_written != bytes_read) {
fprintf(stderr, "Couldn't write to %s!\n", destfile);
rv = -1;
goto out;
}
bytes_dld += bytes_read;
stat_update(&xs, bytes_dld);
}
if (bytes_read == -1) {
fprintf(stderr, "IO error while fetching %s: %s\n", filename,
fetchLastErrString);
errno = EIO;
rv = -1;
goto out;
}
stat_end(&xs);
if (fd == -1)
goto out;
/*
* Update mtime in local file to match remote file if transfer
* was successful.
*/
tv[0].tv_sec = url_st.atime ? url_st.atime : url_st.mtime;
tv[1].tv_sec = url_st.mtime;
tv[0].tv_usec = tv[1].tv_usec = 0;
if (utimes(destfile, tv) == -1)
rv = -1;
else {
/* File downloaded successfully */
rv = 1;
}
out:
if (fd != -1)
(void)close(fd);
if (fio != NULL)
fetchIO_close(fio);
if (url != NULL)
fetchFreeURL(url);
if (destfile != NULL)
free(destfile);
return rv;
}