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