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