- updated debian/rules to use new udev rules file
[barry.git] / ChangeLog
blob16ee7c6fd0e161f906039b936f7d530b1592402e
1 Release: version 0.8 - 2007/05/??
2 ------------------------------------------------------------------------------
3 2007/05/11
4         - applied patches from Brian Edginton, parsing more
5                 fields in Contact and Calendar records
6         - added Brian Edginton to AUTHORS
7         - reformatted record.{h,cc} to match the rest of the code,
8                 removed commented out code, and removed mention of
9                 Outlook from the comments.
10         - updated udev/10-blackberry.rules.Debian for Debian Etch
11         - updated debian/rules to use new udev rules file
12         - removed debian/postinst, as stable versions of Debian now
13                 have a recent udev, and don't need the special handling
14         - updated Debian build scripts to build separate packages:
15                 libbarry
16                 libbarry-dev
17                 barry-util
18                 barrybackup-gui
19         - added menu support to Debian barrybackup-gui package
20 2007/05/04
21         - opensync plugin:
22                 - partial porting to opensync 0.30 (in progress!)
23                 - fixed bug in sync_done where it reported context error
24                         and then success afterward
25         - checking in new INSTALL files based on Etch's autoconf run
26         - added item to gui's todo list
27         - bumped version numbers to 0.8 in:
28                 - configure.ac
29                 - src/Makefile.am
30                 - src/version.cc
31                 - gui/src/BackupWindow.cc (about dialog)
32                 - src/Doxygen
33                 - rpm/barry*.spec
35 Release: version 0.7 - 2007/05/02
36 ------------------------------------------------------------------------------
37 2007/05/02
38         - added rpm building to maintainer/release scripts
39         - added "HEAD" feature to tarball creation script, for easier testing
40         - updated maintainer/README
41         - updated maintainer/release.sh to use new HEAD feature too
42 2007/05/01
43         - added pppob to rpm barry.spec
44         - bumped release number in barry.spec
45 2007/04/30
46         - opensync plugin:
47                 - fixed size check bugs (strlen() == 0 when empty)
48                 - finished refactoring calendar conversion routines
49                 - started timezone parsing, but this may go away
50                         if we use opensync 0.30's time functions and
51                         xml data format...
52                 - added development note to README
53 2007/04/29
54         - updated README and opensync-plugin/README with more current
55                 build instructions
56         - opensync plugin:
57                 - refactored some calendar conversion routines
58                 - added Barry->vCalendar conversion for recurring appointments
59 2007/04/27
60         - opensync module:
61                 - removed some unneeded trace logs
62                 - fixed VEventConverter constructor bug, with uninitialized
63                         m_Data pointer
64                 - eased up the requirement that every calendar event
65                         must have a summary... defaults to "<blank subject>"
66                         if empty
67                 - added more VCALENDAR fields to match Barry::Calendar record
68                 - fixed case sensitive compares in vformat.c
69 2007/04/26
70         - opensync module work:
71                 - added id map class to map string uid's from OpenSync to
72                         numeric ID's from the Blackberry
73                 - fixed bug in CommitChange() where it was still using
74                         a hard coded calendar record state table
75                 - added lots of logging throughout
76                 - fixed bug where newly added records didn't use the
77                         change object's uid, but created a new ID,
78                         causing another sync on the next run
79                         i.e. (CommitData_t was missing an argument)
80                 - fixed bug where uninitialized notification time was
81                         written to the Blackberry
82         - more opensync module work:
83                 - refactored the environment class into another subclass
84                         called DatabaseSyncState, and moved some stand-
85                         alone functions from barry_sync.cc into
86                         the environment classes
87                 - added a tagged constructor to the trace class
88                 - fixed idmap::Load() to clear map before loading
89 2007/04/20
90         - renamed barry-config to barry-sync, the default configuration
91                 file for the opensync module... and filled it with
92                 a sample configuration
93         - added code to update the calendar cache, and write it to disk
94                 on success (opensync module)
95         - added code to clear dirty flags in the device (opensync module)
96         - allowed comments in the config file
97         - added vformat.c from libopensync 0.22, since the vformat
98                 routines are not available from the plugin side
99 2007/04/19
100         - updated gui/TODO
101         - added -d switch to bcharge to switch back from 0001 to 0004 mode,
102                 changed the auto-detection logic to ignore iProduct and
103                 only use idProduct, and updated man page
104         - updated breset to recognize the Pearl in 00004 mode as well
105         - changed src/probe.cc logic to assume that the second endpoint
106                 pair is the one needed for database communication, instead
107                 of doing a reverse search from the end... newer Pearls
108                 in Dual mode seem to have at least 3 or 4 endpoint pairs,
109                 and the old search didn't always work
110         - applied sourceforge patch #1696884 from Peter Silva, updating
111                 the Debian build for Etch, and including all files in one deb
112         - added Peter Silva to AUTHORS file
113         - uncommented the "make distclean" in debian/rules, and removed
114                 the reliance on /tmp when installing 99-barry-perms.rules
115         - applied bb_task_format.txt patch from Peter Silva
116         - fixed each misspelling of "recurrance" to "recurrence"
117         - tweaked src/probe.cc again for paranoia's sake... start at
118                 offset 1 if more than 1 endpoint pair, otherwise start
119                 search at 0
120         - split up opensync module into multiple source files, and started
121                 using the opensync vformat routines for parsing and building
122                 the vevent20 data (experimental)
123 2007/04/04
124         - more incremental work on the opensync plugin, adding ADDED
125                 and MODIFIED functionality... (experimental!)
126 2007/03/30
127         - added code to dump extra descriptors during device discovery,
128                 if found
129         - bumped opensync version number in configure.ac, and made
130                 the configure scripts more consistent with the rest
131                 of the project
132         - fixed printf-format size bug in opensync module
133 2007/03/29
134         - applied patch from Niels de Vos, fixing deb udev rules for Pearl
135         - updated AUTHORS
136         - fixed extra space bug in LDIF output (added space when creating
137                 FullName, even if there was no last name)
138         - fixed Address Book record parsing in Contact class... the
139                 Blackberry database uses field id 0x20 for both the
140                 first and last names, and if only a last name exists,
141                 the first name will be empty.  Fixed parser to handle
142                 this special case, without relying on string length.
143                 Thanks to Troy Engel for reporting above two LDIF bugs.
144         - added a few more constants to bcharge.cc
145         - renamed opensync's configure.in to configure.ac
146 2007/03/17
147         - fixed bcharge to avoid endless reset loop... oops
148 2007/03/16
149         - reorganized bcharge.cc to make it possible to switch between
150                 Pearl modes 0004 and 0001
151         - added flag to BadPassword exception class, to signal whether
152                 the library considers the device "out of retries" or not
153         - updated socket.cc for new BadPassword exception
154         - added special case to Controller class destructor to reset the
155                 device if being destroyed in a half-open state... this is
156                 a temporary fix until we understand how to handle
157                 the "already open" message we get when opening the Desktop
158                 in some cases
159         - added password prompt dialog to the backup GUI
160         - fixed possible memory leak in GUI's DeviceInterface::Connect()
161 2007/03/08
162         - committed Troy Engel's bbrules_mass_symlinks.patch, fixing
163                 udev rules for the Pearl
164         - updated 10-blackberry.rules.Debian to match 10-blackberry.rules's
165                 functionality
166         - applied Troy Engel's barry.spec patch to generate all required
167                 RPM's... Thank you!  Notes in the README taken from
168                 the sourceforge tracker entry containing the patch.
169         - added libusb lib flags to tools/ and examples/ makefiles,
170                 and tweaked configure.ac with a better default,
171                 to build cleanly on RHEL 4
172         - modified rpm/barry.spec:
173                 - does not create doc-only barry base package anymore
174                 - fixed "barry-backup" typo
175                 - removed the patch step, as version 0.7 shouldn't need it
176                 - added license file to each package
177                 - commented out console perms scripts, pending mailing list
178                         discussion
179         - updated AUTHORS
180         - applied Troy Engel's barry.spec patch to fix RHEL4 compile issues
181         - fixed 80 column wrapping error in barry.spec, thanks to Troy Engel
182                 for the bug report
183         - applied Troy Engel's udev permissions patch for Redhat/Fedora
184                 systems, which automatically set the ownership of a
185                 newly plugged in device to the currently logged in console
186                 user.
187         - added udev/README to document what all those files are for...
188                 part of the text comes from the sourceforge comment
189                 on the above udev permissions patch from Troy Engel
190         - uncommented the console perms scripts for rpm/barry.spec
191         - added libglademm-2.4 to gui/README's dependency list
192         - made usbwrap.* calls more threadsafe
193         - added Usb::Timeout exception for timeout errors
194         - added preliminary UsbSerData support to library for GPRS modem
195                 functionality, using Rick Scott's XmBlackBerry's serdata.c
196                 as a guide
197         - added overloaded Socket::Send() for sending without receiving
198         - added preliminary pppob command line tool
199 2007/03/02
200         - version bump in:
201                 - configure.ac
202                 - src/Makefile.am
203                 - src/version.cc
204                 - gui/src/BackupWindow.cc (about dialog)
205                 - src/Doxyfile
206                 - rpm/barry.spec
207         - build system tweaks for opensync-plugin, and added a buildgen.sh
208                 for it
209         - added better debug messages in probe.cc and usbwrap.cc's
210                 device discovery code
211         - changed error handling for null interface->altsetting pointers
212                 when doing device discovery in usbwrap.cc.  Seems that
213                 some devices report a higher number in bNumInterfaces
214                 than are really available... in this case, let's
215                 just ignore the missing data and assume success
216         - applied udev script patch #1663986 from Troy Engel
217         - applied barry-bcharge.spec patch #1672178 from Troy Engel
218         - ReleaseChecklist update
219         - added rpm/README based on Troy Engel's patch notes
220         - updated new barry-bcharge.spec for version 0.7, removing patch
221                 dependency
223 Release: version 0.6 - 2007/02/28
224 ------------------------------------------------------------------------------
225 2007/02/28
226         - fixed size checks for device database records larger than 64K
227                 Thanks to Michael Brown for the bug report.
228         - added initial release maintainer scripts
229         - fixed odd backup success message in GUI when doing a backup with
230                 no databases selected in configuration
231                 Thanks to Michael Brown for the bug report.
232         - added udev permissions file patch from Michael Brown
233         - added Michael Brown to AUTHORS
234         - updated README, gui/README, and doc/USB-capture.txt
235         - added -o command line switch to bcharge.cc, and updated man page
236 2007/02/23
237         - changed library behaviour so it only turns on libusb debug output
238                 if in data dump mode.  In btool, -v controls this output.
239         - minor stream formatting fix in btool
240         - added OpenSSL dependency to build for password hash support
241         - made debug dout() output conditional on Init() flag... In btool,
242                 -v now controls this as well
243         - reverse engineered more of the initial probe packets, and
244                 implemented probing in struct based code... changes include:
245                 - added support for "attribute fetch" packets, used at
246                         the beginning of USB conversations
247                 - defined object/attribute id codes for the PIN number
248                 - made Protocol::SocketCommand more robust, and implemented
249                         its sequence number behaviour
250                 - moved ModeSelectCommand into SocketCommand, as it is a
251                         socket 0 level command
252                 - added initial protocol struct: PasswordChallenge
253                 - renamed Barry::Packet to DBPacket
254                 - added ZeroPacket for socket 0 packet creation and analysis
255                 - Barry::Packet is now the base class for the above
256                 - implemented socket 0 behaviour in socket.cc
257                 - changed return values for Send/Receive/Packet/NextRecord
258                         members in the Socket class from bool to void, as they
259                         don't generate errors themselves, but only can
260                         have an error if Usb::Device throws an exception.
261                         Cleaned up all code that called these members as well.
262                 - removed "last status" from Socket class as it was unused
263                 - updated probe.cc to use new socket 0 implementation
264                 - removed two of the hard coded packet handshakes in favour
265                         of socket 0 packets
266                 - updated controller.cc:
267                         - uses new socket 0 implementation
268                         - removed "flag" hack when opening sockets and
269                                 selecting modes, as it should use the
270                                 socket 0 sequence number
271         - added initial, incomplete prototype header for the C API
272         - updated some .cvsignore files
273         - updated TODO
274         - updated ReleaseChecklist.txt, adding rpm spec file
275         - added the following to ZeroPacket:
276                 - ChallengeSeed()
277                 - RemainingTries()
278                 - SocketResponse()
279                 - SocketSqeuence()
280         - moved Command() to base Packet class
281         - added comments to protostructs.h and size constants for the
282                 new PasswordChallenge struct
283         - added password support to Socket and Controller classes
284                 Thanks to Rick Scott's XmBlackBerry for the openssl
285                 password hashing logic.
286         - updated btool to use new password support, and updated its man page
287 2007/02/22
288         - updated Doxygen input files and version, and added to ReleaseChecklist
289         - fixed btool PIN output for LDIF mode, now commented in output
290         - major LDIF overhaul:
291                 - split LDIF specific code out of the record class and
292                         into its own
293                 - fixed "full name" behaviour that added an extra space
294                         in dn attributes, as reported by Troy Engel
295                 - added support for mapping of LDIF attributes to Barry
296                         contact field names
297                 - fixed base64 handling, so attributes are only so encoded
298                         if necessary
299                 - fixed base64 attribute reading inconsistency... some
300                         notes fields were missed in old version if not
301                         encoded
302                 - added support for specifying alternate attribute for
303                         constructing a FQDN, instead of just "cn"
304                 - updated btool and upldif to use new features
305         - large update to btool manpage
306         - fixed initialization bug in Contact constructor (missed RecType)
307 2007/02/15
308         - added ktrans.cc to make reading of kernel usbfs_snoop logs easier
309         - removed commented code from translate.cc
310         - added Pearl handshake support to bcharge.cc, which resets the
311                 Pearl so that the vendor specific 0xFF class exists.
312                 This should allow use of btool on the Pearl.
313         - added Data::AppendHexString to data.cc
314         - added better probing support for the Pearl, so it detects the
315                 Product ID 0x0004 mode, and does a search for class 0xFF
316                 instead of hardcoding it.
317 2007/02/10
318         - applied README patch from Ian Darwin
319         - minor tweaks to README
320         - added missing errno.h header in src/usbwrap.cc for AMD64
321                 Thanks to Jonathan Hudson for reporting the bug.
322         - tightened up size checks in Data::ReleaseBuffer()
323         - stable libusb *does* return the actual length of the USB packet...
324                 fixed this in usbwrap.cc to set the actual size of read data,
325                 and removed the size hacks elsewhere in the code:
326                 probe.cc, protocol.cc, socket.cc, usbwrap.cc
327 2007/02/09
328         - added proper return codes for error conditions in btool.cc
329         - clarified some stream output code in the library, for hex/dec numbers
330         - removed old, non-working connect.cc test program
331         - added iomanip to debug.h
332         - changed usbwrap to call libusb again if EINTR and EAGAIN
333                 This should fix one of the OpenBSD issues
334 2007/02/04
335         - updated AUTHORS
336         - fixed bug in barrybackup GUI that didn't create the target path
337                 if the user didn't do Edit | Config first.
338                 Thanks to Ian Darwin for reporting the bug.
339         - applied gui/src/ConfigFile.cc header fix patch for OpenBSD
340                 from Ian Darwin
341 2007/02/03
342         - added initial btool.1 man page from Ian Darwin
343         - updated man/Makefile.am for new btool.1
344         - updated AUTHORS
345         - applied btool -h help clarification patch from Ian Darwin
346 2007/02/02
347         - reworked exception hierarchy, so applications can handle all
348                 Barry related exceptions, including Usb errors, with
349                 one base class: Barry::Error
350         - fixed all the ripple changes this caused throughout the codebase
351         - added BadPassword exception
352 2007/02/01
353         - version bump in:
354                 - configure.ac
355                 - src/Makefile.am
356                 - src/version.cc
357                 - gui/src/BackupWindow.cc (about dialog)
358         - updated doc/ReleaseChecklist.txt
359         - added usb-level breset.cc command line tool
360         - fixed bug in gui/src/tarfile.* for systems where
361                 sizeof(int) != sizeof(void*)
362                 - TarFile class now uses a plugin style for the compression
363                         operations, to allow for threadsafe versions if needed
364                         in the future.
365                 - also fixed leaked file handle bug in open_compressed()
366                 - Thanks to Jonathan Hudson for reporting this for 64bit systems
367         - minor signed comparison fixes in the library
368         - added better protocol data dumping code in probe.cc
369         - added Usb::Device::BulkDrain(), to prevent Barry from hanging
370                 due to pending reads
372 Release: version 0.5 - 2007/01/26
373 ------------------------------------------------------------------------------
374 2007/01/26
375         - added missing errno.h header to gui/src/util.cc
376         - lots more endian fixes after testing on iMac  
377         - iostream output size fixes
378         - added option to btool to reset the device via software
379         - beefed up exception handling in barrybackup
380         - checked in opensync work-in-progress: trace logging, pointer bugfix
381                 this is still experimental
382         - added aboutdialog.* files from gtkmm24 2.10.6, so we have a dialog
383                 class for systems running older versions of gtkmm, like
384                 Debian stable
385         - uncommented the about box menu handler
386         - added "cleanall" option to root buildgen.sh script
387         - update ReleaseChecklist.txt
388         - removed CVS auto-history strings from aboutdialog.*
389 2007/01/25
390         - found a link between the unknown field in tagged protocol headers
391                 and the unknown field in RecordStateTable entries.  This
392                 field matters when uploading certain databases, such as
393                 Browser Options.  It is unknown what this field really
394                 means, but we're calling it RecType.  Updated the API
395                 to use this in all parser objects and builder objects
396                 and record objects that use it.
397         - changed some uses of uint64_t to uint32_t, in Contact and
398                 Calendar record objects... unique IDs only seem to be
399                 32 bits
400         - added new static function to record classes: GetDefaultRecType()
401                 This returns the default rectype that should work
402                 for that record.  Ideally this should be retrieved from
403                 the device, but in the case where a database has no
404                 records, this info would be good to know.
405         - updated convenience template function Controller::AddRecordByType()
406                 to use GetDefaultRecType()
407         - documented the recurrence data and how to use it in Calendar objects
408         - added data debug output for incoming USB packets in the
409                 socket class... when we ported to the stable libusb
410                 we lost some of the verbose output... this should get it
411                 back.  (In the official release, you need to uncomment
412                 ddout() in debug.h for the full blast of debug output).
413         - backup GUI updates:
414                 - changed error_done signal into a pure error signal,
415                         and changed the logic so the restore continues
416                         even if there was a protocol error on one database
417                 - changed status bar messages to show what's happening
418                         i.e. Backup or Restore
419                 - default to not restore the "Handheld Agent" database as
420                         it appears to be read-only on the device
421                 - added temporary Restore & Backup mode for debugging
422                 - added extra hyphen to backup files to show date/time better
423                 - updated GUI to save and restore the new RecType field
424                         supported now by the library
425 2007/01/21
426         - added future considerations to doc/ReleaseChecklist.txt
427         - applied big endian patch from Jonathan Hudson
428         - changes to patch:
429                 - removed endian.h include from barry.h, since applications
430                         using the library should not care about endianness
431                 - hard coded the path to config.h in endian.h
432                         so that endian.h never makes it into the final
433                         install
434                 - removed DEFAULT_INCLUDES setting from src/Makefile.am
435                         for the same reason
436                 - removed config.h dependency in btool.cc and used library
437                         Version call instead
438         - added big/little endian text to the Barry::Version call
439         - updated AUTHORS
440         - fixed install location of bcharge when building with ./configure;
441                 now goes to sbin/ for both source compile and binary packages
442                 Thanks to Jonathan Hudson for reporting this bug.
443 2007/01/20
444         - added smarter timeout values to controller, and allowed
445                 timeout overrides in the packet, socket, and usbwrap code...
446                 extra timeouts are needed for erasing databases for
447                 some older devices
448         - added an explicit DataDumpParser class to btool.cc, as the
449                 library doesn't always have extreme verbose debugging on...
450                 this makes sure anyone can always get raw database packets
451                 through btool, for development
452         - added thread callback signals for error finishes and erase_db
453                 operations, so the GUI is updated properly
454         - more GUI cleanups (status bar updates, etc)
455         - finished implementation of GUI restore
456         - fixed gtkmm/glibmm exception handling when the exceptions
457                 occur in sigc signal handlers... in that case,
458                 exceptions need to be handled with
459                 Glib::add_exception_handler()
460         - added filename-only reading support to TarFile class
461         - added pending gui/TODO items
462 2007/01/19
463         - backup GUI now properly shows progress
464         - the buttons become insensitive when backup is busy
465         - refactored directory check code, and added mkdir check
466                 when to the backup setup (so the directory exists
467                 when we try to write to it)
468         - updated code to use Barry::Data in new namespace
469 2007/01/18
470         - moved Data class into Barry namespace
471 2007/01/13
472         - updated copyright dates for the new year
473         - clarified exception message in controller.cc
474         - fixed pointer initialization bug in controller.cc
475         - added documentation comments to parser.h and builder.h
476         - updated ReleaseChecklist.txt
477         - updated README
478         - changed Barry library configure scripts to make better
479                 use of pkg-config for autodetecting dependencies
480         - added initial Barry Backup GUI (gui/ directory), capable of making
481                 backups only at this point
482 2007/01/11
483         - added doc/ReleaseChecklist.txt
484         - added version API, returning version number and string
485         - added Troy Engel to AUTHORS
486         - added special case to bcharge.cc for the Blackberry Pearl,
487                 which doesn't reset itself after the charge handshake
488                 Thanks to Troy Engel for testing.
489 2007/01/05
490         - added pkg-config support for the library (libbarry-0.pc.in)
491         - fixed compile error on g++ 3.3 systems (missing stdint.h
492                 in probe.h)
493         - fixed protocol hang at end of Controller operation... in
494                 controller destructor, it was deleting the USB interface
495                 before closing the socket at the BlackBerry level, thereby
496                 leaving the device in Desktop mode
497 2007/01/04
498         - support the newer udev packages on Ubuntu, which need slightly
499                 different rules
500         - modified bcharge.cc to search for Pearl devices too.
501                 USB product ID 6
502         - added Pearl product ID to probe code, but likely not functional
503                 yet until we find someone able to get a USB capture for us
504 2006/12/29
505         - version bump in configure.ac and src/Makefile.am
507 Release: version 0.4 - 2006/12/29
508 ------------------------------------------------------------------------------
509 2006/12/29
510         - added bcharge.cc to the tools/ directory (whoohoo!)
511         - added initial release version of rpm/barry.spec (aka bcharge.spec)
512                 This begins the barry binary release, currently only
513                 including the bcharge utility, but possibly more in
514                 the future.  Future binary packages will likely include
515                 libbarry, libbarry-devel, etc, which barry will then
516                 depend on.
517         - added udev rule script for BlackBerry devices
518         - added man/ directory and bcharge.1 manpage
519         - added debian/ directory for building deb packages, with initial
520                 package scripts
521         - added rpm/make-rpm-tarball.sh for building RPMs
522         - split out technical docs into separate libbarry.docs file for
523                 a future Debian install
524         - added more cleaning to buildgen.sh
525         - added new udev rule file for Debian stable
526         - hardcoded g++ to 3.3 in debian/rules as I have multiple versions
527                 on my system and need to compile releases with stable
528 2006/12/21
529         - ported Barry to use the stable branch of libusb
530                 NOTE: no longer depends on the devel libusb tarball!
531                         Just use your distro's libusb packages.
532         - fixed more endian issues
533         - minor update to TODO
534 2006/12/15
535         - moved Exceptions, Hacking, and VersionNotes to doc/
536         - added doc/USB-capture.txt
537 2006/12/08
538         - added Controller::AddRecord() and template helper
539         - added beginning version of generic RecordFetch<> template
540         - set default of Barry::Init() to false (no data dump mode)
541         - added examples/ directory, with first addcontact.cc example
542 2006/12/07
543         - added autoconf support based on Peter McAlpine's patch
544         - renamed Makefiles to Makefile.orig and added script to turn
545                 on old build system if wanted
546         - fixed boost-specific error path in btool
547         - moved platform specific code out of time.h and into time.cc
548         - moved btool.cc, translate.cc, and upldif.cc out of src/ and
549                 into their own tools/ subdirectory
550         - added NEWS file to make autotools happy
551         - added a "clean" option to the buildgen.sh script... maintainer's
552                 use only
553         - reworked autoconf and automake files, to support
554                 barry as a library, to move the programs into their
555                 own tools directory, and support a proper installation
556         - fixed headers in parser.h, btool.cc, and upldif.cc to work
557                 properly when installed standalone
558         - added tools/Makefile.plain for testing compiling against
559                 installed barry library
560         - added commentary on version number system
561         - removed Makefile.conf and Makefile.orig, as new autoconf
562                 system supercedes it
563         - added support for boost serialization library in autoconf build
564         - added library version number to autoconf build
565         - changed boost flag to __BARRY_BOOST_MODE__ to avoid collisions
566         - removed debug.h dependency from btool.cc
567         - removed libusb check in favour of specific --with-libusb
568                 option... may need to revisit this later
569         - quick installation update in README
570 2006/12/01
571         - fixed some missed endian conversions in record.cc and added
572                 some size checks
573         - fixed endian issues in time.h
574         - added 2 more functions to the time zone API, and adjusted
575                 the time zone table for better defaults in North America
576         - added btool and upldif to the make install sequence
577         - added support for Calendar recurrence data
578         - small doc/TimeZones.txt update
579 2006/11/24
580         - added BlackBerry time zone code list, reverse engineered from a 7750
581         - added GetTimeZone() to convert device time zone codes to useful data
583 Release: version 0.0.3 - 2006/11/24
584 ------------------------------------------------------------------------------
585 2006/11/23
586         - added return code check to Controller::SaveDatabase()
587         - fixed Data() class constructor, so it doesn't auto-convert
588                 from any int
589         - fixed size checking bug in Packet::ReturnCode() that caused
590                 uploading to device to fail
591 2006/11/10
592         - added Exceptions doc file, documenting the C++ exceptions used,
593                 and their hierarchy
594         - fixed small bug in 'make install' which didn't build first
595         - minor documentation and cleanup in upldif.cc
596         - added utility functions to the RecordStateTable class,
597                 GetIndex() and MakeNewRecordId()
598         - changed btool so that the -d command modifiers can be
599                 specified multiple times to work with multiple records
600                 at once
601         - added Calendar sync code to the opensync module (not complete)
602         - cleaned up exception handling in the opensync module, making
603                 more use of the base exception to make sure no
604                 exceptions leak into the C library code
606 Release: version 0.0.2 - 2006/10/12
607 ------------------------------------------------------------------------------
608 2006/10/12
609         - fixed casting error in opensync module
610         - minor updates to documentation to prepare for release
611 2006/09/29
612         - added stdint.h to parser.h for uint32_t.  Thanks Ron Gage for
613                 the bug report
614 2006/09/08
615         - large refactoring of the packet parsing and building code,
616                 splitting the code into 3 groups:
617                 - record: handles record specific parsing and building...
618                         this is mostly subfields with CommonField structs
619                         as their headers, but sometimes has a specific
620                         header of its own, in the case of email
621                         Note: email's header is as yet undecoded.
622                         Record does not know the details of the packet
623                         formats, only the formats of its own record data.
624                 - packet: handles building of complete command packets
625                         and handles parsing of commonly used header values,
626                         providing an API for it... packet does not know
627                         the record format details, but does know the
628                         details of each Database Operation (protocol.h)
629                         packet format.
630                         So far, it seems that there is a real separation
631                         of operation formats and record formats, with the
632                         record formats being the same even with different
633                         database operation codes (GET_RECORDS /
634                         OLD_GET_RECORDS), which was not confirmed before.
635                         See the header size of the email record after
636                         refactoring.
637                 - controller: handles device state, and the management of
638                         sockets, commands, and checking for response values.
639                         The Controller object does not know the format
640                         of either the record or the packet it is sending,
641                         but does know the protocol handshake logic used
642                         to talk to the device.
643         - implemented SetRecord (SET_RECORD_BY_INDEX)... syncing, here
644                 we come!
645         - spelling correction in opensync-plugin/AUTHORS
646 2006/09/01
647         - added sample hotplug scripts
648         - added .cvsignore files for doxygen and opensync directories
649         - added src/endian.h... still need to add configure support to
650                 handle non-little-endian machines
651         - added exception handler in opensync plugin commit_change()
652         - removed the device reset code in probe.cc, as resetting a device
653                 can renumber the devices in /proc on kernel 2.4.x,
654                 and cause a failure to reach the device...
655                 FIXME - this should be changed someday to reset if probing
656                 fails, and restart the probe on reset, as sometimes
657                 the blackberry devices respond differently when not reset
658                 Ideally, the probe protocol should be properly reverse
659                 engineered.
660         - added support for retrieving record state table, which is needed
661                 for smarter syncing
662         - added support for retrieving, deleting, and clearing the dirty
663                 flags of individual blackberry device records
664         - added endian macros throughout the code
665 2006/07/13
666         - added opensync-plugin to root Makefile's clean
667         - updated time conversion calls to match opensync's latest SVN
668         - added opensync_change_set_changetype() (only add for now,
669                 for development)
670         - removed slow sync functions for now
671 2006/07/07
672         - added quick "install" makefile target, to src/install by default
673         - added static library target... this is temporary until autoconf
674                 stuff is added properly... needed for the opensync plugin
675         - documented in comments that Barry::BError is intended to be
676                 the base classes for all exceptions
677         - added first round of implementation of an opensync plugin, based
678                 on the example plugin code from the opensync sources
679 2006/06/22
680         - added to Contact record class:
681                 - Clear()
682                 - ReadLdif() to load and parse LDAP data
683         - added fragmented send support to Socket class
684         - added Probe::FindActive() to make client programs more streamlined
685         - fixed hex/decimal printing of record counts in btool
686         - added upldif.cc, a utility to take ldapsearch output on stdin
687                 and upload it to a blackberry
688         - updated src/.cvsignore
689 2006/06/16
690         - added parsing of service book fields:
691                 - old and new name
692                 - old and new unique ID (UID)
693                 - content ID (CID)
694                 - old and new description
695                 - DSID
696                 - bes domain / domain
697         - date change in legal.txt
698         - added initial parsing of ServiceBook field 0x09, and calling it
699                 ServiceBookConfig for now, for lack of a better name
700         - added parsing for ServiceBook field 0x02 on 72xx Blackberries...
701                 seems to be a name or description, but doesn't appear
702                 in the device's own GUI... called "Hidden Name" for now
703 2006/06/09
704         - added ServiceBook record class and parser code, based on some
705                 of Ron Gage's reverse engineering... code is by Chris Frey
706         - added AUTHORS file
707         - fixed the libusb set_configuration/claim_interface order
708                 bug in controller.{h,cc}... already fixed in probe,
709                 but not controller.  Thanks Ron Gage for finding this.
710 2006/05/25
711         - renamed Changelog to ChangeLog in preparation for autoconf
712         - renamed Todo to TODO in preparation for autoconf
713 2006/05/18
714         - make clean cleans up tests properly now
715 2006/03/31
716         - turned source code browsing on in Doxyfile
717         - added LoadDatabaseByName() and LoadDatabaseByType() template members
718                 to the Controller class
719                 - new file: controllertmpl.h
720         - documentation fixes in builder.h
721         - added static GetDBName() functions to all record classes, in
722                 support of the template Controller functions
723         - fleshed out DatabaseDatabase::GetDBNumber() and GetDBName(),
724                 returning errors properly
725         - documented sample btool.cc code better, and added example
726                 of Controller template member usage
727 2006/03/29
728         - copyright dates updated for 2006
729 2006/01/05
730         - backed out update to latest libusb DEVEL tree, since it is buggy.
731                 Stick with libusb 2005/11/26
732 2005/12/30
733         - added clean target to convenience Makefile
734         - added Boost to list of dependencies in README
735         - fixed minor compile warnings in base64.cc
736         - fixed new USB discovery code, and changed endpoint usage to use
737                 it, instead of the READ_ENDPOINT and WRITE_ENDPOINT
738                 constants... constants are now removed
739                 common.h, controller.cc, probe.cc, probe.h, usbwrap.cc
740         - added ClearHalt() to Usb::Device (usbwrap.cc)
741         - updated usbwrap.h to match latest libusb CVS devel tree
742         - updated README to refer to 2005/12/30 libusb CVS devel tree
743         - added roadmap to Todo list
744 2005/12/29
745         - added convenience Makefile in root directory
746         - added Hacking document
747         - minor touchups to README
748         - added caution warning to README, since this release will support
749                 delete / overwrite / upload functionality
750         - minor compile order change in Makefile (speed reasons)
751         - added dynamic endpoint discovery to probe.cc
752         - changed claim_interface/set_configuration() function call order in
753                 probe.cc based on feedback on the libusb mailing list
754         - added USB discovery code to usbwrap.{h,cc}
755 2005/12/23
756         - fixed packing bug in new upload header struct
757         - renamed CommonField union from data to u to be consistent
758         - added return_code field to DBAccess struct, for error checking
759         - added response checking during upload: if response is non-zero
760                 throw exception in controller.cc
761         - added sorting operators to record parser classes... when writing
762                 contact data to the device, it may be important to write
763                 group link items last, since they reference other contacts...
764                 This needs to be tested, and if not required, removed.
765         - added GROUP_FLAG field code to Contact parser class
766         - fixed offset bug in Contact and Calendar Build() functions
767         - fixed name bug in Contact::Build(), now output only with data
768         - added appointment type flag support to Calendar record parser
769                 class, and "all day event" flag support
770 2005/12/22
771         - added autoconf to Todo list
772         - refactored the protocol structures so that record structs can
773                 be reused for upload and download
774         - with new protostructs, more header control is handled by
775                 controller.cc instead of record.cc parsers and builders
776         - parser code now accepts an offset, to govern start of record data
777         - changed Data sizes from int to size_t and removed casts
778         - removed unneeded Parser::GetHeaderSize() (new protostructs make
779                 this obsolete)
780         - added Calendar::Build() for calendar uploads
781 2005/12/10
782         - added s11n-boost.h serialization templates for boost::serialization
783         - added boost::serialization to build
784         - minor change in usbwrap.cc to display error codes in decimal
785         - added SizePacket special case code to Socket::Send()... this is
786                 required when uploaded packet size is a multiple of 0x40,
787                 a special 3 byte size packet is sent
788         - moved some record class variables to public: so they can be
789                 properly serialized
790         - fixed variable name but in RecordBuilder template
791         - added -f switch to btool, for saving and loading of record data
792         - added -s switch to btool, for uploading saved data back to handheld
793         - added Controller::SaveDatabase()
794 2005/12/08
795         - fixed potential casting / pointer bug in controller.cc
796         - added builder.h, to support uploading
797         - minor comment fixes in parser.h
798         - added preliminary Contact protocol record building support
799         - fixed field order bug in ContactRecord protocol struct
800         - Contact record.h class now saves unknown Group Link field,
801                 for later saving
802 2005/12/07
803         - added -fno-strict-aliasing to compiler flags so gcc-4.0.x won't
804                 optimize away protocol struct casts
805                 see: 
806                 http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25235
807                 http://mail-index.netbsd.org/tech-kern/2003/08/11/0001.html
808                 http://groups.google.ca/group/comp.lang.c++.moderated/ \
809                         browse_thread/thread/e7bf096832526f8e/5714701b \
810                         02a2a3cc?hl=en#5714701b02a2a3cc
811         - changed headers so that any low level protocol-specific sizes and
812                 structs are completely hidden in the library...
813                 this adds library-only header: protostructs.h
815 Release: version 0.0.1 - 2005/11/25
816 ------------------------------------------------------------------------------
817 2005/11/25
818         - added barry.h for documentation purposes and application usage
819         - updated README for release
820         - renamed SBError exception class to BError
821         - updated Doxyfile to version 1.4.5
822         - added more doxygen comments
823 2005/11/24
824         - added conversion routines (and tests) between time_t and min1900_t
825         - added -v option to btool to dynamically control protocol dumping
826         - removed duplicated database database table display in controller.cc
827         - minor spelling corrections
828         - added copyright to usbwrap.{h,cc} as per earlier meeting
829         - added support for Old protocol Calendar entries
830 2005/11/20
831         - added legal.txt, to save typing when adding new source files
832         - ignore test-base64 file (cvsignore)
833         - added contact-to-ldif generation, and updated supporting code
834         - added argument to btool to support contact-to-ldif operation
835         - added Contact::GetPostalAddress()
836         - added README documentation in preparation for future release
837 2005/11/19
838         - added parser.{h,cc} virtual wrapper to generalize LoadDatabase()
839         - added code to socket.cc's Packet() command to re-receive on
840                 reception of empty packets... this seems to be a signal
841                 from the device that it needs more time for long transfers
842                 Current limit: 10 blank packets before exception is thrown
843                 Observed maximum blank count: 1
844         - added MessageRecord and OldMessageRecord to protocol.h
845         - changed common record field structs to one CommonField struct
846         - increased default USB timeout to 10 seconds (some loaded devices
847                 seem to need more time...)
848         - reorganized record.{h,cc} to try to reduce the code duplication
849         - record.h classes now "know" the sizes of their corresponding
850                 protocol structs... this may cause trouble down the line
851                 with Python, if used(?)
852         - added Message class for Email records
853         - removed the "Get*" database functions and replaced with
854                 general LoadDatabase() call, which loads any database
855                 available, and parses it with a Parser object
856         - added GetDBID() for searching for database numbers via name
857         - added test code to retrieve and display all email
858         - cleaned up comments
859         - renamed blackberry.{h,cc} to controller.{h,cc}
860         - renamed bbtool.cc to btool.cc
861         - added Makefile.conf
862         - added copyright notices to source files
863         - added COPYING file with GPL
864         - put parser in Barry namespace, and added auto_ptr-like mode for
865                 store object pointers
866         - added doxygen docs
867         - added header comments to convo.awk script
868         - removed Test() function in Controller object, and made class
869                 better suited to its general API purpose
870         - changed OpenMode() so it loads command table and DBDB... it is now
871                 a public API function
872         - moved Controller test code to btool.cc and made tool more
873                 generically useful... can now download any DB by name on
874                 the command line
875         - added mode checks to Controller
876         - added -t and -d command line options to btool
877         - added base64 routines from John Walker / Fourmilab and Citadel/UX
878         - converted base64 routines into an API, instead of hardcoded
879                 file based
880 2005/11/18
881         - changed project name to Barry, including namespaces
882         - renamed sbcommon.* to common.*
883         - increased USB default timeout to 2 seconds
884         - fixed formatting bug in Data operator<< output
885         - cleaned up the protocol packet structs, getting rid of the
886                 confusing param/simple split... param is now the tableCmd
887                 from the Command Table
888         - moved protocol structs from record.h to protocol.h
889         - added support for older version of the USB protocol, which matches
890                 the Cassis spec more closely
891         - fixed the hardcoded offsets in blackberry.cc's protocol parsing
892         - fixed Socket::Close() so on error, socket flags are reset.
893                 This stops Close() from being called twice on exception
894                 destructors
895 2005/11/17
896         - added Doxyfile to the project
897         - tuned Makefile
898         - added mode selection support to Blackberry class (RIM Desktop,
899                 RIM Bypass, and RIM_JavaLoader)
900                 Mode selection governs which socket is used in subsequent
901                 data transfers.
902         - added Command Table parsing and protocol support
903                 Blackberry class, and CommandTable record class
904         - added Database database parsing and protocol support
905                 Blackberry class and DatabaseDatabase record class
906         - added Address book retrieval support - dumps data to stdout for now
907         - fixed bug in CopyOnWrite mode in Data class, where could allocate
908                 less buffer than data copied
909         - added "easy exception" debug output macro
910         - fixed minor spelling error in protocol.cc
911         - fixed ModeSelectCommand protocol structure - it is not a parameter
912                 command, but uses the unknown slots for socket and flag
913                 data
914         - removed hardcoded socket numbers from protocol.h
915         - fixed bug in socket.cc:Open() where packet size was not properly
916                 saved
917         - implemented socket::Close()
918         - fixed sequence number checks, so it is reset properly on socket 0
919         - added Socket::NextRecord() for multiple record data transfers
920         - fixed input handling bug in translate.cc
921 2005/11/11
922         - added .cvsignore files to project
923         - added README notes to document the source architecture
924         - added dbsetup data script, which shows how to get into database
925                 mode, using the RIM Desktop mode, and open a socket
926         - added blackberry.{h,cc} class
927         - added command line parameters to bbtool.cc
928                 -l = list only
929                 -p = specify pin of blackberry device
930         - added blackberry test code in bbtool.cc - debugging the initial
931                 opening protocol: sockets, modes, etc... see dbsetup for
932                 results
933         - added copy-on-write functionality to Data class, so it can be used
934                 with plain data buffers with little performance impact
935         - added eout() and ddout() debugging - to separate:
936                 - regular debug output
937                 - exception debug output (should probably be logged to
938                         syslog someday, and never turned off)
939                 - raw data dump output
940         - changed errno SBError exception handler to try to decode the error
941                 numbers into english (limited success)
942         - fixed probe and socket USB Bulk message handling, so they don't
943                 use PollCompletions(), but use IO::Wait() (libusb_io_wait())
944         - added common packet size checker in protocol.cc
945         - fixed unpacked protocol packet structs... using gcc's
946                 __attribute__ ((packed)) ... see protocol.h
947         - added ModeSelectCommand structure (protocol.h)
948         - finished Socket::Open() call  (Close() not yet implemented)
949         - moved Socket::Send/Receive() out of private, as they can be used
950                 for socket 0 operations.
951         - cleaned up pointer management with macros:
952                 MAKE_PACKET()
953                 COMMAND()
954                 IS_COMMAND()
955         - added IO::Wait() and IO::Cancel() to correspond with libusb API
956         - added datadumping in usbwrap for easy protocol capture
957         - added preliminary record.{h,cc} classes
958         - added Contact record parsing, and test code
959 2005/10/20
960         - syncberry tree started