Initial import from crosswire CVS for syncingimport-1.1.1

1 files changed, 247 insertions, 0 deletions

diff --git a/utilities/stepdump.cpp b/utilities/stepdump.cpp
new file mode 100644
index 0000000..5dfe114
--- /dev/null
+++ b/utilities/stepdump.cpp
@@ -0,0 +1,247 @@
+#include <iostream>
+#include <string>
+
+#include <fcntl.h>
+#include <unistd.h>
+
+#include <lzsscomprs.h>
+
+#ifndef O_BINARY
+#define O_BINARY 0
+#endif
+
+
+using namespace std;
+
+typedef struct {
+	short versionRecordSize;
+	short publisherID;
+	short bookID;
+	short setID;
+	char conversionProgramVerMajor;
+	char conversionProgramVerMinor;
+	char leastCompatSTEPVerMajor;
+	char leastCompatSTEPVerMinor;
+	char encryptionType;
+	char editionID;
+	short modifiedBy;
+} Version;
+
+typedef struct {
+	short viewableHeaderRecordSize;
+	long viewableBlocksCount; // this is listed as nonGlossBlocksCount in spec!
+	long glossBlocksCount;
+	char compressionType; // 0 - none; 1 - LZSS
+	char reserved1;
+	short blockEntriesSize;
+	short reserved2;
+} ViewableHeader;
+
+typedef struct {
+	long offset;
+	long uncompressedSize;
+	long size;
+} ViewableBlock;
+		
+void readVersion(int fd, Version *versionRecord);
+void readHeaderControlWordAreaText(int fd, char **buf);
+void readViewableHeader(int fd, ViewableHeader *viewableHeaderRecord);
+void readViewableBlock(int fd, ViewableBlock *vb);
+void readViewableBlockText(int fd, ViewableBlock *vb, char **buf);
+
+SWCompress *compress = 0;
+
+int main(int argc, char **argv) {
+
+	compress = new LZSSCompress();
+	char *buf;
+	Version versionRecord;
+	ViewableHeader viewableHeaderRecord;
+
+	if (argc < 2) {
+		cerr << "usage: "<< *argv << " <database to step module>\n";
+		exit (-1);
+	}
+
+	string bookpath = argv[1];
+	string fileName;
+
+	if ((argv[1][strlen(argv[1])-1] != '/') &&
+		(argv[1][strlen(argv[1])-1] != '\\'))
+		bookpath += "/";
+
+	fileName = bookpath + "Book.dat";
+	int fd = open(fileName.c_str(), O_RDONLY|O_BINARY);
+
+	if (fd < 1) {
+		cerr << "error, couldn't open file: " << fileName << "\n";
+		exit (-2);
+	}
+
+	readVersion(fd, &versionRecord);
+	readHeaderControlWordAreaText(fd, &buf);
+	delete [] buf;
+
+
+	fileName = bookpath + "Viewable.idx";
+	int fdv = open(fileName.c_str(), O_RDONLY|O_BINARY);
+
+	if (fdv < 1) {
+		cerr << "error, couldn't open file: " << fileName << "\n";
+		exit (-3);
+	}
+
+	readVersion(fdv, &versionRecord);
+	readViewableHeader(fdv, &viewableHeaderRecord);
+
+	ViewableBlock vb;
+
+	cout << "\n\nReading special preface viewable BLOCK 0";
+
+	readViewableBlock(fdv, &vb);
+	readViewableBlockText(fd, &vb, &buf);
+	delete [] buf;
+	
+	int nonGlossBlocksCount = viewableHeaderRecord.viewableBlocksCount
+					    - viewableHeaderRecord.glossBlocksCount;
+
+	cout << "\n\nReading " << nonGlossBlocksCount << " non-glossary viewable blocks";
+	// 1 because we already read the first block above
+	for (int i = 1; i < nonGlossBlocksCount; i++) {
+		cout << "\nNon-Glossary viewable block: " << i;
+		readViewableBlock(fdv, &vb);
+		readViewableBlockText(fd, &vb, &buf);
+		delete [] buf;
+	}
+
+	cout << "\n\nReading " << viewableHeaderRecord.glossBlocksCount << " glossary viewable blocks";
+	for (int i = 0; i < viewableHeaderRecord.glossBlocksCount; i++) {
+		cout << "\nGlossary viewable block: " << i;
+		readViewableBlock(fdv, &vb);
+		readViewableBlockText(fd, &vb, &buf);
+		delete [] buf;
+	}
+
+	close(fdv);
+	close(fd);
+
+}
+
+
+
+void readVersion(int fd, Version *versionRecord) {
+
+	cout << "\n\nReading Version Record (" << 16/*sizeof(struct Version)*/ << " bytes)\n\n";
+// DO NOT USE BECAUSE OF RECORD BYTE ALIGNMENT PROBLEMS
+//	read(fd, &versionRecord, sizeof(struct Version));
+
+	cout << "Version Record Information\n";
+	read(fd, &(versionRecord->versionRecordSize), 2);
+	cout << "\tversionRecordSize: " << versionRecord->versionRecordSize << "\n";
+	read(fd, &(versionRecord->publisherID), 2);
+	cout << "\tpublisherID: " << versionRecord->publisherID << "\n";
+	read(fd, &(versionRecord->bookID), 2);
+	cout << "\tbookID: " << versionRecord->bookID << "\n";
+	read(fd, &(versionRecord->setID), 2);
+	cout << "\tsetID: " << versionRecord->setID << "\n";
+	read(fd, &(versionRecord->conversionProgramVerMajor), 1);
+	cout << "\tconversionProgramVerMajor: " << (int)versionRecord->conversionProgramVerMajor << "\n";
+	read(fd, &(versionRecord->conversionProgramVerMinor), 1);
+	cout << "\tconversionProgramVerMinor: " << (int)versionRecord->conversionProgramVerMinor << "\n";
+	read(fd, &(versionRecord->leastCompatSTEPVerMajor), 1);
+	cout << "\tleastCompatSTEPVerMajor: " << (int)versionRecord->leastCompatSTEPVerMajor << "\n";
+	read(fd, &(versionRecord->leastCompatSTEPVerMinor), 1);
+	cout << "\tleastCompatSTEPVerMinor: " << (int)versionRecord->leastCompatSTEPVerMinor << "\n";
+	read(fd, &(versionRecord->encryptionType), 1);
+	cout << "\tencryptionType: " << (int)versionRecord->encryptionType << "\n";
+	read(fd, &(versionRecord->editionID), 1);
+	cout << "\teditionID: " << (int)versionRecord->editionID << "\n";
+	read(fd, &(versionRecord->modifiedBy), 2);
+	cout << "\tmodifiedBy: " << versionRecord->modifiedBy << "\n";
+
+	int skip = versionRecord->versionRecordSize - 16/*sizeof(struct Version*/;
+
+	if (skip) {
+		cout << "\nSkipping " << skip << " unknown bytes.\n";
+		char skipbuf[skip];
+		read(fd, skipbuf, skip);
+	}
+}
+
+
+void readViewableHeader(int fd, ViewableHeader *viewableHeaderRecord) {
+
+	cout << "\n\nReading Viewable Header Record (" << 16/*sizeof(struct ViewableHeader)*/ << " bytes)\n\n";
+
+// DO NOT USE BECAUSE OF RECORD BYTE ALIGNMENT PROBLEMS
+//	read(fd, &viewableHeaderRecord, sizeof(struct ViewableHeader));
+
+	cout << "Viewable Header Record Information\n";
+	read(fd, &(viewableHeaderRecord->viewableHeaderRecordSize), 2);
+	cout << "\tviewableHeaderRecordSize: " << viewableHeaderRecord->viewableHeaderRecordSize << "\n";
+	read(fd, &(viewableHeaderRecord->viewableBlocksCount), 4);
+	cout << "\tviewableBlocksCount: " << viewableHeaderRecord->viewableBlocksCount << "\n";
+	read(fd, &(viewableHeaderRecord->glossBlocksCount), 4);
+	cout << "\tglossBlocksCount: " << viewableHeaderRecord->glossBlocksCount << "\n";
+	read(fd, &(viewableHeaderRecord->compressionType), 1);
+	cout << "\tcompressionType: " << (int)viewableHeaderRecord->compressionType << "(0 - none; 1 - LZSS)\n";
+	read(fd, &(viewableHeaderRecord->reserved1), 1);
+	cout << "\treserved1: " << (int)viewableHeaderRecord->reserved1 << "\n";
+	read(fd, &(viewableHeaderRecord->blockEntriesSize), 2);
+	cout << "\tblockEntriesSize: " << viewableHeaderRecord->blockEntriesSize << "\n";
+	read(fd, &(viewableHeaderRecord->reserved2), 2);
+	cout << "\treserved2: " << viewableHeaderRecord->reserved2 << "\n";
+
+	int skip = viewableHeaderRecord->viewableHeaderRecordSize - 16/*sizeof(struct ViewableHeader)*/;
+
+	if (skip) {
+		cout << "\nSkipping " << skip << " unknown bytes.\n";
+		char skipbuf[skip];
+		read(fd, skipbuf, skip);
+	}
+}
+
+
+void readViewableBlockText(int fd, ViewableBlock *vb, char **buf) {
+	unsigned long size = vb->size;
+
+	*buf = new char [ ((vb->size > vb->uncompressedSize) ? vb->size : vb->uncompressedSize) + 1 ];
+	lseek(fd, vb->offset, SEEK_SET);
+	read(fd, *buf, vb->size);
+
+	compress->zBuf(&size, *buf);
+	strcpy(*buf, compress->Buf());
+	cout << "Viewable Block Text:\n";
+	cout << *buf << "\n\n";
+}
+
+
+void readViewableBlock(int fd, ViewableBlock *vb) {
+
+	cout << "\n\nReading Viewable Block (" << 12/*sizeof(struct ViewableHeader)*/ << " bytes)\n\n";
+
+// DO NOT USE BECAUSE OF RECORD BYTE ALIGNMENT PROBLEMS
+//	read(fd, &vb, sizeof(struct ViewableBlock));
+
+	cout << "Viewable Block Information\n";
+	read(fd, &(vb->offset), 4);
+	cout << "\toffset: " << vb->offset << "\n";
+	read(fd, &(vb->uncompressedSize), 4);
+	cout << "\tuncompressedSize: " << vb->uncompressedSize << "\n";
+	read(fd, &(vb->size), 4);
+	cout << "\tsize: " << vb->size << "\n";
+}
+
+
+void readHeaderControlWordAreaText(int fd, char **buf) {
+	long headerControlWordAreaSize;
+	read(fd, &headerControlWordAreaSize, 4);
+	cout << "Reading Header Control Word Area (" << headerControlWordAreaSize << " bytes)\n\n";
+
+	*buf = new char [headerControlWordAreaSize + 1];
+
+	read(fd, *buf, headerControlWordAreaSize);
+	(*buf)[headerControlWordAreaSize] = 0;
+
+	cout << "headerControlWordArea:\n" << *buf << "\n";
+}