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.84 2009/01/17 13:34:56 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>
50 #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 i_flag
; /* -i: specify input file for mtime comparison */
64 char *i_filename
; /* name of input file */
65 int l_flag
; /* -l: link rather than copy file: URLs */
66 int m_flag
; /* -[Mm]: mirror mode */
67 char *N_filename
; /* -N: netrc file name */
68 int n_flag
; /* -n: do not preserve modification time */
69 int o_flag
; /* -o: specify output file */
70 int o_directory
; /* output file is a directory */
71 char *o_filename
; /* name of output file */
72 int o_stdout
; /* output file is stdout */
73 int once_flag
; /* -1: stop at first successful file */
74 int p_flag
; /* -[Pp]: use passive FTP */
75 int R_flag
; /* -R: don't delete partially transferred files */
76 int r_flag
; /* -r: restart previously interrupted transfer */
77 off_t S_size
; /* -S: require size to match */
78 int s_flag
; /* -s: show size, don't fetch */
79 long T_secs
; /* -T: transfer timeout in seconds */
80 int t_flag
; /*! -t: workaround TCP bug */
81 int U_flag
; /* -U: do not use high ports */
82 int v_level
= 1; /* -v: verbosity level */
83 int v_tty
; /* stdout is a tty */
84 pid_t pgrp
; /* our process group */
85 long w_secs
; /* -w: retry delay */
86 int family
= PF_UNSPEC
; /* -[46]: address family to use */
88 int sigalrm
; /* SIGALRM received */
89 int siginfo
; /* SIGINFO received */
90 int sigint
; /* SIGINT received */
92 long ftp_timeout
= TIMEOUT
; /* default timeout for FTP transfers */
93 long http_timeout
= TIMEOUT
; /* default timeout for HTTP transfers */
94 char *buf
; /* transfer buffer */
118 struct timeval start
;
126 * Compute and display ETA
129 stat_eta(struct xferstat
*xs
)
133 off_t received
, expected
;
135 elapsed
= xs
->last
.tv_sec
- xs
->start
.tv_sec
;
136 received
= xs
->rcvd
- xs
->offset
;
137 expected
= xs
->size
- xs
->rcvd
;
138 eta
= (long)((double)elapsed
* expected
/ received
);
140 snprintf(str
, sizeof str
, "%02ldh%02ldm",
141 eta
/ 3600, (eta
% 3600) / 60);
143 snprintf(str
, sizeof str
, "%02ldm%02lds",
149 * Format a number as "xxxx YB" where Y is ' ', 'k', 'M'...
151 static const char *prefixes
= " kMGTP";
153 stat_bytes(off_t bytes
)
156 const char *prefix
= prefixes
;
158 while (bytes
> 9999 && prefix
[1] != '\0') {
162 snprintf(str
, sizeof str
, "%4jd %cB", (intmax_t)bytes
, *prefix
);
167 * Compute and display transfer rate
170 stat_bps(struct xferstat
*xs
)
175 delta
= (xs
->last
.tv_sec
+ (xs
->last
.tv_usec
/ 1.e6
))
176 - (xs
->start
.tv_sec
+ (xs
->start
.tv_usec
/ 1.e6
));
178 snprintf(str
, sizeof str
, "?? Bps");
180 bps
= (xs
->rcvd
- xs
->offset
) / delta
;
181 snprintf(str
, sizeof str
, "%sps", stat_bytes((off_t
)bps
));
187 * Update the stats display
190 stat_display(struct xferstat
*xs
, int force
)
195 /* check if we're the foreground process */
196 if (ioctl(STDERR_FILENO
, TIOCGPGRP
, &ctty_pgrp
) == -1 ||
197 (pid_t
)ctty_pgrp
!= pgrp
)
200 gettimeofday(&now
, NULL
);
201 if (!force
&& now
.tv_sec
<= xs
->last
.tv_sec
)
205 fprintf(stderr
, "\r%-46.46s", xs
->name
);
207 setproctitle("%s [%s]", xs
->name
, stat_bytes(xs
->rcvd
));
208 fprintf(stderr
, " %s", stat_bytes(xs
->rcvd
));
210 setproctitle("%s [%d%% of %s]", xs
->name
,
211 (int)((100.0 * xs
->rcvd
) / xs
->size
),
212 stat_bytes(xs
->size
));
213 fprintf(stderr
, "%3d%% of %s",
214 (int)((100.0 * xs
->rcvd
) / xs
->size
),
215 stat_bytes(xs
->size
));
217 fprintf(stderr
, " %s", stat_bps(xs
));
218 if (xs
->size
> 0 && xs
->rcvd
> 0 &&
219 xs
->last
.tv_sec
>= xs
->start
.tv_sec
+ 10)
220 fprintf(stderr
, " %s", stat_eta(xs
));
224 * Initialize the transfer statistics
227 stat_start(struct xferstat
*xs
, const char *name
, off_t size
, off_t offset
)
229 snprintf(xs
->name
, sizeof xs
->name
, "%s", name
);
230 gettimeofday(&xs
->start
, NULL
);
231 xs
->last
.tv_sec
= xs
->last
.tv_usec
= 0;
235 if (v_tty
&& v_level
> 0)
237 else if (v_level
> 0)
238 fprintf(stderr
, "%-46s", xs
->name
);
242 * Update the transfer statistics
245 stat_update(struct xferstat
*xs
, off_t rcvd
)
248 if (v_tty
&& v_level
> 0)
253 * Finalize the transfer statistics
256 stat_end(struct xferstat
*xs
)
258 gettimeofday(&xs
->last
, NULL
);
259 if (v_tty
&& v_level
> 0) {
262 } else if (v_level
> 0) {
263 fprintf(stderr
, " %s %s\n",
264 stat_bytes(xs
->size
), stat_bps(xs
));
269 * Ask the user for authentication details
272 query_auth(struct url
*URL
)
275 tcflag_t saved_flags
;
278 fprintf(stderr
, "Authentication required for <%s://%s:%d/>!\n",
279 URL
->scheme
, URL
->host
, URL
->port
);
281 fprintf(stderr
, "Login: ");
282 if (fgets(URL
->user
, sizeof URL
->user
, stdin
) == NULL
)
284 for (i
= strlen(URL
->user
); i
>= 0; --i
)
285 if (URL
->user
[i
] == '\r' || URL
->user
[i
] == '\n')
288 fprintf(stderr
, "Password: ");
289 if (tcgetattr(STDIN_FILENO
, &tios
) == 0) {
290 saved_flags
= tios
.c_lflag
;
291 tios
.c_lflag
&= ~ECHO
;
292 tios
.c_lflag
|= ECHONL
|ICANON
;
293 tcsetattr(STDIN_FILENO
, TCSAFLUSH
|TCSASOFT
, &tios
);
294 nopwd
= (fgets(URL
->pwd
, sizeof URL
->pwd
, stdin
) == NULL
);
295 tios
.c_lflag
= saved_flags
;
296 tcsetattr(STDIN_FILENO
, TCSANOW
|TCSASOFT
, &tios
);
298 nopwd
= (fgets(URL
->pwd
, sizeof URL
->pwd
, stdin
) == NULL
);
302 for (i
= strlen(URL
->pwd
); i
>= 0; --i
)
303 if (URL
->pwd
[i
] == '\r' || URL
->pwd
[i
] == '\n')
313 fetch(char *URL
, const char *path
)
336 /* set verbosity level */
343 if ((url
= fetchParseURL(URL
)) == NULL
) {
344 warnx("%s: parse error", URL
);
348 /* if no scheme was specified, take a guess */
349 if (*url
->scheme
== 0) {
351 strcpy(url
->scheme
, SCHEME_FILE
);
352 else if (strncasecmp(url
->host
, "ftp.", 4) == 0)
353 strcpy(url
->scheme
, SCHEME_FTP
);
354 else if (strncasecmp(url
->host
, "www.", 4) == 0)
355 strcpy(url
->scheme
, SCHEME_HTTP
);
368 /* FTP specific flags */
369 if (strcmp(url
->scheme
, SCHEME_FTP
) == 0) {
376 timeout
= T_secs
? T_secs
: ftp_timeout
;
379 /* HTTP specific flags */
380 if (strcmp(url
->scheme
, SCHEME_HTTP
) == 0 ||
381 strcmp(url
->scheme
, SCHEME_HTTPS
) == 0) {
386 timeout
= T_secs
? T_secs
: http_timeout
;
388 if (stat(i_filename
, &sb
)) {
389 warn("%s: stat()", i_filename
);
392 url
->ims_time
= sb
.st_mtime
;
397 /* set the protocol timeout. */
398 fetchTimeout
= timeout
;
400 /* just print size */
404 r
= fetchStat(url
, &us
, flags
);
407 if (sigalrm
|| sigint
)
410 warnx("%s", fetchLastErrString
);
416 printf("%jd\n", (intmax_t)us
.size
);
421 * If the -r flag was specified, we have to compare the local
422 * and remote files, so we should really do a fetchStat()
423 * first, but I know of at least one HTTP server that only
424 * sends the content size in response to GET requests, and
425 * leaves it out of replies to HEAD requests. Also, in the
426 * (frequent) case that the local and remote files match but
427 * the local file is truncated, we have sufficient information
428 * before the compare to issue a correct request. Therefore,
429 * we always issue a GET request as if we were sure the local
430 * file was a truncated copy of the remote file; we can drop
431 * the connection later if we change our minds.
436 if (r
== 0 && r_flag
&& S_ISREG(sb
.st_mode
)) {
437 url
->offset
= sb
.st_size
;
438 } else if (r
== -1 || !S_ISREG(sb
.st_mode
)) {
440 * Whatever value sb.st_size has now is either
441 * wrong (if stat(2) failed) or irrelevant (if the
442 * path does not refer to a regular file)
446 if (r
== -1 && errno
!= ENOENT
) {
447 warnx("%s: stat()", path
);
452 /* start the transfer */
455 f
= fetchXGet(url
, &us
, flags
);
458 if (sigalrm
|| sigint
)
461 warnx("%s: %s", URL
, fetchLastErrString
);
462 if (i_flag
&& strcmp(url
->scheme
, SCHEME_HTTP
) == 0
463 && fetchLastErrCode
== FETCH_OK
464 && strcmp(fetchLastErrString
, "Not Modified") == 0) {
465 /* HTTP Not Modified Response, return OK. */
474 /* check that size is as expected */
477 warnx("%s: size unknown", URL
);
478 } else if (us
.size
!= S_size
) {
479 warnx("%s: size mismatch: expected %jd, actual %jd",
480 URL
, (intmax_t)S_size
, (intmax_t)us
.size
);
485 /* symlink instead of copy */
486 if (l_flag
&& strcmp(url
->scheme
, "file") == 0 && !o_stdout
) {
487 if (symlink(url
->doc
, path
) == -1) {
488 warn("%s: symlink()", path
);
494 if (us
.size
== -1 && !o_stdout
&& v_level
> 0)
495 warnx("%s: size of remote file is not known", URL
);
497 if (sb
.st_size
!= -1)
498 fprintf(stderr
, "local size / mtime: %jd / %ld\n",
499 (intmax_t)sb
.st_size
, (long)sb
.st_mtime
);
501 fprintf(stderr
, "remote size / mtime: %jd / %ld\n",
502 (intmax_t)us
.size
, (long)us
.mtime
);
505 /* open output file */
507 /* output to stdout */
509 } else if (r_flag
&& sb
.st_size
!= -1) {
510 /* resume mode, local file exists */
511 if (!F_flag
&& us
.mtime
&& sb
.st_mtime
!= us
.mtime
) {
512 /* no match! have to refetch */
514 /* if precious, warn the user and give up */
516 warnx("%s: local modification time "
517 "does not match remote", path
);
520 } else if (us
.size
!= -1) {
521 if (us
.size
== sb
.st_size
)
524 if (sb
.st_size
> us
.size
) {
525 /* local file too long! */
526 warnx("%s: local file (%jd bytes) is longer "
527 "than remote file (%jd bytes)", path
,
528 (intmax_t)sb
.st_size
, (intmax_t)us
.size
);
531 /* we got it, open local file */
532 if ((of
= fopen(path
, "a")) == NULL
) {
533 warn("%s: fopen()", path
);
536 /* check that it didn't move under our feet */
537 if (fstat(fileno(of
), &nsb
) == -1) {
539 warn("%s: fstat()", path
);
542 if (nsb
.st_dev
!= sb
.st_dev
||
543 nsb
.st_ino
!= nsb
.st_ino
||
544 nsb
.st_size
!= sb
.st_size
) {
545 warnx("%s: file has changed", URL
);
551 } else if (m_flag
&& sb
.st_size
!= -1) {
552 /* mirror mode, local file exists */
553 if (sb
.st_size
== us
.size
&& sb
.st_mtime
== us
.mtime
)
559 * We don't yet have an output file; either this is a
560 * vanilla run with no special flags, or the local and
561 * remote files didn't match.
564 if (url
->offset
> 0) {
566 * We tried to restart a transfer, but for
567 * some reason gave up - so we have to restart
568 * from scratch if we want the whole file
571 if ((f
= fetchXGet(url
, &us
, flags
)) == NULL
) {
572 warnx("%s: %s", URL
, fetchLastErrString
);
579 /* construct a temporary file name */
580 if (sb
.st_size
!= -1 && S_ISREG(sb
.st_mode
)) {
581 if ((slash
= strrchr(path
, '/')) == NULL
)
585 asprintf(&tmppath
, "%.*s.fetch.XXXXXX.%s",
586 (int)(slash
- path
), path
, slash
);
587 if (tmppath
!= NULL
) {
588 if (mkstemps(tmppath
, strlen(slash
)+1) == -1) {
589 warn("%s: mkstemps()", path
);
593 of
= fopen(tmppath
, "w");
594 chown(tmppath
, sb
.st_uid
, sb
.st_gid
);
595 chmod(tmppath
, sb
.st_mode
& ALLPERMS
);
600 if ((of
= fopen(path
, "w")) == NULL
) {
601 warn("%s: fopen()", path
);
607 /* start the counter */
608 stat_start(&xs
, path
, us
.size
, count
);
610 sigalrm
= siginfo
= sigint
= 0;
612 /* suck in the data */
613 signal(SIGINFO
, sig_handler
);
615 if (us
.size
!= -1 && us
.size
- count
< B_size
&&
616 us
.size
- count
>= 0)
617 size
= us
.size
- count
;
624 if ((size
= fread(buf
, 1, size
, f
)) == 0) {
625 if (ferror(f
) && errno
== EINTR
&& !sigint
)
630 stat_update(&xs
, count
+= size
);
631 for (ptr
= buf
; size
> 0; ptr
+= wr
, size
-= wr
)
632 if ((wr
= fwrite(ptr
, 1, size
, of
)) < size
) {
633 if (ferror(of
) && errno
== EINTR
&& !sigint
)
642 sigalrm
= ferror(f
) && errno
== ETIMEDOUT
;
643 signal(SIGINFO
, SIG_DFL
);
648 * If the transfer timed out or was interrupted, we still want to
649 * set the mtime in case the file is not removed (-r or -R) and
650 * the user later restarts the transfer.
653 /* set mtime of local file */
654 if (!n_flag
&& us
.mtime
&& !o_stdout
&& of
!= NULL
&&
655 (stat(path
, &sb
) != -1) && sb
.st_mode
& S_IFREG
) {
656 struct timeval tv
[2];
659 tv
[0].tv_sec
= (long)(us
.atime
? us
.atime
: us
.mtime
);
660 tv
[1].tv_sec
= (long)us
.mtime
;
661 tv
[0].tv_usec
= tv
[1].tv_usec
= 0;
662 if (utimes(tmppath
? tmppath
: path
, tv
))
663 warn("%s: utimes()", tmppath
? tmppath
: path
);
666 /* timed out or interrupted? */
668 warnx("transfer timed out");
670 warnx("transfer interrupted");
674 /* timeout / interrupt before connection completley established? */
679 /* check the status of our files */
684 if (ferror(f
) || ferror(of
))
688 /* did the transfer complete normally? */
689 if (us
.size
!= -1 && count
< us
.size
) {
690 warnx("%s appears to be truncated: %jd/%jd bytes",
691 path
, (intmax_t)count
, (intmax_t)us
.size
);
696 * If the transfer timed out and we didn't know how much to
697 * expect, assume the worst (i.e. we didn't get all of it)
699 if (sigalrm
&& us
.size
== -1) {
700 warnx("%s may be truncated", path
);
706 if (tmppath
!= NULL
&& rename(tmppath
, path
) == -1) {
707 warn("%s: rename()", path
);
712 if (of
&& of
!= stdout
&& !R_flag
&& !r_flag
)
713 if (stat(path
, &sb
) != -1 && (sb
.st_mode
& S_IFREG
))
714 unlink(tmppath
? tmppath
: path
);
715 if (R_flag
&& tmppath
!= NULL
&& sb
.st_size
== -1)
716 rename(tmppath
, path
); /* ignore errors here */
723 if (of
&& of
!= stdout
)
735 fprintf(stderr
, "%s\n%s\n%s\n%s\n",
736 "usage: fetch [-146AadFlMmnPpqRrsUv] [-B bytes] [-N file] [-o file] [-S bytes]",
737 " [-T seconds] [-w seconds] [-i file] URL ...",
738 " fetch [-146AadFlMmnPpqRrsUv] [-B bytes] [-N file] [-o file] [-S bytes]",
739 " [-T seconds] [-w seconds] [-i file] -h host -f file [-c dir]");
747 main(int argc
, char *argv
[])
755 while ((c
= getopt(argc
, argv
,
756 "146AaB:bc:dFf:Hh:i:lMmN:nPpo:qRrS:sT:tUvw:")) != -1)
774 B_size
= (off_t
)strtol(optarg
, &end
, 10);
775 if (*optarg
== '\0' || *end
!= '\0')
776 errx(1, "invalid buffer size (%s)", optarg
);
779 warnx("warning: the -b option is deprecated");
795 warnx("the -H option is now implicit, "
796 "use -U to disable");
815 errx(1, "the -m and -r flags "
816 "are mutually exclusive");
837 errx(1, "the -m and -r flags "
838 "are mutually exclusive");
842 S_size
= (off_t
)strtol(optarg
, &end
, 10);
843 if (*optarg
== '\0' || *end
!= '\0')
844 errx(1, "invalid size (%s)", optarg
);
850 T_secs
= strtol(optarg
, &end
, 10);
851 if (*optarg
== '\0' || *end
!= '\0')
852 errx(1, "invalid timeout (%s)", optarg
);
856 warnx("warning: the -t option is deprecated");
866 w_secs
= strtol(optarg
, &end
, 10);
867 if (*optarg
== '\0' || *end
!= '\0')
868 errx(1, "invalid delay (%s)", optarg
);
878 if (h_hostname
|| f_filename
|| c_dirname
) {
879 if (!h_hostname
|| !f_filename
|| argc
) {
883 /* XXX this is a hack. */
884 if (strcspn(h_hostname
, "@:/") != strlen(h_hostname
))
885 errx(1, "invalid hostname");
886 if (asprintf(argv
, "ftp://%s/%s/%s", h_hostname
,
887 c_dirname
? c_dirname
: "", f_filename
) == -1)
888 errx(1, "%s", strerror(ENOMEM
));
897 /* allocate buffer */
898 if (B_size
< MINBUFSIZE
)
900 if ((buf
= malloc(B_size
)) == NULL
)
901 errx(1, "%s", strerror(ENOMEM
));
904 if ((s
= getenv("FTP_TIMEOUT")) != NULL
) {
905 ftp_timeout
= strtol(s
, &end
, 10);
906 if (*s
== '\0' || *end
!= '\0' || ftp_timeout
< 0) {
907 warnx("FTP_TIMEOUT (%s) is not a positive integer", s
);
911 if ((s
= getenv("HTTP_TIMEOUT")) != NULL
) {
912 http_timeout
= strtol(s
, &end
, 10);
913 if (*s
== '\0' || *end
!= '\0' || http_timeout
< 0) {
914 warnx("HTTP_TIMEOUT (%s) is not a positive integer", s
);
919 /* signal handling */
921 sa
.sa_handler
= sig_handler
;
922 sigemptyset(&sa
.sa_mask
);
923 sigaction(SIGALRM
, &sa
, NULL
);
924 sa
.sa_flags
= SA_RESETHAND
;
925 sigaction(SIGINT
, &sa
, NULL
);
926 fetchRestartCalls
= 0;
930 if (strcmp(o_filename
, "-") == 0) {
932 } else if (stat(o_filename
, &sb
) == -1) {
933 if (errno
== ENOENT
) {
935 errx(1, "%s is not a directory",
938 err(1, "%s", o_filename
);
941 if (sb
.st_mode
& S_IFDIR
)
946 /* check if output is to a tty (for progress report) */
947 v_tty
= isatty(STDERR_FILENO
);
955 fetchAuthMethod
= query_auth
;
956 if (N_filename
!= NULL
) {
957 if (setenv("NETRC", N_filename
, 1) == -1)
958 err(1, "setenv: cannot set NETRC=%s", N_filename
);
962 if ((p
= strrchr(*argv
, '/')) == NULL
)
970 fetchLastErrCode
= 0;
974 e
= fetch(*argv
, "-");
975 } else if (o_directory
) {
976 asprintf(&q
, "%s/%s", o_filename
, p
);
980 e
= fetch(*argv
, o_filename
);
987 kill(getpid(), SIGINT
);
989 if (e
== 0 && once_flag
)
994 if ((fetchLastErrCode
995 && fetchLastErrCode
!= FETCH_UNAVAIL
996 && fetchLastErrCode
!= FETCH_MOVED
997 && fetchLastErrCode
!= FETCH_URL
998 && fetchLastErrCode
!= FETCH_RESOLV
999 && fetchLastErrCode
!= FETCH_UNKNOWN
)) {
1000 if (w_secs
&& v_level
)
1001 fprintf(stderr
, "Waiting %ld seconds "
1002 "before retrying\n", w_secs
);