menu: added new Keywords tag to .desktop files
[barry.git] / src / r_sms.h
blob3879fb3598f3cf7cf74ffed6eae6ac5170bc8e05
1 ///
2 /// \file r_sms.h
3 /// Record parsing class for SMS messages.
4 ///
6 /*
7 Copyright (C) 2005-2013, Net Direct Inc. (http://www.netdirect.ca/)
8 Copyright (C) 2009, Ryan Li(ryan@ryanium.com)
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.
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.
19 See the GNU General Public License in the COPYING file at the
20 root directory of this project for more details.
23 #ifndef __BARRY_RECORD_SMS_H__
24 #define __BARRY_RECORD_SMS_H__
26 #include "dll.h"
27 #include "record.h"
28 #include <vector>
29 #include <string>
30 #include <stdint.h>
32 namespace Barry {
34 // forward declarations
35 class IConverter;
37 class BXEXPORT Sms
39 public:
40 typedef Barry::UnknownsType UnknownsType;
42 uint8_t RecType;
43 uint32_t RecordId;
45 enum MessageType
47 Unknown = 0,
48 Received,
49 Sent,
50 Draft
52 MessageType MessageStatus;
54 enum DeliveryType
56 NoReport = 0,
57 Failed,
58 Succeeded
60 DeliveryType DeliveryStatus; // not implemented yet
62 bool IsNew;
63 bool NewConversation;
64 bool Saved;
65 bool Deleted;
66 bool Opened;
68 uint64_t Timestamp; // milliseconds from Jan 1, 1970
69 uint64_t ServiceCenterTimestamp; // not applicable for non-incoming messages
71 enum DataCodingSchemeType
73 SevenBit = 0,
74 EightBit,
75 UCS2
77 DataCodingSchemeType DataCodingScheme;
79 uint32_t ErrorId;
81 EmailList Addresses; //< not strictly email, but just a list
82 //< strings, used for phone numbers
83 std::string Body;
85 UnknownsType Unknowns;
87 public:
88 Sms();
89 ~Sms();
91 time_t GetTime() const;
92 time_t GetServiceCenterTime() const;
93 void SetTime(const time_t timestamp, unsigned int milliseconds = 0);
94 void SetServiceCenterTime(const time_t timestamp, unsigned int milliseconds = 0);
96 // Parser / Builder API (see parser.h / builder.h)
97 void Validate() const;
98 const unsigned char* ParseField(const unsigned char *begin, const unsigned char *end, const IConverter *ic = 0);
99 uint8_t GetRecType() const { return RecType; }
100 uint32_t GetUniqueId() const { return RecordId; }
101 void SetIds(uint8_t Type, uint32_t Id) { RecType = Type; RecordId = Id; }
102 void ParseHeader(const Data &data, size_t &offset);
103 void ParseFields(const Data &data, size_t &offset, const IConverter *ic = 0);
104 void BuildHeader(Data &data, size_t &offset) const;
105 void BuildFields(Data &data, size_t &offset, const IConverter *ic = 0) const;
107 // operations (common among record classes)
108 void Clear();
109 void Dump(std::ostream &os) const;
110 std::string GetDescription() const;
112 static std::string ConvertGsmToUtf8(const std::string &);
114 // sorting
115 bool operator<(const Sms &other) const {
116 return Timestamp < other.Timestamp;
119 // database name
120 static const char * GetDBName() { return "SMS Messages"; }
121 static uint8_t GetDefaultRecType() { return 5; }
123 // Generic Field Handle support
124 static const FieldHandle<Sms>::ListT& GetFieldHandles();
127 BXEXPORT inline std::ostream& operator<<(std::ostream &os, const Sms &msg) {
128 msg.Dump(os);
129 return os;
132 } // namespace Barry
134 #endif