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