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