3 /// Barry library tester
7 Copyright (C) 2005-2007, 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 <barry/barry.h>
32 using namespace Barry
;
37 const char *Version
= Barry::Version(major
, minor
);
40 << "btool - Command line USB Blackberry Test Tool\n"
41 << " Copyright 2005-2007, Net Direct Inc. (http://www.netdirect.ca/)\n"
42 << " Using: " << Version
<< "\n"
44 << " -c dn Convert address book database to LDIF format, using the\n"
45 << " specified baseDN\n"
46 << " -C dnattr LDIF attribute name to use when building the FQDN\n"
47 << " Defaults to 'cn'\n"
48 << " -d db Load database 'db' FROM device and dump to screen\n"
49 << " Can be used multiple times to fetch more than one DB\n"
50 #ifdef __BARRY_BOOST_MODE__
51 << " -f file Filename to save or load handheld data to/from\n"
54 << " -l List devices\n"
55 << " -L List Contact field names\n"
56 << " -m Map LDIF name to Contact field / Unmap LDIF name\n"
57 << " Map: ldif,read,write - maps ldif to read/write Contact fields\n"
58 << " Unmap: ldif name alone\n"
59 << " -M List current LDIF mapping\n"
60 << " -p pin PIN of device to talk with\n"
61 << " If only one device plugged in, this flag is optional\n"
62 << " -P pass Simplistic method to specify device password\n"
63 << " -s db Save database 'db' TO device from data loaded from -f file\n"
64 << " -t Show database database table\n"
65 << " -T db Show record state table for given database\n"
66 << " -v Dump protocol data during operation\n"
67 << " -X Reset device\n"
69 << " -d Command modifiers: (can be used multiple times for more than 1 record)\n"
71 << " -r # Record index number as seen in the -T state table.\n"
72 << " This overrides the default -d behaviour, and only\n"
73 << " downloads the one specified record, sending to stdout.\n"
74 << " -R # Same as -r, but also clears the record's dirty flags.\n"
75 << " -D # Record index number as seen in the -T state table,\n"
76 << " which indicates the record to delete. Used with the -d\n"
77 << " command to specify the database.\n"
84 Barry::ContactLdif
&ldif
;
86 Contact2Ldif(Barry::ContactLdif
&ldif
) : ldif(ldif
) {}
88 void operator()(const Contact
&rec
)
90 ldif
.DumpLdif(cout
, rec
);
94 template <class Record
>
97 std::vector
<Record
> records
;
98 mutable typename
std::vector
<Record
>::const_iterator rec_it
;
103 Store(const string
&filename
, bool load
)
104 : rec_it(records
.end()),
109 #ifdef __BARRY_BOOST_MODE__
112 if( load
&& filename
.size() ) {
113 // filename is available, attempt to load
114 cout
<< "Loading: " << filename
<< endl
;
115 ifstream
ifs(filename
.c_str());
116 boost::archive::text_iarchive
ia(ifs
);
118 cout
<< records
.size()
119 << " records loaded from '"
120 << filename
<< "'" << endl
;
121 sort(records
.begin(), records
.end());
122 rec_it
= records
.begin();
125 typename
std::vector
<Record
>::const_iterator beg
= records
.begin(), end
= records
.end();
126 for( ; beg
!= end
; beg
++ ) {
127 cout
<< (*beg
) << endl
;
131 } catch( boost::archive::archive_exception
&ae
) {
132 cerr
<< "Archive exception in ~Store(): "
133 << ae
.what() << endl
;
139 cout
<< "Store counted " << dec
<< count
<< " records." << endl
;
140 #ifdef __BARRY_BOOST_MODE__
143 if( !load
&& filename
.size() ) {
144 // filename is available, attempt to save
145 cout
<< "Saving: " << filename
<< endl
;
146 const std::vector
<Record
> &r
= records
;
147 ofstream
ofs(filename
.c_str());
148 boost::archive::text_oarchive
oa(ofs
);
150 cout
<< dec
<< r
.size() << " records saved to '"
151 << filename
<< "'" << endl
;
154 } catch( boost::archive::archive_exception
&ae
) {
155 cerr
<< "Archive exception in ~Store(): "
156 << ae
.what() << endl
;
162 void operator()(const Record
&rec
)
165 std::cout
<< rec
<< std::endl
;
166 records
.push_back(rec
);
169 // retrieval operator
170 bool operator()(Record
&rec
, unsigned int databaseId
) const
172 if( rec_it
== records
.end() )
180 class DataDumpParser
: public Barry::Parser
185 virtual void SetUniqueId(uint32_t id
)
190 virtual void ParseFields(const Barry::Data
&data
, size_t &offset
)
192 std::cout
<< "Raw record dump for record: "
193 << std::hex
<< m_id
<< std::endl
;
194 std::cout
<< data
<< std::endl
;
198 auto_ptr
<Parser
> GetParser(const string
&name
, const string
&filename
)
200 // check for recognized database names
201 if( name
== "Address Book" ) {
202 return auto_ptr
<Parser
>(
203 new RecordParser
<Contact
, Store
<Contact
> > (
204 new Store
<Contact
>(filename
, false)));
206 else if( name
== "Messages" ) {
207 return auto_ptr
<Parser
>(
208 new RecordParser
<Message
, Store
<Message
> > (
209 new Store
<Message
>(filename
, false)));
211 else if( name
== "Calendar" ) {
212 return auto_ptr
<Parser
>(
213 new RecordParser
<Calendar
, Store
<Calendar
> > (
214 new Store
<Calendar
>(filename
, false)));
216 else if( name
== "Service Book" ) {
217 return auto_ptr
<Parser
>(
218 new RecordParser
<ServiceBook
, Store
<ServiceBook
> > (
219 new Store
<ServiceBook
>(filename
, false)));
222 else if( name == "Memos" ) {
223 return auto_ptr<Parser>(
224 new RecordParser<Memo, Store<Memo> > (
225 new Store<Memo>(filename, false )));
227 else if( name == "Tasks" ) {
228 return auto_ptr<Parser>(
229 new RecordParser<Task, Store<Task> > (
230 new Store<Task>(filename, false )));
234 // unknown database, use null parser
235 return auto_ptr
<Parser
>( new DataDumpParser
);
239 auto_ptr
<Builder
> GetBuilder(const string
&name
, const string
&filename
)
241 // check for recognized database names
242 if( name
== "Address Book" ) {
243 return auto_ptr
<Builder
>(
244 new RecordBuilder
<Contact
, Store
<Contact
> > (
245 new Store
<Contact
>(filename
, true)));
248 else if( name == "Messages" ) {
249 return auto_ptr<Parser>(
250 new RecordParser<Message, Store<Message> > (
251 new Store<Message>(filename, true)));
253 else if( name == "Calendar" ) {
254 return auto_ptr<Parser>(
255 new RecordParser<Calendar, Store<Calendar> > (
256 new Store<Calendar>(filename, true)));
258 else if( name == "Service Book" ) {
259 return auto_ptr<Parser>(
260 new RecordParser<ServiceBook, Store<ServiceBook> > (
261 new Store<ServiceBook>(filename, true)));
263 else if( name == "Memos" ) {
264 return auto_ptr<Parser>(
265 new RecordParser<Memo, Store<Memo> > (
266 new Store<Memo>(filename, true)));
268 else if( name == "Tasks" ) {
269 return auto_ptr<Parser>(
270 new RecordParser<Task, Store<Task> > (
271 new Store<Task>(filename, true)));
275 throw std::runtime_error("No Builder available for database");
279 struct StateTableCommand
285 StateTableCommand(char f
, bool c
, unsigned int i
)
286 : flag(f
), clear(c
), index(i
) {}
289 bool SplitMap(const string
&map
, string
&ldif
, string
&read
, string
&write
)
291 string::size_type a
= map
.find(',');
292 if( a
== string::npos
)
295 string::size_type b
= map
.find(',', a
+1);
296 if( b
== string::npos
)
299 ldif
.assign(map
, 0, a
);
300 read
.assign(map
, a
+ 1, b
- a
- 1);
301 write
.assign(map
, b
+ 1, map
.size() - b
- 1);
303 return ldif
.size() && read
.size() && write
.size();
306 void DoMapping(ContactLdif
&ldif
, const vector
<string
> &mapCommands
)
308 for( vector
<string
>::const_iterator i
= mapCommands
.begin();
309 i
!= mapCommands
.end();
312 // single names mean unmapping
313 if( i
->find(',') == string::npos
) {
315 cerr
<< "Unmapping: " << *i
<< endl
;
319 cerr
<< "Mapping: " << *i
<< endl
;
321 // map... extract ldif/read/write names
322 string ldifname
, read
, write
;
323 if( SplitMap(*i
, ldifname
, read
, write
) ) {
324 if( !ldif
.Map(ldifname
, read
, write
) ) {
325 cerr
<< "Read/Write name unknown: " << *i
<< endl
;
329 cerr
<< "Invalid map format: " << *i
<< endl
;
335 int main(int argc
, char *argv
[])
337 cout
.sync_with_stdio(true); // leave this on, since libusb uses
338 // stdio for debug messages
343 bool list_only
= false,
345 ldif_contacts
= false,
347 reset_device
= false,
348 list_contact_fields
= false,
349 list_ldif_map
= false,
350 record_state
= false;
351 string ldifBaseDN
, ldifDnAttr
;
354 vector
<string
> dbNames
, saveDbNames
, mapCommands
;
355 vector
<StateTableCommand
> stCommands
;
357 // process command line options
359 int cmd
= getopt(argc
, argv
, "c:C:d:D:f:hlLm:Mp:P:r:R:s:tT:vX");
365 case 'c': // contacts to ldap ldif
366 ldif_contacts
= true;
370 case 'C': // DN Attribute for FQDN
374 case 'd': // show dbname
375 dbNames
.push_back(string(optarg
));
378 case 'D': // delete record
379 stCommands
.push_back(
380 StateTableCommand('D', false, atoi(optarg
)));
383 case 'f': // filename
384 #ifdef __BARRY_BOOST_MODE__
387 cerr
<< "-f option not supported - no Boost "
388 "serialization support available\n";
392 case 'l': // list only
396 case 'L': // List Contact field names
397 list_contact_fields
= true;
400 case 'm': // Map / Unmap
401 mapCommands
.push_back(string(optarg
));
404 case 'M': // List LDIF map
405 list_ldif_map
= true;
408 case 'p': // Blackberry PIN
409 pin
= strtoul(optarg
, NULL
, 16);
412 case 'P': // Device password
416 case 'r': // get specific record index
417 stCommands
.push_back(
418 StateTableCommand('r', false, atoi(optarg
)));
421 case 'R': // same as 'r', and clears dirty
422 stCommands
.push_back(
423 StateTableCommand('r', true, atoi(optarg
)));
426 case 's': // save dbname
427 saveDbNames
.push_back(string(optarg
));
430 case 't': // display database database
434 case 'T': // show RecordStateTable
436 dbNames
.push_back(string(optarg
));
439 case 'v': // data dump on
443 case 'X': // reset device
454 // Initialize the barry library. Must be called before
456 Barry::Init(data_dump
);
458 // LDIF class... only needed if ldif output turned on
459 ContactLdif
ldif(ldifBaseDN
);
460 DoMapping(ldif
, mapCommands
);
461 if( ldifDnAttr
.size() ) {
462 if( !ldif
.SetDNAttr(ldifDnAttr
) ) {
463 cerr
<< "Unable to set DN Attr: " << ldifDnAttr
<< endl
;
467 // Probe the USB bus for Blackberry devices and display.
468 // If user has specified a PIN, search for it in the
469 // available device list here as well
471 int activeDevice
= -1;
474 cout
<< "Blackberry devices found:" << endl
;
475 for( int i
= 0; i
< probe
.GetCount(); i
++ ) {
478 cout
<< probe
.Get(i
) << endl
;
479 if( probe
.Get(i
).m_pin
== pin
)
486 if( activeDevice
== -1 ) {
488 // can we default to single device?
489 if( probe
.GetCount() == 1 )
492 cerr
<< "No device selected" << endl
;
497 cerr
<< "PIN " << setbase(16) << pin
498 << " not found" << endl
;
504 Usb::Device
dev(probe
.Get(activeDevice
).m_dev
);
509 // Create our controller object
510 Barry::Controller
con(probe
.Get(activeDevice
));
513 // execute each mode that was turned on
517 // Dump list of all databases to stdout
519 // open desktop mode socket
520 con
.OpenMode(Controller::Desktop
, password
.c_str());
521 cout
<< con
.GetDBDB() << endl
;
524 // Dump list of Contact field names
525 if( list_contact_fields
) {
526 for( const ContactLdif::NameToFunc
*n
= ldif
.GetFieldNames(); n
->name
; n
++ ) {
528 cout
<< " " << left
<< setw(20) << n
->name
<< ": "
529 << n
->description
<< endl
;
533 // Dump current LDIF mapping
534 if( list_ldif_map
) {
535 cout
<< ldif
<< endl
;
538 // Dump list of contacts to an LDAP LDIF file
539 // This uses the Controller convenience templates
540 if( ldif_contacts
) {
541 // make sure we're in desktop mode
542 con
.OpenMode(Controller::Desktop
, password
.c_str());
544 // create a storage functor object that accepts
545 // Barry::Contact objects as input
546 Contact2Ldif
storage(ldif
);
548 // load all the Contact records into storage
549 con
.LoadDatabaseByType
<Barry::Contact
>(storage
);
552 // Dump record state table to stdout
554 if( dbNames
.size() == 0 ) {
555 cout
<< "No db names to process" << endl
;
559 vector
<string
>::iterator b
= dbNames
.begin();
560 for( ; b
!= dbNames
.end(); b
++ ) {
561 con
.OpenMode(Controller::Desktop
, password
.c_str());
562 unsigned int id
= con
.GetDBID(*b
);
563 RecordStateTable state
;
564 con
.GetRecordStateTable(id
, state
);
565 cout
<< "Record state table for: " << *b
<< endl
;
571 // Get Record mode overrides the default name mode
572 if( stCommands
.size() ) {
573 if( dbNames
.size() != 1 ) {
574 cout
<< "Must have 1 db name to process" << endl
;
578 con
.OpenMode(Controller::Desktop
, password
.c_str());
579 unsigned int id
= con
.GetDBID(dbNames
[0]);
580 auto_ptr
<Parser
> parse
= GetParser(dbNames
[0],filename
);
582 for( unsigned int i
= 0; i
< stCommands
.size(); i
++ ) {
583 con
.GetRecord(id
, stCommands
[i
].index
, *parse
.get());
585 if( stCommands
[i
].flag
== 'r' && stCommands
[i
].clear
) {
586 cout
<< "Clearing record's dirty flags..." << endl
;
587 con
.ClearDirty(id
, stCommands
[i
].index
);
590 if( stCommands
[i
].flag
== 'D' ) {
591 con
.DeleteRecord(id
, stCommands
[i
].index
);
598 // Dump contents of selected databases to stdout, or
599 // to file if specified.
600 // This is retrieving data from the Blackberry.
601 if( dbNames
.size() ) {
602 vector
<string
>::iterator b
= dbNames
.begin();
604 for( ; b
!= dbNames
.end(); b
++ ) {
605 con
.OpenMode(Controller::Desktop
, password
.c_str());
606 auto_ptr
<Parser
> parse
= GetParser(*b
,filename
);
607 unsigned int id
= con
.GetDBID(*b
);
608 con
.LoadDatabase(id
, *parse
.get());
612 // Save contents of file to specified databases
613 // This is writing data to the Blackberry.
614 if( saveDbNames
.size() ) {
615 vector
<string
>::iterator b
= saveDbNames
.begin();
617 for( ; b
!= saveDbNames
.end(); b
++ ) {
618 con
.OpenMode(Controller::Desktop
, password
.c_str());
619 auto_ptr
<Builder
> build
=
620 GetBuilder(*b
, filename
);
621 unsigned int id
= con
.GetDBID(*b
);
622 con
.SaveDatabase(id
, *build
);
627 catch( Usb::Error
&ue
) {
628 std::cerr
<< "Usb::Error caught: " << ue
.what() << endl
;
631 catch( Barry::Error
&se
) {
632 std::cerr
<< "Barry::Error caught: " << se
.what() << endl
;
635 catch( std::exception
&e
) {
636 std::cerr
<< "std::exception caught: " << e
.what() << endl
;