src/archive.h

   1 #ifndef __ARCHIVE_HH
   2 #define __ARCHIVE_HH
   3
   4 /**
   5  *
   6  * Tennix Archive File Format
   7  * Copyright (C) 2009-2010 Thomas Perl <thp@thpinfo.com>
   8  *
   9  * This program is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU General Public License
  11  * as published by the Free Software Foundation; either version 2
  12  * of the License, or (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
  22  * MA  02110-1301, USA.
  23  *
  24  **/
  25
  26 #include <iostream>
  27
  28 #include <stdio.h>
  29 #include <stdint.h>
  30 #include <stdlib.h>
  31 #include <string.h>
  32
  33 #define TENNIX_ARCHIVE_HEADER "thpinfo.com/2009/tennix/afmt "
  34 #define TENNIX_ARCHIVE_HEADER_LEN 30
  35
  36 #define TENNIX_ARCHIVE_VERSIONMAJOR 1
  37 #define TENNIX_ARCHIVE_VERSIONMINOR 0
  38
  39 #define TENNIX_ARCHIVE_ITEM_MAXNAME 86
  40
  41
  42 /* architecture-independent (in-file) structs */
  43
  44 struct _TennixArchiveItem {
  45     char filename[TENNIX_ARCHIVE_ITEM_MAXNAME];
  46     uint32_t offset; /* network byte order */
  47     uint32_t length; /* network byte order */
  48     uint8_t key;
  49 };
  50
  51 typedef struct _TennixArchiveItem TennixArchiveItem;
  52
  53 std::ostream&
  54 operator<<(std::ostream& out, TennixArchiveItem& item);
  55
  56 struct _TennixArchiveHeader {
  57     char header[TENNIX_ARCHIVE_HEADER_LEN];
  58     uint8_t versionmajor; /* major file version */
  59     uint8_t versionminor; /* minor file version */
  60     uint8_t key;
  61     uint8_t items; /* maximum 255 files per archive */
  62 };
  63
  64 typedef struct _TennixArchiveHeader TennixArchiveHeader;
  65
  66 std::ostream&
  67 operator<<(std::ostream& out, TennixArchiveHeader& header);
  68
  69 class TennixArchive {
  70     private:
  71         FILE* fp;
  72         TennixArchiveHeader header;
  73         TennixArchiveItem* items;
  74         char** blobs;
  75         size_t offset;
  76         int current_item;
  77         int building;
  78
  79         static void xormem(char* mem, uint32_t length, char key);
  80
  81     public:
  82         TennixArchive();
  83         TennixArchive(const char* filename, const char* fallback=NULL);
  84
  85         ~TennixArchive() {
  86             if (fp != NULL) {
  87                 fclose(fp);
  88             }
  89             free(items);
  90         }
  91
  92         int setItemFilename(const char* filename);
  93
  94         const char* getItemFilename() {
  95             return items[current_item].filename;
  96         }
  97
  98         char* getItemBytes();
  99
 100         size_t getItemSize() {
 101             return items[current_item].length;
 102         }
 103
 104         int endOfFile() {
 105             return current_item >= header.items;
 106         }
 107
 108         void next() {
 109             current_item++;
 110         }
 111
 112         /* only for building/utility mode: */
 113         void appendItem(char* filename, char* data, uint32_t length);
 114         void buildFile(char* filename);
 115
 116         friend std::ostream& operator<<(std::ostream& out, TennixArchive& archive);
 117 };
 118
 119 /* Used for dumping the contents of a TennixArchive */
 120 std::ostream&
 121 operator<<(std::ostream& out, TennixArchive& archive);
 122
 123 #endif