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