src/r_contact.h

   1 ///
   2 /// \file       r_contact.h
   3 ///             Blackberry database record parser class for contact records.
   4 ///
   5
   6 /*
   7     Copyright (C) 2005-2010, Net Direct Inc. (http://www.netdirect.ca/)
   8
   9     This program is free software; you can redistribute it and/or modify
  10     it under the terms of the GNU General Public License as published by
  11     the Free Software Foundation; either version 2 of the License, or
  12     (at your option) any later version.
  13
  14     This program is distributed in the hope that it will be useful,
  15     but WITHOUT ANY WARRANTY; without even the implied warranty of
  16     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  17
  18     See the GNU General Public License in the COPYING file at the
  19     root directory of this project for more details.
  20 */
  21
  22 #ifndef __BARRY_RECORD_CONTACT_H__
  23 #define __BARRY_RECORD_CONTACT_H__
  24
  25 #include "dll.h"
  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 // forward declarations
  36 class IConverter;
  37
  38 //
  39 // NOTE:  All classes here must be container-safe!  Perhaps add sorting
  40 //        operators in the future.
  41 //
  42
  43 struct BXEXPORT ContactGroupLink
  44 {
  45         uint32_t Link;
  46         uint16_t Unknown;
  47
  48         ContactGroupLink() : Link(0), Unknown(0) {}
  49         ContactGroupLink(uint32_t link, uint16_t unknown)
  50                 : Link(link), Unknown(unknown)
  51         {}
  52 };
  53
  54 /// \addtogroup RecordParserClasses
  55 /// @{
  56
  57 //
  58 // Contact record class
  59 //
  60 /// Represents a single record in the Address Book Blackberry database.
  61 ///
  62 class BXEXPORT Contact
  63 {
  64 public:
  65         typedef Barry::CategoryList                     CategoryList;
  66         typedef ContactGroupLink                        GroupLink;
  67         typedef std::vector<GroupLink>                  GroupLinksType;
  68         typedef std::vector<UnknownField>               UnknownsType;
  69         typedef std::string                             EmailType;
  70         typedef std::vector<EmailType>                  EmailList;
  71
  72         //
  73         // Record fields
  74         //
  75
  76         // contact specific data
  77         uint8_t RecType;
  78         uint32_t RecordId;
  79         EmailList EmailAddresses;
  80
  81         /// This field, Phone, is deprecated.  It is possible
  82         /// to write to this field to the Blackberry,
  83         /// but modern devices won't let you add it
  84         /// through their GUIs.  This field only seems
  85         /// to exist on the 7750.  While other devices
  86         /// accept the field and display it, it is
  87         /// not accessible by default.
  88         std::string Phone;
  89
  90         std::string
  91                 Fax,
  92                 WorkPhone,
  93                 HomePhone,
  94                 MobilePhone,
  95                 Pager,
  96                 PIN,
  97                 Radio,
  98                 WorkPhone2,
  99                 HomePhone2,
 100                 OtherPhone,
 101                 FirstName,
 102                 LastName,
 103                 Company,
 104                 DefaultCommunicationsMethod,
 105                 JobTitle,
 106                 PublicKey,
 107                 URL,
 108                 Prefix,
 109                 Notes,
 110                 UserDefined1,
 111                 UserDefined2,
 112                 UserDefined3,
 113                 UserDefined4,
 114                 Image;
 115
 116         Date Birthday;
 117         Date Anniversary;
 118
 119         PostalAddress WorkAddress;
 120         PostalAddress HomeAddress;
 121
 122         // Categories are not allowed to have commas in them.
 123         // A category name containing a comma will be split into
 124         // two categories, not only by this library, but by the
 125         // device itself.
 126         CategoryList Categories;
 127
 128         GroupLinksType GroupLinks;
 129         UnknownsType Unknowns;
 130
 131 private:
 132         bool m_FirstNameSeen;
 133
 134 public:
 135         const unsigned char* ParseField(const unsigned char *begin,
 136                 const unsigned char *end, const IConverter *ic = 0);
 137
 138 public:
 139         Contact();
 140         ~Contact();
 141
 142         uint32_t GetID() const { return RecordId; }
 143         std::string GetFullName() const;
 144         const std::string& GetEmail(unsigned int index = 0) const;
 145
 146         // Parser / Builder API (see parser.h / builder.h)
 147         uint8_t GetRecType() const { return RecType; }
 148         uint32_t GetUniqueId() const { return RecordId; }
 149         void SetIds(uint8_t Type, uint32_t Id) { RecType = Type; RecordId = Id; }
 150         void ParseHeader(const Data &data, size_t &offset);
 151         void ParseFields(const Data &data, size_t &offset, const IConverter *ic = 0);
 152         void BuildHeader(Data &data, size_t &offset) const;
 153         void BuildFields(Data &data, size_t &offset, const IConverter *ic = 0) const;
 154
 155         void Clear();                   // erase everything
 156
 157         void Dump(std::ostream &os) const;
 158
 159         // Sorting - use enough data to make the sorting as
 160         //           consistent as possible
 161         bool operator<(const Contact &other) const;
 162
 163         // database name
 164         static const char * GetDBName() { return "Address Book"; }
 165         static uint8_t GetDefaultRecType() { return 0; }
 166
 167         // helpers
 168         static void SplitName(const std::string &full, std::string &first, std::string &last);
 169 };
 170
 171 BXEXPORT inline std::ostream& operator<< (std::ostream &os, const Contact &contact) {
 172         contact.Dump(os);
 173         return os;
 174 }
 175
 176 /// @}
 177
 178 } // namespace Barry
 179
 180 #endif
 181