src/r_pin_message.h

   1 ///
   2 /// \file       r_pin_message.h
   3 ///             Blackberry database record parser class for pin message records.
   4 ///
   5
   6 /*
   7     Copyright (C) 2005-2008, Net Direct Inc. (http://www.netdirect.ca/)
   8     Copyright (C) 2007, Brian Edginton (edge@edginton.net)
   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 #ifndef __BARRY_RECORD_PIN_MESSAGE_H__
  24 #define __BARRY_RECORD_PIN_MESSAGE_H__
  25
  26 #include "dll.h"
  27 #include "record.h"
  28 #include <iosfwd>
  29 #include <string>
  30 #include <vector>
  31 #include <map>
  32 #include <stdint.h>
  33
  34 namespace Barry {
  35
  36 //
  37 // NOTE:  All classes here must be container-safe!  Perhaps add sorting
  38 //        operators in the future.
  39 //
  40
  41 /// \addtogroup RecordParserClasses
  42 /// @{
  43
  44 class BXEXPORT PINMessage
  45 {
  46 public:
  47         uint8_t RecType;
  48         uint32_t RecordId;
  49
  50         EmailAddress From;
  51         EmailAddress To;
  52         EmailAddress Cc;
  53         EmailAddress Bcc;
  54         std::string Subject;
  55         std::string Body;
  56         uint32_t MessageRecordId;       // this happens to be the same as
  57                                         // RecordId in my (CDF) testing,
  58                                         // but interestingly, it is stored
  59                                         // as a field *inside* the record,
  60                                         // and not as part of the header...
  61                                         // in effect, this record ID occurs
  62                                         // twice in the protocol
  63         uint32_t MessageReplyTo;
  64         time_t MessageDateSent;
  65         time_t MessageDateReceived;
  66
  67         // Message Flags
  68         bool    MessageTruncated;
  69         bool    MessageRead;
  70         bool    MessageReply;
  71         bool    MessageSaved;
  72         bool    MessageSavedDeleted;
  73
  74         enum MessagePriorityType {
  75                 LowPriority = 0,
  76                 NormalPriority,
  77                 HighPriority,
  78                 UnknownPriority
  79         };
  80         MessagePriorityType MessagePriority;
  81
  82         enum MessageSensitivityType {
  83                 NormalSensitivity = 0,
  84                 Personal,
  85                 Private,
  86                 Confidential,
  87                 UnknownSensitivity
  88         };
  89         MessageSensitivityType MessageSensitivity;
  90
  91         std::vector<UnknownField> Unknowns;
  92
  93 public:
  94         const unsigned char* ParseField(const unsigned char *begin,
  95                 const unsigned char *end);
  96
  97 public:
  98         PINMessage();
  99         ~PINMessage();
 100
 101         // Parser / Builder API (see parser.h / builder.h)
 102         uint8_t GetRecType() const { return RecType; }
 103         uint32_t GetUniqueId() const { return RecordId; }
 104         void SetIds(uint8_t Type, uint32_t Id) { RecType = Type; RecordId = Id; }
 105         void ParseHeader(const Data &data, size_t &offset);
 106         void ParseFields(const Data &data, size_t &offset);
 107         void BuildHeader(Data &data, size_t &offset) const;
 108         void BuildFields(Data &data, size_t &offset) const;
 109
 110         void Clear();
 111
 112         void Dump(std::ostream &os) const;
 113
 114         // sorting
 115         bool operator<(const PINMessage &other) const { return Subject < other.Subject; }
 116
 117         // database name
 118         static const char * GetDBName() { return "PIN Messages"; }
 119         static uint8_t GetDefaultRecType() { return 0; }
 120 };
 121
 122 BXEXPORT inline std::ostream& operator<<(std::ostream &os, const PINMessage &msg) {
 123         msg.Dump(os);
 124         return os;
 125 }
 126
 127 /// @}
 128
 129 } // namespace Barry
 130
 131 #endif // __BARRY_RECORD_PIN_MESSAGE_H__
 132
 133