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