ChangeLog

   1 Release: version 0.10 - 2007/10/12
   2 ------------------------------------------------------------------------------
   3 2007/11/09
   4         - added modprobe/blacklist-berry_charge as per Simon Ruggier's
   5                 suggestion.  Thanks also to Niels de Vos for a similar
   6                 suggestion.
   7         - fixed udev rules to work on both old and new distros
   8                 Thanks to Duncan Mak for the bug report.
   9         - AUTHORS update
  10         - fixed string comparison to use case insensitive compare in
  11                 opensync plugin
  12         - updated Debian package to include modprobe blacklist file
  13 2007/10/26
  14         - opensync plugin fixes:
  15                 - fixed memory leak in vBase::GetAttr()
  16                 - added support in vformat parser to parse "blocks"
  17                         and keep track of the hierarchy when
  18                         parsing an iCalendar, etc.
  19                 - added support for searching for attributes only
  20                         inside certain blocks (i.e. find first
  21                         DTSTART in VEVENT block, not VTIMEZONE block)
  22 2007/10/25
  23         - fixed bug in Calendar::Clear, missing the Free / Class
  24                 member variables, leaving them uninitialized
  25         - added examples/addcalendar.cc
  26         - added more logging to the opensync plugin, logging the
  27                 ToBarry conversion results
  28         - added code to force struct tm.tm_isdst to -1 before calling
  29                 mktime, in vformat.c
  30                 - fixed typo in previous fix
  31 2007/10/12
  32         - renamed ktrans and translate to bktrans and btranslate to avoid
  33                 file name clashes with libtranslate of Gnome
  34                 Closes bug #1812410 reported by Troy Engel.
  35         - version bump:
  36                 - configure.ac
  37                 - src/Makefile.am
  38                 - src/version.cc
  39                 - gui/src/BackupWindow.cc
  40                 - src/Doxygen
  41                 - rpm/barry.spec
  42                 - debian/changelog
  43                 - opensync-plugin/src/barry_sync.cc
  44         - fixed missing default config file in the debian package for
  45                 the opensync plugin
  46                 Closes bug #1812224 reported by Ariel (adonatti).
  47         - added debian dbg packages for tracing segfaults
  48         - modified maintainer scripts so debug packages would reference
  49                 source code located in /usr/src/barry-0.9, etc.
  50
  51 Release: version 0.9 - 2007/10/12
  52 ------------------------------------------------------------------------------
  53 2007/09/29
  54         - adjusted autosuspend disabling code in bcharge, based on new
  55                 information on how kernels 2.6.21 / 2.6.22 work.
  56                 See bcharge.cc for comments.  If device/power/level or
  57                 device/power/autosuspend exist, charging should now work
  58                 without recompiling the kernel.
  59         - updated website docs with autosuspend info
  60 2007/09/27
  61         - large update to the doc/www web pages, moving some of the
  62                 information in README files to html format, so that it
  63                 is commonly available on the web
  64         - added step in maintenance scripts to automatically build the
  65                 .html files in doc/www when making a tarball release
  66 2007/09/22
  67         - added libopensync 0.22 version requirement to barry.spec file,
  68                 but it doesn't seem to work on OpenSuSE 10.2, where it's
  69                 needed.... hmmmm
  70 2007/09/21
  71         - updated README to mention new tree build configure options
  72         - fixed the configure scripts and makefiles so that when building
  73                 with custom CXXFLAGS and LDFLAGS environment variables,
  74                 it doesn't break the full-tree build mode, when
  75                 using --enable-gui and/or --enable-opensync-plugin
  76         - added config.h.in~ to buildgen.sh clean target
  77         - converted Debian build scripts to use cdbs
  78         - added opensync plugin binary package for Debian
  79         - added "Getting Started" section to web pages, as well as an
  80                 explanatory document for various system requirements
  81         - turned on opensync build in RPM maintainer scripts
  82 2007/09/20
  83         - added filename to power/state error message in bcharge.cc
  84         - adjusted maintainer scripts to automatically adjust barry.spec
  85                 for opensuse rpm builds
  86 2007/09/13
  87         - fixed some of the release build scripts and added support for
  88                 automated opensuse 10.2 builds
  89                 - fixed build target to i386
  90                 - changed scripts to add to PKG_CONFIG_PATH variable instead
  91                         of overwriting it
  92 2007/09/07
  93         - added website docs to doc/www... these are out of date at the
  94                 moment, and hopefully by including them here, they
  95                 will be updated more frequently
  96 2007/09/05
  97         - applied Simon Ruggier's build system patch that allowed a build
  98                 of all 3 components from the root directory and fixed the
  99                 configure scripts to support external build directories
 100         - reordered clean commands in the buildgen.sh scripts, and removed
 101                 the INSTALL files, since they are auto-generated by autoconf
 102         - removed extraneous buildgen.sh calls in maintainer scripts
 103         - added Simon Ruggier to AUTHORS
 104         - added explanatory note to 3 stage test build process in
 105                 maintainer script
 106 2007/08/24
 107         - fixed Category handling in the Contact record class, to
 108                 parse the comma separated string into an array,
 109                 and back
 110                 Note: this involves a change to the boost serialization
 111                         and will affect backward compatibility with
 112                         old serialization datafiles
 113         - added Category to examples/addcontact.cc
 114         - added Category support to the opensync plugin
 115 2007/08/23
 116         - fixed wrong read/write in btool output (oops)
 117         - added BadSize exception, and changed CheckSize() function
 118                 to throw it on error
 119         - changed backup GUI to catch BadSize exceptions on initial
 120                 connect, and try a reset if that error occurs, since
 121                 that likely means the device didn't shutdown properly
 122         - fixed in opensync plugin:
 123                 - some vcard data contains types codes in capital letters,
 124                         so added lower case conversion routine
 125                 - changed the order of address lines, so that address1
 126                         is the street, address2 is the extended address,
 127                         and address3 is the PO Box.  The Blackberry
 128                         doesn't seem to have any PO Box field.
 129 2007/08/20
 130         - added -e endpoint override option to btool
 131         - added status message to endpoint override
 132 2007/08/18
 133         - added configure check for strnlen, and implementation for
 134                 systems that don't have it, or that have it implemented
 135                 incorrectly.  Went a little paranoid here, since
 136                 AC_FUNC_STRNLEN doesn't set a define in config.h,
 137                 so I had to do it manually, and check in case autoconf
 138                 changes in the future... ugh.  See src/strnlen.h for
 139                 the gory details.
 140         - added code in probe.cc to fetch the device's description.
 141                 The description is now part of the probe results
 142                 along with the PIN.  Updates to protocol.h, adding
 143                 a new attribute definition.
 144                 Thanks to Rick Scott for pointing out the code in
 145                 XmBlackberry where he implemented this first.
 146         - fixed header dependency in record-internal.h
 147         - updated the "required autoconf" version to 2.61 for root build
 148         - moved nested structs out of the record classes that contain them,
 149                 in order to better support SWIG and Python
 150 2007/08/17
 151         - changed bcharge to use getopt() for its argument processing
 152         - added options -p and -s to bcharge, to adjust usb suspend
 153                 settings automatically where possible
 154         - updated the udev rules to use the new bcharge settings
 155         - updated the bcharge man page with the new arguments
 156 2007/08/16
 157         - cleaned up Usb exception handling, moving libusb error code
 158                 processing into the Usb::Error exception class.
 159                 error.cc is now an empty shell
 160         - added return codes to the Usb::Error exceptions
 161         - removed aboutdialog.{h,cc} from the backup GUI since even
 162                 Debian stable now has up-to-date gtkmm libraries
 163         - added more user friendly error message for the "device busy"
 164                 case, recommending 'rmmod usb_storage'.
 165 2007/08/09
 166         - added better error checking to bcharge.cc
 167         - version bump:
 168                 - configure.ac
 169                 - src/Makefile.am
 170                 - src/version.cc
 171                 - gui/src/BackupWindow.cc
 172                 - src/Doxygen
 173                 - rpm/barry.spec
 174                 - debian/changelog
 175                 - opensync-plugin/src/barry_sync.cc
 176         - removed usb_set_configuration() check from bcharge.cc, since
 177                 that may fail under normal operation, in this case
 178
 179 Release: version 0.8 - 2007/08/03
 180 ------------------------------------------------------------------------------
 181 2007/08/03
 182         - moved Interface implementation to usbwrap.cc file
 183         - added dout debugging messages to usbwrap.cc
 184         - clarified unhandled packet error message in socket.cc
 185         - added temporary workaround in opensync-plugin environment's
 186                 Reconnect(), for odd message seen on newer Blackberry
 187                 devices
 188         - fixing issues with Brian Edginton's MessageRecord patch (2007/06/29)
 189                 - fixed missing size check in message oriented ParseHeader()
 190                 - fixed endian conversion issues (also found one pre-existing
 191                         endian bug in the process)
 192                 - moved message timestamp converter code to time.cc
 193         - added Barry version number to opensync plugin name
 194         - changed maintainer scripts and rpm.spec to use bzip2 instead of gzip
 195         - added opensync-plugin to configure script build
 196         - added -S option to btool, to list supported parsers and builders
 197         - slight change to opensync-plugin/buildgen.sh to cleanup config.h.in~
 198         - opensync-plugin/README update
 199         - added opensync-plugin/patches for others who may be building and
 200                 testing the plugin with OpenSync 0.22
 201         - added debian package build scripts to maintainer/
 202 2007/08/01
 203         - added entry to doc/TroubleShooting.txt
 204 2007/07/28
 205         - added doc/TroubleShooting.txt
 206 2007/07/27
 207         - opensync plugin:
 208                 - fixed bug in vcard.cc that was using the FN field
 209                         for the broken-down name instead of N
 210                 - added dbId and dbName to DatabaseSyncState
 211                 - added Reconnect() functionality to BarryEnvironment class
 212                         and moved connect logic out of barry_sync.cc
 213                 - changed the batch commit functionality in barry_sync.cc
 214                         to single-change-commit.  Why?  Because opensync
 215                         0.22 groups all batch changes into one group
 216                         and calls one batch commit function, even if you
 217                         registered two.  Moving to single change commit
 218                         mode removes a chunk of unneccessary code
 219                         from the plugin as well, and can in theory
 220                         ease memory pressure in the library.
 221                 - added FinishSync() to perform actions needed on successful
 222                         syncing completion
 223                 - disconnect on successful sync completion, and reconnect,
 224                         since the device's dirty flags don't seem to
 225                         be updated until a disconnect occurs.
 226 2007/07/26
 227         - added ReadDataArray() to data.h, using an istream instead of
 228                 requiring a file
 229         - added raw data version of BuildField() to record-internal.h
 230                 This is so that btool doesn't add extra null terminators
 231                 to unknown data, when restoring with option -s
 232         - fixed bugs in r_contact.cc:
 233                 - fixed bug that caused a LastName/FirstName swap
 234                         if FirstName was empty and you wrote a contact
 235                         record into the device.... First/Last Name
 236                         fields are position sensitive, and the code
 237                         was missing the empty FirstName case on writing
 238                 - fixed bug in BuildFields() and Dump() where they
 239                         were not updated to handle the new field
 240                         table added for the postal address changes
 241                         on 2007/07/20, oops
 242         - opensync plugin:
 243                 - changed the plugin config file, so it is possible to
 244                         turn debug output on/off without recompiling
 245                 - moved the standalone Map2Uid() function into
 246                         the DatabaseSyncState class, and changed the
 247                         code to produce "contact-#" and "calendar-#"
 248                         UID strings, instead of just numbers
 249                 - changed default PIN to -1, so that if the user doesn't
 250                         configure properly, it will fail... this is a
 251                         safety measure to avoid syncing with different
 252                         devices and corrupting the cache/idmap...
 253                         this should be fixed someday, to handle this
 254                         automatically
 255                         On second thought... is this right?  Perhaps
 256                         it is better to fail if the PIN is not what
 257                         is expected, so a user doesn't accidentally
 258                         sync the wrong device and lose data.
 259                         Actions to take on new PIN:
 260                                 - force slow_sync, or
 261                                 - fail
 262                 - incorporated the new VCardConverter code into the
 263                         main barry_sync.cc plugin code
 264                 - fixed bug that did not clear the devices dirty flags
 265                         in the case where a sync only read data from it,
 266                         and didn't write
 267                 - changed PIN error message number to hex
 268 2007/07/20
 269         - minor wording change in backup GUI prompt: "Backup working..." to
 270                 "Backup in progress..."
 271         - renamed Contact class's Title field to JobTitle for clarity
 272         - added record function ParseFieldString(), which properly handles
 273                 strings from the device that have multiple null terminators,
 274                 and changed the record parsing code to use this new function
 275         - moved FullName() function from ldif.cc to r_contact.cc since it
 276                 is generally useful in areas outside of LDIF processing
 277         - refactored postal addresses in the Contact record class into
 278                 a new class called PostalAddress
 279         - renamed Address class in record.h to EmailAddress
 280         - moved Contact::GetPostalAddress() to record.cc as part of the
 281                 new PostalAddress class and renamed it
 282                 PostalAddress::GetLabel()
 283         - opensync plugin:
 284                 - refactored vformat helpers into separate base class
 285                         called vBase
 286                 - added vCard converter class
 287                 - commented out the code that skipped over the adding
 288                         of empty attribute values and parameters,
 289                         since VCARD depends on some of this behaviour
 290                 - movified vformat.c:vformat_find_attribute() to take
 291                         an extra nth argument, in order to search
 292                         for multiple attributes with the same name...
 293                         the way this is coded is a bit inefficient...
 294                         but we're moving away from vformat when we move
 295                         to OpenSync 0.3x / 0.40, so this is just temporary
 296                         pain
 297 2007/07/19
 298         - added SUBSYSTEM=="usb_device" to example udev rules, in order
 299                 to avoid running bcharge for each endpoint that is
 300                 added by udev, when first plugged in.  Running bcharge
 301                 back-to-back multiple times can crash some
 302                 Blackberries.
 303 2007/07/14
 304         - opensync plugin:
 305                 - fixed ID mapping bug in the case of a non-numeric UID
 306                         from syncing external -> Barry, and then the
 307                         new Barry ID would look like a new change
 308                         when syncing back from Barry -> external.
 309                 - added support for slow sync
 310                 - added clear() to idmap class
 311                 - added vformat attr parameter extraction class
 312                 - added more trace logging during vformat/Barry conversions
 313                 - added Notification time support
 314                 - handled "all day" vformat special case, when DTEND
 315                         does not exist in a vformat data block
 316         - changed the min1900_t time conversion functions to handle
 317                 the 0xffffffff special case, when notifications
 318                 are turned off on a calendar event (src/time.cc)
 319         - also made the calendar data dump output clearer for
 320                 disabled timestamps, and added debug output
 321                 for the raw min1900 value, in case there are more
 322                 special cases in the future
 323 2007/07/13
 324         - fixed null pointer access in opensync's HasMultipleVEvents()
 325 2007/07/12
 326         - upper management directive: revert all OpenSync 0.3x changes
 327                 and proceed with OpenSync 0.22.  Reverting the
 328                 opensync-plugin/src tree to Barry 0.7 status.
 329 2007/07/06
 330         - reorganized exception and trace code in opensync plugin
 331         - added XmlToCalendar() function, based on unfinished opensync
 332                 library API that is not yet finished... will be
 333                 committed to opensync svn tree when complete
 334         - added OSyncXMLField logger to plugin trace class
 335 2007/06/29
 336         - applied email MessageRecord patch from Brian Edginton (thanks!)
 337         - updated Message::Dump() to output more valid mbox data...
 338                 the goal is to be able to do:
 339                         btool -d "Messages" > email.mbox
 340                         mutt -f email.mbox
 341         - changed some TODO's to FIXME's to keep it grep-consistent
 342         - applied Folder support patch from Brian Edginton
 343         - fixed pedantic compile warnings, and changed order in src/Makefile.am
 344         - removed unneeded cast in src/r_folder.cc
 345 2007/06/28
 346         - minor adjustment to ctags building in buildgen.sh
 347         - applied patch from Brian Edginton for better boost detection
 348                 in configure.ac
 349         - added boost usage message to btool -h output
 350 2007/06/21
 351         - more porting of OpenSync module to 0.30
 352         - added ctags build for opensync source tree to buildgen.sh
 353 2007/06/14
 354         - changed PKG_CONFIG_PATH setting in rpm script, so that systems
 355                 like SuSE that have an extensive PKG_CONFIG_PATH
 356                 in general use will not break on build
 357         - added PKG_CONFIG_PATH to debian script too, just in case :-)
 358         - added debian/changelog to doc/ReleaseChecklist.txt
 359         - added comment to rpm/barry.spec regarding SuSE RPM builds
 360 2007/06/08
 361         - applied patch from Niels de Vos fixing debian package build
 362                 dependency
 363         - applied Brian Edginton's Saved Email Messages patch
 364         - updated r_saved_messages.cc comment to match header
 365         - added GetRecType()/GetUniqueId() to r_saved_messages.h, since
 366                 SetIds() is already there
 367         - removed Address version of operator<<() from message related headers
 368                 and moved into record.h
 369         - added std::hex to message related dumps, and changed output to
 370                 be more mbox-like
 371         - updated doc/CodingStyle.txt to cover switch() statements
 372         - opensync compiles again, with 0.30!  (not functional yet)
 373                 - moving closer to more modular and reusable plugin functions
 374         - updated release checklist for opensync version number
 375 2007/06/07
 376         - added doc/CodingStyle.txt... preliminary version
 377 2007/06/06
 378         - applied Brian Edginton's PIN message patch
 379         - changes to PIN message patch:
 380                 - fixed missing backslash in src/Makefile.am
 381                 - fixed tab alignment throughout
 382                 - removed typedef from Address struct
 383                 - added clear() to Address... might as well, if it it is
 384                         going to be a standalone type
 385                 - fixed missing comma in PINMessageFieldLinks table
 386                 - changed MessageRecordId in PINMessage to load from a new
 387                         uint32_t field in CommonField, instead of piggy
 388                         backing on a field for other use
 389         - did some testing and found that PINMessage's MessageRecordId
 390                 is the same as the RecordId given through the SetIds()
 391                 API... but these Id's are duplicated in the protocol...
 392                 RecordId is stored in the protocol header, while
 393                 MessageRecordId is stored in the record it self as
 394                 a common field... added RecType and RecordId to
 395                 PIN Message so that we store both of these
 396         - updated AUTHORS
 397 2007/05/27
 398         - added item to gui/TODO
 399         - applied Brian Edginton's s11n-boost.h patch
 400 2007/05/25
 401         - renamed template values to more consistent naming scheme
 402         - applied memos and tasks patch from Brian Edginton, slightly
 403                 modified to split into the new separate files system
 404         - changes to memos and tasks classes:
 405                 - reformatted the code to match coding style
 406                         (come on Brian) :-)
 407                 - added copyright notice
 408                 - changed class to singular (Memo, not Memos)
 409                 - placed in Barry namespace
 410                 - added #ifdef header protectors
 411                 - added new files to Makefile.am
 412                 - added new r_*.h headers to record.h
 413         - added support for Memos and Tasks to tools/btool.cc, based on
 414                 Brian Edginton's patch
 415                 (currently commented out, for Boost library reasons):
 416         - added doc/CommitPolicy.txt
 417         - updated AUTHORS
 418 2007/05/24
 419         - added ctags generation to buildgen.sh
 420         - applied record.{h,cc} fix patch from Brian Edginton
 421                 - ClassFlag
 422                 - FreeBusyFlag
 423                 - Clear() fixes
 424         - fixed broken formatting in above patch
 425         - refactored record parser classes into separate files for each
 426         - changed the ConvertHtoB<> template to inline, as it caused
 427                 linker errors with the new file layout
 428 2007/05/17
 429         - fixed bug in Debian packaging that put util commands in
 430                 /bin and /sbin instead of /usr/bin and /usr/sbin
 431         - commited byteswap.h replacement code from gm2net
 432         - backup gui:
 433                 - removed unneeded debug messages on stdout
 434                 - changed the default for debug output to "off"
 435                         and added a command line option to turn
 436                         it on if necessary  (--debug-output)
 437                 - command line option --help now also works
 438         - fixed bug in Calendar class where it didn't initialize
 439                 RecType properly... and cleaned up other RecType
 440                 code to use the GetDefaultRecType() functions,
 441                 localizing the constants in one place
 442 2007/05/11
 443         - applied patches from Brian Edginton, parsing more
 444                 fields in Contact and Calendar records
 445         - added Brian Edginton to AUTHORS
 446         - reformatted record.{h,cc} to match the rest of the code,
 447                 removed commented out code, and removed mention of
 448                 Outlook from the comments.
 449         - updated udev/10-blackberry.rules.Debian for Debian Etch
 450         - updated debian/rules to use new udev rules file
 451         - removed debian/postinst, as stable versions of Debian now
 452                 have a recent udev, and don't need the special handling
 453         - updated Debian build scripts to build separate packages:
 454                 libbarry
 455                 libbarry-dev
 456                 barry-util
 457                 barrybackup-gui
 458         - added menu support to Debian barrybackup-gui package
 459         - made the buttons bigger in the backup GUI, as they were too
 460                 small on Debian Etch
 461         - opensync plugin:
 462                 - more progress in porting to opensync 0.30, heavily
 463                         based on the example plugin in the opensync
 464                         svn tree...  this is a work in progress, and so far
 465                         is incomplete
 466 2007/05/04
 467         - opensync plugin:
 468                 - partial porting to opensync 0.30 (in progress!)
 469                 - fixed bug in sync_done where it reported context error
 470                         and then success afterward
 471         - checking in new INSTALL files based on Etch's autoconf run
 472         - added item to gui's todo list
 473         - bumped version numbers to 0.8 in:
 474                 - configure.ac
 475                 - src/Makefile.am
 476                 - src/version.cc
 477                 - gui/src/BackupWindow.cc (about dialog)
 478                 - src/Doxygen
 479                 - rpm/barry*.spec
 480
 481 Release: version 0.7 - 2007/05/02
 482 ------------------------------------------------------------------------------
 483 2007/05/02
 484         - added rpm building to maintainer/release scripts
 485         - added "HEAD" feature to tarball creation script, for easier testing
 486         - updated maintainer/README
 487         - updated maintainer/release.sh to use new HEAD feature too
 488 2007/05/01
 489         - added pppob to rpm barry.spec
 490         - bumped release number in barry.spec
 491 2007/04/30
 492         - opensync plugin:
 493                 - fixed size check bugs (strlen() == 0 when empty)
 494                 - finished refactoring calendar conversion routines
 495                 - started timezone parsing, but this may go away
 496                         if we use opensync 0.30's time functions and
 497                         xml data format...
 498                 - added development note to README
 499 2007/04/29
 500         - updated README and opensync-plugin/README with more current
 501                 build instructions
 502         - opensync plugin:
 503                 - refactored some calendar conversion routines
 504                 - added Barry->vCalendar conversion for recurring appointments
 505 2007/04/27
 506         - opensync module:
 507                 - removed some unneeded trace logs
 508                 - fixed VEventConverter constructor bug, with uninitialized
 509                         m_Data pointer
 510                 - eased up the requirement that every calendar event
 511                         must have a summary... defaults to "<blank subject>"
 512                         if empty
 513                 - added more VCALENDAR fields to match Barry::Calendar record
 514                 - fixed case sensitive compares in vformat.c
 515 2007/04/26
 516         - opensync module work:
 517                 - added id map class to map string uid's from OpenSync to
 518                         numeric ID's from the Blackberry
 519                 - fixed bug in CommitChange() where it was still using
 520                         a hard coded calendar record state table
 521                 - added lots of logging throughout
 522                 - fixed bug where newly added records didn't use the
 523                         change object's uid, but created a new ID,
 524                         causing another sync on the next run
 525                         i.e. (CommitData_t was missing an argument)
 526                 - fixed bug where uninitialized notification time was
 527                         written to the Blackberry
 528         - more opensync module work:
 529                 - refactored the environment class into another subclass
 530                         called DatabaseSyncState, and moved some stand-
 531                         alone functions from barry_sync.cc into
 532                         the environment classes
 533                 - added a tagged constructor to the trace class
 534                 - fixed idmap::Load() to clear map before loading
 535 2007/04/20
 536         - renamed barry-config to barry-sync, the default configuration
 537                 file for the opensync module... and filled it with
 538                 a sample configuration
 539         - added code to update the calendar cache, and write it to disk
 540                 on success (opensync module)
 541         - added code to clear dirty flags in the device (opensync module)
 542         - allowed comments in the config file
 543         - added vformat.c from libopensync 0.22, since the vformat
 544                 routines are not available from the plugin side
 545 2007/04/19
 546         - updated gui/TODO
 547         - added -d switch to bcharge to switch back from 0001 to 0004 mode,
 548                 changed the auto-detection logic to ignore iProduct and
 549                 only use idProduct, and updated man page
 550         - updated breset to recognize the Pearl in 00004 mode as well
 551         - changed src/probe.cc logic to assume that the second endpoint
 552                 pair is the one needed for database communication, instead
 553                 of doing a reverse search from the end... newer Pearls
 554                 in Dual mode seem to have at least 3 or 4 endpoint pairs,
 555                 and the old search didn't always work
 556         - applied sourceforge patch #1696884 from Peter Silva, updating
 557                 the Debian build for Etch, and including all files in one deb
 558         - added Peter Silva to AUTHORS file
 559         - uncommented the "make distclean" in debian/rules, and removed
 560                 the reliance on /tmp when installing 99-barry-perms.rules
 561         - applied bb_task_format.txt patch from Peter Silva
 562         - fixed each misspelling of "recurrance" to "recurrence"
 563         - tweaked src/probe.cc again for paranoia's sake... start at
 564                 offset 1 if more than 1 endpoint pair, otherwise start
 565                 search at 0
 566         - split up opensync module into multiple source files, and started
 567                 using the opensync vformat routines for parsing and building
 568                 the vevent20 data (experimental)
 569 2007/04/04
 570         - more incremental work on the opensync plugin, adding ADDED
 571                 and MODIFIED functionality... (experimental!)
 572 2007/03/30
 573         - added code to dump extra descriptors during device discovery,
 574                 if found
 575         - bumped opensync version number in configure.ac, and made
 576                 the configure scripts more consistent with the rest
 577                 of the project
 578         - fixed printf-format size bug in opensync module
 579 2007/03/29
 580         - applied patch from Niels de Vos, fixing deb udev rules for Pearl
 581         - updated AUTHORS
 582         - fixed extra space bug in LDIF output (added space when creating
 583                 FullName, even if there was no last name)
 584         - fixed Address Book record parsing in Contact class... the
 585                 Blackberry database uses field id 0x20 for both the
 586                 first and last names, and if only a last name exists,
 587                 the first name will be empty.  Fixed parser to handle
 588                 this special case, without relying on string length.
 589                 Thanks to Troy Engel for reporting above two LDIF bugs.
 590         - added a few more constants to bcharge.cc
 591         - renamed opensync's configure.in to configure.ac
 592 2007/03/17
 593         - fixed bcharge to avoid endless reset loop... oops
 594 2007/03/16
 595         - reorganized bcharge.cc to make it possible to switch between
 596                 Pearl modes 0004 and 0001
 597         - added flag to BadPassword exception class, to signal whether
 598                 the library considers the device "out of retries" or not
 599         - updated socket.cc for new BadPassword exception
 600         - added special case to Controller class destructor to reset the
 601                 device if being destroyed in a half-open state... this is
 602                 a temporary fix until we understand how to handle
 603                 the "already open" message we get when opening the Desktop
 604                 in some cases
 605         - added password prompt dialog to the backup GUI
 606         - fixed possible memory leak in GUI's DeviceInterface::Connect()
 607 2007/03/08
 608         - committed Troy Engel's bbrules_mass_symlinks.patch, fixing
 609                 udev rules for the Pearl
 610         - updated 10-blackberry.rules.Debian to match 10-blackberry.rules's
 611                 functionality
 612         - applied Troy Engel's barry.spec patch to generate all required
 613                 RPM's... Thank you!  Notes in the README taken from
 614                 the sourceforge tracker entry containing the patch.
 615         - added libusb lib flags to tools/ and examples/ makefiles,
 616                 and tweaked configure.ac with a better default,
 617                 to build cleanly on RHEL 4
 618         - modified rpm/barry.spec:
 619                 - does not create doc-only barry base package anymore
 620                 - fixed "barry-backup" typo
 621                 - removed the patch step, as version 0.7 shouldn't need it
 622                 - added license file to each package
 623                 - commented out console perms scripts, pending mailing list
 624                         discussion
 625         - updated AUTHORS
 626         - applied Troy Engel's barry.spec patch to fix RHEL4 compile issues
 627         - fixed 80 column wrapping error in barry.spec, thanks to Troy Engel
 628                 for the bug report
 629         - applied Troy Engel's udev permissions patch for Redhat/Fedora
 630                 systems, which automatically set the ownership of a
 631                 newly plugged in device to the currently logged in console
 632                 user.
 633         - added udev/README to document what all those files are for...
 634                 part of the text comes from the sourceforge comment
 635                 on the above udev permissions patch from Troy Engel
 636         - uncommented the console perms scripts for rpm/barry.spec
 637         - added libglademm-2.4 to gui/README's dependency list
 638         - made usbwrap.* calls more threadsafe
 639         - added Usb::Timeout exception for timeout errors
 640         - added preliminary UsbSerData support to library for GPRS modem
 641                 functionality, using Rick Scott's XmBlackBerry's serdata.c
 642                 as a guide
 643         - added overloaded Socket::Send() for sending without receiving
 644         - added preliminary pppob command line tool
 645 2007/03/02
 646         - version bump in:
 647                 - configure.ac
 648                 - src/Makefile.am
 649                 - src/version.cc
 650                 - gui/src/BackupWindow.cc (about dialog)
 651                 - src/Doxyfile
 652                 - rpm/barry.spec
 653         - build system tweaks for opensync-plugin, and added a buildgen.sh
 654                 for it
 655         - added better debug messages in probe.cc and usbwrap.cc's
 656                 device discovery code
 657         - changed error handling for null interface->altsetting pointers
 658                 when doing device discovery in usbwrap.cc.  Seems that
 659                 some devices report a higher number in bNumInterfaces
 660                 than are really available... in this case, let's
 661                 just ignore the missing data and assume success
 662         - applied udev script patch #1663986 from Troy Engel
 663         - applied barry-bcharge.spec patch #1672178 from Troy Engel
 664         - ReleaseChecklist update
 665         - added rpm/README based on Troy Engel's patch notes
 666         - updated new barry-bcharge.spec for version 0.7, removing patch
 667                 dependency
 668
 669 Release: version 0.6 - 2007/02/28
 670 ------------------------------------------------------------------------------
 671 2007/02/28
 672         - fixed size checks for device database records larger than 64K
 673                 Thanks to Michael Brown for the bug report.
 674         - added initial release maintainer scripts
 675         - fixed odd backup success message in GUI when doing a backup with
 676                 no databases selected in configuration
 677                 Thanks to Michael Brown for the bug report.
 678         - added udev permissions file patch from Michael Brown
 679         - added Michael Brown to AUTHORS
 680         - updated README, gui/README, and doc/USB-capture.txt
 681         - added -o command line switch to bcharge.cc, and updated man page
 682 2007/02/23
 683         - changed library behaviour so it only turns on libusb debug output
 684                 if in data dump mode.  In btool, -v controls this output.
 685         - minor stream formatting fix in btool
 686         - added OpenSSL dependency to build for password hash support
 687         - made debug dout() output conditional on Init() flag... In btool,
 688                 -v now controls this as well
 689         - reverse engineered more of the initial probe packets, and
 690                 implemented probing in struct based code... changes include:
 691                 - added support for "attribute fetch" packets, used at
 692                         the beginning of USB conversations
 693                 - defined object/attribute id codes for the PIN number
 694                 - made Protocol::SocketCommand more robust, and implemented
 695                         its sequence number behaviour
 696                 - moved ModeSelectCommand into SocketCommand, as it is a
 697                         socket 0 level command
 698                 - added initial protocol struct: PasswordChallenge
 699                 - renamed Barry::Packet to DBPacket
 700                 - added ZeroPacket for socket 0 packet creation and analysis
 701                 - Barry::Packet is now the base class for the above
 702                 - implemented socket 0 behaviour in socket.cc
 703                 - changed return values for Send/Receive/Packet/NextRecord
 704                         members in the Socket class from bool to void, as they
 705                         don't generate errors themselves, but only can
 706                         have an error if Usb::Device throws an exception.
 707                         Cleaned up all code that called these members as well.
 708                 - removed "last status" from Socket class as it was unused
 709                 - updated probe.cc to use new socket 0 implementation
 710                 - removed two of the hard coded packet handshakes in favour
 711                         of socket 0 packets
 712                 - updated controller.cc:
 713                         - uses new socket 0 implementation
 714                         - removed "flag" hack when opening sockets and
 715                                 selecting modes, as it should use the
 716                                 socket 0 sequence number
 717         - added initial, incomplete prototype header for the C API
 718         - updated some .cvsignore files
 719         - updated TODO
 720         - updated ReleaseChecklist.txt, adding rpm spec file
 721         - added the following to ZeroPacket:
 722                 - ChallengeSeed()
 723                 - RemainingTries()
 724                 - SocketResponse()
 725                 - SocketSqeuence()
 726         - moved Command() to base Packet class
 727         - added comments to protostructs.h and size constants for the
 728                 new PasswordChallenge struct
 729         - added password support to Socket and Controller classes
 730                 Thanks to Rick Scott's XmBlackBerry for the openssl
 731                 password hashing logic.
 732         - updated btool to use new password support, and updated its man page
 733 2007/02/22
 734         - updated Doxygen input files and version, and added to ReleaseChecklist
 735         - fixed btool PIN output for LDIF mode, now commented in output
 736         - major LDIF overhaul:
 737                 - split LDIF specific code out of the record class and
 738                         into its own
 739                 - fixed "full name" behaviour that added an extra space
 740                         in dn attributes, as reported by Troy Engel
 741                 - added support for mapping of LDIF attributes to Barry
 742                         contact field names
 743                 - fixed base64 handling, so attributes are only so encoded
 744                         if necessary
 745                 - fixed base64 attribute reading inconsistency... some
 746                         notes fields were missed in old version if not
 747                         encoded
 748                 - added support for specifying alternate attribute for
 749                         constructing a FQDN, instead of just "cn"
 750                 - updated btool and upldif to use new features
 751         - large update to btool manpage
 752         - fixed initialization bug in Contact constructor (missed RecType)
 753 2007/02/15
 754         - added ktrans.cc to make reading of kernel usbfs_snoop logs easier
 755         - removed commented code from translate.cc
 756         - added Pearl handshake support to bcharge.cc, which resets the
 757                 Pearl so that the vendor specific 0xFF class exists.
 758                 This should allow use of btool on the Pearl.
 759         - added Data::AppendHexString to data.cc
 760         - added better probing support for the Pearl, so it detects the
 761                 Product ID 0x0004 mode, and does a search for class 0xFF
 762                 instead of hardcoding it.
 763 2007/02/10
 764         - applied README patch from Ian Darwin
 765         - minor tweaks to README
 766         - added missing errno.h header in src/usbwrap.cc for AMD64
 767                 Thanks to Jonathan Hudson for reporting the bug.
 768         - tightened up size checks in Data::ReleaseBuffer()
 769         - stable libusb *does* return the actual length of the USB packet...
 770                 fixed this in usbwrap.cc to set the actual size of read data,
 771                 and removed the size hacks elsewhere in the code:
 772                 probe.cc, protocol.cc, socket.cc, usbwrap.cc
 773 2007/02/09
 774         - added proper return codes for error conditions in btool.cc
 775         - clarified some stream output code in the library, for hex/dec numbers
 776         - removed old, non-working connect.cc test program
 777         - added iomanip to debug.h
 778         - changed usbwrap to call libusb again if EINTR and EAGAIN
 779                 This should fix one of the OpenBSD issues
 780 2007/02/04
 781         - updated AUTHORS
 782         - fixed bug in barrybackup GUI that didn't create the target path
 783                 if the user didn't do Edit | Config first.
 784                 Thanks to Ian Darwin for reporting the bug.
 785         - applied gui/src/ConfigFile.cc header fix patch for OpenBSD
 786                 from Ian Darwin
 787 2007/02/03
 788         - added initial btool.1 man page from Ian Darwin
 789         - updated man/Makefile.am for new btool.1
 790         - updated AUTHORS
 791         - applied btool -h help clarification patch from Ian Darwin
 792 2007/02/02
 793         - reworked exception hierarchy, so applications can handle all
 794                 Barry related exceptions, including Usb errors, with
 795                 one base class: Barry::Error
 796         - fixed all the ripple changes this caused throughout the codebase
 797         - added BadPassword exception
 798 2007/02/01
 799         - version bump in:
 800                 - configure.ac
 801                 - src/Makefile.am
 802                 - src/version.cc
 803                 - gui/src/BackupWindow.cc (about dialog)
 804         - updated doc/ReleaseChecklist.txt
 805         - added usb-level breset.cc command line tool
 806         - fixed bug in gui/src/tarfile.* for systems where
 807                 sizeof(int) != sizeof(void*)
 808                 - TarFile class now uses a plugin style for the compression
 809                         operations, to allow for threadsafe versions if needed
 810                         in the future.
 811                 - also fixed leaked file handle bug in open_compressed()
 812                 - Thanks to Jonathan Hudson for reporting this for 64bit systems
 813         - minor signed comparison fixes in the library
 814         - added better protocol data dumping code in probe.cc
 815         - added Usb::Device::BulkDrain(), to prevent Barry from hanging
 816                 due to pending reads
 817
 818 Release: version 0.5 - 2007/01/26
 819 ------------------------------------------------------------------------------
 820 2007/01/26
 821         - added missing errno.h header to gui/src/util.cc
 822         - lots more endian fixes after testing on iMac
 823         - iostream output size fixes
 824         - added option to btool to reset the device via software
 825         - beefed up exception handling in barrybackup
 826         - checked in opensync work-in-progress: trace logging, pointer bugfix
 827                 this is still experimental
 828         - added aboutdialog.* files from gtkmm24 2.10.6, so we have a dialog
 829                 class for systems running older versions of gtkmm, like
 830                 Debian stable
 831         - uncommented the about box menu handler
 832         - added "cleanall" option to root buildgen.sh script
 833         - update ReleaseChecklist.txt
 834         - removed CVS auto-history strings from aboutdialog.*
 835 2007/01/25
 836         - found a link between the unknown field in tagged protocol headers
 837                 and the unknown field in RecordStateTable entries.  This
 838                 field matters when uploading certain databases, such as
 839                 Browser Options.  It is unknown what this field really
 840                 means, but we're calling it RecType.  Updated the API
 841                 to use this in all parser objects and builder objects
 842                 and record objects that use it.
 843         - changed some uses of uint64_t to uint32_t, in Contact and
 844                 Calendar record objects... unique IDs only seem to be
 845                 32 bits
 846         - added new static function to record classes: GetDefaultRecType()
 847                 This returns the default rectype that should work
 848                 for that record.  Ideally this should be retrieved from
 849                 the device, but in the case where a database has no
 850                 records, this info would be good to know.
 851         - updated convenience template function Controller::AddRecordByType()
 852                 to use GetDefaultRecType()
 853         - documented the recurrence data and how to use it in Calendar objects
 854         - added data debug output for incoming USB packets in the
 855                 socket class... when we ported to the stable libusb
 856                 we lost some of the verbose output... this should get it
 857                 back.  (In the official release, you need to uncomment
 858                 ddout() in debug.h for the full blast of debug output).
 859         - backup GUI updates:
 860                 - changed error_done signal into a pure error signal,
 861                         and changed the logic so the restore continues
 862                         even if there was a protocol error on one database
 863                 - changed status bar messages to show what's happening
 864                         i.e. Backup or Restore
 865                 - default to not restore the "Handheld Agent" database as
 866                         it appears to be read-only on the device
 867                 - added temporary Restore & Backup mode for debugging
 868                 - added extra hyphen to backup files to show date/time better
 869                 - updated GUI to save and restore the new RecType field
 870                         supported now by the library
 871 2007/01/21
 872         - added future considerations to doc/ReleaseChecklist.txt
 873         - applied big endian patch from Jonathan Hudson
 874         - changes to patch:
 875                 - removed endian.h include from barry.h, since applications
 876                         using the library should not care about endianness
 877                 - hard coded the path to config.h in endian.h
 878                         so that endian.h never makes it into the final
 879                         install
 880                 - removed DEFAULT_INCLUDES setting from src/Makefile.am
 881                         for the same reason
 882                 - removed config.h dependency in btool.cc and used library
 883                         Version call instead
 884         - added big/little endian text to the Barry::Version call
 885         - updated AUTHORS
 886         - fixed install location of bcharge when building with ./configure;
 887                 now goes to sbin/ for both source compile and binary packages
 888                 Thanks to Jonathan Hudson for reporting this bug.
 889 2007/01/20
 890         - added smarter timeout values to controller, and allowed
 891                 timeout overrides in the packet, socket, and usbwrap code...
 892                 extra timeouts are needed for erasing databases for
 893                 some older devices
 894         - added an explicit DataDumpParser class to btool.cc, as the
 895                 library doesn't always have extreme verbose debugging on...
 896                 this makes sure anyone can always get raw database packets
 897                 through btool, for development
 898         - added thread callback signals for error finishes and erase_db
 899                 operations, so the GUI is updated properly
 900         - more GUI cleanups (status bar updates, etc)
 901         - finished implementation of GUI restore
 902         - fixed gtkmm/glibmm exception handling when the exceptions
 903                 occur in sigc signal handlers... in that case,
 904                 exceptions need to be handled with
 905                 Glib::add_exception_handler()
 906         - added filename-only reading support to TarFile class
 907         - added pending gui/TODO items
 908 2007/01/19
 909         - backup GUI now properly shows progress
 910         - the buttons become insensitive when backup is busy
 911         - refactored directory check code, and added mkdir check
 912                 when to the backup setup (so the directory exists
 913                 when we try to write to it)
 914         - updated code to use Barry::Data in new namespace
 915 2007/01/18
 916         - moved Data class into Barry namespace
 917 2007/01/13
 918         - updated copyright dates for the new year
 919         - clarified exception message in controller.cc
 920         - fixed pointer initialization bug in controller.cc
 921         - added documentation comments to parser.h and builder.h
 922         - updated ReleaseChecklist.txt
 923         - updated README
 924         - changed Barry library configure scripts to make better
 925                 use of pkg-config for autodetecting dependencies
 926         - added initial Barry Backup GUI (gui/ directory), capable of making
 927                 backups only at this point
 928 2007/01/11
 929         - added doc/ReleaseChecklist.txt
 930         - added version API, returning version number and string
 931         - added Troy Engel to AUTHORS
 932         - added special case to bcharge.cc for the Blackberry Pearl,
 933                 which doesn't reset itself after the charge handshake
 934                 Thanks to Troy Engel for testing.
 935 2007/01/05
 936         - added pkg-config support for the library (libbarry-0.pc.in)
 937         - fixed compile error on g++ 3.3 systems (missing stdint.h
 938                 in probe.h)
 939         - fixed protocol hang at end of Controller operation... in
 940                 controller destructor, it was deleting the USB interface
 941                 before closing the socket at the BlackBerry level, thereby
 942                 leaving the device in Desktop mode
 943 2007/01/04
 944         - support the newer udev packages on Ubuntu, which need slightly
 945                 different rules
 946         - modified bcharge.cc to search for Pearl devices too.
 947                 USB product ID 6
 948         - added Pearl product ID to probe code, but likely not functional
 949                 yet until we find someone able to get a USB capture for us
 950 2006/12/29
 951         - version bump in configure.ac and src/Makefile.am
 952
 953 Release: version 0.4 - 2006/12/29
 954 ------------------------------------------------------------------------------
 955 2006/12/29
 956         - added bcharge.cc to the tools/ directory (whoohoo!)
 957         - added initial release version of rpm/barry.spec (aka bcharge.spec)
 958                 This begins the barry binary release, currently only
 959                 including the bcharge utility, but possibly more in
 960                 the future.  Future binary packages will likely include
 961                 libbarry, libbarry-devel, etc, which barry will then
 962                 depend on.
 963         - added udev rule script for BlackBerry devices
 964         - added man/ directory and bcharge.1 manpage
 965         - added debian/ directory for building deb packages, with initial
 966                 package scripts
 967         - added rpm/make-rpm-tarball.sh for building RPMs
 968         - split out technical docs into separate libbarry.docs file for
 969                 a future Debian install
 970         - added more cleaning to buildgen.sh
 971         - added new udev rule file for Debian stable
 972         - hardcoded g++ to 3.3 in debian/rules as I have multiple versions
 973                 on my system and need to compile releases with stable
 974 2006/12/21
 975         - ported Barry to use the stable branch of libusb
 976                 NOTE: no longer depends on the devel libusb tarball!
 977                         Just use your distro's libusb packages.
 978         - fixed more endian issues
 979         - minor update to TODO
 980 2006/12/15
 981         - moved Exceptions, Hacking, and VersionNotes to doc/
 982         - added doc/USB-capture.txt
 983 2006/12/08
 984         - added Controller::AddRecord() and template helper
 985         - added beginning version of generic RecordFetch<> template
 986         - set default of Barry::Init() to false (no data dump mode)
 987         - added examples/ directory, with first addcontact.cc example
 988 2006/12/07
 989         - added autoconf support based on Peter McAlpine's patch
 990         - renamed Makefiles to Makefile.orig and added script to turn
 991                 on old build system if wanted
 992         - fixed boost-specific error path in btool
 993         - moved platform specific code out of time.h and into time.cc
 994         - moved btool.cc, translate.cc, and upldif.cc out of src/ and
 995                 into their own tools/ subdirectory
 996         - added NEWS file to make autotools happy
 997         - added a "clean" option to the buildgen.sh script... maintainer's
 998                 use only
 999         - reworked autoconf and automake files, to support
