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