src/r_calendar.cc

   1 ///
   2 /// \file       r_calendar.cc
   3 ///             Blackberry database record parser class for calendar records.
   4 ///
   5
   6 /*
   7     Copyright (C) 2005-2007, 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_calendar.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 // Calendar class
  46
  47 // calendar field codes
  48 #define CALFC_APPT_TYPE_FLAG            0x01
  49 #define CALFC_SUBJECT                   0x02
  50 #define CALFC_NOTES                     0x03
  51 #define CALFC_LOCATION                  0x04
  52 #define CALFC_NOTIFICATION_TIME         0x05
  53 #define CALFC_START_TIME                0x06
  54 #define CALFC_END_TIME                  0x07
  55 #define CALFC_RECURRENCE_DATA           0x0c
  56 #define CALFC_VERSION_DATA              0x10
  57 #define CALFC_NOTIFICATION_DATA         0x1a
  58 #define CALFC_FREEBUSY_FLAG             0x1c
  59 #define CALFC_TIMEZONE_CODE             0x1e    // only seems to show up if recurring
  60 #define CALFC_CLASS_FLAG                0x28    // private flag from outlook
  61 #define CALFC_ALLDAYEVENT_FLAG          0xff
  62 #define CALFC_END                       0xffff
  63
  64 FieldLink<Calendar> CalendarFieldLinks[] = {
  65    { CALFC_SUBJECT,    "Subject",    0, 0,    &Calendar::Subject, 0, 0 },
  66    { CALFC_NOTES,      "Notes",      0, 0,    &Calendar::Notes, 0, 0 },
  67    { CALFC_LOCATION,   "Location",   0, 0,    &Calendar::Location, 0, 0 },
  68    { CALFC_NOTIFICATION_TIME,"Notification Time",0,0, 0, 0, &Calendar::NotificationTime },
  69    { CALFC_START_TIME, "Start Time", 0, 0,    0, 0, &Calendar::StartTime },
  70    { CALFC_END_TIME,   "End Time",   0, 0,    0, 0, &Calendar::EndTime },
  71    { CALFC_END,        "End of List",0, 0,    0, 0, 0 }
  72 };
  73
  74 Calendar::Calendar()
  75 {
  76         Clear();
  77 }
  78
  79 Calendar::~Calendar()
  80 {
  81 }
  82
  83 const unsigned char* Calendar::ParseField(const unsigned char *begin,
  84                                           const unsigned char *end)
  85 {
  86         const CommonField *field = (const CommonField *) begin;
  87
  88         // advance and check size
  89         begin += COMMON_FIELD_HEADER_SIZE + btohs(field->size);
  90         if( begin > end )               // if begin==end, we are ok
  91                 return begin;
  92
  93         if( !btohs(field->size) )       // if field has no size, something's up
  94                 return begin;
  95
  96         // cycle through the type table
  97         for(    FieldLink<Calendar> *b = CalendarFieldLinks;
  98                 b->type != CALFC_END;
  99                 b++ )
 100         {
 101                 if( b->type == field->type ) {
 102                         if( b->strMember ) {
 103                                 std::string &s = this->*(b->strMember);
 104                                 s.assign((const char *)field->u.raw, btohs(field->size)-1);
 105                                 return begin;   // done!
 106                         }
 107                         else if( b->timeMember && btohs(field->size) == 4 ) {
 108                                 time_t &t = this->*(b->timeMember);
 109                                 t = min2time(field->u.min1900);
 110                                 return begin;
 111                         }
 112                 }
 113         }
 114
 115         // handle special cases
 116         switch( field->type )
 117         {
 118         case CALFC_APPT_TYPE_FLAG:
 119                 switch( field->u.raw[0] )
 120                 {
 121                 case 'a':                       // regular non-recurring appointment
 122                         Recurring = false;
 123                         return begin;
 124
 125                 case '*':                       // recurring appointment
 126                         Recurring = true;
 127                         return begin;
 128
 129                 default:
 130                         throw Error("Calendar::ParseField: unknown appointment type");
 131                 }
 132                 break;
 133
 134         case CALFC_ALLDAYEVENT_FLAG:
 135                 AllDayEvent = field->u.raw[0] == 1;
 136                 return begin;
 137
 138         case CALFC_RECURRENCE_DATA:
 139                 if( btohs(field->size) >= CALENDAR_RECURRENCE_DATA_FIELD_SIZE ) {
 140                         // good data
 141                         ParseRecurrenceData(&field->u.raw[0]);
 142                 }
 143                 else {
 144                         // not enough data!
 145                         throw Error("Calendar::ParseField: not enough data in recurrence data field");
 146                 }
 147                 return begin;
 148
 149         case CALFC_TIMEZONE_CODE:
 150                 if( btohs(field->size) == 2 ) {
 151                         // good data
 152                         TimeZoneCode = btohs(field->u.code);
 153                 }
 154                 else {
 155                         throw Error("Calendar::ParseField: not enough data in time zone code field");
 156                 }
 157                 return begin;
 158
 159         case CALFC_FREEBUSY_FLAG:
 160                 FreeBusyFlag = (FreeBusyFlagType)field->u.raw[0];
 161                 if( FreeBusyFlag > OutOfOffice ) {
 162                         throw Error("Calendar::ParseField: FreeBusyFlag out of range" );
 163                 }
 164                 return begin;
 165
 166         case CALFC_CLASS_FLAG:
 167                 ClassFlag = (ClassFlagType)field->u.raw[0];
 168                 if( ClassFlag > Private ) {
 169                         throw Error("Calendar::ParseField: ClassFlag out of range" );
 170                 }
 171                 return begin;
 172         }
 173
 174         // if still not handled, add to the Unknowns list
 175         UnknownField uf;
 176         uf.type = field->type;
 177         uf.data.assign((const char*)field->u.raw, btohs(field->size));
 178         Unknowns.push_back(uf);
 179
 180         // return new pointer for next field
 181         return begin;
 182 }
 183
 184 // this function assumes the size has already been checked
 185 void Calendar::ParseRecurrenceData(const void *data)
 186 {
 187         const CalendarRecurrenceDataField *rec =
 188                 (const CalendarRecurrenceDataField*) data;
 189
 190         Interval = btohs(rec->interval);
 191         if( Interval < 1 )
 192                 Interval = 1;   // must always be >= 1
 193
 194         if( rec->endTime == 0xffffffff ) {
 195                 Perpetual = true;
 196         }
 197         else {
 198                 RecurringEndTime = min2time(rec->endTime);
 199                 Perpetual = false;
 200         }
 201
 202         switch( rec->type )
 203         {
 204         case CRDF_TYPE_DAY:
 205                 RecurringType = Day;
 206                 // no extra data
 207                 break;
 208
 209         case CRDF_TYPE_MONTH_BY_DATE:
 210                 RecurringType = MonthByDate;
 211                 DayOfMonth = rec->u.month_by_date.monthDay;
 212                 break;
 213
 214         case CRDF_TYPE_MONTH_BY_DAY:
 215                 RecurringType = MonthByDay;
 216                 DayOfWeek = rec->u.month_by_day.weekDay;
 217                 WeekOfMonth = rec->u.month_by_day.week;
 218                 break;
 219
 220         case CRDF_TYPE_YEAR_BY_DATE:
 221                 RecurringType = YearByDate;
 222                 DayOfMonth = rec->u.year_by_date.monthDay;
 223                 MonthOfYear = rec->u.year_by_date.month;
 224                 break;
 225
 226         case CRDF_TYPE_YEAR_BY_DAY:
 227                 RecurringType = YearByDay;
 228                 DayOfWeek = rec->u.year_by_day.weekDay;
 229                 WeekOfMonth = rec->u.year_by_day.week;
 230                 MonthOfYear = rec->u.year_by_day.month;
 231                 break;
 232
 233         case CRDF_TYPE_WEEK:
 234                 RecurringType = Week;
 235
 236                 // Note: this simple copy is only possible since
 237                 // the CAL_WD_* constants are the same as CRDF_WD_* constants.
 238                 // If this ever changes, this code will need to change.
 239                 WeekDays = rec->u.week.days;
 240                 break;
 241
 242         default:
 243                 eout("Unknown recurrence data type: " << rec->type);
 244                 throw Error("Unknown recurrence data type");
 245         }
 246 }
 247
 248 // this function assumes there is CALENDAR_RECURRENCE_DATA_FIELD_SIZE bytes
 249 // available in data
 250 void Calendar::BuildRecurrenceData(void *data)
 251 {
 252         if( !Recurring )
 253                 throw Error("Calendar::BuildRecurrenceData: Attempting to build recurrence data on non-recurring record.");
 254
 255         CalendarRecurrenceDataField *rec = (CalendarRecurrenceDataField*) data;
 256
 257         // set all to zero
 258         memset(data, 0, CALENDAR_RECURRENCE_DATA_FIELD_SIZE);
 259
 260         rec->interval = htobs(Interval);
 261         rec->startTime = time2min(StartTime);
 262         if( Perpetual )
 263                 rec->endTime = 0xffffffff;
 264         else
 265                 rec->endTime = time2min(RecurringEndTime);
 266
 267         switch( RecurringType )
 268         {
 269         case Day:
 270                 rec->type = CRDF_TYPE_DAY;
 271                 // no extra data
 272                 break;
 273
 274         case MonthByDate:
 275                 rec->type = CRDF_TYPE_MONTH_BY_DATE;
 276                 rec->u.month_by_date.monthDay = DayOfMonth;
 277                 break;
 278
 279         case MonthByDay:
 280                 rec->type = CRDF_TYPE_MONTH_BY_DAY;
 281                 rec->u.month_by_day.weekDay = DayOfWeek;
 282                 rec->u.month_by_day.week = WeekOfMonth;
 283                 break;
 284
 285         case YearByDate:
 286                 rec->type = CRDF_TYPE_YEAR_BY_DATE;
 287                 rec->u.year_by_date.monthDay = DayOfMonth;
 288                 rec->u.year_by_date.month = MonthOfYear;
 289                 break;
 290
 291         case YearByDay:
 292                 rec->type = CRDF_TYPE_YEAR_BY_DAY;
 293                 rec->u.year_by_day.weekDay = DayOfWeek;
 294                 rec->u.year_by_day.week = WeekOfMonth;
 295                 rec->u.year_by_day.month = MonthOfYear;
 296                 break;
 297
 298         case Week:
 299                 rec->type = CRDF_TYPE_WEEK;
 300
 301                 // Note: this simple copy is only possible since
 302                 // the CAL_WD_* constants are the same as CRDF_WD_* constants.
 303                 // If this ever changes, this code will need to change.
 304                 rec->u.week.days = WeekDays;
 305                 break;
 306
 307         default:
 308                 eout("Calendar::BuildRecurrenceData: "
 309                         "Unknown recurrence data type: " << rec->type);
 310                 throw Error("Calendar::BuildRecurrenceData: Unknown recurrence data type");
 311         }
 312 }
 313
 314 void Calendar::ParseHeader(const Data &data, size_t &offset)
 315 {
 316         // no header in Calendar records
 317 }
 318
 319 void Calendar::ParseFields(const Data &data, size_t &offset)
 320 {
 321         const unsigned char *finish = ParseCommonFields(*this,
 322                 data.GetData() + offset, data.GetData() + data.GetSize());
 323         offset += finish - (data.GetData() + offset);
 324 }
 325
 326 void Calendar::BuildHeader(Data &data, size_t &offset) const
 327 {
 328         // no header in Calendar records
 329 }
 330
 331 //
 332 // Build
 333 //
 334 /// Build fields part of record.
 335 ///
 336 void Calendar::BuildFields(Data &data, size_t &offset) const
 337 {
 338         data.Zap();
 339
 340         // output the type first
 341         BuildField(data, offset, CALFC_APPT_TYPE_FLAG, Recurring ? '*' : 'a');
 342
 343         // output all day event flag only if set
 344         if( AllDayEvent )
 345                 BuildField(data, offset, CALFC_ALLDAYEVENT_FLAG, (char)1);
 346
 347         // cycle through the type table
 348         for(    const FieldLink<Calendar> *b = CalendarFieldLinks;
 349                 b->type != CALFC_END;
 350                 b++ )
 351         {
 352                 if( b->strMember ) {
 353                         const std::string &s = this->*(b->strMember);
 354                         if( s.size() )
 355                                 BuildField(data, offset, b->type, s);
 356                 }
 357                 else if( b->timeMember ) {
 358                         time_t t = this->*(b->timeMember);
 359                         if( t > 0 )
 360                                 BuildField1900(data, offset, b->type, t);
 361                 }
 362         }
 363
 364         // and finally save unknowns
 365         UnknownsType::const_iterator
 366                 ub = Unknowns.begin(), ue = Unknowns.end();
 367         for( ; ub != ue; ub++ ) {
 368                 BuildField(data, offset, ub->type, ub->data);
 369         }
 370
 371         data.ReleaseBuffer(offset);
 372 }
 373
 374 void Calendar::Clear()
 375 {
 376         RecType = Calendar::GetDefaultRecType();
 377
 378         AllDayEvent = false;
 379         Subject.clear();
 380         Notes.clear();
 381         Location.clear();
 382         NotificationTime = StartTime = EndTime = 0;
 383
 384         Recurring = false;
 385         RecurringType = Calendar::Week;
 386         Interval = 1;
 387         RecurringEndTime = 0;
 388         Perpetual = false;
 389         TimeZoneCode = GetTimeZoneCode(0, 0);   // default to GMT
 390         DayOfWeek = WeekOfMonth = DayOfMonth = MonthOfYear = 0;
 391         WeekDays = 0;
 392
 393         Unknowns.clear();
 394 }
 395
 396 void Calendar::Dump(std::ostream &os) const
 397 {
 398         static const char *DayNames[] = { "Sun", "Mon", "Tue", "Wed",
 399                 "Thu", "Fri", "Sat" };
 400         static const char *MonthNames[] = { "Jan", "Feb", "Mar", "Apr",
 401                 "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
 402         static const char *ClassTypes[] = { "Public", "Confidential", "Private" };
 403         static const char *FreeBusy[] = { "Free", "Tentative", "Busy", "Out of Office" };
 404
 405 // FIXME - need a "check all data" function that make sure that all
 406 // recurrence data is within range.  Then call that before using
 407 // the data, such as in Build and in Dump.
 408
 409         os << "Calendar entry: 0x" << setbase(16) << RecordId
 410                 << " (" << (unsigned int)RecType << ")\n";
 411         os << "   All Day Event: " << (AllDayEvent ? "yes" : "no") << "\n";
 412         os << "   Class: " << ClassTypes[ClassFlag] << "\n";
 413         os << "   Free/Busy: " << FreeBusy[FreeBusyFlag] << "\n";
 414
 415         // cycle through the type table
 416         for(    const FieldLink<Calendar> *b = CalendarFieldLinks;
 417                 b->type != CALFC_END;
 418                 b++ )
 419         {
 420                 if( b->strMember ) {
 421                         const std::string &s = this->*(b->strMember);
 422                         if( s.size() )
 423                                 os << "   " << b->name << ": " << s << "\n";
 424                 }
 425                 else if( b->timeMember ) {
 426                         time_t t = this->*(b->timeMember);
 427                         if( t > 0 )
 428                                 os << "   " << b->name << ": " << ctime(&t);
 429                 }
 430         }
 431
 432         // print recurrence data if available
 433         os << "   Recurring: " << (Recurring ? "yes" : "no") << "\n";
 434         if( Recurring ) {
 435                 switch( RecurringType )
 436                 {
 437                 case Day:
 438                         os << "      Every day.\n";
 439                         break;
 440
 441                 case MonthByDate:
 442                         os << "      Every month on the "
 443                            << DayOfMonth
 444                            << (DayOfMonth == 1 ? "st" : "")
 445                            << (DayOfMonth == 2 ? "nd" : "")
 446                            << (DayOfMonth == 3 ? "rd" : "")
 447                            << (DayOfMonth > 3  ? "th" : "")
 448                            << "\n";
 449                         break;
 450
 451                 case MonthByDay:
 452                         os << "      Every month on the "
 453                            << DayNames[DayOfWeek]
 454                            << " of week "
 455                            << WeekOfMonth
 456                            << "\n";
 457                         break;
 458
 459                 case YearByDate:
 460                         os << "      Every year on "
 461                            << MonthNames[MonthOfYear-1]
 462                            << " " << DayOfMonth << "\n";
 463                         break;
 464
 465                 case YearByDay:
 466                         os << "      Every year in " << MonthNames[MonthOfYear-1]
 467                            << " on "
 468                            << DayNames[DayOfWeek]
 469                            << " of week " << WeekOfMonth << "\n";
 470                         break;
 471
 472                 case Week:
 473                         os << "      Every week on: ";
 474                         if( WeekDays & CAL_WD_SUN ) os << "Sun ";
 475                         if( WeekDays & CAL_WD_MON ) os << "Mon ";
 476                         if( WeekDays & CAL_WD_TUE ) os << "Tue ";
 477                         if( WeekDays & CAL_WD_WED ) os << "Wed ";
 478                         if( WeekDays & CAL_WD_THU ) os << "Thu ";
 479                         if( WeekDays & CAL_WD_FRI ) os << "Fri ";
 480                         if( WeekDays & CAL_WD_SAT ) os << "Sat ";
 481                         os << "\n";
 482                         break;
 483
 484                 default:
 485                         os << "      Unknown recurrence type\n";
 486                         break;
 487                 }
 488
 489                 os << "      Interval: " << Interval << "\n";
 490
 491                 if( Perpetual )
 492                         os << "      Ends: never\n";
 493                 else
 494                         os << "      Ends: "
 495                            << ctime(&RecurringEndTime);
 496         }
 497
 498         // print any unknowns
 499         os << Unknowns;
 500 }
 501
 502
 503 } // namespace Barry
 504