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