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