[0001]
[0002]
[0003]
[0004]
[0005]
[0006]
[0007]
[0008]
[0009]
[0010]
[0011]
[0012]
[0013]
[0014]
[0015]
[0016]
[0017]
[0018]
[0019]
[0020]
[0021]
[0022]
[0023]
[0024]
[0025]
[0026]
[0027]
[0028]
[0029]
[0030]
[0031]
[0032]
[0033]
[0034]
[0035]
[0036]
[0037]
[0038]
[0039]
[0040]
[0041]
[0042]
[0043]
[0044]
[0045]
[0046]
[0047]
[0048]
[0049]
[0050]
[0051]
[0052]
[0053]
[0054]
[0055]
[0056]
[0057]
[0058]
[0059]
[0060]
[0061]
[0062]
[0063]
[0064]
[0065]
[0066]
[0067]
[0068]
[0069]
[0070]
[0071]
[0072]
[0073]
[0074]
[0075]
[0076]
[0077]
[0078]
[0079]
[0080]
[0081]
[0082]
[0083]
[0084]
[0085]
[0086]
[0087]
[0088]
[0089]
[0090]
[0091]
[0092]
[0093]
[0094]
[0095]
[0096]
[0097]
[0098]
[0099]
[0100]
[0101]
[0102]
[0103]
[0104]
[0105]
[0106]
[0107]
[0108]
[0109]
[0110]
[0111]
[0112]
[0113]
[0114]
[0115]
[0116]
[0117]
[0118]
[0119]
[0120]
[0121]
[0122]
[0123]
[0124]
[0125]
[0126]
[0127]
[0128]
[0129]
[0130]
[0131]
[0132]
[0133]
[0134]
[0135]
[0136]
[0137]
[0138]
[0139]
[0140]
[0141]
[0142]
[0143]
[0144]
[0145]
[0146]
[0147]
[0148]
[0149]
[0150]
[0151]
[0152]
[0153]
[0154]
[0155]
[0156]
[0157]
[0158]
[0159]
[0160]
[0161]
[0162]
[0163]
[0164]
[0165]
[0166]
[0167]
[0168]
[0169]
[0170]
[0171]
[0172]
[0173]
[0174]
[0175]
[0176]
[0177]
[0178]
[0179]
[0180]
[0181]
[0182]
[0183]
[0184]
[0185]
[0186]
[0187]
[0188]
[0189]
/*****************************************************************************/
/*
                                  file.h
*/
/*****************************************************************************/

#ifndef FILE_H_LOADED
#define FILE_H_LOADED 1

#include "strdsc.h"
#include "wasd.h"

/**********/
/* macros */
/**********/

/* default maximum file size 2048 blocks, ~1MB */
#define FILE_TYPE_DEFAULT_SIZE_MAX 2048*512
/* maximum size of .ISMAP file, 64 blocks, ~32kB */
#define FILE_TYPE_ISMAP_SIZE_MAX 64*512
/* 64 blocks, ~32kB */
#define FILE_TYPE_MENU_SIZE_MAX 64*512
/* 256 blocks, ~128kB */
#define FILE_TYPE_README_SIZE_MAX 256*512
/* 256 blocks, ~128kB */
#define FILE_TYPE_SSI_SIZE_MAX 256*512
/* 16 blocks, ~8kB */
#define FILE_TYPE_URL_SIZE_MAX 16*512

/* ambit dynamically allocated string space when negotiating file language */
#define FILE_ACCEPT_LANG_SIZE 256

/* maximum size of language variant string (larger is obviously not) */
#define FILE_ACCEPT_LANG_VARIANT_MAX 5

#define FILE_VAR_ASIS    1  /* transferred EXACTLY as-is on disk */
/* when converting variable length records */
#define FILE_VAR_DEFAULT 2
#define FILE_VAR_CRLF    3
#define FILE_VAR_LF      4  /* default format also */
#define FILE_VAR_NONE    5

/**************/
/* structures */
/**************/

#pragma member_alignment __save
#pragma member_alignment

typedef struct FileContentsStruct FILE_CONTENT;

struct FileContentsStruct
{
   int  /* count during load, and final length of contents */
        ContentLength,
        /* contents buffer space remaining (complement to 'ContentLength') */
        ContentRemaining,
        /* contents buffer size (total originally allocated memory) */
        ContentSize,
        /* limit on content size */
        ContentSizeMax,
        /* fairly obvious */
        FileNameLength;

   int64  CdtTime64,
          RdtTime64;

   unsigned short  UicGroup,
                   UicMember,
                   Protection;

   char  /* buffer (pointer to allocated memory, see note below) */
         *ContentPtr,
         /* pointer to current position in buffer */
         *CurrentPtr;

