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