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