/*

 * $LynxId: HTVMS_WaisProt.c,v 1.9 2010/09/24 23:51:22 tom Exp $

 *

 *							  HTVMS_WAISProt.c

 *

 *	Adaptation for Lynx by F.Macrides (macrides@sci.wfeb.edu)

 *

 *	31-May-1994 FM	Initial version.

 *

 *----------------------------------------------------------------------*/

/*

 *	Routines originally from WProt.c -- FM

 *

 *----------------------------------------------------------------------*/

/* WIDE AREA INFORMATION SERVER SOFTWARE:

 * No guarantees or restrictions.  See the readme file for the full standard

 * disclaimer.

 * 3.26.90	Harry Morris, morris@think.com

 * 3.30.90  Harry Morris

 * -	removed chunk code from WAISSearchAPDU,

 * -	added makeWAISQueryType1Query() and readWAISType1Query() which replace

 * makeWAISQueryTerms() and makeWAISQueryDocs().

 * 4.11.90  HWM - generalized conditional includes (see c-dialect.h)

 * - renamed makeWAISType1Query() to makeWAISTextQuery()

 * renamed readWAISType1Query() to readWAISTextQuery()

 * 5.29.90  TS - fixed bug in makeWAISQueryDocs

 * added CSTFreeWAISFoo functions

 */

#define _C_WAIS_protocol_

/*	This file implements the Z39.50 extensions required for WAIS

*/

#include <HTUtils.h>

#include <HTVMS_WaisUI.h>

#include <HTVMS_WaisProt.h>

#include <LYLeaks.h>

/* very rough estimates of the size of an object */

#define DefWAISInitResponseSize		(size_t)200

#define DefWAISSearchSize			(size_t)3000

#define DefWAISSearchResponseSize	(size_t)6000

#define DefWAISPresentSize			(size_t)1000

#define DefWAISPresentResponseSize	(size_t)6000

#define DefWAISDocHeaderSize		(size_t)500

#define DefWAISShortHeaderSize		(size_t)200

#define DefWAISLongHeaderSize		(size_t)800

#define DefWAISDocTextSize			(size_t)6000

#define DefWAISDocHeadlineSize		(size_t)500

#define DefWAISDocCodeSize			(size_t)500

#define RESERVE_SPACE_FOR_WAIS_HEADER(len)	\

     if (*len > 0)				\

	*len -= header_len;

#define S_MALLOC(type) (type*)s_malloc(sizeof(type))

#define S_MALLOC2(type) (type*)s_malloc(sizeof(type) * 2)

#define S_REALLOC2(type, ptr, num) (type*)s_realloc((char*)ptr, (sizeof(type) * (num + 2)))

/*----------------------------------------------------------------------*/

static unsigned long userInfoTagSize(data_tag tag,

				     unsigned long length)

/* return the number of bytes required to write the user info tag and

   length

 */

{

    unsigned long size;

    /* calculate bytes required to represent tag.  max tag is 16K */

    size = writtenCompressedIntSize(tag);

    size += writtenCompressedIntSize(length);

    return (size);

}

/*----------------------------------------------------------------------*/

static char *writeUserInfoHeader(data_tag tag,

				 long infoSize,

				 long estHeaderSize,

				 char *buffer,

				 long *len)

/* write the tag and size, making sure the info fits.  return the true end

   of the info (after adjustment) note that the argument infoSize includes

   estHeaderSize.  Note that the argument len is the number of bytes remaining

   in the buffer.  Since we write the tag and size at the begining of the

   buffer (in space that we reserved) we don't want to pass len the calls which

   do that writing.

 */

