lib/libfetch/fetch.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1998-2004 Dag-Erling Smørgrav
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer
  12  *    in this position and unchanged.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  * 3. The name of the author may not be used to endorse or promote products
  17  *    derived from this software without specific prior written permission
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  20  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  21  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  22  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  23  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  24  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  28  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  *
  30  * $FreeBSD: head/lib/libfetch/fetch.h 326219 2017-11-26 02:00:33Z pfg $
  31  */
  32
  33 #ifndef _FETCH_H_INCLUDED
  34 #define _FETCH_H_INCLUDED
  35
  36 #define _LIBFETCH_VER "libfetch/2.0"
  37
  38 #define URL_SCHEMELEN 16
  39 #define URL_USERLEN 256
  40 #define URL_PWDLEN 256
  41
  42 struct url {
  43         char             scheme[URL_SCHEMELEN+1];
  44         char             user[URL_USERLEN+1];
  45         char             pwd[URL_PWDLEN+1];
  46         char             host[MAXHOSTNAMELEN+1];
  47         int              port;
  48         char            *doc;
  49         off_t            offset;
  50         size_t           length;
  51         time_t           ims_time;
  52         int              netrcfd;
  53 };
  54
  55 struct url_stat {
  56         off_t            size;
  57         time_t           atime;
  58         time_t           mtime;
  59 };
  60
  61 struct url_ent {
  62         char             name[PATH_MAX];
  63         struct url_stat  stat;
  64 };
  65
  66 /* Recognized schemes */
  67 #define SCHEME_FTP      "ftp"
  68 #define SCHEME_HTTP     "http"
  69 #define SCHEME_HTTPS    "https"
  70 #define SCHEME_FILE     "file"
  71
  72 /* Error codes */
  73 #define FETCH_ABORT      1
  74 #define FETCH_AUTH       2
  75 #define FETCH_DOWN       3
  76 #define FETCH_EXISTS     4
  77 #define FETCH_FULL       5
  78 #define FETCH_INFO       6
  79 #define FETCH_MEMORY     7
  80 #define FETCH_MOVED      8
  81 #define FETCH_NETWORK    9
  82 #define FETCH_OK        10
  83 #define FETCH_PROTO     11
  84 #define FETCH_RESOLV    12
  85 #define FETCH_SERVER    13
  86 #define FETCH_TEMP      14
  87 #define FETCH_TIMEOUT   15
  88 #define FETCH_UNAVAIL   16
  89 #define FETCH_UNKNOWN   17
  90 #define FETCH_URL       18
  91 #define FETCH_VERBOSE   19
  92
  93 __BEGIN_DECLS
  94
  95 /* FILE-specific functions */
  96 FILE            *fetchXGetFile(struct url *, struct url_stat *, const char *);
  97 FILE            *fetchGetFile(struct url *, const char *);
  98 FILE            *fetchPutFile(struct url *, const char *);
  99 int              fetchStatFile(struct url *, struct url_stat *, const char *);
 100 struct url_ent  *fetchListFile(struct url *, const char *);
 101
 102 /* HTTP-specific functions */
 103 FILE            *fetchXGetHTTP(struct url *, struct url_stat *, const char *);
 104 FILE            *fetchGetHTTP(struct url *, const char *);
 105 FILE            *fetchPutHTTP(struct url *, const char *);
 106 int              fetchStatHTTP(struct url *, struct url_stat *, const char *);
 107 struct url_ent  *fetchListHTTP(struct url *, const char *);
 108 FILE            *fetchReqHTTP(struct url *, const char *, const char *,
 109                     const char *, const char *);
 110
 111 /* FTP-specific functions */
 112 FILE            *fetchXGetFTP(struct url *, struct url_stat *, const char *);
 113 FILE            *fetchGetFTP(struct url *, const char *);
 114 FILE            *fetchPutFTP(struct url *, const char *);
 115 int              fetchStatFTP(struct url *, struct url_stat *, const char *);
 116 struct url_ent  *fetchListFTP(struct url *, const char *);
 117
 118 /* Generic functions */
 119 FILE            *fetchXGetURL(const char *, struct url_stat *, const char *);
 120 FILE            *fetchGetURL(const char *, const char *);
 121 FILE            *fetchPutURL(const char *, const char *);
 122 int              fetchStatURL(const char *, struct url_stat *, const char *);
 123 struct url_ent  *fetchListURL(const char *, const char *);
 124 FILE            *fetchXGet(struct url *, struct url_stat *, const char *);
 125 FILE            *fetchGet(struct url *, const char *);
 126 FILE            *fetchPut(struct url *, const char *);
 127 int              fetchStat(struct url *, struct url_stat *, const char *);
 128 struct url_ent  *fetchList(struct url *, const char *);
 129
 130 /* URL parsing */
 131 struct url      *fetchMakeURL(const char *, const char *, int,
 132                      const char *, const char *, const char *);
 133 struct url      *fetchParseURL(const char *);
 134 void             fetchFreeURL(struct url *);
 135
 136 __END_DECLS
 137
 138 /* Authentication */
 139 typedef int (*auth_t)(struct url *);
 140 extern auth_t            fetchAuthMethod;
 141
 142 /* Last error code */
 143 extern int               fetchLastErrCode;
 144 #define MAXERRSTRING 256
 145 extern char              fetchLastErrString[MAXERRSTRING];
 146
 147 /* I/O timeout */
 148 extern int               fetchTimeout;
 149
 150 /* Restart interrupted syscalls */
 151 extern int               fetchRestartCalls;
 152
 153 /* Extra verbosity */
 154 extern int               fetchDebug;
 155
 156 #endif