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