{

    long dummyLen = 100;	/* plenty of space for a tag and size */

    char *buf = buffer;

    long realSize = infoSize - estHeaderSize;

    long realHeaderSize = userInfoTagSize(tag, realSize);

    if (buffer == NULL || *len == 0)

	return (NULL);

    /* write the tag */

    buf = writeTag(tag, buf, &dummyLen);

    /* see if the if the header size was correct. if not,

       we have to shift the info to fit the real header size */

    if (estHeaderSize != realHeaderSize) {	/* make sure there is enough space */

	CHECK_FOR_SPACE_LEFT(realHeaderSize - estHeaderSize, len);

	memmove(buffer + realHeaderSize, buffer + estHeaderSize, (size_t) (realSize));

    }

    /* write the size */

    writeCompressedInteger(realSize, buf, &dummyLen);

    /* return the true end of buffer */

    return (buffer + realHeaderSize + realSize);

}

/*----------------------------------------------------------------------*/

static char *readUserInfoHeader(data_tag *tag,

				unsigned long *num,

				char *buffer)

/* read the tag and size */

{

    char *buf = buffer;

    buf = readTag(tag, buf);

    buf = readCompressedInteger(num, buf);

    return (buf);

}

/*----------------------------------------------------------------------*/

WAISInitResponse *makeWAISInitResponse(long chunkCode,

				       long chunkIDLen,

				       char *chunkMarker,

				       char *highlightMarker,

				       char *deHighlightMarker,

				       char *newLineChars)

/* create a WAIS init response object */

{

    WAISInitResponse *init = S_MALLOC(WAISInitResponse);

    init->ChunkCode = chunkCode;	/* note: none are copied! */

    init->ChunkIDLength = chunkIDLen;

    init->ChunkMarker = chunkMarker;

    init->HighlightMarker = highlightMarker;

    init->DeHighlightMarker = deHighlightMarker;

    init->NewlineCharacters = newLineChars;

    return (init);

}

/*----------------------------------------------------------------------*/

void freeWAISInitResponse(WAISInitResponse *init)

/* free an object made with makeWAISInitResponse */

{

    s_free(init->ChunkMarker);

    s_free(init->HighlightMarker);

    s_free(init->DeHighlightMarker);

    s_free(init->NewlineCharacters);

    s_free(init);

}

/*----------------------------------------------------------------------*/

char *writeInitResponseInfo(InitResponseAPDU *init,

			    char *buffer,

			    long *len)

/* write an init response object */

{

    unsigned long header_len = userInfoTagSize(DT_UserInformationLength,

					       DefWAISInitResponseSize);

    char *buf = buffer + header_len;

    WAISInitResponse *info = (WAISInitResponse *) init->UserInformationField;

    unsigned long size;

    RESERVE_SPACE_FOR_WAIS_HEADER(len);

    buf = writeNum(info->ChunkCode, DT_ChunkCode, buf, len);

    buf = writeNum(info->ChunkIDLength, DT_ChunkIDLength, buf, len);

    buf = writeString(info->ChunkMarker, DT_ChunkMarker, buf, len);

    buf = writeString(info->HighlightMarker, DT_HighlightMarker, buf, len);

    buf = writeString(info->DeHighlightMarker, DT_DeHighlightMarker, buf, len);

    buf = writeString(info->NewlineCharacters, DT_NewlineCharacters, buf, len);

    /* now write the header and size */

    size = buf - buffer;

    buf = writeUserInfoHeader(DT_UserInformationLength,

			      size,

			      header_len,

			      buffer,

			      len);

    return (buf);

}

/*----------------------------------------------------------------------*/

char *readInitResponseInfo(void **info,

			   char *buffer)

/* read an init response object */

