src/r_message_base.h

   1 ///
   2 /// \file       r_message_base.h
   3 ///             Base class for email-oriented Blackberry database records
   4 ///
   5
   6 /*
   7     Copyright (C) 2005-2009, 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_MESSAGE_BASE_H__
  24 #define __BARRY_RECORD_MESSAGE_BASE_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
  35 namespace Barry {
  36
  37 // forward declarations
  38 class IConverter;
  39
  40 //
  41 // NOTE:  All classes here must be container-safe!  Perhaps add sorting
  42 //        operators in the future.
  43 //
  44
  45 /// \addtogroup RecordParserClasses
  46 /// @{
  47
  48 class BXEXPORT MessageBase
  49 {
  50 public:
  51         uint8_t RecType;
  52         uint32_t RecordId;
  53
  54         EmailAddressList From;
  55         EmailAddressList To;
  56         EmailAddressList Cc;
  57         EmailAddressList Bcc;
  58         EmailAddressList Sender;                //< not available for PINMessage?
  59         EmailAddressList ReplyTo;               //< not available for PINMessage?
  60         std::string Subject;
  61         std::string Body;
  62         std::string Attachment;                 //< not available for PINMessage?
  63
  64         uint32_t MessageRecordId;       // in PINMessage, this happens to be
  65                                         // the same as RecordId in my (CDF)
  66                                         // testing, but interestingly, it is
  67                                         // stored  as a field *inside* the
  68                                         // record, and not as part of the
  69                                         // header... in effect, this record ID
  70                                         // occurs twice in the protocol
  71         uint32_t MessageReplyTo;
  72         time_t MessageDateSent;
  73         time_t MessageDateReceived;
  74
  75         // Message Flags
  76         bool    MessageTruncated;
  77         bool    MessageRead;
  78         bool    MessageReply;
  79         bool    MessageSaved;
  80         bool    MessageSavedDeleted;
  81
  82         enum MessagePriorityType {
  83                 LowPriority = 0,
  84                 NormalPriority,
  85                 HighPriority,
  86                 UnknownPriority
  87         };
  88         MessagePriorityType MessagePriority;
  89
  90         enum MessageSensitivityType {
  91                 NormalSensitivity = 0,
  92                 Personal,
  93                 Private,
  94                 Confidential,
  95                 UnknownSensitivity
  96         };
  97         MessageSensitivityType MessageSensitivity;
  98
  99         std::vector<UnknownField> Unknowns;
 100
 101 protected:
 102         std::string SimpleFromAddress() const;
 103
 104 public:
 105         const unsigned char* ParseField(const unsigned char *begin,
 106                 const unsigned char *end, const IConverter *ic = 0);
 107
 108 public:
 109         MessageBase();
 110         ~MessageBase();
 111
 112         // Parser / Builder API (see parser.h / builder.h)
 113         uint8_t GetRecType() const;
 114         uint32_t GetUniqueId() const;   // empty API, not required by protocol
 115         void SetIds(uint8_t Type, uint32_t Id){ RecType = Type; RecordId = Id; }
 116         void ParseHeader(const Data &data, size_t &offset);
 117         void ParseFields(const Data &data, size_t &offset, const IConverter *ic = 0);
 118         void BuildHeader(Data &data, size_t &offset) const;
 119         void BuildFields(Data &data, size_t &offset, const IConverter *ic = 0) const;
 120
 121         void Clear();
 122
 123         void Dump(std::ostream &os) const;
 124
 125         // sorting
 126         bool operator<(const MessageBase &other) const
 127         {
 128                 return Subject < other.Subject;
 129         }
 130 };
 131
 132 BXEXPORT inline std::ostream& operator<<(std::ostream &os, const MessageBase &msg) {
 133         msg.Dump(os);
 134         return os;
 135 }
 136
 137 /// @}
 138
 139 } // namespace Barry
 140
 141 #endif
 142