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