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