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