fetch.h revision 60924 
1/*-
2 * Copyright (c) 1998 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 *    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: head/lib/libfetch/fetch.h 60924 2000-05-25 16:24:31Z 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};
50
51struct url_stat {
52    off_t	 size;
53    time_t	 atime;
54    time_t	 mtime;
55};
56
57struct url_ent {
58    char	 name[MAXPATHLEN];
59    struct url_stat stat;
60};
61
62/* Error codes */
63#define	FETCH_ABORT	 1
64#define	FETCH_AUTH	 2
65#define	FETCH_DOWN	 3
66#define	FETCH_EXISTS	 4
67#define	FETCH_FULL	 5
68#define	FETCH_INFO	 6
69#define	FETCH_MEMORY	 7
70#define	FETCH_MOVED	 8
71#define	FETCH_NETWORK	 9
72#define	FETCH_OK	10
73#define	FETCH_PROTO	11
74#define	FETCH_RESOLV	12
75#define	FETCH_SERVER	13
76#define	FETCH_TEMP	14
77#define	FETCH_TIMEOUT	15
78#define	FETCH_UNAVAIL	16
79#define	FETCH_UNKNOWN	17
80#define	FETCH_URL	18
81#define	FETCH_VERBOSE	19
82
83/* FILE-specific functions */
84FILE		*fetchGetFile(struct url *, char *);
85FILE		*fetchPutFile(struct url *, char *);
86int		 fetchStatFile(struct url *, struct url_stat *, char *);
87struct url_ent	*fetchListFile(struct url *, char *);
88
89/* HTTP-specific functions */
90char		*fetchContentType(FILE *);
91FILE		*fetchGetHTTP(struct url *, char *);
92FILE		*fetchPutHTTP(struct url *, char *);
93int		 fetchStatHTTP(struct url *, struct url_stat *, char *);
94struct url_ent	*fetchListHTTP(struct url *, char *);
95
96/* FTP-specific functions */
97FILE		*fetchGetFTP(struct url *, char *);
98FILE		*fetchPutFTP(struct url *, char *);
99int		 fetchStatFTP(struct url *, struct url_stat *, char *);
100struct url_ent	*fetchListFTP(struct url *, char *);
101
102/* Generic functions */
103FILE		*fetchGetURL(char *, char *);
104FILE		*fetchPutURL(char *, char *);
105int		 fetchStatURL(char *, struct url_stat *, char *);
106struct url_ent	*fetchListURL(char *, char *);
107FILE		*fetchGet(struct url *, char *);
108FILE		*fetchPut(struct url *, char *);
109int		 fetchStat(struct url *, struct url_stat *, char *);
110struct url_ent	*fetchList(struct url *, char *);
111
112/* URL parsing */
113struct url	*fetchParseURL(char *);
114void		 fetchFreeURL(struct url *);
115
116/* Last error code */
117extern int	 fetchLastErrCode;
118#define MAXERRSTRING 256
119extern char	 fetchLastErrString[MAXERRSTRING];
120extern int	 fetchTimeout;
121
122#endif
123