{

    char *buf = buffer;

    unsigned long size;

    unsigned long headerSize;

    long chunkCode, chunkIDLen;

    data_tag tag1;

    char *chunkMarker = NULL;

    char *highlightMarker = NULL;

    char *deHighlightMarker = NULL;

    char *newLineChars = NULL;

    chunkCode = chunkIDLen = UNUSED;

    buf = readUserInfoHeader(&tag1, &size, buf);

    headerSize = buf - buffer;

    while (buf < (buffer + size + headerSize)) {

	data_tag tag = peekTag(buf);

	switch (tag) {

	case DT_ChunkCode:

	    buf = readNum(&chunkCode, buf);

	    break;

	case DT_ChunkIDLength:

	    buf = readNum(&chunkIDLen, buf);

	    break;

	case DT_ChunkMarker:

	    buf = readString(&chunkMarker, buf);

	    break;

	case DT_HighlightMarker:

	    buf = readString(&highlightMarker, buf);

	    break;

	case DT_DeHighlightMarker:

	    buf = readString(&deHighlightMarker, buf);

	    break;

	case DT_NewlineCharacters:

	    buf = readString(&newLineChars, buf);

	    break;

	default:

	    s_free(highlightMarker);

	    s_free(deHighlightMarker);

	    s_free(newLineChars);

	    REPORT_READ_ERROR(buf);

	    break;

	}

    }

    *info = (void *) makeWAISInitResponse(chunkCode, chunkIDLen, chunkMarker,

					  highlightMarker, deHighlightMarker,

					  newLineChars);

    return (buf);

}

/*----------------------------------------------------------------------*/

WAISSearch *makeWAISSearch(char *seedWords,

			   DocObj **docs,

			   char **textList,

			   long dateFactor,

			   char *beginDateRange,

			   char *endDateRange,

			   long maxDocsRetrieved)

/* create a type 3 query object */

{

    WAISSearch *query = S_MALLOC(WAISSearch);

    query->SeedWords = seedWords;	/* not copied! */

    query->Docs = docs;		/* not copied! */

    query->TextList = textList;	/* not copied! */

    query->DateFactor = dateFactor;

    query->BeginDateRange = beginDateRange;

    query->EndDateRange = endDateRange;

    query->MaxDocumentsRetrieved = maxDocsRetrieved;

    return (query);

}

/*----------------------------------------------------------------------*/

void freeWAISSearch(WAISSearch *query)

/* destroy an object made with makeWAISSearch() */

{

    void *ptr = NULL;

    long i;

    s_free(query->SeedWords);

    if (query->Docs != NULL)

	for (i = 0, ptr = (void *) query->Docs[i];

	     ptr != NULL;

	     ptr = (void *) query->Docs[++i])

	    freeDocObj((DocObj *) ptr);

    s_free(query->Docs);

    if (query->TextList != NULL)	/* XXX revisit when textlist is fully defined */

	for (i = 0, ptr = (void *) query->TextList[i];

	     ptr != NULL;

	     ptr = (void *) query->TextList[++i])

	    s_free(ptr);

    s_free(query->TextList);

    s_free(query->BeginDateRange);

    s_free(query->EndDateRange);

    s_free(query);

}

/*----------------------------------------------------------------------*/

DocObj *makeDocObjUsingWholeDocument(any *docID,

				     char *type)

/* construct a document object using byte chunks - only for use by

   servers */

{

    DocObj *doc = S_MALLOC(DocObj);

    doc->DocumentID = docID;	/* not copied! */

    doc->Type = type;		/* not copied! */

    doc->ChunkCode = CT_document;

    return (doc);

}

/*----------------------------------------------------------------------*/

DocObj *makeDocObjUsingLines(any *docID,

			     char *type,

			     long start,

			     long end)

/* construct a document object using line chunks - only for use by

   servers */

{

    DocObj *doc = S_MALLOC(DocObj);

    doc->ChunkCode = CT_line;

    doc->DocumentID = docID;	/* not copied */

    doc->Type = type;		/* not copied! */

    doc->ChunkStart.Pos = start;

    doc->ChunkEnd.Pos = end;

    return (doc);

}

/*----------------------------------------------------------------------*/

DocObj *makeDocObjUsingBytes(any *docID,

			     char *type,

			     long start,

			     long end)

/* construct a document object using byte chunks - only for use by

   servers */

{

    DocObj *doc = S_MALLOC(DocObj);

    doc->ChunkCode = CT_byte;

    doc->DocumentID = docID;	/* not copied */

    doc->Type = type;		/* not copied! */

    doc->ChunkStart.Pos = start;

    doc->ChunkEnd.Pos = end;

    return (doc);

}

