gopher.cc File Reference

#include "squid.h"
#include "base/AsyncCbdataCalls.h"
#include "comm.h"
#include "comm/Read.h"
#include "comm/Write.h"
#include "errorpage.h"
#include "fd.h"
#include "FwdState.h"
#include "globals.h"
#include "gopher.h"
#include "html_quote.h"
#include "HttpReply.h"
#include "HttpRequest.h"
#include "MemBuf.h"
#include "mime.h"
#include "parser/Tokenizer.h"
#include "rfc1738.h"
#include "SquidConfig.h"
#include "StatCounters.h"
#include "Store.h"
#include "tools.h"
#include "DelayPools.h"
#include "MemObject.h"

Include dependency graph for gopher.cc:

Go to the source code of this file.

Classes
class	GopherStateData

Macros
#define	GOPHER_FILE   '0'
#define	GOPHER_DIRECTORY   '1'
#define	GOPHER_CSO   '2'
#define	GOPHER_ERROR   '3'
#define	GOPHER_MACBINHEX   '4'
#define	GOPHER_DOSBIN   '5'
#define	GOPHER_UUENCODED   '6'
#define	GOPHER_INDEX   '7'
#define	GOPHER_TELNET   '8'
#define	GOPHER_BIN   '9'
#define	GOPHER_REDUNT   '+'
#define	GOPHER_3270   'T'
#define	GOPHER_GIF   'g'
#define	GOPHER_IMAGE   'I'
#define	GOPHER_PLUS_IMAGE   ':'
#define	GOPHER_PLUS_MOVIE   ';'
#define	GOPHER_PLUS_SOUND   '<'
#define	GOPHER_HTML   'h'
#define	GOPHER_INFO   'i'
#define	GOPHER_WWW   'w'
#define	GOPHER_SOUND   's'
#define	GOPHER_PORT   70
#define	TAB   '\t'
#define	TEMP_BUF_SIZE   4096
#define	MAX_CSO_RESULT   1024

Functions
static void	gopherMimeCreate (GopherStateData *)
static void	gopher_request_parse (const HttpRequest *req, char *type_id, char *request)
static void	gopherEndHTML (GopherStateData *)
static void	gopherToHTML (GopherStateData *, char *inbuf, int len)
static void	gopherStateFree (const CommCloseCbParams &params)
int	gopherCachable (const HttpRequest *req)
static void	gopherHTMLHeader (StoreEntry *e, const char *title, const char *substring)
static void	gopherHTMLFooter (StoreEntry *e)
static void	gopherTimeout (const CommTimeoutCbParams &io)
static void	gopherReadReply (const Comm::ConnectionPointer &conn, char *buf, size_t len, Comm::Flag flag, int xerrno, void *data)
static void	gopherSendComplete (const Comm::ConnectionPointer &conn, char *, size_t size, Comm::Flag errflag, int xerrno, void *data)
static void	gopherSendRequest (int, void *data)
void	gopherStart (FwdState *fwd)

Variables
static CLCB	gopherStateFree
static CTCB	gopherTimeout
static IOCB	gopherReadReply
static IOCB	gopherSendComplete
static PF	gopherSendRequest
static char	def_gopher_bin [] = "www/unknown"
static char	def_gopher_text [] = "text/plain"

Macro Definition Documentation

GOPHER_3270

#define GOPHER_3270   'T'

Definition at line 50 of file gopher.cc.

GOPHER_BIN

#define GOPHER_BIN   '9'

Definition at line 48 of file gopher.cc.

GOPHER_CSO

#define GOPHER_CSO   '2'

Definition at line 41 of file gopher.cc.

GOPHER_DIRECTORY

#define GOPHER_DIRECTORY   '1'

Definition at line 40 of file gopher.cc.

GOPHER_DOSBIN

#define GOPHER_DOSBIN   '5'

Definition at line 44 of file gopher.cc.

GOPHER_ERROR

#define GOPHER_ERROR   '3'

