src/r_contact.cc

   1 ///
   2 /// \file       r_contact.cc
   3 ///             Blackberry database record parser class for contact records.
   4 ///
   5
   6 /*
   7     Copyright (C) 2005-2008, 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 #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 <ostream>
  31 #include <iomanip>
  32 #include <time.h>
  33 #include <stdexcept>
  34
  35 #define __DEBUG_MODE__
  36 #include "debug.h"
  37
  38 using namespace std;
  39 using namespace Barry::Protocol;
  40
  41 namespace Barry {
  42
  43
  44
  45 ///////////////////////////////////////////////////////////////////////////////
  46 // Contact class
  47
  48 // Contact field codes
  49 #define CFC_EMAIL               1
  50 #define CFC_PHONE               2
  51 #define CFC_FAX                 3
  52 #define CFC_WORK_PHONE          6
  53 #define CFC_HOME_PHONE          7
  54 #define CFC_MOBILE_PHONE        8
  55 #define CFC_PAGER               9
  56 #define CFC_PIN                 10
  57 #define CFC_RADIO               14      // 0x0e
  58 #define CFC_WORK_PHONE_2        16      // 0x10
  59 #define CFC_HOME_PHONE_2        17      // 0x11
  60 #define CFC_OTHER_PHONE         18      // 0x12
  61 #define CFC_NAME                32      // 0x20 used twice, in first/last name order
  62 #define CFC_COMPANY             33
  63 #define CFC_DEFAULT_COMM_METHOD 34
  64 #define CFC_ADDRESS1            35
  65 #define CFC_ADDRESS2            36
  66 #define CFC_ADDRESS3            37
  67 #define CFC_CITY                38
  68 #define CFC_PROVINCE            39
  69 #define CFC_POSTAL_CODE         40
  70 #define CFC_COUNTRY             41
  71 #define CFC_TITLE               42      // 0x2a
  72 #define CFC_PUBLIC_KEY          43
  73 #define CFC_GROUP_FLAG          44
  74 #define CFC_GROUP_LINK          52
  75 #define CFC_URL                 54      // 0x36
  76 #define CFC_PREFIX              55      // 0x37
  77 #define CFC_CATEGORY            59      // 0x3B
  78 #define CFC_HOME_ADDRESS1       61      // 0x3D
  79 #define CFC_HOME_ADDRESS2       62      // 0x3E
  80   // If the address 3 isn't mapped then it appears
  81   // in the same field as address2 with a space
  82 #define CFC_HOME_ADDRESS3       63      // 0x3F
  83 #define CFC_NOTES               64      // 0x40
  84 #define CFC_USER_DEFINED_1      65      // 0x41
  85 #define CFC_USER_DEFINED_2      66      // 0x42
  86 #define CFC_USER_DEFINED_3      67      // 0x43
  87 #define CFC_USER_DEFINED_4      68      // 0x44
  88 #define CFC_HOME_CITY           69      // 0x45
  89 #define CFC_HOME_PROVINCE       70      // 0x46
  90 #define CFC_HOME_POSTAL_CODE    71      // 0x47
  91 #define CFC_HOME_COUNTRY        72      // 0x48
  92 #define CFC_IMAGE               77      // 0x4D
  93 #define CFC_INVALID_FIELD       255
  94
  95 // Contact code to field table
  96 FieldLink<Contact> ContactFieldLinks[] = {
  97    { CFC_EMAIL,        "Email",      "mail",0,            &Contact::Email, 0, 0 },
  98    { CFC_PHONE,        "Phone",      0,0,                 &Contact::Phone, 0, 0 },
  99    { CFC_FAX,          "Fax",        "facsimileTelephoneNumber",0, &Contact::Fax, 0, 0 },
 100    { CFC_WORK_PHONE,   "WorkPhone",  "telephoneNumber",0, &Contact::WorkPhone, 0, 0 },
 101    { CFC_HOME_PHONE,   "HomePhone",  "homePhone",0,       &Contact::HomePhone, 0, 0 },
 102    { CFC_MOBILE_PHONE, "MobilePhone","mobile",0,          &Contact::MobilePhone, 0, 0 },
 103    { CFC_PAGER,        "Pager",      "pager",0,           &Contact::Pager, 0, 0 },
 104    { CFC_PIN,          "PIN",        0,0,                 &Contact::PIN, 0, 0 },
 105    { CFC_RADIO,        "Radio",      0,0,                 &Contact::Radio, 0, 0 },
 106    { CFC_WORK_PHONE_2, "WorkPhone2", 0,0,                 &Contact::WorkPhone2, 0, 0 },
 107    { CFC_HOME_PHONE_2, "HomePhone2", 0,0,                 &Contact::HomePhone2, 0, 0 },
 108    { CFC_OTHER_PHONE,  "OtherPhone", 0,0,                 &Contact::OtherPhone, 0, 0 },
 109    { CFC_COMPANY,      "Company",    "o",0,               &Contact::Company, 0, 0 },
 110    { CFC_DEFAULT_COMM_METHOD,"DefaultCommMethod",0,0,     &Contact::DefaultCommunicationsMethod, 0, 0 },
 111    { CFC_ADDRESS1,     "WorkAddress1",   0,0,             0, 0, 0, &Contact::WorkAddress, &PostalAddress::Address1 },
 112    { CFC_ADDRESS2,     "WorkAddress2",   0,0,             0, 0, 0, &Contact::WorkAddress, &PostalAddress::Address2 },
 113    { CFC_ADDRESS3,     "WorkAddress3",   0,0,             0, 0, 0, &Contact::WorkAddress, &PostalAddress::Address3 },
 114    { CFC_CITY,         "WorkCity",       "l",0,           0, 0, 0, &Contact::WorkAddress, &PostalAddress::City },
 115    { CFC_PROVINCE,     "WorkProvince",   "st",0,          0, 0, 0, &Contact::WorkAddress, &PostalAddress::Province },
 116    { CFC_POSTAL_CODE,  "WorkPostalCode", "postalCode",0,  0, 0, 0, &Contact::WorkAddress, &PostalAddress::PostalCode },
 117    { CFC_COUNTRY,      "WorkCountry",    "c", "country",  0, 0, 0, &Contact::WorkAddress, &PostalAddress::Country },
 118    { CFC_TITLE,        "JobTitle",   "title",0,           &Contact::JobTitle, 0, 0 },
 119    { CFC_PUBLIC_KEY,   "PublicKey",  0,0,                 &Contact::PublicKey, 0, 0 },
 120    { CFC_URL,          "URL",        0,0,                 &Contact::URL, 0, 0 },
 121    { CFC_PREFIX,       "Prefix",     0,0,                 &Contact::Prefix, 0, 0 },
 122    { CFC_HOME_ADDRESS1,"HomeAddress1", 0,0,               0, 0, 0, &Contact::HomeAddress, &PostalAddress::Address1, },
 123    { CFC_HOME_ADDRESS2,"HomeAddress2", 0,0,               0, 0, 0, &Contact::HomeAddress, &PostalAddress::Address2, },
 124    { CFC_HOME_ADDRESS3,"HomeAddress3", 0,0,               0, 0, 0, &Contact::HomeAddress, &PostalAddress::Address3, },
 125    { CFC_NOTES,        "Notes",      0,0,                 &Contact::Notes, 0, 0 },
 126    { CFC_USER_DEFINED_1, "UserDefined1", 0,0,             &Contact::UserDefined1, 0, 0 },
 127    { CFC_USER_DEFINED_2, "UserDefined2", 0,0,             &Contact::UserDefined2, 0, 0 },
 128    { CFC_USER_DEFINED_3, "UserDefined3", 0,0,             &Contact::UserDefined3, 0, 0 },
 129    { CFC_USER_DEFINED_4, "UserDefined4", 0,0,             &Contact::UserDefined4, 0, 0 },
 130    { CFC_HOME_CITY,    "HomeCity",   0,0,                 0, 0, 0, &Contact::HomeAddress, &PostalAddress::City, },
 131    { CFC_HOME_PROVINCE,"HomeProvince", 0,0,               0, 0, 0, &Contact::HomeAddress, &PostalAddress::Province, },
 132    { CFC_HOME_POSTAL_CODE, "HomePostalCode", 0,0,         0, 0, 0, &Contact::HomeAddress, &PostalAddress::PostalCode, },
 133    { CFC_HOME_COUNTRY, "HomeCountry",0,0,                 0, 0, 0, &Contact::HomeAddress, &PostalAddress::Country, },
 134    { CFC_IMAGE,        "Image",      0,0,                 &Contact::Image, 0, 0 },
 135    { CFC_INVALID_FIELD,"EndOfList",  0, 0, 0 }
 136 };
 137
 138 Contact::Contact()
 139         : RecType(Contact::GetDefaultRecType()),
 140         RecordId(0),
 141         m_FirstNameSeen(false)
 142 {
 143 }
 144
 145 Contact::~Contact()
 146 {
 147 }
 148
 149 const unsigned char* Contact::ParseField(const unsigned char *begin,
 150                                          const unsigned char *end)
 151 {
 152         const CommonField *field = (const CommonField *) begin;
 153
 154         // advance and check size
 155         begin += COMMON_FIELD_HEADER_SIZE + btohs(field->size);
 156         if( begin > end )               // if begin==end, we are ok
 157                 return begin;
 158
 159         if( !btohs(field->size) )       // if field has no size, something's up
 160                 return begin;
 161
 162         // cycle through the type table
 163         for(    FieldLink<Contact> *b = ContactFieldLinks;
 164                 b->type != CFC_INVALID_FIELD;
 165                 b++ )
 166         {
 167                 if( b->type == field->type ) {
 168                         if( b->strMember ) {
 169                                 std::string &s = this->*(b->strMember);
 170                                 s = ParseFieldString(field);
 171                                 return begin;   // done!
 172                         }
 173                         else if( b->postMember && b->postField ) {
 174                                 std::string &s = (this->*(b->postMember)).*(b->postField);
 175                                 s = ParseFieldString(field);
 176                                 return begin;
 177                         }
 178                         else {
 179                                 break;  // fall through to special handling
 180                         }
 181                 }
 182         }
 183
 184         // if not found in the type table, check for special handling
 185         switch( field->type )
 186         {
 187         case CFC_NAME: {
 188                 // can be used multiple times, for first/last names
 189                 std::string *name;
 190                 if( FirstName.size() || m_FirstNameSeen ) {
 191                         // first name already filled, use last name
 192                         name = &LastName;
 193                         m_FirstNameSeen = false;
 194                 }
 195                 else {
 196                         name = &FirstName;
 197                         m_FirstNameSeen = true;
 198                 }
 199
 200                 *name = ParseFieldString(field);
 201                 }
 202                 return begin;
 203
 204         case CFC_GROUP_LINK:
 205                 // just add the unique ID to the list
 206                 GroupLinks.push_back(
 207                         GroupLink(field->u.link.uniqueId,
 208                                 field->u.link.unknown));
 209                 return begin;
 210
 211         case CFC_GROUP_FLAG:
 212                 // ignore the group flag... the presense of group link items
 213                 // behaves as the flag in this class
 214                 return begin;
 215
 216         case CFC_CATEGORY: {
 217                 std::string catstring = ParseFieldString(field);
 218                 CategoryStr2List(catstring, Categories);
 219                 }
 220                 return begin;
 221         }
 222
 223         // if still not handled, add to the Unknowns list
 224         UnknownField uf;
 225         uf.type = field->type;
 226         uf.data.assign((const char*)field->u.raw, btohs(field->size));
 227         Unknowns.push_back(uf);
 228
 229         // return new pointer for next field
 230         return begin;
 231 }
 232
 233 void Contact::ParseHeader(const Data &data, size_t &offset)
 234 {
 235         // no header to parse in Contact records
 236 }
 237
 238 // this is called by the RecordParser<> class, which checks size for us
 239 void Contact::ParseFields(const Data &data, size_t &offset)
 240 {
 241         const unsigned char *finish = ParseCommonFields(*this,
 242                 data.GetData() + offset, data.GetData() + data.GetSize());
 243         offset += finish - (data.GetData() + offset);
 244 }
 245
 246 void Contact::BuildHeader(Data &data, size_t &offset) const
 247 {
 248         // no header in Contact records
 249 }
 250
 251 //
 252 // BuildFields
 253 //
 254 /// Build fields part of record
 255 ///
 256 void Contact::BuildFields(Data &data, size_t &offset) const
 257 {
 258         data.Zap();
 259
 260         // check if this is a group link record, and if so, output
 261         // the group flag
 262         if( GroupLinks.size() )
 263                 BuildField(data, offset, CFC_GROUP_FLAG, 'G');
 264
 265         // special fields not in type table
 266         if( FirstName.size() )
 267                 BuildField(data, offset, CFC_NAME, FirstName);
 268         if( LastName.size() ) {
 269                 if( !FirstName.size() ) {
 270                         // order matters with first/last name, and if
 271                         // last name exists, and first name doesn't,
 272                         // insert blank first name ahead of it
 273                         BuildField(data, offset, CFC_NAME, FirstName);
 274                 }
 275                 BuildField(data, offset, CFC_NAME, LastName);
 276         }
 277
 278         // cycle through the type table
 279         for(    FieldLink<Contact> *b = ContactFieldLinks;
 280                 b->type != CFC_INVALID_FIELD;
 281                 b++ )
 282         {
 283                 // print only fields with data
 284                 if( b->strMember ) {
 285                         const std::string &field = this->*(b->strMember);
 286                         if( field.size() ) {
 287                                 BuildField(data, offset, b->type, field);
 288                         }
 289                 }
 290                 else if( b->postMember && b->postField ) {
 291                         const std::string &field = (this->*(b->postMember)).*(b->postField);
 292                         if( field.size() ) {
 293                                 BuildField(data, offset, b->type, field);
 294                         }
 295                 }
 296         }
 297
 298         // save any group links
 299         GroupLinksType::const_iterator
 300                 gb = GroupLinks.begin(), ge = GroupLinks.end();
 301         for( ; gb != ge; gb++ ) {
 302                 Barry::Protocol::GroupLink link;
 303                 link.uniqueId = htobl(gb->Link);
 304                 link.unknown = htobs(gb->Unknown);
 305                 BuildField(data, offset, CFC_GROUP_LINK, link);
 306         }
 307
 308         if( Categories.size() ) {
 309                 string store;
 310                 CategoryList2Str(Categories, store);
 311                 BuildField(data, offset, CFC_CATEGORY, store);
 312         }
 313
 314         // and finally save unknowns
 315         UnknownsType::const_iterator
 316                 ub = Unknowns.begin(), ue = Unknowns.end();
 317         for( ; ub != ue; ub++ ) {
 318                 BuildField(data, offset, *ub);
 319         }
 320
 321         data.ReleaseBuffer(offset);
 322 }
 323
 324 void Contact::Clear()
 325 {
 326         RecType = Contact::GetDefaultRecType();
 327
 328         Email.clear();
 329         Phone.clear();
 330         Fax.clear();
 331         WorkPhone.clear();
 332         HomePhone.clear();
 333         MobilePhone.clear();
 334         Pager.clear();
 335         PIN.clear();
 336         Radio.clear();
 337         WorkPhone2.clear();
 338         HomePhone2.clear();
 339         OtherPhone.clear();
 340         FirstName.clear();
 341         LastName.clear();
 342         Company.clear();
 343         DefaultCommunicationsMethod.clear();
 344         JobTitle.clear();
 345         PublicKey.clear();
 346         URL.clear();
 347         Prefix.clear();
 348         Notes.clear();
 349         UserDefined1.clear();
 350         UserDefined2.clear();
 351         UserDefined3.clear();
 352         UserDefined4.clear();
 353         Image.clear();
 354
 355         WorkAddress.Clear();
 356         HomeAddress.Clear();
 357
 358         Categories.clear();
 359
 360         GroupLinks.clear();
 361         Unknowns.clear();
 362
 363         m_FirstNameSeen = false;
 364 }
 365
 366 //
 367 // GetFullName
 368 //
 369 /// Helper function that returns a formatted full name
 370 ///
 371 std::string Contact::GetFullName() const
 372 {
 373         std::string Full = FirstName;
 374         if( Full.size() && LastName.size() )
 375                 Full += " ";
 376         Full += LastName;
 377         return Full;
 378 }
 379
 380 void Contact::Dump(std::ostream &os) const
 381 {
 382         ios::fmtflags oldflags = os.setf(ios::left);
 383         char fill = os.fill(' ');
 384
 385         os << "Contact: 0x" << setbase(16) << GetID()
 386                 << " (" << (unsigned int)RecType << ")\n";
 387
 388         // special fields not in type table
 389         os << "    " << setw(20) << "FirstName";
 390         os << ": " << FirstName << "\n";
 391         os << "    " << setw(20) << "LastName";
 392         os << ": " << LastName << "\n";
 393
 394         // cycle through the type table
 395         for(    FieldLink<Contact> *b = ContactFieldLinks;
 396                 b->type != CFC_INVALID_FIELD;
 397                 b++ )
 398         {
 399                 const std::string *pField = 0;
 400                 if( b->strMember ) {
 401                         pField = &(this->*(b->strMember));
 402                 }
 403                 else if( b->postMember && b->postField ) {
 404                         pField = &((this->*(b->postMember)).*(b->postField));
 405                 }
 406
 407                 // print only fields with data
 408                 if( pField && pField->size() ) {
 409                         os << "    " << setw(20) << b->name;
 410                         os << ": " << *pField << "\n";
 411                 }
 412         }
 413
 414         if( Categories.size() ) {
 415                 string display;
 416                 CategoryList2Str(Categories, display);
 417                 os << "    Categories          : " << display << "\n";
 418         }
 419
 420         // print any group links
 421         GroupLinksType::const_iterator
 422                 gb = GroupLinks.begin(), ge = GroupLinks.end();
 423         if( gb != ge )
 424                 os << "    GroupLinks:\n";
 425         for( ; gb != ge; gb++ ) {
 426                 os << "        ID: 0x" << setbase(16) << gb->Link << "\n";
 427         }
 428
 429         // and finally print unknowns
 430         os << Unknowns;
 431
 432         // cleanup the stream
 433         os.flags(oldflags);
 434         os.fill(fill);
 435 }
 436
 437 void Contact::SplitName(const std::string &full, std::string &first, std::string &last)
 438 {
 439         first.clear();
 440         last.clear();
 441
 442         string::size_type pos = full.find_last_of(' ');
 443         if( pos != string::npos ) {
 444                 // has space, assume last word is last name
 445                 last = full.c_str() + pos + 1;
 446                 first = full.substr(0, pos);
 447         }
 448         else {
 449                 // no space, assume only first name
 450                 first = full.substr(0);
 451         }
 452 }
 453
 454 void Contact::CategoryStr2List(const std::string &str,
 455                                Barry::CategoryList &list)
 456 {
 457         // start fresh
 458         list.clear();
 459
 460         if( !str.size() )
 461                 return;
 462
 463         // parse the comma-delimited string to a list, stripping away
 464         // any white space around each category name
 465         string::size_type start = 0, end = 0, delim = str.find(',', start);
 466         while( start != string::npos ) {
 467                 if( delim == string::npos )
 468                         end = str.size() - 1;
 469                 else
 470                         end = delim - 1;
 471
 472                 // strip surrounding whitespace
 473                 while( str[start] == ' ' )
 474                         start++;
 475                 while( end && str[end] == ' ' )
 476                         end--;
 477
 478                 if( start <= end ) {
 479                         string token = str.substr(start, end-start+1);
 480                         list.push_back(token);
 481                 }
 482
 483                 // next
 484                 start = delim;
 485                 if( start != string::npos )
 486                         start++;
 487                 delim = str.find(',', start);
 488         }
 489 }
 490
 491 void Contact::CategoryList2Str(const Barry::CategoryList &list,
 492                                std::string &str)
 493 {
 494         str.clear();
 495
 496         Barry::CategoryList::const_iterator i = list.begin();
 497         for( ; i != list.end(); ++i ) {
 498                 if( str.size() )
 499                         str += ", ";
 500                 str += *i;
 501         }
 502 }
 503
 504 } // namespace Barry
 505