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