1998-07-09 16:52:44 +00:00
|
|
|
/*-
|
2017-11-26 02:00:33 +00:00
|
|
|
* SPDX-License-Identifier: BSD-3-Clause
|
|
|
|
|
*
|
2011-10-19 11:43:51 +00:00
|
|
|
* Copyright (c) 1998-2004 Dag-Erling Smørgrav
|
1998-07-09 16:52:44 +00:00
|
|
|
* All rights reserved.
|
|
|
|
|
*
|
|
|
|
|
* Redistribution and use in source and binary forms, with or without
|
|
|
|
|
* modification, are permitted provided that the following conditions
|
|
|
|
|
* are met:
|
|
|
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
|
|
|
* notice, this list of conditions and the following disclaimer
|
|
|
|
|
* in this position and unchanged.
|
|
|
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
|
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
|
|
|
* documentation and/or other materials provided with the distribution.
|
|
|
|
|
* 3. The name of the author may not be used to endorse or promote products
|
|
|
|
|
* derived from this software without specific prior written permission
|
|
|
|
|
*
|
|
|
|
|
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
|
|
|
|
|
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
|
|
|
|
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
|
|
|
|
* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|
|
|
|
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
|
|
|
|
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
|
|
|
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
|
|
|
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
|
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
|
|
|
|
|
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
|
*
|
1999-08-28 00:22:10 +00:00
|
|
|
* $FreeBSD$
|
1998-07-09 16:52:44 +00:00
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
#ifndef _FETCH_H_INCLUDED
|
|
|
|
|
#define _FETCH_H_INCLUDED
|
|
|
|
|
|
2000-05-25 16:24:31 +00:00
|
|
|
#define _LIBFETCH_VER "libfetch/2.0"
|
1998-07-09 16:52:44 +00:00
|
|
|
|
|
|
|
|
#define URL_SCHEMELEN 16
|
|
|
|
|
#define URL_USERLEN 256
|
|
|
|
|
#define URL_PWDLEN 256
|
|
|
|
|
|
Second of a series of cleanups to libfetch.
This commit introduces the following features:
a) the fetchStat*() functions, which return meta-information for a
document, such as size, modification time, etc.
b) the use of the com_err(3) facilities to report errors.
It also fixes a bunch of style bugs and a few logic bugs and somewhat
improves the man page.
Changed files, in alphabetical order:
Makefile:
Don't generate macros in {ftp,http}err.c.
Generate category fields for the error message lists.
Compile the error table.
Install fetch_err.h along with fetch.h.
common.c:
Remove the _netdb_errstring() macro, and add FETCH_ERR_NETDB to the
error code in the _netdb_seterr() macro.
Add categories to the _netdb_errlist table.
Report errors through the Common Error library.
common.h:
Add the DEBUG macros.
Add prototype for fetchConnect().
Remove the prototype for _fetch_errstring(), which is local to common.c
Add a categroy field to struct fetcherr, and define constants for
error categories.
Define macros for _{url,netdb,ftp,http}_seterr().
errors.et: (new file)
List error categories.
fetch.3:
Document the fetchStat*() functions.
Move the "unimplemented functionality" comments from NOTES to BUGS.
Document that applications which use libfetch must also use
libcom_err, and list existing error codes.
Undocument fetchLastErr{Code,String}.
Remove the (empty) DIAGNOSTICS section.
Mention Eugene Skepner in the AUTHORS section.
fetch.c:
Move the DEBUG macros to common.c
Add fetchStat() and fetchStatURL().
Generate error messages for URL parser errors, and fix a minor bug
in the parser.
Use 'struct url' instead of 'url_t'.
Remove fetchLastErr{Code,String}.
fetch.h:
Use 'struct url' instead of 'url_t', and remove the typedef.
Define struct url_stat (used by fetchStat()).
Add prototypes for fetchStat*().
Remove the declarations for fetchLastErr{Code,String}.
Include fetch_err.h.
fetch_err.et: (new file)
Error table for libfetch.
file.c:
Add fetchStatFile().
Use 'struct url' instead of 'url_t'.
ftp.c:
Add fetchStatFTP().
Use 'struct url' instead of 'url_t'.
Don't use fetchLastErrCode.
ftp.errors:
Add categories to all error messages.
http.c:
Add fetchStatHTTP().
Use 'struct url' instead of 'url_t'.
Don't use fetchLastErr{Code,Text}.
http.errors:
Add categories to all error messages.
Prompted by: jkh and Eugene Skepner
Numerous sugestions from: Garett Wollman and Eugene Skepner
1998-11-06 22:14:08 +00:00
|
|
|
struct url {
|
2002-02-05 22:13:51 +00:00
|
|
|
char scheme[URL_SCHEMELEN+1];
|
|
|
|
|
char user[URL_USERLEN+1];
|
|
|
|
|
char pwd[URL_PWDLEN+1];
|
|
|
|
|
char host[MAXHOSTNAMELEN+1];
|
|
|
|
|
int port;
|
|
|
|
|
char *doc;
|
|
|
|
|
off_t offset;
|
|
|
|
|
size_t length;
|
2008-12-15 08:27:44 +00:00
|
|
|
time_t ims_time;
|
2017-02-20 00:14:31 +00:00
|
|
|
int netrcfd;
|
1998-07-09 16:52:44 +00:00
|
|
|
};
|
|
|
|
|
|
Second of a series of cleanups to libfetch.
This commit introduces the following features:
a) the fetchStat*() functions, which return meta-information for a
document, such as size, modification time, etc.
b) the use of the com_err(3) facilities to report errors.
It also fixes a bunch of style bugs and a few logic bugs and somewhat
improves the man page.
Changed files, in alphabetical order:
Makefile:
Don't generate macros in {ftp,http}err.c.
Generate category fields for the error message lists.
Compile the error table.
Install fetch_err.h along with fetch.h.
common.c:
Remove the _netdb_errstring() macro, and add FETCH_ERR_NETDB to the
error code in the _netdb_seterr() macro.
Add categories to the _netdb_errlist table.
Report errors through the Common Error library.
common.h:
Add the DEBUG macros.
Add prototype for fetchConnect().
Remove the prototype for _fetch_errstring(), which is local to common.c
Add a categroy field to struct fetcherr, and define constants for
error categories.
Define macros for _{url,netdb,ftp,http}_seterr().
errors.et: (new file)
List error categories.
fetch.3:
Document the fetchStat*() functions.
Move the "unimplemented functionality" comments from NOTES to BUGS.
Document that applications which use libfetch must also use
libcom_err, and list existing error codes.
Undocument fetchLastErr{Code,String}.
Remove the (empty) DIAGNOSTICS section.
Mention Eugene Skepner in the AUTHORS section.
fetch.c:
Move the DEBUG macros to common.c
Add fetchStat() and fetchStatURL().
Generate error messages for URL parser errors, and fix a minor bug
in the parser.
Use 'struct url' instead of 'url_t'.
Remove fetchLastErr{Code,String}.
fetch.h:
Use 'struct url' instead of 'url_t', and remove the typedef.
Define struct url_stat (used by fetchStat()).
Add prototypes for fetchStat*().
Remove the declarations for fetchLastErr{Code,String}.
Include fetch_err.h.
fetch_err.et: (new file)
Error table for libfetch.
file.c:
Add fetchStatFile().
Use 'struct url' instead of 'url_t'.
ftp.c:
Add fetchStatFTP().
Use 'struct url' instead of 'url_t'.
Don't use fetchLastErrCode.
ftp.errors:
Add categories to all error messages.
http.c:
Add fetchStatHTTP().
Use 'struct url' instead of 'url_t'.
Don't use fetchLastErr{Code,Text}.
http.errors:
Add categories to all error messages.
Prompted by: jkh and Eugene Skepner
Numerous sugestions from: Garett Wollman and Eugene Skepner
1998-11-06 22:14:08 +00:00
|
|
|
struct url_stat {
|
2002-02-05 22:13:51 +00:00
|
|
|
off_t size;
|
|
|
|
|
time_t atime;
|
|
|
|
|
time_t mtime;
|
Second of a series of cleanups to libfetch.
This commit introduces the following features:
a) the fetchStat*() functions, which return meta-information for a
document, such as size, modification time, etc.
b) the use of the com_err(3) facilities to report errors.
It also fixes a bunch of style bugs and a few logic bugs and somewhat
improves the man page.
Changed files, in alphabetical order:
Makefile:
Don't generate macros in {ftp,http}err.c.
Generate category fields for the error message lists.
Compile the error table.
Install fetch_err.h along with fetch.h.
common.c:
Remove the _netdb_errstring() macro, and add FETCH_ERR_NETDB to the
error code in the _netdb_seterr() macro.
Add categories to the _netdb_errlist table.
Report errors through the Common Error library.
common.h:
Add the DEBUG macros.
Add prototype for fetchConnect().
Remove the prototype for _fetch_errstring(), which is local to common.c
Add a categroy field to struct fetcherr, and define constants for
error categories.
Define macros for _{url,netdb,ftp,http}_seterr().
errors.et: (new file)
List error categories.
fetch.3:
Document the fetchStat*() functions.
Move the "unimplemented functionality" comments from NOTES to BUGS.
Document that applications which use libfetch must also use
libcom_err, and list existing error codes.
Undocument fetchLastErr{Code,String}.
Remove the (empty) DIAGNOSTICS section.
Mention Eugene Skepner in the AUTHORS section.
fetch.c:
Move the DEBUG macros to common.c
Add fetchStat() and fetchStatURL().
Generate error messages for URL parser errors, and fix a minor bug
in the parser.
Use 'struct url' instead of 'url_t'.
Remove fetchLastErr{Code,String}.
fetch.h:
Use 'struct url' instead of 'url_t', and remove the typedef.
Define struct url_stat (used by fetchStat()).
Add prototypes for fetchStat*().
Remove the declarations for fetchLastErr{Code,String}.
Include fetch_err.h.
fetch_err.et: (new file)
Error table for libfetch.
file.c:
Add fetchStatFile().
Use 'struct url' instead of 'url_t'.
ftp.c:
Add fetchStatFTP().
Use 'struct url' instead of 'url_t'.
Don't use fetchLastErrCode.
ftp.errors:
Add categories to all error messages.
http.c:
Add fetchStatHTTP().
Use 'struct url' instead of 'url_t'.
Don't use fetchLastErr{Code,Text}.
http.errors:
Add categories to all error messages.
Prompted by: jkh and Eugene Skepner
Numerous sugestions from: Garett Wollman and Eugene Skepner
1998-11-06 22:14:08 +00:00
|
|
|
};
|
1998-07-09 16:52:44 +00:00
|
|
|
|
1998-12-21 19:41:50 +00:00
|
|
|
struct url_ent {
|
2002-02-05 22:13:51 +00:00
|
|
|
char name[PATH_MAX];
|
|
|
|
|
struct url_stat stat;
|
1998-12-21 19:41:50 +00:00
|
|
|
};
|
|
|
|
|
|
2000-10-12 21:59:22 +00:00
|
|
|
/* Recognized schemes */
|
|
|
|
|
#define SCHEME_FTP "ftp"
|
|
|
|
|
#define SCHEME_HTTP "http"
|
2000-12-01 11:04:43 +00:00
|
|
|
#define SCHEME_HTTPS "https"
|
2000-10-12 21:59:22 +00:00
|
|
|
#define SCHEME_FILE "file"
|
|
|
|
|
|
2000-05-25 16:24:31 +00:00
|
|
|
/* Error codes */
|
|
|
|
|
#define FETCH_ABORT 1
|
|
|
|
|
#define FETCH_AUTH 2
|
|
|
|
|
#define FETCH_DOWN 3
|
|
|
|
|
#define FETCH_EXISTS 4
|
|
|
|
|
#define FETCH_FULL 5
|
|
|
|
|
#define FETCH_INFO 6
|
|
|
|
|
#define FETCH_MEMORY 7
|
|
|
|
|
#define FETCH_MOVED 8
|
|
|
|
|
#define FETCH_NETWORK 9
|
|
|
|
|
#define FETCH_OK 10
|
|
|
|
|
#define FETCH_PROTO 11
|
|
|
|
|
#define FETCH_RESOLV 12
|
|
|
|
|
#define FETCH_SERVER 13
|
|
|
|
|
#define FETCH_TEMP 14
|
|
|
|
|
#define FETCH_TIMEOUT 15
|
|
|
|
|
#define FETCH_UNAVAIL 16
|
|
|
|
|
#define FETCH_UNKNOWN 17
|
|
|
|
|
#define FETCH_URL 18
|
|
|
|
|
#define FETCH_VERBOSE 19
|
|
|
|
|
|
2002-07-22 16:11:39 +00:00
|
|
|
__BEGIN_DECLS
|
|
|
|
|
|
1998-07-09 16:52:44 +00:00
|
|
|
/* FILE-specific functions */
|
2001-04-24 00:06:21 +00:00
|
|
|
FILE *fetchXGetFile(struct url *, struct url_stat *, const char *);
|
|
|
|
|
FILE *fetchGetFile(struct url *, const char *);
|
|
|
|
|
FILE *fetchPutFile(struct url *, const char *);
|
|
|
|
|
int fetchStatFile(struct url *, struct url_stat *, const char *);
|
|
|
|
|
struct url_ent *fetchListFile(struct url *, const char *);
|
1998-07-09 16:52:44 +00:00
|
|
|
|
|
|
|
|
/* HTTP-specific functions */
|
2001-04-24 00:06:21 +00:00
|
|
|
FILE *fetchXGetHTTP(struct url *, struct url_stat *, const char *);
|
|
|
|
|
FILE *fetchGetHTTP(struct url *, const char *);
|
|
|
|
|
FILE *fetchPutHTTP(struct url *, const char *);
|
|
|
|
|
int fetchStatHTTP(struct url *, struct url_stat *, const char *);
|
|
|
|
|
struct url_ent *fetchListHTTP(struct url *, const char *);
|
2014-06-05 22:16:26 +00:00
|
|
|
FILE *fetchReqHTTP(struct url *, const char *, const char *,
|
|
|
|
|
const char *, const char *);
|
1998-07-09 16:52:44 +00:00
|
|
|
|
|
|
|
|
/* FTP-specific functions */
|
2001-04-24 00:06:21 +00:00
|
|
|
FILE *fetchXGetFTP(struct url *, struct url_stat *, const char *);
|
|
|
|
|
FILE *fetchGetFTP(struct url *, const char *);
|
|
|
|
|
FILE *fetchPutFTP(struct url *, const char *);
|
|
|
|
|
int fetchStatFTP(struct url *, struct url_stat *, const char *);
|
|
|
|
|
struct url_ent *fetchListFTP(struct url *, const char *);
|
1998-07-09 16:52:44 +00:00
|
|
|
|
|
|
|
|
/* Generic functions */
|
2001-04-24 00:06:21 +00:00
|
|
|
FILE *fetchXGetURL(const char *, struct url_stat *, const char *);
|
|
|
|
|
FILE *fetchGetURL(const char *, const char *);
|
|
|
|
|
FILE *fetchPutURL(const char *, const char *);
|
|
|
|
|
int fetchStatURL(const char *, struct url_stat *, const char *);
|
|
|
|
|
struct url_ent *fetchListURL(const char *, const char *);
|
|
|
|
|
FILE *fetchXGet(struct url *, struct url_stat *, const char *);
|
|
|
|
|
FILE *fetchGet(struct url *, const char *);
|
|
|
|
|
FILE *fetchPut(struct url *, const char *);
|
|
|
|
|
int fetchStat(struct url *, struct url_stat *, const char *);
|
|
|
|
|
struct url_ent *fetchList(struct url *, const char *);
|
1998-07-09 16:52:44 +00:00
|
|
|
|
2000-05-11 13:31:02 +00:00
|
|
|
/* URL parsing */
|
2001-04-24 00:06:21 +00:00
|
|
|
struct url *fetchMakeURL(const char *, const char *, int,
|
2002-02-05 22:13:51 +00:00
|
|
|
const char *, const char *, const char *);
|
2001-04-24 00:06:21 +00:00
|
|
|
struct url *fetchParseURL(const char *);
|
2000-05-11 13:31:02 +00:00
|
|
|
void fetchFreeURL(struct url *);
|
|
|
|
|
|
2002-07-22 16:11:39 +00:00
|
|
|
__END_DECLS
|
|
|
|
|
|
2001-05-26 19:37:15 +00:00
|
|
|
/* Authentication */
|
|
|
|
|
typedef int (*auth_t)(struct url *);
|
2002-02-05 22:13:51 +00:00
|
|
|
extern auth_t fetchAuthMethod;
|
2001-05-26 19:37:15 +00:00
|
|
|
|
1998-12-16 10:24:55 +00:00
|
|
|
/* Last error code */
|
2002-02-05 22:13:51 +00:00
|
|
|
extern int fetchLastErrCode;
|
2000-05-25 16:24:31 +00:00
|
|
|
#define MAXERRSTRING 256
|
2002-02-05 22:13:51 +00:00
|
|
|
extern char fetchLastErrString[MAXERRSTRING];
|
|
|
|
|
|
|
|
|
|
/* I/O timeout */
|
|
|
|
|
extern int fetchTimeout;
|
|
|
|
|
|
|
|
|
|
/* Restart interrupted syscalls */
|
|
|
|
|
extern int fetchRestartCalls;
|
1998-12-16 10:24:55 +00:00
|
|
|
|
2001-12-09 15:05:19 +00:00
|
|
|
/* Extra verbosity */
|
2002-02-05 22:13:51 +00:00
|
|
|
extern int fetchDebug;
|
2001-12-09 15:05:19 +00:00
|
|
|
|
1998-07-09 16:52:44 +00:00
|
|
|
#endif
|
