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