d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
efe67753cc
freebsd-skq/lib/libfetch/fetch.h

155 lines
4.8 KiB
C
Raw Normal View History

Imported libfetch into the tree. It compiles, but there's still some work to do. I especially need help with the man page.
1998-07-09 16:52:44 +00:00
/*-
latin1 -> utf8
2011-10-19 11:43:51 +00:00
* Copyright (c) 1998-2004 Dag-Erling Smørgrav
Imported libfetch into the tree. It compiles, but there's still some work to do. I especially need help with the man page.
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.
*
$Id$ -> $FreeBSD$
1999-08-28 00:22:10 +00:00
* $FreeBSD$
Imported libfetch into the tree. It compiles, but there's still some work to do. I especially need help with the man page.
1998-07-09 16:52:44 +00:00
*/
#ifndef _FETCH_H_INCLUDED
#define _FETCH_H_INCLUDED
Dump com_err, it's a stinking crock of shit.
2000-05-25 16:24:31 +00:00
#define _LIBFETCH_VER "libfetch/2.0"
Imported libfetch into the tree. It compiles, but there's still some work to do. I especially need help with the man page.
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 {
Reindent, and add parentheses to return statements. Some functions in ftp.c and http.c now have exceedingly long lines due to deep nesting; this will be corrected by reorganizing the code in a later revision.
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;
Add support for HTTP 1.1 If-Modified-Since behavior. fetch(1) accepts a new argument -i <file> that if specified will cause the file to be downloaded only if it is more recent than the mtime of <file>. libfetch(3) accepts the mtime in the url structure and a flag to indicate when this behavior is desired. PR: bin/87841 Submitted by: Jukka A. Ukkonen <jau@iki.fi> (partially) Reviewed by: des, ru MFC after: 3 weeks
2008-12-15 08:27:44 +00:00
time_t ims_time;
Add a file descriptor in struct url for netrc When using libfetch in an application that drops privileges when fetching like pkg(8) then user complain because the application does not read anymore ${HOME}/.netrc. Now a caller can prepare a fd to the said file and manually assign it to the structure. It is also a first step to allow to capsicumize libfetch applications Reviewed by: allanjude, des Approved by: des Differential Revision: https://reviews.freebsd.org/D9678
2017-02-20 00:14:31 +00:00
int netrcfd;
Imported libfetch into the tree. It compiles, but there's still some work to do. I especially need help with the man page.
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 {
Reindent, and add parentheses to return statements. Some functions in ftp.c and http.c now have exceedingly long lines due to deep nesting; this will be corrected by reorganizing the code in a later revision.
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
};
Imported libfetch into the tree. It compiles, but there's still some work to do. I especially need help with the man page.
1998-07-09 16:52:44 +00:00
Implement and document file list retrieval.
1998-12-21 19:41:50 +00:00
struct url_ent {
Reindent, and add parentheses to return statements. Some functions in ftp.c and http.c now have exceedingly long lines due to deep nesting; this will be corrected by reorganizing the code in a later revision.
2002-02-05 22:13:51 +00:00
char name[PATH_MAX];
struct url_stat stat;
Implement and document file list retrieval.
1998-12-21 19:41:50 +00:00
};
Add macros for the names of the URL schemes we support.
2000-10-12 21:59:22 +00:00
/* Recognized schemes */
#define SCHEME_FTP "ftp"
#define SCHEME_HTTP "http"
Add SCHEME_HTTPS.
2000-12-01 11:04:43 +00:00
#define SCHEME_HTTPS "https"
Add macros for the names of the URL schemes we support.
2000-10-12 21:59:22 +00:00
#define SCHEME_FILE "file"
Dump com_err, it's a stinking crock of shit.
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
Surround prototypes with __BEGIN_DECLS / __END_DECLS. PR: misc/40399 MFC after: 3 days
2002-07-22 16:11:39 +00:00
__BEGIN_DECLS
Imported libfetch into the tree. It compiles, but there's still some work to do. I especially need help with the man page.
1998-07-09 16:52:44 +00:00
/* FILE-specific functions */
Apply 'const' liberally. Fix some other minor glitches.
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 *);
Imported libfetch into the tree. It compiles, but there's still some work to do. I especially need help with the man page.
1998-07-09 16:52:44 +00:00
/* HTTP-specific functions */
Apply 'const' liberally. Fix some other minor glitches.
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 *);
Add support for arbitrary http requests Submitted by: Alex Hornung <alex@alexhornung.com> Reviewed by: des Obtained from: Dragonfly MFC after: 3 week
2014-06-05 22:16:26 +00:00
FILE *fetchReqHTTP(struct url *, const char *, const char *,
const char *, const char *);
Imported libfetch into the tree. It compiles, but there's still some work to do. I especially need help with the man page.
1998-07-09 16:52:44 +00:00
/* FTP-specific functions */
Apply 'const' liberally. Fix some other minor glitches.
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 *);
Imported libfetch into the tree. It compiles, but there's still some work to do. I especially need help with the man page.
1998-07-09 16:52:44 +00:00
/* Generic functions */
Apply 'const' liberally. Fix some other minor glitches.
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 *);
Imported libfetch into the tree. It compiles, but there's still some work to do. I especially need help with the man page.
1998-07-09 16:52:44 +00:00
Reorganize some of the http code and split it into more functions. Implement fetchStatHTTP(). Unbungle struct url, and add fetchFreeURL(). Document it.
2000-05-11 13:31:02 +00:00
/* URL parsing */
Apply 'const' liberally. Fix some other minor glitches.
2001-04-24 00:06:21 +00:00
struct url *fetchMakeURL(const char *, const char *, int,
Reindent, and add parentheses to return statements. Some functions in ftp.c and http.c now have exceedingly long lines due to deep nesting; this will be corrected by reorganizing the code in a later revision.
2002-02-05 22:13:51 +00:00
const char *, const char *, const char *);
Apply 'const' liberally. Fix some other minor glitches.
2001-04-24 00:06:21 +00:00
struct url *fetchParseURL(const char *);
Reorganize some of the http code and split it into more functions. Implement fetchStatHTTP(). Unbungle struct url, and add fetchFreeURL(). Document it.
2000-05-11 13:31:02 +00:00
void fetchFreeURL(struct url *);
Surround prototypes with __BEGIN_DECLS / __END_DECLS. PR: misc/40399 MFC after: 3 days
2002-07-22 16:11:39 +00:00
__END_DECLS
Add rudimentary support for an authentication callback function.
2001-05-26 19:37:15 +00:00
/* Authentication */
typedef int (*auth_t)(struct url *);
Reindent, and add parentheses to return statements. Some functions in ftp.c and http.c now have exceedingly long lines due to deep nesting; this will be corrected by reorganizing the code in a later revision.
2002-02-05 22:13:51 +00:00
extern auth_t fetchAuthMethod;
Add rudimentary support for an authentication callback function.
2001-05-26 19:37:15 +00:00
Add verbose flag, and support functions. Brucify the Makefile. Differentiate atime and mtime in fetch*Stat(). Fix a few pointer bugs. Tweak some error messages. Don't #include sys/param.h and stdio.h in fetch.h. Document that sys/param.h and stdio.h must be #included before fetch.h.
1998-12-16 10:24:55 +00:00
/* Last error code */
Reindent, and add parentheses to return statements. Some functions in ftp.c and http.c now have exceedingly long lines due to deep nesting; this will be corrected by reorganizing the code in a later revision.
2002-02-05 22:13:51 +00:00
extern int fetchLastErrCode;
Dump com_err, it's a stinking crock of shit.
2000-05-25 16:24:31 +00:00
#define MAXERRSTRING 256
Reindent, and add parentheses to return statements. Some functions in ftp.c and http.c now have exceedingly long lines due to deep nesting; this will be corrected by reorganizing the code in a later revision.
2002-02-05 22:13:51 +00:00
extern char fetchLastErrString[MAXERRSTRING];
/* I/O timeout */
extern int fetchTimeout;
/* Restart interrupted syscalls */
extern int fetchRestartCalls;
Add verbose flag, and support functions. Brucify the Makefile. Differentiate atime and mtime in fetch*Stat(). Fix a few pointer bugs. Tweak some error messages. Don't #include sys/param.h and stdio.h in fetch.h. Document that sys/param.h and stdio.h must be #included before fetch.h.
1998-12-16 10:24:55 +00:00
Introduce a fetchDebug global. Change the DEBUG macro so it only runs the debugging code if fetchDebug is set. PR: bin/32615 MFC after: 1 week
2001-12-09 15:05:19 +00:00
/* Extra verbosity */
Reindent, and add parentheses to return statements. Some functions in ftp.c and http.c now have exceedingly long lines due to deep nesting; this will be corrected by reorganizing the code in a later revision.
2002-02-05 22:13:51 +00:00
extern int fetchDebug;
Introduce a fetchDebug global. Change the DEBUG macro so it only runs the debugging code if fetchDebug is set. PR: bin/32615 MFC after: 1 week
2001-12-09 15:05:19 +00:00
Imported libfetch into the tree. It compiles, but there's still some work to do. I especially need help with the man page.
1998-07-09 16:52:44 +00:00
#endif
Reference in New Issue Copy Permalink