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