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