/*----------------------------------------------------------------------*/

DocObj *makeDocObjUsingParagraphs(any *docID,

				  char *type,

				  any *start,

				  any *end)

/* construct a document object using byte chunks - only for use by

   servers */

{

    DocObj *doc = S_MALLOC(DocObj);

    doc->ChunkCode = CT_paragraph;

    doc->DocumentID = docID;	/* not copied */

    doc->Type = type;

    doc->ChunkStart.ID = start;

    doc->ChunkEnd.ID = end;

    return (doc);

}

/*----------------------------------------------------------------------*/

void freeDocObj(DocObj *doc)

/* free a docObj */

{

    freeAny(doc->DocumentID);

    s_free(doc->Type);

    if (doc->ChunkCode == CT_paragraph) {

	freeAny(doc->ChunkStart.ID);

	freeAny(doc->ChunkEnd.ID);

    }

    s_free(doc);

}

/*----------------------------------------------------------------------*/

static char *writeDocObj(DocObj *doc,

			 char *buffer,

			 long *len)

/* write as little as we can about the doc obj */

{

    char *buf = buffer;

    /* we alwasy have to write the id, but its tag depends on if its a chunk */

    if (doc->ChunkCode == CT_document)

	buf = writeAny(doc->DocumentID, DT_DocumentID, buf, len);

    else

	buf = writeAny(doc->DocumentID, DT_DocumentIDChunk, buf, len);

    if (doc->Type != NULL)

	buf = writeString(doc->Type, DT_TYPE, buf, len);

    switch (doc->ChunkCode) {

    case CT_document:

	/* do nothing - there is no chunk data */

	break;

    case CT_byte:

    case CT_line:

	buf = writeNum(doc->ChunkCode, DT_ChunkCode, buf, len);

	buf = writeNum(doc->ChunkStart.Pos, DT_ChunkStartID, buf, len);

	buf = writeNum(doc->ChunkEnd.Pos, DT_ChunkEndID, buf, len);

	break;

    case CT_paragraph:

	buf = writeNum(doc->ChunkCode, DT_ChunkCode, buf, len);

	buf = writeAny(doc->ChunkStart.ID, DT_ChunkStartID, buf, len);

	buf = writeAny(doc->ChunkEnd.ID, DT_ChunkEndID, buf, len);

	break;

    default:

	panic("Implementation error: unknown chuck type %ld",

	      doc->ChunkCode);

	break;

    }

    return (buf);

}

/*----------------------------------------------------------------------*/

static char *readDocObj(DocObj **doc,

			char *buffer)

/* read whatever we have about the new document */

{

    char *buf = buffer;

    data_tag tag;

    *doc = S_MALLOC(DocObj);

    tag = peekTag(buf);

    buf = readAny(&((*doc)->DocumentID), buf);

    if (tag == DT_DocumentID) {

	(*doc)->ChunkCode = CT_document;

	tag = peekTag(buf);

	if (tag == DT_TYPE)	/* XXX depends on DT_TYPE != what comes next */

	    buf = readString(&((*doc)->Type), buf);

	/* ChunkStart and ChunkEnd are undefined */

    } else if (tag == DT_DocumentIDChunk) {

	boolean readParagraphs = false;		/* for cleanup */

	tag = peekTag(buf);

	if (tag == DT_TYPE)	/* XXX depends on DT_TYPE != CT_FOO */

	    buf = readString(&((*doc)->Type), buf);

	buf = readNum(&((*doc)->ChunkCode), buf);

	switch ((*doc)->ChunkCode) {

	case CT_byte:

	case CT_line:

	    buf = readNum(&((*doc)->ChunkStart.Pos), buf);

	    buf = readNum(&((*doc)->ChunkEnd.Pos), buf);

	    break;

	case CT_paragraph:

	    buf = readAny(&((*doc)->ChunkStart.ID), buf);

	    buf = readAny(&((*doc)->ChunkEnd.ID), buf);

	    break;

	default:

	    freeAny((*doc)->DocumentID);

	    if (readParagraphs) {

		freeAny((*doc)->ChunkStart.ID);

		freeAny((*doc)->ChunkEnd.ID);

	    }

	    s_free(doc);

	    REPORT_READ_ERROR(buf);

	    break;

	}

    } else {

	freeAny((*doc)->DocumentID);

	s_free(*doc);

	REPORT_READ_ERROR(buf);

    }

    return (buf);

}

