libervia-pubsub: sat_pubsub/privilege.py annotate

annotate sat_pubsub/privilege.py @ 467:d86e0f8a1405

privilege: store roster cache in database: - rosters are now stored on database and restored on startup. This way, presence map can be restored without the need to wait for all contact to send presence again - roster version are checked, if a new version is received, presence map is updated accordingly - roster are not retrieved if presence are received in a too short delay (see ROSTER_TTL), to avoid using too much resources if a client connect/disconnect a lot The current behaviour works around XEP-0356 limitations. An update of the XEP will be needed to get roster pushes and roster version.

author	Goffi <goffi@goffi.org>
date	Fri, 15 Oct 2021 15:30:18 +0200
parents	f520ac3164b0
children	a549c8e17827

rev	line source
414 ccb2a22ea0fc Python 3 port: Goffi <goffi@goffi.org> parents: 405 diff changeset	1 #!/usr/bin/env python3
242 a6170637690d remote roster partial support Goffi <goffi@goffi.org> parents: diff changeset	2 #
460 607616f9ef5b backend: new `server_jid` option: Goffi <goffi@goffi.org> parents: 455 diff changeset	3 # Copyright (c) 2015-2021 Jérôme Poisson
242 a6170637690d remote roster partial support Goffi <goffi@goffi.org> parents: diff changeset	4
a6170637690d remote roster partial support Goffi <goffi@goffi.org> parents: diff changeset	5
312 5d7c3787672e fixed copyright put in docstring instead of comments Goffi <goffi@goffi.org> parents: 293 diff changeset	6 # This program is free software: you can redistribute it and/or modify
5d7c3787672e fixed copyright put in docstring instead of comments Goffi <goffi@goffi.org> parents: 293 diff changeset	7 # it under the terms of the GNU Affero General Public License as published by
5d7c3787672e fixed copyright put in docstring instead of comments Goffi <goffi@goffi.org> parents: 293 diff changeset	8 # the Free Software Foundation, either version 3 of the License, or
5d7c3787672e fixed copyright put in docstring instead of comments Goffi <goffi@goffi.org> parents: 293 diff changeset	9 # (at your option) any later version.
242 a6170637690d remote roster partial support Goffi <goffi@goffi.org> parents: diff changeset	10
312 5d7c3787672e fixed copyright put in docstring instead of comments Goffi <goffi@goffi.org> parents: 293 diff changeset	11 # This program is distributed in the hope that it will be useful,
5d7c3787672e fixed copyright put in docstring instead of comments Goffi <goffi@goffi.org> parents: 293 diff changeset	12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
5d7c3787672e fixed copyright put in docstring instead of comments Goffi <goffi@goffi.org> parents: 293 diff changeset	13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
5d7c3787672e fixed copyright put in docstring instead of comments Goffi <goffi@goffi.org> parents: 293 diff changeset	14 # GNU Affero General Public License for more details.
242 a6170637690d remote roster partial support Goffi <goffi@goffi.org> parents: diff changeset	15
312 5d7c3787672e fixed copyright put in docstring instead of comments Goffi <goffi@goffi.org> parents: 293 diff changeset	16 # You should have received a copy of the GNU Affero General Public License
5d7c3787672e fixed copyright put in docstring instead of comments Goffi <goffi@goffi.org> parents: 293 diff changeset	17 # along with this program. If not, see <http://www.gnu.org/licenses/>.
242 a6170637690d remote roster partial support Goffi <goffi@goffi.org> parents: diff changeset	18
460 607616f9ef5b backend: new `server_jid` option: Goffi <goffi@goffi.org> parents: 455 diff changeset	19 "This module implements XEP-0356 (Privileged Entity) to manage rosters, messages and "
607616f9ef5b backend: new `server_jid` option: Goffi <goffi@goffi.org> parents: 455 diff changeset	20 "presences"
242 a6170637690d remote roster partial support Goffi <goffi@goffi.org> parents: diff changeset	21
463 f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	22 import time
467 d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	23 from typing import Optional, Dict, List, Set
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	24 from datetime import datetime, timezone
242 a6170637690d remote roster partial support Goffi <goffi@goffi.org> parents: diff changeset	25 from wokkel import xmppim
a6170637690d remote roster partial support Goffi <goffi@goffi.org> parents: diff changeset	26 from wokkel.compat import IQ
293 b96a4ac25f8b privilege: added methods to send privileged messages and notifications Goffi <goffi@goffi.org> parents: 286 diff changeset	27 from wokkel import pubsub
338 6d059f07c2d3 privilege: added presence and +notify initial support: Goffi <goffi@goffi.org> parents: 321 diff changeset	28 from wokkel import disco
293 b96a4ac25f8b privilege: added methods to send privileged messages and notifications Goffi <goffi@goffi.org> parents: 286 diff changeset	29 from wokkel.iwokkel import IPubSubService
285 a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	30 from twisted.python import log
a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	31 from twisted.python import failure
338 6d059f07c2d3 privilege: added presence and +notify initial support: Goffi <goffi@goffi.org> parents: 321 diff changeset	32 from twisted.internet import defer
293 b96a4ac25f8b privilege: added methods to send privileged messages and notifications Goffi <goffi@goffi.org> parents: 286 diff changeset	33 from twisted.words.xish import domish
435 96342e7e9f5d privilege: log error when `requestInfo` is failing Goffi <goffi@goffi.org> parents: 414 diff changeset	34 from twisted.words.protocols.jabber import jid, error
242 a6170637690d remote roster partial support Goffi <goffi@goffi.org> parents: diff changeset	35
293 b96a4ac25f8b privilege: added methods to send privileged messages and notifications Goffi <goffi@goffi.org> parents: 286 diff changeset	36 FORWARDED_NS = 'urn:xmpp:forward:0'
285 a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	37 PRIV_ENT_NS = 'urn:xmpp:privilege:1'
a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	38 PRIV_ENT_ADV_XPATH = '/message/privilege[@xmlns="{}"]'.format(PRIV_ENT_NS)
a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	39 ROSTER_NS = 'jabber:iq:roster'
a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	40 PERM_ROSTER = 'roster'
a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	41 PERM_MESSAGE = 'message'
a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	42 PERM_PRESENCE = 'presence'
a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	43 ALLOWED_ROSTER = ('none', 'get', 'set', 'both')
a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	44 ALLOWED_MESSAGE = ('none', 'outgoing')
a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	45 ALLOWED_PRESENCE = ('none', 'managed_entity', 'roster')
463 f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	46 TO_CHECK = {
f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	47 PERM_ROSTER:ALLOWED_ROSTER,
f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	48 PERM_MESSAGE:ALLOWED_MESSAGE,
f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	49 PERM_PRESENCE:ALLOWED_PRESENCE
f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	50 }
242 a6170637690d remote roster partial support Goffi <goffi@goffi.org> parents: diff changeset	51
467 d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	52 # Number of seconds before a roster cache is not considered valid anymore.
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	53 # We keep this delay to avoid requesting roster too much in a row if an entity is
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	54 # connecting/disconnecting often in a short time.
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	55 ROSTER_TTL = 3600
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	56
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	57
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	58 Roster = Dict[jid.JID, xmppim.RosterItem]
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	59
285 a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	60
a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	61 class InvalidStanza(Exception):
a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	62 pass
a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	63
a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	64 class NotAllowedError(Exception):
a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	65 pass
a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	66
338 6d059f07c2d3 privilege: added presence and +notify initial support: Goffi <goffi@goffi.org> parents: 321 diff changeset	67 class PrivilegesHandler(disco.DiscoClientProtocol):
463 f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	68 # FIXME: need to manage updates, XEP-0356 must be updated to get roster pushes
f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	69 # TODO: cache
242 a6170637690d remote roster partial support Goffi <goffi@goffi.org> parents: diff changeset	70
321 c7fe09894952 privilege: better handling of main message 'to' attribute (i.e. privileged entity's server) Goffi <goffi@goffi.org> parents: 312 diff changeset	71 def __init__(self, service_jid):
285 a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	72 super(PrivilegesHandler, self).__init__()
460 607616f9ef5b backend: new `server_jid` option: Goffi <goffi@goffi.org> parents: 455 diff changeset	73 self.backend = None
285 a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	74 self._permissions = {PERM_ROSTER: 'none',
a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	75 PERM_MESSAGE: 'none',
a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	76 PERM_PRESENCE: 'none'}
293 b96a4ac25f8b privilege: added methods to send privileged messages and notifications Goffi <goffi@goffi.org> parents: 286 diff changeset	77 self._pubsub_service = None
343 ff8aff4c9b79 backend, psql: implemented notifications for auto subscribers in PEP: Goffi <goffi@goffi.org> parents: 342 diff changeset	78 self.caps_map = {} # key: bare jid, value: dict of resources with caps hash
460 607616f9ef5b backend: new `server_jid` option: Goffi <goffi@goffi.org> parents: 455 diff changeset	79 # key: (hash,version), value: dict with DiscoInfo instance (infos) and nodes to
607616f9ef5b backend: new `server_jid` option: Goffi <goffi@goffi.org> parents: 455 diff changeset	80 # notify (notify)
607616f9ef5b backend: new `server_jid` option: Goffi <goffi@goffi.org> parents: 455 diff changeset	81 self.hash_map = {}
467 d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	82 # dict which will be filled from database once connection is initialized,
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	83 # key: jid, value: dict with "timestamp" and "roster"
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	84 self.roster_cache = None
463 f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	85 # key: jid, value: set of entities who need to receive a notification when we
f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	86 # get a presence from them. All entities in value have a presence subscription
f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	87 # to the key entity.
f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	88 self.presence_map = {}
f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	89 # resource currently online
f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	90 self.presences = set()
285 a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	91
a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	92 @property
a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	93 def permissions(self):
a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	94 return self._permissions
a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	95
467 d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	96 async def getRosterCacheFromDB(self):
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	97 rows = await self.backend.storage.getRosterCache()
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	98 for __, owner_jid, version, timestamp, roster_elt in rows:
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	99 roster = self.getRosterFromElement(roster_elt)
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	100 self.roster_cache[owner_jid] = {
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	101 "timestamp": timestamp,
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	102 "roster": roster,
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	103 "version": version
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	104 }
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	105 self.updatePresenceMap(owner_jid, roster, None)
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	106
285 a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	107 def connectionInitialized(self):
293 b96a4ac25f8b privilege: added methods to send privileged messages and notifications Goffi <goffi@goffi.org> parents: 286 diff changeset	108 for handler in self.parent.handlers:
b96a4ac25f8b privilege: added methods to send privileged messages and notifications Goffi <goffi@goffi.org> parents: 286 diff changeset	109 if IPubSubService.providedBy(handler):
b96a4ac25f8b privilege: added methods to send privileged messages and notifications Goffi <goffi@goffi.org> parents: 286 diff changeset	110 self._pubsub_service = handler
b96a4ac25f8b privilege: added methods to send privileged messages and notifications Goffi <goffi@goffi.org> parents: 286 diff changeset	111 break
460 607616f9ef5b backend: new `server_jid` option: Goffi <goffi@goffi.org> parents: 455 diff changeset	112 self.backend = self.parent.parent.getServiceNamed('backend')
285 a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	113 self.xmlstream.addObserver(PRIV_ENT_ADV_XPATH, self.onAdvertise)
460 607616f9ef5b backend: new `server_jid` option: Goffi <goffi@goffi.org> parents: 455 diff changeset	114 self.xmlstream.addObserver('/presence', self._onPresence)
467 d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	115 if self.roster_cache is None:
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	116 self.roster_cache = {}
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	117 defer.ensureDeferred(self.getRosterCacheFromDB())
285 a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	118
a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	119 def onAdvertise(self, message):
a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	120 """Managage the <message/> advertising privileges
a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	121
a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	122 self._permissions will be updated according to advertised privileged
a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	123 """
414 ccb2a22ea0fc Python 3 port: Goffi <goffi@goffi.org> parents: 405 diff changeset	124 privilege_elt = next(message.elements(PRIV_ENT_NS, 'privilege'))
285 a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	125 for perm_elt in privilege_elt.elements(PRIV_ENT_NS):
a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	126 try:
a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	127 if perm_elt.name != 'perm':
414 ccb2a22ea0fc Python 3 port: Goffi <goffi@goffi.org> parents: 405 diff changeset	128 raise InvalidStanza('unexpected element {}'.format(perm_elt.name))
285 a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	129 perm_access = perm_elt['access']
a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	130 perm_type = perm_elt['type']
a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	131 try:
a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	132 if perm_type not in TO_CHECK[perm_access]:
463 f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	133 raise InvalidStanza(
f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	134 'bad type [{}] for permission {}'
f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	135 .format(perm_type, perm_access)
f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	136 )
285 a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	137 except KeyError:
414 ccb2a22ea0fc Python 3 port: Goffi <goffi@goffi.org> parents: 405 diff changeset	138 raise InvalidStanza('bad permission [{}]'.format(perm_access))
285 a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	139 except InvalidStanza as e:
463 f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	140 log.msg(
f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	141 f"Invalid stanza received ({e}), setting permission to none"
f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	142 )
285 a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	143 for perm in self._permissions:
a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	144 self._permissions[perm] = 'none'
a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	145 break
a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	146
a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	147 self._permissions[perm_access] = perm_type or 'none'
a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	148
463 f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	149 log.msg(
f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	150 'Privileges updated: roster={roster}, message={message}, presence={presence}'
f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	151 .format(**self._permissions)
f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	152 )
285 a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	153
293 b96a4ac25f8b privilege: added methods to send privileged messages and notifications Goffi <goffi@goffi.org> parents: 286 diff changeset	154 ## roster ##
285 a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	155
467 d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	156 def updatePresenceMap(
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	157 self,
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	158 owner_jid: jid.JID,
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	159 roster: Roster,
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	160 old_roster: Optional[Roster]
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	161 ) -> None:
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	162 """Update ``self.presence_map`` from roster
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	163
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	164 @param owner_jid: jid of the owner of the roster
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	165 @param roster: roster dict as returned by self.getRoster
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	166 @param old_roster: previously cached roster if any
242 a6170637690d remote roster partial support Goffi <goffi@goffi.org> parents: diff changeset	167 """
467 d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	168 if old_roster is not None:
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	169 # we check if presence subscription have not been removed and update
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	170 # presence_map accordingly
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	171 for roster_jid, roster_item in old_roster.items():
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	172 if ((roster_item.subscriptionFrom
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	173 and (roster_jid not in roster
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	174 or not roster[roster_jid].subscriptionFrom)
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	175 )):
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	176 try:
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	177 self.presence_map[roster_jid].discard(owner_jid)
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	178 except KeyError:
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	179 pass
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	180 if ((roster_item.subscriptionTo
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	181 and (roster_jid not in roster
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	182 or not roster[roster_jid].subscriptionTo)
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	183 )):
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	184 try:
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	185 self.presence_map[owner_jid].discard(roster_jid)
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	186 except KeyError:
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	187 pass
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	188
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	189 for roster_jid, roster_item in roster.items():
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	190 if roster_item.subscriptionFrom:
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	191 # we need to know who is subscribed to our user, to send them
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	192 # notifications when they send presence to us
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	193 self.presence_map.setdefault(roster_jid, set()).add(owner_jid)
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	194 if ((roster_item.subscriptionTo
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	195 and jid.JID(roster_jid.host) == self.backend.server_jid)):
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	196 # we also need to know who on this server we are subscribed to, so
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	197 # we can get their notifications even if they didn't connect so far.
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	198 self.presence_map.setdefault(owner_jid, set()).add(roster_jid)
242 a6170637690d remote roster partial support Goffi <goffi@goffi.org> parents: diff changeset	199
467 d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	200 def serialiseRoster(
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	201 self,
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	202 roster: Roster,
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	203 version: Optional[str] = None
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	204 ) -> domish.Element:
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	205 """Reconstruct Query element of the roster"""
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	206 roster_elt = domish.Element((ROSTER_NS, "query"))
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	207 if version:
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	208 roster_elt["ver"] = version
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	209 for item in roster.values():
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	210 roster_elt.addChild(item.toElement())
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	211 return roster_elt
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	212
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	213 async def updateRosterCache(
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	214 self,
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	215 owner_jid: jid.JID,
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	216 roster: Roster,
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	217 version: str
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	218 ) -> None:
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	219 """Update local roster cache and database"""
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	220 now = time.time()
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	221 self.roster_cache[owner_jid] = {
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	222 'timestamp': now,
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	223 'roster': roster,
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	224 'version': version
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	225 }
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	226 roster_elt = self.serialiseRoster(roster, version)
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	227 await self.backend.storage.setRosterCache(
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	228 owner_jid, version, now, roster_elt
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	229 )
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	230
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	231 def getRosterFromElement(self, query_elt: domish.Element) -> Roster:
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	232 """Parse roster query result payload to get a Roster dict"""
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	233 roster = {}
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	234 for element in query_elt.elements(ROSTER_NS, 'item'):
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	235 item = xmppim.RosterItem.fromElement(element)
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	236 roster[item.entity] = item
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	237 return roster
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	238
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	239 async def getRoster(self, to_jid: jid.JID) -> Roster:
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	240 """Retrieve contact list.
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	241
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	242 @param to_jid: jid of the entity owning the roster
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	243 @return: roster data
242 a6170637690d remote roster partial support Goffi <goffi@goffi.org> parents: diff changeset	244 """
285 a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	245 if self._permissions[PERM_ROSTER] not in ('get', 'both'):
a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	246 log.msg("WARNING: permission not allowed to get roster")
a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	247 raise failure.Failure(NotAllowedError('roster get is not allowed'))
242 a6170637690d remote roster partial support Goffi <goffi@goffi.org> parents: diff changeset	248
a6170637690d remote roster partial support Goffi <goffi@goffi.org> parents: diff changeset	249 iq = IQ(self.xmlstream, 'get')
285 a87c155d0fd5 replaced former roster dirty hack by a XEP-0356 first draft implementation, only roster get is implemented so far Goffi <goffi@goffi.org> parents: 283 diff changeset	250 iq.addElement((ROSTER_NS, 'query'))
242 a6170637690d remote roster partial support Goffi <goffi@goffi.org> parents: diff changeset	251 iq["to"] = to_jid.userhost()
467 d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	252 iq_result = await iq.send()
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	253 roster = self.getRosterFromElement(iq_result.query)
293 b96a4ac25f8b privilege: added methods to send privileged messages and notifications Goffi <goffi@goffi.org> parents: 286 diff changeset	254
467 d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	255 version = iq_result.query.getAttribute('ver')
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	256 cached_roster = self.roster_cache.get("to_jid")
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	257 if not cached_roster:
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	258 self.updatePresenceMap(to_jid, roster, None)
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	259 await self.updateRosterCache(to_jid, roster, version)
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	260 else:
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	261 # we already have a roster in cache, we have to check it if the new one is
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	262 # modified, and update presence_map and database
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	263 if version:
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	264 if cached_roster["version"] != version:
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	265 self.updatePresenceMap(to_jid, roster, cached_roster["roster"])
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	266 await self.updateRosterCache(to_jid, roster, version)
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	267 else:
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	268 cached_roster["timestamp"] = time.time()
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	269 else:
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	270 # no version available, we have to compare the whole XML
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	271 if ((self.serialiseRoster(cached_roster["roster"]).toXml() !=
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	272 self.serialiseRoster(roster))):
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	273 self.updatePresenceMap(to_jid, roster, cached_roster["roster"])
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	274 await self.updateRosterCache(to_jid, roster, version)
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	275 else:
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	276 cached_roster["timestamp"] = time.time()
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	277
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	278 return roster
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	279
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	280 async def isSubscribedFrom(self, entity: jid.JID, roster_owner_jid: jid.JID) -> bool:
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	281 """Check if entity has presence subscription from roster_owner_jid
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	282
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	283 @param entity: entity to check subscription to
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	284 @param roster_owner_jid: owner of the roster to check
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	285 @return: True if entity has a subscription from roster_owner_jid
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	286 """
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	287 roster = await self.getRoster(roster_owner_jid)
348 d1f63ae1eaf4 privilege: added isSubscribedFrom method to check if an entity has presence subscription from an other entity. Goffi <goffi@goffi.org> parents: 343 diff changeset	288 try:
d1f63ae1eaf4 privilege: added isSubscribedFrom method to check if an entity has presence subscription from an other entity. Goffi <goffi@goffi.org> parents: 343 diff changeset	289 return roster[entity.userhostJID()].subscriptionFrom
d1f63ae1eaf4 privilege: added isSubscribedFrom method to check if an entity has presence subscription from an other entity. Goffi <goffi@goffi.org> parents: 343 diff changeset	290 except KeyError:
d1f63ae1eaf4 privilege: added isSubscribedFrom method to check if an entity has presence subscription from an other entity. Goffi <goffi@goffi.org> parents: 343 diff changeset	291 return False
d1f63ae1eaf4 privilege: added isSubscribedFrom method to check if an entity has presence subscription from an other entity. Goffi <goffi@goffi.org> parents: 343 diff changeset	292
293 b96a4ac25f8b privilege: added methods to send privileged messages and notifications Goffi <goffi@goffi.org> parents: 286 diff changeset	293 ## message ##
b96a4ac25f8b privilege: added methods to send privileged messages and notifications Goffi <goffi@goffi.org> parents: 286 diff changeset	294
321 c7fe09894952 privilege: better handling of main message 'to' attribute (i.e. privileged entity's server) Goffi <goffi@goffi.org> parents: 312 diff changeset	295 def sendMessage(self, priv_message, to_jid=None):
348 d1f63ae1eaf4 privilege: added isSubscribedFrom method to check if an entity has presence subscription from an other entity. Goffi <goffi@goffi.org> parents: 343 diff changeset	296 """Send privileged message (in the name of the server)
293 b96a4ac25f8b privilege: added methods to send privileged messages and notifications Goffi <goffi@goffi.org> parents: 286 diff changeset	297
b96a4ac25f8b privilege: added methods to send privileged messages and notifications Goffi <goffi@goffi.org> parents: 286 diff changeset	298 @param priv_message(domish.Element): privileged message
321 c7fe09894952 privilege: better handling of main message 'to' attribute (i.e. privileged entity's server) Goffi <goffi@goffi.org> parents: 312 diff changeset	299 @param to_jid(jid.JID, None): main message destinee
c7fe09894952 privilege: better handling of main message 'to' attribute (i.e. privileged entity's server) Goffi <goffi@goffi.org> parents: 312 diff changeset	300 None to use our own server
293 b96a4ac25f8b privilege: added methods to send privileged messages and notifications Goffi <goffi@goffi.org> parents: 286 diff changeset	301 """
b96a4ac25f8b privilege: added methods to send privileged messages and notifications Goffi <goffi@goffi.org> parents: 286 diff changeset	302 if self._permissions[PERM_MESSAGE] not in ('outgoing',):
b96a4ac25f8b privilege: added methods to send privileged messages and notifications Goffi <goffi@goffi.org> parents: 286 diff changeset	303 log.msg("WARNING: permission not allowed to send privileged messages")
b96a4ac25f8b privilege: added methods to send privileged messages and notifications Goffi <goffi@goffi.org> parents: 286 diff changeset	304 raise failure.Failure(NotAllowedError('privileged messages are not allowed'))
b96a4ac25f8b privilege: added methods to send privileged messages and notifications Goffi <goffi@goffi.org> parents: 286 diff changeset	305
b96a4ac25f8b privilege: added methods to send privileged messages and notifications Goffi <goffi@goffi.org> parents: 286 diff changeset	306 main_message = domish.Element((None, "message"))
321 c7fe09894952 privilege: better handling of main message 'to' attribute (i.e. privileged entity's server) Goffi <goffi@goffi.org> parents: 312 diff changeset	307 if to_jid is None:
460 607616f9ef5b backend: new `server_jid` option: Goffi <goffi@goffi.org> parents: 455 diff changeset	308 to_jid = self.backend.server_jid
293 b96a4ac25f8b privilege: added methods to send privileged messages and notifications Goffi <goffi@goffi.org> parents: 286 diff changeset	309 main_message['to'] = to_jid.full()
b96a4ac25f8b privilege: added methods to send privileged messages and notifications Goffi <goffi@goffi.org> parents: 286 diff changeset	310 privilege_elt = main_message.addElement((PRIV_ENT_NS, 'privilege'))
b96a4ac25f8b privilege: added methods to send privileged messages and notifications Goffi <goffi@goffi.org> parents: 286 diff changeset	311 forwarded_elt = privilege_elt.addElement((FORWARDED_NS, 'forwarded'))
b96a4ac25f8b privilege: added methods to send privileged messages and notifications Goffi <goffi@goffi.org> parents: 286 diff changeset	312 priv_message['xmlns'] = 'jabber:client'
b96a4ac25f8b privilege: added methods to send privileged messages and notifications Goffi <goffi@goffi.org> parents: 286 diff changeset	313 forwarded_elt.addChild(priv_message)
b96a4ac25f8b privilege: added methods to send privileged messages and notifications Goffi <goffi@goffi.org> parents: 286 diff changeset	314 self.send(main_message)
b96a4ac25f8b privilege: added methods to send privileged messages and notifications Goffi <goffi@goffi.org> parents: 286 diff changeset	315
b96a4ac25f8b privilege: added methods to send privileged messages and notifications Goffi <goffi@goffi.org> parents: 286 diff changeset	316 def notifyPublish(self, pep_jid, nodeIdentifier, notifications):
b96a4ac25f8b privilege: added methods to send privileged messages and notifications Goffi <goffi@goffi.org> parents: 286 diff changeset	317 """Do notifications using privileges"""
b96a4ac25f8b privilege: added methods to send privileged messages and notifications Goffi <goffi@goffi.org> parents: 286 diff changeset	318 for subscriber, subscriptions, items in notifications:
455 0b5233981671 backend: fix `delete` notification + add `purge` notification Goffi <goffi@goffi.org> parents: 435 diff changeset	319 message = self._pubsub_service._createNotification(
0b5233981671 backend: fix `delete` notification + add `purge` notification Goffi <goffi@goffi.org> parents: 435 diff changeset	320 'items',
0b5233981671 backend: fix `delete` notification + add `purge` notification Goffi <goffi@goffi.org> parents: 435 diff changeset	321 pep_jid,
0b5233981671 backend: fix `delete` notification + add `purge` notification Goffi <goffi@goffi.org> parents: 435 diff changeset	322 nodeIdentifier,
0b5233981671 backend: fix `delete` notification + add `purge` notification Goffi <goffi@goffi.org> parents: 435 diff changeset	323 subscriber,
0b5233981671 backend: fix `delete` notification + add `purge` notification Goffi <goffi@goffi.org> parents: 435 diff changeset	324 subscriptions
0b5233981671 backend: fix `delete` notification + add `purge` notification Goffi <goffi@goffi.org> parents: 435 diff changeset	325 )
293 b96a4ac25f8b privilege: added methods to send privileged messages and notifications Goffi <goffi@goffi.org> parents: 286 diff changeset	326 for item in items:
b96a4ac25f8b privilege: added methods to send privileged messages and notifications Goffi <goffi@goffi.org> parents: 286 diff changeset	327 item.uri = pubsub.NS_PUBSUB_EVENT
b96a4ac25f8b privilege: added methods to send privileged messages and notifications Goffi <goffi@goffi.org> parents: 286 diff changeset	328 message.event.items.addChild(item)
321 c7fe09894952 privilege: better handling of main message 'to' attribute (i.e. privileged entity's server) Goffi <goffi@goffi.org> parents: 312 diff changeset	329 self.sendMessage(message)
293 b96a4ac25f8b privilege: added methods to send privileged messages and notifications Goffi <goffi@goffi.org> parents: 286 diff changeset	330
b96a4ac25f8b privilege: added methods to send privileged messages and notifications Goffi <goffi@goffi.org> parents: 286 diff changeset	331 def notifyRetract(self, pep_jid, nodeIdentifier, notifications):
b96a4ac25f8b privilege: added methods to send privileged messages and notifications Goffi <goffi@goffi.org> parents: 286 diff changeset	332 for subscriber, subscriptions, items in notifications:
455 0b5233981671 backend: fix `delete` notification + add `purge` notification Goffi <goffi@goffi.org> parents: 435 diff changeset	333 message = self._pubsub_service._createNotification(
0b5233981671 backend: fix `delete` notification + add `purge` notification Goffi <goffi@goffi.org> parents: 435 diff changeset	334 'items',
0b5233981671 backend: fix `delete` notification + add `purge` notification Goffi <goffi@goffi.org> parents: 435 diff changeset	335 pep_jid,
0b5233981671 backend: fix `delete` notification + add `purge` notification Goffi <goffi@goffi.org> parents: 435 diff changeset	336 nodeIdentifier,
0b5233981671 backend: fix `delete` notification + add `purge` notification Goffi <goffi@goffi.org> parents: 435 diff changeset	337 subscriber,
0b5233981671 backend: fix `delete` notification + add `purge` notification Goffi <goffi@goffi.org> parents: 435 diff changeset	338 subscriptions
0b5233981671 backend: fix `delete` notification + add `purge` notification Goffi <goffi@goffi.org> parents: 435 diff changeset	339 )
293 b96a4ac25f8b privilege: added methods to send privileged messages and notifications Goffi <goffi@goffi.org> parents: 286 diff changeset	340 for item in items:
b96a4ac25f8b privilege: added methods to send privileged messages and notifications Goffi <goffi@goffi.org> parents: 286 diff changeset	341 retract = domish.Element((None, "retract"))
b96a4ac25f8b privilege: added methods to send privileged messages and notifications Goffi <goffi@goffi.org> parents: 286 diff changeset	342 retract['id'] = item['id']
b96a4ac25f8b privilege: added methods to send privileged messages and notifications Goffi <goffi@goffi.org> parents: 286 diff changeset	343 message.event.items.addChild(retract)
321 c7fe09894952 privilege: better handling of main message 'to' attribute (i.e. privileged entity's server) Goffi <goffi@goffi.org> parents: 312 diff changeset	344 self.sendMessage(message)
293 b96a4ac25f8b privilege: added methods to send privileged messages and notifications Goffi <goffi@goffi.org> parents: 286 diff changeset	345
455 0b5233981671 backend: fix `delete` notification + add `purge` notification Goffi <goffi@goffi.org> parents: 435 diff changeset	346 def notifyDelete(self, pep_jid, nodeIdentifier, subscribers, redirectURI=None):
0b5233981671 backend: fix `delete` notification + add `purge` notification Goffi <goffi@goffi.org> parents: 435 diff changeset	347 for subscriber in subscribers:
0b5233981671 backend: fix `delete` notification + add `purge` notification Goffi <goffi@goffi.org> parents: 435 diff changeset	348 message = self._pubsub_service._createNotification(
0b5233981671 backend: fix `delete` notification + add `purge` notification Goffi <goffi@goffi.org> parents: 435 diff changeset	349 'delete',
0b5233981671 backend: fix `delete` notification + add `purge` notification Goffi <goffi@goffi.org> parents: 435 diff changeset	350 pep_jid,
0b5233981671 backend: fix `delete` notification + add `purge` notification Goffi <goffi@goffi.org> parents: 435 diff changeset	351 nodeIdentifier,
0b5233981671 backend: fix `delete` notification + add `purge` notification Goffi <goffi@goffi.org> parents: 435 diff changeset	352 subscriber
0b5233981671 backend: fix `delete` notification + add `purge` notification Goffi <goffi@goffi.org> parents: 435 diff changeset	353 )
0b5233981671 backend: fix `delete` notification + add `purge` notification Goffi <goffi@goffi.org> parents: 435 diff changeset	354 if redirectURI:
0b5233981671 backend: fix `delete` notification + add `purge` notification Goffi <goffi@goffi.org> parents: 435 diff changeset	355 redirect = message.event.delete.addElement('redirect')
0b5233981671 backend: fix `delete` notification + add `purge` notification Goffi <goffi@goffi.org> parents: 435 diff changeset	356 redirect['uri'] = redirectURI
0b5233981671 backend: fix `delete` notification + add `purge` notification Goffi <goffi@goffi.org> parents: 435 diff changeset	357 self.sendMessage(message)
293 b96a4ac25f8b privilege: added methods to send privileged messages and notifications Goffi <goffi@goffi.org> parents: 286 diff changeset	358
455 0b5233981671 backend: fix `delete` notification + add `purge` notification Goffi <goffi@goffi.org> parents: 435 diff changeset	359 def notifyPurge(self, pep_jid, nodeIdentifier, subscribers):
0b5233981671 backend: fix `delete` notification + add `purge` notification Goffi <goffi@goffi.org> parents: 435 diff changeset	360 for subscriber in subscribers:
0b5233981671 backend: fix `delete` notification + add `purge` notification Goffi <goffi@goffi.org> parents: 435 diff changeset	361 message = self._pubsub_service._createNotification(
0b5233981671 backend: fix `delete` notification + add `purge` notification Goffi <goffi@goffi.org> parents: 435 diff changeset	362 'purge',
0b5233981671 backend: fix `delete` notification + add `purge` notification Goffi <goffi@goffi.org> parents: 435 diff changeset	363 pep_jid,
0b5233981671 backend: fix `delete` notification + add `purge` notification Goffi <goffi@goffi.org> parents: 435 diff changeset	364 nodeIdentifier,
0b5233981671 backend: fix `delete` notification + add `purge` notification Goffi <goffi@goffi.org> parents: 435 diff changeset	365 subscriber
0b5233981671 backend: fix `delete` notification + add `purge` notification Goffi <goffi@goffi.org> parents: 435 diff changeset	366 )
0b5233981671 backend: fix `delete` notification + add `purge` notification Goffi <goffi@goffi.org> parents: 435 diff changeset	367 self.sendMessage(message)
338 6d059f07c2d3 privilege: added presence and +notify initial support: Goffi <goffi@goffi.org> parents: 321 diff changeset	368
6d059f07c2d3 privilege: added presence and +notify initial support: Goffi <goffi@goffi.org> parents: 321 diff changeset	369 ## presence ##
6d059f07c2d3 privilege: added presence and +notify initial support: Goffi <goffi@goffi.org> parents: 321 diff changeset	370
460 607616f9ef5b backend: new `server_jid` option: Goffi <goffi@goffi.org> parents: 455 diff changeset	371 def _onPresence(self, presence_elt: domish.Element) -> None:
607616f9ef5b backend: new `server_jid` option: Goffi <goffi@goffi.org> parents: 455 diff changeset	372 defer.ensureDeferred(self.onPresence(presence_elt))
607616f9ef5b backend: new `server_jid` option: Goffi <goffi@goffi.org> parents: 455 diff changeset	373
607616f9ef5b backend: new `server_jid` option: Goffi <goffi@goffi.org> parents: 455 diff changeset	374 async def onPresence(self, presence_elt: domish.Element) -> None:
338 6d059f07c2d3 privilege: added presence and +notify initial support: Goffi <goffi@goffi.org> parents: 321 diff changeset	375 from_jid = jid.JID(presence_elt['from'])
6d059f07c2d3 privilege: added presence and +notify initial support: Goffi <goffi@goffi.org> parents: 321 diff changeset	376 from_jid_bare = from_jid.userhostJID()
460 607616f9ef5b backend: new `server_jid` option: Goffi <goffi@goffi.org> parents: 455 diff changeset	377 if ((jid.JID(from_jid.host) == self.backend.server_jid
467 d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	378 and (
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	379 from_jid_bare not in self.roster_cache
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	380 or time.time()-self.roster_cache[from_jid_bare]["timestamp"]>ROSTER_TTL
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	381 ))):
d86e0f8a1405 privilege: store roster cache in database: Goffi <goffi@goffi.org> parents: 463 diff changeset	382 roster = await self.getRoster(from_jid)
338 6d059f07c2d3 privilege: added presence and +notify initial support: Goffi <goffi@goffi.org> parents: 321 diff changeset	383
6d059f07c2d3 privilege: added presence and +notify initial support: Goffi <goffi@goffi.org> parents: 321 diff changeset	384 presence_type = presence_elt.getAttribute('type')
463 f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	385 if presence_type == "unavailable":
f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	386 self.presences.discard(from_jid)
f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	387 elif from_jid not in self.presences:
f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	388 # new resource available
f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	389
f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	390 # we keep resources present in cache to avoid sending notifications on each
f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	391 # status change
f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	392 self.presences.add(from_jid)
f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	393
f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	394 # we check entity capabilities
338 6d059f07c2d3 privilege: added presence and +notify initial support: Goffi <goffi@goffi.org> parents: 321 diff changeset	395 try:
463 f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	396 c_elt = next(
f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	397 presence_elt.elements('http://jabber.org/protocol/caps', 'c')
f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	398 )
338 6d059f07c2d3 privilege: added presence and +notify initial support: Goffi <goffi@goffi.org> parents: 321 diff changeset	399 hash_ = c_elt['hash']
6d059f07c2d3 privilege: added presence and +notify initial support: Goffi <goffi@goffi.org> parents: 321 diff changeset	400 ver = c_elt['ver']
6d059f07c2d3 privilege: added presence and +notify initial support: Goffi <goffi@goffi.org> parents: 321 diff changeset	401 except (StopIteration, KeyError):
6d059f07c2d3 privilege: added presence and +notify initial support: Goffi <goffi@goffi.org> parents: 321 diff changeset	402 # no capabilities, we don't go further
6d059f07c2d3 privilege: added presence and +notify initial support: Goffi <goffi@goffi.org> parents: 321 diff changeset	403 return
6d059f07c2d3 privilege: added presence and +notify initial support: Goffi <goffi@goffi.org> parents: 321 diff changeset	404
6d059f07c2d3 privilege: added presence and +notify initial support: Goffi <goffi@goffi.org> parents: 321 diff changeset	405 # FIXME: hash is not checked (cf. XEP-0115)
6d059f07c2d3 privilege: added presence and +notify initial support: Goffi <goffi@goffi.org> parents: 321 diff changeset	406 disco_tuple = (hash_, ver)
6d059f07c2d3 privilege: added presence and +notify initial support: Goffi <goffi@goffi.org> parents: 321 diff changeset	407
6d059f07c2d3 privilege: added presence and +notify initial support: Goffi <goffi@goffi.org> parents: 321 diff changeset	408 if disco_tuple not in self.hash_map:
6d059f07c2d3 privilege: added presence and +notify initial support: Goffi <goffi@goffi.org> parents: 321 diff changeset	409 # first time we se this hash, what is behind it?
435 96342e7e9f5d privilege: log error when `requestInfo` is failing Goffi <goffi@goffi.org> parents: 414 diff changeset	410 try:
463 f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	411 infos = await self.requestInfo(from_jid)
435 96342e7e9f5d privilege: log error when `requestInfo` is failing Goffi <goffi@goffi.org> parents: 414 diff changeset	412 except error.StanzaError as e:
96342e7e9f5d privilege: log error when `requestInfo` is failing Goffi <goffi@goffi.org> parents: 414 diff changeset	413 log.msg(
96342e7e9f5d privilege: log error when `requestInfo` is failing Goffi <goffi@goffi.org> parents: 414 diff changeset	414 f"WARNING: can't request disco info for {from_jid!r} (presence: "
96342e7e9f5d privilege: log error when `requestInfo` is failing Goffi <goffi@goffi.org> parents: 414 diff changeset	415 f"{presence_type}): {e}"
96342e7e9f5d privilege: log error when `requestInfo` is failing Goffi <goffi@goffi.org> parents: 414 diff changeset	416 )
96342e7e9f5d privilege: log error when `requestInfo` is failing Goffi <goffi@goffi.org> parents: 414 diff changeset	417 else:
96342e7e9f5d privilege: log error when `requestInfo` is failing Goffi <goffi@goffi.org> parents: 414 diff changeset	418 self.hash_map[disco_tuple] = {
96342e7e9f5d privilege: log error when `requestInfo` is failing Goffi <goffi@goffi.org> parents: 414 diff changeset	419 'notify': {
96342e7e9f5d privilege: log error when `requestInfo` is failing Goffi <goffi@goffi.org> parents: 414 diff changeset	420 f[:-7] for f in infos.features if f.endswith('+notify')
96342e7e9f5d privilege: log error when `requestInfo` is failing Goffi <goffi@goffi.org> parents: 414 diff changeset	421 },
96342e7e9f5d privilege: log error when `requestInfo` is failing Goffi <goffi@goffi.org> parents: 414 diff changeset	422 'infos': infos
338 6d059f07c2d3 privilege: added presence and +notify initial support: Goffi <goffi@goffi.org> parents: 321 diff changeset	423 }
6d059f07c2d3 privilege: added presence and +notify initial support: Goffi <goffi@goffi.org> parents: 321 diff changeset	424
400 371e72871e19 privilege: fill hash_map before jid_caps to avoid KeyError in getAutoSubscribers Goffi <goffi@goffi.org> parents: 369 diff changeset	425 # jid_caps must be filled only after hash_map is set, to be sure that
371e72871e19 privilege: fill hash_map before jid_caps to avoid KeyError in getAutoSubscribers Goffi <goffi@goffi.org> parents: 369 diff changeset	426 # the hash data is available in getAutoSubscribers
371e72871e19 privilege: fill hash_map before jid_caps to avoid KeyError in getAutoSubscribers Goffi <goffi@goffi.org> parents: 369 diff changeset	427 jid_caps = self.caps_map.setdefault(from_jid_bare, {})
371e72871e19 privilege: fill hash_map before jid_caps to avoid KeyError in getAutoSubscribers Goffi <goffi@goffi.org> parents: 369 diff changeset	428 if from_jid.resource not in jid_caps:
371e72871e19 privilege: fill hash_map before jid_caps to avoid KeyError in getAutoSubscribers Goffi <goffi@goffi.org> parents: 369 diff changeset	429 jid_caps[from_jid.resource] = disco_tuple
371e72871e19 privilege: fill hash_map before jid_caps to avoid KeyError in getAutoSubscribers Goffi <goffi@goffi.org> parents: 369 diff changeset	430
338 6d059f07c2d3 privilege: added presence and +notify initial support: Goffi <goffi@goffi.org> parents: 321 diff changeset	431 # nodes are the nodes subscribed with +notify
6d059f07c2d3 privilege: added presence and +notify initial support: Goffi <goffi@goffi.org> parents: 321 diff changeset	432 nodes = tuple(self.hash_map[disco_tuple]['notify'])
6d059f07c2d3 privilege: added presence and +notify initial support: Goffi <goffi@goffi.org> parents: 321 diff changeset	433 if not nodes:
6d059f07c2d3 privilege: added presence and +notify initial support: Goffi <goffi@goffi.org> parents: 321 diff changeset	434 return
462 a017af61a32b privilege: add server JID to `publisher` so `+notify` works with it: Goffi <goffi@goffi.org> parents: 460 diff changeset	435 # publishers are entities which have granted presence access to our user
a017af61a32b privilege: add server JID to `publisher` so `+notify` works with it: Goffi <goffi@goffi.org> parents: 460 diff changeset	436 # + user itself + server
a017af61a32b privilege: add server JID to `publisher` so `+notify` works with it: Goffi <goffi@goffi.org> parents: 460 diff changeset	437 publishers = (
a017af61a32b privilege: add server JID to `publisher` so `+notify` works with it: Goffi <goffi@goffi.org> parents: 460 diff changeset	438 tuple(self.presence_map.get(from_jid_bare, ()))
a017af61a32b privilege: add server JID to `publisher` so `+notify` works with it: Goffi <goffi@goffi.org> parents: 460 diff changeset	439 + (from_jid_bare, self.backend.server_jid)
a017af61a32b privilege: add server JID to `publisher` so `+notify` works with it: Goffi <goffi@goffi.org> parents: 460 diff changeset	440 )
338 6d059f07c2d3 privilege: added presence and +notify initial support: Goffi <goffi@goffi.org> parents: 321 diff changeset	441
343 ff8aff4c9b79 backend, psql: implemented notifications for auto subscribers in PEP: Goffi <goffi@goffi.org> parents: 342 diff changeset	442 # FIXME: add "presence" access_model (for node) for getLastItems
463 f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	443 # TODO: manage other access model (whitelist, …)
f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	444 last_items = await self.backend.storage.getLastItems(
f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	445 publishers,
f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	446 nodes,
f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	447 ('open', 'presence'), ('open', 'presence'), True
f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	448 )
f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	449 # we send message with last item, as required by
f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	450 # https://xmpp.org/extensions/xep-0163.html#notify-last
338 6d059f07c2d3 privilege: added presence and +notify initial support: Goffi <goffi@goffi.org> parents: 321 diff changeset	451 for pep_jid, node, item, item_access_model in last_items:
6d059f07c2d3 privilege: added presence and +notify initial support: Goffi <goffi@goffi.org> parents: 321 diff changeset	452 self.notifyPublish(pep_jid, node, [(from_jid, None, [item])])
343 ff8aff4c9b79 backend, psql: implemented notifications for auto subscribers in PEP: Goffi <goffi@goffi.org> parents: 342 diff changeset	453
ff8aff4c9b79 backend, psql: implemented notifications for auto subscribers in PEP: Goffi <goffi@goffi.org> parents: 342 diff changeset	454 ## misc ##
ff8aff4c9b79 backend, psql: implemented notifications for auto subscribers in PEP: Goffi <goffi@goffi.org> parents: 342 diff changeset	455
463 f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	456 async def getAutoSubscribers(
f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	457 self,
f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	458 recipient: jid.JID,
f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	459 nodeIdentifier: str,
f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	460 explicit_subscribers: Set[jid.JID]
f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	461 ) -> List[jid.JID]:
f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	462 """Get automatic subscribers
343 ff8aff4c9b79 backend, psql: implemented notifications for auto subscribers in PEP: Goffi <goffi@goffi.org> parents: 342 diff changeset	463
463 f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	464 Get subscribers with presence subscription and +notify for this node
f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	465 @param recipient: jid of the PEP owner of this node
f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	466 @param nodeIdentifier: node
f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	467 @param explicit_subscribers: jids of people which have an explicit subscription
f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	468 @return: full jid of automatically subscribed entities
343 ff8aff4c9b79 backend, psql: implemented notifications for auto subscribers in PEP: Goffi <goffi@goffi.org> parents: 342 diff changeset	469 """
ff8aff4c9b79 backend, psql: implemented notifications for auto subscribers in PEP: Goffi <goffi@goffi.org> parents: 342 diff changeset	470 auto_subscribers = []
463 f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	471 roster = await self.getRoster(recipient)
414 ccb2a22ea0fc Python 3 port: Goffi <goffi@goffi.org> parents: 405 diff changeset	472 for roster_jid, roster_item in roster.items():
343 ff8aff4c9b79 backend, psql: implemented notifications for auto subscribers in PEP: Goffi <goffi@goffi.org> parents: 342 diff changeset	473 if roster_jid in explicit_subscribers:
ff8aff4c9b79 backend, psql: implemented notifications for auto subscribers in PEP: Goffi <goffi@goffi.org> parents: 342 diff changeset	474 continue
ff8aff4c9b79 backend, psql: implemented notifications for auto subscribers in PEP: Goffi <goffi@goffi.org> parents: 342 diff changeset	475 if roster_item.subscriptionFrom:
ff8aff4c9b79 backend, psql: implemented notifications for auto subscribers in PEP: Goffi <goffi@goffi.org> parents: 342 diff changeset	476 try:
ff8aff4c9b79 backend, psql: implemented notifications for auto subscribers in PEP: Goffi <goffi@goffi.org> parents: 342 diff changeset	477 online_resources = self.caps_map[roster_jid]
ff8aff4c9b79 backend, psql: implemented notifications for auto subscribers in PEP: Goffi <goffi@goffi.org> parents: 342 diff changeset	478 except KeyError:
ff8aff4c9b79 backend, psql: implemented notifications for auto subscribers in PEP: Goffi <goffi@goffi.org> parents: 342 diff changeset	479 continue
414 ccb2a22ea0fc Python 3 port: Goffi <goffi@goffi.org> parents: 405 diff changeset	480 for res, disco_tuple in online_resources.items():
400 371e72871e19 privilege: fill hash_map before jid_caps to avoid KeyError in getAutoSubscribers Goffi <goffi@goffi.org> parents: 369 diff changeset	481 notify = self.hash_map[disco_tuple]['notify']
343 ff8aff4c9b79 backend, psql: implemented notifications for auto subscribers in PEP: Goffi <goffi@goffi.org> parents: 342 diff changeset	482 if nodeIdentifier in notify:
ff8aff4c9b79 backend, psql: implemented notifications for auto subscribers in PEP: Goffi <goffi@goffi.org> parents: 342 diff changeset	483 full_jid = jid.JID(tuple=(roster_jid.user, roster_jid.host, res))
ff8aff4c9b79 backend, psql: implemented notifications for auto subscribers in PEP: Goffi <goffi@goffi.org> parents: 342 diff changeset	484 auto_subscribers.append(full_jid)
463 f520ac3164b0 privilege: improvment on last message sending on presence with `+notify`: Goffi <goffi@goffi.org> parents: 462 diff changeset	485 return auto_subscribers

Mercurial > libervia-pubsub

annotate sat_pubsub/privilege.py @ 467:d86e0f8a1405