view MoinMoin/groups/backends/__init__.py @ 4796:7dd5d15de911

Groups2009: BaseGroup and BaseBackend initial import. wiki_group.Group and wiki_group.Backend inherit from those classes. TestWikiGroupNameMapping is added to check group name mapping routines.
author Dmitrijs Milajevs <dimazest@gmail.com>
date Tue, 09 Jun 2009 23:35:01 +0200
parents 3f9147c23d9c
children 4539a7956eac
line wrap: on
line source
# -*- coding: iso-8859-1 -*-
"""
MoinMoin - base classes for group backends.

@copyright: 2009 MoinMoin:DmitrijsMilajevs
@license: GPL, see COPYING for details
"""

class BaseGroup(object):

    def __init__(self, request, name, backend):
        """
        Initialize a group.

        @param request
        @param name: moin group name
        @backend: backend object which created this object

        """
        self.request = request
        self.name = name
        self.backend = backend

        self.to_backend_name = backend.to_backend_name
        self.to_group_name = backend.to_group_name

        self._load_group()

    def _load_group(self):
        """
        Fill in self.members, self.member_groups with data retrieved from the backend.
        member_groups are moin group names.
        """
        raise NotImplementedError()

    def _contains(self, member, processed_groups):
        """
        First check if <member> is part of this group and then check
        for every subgroup in this group.

        <processed_groups> is needed to avoid infinite recursion, if
        groups are defined recursively.

        @param member: member name [unicode]
        @param processed_groups: groups which were checked for containment before [set]
        """
        processed_groups.add(self.name)

        if member in self.members:
            return True
        else:
            groups = self.request.groups
            for group_name in self.member_groups:
                if group_name not in processed_groups and groups[group_name]._contains(member, processed_groups):
                    return True

        return False

    def __contains__(self, member):
        """
        Check if <member> is defined in this group. Checks also for subgroups.
        """
        return self._contains(member, set())

    def _iter(self, yielded_members, processed_groups):
        """
        Iterate first over members of this group, then over subgroups of this group.

        <yielded_members> and <processed_groups> are needed to avoid infinite recursion.
        This can happen if there are two groups like these:
           OneGroup: Something, OtherGroup
           OtherGroup: OneGroup, SomethingOther

        @param yielded_members: members which have been already yielded before [set]
        @param processed_groups: group names which have been iterated before [set]
        """
        processed_groups.add(self.name)

        for member in self.members:
            if member not in yielded_members:
                yield member
                yielded_members.add(member)

        groups = self.request.groups
        for group_name in self.member_groups:
            if group_name not in processed_groups:
                for member in groups[group_name]._iter(yielded_members, processed_groups):
                    if member not in yielded_members:
                        yield member
                        yielded_members.add(member)


    def __iter__(self):
        """
        Iterate over members of this group. Iterates also over subgroups if any.
        """
        return self._iter(set(), set())

    def __repr__(self):
        return "<%s name=%s members=%s member_groups=%s>" % (self.__class__,
                                                                   self.name,
                                                                   self.members,
                                                                   self.member_groups)


class BaseBackend(object):

    def __init__(self, request):
        self.request = request

    def __contains__(self, group_name):
        """
        Check if a group called <group_name> is available in this backend.
        """
        return self._exists_group(group_name)

    def __iter__(self):
        """
        Iterate over group names of the groups defined in this backend.

        @return: moin group names
        """
        backend_group_names = self._get_group_names()
        return (self.to_group_name(backend_group_name) for backend_group_name in backend_group_names)

    def __getitem__(self, group_name):
        """
        Get a group by its moin group name.
        """
        return self._get_group(group_name)

    # These methods should be overridden in children classes.
    def to_backend_name(self, group_name):
        """
        A function mapping the moin group name to the backend group name.
        """
        return group_name

    def to_group_name(self, backend_group_name):
        """
        A function mapping the backend group name to the moin group name.
        """
        return backend_group_name

    def _exists_group(self, group_name):
        """
        Check if the group <group_name> is defined in the backend.
        """
        raise NotImplementedError()

    def _get_group(self, group_name):
        """
        Retrieve a <group_name> group members from the backend.

        @return: a group with retrieved members. [Group]
        """
        raise NotImplementedError()

    def _get_group_names(self):
        """
        Retrieve moin group names stored in the backend.
        """
        raise NotImplementedError()