src/record.h

   1 ///
   2 /// \file       record.h
   3 ///             Blackberry database record classes.  Help translate data
   4 ///             from data packets to useful structurs, and back.
   5 ///             This header provides the common types and classes
   6 ///             used by the general record parser classes in the
   7 ///             r_*.h files.  Only application-safe API stuff goes in
   8 ///             here.  Internal library types go in record-internal.h
   9 ///
  10
  11 /*
  12     Copyright (C) 2005-2010, Net Direct Inc. (http://www.netdirect.ca/)
  13
  14     This program is free software; you can redistribute it and/or modify
  15     it under the terms of the GNU General Public License as published by
  16     the Free Software Foundation; either version 2 of the License, or
  17     (at your option) any later version.
  18
  19     This program is distributed in the hope that it will be useful,
  20     but WITHOUT ANY WARRANTY; without even the implied warranty of
  21     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  22
  23     See the GNU General Public License in the COPYING file at the
  24     root directory of this project for more details.
  25 */
  26
  27 #ifndef __BARRY_RECORD_H__
  28 #define __BARRY_RECORD_H__
  29
  30 #include "dll.h"
  31 #include <iosfwd>
  32 #include <string>
  33 #include <vector>
  34 #include <map>
  35 #include <stdint.h>
  36
  37 // forward declarations
  38 namespace Barry { class Data; }
  39
  40 namespace Barry {
  41
  42 //
  43 // NOTE:  All classes here must be container-safe!  Perhaps add sorting
  44 //        operators in the future.
  45 //
  46
  47
  48
  49 struct BXEXPORT CommandTableCommand
  50 {
  51         unsigned int Code;
  52         std::string Name;
  53 };
  54
  55 class BXEXPORT CommandTable
  56 {
  57 public:
  58         typedef CommandTableCommand Command;
  59         typedef std::vector<Command> CommandArrayType;
  60
  61         CommandArrayType Commands;
  62
  63 private:
  64         BXLOCAL const unsigned char* ParseField(const unsigned char *begin,
  65                 const unsigned char *end);
  66 public:
  67         CommandTable();
  68         ~CommandTable();
  69
  70         void Parse(const Data &data, size_t offset);
  71         void Clear();
  72
  73         // returns 0 if unable to find command name, which is safe, since
  74         // 0 is a special command that shouldn't be in the table anyway
  75         unsigned int GetCommand(const std::string &name) const;
  76
  77         void Dump(std::ostream &os) const;
  78 };
  79
  80 BXEXPORT inline std::ostream& operator<< (std::ostream &os, const CommandTable &command) {
  81         command.Dump(os);
  82         return os;
  83 }
  84
  85
  86
  87 struct BXEXPORT RecordStateTableState
  88 {
  89         unsigned int Index;
  90         uint32_t RecordId;
  91         bool Dirty;
  92         unsigned int RecType;
  93         std::string Unknown2;
  94 };
  95
  96 class BXEXPORT RecordStateTable
  97 {
  98 public:
  99         typedef RecordStateTableState State;
 100         typedef unsigned int IndexType;
 101         typedef std::map<IndexType, State> StateMapType;
 102
 103         StateMapType StateMap;
 104
 105 private:
 106         mutable IndexType m_LastNewRecordId;
 107
 108 private:
 109         BXLOCAL const unsigned char* ParseField(const unsigned char *begin,
 110                 const unsigned char *end);
 111
 112 public:
 113         RecordStateTable();
 114         ~RecordStateTable();
 115
 116         void Parse(const Data &data);
 117         void Clear();
 118
 119         bool GetIndex(uint32_t RecordId, IndexType *pFoundIndex = 0) const;
 120         uint32_t MakeNewRecordId() const;
 121
 122         void Dump(std::ostream &os) const;
 123 };
 124
 125 BXEXPORT inline std::ostream& operator<< (std::ostream &os, const RecordStateTable &rst) {
 126         rst.Dump(os);
 127         return os;
 128 }
 129
 130
 131
 132 struct BXEXPORT DatabaseItem
 133 {
 134         unsigned int Number;
 135         unsigned int RecordCount;
 136         std::string Name;
 137 };
 138
 139 class BXEXPORT DatabaseDatabase
 140 {
 141 public:
 142         typedef DatabaseItem Database;
 143         typedef std::vector<Database> DatabaseArrayType;
 144
 145         DatabaseArrayType Databases;
 146
 147 private:
 148         template <class RecordType, class FieldType>
 149         void ParseRec(const RecordType &rec, const unsigned char *end);
 150
 151         template <class FieldType>
 152         const unsigned char* ParseField(const unsigned char *begin,
 153                 const unsigned char *end);
 154
 155 public:
 156         DatabaseDatabase();
 157         ~DatabaseDatabase();
 158
 159         void Parse(const Data &data);
 160         void Clear();
 161
 162         // returns true on success, and fills target
 163         bool GetDBNumber(const std::string &name, unsigned int &number) const;
 164         bool GetDBName(unsigned int number, std::string &name) const;
 165
 166         void Dump(std::ostream &os) const;
 167 };
 168
 169 BXEXPORT inline std::ostream& operator<<(std::ostream &os, const DatabaseDatabase &dbdb) {
 170         dbdb.Dump(os);
 171         return os;
 172 }
 173
 174 struct UnknownData
 175 {
 176         std::string raw_data;
 177
 178         const std::string::value_type* data() const { return raw_data.data(); }
 179         std::string::size_type size() const { return raw_data.size(); }
 180         void assign(const std::string::value_type *s, std::string::size_type n)
 181                 { raw_data.assign(s, n); }
 182 };
 183
 184 struct BXEXPORT UnknownField
 185 {
 186         uint8_t type;
 187         UnknownData data;
 188 };
 189 BXEXPORT std::ostream& operator<< (std::ostream &os, const std::vector<UnknownField> &unknowns);
 190
 191 struct BXEXPORT EmailAddress
 192 {
 193         std::string Name;
 194         std::string Email;
 195
 196         void clear()
 197         {
 198                 Name.clear();
 199                 Email.clear();
 200         }
 201
 202         size_t size() const
 203         {
 204                 return Name.size() + Email.size();
 205         }
 206 };
 207 BXEXPORT std::ostream& operator<<(std::ostream &os, const EmailAddress &msga);
 208
 209 typedef std::vector<EmailAddress>       EmailAddressList;
 210 BXEXPORT std::ostream& operator<<(std::ostream &os, const EmailAddressList &elist);
 211
 212 struct BXEXPORT PostalAddress
 213 {
 214         std::string
 215                 Address1,
 216                 Address2,
 217                 Address3,
 218                 City,
 219                 Province,
 220                 PostalCode,
 221                 Country;
 222
 223         std::string GetLabel() const;
 224         void Clear();
 225
 226         bool HasData() const { return Address1.size() || Address2.size() ||
 227                 Address3.size() || City.size() || Province.size() ||
 228                 PostalCode.size() || Country.size(); }
 229 };
 230 BXEXPORT std::ostream& operator<<(std::ostream &os, const PostalAddress &msga);
 231
 232 struct BXEXPORT Date
 233 {
 234         int Month;                      // 0 to 11
 235         int Day;                        // 1 to 31
 236         int Year;                       // exact number, eg. 2008
 237
 238         Date() : Month(0), Day(0), Year(0) {}
 239         explicit Date(const struct tm *timep);
 240
 241         bool HasData() const { return Month || Day || Year; }
 242         void Clear();
 243
 244         void ToTm(struct tm *timep) const;
 245         std::string ToYYYYMMDD() const;
 246         std::string ToBBString() const; // converts to Blackberry string
 247                                         // format of DD/MM/YYYY
 248
 249         bool FromTm(const struct tm *timep);
 250         bool FromBBString(const std::string &str);
 251         bool FromYYYYMMDD(const std::string &str);
 252 };
 253 BXEXPORT std::ostream& operator<<(std::ostream &os, const Date &date);
 254
 255 class BXEXPORT CategoryList : public std::vector<std::string>
 256 {
 257 public:
 258         /// Parses the given comma delimited category string into
 259         /// this CategoryList object, appending each token to the vector.
 260         /// Will clear vector beforehand.
 261         void CategoryStr2List(const std::string &str);
 262
 263         /// Turns the current vectory into a comma delimited category
 264         /// string suitable for use in Calendar, Task, and Memo
 265         /// protocol values.
 266         void CategoryList2Str(std::string &str) const;
 267
 268         using std::vector<std::string>::operator=;
 269 };
 270
 271
 272 /// \addtogroup RecordParserClasses
 273 ///             Parser and data storage classes.  These classes take a
 274 ///             Database Database record and convert them into C++ objects.
 275 ///             Each of these classes are safe to be used in standard
 276 ///             containers, and are meant to be used in conjunction with the
 277 ///             RecordParser<> template when calling Controller::LoadDatabase().
 278 /// @{
 279 /// @}
 280
 281 } // namespace Barry
 282
 283 #ifndef __BARRY_LIBRARY_BUILD__
 284 // Include all parser classes, to make it easy for the application to use.
 285 #include "r_calendar.h"
 286 #include "r_calllog.h"
 287 #include "r_bookmark.h"
 288 #include "r_contact.h"
 289 #include "r_memo.h"
 290 #include "r_message.h"
 291 #include "r_servicebook.h"
 292 #include "r_task.h"
 293 #include "r_pin_message.h"
 294 #include "r_saved_message.h"
 295 #include "r_sms.h"
 296 #include "r_folder.h"
 297 #include "r_timezone.h"
 298 #endif
 299
 300 #endif
 301