xref: /freebsd/lib/libfetch/fetch.h (revision b95b56c7a06bd268299c6d3b1104e09831e600dc)
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 #include <fetch_err.h>
35 
36 #define _LIBFETCH_VER "libfetch/1.0"
37 
38 #define URL_SCHEMELEN 16
39 #define URL_USERLEN 256
40 #define URL_PWDLEN 256
41 
42 struct url {
43     off_t	 offset;
44     size_t	 length;
45     char	 scheme[URL_SCHEMELEN+1];
46     char	 user[URL_USERLEN+1];
47     char	 pwd[URL_PWDLEN+1];
48     char	 host[MAXHOSTNAMELEN+1];
49     int		 port;
50     char	 doc[2];
51 };
52 
53 struct url_stat {
54     off_t	 size;
55     time_t	 atime;
56     time_t	 mtime;
57 };
58 
59 struct url_ent {
60     char	 name[MAXPATHLEN];
61     struct url_stat stat;
62 };
63 
64 /* FILE-specific functions */
65 FILE		*fetchGetFile(struct url *, char *);
66 FILE		*fetchPutFile(struct url *, char *);
67 int		 fetchStatFile(struct url *, struct url_stat *, char *);
68 struct url_ent	*fetchListFile(struct url *, char *);
69 
70 /* HTTP-specific functions */
71 char		*fetchContentType(FILE *);
72 FILE		*fetchGetHTTP(struct url *, char *);
73 FILE		*fetchPutHTTP(struct url *, char *);
74 int		 fetchStatHTTP(struct url *, struct url_stat *, char *);
75 struct url_ent	*fetchListHTTP(struct url *, char *);
76 
77 /* FTP-specific functions */
78 FILE		*fetchGetFTP(struct url *, char *);
79 FILE		*fetchPutFTP(struct url *, char *);
80 int		 fetchStatFTP(struct url *, struct url_stat *, char *);
81 struct url_ent	*fetchListFTP(struct url *, char *);
82 
83 /* Generic functions */
84 struct url	*fetchParseURL(char *);
85 FILE		*fetchGetURL(char *, char *);
86 FILE		*fetchPutURL(char *, char *);
87 int		 fetchStatURL(char *, struct url_stat *, char *);
88 struct url_ent	*fetchListURL(char *, char *);
89 FILE		*fetchGet(struct url *, char *);
90 FILE		*fetchPut(struct url *, char *);
91 int		 fetchStat(struct url *, struct url_stat *, char *);
92 struct url_ent	*fetchList(struct url *, char *);
93 
94 /* Last error code */
95 extern int	 fetchLastErrCode;
96 extern int	 fetchTimeout;
97 
98 #endif
99