What’s in this release

The 0.18 release represents a lot of new work over many months.  Some of the highlights are:

• Site admins can delete members from the web UI
• Much more of the interface is now internationalized thanks to Leonardo Caballero, and the French, Spanish and Portugese translations have been expanded and edited by Pierre George and Leonardo
• Project admins will now see a “send message to team” button on a project’s manage-team page
• Lists of members are now sorted case-insensitively by display name
• It is now possible to customize the default text filled in when a new wiki page is created
  

For a more complete list of changes, see https://svn.openplans.org/svn/opencore/tags/0.18.0/CHANGES.txt

Installing the release

The source is available at https://svn.openplans.org/svn/opencore/tags/0.18.0/.  As usual, we strongly recommend following the Fassembler-based build procedure.

To install the opencore-maximal profile (site-agnostic and including TaskTracker etc), follow the getting started steps with

 ./newbuild.sh opencore-maximal/tags/opencore-0.18.0/

or

./newbuild.sh opencore-minimal/tags/opencore-0.18.0/

for the opencore-minimal profile.

Migrations for existing sites

If you have an existing OpenCore site you will need to perform some content migrations, which can be run from the portal_setup tool.

• “Declare Supported Languages” (#2800) allows the site to serve the Spanish, Portugese (BR) and French translations when users visit the site with their browser’s language preferences set.
  
• “Add sortable_title index to membrane tool” regenerates the membrane_tool catalog and reindexes it, to allow efficient sorting of lists of members by the lowercase form of their username.
• “Mark listen folders w/ IListenContainer” applies a marker interface to all projects’ `lists` folder, which will enable the manage-team view to display a “Write message to team” button when applicable.
• “Bootstrap member removal queue” sets up the asynchronous task queue which will process member deletion requests.
  

As always, make sure you back up your data first before performing upgrade steps.

I’ve tracked down the cause of this bug.  It’s dependent on the configuration of the underlying ZCatalog, so it does not affect all OpenCore sites.  Newly built sites with new databases are unlikely to see this bug.

We should be able to provide an automatic upgrade step to fix this soon, but for now, if you’re experiencing this bug, you can fix it with some manual administration in the Zope Management Interface.

I’ve written up the symptoms and the manual steps you can follow if you need to fix it:

http://www.coactivate.org/projects/opencore/case-normalization-in-the-membrane-tool

Please be in touch if you have any questions.

What’s in this release

The 0.18 release represents quite a lot of work over many months, particularly by Rob Miller and Paul Winkler over the summer.  Some highlights are:

• Site admins can delete members from the web UI.
• Much more of the interface is now internationalized thanks to Leonardo Caballero, and the French, Spanish and Portugese translations have been expanded and edited by Pierre George and Leonardo.
• UI improvements based on user feedback, like a “send message to team” button on a project’s manage-team page; lists of members sorted case-insensitively by display name; and customizable wiki blank slate text.
  

For a more complete list of changes, see https://svn.openplans.org/svn/opencore/tags/0.18.0rc1/CHANGES.txt

Installing the release

The release candidate source is available at https://svn.openplans.org/svn/opencore/tags/0.18.0rc1/.

To install the opencore-maximal profile (site-agnostic and including TaskTracker etc), follow the getting started steps with

 ./newbuild.sh opencore-maximal/tags/opencore-0.18.0rc1/

or

./newbuild.sh opencore-minimal/tags/opencore-0.18.0rc1/

for the opencore-minimal profile.

Migrations for existing sites

If you want to try upgrading an existing site to the 0.18rc, please make sure you back up your data first or do the upgrade on a test environment only.  There are four migrations, which can be run from the portal_setup tool.

• Add sortable_title index to membrane tool 
• Mark listen folders w/ IListenContainer
• Bootstrap member removal queue
• Declare supported languages (en, es, fr, pt) to respect HTTP language codes from users’ browser preferences
  

Why a release candidate?

At this point I feel confident that the code in the 0.18 release branch is stable and is at a good place for a release.  However, I haven’t had an opportunity to robustly test the data migrations against a pre-existing 0.17-series database.  So I am not yet confident enough in the migrations to make a final release.

I will follow up and make a final release within four weeks.

If you want to try upgrading an existing site to the 0.18rc, please make sure you back up your data first or do the upgrade on a test environment only.  If you do try this, please drop us a line and let us know how it goes.

 

Upgrading to OpenCore 0.17.1 will prevent this bug from recurring.  If you’ve been running an OpenCore site prior to 0.17.1, there is a migration script that you should run to fix up existing data on your site.

cd {build_dir}/opencore
source bin/activate
./zope/bin/zopectl run src/opencore/migrations/resync-page-history-caches.py

It may take a while to run.  When it’s finished, wiki page histories on your site should be correct.

For more information, see http://trac.openplans.org/openplans/ticket/2836

I’ve written up a quick configuration patch that you can use to work around this bug:

http://www.coactivate.org/projects/opencore/syncing-the-membrane-tool

Please let me know if you have any questions.

Should I upgrade?

This release includes a number of usability enhancements and bug fixes, with a focus on fixing internationalization and character encoding issues; along the same lines, it also includes a significantly expanded set of localizable strings, and we’re hoping to be able to provide translations for them soon.  (If you can help out, please get in touch!)

If you’re running an Opencore site with significant non-English content, you will want to upgrade.

What’s New Since 0.16

Data Migrations:  There are two migrations: one to mark “project-discussion” mailing lists with a marker interface and another to retitle member areas.  You will need to use the portal_setup tool in the ZMI to run all the available upgrades for version 0.17.

Features Added:

 * Wiki pages now have a view at `latest-change` which redirects to the `version_compare` page displaying the most recent edit on the page. It is linked from the “last modified” text in the tabs on the page’s standard view. (#2781) (egj)

 * A portal status message now notifies users when their wiki content is stripped out because of the allowed_hosts whitelist, a frequent point of confusion for end users. (#2793) (egj)

 * Paginated search results now include a “jump to page” option (#1488) (egj)

 * All contexts now have a view at `searching` which returns a paginated list of all contents published underneath the given context. It is not yet linked to anywhere in the UI. (egj)

 * Rename ‘pages’ back to ‘wiki’ (#2749) (egj)

 * Mailing lists now support an ISyncWithProjectMembership marker interface; any list marked with this interface will automatically subscribe and unsubscribe members as they are added to or removed from a project. This used to only work for mailing lists with a specific id based on the project name; run the “Mark ISyncWithProjectMembership on -discussion lists” migration in opencore.upgrades.to_0_17_0″ to retain the functionality. (rafrombrc)

 * More templates marked up for translation. (egj)

 * The infamous `project_noun` is now marked up for translation. (#2739) (egj)

 * Xinha UI is now localizable (#2730) It respects the registered implementation of zope.i18n.interfaces.IUserPreferredLanguages to determine language preferences. (egj)

Bugs Fixed:

 * The topnav within a member space was always displaying the member’s original Title (i.e. fullname?fullname:id) as it was set at account creation time. It now properly displays the member’s current Title at all times (#2779)  Run the “Retitle member areas” migration to fix your site’s existing content. (egj)

 * Thumbnail view on the attachment images now explicitly sets content type header as image/jpeg (rafrombrc)

Refactoring:

 * Extracted opencore.wordpress into its own egg as a plugin (#2715) (egj)

 * Heavily refactored `BaseView.area` and `BaseView.window_title` functions in `opencore.browser.base` (#588#comment:7 and following) (egj)

 * Heavily refactored `opencore.nui.main.search` module and related views (egj)

 * Optimization: cut down on number of catalog queries in forgot view (rmarianski)

How to Install

As usual, I recommend building using our usual build process. Whether you use the newbuild.sh wrapper script from the fassembler-boot package, or just use fassembler directly, you have a choice of two requirements sets:

• opencore-minimal/tags/opencore-0.17.0 is a requirements profile for a fairly stripped down opencore build. It includes supervisord and zeo, but does not include tasktracker, wordpress, or deliverance.
  
• openplans/branches/opencore-0.17 builds a more complete stack based on the 0.17 branch, including tasktracker and wordpress blogs.
  

Support

As always, if you have any problems, contact us on the opencore-users mailing list or look us up on the #openplans IRC channel on freenode.

Should I upgrade?

This release consists almost entirely of bug fixes.  It should be a safe. minor upgrade from 0.15. I almost wish I’d called it 0.15.1, but it’s too late to change my mind  

What’s New Since 0.15

Data Migrations:

Nothing new this time. If you’re upgrading from a release older than 0.15, you should check for older migrations that need running; see CHANGES.txt in the source code or previous release announcements on this blog.

Features:

Nothing you’d notice really :-)  A slight enhancement was added to give the proper project context based on Deliverance headers; if you don’t know what that means, you probably don’t care.

Also, some minor speed enhancements.

Bug fixes:

  * Fixed a bug in utility.email_sender that prevented keyword args from being used in translation interpolation as expected (slinkp)

 * Fixed invite reminder email so the message gets correctly translated including the passed variables (slinkp)

 * Fixed unicode decode error in member contact form (and hopefully avoid related errors on other pages). (#2768) (slinkp)

 * RSS feeds of wiki page history was prohibitively expensive. Fixed.  (#2766) (slinkp)

 * The user folder ID migration fix from opencore 0.14 (see below) would barf on a few mysterious users. We work around that now, although the real fix is to upgrade membrane, which is done in the latest Products bundle.  (slinkp)

 * The member area title migration was tweaked to avoid some unnecessary data changes, and commit every so often to avoid conflict errors. (slinkp)

 * The workflow update migration was refactored to commit every so often, to avoid conflict errors. (slinkp)

 * Project summary now correctly shows the blank slate version of the  BlogSummaryViewlet when there are no blog posts. (slinkp, jhammel)

How to Install

As usual, I recommend building using our usual build process.  Whether you use the newbuild.sh wrapper script from the fassembler-boot package, or just use fassembler directly, you have a choice of two requirements sets:

• ­opencore-minimal/tags/0.16.0 is a requirements profile for a fairly stripped down opencore build. It includes supervisord and zeo, but does not include tasktracker, wordpress, or deliverance.
  
• openplans/branches/opencore-0.16 builds a more complete stack based on the 0.16 branch, including tasktracker and wordpress blogs.  We are in process of vetting this for deployment to www.openplans.org  (this site).  Once that’s done, we’ll put a tag of these requirements in openplans/releases.  

Support

As always, if you have any problems, contact us on the opencore-users mailing list or look us up on the #openplans IRC channel on freenode.

This release includes several small usability enhancements and bug fixes, with a focus on fixing internationalization and character encoding issues. If you’re running an Opencore site with significant non-English content, you will want to upgrade.

If you are still running Opencore 0.12 or earlier on top of Plone 2.5, this is a fairly big upgrade; see the 0.13 announcement for more info.

What’s New Since 0.14.1

Data Migrations: You will need to use the portal_setup tool in the ZMI to run all the available upgrades for version 0.15.

Features:

* Partial translations of the UI into Spanish, French & Portuguese (dimo)

* Member objects now have a _change_member_id() method. This is not exposed by UI yet, but admins can use it in eg. zopectl debug.

* Member profile now has a “contact” button which links to a mail form. The member’s email address is not exposed. (slinkp, rafrombrc)

* We now use the member’s full name (by way of Title()) in most places that conceptually refer to a person, and the member’s ID only in places that refer to the account. Fixes openplans:#2740 (slinkp)

* Mailing lists now have a /membership view that non-Managers can see. Includes a link to each member’s contact form. Email addresses are not exposed. Sorted case-insensitively by member Title or email. (closes openplans:#2752; partially closes openplans:#2751) (slinkp)

* Mailing lists’ manage_membership page now includes links to members’ contact form, and is sorted case-insensitively by member Title or email address. (Partially closes openplans:#2751) (slinkp)

* When inviting a site member to join a project, it is now possible to customize the email message sent (closes openplans:#2741) (egj)

* Marked up a few more strings for translation (slinkp)

* There is now a rebuild_i18n script for conveniently merging new message ids into all the .po files, and generating the test az “translation”. See for more info: http://www.openplans.org/projects/opencore/i18n-usage-in-opencore (slinkp)

* opencore.utils now includes a simple in-memory timestamp_memoize() for caching expensive calls (rafrombrc)

* Added a manual.pot file to manually manage strings from zcml files which can’t be parsed automatically by i18ndude (dimo)

* Added viewlet for analytics JS snippets (rafrombrc)

Bug fixes:

* Fix a longstanding point of user confusion, openplans:#1474. The member search in team management view no longer ignores existing team members but instead displays them with a contextual note that they are already in the project. (egj)

* Account creation forms no longer explode when the id contains ‘(’ or ‘)’. (egj)

* “Delete” button on project contents page now is shown or hidden based on correct permission check. There is a GS upgradeStep to fix existing workflows. (rafrombrc)

* The ‘addable types’ setting for the OpenTeam types was incorrect; it was set to all implicitly allowable types instead of explicitly allowing OpenMembership (and nothing else). Edited the GS profile to reflect the new setting and added an upgradeStep to automate its application. (rafrombrc)

* The create-az.py script now reliably finds all message ids, is less likely to produce invalid output, and doesn’t care what directory you’re in. (slinkp)

* Many flunc tests are slightly less fragile (slinkp)

* Unit tests no longer fail when VerboseSecurity is enabled (slinkp)

* Fix unicode errors in project preferences view (dimo, novalis)

* Fix unicode errors in request-membership view (dimo)

* Wiki attachments now have unique ids based on full path (closes http://trac.openplans.org/openplans/ticket/2728) (novalis)

* Fixed AttributeError when anonymous user requests project membership (http://trac.openplans.org/openplans/ticket/2735) (dimo)

* Slightly more useful error message on project creation when URLdoes not contain enough ASCII characters (http://trac.openplans.org/openplans/ticket/2733) (egj)

* opencore.utility.email_sender now does quoted-printable encoding of headers when it gets anything that can’t be encoded as ascii. (slinkp)

* opencore.utility.email_sender is now a bit smarter about addresses. (slinkp)

How to Install

As usual, I recommend building using our usual build process. Whether you use the newbuild.sh wrapper script from the fassembler-boot package, or just use fassembler directly, you have a choice of two requirements sets:

• opencore-minimal/tags/0.15.0 is a requirements profile for a fairly stripped down opencore build. It includes supervisord and zeo, but does not include tasktracker, wordpress, or deliverance.
  
• openplans/branches/opencore-0.15 builds a more complete stack based on the 0.15 branch, including tasktracker and wordpress blogs. We are in process of vetting this for deployment to www.openplans.org (this site). Once that’s done, we’ll put a tag of these requirements in openplans/releases.

Support

As always, if you have any problems, contact us on the opencore-users mailing list or look us up on the #openplans IRC channel on freenode.

What’s next?

We’re planning to do another release in January; the plan is to get Opencore 0.16 out in time for our friends at http://openfsm.net/ to have it in place before their conference in Belem at the end of the month. A lot of the remaining high-priority issues are still to do with internationalization and translation. Feel like helping out? Get in touch on the opencore-dev mailing list

This is a bugfix-only release. If you are running opencore 0.13 or 0.14, this should be a safe upgrade with a few useful fixes.

If you are still running opencore 0.12 or earlier on top of Plone 2.5, this is a fairly big upgrade; see the 0.13 announcement for more info.

What’s New Since 0.14.0

Data Migrations: You will need to run this migration only if you’re upgrading from 0.13 or earlier. You can run the migration via the portal_setup tool in the ZMI; go to the upgrades tab and run the upgrade registered for version 0.14.0.

Bug fixes:

  * List manager address was showing up as escaped HTML.  (slinkp) (http://trac.openplans.org/openplans/ticket/2706)

 * Wiki version view doesn’t error when no version_id is specified  (slinkp) (http://trac.openplans.org/errors-openplans/ticket/30)

 * Error page doesn’t barf on 404s if the catalog has a problem coming up with suggestions based on the current URL (slinkp)  (http://trac.openplans.org/errors-openplans/ticket/23)

 * Fixed rare error in recataloging projects, raised by the project’s _default_img_data method. (slinkp)

There are also a bunch of upstream bugfixes in Listen, our mailing list component. You will want to upgrade if you’ve had any trouble with non-ASCII characters in mail messages.

How to Install

As usual, I recommend building using our usual build process.  Whether you use the newbuild.sh wrapper script from the fassembler-boot package, or just use fassembler directly, you have a choice of two requirements sets:

• opencore-minimal/tags/0.14.1 is a requirements profile for a fairly stripped down opencore build. It includes supervisord and zeo, but does not include tasktracker, wordpress, or deliverance.
  
• openplans/releases/opencore-0.14.1-rc builds a more complete stack including tasktracker and wordpress blogs; this is equivalent to what we’d deploy on www.openplans.org.   We haven’t fully vetted this build for deployment yet, but it passes all functional and unit tests.
  

Support

As always, if you have any problems, contact us on the opencore-users mailing list or look us up on the #openplans IRC channel on freenode.

What took so long?

I realize it’s been over a month since Opencore 0.14.0.  One thing that added to the time was that, this time I was very careful to create a frozen list of all python packages that opencore depends on, directly or indirectly, so that building this release should be reliable and repeatable. No more depending on whatever happens to currently be in SVN.  And since I’d never done this for 0.13 or 0.14.0, it took longer and I ran into more problems than I expect to for future bugfix releases.

Pip was very useful for this job, although I had to massage the output a little bit to make fassembler happy.

I also took the time to edit my notes and document exactly how I make a release.  I’m using this as a checklist for now.  In the future I’d like to automate some of the more mechanical parts of the process.