2 * Copyright (c) 2000-2004 Dag-Erling Coïdan Smørgrav
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer
10 * in this position and unchanged.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * 3. The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 * $FreeBSD: src/usr.bin/fetch/fetch.c,v 1.78 2006/11/10 22:05:41 des Exp $
29 * $DragonFly: src/usr.bin/fetch/fetch.c,v 1.8 2007/08/05 21:48:12 swildner Exp $
32 #include <sys/param.h>
33 #include <sys/socket.h>
51 #define MINBUFSIZE 4096
54 int A_flag; /* -A: do not follow 302 redirects */
55 int a_flag; /* -a: auto retry */
56 off_t B_size; /* -B: buffer size */
57 int b_flag; /*! -b: workaround TCP bug */
58 char *c_dirname; /* -c: remote directory */
59 int d_flag; /* -d: direct connection */
60 int F_flag; /* -F: restart without checking mtime */
61 char *f_filename; /* -f: file to fetch */
62 char *h_hostname; /* -h: host to fetch from */
63 int l_flag; /* -l: link rather than copy file: URLs */
64 int m_flag; /* -[Mm]: mirror mode */
65 char *N_filename; /* -N: netrc file name */
66 int n_flag; /* -n: do not preserve modification time */
67 int o_flag; /* -o: specify output file */
68 int o_directory; /* output file is a directory */
69 char *o_filename; /* name of output file */
70 int o_stdout; /* output file is stdout */
71 int once_flag; /* -1: stop at first successful file */
72 int p_flag; /* -[Pp]: use passive FTP */
73 int R_flag; /* -R: don't delete partially transferred files */
74 int r_flag; /* -r: restart previously interrupted transfer */
75 off_t S_size; /* -S: require size to match */
76 int s_flag; /* -s: show size, don't fetch */
77 long T_secs = 120; /* -T: transfer timeout in seconds */
78 int t_flag; /*! -t: workaround TCP bug */
79 int U_flag; /* -U: do not use high ports */
80 int v_level = 1; /* -v: verbosity level */
81 int v_tty; /* stdout is a tty */
82 pid_t pgrp; /* our process group */
83 long w_secs; /* -w: retry delay */
84 int family = PF_UNSPEC; /* -[46]: address family to use */
86 int sigalrm; /* SIGALRM received */
87 int siginfo; /* SIGINFO received */
88 int sigint; /* SIGINT received */
90 long ftp_timeout; /* default timeout for FTP transfers */
91 long http_timeout; /* default timeout for HTTP transfers */
92 char *buf; /* transfer buffer */
116 struct timeval start;
124 * Compute and display ETA
127 stat_eta(struct xferstat *xs)
131 off_t received, expected;
133 elapsed = xs->last.tv_sec - xs->start.tv_sec;
134 received = xs->rcvd - xs->offset;
135 expected = xs->size - xs->rcvd;
136 eta = (long)((double)elapsed * expected / received);
138 snprintf(str, sizeof str, "%02ldh%02ldm",
139 eta / 3600, (eta % 3600) / 60);
141 snprintf(str, sizeof str, "%02ldm%02lds",
147 * Format a number as "xxxx YB" where Y is ' ', 'k', 'M'...
149 static const char *prefixes = " kMGTP";
151 stat_bytes(off_t bytes)
154 const char *prefix = prefixes;
156 while (bytes > 9999 && prefix[1] != '\0') {
160 snprintf(str, sizeof str, "%4jd %cB", (intmax_t)bytes, *prefix);
165 * Compute and display transfer rate
168 stat_bps(struct xferstat *xs)
173 delta = (xs->last.tv_sec + (xs->last.tv_usec / 1.e6))
174 - (xs->start.tv_sec + (xs->start.tv_usec / 1.e6));
176 snprintf(str, sizeof str, "?? Bps");
178 bps = (xs->rcvd - xs->offset) / delta;
179 snprintf(str, sizeof str, "%sps", stat_bytes((off_t)bps));
185 * Update the stats display
188 stat_display(struct xferstat *xs, int force)
193 /* check if we're the foreground process */
194 if (ioctl(STDERR_FILENO, TIOCGPGRP, &ctty_pgrp) == -1 ||
195 (pid_t)ctty_pgrp != pgrp)
198 gettimeofday(&now, NULL);
199 if (!force && now.tv_sec <= xs->last.tv_sec)
203 fprintf(stderr, "\r%-46.46s", xs->name);
205 setproctitle("%s [%s]", xs->name, stat_bytes(xs->rcvd));
206 fprintf(stderr, " %s", stat_bytes(xs->rcvd));
208 setproctitle("%s [%d%% of %s]", xs->name,
209 (int)((100.0 * xs->rcvd) / xs->size),
210 stat_bytes(xs->size));
211 fprintf(stderr, "%3d%% of %s",
212 (int)((100.0 * xs->rcvd) / xs->size),
213 stat_bytes(xs->size));
215 fprintf(stderr, " %s", stat_bps(xs));
216 if (xs->size > 0 && xs->rcvd > 0 &&
217 xs->last.tv_sec >= xs->start.tv_sec + 10)
218 fprintf(stderr, " %s", stat_eta(xs));
222 * Initialize the transfer statistics
225 stat_start(struct xferstat *xs, const char *name, off_t size, off_t offset)
227 snprintf(xs->name, sizeof xs->name, "%s", name);
228 gettimeofday(&xs->start, NULL);
229 xs->last.tv_sec = xs->last.tv_usec = 0;
233 if (v_tty && v_level > 0)
235 else if (v_level > 0)
236 fprintf(stderr, "%-46s", xs->name);
240 * Update the transfer statistics
243 stat_update(struct xferstat *xs, off_t rcvd)
246 if (v_tty && v_level > 0)
251 * Finalize the transfer statistics
254 stat_end(struct xferstat *xs)
256 gettimeofday(&xs->last, NULL);
257 if (v_tty && v_level > 0) {
260 } else if (v_level > 0) {
261 fprintf(stderr, " %s %s\n",
262 stat_bytes(xs->size), stat_bps(xs));
267 * Ask the user for authentication details
270 query_auth(struct url *URL)
273 tcflag_t saved_flags;
276 fprintf(stderr, "Authentication required for <%s://%s:%d/>!\n",
277 URL->scheme, URL->host, URL->port);
279 fprintf(stderr, "Login: ");
280 if (fgets(URL->user, sizeof URL->user, stdin) == NULL)
282 for (i = strlen(URL->user); i >= 0; --i)
283 if (URL->user[i] == '\r' || URL->user[i] == '\n')
286 fprintf(stderr, "Password: ");
287 if (tcgetattr(STDIN_FILENO, &tios) == 0) {
288 saved_flags = tios.c_lflag;
289 tios.c_lflag &= ~ECHO;
290 tios.c_lflag |= ECHONL|ICANON;
291 tcsetattr(STDIN_FILENO, TCSAFLUSH|TCSASOFT, &tios);
292 nopwd = (fgets(URL->pwd, sizeof URL->pwd, stdin) == NULL);
293 tios.c_lflag = saved_flags;
294 tcsetattr(STDIN_FILENO, TCSANOW|TCSASOFT, &tios);
296 nopwd = (fgets(URL->pwd, sizeof URL->pwd, stdin) == NULL);
300 for (i = strlen(URL->pwd); i >= 0; --i)
301 if (URL->pwd[i] == '\r' || URL->pwd[i] == '\n')
311 fetch(char *URL, const char *path)
334 /* set verbosity level */
341 if ((url = fetchParseURL(URL)) == NULL) {
342 warnx("%s: parse error", URL);
346 /* if no scheme was specified, take a guess */
347 if (*url->scheme == 0) {
349 strcpy(url->scheme, SCHEME_FILE);
350 else if (strncasecmp(url->host, "ftp.", 4) == 0)
351 strcpy(url->scheme, SCHEME_FTP);
352 else if (strncasecmp(url->host, "www.", 4) == 0)
353 strcpy(url->scheme, SCHEME_HTTP);
366 /* FTP specific flags */
367 if (strcmp(url->scheme, "ftp") == 0) {
374 timeout = T_secs ? T_secs : ftp_timeout;
377 /* HTTP specific flags */
378 if (strcmp(url->scheme, "http") == 0) {
383 timeout = T_secs ? T_secs : http_timeout;
386 /* set the protocol timeout. */
387 fetchTimeout = timeout;
389 /* just print size */
393 r = fetchStat(url, &us, flags);
396 if (sigalrm || sigint)
399 warnx("%s", fetchLastErrString);
405 printf("%jd\n", (intmax_t)us.size);
410 * If the -r flag was specified, we have to compare the local
411 * and remote files, so we should really do a fetchStat()
412 * first, but I know of at least one HTTP server that only
413 * sends the content size in response to GET requests, and
414 * leaves it out of replies to HEAD requests. Also, in the
415 * (frequent) case that the local and remote files match but
416 * the local file is truncated, we have sufficient information
417 * before the compare to issue a correct request. Therefore,
418 * we always issue a GET request as if we were sure the local
419 * file was a truncated copy of the remote file; we can drop
420 * the connection later if we change our minds.
425 if (r == 0 && r_flag && S_ISREG(sb.st_mode)) {
426 url->offset = sb.st_size;
427 } else if (r == -1 || !S_ISREG(sb.st_mode)) {
429 * Whatever value sb.st_size has now is either
430 * wrong (if stat(2) failed) or irrelevant (if the
431 * path does not refer to a regular file)
435 if (r == -1 && errno != ENOENT) {
436 warnx("%s: stat()", path);
441 /* start the transfer */
444 f = fetchXGet(url, &us, flags);
447 if (sigalrm || sigint)
450 warnx("%s: %s", URL, fetchLastErrString);
456 /* check that size is as expected */
459 warnx("%s: size unknown", URL);
460 } else if (us.size != S_size) {
461 warnx("%s: size mismatch: expected %jd, actual %jd",
462 URL, (intmax_t)S_size, (intmax_t)us.size);
467 /* symlink instead of copy */
468 if (l_flag && strcmp(url->scheme, "file") == 0 && !o_stdout) {
469 if (symlink(url->doc, path) == -1) {
470 warn("%s: symlink()", path);
476 if (us.size == -1 && !o_stdout && v_level > 0)
477 warnx("%s: size of remote file is not known", URL);
479 if (sb.st_size != -1)
480 fprintf(stderr, "local size / mtime: %jd / %ld\n",
481 (intmax_t)sb.st_size, (long)sb.st_mtime);
483 fprintf(stderr, "remote size / mtime: %jd / %ld\n",
484 (intmax_t)us.size, (long)us.mtime);
487 /* open output file */
489 /* output to stdout */
491 } else if (r_flag && sb.st_size != -1) {
492 /* resume mode, local file exists */
493 if (!F_flag && us.mtime && sb.st_mtime != us.mtime) {
494 /* no match! have to refetch */
496 /* if precious, warn the user and give up */
498 warnx("%s: local modification time "
499 "does not match remote", path);
502 } else if (us.size != -1) {
503 if (us.size == sb.st_size)
506 if (sb.st_size > us.size) {
507 /* local file too long! */
508 warnx("%s: local file (%jd bytes) is longer "
509 "than remote file (%jd bytes)", path,
510 (intmax_t)sb.st_size, (intmax_t)us.size);
513 /* we got it, open local file */
514 if ((of = fopen(path, "a")) == NULL) {
515 warn("%s: fopen()", path);
518 /* check that it didn't move under our feet */
519 if (fstat(fileno(of), &nsb) == -1) {
521 warn("%s: fstat()", path);
524 if (nsb.st_dev != sb.st_dev ||
525 nsb.st_ino != nsb.st_ino ||
526 nsb.st_size != sb.st_size) {
527 warnx("%s: file has changed", URL);
533 } else if (m_flag && sb.st_size != -1) {
534 /* mirror mode, local file exists */
535 if (sb.st_size == us.size && sb.st_mtime == us.mtime)
541 * We don't yet have an output file; either this is a
542 * vanilla run with no special flags, or the local and
543 * remote files didn't match.
546 if (url->offset > 0) {
548 * We tried to restart a transfer, but for
549 * some reason gave up - so we have to restart
550 * from scratch if we want the whole file
553 if ((f = fetchXGet(url, &us, flags)) == NULL) {
554 warnx("%s: %s", URL, fetchLastErrString);
561 /* construct a temporary file name */
562 if (sb.st_size != -1 && S_ISREG(sb.st_mode)) {
563 if ((slash = strrchr(path, '/')) == NULL)
567 asprintf(&tmppath, "%.*s.fetch.XXXXXX.%s",
568 (int)(slash - path), path, slash);
569 if (tmppath != NULL) {
570 if (mkstemps(tmppath, strlen(slash)+1) == -1) {
571 warn("%s: mkstemps()", path);
575 of = fopen(tmppath, "w");
576 chown(tmppath, sb.st_uid, sb.st_gid);
577 chmod(tmppath, sb.st_mode & ALLPERMS);
582 if ((of = fopen(path, "w")) == NULL) {
583 warn("%s: fopen()", path);
589 /* start the counter */
590 stat_start(&xs, path, us.size, count);
592 sigalrm = siginfo = sigint = 0;
594 /* suck in the data */
595 signal(SIGINFO, sig_handler);
597 if (us.size != -1 && us.size - count < B_size &&
598 us.size - count >= 0)
599 size = us.size - count;
606 if ((size = fread(buf, 1, size, f)) == 0) {
607 if (ferror(f) && errno == EINTR && !sigint)
612 stat_update(&xs, count += size);
613 for (ptr = buf; size > 0; ptr += wr, size -= wr)
614 if ((wr = fwrite(ptr, 1, size, of)) < size) {
615 if (ferror(of) && errno == EINTR && !sigint)
624 sigalrm = ferror(f) && errno == ETIMEDOUT;
625 signal(SIGINFO, SIG_DFL);
630 * If the transfer timed out or was interrupted, we still want to
631 * set the mtime in case the file is not removed (-r or -R) and
632 * the user later restarts the transfer.
635 /* set mtime of local file */
636 if (!n_flag && us.mtime && !o_stdout && of != NULL &&
637 (stat(path, &sb) != -1) && sb.st_mode & S_IFREG) {
638 struct timeval tv[2];
641 tv[0].tv_sec = (long)(us.atime ? us.atime : us.mtime);
642 tv[1].tv_sec = (long)us.mtime;
643 tv[0].tv_usec = tv[1].tv_usec = 0;
644 if (utimes(tmppath ? tmppath : path, tv))
645 warn("%s: utimes()", tmppath ? tmppath : path);
648 /* timed out or interrupted? */
650 warnx("transfer timed out");
652 warnx("transfer interrupted");
656 /* timeout / interrupt before connection completley established? */
661 /* check the status of our files */
666 if (ferror(f) || ferror(of))
670 /* did the transfer complete normally? */
671 if (us.size != -1 && count < us.size) {
672 warnx("%s appears to be truncated: %jd/%jd bytes",
673 path, (intmax_t)count, (intmax_t)us.size);
678 * If the transfer timed out and we didn't know how much to
679 * expect, assume the worst (i.e. we didn't get all of it)
681 if (sigalrm && us.size == -1) {
682 warnx("%s may be truncated", path);
688 if (tmppath != NULL && rename(tmppath, path) == -1) {
689 warn("%s: rename()", path);
694 if (of && of != stdout && !R_flag && !r_flag)
695 if (stat(path, &sb) != -1 && (sb.st_mode & S_IFREG))
696 unlink(tmppath ? tmppath : path);
697 if (R_flag && tmppath != NULL && sb.st_size == -1)
698 rename(tmppath, path); /* ignore errors here */
705 if (of && of != stdout)
717 fprintf(stderr, "%s\n%s\n%s\n",
718 "usage: fetch [-146AFMPRUadlmnpqrsv] [-N netrc] [-o outputfile]",
719 " [-S bytes] [-B bytes] [-T seconds] [-w seconds]",
720 " [-h host -f file [-c dir] | URL ...]");
728 main(int argc, char *argv[])
736 while ((c = getopt(argc, argv,
737 "146AaB:bc:dFf:Hh:lMmN:nPpo:qRrS:sT:tUvw:")) != -1)
755 B_size = (off_t)strtol(optarg, &end, 10);
756 if (*optarg == '\0' || *end != '\0')
757 errx(1, "invalid buffer size (%s)", optarg);
760 warnx("warning: the -b option is deprecated");
776 warnx("the -H option is now implicit, "
777 "use -U to disable");
792 errx(1, "the -m and -r flags "
793 "are mutually exclusive");
814 errx(1, "the -m and -r flags "
815 "are mutually exclusive");
819 S_size = (off_t)strtol(optarg, &end, 10);
820 if (*optarg == '\0' || *end != '\0')
821 errx(1, "invalid size (%s)", optarg);
827 T_secs = strtol(optarg, &end, 10);
828 if (*optarg == '\0' || *end != '\0')
829 errx(1, "invalid timeout (%s)", optarg);
833 warnx("warning: the -t option is deprecated");
843 w_secs = strtol(optarg, &end, 10);
844 if (*optarg == '\0' || *end != '\0')
845 errx(1, "invalid delay (%s)", optarg);
855 if (h_hostname || f_filename || c_dirname) {
856 if (!h_hostname || !f_filename || argc) {
860 /* XXX this is a hack. */
861 if (strcspn(h_hostname, "@:/") != strlen(h_hostname))
862 errx(1, "invalid hostname");
863 if (asprintf(argv, "ftp://%s/%s/%s", h_hostname,
864 c_dirname ? c_dirname : "", f_filename) == -1)
865 errx(1, "%s", strerror(ENOMEM));
874 /* allocate buffer */
875 if (B_size < MINBUFSIZE)
877 if ((buf = malloc(B_size)) == NULL)
878 errx(1, "%s", strerror(ENOMEM));
881 if ((s = getenv("FTP_TIMEOUT")) != NULL) {
882 ftp_timeout = strtol(s, &end, 10);
883 if (*s == '\0' || *end != '\0' || ftp_timeout < 0) {
884 warnx("FTP_TIMEOUT (%s) is not a positive integer", s);
888 if ((s = getenv("HTTP_TIMEOUT")) != NULL) {
889 http_timeout = strtol(s, &end, 10);
890 if (*s == '\0' || *end != '\0' || http_timeout < 0) {
891 warnx("HTTP_TIMEOUT (%s) is not a positive integer", s);
896 /* signal handling */
898 sa.sa_handler = sig_handler;
899 sigemptyset(&sa.sa_mask);
900 sigaction(SIGALRM, &sa, NULL);
901 sa.sa_flags = SA_RESETHAND;
902 sigaction(SIGINT, &sa, NULL);
903 fetchRestartCalls = 0;
907 if (strcmp(o_filename, "-") == 0) {
909 } else if (stat(o_filename, &sb) == -1) {
910 if (errno == ENOENT) {
912 errx(EX_USAGE, "%s is not a directory",
915 err(EX_IOERR, "%s", o_filename);
918 if (sb.st_mode & S_IFDIR)
923 /* check if output is to a tty (for progress report) */
924 v_tty = isatty(STDERR_FILENO);
932 fetchAuthMethod = query_auth;
933 if (N_filename != NULL) {
934 if (setenv("NETRC", N_filename, 1) == -1)
935 err(1, "setenv: cannot set NETRC=%s", N_filename);
939 if ((p = strrchr(*argv, '/')) == NULL)
947 fetchLastErrCode = 0;
951 e = fetch(*argv, "-");
952 } else if (o_directory) {
953 asprintf(&q, "%s/%s", o_filename, p);
957 e = fetch(*argv, o_filename);
964 kill(getpid(), SIGINT);
966 if (e == 0 && once_flag)
971 if ((fetchLastErrCode
972 && fetchLastErrCode != FETCH_UNAVAIL
973 && fetchLastErrCode != FETCH_MOVED
974 && fetchLastErrCode != FETCH_URL
975 && fetchLastErrCode != FETCH_RESOLV
976 && fetchLastErrCode != FETCH_UNKNOWN)) {
977 if (w_secs && v_level)
978 fprintf(stderr, "Waiting %ld seconds "
979 "before retrying\n", w_secs);