3 /// Blackberry database record classes. Help translate data
4 /// from data packets to useful structurs, and back.
5 /// This header provides the common types and classes
6 /// used by the general record parser classes in the
7 /// r_*.h files. Only application-safe API stuff goes in
8 /// here. Internal library types go in record-internal.h
12 Copyright (C) 2005-2008, Net Direct Inc. (http://www.netdirect.ca/)
14 This program is free software; you can redistribute it and/or modify
15 it under the terms of the GNU General Public License as published by
16 the Free Software Foundation; either version 2 of the License, or
17 (at your option) any later version.
19 This program is distributed in the hope that it will be useful,
20 but WITHOUT ANY WARRANTY; without even the implied warranty of
21 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
23 See the GNU General Public License in the COPYING file at the
24 root directory of this project for more details.
28 #include "record-internal.h"
30 #include "protostructs.h"
41 #define __DEBUG_MODE__
45 using namespace Barry::Protocol
;
49 //////////////////////////////////////////////////////////////////////////////
50 // Field builder helper functions
52 void BuildField1900(Data
&data
, size_t &size
, uint8_t type
, time_t t
)
54 size_t timesize
= COMMON_FIELD_MIN1900_SIZE
;
55 size_t fieldsize
= COMMON_FIELD_HEADER_SIZE
+ timesize
;
56 unsigned char *pd
= data
.GetBuffer(size
+ fieldsize
) + size
;
57 CommonField
*field
= (CommonField
*) pd
;
59 field
->size
= htobs(timesize
);
61 field
->u
.min1900
= time2min(t
);
66 void BuildField(Data
&data
, size_t &size
, uint8_t type
, char c
)
69 size_t fieldsize
= COMMON_FIELD_HEADER_SIZE
+ strsize
;
70 unsigned char *pd
= data
.GetBuffer(size
+ fieldsize
) + size
;
71 CommonField
*field
= (CommonField
*) pd
;
73 field
->size
= htobs(strsize
);
75 memcpy(field
->u
.raw
, &c
, strsize
);
80 void BuildField(Data
&data
, size_t &size
, uint8_t type
, uint16_t value
)
83 size_t fieldsize
= COMMON_FIELD_HEADER_SIZE
+ strsize
;
84 unsigned char *pd
= data
.GetBuffer(size
+ fieldsize
) + size
;
85 CommonField
*field
= (CommonField
*) pd
;
87 field
->size
= htobs(strsize
);
90 uint16_t store
= htobs(value
);
91 memcpy(field
->u
.raw
, &store
, strsize
);
96 void BuildField(Data
&data
, size_t &size
, uint8_t type
, const std::string
&str
)
98 // include null terminator
99 BuildField(data
, size
, type
, str
.c_str(), str
.size() + 1);
102 void BuildField(Data
&data
, size_t &size
, uint8_t type
,
103 const void *buf
, size_t bufsize
)
105 // include null terminator
106 size_t fieldsize
= COMMON_FIELD_HEADER_SIZE
+ bufsize
;
107 unsigned char *pd
= data
.GetBuffer(size
+ fieldsize
) + size
;
108 CommonField
*field
= (CommonField
*) pd
;
110 field
->size
= htobs(bufsize
);
112 memcpy(field
->u
.raw
, buf
, bufsize
);
117 void BuildField(Data
&data
, size_t &size
, const Barry::UnknownField
&field
)
119 BuildField(data
, size
, field
.type
,
120 field
.data
.raw_data
.data(), field
.data
.raw_data
.size());
123 void BuildField(Data
&data
, size_t &size
, uint8_t type
, const Barry::Protocol::GroupLink
&link
)
125 size_t linksize
= sizeof(Barry::Protocol::GroupLink
);
126 size_t fieldsize
= COMMON_FIELD_HEADER_SIZE
+ linksize
;
127 unsigned char *pd
= data
.GetBuffer(size
+ fieldsize
) + size
;
128 CommonField
*field
= (CommonField
*) pd
;
130 field
->size
= htobs(linksize
);
132 field
->u
.link
= link
;
137 std::string
ParseFieldString(const Barry::Protocol::CommonField
*field
)
139 // make no assumptions here, and pass the full size in as
140 // the maxlen, even though 99% of the time, it will be a null...
141 // this function can be used by non-null terminated strings as well
142 return ParseFieldString(field
->u
.raw
, btohs(field
->size
));
145 std::string
ParseFieldString(const void *data
, uint16_t maxlen
)
147 const char *str
= (const char *)data
;
149 // find last non-null character, since some fields
150 // can have multiple null terminators
151 while( maxlen
&& str
[maxlen
-1] == 0 )
154 return std::string(str
, maxlen
);
158 ///////////////////////////////////////////////////////////////////////////////
159 // CommandTable class
161 CommandTable::CommandTable()
165 CommandTable::~CommandTable()
169 const unsigned char* CommandTable::ParseField(const unsigned char *begin
,
170 const unsigned char *end
)
172 // check if there is enough data for a header
173 const unsigned char *headend
= begin
+ sizeof(CommandTableField
);
177 const CommandTableField
*field
= (const CommandTableField
*) begin
;
179 // advance and check size
180 begin
+= COMMAND_FIELD_HEADER_SIZE
+ field
->size
; // size is byte
181 if( begin
> end
) // if begin==end, we are ok
184 if( !field
->size
) // if field has no size, something's up
188 command
.Code
= field
->code
;
189 command
.Name
.assign((const char *)field
->name
, field
->size
);
190 Commands
.push_back(command
);
194 void CommandTable::Parse(const Data
&data
, size_t offset
)
196 if( offset
>= data
.GetSize() )
199 const unsigned char *begin
= data
.GetData() + offset
;
200 const unsigned char *end
= data
.GetData() + data
.GetSize();
203 begin
= ParseField(begin
, end
);
206 void CommandTable::Clear()
211 unsigned int CommandTable::GetCommand(const std::string
&name
) const
213 CommandArrayType::const_iterator b
= Commands
.begin();
214 for( ; b
!= Commands
.end(); b
++ )
215 if( b
->Name
== name
)
220 void CommandTable::Dump(std::ostream
&os
) const
222 CommandArrayType::const_iterator b
= Commands
.begin();
223 os
<< "Command table:\n";
224 for( ; b
!= Commands
.end(); b
++ ) {
225 os
<< " Command: 0x" << setbase(16) << b
->Code
226 << " '" << b
->Name
<< "'\n";
232 ///////////////////////////////////////////////////////////////////////////////
233 // RecordStateTable class
235 RecordStateTable::RecordStateTable()
236 : m_LastNewRecordId(1)
240 RecordStateTable::~RecordStateTable()
244 const unsigned char* RecordStateTable::ParseField(const unsigned char *begin
,
245 const unsigned char *end
)
247 const RecordStateTableField
*field
= (const RecordStateTableField
*) begin
;
249 // advance and check size
250 begin
+= sizeof(RecordStateTableField
);
251 if( begin
> end
) // if begin==end, we are ok
255 state
.Index
= btohs(field
->index
);
256 state
.RecordId
= btohl(field
->uniqueId
);
257 state
.Dirty
= (field
->flags
& BARRY_RSTF_DIRTY
) != 0;
258 state
.RecType
= field
->rectype
;
259 state
.Unknown2
.assign((const char*)field
->unknown2
, sizeof(field
->unknown2
));
260 StateMap
[state
.Index
] = state
;
265 void RecordStateTable::Parse(const Data
&data
)
267 size_t offset
= 12; // skipping the unknown 2 bytes at start
269 if( offset
>= data
.GetSize() )
272 const unsigned char *begin
= data
.GetData() + offset
;
273 const unsigned char *end
= data
.GetData() + data
.GetSize();
276 begin
= ParseField(begin
, end
);
279 void RecordStateTable::Clear()
282 m_LastNewRecordId
= 1;
285 // Searches the StateMap table for RecordId, and returns the "index"
286 // in the map if found. Returns true if found, false if not.
287 // pFoundIndex can be null if only the existence of the index is desired
288 bool RecordStateTable::GetIndex(uint32_t RecordId
, IndexType
*pFoundIndex
) const
290 StateMapType::const_iterator i
= StateMap
.begin();
291 for( ; i
!= StateMap
.end(); ++i
) {
292 if( i
->second
.RecordId
== RecordId
) {
294 *pFoundIndex
= i
->first
;
301 // Generate a new RecordId that is not in the state table.
302 // Starts at 1 and keeps incrementing until a free one is found.
303 uint32_t RecordStateTable::MakeNewRecordId() const
305 // start with next Id
308 // make sure it doesn't already exist
309 StateMapType::const_iterator i
= StateMap
.begin();
310 while( i
!= StateMap
.end() ) {
311 if( m_LastNewRecordId
== i
->second
.RecordId
) {
312 m_LastNewRecordId
++; // try again
313 i
= StateMap
.begin(); // start over
319 return m_LastNewRecordId
;
322 void RecordStateTable::Dump(std::ostream
&os
) const
324 ios::fmtflags oldflags
= os
.setf(ios::right
);
325 char fill
= os
.fill(' ');
326 bool bPrintAscii
= Data::PrintAscii();
327 Data::PrintAscii(false);
329 os
<< " Index RecordId Dirty RecType" << endl
;
330 os
<< "------- ---------- ----- -------" << endl
;
332 StateMapType::const_iterator b
, e
= StateMap
.end();
333 for( b
= StateMap
.begin(); b
!= e
; ++b
) {
334 const State
&state
= b
->second
;
337 os
<< setbase(10) << setw(7) << state
.Index
;
338 os
<< " 0x" << setbase(16) << setfill('0') << setw(8) << state
.RecordId
;
339 os
<< " " << setfill(' ') << setw(5) << (state
.Dirty
? "yes" : "no");
340 os
<< " 0x" << setbase(16) << setfill('0') << setw(2) << state
.RecType
;
341 os
<< " " << Data(state
.Unknown2
.data(), state
.Unknown2
.size());
344 // cleanup the stream
347 Data::PrintAscii(bPrintAscii
);
352 ///////////////////////////////////////////////////////////////////////////////
353 // DatabaseDatabase class
355 DatabaseDatabase::DatabaseDatabase()
359 DatabaseDatabase::~DatabaseDatabase()
363 template <class RecordType
, class FieldType
>
364 void DatabaseDatabase::ParseRec(const RecordType
&rec
, const unsigned char *end
)
368 template <class FieldType
>
369 const unsigned char* DatabaseDatabase::ParseField(const unsigned char *begin
,
370 const unsigned char *end
)
372 // check if there is enough data for a header
373 const unsigned char *headend
= begin
+ sizeof(FieldType
);
378 const FieldType
*field
= (const FieldType
*) begin
;
380 // advance and check size
381 begin
+= sizeof(FieldType
) - sizeof(field
->name
) + ConvertHtoB(field
->nameSize
);
382 if( begin
> end
) // if begin==end, we are ok
385 if( !ConvertHtoB(field
->nameSize
) ) // if field has no size, something's up
389 db
.Number
= ConvertHtoB(field
->dbNumber
);
390 db
.RecordCount
= ConvertHtoB(field
->dbRecordCount
);
391 db
.Name
.assign((const char *)field
->name
, ConvertHtoB(field
->nameSize
) - 1);
392 Databases
.push_back(db
);
396 void DatabaseDatabase::Parse(const Data
&data
)
398 // check size to make sure we have up to the DBAccess operation byte
399 if( data
.GetSize() < (SB_PACKET_DBACCESS_HEADER_SIZE
+ 1) )
402 MAKE_PACKET(pack
, data
);
403 const unsigned char *begin
= 0;
404 const unsigned char *end
= data
.GetData() + data
.GetSize();
406 switch( pack
->u
.db
.u
.response
.operation
)
408 case SB_DBOP_GET_DBDB
:
409 // using the new protocol
410 if( data
.GetSize() > SB_PACKET_DBDB_HEADER_SIZE
) {
411 begin
= (const unsigned char *)
412 &pack
->u
.db
.u
.response
.u
.dbdb
.field
[0];
414 // this while check is ok, since ParseField checks
417 begin
= ParseField
<DBDBField
>(begin
, end
);
420 dout("DatabaseDatabase: not enough data for parsing");
423 case SB_DBOP_OLD_GET_DBDB
:
424 // using the old protocol
425 if( data
.GetSize() > SB_PACKET_OLD_DBDB_HEADER_SIZE
) {
426 begin
= (const unsigned char *)
427 &pack
->u
.db
.u
.response
.u
.old_dbdb
.field
[0];
429 // this while check is ok, since ParseField checks
432 begin
= ParseField
<OldDBDBField
>(begin
, end
);
435 dout("DatabaseDatabase: not enough data for parsing");
440 dout("Unknown protocol");
447 void DatabaseDatabase::Clear()
452 bool DatabaseDatabase::GetDBNumber(const std::string
&name
,
453 unsigned int &number
) const
455 DatabaseArrayType::const_iterator b
= Databases
.begin();
456 for( ; b
!= Databases
.end(); b
++ )
457 if( b
->Name
== name
) {
464 bool DatabaseDatabase::GetDBName(unsigned int number
,
465 std::string
&name
) const
467 DatabaseArrayType::const_iterator b
= Databases
.begin();
468 for( ; b
!= Databases
.end(); b
++ )
469 if( b
->Number
== number
) {
476 void DatabaseDatabase::Dump(std::ostream
&os
) const
478 DatabaseArrayType::const_iterator b
= Databases
.begin();
479 os
<< "Database database:\n";
480 for( ; b
!= Databases
.end(); b
++ ) {
481 os
<< " Database: 0x" << setbase(16) << b
->Number
482 << " '" << b
->Name
<< "' (records: "
483 << setbase(10) << b
->RecordCount
<< ")\n";
488 std::ostream
& operator<< (std::ostream
&os
, const std::vector
<UnknownField
> &unknowns
)
490 std::vector
<UnknownField
>::const_iterator
491 ub
= unknowns
.begin(), ue
= unknowns
.end();
493 os
<< " Unknowns:\n";
494 for( ; ub
!= ue
; ub
++ ) {
495 os
<< " Type: 0x" << setbase(16)
496 << (unsigned int) ub
->type
497 << " Data:\n" << Data(ub
->data
.data(), ub
->data
.size());
504 ///////////////////////////////////////////////////////////////////////////////
505 // EmailAddress class
507 std::ostream
& operator<<(std::ostream
&os
, const EmailAddress
&msga
) {
508 os
<< msga
.Name
.c_str() << " <" << msga
.Email
.c_str() << ">";
513 ///////////////////////////////////////////////////////////////////////////////
514 // PostalAddress class
519 /// Format a mailing address into a single string, handling missing fields.
521 std::string
PostalAddress::GetLabel() const
523 std::string address
= Address1
;
524 if( Address2
.size() ) {
529 if( Address3
.size() ) {
537 address
+= City
+ " ";
538 if( Province
.size() )
539 address
+= Province
+ " ";
544 if( PostalCode
.size() )
545 address
+= PostalCode
;
550 void PostalAddress::Clear()
561 std::ostream
& operator<<(std::ostream
&os
, const PostalAddress
&post
) {
562 os
<< post
.GetLabel();
568 ///////////////////////////////////////////////////////////////////////////////
571 Date::Date(const struct tm
*timep
)
578 Month
= Day
= Year
= 0;
581 void Date::ToTm(struct tm
*timep
) const
583 memset(timep
, 0, sizeof(tm
));
584 timep
->tm_year
= Year
- 1900;
585 timep
->tm_mon
= Month
;
586 timep
->tm_mday
= Day
;
589 std::string
Date::ToYYYYMMDD() const
591 std::ostringstream oss
;
592 oss
<< setw(4) << Year
593 << setw(2) << Month
+ 1
601 /// The Blackberry stores Birthday and Anniversary date fields
602 /// with the format: DD/MM/YYYY
604 std::string
Date::ToBBString() const
606 std::ostringstream oss
;
607 oss
<< setw(2) << Day
613 bool Date::FromTm(const struct tm
*timep
)
615 Year
= timep
->tm_year
+ 1900;
616 Month
= timep
->tm_mon
;
617 Day
= timep
->tm_mday
;
621 bool Date::FromBBString(const std::string
&str
)
624 if( 3 == sscanf(str
.c_str(), "%d/%d/%d", &d
, &m
, &y
) ) {
633 bool Date::FromYYYYMMDD(const std::string
&str
)
636 if( 3 == sscanf(str
.c_str(), "%4d%2d%2d", &y
, &m
, &d
) ) {
645 std::ostream
& operator<<(std::ostream
&os
, const Date
&date
)
647 os
<< setw(4) << date
.Year
<< '/'
648 << setw(2) << date
.Month
<< '/'
649 << setw(2) << date
.Day
;
662 int main(int argc
, char *argv
[])
665 cerr
<< "Usage: test <datafile>" << endl
;
669 std::vector
<Data
> array
;
670 if( !LoadDataArray(argv
[1], array
) ) {
671 cerr
<< "Unable to load file: " << argv
[1] << endl
;
675 cout
<< "Loaded " << array
.size() << " items" << endl
;
677 for( std::vector
<Data
>::iterator b
= array
.begin(), e
= array
.end();
681 // cout << d << endl;
682 if( d
.GetSize() > 13 && d
.GetData()[6] == 0x4f ) {
683 Barry::Contact contact
;
685 contact
.ParseFields(d
, size
);
686 cout
<< contact
<< endl
;
687 contact
.DumpLdif(cout
, "ou=People,dc=example,dc=com");
689 else if( d
.GetSize() > 13 && d
.GetData()[6] == 0x44 ) {
692 cal
.ParseFields(d
, size
);