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