hammer util: avoid running concurrent cleanups
[dragonfly.git] / lib / libfetch / fetch.3
blob6d412b590574b2e1a438005ca4068ca26b8bde06
1 .\"-
2 .\" Copyright (c) 1998-2004 Dag-Erling Coïdan Smørgrav
3 .\" All rights reserved.
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\"    notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\"    notice, this list of conditions and the following disclaimer in the
12 .\"    documentation and/or other materials provided with the distribution.
13 .\"
14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 .\" SUCH DAMAGE.
25 .\"
26 .\" $FreeBSD: src/lib/libfetch/fetch.3,v 1.66 2008/12/15 08:27:44 murray Exp $
27 .\" $DragonFly: src/lib/libfetch/fetch.3,v 1.5 2007/11/23 23:16:36 swildner Exp $
28 .\"
29 .Dd May 10, 2009
30 .Dt FETCH 3
31 .Os
32 .Sh NAME
33 .Nm fetchMakeURL ,
34 .Nm fetchParseURL ,
35 .Nm fetchFreeURL ,
36 .Nm fetchXGetURL ,
37 .Nm fetchGetURL ,
38 .Nm fetchPutURL ,
39 .Nm fetchStatURL ,
40 .Nm fetchListURL ,
41 .Nm fetchXGet ,
42 .Nm fetchGet ,
43 .Nm fetchPut ,
44 .Nm fetchStat ,
45 .Nm fetchList ,
46 .Nm fetchXGetFile ,
47 .Nm fetchGetFile ,
48 .Nm fetchPutFile ,
49 .Nm fetchStatFile ,
50 .Nm fetchListFile ,
51 .Nm fetchXGetHTTP ,
52 .Nm fetchGetHTTP ,
53 .Nm fetchPutHTTP ,
54 .Nm fetchStatHTTP ,
55 .Nm fetchListHTTP ,
56 .Nm fetchXGetFTP ,
57 .Nm fetchGetFTP ,
58 .Nm fetchPutFTP ,
59 .Nm fetchStatFTP ,
60 .Nm fetchListFTP
61 .Nd file transfer functions
62 .Sh LIBRARY
63 .Lb libfetch
64 .Sh SYNOPSIS
65 .In sys/param.h
66 .In stdio.h
67 .In fetch.h
68 .Ft struct url *
69 .Fn fetchMakeURL "const char *scheme" "const char *host" "int port" "const char *doc" "const char *user" "const char *pwd"
70 .Ft struct url *
71 .Fn fetchParseURL "const char *URL"
72 .Ft void
73 .Fn fetchFreeURL "struct url *u"
74 .Ft FILE *
75 .Fn fetchXGetURL "const char *URL" "struct url_stat *us" "const char *flags"
76 .Ft FILE *
77 .Fn fetchGetURL "const char *URL" "const char *flags"
78 .Ft FILE *
79 .Fn fetchPutURL "const char *URL" "const char *flags"
80 .Ft int
81 .Fn fetchStatURL "const char *URL" "struct url_stat *us" "const char *flags"
82 .Ft struct url_ent *
83 .Fn fetchListURL "const char *URL" "const char *flags"
84 .Ft FILE *
85 .Fn fetchXGet "struct url *u" "struct url_stat *us" "const char *flags"
86 .Ft FILE *
87 .Fn fetchGet "struct url *u" "const char *flags"
88 .Ft FILE *
89 .Fn fetchPut "struct url *u" "const char *flags"
90 .Ft int
91 .Fn fetchStat "struct url *u" "struct url_stat *us" "const char *flags"
92 .Ft struct url_ent *
93 .Fn fetchList "struct url *u" "const char *flags"
94 .Ft FILE *
95 .Fn fetchXGetFile "struct url *u" "struct url_stat *us" "const char *flags"
96 .Ft FILE *
97 .Fn fetchGetFile "struct url *u" "const char *flags"
98 .Ft FILE *
99 .Fn fetchPutFile "struct url *u" "const char *flags"
100 .Ft int
101 .Fn fetchStatFile "struct url *u" "struct url_stat *us" "const char *flags"
102 .Ft struct url_ent *
103 .Fn fetchListFile "struct url *u" "const char *flags"
104 .Ft FILE *
105 .Fn fetchXGetHTTP "struct url *u" "struct url_stat *us" "const char *flags"
106 .Ft FILE *
107 .Fn fetchGetHTTP "struct url *u" "const char *flags"
108 .Ft FILE *
109 .Fn fetchPutHTTP "struct url *u" "const char *flags"
110 .Ft int
111 .Fn fetchStatHTTP "struct url *u" "struct url_stat *us" "const char *flags"
112 .Ft struct url_ent *
113 .Fn fetchListHTTP "struct url *u" "const char *flags"
114 .Ft FILE *
115 .Fn fetchXGetFTP "struct url *u" "struct url_stat *us" "const char *flags"
116 .Ft FILE *
117 .Fn fetchGetFTP "struct url *u" "const char *flags"
118 .Ft FILE *
119 .Fn fetchPutFTP "struct url *u" "const char *flags"
120 .Ft int
121 .Fn fetchStatFTP "struct url *u" "struct url_stat *us" "const char *flags"
122 .Ft struct url_ent *
123 .Fn fetchListFTP "struct url *u" "const char *flags"
124 .Sh DESCRIPTION
125 These functions implement a high-level library for retrieving and
126 uploading files using Uniform Resource Locators (URLs).
128 .Fn fetchParseURL
129 takes a URL in the form of a null-terminated string and splits it into
130 its components function according to the Common Internet Scheme Syntax
131 detailed in RFC 1738.
132 A regular expression which produces this syntax is:
133 .Bd -literal
134     <scheme>:(//(<user>(:<pwd>)?@)?<host>(:<port>)?)?/(<document>)?
137 If the URL does not seem to begin with a scheme name, the following
138 syntax is assumed:
139 .Bd -literal
140     ((<user>(:<pwd>)?@)?<host>(:<port>)?)?/(<document>)?
143 Note that some components of the URL are not necessarily relevant to
144 all URL schemes.
145 For instance, the file scheme only needs the <scheme> and <document>
146 components.
148 .Fn fetchMakeURL
150 .Fn fetchParseURL
151 return a pointer to a
152 .Vt url
153 structure, which is defined as follows in
154 .In fetch.h :
155 .Bd -literal
156 #define URL_SCHEMELEN 16
157 #define URL_USERLEN 256
158 #define URL_PWDLEN 256
160 struct url {
161     char         scheme[URL_SCHEMELEN+1];
162     char         user[URL_USERLEN+1];
163     char         pwd[URL_PWDLEN+1];
164     char         host[MAXHOSTNAMELEN+1];
165     int          port;
166     char        *doc;
167     off_t        offset;
168     size_t       length;
169     time_t       ims_time;
174 .Va ims_time
175 field stores the time value for
176 .Li If-Modified-Since
177 HTTP requests.
179 The pointer returned by
180 .Fn fetchMakeURL
182 .Fn fetchParseURL
183 should be freed using
184 .Fn fetchFreeURL .
186 .Fn fetchXGetURL ,
187 .Fn fetchGetURL ,
189 .Fn fetchPutURL
190 constitute the recommended interface to the
191 .Nm fetch
192 library.
193 They examine the URL passed to them to determine the transfer
194 method, and call the appropriate lower-level functions to perform the
195 actual transfer.
196 .Fn fetchXGetURL
197 also returns the remote document's metadata in the
198 .Vt url_stat
199 structure pointed to by the
200 .Fa us
201 argument.
204 .Fa flags
205 argument is a string of characters which specify transfer options.
207 meaning of the individual flags is scheme-dependent, and is detailed
208 in the appropriate section below.
210 .Fn fetchStatURL
211 attempts to obtain the requested document's metadata and fill in the
212 structure pointed to by its second argument.
214 .Vt url_stat
215 structure is defined as follows in
216 .In fetch.h :
217 .Bd -literal
218 struct url_stat {
219     off_t        size;
220     time_t       atime;
221     time_t       mtime;
225 If the size could not be obtained from the server, the
226 .Fa size
227 field is set to -1.
228 If the modification time could not be obtained from the server, the
229 .Fa mtime
230 field is set to the epoch.
231 If the access time could not be obtained from the server, the
232 .Fa atime
233 field is set to the modification time.
235 .Fn fetchListURL
236 attempts to list the contents of the directory pointed to by the URL
237 provided.
238 If successful, it returns a malloced array of
239 .Vt url_ent
240 structures.
242 .Vt url_ent
243 structure is defined as follows in
244 .In fetch.h :
245 .Bd -literal
246 struct url_ent {
247     char         name[PATH_MAX];
248     struct url_stat stat;
252 The list is terminated by an entry with an empty name.
254 The pointer returned by
255 .Fn fetchListURL
256 should be freed using
257 .Fn free .
259 .Fn fetchXGet ,
260 .Fn fetchGet ,
261 .Fn fetchPut
263 .Fn fetchStat
264 are similar to
265 .Fn fetchXGetURL ,
266 .Fn fetchGetURL ,
267 .Fn fetchPutURL
269 .Fn fetchStatURL ,
270 except that they expect a pre-parsed URL in the form of a pointer to
272 .Vt struct url
273 rather than a string.
275 All of the
276 .Fn fetchXGetXXX ,
277 .Fn fetchGetXXX
279 .Fn fetchPutXXX
280 functions return a pointer to a stream which can be used to read or
281 write data from or to the requested document, respectively.
282 Note that
283 although the implementation details of the individual access methods
284 vary, it can generally be assumed that a stream returned by one of the
285 .Fn fetchXGetXXX
287 .Fn fetchGetXXX
288 functions is read-only, and that a stream returned by one of the
289 .Fn fetchPutXXX
290 functions is write-only.
291 .Sh FILE SCHEME
292 .Fn fetchXGetFile ,
293 .Fn fetchGetFile
295 .Fn fetchPutFile
296 provide access to documents which are files in a locally mounted file
297 system.
298 Only the <document> component of the URL is used.
300 .Fn fetchXGetFile
302 .Fn fetchGetFile
303 do not accept any flags.
305 .Fn fetchPutFile
306 accepts the
307 .Ql a
308 (append to file) flag.
309 If that flag is specified, the data written to
310 the stream returned by
311 .Fn fetchPutFile
312 will be appended to the previous contents of the file, instead of
313 replacing them.
314 .Sh FTP SCHEME
315 .Fn fetchXGetFTP ,
316 .Fn fetchGetFTP
318 .Fn fetchPutFTP
319 implement the FTP protocol as described in RFC 959.
321 If the
322 .Ql p
323 (passive) flag is specified, a passive (rather than active) connection
324 will be attempted.
326 If the
327 .Ql l
328 (low) flag is specified, data sockets will be allocated in the low (or
329 default) port range instead of the high port range (see
330 .Xr ip 4 ) .
332 If the
333 .Ql d
334 (direct) flag is specified,
335 .Fn fetchXGetFTP ,
336 .Fn fetchGetFTP
338 .Fn fetchPutFTP
339 will use a direct connection even if a proxy server is defined.
341 If no user name or password is given, the
342 .Nm fetch
343 library will attempt an anonymous login, with user name "anonymous"
344 and password "anonymous@<hostname>".
345 .Sh HTTP SCHEME
347 .Fn fetchXGetHTTP ,
348 .Fn fetchGetHTTP
350 .Fn fetchPutHTTP
351 functions implement the HTTP/1.1 protocol.
352 With a little luck, there is
353 even a chance that they comply with RFC 2616 and RFC 2617.
355 If the
356 .Ql d
357 (direct) flag is specified,
358 .Fn fetchXGetHTTP ,
359 .Fn fetchGetHTTP
361 .Fn fetchPutHTTP
362 will use a direct connection even if a proxy server is defined.
364 If the
365 .Ql i
366 (if-modified-since) flag is specified, and
368 .Va ims_time
369 field is set in
370 .Vt "struct url" ,
371 then
372 .Fn fetchXGetHTTP
374 .Fn fetchGetHTTP
375 will send a conditional
376 .Li If-Modified-Since
377 HTTP header to only fetch the content if it is newer than
378 .Va ims_time .
380 Since there seems to be no good way of implementing the HTTP PUT
381 method in a manner consistent with the rest of the
382 .Nm fetch
383 library,
384 .Fn fetchPutHTTP
385 is currently unimplemented.
386 .Sh AUTHENTICATION
387 Apart from setting the appropriate environment variables and
388 specifying the user name and password in the URL or the
389 .Vt struct url ,
390 the calling program has the option of defining an authentication
391 function with the following prototype:
393 .Ft int
394 .Fn myAuthMethod "struct url *u"
396 The callback function should fill in the
397 .Fa user
399 .Fa pwd
400 fields in the provided
401 .Vt struct url
402 and return 0 on success, or any other value to indicate failure.
404 To register the authentication callback, simply set
405 .Va fetchAuthMethod
406 to point at it.
407 The callback will be used whenever a site requires authentication and
408 the appropriate environment variables are not set.
410 This interface is experimental and may be subject to change.
411 .Sh RETURN VALUES
412 .Fn fetchParseURL
413 returns a pointer to a
414 .Vt struct url
415 containing the individual components of the URL.
416 If it is
417 unable to allocate memory, or the URL is syntactically incorrect,
418 .Fn fetchParseURL
419 returns a NULL pointer.
422 .Fn fetchStat
423 functions return 0 on success and -1 on failure.
425 All other functions return a stream pointer which may be used to
426 access the requested document, or NULL if an error occurred.
428 The following error codes are defined in
429 .In fetch.h :
430 .Bl -tag -width 18n
431 .It Bq Er FETCH_ABORT
432 Operation aborted
433 .It Bq Er FETCH_AUTH
434 Authentication failed
435 .It Bq Er FETCH_DOWN
436 Service unavailable
437 .It Bq Er FETCH_EXISTS
438 File exists
439 .It Bq Er FETCH_FULL
440 File system full
441 .It Bq Er FETCH_INFO
442 Informational response
443 .It Bq Er FETCH_MEMORY
444 Insufficient memory
445 .It Bq Er FETCH_MOVED
446 File has moved
447 .It Bq Er FETCH_NETWORK
448 Network error
449 .It Bq Er FETCH_OK
450 No error
451 .It Bq Er FETCH_PROTO
452 Protocol error
453 .It Bq Er FETCH_RESOLV
454 Resolver error
455 .It Bq Er FETCH_SERVER
456 Server error
457 .It Bq Er FETCH_TEMP
458 Temporary error
459 .It Bq Er FETCH_TIMEOUT
460 Operation timed out
461 .It Bq Er FETCH_UNAVAIL
462 File is not available
463 .It Bq Er FETCH_UNKNOWN
464 Unknown error
465 .It Bq Er FETCH_URL
466 Invalid URL
469 The accompanying error message includes a protocol-specific error code
470 and message, e.g.\& "File is not available (404 Not Found)"
471 .Sh ENVIRONMENT
472 .Bl -tag -width ".Ev FETCH_BIND_ADDRESS"
473 .It Ev FETCH_BIND_ADDRESS
474 Specifies a hostname or IP address to which sockets used for outgoing
475 connections will be bound.
476 .It Ev FTP_LOGIN
477 Default FTP login if none was provided in the URL.
478 .It Ev FTP_PASSIVE_MODE
479 If set to anything but
480 .Ql no ,
481 forces the FTP code to use passive mode.
482 .It Ev FTP_PASSWORD
483 Default FTP password if the remote server requests one and none was
484 provided in the URL.
485 .It Ev FTP_PROXY
486 URL of the proxy to use for FTP requests.
487 The document part is ignored.
488 FTP and HTTP proxies are supported; if no scheme is specified, FTP is
489 assumed.
490 If the proxy is an FTP proxy,
491 .Nm libfetch
492 will send
493 .Ql user@host
494 as user name to the proxy, where
495 .Ql user
496 is the real user name, and
497 .Ql host
498 is the name of the FTP server.
500 If this variable is set to an empty string, no proxy will be used for
501 FTP requests, even if the
502 .Ev HTTP_PROXY
503 variable is set.
504 .It Ev ftp_proxy
505 Same as
506 .Ev FTP_PROXY ,
507 for compatibility.
508 .It Ev HTTP_AUTH
509 Specifies HTTP authorization parameters as a colon-separated list of
510 items.
511 The first and second item are the authorization scheme and realm
512 respectively; further items are scheme-dependent.
513 Currently, only basic authorization is supported.
515 Basic authorization requires two parameters: the user name and
516 password, in that order.
518 This variable is only used if the server requires authorization and
519 no user name or password was specified in the URL.
520 .It Ev HTTP_PROXY
521 URL of the proxy to use for HTTP requests.
522 The document part is ignored.
523 Only HTTP proxies are supported for HTTP requests.
524 If no port number is specified, the default is 3128.
526 Note that this proxy will also be used for FTP documents, unless the
527 .Ev FTP_PROXY
528 variable is set.
529 .It Ev http_proxy
530 Same as
531 .Ev HTTP_PROXY ,
532 for compatibility.
533 .It Ev HTTP_PROXY_AUTH
534 Specifies authorization parameters for the HTTP proxy in the same
535 format as the
536 .Ev HTTP_AUTH
537 variable.
539 This variable is used if and only if connected to an HTTP proxy, and
540 is ignored if a user and/or a password were specified in the proxy
541 URL.
542 .It Ev HTTP_REFERER
543 Specifies the referrer URL to use for HTTP requests.
544 If set to
545 .Dq auto ,
546 the document URL will be used as referrer URL.
547 .It Ev HTTP_USER_AGENT
548 Specifies the User-Agent string to use for HTTP requests.
549 This can be useful when working with HTTP origin or proxy servers that
550 differentiate between user agents.
551 .It Ev NETRC
552 Specifies a file to use instead of
553 .Pa ~/.netrc
554 to look up login names and passwords for FTP sites.
556 .Xr ftp 1
557 for a description of the file format.
558 This feature is experimental.
559 .It Ev NO_PROXY
560 Either a single asterisk, which disables the use of proxies
561 altogether, or a comma- or whitespace-separated list of hosts for
562 which proxies should not be used.
563 .It Ev no_proxy
564 Same as
565 .Ev NO_PROXY ,
566 for compatibility.
568 .Sh EXAMPLES
569 To access a proxy server on
570 .Pa proxy.example.com
571 port 8080, set the
572 .Ev HTTP_PROXY
573 environment variable in a manner similar to this:
575 .Dl HTTP_PROXY=http://proxy.example.com:8080
577 If the proxy server requires authentication, there are
578 two options available for passing the authentication data.
579 The first method is by using the proxy URL:
581 .Dl HTTP_PROXY=http://<user>:<pwd>@proxy.example.com:8080
583 The second method is by using the
584 .Ev HTTP_PROXY_AUTH
585 environment variable:
586 .Bd -literal -offset indent
587 HTTP_PROXY=http://proxy.example.com:8080
588 HTTP_PROXY_AUTH=basic:*:<user>:<pwd>
591 To disable the use of a proxy for an HTTP server running on the local
592 host, define
593 .Ev NO_PROXY
594 as follows:
595 .Bd -literal -offset indent
596 NO_PROXY=localhost,127.0.0.1
598 .Sh SEE ALSO
599 .Xr fetch 1 ,
600 .Xr ftpio 3 ,
601 .Xr ip 4
603 .%A J. Postel
604 .%A J. K. Reynolds
605 .%D October 1985
606 .%B File Transfer Protocol
607 .%O RFC 959
610 .%A P. Deutsch
611 .%A A. Emtage
612 .%A A. Marine.
613 .%D May 1994
614 .%T How to Use Anonymous FTP
615 .%O RFC 1635
618 .%A T. Berners-Lee
619 .%A L. Masinter
620 .%A M. McCahill
621 .%D December 1994
622 .%T Uniform Resource Locators (URL)
623 .%O RFC 1738
626 .%A R. Fielding
627 .%A J. Gettys
628 .%A J. Mogul
629 .%A H. Frystyk
630 .%A L. Masinter
631 .%A P. Leach
632 .%A T. Berners-Lee
633 .%D January 1999
634 .%B Hypertext Transfer Protocol -- HTTP/1.1
635 .%O RFC 2616
638 .%A J. Franks
639 .%A P. Hallam-Baker
640 .%A J. Hostetler
641 .%A S. Lawrence
642 .%A P. Leach
643 .%A A. Luotonen
644 .%A L. Stewart
645 .%D June 1999
646 .%B HTTP Authentication: Basic and Digest Access Authentication
647 .%O RFC 2617
649 .Sh HISTORY
651 .Nm fetch
652 library first appeared in
653 .Fx 3.0 .
654 .Sh AUTHORS
655 .An -nosplit
657 .Nm fetch
658 library was mostly written by
659 .An Dag-Erling Sm\(/orgrav Aq des@FreeBSD.org
660 with numerous suggestions from
661 .An Jordan K. Hubbard Aq jkh@FreeBSD.org ,
662 .An Eugene Skepner Aq eu@qub.com
663 and other
665 developers.
666 It replaces the older
667 .Nm ftpio
668 library written by
669 .An Poul-Henning Kamp Aq phk@FreeBSD.org
671 .An Jordan K. Hubbard Aq jkh@FreeBSD.org .
673 This manual page was written by
674 .An Dag-Erling Sm\(/orgrav Aq des@FreeBSD.org .
675 .Sh BUGS
676 Some parts of the library are not yet implemented.
677 The most notable
678 examples of this are
679 .Fn fetchPutHTTP ,
680 .Fn fetchListHTTP ,
681 .Fn fetchListFTP
682 and FTP proxy support.
684 There is no way to select a proxy at run-time other than setting the
685 .Ev HTTP_PROXY
687 .Ev FTP_PROXY
688 environment variables as appropriate.
690 .Nm libfetch
691 does not understand or obey 305 (Use Proxy) replies.
693 Error numbers are unique only within a certain context; the error
694 codes used for FTP and HTTP overlap, as do those used for resolver and
695 system errors.
696 For instance, error code 202 means "Command not
697 implemented, superfluous at this site" in an FTP context and
698 "Accepted" in an HTTP context.
700 .Fn fetchStatFTP
701 does not check that the result of an MDTM command is a valid date.
703 The man page is incomplete, poorly written and produces badly
704 formatted text.
706 The error reporting mechanism is unsatisfactory.
708 Some parts of the code are not fully reentrant.