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         Address From;
  50         Address To;
  51         Address Cc;
  52         Address 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         std::vector<UnknownField> Unknowns;
  63
  64 public:
  65         const unsigned char* ParseField(const unsigned char *begin,
  66                 const unsigned char *end);
  67
  68 public:
  69         PINMessage();
  70         ~PINMessage();
  71
  72         // Parser / Builder API (see parser.h / builder.h)
  73         uint8_t GetRecType() const { return RecType; }
  74         uint32_t GetUniqueId() const { return RecordId; }
  75         void SetIds(uint8_t Type, uint32_t Id) { RecType = Type; RecordId = Id; }
  76         void ParseHeader(const Data &data, size_t &offset);
  77         void ParseFields(const Data &data, size_t &offset);
  78         void BuildHeader(Data &data, size_t &offset) const;
  79         void BuildFields(Data &data, size_t &offset) const;
  80
  81         void Clear();
  82
  83         void Dump(std::ostream &os) const;
  84
  85         // sorting
  86         bool operator<(const PINMessage &other) const { return Subject < other.Subject; }
  87
  88         // database name
  89         static const char * GetDBName() { return "PIN Messages"; }
  90         static uint8_t GetDefaultRecType() { return 0; }
  91 };
  92
  93 inline std::ostream& operator<<(std::ostream &os, const PINMessage &msg) {
  94         msg.Dump(os);
  95         return os;
  96 }
  97
  98 std::ostream& operator<<(std::ostream &os, const Address &msga);
  99
 100
 101 /// @}
 102
 103 } // namespace Barry
 104
 105 #endif // __BARRY_RECORD_PIN_MESSAGE_H__
 106
 107