Definition at line 42 of file gopher.cc.

GOPHER_FILE

#define GOPHER_FILE   '0'

Definition at line 39 of file gopher.cc.

GOPHER_GIF

#define GOPHER_GIF   'g'

Definition at line 51 of file gopher.cc.

GOPHER_HTML

#define GOPHER_HTML   'h'

Definition at line 61 of file gopher.cc.

GOPHER_IMAGE

#define GOPHER_IMAGE   'I'

Definition at line 52 of file gopher.cc.

GOPHER_INDEX

#define GOPHER_INDEX   '7'

Definition at line 46 of file gopher.cc.

GOPHER_INFO

#define GOPHER_INFO   'i'

Definition at line 62 of file gopher.cc.

GOPHER_MACBINHEX

#define GOPHER_MACBINHEX   '4'

Definition at line 43 of file gopher.cc.

GOPHER_PLUS_IMAGE

#define GOPHER_PLUS_IMAGE   ':'

Definition at line 56 of file gopher.cc.

GOPHER_PLUS_MOVIE

#define GOPHER_PLUS_MOVIE   ';'

Definition at line 57 of file gopher.cc.

GOPHER_PLUS_SOUND

#define GOPHER_PLUS_SOUND   '<'

Definition at line 58 of file gopher.cc.

GOPHER_PORT

#define GOPHER_PORT   70

Definition at line 66 of file gopher.cc.

GOPHER_REDUNT

#define GOPHER_REDUNT   '+'

Definition at line 49 of file gopher.cc.

GOPHER_SOUND

#define GOPHER_SOUND   's'

Definition at line 64 of file gopher.cc.

GOPHER_TELNET

#define GOPHER_TELNET   '8'

Definition at line 47 of file gopher.cc.

GOPHER_UUENCODED

#define GOPHER_UUENCODED   '6'

Definition at line 45 of file gopher.cc.

GOPHER_WWW

#define GOPHER_WWW   'w'

Definition at line 63 of file gopher.cc.

MAX_CSO_RESULT

#define MAX_CSO_RESULT   1024

Definition at line 73 of file gopher.cc.

TAB

#define TAB   '\t'

Definition at line 68 of file gopher.cc.

TEMP_BUF_SIZE

#define TEMP_BUF_SIZE   4096

Definition at line 71 of file gopher.cc.

Function Documentation

gopher_request_parse()

static void gopher_request_parse ( const HttpRequest *  req, char *  type_id, char *  request  )

static

Parse a gopher request into components. By Anawat.

Definition at line 311 of file gopher.cc.

References GOPHER_DIRECTORY, MAX_URL, AnyP::Uri::path(), request(), rfc1738_unescape(), SBufToCstring(), and HttpRequest::url.

Referenced by gopherCachable(), and gopherStart().

gopherEndHTML()

static void gopherEndHTML ( GopherStateData *  gopherState )

static

Definition at line 400 of file gopher.cc.

References GopherStateData::entry, gopherHTMLFooter(), gopherHTMLHeader(), GopherStateData::HTML_header_added, GopherStateData::HTML_pre, NULL, and storeAppendPrintf().

Referenced by gopherReadReply().

gopherHTMLFooter()

static void gopherHTMLFooter ( StoreEntry *  e )

static

Definition at line 388 of file gopher.cc.

References Time::FormatRfc1123(), getMyHostname(), squid_curtime, storeAppendPrintf(), and visible_appname_string.

Referenced by gopherEndHTML(), and gopherToHTML().

gopherHTMLHeader()

static void gopherHTMLHeader ( StoreEntry *  e, const char *  title, const char *  substring  )

static

Definition at line 375 of file gopher.cc.

References storeAppendPrintf().

Referenced by gopherEndHTML(), and gopherToHTML().

gopherMimeCreate()

static void gopherMimeCreate ( GopherStateData *  gopherState )

static

Create MIME Header for Gopher Data

Definition at line 233 of file gopher.cc.

