Products.membrane 6.0.0

Content-based users and groups for Plone

Overview

membrane is a set of PluggableAuthService (PAS) plug-ins that allow for the user-related behaviour and data (authentication, properties, roles, groups, etc.) to be obtained from content within a Plone site. It does not actually provide a full member implementation, it is intended to be a set of tools from which a full implementation can be constructed. It is meant to be flexible and pluggable, and easy to adapt to different deployment scenarios. It is not meant to be configured through-the-web-only, but to be adapted by filesystem code.

The canonical implementation of such a content type type for Plone is dexterity.membrane.

membrane tries to take a step backwards and re-think some of the Plone membership-handling. We have tried to make it as simple as possible, so that grasping and extending it is simple. Hopefully, simplicity should also make it easier to make sure it is secure.

Vision

membrane is a product to enable users as content in Plone sites, in collaboration with PlonePAS. The name gives you an idea of the intended complexity and amount of code.

membrane won’t be the only member handling product in your site, instead it should enable us to easily plug in products that enable default Plone member policy, or more exotic setups in corporate intranets. This means that to get the default Plone behaviour you will need something else in addition to membrane.

Requirements

Since version 6.0: Plone 5.2, Python3 only. Support for Archetypes was removed. Since version 5.0: Plone 5.2. Since version 4.0: Plone 5.1. Version 3.0: Plone 4.3 or 5.0. We only test with Python 2.7. For older Plone versions, please use Products.membrane branch 2.1.x.

WARNING!!

Currently, a catalog is used to index the interfaces implemented by the objects in the portal. However, interfaces are specified programmatically, either via Python code or ZCML. Any time Zope is restarted, interfaces may have changed, and, if they have, the catalog will have become out of date. Work is under way on a more robust interface lookup solution, but for now if you change the interfaces implemented on any membrane related type or object, you may need to explicitly reindex the ‘object_implements’ interface on the membrane_tool.

Changelog

6.0.0 (2022-10-10)

• Support Plone 6.0 [ale-rt]

• Remove support for Python2 and Archetypes, remove deprecated code [ale-rt]

• Remove mentions to Products.remember which is unsopported since years [ale-rt]

5.0.3 (2021-12-06)

