fetch.h revision 315902 
1/*-
2 * Copyright (c) 1998-2004 Dag-Erling 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 *    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
16 *
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.
27 *
28 * $FreeBSD: stable/11/lib/libfetch/fetch.h 315902 2017-03-24 14:19:52Z des $
29 */
30
31#ifndef _FETCH_H_INCLUDED
32#define _FETCH_H_INCLUDED
33
34#define _LIBFETCH_VER "libfetch/2.0"
35
36#define URL_SCHEMELEN 16
37#define URL_USERLEN 256
38#define URL_PWDLEN 256
39
40struct url {
41	char		 scheme[URL_SCHEMELEN+1];
42	char		 user[URL_USERLEN+1];
43	char		 pwd[URL_PWDLEN+1];
44	char		 host[MAXHOSTNAMELEN+1];
45	int		 port;
46	char		*doc;
47	off_t		 offset;
48	size_t		 length;
49	time_t		 ims_time;
50	int		 netrcfd;
51};
52
53struct url_stat {
54	off_t		 size;
55	time_t		 atime;
56	time_t		 mtime;
57};
58
59struct url_ent {
60	char		 name[PATH_MAX];
61	struct url_stat	 stat;
62};
63
64/* Recognized schemes */
65#define SCHEME_FTP	"ftp"
66#define SCHEME_HTTP	"http"
67#define SCHEME_HTTPS	"https"
68#define SCHEME_FILE	"file"
69
70/* Error codes */
71#define	FETCH_ABORT	 1
72#define	FETCH_AUTH	 2
73#define	FETCH_DOWN	 3
74#define	FETCH_EXISTS	 4
75#define	FETCH_FULL	 5
76#define	FETCH_INFO	 6
77#define	FETCH_MEMORY	 7
78#define	FETCH_MOVED	 8
79#define	FETCH_NETWORK	 9
80#define	FETCH_OK	10
81#define	FETCH_PROTO	11
82#define	FETCH_RESOLV	12
83#define	FETCH_SERVER	13
84#define	FETCH_TEMP	14
85#define	FETCH_TIMEOUT	15
86#define	FETCH_UNAVAIL	16
87#define	FETCH_UNKNOWN	17
88#define	FETCH_URL	18
89#define	FETCH_VERBOSE	19
90
91__BEGIN_DECLS
92
93/* FILE-specific functions */
94FILE		*fetchXGetFile(struct url *, struct url_stat *, const char *);
95FILE		*fetchGetFile(struct url *, const char *);
96FILE		*fetchPutFile(struct url *, const char *);
97int		 fetchStatFile(struct url *, struct url_stat *, const char *);
98struct url_ent	*fetchListFile(struct url *, const char *);
99
100/* HTTP-specific functions */
101FILE		*fetchXGetHTTP(struct url *, struct url_stat *, const char *);
102FILE		*fetchGetHTTP(struct url *, const char *);
103FILE		*fetchPutHTTP(struct url *, const char *);
104int		 fetchStatHTTP(struct url *, struct url_stat *, const char *);
105struct url_ent	*fetchListHTTP(struct url *, const char *);
106FILE		*fetchReqHTTP(struct url *, const char *, const char *,
107		    const char *, const char *);
108
109/* FTP-specific functions */
110FILE		*fetchXGetFTP(struct url *, struct url_stat *, const char *);
111FILE		*fetchGetFTP(struct url *, const char *);
112FILE		*fetchPutFTP(struct url *, const char *);
113int		 fetchStatFTP(struct url *, struct url_stat *, const char *);
114struct url_ent	*fetchListFTP(struct url *, const char *);
115
116/* Generic functions */
117FILE		*fetchXGetURL(const char *, struct url_stat *, const char *);
118FILE		*fetchGetURL(const char *, const char *);
119FILE		*fetchPutURL(const char *, const char *);
120int		 fetchStatURL(const char *, struct url_stat *, const char *);
121struct url_ent	*fetchListURL(const char *, const char *);
122FILE		*fetchXGet(struct url *, struct url_stat *, const char *);
123FILE		*fetchGet(struct url *, const char *);
124FILE		*fetchPut(struct url *, const char *);
125int		 fetchStat(struct url *, struct url_stat *, const char *);
126struct url_ent	*fetchList(struct url *, const char *);
127
128/* URL parsing */
129struct url	*fetchMakeURL(const char *, const char *, int,
130		     const char *, const char *, const char *);
131struct url	*fetchParseURL(const char *);
132void		 fetchFreeURL(struct url *);
133
134__END_DECLS
135
136/* Authentication */
137typedef int (*auth_t)(struct url *);
138extern auth_t		 fetchAuthMethod;
139
140/* Last error code */
141extern int		 fetchLastErrCode;
142#define MAXERRSTRING 256
143extern char		 fetchLastErrString[MAXERRSTRING];
144
145/* I/O timeout */
146extern int		 fetchTimeout;
147
148/* Restart interrupted syscalls */
149extern int		 fetchRestartCalls;
150
151/* Extra verbosity */
152extern int		 fetchDebug;
153
154#endif
155