1998-11-05 19:48:17 +00:00
|
|
|
|
/*-
|
|
|
|
|
|
* Copyright (c) 1998 Dag-Erling Co<EFBFBD>dan Sm<EFBFBD>rgrav
|
|
|
|
|
|
* 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-11-05 19:48:17 +00:00
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
|
|
#ifndef _COMMON_H_INCLUDED
|
|
|
|
|
|
#define _COMMON_H_INCLUDED
|
|
|
|
|
|
|
2000-07-25 11:45:38 +00:00
|
|
|
|
#define FTP_DEFAULT_PORT 21
|
|
|
|
|
|
#define HTTP_DEFAULT_PORT 80
|
2000-11-10 08:43:40 +00:00
|
|
|
|
#define FTP_DEFAULT_PROXY_PORT 21
|
|
|
|
|
|
#define HTTP_DEFAULT_PROXY_PORT 3128
|
2000-07-25 11:45:38 +00:00
|
|
|
|
|
1998-11-05 19:48:17 +00:00
|
|
|
|
/* Structure used for error message lists */
|
|
|
|
|
|
struct fetcherr {
|
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
|
|
|
|
const int num, cat;
|
|
|
|
|
|
const char *string;
|
1998-11-05 19:48:17 +00:00
|
|
|
|
};
|
|
|
|
|
|
|
2000-01-07 12:58:40 +00:00
|
|
|
|
void _fetch_seterr(struct fetcherr *p, int e);
|
1998-11-05 19:48:17 +00:00
|
|
|
|
void _fetch_syserr(void);
|
2001-04-24 00:06:21 +00:00
|
|
|
|
void _fetch_info(const char *fmt, ...);
|
|
|
|
|
|
int _fetch_default_port(const char *);
|
|
|
|
|
|
int _fetch_default_proxy_port(const char *);
|
|
|
|
|
|
int _fetch_connect(const char *host, int port, int af, int verbose);
|
2000-01-07 12:58:40 +00:00
|
|
|
|
int _fetch_getln(int fd, char **buf, size_t *size, size_t *len);
|
2001-04-24 00:06:21 +00:00
|
|
|
|
int _fetch_putln(int fd, const char *str, size_t len);
|
1998-12-21 19:41:50 +00:00
|
|
|
|
int _fetch_add_entry(struct url_ent **p, int *size, int *len,
|
2001-04-24 00:06:21 +00:00
|
|
|
|
const char *name, struct url_stat *stat);
|
1998-12-21 19:41:50 +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
|
|
|
|
#define _ftp_seterr(n) _fetch_seterr(_ftp_errlist, n)
|
|
|
|
|
|
#define _http_seterr(n) _fetch_seterr(_http_errlist, n)
|
|
|
|
|
|
#define _netdb_seterr(n) _fetch_seterr(_netdb_errlist, n)
|
|
|
|
|
|
#define _url_seterr(n) _fetch_seterr(_url_errlist, n)
|
|
|
|
|
|
|
|
|
|
|
|
#ifndef NDEBUG
|
|
|
|
|
|
#define DEBUG(x) do x; while (0)
|
|
|
|
|
|
#else
|
|
|
|
|
|
#define DEBUG(x) do { } while (0)
|
|
|
|
|
|
#endif
|
|
|
|
|
|
|
2000-10-12 22:10:43 +00:00
|
|
|
|
/*
|
|
|
|
|
|
* I don't really like exporting _http_request() from http.c, but ftp.c
|
|
|
|
|
|
* occasionally needs to use an HTTP proxy, and this saves me from adding
|
|
|
|
|
|
* a lot of special-case code to http.c to handle those cases.
|
|
|
|
|
|
*
|
|
|
|
|
|
* Note that _http_request() frees purl, which is way ugly but saves us a
|
|
|
|
|
|
* whole lot of trouble.
|
|
|
|
|
|
*/
|
2001-04-24 00:06:21 +00:00
|
|
|
|
FILE *_http_request(struct url *URL, const char *op,
|
|
|
|
|
|
struct url_stat *us, struct url *purl,
|
|
|
|
|
|
const char *flags);
|
2000-10-12 22:10:43 +00:00
|
|
|
|
|
2000-10-29 15:45:31 +00:00
|
|
|
|
/*
|
|
|
|
|
|
* Check whether a particular flag is set
|
|
|
|
|
|
*/
|
|
|
|
|
|
#define CHECK_FLAG(x) (flags && strchr(flags, (x)))
|
|
|
|
|
|
|
1998-11-05 19:48:17 +00:00
|
|
|
|
#endif
|
