src/socket.cc: Source code reorganization
[barry/pauldeden.git] / ChangeLog
blob6faf48ad79cec5bfc168c4b519dab27a1055cd30
1 Release: version 0.13 - 2008/05/??
2 ------------------------------------------------------------------------------
3 2008/05/16
4         - put sequence packet check directly in the SocketZero::RawReceive()
5                 function, which now localizes all sequence packet
6                 handling and checking, as well as avoids packet
7                 order problems when multiple sockets are in use,
8                 such as with pppob...
9                 FIXME - this localized sequence checking may make all
10                 the calls to CheckSequence() obsolete which
11                 should probably be cleaned up someday, if so.
12         - reorganized src/socket.cc to match class private/public
13                 order (no code change, only move)
14 2008/05/15
15         - mention CVS and git on main documentation "how to" list
16         - moved PPP filter logic into its own class
17         - enhanced PPP filter class to support prepending of
18                 empty bytes if needed, in order to reduce data
19                 copying, and clarified why there is no GetBuffer()
20         - added ProbeResult::HasIpModem() to determine whether
21                 IpModem endpoints are available
22         - added pure virtual Modem base class for common
23                 modem-oriented API (only Open and Write so far)
24         - Mode::IpModem is now derived from Barry::Modem
25         - experimental implementation for Mode::Serial,
26                 which is now derived from Barry::Modem,
27                 and uses PppFilter
28         - pppob now supports IpModem and Serial modes, and logging
29                 to file instead of stderr
30         - added man page for pppob
31 2008/05/10
32         - modified the planned version numbering scheme in doc/VersionNotes,
33                 so that a 1.0 is possible, with 1.50 as the devel series
34 2008/05/09
35         - continuing to update html documentation in preparation for
36                 0.13 release
37 2008/05/02
38         - removed -fvisibility-inlines-hidden compile options since some
39                 distros have old or broken compilers or libraries where
40                 the build breaks looking for STL templates (Ubuntu 7.10,
41                 I'm looking at you...)
42         - changed brecsum so usage information is displayed automatically
43                 if no command line arguments are specified
44         - added opensync-plugin to maintainer test scripts, and added
45                 ubuntu710 to the test build sequence
46 2008/05/01
47         - updated doc/TroubleShooting.txt
48         - removed usb_control message check from IpModem endpoint probing
49                 in src/probe.cc, since some devices, like the 8700
50                 have both RIM_UsbSerData mode and IpModem mode.
51         - fixed serialization code for Calendar record class, in s11n-boost.h
52         - made UnknownField's data member into its own type,
53                 so that when building records, it doesn't get processed
54                 like a null terminated string... also added more
55                 BuildField() helper functions for accuracy
56         - fixed missing fields in the Calendar record build process
57         - added Calendar to list of Builders in tools/btool...
58                 it is now possible to run: btool -s "Calendar" -f datafile
59         - added tools/brecsum program, which calculates SHA1 checksums
60                 on database records, for testing
61         - added brecsum to debian and rpm builds
62         - added recurrence builder function to Calendar record builder code
63                 which completes builder support
64                 Checksums from the following commands now match:
65                         brecsum -d Calendar > sum1.txt
66                         btool -d Calendar -f calendar.dat
67                         btool -s Calendar -f calendar.dat
68                         brecsum -d Calendar > sum2.txt
69                         diff -u <(sort sum1.txt) <(sort sum2.txt)
70 2008/04/29
71         - applied Jason Thomas's ACLOCAL_FLAGS patch to make autoreconf
72                 work again... Thanks!
73         - applied Jason Thomas's debian build dependency patch
74         - updated AUTHORS
75 2008/04/26
76         - started documentation overhaul in doc/www, putting the commonly
77                 asked questions right on the front page, and making it more
78                 goal-oriented, so it is hopefully easier to use
79 2008/04/25
80         - updated NEWS file
81         - fixed error messages in m_desktop.cc that still referred
82                 to Controller
83 2008/04/25
84         - major merge of barry-b1-socket-arch-branch into MAIN.
85           The following is the changelog from that branch, which is now MAIN.
87         2008/04/25
88                 - added thread-safe logging mechanism
89                 - added preliminary IP modem support... requires a recent
90                         device... serial mode is not yet supported
91                 - merged HEAD changes
92         2008/03/27
93                 - changed Barry::Init() so programmer can choose where
94                         debug and exception information goes, instead of
95                         always to stdout
96         2008/03/22
97                 - merged HEAD changes
98         2008/03/20
99                 - fixed bug in probe class, which missed storing the PIN
100                         number in ProbeResult
101                 - also added ProbeResult constructor
102                 - merged changes from visibility branch:
103                         - GCC visibility support, limiting what symbols are
104                           visible in the shared library, libbarry... this makes
105                           a drastic reduction in the symbol table, and should
106                           avoid future name clashes with other libraries such
107                           as opensync
108                           See: http://gcc.gnu.org/wiki/Visibility
109                         - vformat_() function name changes
110         2008/03/07
111                 - merged HEAD changes
112                 - added threads library to new bs11nread build
113         2008/02/28
114                 - fixed variable size issues in btranslate.cc, evident with
115                         some compilers on 64 bit systems
116                 - merged HEAD changes
117                 - added comments for threaded usage in usbwrap.h
118                 - changed router to use SocketId typedef, for clarity
119         2008/02/22
120                 - fixed const char warnings from newer gcc compilers
121                 - controller object now saves a copy of the probe result
122                         and provides an API to retrieve it
123                 - added sanity checks to m_serial.cc
124                 - fixed probe behaviour so that a USB probe on an endpoint
125                         that doesn't respond won't halt everything
126                 - refactored some of the probe code, and added checks for
127                         IP modem endpoints
128                 - added Probe::DumpAll()
129                 - added Open() call to pppob.cc (not yet complete)
130         2008/01/30
131                 - implemented dataqueue.{h,cc}... looks ready for testing,
132                         once things compile again
133                 - changed free list copy in router.cc to use
134                         DataQueue::append_from()
135                 - finished packet.{h,cc} implementation, ready for testing
136                 - finished controller.{h,cc}, ready for testing
137                 - finished m_desktop.{h,cc}, ready for testing
138                 - added skeleton m_serial.cc
139                 - the base library and utilities compile again!
140                 - added constructor for SocketZero(queue)
141                 - fixed ErrnoError::GetMsg()
142                 - updated GUI and opensync plugin to compile with new API
143                 - moved Raw Send/Receive socket functions to private
144                 - fixed packet header size bug in socket that caused
145                         socket ID override to be skipped
146                 - fixed incorrect use of gettimeofday()
147                 - fixed race condition where Controller could destroy
148                         the Usb::Device object before the SocketRoutingQueue
149                         was done with it
150                 - fixed segfault in SocketZero::RawSend() when a router
151                         was in use
152                 - fixed Open() bugs in btool... Open() must be outside of loops
153                 - btool uses the router thread now, for testing
154                 - partially implemented m_serial.{h,cc}... needs testing
155                 - added automatic buffer allocation to SocketRoutingQueue
156                         constructor
157                 - made AllocateBuffers() a little smarter, so it was not
158                         pure appending
159                 - added a context data pointer to the SocketRoutingQueue
160                         RegisterInterest callback
161                 - added RegisterInterest functionality to Socket class
162                 - added exceptions on router read errors in socketzero
163         2008/01/26
164                 - implemented router.{h,cc}... looks ready for testing,
165                         once things compile again
166         2008/01/25
167                 - merged HEAD changes
168                 - added router.cc and continued work on new arch
169                 - merged HEAD changes for 2008 copyright statements
170                 - added scoped_lock.h
171                 - added ErrnoError exception class
172                 - documented Controller / SocketRoutingQueue behaviour
173                 - more router implementation
174                 - simplified pppob
175                 - audit and cleanup of socket.{h,cc} code... looks ready
176                         for testing now, once things compile again
177                 - removed FIXME in router.*
178                 - removed pthread header from pppob as it is not needed
179         2007/11/22
180                 - merged HEAD changes
181         2007/10/25
182                 - merged HEAD changes
183         2007/10/19
184                 - branch started, to track development of the new socket
185                         architecture, and new mode architecture, needed
186                         to support GPRS modem support, and threaded
187                         USB access
188                 - committed work-in-progress... does not compile
190 2008/04/10
191         - added Tasks and Memos to TODO list
192 2008/03/27
193         - added support for Blackberry 8120, which has a unique Product ID
194                 Sourceforge tracker ID: 1829537
195 2008/03/22
196         - removed TimeZones from TODO list, as it is done
197 2008/03/21
198         - version bump:
199                 - configure.ac
200                 - src/Makefile.am
201                 - src/version.cc
202                 - gui/src/BackupWindow.cc
203                 - src/Doxyfile
204                 - rpm/barry.spec
205                 - debian/changelog
206                 - opensync-plugin/src/barry_sync.cc
207         - added GCC visibility support, limiting what symbols are visible
208                 in the shared library, libbarry... this makes a drastic
209                 reduction in the symbol table, and should avoid future
210                 name clashes with other libraries such as opensync
211                 See: http://gcc.gnu.org/wiki/Visibility
213 Release: version 0.12 - 2008/03/21
214 ------------------------------------------------------------------------------
215 2008/03/21
216         - changed maintainer script to use CVS export instead of checkout,
217                 to avoid the CVS directories
218         - added support for building Debian source packages with proper
219                 diff.gz and dsc files
220         - fixed find warning in maintainer/make-rpm.sh
221         - added support for Ubuntu binary packages to the maintainer build
222                 scripts
223 2008/03/13
224         - renamed all vformat_ and VFormat symbols in opensync plugin's
225                 copy of vformat code, so they don't conflict with the
226                 real opensync libraries
227 2008/03/07
228         - updated the install.php web page with Paul Dugas's notes on
229                 building RPM's from CVS
230         - fixed problem in tools/Makefile.am where bs11nread was included
231                 in build, even if --with-boost was not specified
232                 on ./configure command line
233 2008/03/06
234         - changed format of Boost serialization file output from btool,
235                 so that the database name is stored as the first line
236                 of the file
237         - added tools/bs11nread.cc to read Boost serialization file data
238                 written by btool
239         - minor adjustments to r_message.h and r_timezone.h
240         - updated s11n-boost.h header to match record classes
241 2008/03/01
242         - applied Time Zone parsing patches from Brian Edginton
243         - added Time Zones to list of supported parsers in btool.cc
244 2008/02/29
245         - changed configure.ac to use bzip2 for "make dist".. thanks to
246                 Paul Dugas for the tip
247 2008/02/28
248         - committed Chris Burgess's update to the roadmap document
249         - applied Paul Dugas's x86-64 build patch, except the
250                 tar.bz2/tar.gz change
251         - updated AUTHORS file
252 2008/02/22
253         - fixed configure.ac's --with-boost option, so that without args,
254                 it defaults to using --includedir and --libdir settings,
255                 instead of hardcoding /usr/include and /usr/lib... this
256                 should allow smarter compiling on 64 bit systems
257         - updated RPM spec file to use new --with-boost behaviour
258         - ahem, fixed configure.ac again... don't use --includedir and
259                 --libdir, as those are install targets... oops.
260                 Don't add path overrides at all if not specified.
261 2008/01/25
262         - fixed locale issues in src/data.cc
263         - updated copyright statments for 2008
264 2007/12/21
265         - applied wording correction patch to btool from Matt LaPlante
266 2007/12/07
267         - changed hard coded databases names in btool to calls to
268                 <recordclass>::GetDBName()
269         - version bump:
270                 - configure.ac
271                 - src/Makefile.am
272                 - src/version.cc
273                 - gui/src/BackupWindow.cc
274                 - src/Doxygen
275                 - rpm/barry.spec
276                 - debian/changelog
277                 - opensync-plugin/src/barry_sync.cc
278         - updated TODO
280 Release: version 0.11 - 2007/12/01
281 ------------------------------------------------------------------------------
282 2007/12/01
283         - fixed null pointer bug in Probe class (bug #1842407)
284         - added pause to maintainer release script
285 2007/11/30
286         - version bump:
287                 - configure.ac
288                 - src/Makefile.am
289                 - src/version.cc
290                 - gui/src/BackupWindow.cc
291                 - src/Doxygen
292                 - rpm/barry.spec
293                 - debian/changelog
294                 - opensync-plugin/src/barry_sync.cc
296 Release: version 0.10 - 2007/11/30
297 ------------------------------------------------------------------------------
298 2007/11/30
299         - added support to the usbwrap Match class to limit its
300                 search by busname / devname
301         - added support to the Probe class to limit its search for
302                 Blackberry devices to a given bus or device name
303         - added command line options to btool for the above Probe
304                 bus/device names, and updated the man page
305         - updated the www docs with regard to the new usb_storage
306                 behaviour and the new blacklist files... less
307                 concern about berry_charge and usb_storage conflicts
308         - added bidentify tool and accompanying man page
309         - fixed bug in rpm maintenance script that used the wrong
310                 spec file for opensuse
311 2007/11/29
312         - added better error checking to breset
313         - commented the sleep() for the 8830
314         - added code to handle the race condition where usb_storage
315                 claims the device before bcharge arrives on the scene,
316                 by asking the kernel to detach the driver from
317                 the Mass Storage interface... this change makes it
318                 possible to run bcharge, moving from 0006 to 0004
319                 to 0001 and back to 0004, all *while* usb_storage
320                 is loaded!
321         - changed Probe class behaviour so that it will not throw an
322                 exception on Device Busy (-EBUSY) but instead
323                 log the error in an internal array and keep going.
324                 This makes it possible to use btool and barrybackup
325                 with two devices plugged in at the same time.
326                 BACKWARD COMPATIBILITY NOTE: this changes initializaion
327                         behaviour, but in practice, it should only
328                         make applications look more capable, not less.
329         - updated btool to show errors logged by Probe
330         - added message to specify which PIN device is being used by btool
331         - added explanatory comments to udev rules files, about why
332                 they are so verbose
333 2007/11/27
334         - added ClearHalt() calls to probe and controller classes, just
335                 before any communication happens... the 8830 seems
336                 to need this
337 2007/11/23
338         - added usbwrap.cc:GetConfiguration()
339         - added code to check whether the configuration is the one
340                 we require, before calling SetConfiguration()... and not
341                 to call it if unnecessary.  This allows us to run
342                 at the same time as usb_storage.
343                 Thanks to Martin Owens for not letting this issue go. :-)
344         - added sleep to bcharge, before calling usb_reset()... the
345                 Blackberry 8830 behaves like a Pearl device in that
346                 it has mass storage support, but behaves like a Classic
347                 in that it resets itself... the usb_reset() seems
348                 to reset it back to 0006.  The sleep allows the device
349                 to disappear via its own reset, and let usb_reset()
350                 fail naturally on these devices.
351                 This is not an ideal solution... mainly for testing.
352 2007/11/09
353         - added modprobe/blacklist-berry_charge as per Simon Ruggier's
354                 suggestion.  Thanks also to Niels de Vos for a similar
355                 suggestion.
356         - fixed udev rules to work on both old and new distros
357                 Thanks to Duncan Mak for the bug report.
358         - AUTHORS update
359         - fixed string comparison to use case insensitive compare in
360                 opensync plugin
361         - updated Debian package to include modprobe blacklist file
362         - updated rpm spec file to include modprobe blacklist file
363         - split the maintenance scripts into release and test, so
364                 that release package builds can be done faster
365 2007/10/26
366         - opensync plugin fixes:
367                 - fixed memory leak in vBase::GetAttr()
368                 - added support in vformat parser to parse "blocks"
369                         and keep track of the hierarchy when
370                         parsing an iCalendar, etc.
371                 - added support for searching for attributes only
372                         inside certain blocks (i.e. find first
373                         DTSTART in VEVENT block, not VTIMEZONE block)
374 2007/10/25
375         - fixed bug in Calendar::Clear, missing the Free / Class
376                 member variables, leaving them uninitialized
377         - added examples/addcalendar.cc
378         - added more logging to the opensync plugin, logging the
379                 ToBarry conversion results
380         - added code to force struct tm.tm_isdst to -1 before calling
381                 mktime, in vformat.c
382                 - fixed typo in previous fix
383 2007/10/12
384         - renamed ktrans and translate to bktrans and btranslate to avoid
385                 file name clashes with libtranslate of Gnome
386                 Closes bug #1812410 reported by Troy Engel.
387         - version bump:
388                 - configure.ac
389                 - src/Makefile.am
390                 - src/version.cc
391                 - gui/src/BackupWindow.cc
392                 - src/Doxygen
393                 - rpm/barry.spec
394                 - debian/changelog
395                 - opensync-plugin/src/barry_sync.cc
396         - fixed missing default config file in the debian package for
397                 the opensync plugin
398                 Closes bug #1812224 reported by Ariel (adonatti).
399         - added debian dbg packages for tracing segfaults
400         - modified maintainer scripts so debug packages would reference
401                 source code located in /usr/src/barry-0.9, etc.
403 Release: version 0.9 - 2007/10/12
404 ------------------------------------------------------------------------------
405 2007/09/29
406         - adjusted autosuspend disabling code in bcharge, based on new
407                 information on how kernels 2.6.21 / 2.6.22 work.
408                 See bcharge.cc for comments.  If device/power/level or
409                 device/power/autosuspend exist, charging should now work
410                 without recompiling the kernel.
411         - updated website docs with autosuspend info
412 2007/09/27
413         - large update to the doc/www web pages, moving some of the
414                 information in README files to html format, so that it
415                 is commonly available on the web
416         - added step in maintenance scripts to automatically build the
417                 .html files in doc/www when making a tarball release
418 2007/09/22
419         - added libopensync 0.22 version requirement to barry.spec file,
420                 but it doesn't seem to work on OpenSuSE 10.2, where it's
421                 needed.... hmmmm
422 2007/09/21
423         - updated README to mention new tree build configure options
424         - fixed the configure scripts and makefiles so that when building
425                 with custom CXXFLAGS and LDFLAGS environment variables,
426                 it doesn't break the full-tree build mode, when
427                 using --enable-gui and/or --enable-opensync-plugin
428         - added config.h.in~ to buildgen.sh clean target
429         - converted Debian build scripts to use cdbs
430         - added opensync plugin binary package for Debian
431         - added "Getting Started" section to web pages, as well as an
432                 explanatory document for various system requirements
433         - turned on opensync build in RPM maintainer scripts
434 2007/09/20
435         - added filename to power/state error message in bcharge.cc
436         - adjusted maintainer scripts to automatically adjust barry.spec
437                 for opensuse rpm builds
438 2007/09/13
439         - fixed some of the release build scripts and added support for
440                 automated opensuse 10.2 builds
441                 - fixed build target to i386
442                 - changed scripts to add to PKG_CONFIG_PATH variable instead
443                         of overwriting it
444 2007/09/07
445         - added website docs to doc/www... these are out of date at the
446                 moment, and hopefully by including them here, they
447                 will be updated more frequently
448 2007/09/05
449         - applied Simon Ruggier's build system patch that allowed a build
450                 of all 3 components from the root directory and fixed the
451                 configure scripts to support external build directories
452         - reordered clean commands in the buildgen.sh scripts, and removed
453                 the INSTALL files, since they are auto-generated by autoconf
454         - removed extraneous buildgen.sh calls in maintainer scripts
455         - added Simon Ruggier to AUTHORS
456         - added explanatory note to 3 stage test build process in
457                 maintainer script
458 2007/08/24
459         - fixed Category handling in the Contact record class, to
460                 parse the comma separated string into an array,
461                 and back
462                 Note: this involves a change to the boost serialization
463                         and will affect backward compatibility with
464                         old serialization datafiles
465         - added Category to examples/addcontact.cc
466         - added Category support to the opensync plugin
467 2007/08/23
468         - fixed wrong read/write in btool output (oops)
469         - added BadSize exception, and changed CheckSize() function
470                 to throw it on error
471         - changed backup GUI to catch BadSize exceptions on initial
472                 connect, and try a reset if that error occurs, since
473                 that likely means the device didn't shutdown properly
474         - fixed in opensync plugin:
475                 - some vcard data contains types codes in capital letters,
476                         so added lower case conversion routine
477                 - changed the order of address lines, so that address1
478                         is the street, address2 is the extended address,
479                         and address3 is the PO Box.  The Blackberry
480                         doesn't seem to have any PO Box field.
481 2007/08/20
482         - added -e endpoint override option to btool
483         - added status message to endpoint override
484 2007/08/18
485         - added configure check for strnlen, and implementation for
486                 systems that don't have it, or that have it implemented
487                 incorrectly.  Went a little paranoid here, since
488                 AC_FUNC_STRNLEN doesn't set a define in config.h,
489                 so I had to do it manually, and check in case autoconf
490                 changes in the future... ugh.  See src/strnlen.h for
491                 the gory details.
492         - added code in probe.cc to fetch the device's description.
493                 The description is now part of the probe results
494                 along with the PIN.  Updates to protocol.h, adding
495                 a new attribute definition.
496                 Thanks to Rick Scott for pointing out the code in
497                 XmBlackberry where he implemented this first.
498         - fixed header dependency in record-internal.h
499         - updated the "required autoconf" version to 2.61 for root build
500         - moved nested structs out of the record classes that contain them,
501                 in order to better support SWIG and Python
502 2007/08/17
503         - changed bcharge to use getopt() for its argument processing
504         - added options -p and -s to bcharge, to adjust usb suspend
505                 settings automatically where possible
506         - updated the udev rules to use the new bcharge settings
507         - updated the bcharge man page with the new arguments
508 2007/08/16
509         - cleaned up Usb exception handling, moving libusb error code
510                 processing into the Usb::Error exception class.
511                 error.cc is now an empty shell
512         - added return codes to the Usb::Error exceptions
513         - removed aboutdialog.{h,cc} from the backup GUI since even
514                 Debian stable now has up-to-date gtkmm libraries
515         - added more user friendly error message for the "device busy"
516                 case, recommending 'rmmod usb_storage'.
517 2007/08/09
518         - added better error checking to bcharge.cc
519         - version bump:
520                 - configure.ac
521                 - src/Makefile.am
522                 - src/version.cc
523                 - gui/src/BackupWindow.cc
524                 - src/Doxygen
525                 - rpm/barry.spec
526                 - debian/changelog
527                 - opensync-plugin/src/barry_sync.cc
528         - removed usb_set_configuration() check from bcharge.cc, since
529                 that may fail under normal operation, in this case
531 Release: version 0.8 - 2007/08/03
532 ------------------------------------------------------------------------------
533 2007/08/03
534         - moved Interface implementation to usbwrap.cc file
535         - added dout debugging messages to usbwrap.cc
536         - clarified unhandled packet error message in socket.cc
537         - added temporary workaround in opensync-plugin environment's
538                 Reconnect(), for odd message seen on newer Blackberry
539                 devices
540         - fixing issues with Brian Edginton's MessageRecord patch (2007/06/29)
541                 - fixed missing size check in message oriented ParseHeader()
542                 - fixed endian conversion issues (also found one pre-existing
543                         endian bug in the process)
544                 - moved message timestamp converter code to time.cc
545         - added Barry version number to opensync plugin name
546         - changed maintainer scripts and rpm.spec to use bzip2 instead of gzip
547         - added opensync-plugin to configure script build
548         - added -S option to btool, to list supported parsers and builders
549         - slight change to opensync-plugin/buildgen.sh to cleanup config.h.in~
550         - opensync-plugin/README update
551         - added opensync-plugin/patches for others who may be building and
552                 testing the plugin with OpenSync 0.22
553         - added debian package build scripts to maintainer/
554 2007/08/01
555         - added entry to doc/TroubleShooting.txt
556 2007/07/28
557         - added doc/TroubleShooting.txt
558 2007/07/27
559         - opensync plugin:
560                 - fixed bug in vcard.cc that was using the FN field
561                         for the broken-down name instead of N
562                 - added dbId and dbName to DatabaseSyncState
563                 - added Reconnect() functionality to BarryEnvironment class
564                         and moved connect logic out of barry_sync.cc
565                 - changed the batch commit functionality in barry_sync.cc
566                         to single-change-commit.  Why?  Because opensync
567                         0.22 groups all batch changes into one group
568                         and calls one batch commit function, even if you
569                         registered two.  Moving to single change commit
570                         mode removes a chunk of unneccessary code
571                         from the plugin as well, and can in theory
572                         ease memory pressure in the library.
573                 - added FinishSync() to perform actions needed on successful
574                         syncing completion
575                 - disconnect on successful sync completion, and reconnect,
576                         since the device's dirty flags don't seem to
577                         be updated until a disconnect occurs.
578 2007/07/26
579         - added ReadDataArray() to data.h, using an istream instead of
580                 requiring a file
581         - added raw data version of BuildField() to record-internal.h
582                 This is so that btool doesn't add extra null terminators
583                 to unknown data, when restoring with option -s
584         - fixed bugs in r_contact.cc:
585                 - fixed bug that caused a LastName/FirstName swap
586                         if FirstName was empty and you wrote a contact
587                         record into the device.... First/Last Name
588                         fields are position sensitive, and the code
589                         was missing the empty FirstName case on writing
590                 - fixed bug in BuildFields() and Dump() where they
591                         were not updated to handle the new field
592                         table added for the postal address changes
593                         on 2007/07/20, oops
594         - opensync plugin:
595                 - changed the plugin config file, so it is possible to
596                         turn debug output on/off without recompiling
597                 - moved the standalone Map2Uid() function into
598                         the DatabaseSyncState class, and changed the
599                         code to produce "contact-#" and "calendar-#"
600                         UID strings, instead of just numbers
601                 - changed default PIN to -1, so that if the user doesn't
602                         configure properly, it will fail... this is a
603                         safety measure to avoid syncing with different
604                         devices and corrupting the cache/idmap...
605                         this should be fixed someday, to handle this
606                         automatically
607                         On second thought... is this right?  Perhaps
608                         it is better to fail if the PIN is not what
609                         is expected, so a user doesn't accidentally
610                         sync the wrong device and lose data.
611                         Actions to take on new PIN:
612                                 - force slow_sync, or
613                                 - fail
614                 - incorporated the new VCardConverter code into the
615                         main barry_sync.cc plugin code
616                 - fixed bug that did not clear the devices dirty flags
617                         in the case where a sync only read data from it,
618                         and didn't write
619                 - changed PIN error message number to hex
620 2007/07/20
621         - minor wording change in backup GUI prompt: "Backup working..." to
622                 "Backup in progress..."
623         - renamed Contact class's Title field to JobTitle for clarity
624         - added record function ParseFieldString(), which properly handles
625                 strings from the device that have multiple null terminators,
626                 and changed the record parsing code to use this new function
627         - moved FullName() function from ldif.cc to r_contact.cc since it
628                 is generally useful in areas outside of LDIF processing
629         - refactored postal addresses in the Contact record class into
630                 a new class called PostalAddress
631         - renamed Address class in record.h to EmailAddress
632         - moved Contact::GetPostalAddress() to record.cc as part of the
633                 new PostalAddress class and renamed it
634                 PostalAddress::GetLabel()
635         - opensync plugin:
636                 - refactored vformat helpers into separate base class
637                         called vBase
638                 - added vCard converter class
639                 - commented out the code that skipped over the adding
640                         of empty attribute values and parameters,
641                         since VCARD depends on some of this behaviour
642                 - movified vformat.c:vformat_find_attribute() to take
643                         an extra nth argument, in order to search
644                         for multiple attributes with the same name...
645                         the way this is coded is a bit inefficient...
646                         but we're moving away from vformat when we move
647                         to OpenSync 0.3x / 0.40, so this is just temporary
648                         pain
649 2007/07/19
650         - added SUBSYSTEM=="usb_device" to example udev rules, in order
651                 to avoid running bcharge for each endpoint that is
652                 added by udev, when first plugged in.  Running bcharge
653                 back-to-back multiple times can crash some
654                 Blackberries.
655 2007/07/14
656         - opensync plugin:
657                 - fixed ID mapping bug in the case of a non-numeric UID
658                         from syncing external -> Barry, and then the
659                         new Barry ID would look like a new change
660                         when syncing back from Barry -> external.
661                 - added support for slow sync
662                 - added clear() to idmap class
663                 - added vformat attr parameter extraction class
664                 - added more trace logging during vformat/Barry conversions
665                 - added Notification time support
666                 - handled "all day" vformat special case, when DTEND
667                         does not exist in a vformat data block
668         - changed the min1900_t time conversion functions to handle
669                 the 0xffffffff special case, when notifications
670                 are turned off on a calendar event (src/time.cc)
671         - also made the calendar data dump output clearer for
672                 disabled timestamps, and added debug output
673                 for the raw min1900 value, in case there are more
674                 special cases in the future
675 2007/07/13
676         - fixed null pointer access in opensync's HasMultipleVEvents()
677 2007/07/12
678         - upper management directive: revert all OpenSync 0.3x changes
679                 and proceed with OpenSync 0.22.  Reverting the
680                 opensync-plugin/src tree to Barry 0.7 status.
681 2007/07/06
682         - reorganized exception and trace code in opensync plugin
683         - added XmlToCalendar() function, based on unfinished opensync
684                 library API that is not yet finished... will be
685                 committed to opensync svn tree when complete
686         - added OSyncXMLField logger to plugin trace class
687 2007/06/29
688         - applied email MessageRecord patch from Brian Edginton (thanks!)
689         - updated Message::Dump() to output more valid mbox data...
690                 the goal is to be able to do:
691                         btool -d "Messages" > email.mbox
692                         mutt -f email.mbox
693         - changed some TODO's to FIXME's to keep it grep-consistent
694         - applied Folder support patch from Brian Edginton
695         - fixed pedantic compile warnings, and changed order in src/Makefile.am
696         - removed unneeded cast in src/r_folder.cc
697 2007/06/28
698         - minor adjustment to ctags building in buildgen.sh
699         - applied patch from Brian Edginton for better boost detection
700                 in configure.ac
701         - added boost usage message to btool -h output
702 2007/06/21
703         - more porting of OpenSync module to 0.30
704         - added ctags build for opensync source tree to buildgen.sh
705 2007/06/14
706         - changed PKG_CONFIG_PATH setting in rpm script, so that systems
707                 like SuSE that have an extensive PKG_CONFIG_PATH
708                 in general use will not break on build
709         - added PKG_CONFIG_PATH to debian script too, just in case :-)
710         - added debian/changelog to doc/ReleaseChecklist.txt
711         - added comment to rpm/barry.spec regarding SuSE RPM builds
712 2007/06/08
713         - applied patch from Niels de Vos fixing debian package build
714                 dependency
715         - applied Brian Edginton's Saved Email Messages patch
716         - updated r_saved_messages.cc comment to match header
717         - added GetRecType()/GetUniqueId() to r_saved_messages.h, since
718                 SetIds() is already there
719         - removed Address version of operator<<() from message related headers
720                 and moved into record.h
721         - added std::hex to message related dumps, and changed output to
722                 be more mbox-like
723         - updated doc/CodingStyle.txt to cover switch() statements
724         - opensync compiles again, with 0.30!  (not functional yet)
725                 - moving closer to more modular and reusable plugin functions
726         - updated release checklist for opensync version number
727 2007/06/07
728         - added doc/CodingStyle.txt... preliminary version
729 2007/06/06
730         - applied Brian Edginton's PIN message patch
731         - changes to PIN message patch:
732                 - fixed missing backslash in src/Makefile.am
733                 - fixed tab alignment throughout
734                 - removed typedef from Address struct
735                 - added clear() to Address... might as well, if it it is
736                         going to be a standalone type
737                 - fixed missing comma in PINMessageFieldLinks table
738                 - changed MessageRecordId in PINMessage to load from a new
739                         uint32_t field in CommonField, instead of piggy
740                         backing on a field for other use
741         - did some testing and found that PINMessage's MessageRecordId
742                 is the same as the RecordId given through the SetIds()
743                 API... but these Id's are duplicated in the protocol...
744                 RecordId is stored in the protocol header, while
745                 MessageRecordId is stored in the record it self as
746                 a common field... added RecType and RecordId to
747                 PIN Message so that we store both of these
748         - updated AUTHORS
749 2007/05/27
750         - added item to gui/TODO
751         - applied Brian Edginton's s11n-boost.h patch
752 2007/05/25
753         - renamed template values to more consistent naming scheme
754         - applied memos and tasks patch from Brian Edginton, slightly
755                 modified to split into the new separate files system
756         - changes to memos and tasks classes:
757                 - reformatted the code to match coding style
758                         (come on Brian) :-)
759                 - added copyright notice
760                 - changed class to singular (Memo, not Memos)
761                 - placed in Barry namespace
762                 - added #ifdef header protectors
763                 - added new files to Makefile.am
764                 - added new r_*.h headers to record.h
765         - added support for Memos and Tasks to tools/btool.cc, based on
766                 Brian Edginton's patch
767                 (currently commented out, for Boost library reasons):
768         - added doc/CommitPolicy.txt
769         - updated AUTHORS
770 2007/05/24
771         - added ctags generation to buildgen.sh
772         - applied record.{h,cc} fix patch from Brian Edginton
773                 - ClassFlag
774                 - FreeBusyFlag
775                 - Clear() fixes
776         - fixed broken formatting in above patch
777         - refactored record parser classes into separate files for each
778         - changed the ConvertHtoB<> template to inline, as it caused
779                 linker errors with the new file layout
780 2007/05/17
781         - fixed bug in Debian packaging that put util commands in
782                 /bin and /sbin instead of /usr/bin and /usr/sbin
783         - commited byteswap.h replacement code from gm2net
784         - backup gui:
785                 - removed unneeded debug messages on stdout
786                 - changed the default for debug output to "off"
787                         and added a command line option to turn
788                         it on if necessary  (--debug-output)
789                 - command line option --help now also works
790         - fixed bug in Calendar class where it didn't initialize
791                 RecType properly... and cleaned up other RecType
792                 code to use the GetDefaultRecType() functions,
793                 localizing the constants in one place
794 2007/05/11
795         - applied patches from Brian Edginton, parsing more
796                 fields in Contact and Calendar records
797         - added Brian Edginton to AUTHORS
798         - reformatted record.{h,cc} to match the rest of the code,
799                 removed commented out code, and removed mention of
800                 Outlook from the comments.
801         - updated udev/10-blackberry.rules.Debian for Debian Etch
802         - updated debian/rules to use new udev rules file
803         - removed debian/postinst, as stable versions of Debian now
804                 have a recent udev, and don't need the special handling
805         - updated Debian build scripts to build separate packages:
806                 libbarry
807                 libbarry-dev
808                 barry-util
809                 barrybackup-gui
810         - added menu support to Debian barrybackup-gui package
811         - made the buttons bigger in the backup GUI, as they were too
812                 small on Debian Etch
813         - opensync plugin:
814                 - more progress in porting to opensync 0.30, heavily
815                         based on the example plugin in the opensync
816                         svn tree...  this is a work in progress, and so far
817                         is incomplete
818 2007/05/04
819         - opensync plugin:
820                 - partial porting to opensync 0.30 (in progress!)
821                 - fixed bug in sync_done where it reported context error
822                         and then success afterward
823         - checking in new INSTALL files based on Etch's autoconf run
824         - added item to gui's todo list
825         - bumped version numbers to 0.8 in:
826                 - configure.ac
827                 - src/Makefile.am
828                 - src/version.cc
829                 - gui/src/BackupWindow.cc (about dialog)
830                 - src/Doxygen
831                 - rpm/barry*.spec
833 Release: version 0.7 - 2007/05/02
834 ------------------------------------------------------------------------------
835 2007/05/02
836         - added rpm building to maintainer/release scripts
837         - added "HEAD" feature to tarball creation script, for easier testing
838         - updated maintainer/README
839         - updated maintainer/release.sh to use new HEAD feature too
840 2007/05/01
841         - added pppob to rpm barry.spec
842         - bumped release number in barry.spec
843 2007/04/30
844         - opensync plugin:
845                 - fixed size check bugs (strlen() == 0 when empty)
846                 - finished refactoring calendar conversion routines
847                 - started timezone parsing, but this may go away
848                         if we use opensync 0.30's time functions and
849                         xml data format...
850                 - added development note to README
851 2007/04/29
852         - updated README and opensync-plugin/README with more current
853                 build instructions
854         - opensync plugin:
855                 - refactored some calendar conversion routines
856                 - added Barry->vCalendar conversion for recurring appointments
857 2007/04/27
858         - opensync module:
859                 - removed some unneeded trace logs
860                 - fixed VEventConverter constructor bug, with uninitialized
861                         m_Data pointer
862                 - eased up the requirement that every calendar event
863                         must have a summary... defaults to "<blank subject>"
864                         if empty
865                 - added more VCALENDAR fields to match Barry::Calendar record
866                 - fixed case sensitive compares in vformat.c
867 2007/04/26
868         - opensync module work:
869                 - added id map class to map string uid's from OpenSync to
870                         numeric ID's from the Blackberry
871                 - fixed bug in CommitChange() where it was still using
872                         a hard coded calendar record state table
873                 - added lots of logging throughout
874                 - fixed bug where newly added records didn't use the
875                         change object's uid, but created a new ID,
876                         causing another sync on the next run
877                         i.e. (CommitData_t was missing an argument)
878                 - fixed bug where uninitialized notification time was
879                         written to the Blackberry
880         - more opensync module work:
881                 - refactored the environment class into another subclass
882                         called DatabaseSyncState, and moved some stand-
883                         alone functions from barry_sync.cc into
884                         the environment classes
885                 - added a tagged constructor to the trace class
886                 - fixed idmap::Load() to clear map before loading
887 2007/04/20
888         - renamed barry-config to barry-sync, the default configuration
889                 file for the opensync module... and filled it with
890                 a sample configuration
891         - added code to update the calendar cache, and write it to disk
892                 on success (opensync module)
893         - added code to clear dirty flags in the device (opensync module)
894         - allowed comments in the config file
895         - added vformat.c from libopensync 0.22, since the vformat
896                 routines are not available from the plugin side
897 2007/04/19
898         - updated gui/TODO
899         - added -d switch to bcharge to switch back from 0001 to 0004 mode,
900                 changed the auto-detection logic to ignore iProduct and
901                 only use idProduct, and updated man page
902         - updated breset to recognize the Pearl in 00004 mode as well
903         - changed src/probe.cc logic to assume that the second endpoint
904                 pair is the one needed for database communication, instead
905                 of doing a reverse search from the end... newer Pearls
906                 in Dual mode seem to have at least 3 or 4 endpoint pairs,
907                 and the old search didn't always work
908         - applied sourceforge patch #1696884 from Peter Silva, updating
909                 the Debian build for Etch, and including all files in one deb
910         - added Peter Silva to AUTHORS file
911         - uncommented the "make distclean" in debian/rules, and removed
912                 the reliance on /tmp when installing 99-barry-perms.rules
913         - applied bb_task_format.txt patch from Peter Silva
914         - fixed each misspelling of "recurrance" to "recurrence"
915         - tweaked src/probe.cc again for paranoia's sake... start at
916                 offset 1 if more than 1 endpoint pair, otherwise start
917                 search at 0
918         - split up opensync module into multiple source files, and started
919                 using the opensync vformat routines for parsing and building
920                 the vevent20 data (experimental)
921 2007/04/04
922         - more incremental work on the opensync plugin, adding ADDED
923                 and MODIFIED functionality... (experimental!)
924 2007/03/30
925         - added code to dump extra descriptors during device discovery,
926                 if found
927         - bumped opensync version number in configure.ac, and made
928                 the configure scripts more consistent with the rest
929                 of the project
930         - fixed printf-format size bug in opensync module
931 2007/03/29
932         - applied patch from Niels de Vos, fixing deb udev rules for Pearl
933         - updated AUTHORS
934         - fixed extra space bug in LDIF output (added space when creating
935                 FullName, even if there was no last name)
936         - fixed Address Book record parsing in Contact class... the
937                 Blackberry database uses field id 0x20 for both the
938                 first and last names, and if only a last name exists,
939                 the first name will be empty.  Fixed parser to handle
940                 this special case, without relying on string length.
941                 Thanks to Troy Engel for reporting above two LDIF bugs.
942         - added a few more constants to bcharge.cc
943         - renamed opensync's configure.in to configure.ac
944 2007/03/17
945         - fixed bcharge to avoid endless reset loop... oops
946 2007/03/16
947         - reorganized bcharge.cc to make it possible to switch between
948                 Pearl modes 0004 and 0001
949         - added flag to BadPassword exception class, to signal whether
950                 the library considers the device "out of retries" or not
951         - updated socket.cc for new BadPassword exception
952         - added special case to Controller class destructor to reset the
953                 device if being destroyed in a half-open state... this is
954                 a temporary fix until we understand how to handle
955                 the "already open" message we get when opening the Desktop
956                 in some cases
957         - added password prompt dialog to the backup GUI
958         - fixed possible memory leak in GUI's DeviceInterface::Connect()
959 2007/03/08
960         - committed Troy Engel's bbrules_mass_symlinks.patch, fixing
961                 udev rules for the Pearl
962         - updated 10-blackberry.rules.Debian to match 10-blackberry.rules's
963                 functionality
964         - applied Troy Engel's barry.spec patch to generate all required
965                 RPM's... Thank you!  Notes in the README taken from
966                 the sourceforge tracker entry containing the patch.
967         - added libusb lib flags to tools/ and examples/ makefiles,
968                 and tweaked configure.ac with a better default,
969                 to build cleanly on RHEL 4
970         - modified rpm/barry.spec:
971                 - does not create doc-only barry base package anymore
972                 - fixed "barry-backup" typo
973                 - removed the patch step, as version 0.7 shouldn't need it
974                 - added license file to each package
975                 - commented out console perms scripts, pending mailing list
976                         discussion
977         - updated AUTHORS
978         - applied Troy Engel's barry.spec patch to fix RHEL4 compile issues
979         - fixed 80 column wrapping error in barry.spec, thanks to Troy Engel
980                 for the bug report
981         - applied Troy Engel's udev permissions patch for Redhat/Fedora
982                 systems, which automatically set the ownership of a
983                 newly plugged in device to the currently logged in console
984                 user.
985         - added udev/README to document what all those files are for...
986                 part of the text comes from the sourceforge comment
987                 on the above udev permissions patch from Troy Engel
988         - uncommented the console perms scripts for rpm/barry.spec
989         - added libglademm-2.4 to gui/README's dependency list
990         - made usbwrap.* calls more threadsafe
991         - added Usb::Timeout exception for timeout errors
992         - added preliminary UsbSerData support to library for GPRS modem
993                 functionality, using Rick Scott's XmBlackBerry's serdata.c
994                 as a guide
995         - added overloaded Socket::Send() for sending without receiving
996         - added preliminary pppob command line tool
997 2007/03/02
998         - version bump in:
999                 - configure.ac
1000                 - src/Makefile.am
1001                 - src/version.cc
1002                 - gui/src/BackupWindow.cc (about dialog)
1003                 - src/Doxyfile
1004                 - rpm/barry.spec
1005         - build system tweaks for opensync-plugin, and added a buildgen.sh
1006                 for it
1007         - added better debug messages in probe.cc and usbwrap.cc's
1008                 device discovery code
1009         - changed error handling for null interface->altsetting pointers
1010                 when doing device discovery in usbwrap.cc.  Seems that
1011                 some devices report a higher number in bNumInterfaces
1012                 than are really available... in this case, let's
1013                 just ignore the missing data and assume success
1014         - applied udev script patch #1663986 from Troy Engel
1015         - applied barry-bcharge.spec patch #1672178 from Troy Engel
1016         - ReleaseChecklist update
1017         - added rpm/README based on Troy Engel's patch notes
1018         - updated new barry-bcharge.spec for version 0.7, removing patch
1019                 dependency
1021 Release: version 0.6 - 2007/02/28
1022 ------------------------------------------------------------------------------
1023 2007/02/28
1024         - fixed size checks for device database records larger than 64K
1025                 Thanks to Michael Brown for the bug report.
1026         - added initial release maintainer scripts
1027         - fixed odd backup success message in GUI when doing a backup with
1028                 no databases selected in configuration
1029                 Thanks to Michael Brown for the bug report.
1030         - added udev permissions file patch from Michael Brown
1031         - added Michael Brown to AUTHORS
1032         - updated README, gui/README, and doc/USB-capture.txt
1033         - added -o command line switch to bcharge.cc, and updated man page
1034 2007/02/23
1035         - changed library behaviour so it only turns on libusb debug output
1036                 if in data dump mode.  In btool, -v controls this output.
1037         - minor stream formatting fix in btool
1038         - added OpenSSL dependency to build for password hash support
1039         - made debug dout() output conditional on Init() flag... In btool,
1040                 -v now controls this as well
1041         - reverse engineered more of the initial probe packets, and
1042                 implemented probing in struct based code... changes include:
1043                 - added support for "attribute fetch" packets, used at
1044                         the beginning of USB conversations
1045                 - defined object/attribute id codes for the PIN number
1046                 - made Protocol::SocketCommand more robust, and implemented
1047                         its sequence number behaviour
1048                 - moved ModeSelectCommand into SocketCommand, as it is a
1049                         socket 0 level command
1050                 - added initial protocol struct: PasswordChallenge
1051                 - renamed Barry::Packet to DBPacket
1052                 - added ZeroPacket for socket 0 packet creation and analysis
1053                 - Barry::Packet is now the base class for the above
1054                 - implemented socket 0 behaviour in socket.cc
1055                 - changed return values for Send/Receive/Packet/NextRecord
1056                         members in the Socket class from bool to void, as they
1057                         don't generate errors themselves, but only can
1058                         have an error if Usb::Device throws an exception.
1059                         Cleaned up all code that called these members as well.
1060                 - removed "last status" from Socket class as it was unused
1061                 - updated probe.cc to use new socket 0 implementation
1062                 - removed two of the hard coded packet handshakes in favour
1063                         of socket 0 packets
1064                 - updated controller.cc:
1065                         - uses new socket 0 implementation
1066                         - removed "flag" hack when opening sockets and
1067                                 selecting modes, as it should use the
1068                                 socket 0 sequence number
1069         - added initial, incomplete prototype header for the C API
1070         - updated some .cvsignore files
1071         - updated TODO
1072         - updated ReleaseChecklist.txt, adding rpm spec file
1073         - added the following to ZeroPacket:
1074                 - ChallengeSeed()
1075                 - RemainingTries()
1076                 - SocketResponse()
1077                 - SocketSqeuence()
1078         - moved Command() to base Packet class
1079         - added comments to protostructs.h and size constants for the
1080                 new PasswordChallenge struct
1081         - added password support to Socket and Controller classes
1082                 Thanks to Rick Scott's XmBlackBerry for the openssl
1083                 password hashing logic.
1084         - updated btool to use new password support, and updated its man page
1085 2007/02/22
1086         - updated Doxygen input files and version, and added to ReleaseChecklist
1087         - fixed btool PIN output for LDIF mode, now commented in output
1088         - major LDIF overhaul:
1089                 - split LDIF specific code out of the record class and
1090                         into its own
1091                 - fixed "full name" behaviour that added an extra space
1092                         in dn attributes, as reported by Troy Engel
1093                 - added support for mapping of LDIF attributes to Barry
1094                         contact field names
1095                 - fixed base64 handling, so attributes are only so encoded
1096                         if necessary
1097                 - fixed base64 attribute reading inconsistency... some
1098                         notes fields were missed in old version if not
1099                         encoded
1100                 - added support for specifying alternate attribute for
1101                         constructing a FQDN, instead of just "cn"
1102                 - updated btool and upldif to use new features
1103         - large update to btool manpage
1104         - fixed initialization bug in Contact constructor (missed RecType)
1105 2007/02/15
1106         - added ktrans.cc to make reading of kernel usbfs_snoop logs easier
1107         - removed commented code from translate.cc
1108         - added Pearl handshake support to bcharge.cc, which resets the
1109                 Pearl so that the vendor specific 0xFF class exists.
1110                 This should allow use of btool on the Pearl.
1111         - added Data::AppendHexString to data.cc
1112         - added better probing support for the Pearl, so it detects the
1113                 Product ID 0x0004 mode, and does a search for class 0xFF
1114                 instead of hardcoding it.
1115 2007/02/10
1116         - applied README patch from Ian Darwin
1117         - minor tweaks to README
1118         - added missing errno.h header in src/usbwrap.cc for AMD64
1119                 Thanks to Jonathan Hudson for reporting the bug.
1120         - tightened up size checks in Data::ReleaseBuffer()
1121         - stable libusb *does* return the actual length of the USB packet...
1122                 fixed this in usbwrap.cc to set the actual size of read data,
1123                 and removed the size hacks elsewhere in the code:
1124                 probe.cc, protocol.cc, socket.cc, usbwrap.cc
1125 2007/02/09
1126         - added proper return codes for error conditions in btool.cc
1127         - clarified some stream output code in the library, for hex/dec numbers
1128         - removed old, non-working connect.cc test program
1129         - added iomanip to debug.h
1130         - changed usbwrap to call libusb again if EINTR and EAGAIN
1131                 This should fix one of the OpenBSD issues
1132 2007/02/04
1133         - updated AUTHORS
1134         - fixed bug in barrybackup GUI that didn't create the target path
1135                 if the user didn't do Edit | Config first.
1136                 Thanks to Ian Darwin for reporting the bug.
1137         - applied gui/src/ConfigFile.cc header fix patch for OpenBSD
1138                 from Ian Darwin
1139 2007/02/03
1140         - added initial btool.1 man page from Ian Darwin
1141         - updated man/Makefile.am for new btool.1
1142         - updated AUTHORS
1143         - applied btool -h help clarification patch from Ian Darwin
1144 2007/02/02
1145         - reworked exception hierarchy, so applications can handle all
1146                 Barry related exceptions, including Usb errors, with
1147                 one base class: Barry::Error
1148         - fixed all the ripple changes this caused throughout the codebase
1149         - added BadPassword exception
1150 2007/02/01
1151         - version bump in:
1152                 - configure.ac
1153                 - src/Makefile.am
1154                 - src/version.cc
1155                 - gui/src/BackupWindow.cc (about dialog)
1156         - updated doc/ReleaseChecklist.txt
1157         - added usb-level breset.cc command line tool
1158         - fixed bug in gui/src/tarfile.* for systems where
1159                 sizeof(int) != sizeof(void*)
1160                 - TarFile class now uses a plugin style for the compression
1161                         operations, to allow for threadsafe versions if needed
1162                         in the future.
1163                 - also fixed leaked file handle bug in open_compressed()
1164                 - Thanks to Jonathan Hudson for reporting this for 64bit systems
1165         - minor signed comparison fixes in the library
1166         - added better protocol data dumping code in probe.cc
1167         - added Usb::Device::BulkDrain(), to prevent Barry from hanging
1168                 due to pending reads
1170 Release: version 0.5 - 2007/01/26
1171 ------------------------------------------------------------------------------
1172 2007/01/26
1173         - added missing errno.h header to gui/src/util.cc
1174         - lots more endian fixes after testing on iMac  
1175         - iostream output size fixes
1176         - added option to btool to reset the device via software
1177         - beefed up exception handling in barrybackup
1178         - checked in opensync work-in-progress: trace logging, pointer bugfix
1179                 this is still experimental
1180         - added aboutdialog.* files from gtkmm24 2.10.6, so we have a dialog
1181                 class for systems running older versions of gtkmm, like
1182                 Debian stable
1183         - uncommented the about box menu handler
1184         - added "cleanall" option to root buildgen.sh script
1185         - update ReleaseChecklist.txt
1186         - removed CVS auto-history strings from aboutdialog.*
1187 2007/01/25
1188         - found a link between the unknown field in tagged protocol headers
1189                 and the unknown field in RecordStateTable entries.  This
1190                 field matters when uploading certain databases, such as
1191                 Browser Options.  It is unknown what this field really
1192                 means, but we're calling it RecType.  Updated the API
1193                 to use this in all parser objects and builder objects
1194                 and record objects that use it.
1195         - changed some uses of uint64_t to uint32_t, in Contact and
1196                 Calendar record objects... unique IDs only seem to be
1197                 32 bits
1198         - added new static function to record classes: GetDefaultRecType()
1199                 This returns the default rectype that should work
1200                 for that record.  Ideally this should be retrieved from
1201                 the device, but in the case where a database has no
1202                 records, this info would be good to know.
1203         - updated convenience template function Controller::AddRecordByType()
1204                 to use GetDefaultRecType()
1205         - documented the recurrence data and how to use it in Calendar objects
1206         - added data debug output for incoming USB packets in the
1207                 socket class... when we ported to the stable libusb
1208                 we lost some of the verbose output... this should get it
1209                 back.  (In the official release, you need to uncomment
1210                 ddout() in debug.h for the full blast of debug output).
1211         - backup GUI updates:
1212                 - changed error_done signal into a pure error signal,
1213                         and changed the logic so the restore continues
1214                         even if there was a protocol error on one database
1215                 - changed status bar messages to show what's happening
1216                         i.e. Backup or Restore
1217                 - default to not restore the "Handheld Agent" database as
1218                         it appears to be read-only on the device
1219                 - added temporary Restore & Backup mode for debugging
1220                 - added extra hyphen to backup files to show date/time better
1221                 - updated GUI to save and restore the new RecType field
1222                         supported now by the library
1223 2007/01/21
1224         - added future considerations to doc/ReleaseChecklist.txt
1225         - applied big endian patch from Jonathan Hudson
1226         - changes to patch:
1227                 - removed endian.h include from barry.h, since applications
1228                         using the library should not care about endianness
1229                 - hard coded the path to config.h in endian.h
1230                         so that endian.h never makes it into the final
1231                         install
1232                 - removed DEFAULT_INCLUDES setting from src/Makefile.am
1233                         for the same reason
1234                 - removed config.h dependency in btool.cc and used library
1235                         Version call instead
1236         - added big/little endian text to the Barry::Version call
1237         - updated AUTHORS
1238         - fixed install location of bcharge when building with ./configure;
1239                 now goes to sbin/ for both source compile and binary packages
1240                 Thanks to Jonathan Hudson for reporting this bug.
1241 2007/01/20
1242         - added smarter timeout values to controller, and allowed
1243                 timeout overrides in the packet, socket, and usbwrap code...
1244                 extra timeouts are needed for erasing databases for
1245                 some older devices
1246         - added an explicit DataDumpParser class to btool.cc, as the
1247                 library doesn't always have extreme verbose debugging on...
1248                 this makes sure anyone can always get raw database packets
1249                 through btool, for development
1250         - added thread callback signals for error finishes and erase_db
1251                 operations, so the GUI is updated properly
1252         - more GUI cleanups (status bar updates, etc)
1253         - finished implementation of GUI restore
1254         - fixed gtkmm/glibmm exception handling when the exceptions
1255                 occur in sigc signal handlers... in that case,
1256                 exceptions need to be handled with
1257                 Glib::add_exception_handler()
1258         - added filename-only reading support to TarFile class
1259         - added pending gui/TODO items
1260 2007/01/19
1261         - backup GUI now properly shows progress
1262         - the buttons become insensitive when backup is busy
1263         - refactored directory check code, and added mkdir check
1264                 when to the backup setup (so the directory exists
1265                 when we try to write to it)
1266         - updated code to use Barry::Data in new namespace
1267 2007/01/18
1268         - moved Data class into Barry namespace
1269 2007/01/13
1270         - updated copyright dates for the new year
1271         - clarified exception message in controller.cc
1272         - fixed pointer initialization bug in controller.cc
1273         - added documentation comments to parser.h and builder.h
1274         - updated ReleaseChecklist.txt
1275         - updated README
1276         - changed Barry library configure scripts to make better
1277                 use of pkg-config for autodetecting dependencies
1278         - added initial Barry Backup GUI (gui/ directory), capable of making
1279                 backups only at this point
1280 2007/01/11
1281         - added doc/ReleaseChecklist.txt
1282         - added version API, returning version number and string
1283         - added Troy Engel to AUTHORS
1284         - added special case to bcharge.cc for the Blackberry Pearl,
1285                 which doesn't reset itself after the charge handshake
1286                 Thanks to Troy Engel for testing.
1287 2007/01/05
1288         - added pkg-config support for the library (libbarry-0.pc.in)
1289         - fixed compile error on g++ 3.3 systems (missing stdint.h
1290                 in probe.h)
1291         - fixed protocol hang at end of Controller operation... in
1292                 controller destructor, it was deleting the USB interface
1293                 before closing the socket at the BlackBerry level, thereby
1294                 leaving the device in Desktop mode
1295 2007/01/04
1296         - support the newer udev packages on Ubuntu, which need slightly
1297                 different rules
1298         - modified bcharge.cc to search for Pearl devices too.
1299                 USB product ID 6
1300         - added Pearl product ID to probe code, but likely not functional
1301                 yet until we find someone able to get a USB capture for us
1302 2006/12/29
1303         - version bump in configure.ac and src/Makefile.am
1305 Release: version 0.4 - 2006/12/29
1306 ------------------------------------------------------------------------------
1307 2006/12/29
1308         - added bcharge.cc to the tools/ directory (whoohoo!)
1309         - added initial release version of rpm/barry.spec (aka bcharge.spec)
1310                 This begins the barry binary release, currently only
1311                 including the bcharge utility, but possibly more in
1312                 the future.  Future binary packages will likely include
1313                 libbarry, libbarry-devel, etc, which barry will then
1314                 depend on.
1315         - added udev rule script for BlackBerry devices
1316         - added man/ directory and bcharge.1 manpage
1317         - added debian/ directory for building deb packages, with initial
1318                 package scripts
1319         - added rpm/make-rpm-tarball.sh for building RPMs
1320         - split out technical docs into separate libbarry.docs file for
1321                 a future Debian install
1322         - added more cleaning to buildgen.sh
1323         - added new udev rule file for Debian stable
1324         - hardcoded g++ to 3.3 in debian/rules as I have multiple versions
1325                 on my system and need to compile releases with stable
1326 2006/12/21
1327         - ported Barry to use the stable branch of libusb
1328                 NOTE: no longer depends on the devel libusb tarball!
1329                         Just use your distro's libusb packages.
1330         - fixed more endian issues
1331         - minor update to TODO
1332 2006/12/15
1333         - moved Exceptions, Hacking, and VersionNotes to doc/
1334         - added doc/USB-capture.txt
1335 2006/12/08
1336         - added Controller::AddRecord() and template helper
1337         - added beginning version of generic RecordFetch<> template
1338         - set default of Barry::Init() to false (no data dump mode)
1339         - added examples/ directory, with first addcontact.cc example
1340 2006/12/07
1341         - added autoconf support based on Peter McAlpine's patch
1342         - renamed Makefiles to Makefile.orig and added script to turn
1343                 on old build system if wanted
1344         - fixed boost-specific error path in btool
1345         - moved platform specific code out of time.h and into time.cc
1346         - moved btool.cc, translate.cc, and upldif.cc out of src/ and
1347                 into their own tools/ subdirectory
1348         - added NEWS file to make autotools happy
1349         - added a "clean" option to the buildgen.sh script... maintainer's
1350                 use only
1351         - reworked autoconf and automake files, to support
1352                 barry as a library, to move the programs into their
1353                 own tools directory, and support a proper installation
1354         - fixed headers in parser.h, btool.cc, and upldif.cc to work
1355                 properly when installed standalone
1356         - added tools/Makefile.plain for testing compiling against
1357                 installed barry library
1358         - added commentary on version number system
1359         - removed Makefile.conf and Makefile.orig, as new autoconf
1360                 system supercedes it
1361         - added support for boost serialization library in autoconf build
1362         - added library version number to autoconf build
1363         - changed boost flag to __BARRY_BOOST_MODE__ to avoid collisions
1364         - removed debug.h dependency from btool.cc
1365         - removed libusb check in favour of specific --with-libusb
1366                 option... may need to revisit this later
1367         - quick installation update in README
1368 2006/12/01
1369         - fixed some missed endian conversions in record.cc and added
1370                 some size checks
1371         - fixed endian issues in time.h
1372         - added 2 more functions to the time zone API, and adjusted
1373                 the time zone table for better defaults in North America
1374         - added btool and upldif to the make install sequence
1375         - added support for Calendar recurrence data
1376         - small doc/TimeZones.txt update
1377 2006/11/24
1378         - added BlackBerry time zone code list, reverse engineered from a 7750
1379         - added GetTimeZone() to convert device time zone codes to useful data
1381 Release: version 0.0.3 - 2006/11/24
1382 ------------------------------------------------------------------------------
1383 2006/11/23
1384         - added return code check to Controller::SaveDatabase()
1385         - fixed Data() class constructor, so it doesn't auto-convert
1386                 from any int
1387         - fixed size checking bug in Packet::ReturnCode() that caused
1388                 uploading to device to fail
1389 2006/11/10
1390         - added Exceptions doc file, documenting the C++ exceptions used,
1391                 and their hierarchy
1392         - fixed small bug in 'make install' which didn't build first
1393         - minor documentation and cleanup in upldif.cc
1394         - added utility functions to the RecordStateTable class,
1395                 GetIndex() and MakeNewRecordId()
1396         - changed btool so that the -d command modifiers can be
1397                 specified multiple times to work with multiple records
1398                 at once
1399         - added Calendar sync code to the opensync module (not complete)
1400         - cleaned up exception handling in the opensync module, making
1401                 more use of the base exception to make sure no
1402                 exceptions leak into the C library code
1404 Release: version 0.0.2 - 2006/10/12
1405 ------------------------------------------------------------------------------
1406 2006/10/12
1407         - fixed casting error in opensync module
1408         - minor updates to documentation to prepare for release
1409 2006/09/29
1410         - added stdint.h to parser.h for uint32_t.  Thanks Ron Gage for
1411                 the bug report
1412 2006/09/08
1413         - large refactoring of the packet parsing and building code,
1414                 splitting the code into 3 groups:
1415                 - record: handles record specific parsing and building...
1416                         this is mostly subfields with CommonField structs
1417                         as their headers, but sometimes has a specific
1418                         header of its own, in the case of email
1419                         Note: email's header is as yet undecoded.
1420                         Record does not know the details of the packet
1421                         formats, only the formats of its own record data.
1422                 - packet: handles building of complete command packets
1423                         and handles parsing of commonly used header values,
1424                         providing an API for it... packet does not know
1425                         the record format details, but does know the
1426                         details of each Database Operation (protocol.h)
1427                         packet format.
1428                         So far, it seems that there is a real separation
1429                         of operation formats and record formats, with the
1430                         record formats being the same even with different
1431                         database operation codes (GET_RECORDS /
1432                         OLD_GET_RECORDS), which was not confirmed before.
1433                         See the header size of the email record after
1434                         refactoring.
1435                 - controller: handles device state, and the management of
1436                         sockets, commands, and checking for response values.
1437                         The Controller object does not know the format
1438                         of either the record or the packet it is sending,
1439                         but does know the protocol handshake logic used
1440                         to talk to the device.
1441         - implemented SetRecord (SET_RECORD_BY_INDEX)... syncing, here
1442                 we come!
1443         - spelling correction in opensync-plugin/AUTHORS
1444 2006/09/01
1445         - added sample hotplug scripts
1446         - added .cvsignore files for doxygen and opensync directories
1447         - added src/endian.h... still need to add configure support to
1448                 handle non-little-endian machines
1449         - added exception handler in opensync plugin commit_change()
1450         - removed the device reset code in probe.cc, as resetting a device
1451                 can renumber the devices in /proc on kernel 2.4.x,
1452                 and cause a failure to reach the device...
1453                 FIXME - this should be changed someday to reset if probing
1454                 fails, and restart the probe on reset, as sometimes
1455                 the blackberry devices respond differently when not reset
1456                 Ideally, the probe protocol should be properly reverse
1457                 engineered.
1458         - added support for retrieving record state table, which is needed
1459                 for smarter syncing
1460         - added support for retrieving, deleting, and clearing the dirty
1461                 flags of individual blackberry device records
1462         - added endian macros throughout the code
1463 2006/07/13
1464         - added opensync-plugin to root Makefile's clean
1465         - updated time conversion calls to match opensync's latest SVN
1466         - added opensync_change_set_changetype() (only add for now,
1467                 for development)
1468         - removed slow sync functions for now
1469 2006/07/07
1470         - added quick "install" makefile target, to src/install by default
1471         - added static library target... this is temporary until autoconf
1472                 stuff is added properly... needed for the opensync plugin
1473         - documented in comments that Barry::BError is intended to be
1474                 the base classes for all exceptions
1475         - added first round of implementation of an opensync plugin, based
1476                 on the example plugin code from the opensync sources
1477 2006/06/22
1478         - added to Contact record class:
1479                 - Clear()
1480                 - ReadLdif() to load and parse LDAP data
1481         - added fragmented send support to Socket class
1482         - added Probe::FindActive() to make client programs more streamlined
1483         - fixed hex/decimal printing of record counts in btool
1484         - added upldif.cc, a utility to take ldapsearch output on stdin
1485                 and upload it to a blackberry
1486         - updated src/.cvsignore
1487 2006/06/16
1488         - added parsing of service book fields:
1489                 - old and new name
1490                 - old and new unique ID (UID)
1491                 - content ID (CID)
1492                 - old and new description
1493                 - DSID
1494                 - bes domain / domain
1495         - date change in legal.txt
1496         - added initial parsing of ServiceBook field 0x09, and calling it
1497                 ServiceBookConfig for now, for lack of a better name
1498         - added parsing for ServiceBook field 0x02 on 72xx Blackberries...
1499                 seems to be a name or description, but doesn't appear
1500                 in the device's own GUI... called "Hidden Name" for now
1501 2006/06/09
1502         - added ServiceBook record class and parser code, based on some
1503                 of Ron Gage's reverse engineering... code is by Chris Frey
1504         - added AUTHORS file
1505         - fixed the libusb set_configuration/claim_interface order
1506                 bug in controller.{h,cc}... already fixed in probe,
1507                 but not controller.  Thanks Ron Gage for finding this.
1508 2006/05/25
1509         - renamed Changelog to ChangeLog in preparation for autoconf
1510         - renamed Todo to TODO in preparation for autoconf
1511 2006/05/18
1512         - make clean cleans up tests properly now
1513 2006/03/31
1514         - turned source code browsing on in Doxyfile
1515         - added LoadDatabaseByName() and LoadDatabaseByType() template members
1516                 to the Controller class
1517                 - new file: controllertmpl.h
1518         - documentation fixes in builder.h
1519         - added static GetDBName() functions to all record classes, in
1520                 support of the template Controller functions
1521         - fleshed out DatabaseDatabase::GetDBNumber() and GetDBName(),
1522                 returning errors properly
1523         - documented sample btool.cc code better, and added example
1524                 of Controller template member usage
1525 2006/03/29
1526         - copyright dates updated for 2006
1527 2006/01/05
1528         - backed out update to latest libusb DEVEL tree, since it is buggy.
1529                 Stick with libusb 2005/11/26
1530 2005/12/30
1531         - added clean target to convenience Makefile
1532         - added Boost to list of dependencies in README
1533         - fixed minor compile warnings in base64.cc
1534         - fixed new USB discovery code, and changed endpoint usage to use
1535                 it, instead of the READ_ENDPOINT and WRITE_ENDPOINT
1536                 constants... constants are now removed
1537                 common.h, controller.cc, probe.cc, probe.h, usbwrap.cc
1538         - added ClearHalt() to Usb::Device (usbwrap.cc)
1539         - updated usbwrap.h to match latest libusb CVS devel tree
1540         - updated README to refer to 2005/12/30 libusb CVS devel tree
1541         - added roadmap to Todo list
1542 2005/12/29
1543         - added convenience Makefile in root directory
1544         - added Hacking document
1545         - minor touchups to README
1546         - added caution warning to README, since this release will support
1547                 delete / overwrite / upload functionality
1548         - minor compile order change in Makefile (speed reasons)
1549         - added dynamic endpoint discovery to probe.cc
1550         - changed claim_interface/set_configuration() function call order in
1551                 probe.cc based on feedback on the libusb mailing list
1552         - added USB discovery code to usbwrap.{h,cc}
1553 2005/12/23
1554         - fixed packing bug in new upload header struct
1555         - renamed CommonField union from data to u to be consistent
1556         - added return_code field to DBAccess struct, for error checking
1557         - added response checking during upload: if response is non-zero
1558                 throw exception in controller.cc
1559         - added sorting operators to record parser classes... when writing
1560                 contact data to the device, it may be important to write
1561                 group link items last, since they reference other contacts...
1562                 This needs to be tested, and if not required, removed.
1563         - added GROUP_FLAG field code to Contact parser class
1564         - fixed offset bug in Contact and Calendar Build() functions
1565         - fixed name bug in Contact::Build(), now output only with data
1566         - added appointment type flag support to Calendar record parser
1567                 class, and "all day event" flag support
1568 2005/12/22
1569         - added autoconf to Todo list
1570         - refactored the protocol structures so that record structs can
1571                 be reused for upload and download
1572         - with new protostructs, more header control is handled by
1573                 controller.cc instead of record.cc parsers and builders
1574         - parser code now accepts an offset, to govern start of record data
1575         - changed Data sizes from int to size_t and removed casts
1576         - removed unneeded Parser::GetHeaderSize() (new protostructs make
1577                 this obsolete)
1578         - added Calendar::Build() for calendar uploads
1579 2005/12/10
1580         - added s11n-boost.h serialization templates for boost::serialization
1581         - added boost::serialization to build
1582         - minor change in usbwrap.cc to display error codes in decimal
1583         - added SizePacket special case code to Socket::Send()... this is
1584                 required when uploaded packet size is a multiple of 0x40,
1585                 a special 3 byte size packet is sent
1586         - moved some record class variables to public: so they can be
1587                 properly serialized
1588         - fixed variable name but in RecordBuilder template
1589         - added -f switch to btool, for saving and loading of record data
1590         - added -s switch to btool, for uploading saved data back to handheld
1591         - added Controller::SaveDatabase()
1592 2005/12/08
1593         - fixed potential casting / pointer bug in controller.cc
1594         - added builder.h, to support uploading
1595         - minor comment fixes in parser.h
1596         - added preliminary Contact protocol record building support
1597         - fixed field order bug in ContactRecord protocol struct
1598         - Contact record.h class now saves unknown Group Link field,
1599                 for later saving
1600 2005/12/07
1601         - added -fno-strict-aliasing to compiler flags so gcc-4.0.x won't
1602                 optimize away protocol struct casts
1603                 see: 
1604                 http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25235
1605                 http://mail-index.netbsd.org/tech-kern/2003/08/11/0001.html
1606                 http://groups.google.ca/group/comp.lang.c++.moderated/ \
1607                         browse_thread/thread/e7bf096832526f8e/5714701b \
1608                         02a2a3cc?hl=en#5714701b02a2a3cc
1609         - changed headers so that any low level protocol-specific sizes and
1610                 structs are completely hidden in the library...
1611                 this adds library-only header: protostructs.h
1613 Release: version 0.0.1 - 2005/11/25
1614 ------------------------------------------------------------------------------
1615 2005/11/25
1616         - added barry.h for documentation purposes and application usage
1617         - updated README for release
1618         - renamed SBError exception class to BError
1619         - updated Doxyfile to version 1.4.5
1620         - added more doxygen comments
1621 2005/11/24
1622         - added conversion routines (and tests) between time_t and min1900_t
1623         - added -v option to btool to dynamically control protocol dumping
1624         - removed duplicated database database table display in controller.cc
1625         - minor spelling corrections
1626         - added copyright to usbwrap.{h,cc} as per earlier meeting
1627         - added support for Old protocol Calendar entries
1628 2005/11/20
1629         - added legal.txt, to save typing when adding new source files
1630         - ignore test-base64 file (cvsignore)
1631         - added contact-to-ldif generation, and updated supporting code
1632         - added argument to btool to support contact-to-ldif operation
1633         - added Contact::GetPostalAddress()
1634         - added README documentation in preparation for future release
1635 2005/11/19
1636         - added parser.{h,cc} virtual wrapper to generalize LoadDatabase()
1637         - added code to socket.cc's Packet() command to re-receive on
1638                 reception of empty packets... this seems to be a signal
1639                 from the device that it needs more time for long transfers
1640                 Current limit: 10 blank packets before exception is thrown
1641                 Observed maximum blank count: 1
1642         - added MessageRecord and OldMessageRecord to protocol.h
1643         - changed common record field structs to one CommonField struct
1644         - increased default USB timeout to 10 seconds (some loaded devices
1645                 seem to need more time...)
1646         - reorganized record.{h,cc} to try to reduce the code duplication
1647         - record.h classes now "know" the sizes of their corresponding
1648                 protocol structs... this may cause trouble down the line
1649                 with Python, if used(?)
1650         - added Message class for Email records
1651         - removed the "Get*" database functions and replaced with
1652                 general LoadDatabase() call, which loads any database
1653                 available, and parses it with a Parser object
1654         - added GetDBID() for searching for database numbers via name
1655         - added test code to retrieve and display all email
1656         - cleaned up comments
1657         - renamed blackberry.{h,cc} to controller.{h,cc}
1658         - renamed bbtool.cc to btool.cc
1659         - added Makefile.conf
1660         - added copyright notices to source files
1661         - added COPYING file with GPL
1662         - put parser in Barry namespace, and added auto_ptr-like mode for
1663                 store object pointers
1664         - added doxygen docs
1665         - added header comments to convo.awk script
1666         - removed Test() function in Controller object, and made class
1667                 better suited to its general API purpose
1668         - changed OpenMode() so it loads command table and DBDB... it is now
1669                 a public API function
1670         - moved Controller test code to btool.cc and made tool more
1671                 generically useful... can now download any DB by name on
1672                 the command line
1673         - added mode checks to Controller
1674         - added -t and -d command line options to btool
1675         - added base64 routines from John Walker / Fourmilab and Citadel/UX
1676         - converted base64 routines into an API, instead of hardcoded
1677                 file based
1678 2005/11/18
1679         - changed project name to Barry, including namespaces
1680         - renamed sbcommon.* to common.*
1681         - increased USB default timeout to 2 seconds
1682         - fixed formatting bug in Data operator<< output
1683         - cleaned up the protocol packet structs, getting rid of the
1684                 confusing param/simple split... param is now the tableCmd
1685                 from the Command Table
1686         - moved protocol structs from record.h to protocol.h
1687         - added support for older version of the USB protocol, which matches
1688                 the Cassis spec more closely
1689         - fixed the hardcoded offsets in blackberry.cc's protocol parsing
1690         - fixed Socket::Close() so on error, socket flags are reset.
1691                 This stops Close() from being called twice on exception
1692                 destructors
1693 2005/11/17
1694         - added Doxyfile to the project
1695         - tuned Makefile
1696         - added mode selection support to Blackberry class (RIM Desktop,
1697                 RIM Bypass, and RIM_JavaLoader)
1698                 Mode selection governs which socket is used in subsequent
1699                 data transfers.
1700         - added Command Table parsing and protocol support
1701                 Blackberry class, and CommandTable record class
1702         - added Database database parsing and protocol support
1703                 Blackberry class and DatabaseDatabase record class
1704         - added Address book retrieval support - dumps data to stdout for now
1705         - fixed bug in CopyOnWrite mode in Data class, where could allocate
1706                 less buffer than data copied
1707         - added "easy exception" debug output macro
1708         - fixed minor spelling error in protocol.cc
1709         - fixed ModeSelectCommand protocol structure - it is not a parameter
1710                 command, but uses the unknown slots for socket and flag
1711                 data
1712         - removed hardcoded socket numbers from protocol.h
1713         - fixed bug in socket.cc:Open() where packet size was not properly
1714                 saved
1715         - implemented socket::Close()
1716         - fixed sequence number checks, so it is reset properly on socket 0
1717         - added Socket::NextRecord() for multiple record data transfers
1718         - fixed input handling bug in translate.cc
1719 2005/11/11
1720         - added .cvsignore files to project
1721         - added README notes to document the source architecture
1722         - added dbsetup data script, which shows how to get into database
1723                 mode, using the RIM Desktop mode, and open a socket
1724         - added blackberry.{h,cc} class
1725         - added command line parameters to bbtool.cc
1726                 -l = list only
1727                 -p = specify pin of blackberry device
1728         - added blackberry test code in bbtool.cc - debugging the initial
1729                 opening protocol: sockets, modes, etc... see dbsetup for
1730                 results
1731         - added copy-on-write functionality to Data class, so it can be used
1732                 with plain data buffers with little performance impact
1733         - added eout() and ddout() debugging - to separate:
1734                 - regular debug output
1735                 - exception debug output (should probably be logged to
1736                         syslog someday, and never turned off)
1737                 - raw data dump output
1738         - changed errno SBError exception handler to try to decode the error
1739                 numbers into english (limited success)
1740         - fixed probe and socket USB Bulk message handling, so they don't
1741                 use PollCompletions(), but use IO::Wait() (libusb_io_wait())
1742         - added common packet size checker in protocol.cc
1743         - fixed unpacked protocol packet structs... using gcc's
1744                 __attribute__ ((packed)) ... see protocol.h
1745         - added ModeSelectCommand structure (protocol.h)
1746         - finished Socket::Open() call  (Close() not yet implemented)
1747         - moved Socket::Send/Receive() out of private, as they can be used
1748                 for socket 0 operations.
1749         - cleaned up pointer management with macros:
1750                 MAKE_PACKET()
1751                 COMMAND()
1752                 IS_COMMAND()
1753         - added IO::Wait() and IO::Cancel() to correspond with libusb API
1754         - added datadumping in usbwrap for easy protocol capture
1755         - added preliminary record.{h,cc} classes
1756         - added Contact record parsing, and test code
1757 2005/10/20
1758         - syncberry tree started