freebsd-nq/lib/libfetch/http.c
Dag-Erling Smørgrav d8acd8dc5c 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

469 lines
12 KiB
C

/*-
* Copyright (c) 1998 Dag-Erling Coïdan Smørgrav
* 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: http.c,v 1.6 1998/11/05 19:48:17 des Exp $
*/
/*
* The base64 code in this file is based on code from MIT fetch, which
* has the following copyright and license:
*
*-
* Copyright 1997 Massachusetts Institute of Technology
*
* Permission to use, copy, modify, and distribute this software and
* its documentation for any purpose and without fee is hereby
* granted, provided that both the above copyright notice and this
* permission notice appear in all copies, that both the above
* copyright notice and this permission notice appear in all
* supporting documentation, and that the name of M.I.T. not be used
* in advertising or publicity pertaining to distribution of the
* software without specific, written prior permission. M.I.T. makes
* no representations about the suitability of this software for any
* purpose. It is provided "as is" without express or implied
* warranty.
*
* THIS SOFTWARE IS PROVIDED BY M.I.T. ``AS IS''. M.I.T. DISCLAIMS
* ALL EXPRESS OR IMPLIED WARRANTIES WITH REGARD TO THIS SOFTWARE,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT
* SHALL M.I.T. 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. */
#include <sys/param.h>
#include <sys/errno.h>
#include <sys/socket.h>
#include <sys/types.h>
#include <netinet/in.h>
#include <err.h>
#include <ctype.h>
#include <netdb.h>
#include <stdarg.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include "fetch.h"
#include "common.h"
#include "httperr.inc"
#ifndef NDEBUG
#define DEBUG(x) do x; while (0)
#else
#define DEBUG(x) do { } while (0)
#endif
extern char *__progname;
#define ENDL "\r\n"
struct cookie
{
FILE *real_f;
#define ENC_NONE 0
#define ENC_CHUNKED 1
int encoding; /* 1 = chunked, 0 = none */
#define HTTPCTYPELEN 59
char content_type[HTTPCTYPELEN+1];
char *buf;
int b_cur, eof;
unsigned b_len, chunksize;
};
/*
* Send a formatted line; optionally echo to terminal
*/
static int
_http_cmd(FILE *f, char *fmt, ...)
{
va_list ap;
va_start(ap, fmt);
vfprintf(f, fmt, ap);
#ifndef NDEBUG
fprintf(stderr, "\033[1m>>> ");
vfprintf(stderr, fmt, ap);
fprintf(stderr, "\033[m");
#endif
va_end(ap);
return 0; /* XXX */
}
/*
* Fill the input buffer, do chunk decoding on the fly
*/
static char *
_http_fillbuf(struct cookie *c)
{
char *ln;
unsigned int len;
if (c->eof)
return NULL;
if (c->encoding == ENC_NONE) {
c->buf = fgetln(c->real_f, &(c->b_len));
c->b_cur = 0;
} else if (c->encoding == ENC_CHUNKED) {
if (c->chunksize == 0) {
ln = fgetln(c->real_f, &len);
DEBUG(fprintf(stderr, "\033[1m_http_fillbuf(): new chunk: "
"%*.*s\033[m\n", (int)len-2, (int)len-2, ln));
sscanf(ln, "%x", &(c->chunksize));
if (!c->chunksize) {
DEBUG(fprintf(stderr, "\033[1m_http_fillbuf(): "
"end of last chunk\033[m\n"));
c->eof = 1;
return NULL;
}
DEBUG(fprintf(stderr, "\033[1m_http_fillbuf(): "
"new chunk: %X\033[m\n", c->chunksize));
}
c->buf = fgetln(c->real_f, &(c->b_len));
if (c->b_len > c->chunksize)
c->b_len = c->chunksize;
c->chunksize -= c->b_len;
c->b_cur = 0;
}
else return NULL; /* unknown encoding */
return c->buf;
}
/*
* Read function
*/
static int
_http_readfn(struct cookie *c, char *buf, int len)
{
int l, pos = 0;
while (len) {
/* empty buffer */
if (!c->buf || (c->b_cur == c->b_len))
if (!_http_fillbuf(c))
break;
l = c->b_len - c->b_cur;
if (len < l) l = len;
memcpy(buf + pos, c->buf + c->b_cur, l);
c->b_cur += l;
pos += l;
len -= l;
}
if (ferror(c->real_f))
return -1;
else return pos;
}
/*
* Write function
*/
static int
_http_writefn(struct cookie *c, const char *buf, int len)
{
size_t r = fwrite(buf, 1, (size_t)len, c->real_f);
return r ? r : -1;
}
/*
* Close function
*/
static int
_http_closefn(struct cookie *c)
{
int r = fclose(c->real_f);
free(c);
return (r == EOF) ? -1 : 0;
}
/*
* Extract content type from cookie
*/
char *
fetchContentType(FILE *f)
{
/*
* We have no way of making sure this really *is* one of our cookies,
* so just check for a null pointer and hope for the best.
*/
return f->_cookie ? (((struct cookie *)f->_cookie)->content_type) : NULL;
}
/*
* Base64 encoding
*/
int
_http_base64(char *dst, char *src, int l)
{
static const char base64[] =
"ABCDEFGHIJKLMNOPQRSTUVWXYZ"
"abcdefghijklmnopqrstuvwxyz"
"0123456789+/";
int t, r = 0;
while (l >= 3) {
t = (src[0] << 16) | (src[1] << 8) | src[2];
dst[0] = base64[(t >> 18) & 0x3f];
dst[1] = base64[(t >> 12) & 0x3f];
dst[2] = base64[(t >> 6) & 0x3f];
dst[3] = base64[(t >> 0) & 0x3f];
src += 3; l -= 3;
dst += 4; r += 4;
}
switch (l) {
case 2:
t = (src[0] << 16) | (src[1] << 8);
dst[0] = base64[(t >> 18) & 0x3f];
dst[1] = base64[(t >> 12) & 0x3f];
dst[2] = base64[(t >> 6) & 0x3f];
dst[3] = '=';
dst += 4;
r += 4;
break;
case 1:
t = src[0] << 16;
dst[0] = base64[(t >> 18) & 0x3f];
dst[1] = base64[(t >> 12) & 0x3f];
dst[2] = dst[3] = '=';
dst += 4;
r += 4;
break;
case 0:
break;
}
*dst = 0;
return r;
}
/*
* Encode username and password
*/
char *
_http_auth(char *usr, char *pwd)
{
int len, lu, lp;
char *str, *s;
lu = strlen(usr);
lp = strlen(pwd);
len = (lu * 4 + 2) / 3 /* user name, round up */
+ 1 /* colon */
+ (lp * 4 + 2) / 3 /* password, round up */
+ 1; /* null */
if ((s = str = (char *)malloc(len)) == NULL)
return NULL;
s += _http_base64(s, usr, lu);
*s++ = ':';
s += _http_base64(s, pwd, lp);
*s = 0;
return str;
}
/*
* Retrieve a file by HTTP
*/
FILE *
fetchGetHTTP(struct url *URL, char *flags)
{
int sd = -1, err, i, enc = ENC_NONE;
struct cookie *c;
char *ln, *p, *q;
FILE *f, *cf;
size_t len;
/* allocate cookie */
if ((c = calloc(1, sizeof(struct cookie))) == NULL)
return NULL;
/* check port */
if (!URL->port)
URL->port = 80; /* default HTTP port */
/* attempt to connect to proxy server */
if (getenv("HTTP_PROXY")) {
char *px, host[MAXHOSTNAMELEN];
int port = 3128; /* XXX I think 3128 is default... check? */
size_t len;
/* measure length */
px = getenv("HTTP_PROXY");
len = strcspn(px, ":");
/* get port (atoi is a little too tolerant perhaps?) */
if (px[len] == ':')
port = atoi(px+len+1);
/* get host name */
if (len >= MAXHOSTNAMELEN)
len = MAXHOSTNAMELEN - 1;
strncpy(host, px, len);
host[len] = 0;
/* connect */
sd = fetchConnect(host, port);
}
/* if no proxy is configured or could be contacted, try direct */
if (sd == -1) {
if ((sd = fetchConnect(URL->host, URL->port)) == -1)
goto ouch;
}
/* reopen as stream */
if ((f = fdopen(sd, "r+")) == NULL)
goto ouch;
c->real_f = f;
/* send request (proxies require absolute form, so use that) */
_http_cmd(f, "GET http://%s:%d%s HTTP/1.1" ENDL,
URL->host, URL->port, URL->doc);
/* start sending headers away */
if (URL->user[0] || URL->pwd[0]) {
char *auth_str = _http_auth(URL->user, URL->pwd);
if (!auth_str)
goto fouch;
_http_cmd(f, "Authorization: Basic %s" ENDL, auth_str);
free(auth_str);
}
_http_cmd(f, "Host: %s:%d" ENDL, URL->host, URL->port);
_http_cmd(f, "User-Agent: %s " _LIBFETCH_VER ENDL, __progname);
_http_cmd(f, "Connection: close" ENDL ENDL);
/* get response */
if ((ln = fgetln(f, &len)) == NULL)
goto fouch;
DEBUG(fprintf(stderr, "response: [\033[1m%*.*s\033[m]\n",
(int)len-2, (int)len-2, ln));
/* we can't use strchr() and friends since ln isn't NUL-terminated */
p = ln;
while ((p < ln + len) && !isspace(*p))
p++;
while ((p < ln + len) && !isdigit(*p))
p++;
if (!isdigit(*p))
goto fouch;
err = atoi(p);
DEBUG(fprintf(stderr, "code: [\033[1m%d\033[m]\n", err));
/* add code to handle redirects later */
if (err != 200) {
_http_seterr(err);
goto fouch;
}
/* browse through header */
while (1) {
if ((ln = fgetln(f, &len)) == NULL)
goto fouch;
if ((ln[0] == '\r') || (ln[0] == '\n'))
break;
DEBUG(fprintf(stderr, "header: [\033[1m%*.*s\033[m]\n",
(int)len-2, (int)len-2, ln));
#define XFERENC "Transfer-Encoding:"
if (strncasecmp(ln, XFERENC, sizeof(XFERENC)-1) == 0) {
p = ln + sizeof(XFERENC) - 1;
while ((p < ln + len) && isspace(*p))
p++;
for (q = p; (q < ln + len) && !isspace(*q); q++)
/* VOID */ ;
*q = 0;
if (strcasecmp(p, "chunked") == 0)
enc = ENC_CHUNKED;
DEBUG(fprintf(stderr, "xferenc: [\033[1m%s\033[m]\n", p));
#undef XFERENC
#define CONTTYPE "Content-Type:"
} else if (strncasecmp(ln, CONTTYPE, sizeof(CONTTYPE)-1) == 0) {
p = ln + sizeof(CONTTYPE) - 1;
while ((p < ln + len) && isspace(*p))
p++;
for (i = 0; p < ln + len; p++)
if (i < HTTPCTYPELEN)
c->content_type[i++] = *p;
do c->content_type[i--] = 0; while (isspace(c->content_type[i]));
DEBUG(fprintf(stderr, "conttype: [\033[1m%s\033[m]\n",
c->content_type));
#undef CONTTYPE
}
}
/* only body remains */
c->encoding = enc;
cf = funopen(c,
(int (*)(void *, char *, int))_http_readfn,
(int (*)(void *, const char *, int))_http_writefn,
(fpos_t (*)(void *, fpos_t, int))NULL,
(int (*)(void *))_http_closefn);
if (cf == NULL)
goto fouch;
return cf;
ouch:
if (sd >= 0)
close(sd);
free(c);
return NULL;
fouch:
fclose(f);
free(c);
return NULL;
}
FILE *
fetchPutHTTP(struct url *URL, char *flags)
{
warnx("fetchPutHTTP(): not implemented");
return NULL;
}
/*
* Get an HTTP document's metadata
*/
int
fetchStatHTTP(struct url *url, struct url_stat *us, char *flags)
{
warnx("fetchStatHTTP(): not implemented");
return -1;
}