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$
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};
51
52struct url_stat {
53	off_t		 size;
54	time_t		 atime;
55	time_t		 mtime;
56};
57
58struct url_ent {
59	char		 name[PATH_MAX];
60	struct url_stat	 stat;
61};
62
63/* Recognized schemes */
64#define SCHEME_FTP	"ftp"
65#define SCHEME_HTTP	"http"
66#define SCHEME_HTTPS	"https"
67#define SCHEME_FILE	"file"
68
69/* Error codes */
70#define	FETCH_ABORT	 1
71#define	FETCH_AUTH	 2
72#define	FETCH_DOWN	 3
73#define	FETCH_EXISTS	 4
74#define	FETCH_FULL	 5
75#define	FETCH_INFO	 6
76#define	FETCH_MEMORY	 7
77#define	FETCH_MOVED	 8
78#define	FETCH_NETWORK	 9
79#define	FETCH_OK	10
80#define	FETCH_PROTO	11
81#define	FETCH_RESOLV	12
82#define	FETCH_SERVER	13
83#define	FETCH_TEMP	14
84#define	FETCH_TIMEOUT	15
85#define	FETCH_UNAVAIL	16
86#define	FETCH_UNKNOWN	17
87#define	FETCH_URL	18
88#define	FETCH_VERBOSE	19
89
90__BEGIN_DECLS
91
92/* FILE-specific functions */
93FILE		*fetchXGetFile(struct url *, struct url_stat *, const char *);
94FILE		*fetchGetFile(struct url *, const char *);
95FILE		*fetchPutFile(struct url *, const char *);
96int		 fetchStatFile(struct url *, struct url_stat *, const char *);
97struct url_ent	*fetchListFile(struct url *, const char *);
98
99/* HTTP-specific functions */
100FILE		*fetchXGetHTTP(struct url *, struct url_stat *, const char *);
101FILE		*fetchGetHTTP(struct url *, const char *);
102FILE		*fetchPutHTTP(struct url *, const char *);
103int		 fetchStatHTTP(struct url *, struct url_stat *, const char *);
104struct url_ent	*fetchListHTTP(struct url *, const char *);
105FILE		*fetchReqHTTP(struct url *, const char *, const char *,
106		    const char *, const char *);
107
108/* FTP-specific functions */
109FILE		*fetchXGetFTP(struct url *, struct url_stat *, const char *);
110FILE		*fetchGetFTP(struct url *, const char *);
111FILE		*fetchPutFTP(struct url *, const char *);
112int		 fetchStatFTP(struct url *, struct url_stat *, const char *);
113struct url_ent	*fetchListFTP(struct url *, const char *);
114
115/* Generic functions */
116FILE		*fetchXGetURL(const char *, struct url_stat *, const char *);
117FILE		*fetchGetURL(const char *, const char *);
118FILE		*fetchPutURL(const char *, const char *);
119int		 fetchStatURL(const char *, struct url_stat *, const char *);
120struct url_ent	*fetchListURL(const char *, const char *);
121FILE		*fetchXGet(struct url *, struct url_stat *, const char *);
122FILE		*fetchGet(struct url *, const char *);
123FILE		*fetchPut(struct url *, const char *);
124int		 fetchStat(struct url *, struct url_stat *, const char *);
125struct url_ent	*fetchList(struct url *, const char *);
126
127/* URL parsing */
128struct url	*fetchMakeURL(const char *, const char *, int,
129		     const char *, const char *, const char *);
130struct url	*fetchParseURL(const char *);
131void		 fetchFreeURL(struct url *);
132
133__END_DECLS
134
135/* Authentication */
136typedef int (*auth_t)(struct url *);
137extern auth_t		 fetchAuthMethod;
138
139/* Last error code */
140extern int		 fetchLastErrCode;
141#define MAXERRSTRING 256
142extern char		 fetchLastErrString[MAXERRSTRING];
143
144/* I/O timeout */
145extern int		 fetchTimeout;
146
147/* Restart interrupted syscalls */
148extern int		 fetchRestartCalls;
149
150/* Extra verbosity */
151extern int		 fetchDebug;
152
153#endif
154