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