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