lib: added HomeFax, MobilePhone2, and Nickname fields to Contact record
[barry.git] / src / r_contact.cc
blobc5ad577212cb94c15e78c3cc2273648487d54167
1 ///
2 /// \file r_contact.cc
3 /// Blackberry database record parser class for contact records.
4 ///
6 /*
7 Copyright (C) 2005-2010, Net Direct Inc. (http://www.netdirect.ca/)
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.
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.
18 See the GNU General Public License in the COPYING file at the
19 root directory of this project for more details.
22 #include "r_contact.h"
23 #include "record-internal.h"
24 #include "protocol.h"
25 #include "protostructs.h"
26 #include "data.h"
27 #include "time.h"
28 #include "error.h"
29 #include "endian.h"
30 #include "iconv.h"
31 #include <ostream>
32 #include <iomanip>
33 #include <time.h>
34 #include <stdexcept>
36 #define __DEBUG_MODE__
37 #include "debug.h"
39 using namespace std;
40 using namespace Barry::Protocol;
42 namespace Barry {
46 ///////////////////////////////////////////////////////////////////////////////
47 // Contact class
49 // Contact field codes
50 #define CFC_EMAIL 1
51 #define CFC_PHONE 2
52 #define CFC_FAX 3
53 #define CFC_WORK_PHONE 6
54 #define CFC_HOME_PHONE 7
55 #define CFC_MOBILE_PHONE 8
56 #define CFC_PAGER 9
57 #define CFC_PIN 10
58 #define CFC_RADIO 14 // 0x0e
59 #define CFC_WORK_PHONE_2 16 // 0x10
60 #define CFC_HOME_PHONE_2 17 // 0x11
61 #define CFC_OTHER_PHONE 18 // 0x12
62 #define CFC_MOBILE_PHONE_2 19 // 0x13
63 #define CFC_HOME_FAX 20 // 0x14
64 #define CFC_NAME 32 // 0x20 used twice, in first/last name order
65 #define CFC_COMPANY 33
66 #define CFC_DEFAULT_COMM_METHOD 34
67 #define CFC_ADDRESS1 35
68 #define CFC_ADDRESS2 36
69 #define CFC_ADDRESS3 37
70 #define CFC_CITY 38
71 #define CFC_PROVINCE 39
72 #define CFC_POSTAL_CODE 40
73 #define CFC_COUNTRY 41
74 #define CFC_TITLE 42 // 0x2a
75 #define CFC_PUBLIC_KEY 43
76 #define CFC_GROUP_FLAG 44
77 #define CFC_GROUP_LINK 52
78 #define CFC_URL 54 // 0x36
79 #define CFC_PREFIX 55 // 0x37
80 #define CFC_CATEGORY 59 // 0x3B
81 #define CFC_HOME_ADDRESS1 61 // 0x3D
82 #define CFC_HOME_ADDRESS2 62 // 0x3E
83 // If the address 3 isn't mapped then it appears
84 // in the same field as address2 with a space
85 #define CFC_HOME_ADDRESS3 63 // 0x3F
86 #define CFC_NOTES 64 // 0x40
87 #define CFC_USER_DEFINED_1 65 // 0x41
88 #define CFC_USER_DEFINED_2 66 // 0x42
89 #define CFC_USER_DEFINED_3 67 // 0x43
90 #define CFC_USER_DEFINED_4 68 // 0x44
91 #define CFC_HOME_CITY 69 // 0x45
92 #define CFC_HOME_PROVINCE 70 // 0x46
93 #define CFC_HOME_POSTAL_CODE 71 // 0x47
94 #define CFC_HOME_COUNTRY 72 // 0x48
95 #define CFC_IMAGE 77 // 0x4D
96 #define CFC_BIRTHDAY 82 // 0x52
97 #define CFC_ANNIVERSARY 83 // 0x53
98 #define CFC_UNIQUEID 85 // 0x55
99 #define CFC_NICKNAME 86 // 0x56
100 #define CFC_INVALID_FIELD 255
102 // Contact code to field table
103 static FieldLink<Contact> ContactFieldLinks[] = {
104 { CFC_NICKNAME, "Nickname", 0,0, &Contact::Nickname, 0, 0, 0, 0, true },
105 { CFC_PHONE, "Phone", 0,0, &Contact::Phone, 0, 0, 0, 0, true },
106 { CFC_FAX, "Fax", "facsimileTelephoneNumber",0, &Contact::Fax, 0, 0, 0, 0, true },
107 { CFC_HOME_FAX, "HomeFax", 0,0, &Contact::HomeFax, 0, 0, 0, 0, true },
108 { CFC_WORK_PHONE, "WorkPhone", "telephoneNumber",0, &Contact::WorkPhone, 0, 0, 0, 0, true },
109 { CFC_HOME_PHONE, "HomePhone", "homePhone",0, &Contact::HomePhone, 0, 0, 0, 0, true },
110 { CFC_MOBILE_PHONE, "MobilePhone","mobile",0, &Contact::MobilePhone, 0, 0, 0, 0, true },
111 { CFC_MOBILE_PHONE_2,"MobilePhone2",0,0, &Contact::MobilePhone2, 0, 0, 0, 0, true },
112 { CFC_PAGER, "Pager", "pager",0, &Contact::Pager, 0, 0, 0, 0, true },
113 { CFC_PIN, "PIN", 0,0, &Contact::PIN, 0, 0, 0, 0, true },
114 { CFC_RADIO, "Radio", 0,0, &Contact::Radio, 0, 0, 0, 0, true },
115 { CFC_WORK_PHONE_2, "WorkPhone2", 0,0, &Contact::WorkPhone2, 0, 0, 0, 0, true },
116 { CFC_HOME_PHONE_2, "HomePhone2", 0,0, &Contact::HomePhone2, 0, 0, 0, 0, true },
117 { CFC_OTHER_PHONE, "OtherPhone", 0,0, &Contact::OtherPhone, 0, 0, 0, 0, true },
118 { CFC_COMPANY, "Company", "o",0, &Contact::Company, 0, 0, 0, 0, true },
119 { CFC_DEFAULT_COMM_METHOD,"DefaultCommMethod",0,0, &Contact::DefaultCommunicationsMethod, 0, 0, 0, 0, true },
120 { CFC_ADDRESS1, "WorkAddress1", 0,0, 0, 0, 0, &Contact::WorkAddress, &PostalAddress::Address1, true },
121 { CFC_ADDRESS2, "WorkAddress2", 0,0, 0, 0, 0, &Contact::WorkAddress, &PostalAddress::Address2, true },
122 { CFC_ADDRESS3, "WorkAddress3", 0,0, 0, 0, 0, &Contact::WorkAddress, &PostalAddress::Address3, true },
123 { CFC_CITY, "WorkCity", "l",0, 0, 0, 0, &Contact::WorkAddress, &PostalAddress::City, true },
124 { CFC_PROVINCE, "WorkProvince", "st",0, 0, 0, 0, &Contact::WorkAddress, &PostalAddress::Province, true },
125 { CFC_POSTAL_CODE, "WorkPostalCode", "postalCode",0, 0, 0, 0, &Contact::WorkAddress, &PostalAddress::PostalCode, true },
126 { CFC_COUNTRY, "WorkCountry", "c", "country", 0, 0, 0, &Contact::WorkAddress, &PostalAddress::Country, true },
127 { CFC_TITLE, "JobTitle", "title",0, &Contact::JobTitle, 0, 0, 0, 0, true },
128 { CFC_PUBLIC_KEY, "PublicKey", 0,0, &Contact::PublicKey, 0, 0, 0, 0, false },
129 { CFC_URL, "URL", 0,0, &Contact::URL, 0, 0, 0, 0, true },
130 { CFC_PREFIX, "Prefix", 0,0, &Contact::Prefix, 0, 0, 0, 0, true },
131 { CFC_HOME_ADDRESS1,"HomeAddress1", 0,0, 0, 0, 0, &Contact::HomeAddress, &PostalAddress::Address1, true },
132 { CFC_HOME_ADDRESS2,"HomeAddress2", 0,0, 0, 0, 0, &Contact::HomeAddress, &PostalAddress::Address2, true },
133 { CFC_HOME_ADDRESS3,"HomeAddress3", 0,0, 0, 0, 0, &Contact::HomeAddress, &PostalAddress::Address3, true },
134 { CFC_NOTES, "Notes", 0,0, &Contact::Notes, 0, 0, 0, 0, true },
135 { CFC_USER_DEFINED_1, "UserDefined1", 0,0, &Contact::UserDefined1, 0, 0, 0, 0, true },
136 { CFC_USER_DEFINED_2, "UserDefined2", 0,0, &Contact::UserDefined2, 0, 0, 0, 0, true },
137 { CFC_USER_DEFINED_3, "UserDefined3", 0,0, &Contact::UserDefined3, 0, 0, 0, 0, true },
138 { CFC_USER_DEFINED_4, "UserDefined4", 0,0, &Contact::UserDefined4, 0, 0, 0, 0, true },
139 { CFC_HOME_CITY, "HomeCity", 0,0, 0, 0, 0, &Contact::HomeAddress, &PostalAddress::City, true },
140 { CFC_HOME_PROVINCE,"HomeProvince", 0,0, 0, 0, 0, &Contact::HomeAddress, &PostalAddress::Province, true },
141 { CFC_HOME_POSTAL_CODE, "HomePostalCode", 0,0, 0, 0, 0, &Contact::HomeAddress, &PostalAddress::PostalCode, true },
142 { CFC_HOME_COUNTRY, "HomeCountry",0,0, 0, 0, 0, &Contact::HomeAddress, &PostalAddress::Country, true },
143 { CFC_IMAGE, "Image", 0,0, &Contact::Image, 0, 0, 0, 0, false },
144 { CFC_INVALID_FIELD,"EndOfList", 0, 0, 0, 0, 0, 0, 0, false }
147 Contact::Contact()
148 : RecType(Contact::GetDefaultRecType()),
149 RecordId(0),
150 m_FirstNameSeen(false)
154 Contact::~Contact()
158 const unsigned char* Contact::ParseField(const unsigned char *begin,
159 const unsigned char *end,
160 const IConverter *ic)
162 const CommonField *field = (const CommonField *) begin;
164 // advance and check size
165 begin += COMMON_FIELD_HEADER_SIZE + btohs(field->size);
166 if( begin > end ) // if begin==end, we are ok
167 return begin;
169 if( !btohs(field->size) ) // if field has no size, something's up
170 return begin;
172 // cycle through the type table
173 for( FieldLink<Contact> *b = ContactFieldLinks;
174 b->type != CFC_INVALID_FIELD;
175 b++ )
177 if( b->type == field->type ) {
178 if( b->strMember ) {
179 std::string &s = this->*(b->strMember);
180 s = ParseFieldString(field);
181 if( b->iconvNeeded && ic )
182 s = ic->FromBB(s);
183 return begin; // done!
185 else if( b->postMember && b->postField ) {
186 std::string &s = (this->*(b->postMember)).*(b->postField);
187 s = ParseFieldString(field);
188 if( b->iconvNeeded && ic )
189 s = ic->FromBB(s);
190 return begin;
192 else {
193 break; // fall through to special handling
198 // if not found in the type table, check for special handling
199 switch( field->type )
201 case CFC_EMAIL: {
202 std::string s = ParseFieldString(field);
203 if( ic )
204 s = ic->FromBB(s);
205 EmailAddresses.push_back( s );
207 return begin;
209 case CFC_NAME: {
210 // can be used multiple times, for first/last names
211 std::string *name;
212 if( FirstName.size() || m_FirstNameSeen ) {
213 // first name already filled, use last name
214 name = &LastName;
215 m_FirstNameSeen = false;
217 else {
218 name = &FirstName;
219 m_FirstNameSeen = true;
222 *name = ParseFieldString(field);
223 if( ic )
224 *name = ic->FromBB(*name);
226 return begin;
228 case CFC_GROUP_LINK:
229 // just add the unique ID to the list
230 GroupLinks.push_back(
231 GroupLink(field->u.link.uniqueId,
232 field->u.link.unknown));
233 return begin;
235 case CFC_GROUP_FLAG:
236 // ignore the group flag... the presense of group link items
237 // behaves as the flag in this class
238 return begin;
240 case CFC_CATEGORY: {
241 std::string catstring = ParseFieldString(field);
242 if( ic )
243 catstring = ic->FromBB(catstring);
244 Categories.CategoryStr2List(catstring);
246 return begin;
248 case CFC_BIRTHDAY: {
249 std::string bstring = ParseFieldString(field);
250 Birthday.FromBBString(bstring);
252 return begin;
254 case CFC_ANNIVERSARY: {
255 std::string astring = ParseFieldString(field);
256 Anniversary.FromBBString(astring);
258 return begin;
261 // if still not handled, add to the Unknowns list
262 UnknownField uf;
263 uf.type = field->type;
264 uf.data.assign((const char*)field->u.raw, btohs(field->size));
265 Unknowns.push_back(uf);
267 // return new pointer for next field
268 return begin;
271 void Contact::ParseHeader(const Data &data, size_t &offset)
273 // no header to parse in Contact records
276 void Contact::ParseFields(const Data &data, size_t &offset, const IConverter *ic)
278 const unsigned char *finish = ParseCommonFields(*this,
279 data.GetData() + offset, data.GetData() + data.GetSize(), ic);
280 offset += finish - (data.GetData() + offset);
283 void Contact::BuildHeader(Data &data, size_t &offset) const
285 // no header in Contact records
289 // BuildFields
291 /// Build fields part of record
293 void Contact::BuildFields(Data &data, size_t &offset, const IConverter *ic) const
295 data.Zap();
297 // Sanity check: the Blackberry requires at least a name or
298 // a company name for each address record.
299 if( !GetFullName().size() && !Company.size() )
300 throw BadData("Contact must have name or company name.");
302 // check if this is a group link record, and if so, output
303 // the group flag
304 if( GroupLinks.size() )
305 BuildField(data, offset, CFC_GROUP_FLAG, 'G');
307 // special fields not in type table
308 if( FirstName.size() ) {
309 std::string s = ic ? ic->ToBB(FirstName) : FirstName;
310 BuildField(data, offset, CFC_NAME, s);
312 if( LastName.size() ) {
313 if( !FirstName.size() ) {
314 // order matters with first/last name, and if
315 // last name exists, and first name doesn't,
316 // insert blank first name ahead of it
317 BuildField(data, offset, CFC_NAME, "");
319 BuildField(data, offset, CFC_NAME, ic ? ic->ToBB(LastName) : LastName);
322 // FIXME
323 // // add unknown data
324 // char buffer[] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
325 // BuildField(data, offset, 0x54, buffer, 8);
327 // With the BlackBerry Storm, I have to add this entry.
328 // Otherwise the uniqueId of this contact is reseted !
329 // The device seems accept the multiple contact with the same uniqueId,
330 // but the synchronization process uses this uniqueId to identify the contact.
331 // add uniqueId
332 BuildField(data, offset, CFC_UNIQUEID, RecordId);
334 // add all email addresses
335 EmailList::const_iterator eai = EmailAddresses.begin();
336 for( ; eai != EmailAddresses.end(); ++eai ) {
337 if( eai->size() ) {
338 BuildField(data, offset, CFC_EMAIL, ic ? ic->ToBB(*eai) : *eai);
342 // cycle through the type table
343 for( FieldLink<Contact> *b = ContactFieldLinks;
344 b->type != CFC_INVALID_FIELD;
345 b++ )
347 // print only fields with data
348 if( b->strMember ) {
349 const std::string &field = this->*(b->strMember);
350 if( field.size() ) {
351 std::string s = (b->iconvNeeded && ic) ? ic->ToBB(field) : field;
352 BuildField(data, offset, b->type, s);
355 else if( b->postMember && b->postField ) {
356 const std::string &field = (this->*(b->postMember)).*(b->postField);
357 if( field.size() ) {
358 std::string s = (b->iconvNeeded && ic) ? ic->ToBB(field) : field;
359 BuildField(data, offset, b->type, s);
364 // save any group links
365 GroupLinksType::const_iterator
366 gb = GroupLinks.begin(), ge = GroupLinks.end();
367 for( ; gb != ge; gb++ ) {
368 Barry::Protocol::GroupLink link;
369 link.uniqueId = htobl(gb->Link);
370 link.unknown = htobs(gb->Unknown);
371 BuildField(data, offset, CFC_GROUP_LINK, link);
374 // save categories
375 if( Categories.size() ) {
376 string store;
377 Categories.CategoryList2Str(store);
378 BuildField(data, offset, CFC_CATEGORY, ic ? ic->ToBB(store) : store);
381 // save Birthday and Anniversary
382 if( Birthday.HasData() )
383 BuildField(data, offset, CFC_BIRTHDAY, Birthday.ToBBString());
384 if( Anniversary.HasData() )
385 BuildField(data, offset, CFC_ANNIVERSARY, Anniversary.ToBBString());
387 // and finally save unknowns
388 UnknownsType::const_iterator
389 ub = Unknowns.begin(), ue = Unknowns.end();
390 for( ; ub != ue; ub++ ) {
391 BuildField(data, offset, *ub);
394 data.ReleaseBuffer(offset);
397 void Contact::Clear()
399 RecType = GetDefaultRecType();
400 RecordId = 0;
402 EmailAddresses.clear();
403 Phone.clear();
405 Fax.clear();
406 HomeFax.clear();
407 WorkPhone.clear();
408 HomePhone.clear();
409 MobilePhone.clear();
410 MobilePhone2.clear();
411 Pager.clear();
412 PIN.clear();
413 Radio.clear();
414 WorkPhone2.clear();
415 HomePhone2.clear();
416 OtherPhone.clear();
417 FirstName.clear();
418 LastName.clear();
419 Company.clear();
420 DefaultCommunicationsMethod.clear();
421 JobTitle.clear();
422 PublicKey.clear();
423 URL.clear();
424 Prefix.clear();
425 Notes.clear();
426 UserDefined1.clear();
427 UserDefined2.clear();
428 UserDefined3.clear();
429 UserDefined4.clear();
430 Image.clear();
431 Nickname.clear();
433 Birthday.Clear();
434 Anniversary.Clear();
436 WorkAddress.Clear();
437 HomeAddress.Clear();
439 Categories.clear();
441 GroupLinks.clear();
442 Unknowns.clear();
444 m_FirstNameSeen = false;
448 // GetFullName
450 /// Helper function that returns a formatted full name
452 std::string Contact::GetFullName() const
454 std::string Full = FirstName;
455 if( Full.size() && LastName.size() )
456 Full += " ";
457 Full += LastName;
458 return Full;
462 // GetEmail
464 /// Helper function that always returns a valid string. The string
465 /// may be empty if there is no address at the specified index.
467 const std::string& Contact::GetEmail(unsigned int index) const
469 static const std::string blank;
470 if( index < EmailAddresses.size() )
471 return EmailAddresses[index];
472 return blank;
475 void Contact::Dump(std::ostream &os) const
477 ios::fmtflags oldflags = os.setf(ios::left);
478 char fill = os.fill(' ');
480 os << "Contact: 0x" << setbase(16) << GetID()
481 << " (" << (unsigned int)RecType << ")\n";
483 // special fields not in type table
484 os << " " << setw(20) << "FirstName";
485 os << ": " << FirstName << "\n";
486 os << " " << setw(20) << "LastName";
487 os << ": " << LastName << "\n";
489 // cycle through email addresses
490 EmailList::const_iterator eai = EmailAddresses.begin();
491 for( ; eai != EmailAddresses.end(); ++eai ) {
492 if( eai->size() ) {
493 os << " Email : " << *eai << "\n";
497 // cycle through the type table
498 for( FieldLink<Contact> *b = ContactFieldLinks;
499 b->type != CFC_INVALID_FIELD;
500 b++ )
502 // special case: don't dump the raw image data, but
503 // leave that for a special hex dump
504 if( b->type == CFC_IMAGE )
505 continue;
507 const std::string *pField = 0;
508 if( b->strMember ) {
509 pField = &(this->*(b->strMember));
511 else if( b->postMember && b->postField ) {
512 pField = &((this->*(b->postMember)).*(b->postField));
515 // print only fields with data
516 if( pField && pField->size() ) {
517 os << " " << setw(20) << b->name;
518 os << ": " << Cr2LfWrapper(*pField) << "\n";
522 if( Categories.size() ) {
523 string display;
524 Categories.CategoryList2Str(display);
525 os << " Categories : " << display << "\n";
528 // print Birthday and Anniversary
529 if( Birthday.HasData() ) {
530 os << " Birthday : " << Birthday << "\n";
532 if( Anniversary.HasData() ) {
533 os << " Anniversary : " << Anniversary << "\n";
536 // print any group links
537 GroupLinksType::const_iterator
538 gb = GroupLinks.begin(), ge = GroupLinks.end();
539 if( gb != ge )
540 os << " GroupLinks:\n";
541 for( ; gb != ge; gb++ ) {
542 os << " ID: 0x" << setbase(16) << gb->Link << "\n";
545 // print Image in hex dump format, if available
546 if( Image.size() ) {
547 Data image(Image.data(), Image.size());
548 os << " Photo image:\n";
549 os << image << "\n";
552 // and finally print unknowns
553 os << Unknowns;
555 // cleanup the stream
556 os.flags(oldflags);
557 os.fill(fill);
560 bool Contact::operator<(const Contact &other) const
562 // old sorting mechanism, to put group links at the bottom
563 //return GroupLinks.size() == 0 && other.GroupLinks.size() > 0;
564 // testing - put group links at the top
565 //return GroupLinks.size() > 0 && other.GroupLinks.size() == 0;
567 // usually one of these fields is filled in, so compare
568 // them all in a ( LastName + FirstName + Company ) key style
569 int cmp = LastName.compare(other.LastName);
570 if( cmp == 0 )
571 cmp = FirstName.compare(other.FirstName);
572 if( cmp == 0 )
573 cmp = Company.compare(other.Company);
574 return cmp < 0;
577 void Contact::SplitName(const std::string &full, std::string &first, std::string &last)
579 first.clear();
580 last.clear();
582 string::size_type pos = full.find_last_of(' ');
583 if( pos != string::npos ) {
584 // has space, assume last word is last name
585 last = full.c_str() + pos + 1;
586 first = full.substr(0, pos);
588 else {
589 // no space, assume only first name
590 first = full.substr(0);
594 } // namespace Barry