References assert, StoreEntry::buffer(), Http::CONTENT_ENCODING, def_gopher_bin, def_gopher_text, GopherStateData::entry, GOPHER_BIN, GOPHER_CSO, GOPHER_DIRECTORY, GOPHER_DOSBIN, GOPHER_FILE, GOPHER_GIF, GOPHER_HTML, GOPHER_IMAGE, GOPHER_INDEX, GOPHER_MACBINHEX, GOPHER_PLUS_IMAGE, GOPHER_PLUS_MOVIE, GOPHER_PLUS_SOUND, GOPHER_SOUND, GOPHER_UUENCODED, GOPHER_WWW, Http::Message::header, StoreEntry::isEmpty(), mimeGetContentEncoding(), mimeGetContentType(), NULL, HttpHeader::putStr(), StoreEntry::replaceHttpReply(), GopherStateData::reply_, GopherStateData::request, Http::scOkay, HttpReply::setHeaders(), and GopherStateData::type_id.

Referenced by gopherSendComplete(), and gopherStart().

gopherReadReply()

static void gopherReadReply ( const Comm::ConnectionPointer &  conn, char *  buf, size_t  len, Comm::Flag  flag, int  xerrno, void *  data  )

static

This will be called when data is ready to be read from fd. Read until error or connection closed.

Definition at line 712 of file gopher.cc.

References FwdState::al, StatCounters::all, StoreEntry::append(), assert, HierarchyLogEntry::bodyBytesRead, BUFSIZ, DelayId::bytesIn(), DelayId::bytesWanted(), Comm::Connection::close(), comm_read(), commCbCall(), commSetConnTimeout(), FwdState::complete(), Config, conn, GopherStateData::conversion, DBG_IMPORTANT, debugs, GopherStateData::DelayAwareRead(), GopherStateData::entry, Comm::ERR_CLOSING, ERR_READ_ERROR, ERR_ZERO_SIZE_OBJECT, FwdState::fail(), StoreEntry::flush(), GopherStateData::fwd, IoStats::Gopher, gopherEndHTML(), gopherReadReply, gopherToHTML(), HttpRequest::hier, ignoreErrno(), IOStats, StoreEntry::isAccepting(), StoreEntry::isEmpty(), GopherStateData::len, FwdState::markStoredReplyAsWhole(), StoreEntry::mem_obj, MemObject::mostBytesAllowed(), MYNAME, Store::nil, GopherStateData::NORMAL, Comm::OK, StatCounters::other, GopherStateData::overflowed, SquidConfig::read, IoStats::read_hist, IoStats::reads, GopherStateData::reply_, GopherStateData::replybuf, FwdState::request, Http::scInternalServerError, Http::scServiceUnavailable, StatCounters::server, GopherStateData::serverConn, Http::Message::sources, Http::Message::srcGopher, statCounter, SquidConfig::Timeout, StoreEntry::timestampsSet(), and xstrerr().

gopherSendComplete()

static void gopherSendComplete ( const Comm::ConnectionPointer &  conn, char *  , size_t  size, Comm::Flag  errflag, int  xerrno, void *  data  )

static

This will be called when request write is complete. Schedule read of reply.

Definition at line 844 of file gopher.cc.

References FwdState::al, StatCounters::all, StoreEntry::buffer(), Comm::Connection::close(), conn, GopherStateData::conversion, GopherStateData::cso_recno, debugs, GopherStateData::DelayAwareRead(), GopherStateData::entry, ERR_WRITE_ERROR, FwdState::fail(), fd_bytes(), FD_WRITE, StoreEntry::flush(), GopherStateData::fwd, GOPHER_CSO, GOPHER_DIRECTORY, GOPHER_INDEX, gopherMimeCreate(), GopherStateData::HTML_CSO_RESULT, GopherStateData::HTML_DIR, GopherStateData::HTML_header_added, GopherStateData::HTML_INDEX_RESULT, StoreEntry::isAccepting(), GopherStateData::NORMAL, StatCounters::other, AnyP::Uri::port(), FwdState::request, Http::scServiceUnavailable, StatCounters::server, GopherStateData::serverConn, size, statCounter, GopherStateData::type_id, HttpRequest::url, StoreEntry::url(), and xstrdup.

