ChangeLog

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