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