lib/libfetch/common.h

   1 /*-
   2  * Copyright (c) 1998 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$
  29  */
  30
  31 #ifndef _COMMON_H_INCLUDED
  32 #define _COMMON_H_INCLUDED
  33
  34 #define FTP_DEFAULT_PORT        21
  35 #define HTTP_DEFAULT_PORT       80
  36 #define FTP_DEFAULT_PROXY_PORT  21
  37 #define HTTP_DEFAULT_PROXY_PORT 3128
  38
  39 /* Structure used for error message lists */
  40 struct fetcherr {
  41     const int num, cat;
  42     const char *string;
  43 };
  44
  45 void             _fetch_seterr(struct fetcherr *p, int e);
  46 void             _fetch_syserr(void);
  47 void             _fetch_info(const char *fmt, ...);
  48 int              _fetch_default_port(const char *);
  49 int              _fetch_default_proxy_port(const char *);
  50 int              _fetch_connect(const char *host, int port, int af, int verbose);
  51 int              _fetch_getln(int fd, char **buf, size_t *size, size_t *len);
  52 int              _fetch_putln(int fd, const char *str, size_t len);
  53 int              _fetch_add_entry(struct url_ent **p, int *size, int *len,
  54                                   const char *name, struct url_stat *stat);
  55
  56 #define _ftp_seterr(n)   _fetch_seterr(_ftp_errlist, n)
  57 #define _http_seterr(n)  _fetch_seterr(_http_errlist, n)
  58 #define _netdb_seterr(n) _fetch_seterr(_netdb_errlist, n)
  59 #define _url_seterr(n)   _fetch_seterr(_url_errlist, n)
  60
  61 #ifndef NDEBUG
  62 #define DEBUG(x) do x; while (0)
  63 #else
  64 #define DEBUG(x) do { } while (0)
  65 #endif
  66
  67 /*
  68  * I don't really like exporting _http_request() from http.c, but ftp.c
  69  * occasionally needs to use an HTTP proxy, and this saves me from adding
  70  * a lot of special-case code to http.c to handle those cases.
  71  *
  72  * Note that _http_request() frees purl, which is way ugly but saves us a
  73  * whole lot of trouble.
  74  */
  75 FILE            *_http_request(struct url *URL, const char *op,
  76                                 struct url_stat *us, struct url *purl,
  77                                 const char *flags);
  78
  79 /*
  80  * Check whether a particular flag is set
  81  */
  82 #define CHECK_FLAG(x)   (flags && strchr(flags, (x)))
  83
  84 #endif