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