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