htmlfiles.h

Go to the documentation of this file.

/*NB_REVISION*/
 
/*NB_COPYRIGHT*/
 
/*-----------------------------------------------------------------------------
 *   These functions are satisfied by the code generated by the utility
 *   "comphtml.exe".
 *----------------------------------------------------------------------------*/
#ifndef NB_HTMLFILES_H
#define NB_HTMLFILES_H
 
#include <basictypes.h>
#include <nettypes.h>
 
// File compression types
enum comp_type
{
    eNoCompression,   // No compression, no dynamic HTML tags
    eHuffman,         // Huffman encoded without dynamic content HTML tags
    eHuffmanHtml,     // Huffman encoded with dynamic HTML tags such as CPPCALL and VARIABLE
    eUncompHtml,      // No compression, file contains dynamic HTML tags such as CPPCALL and VARIABLE
    ePrevCompGZip     // File has been compressed with gzip
};
 
// File type
enum file_type
{
    eTypeText,
    eTypeHtml,
    eTypeJpg,
    eTypeGIF,
    eTypeClass,
    eTypePNG,
    eTypeJar,
    eTypeOther,
    eTypeMPEG,
    eTypeCSS,
    eTypeXML,
    eTypeWBMP,
    eTypeJS
};
 
// Each file has a record in htmldata.cpp
struct HTML_FILE_RECORD
{
    const char *fname;                   // name of file
    const unsigned char *file_pointer;   // pointer to file in array
    unsigned long siz;                   // size of file in bytes
    comp_type cType;                     // file compression type
    short fType;                         // file type
    short has_calls;                     // file has function call tags, such as: CPPCALL or VARIABLE
    int access_group;                    // security access group
    bool no_direct;                      // files to be included as part of an outer file, and are not directly accessed.
                                         // For example, A page with multiple repeated subelements could include the
                                         // same no_direct page multiple times, but with slightly different settings,
                                         // thereby eliminating the need to have the whole page as a single entry.
};
 
// Variables declared in auto-generated htmldata.cpp
extern const unsigned n_file_record;
extern const unsigned short huffman_table[];
extern const HTML_FILE_RECORD file_record[];
extern const char *MIME_table[];
extern const char *html_table[];
 
int SendEmailResponse(int sock, const char *name, const char *attachment);
 
int SendFullResponse(char const *name, int fd);
 
int SendFullResponse(HTML_FILE_RECORD *fr, int fd, const char *pUrl);
 
int SendHeaderResponse(char const *name, int fd);
 
int SendHeaderResponse(HTML_FILE_RECORD *fr, int fd);
 
int32_t SendFileFragment(char const *name, int32_t fd, PCSTR url = NULL);
 
HTML_FILE_RECORD *GetRecordFromName(char const *name);
 
void SendData(HTML_FILE_RECORD *fr, int sock, PCSTR url = NULL);
 
void WriteHtmlVariable(int fd, char c);
void WriteHtmlVariable(int fd, int i);
void WriteHtmlVariable(int fd, short i);
void WriteHtmlVariable(int fd, long i);
void WriteHtmlVariable(int fd, uint8_t b);
void WriteHtmlVariable(int fd, uint16_t w);
void WriteHtmlVariable(int fd, unsigned long dw);
void WriteHtmlVariable(int fd, const char *);
 
void WriteHtmlVariable(int fd, MACADR ip);
 
#ifdef IPV6
#include <ipv6/ipv6_addr.h>
 
class IPADDR_WCLASS
{
   public:
    IPADDR the_addr;
    IPADDR_WCLASS(IPADDR ip) { the_addr = ip; }
    IPADDR_WCLASS(IPADDR4 ip4) { the_addr = ip4; }
};
 
IPADDR_WCLASS IPCAST(IPADDR ip);
 
#else
class IPADDR_WCLASS
{
   public:
    IPADDR the_addr;
    IPADDR_WCLASS(IPADDR ip) { the_addr = ip; }
};
 
#endif
IPADDR_WCLASS IPCAST(IPADDR ip);
 
void WriteHtmlVariable(int fd, IPADDR_WCLASS ipa);
 
class config_leaf;
 
/*
 * eMode values:
 *  1 = CONFIGVALUE     Value of the configuration object. For example an IP value would be a string "192.168.1.10".
 *  2 = CONFIGINPUT     HTML input element with name and value that can be used as an input for form processing. An input
 *                      element can be a checkbox (boolean), text edit field, or chooser (drop down box).
 *  3 = CONFIGFULL      HTML input name, element, and hint all as one HTML string.
 *  4 = CONFIGTABLE     HTML input name, element, and hint all as one HTML string with <td> and </td> HTML tags. Note: <table>
 *                      and </table> tags must be provided separately.
 *  5 = CONFIGHINT      Text value of hint associated with element.
 *
 */
struct CONFIG_RENDER_OBJ
{
    config_leaf *pObj;
    int eMode;
    int len;
    const char *extra;
};
 
CONFIG_RENDER_OBJ ConfigRenderFunc(int mode, const char *pobj, int len = 20, const char *extra = 0);
 
CONFIG_RENDER_OBJ ConfigRenderFunc(int mode, config_leaf &cl, int len = 20, const char *extra = 0);
 
void WriteHtmlVariable(int fd, CONFIG_RENDER_OBJ co);
 
#endif