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