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