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