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