   char  /* file name stored locally */
         FileName [ODS_MAX_FILE_NAME_LENGTH+1];

   REQUEST_AST  /* the address of the function processing this content */
                ContentHandlerFunction,
                /* passes on next task that was passed to FileBegin() */
                NextTaskFunction;

   /*  contents are straight after this and pointed to by 'ContentPtr' */
};

typedef struct FileTaskStruct FILE_TASK;

struct FileTaskStruct
{
   BOOL  /* a lower case alphabetic was detected in the file name */
         AcceptLangLowerCase,
         /* authorize the path to the filename before processing */
         AuthorizePath,
         /* caching of this file is allowed */
         CacheAllowed,
         /* when true HTML-forbidden characters are escaped */
         EscapeHtml,
         /* when true a file's contents are enclosed in <PRE></PRE> tags */
         PreTagFileContents,
         /* when a file's contents have been <PRE>ed, end with </PRE> tag */
         PreTagEndFileContents,
         /* WATCHed the type of variable record carriage-control */
         WatchVarRecordCC;

   int  /* current used from memory allocated */
        AcceptLangTypesLength,
        /* amount of memory allocated */
        AcceptLangTypesSize,
        /* size of buffer for escaping HTML */
        EscapeHtmlSize,
        /* maximum file size allowed when buffering a file's contents */
        FileContentsSizeMax,
        /* fairly obvious */
        FileNameLength,
        /* kludge for (so far) mysterious stall */
        NextBlocksTickSecond,
        /* note when a search-list has been searched for the file */
        SearchListCount,
        /* buffer for most recent task status */
        TaskStatusBuffer;

   char  /* HTTP/1.1 entity tag */
         EntityTag [ENTITY_TAG_MAX+1],
         /* file name stored locally */
         FileName [ODS_MAX_FILE_NAME_LENGTH+1];

   char  /* points to where the language variant wildcard was added */
         *AcceptLangVariantPtr,
         /* when negotiating language contains searched-for types */
         *AcceptLangTypesPtr,
         /* pointer to MIME content-type */
         *ContentTypePtr;

   /* MD5 hash of the resource */
   MD5_HASH  Md5Hash;

   /* structure for file system access */
   ODS_STRUCT  FileOds;

   /* structure used for escaping HTML */
   STR_DSC  BufferDsc;

   /* success and file-not-found handlers */
   REQUEST_AST  ContentHandlerFunction,
                NextTaskFunction,
                NoSuchFileFunction;
};

#pragma member_alignment __restore

/***********************/
/* function prototypes */
/***********************/

FileAcceptLangBegin (REQUEST_STRUCT*, char*);
FileAcceptLangDefault (REQUEST_STRUCT*);
FileAcceptLangParseAst (REQUEST_STRUCT*);
FileAcceptLangSearchAst (REQUEST_STRUCT*);
FileAcceptLangSelect (REQUEST_STRUCT*);
FileAccessAst (REQUEST_STRUCT*);
FileAcpInfo (REQUEST_STRUCT*);
FileAcpInfoAst (REQUEST_STRUCT*); 
FileAuthorizationAst (REQUEST_STRUCT*); 
FileBegin (REQUEST_STRUCT*, REQUEST_AST, REQUEST_AST, MD5_HASH*, char*, char*);
FileConnectAst (struct RAB*); 
FileContentsBuffer (REQUEST_STRUCT*, REQUEST_AST, char*, int);
FileEnd (REQUEST_STRUCT*);
FileFixedRecordNoSpan (REQUEST_STRUCT*);
FileGenerateEntityTag (char*, FILE_QIO*);
FileHttpHeader (REQUEST_STRUCT*, int, char*, int);
FileNextBlocks (REQUEST_STRUCT*);
FileNextBlocksAst (REQUEST_STRUCT*); 
FileOpen (FILE_TASK*); 
FileParse (REQUEST_STRUCT*); 
FileParseAst (REQUEST_STRUCT*); 
BOOL FileResponseHeader (REQUEST_STRUCT*, char*, int64, unsigned long*);
void FileSetAuthorizePath (REQUEST_STRUCT*, BOOL);
void FileSetCacheAllowed (REQUEST_STRUCT*, BOOL);
void FileSetContentHandler (REQUEST_STRUCT*, REQUEST_AST, int);
void FileSetEscapeHtml (REQUEST_STRUCT*, BOOL);
void FileSetPreTag (REQUEST_STRUCT*, BOOL);
char* FileSetCharset (REQUEST_STRUCT*, char*);
FileVariableRecord (REQUEST_STRUCT*);

#endif /* FILE_H_LOADED */

/*****************************************************************************/