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.27 2008/12/15 08:27:44 murray Exp $ 29 * $DragonFly: src/lib/libfetch/fetch.h,v 1.3 2007/08/05 21:48:12 swildner Exp $ 30 */ 31 32 #ifndef _FETCH_H_INCLUDED 33 #define _FETCH_H_INCLUDED 34 35 #define _LIBFETCH_VER "libfetch/2.0" 36 37 #define URL_SCHEMELEN 16 38 #define URL_USERLEN 256 39 #define URL_PWDLEN 256 40 41 struct url { 42 char scheme[URL_SCHEMELEN+1]; 43 char user[URL_USERLEN+1]; 44 char pwd[URL_PWDLEN+1]; 45 char host[MAXHOSTNAMELEN+1]; 46 int port; 47 char *doc; 48 off_t offset; 49 size_t length; 50 time_t ims_time; 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[PATH_MAX]; 61 struct url_stat stat; 62 }; 63 64 /* Recognized schemes */ 65 #define SCHEME_FTP "ftp" 66 #define SCHEME_HTTP "http" 67 #define SCHEME_HTTPS "https" 68 #define SCHEME_FILE "file" 69 70 /* Error codes */ 71 #define FETCH_ABORT 1 72 #define FETCH_AUTH 2 73 #define FETCH_DOWN 3 74 #define FETCH_EXISTS 4 75 #define FETCH_FULL 5 76 #define FETCH_INFO 6 77 #define FETCH_MEMORY 7 78 #define FETCH_MOVED 8 79 #define FETCH_NETWORK 9 80 #define FETCH_OK 10 81 #define FETCH_PROTO 11 82 #define FETCH_RESOLV 12 83 #define FETCH_SERVER 13 84 #define FETCH_TEMP 14 85 #define FETCH_TIMEOUT 15 86 #define FETCH_UNAVAIL 16 87 #define FETCH_UNKNOWN 17 88 #define FETCH_URL 18 89 #define FETCH_VERBOSE 19 90 91 __BEGIN_DECLS 92 93 /* FILE-specific functions */ 94 FILE *fetchXGetFile(struct url *, struct url_stat *, const char *); 95 FILE *fetchGetFile(struct url *, const char *); 96 FILE *fetchPutFile(struct url *, const char *); 97 int fetchStatFile(struct url *, struct url_stat *, const char *); 98 struct url_ent *fetchListFile(struct url *, const char *); 99 100 /* HTTP-specific functions */ 101 FILE *fetchXGetHTTP(struct url *, struct url_stat *, const char *); 102 FILE *fetchGetHTTP(struct url *, const char *); 103 FILE *fetchPutHTTP(struct url *, const char *); 104 int fetchStatHTTP(struct url *, struct url_stat *, const char *); 105 struct url_ent *fetchListHTTP(struct url *, const char *); 106 107 /* FTP-specific functions */ 108 FILE *fetchXGetFTP(struct url *, struct url_stat *, const char *); 109 FILE *fetchGetFTP(struct url *, const char *); 110 FILE *fetchPutFTP(struct url *, const char *); 111 int fetchStatFTP(struct url *, struct url_stat *, const char *); 112 struct url_ent *fetchListFTP(struct url *, const char *); 113 114 /* Generic functions */ 115 FILE *fetchXGetURL(const char *, struct url_stat *, const char *); 116 FILE *fetchGetURL(const char *, const char *); 117 FILE *fetchPutURL(const char *, const char *); 118 int fetchStatURL(const char *, struct url_stat *, const char *); 119 struct url_ent *fetchListURL(const char *, const char *); 120 FILE *fetchXGet(struct url *, struct url_stat *, const char *); 121 FILE *fetchGet(struct url *, const char *); 122 FILE *fetchPut(struct url *, const char *); 123 int fetchStat(struct url *, struct url_stat *, const char *); 124 struct url_ent *fetchList(struct url *, const char *); 125 126 /* URL parsing */ 127 struct url *fetchMakeURL(const char *, const char *, int, 128 const char *, const char *, const char *); 129 struct url *fetchParseURL(const char *); 130 void fetchFreeURL(struct url *); 131 132 __END_DECLS 133 134 /* Authentication */ 135 typedef int (*auth_t)(struct url *); 136 extern auth_t fetchAuthMethod; 137 138 /* Last error code */ 139 extern int fetchLastErrCode; 140 #define MAXERRSTRING 256 141 extern char fetchLastErrString[MAXERRSTRING]; 142 143 /* I/O timeout */ 144 extern int fetchTimeout; 145 146 /* Restart interrupted syscalls */ 147 extern int fetchRestartCalls; 148 149 /* Extra verbosity */ 150 extern int fetchDebug; 151 152 #endif 153