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