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