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