class MembershipTool(BaseTool):
""" Implement 'portal_membership' interface using "stock" policies.
"""
__implements__ = (IMembershipTool, ActionProviderBase.__implements__)
meta_type = 'Default Membership Tool'
_actions = (
AI(id='login',
title='Login',
description='Click here to Login',
action=Expression(text='string:${portal_url}/login_form'),
permissions=(View, ),
category='user',
condition=Expression(text='not: member'),
visible=1),
AI(id='preferences',
title='Preferences',
description='Change your user preferences',
action=Expression(text='string:${portal_url}/personalize_form'),
permissions=(View, ),
category='user',
condition=Expression(text='member'),
visible=1),
AI(id='logout',
title='Log out',
description='Click here to logout',
action=Expression(text='string:${portal_url}/logout'),
permissions=(View, ),
category='user',
condition=Expression(text='member'),
visible=1),
AI(id='addFavorite',
title='Add to favorites',
description='Add this item to your favorites',
action=Expression(text='string:${object_url}/addtoFavorites'),
permissions=(View, ),
category='user',
condition=Expression(text='portal/portal_membership' +
'/getHomeFolder'),
visible=1),
AI(id='mystuff',
title='My stuff',
description='Goto your home folder',
action=Expression(text='string:${portal/portal_membership' +
'/getHomeUrl}/folder_contents'),
permissions=(View, ),
category='user',
condition=Expression(text='python: member and ' +
'portal.portal_membership.getHomeFolder()'),
visible=1),
AI(id='favorites',
title='My favorites',
description='Browse your favorites',
action=Expression(text='string:${portal/portal_membership' +
'/getHomeUrl}/Favorites/folder_contents'),
permissions=(View, ),
category='user',
condition=Expression(text='python: member and ' +
'hasattr(portal.portal_membership.' +
'getHomeFolder(), "Favorites")'),
visible=1),
AI(id='manage_members',
title='Manage members',
description='Manage portal members',
action=Expression(text='string:${portal_url}/members_manage_form'),
permissions=(ManageUsers, ),
category='global',
condition=None,
visible=1),
AI(id='logged_in',
title='Logged in',
description='Used by scripts',
action=Expression(text='string:${portal_url}/logged_in'),
permissions=(View, ),
category='user',
condition=None,
visible=0))
membersfolder_id = 'Members'
security = ClassSecurityInfo()
#
# ZMI methods
#
security.declareProtected(ManagePortal, 'manage_overview')
manage_overview = DTMLFile('explainMembershipTool', _dtmldir)
security.declareProtected(ManagePortal, 'manage_mapRoles')
manage_mapRoles = DTMLFile('membershipRolemapping', _dtmldir)
security.declareProtected(ManagePortal, 'manage_setMembersFolderById')
def manage_setMembersFolderById(self, id='', REQUEST=None):
""" ZMI method to set the members folder object by its id.
"""
self.setMembersFolderById(id)
if REQUEST is not None:
REQUEST['RESPONSE'].redirect(
self.absolute_url() + '/manage_mapRoles' +
'?manage_tabs_message=Members+folder+changed.')
#
# 'portal_membership' interface methods
#
security.declareProtected(ListPortalMembers, 'getRoster')
def getRoster(self):
""" Return a list of mappings for 'listed' members.
If Manager, return a list of all usernames. The mapping
contains the id and listed variables.
"""
isUserManager = _checkPermission(ManageUsers, self)
roster = []
for member in self.listMembers():
if isUserManager or member.listed:
roster.append({'id': member.getId(), 'listed': member.listed})
return roster
security.declareProtected(ManagePortal, 'setMembersFolderById')
def setMembersFolderById(self, id=''):
""" Set the members folder object by its id.
"""
self.membersfolder_id = id.strip()
security.declarePublic('getMembersFolder')
def getMembersFolder(self):
""" Get the members folder object.
"""
parent = aq_parent(aq_inner(self))
members = getattr(parent, self.membersfolder_id, None)
return members
security.declarePublic('createMemberArea')
def createMemberArea(self, member_id=''):
""" Create a member area for 'member_id' or authenticated user.
"""
if not self.getMemberareaCreationFlag():
return None
members = self.getMembersFolder()
if not members:
return None
if self.isAnonymousUser():
return None
# Note: We can't use getAuthenticatedMember() and getMemberById()
# because they might be wrapped by MemberDataTool.
user = _getAuthenticatedUser(self)
user_id = user.getId()
if member_id in ('', user_id):
member = user
member_id = user_id
else:
if _checkPermission(ManageUsers, self):
member = self.acl_users.getUserById(member_id, None)
if member:
member = member.__of__(self.acl_users)
else:
raise ValueError, 'Member %s does not exist' % member_id
else:
return None
if hasattr(aq_base(members), member_id):
return None
# Note: We can't use invokeFactory() to add folder and content because
# the user might not have the necessary permissions.
# Create Member's home folder.
members.manage_addPortalFolder(id=member_id,
title="%s's Home" % member_id)
f = members._getOb(member_id)
# Grant Ownership and Owner role to Member
f.changeOwnership(member)
f.__ac_local_roles__ = None
f.manage_setLocalRoles(member_id, ['Owner'])
# Create Member's initial content.
if hasattr(self, 'createMemberContent'):
self.createMemberContent(member=member,
member_id=member_id,
member_folder=f)
else:
addDocument(f, 'index_html', member_id + "'s Home",
member_id + "'s front page", "structured-text",
(DEFAULT_MEMBER_CONTENT % member_id))
# Grant Ownership and Owner role to Member
f.index_html.changeOwnership(member)
f.index_html.__ac_local_roles__ = None
f.index_html.manage_setLocalRoles(member_id, ['Owner'])
f.index_html._setPortalTypeName('Document')
f.index_html.reindexObject()
f.index_html.notifyWorkflowCreated()
return f
security.declarePublic('createMemberarea')
createMemberarea = createMemberArea
def getHomeFolder(self, id=None, verifyPermission=0):
""" Return a member's home folder object, or None.
"""
if id is None:
member = self.getAuthenticatedMember()
if not hasattr(member, 'getMemberId'):
return None
id = member.getMemberId()
members = self.getMembersFolder()
if members:
try:
folder = members._getOb(id)
if verifyPermission and not _checkPermission(View, folder):
# Don't return the folder if the user can't get to it.
return None
return folder
except AttributeError:
pass
return None
def getHomeUrl(self, id=None, verifyPermission=0):
""" Return the URL to a member's home folder, or None.
"""
home = self.getHomeFolder(id, verifyPermission)
if home is not None:
return home.absolute_url()
else:
return None
class MembershipTool( BaseTool ):
""" Implement 'portal_membership' interface using "stock" policies.
"""
__implements__ = (IMembershipTool, ActionProviderBase.__implements__)
meta_type = 'Default Membership Tool'
_actions = (
AI( id='login'
, title='Login'
, description='Click here to Login'
, action=Expression(text='string:${portal_url}/login_form')
, permissions=(View,)
, category='user'
, condition=Expression(text='not: member')
, visible=1
)
, AI( id='preferences'
, title='Preferences'
, description='Change your user preferences'
, action=Expression(text='string:${portal_url}/personalize_form')
, permissions=(View,)
, category='user'
, condition=Expression(text='member')
, visible=1
)
, AI( id='logout'
, title='Log out'
, description='Click here to logout'
, action=Expression(text='string:${portal_url}/logout')
, permissions=(View,)
, category='user'
, condition=Expression(text='member')
, visible=1
)
, AI( id='addFavorite'
, title='Add to favorites'
, description='Add this item to your favorites'
, action=Expression(text='string:${object_url}/addtoFavorites')
, permissions=(View,)
, category='user'
, condition=Expression(text= 'portal/portal_membership'
+ '/getHomeFolder')
, visible=1
)
, AI( id='mystuff'
, title='My stuff'
, description='Goto your home folder'
, action=Expression(text='string:${portal/portal_membership'
+ '/getHomeUrl}/folder_contents')
, permissions=(View,)
, category='user'
, condition=Expression( text='python: member and '
+ 'portal.portal_membership.getHomeFolder()')
, visible=1
)
, AI( id='favorites'
, title='My favorites'
, description='Browse your favorites'
, action=Expression(text='string:${portal/portal_membership'
+ '/getHomeUrl}/Favorites/folder_contents')
, permissions=(View,)
, category='user'
, condition=Expression( text='python: member and '
+ 'hasattr(portal.portal_membership.'
+ 'getHomeFolder(), "Favorites")')
, visible=1
)
)
membersfolder_id = 'Members'
security = ClassSecurityInfo()
#
# ZMI methods
#
security.declareProtected( ManagePortal, 'manage_overview' )
manage_overview = DTMLFile( 'explainMembershipTool', _dtmldir )
security.declareProtected(ManagePortal, 'manage_mapRoles')
manage_mapRoles = DTMLFile('membershipRolemapping', _dtmldir )
security.declareProtected(ManagePortal, 'manage_setMembersFolderById')
def manage_setMembersFolderById(self, id='', REQUEST=None):
""" ZMI method to set the members folder object by its id.
"""
self.setMembersFolderById(id)
if REQUEST is not None:
REQUEST['RESPONSE'].redirect( self.absolute_url()
+ '/manage_mapRoles'
+ '?manage_tabs_message=Members+folder+changed.'
)
#
# 'portal_membership' interface methods
#
security.declareProtected( ListPortalMembers, 'getRoster' )
def getRoster(self):
""" Return a list of mappings for 'listed' members.
If Manager, return a list of all usernames. The mapping
contains the id and listed variables.
"""
isManager = _checkPermission('Manage portal', self)
roster = []
for member in self.listMembers():
if isManager or member.listed:
roster.append({'id':member.getId(),
'listed':member.listed})
return roster
security.declareProtected(ManagePortal, 'setMembersFolderById')
def setMembersFolderById(self, id=''):
""" Set the members folder object by its id.
"""
self.membersfolder_id = id.strip()
security.declarePublic('getMembersFolder')
def getMembersFolder(self):
""" Get the members folder object.
"""
parent = aq_parent( aq_inner(self) )
members = getattr(parent, self.membersfolder_id, None)
return members
security.declareProtected(ManagePortal, 'createMemberarea')
def createMemberarea(self, member_id):
""" Create a member area for 'member_id'.
"""
members = self.getMembersFolder()
if members is not None and not hasattr( aq_base(members), member_id ):
f_title = "%s's Home" % member_id
members.manage_addPortalFolder( id=member_id, title=f_title )
f=getattr(members, member_id)
# Grant ownership to Member
acl_users = self.__getPUS()
user = acl_users.getUser(member_id)
if user is not None:
user= user.__of__(acl_users)
else:
from AccessControl import getSecurityManager
user= getSecurityManager().getUser()
# check that we do not do something wrong
if user.getId() != member_id:
raise NotImplementedError, \
'cannot get user for member area creation'
f.changeOwnership(user)
f.manage_setLocalRoles(member_id, ['Owner'])
# Create Member's home page.
# DEFAULT_MEMBER_CONTENT ought to be configurable per
# instance of MembershipTool.
addDocument( f
, 'index_html'
, member_id+"'s Home"
, member_id+"'s front page"
, "structured-text"
, (DEFAULT_MEMBER_CONTENT % member_id)
)
f.index_html._setPortalTypeName( 'Document' )
# Overcome an apparent catalog bug.
f.index_html.reindexObject()
wftool = getToolByName( f, 'portal_workflow' )
wftool.notifyCreated( f.index_html )
def getHomeFolder(self, id=None, verifyPermission=0):
""" Return a member's home folder object, or None.
"""
if id is None:
member = self.getAuthenticatedMember()
if not hasattr(member, 'getMemberId'):
return None
id = member.getMemberId()
members = self.getMembersFolder()
if members:
try:
folder = members[id]
if verifyPermission and not _checkPermission('View', folder):
# Don't return the folder if the user can't get to it.
return None
return folder
except KeyError: pass
return None
def getHomeUrl(self, id=None, verifyPermission=0):
""" Return the URL to a member's home folder, or None.
"""
home = self.getHomeFolder(id, verifyPermission)
if home is not None:
return home.absolute_url()
else:
return None