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