• Add uninstall profile (fixes #20) [petschki]

5.0.2 (2021-04-23)

• Remove a deprecation warning (fixes #26) [ale-rt]

5.0.1 (2021-03-02)

• fixes the main membrane_tool template in ZMI

5.0.0 (2021-02-17)

• Remove a deprecation warning (fixes #21) [ale-rt]

5.0.0a1 (2020-02-19)

Breaking changes:

• Requires Plone 5.2 or newer. [ale-rt]

New features:

• add item here

Bug fixes:

• Plone 5.2 / Zope 4 compatibility. [thet]

4.0 (2017-10-05)

Breaking changes:

• Requires Plone 5.1 or newer. [datakurre]

Fixes:

• Modernization and cleanup: Use Decorators for ZCA and security. Sort and cleanup imports. Add utf8 headers. Updated bootstrapping and test setup. [jensens]

3.0.2 (2017-09-15)

• Fix user/group search for @@sharing. A unicode search string could get passed, where we expected a string. [pysailor]

3.0.1 (2017-04-05)

• Set the return state of the updateUser method to True if membrane is responsible for managing the user. [agitator]

3.0 (2016-07-06)

Breaking changes:

• Split user and group groups interface. A group that implemented user.IUserGroupsProvider would get included when listing members, which led to AttributeError: 'NoneType' object has no attribute '__of__'. The new interface is group.IGroupGroupsProvider. We look for this in our group manager plugin in the getGroupsForPrincipal method. If no providers are found, we try the old way for backwards compatibility. [maurits]

• Split user properties and group properties interface. A group that implemented IPropertiesProvider would get included when listing members, which led to AttributeError: 'NoneType' object has no attribute '__of__'. Renamed IPropertiesProvider to IUserPropertiesProvider but kept the old name as alias for backwards compatibility. Added IGroupPropertiesProvider. You may need to reindex the membrane_tool catalog if you have problems. [maurits]

• Dropped compatibility with Plone 4.2 and lower. For those Plone versions, please use Products.membrane branch 2.1.x. Note that 2.1.x is fine for Plone 4.3 and 5.0 too, but you are missing the fixes done in the 3.0 release. [maurits]

New features:

• Fixed tests on Plone 5. Added Travis for continuous integration testing on Plone 4.3 and 5.0. We only test with Python 2.7. [maurits]

• Ported tests to plone.app.testing. [maurits]

Bug fixes:

• Fixed various pep8 and pyflakes errors and warnings. [maurits]

2.1.13 (2015-11-05)

• Fix broken distribution; README file was renamed and MANIFEST.in was updated. [hvelarde]

2.1.12 (2015-06-25)

• Allow arbitrary indexes to be passed in to the catalog query in groupmanager. [cedricmessiant]

• Fix bug where moving a membrane object did not unindex it from the membrane catalog. [davisagli]

• Replaced getUserId for exact_getUserId to avoid weird lookup side effects. [agitator]

2.1.11 (2014-03-31)

• Recursive group plugin now works with membrane groups. [vincentfretin]

• Fix username/userid error in the PAS users plugin: allowPasswordSet and allowDeletePrincipal takes a userid as parameter, not a username. [vincentfretin]

2.1.10 (2013-10-19)

• Fix: check if the user adder can be acquired. [gagaro]

2.1.9 (2013-07-18)

• When enumerateUsers gets criteria that lead to an empty query, do not return any results. When no criteria are passed, return all members. This refs the discussion at https://github.com/collective/Products.membrane/commit/c336a17f926a10ad384ea7b056db8d166a7eea00 [maurits]

2.1.8 (2013-03-31)

• Added updateUser and updateEveryLoginName methods. For the moment they do nothing. They are needed for compatibility with PluggableAuthService 1.10 and higher. [maurits]

2.1.7 (2013-03-01)

• Fixed broken release that was missing README.txt file. [maurits]

2.1.6 (2013-03-01)

• Removed getUserAuthProvider from IMembraneTool interface. Replaced it with getUserObject which has been the method to call for a few years. [maurits]

• Add handling of new keyword argument fullname passed by plone.app.controlpanel.usergroups.UsersOverviewControlPanel for enumerateUsers(...). This avoids finding all membrane users on any searchterm in sharing tab or user control panel. [saily]

2.1.5 (2012-09-13)

• Moved to github: https://github.com/collective/Products.membrane [maurits]

2.1.4 (2012-04-13)

• False user property values were being converted to empty strings which would cause the property sheet to treat them as strings and make it impossible to set these properties back to True. [cah190]

2.1.3 (2012-02-27)

• Bugfix. The catalog processor called by collective.indexing doesn’t unindex users from the membrane_tool. [jcbrand]

2.1.2 (2011-12-16)

• Fixed problem that occurs after upgrading the SearchableText index of the membrane_tool, which happens after upgrading to membrane 2.0 or to Plone 4: the membrane_tool catalog would be empty. Now we refresh the membrane_tool catalog when we upgrade the index. If this has already happened to you, it should work to just go to the membrane_tool, then the Advanced tab, and click on ‘Update Catalog.’ [maurits]

2.1.1, 29 November, 2011

• Made the getUserObject method private for better security. Use portal_membership.getMemberInfo(user_id) when you need something similar in a skin script or template. Or @@pas_member on Plone 4.0+. Problem reported by Richard Mitchell, thanks! [maurits]

2.1.0, 15 November, 2011

• Restored compatibility with collective.indexing 1.8 or earlier. [maurits]

• Added a normalizer lexicon that does case normalization. getUserId and getUserName are the only places where case sensitivity makes sense in searches. Title and SearchableText needs normalization. [tesdal]

• Fixed a bug where only user objects and not groups would be indexed if collective.indexing could be imported. Also added a missing check of of portal_type against listMembraneTypes before performing re/un/indexing. [tesdal]

• Add compatibility with collective.indexing 2.0a1. [hannosch]

2.0.2, 26 April, 2011

• In the unindexObject patch when collective.indexing is used, when the object is no membrane object, try to unwrap it, as it may be a PathWrapper around the object, wrapped by collective.indexing. Without this, stale brains may be left in the membrane_tool catalog, at least when using dexterity objects as members. [maurits]

• Changed the test setup so the tests also work on Plone 4.1, next to Plone 4.0 and 3.3. [maurits]

2.0.1, March 11, 2011

• Add an upgrade step to handle cases where meta_type for the SearchableText step has been rewritten to “Broken Because Product is Gone” which would cause the 2.0 upgrade step to not migrate the index. [cah190]

2.0, March 9, 2011

• Add an upgrade step to migrate from membrane 1.1 releases. [cah190]

2.0b2, September 20, 2010

• Fix username/userid error in the PAS users plugin: doChangeUser takes a userid as parameter, not a username. [wichert]

2.0b1, August 31, 2010

• Apply the collective.indexing profile when it is available. [maurits]

• Removed the dependency on collective.indexing >= 1.1 as it was added to allow non-Archetypes content to be used, but it is giving problems with some normal Archetypes content. If you add collective.indexing to your buildout yourself, we still use it and register our own catalog queue processor with it. Please install it in your Plone Site yourself. [maurits]

• Bug fix: when asked to return a maximum number of users, convert max_results to an integer. [maurits]

• Remove deprecated workflow state category set status mapper. This should be implemented using a workflow based test in an IMembraneUserAuth implementation, not in the core Membrane code. [rossp, wichert]

• Fix performance problems with the object_implements index using marker interfaces registered as utilities. [rossp]

  The object_implements index used to use the ZCA to find out not only what interfaces an object provided, but what interfaces an object could be adapted to out to the second order (adapting two objects). Providing this degree of magical awareness proved to be a large performance problem.

• Remove BBB method to migrate the list of membrane types from archetypes_tool to membrane_tool. [rossp]

• Use ZCTextIndex for the SearchableText index. This fixes problems with unicode data. [wichert]

• Modify the property plugin to handle property adapters returning None and pure dictionaries. Even though the PAS interface does not allow it this is common behaviour. [wichert]

• Use collective.indexing to update the membrane_tool catalog data. This allows non-Archetypes content to be used. [wichert]

• Refactor PAS plugins to only depend on the generic interfaces. This removes the dependency on Archetypes. [wichert]

• Use plone.indexer to manager indexable attribuets. [wichert]

• Update GenericSetup import handler to gracefully handle sites without a membrane_tool installed. [wichert]

• Improve package description, RESTify the changelog. [wichert]

• Move GenericSetup profile and step registration to zcml. [wichert]

1.1b5 Released March 23, 2009

• Fix git based release problem, now using setuptools-git [hannosch]

1.1b4 Released March 20, 2009

• Tested with Plone 3.0-3.2 [rossp]

• Add a warning about upcoming changes to object_implements [rossp]

• Deprecate the category mapper support [rossp]

• Deprecate AT assumptions [rossp]

• Provide the offending login name when more than one match [witsch]

• Fix AttributeError bug when the search term is None [claytron]

• Distinguish btn substring matches and case-insensitive matches for userid and username when supporting case-insensitive logins [rafrombrc]

• Only use the membrane user factory plug-in for users for whom membrane provides authentication. [rafrombrc]

1.1b3 Released July 23, 2008

• Fix issue with retrieving unnamed user adders. [witsch]

• Remove counter again as the membrane tool inherits from Plone’s catalog tool, which already has support for a counter. Keep the test and caching helper, though. :) [witsch]

1.1b2 Released July 22, 2008

• Add a counter to the membrane tool which can be used as a cache key as well as a convenience helper for quickly memoizing adapters and tools. [witsch]

• Have rolemanager and groupmanager search for exact userids. [mj]

1.1b1 Released May 22, 2008

• Initial egg release. [rafrombrc]

• removed deprecation messages in Plone 3.0 (Zope 2.10): Import of zope.app.annotation turned into zope.annotation [jensens]

1.0b1

• Introduced IUserChanger interface to separate the password changing from the user addition and deletion portions of IUserManagement. [rafrombrc]

• Completed general implementation of roles, groups, properties plugins. [rafrombrc, jhammel, rmarianski]

0.3

• Added a IUserManagement interface (from PlonePAS) to the usermanager. It will be available to implementations that provide the corresponding IMembraneUserManagement interface directly or through adaptation. This allows thing like PasswordResetTool to work.

• Renamed package to ‘membrane’ from ‘Membrane’ to reflect current standard python naming conventions. [rafrombrc]

• Major refactoring to use Zope 3 component engine to glue together all the pieces. Mix-ins have been converted to adapters, providers are defined by implementation of specific interfaces. [rafrombrc]

0.2-alpha

• Made Title in membrane_tool a ZCTextIndex too, so that enumerateGroups() of membrane_groups works without exact_match.

• getUserName and getUserId indexes in membrane_tool are now of type ZCTextIndex, allowing us to do exact_match=False queries in MembraneUserManager.enumerateUsers.

  PluggableAuthService.enumerateUsers recommends treating id and login as “contains” search tokens, but with our text index we can only do “starts with” searches. However, that’s much better than returning () for every call that has “exact_match=False”. [dpunktnpunkt]