/*----------------------------------------------------------------------*/

char *writeSearchInfo(SearchAPDU *query,

		      char *buffer,

		      long *len)

/* write out a WAIS query (type 1 or 3) */

{

    if (strcmp(query->QueryType, QT_TextRetrievalQuery) == 0) {

	return (writeAny((any *) query->Query, DT_Query, buffer, len));

    } else {

	unsigned long header_len = userInfoTagSize(DT_UserInformationLength,

						   DefWAISSearchSize);

	char *buf = buffer + header_len;

	WAISSearch *info = (WAISSearch *) query->Query;

	unsigned long size;

	long i;

	RESERVE_SPACE_FOR_WAIS_HEADER(len);

	buf = writeString(info->SeedWords, DT_SeedWords, buf, len);

	if (info->Docs != NULL) {

	    for (i = 0; info->Docs[i] != NULL; i++) {

		buf = writeDocObj(info->Docs[i], buf, len);

	    }

	}

	/* XXX text list */

	buf = writeNum(info->DateFactor,

		       DT_DateFactor,

		       buf,

		       len);

	buf = writeString(info->BeginDateRange,

			  DT_BeginDateRange,

			  buf,

			  len);

	buf = writeString(info->EndDateRange,

			  DT_EndDateRange,

			  buf,

			  len);

	buf = writeNum(info->MaxDocumentsRetrieved,

		       DT_MaxDocumentsRetrieved,

		       buf,

		       len);

	/* now write the header and size */

	size = buf - buffer;

	buf = writeUserInfoHeader(DT_UserInformationLength,

				  size,

				  header_len,

				  buffer,

				  len);

	return (buf);

    }

}

/*----------------------------------------------------------------------*/

char *readSearchInfo(void **info,

		     char *buffer)

/* read a WAIS query (type 1 or 3) */

{

    data_tag type = peekTag(buffer);

    if (type == DT_Query)	/* this is a type 1 query */

    {

	char *buf = buffer;

	any *query = NULL;

	buf = readAny(&query, buf);

	*info = (void *) query;

	return (buf);

    } else {			/* a type 3 query */

	char *buf = buffer;

	unsigned long size;

	unsigned long headerSize;

	data_tag tag1;

	char *seedWords = NULL;

	char *beginDateRange = NULL;

	char *endDateRange = NULL;

	long dateFactor, maxDocsRetrieved;

	char **textList = NULL;

	DocObj **docIDs = NULL;

	DocObj *doc = NULL;

	long docs = 0;

	long i;

	void *ptr = NULL;

	dateFactor = maxDocsRetrieved = UNUSED;

	buf = readUserInfoHeader(&tag1, &size, buf);

	headerSize = buf - buffer;

	while (buf < (buffer + size + headerSize)) {

	    data_tag tag = peekTag(buf);

	    switch (tag) {

	    case DT_SeedWords:

		buf = readString(&seedWords, buf);

		break;

	    case DT_DocumentID:

	    case DT_DocumentIDChunk:

		if (docIDs == NULL)	/* create a new doc list */

		{

		    docIDs = S_MALLOC2(DocObj *);

		} else {	/* grow the doc list */

		    docIDs = S_REALLOC2(DocObj *, docIDs, docs);

		}

		buf = readDocObj(&doc, buf);

		if (buf == NULL) {

		    s_free(seedWords);

		    s_free(beginDateRange);

		    s_free(endDateRange);

		    if (docIDs != NULL)

			for (i = 0, ptr = (void *) docIDs[i];

			     ptr != NULL;

			     ptr = (void *) docIDs[++i])

			    freeDocObj((DocObj *) ptr);

		    s_free(docIDs);

		    /* XXX should also free textlist when it is fully defined */

		}

		RETURN_ON_NULL(buf);

		docIDs[docs++] = doc;	/* put it in the list */

		docIDs[docs] = NULL;

		break;

	    case DT_TextList:

		/* XXX */

		break;

	    case DT_DateFactor:

		buf = readNum(&dateFactor, buf);

		break;

	    case DT_BeginDateRange:

		buf = readString(&beginDateRange, buf);

		break;

	    case DT_EndDateRange:

		buf = readString(&endDateRange, buf);

		break;

	    case DT_MaxDocumentsRetrieved:

		buf = readNum(&maxDocsRetrieved, buf);

		break;

	    default:

		s_free(seedWords);

		s_free(beginDateRange);

		s_free(endDateRange);

		if (docIDs != NULL)

		    for (i = 0, ptr = (void *) docIDs[i];

			 ptr != NULL;

			 ptr = (void *) docIDs[++i])

			freeDocObj((DocObj *) ptr);

		s_free(docIDs);

		/* XXX should also free textlist when it is fully defined */

		REPORT_READ_ERROR(buf);

		break;

	    }

	}

	*info = (void *) makeWAISSearch(seedWords, docIDs, textList,

					dateFactor, beginDateRange, endDateRange,

					maxDocsRetrieved);

	return (buf);

    }

}

