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