src/m_desktop.cc

   1 ///
   2 /// \file       m_desktop.cc
   3 ///             Mode class for the Desktop mode
   4 ///
   5
   6 /*
   7     Copyright (C) 2005-2010, 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 "m_desktop.h"
  23 #include "data.h"
  24 #include "protocol.h"
  25 #include "protostructs.h"
  26 #include "packet.h"
  27 #include "endian.h"
  28 #include "error.h"
  29 #include "usbwrap.h"
  30 #include "controller.h"
  31 #include "parser.h"
  32 #include <stdexcept>
  33 #include <sstream>
  34
  35 #include "debug.h"
  36
  37 namespace Barry { namespace Mode {
  38
  39
  40 ///////////////////////////////////////////////////////////////////////////////
  41 // Desktop Mode class
  42
  43 Desktop::Desktop(Controller &con)
  44         : Mode(con, Controller::Desktop)
  45         , m_ic(0)
  46 {
  47 }
  48
  49 Desktop::Desktop(Controller &con, const IConverter &ic)
  50         : Mode(con, Controller::Desktop)
  51         , m_ic(&ic)
  52 {
  53 }
  54
  55 Desktop::~Desktop()
  56 {
  57 }
  58
  59 ///////////////////////////////////////////////////////////////////////////////
  60 // protected members
  61
  62 void Desktop::LoadCommandTable()
  63 {
  64         char rawCommand[] = { 6, 0, 0x0a, 0, 0x40, 0, 0, 1, 0, 0 };
  65         *((uint16_t*) rawCommand) = htobs(m_socket->GetSocket());
  66
  67         Data command(rawCommand, sizeof(rawCommand));
  68
  69         try {
  70                 m_socket->Packet(command, m_response);
  71
  72                 MAKE_PACKET(rpack, m_response);
  73                 while( rpack->command != SB_COMMAND_DB_DONE ) {
  74                         m_socket->NextRecord(m_response);
  75
  76                         rpack = (const Protocol::Packet *) m_response.GetData();
  77                         if( rpack->command == SB_COMMAND_DB_DATA && btohs(rpack->size) > 10 ) {
  78                                 // second packet is generally large, and contains
  79                                 // the command table
  80                                 m_commandTable.Clear();
  81                                 m_commandTable.Parse(m_response, 6);
  82                         }
  83                 }
  84
  85                 ddout(m_commandTable);
  86
  87         }
  88         catch( Usb::Error & ) {
  89                 eout("Desktop: error getting command table");
  90                 eeout(command, m_response);
  91                 throw;
  92         }
  93 }
  94
  95 void Desktop::LoadDBDB()
  96 {
  97         DBPacket packet(*this, m_command, m_response);
  98         packet.GetDBDB();
  99
 100         m_socket->Packet(packet);
 101
 102         while( packet.Command() != SB_COMMAND_DB_DONE ) {
 103                 if( packet.Command() == SB_COMMAND_DB_DATA ) {
 104                         m_dbdb.Clear();
 105                         m_dbdb.Parse(m_response);
 106                 }
 107
 108                 // advance!
 109                 m_socket->NextRecord(m_response);
 110         }
 111 }
 112
 113 void Desktop::OnOpen()
 114 {
 115         // get command table and database database
 116         LoadCommandTable();
 117         LoadDBDB();
 118 }
 119
 120 ///////////////////////////////////////////////////////////////////////////////
 121 // public API
 122
 123 //
 124 // GetDBID
 125 //
 126 /// Get numeric database ID by name.
 127 ///
 128 /// \param[in]  name            Name of database, which matches one of the
 129 ///                             names listed in GetDBDB()
 130 ///
 131 /// \exception  Barry::Error
 132 ///             Thrown if name not found.
 133 ///
 134 unsigned int Desktop::GetDBID(const std::string &name) const
 135 {
 136         unsigned int ID = 0;
 137         // FIXME - this needs a better error handler...
 138         if( !m_dbdb.GetDBNumber(name, ID) ) {
 139                 throw Error("Desktop: database name not found: " + name);
 140         }
 141         return ID;
 142 }
 143
 144 //
 145 // GetDBCommand
 146 //
 147 /// Get database command from command table.  Must call Open()
 148 /// before this.
 149 ///
 150 unsigned int Desktop::GetDBCommand(CommandType ct)
 151 {
 152         unsigned int cmd = 0;
 153         const char *cmdName = "Unknown";
 154
 155         switch( ct )
 156         {
 157         case DatabaseAccess:
 158                 cmdName = "Database Access";
 159                 cmd = m_commandTable.GetCommand(cmdName);
 160                 break;
 161         default:
 162                 throw std::logic_error("Desktop: unknown command type");
 163         }
 164
 165         if( cmd == 0 ) {
 166                 std::ostringstream oss;
 167                 oss << "Desktop: unable to get command code: " << cmdName;
 168                 throw Error(oss.str());
 169         }
 170
 171         return cmd;
 172 }
 173
 174 void Desktop::SetIConverter(const IConverter &ic)
 175 {
 176         m_ic = &ic;
 177 }
 178
 179 //
 180 // GetRecordStateTable
 181 //
 182 /// Retrieve the record state table from the handheld device, using the given
 183 /// database ID.  Results will be stored in result, which will be cleared
 184 /// before adding.
 185 ///
 186 void Desktop::GetRecordStateTable(unsigned int dbId, RecordStateTable &result)
 187 {
 188         dout("Database ID: " << dbId);
 189
 190         // start fresh
 191         result.Clear();
 192
 193         DBPacket packet(*this, m_command, m_response);
 194         packet.GetRecordStateTable(dbId);
 195
 196         m_socket->Packet(packet);
 197         result.Parse(m_response);
 198
 199         // flush the command sequence
 200         while( packet.Command() != SB_COMMAND_DB_DONE )
 201                 m_socket->NextRecord(m_response);
 202 }
 203
 204 //
 205 // AddRecord
 206 //
 207 /// Adds a record to the specified database.  RecordId is
 208 /// retrieved from build, and duplicate IDs are allowed by the device
 209 /// (i.e. you can have two records with the same ID)
 210 /// but *not* recommended!
 211 //
 212 void Desktop::AddRecord(unsigned int dbId, Builder &build)
 213 {
 214         dout("Database ID: " << dbId);
 215
 216         DBPacket packet(*this, m_command, m_response);
 217
 218         if( packet.SetRecord(dbId, build, m_ic) ) {
 219
 220                 std::ostringstream oss;
 221
 222                 m_socket->Packet(packet);
 223
 224                 // successful packet transfer, so check the network return code
 225                 if( packet.Command() != SB_COMMAND_DB_DONE ) {
 226                         oss << "Desktop: device responded with unexpected packet command code: "
 227                             << "0x" << std::hex << packet.Command();
 228                         throw Error(oss.str());
 229                 }
 230
 231                 if( packet.ReturnCode() != 0 ) {
 232                         oss << "Desktop: device responded with error code (command: "
 233                             << packet.Command() << ", code: "
 234                             << packet.ReturnCode() << ")";
 235                         throw Error(oss.str());
 236                 }
 237         }
 238 }
 239
 240 //
 241 // GetRecord
 242 //
 243 /// Retrieves a specific record from the specified database.
 244 /// The stateTableIndex comes from the GetRecordStateTable()
 245 /// function.  GetRecord() does not clear the dirty flag.
 246 ///
 247 void Desktop::GetRecord(unsigned int dbId,
 248                            unsigned int stateTableIndex,
 249                            Parser &parser)
 250 {
 251         dout("Database ID: " << dbId);
 252
 253         std::string dbName;
 254         m_dbdb.GetDBName(dbId, dbName);
 255
 256         DBPacket packet(*this, m_command, m_response);
 257         packet.GetRecordByIndex(dbId, stateTableIndex);
 258
 259         m_socket->Packet(packet);
 260
 261         // perform copious packet checks
 262         if( m_response.GetSize() < SB_PACKET_RESPONSE_HEADER_SIZE ) {
 263                 eeout(m_command, m_response);
 264
 265                 std::ostringstream oss;
 266                 oss << "Desktop: invalid response packet size of "
 267                     << std::dec << m_response.GetSize();
 268                 eout(oss.str());
 269                 throw Error(oss.str());
 270         }
 271         if( packet.Command() != SB_COMMAND_DB_DATA ) {
 272                 eeout(m_command, m_response);
 273
 274                 std::ostringstream oss;
 275                 oss << "Desktop: unexpected command of 0x"
 276                     << std::setbase(16) << packet.Command()
 277                     << " instead of expected 0x"
 278                     << std::setbase(16) << (unsigned int)SB_COMMAND_DB_DATA;
 279                 eout(oss.str());
 280                 throw Error(oss.str());
 281         }
 282
 283         // grab that data
 284         packet.Parse(parser, dbName, m_ic);
 285
 286         // flush the command sequence
 287         while( packet.Command() != SB_COMMAND_DB_DONE )
 288                 m_socket->NextRecord(m_response);
 289 }
 290
 291 //
 292 // SetRecord
 293 //
 294 /// Overwrites a specific record in the device as identified by the
 295 /// stateTableIndex.
 296 ///
 297 void Desktop::SetRecord(unsigned int dbId, unsigned int stateTableIndex,
 298                            Builder &build)
 299 {
 300         dout("Database ID: " << dbId << " Index: " << stateTableIndex);
 301
 302         DBPacket packet(*this, m_command, m_response);
 303
 304         // loop until builder object has no more data
 305         if( !packet.SetRecordByIndex(dbId, stateTableIndex, build, m_ic) ) {
 306                 throw std::logic_error("Desktop: no data available in SetRecord");
 307         }
 308
 309         m_socket->Packet(packet);
 310
 311         std::ostringstream oss;
 312
 313         // successful packet transfer, so check the network return code
 314         if( packet.Command() != SB_COMMAND_DB_DONE ) {
 315                 oss << "Desktop: device responded with unexpected packet command code: "
 316                     << "0x" << std::hex << packet.Command();
 317                 throw Error(oss.str());
 318         }
 319
 320         if( packet.ReturnCode() != 0 ) {
 321                 oss << "Desktop: device responded with error code (command: "
 322                     << packet.Command() << ", code: "
 323                     << packet.ReturnCode() << ")";
 324                 throw Error(oss.str());
 325         }
 326 }
 327
 328 //
 329 // ClearDirty
 330 //
 331 /// Clears the dirty flag on the specified record in the specified database.
 332 ///
 333 void Desktop::ClearDirty(unsigned int dbId, unsigned int stateTableIndex)
 334 {
 335         dout("Database ID: " << dbId);
 336
 337         DBPacket packet(*this, m_command, m_response);
 338         packet.SetRecordFlags(dbId, stateTableIndex, 0);
 339
 340         m_socket->Packet(packet);
 341
 342         // flush the command sequence
 343         while( packet.Command() != SB_COMMAND_DB_DONE )
 344                 m_socket->NextRecord(m_response);
 345 }
 346
 347 //
 348 // DeleteRecord
 349 //
 350 /// Deletes the specified record in the specified database.
 351 ///
 352 void Desktop::DeleteRecord(unsigned int dbId, unsigned int stateTableIndex)
 353 {
 354         dout("Database ID: " << dbId);
 355
 356         DBPacket packet(*this, m_command, m_response);
 357         packet.DeleteRecordByIndex(dbId, stateTableIndex);
 358
 359         m_socket->Packet(packet);
 360
 361         // flush the command sequence
 362         while( packet.Command() != SB_COMMAND_DB_DONE )
 363                 m_socket->NextRecord(m_response);
 364 }
 365
 366 //
 367 // LoadDatabase
 368 //
 369 /// Retrieve a database from the handheld device, using the given parser
 370 /// to parse the resulting data, and optionally store it.
 371 ///
 372 /// See the RecordParser<> template to create a parser object.  The
 373 /// RecordParser<> template allows custom storage based on the type of
 374 /// database record retrieved.  The database ID and the parser Record
 375 /// type must match.
 376 ///
 377 /// \param[in]  dbId            Database Database ID - use GetDBID()
 378 /// \param[out] parser          Parser object which parses the resulting
 379 ///                             protocol data, and optionally stores it in
 380 ///                             a custom fashion.  See the RecordParser<>
 381 ///                             template.
 382 ///
 383 /// \exception  Barry::Error
 384 ///             Thrown on protocol error.
 385 ///
 386 /// \exception  std::logic_error
 387 ///             Thrown if not in Desktop mode.
 388 ///
 389 void Desktop::LoadDatabase(unsigned int dbId, Parser &parser)
 390 {
 391         DBData data;
 392         DBLoader loader(*this);
 393         bool loading = loader.StartDBLoad(dbId, data);
 394         while( loading ) {
 395                 // manual parser call
 396                 parser.ParseRecord(data, m_ic);
 397
 398                 // advance!
 399                 loading = loader.GetNextRecord(data);
 400         }
 401 }
 402
 403 void Desktop::ClearDatabase(unsigned int dbId)
 404 {
 405         dout("Database ID: " << dbId);
 406
 407         DBPacket packet(*this, m_command, m_response);
 408         packet.ClearDatabase(dbId);
 409
 410         // wait up to a minute here for old, slower devices with lots of data
 411         m_socket->Packet(packet, 60000);
 412         if( packet.ReturnCode() != 0 ) {
 413                 std::ostringstream oss;
 414                 oss << "Desktop: could not clear database: (command: "
 415                     << "0x" << std::hex << packet.Command() << ", code: "
 416                     << "0x" << std::hex << packet.ReturnCode() << ")";
 417                 throw Error(oss.str());
 418         }
 419
 420         // check response to clear command was successful
 421         if( packet.Command() != SB_COMMAND_DB_DONE ) {
 422                 eeout(m_command, m_response);
 423                 throw Error("Desktop: error clearing database, bad response");
 424         }
 425 }
 426
 427 void Desktop::SaveDatabase(unsigned int dbId, Builder &builder)
 428 {
 429         dout("Database ID: " << dbId);
 430
 431         // Protocol note: so far in testing, this CLEAR_DATABASE operation is
 432         //                required, since every record sent via SET_RECORD
 433         //                is treated like a hypothetical "ADD_RECORD" (perhaps
 434         //                SET_RECORD should be renamed)... I don't know if
 435         //                there is a real SET_RECORD... all I know is from
 436         //                the Windows USB captures, which uses this same
 437         //                technique.
 438         ClearDatabase(dbId);
 439
 440         DBPacket packet(*this, m_command, m_response);
 441
 442         // loop until builder object has no more data
 443         bool first = true;
 444         while( packet.SetRecord(dbId, builder, m_ic) ) {
 445                 dout("Database ID: " << dbId);
 446
 447                 m_socket->Packet(packet, first ? 60000 : -1);
 448                 first = false;
 449
 450                 std::ostringstream oss;
 451                 // successful packet transfer, so check the network return code
 452                 if( packet.Command() != SB_COMMAND_DB_DONE ) {
 453                         oss << "Desktop: device responded with unexpected packet command code: "
 454                             << "0x" << std::hex << packet.Command();
 455                         throw Error(oss.str());
 456                 }
 457
 458                 if( packet.ReturnCode() != 0 ) {
 459                         oss << "Desktop: device responded with error code (command: "
 460                             << packet.Command() << ", code: "
 461                             << packet.ReturnCode() << ")";
 462                         throw Error(oss.str());
 463                 }
 464         }
 465 }
 466
 467
 468
 469 //////////////////////////////////////////////////////////////////////////////
 470 // DBLoader class
 471
 472 struct DBLoaderData
 473 {
 474         DBPacket m_packet;
 475         DBLoaderData(Desktop &desktop, Data &command, Data &response)
 476                 : m_packet(desktop, command, response)
 477         {
 478         }
 479 };
 480
 481 DBLoader::DBLoader(Desktop &desktop)
 482         : m_desktop(desktop)
 483         , m_loading(false)
 484         , m_loader(new DBLoaderData(desktop, m_send, m_send))
 485 {
 486 }
 487
 488 DBLoader::~DBLoader()
 489 {
 490         delete m_loader;
 491 }
 492
 493 bool DBLoader::StartDBLoad(unsigned int dbId, DBData &data)
 494 {
 495         dout("Database ID: " << dbId);
 496
 497         m_loading = true;
 498         m_desktop.m_dbdb.GetDBName(dbId, m_dbName);
 499
 500         DBPacket &packet = m_loader->m_packet;
 501         packet.SetNewReceive(data.UseData());
 502         packet.GetRecords(dbId);
 503         m_desktop.m_socket->Packet(packet);
 504
 505         while( packet.Command() != SB_COMMAND_DB_DONE ) {
 506                 if( packet.Command() == SB_COMMAND_DB_DATA ) {
 507                         packet.ParseMeta(data);
 508                         data.SetDBName(m_dbName);
 509                         return true;
 510                 }
 511
 512                 // advance! (use the same data block as in packet)
 513                 m_desktop.m_socket->NextRecord(data.UseData());
 514         }
 515
 516         m_loading = false;
 517         return false;
 518 }
 519
 520 bool DBLoader::GetNextRecord(DBData &data)
 521 {
 522         if( !m_loading )
 523                 return false;
 524
 525         DBPacket &packet = m_loader->m_packet;
 526         packet.SetNewReceive(data.UseData());
 527
 528         do {
 529                 // advance! (use same data as in packet)
 530                 m_desktop.m_socket->NextRecord(data.UseData());
 531
 532                 if( packet.Command() == SB_COMMAND_DB_DATA ) {
 533                         packet.ParseMeta(data);
 534                         return true;
 535                 }
 536         } while( m_loader->m_packet.Command() != SB_COMMAND_DB_DONE );
 537
 538         m_loading = false;
 539         return false;
 540 }
 541
 542 } // namespace Barry::Mode
 543
 544
 545
 546
 547
 548 //////////////////////////////////////////////////////////////////////////////
 549 // DeviceBuilder class
 550
 551 DeviceBuilder::DeviceBuilder(Mode::Desktop &desktop)
 552         : m_desktop(desktop)
 553         , m_loader(desktop)
 554 {
 555 }
 556
 557 // searches the dbdb from the desktop to find the dbId,
 558 // returns false if not found, and adds it to the list of
 559 // databases to retrieve if found
 560 bool DeviceBuilder::Add(const std::string &dbname)
 561 {
 562         try {
 563                 DBLabel id(m_desktop.GetDBID(dbname), dbname);
 564                 m_dbIds.push_back(id);
 565                 m_current = m_dbIds.begin();
 566                 return true;
 567         }
 568         catch( Barry::Error & ) {
 569                 // GetDBID() throws on error...
 570                 return false;
 571         }
 572 }
 573
 574 bool DeviceBuilder::BuildRecord(DBData &data,
 575                                 size_t &offset,
 576                                 const IConverter *ic)
 577 {
 578         DBData temp;
 579         if( !FetchRecord(temp, ic) )
 580                 return false;
 581
 582         // copy the metadata
 583         data.SetVersion(temp.GetVersion());
 584         data.SetDBName(temp.GetDBName());
 585         data.SetIds(temp.GetRecType(), temp.GetUniqueId());
 586         data.SetOffset(offset);
 587
 588         // copy data from temp into the given offset
 589         size_t tempsize = temp.GetData().GetSize() - temp.GetOffset();
 590         data.UseData().MemCpy(offset,
 591                 temp.GetData().GetData() + temp.GetOffset(), tempsize);
 592         data.UseData().ReleaseBuffer(offset + tempsize);
 593         return true;
 594 }
 595
 596 bool DeviceBuilder::FetchRecord(DBData &data, const IConverter *ic)
 597 {
 598         bool ret;
 599
 600         if( m_loader.IsBusy() ) {
 601                 ret = m_loader.GetNextRecord(data);
 602         }
 603         else {
 604                 // don't do anything if we're at the end of our rope
 605                 if( EndOfFile() )
 606                         return false;
 607
 608                 // advance and check again... m_current always points
 609                 // to our current DB
 610                 ++m_current;
 611                 if( EndOfFile() )
 612                         return false;
 613
 614                 ret = m_loader.StartDBLoad(m_current->id, data);
 615         }
 616
 617         // fill in the DBname if successful
 618         if( ret ) {
 619                 data.SetDBName(m_current->name);
 620         }
 621         return ret;
 622 }
 623
 624 bool DeviceBuilder::EndOfFile() const
 625 {
 626         return m_current == m_dbIds.end();
 627 }
 628
 629 } // namespace Barry
 630