app/soc/logic/rights.py
author Daniel Hans <Daniel.M.Hans@gmail.com>
Fri, 07 Aug 2009 01:27:24 +0200
changeset 2736 8f3935f0f4ba
parent 1528 abbdf42ab322
child 2956 50ce8ac13932
permissions -rw-r--r--
Argument store added to updateEntityProperties. This argument determines if an entity should be stored in the data model after its properties are updated. It may be useful, for example, along with tasks (Task Queue API). One may want to make some modifications to an entity during execution of a task, but the developer is sure that at least one new task, which also wants to modify the entity, will be queued, so he or she can just update the entity without saving the changes to the data model, set the entity in memcache and the following task (which is to be executed very shortly) is to retrive the current entity from the memcache (without any expensive calls to the actual data model).

#!/usr/bin/python2.5
#
# Copyright 2009 the Melange authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""Module with rights related methods.
"""

__authors__ = [
  '"Sverre Rabbelier" <sverre@rabbelier.nl>',
  ]


from soc.logic import dicts


class Checker(object):
  """Checker class that maps from prefix and status to membership.
  """

  SITE_MEMBERSHIP = {
      'admin': [],
      'restricted': ['host'],
      'member': ['user'],
      'list': ['host'],
      }

  CLUB_MEMBERSHIP = {
      'admin': ['host', 'club_admin'],
      'restricted': ['host', 'club_admin'],
      'member': ['host', 'club_admin', 'club_member'],
      'list': ['host', 'club_admin', 'club_member'],
      }

  SPONSOR_MEMBERSHIP = {
      'admin': ['host'],
      'restricted': ['host'],
      'member': ['host'],
      'list': ['host'],
      }

  PROGRAM_MEMBERSHIP = {
      'admin': ['host'],
      'restricted': ['host', 'org_admin'],
      'member': ['host', 'org_admin', 'org_mentor', 'org_student'],
      'list': ['host', 'org_admin', 'org_mentor'],
      }

  ORGANIZATION_MEMBERSHIP = {
      'admin': ['host', 'org_admin'],
      'restricted': ['host', 'org_admin', 'org_mentor'],
      'member': ['host', 'org_admin', 'org_mentor', 'org_student'],
      'list': ['host', 'org_admin', 'org_mentor'],
      }

  USER_MEMBERSHIP = {
      'admin': ['user_self'],
      'restricted': ['user_self'], # ,'friends'
      'member': ['user'],
      'list': ['user_self'],
      }

  RIGHTS = {
      'site': SITE_MEMBERSHIP,
      'club': CLUB_MEMBERSHIP,
      'sponsor': SPONSOR_MEMBERSHIP,
      'program': PROGRAM_MEMBERSHIP,
      'org': ORGANIZATION_MEMBERSHIP,
      'user': USER_MEMBERSHIP,
      }

  def __init__(self, prefix):
    """Constructs a Checker for the specified prefix.
    """

    self.prefix = prefix
    self.rights = self.RIGHTS[prefix]

  def getMembership(self, status):
    """Retrieves the membership list for the specified status.
    """

    if status == 'user':
      return ['user']

    if status == 'public':
      return ['anyone']

    return self.rights[status]

  def getMemberships(self):
    """Returns all memberships for the configured prefix.
    """

    extra_rights = {
        'user': ['user'],
        'public': ['anyone'],
        'list': [],
        }

    return dicts.merge(extra_rights, self.rights)