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