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