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