Changeset 9309

Timestamp:

7 Oct 2012, 21:49:12 (12 years ago)

Author:

Henrik Bettermann

Message:

Add function get_users_with_role. We need this for collecting email addresses.

Location:

main/waeup.kofa/trunk/src/waeup/kofa

Files:

• permissions.py (modified) (1 diff)
• permissions.txt (modified) (1 diff)

main/waeup.kofa/trunk/src/waeup/kofa/permissions.py

@@ -360 +360 @@
                    local_role_title = local_role_title,
                    setting = setting)
+
+def get_users_with_role(role, context):
+    """Get a list of dicts representing the usres who have been granted
+    a role for `context`.
+    """
+    try:
+        role_map = IPrincipalRoleMap(context)
+    except TypeError:
+        # no map no roles.
+        raise StopIteration
+    for user_name, setting in role_map.getPrincipalsForRole(role):
+        user = grok.getSite()['users'].get(user_name,None)
+        user_title = getattr(user, 'title', user_name)
+        user_email = getattr(user, 'email', None)
+        yield dict(user_name = user_name,
+                   user_title = user_title,
+                   user_email = user_email,
+                   setting = setting)

main/waeup.kofa/trunk/src/waeup/kofa/permissions.txt

@@ -89 +89 @@
     >>> people_and_roles
     []
+
+:func:`get_users_with_role`
+---------------------------
+
+We can get all users with a specific role for a certain context
+object:
+
+    >>> from waeup.kofa.permissions import get_users_with_role
+    >>> mycontext = object()
+    >>> people = get_users_with_role('waeup.portalManager', mycontext)
+    >>> people
+    <generator object...at 0x...>
+
+In this case, the result is empty:
+
+    >>> people = list(people)
+    >>> people
+    []