/*----------------------------------------------------------------------*/

WAISDocumentHeader *makeWAISDocumentHeader(any *docID,

					   long versionNumber,

					   long score,

					   long bestMatch,

					   long docLen,

					   long lines,

					   char **types,

					   char *source,

					   char *date,

					   char *headline,

					   char *originCity)

/* construct a standard document header, note that no fields are copied!

   if the application needs to save these fields, it should copy them,

   or set the field in this object to NULL before freeing it.

 */

{

    WAISDocumentHeader *header = S_MALLOC(WAISDocumentHeader);

    header->DocumentID = docID;

    header->VersionNumber = versionNumber;

    header->Score = score;

    header->BestMatch = bestMatch;

    header->DocumentLength = docLen;

    header->Lines = lines;

    header->Types = types;

    header->Source = source;

    header->Date = date;

    header->Headline = headline;

    header->OriginCity = originCity;

    return (header);

}

/*----------------------------------------------------------------------*/

void freeWAISDocumentHeader(WAISDocumentHeader *header)

{

    freeAny(header->DocumentID);

    doList((void **) header->Types, fs_free);	/* can't use the macro here ! */

    s_free(header->Types);

    s_free(header->Source);

    s_free(header->Date);

    s_free(header->Headline);

    s_free(header->OriginCity);

    s_free(header);

}

/*----------------------------------------------------------------------*/

char *writeWAISDocumentHeader(WAISDocumentHeader *header, char *buffer,

			      long *len)

