indico/MaKaC/user.py

   1 # This file is part of Indico.
   2 # Copyright (C) 2002 - 2015 European Organization for Nuclear Research (CERN).
   3 #
   4 # Indico is free software; you can redistribute it and/or
   5 # modify it under the terms of the GNU General Public License as
   6 # published by the Free Software Foundation; either version 3 of the
   7 # License, or (at your option) any later version.
   8 #
   9 # Indico is distributed in the hope that it will be useful, but
  10 # WITHOUT ANY WARRANTY; without even the implied warranty of
  11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12 # General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU General Public License
  15 # along with Indico; if not, see <http://www.gnu.org/licenses/>.
  16
  17
  18 from flask_multipass import IdentityInfo
  19
  20 from MaKaC.common.cache import GenericCache
  21 from MaKaC.common.ObjectHolders import ObjectHolder
  22
  23 from indico.modules.users import User
  24 from indico.modules.users.legacy import AvatarProvisionalWrapper
  25
  26
  27 AVATAR_FIELD_MAP = {
  28     "email": "email",
  29     "name": "first_name",
  30     "surName": "last_name",
  31     "organisation": "affiliation"
  32 }
  33
  34
  35 class AvatarHolder(ObjectHolder):
  36     """Specialised ObjectHolder dealing with user (avatar) objects. Objects of
  37        this class represent an access point to Avatars of the application and
  38        provides different methods for accessing and retrieving them in several
  39        ways.
  40     """
  41     idxName = "avatars"
  42     counterName = "PRINCIPAL"
  43
  44     def match(self, criteria, exact=False, onlyActivated=True, searchInAuthenticators=False):
  45         from indico.modules.users.util import search_users
  46         cache = GenericCache('pending_identities')
  47
  48         def _process_identities(obj):
  49             if isinstance(obj, IdentityInfo):
  50                 cache.set(obj.provider.name + ":" + obj.identifier, obj.data)
  51                 return AvatarProvisionalWrapper(obj)
  52             else:
  53                 return obj.as_avatar
  54
  55         results = search_users(exact=exact, include_pending=not onlyActivated, include_deleted=not onlyActivated,
  56                                external=searchInAuthenticators,
  57                                **{AVATAR_FIELD_MAP[k]: v for (k, v) in criteria.iteritems() if v})
  58
  59         return [_process_identities(obj) for obj in results]
  60
  61     def getById(self, id):
  62         if isinstance(id, int) or id.isdigit():
  63             user = User.get(int(id))
  64             if user:
  65                 return user.as_avatar