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