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