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