tools/btool.cc

   1 ///
   2 /// \file       btool.cc
   3 ///             Barry library tester
   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 <barry/barry.h>
  23 #include <iomanip>
  24 #include <iostream>
  25 #include <fstream>
  26 #include <vector>
  27 #include <string>
  28 #include <getopt.h>
  29
  30
  31 using namespace std;
  32 using namespace Barry;
  33
  34 void Usage()
  35 {
  36    int major, minor;
  37    const char *Version = Barry::Version(major, minor);
  38
  39    cerr
  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"
  43    << "\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"
  52 #endif
  53    << "   -h        This help\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"
  68    << "\n"
  69    << " -d Command modifiers:   (can be used multiple times for more than 1 record)\n"
  70    << "\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"
  78    << endl;
  79 }
  80
  81 class Contact2Ldif
  82 {
  83 public:
  84         Barry::ContactLdif &ldif;
  85
  86         Contact2Ldif(Barry::ContactLdif &ldif) : ldif(ldif) {}
  87
  88         void operator()(const Contact &rec)
  89         {
  90                 ldif.DumpLdif(cout, rec);
  91         }
  92 };
  93
  94 template <class Record>
  95 struct Store
  96 {
  97         std::vector<Record> records;
  98         mutable typename std::vector<Record>::const_iterator rec_it;
  99         std::string filename;
 100         bool load;
 101         int count;
 102
 103         Store(const string &filename, bool load)
 104                 : rec_it(records.end()),
 105                 filename(filename),
 106                 load(load),
 107                 count(0)
 108         {
 109 #ifdef __BARRY_BOOST_MODE__
 110                 try {
 111
 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);
 117                                 ia >> records;
 118                                 cout << records.size()
 119                                      << " records loaded from '"
 120                                      << filename << "'" << endl;
 121                                 sort(records.begin(), records.end());
 122                                 rec_it = records.begin();
 123
 124                                 // debugging aid
 125                                 typename std::vector<Record>::const_iterator beg = records.begin(), end = records.end();
 126                                 for( ; beg != end; beg++ ) {
 127                                         cout << (*beg) << endl;
 128                                 }
 129                         }
 130
 131                 } catch( boost::archive::archive_exception &ae ) {
 132                         cerr << "Archive exception in ~Store(): "
 133                              << ae.what() << endl;
 134                 }
 135 #endif
 136         }
 137         ~Store()
 138         {
 139                 cout << "Store counted " << dec << count << " records." << endl;
 140 #ifdef __BARRY_BOOST_MODE__
 141                 try {
 142
 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);
 149                                 oa << r;
 150                                 cout << dec << r.size() << " records saved to '"
 151                                         << filename << "'" << endl;
 152                         }
 153
 154                 } catch( boost::archive::archive_exception &ae ) {
 155                         cerr << "Archive exception in ~Store(): "
 156                              << ae.what() << endl;
 157                 }
 158 #endif
 159         }
 160
 161         // storage operator
 162         void operator()(const Record &rec)
 163         {
 164                 count++;
 165                 std::cout << rec << std::endl;
 166                 records.push_back(rec);
 167         }
 168
 169         // retrieval operator
 170         bool operator()(Record &rec, unsigned int databaseId) const
 171         {
 172                 if( rec_it == records.end() )
 173                         return false;
 174                 rec = *rec_it;
 175                 rec_it++;
 176                 return true;
 177         }
 178 };
 179
 180 class DataDumpParser : public Barry::Parser
 181 {
 182         uint32_t m_id;
 183
 184 public:
 185         virtual void SetUniqueId(uint32_t id)
 186         {
 187                 m_id = id;
 188         }
 189
 190         virtual void ParseFields(const Barry::Data &data, size_t &offset)
 191         {
 192                 std::cout << "Raw record dump for record: "
 193                         << std::hex << m_id << std::endl;
 194                 std::cout << data << std::endl;
 195         }
 196 };
 197
 198 auto_ptr<Parser> GetParser(const string &name, const string &filename)
 199 {
 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)));
 205         }
 206         else if( name == "Messages" ) {
 207                 return auto_ptr<Parser>(
 208                         new RecordParser<Message, Store<Message> > (
 209                                 new Store<Message>(filename, false)));
 210         }
 211         else if( name == "Calendar" ) {
 212                 return auto_ptr<Parser>(
 213                         new RecordParser<Calendar, Store<Calendar> > (
 214                                 new Store<Calendar>(filename, false)));
 215         }
 216         else if( name == "Service Book" ) {
 217                 return auto_ptr<Parser>(
 218                         new RecordParser<ServiceBook, Store<ServiceBook> > (
 219                                 new Store<ServiceBook>(filename, false)));
 220         }
 221 /*
 222         else if( name == "Memos" ) {
 223                 return auto_ptr<Parser>(
 224                         new RecordParser<Memo, Store<Memo> > (
 225                                 new Store<Memo>(filename, false )));
 226         }
 227         else if( name == "Tasks" ) {
 228                 return auto_ptr<Parser>(
 229                         new RecordParser<Task, Store<Task> > (
 230                                 new Store<Task>(filename, false )));
 231         }
 232 */
 233         else {
 234                 // unknown database, use null parser
 235                 return auto_ptr<Parser>( new DataDumpParser );
 236         }
 237 }
 238
 239 auto_ptr<Builder> GetBuilder(const string &name, const string &filename)
 240 {
 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)));
 246         }
 247 /*
 248         else if( name == "Messages" ) {
 249                 return auto_ptr<Parser>(
 250                         new RecordParser<Message, Store<Message> > (
 251                                 new Store<Message>(filename, true)));
 252         }
 253         else if( name == "Calendar" ) {
 254                 return auto_ptr<Parser>(
 255                         new RecordParser<Calendar, Store<Calendar> > (
 256                                 new Store<Calendar>(filename, true)));
 257         }
 258         else if( name == "Service Book" ) {
 259                 return auto_ptr<Parser>(
 260                         new RecordParser<ServiceBook, Store<ServiceBook> > (
 261                                 new Store<ServiceBook>(filename, true)));
 262         }
 263         else if( name == "Memos" ) {
 264                 return auto_ptr<Parser>(
 265                         new RecordParser<Memo, Store<Memo> > (
 266                                 new Store<Memo>(filename, true)));
 267         }
 268         else if( name == "Tasks" ) {
 269                 return auto_ptr<Parser>(
 270                         new RecordParser<Task, Store<Task> > (
 271                                 new Store<Task>(filename, true)));
 272         }
 273 */
 274         else {
 275                 throw std::runtime_error("No Builder available for database");
 276         }
 277 }
 278
 279 struct StateTableCommand
 280 {
 281         char flag;
 282         bool clear;
 283         unsigned int index;
 284
 285         StateTableCommand(char f, bool c, unsigned int i)
 286                 : flag(f), clear(c), index(i) {}
 287 };
 288
 289 bool SplitMap(const string &map, string &ldif, string &read, string &write)
 290 {
 291         string::size_type a = map.find(',');
 292         if( a == string::npos )
 293                 return false;
 294
 295         string::size_type b = map.find(',', a+1);
 296         if( b == string::npos )
 297                 return false;
 298
 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);
 302
 303         return ldif.size() && read.size() && write.size();
 304 }
 305
 306 void DoMapping(ContactLdif &ldif, const vector<string> &mapCommands)
 307 {
 308         for(    vector<string>::const_iterator i = mapCommands.begin();
 309                 i != mapCommands.end();
 310                 ++i )
 311         {
 312                 // single names mean unmapping
 313                 if( i->find(',') == string::npos ) {
 314                         // unmap
 315                         cerr << "Unmapping: " << *i << endl;
 316                         ldif.Unmap(*i);
 317                 }
 318                 else {
 319                         cerr << "Mapping: " << *i << endl;
 320
 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;
 326                                 }
 327                         }
 328                         else {
 329                                 cerr << "Invalid map format: " << *i << endl;
 330                         }
 331                 }
 332         }
 333 }
 334
 335 int main(int argc, char *argv[])
 336 {
 337         cout.sync_with_stdio(true);     // leave this on, since libusb uses
 338                                         // stdio for debug messages
 339
 340         try {
 341
 342                 uint32_t pin = 0;
 343                 bool    list_only = false,
 344                         show_dbdb = false,
 345                         ldif_contacts = false,
 346                         data_dump = false,
 347                         reset_device = false,
 348                         list_contact_fields = false,
 349                         list_ldif_map = false,
 350                         record_state = false;
 351                 string ldifBaseDN, ldifDnAttr;
 352                 string filename;
 353                 string password;
 354                 vector<string> dbNames, saveDbNames, mapCommands;
 355                 vector<StateTableCommand> stCommands;
 356
 357                 // process command line options
 358                 for(;;) {
 359                         int cmd = getopt(argc, argv, "c:C:d:D:f:hlLm:Mp:P:r:R:s:tT:vX");
 360                         if( cmd == -1 )
 361                                 break;
 362
 363                         switch( cmd )
 364                         {
 365                         case 'c':       // contacts to ldap ldif
 366                                 ldif_contacts = true;
 367                                 ldifBaseDN = optarg;
 368                                 break;
 369
 370                         case 'C':       // DN Attribute for FQDN
 371                                 ldifDnAttr = optarg;
 372                                 break;
 373
 374                         case 'd':       // show dbname
 375                                 dbNames.push_back(string(optarg));
 376                                 break;
 377
 378                         case 'D':       // delete record
 379                                 stCommands.push_back(
 380                                         StateTableCommand('D', false, atoi(optarg)));
 381                                 break;
 382
 383                         case 'f':       // filename
 384 #ifdef __BARRY_BOOST_MODE__
 385                                 filename = optarg;
 386 #else
 387                                 cerr << "-f option not supported - no Boost "
 388                                         "serialization support available\n";
 389                                 return 1;
 390 #endif
 391                                 break;
 392                         case 'l':       // list only
 393                                 list_only = true;
 394                                 break;
 395
 396                         case 'L':       // List Contact field names
 397                                 list_contact_fields = true;
 398                                 break;
 399
 400                         case 'm':       // Map / Unmap
 401                                 mapCommands.push_back(string(optarg));
 402                                 break;
 403
 404                         case 'M':       // List LDIF map
 405                                 list_ldif_map = true;
 406                                 break;
 407
 408                         case 'p':       // Blackberry PIN
 409                                 pin = strtoul(optarg, NULL, 16);
 410                                 break;
 411
 412                         case 'P':       // Device password
 413                                 password = optarg;
 414                                 break;
 415
 416                         case 'r':       // get specific record index
 417                                 stCommands.push_back(
 418                                         StateTableCommand('r', false, atoi(optarg)));
 419                                 break;
 420
 421                         case 'R':       // same as 'r', and clears dirty
 422                                 stCommands.push_back(
 423                                         StateTableCommand('r', true, atoi(optarg)));
 424                                 break;
 425
 426                         case 's':       // save dbname
 427                                 saveDbNames.push_back(string(optarg));
 428                                 break;
 429
 430                         case 't':       // display database database
 431                                 show_dbdb = true;
 432                                 break;
 433
 434                         case 'T':       // show RecordStateTable
 435                                 record_state = true;
 436                                 dbNames.push_back(string(optarg));
 437                                 break;
 438
 439                         case 'v':       // data dump on
 440                                 data_dump = true;
 441                                 break;
 442
 443                         case 'X':       // reset device
 444                                 reset_device = true;
 445                                 break;
 446
 447                         case 'h':       // help
 448                         default:
 449                                 Usage();
 450                                 return 0;
 451                         }
 452                 }
 453
 454                 // Initialize the barry library.  Must be called before
 455                 // anything else.
 456                 Barry::Init(data_dump);
 457
 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;
 464                         }
 465                 }
 466
 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
 470                 Barry::Probe probe;
 471                 int activeDevice = -1;
 472                 if( ldif_contacts )
 473                         cout << "# ";
 474                 cout << "Blackberry devices found:" << endl;
 475                 for( int i = 0; i < probe.GetCount(); i++ ) {
 476                         if( ldif_contacts )
 477                                 cout << "# ";
 478                         cout << probe.Get(i) << endl;
 479                         if( probe.Get(i).m_pin == pin )
 480                                 activeDevice = i;
 481                 }
 482
 483                 if( list_only )
 484                         return 0;       // done
 485
 486                 if( activeDevice == -1 ) {
 487                         if( pin == 0 ) {
 488                                 // can we default to single device?
 489                                 if( probe.GetCount() == 1 )
 490                                         activeDevice = 0;
 491                                 else {
 492                                         cerr << "No device selected" << endl;
 493                                         return 1;
 494                                 }
 495                         }
 496                         else {
 497                                 cerr << "PIN " << setbase(16) << pin
 498                                         << " not found" << endl;
 499                                 return 1;
 500                         }
 501                 }
 502
 503                 if( reset_device ) {
 504                         Usb::Device dev(probe.Get(activeDevice).m_dev);
 505                         dev.Reset();
 506                         return 0;
 507                 }
 508
 509                 // Create our controller object
 510                 Barry::Controller con(probe.Get(activeDevice));
 511
 512                 //
 513                 // execute each mode that was turned on
 514                 //
 515
 516
 517                 // Dump list of all databases to stdout
 518                 if( show_dbdb ) {
 519                         // open desktop mode socket
 520                         con.OpenMode(Controller::Desktop, password.c_str());
 521                         cout << con.GetDBDB() << endl;
 522                 }
 523
 524                 // Dump list of Contact field names
 525                 if( list_contact_fields ) {
 526                         for( const ContactLdif::NameToFunc *n = ldif.GetFieldNames(); n->name; n++ ) {
 527                                 cout.fill(' ');
 528                                 cout << "  " << left << setw(20) << n->name << ": "
 529                                         << n->description << endl;
 530                         }
 531                 }
 532
 533                 // Dump current LDIF mapping
 534                 if( list_ldif_map ) {
 535                         cout << ldif << endl;
 536                 }
 537
 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());
 543
 544                         // create a storage functor object that accepts
 545                         // Barry::Contact objects as input
 546                         Contact2Ldif storage(ldif);
 547
 548                         // load all the Contact records into storage
 549                         con.LoadDatabaseByType<Barry::Contact>(storage);
 550                 }
 551
 552                 // Dump record state table to stdout
 553                 if( record_state ) {
 554                         if( dbNames.size() == 0 ) {
 555                                 cout << "No db names to process" << endl;
 556                                 return 1;
 557                         }
 558
 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;
 566                                 cout << state;
 567                         }
 568                         return 0;
 569                 }
 570
 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;
 575                                 return 1;
 576                         }
 577
 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);
 581
 582                         for( unsigned int i = 0; i < stCommands.size(); i++ ) {
 583                                 con.GetRecord(id, stCommands[i].index, *parse.get());
 584
 585                                 if( stCommands[i].flag == 'r' && stCommands[i].clear ) {
 586                                         cout << "Clearing record's dirty flags..." << endl;
 587                                         con.ClearDirty(id, stCommands[i].index);
 588                                 }
 589
 590                                 if( stCommands[i].flag == 'D' ) {
 591                                         con.DeleteRecord(id, stCommands[i].index);
 592                                 }
 593                         }
 594
 595                         return 0;
 596                 }
 597
 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();
 603
 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());
 609                         }
 610                 }
 611
 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();
 616
 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);
 623                         }
 624                 }
 625
 626         }
 627         catch( Usb::Error &ue) {
 628                 std::cerr << "Usb::Error caught: " << ue.what() << endl;
 629                 return 1;
 630         }
 631         catch( Barry::Error &se ) {
 632                 std::cerr << "Barry::Error caught: " << se.what() << endl;
 633                 return 1;
 634         }
 635         catch( std::exception &e ) {
 636                 std::cerr << "std::exception caught: " << e.what() << endl;
 637                 return 1;
 638         }
 639
 640         return 0;
 641 }
 642