+
−"""Core hooks: synchronize living session on persistent data changes
+
−
+
−:organization: Logilab
+
−:copyright: 2001-2010 LOGILAB S.A. (Paris, FRANCE), license is LGPL v2.
+
−:contact: http://www.logilab.fr/ -- mailto:contact@logilab.fr
+
−:license: GNU Lesser General Public License, v2.1 - http://www.gnu.org/licenses
+
−"""
+
−__docformat__ = "restructuredtext en"
+
−
+
−from yams.schema import role_name
+
−from cubicweb import UnknownProperty, ValidationError, BadConnectionId
+
−from cubicweb.selectors import implements
+
−from cubicweb.server import hook
+
−
+
−
+
−def get_user_sessions(repo, ueid):
+
−    for session in repo._sessions.values():
+
−        if ueid == session.user.eid:
+
−            yield session
+
−
+
−
+
−class SyncSessionHook(hook.Hook):
+
−    __abstract__ = True
+
−    category = 'syncsession'
+
−
+
−
+
−# user/groups synchronisation #################################################
+
−
+
−class _GroupOperation(hook.Operation):
+
−    """base class for group operation"""
+
−    geid = None
+
−    def __init__(self, session, *args, **kwargs):
+
−        """override to get the group name before actual groups manipulation:
+
−
+
−        we may temporarily loose right access during a commit event, so
+
−        no query should be emitted while comitting
+
−        """
+
−        rql = 'Any N WHERE G eid %(x)s, G name N'
+
−        result = session.execute(rql, {'x': kwargs['geid']}, 'x', build_descr=False)
+
−        hook.Operation.__init__(self, session, *args, **kwargs)
+
−        self.group = result[0][0]
+
−
+
−
+
−class _DeleteGroupOp(_GroupOperation):
+
−    """synchronize user when a in_group relation has been deleted"""
+
−    def commit_event(self):
+
−        """the observed connections pool has been commited"""
+
−        groups = self.cnxuser.groups
+
−        try:
+
−            groups.remove(self.group)
+
−        except KeyError:
+
−            self.error('user %s not in group %s',  self.cnxuser, self.group)
+
−            return
+
−
+
−
+
−class _AddGroupOp(_GroupOperation):
+
−    """synchronize user when a in_group relation has been added"""
+
−    def commit_event(self):
+
−        """the observed connections pool has been commited"""
+
−        groups = self.cnxuser.groups
+
−        if self.group in groups:
+
−            self.warning('user %s already in group %s', self.cnxuser,
+
−                         self.group)
+
−            return
+
−        groups.add(self.group)
+
−
+
−
+
−class SyncInGroupHook(SyncSessionHook):
+
−    __regid__ = 'syncingroup'
+
−    __select__ = SyncSessionHook.__select__ & hook.match_rtype('in_group')
+
−    events = ('after_delete_relation', 'after_add_relation')
+
−
+
−    def __call__(self):
+
−        if self.event == 'after_delete_relation':
+
−            opcls = _DeleteGroupOp
+
−        else:
+
−            opcls = _AddGroupOp
+
−        for session in get_user_sessions(self._cw.repo, self.eidfrom):
+
−            opcls(self._cw, cnxuser=session.user, geid=self.eidto)
+
−
+
−
+
−class _DelUserOp(hook.Operation):
+
−    """close associated user's session when it is deleted"""
+
−    def __init__(self, session, cnxid):
+
−        self.cnxid = cnxid
+
−        hook.Operation.__init__(self, session)
+
−
+
−    def commit_event(self):
+
−        """the observed connections pool has been commited"""
+
−        try:
+
−            self.session.repo.close(self.cnxid)
+
−        except BadConnectionId:
+
−            pass # already closed
+
−
+
−
+
−class CloseDeletedUserSessionsHook(SyncSessionHook):
+
−    __regid__ = 'closession'
+
−    __select__ = SyncSessionHook.__select__ & implements('CWUser')
+
−    events = ('after_delete_entity',)
+
−
+
−    def __call__(self):
+
−        """modify user permission, need to update users"""
+
−        for session in get_user_sessions(self._cw.repo, self.entity.eid):
+
−            _DelUserOp(self._cw, session.id)
+
−
+
−
+
−# CWProperty hooks #############################################################
+
−
+
−
+
−class _DelCWPropertyOp(hook.Operation):
+
−    """a user's custom properties has been deleted"""
+
−
+
−    def commit_event(self):
+
−        """the observed connections pool has been commited"""
+
−        try:
+
−            del self.cwpropdict[self.key]
+
−        except KeyError:
+
−            self.error('%s has no associated value', self.key)
+
−
+
−
+
−class _ChangeCWPropertyOp(hook.Operation):
+
−    """a user's custom properties has been added/changed"""
+
−
+
−    def commit_event(self):
+
−        """the observed connections pool has been commited"""
+
−        self.cwpropdict[self.key] = self.value
+
−
+
−
+
−class _AddCWPropertyOp(hook.Operation):
+
−    """a user's custom properties has been added/changed"""
+
−
+
−    def commit_event(self):
+
−        """the observed connections pool has been commited"""
+
−        cwprop = self.cwprop
+
−        if not cwprop.for_user:
+
−            self.session.vreg['propertyvalues'][cwprop.pkey] = cwprop.value
+
−        # if for_user is set, update is handled by a ChangeCWPropertyOp operation
+
−
+
−
+
−class AddCWPropertyHook(SyncSessionHook):
+
−    __regid__ = 'addcwprop'
+
−    __select__ = SyncSessionHook.__select__ & implements('CWProperty')
+
−    events = ('after_add_entity',)
+
−
+
−    def __call__(self):
+
−        key, value = self.entity.pkey, self.entity.value
+
−        session = self._cw
+
−        try:
+
−            value = session.vreg.typed_value(key, value)
+
−        except UnknownProperty:
+
−            qname = role_name('pkey', 'subject')
+
−            raise ValidationError(self.entity.eid,
+
−                                  {qname: session._('unknown property key')})
+
−        except ValueError, ex:
+
−            qname = role_name('value', 'subject')
+
−            raise ValidationError(self.entity.eid,
+
−                                  {qname: session._(str(ex))})
+
−        if not session.user.matching_groups('managers'):
+
−            session.add_relation(self.entity.eid, 'for_user', session.user.eid)
+
−        else:
+
−            _AddCWPropertyOp(session, cwprop=self.entity)
+
−
+
−
+
−class UpdateCWPropertyHook(AddCWPropertyHook):
+
−    __regid__ = 'updatecwprop'
+
−    events = ('after_update_entity',)
+
−
+
−    def __call__(self):
+
−        entity = self.entity
+
−        if not ('pkey' in entity.edited_attributes or
+
−                'value' in entity.edited_attributes):
+
−            return
+
−        key, value = entity.pkey, entity.value
+
−        session = self._cw
+
−        try:
+
−            value = session.vreg.typed_value(key, value)
+
−        except UnknownProperty:
+
−            return
+
−        except ValueError, ex:
+
−            qname = role_name('value', 'subject')
+
−            raise ValidationError(entity.eid, {qname: session._(str(ex))})
+
−        if entity.for_user:
+
−            for session_ in get_user_sessions(session.repo, entity.for_user[0].eid):
+
−                _ChangeCWPropertyOp(session, cwpropdict=session_.user.properties,
+
−                                    key=key, value=value)
+
−        else:
+
−            # site wide properties
+
−            _ChangeCWPropertyOp(session, cwpropdict=session.vreg['propertyvalues'],
+
−                              key=key, value=value)
+
−
+
−
+
−class DeleteCWPropertyHook(AddCWPropertyHook):
+
−    __regid__ = 'delcwprop'
+
−    events = ('before_delete_entity',)
+
−
+
−    def __call__(self):
+
−        eid = self.entity.eid
+
−        session = self._cw
+
−        for eidfrom, rtype, eidto in session.transaction_data.get('pendingrelations', ()):
+
−            if rtype == 'for_user' and eidfrom == self.entity.eid:
+
−                # if for_user was set, delete has already been handled
+
−                break
+
−        else:
+
−            _DelCWPropertyOp(session, cwpropdict=session.vreg['propertyvalues'],
+
−                             key=self.entity.pkey)
+
−
+
−
+
−class AddForUserRelationHook(SyncSessionHook):
+
−    __regid__ = 'addcwpropforuser'
+
−    __select__ = SyncSessionHook.__select__ & hook.match_rtype('for_user')
+
−    events = ('after_add_relation',)
+
−
+
−    def __call__(self):
+
−        session = self._cw
+
−        eidfrom = self.eidfrom
+
−        if not session.describe(eidfrom)[0] == 'CWProperty':
+
−            return
+
−        key, value = session.execute('Any K,V WHERE P eid %(x)s,P pkey K,P value V',
+
−                                     {'x': eidfrom}, 'x')[0]
+
−        if session.vreg.property_info(key)['sitewide']:
+
−            qname = role_name('for_user', 'subject')
+
−            msg = session._("site-wide property can't be set for user")
+
−            raise ValidationError(eidfrom,
+
−                                  {qname: msg})
+
−        for session_ in get_user_sessions(session.repo, self.eidto):
+
−            _ChangeCWPropertyOp(session, cwpropdict=session_.user.properties,
+
−                              key=key, value=value)
+
−
+
−
+
−class DelForUserRelationHook(AddForUserRelationHook):
+
−    __regid__ = 'delcwpropforuser'
+
−    events = ('after_delete_relation',)
+
−
+
−    def __call__(self):
+
−        session = self._cw
+
−        key = session.execute('Any K WHERE P eid %(x)s, P pkey K',
+
−                              {'x': self.eidfrom}, 'x')[0][0]
+
−        session.transaction_data.setdefault('pendingrelations', []).append(
+
−            (self.eidfrom, self.rtype, self.eidto))
+
−        for session_ in get_user_sessions(session.repo, self.eidto):
+
−            _DelCWPropertyOp(session, cwpropdict=session_.user.properties, key=key)