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