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