Code

release preparation
[roundup.git] / doc / announcement.txt
index 247bdc68299a7b018f6692f3f570b64aea10fcd2..52881f670aa87e8389a21b4e3de751062df7afe6 100644 (file)
-I'm proud to release version 1.4.11 of Roundup which fixes a number bugs
-and closes a potential security hole.
-
-All tracker maintainers must read the upgrading documentation to make sure
-the hole is fixed in their tracker.
-
-Other changes in this release:
-
-- Generic class editor may now restore retired items (thanks Ralf Hemmecke)
-- Fix security hole allowing user permission escalation (thanks Ralf
-  Schlatterbeck)
-- More SSL fixes. SSL wants the underlying socket non-blocking. So we
-  don't call socket.setdefaulttimeout in case of SSL. This apparently
-  never raises a WantReadError from SSL.
-  This also fixes a case where a WantReadError is raised and apparently
-  the bytes already read are dropped (seems the WantReadError is really
-  an error, not just an indication to retry).
-- Correct initial- and end-handshakes for SSL
-- Update FAQ to mention infinite redirects with pathological settings of
-  the tracker->web variable. Closes issue2537286, thanks to "stuidge"
-  for reporting.
-- Fix some format errors in italian translation file
-- Some bugs issue classifiers were causing database lookup errors
-- Fix security-problem: If user hasn't permission on a message (notably
-  files and content properties) and is on the nosy list, the content was
-  sent via email. We now check that user has permission on the message
-  content and files properties. Thanks to Intevation for funding this
-  fix.
-- Fix traceback on .../msgN/ url, this requests the file content and for
-  apache mod_wsgi produced a traceback because the mime type is None for
-  messages, fixes issue2550586, thanks to Thomas Arendsen Hein for
-  reporting and to Intevation for funding the fix.
-- Handle OPTIONS http request method in wsgi handler, fixes issue2550587.
-  Thanks to Thomas Arendsen Hein for reporting and to Intevation for
-  funding the fix.
-- Add documentation for migrating to the Register permission and
-  fix mailgw to use Register permission, fixes issue2550599
-- Fix styling of calendar to make it more usable, fixes issue2550608
-- Fix typo in email section of user guide, fixes issue2550607
-- Fix WSGI response code (thanks Peter Pöml)
-- Fix linking of an existing item to a newly created item, e.g.
-  edit action in web template is name="issue-1@link@msg" value="msg1"
-  would trigger a traceback about an unbound variable.
-  Add new regression test for this case. May be related to (now closed)
-  issue1177477. Thanks to Intevation for funding the fix.
-- Clean up all the places where role processing occurs. This is now in a
-  central place in hyperdb.Class and is used consistently throughout.
-  This also means now a template can override the way role processing
-  occurs (e.g. for elaborate permission schemes). Thanks to intevation
-  for funding the change.
-- Fix issue2550606 (german translation bug) "an hour" is only used in
-  the context "in an hour" or "an hour ago" which translates to german
-  "in einer Stunde" or "vor einer Stunde".  So "an hour" is translated
-  "einer Stunde" (which sounds wrong at first).  Also note that date.py
-  already has a comment saying "XXX this is internationally broken" --
-  but at least there's a workaround for german :-) Thanks to Chris
-  (radioking) for reporting.
+I'm proud to release version 1.4.17 of Roundup which introduces some
+minor features and, as usual, fixes some bugs:
+
+Features:
+
+- Allow declaration of default_values for properties in schema.
+- Add explicit "Search" permissions, see Security Fix below.
+- Add "lookup" method to xmlrpc interface (Ralf Schlatterbeck)
+- Multilinks can be filtered by combining elements with AND, OR and NOT
+  operators now. A javascript gui was added for "keywords", see issue2550648.
+  Developed by Sascha Teichmann; funded by Intevation. (Bernhard Reiter)
+- Factor MailGW message parsing into a separate class, thanks to John
+  Kristensen who did the major work in issue2550576 -- I wouldn't
+  have attempted it without this. Fixes issue2550576. (Ralf)
+- Now if the -C option to roundup-mailgw specifies "issue" this refers
+  to an issue-like class. The real class is determined from the
+  configured default class, or the -c option to the mailgw, or the class
+  resulting from mail subject parsing. We also accept multiple -S
+  options for the same class now. (Ralf)
+- Optimisation: Late evaluation of Multilinks (only in rdbms backends):
+  previously we materialized each multilink in a Node -- this creates an
+  SQL query for each multilink (e.g. 'files' and 'messages' for each
+  line in the issue index display) -- even if the multilinks aren't
+  displayed. Now we compute multilinks only if they're accessed (and
+  keep them cached).
+- Add a filter_iter similar to the existing filter call. This feature is
+  considered experimental. This is currently not used in the
+  web-interface but passes all tests for the filter call except sorting
+  by Multilinks (which isn't supported by SQL and isn't a sane concept
+  anyway). When using filter_iter instead of filter this saves a *lot*
+  of SQL queries: Filter returns only the IDs of Nodes in the database,
+  the additional content of a Node has to be fetched in a separate SQL
+  call. The new filter_iter also returns the IDs of Nodes (one by one,
+  it's an iterator) but pre-seeds the cache with the content of the
+  Node. The information needed for seeding the cache is retrieved in the
+  same SQL query as the ids.
+
+Fixed:
+
+- Security Fix: Add a check for search-permissions: now we allow
+  searching for properties only if the property is readable without a
+  check method or if an explicit search permission (see above unter
+  "Features) is given for the property. This fixes cases where a user
+  doesn't have access to a property but can deduce the content by
+  crafting a clever search, group or sort query.
+  see doc/upgrading.txt for how to fix your trackers! (Ralf Schlatterbeck).
+- Range support in roundup-server so large files can be served, 
+  e.g. media files on iOS/iPads; issue2550694. (Bernhard Reiter; 
+  Thanks to Jon C. Thomason for the patch.)
+- Fix search for xapian 1.2 issue2550676 
+  (Bernhard Reiter; Thanks to Olly Betts for providing the patch.)
+- Some minor typos fixed in doc/customizing.txt (Thanks Ralf Hemmecke).
+- XML-RPC documentation now linked from the docs/index (Bernhard Reiter).
+- Fix setting of sys.path when importing schema.py, fixes issue2550675,
+  thanks to Bryce L Nordgren for reporting. (Ralf Schlatterbeck)
+- clear the cache on commit for rdbms backends: Don't carry over cached
+  values from one transaction to the next (there may be other changes
+  from other transactions) see new ConcurrentDBTest for a
+  read-modify-update cycle that fails with the old caching behavior.
+  (Ralf Schlatterbeck)
+- Fix incorrect setting of template in customizing.txt example action,
+  patch via issue2550682 (thanks John Kristensen)
+- Configuration issue: On some postgresql 8.4 installations (notably on
+  debian squeeze) the default template database used for database
+  creation doesn't match the needed character encoding UTF8 -- a new
+  config option 'template' in the rdbms section now allows specification
+  of the template. You know you need this option if you get the error
+  message:
+  psycopg2.DataError: new encoding (UTF8) is incompatible with the
+  encoding of the template database (SQL_ASCII)
+  HINT:  Use the same encoding as in the template database, or use
+  template0 as template.
+  (Ralf Schlatterbeck)
+- Fixed bug in mailgw refactoring, patch issue2550697 (thanks Hubert
+  Touvet)
+- Fix Password handling security issue2550688 (thanks Joseph Myers for
+  reporting and Eli Collins for fixing) -- this fixes all observations
+  by Joseph Myers except for auto-migration of existing passwords.
+- Add new config-option 'migrate_passwords' in section 'web' to
+  auto-migrate passwords at web-login time. Default for the new option
+  is "yes" so if you don't want that passwords are auto-migrated to a
+  more secure password scheme on user login, set this to "no" before
+  running your tracker(s) after the upgrade.
+- Add new config-option 'password_pbkdf2_default_rounds' in 'main'
+  section to configure the default parameter for new password
+  generation. Set this to a higher value on faster systems which want
+  more security. Thanks to Eli Collins for implementing this (see
+  issue2550688).
+- Fix documentation for roundup-server about the 'host' parameter as
+  suggested in issue2550693, fixes the first part of this issue. Make
+  'localhost' the new default for this parameter, note the upgrading
+  documentation of changed behaviour.  We also deprecate the empty host
+  parameter for binding to all interfaces now (still left in for
+  compatibility). Thanks to Toni Mueller for providing the first version
+  of this patch and discussing implementations.
+- Fixed bug in filter_iter refactoring (lazy multilinks), in rare cases
+  this would result in duplicate multilinks to the same node. We're now
+  going the safe route and doing lazy evaluation only for read-only
+  access, whenever updates are done we fetch everything.
 
 If you're upgrading from an older version of Roundup you *must* follow
 the "Software Upgrade" guidelines given in the maintenance documentation.
 
-Roundup requires python 2.3 or later (but not 3+) for correct operation.
+Roundup requires python 2.4 or later (but not 3+) for correct operation.
 
 To give Roundup a try, just download (see below), unpack and run::
 
@@ -68,7 +110,7 @@ To give Roundup a try, just download (see below), unpack and run::
 Release info and download page:
      http://cheeseshop.python.org/pypi/roundup
 Source and documentation is available at the website:
-     http://roundup.sourceforge.net/
+     http://roundup-tracker.org/
 Mailing lists - the place to ask questions:
      http://sourceforge.net/mail/?group_id=31577
 
@@ -93,7 +135,7 @@ Roundup manages a number of issues (with flexible properties such as
 The system will facilitate communication among the participants by managing
 discussions and notifying interested parties when issues are edited. One of
 the major design goals for Roundup that it be simple to get going. Roundup
-is therefore usable "out of the box" with any python 2.3+ (but not 3+)
+is therefore usable "out of the box" with any python 2.4+ (but not 3+)
 installation. It doesn't even need to be "installed" to be operational,
 though an install script is provided.