Mercurial > libervia-pubsub
annotate sat_pubsub/privilege.py @ 474:af167e95527c
Added tag v0.4.0 for changeset dc53c6f020bc
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Tue, 30 Nov 2021 23:16:26 +0100 |
| parents | ed9e12701e0f |
| children | b544109ab4c4 |
| rev | line source |
|---|---|
| 414 | 1 #!/usr/bin/env python3 |
| 242 | 2 # |
| 460 | 3 # Copyright (c) 2015-2021 Jérôme Poisson |
| 242 | 4 |
| 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 | 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 | 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 | 18 |
| 460 | 19 "This module implements XEP-0356 (Privileged Entity) to manage rosters, messages and " |
| 20 "presences" | |
| 242 | 21 |
|
471
ed9e12701e0f
backend: return empty roster when `NotAllowedError` is raised in `getOwnerRoster`:
Goffi <goffi@goffi.org>
parents:
470
diff
changeset
|
22 from typing import Dict, List, Optional, Set |
|
463
f520ac3164b0
privilege: improvment on last message sending on presence with `+notify`:
Goffi <goffi@goffi.org>
parents:
462
diff
changeset
|
23 import time |
|
471
ed9e12701e0f
backend: return empty roster when `NotAllowedError` is raised in `getOwnerRoster`:
Goffi <goffi@goffi.org>
parents:
470
diff
changeset
|
24 |
|
ed9e12701e0f
backend: return empty roster when `NotAllowedError` is raised in `getOwnerRoster`:
Goffi <goffi@goffi.org>
parents:
470
diff
changeset
|
25 from twisted.internet import defer |
|
ed9e12701e0f
backend: return empty roster when `NotAllowedError` is raised in `getOwnerRoster`:
Goffi <goffi@goffi.org>
parents:
470
diff
changeset
|
26 from twisted.python import log |
|
ed9e12701e0f
backend: return empty roster when `NotAllowedError` is raised in `getOwnerRoster`:
Goffi <goffi@goffi.org>
parents:
470
diff
changeset
|
27 from twisted.python import failure |
|
ed9e12701e0f
backend: return empty roster when `NotAllowedError` is raised in `getOwnerRoster`:
Goffi <goffi@goffi.org>
parents:
470
diff
changeset
|
28 from twisted.words.protocols.jabber import error, jid |
|
ed9e12701e0f
backend: return empty roster when `NotAllowedError` is raised in `getOwnerRoster`:
Goffi <goffi@goffi.org>
parents:
470
diff
changeset
|
29 from twisted.words.xish import domish |
| 242 | 30 from wokkel import xmppim |
|
293
b96a4ac25f8b
privilege: added methods to send privileged messages and notifications
Goffi <goffi@goffi.org>
parents:
286
diff
changeset
|
31 from wokkel import pubsub |
|
338
6d059f07c2d3
privilege: added presence and +notify initial support:
Goffi <goffi@goffi.org>
parents:
321
diff
changeset
|
32 from wokkel import disco |
|
471
ed9e12701e0f
backend: return empty roster when `NotAllowedError` is raised in `getOwnerRoster`:
Goffi <goffi@goffi.org>
parents:
470
diff
changeset
|
33 from wokkel.compat import IQ |
|
293
b96a4ac25f8b
privilege: added methods to send privileged messages and notifications
Goffi <goffi@goffi.org>
parents:
286
diff
changeset
|
34 from wokkel.iwokkel import IPubSubService |
|
471
ed9e12701e0f
backend: return empty roster when `NotAllowedError` is raised in `getOwnerRoster`:
Goffi <goffi@goffi.org>
parents:
470
diff
changeset
|
35 |
|
ed9e12701e0f
backend: return empty roster when `NotAllowedError` is raised in `getOwnerRoster`:
Goffi <goffi@goffi.org>
parents:
470
diff
changeset
|
36 from .error import NotAllowedError |
| 242 | 37 |
|
293
b96a4ac25f8b
privilege: added methods to send privileged messages and notifications
Goffi <goffi@goffi.org>
parents:
286
diff
changeset
|
38 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
|
39 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
|
40 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
|
41 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
|
42 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
|
43 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
|
44 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
|
45 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
|
46 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
|
47 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
|
48 TO_CHECK = { |
|
f520ac3164b0
privilege: improvment on last message sending on presence with `+notify`:
Goffi <goffi@goffi.org>
parents:
462
diff
changeset
|
49 PERM_ROSTER:ALLOWED_ROSTER, |
|
f520ac3164b0
privilege: improvment on last message sending on presence with `+notify`:
Goffi <goffi@goffi.org>
parents:
462
diff
changeset
|
50 PERM_MESSAGE:ALLOWED_MESSAGE, |
|
f520ac3164b0
privilege: improvment on last message sending on presence with `+notify`:
Goffi <goffi@goffi.org>
parents:
462
diff
changeset
|
51 PERM_PRESENCE:ALLOWED_PRESENCE |
|
f520ac3164b0
privilege: improvment on last message sending on presence with `+notify`:
Goffi <goffi@goffi.org>
parents:
462
diff
changeset
|
52 } |
| 242 | 53 |
|
467
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
54 # 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
|
55 # 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
|
56 # connecting/disconnecting often in a short time. |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
57 ROSTER_TTL = 3600 |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
58 |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
59 |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
60 Roster = Dict[jid.JID, xmppim.RosterItem] |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
61 |
|
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
|
62 |
|
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 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
|
64 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
|
65 |
|
338
6d059f07c2d3
privilege: added presence and +notify initial support:
Goffi <goffi@goffi.org>
parents:
321
diff
changeset
|
66 class PrivilegesHandler(disco.DiscoClientProtocol): |
|
463
f520ac3164b0
privilege: improvment on last message sending on presence with `+notify`:
Goffi <goffi@goffi.org>
parents:
462
diff
changeset
|
67 # 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
|
68 # TODO: cache |
| 242 | 69 |
|
321
c7fe09894952
privilege: better handling of main message 'to' attribute (i.e. privileged entity's server)
Goffi <goffi@goffi.org>
parents:
312
diff
changeset
|
70 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
|
71 super(PrivilegesHandler, self).__init__() |
| 460 | 72 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
|
73 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
|
74 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
|
75 PERM_PRESENCE: 'none'} |
|
293
b96a4ac25f8b
privilege: added methods to send privileged messages and notifications
Goffi <goffi@goffi.org>
parents:
286
diff
changeset
|
76 self._pubsub_service = None |
|
343
ff8aff4c9b79
backend, psql: implemented notifications for auto subscribers in PEP:
Goffi <goffi@goffi.org>
parents:
342
diff
changeset
|
77 self.caps_map = {} # key: bare jid, value: dict of resources with caps hash |
| 460 | 78 # key: (hash,version), value: dict with DiscoInfo instance (infos) and nodes to |
| 79 # notify (notify) | |
| 80 self.hash_map = {} | |
|
467
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
81 # 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
|
82 # key: jid, value: dict with "timestamp" and "roster" |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
83 self.roster_cache = None |
|
463
f520ac3164b0
privilege: improvment on last message sending on presence with `+notify`:
Goffi <goffi@goffi.org>
parents:
462
diff
changeset
|
84 # 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
|
85 # 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
|
86 # to the key entity. |
|
f520ac3164b0
privilege: improvment on last message sending on presence with `+notify`:
Goffi <goffi@goffi.org>
parents:
462
diff
changeset
|
87 self.presence_map = {} |
|
f520ac3164b0
privilege: improvment on last message sending on presence with `+notify`:
Goffi <goffi@goffi.org>
parents:
462
diff
changeset
|
88 # resource currently online |
|
f520ac3164b0
privilege: improvment on last message sending on presence with `+notify`:
Goffi <goffi@goffi.org>
parents:
462
diff
changeset
|
89 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
|
90 |
|
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 @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
|
92 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
|
93 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
|
94 |
|
467
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
95 async def getRosterCacheFromDB(self): |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
96 rows = await self.backend.storage.getRosterCache() |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
97 for __, owner_jid, version, timestamp, roster_elt in rows: |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
98 roster = self.getRosterFromElement(roster_elt) |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
99 self.roster_cache[owner_jid] = { |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
100 "timestamp": timestamp, |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
101 "roster": roster, |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
102 "version": version |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
103 } |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
104 self.updatePresenceMap(owner_jid, roster, None) |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
105 |
|
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
|
106 def connectionInitialized(self): |
|
293
b96a4ac25f8b
privilege: added methods to send privileged messages and notifications
Goffi <goffi@goffi.org>
parents:
286
diff
changeset
|
107 for handler in self.parent.handlers: |
|
b96a4ac25f8b
privilege: added methods to send privileged messages and notifications
Goffi <goffi@goffi.org>
parents:
286
diff
changeset
|
108 if IPubSubService.providedBy(handler): |
|
b96a4ac25f8b
privilege: added methods to send privileged messages and notifications
Goffi <goffi@goffi.org>
parents:
286
diff
changeset
|
109 self._pubsub_service = handler |
|
b96a4ac25f8b
privilege: added methods to send privileged messages and notifications
Goffi <goffi@goffi.org>
parents:
286
diff
changeset
|
110 break |
| 460 | 111 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
|
112 self.xmlstream.addObserver(PRIV_ENT_ADV_XPATH, self.onAdvertise) |
| 460 | 113 self.xmlstream.addObserver('/presence', self._onPresence) |
|
467
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
114 if self.roster_cache is None: |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
115 self.roster_cache = {} |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
116 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
|
117 |
|
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 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
|
119 """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
|
120 |
|
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 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
|
122 """ |
| 414 | 123 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
|
124 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
|
125 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
|
126 if perm_elt.name != 'perm': |
| 414 | 127 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
|
128 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
|
129 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
|
130 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
|
131 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
|
132 raise InvalidStanza( |
|
f520ac3164b0
privilege: improvment on last message sending on presence with `+notify`:
Goffi <goffi@goffi.org>
parents:
462
diff
changeset
|
133 'bad type [{}] for permission {}' |
|
f520ac3164b0
privilege: improvment on last message sending on presence with `+notify`:
Goffi <goffi@goffi.org>
parents:
462
diff
changeset
|
134 .format(perm_type, perm_access) |
|
f520ac3164b0
privilege: improvment on last message sending on presence with `+notify`:
Goffi <goffi@goffi.org>
parents:
462
diff
changeset
|
135 ) |
|
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
|
136 except KeyError: |
| 414 | 137 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
|
138 except InvalidStanza as e: |
|
463
f520ac3164b0
privilege: improvment on last message sending on presence with `+notify`:
Goffi <goffi@goffi.org>
parents:
462
diff
changeset
|
139 log.msg( |
|
f520ac3164b0
privilege: improvment on last message sending on presence with `+notify`:
Goffi <goffi@goffi.org>
parents:
462
diff
changeset
|
140 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
|
141 ) |
|
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
|
142 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
|
143 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
|
144 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
|
145 |
|
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 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
|
147 |
|
463
f520ac3164b0
privilege: improvment on last message sending on presence with `+notify`:
Goffi <goffi@goffi.org>
parents:
462
diff
changeset
|
148 log.msg( |
|
f520ac3164b0
privilege: improvment on last message sending on presence with `+notify`:
Goffi <goffi@goffi.org>
parents:
462
diff
changeset
|
149 '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
|
150 .format(**self._permissions) |
|
f520ac3164b0
privilege: improvment on last message sending on presence with `+notify`:
Goffi <goffi@goffi.org>
parents:
462
diff
changeset
|
151 ) |
|
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
|
152 |
|
293
b96a4ac25f8b
privilege: added methods to send privileged messages and notifications
Goffi <goffi@goffi.org>
parents:
286
diff
changeset
|
153 ## 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
|
154 |
|
467
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
155 def updatePresenceMap( |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
156 self, |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
157 owner_jid: jid.JID, |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
158 roster: Roster, |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
159 old_roster: Optional[Roster] |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
160 ) -> None: |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
161 """Update ``self.presence_map`` from roster |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
162 |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
163 @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
|
164 @param roster: roster dict as returned by self.getRoster |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
165 @param old_roster: previously cached roster if any |
| 242 | 166 """ |
|
467
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
167 if old_roster is not None: |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
168 # 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
|
169 # presence_map accordingly |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
170 for roster_jid, roster_item in old_roster.items(): |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
171 if ((roster_item.subscriptionFrom |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
172 and (roster_jid not in roster |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
173 or not roster[roster_jid].subscriptionFrom) |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
174 )): |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
175 try: |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
176 self.presence_map[roster_jid].discard(owner_jid) |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
177 except KeyError: |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
178 pass |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
179 if ((roster_item.subscriptionTo |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
180 and (roster_jid not in roster |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
181 or not roster[roster_jid].subscriptionTo) |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
182 )): |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
183 try: |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
184 self.presence_map[owner_jid].discard(roster_jid) |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
185 except KeyError: |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
186 pass |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
187 |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
188 for roster_jid, roster_item in roster.items(): |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
189 if roster_item.subscriptionFrom: |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
190 # 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
|
191 # notifications when they send presence to us |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
192 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
|
193 if ((roster_item.subscriptionTo |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
194 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
|
195 # 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
|
196 # 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
|
197 self.presence_map.setdefault(owner_jid, set()).add(roster_jid) |
| 242 | 198 |
|
467
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
199 def serialiseRoster( |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
200 self, |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
201 roster: Roster, |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
202 version: Optional[str] = None |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
203 ) -> domish.Element: |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
204 """Reconstruct Query element of the roster""" |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
205 roster_elt = domish.Element((ROSTER_NS, "query")) |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
206 if version: |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
207 roster_elt["ver"] = version |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
208 for item in roster.values(): |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
209 roster_elt.addChild(item.toElement()) |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
210 return roster_elt |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
211 |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
212 async def updateRosterCache( |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
213 self, |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
214 owner_jid: jid.JID, |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
215 roster: Roster, |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
216 version: str |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
217 ) -> None: |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
218 """Update local roster cache and database""" |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
219 now = time.time() |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
220 self.roster_cache[owner_jid] = { |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
221 'timestamp': now, |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
222 'roster': roster, |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
223 'version': version |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
224 } |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
225 roster_elt = self.serialiseRoster(roster, version) |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
226 await self.backend.storage.setRosterCache( |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
227 owner_jid, version, now, roster_elt |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
228 ) |
|
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 def getRosterFromElement(self, query_elt: domish.Element) -> Roster: |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
231 """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
|
232 roster = {} |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
233 for element in query_elt.elements(ROSTER_NS, 'item'): |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
234 item = xmppim.RosterItem.fromElement(element) |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
235 roster[item.entity] = item |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
236 return roster |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
237 |
|
471
ed9e12701e0f
backend: return empty roster when `NotAllowedError` is raised in `getOwnerRoster`:
Goffi <goffi@goffi.org>
parents:
470
diff
changeset
|
238 async def getRoster(self, to_jid: jid.JID) -> Optional[Roster]: |
|
467
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
239 """Retrieve contact list. |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
240 |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
241 @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
|
242 @return: roster data |
| 242 | 243 """ |
|
470
a549c8e17827
privilege: don't try to get roster if the request if for a jid not belonging to our server
Goffi <goffi@goffi.org>
parents:
467
diff
changeset
|
244 if jid.JID(to_jid.host) != self.backend.server_jid: |
|
a549c8e17827
privilege: don't try to get roster if the request if for a jid not belonging to our server
Goffi <goffi@goffi.org>
parents:
467
diff
changeset
|
245 # no need to try to get the roster if it's not a user of our own server |
|
a549c8e17827
privilege: don't try to get roster if the request if for a jid not belonging to our server
Goffi <goffi@goffi.org>
parents:
467
diff
changeset
|
246 return 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
|
247 if self._permissions[PERM_ROSTER] not in ('get', 'both'): |
|
471
ed9e12701e0f
backend: return empty roster when `NotAllowedError` is raised in `getOwnerRoster`:
Goffi <goffi@goffi.org>
parents:
470
diff
changeset
|
248 raise NotAllowedError('roster get is not allowed') |
| 242 | 249 |
| 250 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
|
251 iq.addElement((ROSTER_NS, 'query')) |
| 242 | 252 iq["to"] = to_jid.userhost() |
|
467
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
253 iq_result = await iq.send() |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
254 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
|
255 |
|
467
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
256 version = iq_result.query.getAttribute('ver') |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
257 cached_roster = self.roster_cache.get("to_jid") |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
258 if not cached_roster: |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
259 self.updatePresenceMap(to_jid, roster, None) |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
260 await self.updateRosterCache(to_jid, roster, version) |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
261 else: |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
262 # 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
|
263 # modified, and update presence_map and database |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
264 if version: |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
265 if cached_roster["version"] != version: |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
266 self.updatePresenceMap(to_jid, roster, cached_roster["roster"]) |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
267 await self.updateRosterCache(to_jid, roster, version) |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
268 else: |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
269 cached_roster["timestamp"] = time.time() |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
270 else: |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
271 # 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
|
272 if ((self.serialiseRoster(cached_roster["roster"]).toXml() != |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
273 self.serialiseRoster(roster))): |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
274 self.updatePresenceMap(to_jid, roster, cached_roster["roster"]) |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
275 await self.updateRosterCache(to_jid, roster, version) |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
276 else: |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
277 cached_roster["timestamp"] = time.time() |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
278 |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
279 return roster |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
280 |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
281 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
|
282 """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
|
283 |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
284 @param entity: entity to check subscription to |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
285 @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
|
286 @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
|
287 """ |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
288 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
|
289 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
|
290 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
|
291 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
|
292 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
|
293 |
|
293
b96a4ac25f8b
privilege: added methods to send privileged messages and notifications
Goffi <goffi@goffi.org>
parents:
286
diff
changeset
|
294 ## message ## |
|
b96a4ac25f8b
privilege: added methods to send privileged messages and notifications
Goffi <goffi@goffi.org>
parents:
286
diff
changeset
|
295 |
|
321
c7fe09894952
privilege: better handling of main message 'to' attribute (i.e. privileged entity's server)
Goffi <goffi@goffi.org>
parents:
312
diff
changeset
|
296 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
|
297 """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
|
298 |
|
b96a4ac25f8b
privilege: added methods to send privileged messages and notifications
Goffi <goffi@goffi.org>
parents:
286
diff
changeset
|
299 @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
|
300 @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
|
301 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
|
302 """ |
|
b96a4ac25f8b
privilege: added methods to send privileged messages and notifications
Goffi <goffi@goffi.org>
parents:
286
diff
changeset
|
303 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
|
304 log.msg("WARNING: permission not allowed to send privileged messages") |
|
471
ed9e12701e0f
backend: return empty roster when `NotAllowedError` is raised in `getOwnerRoster`:
Goffi <goffi@goffi.org>
parents:
470
diff
changeset
|
305 raise NotAllowedError('privileged messages are not allowed') |
|
293
b96a4ac25f8b
privilege: added methods to send privileged messages and notifications
Goffi <goffi@goffi.org>
parents:
286
diff
changeset
|
306 |
|
b96a4ac25f8b
privilege: added methods to send privileged messages and notifications
Goffi <goffi@goffi.org>
parents:
286
diff
changeset
|
307 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
|
308 if to_jid is None: |
| 460 | 309 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
|
310 main_message['to'] = to_jid.full() |
|
b96a4ac25f8b
privilege: added methods to send privileged messages and notifications
Goffi <goffi@goffi.org>
parents:
286
diff
changeset
|
311 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
|
312 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
|
313 priv_message['xmlns'] = 'jabber:client' |
|
b96a4ac25f8b
privilege: added methods to send privileged messages and notifications
Goffi <goffi@goffi.org>
parents:
286
diff
changeset
|
314 forwarded_elt.addChild(priv_message) |
|
b96a4ac25f8b
privilege: added methods to send privileged messages and notifications
Goffi <goffi@goffi.org>
parents:
286
diff
changeset
|
315 self.send(main_message) |
|
b96a4ac25f8b
privilege: added methods to send privileged messages and notifications
Goffi <goffi@goffi.org>
parents:
286
diff
changeset
|
316 |
|
b96a4ac25f8b
privilege: added methods to send privileged messages and notifications
Goffi <goffi@goffi.org>
parents:
286
diff
changeset
|
317 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
|
318 """Do notifications using privileges""" |
|
b96a4ac25f8b
privilege: added methods to send privileged messages and notifications
Goffi <goffi@goffi.org>
parents:
286
diff
changeset
|
319 for subscriber, subscriptions, items in notifications: |
|
455
0b5233981671
backend: fix `delete` notification + add `purge` notification
Goffi <goffi@goffi.org>
parents:
435
diff
changeset
|
320 message = self._pubsub_service._createNotification( |
|
0b5233981671
backend: fix `delete` notification + add `purge` notification
Goffi <goffi@goffi.org>
parents:
435
diff
changeset
|
321 'items', |
|
0b5233981671
backend: fix `delete` notification + add `purge` notification
Goffi <goffi@goffi.org>
parents:
435
diff
changeset
|
322 pep_jid, |
|
0b5233981671
backend: fix `delete` notification + add `purge` notification
Goffi <goffi@goffi.org>
parents:
435
diff
changeset
|
323 nodeIdentifier, |
|
0b5233981671
backend: fix `delete` notification + add `purge` notification
Goffi <goffi@goffi.org>
parents:
435
diff
changeset
|
324 subscriber, |
|
0b5233981671
backend: fix `delete` notification + add `purge` notification
Goffi <goffi@goffi.org>
parents:
435
diff
changeset
|
325 subscriptions |
|
0b5233981671
backend: fix `delete` notification + add `purge` notification
Goffi <goffi@goffi.org>
parents:
435
diff
changeset
|
326 ) |
|
293
b96a4ac25f8b
privilege: added methods to send privileged messages and notifications
Goffi <goffi@goffi.org>
parents:
286
diff
changeset
|
327 for item in items: |
|
b96a4ac25f8b
privilege: added methods to send privileged messages and notifications
Goffi <goffi@goffi.org>
parents:
286
diff
changeset
|
328 item.uri = pubsub.NS_PUBSUB_EVENT |
|
b96a4ac25f8b
privilege: added methods to send privileged messages and notifications
Goffi <goffi@goffi.org>
parents:
286
diff
changeset
|
329 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
|
330 self.sendMessage(message) |
|
293
b96a4ac25f8b
privilege: added methods to send privileged messages and notifications
Goffi <goffi@goffi.org>
parents:
286
diff
changeset
|
331 |
|
b96a4ac25f8b
privilege: added methods to send privileged messages and notifications
Goffi <goffi@goffi.org>
parents:
286
diff
changeset
|
332 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
|
333 for subscriber, subscriptions, items in notifications: |
|
455
0b5233981671
backend: fix `delete` notification + add `purge` notification
Goffi <goffi@goffi.org>
parents:
435
diff
changeset
|
334 message = self._pubsub_service._createNotification( |
|
0b5233981671
backend: fix `delete` notification + add `purge` notification
Goffi <goffi@goffi.org>
parents:
435
diff
changeset
|
335 'items', |
|
0b5233981671
backend: fix `delete` notification + add `purge` notification
Goffi <goffi@goffi.org>
parents:
435
diff
changeset
|
336 pep_jid, |
|
0b5233981671
backend: fix `delete` notification + add `purge` notification
Goffi <goffi@goffi.org>
parents:
435
diff
changeset
|
337 nodeIdentifier, |
|
0b5233981671
backend: fix `delete` notification + add `purge` notification
Goffi <goffi@goffi.org>
parents:
435
diff
changeset
|
338 subscriber, |
|
0b5233981671
backend: fix `delete` notification + add `purge` notification
Goffi <goffi@goffi.org>
parents:
435
diff
changeset
|
339 subscriptions |
|
0b5233981671
backend: fix `delete` notification + add `purge` notification
Goffi <goffi@goffi.org>
parents:
435
diff
changeset
|
340 ) |
|
293
b96a4ac25f8b
privilege: added methods to send privileged messages and notifications
Goffi <goffi@goffi.org>
parents:
286
diff
changeset
|
341 for item in items: |
|
b96a4ac25f8b
privilege: added methods to send privileged messages and notifications
Goffi <goffi@goffi.org>
parents:
286
diff
changeset
|
342 retract = domish.Element((None, "retract")) |
|
b96a4ac25f8b
privilege: added methods to send privileged messages and notifications
Goffi <goffi@goffi.org>
parents:
286
diff
changeset
|
343 retract['id'] = item['id'] |
|
b96a4ac25f8b
privilege: added methods to send privileged messages and notifications
Goffi <goffi@goffi.org>
parents:
286
diff
changeset
|
344 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
|
345 self.sendMessage(message) |
|
293
b96a4ac25f8b
privilege: added methods to send privileged messages and notifications
Goffi <goffi@goffi.org>
parents:
286
diff
changeset
|
346 |
|
455
0b5233981671
backend: fix `delete` notification + add `purge` notification
Goffi <goffi@goffi.org>
parents:
435
diff
changeset
|
347 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
|
348 for subscriber in subscribers: |
|
0b5233981671
backend: fix `delete` notification + add `purge` notification
Goffi <goffi@goffi.org>
parents:
435
diff
changeset
|
349 message = self._pubsub_service._createNotification( |
|
0b5233981671
backend: fix `delete` notification + add `purge` notification
Goffi <goffi@goffi.org>
parents:
435
diff
changeset
|
350 'delete', |
|
0b5233981671
backend: fix `delete` notification + add `purge` notification
Goffi <goffi@goffi.org>
parents:
435
diff
changeset
|
351 pep_jid, |
|
0b5233981671
backend: fix `delete` notification + add `purge` notification
Goffi <goffi@goffi.org>
parents:
435
diff
changeset
|
352 nodeIdentifier, |
|
0b5233981671
backend: fix `delete` notification + add `purge` notification
Goffi <goffi@goffi.org>
parents:
435
diff
changeset
|
353 subscriber |
|
0b5233981671
backend: fix `delete` notification + add `purge` notification
Goffi <goffi@goffi.org>
parents:
435
diff
changeset
|
354 ) |
|
0b5233981671
backend: fix `delete` notification + add `purge` notification
Goffi <goffi@goffi.org>
parents:
435
diff
changeset
|
355 if redirectURI: |
|
0b5233981671
backend: fix `delete` notification + add `purge` notification
Goffi <goffi@goffi.org>
parents:
435
diff
changeset
|
356 redirect = message.event.delete.addElement('redirect') |
|
0b5233981671
backend: fix `delete` notification + add `purge` notification
Goffi <goffi@goffi.org>
parents:
435
diff
changeset
|
357 redirect['uri'] = redirectURI |
|
0b5233981671
backend: fix `delete` notification + add `purge` notification
Goffi <goffi@goffi.org>
parents:
435
diff
changeset
|
358 self.sendMessage(message) |
|
293
b96a4ac25f8b
privilege: added methods to send privileged messages and notifications
Goffi <goffi@goffi.org>
parents:
286
diff
changeset
|
359 |
|
455
0b5233981671
backend: fix `delete` notification + add `purge` notification
Goffi <goffi@goffi.org>
parents:
435
diff
changeset
|
360 def notifyPurge(self, pep_jid, nodeIdentifier, subscribers): |
|
0b5233981671
backend: fix `delete` notification + add `purge` notification
Goffi <goffi@goffi.org>
parents:
435
diff
changeset
|
361 for subscriber in subscribers: |
|
0b5233981671
backend: fix `delete` notification + add `purge` notification
Goffi <goffi@goffi.org>
parents:
435
diff
changeset
|
362 message = self._pubsub_service._createNotification( |
|
0b5233981671
backend: fix `delete` notification + add `purge` notification
Goffi <goffi@goffi.org>
parents:
435
diff
changeset
|
363 'purge', |
|
0b5233981671
backend: fix `delete` notification + add `purge` notification
Goffi <goffi@goffi.org>
parents:
435
diff
changeset
|
364 pep_jid, |
|
0b5233981671
backend: fix `delete` notification + add `purge` notification
Goffi <goffi@goffi.org>
parents:
435
diff
changeset
|
365 nodeIdentifier, |
|
0b5233981671
backend: fix `delete` notification + add `purge` notification
Goffi <goffi@goffi.org>
parents:
435
diff
changeset
|
366 subscriber |
|
0b5233981671
backend: fix `delete` notification + add `purge` notification
Goffi <goffi@goffi.org>
parents:
435
diff
changeset
|
367 ) |
|
0b5233981671
backend: fix `delete` notification + add `purge` notification
Goffi <goffi@goffi.org>
parents:
435
diff
changeset
|
368 self.sendMessage(message) |
|
338
6d059f07c2d3
privilege: added presence and +notify initial support:
Goffi <goffi@goffi.org>
parents:
321
diff
changeset
|
369 |
|
6d059f07c2d3
privilege: added presence and +notify initial support:
Goffi <goffi@goffi.org>
parents:
321
diff
changeset
|
370 ## presence ## |
|
6d059f07c2d3
privilege: added presence and +notify initial support:
Goffi <goffi@goffi.org>
parents:
321
diff
changeset
|
371 |
| 460 | 372 def _onPresence(self, presence_elt: domish.Element) -> None: |
| 373 defer.ensureDeferred(self.onPresence(presence_elt)) | |
| 374 | |
| 375 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
|
376 from_jid = jid.JID(presence_elt['from']) |
|
6d059f07c2d3
privilege: added presence and +notify initial support:
Goffi <goffi@goffi.org>
parents:
321
diff
changeset
|
377 from_jid_bare = from_jid.userhostJID() |
| 460 | 378 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
|
379 and ( |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
380 from_jid_bare not in self.roster_cache |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
381 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
|
382 ))): |
|
d86e0f8a1405
privilege: store roster cache in database:
Goffi <goffi@goffi.org>
parents:
463
diff
changeset
|
383 roster = await self.getRoster(from_jid) |
|
338
6d059f07c2d3
privilege: added presence and +notify initial support:
Goffi <goffi@goffi.org>
parents:
321
diff
changeset
|
384 |
|
6d059f07c2d3
privilege: added presence and +notify initial support:
Goffi <goffi@goffi.org>
parents:
321
diff
changeset
|
385 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
|
386 if presence_type == "unavailable": |
|
f520ac3164b0
privilege: improvment on last message sending on presence with `+notify`:
Goffi <goffi@goffi.org>
parents:
462
diff
changeset
|
387 self.presences.discard(from_jid) |
|
f520ac3164b0
privilege: improvment on last message sending on presence with `+notify`:
Goffi <goffi@goffi.org>
parents:
462
diff
changeset
|
388 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
|
389 # new resource available |
|
f520ac3164b0
privilege: improvment on last message sending on presence with `+notify`:
Goffi <goffi@goffi.org>
parents:
462
diff
changeset
|
390 |
|
f520ac3164b0
privilege: improvment on last message sending on presence with `+notify`:
Goffi <goffi@goffi.org>
parents:
462
diff
changeset
|
391 # 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
|
392 # status change |
|
f520ac3164b0
privilege: improvment on last message sending on presence with `+notify`:
Goffi <goffi@goffi.org>
parents:
462
diff
changeset
|
393 self.presences.add(from_jid) |
|
f520ac3164b0
privilege: improvment on last message sending on presence with `+notify`:
Goffi <goffi@goffi.org>
parents:
462
diff
changeset
|
394 |
|
f520ac3164b0
privilege: improvment on last message sending on presence with `+notify`:
Goffi <goffi@goffi.org>
parents:
462
diff
changeset
|
395 # we check entity capabilities |
|
338
6d059f07c2d3
privilege: added presence and +notify initial support:
Goffi <goffi@goffi.org>
parents:
321
diff
changeset
|
396 try: |
|
463
f520ac3164b0
privilege: improvment on last message sending on presence with `+notify`:
Goffi <goffi@goffi.org>
parents:
462
diff
changeset
|
397 c_elt = next( |
|
f520ac3164b0
privilege: improvment on last message sending on presence with `+notify`:
Goffi <goffi@goffi.org>
parents:
462
diff
changeset
|
398 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
|
399 ) |
|
338
6d059f07c2d3
privilege: added presence and +notify initial support:
Goffi <goffi@goffi.org>
parents:
321
diff
changeset
|
400 hash_ = c_elt['hash'] |
|
6d059f07c2d3
privilege: added presence and +notify initial support:
Goffi <goffi@goffi.org>
parents:
321
diff
changeset
|
401 ver = c_elt['ver'] |
|
6d059f07c2d3
privilege: added presence and +notify initial support:
Goffi <goffi@goffi.org>
parents:
321
diff
changeset
|
402 except (StopIteration, KeyError): |
|
6d059f07c2d3
privilege: added presence and +notify initial support:
Goffi <goffi@goffi.org>
parents:
321
diff
changeset
|
403 # no capabilities, we don't go further |
|
6d059f07c2d3
privilege: added presence and +notify initial support:
Goffi <goffi@goffi.org>
parents:
321
diff
changeset
|
404 return |
|
6d059f07c2d3
privilege: added presence and +notify initial support:
Goffi <goffi@goffi.org>
parents:
321
diff
changeset
|
405 |
|
6d059f07c2d3
privilege: added presence and +notify initial support:
Goffi <goffi@goffi.org>
parents:
321
diff
changeset
|
406 # FIXME: hash is not checked (cf. XEP-0115) |
|
6d059f07c2d3
privilege: added presence and +notify initial support:
Goffi <goffi@goffi.org>
parents:
321
diff
changeset
|
407 disco_tuple = (hash_, ver) |
|
6d059f07c2d3
privilege: added presence and +notify initial support:
Goffi <goffi@goffi.org>
parents:
321
diff
changeset
|
408 |
|
6d059f07c2d3
privilege: added presence and +notify initial support:
Goffi <goffi@goffi.org>
parents:
321
diff
changeset
|
409 if disco_tuple not in self.hash_map: |
|
6d059f07c2d3
privilege: added presence and +notify initial support:
Goffi <goffi@goffi.org>
parents:
321
diff
changeset
|
410 # 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
|
411 try: |
|
463
f520ac3164b0
privilege: improvment on last message sending on presence with `+notify`:
Goffi <goffi@goffi.org>
parents:
462
diff
changeset
|
412 infos = await self.requestInfo(from_jid) |
|
435
96342e7e9f5d
privilege: log error when `requestInfo` is failing
Goffi <goffi@goffi.org>
parents:
414
diff
changeset
|
413 except error.StanzaError as e: |
|
96342e7e9f5d
privilege: log error when `requestInfo` is failing
Goffi <goffi@goffi.org>
parents:
414
diff
changeset
|
414 log.msg( |
|
96342e7e9f5d
privilege: log error when `requestInfo` is failing
Goffi <goffi@goffi.org>
parents:
414
diff
changeset
|
415 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
|
416 f"{presence_type}): {e}" |
|
96342e7e9f5d
privilege: log error when `requestInfo` is failing
Goffi <goffi@goffi.org>
parents:
414
diff
changeset
|
417 ) |
|
96342e7e9f5d
privilege: log error when `requestInfo` is failing
Goffi <goffi@goffi.org>
parents:
414
diff
changeset
|
418 else: |
|
96342e7e9f5d
privilege: log error when `requestInfo` is failing
Goffi <goffi@goffi.org>
parents:
414
diff
changeset
|
419 self.hash_map[disco_tuple] = { |
|
96342e7e9f5d
privilege: log error when `requestInfo` is failing
Goffi <goffi@goffi.org>
parents:
414
diff
changeset
|
420 'notify': { |
|
96342e7e9f5d
privilege: log error when `requestInfo` is failing
Goffi <goffi@goffi.org>
parents:
414
diff
changeset
|
421 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
|
422 }, |
|
96342e7e9f5d
privilege: log error when `requestInfo` is failing
Goffi <goffi@goffi.org>
parents:
414
diff
changeset
|
423 'infos': infos |
|
338
6d059f07c2d3
privilege: added presence and +notify initial support:
Goffi <goffi@goffi.org>
parents:
321
diff
changeset
|
424 } |
|
6d059f07c2d3
privilege: added presence and +notify initial support:
Goffi <goffi@goffi.org>
parents:
321
diff
changeset
|
425 |
|
400
371e72871e19
privilege: fill hash_map before jid_caps to avoid KeyError in getAutoSubscribers
Goffi <goffi@goffi.org>
parents:
369
diff
changeset
|
426 # 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
|
427 # 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
|
428 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
|
429 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
|
430 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
|
431 |
|
338
6d059f07c2d3
privilege: added presence and +notify initial support:
Goffi <goffi@goffi.org>
parents:
321
diff
changeset
|
432 # nodes are the nodes subscribed with +notify |
|
6d059f07c2d3
privilege: added presence and +notify initial support:
Goffi <goffi@goffi.org>
parents:
321
diff
changeset
|
433 nodes = tuple(self.hash_map[disco_tuple]['notify']) |
|
6d059f07c2d3
privilege: added presence and +notify initial support:
Goffi <goffi@goffi.org>
parents:
321
diff
changeset
|
434 if not nodes: |
|
6d059f07c2d3
privilege: added presence and +notify initial support:
Goffi <goffi@goffi.org>
parents:
321
diff
changeset
|
435 return |
|
462
a017af61a32b
privilege: add server JID to `publisher` so `+notify` works with it:
Goffi <goffi@goffi.org>
parents:
460
diff
changeset
|
436 # 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
|
437 # + user itself + server |
|
a017af61a32b
privilege: add server JID to `publisher` so `+notify` works with it:
Goffi <goffi@goffi.org>
parents:
460
diff
changeset
|
438 publishers = ( |
|
a017af61a32b
privilege: add server JID to `publisher` so `+notify` works with it:
Goffi <goffi@goffi.org>
parents:
460
diff
changeset
|
439 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
|
440 + (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
|
441 ) |
|
338
6d059f07c2d3
privilege: added presence and +notify initial support:
Goffi <goffi@goffi.org>
parents:
321
diff
changeset
|
442 |
|
343
ff8aff4c9b79
backend, psql: implemented notifications for auto subscribers in PEP:
Goffi <goffi@goffi.org>
parents:
342
diff
changeset
|
443 # 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
|
444 # 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
|
445 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
|
446 publishers, |
|
f520ac3164b0
privilege: improvment on last message sending on presence with `+notify`:
Goffi <goffi@goffi.org>
parents:
462
diff
changeset
|
447 nodes, |
|
f520ac3164b0
privilege: improvment on last message sending on presence with `+notify`:
Goffi <goffi@goffi.org>
parents:
462
diff
changeset
|
448 ('open', 'presence'), ('open', 'presence'), True |
|
f520ac3164b0
privilege: improvment on last message sending on presence with `+notify`:
Goffi <goffi@goffi.org>
parents:
462
diff
changeset
|
449 ) |
|
f520ac3164b0
privilege: improvment on last message sending on presence with `+notify`:
Goffi <goffi@goffi.org>
parents:
462
diff
changeset
|
450 # 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
|
451 # 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
|
452 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
|
453 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
|
454 |
|
ff8aff4c9b79
backend, psql: implemented notifications for auto subscribers in PEP:
Goffi <goffi@goffi.org>
parents:
342
diff
changeset
|
455 ## misc ## |
|
ff8aff4c9b79
backend, psql: implemented notifications for auto subscribers in PEP:
Goffi <goffi@goffi.org>
parents:
342
diff
changeset
|
456 |
|
463
f520ac3164b0
privilege: improvment on last message sending on presence with `+notify`:
Goffi <goffi@goffi.org>
parents:
462
diff
changeset
|
457 async def getAutoSubscribers( |
|
f520ac3164b0
privilege: improvment on last message sending on presence with `+notify`:
Goffi <goffi@goffi.org>
parents:
462
diff
changeset
|
458 self, |
|
f520ac3164b0
privilege: improvment on last message sending on presence with `+notify`:
Goffi <goffi@goffi.org>
parents:
462
diff
changeset
|
459 recipient: jid.JID, |
|
f520ac3164b0
privilege: improvment on last message sending on presence with `+notify`:
Goffi <goffi@goffi.org>
parents:
462
diff
changeset
|
460 nodeIdentifier: str, |
|
f520ac3164b0
privilege: improvment on last message sending on presence with `+notify`:
Goffi <goffi@goffi.org>
parents:
462
diff
changeset
|
461 explicit_subscribers: Set[jid.JID] |
|
f520ac3164b0
privilege: improvment on last message sending on presence with `+notify`:
Goffi <goffi@goffi.org>
parents:
462
diff
changeset
|
462 ) -> List[jid.JID]: |
|
f520ac3164b0
privilege: improvment on last message sending on presence with `+notify`:
Goffi <goffi@goffi.org>
parents:
462
diff
changeset
|
463 """Get automatic subscribers |
|
343
ff8aff4c9b79
backend, psql: implemented notifications for auto subscribers in PEP:
Goffi <goffi@goffi.org>
parents:
342
diff
changeset
|
464 |
|
463
f520ac3164b0
privilege: improvment on last message sending on presence with `+notify`:
Goffi <goffi@goffi.org>
parents:
462
diff
changeset
|
465 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
|
466 @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
|
467 @param nodeIdentifier: node |
|
f520ac3164b0
privilege: improvment on last message sending on presence with `+notify`:
Goffi <goffi@goffi.org>
parents:
462
diff
changeset
|
468 @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
|
469 @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
|
470 """ |
|
ff8aff4c9b79
backend, psql: implemented notifications for auto subscribers in PEP:
Goffi <goffi@goffi.org>
parents:
342
diff
changeset
|
471 auto_subscribers = [] |
|
463
f520ac3164b0
privilege: improvment on last message sending on presence with `+notify`:
Goffi <goffi@goffi.org>
parents:
462
diff
changeset
|
472 roster = await self.getRoster(recipient) |
| 414 | 473 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
|
474 if roster_jid in explicit_subscribers: |
|
ff8aff4c9b79
backend, psql: implemented notifications for auto subscribers in PEP:
Goffi <goffi@goffi.org>
parents:
342
diff
changeset
|
475 continue |
|
ff8aff4c9b79
backend, psql: implemented notifications for auto subscribers in PEP:
Goffi <goffi@goffi.org>
parents:
342
diff
changeset
|
476 if roster_item.subscriptionFrom: |
|
ff8aff4c9b79
backend, psql: implemented notifications for auto subscribers in PEP:
Goffi <goffi@goffi.org>
parents:
342
diff
changeset
|
477 try: |
|
ff8aff4c9b79
backend, psql: implemented notifications for auto subscribers in PEP:
Goffi <goffi@goffi.org>
parents:
342
diff
changeset
|
478 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
|
479 except KeyError: |
|
ff8aff4c9b79
backend, psql: implemented notifications for auto subscribers in PEP:
Goffi <goffi@goffi.org>
parents:
342
diff
changeset
|
480 continue |
| 414 | 481 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
|
482 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
|
483 if nodeIdentifier in notify: |
|
ff8aff4c9b79
backend, psql: implemented notifications for auto subscribers in PEP:
Goffi <goffi@goffi.org>
parents:
342
diff
changeset
|
484 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
|
485 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
|
486 return auto_subscribers |