Minnow Server ZIP File System Plugin

Detailed Description

The ZipFileSystem is an optional plugin that requires the Barracuda Web Server ZipFileIterator plugin.

The optional ZipFileSystem plugin for the Minnow Server lets you store the web presentation logic compressed in the device. Compressed web applications are typically only one-third of the original size. The compressed web pages are not uncompressed on the device. The web pages are extracted from within the ZIP file and sent "as is" to the browser. All modern browsers uncompress "compressed" data received from the servers.

The optional ZipFileSystem plugin is available at an additional cost.

The ZipFileSystem is a small plugin that includes the classes ZipContainer, CentralDirIterator, and ZipFileInfo. The complete ZipFileSystem does not come delivered with SharkSSL.

Modules
	ZIP File System IO
	Minnow Server ZIP file system IO plugin.

Data Structures
struct	ZipFileSystem
	The ZipFileSystem handle. More...

Functions
MSFetchPage	msInitZipFileSystem (ZipFileSystem *zfs, ZipReader *zipReader)
	Initializes the ZIP File System and returns a WsFetchPage callback function. More...

Function Documentation

msInitZipFileSystem()

MSFetchPage msInitZipFileSystem	(	ZipFileSystem *	zfs,
		ZipReader *	zipReader
	)

Initializes the ZIP File System and returns a WsFetchPage callback function.

Parameters

zfs

the ZipFileSystem to initialize

zipReader

a device driver (interface object) between the Zip File System and the ZIP file. The example below extern declares a function that returns a ZipReader object. This function is typically created automatically by our bin2c tool which converts a ZIP file into a C array. The bin2c tool also generates a ZipReader object automatically. You can also create your own ZipReader driver object if you, for example, want to keep the ZIP file separate from your firmware.

Example code:

extern ZipReader* getZipReader(void);
.
.
WssProtocolHandshake wph={0};
ZipFileSystem zfs;
wph.fetchPage = msInitZipFileSystem(&zfs, getZipReader());
wph.fetchPageHndl=&zfs;

The following example shows a code snippet from a ZIP file converted to C data by running the bin2c tool as follows:
bin2c -z getZipReader www.zip www.c

static const U8 zipfileData[] = { ZIP FILE CONTENT HERE };
 
//ZIP device driver function
int readFromZipFile(CspReader* o,void* data,U32 offset,U32 size,int blockStart)
{
   memcpy(data, zipfileData+offset, size); // Copy ZIP content at offset pos
   return 0; // OK
}
 
// Init and return a ZIP device driver
ZipReader* getZipReader(void)
{
   static ZipReader zipReader;
   ZipReader_constructor(&zipReader,readFromZipFile,sizeof(zipfileData));
   CspReader_setIsValid(&zipReader);
   return &zipReader;
}