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