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