gopherSendRequest()

static void gopherSendRequest ( int  , void *  data  )

static

This will be called when connect completes. Write request.

Definition at line 914 of file gopher.cc.

References MemBuf::append(), Packable::appendf(), commCbCall(), debugs, GopherStateData::entry, GOPHER_CSO, GOPHER_INDEX, gopherSendComplete, MemBuf::init(), StoreEntry::makePrivate(), StoreEntry::makePublic(), GopherStateData::request, GopherStateData::serverConn, GopherStateData::type_id, and Comm::Write().

gopherStateFree()

static void gopherStateFree ( const CommCloseCbParams &  params )

static

Definition at line 162 of file gopher.cc.

References CommCommonCbParams::data.

gopherTimeout()

static void gopherTimeout ( const CommTimeoutCbParams &  io )

static

Definition at line 696 of file gopher.cc.

References FwdState::al, Comm::Connection::close(), CommCommonCbParams::conn, CommCommonCbParams::data, debugs, GopherStateData::entry, ERR_READ_TIMEOUT, FwdState::fail(), GopherStateData::fwd, Comm::IsConnOpen(), FwdState::request, Http::scGatewayTimeout, and StoreEntry::url().

gopherToHTML()

static void gopherToHTML ( GopherStateData *  gopherState, char *  inbuf, int  len  )

static

Convert Gopher to HTML.

Borrow part of code from libwww2 came with Mosaic distribution.

Definition at line 420 of file gopher.cc.

References StoreEntry::append(), SBuf::append(), SBuf::appendf(), GopherStateData::buf, code, GopherStateData::conversion, GopherStateData::cso_recno, DBG_IMPORTANT, debugs, GopherStateData::entry, StoreEntry::flush(), GOPHER_3270, GOPHER_INFO, GOPHER_TELNET, GOPHER_WWW, gopherHTMLFooter(), gopherHTMLHeader(), GopherStateData::HTML_CSO_PAGE, GopherStateData::HTML_CSO_RESULT, GopherStateData::HTML_DIR, GopherStateData::HTML_header_added, GopherStateData::HTML_INDEX_PAGE, GopherStateData::HTML_INDEX_RESULT, GopherStateData::HTML_pre, html_quote(), GopherStateData::iconUrl(), GopherStateData::len, SBuf::length(), LOCAL_ARRAY, NULL, GopherStateData::overflowed, port, SBuf::rawContent(), rfc1738_escape_part, rfc1738_escape_unescaped, safe_free, storeAppendPrintf(), TAB, TEMP_BUF_SIZE, StoreEntry::url(), and xstrdup.

Referenced by gopherReadReply(), and gopherStart().

Variable Documentation

def_gopher_bin

char def_gopher_bin[] = "www/unknown"

static

Definition at line 157 of file gopher.cc.

Referenced by gopherMimeCreate().

def_gopher_text

char def_gopher_text[] = "text/plain"

static

Definition at line 159 of file gopher.cc.

Referenced by gopherMimeCreate().

gopherReadReply

IOCB gopherReadReply

static

Definition at line 153 of file gopher.cc.

Referenced by GopherStateData::DelayAwareRead(), and gopherReadReply().

gopherSendComplete

IOCB gopherSendComplete

static

Definition at line 154 of file gopher.cc.

Referenced by gopherSendRequest().

gopherSendRequest

PF gopherSendRequest

static

Definition at line 155 of file gopher.cc.

Referenced by gopherStart().

gopherStateFree

CLCB gopherStateFree

static

Definition at line 145 of file gopher.cc.

Referenced by gopherStart().

gopherTimeout

CTCB gopherTimeout

static

Definition at line 152 of file gopher.cc.

Referenced by gopherStart().