src/r_sms.h

   1 ///
   2 /// \file       r_sms.h
   3 ///             Record parsing class for SMS messages.
   4 ///
   5
   6 /*
   7     Copyright (C) 2005-2013, Net Direct Inc. (http://www.netdirect.ca/)
   8     Copyright (C) 2009, Ryan Li(ryan@ryanium.com)
   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_SMS_H__
  24 #define __BARRY_RECORD_SMS_H__
  25
  26 #include "dll.h"
  27 #include "record.h"
  28 #include <vector>
  29 #include <string>
  30 #include <stdint.h>
  31
  32 namespace Barry {
  33
  34 // forward declarations
  35 class IConverter;
  36
  37 class BXEXPORT Sms
  38 {
  39 public:
  40         typedef Barry::UnknownsType                     UnknownsType;
  41
  42         uint8_t RecType;
  43         uint32_t RecordId;
  44
  45         enum MessageType
  46         {
  47                 Unknown = 0,
  48                 Received,
  49                 Sent,
  50                 Draft
  51         };
  52         MessageType MessageStatus;
  53
  54         enum DeliveryType
  55         {
  56                 NoReport = 0,
  57                 Failed,
  58                 Succeeded
  59         };
  60         DeliveryType DeliveryStatus; // not implemented yet
  61
  62         bool IsNew;
  63         bool NewConversation;
  64         bool Saved;
  65         bool Deleted;
  66         bool Opened;
  67
  68         uint64_t Timestamp; // milliseconds from Jan 1, 1970
  69         uint64_t ServiceCenterTimestamp; // not applicable for non-incoming messages
  70
  71         enum DataCodingSchemeType
  72         {
  73                 SevenBit = 0,
  74                 EightBit,
  75                 UCS2
  76         };
  77         DataCodingSchemeType DataCodingScheme;
  78
  79         uint32_t ErrorId;
  80
  81         EmailList Addresses;            //< not strictly email, but just a list
  82                                         //< strings, used for phone numbers
  83         std::string Body;
  84
  85         UnknownsType Unknowns;
  86
  87 public:
  88         Sms();
  89         ~Sms();
  90
  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);
  95
  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;
 106
 107         // operations (common among record classes)
 108         void Clear();
 109         void Dump(std::ostream &os) const;
 110         std::string GetDescription() const;
 111
 112         static std::string ConvertGsmToUtf8(const std::string &);
 113
 114         // sorting
 115         bool operator<(const Sms &other) const {
 116                 return Timestamp < other.Timestamp;
 117         }
 118
 119         // database name
 120         static const char * GetDBName() { return "SMS Messages"; }
 121         static uint8_t GetDefaultRecType() { return 5; }
 122
 123         // Generic Field Handle support
 124         static const FieldHandle<Sms>::ListT& GetFieldHandles();
 125 };
 126
 127 BXEXPORT inline std::ostream& operator<<(std::ostream &os, const Sms &msg) {
 128         msg.Dump(os);
 129         return os;
 130 }
 131
 132 } // namespace Barry
 133
 134 #endif
 135