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