src/r_cstore.cc

   1 ///
   2 /// \file       r_cstore.cc
   3 ///             Blackberry database record parser class for
   4 ///             Content Store records.
   5 ///
   6
   7 /*
   8     Copyright (C) 2010-2012, Net Direct Inc. (http://www.netdirect.ca/)
   9
  10     This program is free software; you can redistribute it and/or modify
  11     it under the terms of the GNU General Public License as published by
  12     the Free Software Foundation; either version 2 of the License, or
  13     (at your option) any later version.
  14
  15     This program is distributed in the hope that it will be useful,
  16     but WITHOUT ANY WARRANTY; without even the implied warranty of
  17     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  18
  19     See the GNU General Public License in the COPYING file at the
  20     root directory of this project for more details.
  21 */
  22
  23 #include "r_cstore.h"
  24 #include "record-internal.h"
  25 #include "data.h"
  26
  27 #include <iostream>
  28 #include <sstream>
  29 #include <iomanip>
  30 #include "ios_state.h"
  31
  32 #define __DEBUG_MODE__
  33 #include "debug.h"
  34
  35 using namespace std;
  36 using namespace Barry::Protocol;
  37
  38 namespace Barry {
  39
  40
  41 ///////////////////////////////////////////////////////////////////////////////
  42 // ContentStore class
  43
  44 // ContentStore field codes
  45 #define CSFC_FILENAME           0x01    // may not always be a complete file,but
  46                                         // a folder name as well
  47 #define CSFC_FOLDER_FLAG        0x05
  48 #define CSFC_FILE_DESCRIPTOR    0x06
  49 #define CSFC_FILE_CONTENT       0x07
  50
  51
  52 #define MAX_CONTENT_BLOCK_SIZE  0xfffe
  53
  54 ContentStore::ContentStore()
  55 {
  56         Clear();
  57 }
  58
  59 ContentStore::~ContentStore()
  60 {
  61 }
  62
  63 const unsigned char* ContentStore::ParseField(const unsigned char *begin,
  64                                          const unsigned char *end,
  65                                          const IConverter *ic)
  66 {
  67         const CommonField *field = (const CommonField *) begin;
  68
  69         // advance and check size
  70         begin += COMMON_FIELD_HEADER_SIZE + btohs(field->size);
  71         if( begin > end )               // if begin==end, we are ok
  72                 return begin;
  73
  74         if( !btohs(field->size) )       // if field has no size, something's up
  75                 return begin;
  76
  77         switch( field->type )
  78         {
  79         case CSFC_FILENAME:
  80                 Filename = ParseFieldString(field);
  81                 return begin;
  82
  83         case CSFC_FOLDER_FLAG:
  84                 FolderFlag = false;
  85                 {
  86                         // the CSFC_FOLDER_FLAG field seems to always
  87                         // contain the string "folder".. so check for it
  88                         string s = ParseFieldString(field);
  89                         if( s == "folder" ) {
  90                                 FolderFlag = true;
  91                         }
  92                 }
  93                 return begin;
  94
  95         case CSFC_FILE_CONTENT:
  96                 if( FileSize ) {
  97                         // size already received, append data to FileContent
  98                         FileContent.append((const char*)field->u.raw,
  99                                 btohs(field->size));
 100                 }
 101                 else {
 102                         FileSize = btohll(field->u.uint64);
 103                 }
 104                 return begin;
 105
 106         case CSFC_FILE_DESCRIPTOR:
 107                 // need to parse this further, but until then, just
 108                 // store it as a chunk of data
 109                 FileDescriptor.assign((const char*)field->u.raw,
 110                         btohs(field->size));
 111                 return begin;
 112         }
 113
 114         // if still not handled, add to the Unknowns list
 115         UnknownField uf;
 116         uf.type = field->type;
 117         uf.data.assign((const char*)field->u.raw, btohs(field->size));
 118         Unknowns.push_back(uf);
 119
 120         // return new pointer for next field
 121         return begin;
 122 }
 123
 124 void ContentStore::ParseHeader(const Data &data, size_t &offset)
 125 {
 126         // no header to parse
 127 }
 128
 129 void ContentStore::ParseFields(const Data &data, size_t &offset, const IConverter *ic)
 130 {
 131         const unsigned char *finish = ParseCommonFields(*this,
 132                 data.GetData() + offset, data.GetData() + data.GetSize(), ic);
 133         offset += finish - (data.GetData() + offset);
 134 }
 135
 136 void ContentStore::BuildHeader(Data &data, size_t &offset) const
 137 {
 138 }
 139
 140 void ContentStore::BuildFields(Data &data, size_t &offset, const IConverter *ic) const
 141 {
 142         data.Zap();
 143
 144         if( !Filename.size() )
 145                 throw BadData("Content Store must have a name.");
 146
 147         if( !FolderFlag && !FileContent.size() )
 148                 throw BadData("Content Store item without any data.");
 149
 150         // Filename
 151         BuildField(data, offset, CSFC_FILENAME, Filename);
 152
 153         // Folder?
 154         if( FolderFlag ) {
 155                 BuildField(data, offset, CSFC_FOLDER_FLAG, string("folder"));
 156         }
 157         else {
 158                 // write file descriptor first
 159                 BuildField(data, offset, CSFC_FILE_DESCRIPTOR,
 160                         FileDescriptor.data(), FileDescriptor.size());
 161
 162                 // a normal file... the file content is given:
 163                 //      64 bit size
 164                 //      content in blocks of 0xfffe bytes until done
 165                 // all with the same ID
 166
 167                 // force the size to actual, and write it first
 168                 uint64_t RealSize = FileContent.size();
 169                 BuildField(data, offset, CSFC_FILE_CONTENT, RealSize);
 170
 171                 // write data in blocks of 0xfffe bytes
 172                 for( size_t foff = 0; foff < FileContent.size(); ) {
 173                         size_t blocksize = FileContent.size() - foff;
 174                         if( blocksize > MAX_CONTENT_BLOCK_SIZE )
 175                                 blocksize = MAX_CONTENT_BLOCK_SIZE;
 176                         BuildField(data, offset, CSFC_FILE_CONTENT,
 177                                 FileContent.data() + foff, blocksize);
 178
 179                         // advance
 180                         foff += blocksize;
 181                 }
 182         }
 183
 184         // and finally save unknowns
 185         UnknownsType::const_iterator
 186                 ub = Unknowns.begin(), ue = Unknowns.end();
 187         for( ; ub != ue; ub++ ) {
 188                 BuildField(data, offset, *ub);
 189         }
 190
 191         data.ReleaseBuffer(offset);
 192 }
 193
 194 void ContentStore::Clear()
 195 {
 196         RecType = GetDefaultRecType();
 197         RecordId = 0;
 198
 199         Filename.clear();
 200         FolderFlag = false;
 201         FileContent.clear();
 202         FileDescriptor.clear();
 203
 204         Unknowns.clear();
 205
 206         // internal variables
 207         FileSize = 0;
 208 }
 209
 210 const std::vector<FieldHandle<ContentStore> >& ContentStore::GetFieldHandles()
 211 {
 212         static std::vector<FieldHandle<ContentStore> > fhv;
 213
 214         if( fhv.size() )
 215                 return fhv;
 216
 217 #undef CONTAINER_OBJECT_NAME
 218 #define CONTAINER_OBJECT_NAME fhv
 219
 220 #undef RECORD_CLASS_NAME
 221 #define RECORD_CLASS_NAME ContentStore
 222
 223         FHP(RecType, "Record Type Code");
 224         FHP(RecordId, "Unique Record ID");
 225
 226         FHD(Filename, "File or Folder Name", CSFC_FILENAME, true);
 227         FHD(FolderFlag, "Folder Flag", CSFC_FOLDER_FLAG, false);
 228         FHD(FileContent, "File Content", CSFC_FILE_CONTENT, false);
 229         FHD(FileDescriptor, "File Descriptor", CSFC_FILE_DESCRIPTOR, false);
 230
 231         FHP(Unknowns, "Unknown Fields");
 232
 233         return fhv;
 234 }
 235
 236 std::string ContentStore::GetDescription() const
 237 {
 238         return Filename;
 239 }
 240
 241 void ContentStore::Dump(std::ostream &os) const
 242 {
 243         ios_format_state state(os);
 244
 245         os.setf(ios::left);
 246         os.fill(' ');
 247
 248         os << "ContentStore: 0x" << hex << RecordId
 249                 << " (" << (unsigned int)RecType << ")\n";
 250
 251         os << "       Filename: " << Filename << endl;
 252         os << "         Folder: " << (FolderFlag ? "yes" : "no") << endl;
 253         os << "        BB Size: " << dec << FileSize << endl;
 254         os << "    Actual Size: " << FileContent.size() << endl;
 255         os << "     Descriptor:\n"
 256                 << Data(FileDescriptor.data(), FileDescriptor.size()) << endl;
 257         os << "        Content:\n"
 258                 << Data(FileContent.data(), FileContent.size()) << endl;
 259
 260         // and finally print unknowns
 261         os << Unknowns;
 262 }
 263
 264 bool ContentStore::operator<(const ContentStore &other) const
 265 {
 266         return RecordId < other.RecordId;
 267 }
 268
 269 } // namespace Barry
 270