{

    unsigned long header_len = userInfoTagSize(DT_DocumentHeaderGroup,

					       DefWAISDocHeaderSize);

    char *buf = buffer + header_len;

    unsigned long size1;

    RESERVE_SPACE_FOR_WAIS_HEADER(len);

    buf = writeAny(header->DocumentID, DT_DocumentID, buf, len);

    buf = writeNum(header->VersionNumber, DT_VersionNumber, buf, len);

    buf = writeNum(header->Score, DT_Score, buf, len);

    buf = writeNum(header->BestMatch, DT_BestMatch, buf, len);

    buf = writeNum(header->DocumentLength, DT_DocumentLength, buf, len);

    buf = writeNum(header->Lines, DT_Lines, buf, len);

    if (header->Types != NULL) {

	long size;

	char *ptr = NULL;

	long i;

	buf = writeTag(DT_TYPE_BLOCK, buf, len);

	for (i = 0, size = 0, ptr = header->Types[i];

	     ptr != NULL;

	     ptr = header->Types[++i]) {

	    long typeSize = strlen(ptr);

	    size += writtenTagSize(DT_TYPE);

	    size += writtenCompressedIntSize(typeSize);

	    size += typeSize;

	}

	buf = writeCompressedInteger((unsigned long) size, buf, len);

	for (i = 0, ptr = header->Types[i]; ptr != NULL; ptr = header->Types[++i])

	    buf = writeString(ptr, DT_TYPE, buf, len);

    }

    buf = writeString(header->Source, DT_Source, buf, len);

    buf = writeString(header->Date, DT_Date, buf, len);

    buf = writeString(header->Headline, DT_Headline, buf, len);

    buf = writeString(header->OriginCity, DT_OriginCity, buf, len);

    /* now write the header and size */

    size1 = buf - buffer;

    buf = writeUserInfoHeader(DT_DocumentHeaderGroup,

			      size1,

			      header_len,

			      buffer,

			      len);

    return (buf);

}

/*----------------------------------------------------------------------*/

char *readWAISDocumentHeader(WAISDocumentHeader **header, char *buffer)

{

    char *buf = buffer;

    unsigned long size1;

    unsigned long headerSize;

    data_tag tag1;

    any *docID = NULL;

    long versionNumber, score, bestMatch, docLength, lines;

    char **types = NULL;

    char *source = NULL;

    char *date = NULL;

    char *headline = NULL;

    char *originCity = NULL;

    versionNumber = score = bestMatch = docLength = lines = UNUSED;

    buf = readUserInfoHeader(&tag1, &size1, buf);

    headerSize = buf - buffer;

    while (buf < (buffer + size1 + headerSize)) {

	data_tag tag = peekTag(buf);

	switch (tag) {

	case DT_DocumentID:

	    buf = readAny(&docID, buf);

	    break;

	case DT_VersionNumber:

	    buf = readNum(&versionNumber, buf);

	    break;

	case DT_Score:

	    buf = readNum(&score, buf);

	    break;

	case DT_BestMatch:

	    buf = readNum(&bestMatch, buf);

	    break;

	case DT_DocumentLength:

	    buf = readNum(&docLength, buf);

	    break;

	case DT_Lines:

	    buf = readNum(&lines, buf);

	    break;

	case DT_TYPE_BLOCK:

	    {

		unsigned long size = -1;

		long numTypes = 0;

		buf = readTag(&tag, buf);

		buf = readCompressedInteger(&size, buf);

		while (size > 0) {

		    char *type = NULL;

		    char *originalBuf = buf;

		    buf = readString(&type, buf);

		    types = S_REALLOC2(char *, types, numTypes);

		    types[numTypes++] = type;

		    types[numTypes] = NULL;

		    size -= (buf - originalBuf);

		}

	    }

	    /* FALLTHRU */

	case DT_Source:

	    buf = readString(&source, buf);

	    break;

	case DT_Date:

	    buf = readString(&date, buf);

	    break;

	case DT_Headline:

	    buf = readString(&headline, buf);

	    break;

	case DT_OriginCity:

	    buf = readString(&originCity, buf);

	    break;

	default:

	    freeAny(docID);

	    s_free(source);

	    s_free(date);

	    s_free(headline);

	    s_free(originCity);

	    REPORT_READ_ERROR(buf);

	    break;

	}

    }

    *header = makeWAISDocumentHeader(docID, versionNumber, score, bestMatch,

				     docLength, lines, types, source, date, headline,

				     originCity);

    return (buf);

}

/*----------------------------------------------------------------------*/

WAISDocumentShortHeader *makeWAISDocumentShortHeader(any *docID,

						     long versionNumber,

						     long score,

						     long bestMatch,

						     long docLen,

						     long lines)

/* construct a short document header, note that no fields are copied!

   if the application needs to save these fields, it should copy them,

   or set the field in this object to NULL before freeing it.

 */