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