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