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