1000                 barry as a library, to move the programs into their
1001                 own tools directory, and support a proper installation
1002         - fixed headers in parser.h, btool.cc, and upldif.cc to work
1003                 properly when installed standalone
1004         - added tools/Makefile.plain for testing compiling against
1005                 installed barry library
1006         - added commentary on version number system
1007         - removed Makefile.conf and Makefile.orig, as new autoconf
1008                 system supercedes it
1009         - added support for boost serialization library in autoconf build
1010         - added library version number to autoconf build
1011         - changed boost flag to __BARRY_BOOST_MODE__ to avoid collisions
1012         - removed debug.h dependency from btool.cc
1013         - removed libusb check in favour of specific --with-libusb
1014                 option... may need to revisit this later
1015         - quick installation update in README
1016 2006/12/01
1017         - fixed some missed endian conversions in record.cc and added
1018                 some size checks
1019         - fixed endian issues in time.h
1020         - added 2 more functions to the time zone API, and adjusted
1021                 the time zone table for better defaults in North America
1022         - added btool and upldif to the make install sequence
1023         - added support for Calendar recurrence data
1024         - small doc/TimeZones.txt update
1025 2006/11/24
1026         - added BlackBerry time zone code list, reverse engineered from a 7750
1027         - added GetTimeZone() to convert device time zone codes to useful data
1028
1029 Release: version 0.0.3 - 2006/11/24
1030 ------------------------------------------------------------------------------
1031 2006/11/23
1032         - added return code check to Controller::SaveDatabase()
1033         - fixed Data() class constructor, so it doesn't auto-convert
1034                 from any int
1035         - fixed size checking bug in Packet::ReturnCode() that caused
1036                 uploading to device to fail
1037 2006/11/10
1038         - added Exceptions doc file, documenting the C++ exceptions used,
1039                 and their hierarchy
1040         - fixed small bug in 'make install' which didn't build first
1041         - minor documentation and cleanup in upldif.cc
1042         - added utility functions to the RecordStateTable class,
1043                 GetIndex() and MakeNewRecordId()
1044         - changed btool so that the -d command modifiers can be
1045                 specified multiple times to work with multiple records
1046                 at once
1047         - added Calendar sync code to the opensync module (not complete)
1048         - cleaned up exception handling in the opensync module, making
1049                 more use of the base exception to make sure no
1050                 exceptions leak into the C library code
1051
1052 Release: version 0.0.2 - 2006/10/12
1053 ------------------------------------------------------------------------------
1054 2006/10/12
1055         - fixed casting error in opensync module
1056         - minor updates to documentation to prepare for release
1057 2006/09/29
1058         - added stdint.h to parser.h for uint32_t.  Thanks Ron Gage for
1059                 the bug report
1060 2006/09/08
1061         - large refactoring of the packet parsing and building code,
1062                 splitting the code into 3 groups:
1063                 - record: handles record specific parsing and building...
1064                         this is mostly subfields with CommonField structs
1065                         as their headers, but sometimes has a specific
1066                         header of its own, in the case of email
1067                         Note: email's header is as yet undecoded.
1068                         Record does not know the details of the packet
1069                         formats, only the formats of its own record data.
1070                 - packet: handles building of complete command packets
1071                         and handles parsing of commonly used header values,
1072                         providing an API for it... packet does not know
1073                         the record format details, but does know the
1074                         details of each Database Operation (protocol.h)
1075                         packet format.
1076                         So far, it seems that there is a real separation
1077                         of operation formats and record formats, with the
1078                         record formats being the same even with different
1079                         database operation codes (GET_RECORDS /
1080                         OLD_GET_RECORDS), which was not confirmed before.
1081                         See the header size of the email record after
1082                         refactoring.
1083                 - controller: handles device state, and the management of
1084                         sockets, commands, and checking for response values.
1085                         The Controller object does not know the format
1086                         of either the record or the packet it is sending,
1087                         but does know the protocol handshake logic used
1088                         to talk to the device.
1089         - implemented SetRecord (SET_RECORD_BY_INDEX)... syncing, here
1090                 we come!
1091         - spelling correction in opensync-plugin/AUTHORS
1092 2006/09/01
1093         - added sample hotplug scripts
1094         - added .cvsignore files for doxygen and opensync directories
1095         - added src/endian.h... still need to add configure support to
1096                 handle non-little-endian machines
1097         - added exception handler in opensync plugin commit_change()
1098         - removed the device reset code in probe.cc, as resetting a device
1099                 can renumber the devices in /proc on kernel 2.4.x,
1100                 and cause a failure to reach the device...
1101                 FIXME - this should be changed someday to reset if probing
1102                 fails, and restart the probe on reset, as sometimes
1103                 the blackberry devices respond differently when not reset
1104                 Ideally, the probe protocol should be properly reverse
1105                 engineered.
1106         - added support for retrieving record state table, which is needed
1107                 for smarter syncing
1108         - added support for retrieving, deleting, and clearing the dirty
1109                 flags of individual blackberry device records
1110         - added endian macros throughout the code
1111 2006/07/13
1112         - added opensync-plugin to root Makefile's clean
1113         - updated time conversion calls to match opensync's latest SVN
1114         - added opensync_change_set_changetype() (only add for now,
1115                 for development)
1116         - removed slow sync functions for now
1117 2006/07/07
1118         - added quick "install" makefile target, to src/install by default
1119         - added static library target... this is temporary until autoconf
1120                 stuff is added properly... needed for the opensync plugin
1121         - documented in comments that Barry::BError is intended to be
1122                 the base classes for all exceptions
1123         - added first round of implementation of an opensync plugin, based
1124                 on the example plugin code from the opensync sources
1125 2006/06/22
1126         - added to Contact record class:
1127                 - Clear()
1128                 - ReadLdif() to load and parse LDAP data
1129         - added fragmented send support to Socket class
1130         - added Probe::FindActive() to make client programs more streamlined
1131         - fixed hex/decimal printing of record counts in btool
1132         - added upldif.cc, a utility to take ldapsearch output on stdin
1133                 and upload it to a blackberry
1134         - updated src/.cvsignore
1135 2006/06/16
1136         - added parsing of service book fields:
1137                 - old and new name
1138                 - old and new unique ID (UID)
1139                 - content ID (CID)
1140                 - old and new description
1141                 - DSID
1142                 - bes domain / domain
1143         - date change in legal.txt
1144         - added initial parsing of ServiceBook field 0x09, and calling it
1145                 ServiceBookConfig for now, for lack of a better name
1146         - added parsing for ServiceBook field 0x02 on 72xx Blackberries...
1147                 seems to be a name or description, but doesn't appear
1148                 in the device's own GUI... called "Hidden Name" for now
1149 2006/06/09
1150         - added ServiceBook record class and parser code, based on some
1151                 of Ron Gage's reverse engineering... code is by Chris Frey
1152         - added AUTHORS file
1153         - fixed the libusb set_configuration/claim_interface order
1154                 bug in controller.{h,cc}... already fixed in probe,
1155                 but not controller.  Thanks Ron Gage for finding this.
1156 2006/05/25
1157         - renamed Changelog to ChangeLog in preparation for autoconf
1158         - renamed Todo to TODO in preparation for autoconf
1159 2006/05/18
1160         - make clean cleans up tests properly now
1161 2006/03/31
1162         - turned source code browsing on in Doxyfile
1163         - added LoadDatabaseByName() and LoadDatabaseByType() template members
1164                 to the Controller class
1165                 - new file: controllertmpl.h
1166         - documentation fixes in builder.h
1167         - added static GetDBName() functions to all record classes, in
1168                 support of the template Controller functions
1169         - fleshed out DatabaseDatabase::GetDBNumber() and GetDBName(),
1170                 returning errors properly
1171         - documented sample btool.cc code better, and added example
1172                 of Controller template member usage
1173 2006/03/29
1174         - copyright dates updated for 2006
1175 2006/01/05
1176         - backed out update to latest libusb DEVEL tree, since it is buggy.
1177                 Stick with libusb 2005/11/26
1178 2005/12/30
1179         - added clean target to convenience Makefile
1180         - added Boost to list of dependencies in README
1181         - fixed minor compile warnings in base64.cc
1182         - fixed new USB discovery code, and changed endpoint usage to use
1183                 it, instead of the READ_ENDPOINT and WRITE_ENDPOINT
1184                 constants... constants are now removed
1185                 common.h, controller.cc, probe.cc, probe.h, usbwrap.cc
1186         - added ClearHalt() to Usb::Device (usbwrap.cc)
1187         - updated usbwrap.h to match latest libusb CVS devel tree
1188         - updated README to refer to 2005/12/30 libusb CVS devel tree
1189         - added roadmap to Todo list
1190 2005/12/29
1191         - added convenience Makefile in root directory
1192         - added Hacking document
1193         - minor touchups to README
1194         - added caution warning to README, since this release will support
1195                 delete / overwrite / upload functionality
1196         - minor compile order change in Makefile (speed reasons)
1197         - added dynamic endpoint discovery to probe.cc
1198         - changed claim_interface/set_configuration() function call order in
1199                 probe.cc based on feedback on the libusb mailing list
1200         - added USB discovery code to usbwrap.{h,cc}
1201 2005/12/23
1202         - fixed packing bug in new upload header struct
1203         - renamed CommonField union from data to u to be consistent
1204         - added return_code field to DBAccess struct, for error checking
1205         - added response checking during upload: if response is non-zero
1206                 throw exception in controller.cc
1207         - added sorting operators to record parser classes... when writing
1208                 contact data to the device, it may be important to write
1209                 group link items last, since they reference other contacts...
1210                 This needs to be tested, and if not required, removed.
1211         - added GROUP_FLAG field code to Contact parser class
1212         - fixed offset bug in Contact and Calendar Build() functions
1213         - fixed name bug in Contact::Build(), now output only with data
1214         - added appointment type flag support to Calendar record parser
1215                 class, and "all day event" flag support
1216 2005/12/22
1217         - added autoconf to Todo list
1218         - refactored the protocol structures so that record structs can
1219                 be reused for upload and download
1220         - with new protostructs, more header control is handled by
1221                 controller.cc instead of record.cc parsers and builders
1222         - parser code now accepts an offset, to govern start of record data
1223         - changed Data sizes from int to size_t and removed casts
1224         - removed unneeded Parser::GetHeaderSize() (new protostructs make
1225                 this obsolete)
1226         - added Calendar::Build() for calendar uploads
1227 2005/12/10
1228         - added s11n-boost.h serialization templates for boost::serialization
1229         - added boost::serialization to build
1230         - minor change in usbwrap.cc to display error codes in decimal
1231         - added SizePacket special case code to Socket::Send()... this is
1232                 required when uploaded packet size is a multiple of 0x40,
1233                 a special 3 byte size packet is sent
1234         - moved some record class variables to public: so they can be
1235                 properly serialized
1236         - fixed variable name but in RecordBuilder template
1237         - added -f switch to btool, for saving and loading of record data
1238         - added -s switch to btool, for uploading saved data back to handheld
1239         - added Controller::SaveDatabase()
1240 2005/12/08
1241         - fixed potential casting / pointer bug in controller.cc
1242         - added builder.h, to support uploading
1243         - minor comment fixes in parser.h
1244         - added preliminary Contact protocol record building support
1245         - fixed field order bug in ContactRecord protocol struct
1246         - Contact record.h class now saves unknown Group Link field,
1247                 for later saving
1248 2005/12/07
1249         - added -fno-strict-aliasing to compiler flags so gcc-4.0.x won't
1250                 optimize away protocol struct casts
1251                 see:
1252                 http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25235
1253                 http://mail-index.netbsd.org/tech-kern/2003/08/11/0001.html
1254                 http://groups.google.ca/group/comp.lang.c++.moderated/ \
1255                         browse_thread/thread/e7bf096832526f8e/5714701b \
1256                         02a2a3cc?hl=en#5714701b02a2a3cc
1257         - changed headers so that any low level protocol-specific sizes and
1258                 structs are completely hidden in the library...
1259                 this adds library-only header: protostructs.h
1260
1261 Release: version 0.0.1 - 2005/11/25
1262 ------------------------------------------------------------------------------
1263 2005/11/25
1264         - added barry.h for documentation purposes and application usage
1265         - updated README for release
1266         - renamed SBError exception class to BError
1267         - updated Doxyfile to version 1.4.5
1268         - added more doxygen comments
1269 2005/11/24
1270         - added conversion routines (and tests) between time_t and min1900_t
1271         - added -v option to btool to dynamically control protocol dumping
1272         - removed duplicated database database table display in controller.cc
1273         - minor spelling corrections
1274         - added copyright to usbwrap.{h,cc} as per earlier meeting
1275         - added support for Old protocol Calendar entries
1276 2005/11/20
1277         - added legal.txt, to save typing when adding new source files
1278         - ignore test-base64 file (cvsignore)
1279         - added contact-to-ldif generation, and updated supporting code
1280         - added argument to btool to support contact-to-ldif operation
1281         - added Contact::GetPostalAddress()
1282         - added README documentation in preparation for future release
1283 2005/11/19
1284         - added parser.{h,cc} virtual wrapper to generalize LoadDatabase()
1285         - added code to socket.cc's Packet() command to re-receive on
1286                 reception of empty packets... this seems to be a signal
1287                 from the device that it needs more time for long transfers
1288                 Current limit: 10 blank packets before exception is thrown
1289                 Observed maximum blank count: 1
1290         - added MessageRecord and OldMessageRecord to protocol.h
1291         - changed common record field structs to one CommonField struct
1292         - increased default USB timeout to 10 seconds (some loaded devices
1293                 seem to need more time...)
1294         - reorganized record.{h,cc} to try to reduce the code duplication
1295         - record.h classes now "know" the sizes of their corresponding
1296                 protocol structs... this may cause trouble down the line
1297                 with Python, if used(?)
1298         - added Message class for Email records
1299         - removed the "Get*" database functions and replaced with
1300                 general LoadDatabase() call, which loads any database
1301                 available, and parses it with a Parser object
1302         - added GetDBID() for searching for database numbers via name
1303         - added test code to retrieve and display all email
1304         - cleaned up comments
1305         - renamed blackberry.{h,cc} to controller.{h,cc}
1306         - renamed bbtool.cc to btool.cc
1307         - added Makefile.conf
1308         - added copyright notices to source files
1309         - added COPYING file with GPL
1310         - put parser in Barry namespace, and added auto_ptr-like mode for
1311                 store object pointers
1312         - added doxygen docs
1313         - added header comments to convo.awk script
1314         - removed Test() function in Controller object, and made class
1315                 better suited to its general API purpose
1316         - changed OpenMode() so it loads command table and DBDB... it is now
1317                 a public API function
1318         - moved Controller test code to btool.cc and made tool more
1319                 generically useful... can now download any DB by name on
1320                 the command line
1321         - added mode checks to Controller
1322         - added -t and -d command line options to btool
1323         - added base64 routines from John Walker / Fourmilab and Citadel/UX
1324         - converted base64 routines into an API, instead of hardcoded
1325                 file based
1326 2005/11/18
1327         - changed project name to Barry, including namespaces
1328         - renamed sbcommon.* to common.*
1329         - increased USB default timeout to 2 seconds
1330         - fixed formatting bug in Data operator<< output
1331         - cleaned up the protocol packet structs, getting rid of the
1332                 confusing param/simple split... param is now the tableCmd
1333                 from the Command Table
1334         - moved protocol structs from record.h to protocol.h
1335         - added support for older version of the USB protocol, which matches
1336                 the Cassis spec more closely
1337         - fixed the hardcoded offsets in blackberry.cc's protocol parsing
1338         - fixed Socket::Close() so on error, socket flags are reset.
1339                 This stops Close() from being called twice on exception
1340                 destructors
1341 2005/11/17
1342         - added Doxyfile to the project
1343         - tuned Makefile
1344         - added mode selection support to Blackberry class (RIM Desktop,
1345                 RIM Bypass, and RIM_JavaLoader)
1346                 Mode selection governs which socket is used in subsequent
1347                 data transfers.
1348         - added Command Table parsing and protocol support
1349                 Blackberry class, and CommandTable record class
1350         - added Database database parsing and protocol support
1351                 Blackberry class and DatabaseDatabase record class
1352         - added Address book retrieval support - dumps data to stdout for now
1353         - fixed bug in CopyOnWrite mode in Data class, where could allocate
1354                 less buffer than data copied
1355         - added "easy exception" debug output macro
1356         - fixed minor spelling error in protocol.cc
1357         - fixed ModeSelectCommand protocol structure - it is not a parameter
1358                 command, but uses the unknown slots for socket and flag
1359                 data
1360         - removed hardcoded socket numbers from protocol.h
1361         - fixed bug in socket.cc:Open() where packet size was not properly
1362                 saved
1363         - implemented socket::Close()
1364         - fixed sequence number checks, so it is reset properly on socket 0
1365         - added Socket::NextRecord() for multiple record data transfers
1366         - fixed input handling bug in translate.cc
1367 2005/11/11
1368         - added .cvsignore files to project
1369         - added README notes to document the source architecture
1370         - added dbsetup data script, which shows how to get into database
1371                 mode, using the RIM Desktop mode, and open a socket
1372         - added blackberry.{h,cc} class
1373         - added command line parameters to bbtool.cc
1374                 -l = list only
1375                 -p = specify pin of blackberry device
1376         - added blackberry test code in bbtool.cc - debugging the initial
1377                 opening protocol: sockets, modes, etc... see dbsetup for
1378                 results
1379         - added copy-on-write functionality to Data class, so it can be used
1380                 with plain data buffers with little performance impact
1381         - added eout() and ddout() debugging - to separate:
1382                 - regular debug output
1383                 - exception debug output (should probably be logged to
1384                         syslog someday, and never turned off)
1385                 - raw data dump output
1386         - changed errno SBError exception handler to try to decode the error
1387                 numbers into english (limited success)
1388         - fixed probe and socket USB Bulk message handling, so they don't
1389                 use PollCompletions(), but use IO::Wait() (libusb_io_wait())
1390         - added common packet size checker in protocol.cc
1391         - fixed unpacked protocol packet structs... using gcc's
1392                 __attribute__ ((packed)) ... see protocol.h
1393         - added ModeSelectCommand structure (protocol.h)
1394         - finished Socket::Open() call  (Close() not yet implemented)
1395         - moved Socket::Send/Receive() out of private, as they can be used
1396                 for socket 0 operations.
1397         - cleaned up pointer management with macros:
1398                 MAKE_PACKET()
1399                 COMMAND()
1400                 IS_COMMAND()
1401         - added IO::Wait() and IO::Cancel() to correspond with libusb API
1402         - added datadumping in usbwrap for easy protocol capture
1403         - added preliminary record.{h,cc} classes
1404         - added Contact record parsing, and test code
1405 2005/10/20
1406         - syncberry tree started
1407