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