annotate sat/core/xmpp.py @ 2702:6555e9835ff8

plugin XEP-0060: use new parseExtra methods from MAM and RSM
author Goffi <goffi@goffi.org>
date Sat, 01 Dec 2018 10:34:42 +0100
parents 2ea2369ae7de
children 57eac4fd0ec0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1934
2daf7b4c6756 use of /usr/bin/env instead of /usr/bin/python in shebang
Goffi <goffi@goffi.org>
parents: 1766
diff changeset
1 #!/usr/bin/env python2
0
goffi@necton2
parents:
diff changeset
2 # -*- coding: utf-8 -*-
goffi@necton2
parents:
diff changeset
3
609
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 589
diff changeset
4 # SAT: a jabber client
2483
0046283a285d dates update
Goffi <goffi@goffi.org>
parents: 2460
diff changeset
5 # Copyright (C) 2009-2018 Jérôme Poisson (goffi@goffi.org)
0
goffi@necton2
parents:
diff changeset
6
609
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 589
diff changeset
7 # This program is free software: you can redistribute it and/or modify
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 589
diff changeset
8 # it under the terms of the GNU Affero General Public License as published by
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 589
diff changeset
9 # the Free Software Foundation, either version 3 of the License, or
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 589
diff changeset
10 # (at your option) any later version.
0
goffi@necton2
parents:
diff changeset
11
609
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 589
diff changeset
12 # This program is distributed in the hope that it will be useful,
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 589
diff changeset
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 589
diff changeset
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 589
diff changeset
15 # GNU Affero General Public License for more details.
0
goffi@necton2
parents:
diff changeset
16
609
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 589
diff changeset
17 # You should have received a copy of the GNU Affero General Public License
84a6e83157c2 fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents: 589
diff changeset
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
0
goffi@necton2
parents:
diff changeset
19
1053
71d63750963e core (XMPP): message received (onMessage) refactoring:
Goffi <goffi@goffi.org>
parents: 1037
diff changeset
20 from sat.core.i18n import _
923
e77948faaef3 core: removed default_config:
Goffi <goffi@goffi.org>
parents: 875
diff changeset
21 from sat.core.constants import Const as C
2109
85f3e12e984d core (memory/cache): file caching handling, first draft:
Goffi <goffi@goffi.org>
parents: 2099
diff changeset
22 from sat.memory import cache
2694
a8ec00731ce7 core: removed whitespace ping (not needed anymore as we handle XMPP ping)
Goffi <goffi@goffi.org>
parents: 2693
diff changeset
23 from twisted.internet import defer
1955
633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished):
Goffi <goffi@goffi.org>
parents: 1934
diff changeset
24 from twisted.words.protocols.jabber.xmlstream import XMPPHandler
633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished):
Goffi <goffi@goffi.org>
parents: 1934
diff changeset
25 from twisted.words.protocols.jabber import xmlstream
1573
6338677f3a89 core (client): added a sendError method to easily build error response from <IQ\> stanza
Goffi <goffi@goffi.org>
parents: 1564
diff changeset
26 from twisted.words.protocols.jabber import error
1955
633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished):
Goffi <goffi@goffi.org>
parents: 1934
diff changeset
27 from twisted.words.protocols.jabber import jid
2130
f0bc29dc8157 added "send" trigger point as the last one before sending, can be used for e2e encryption
Goffi <goffi@goffi.org>
parents: 2113
diff changeset
28 from twisted.words.xish import domish
1955
633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished):
Goffi <goffi@goffi.org>
parents: 1934
diff changeset
29 from twisted.python import failure
1963
a2bc5089c2eb backend, frontends: message refactoring (huge commit):
Goffi <goffi@goffi.org>
parents: 1955
diff changeset
30 from wokkel import client as wokkel_client, disco, xmppim, generic, iwokkel
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
31 from wokkel import component
1955
633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished):
Goffi <goffi@goffi.org>
parents: 1934
diff changeset
32 from wokkel import delay
993
301b342c697a core: use of the new core.log module:
Goffi <goffi@goffi.org>
parents: 960
diff changeset
33 from sat.core.log import getLogger
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
34
993
301b342c697a core: use of the new core.log module:
Goffi <goffi@goffi.org>
parents: 960
diff changeset
35 log = getLogger(__name__)
501
e9634d2e7b38 core, quick_frontend, primitivus, wix: Contacts List refactoring phase 1:
Goffi <goffi@goffi.org>
parents: 487
diff changeset
36 from sat.core import exceptions
2646
712cb4ff3e13 core: new EncryptionHandler class which manage encrypted session as a core feature:
Goffi <goffi@goffi.org>
parents: 2645
diff changeset
37 from sat.memory import encryption
2687
e9cd473a2f46 core (xmpp): server certificate validation:
Goffi <goffi@goffi.org>
parents: 2661
diff changeset
38 from sat.tools import xml_tools
666
2a7185b8452c core: added SatIdentityHandler for Disco Identity, and set identity to "client/pc/Salut à Toi"
Goffi <goffi@goffi.org>
parents: 663
diff changeset
39 from zope.interface import implements
1955
633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished):
Goffi <goffi@goffi.org>
parents: 1934
diff changeset
40 import time
633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished):
Goffi <goffi@goffi.org>
parents: 1934
diff changeset
41 import calendar
633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished):
Goffi <goffi@goffi.org>
parents: 1934
diff changeset
42 import uuid
2089
0931b5a6213c core, quick_frontends: android compatibility hacks:
Goffi <goffi@goffi.org>
parents: 2050
diff changeset
43 import sys
0
goffi@necton2
parents:
diff changeset
44
333
4c835d614bdb core: fixed a None sent instead of empty dict in unavailableReceived
Goffi <goffi@goffi.org>
parents: 330
diff changeset
45
2688
943e78e18882 core (xmpp): added missing disco#info namespace to disco info result.
Goffi <goffi@goffi.org>
parents: 2687
diff changeset
46 NS_X_DATA = u"jabber:x:data"
943e78e18882 core (xmpp): added missing disco#info namespace to disco info result.
Goffi <goffi@goffi.org>
parents: 2687
diff changeset
47 NS_DISCO_INFO = u"http://jabber.org/protocol/disco#info"
943e78e18882 core (xmpp): added missing disco#info namespace to disco info result.
Goffi <goffi@goffi.org>
parents: 2687
diff changeset
48
943e78e18882 core (xmpp): added missing disco#info namespace to disco info result.
Goffi <goffi@goffi.org>
parents: 2687
diff changeset
49
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
50 class SatXMPPEntity(object):
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
51 """Common code for Client and Component"""
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 572
diff changeset
52
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
53 def __init__(self, host_app, profile, max_retries):
2691
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
54 factory = self.factory
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
55 factory.maxRetries = max_retries
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
56 factory.maxDelay = 30
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
57 # when self._connected_d is None, we are not connected
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
58 # else, it's a deferred which fire on disconnection
2691
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
59 self._connected_d = None
62
93cb45a7420f SàT multi-profile: connection using profiles
Goffi <goffi@goffi.org>
parents: 60
diff changeset
60 self.profile = profile
64
d46f849664aa SàT: multi-profile, plugins updated
Goffi <goffi@goffi.org>
parents: 63
diff changeset
61 self.host_app = host_app
2109
85f3e12e984d core (memory/cache): file caching handling, first draft:
Goffi <goffi@goffi.org>
parents: 2099
diff changeset
62 self.cache = cache.Cache(host_app, profile)
2701
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages:
Goffi <goffi@goffi.org>
parents: 2694
diff changeset
63 self.mess_id2uid = {} # map from message id to uid used in history.
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages:
Goffi <goffi@goffi.org>
parents: 2694
diff changeset
64 # Key: (full_jid, message_id) Value: uid
2691
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
65 # this Deferred fire when entity is connected
341
9eebdc655b8b code: added asyncConnect
Goffi <goffi@goffi.org>
parents: 336
diff changeset
66 self.conn_deferred = defer.Deferred()
2643
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
67 self._progress_cb = {} # callback called when a progress is requested
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
68 # (key = progress id)
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
69 self.actions = {} # used to keep track of actions for retrieval (key = action_id)
2658
4e130cc9bfc0 core (memore/encryption): new methods and checks:
Goffi <goffi@goffi.org>
parents: 2650
diff changeset
70 self.encryption = encryption.EncryptionHandler(self)
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
71
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
72 ## initialisation ##
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
73
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
74 @defer.inlineCallbacks
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
75 def _callConnectionTriggers(self):
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
76 """Call conneting trigger prepare connected trigger
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
77
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
78 @param plugins(iterable): plugins to use
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
79 @return (list[object, callable]): plugin to trigger tuples with:
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
80 - plugin instance
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
81 - profileConnected* triggers (to call after connection)
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
82 """
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
83 plugin_conn_cb = []
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
84 for plugin in self._getPluginsList():
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
85 # we check if plugin handle client mode
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
86 if plugin.is_handler:
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
87 plugin.getHandler(self).setHandlerParent(self)
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
88
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
89 # profileConnecting/profileConnected methods handling
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
90
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
91 # profile connecting is called right now (before actually starting client)
2498
d6de69da3dd4 core (client): component improvments:
Goffi <goffi@goffi.org>
parents: 2497
diff changeset
92 connecting_cb = getattr(plugin, "profileConnecting", None)
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
93 if connecting_cb is not None:
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
94 yield connecting_cb(self)
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
95
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
96 # profile connected is called after client is ready and roster is got
2498
d6de69da3dd4 core (client): component improvments:
Goffi <goffi@goffi.org>
parents: 2497
diff changeset
97 connected_cb = getattr(plugin, "profileConnected", None)
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
98 if connected_cb is not None:
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
99 plugin_conn_cb.append((plugin, connected_cb))
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
100
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
101 defer.returnValue(plugin_conn_cb)
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
102
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
103 def _getPluginsList(self):
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
104 """Return list of plugin to use
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
105
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
106 need to be implemented by subclasses
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
107 this list is used to call profileConnect* triggers
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
108 @return(iterable[object]): plugins to use
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
109 """
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
110 raise NotImplementedError
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
111
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
112 def _createSubProtocols(self):
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
113 return
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
114
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
115 def entityConnected(self):
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
116 """Called once connection is done
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
117
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
118 may return a Deferred, to perform initialisation tasks
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
119 """
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
120 return
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
121
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
122 @classmethod
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
123 @defer.inlineCallbacks
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
124 def startConnection(cls, host, profile, max_retries):
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
125 """instantiate the entity and start the connection"""
2643
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
126 # FIXME: reconnection doesn't seems to be handled correclty
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
127 # (client is deleted then recreated from scratch)
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
128 # most of methods called here should be called once on first connection
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
129 # (e.g. adding subprotocols)
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
130 # but client should not be deleted except if session is finished
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
131 # (independently of connection/deconnection)
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
132 try:
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
133 port = int(
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
134 host.memory.getParamA(
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
135 C.FORCE_PORT_PARAM, "Connection", profile_key=profile
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
136 )
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
137 )
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
138 except ValueError:
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
139 log.debug(_("Can't parse port value, using default value"))
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
140 port = (
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
141 None
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
142 ) # will use default value 5222 or be retrieved from a DNS SRV record
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
143
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
144 password = yield host.memory.asyncGetParamA(
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
145 "Password", "Connection", profile_key=profile
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
146 )
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
147 entity = host.profiles[profile] = cls(
2691
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
148 host, profile, jid.JID(host.memory.getParamA("JabberID", "Connection",
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
149 profile_key=profile)), password,
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
150 host.memory.getParamA(C.FORCE_SERVER_PARAM, "Connection",
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
151 profile_key=profile) or None,
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
152 port, max_retries,
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
153 )
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
154
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
155 entity._createSubProtocols()
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
156
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
157 entity.fallBack = SatFallbackHandler(host)
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
158 entity.fallBack.setHandlerParent(entity)
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
159
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
160 entity.versionHandler = SatVersionHandler(C.APP_NAME_FULL, host.full_version)
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
161 entity.versionHandler.setHandlerParent(entity)
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
162
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
163 entity.identityHandler = SatIdentityHandler()
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
164 entity.identityHandler.setHandlerParent(entity)
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
165
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
166 log.debug(_("setting plugins parents"))
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
167
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
168 plugin_conn_cb = yield entity._callConnectionTriggers()
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
169
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
170 entity.startService()
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
171
2691
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
172 yield entity.conn_deferred
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
173
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
174 yield defer.maybeDeferred(entity.entityConnected)
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
175
2643
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
176 # Call profileConnected callback for all plugins,
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
177 # and print error message if any of them fails
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
178 conn_cb_list = []
2643
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
179 for __, callback in plugin_conn_cb:
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
180 conn_cb_list.append(defer.maybeDeferred(callback, entity))
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
181 list_d = defer.DeferredList(conn_cb_list)
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
182
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
183 def logPluginResults(results):
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
184 all_succeed = all([success for success, result in results])
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
185 if not all_succeed:
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
186 log.error(_(u"Plugins initialisation error"))
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
187 for idx, (success, result) in enumerate(results):
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
188 if not success:
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
189 log.error(
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
190 u"error (plugin %(name)s): %(failure)s"
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
191 % {
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
192 "name": plugin_conn_cb[idx][0]._info["import_name"],
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
193 "failure": result,
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
194 }
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
195 )
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
196
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
197 yield list_d.addCallback(
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
198 logPluginResults
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
199 ) # FIXME: we should have a timeout here, and a way to know if a plugin freeze
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
200 # TODO: mesure launch time of each plugin
341
9eebdc655b8b code: added asyncConnect
Goffi <goffi@goffi.org>
parents: 336
diff changeset
201
2661
661f66d41215 core (xmpp): send initial presence only after all profileConnected have been treated:
Goffi <goffi@goffi.org>
parents: 2658
diff changeset
202 # we finally send our presence
661f66d41215 core (xmpp): send initial presence only after all profileConnected have been treated:
Goffi <goffi@goffi.org>
parents: 2658
diff changeset
203 entity.presence.available()
661f66d41215 core (xmpp): send initial presence only after all profileConnected have been treated:
Goffi <goffi@goffi.org>
parents: 2658
diff changeset
204
2643
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
205 def _disconnectionCb(self, __):
2691
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
206 self._connected_d = None
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
207
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
208 def _disconnectionEb(self, failure_):
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
209 log.error(_(u"Error while disconnecting: {}".format(failure_)))
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
210
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
211 def _authd(self, xmlstream):
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
212 super(SatXMPPEntity, self)._authd(xmlstream)
2691
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
213 log.debug(_(u"{profile} identified").format(profile=self.profile))
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
214 self.streamInitialized()
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
215
2643
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
216 def _finish_connection(self, __):
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
217 self.conn_deferred.callback(None)
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
218
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
219 def streamInitialized(self):
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
220 """Called after _authd"""
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
221 log.debug(_(u"XML stream is initialized"))
2691
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
222 if not self.host_app.trigger.point("xml_init", self):
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
223 return
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
224 self.postStreamInit()
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
225
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
226 def postStreamInit(self):
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
227 """Workflow after stream initalisation."""
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
228 log.info(
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
229 _(u"********** [{profile}] CONNECTED **********").format(profile=self.profile)
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
230 )
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
231
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
232 # the following Deferred is used to know when we are connected
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
233 # so we need to be set it to None when connection is lost
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
234 self._connected_d = defer.Deferred()
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
235 self._connected_d.addCallback(self._cleanConnection)
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
236 self._connected_d.addCallback(self._disconnectionCb)
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
237 self._connected_d.addErrback(self._disconnectionEb)
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
238
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
239 self.host_app.bridge.connected(
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
240 self.profile, unicode(self.jid)
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
241 ) # we send the signal to the clients
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
242
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
243
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
244 self.disco = SatDiscoProtocol(self)
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
245 self.disco.setHandlerParent(self)
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
246 self.discoHandler = disco.DiscoHandler()
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
247 self.discoHandler.setHandlerParent(self)
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
248 disco_d = defer.succeed(None)
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
249
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
250 if not self.host_app.trigger.point("Disco handled", disco_d, self.profile):
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
251 return
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
252
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
253 disco_d.addCallback(self._finish_connection)
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
254
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
255 def initializationFailed(self, reason):
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
256 log.error(
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
257 _(
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
258 u"ERROR: XMPP connection failed for profile '%(profile)s': %(reason)s"
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
259 % {"profile": self.profile, "reason": reason}
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
260 )
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
261 )
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
262 self.conn_deferred.errback(reason.value)
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
263 try:
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
264 super(SatXMPPEntity, self).initializationFailed(reason)
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
265 except:
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
266 # we already chained an errback, no need to raise an exception
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
267 pass
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
268
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
269 ## connection ##
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
270
2691
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
271 def _connected(self, xs):
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
272 send_hooks = []
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
273 receive_hooks = []
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
274 self.host_app.trigger.point(
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
275 "stream_hooks", self, receive_hooks, send_hooks)
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
276 for hook in receive_hooks:
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
277 xs.addHook(C.STREAM_HOOK_RECEIVE, hook)
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
278 for hook in send_hooks:
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
279 xs.addHook(C.STREAM_HOOK_SEND, hook)
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
280 super(SatXMPPEntity, self)._connected(xs)
2687
e9cd473a2f46 core (xmpp): server certificate validation:
Goffi <goffi@goffi.org>
parents: 2661
diff changeset
281
2691
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
282 def disconnectProfile(self, reason):
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
283 if self._connected_d is not None:
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
284 self.host_app.bridge.disconnected(
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
285 self.profile
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
286 ) # we send the signal to the clients
2691
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
287 self._connected_d.callback(None)
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
288 self.host_app.purgeEntity(
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
289 self.profile
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
290 ) # and we remove references to this client
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
291 log.info(
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
292 _(u"********** [{profile}] DISCONNECTED **********").format(
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
293 profile=self.profile
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
294 )
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
295 )
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
296 if not self.conn_deferred.called:
2691
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
297 if reason is None:
2687
e9cd473a2f46 core (xmpp): server certificate validation:
Goffi <goffi@goffi.org>
parents: 2661
diff changeset
298 err = error.StreamError(u"Server unexpectedly closed the connection")
e9cd473a2f46 core (xmpp): server certificate validation:
Goffi <goffi@goffi.org>
parents: 2661
diff changeset
299 else:
2691
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
300 err = reason
2687
e9cd473a2f46 core (xmpp): server certificate validation:
Goffi <goffi@goffi.org>
parents: 2661
diff changeset
301 try:
e9cd473a2f46 core (xmpp): server certificate validation:
Goffi <goffi@goffi.org>
parents: 2661
diff changeset
302 if err.value.args[0][0][2] == "certificate verify failed":
e9cd473a2f46 core (xmpp): server certificate validation:
Goffi <goffi@goffi.org>
parents: 2661
diff changeset
303 err = exceptions.InvalidCertificate(
e9cd473a2f46 core (xmpp): server certificate validation:
Goffi <goffi@goffi.org>
parents: 2661
diff changeset
304 _(u"Your server certificate is not valid "
e9cd473a2f46 core (xmpp): server certificate validation:
Goffi <goffi@goffi.org>
parents: 2661
diff changeset
305 u"(its identity can't be checked).\n\n"
e9cd473a2f46 core (xmpp): server certificate validation:
Goffi <goffi@goffi.org>
parents: 2661
diff changeset
306 u"This should never happen and may indicate that "
e9cd473a2f46 core (xmpp): server certificate validation:
Goffi <goffi@goffi.org>
parents: 2661
diff changeset
307 u"somebody is trying to spy on you.\n"
e9cd473a2f46 core (xmpp): server certificate validation:
Goffi <goffi@goffi.org>
parents: 2661
diff changeset
308 u"Please contact your server administrator."))
2691
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
309 self.factory.continueTrying = 0
2687
e9cd473a2f46 core (xmpp): server certificate validation:
Goffi <goffi@goffi.org>
parents: 2661
diff changeset
310 except (IndexError, TypeError):
e9cd473a2f46 core (xmpp): server certificate validation:
Goffi <goffi@goffi.org>
parents: 2661
diff changeset
311 pass
e9cd473a2f46 core (xmpp): server certificate validation:
Goffi <goffi@goffi.org>
parents: 2661
diff changeset
312 self.conn_deferred.errback(err)
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
313
2691
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
314 def _disconnected(self, reason):
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
315 super(SatXMPPEntity, self)._disconnected(reason)
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
316 if not self.host_app.trigger.point("disconnected", self, reason):
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
317 return
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
318 self.disconnectProfile(reason)
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
319
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
320 @defer.inlineCallbacks
2643
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
321 def _cleanConnection(self, __):
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
322 """method called on disconnection
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
323
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
324 used to call profileDisconnected* triggers
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
325 """
2498
d6de69da3dd4 core (client): component improvments:
Goffi <goffi@goffi.org>
parents: 2497
diff changeset
326 trigger_name = "profileDisconnected"
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
327 for plugin in self._getPluginsList():
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
328 disconnected_cb = getattr(plugin, trigger_name, None)
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
329 if disconnected_cb is not None:
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
330 yield disconnected_cb(self)
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
331
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
332 def isConnected(self):
2691
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
333 try:
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
334 return bool(self.xmlstream.transport.connected)
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
335 except AttributeError:
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
336 return False
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
337
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
338 def entityDisconnect(self):
2691
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
339 if not self.host_app.trigger.point("disconnecting", self):
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
340 return
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
341 log.info(_(u"Disconnecting..."))
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
342 self.stopService()
2691
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
343 if self._connected_d is not None:
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
344 return self._connected_d
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
345 else:
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
346 return defer.succeed(None)
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
347
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
348 ## sending ##
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
349
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
350 def IQ(self, type_=u"set", timeout=60):
1551
591c32dbfb0b core (client): add IQ method to easily create an IQ stanza with the current xmlstream, and manage result with a Deferred.
Goffi <goffi@goffi.org>
parents: 1522
diff changeset
351 """shortcut to create an IQ element managing deferred
591c32dbfb0b core (client): add IQ method to easily create an IQ stanza with the current xmlstream, and manage result with a Deferred.
Goffi <goffi@goffi.org>
parents: 1522
diff changeset
352
591c32dbfb0b core (client): add IQ method to easily create an IQ stanza with the current xmlstream, and manage result with a Deferred.
Goffi <goffi@goffi.org>
parents: 1522
diff changeset
353 @param type_(unicode): IQ type ('set' or 'get')
591c32dbfb0b core (client): add IQ method to easily create an IQ stanza with the current xmlstream, and manage result with a Deferred.
Goffi <goffi@goffi.org>
parents: 1522
diff changeset
354 @param timeout(None, int): timeout in seconds
2110
2d633b3c923d plugin XEP-0231: Bits of Binary first draft:
Goffi <goffi@goffi.org>
parents: 2109
diff changeset
355 @return((D)domish.Element: result stanza
2d633b3c923d plugin XEP-0231: Bits of Binary first draft:
Goffi <goffi@goffi.org>
parents: 2109
diff changeset
356 errback is called if and error stanza is returned
1551
591c32dbfb0b core (client): add IQ method to easily create an IQ stanza with the current xmlstream, and manage result with a Deferred.
Goffi <goffi@goffi.org>
parents: 1522
diff changeset
357 """
591c32dbfb0b core (client): add IQ method to easily create an IQ stanza with the current xmlstream, and manage result with a Deferred.
Goffi <goffi@goffi.org>
parents: 1522
diff changeset
358 iq_elt = xmlstream.IQ(self.xmlstream, type_)
591c32dbfb0b core (client): add IQ method to easily create an IQ stanza with the current xmlstream, and manage result with a Deferred.
Goffi <goffi@goffi.org>
parents: 1522
diff changeset
359 iq_elt.timeout = timeout
591c32dbfb0b core (client): add IQ method to easily create an IQ stanza with the current xmlstream, and manage result with a Deferred.
Goffi <goffi@goffi.org>
parents: 1522
diff changeset
360 return iq_elt
591c32dbfb0b core (client): add IQ method to easily create an IQ stanza with the current xmlstream, and manage result with a Deferred.
Goffi <goffi@goffi.org>
parents: 1522
diff changeset
361
1573
6338677f3a89 core (client): added a sendError method to easily build error response from <IQ\> stanza
Goffi <goffi@goffi.org>
parents: 1564
diff changeset
362 def sendError(self, iq_elt, condition):
6338677f3a89 core (client): added a sendError method to easily build error response from <IQ\> stanza
Goffi <goffi@goffi.org>
parents: 1564
diff changeset
363 """Send error stanza build from iq_elt
6338677f3a89 core (client): added a sendError method to easily build error response from <IQ\> stanza
Goffi <goffi@goffi.org>
parents: 1564
diff changeset
364
6338677f3a89 core (client): added a sendError method to easily build error response from <IQ\> stanza
Goffi <goffi@goffi.org>
parents: 1564
diff changeset
365 @param iq_elt(domish.Element): initial IQ element
6338677f3a89 core (client): added a sendError method to easily build error response from <IQ\> stanza
Goffi <goffi@goffi.org>
parents: 1564
diff changeset
366 @param condition(unicode): error condition
6338677f3a89 core (client): added a sendError method to easily build error response from <IQ\> stanza
Goffi <goffi@goffi.org>
parents: 1564
diff changeset
367 """
6338677f3a89 core (client): added a sendError method to easily build error response from <IQ\> stanza
Goffi <goffi@goffi.org>
parents: 1564
diff changeset
368 iq_error_elt = error.StanzaError(condition).toResponse(iq_elt)
6338677f3a89 core (client): added a sendError method to easily build error response from <IQ\> stanza
Goffi <goffi@goffi.org>
parents: 1564
diff changeset
369 self.xmlstream.send(iq_error_elt)
6338677f3a89 core (client): added a sendError method to easily build error response from <IQ\> stanza
Goffi <goffi@goffi.org>
parents: 1564
diff changeset
370
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
371 def generateMessageXML(self, data):
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
372 """Generate <message/> stanza from message data
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
373
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
374 @param data(dict): message data
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
375 domish element will be put in data['xml']
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
376 following keys are needed:
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
377 - from
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
378 - to
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
379 - uid: can be set to '' if uid attribute is not wanted
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
380 - message
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
381 - type
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
382 - subject
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
383 - extra
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
384 @return (dict) message data
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
385 """
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
386 data["xml"] = message_elt = domish.Element((None, "message"))
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
387 message_elt["to"] = data["to"].full()
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
388 message_elt["from"] = data["from"].full()
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
389 message_elt["type"] = data["type"]
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
390 if data["uid"]: # key must be present but can be set to ''
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
391 # by a plugin to avoid id on purpose
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
392 message_elt["id"] = data["uid"]
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
393 for lang, subject in data["subject"].iteritems():
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
394 subject_elt = message_elt.addElement("subject", content=subject)
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
395 if lang:
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
396 subject_elt[(C.NS_XML, "lang")] = lang
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
397 for lang, message in data["message"].iteritems():
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
398 body_elt = message_elt.addElement("body", content=message)
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
399 if lang:
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
400 body_elt[(C.NS_XML, "lang")] = lang
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
401 try:
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
402 thread = data["extra"]["thread"]
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
403 except KeyError:
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
404 if "thread_parent" in data["extra"]:
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
405 raise exceptions.InternalError(
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
406 u"thread_parent found while there is not associated thread"
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
407 )
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
408 else:
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
409 thread_elt = message_elt.addElement("thread", content=thread)
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
410 try:
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
411 thread_elt["parent"] = data["extra"]["thread_parent"]
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
412 except KeyError:
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
413 pass
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
414 return data
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
415
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
416 def addPostXmlCallbacks(self, post_xml_treatments):
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
417 """Used to add class level callbacks at the end of the workflow
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
418
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
419 @param post_xml_treatments(D): the same Deferred as in sendMessage trigger
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
420 """
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
421 raise NotImplementedError
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
422
2643
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
423 def sendMessage(self, to_jid, message, subject=None, mess_type="auto", extra=None,
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
424 uid=None, no_trigger=False,):
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
425 r"""Send a message to an entity
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
426
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
427 @param to_jid(jid.JID): destinee of the message
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
428 @param message(dict): message body, key is the language (use '' when unknown)
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
429 @param subject(dict): message subject, key is the language (use '' when unknown)
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
430 @param mess_type(str): one of standard message type (cf RFC 6121 §5.2.2) or:
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
431 - auto: for automatic type detection
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
432 - info: for information ("info_type" can be specified in extra)
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
433 @param extra(dict, None): extra data. Key can be:
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
434 - info_type: information type, can be
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
435 TODO
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
436 @param uid(unicode, None): unique id:
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
437 should be unique at least in this XMPP session
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
438 if None, an uuid will be generated
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
439 @param no_trigger (bool): if True, sendMessage[suffix] trigger will no be used
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
440 useful when a message need to be sent without any modification
2646
712cb4ff3e13 core: new EncryptionHandler class which manage encrypted session as a core feature:
Goffi <goffi@goffi.org>
parents: 2645
diff changeset
441 /!\ this will also skip encryption methods!
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
442 """
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
443 if subject is None:
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
444 subject = {}
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
445 if extra is None:
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
446 extra = {}
2460
feaacc462fef core: moved CHAT_* constants from frontends to core constants + uses constants for MESS_TYPE_* in sendMessage
Goffi <goffi@goffi.org>
parents: 2414
diff changeset
447
feaacc462fef core: moved CHAT_* constants from frontends to core constants + uses constants for MESS_TYPE_* in sendMessage
Goffi <goffi@goffi.org>
parents: 2414
diff changeset
448 assert mess_type in C.MESS_TYPE_ALL
feaacc462fef core: moved CHAT_* constants from frontends to core constants + uses constants for MESS_TYPE_* in sendMessage
Goffi <goffi@goffi.org>
parents: 2414
diff changeset
449
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
450 data = { # dict is similar to the one used in client.onMessage
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
451 "from": self.jid,
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
452 "to": to_jid,
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
453 "uid": uid or unicode(uuid.uuid4()),
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
454 "message": message,
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
455 "subject": subject,
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
456 "type": mess_type,
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
457 "extra": extra,
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
458 "timestamp": time.time(),
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
459 }
2645
f2cf1daa42cb core: added async TriggerManager
Goffi <goffi@goffi.org>
parents: 2643
diff changeset
460 # XXX: plugin can add their pre XML treatments to this deferred
f2cf1daa42cb core: added async TriggerManager
Goffi <goffi@goffi.org>
parents: 2643
diff changeset
461 pre_xml_treatments = defer.Deferred()
f2cf1daa42cb core: added async TriggerManager
Goffi <goffi@goffi.org>
parents: 2643
diff changeset
462 # XXX: plugin can add their post XML treatments to this deferred
f2cf1daa42cb core: added async TriggerManager
Goffi <goffi@goffi.org>
parents: 2643
diff changeset
463 post_xml_treatments = defer.Deferred()
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
464
2460
feaacc462fef core: moved CHAT_* constants from frontends to core constants + uses constants for MESS_TYPE_* in sendMessage
Goffi <goffi@goffi.org>
parents: 2414
diff changeset
465 if data["type"] == C.MESS_TYPE_AUTO:
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
466 # we try to guess the type
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
467 if data["subject"]:
2460
feaacc462fef core: moved CHAT_* constants from frontends to core constants + uses constants for MESS_TYPE_* in sendMessage
Goffi <goffi@goffi.org>
parents: 2414
diff changeset
468 data["type"] = C.MESS_TYPE_NORMAL
2645
f2cf1daa42cb core: added async TriggerManager
Goffi <goffi@goffi.org>
parents: 2643
diff changeset
469 elif not data["to"].resource: # if to JID has a resource,
f2cf1daa42cb core: added async TriggerManager
Goffi <goffi@goffi.org>
parents: 2643
diff changeset
470 # the type is not 'groupchat'
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
471 # we may have a groupchat message, we check if the we know this jid
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
472 try:
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
473 entity_type = self.host_app.memory.getEntityData(
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
474 data["to"], ["type"], self.profile
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
475 )["type"]
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
476 # FIXME: should entity_type manage resources ?
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
477 except (exceptions.UnknownEntityError, KeyError):
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
478 entity_type = "contact"
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
479
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
480 if entity_type == "chatroom":
2460
feaacc462fef core: moved CHAT_* constants from frontends to core constants + uses constants for MESS_TYPE_* in sendMessage
Goffi <goffi@goffi.org>
parents: 2414
diff changeset
481 data["type"] = C.MESS_TYPE_GROUPCHAT
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
482 else:
2460
feaacc462fef core: moved CHAT_* constants from frontends to core constants + uses constants for MESS_TYPE_* in sendMessage
Goffi <goffi@goffi.org>
parents: 2414
diff changeset
483 data["type"] = C.MESS_TYPE_CHAT
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
484 else:
2460
feaacc462fef core: moved CHAT_* constants from frontends to core constants + uses constants for MESS_TYPE_* in sendMessage
Goffi <goffi@goffi.org>
parents: 2414
diff changeset
485 data["type"] == C.MESS_TYPE_CHAT
feaacc462fef core: moved CHAT_* constants from frontends to core constants + uses constants for MESS_TYPE_* in sendMessage
Goffi <goffi@goffi.org>
parents: 2414
diff changeset
486 data["type"] == C.MESS_TYPE_CHAT if data["subject"] else C.MESS_TYPE_NORMAL
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
487
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
488 # FIXME: send_only is used by libervia's OTR plugin to avoid
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
489 # the triggers from frontend, and no_trigger do the same
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
490 # thing internally, this could be unified
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
491 send_only = data["extra"].get("send_only", False)
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
492
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
493 if not no_trigger and not send_only:
2646
712cb4ff3e13 core: new EncryptionHandler class which manage encrypted session as a core feature:
Goffi <goffi@goffi.org>
parents: 2645
diff changeset
494 # is the session encrypted? If so we indicate it in data
712cb4ff3e13 core: new EncryptionHandler class which manage encrypted session as a core feature:
Goffi <goffi@goffi.org>
parents: 2645
diff changeset
495 self.encryption.setEncryptionFlag(data)
712cb4ff3e13 core: new EncryptionHandler class which manage encrypted session as a core feature:
Goffi <goffi@goffi.org>
parents: 2645
diff changeset
496
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
497 if not self.host_app.trigger.point(
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
498 "sendMessage" + self.trigger_suffix,
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
499 self,
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
500 data,
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
501 pre_xml_treatments,
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
502 post_xml_treatments,
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
503 ):
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
504 return defer.succeed(None)
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
505
2643
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
506 log.debug(_(u"Sending message (type {type}, to {to})")
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
507 .format(type=data["type"], to=to_jid.full()))
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
508
2643
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
509 pre_xml_treatments.addCallback(lambda __: self.generateMessageXML(data))
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
510 pre_xml_treatments.chainDeferred(post_xml_treatments)
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
511 post_xml_treatments.addCallback(self.sendMessageData)
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
512 if send_only:
2643
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
513 log.debug(_(u"Triggers, storage and echo have been inhibited by the "
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
514 u"'send_only' parameter"))
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
515 else:
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
516 self.addPostXmlCallbacks(post_xml_treatments)
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
517 post_xml_treatments.addErrback(self._cancelErrorTrap)
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
518 post_xml_treatments.addErrback(self.host_app.logErrback)
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
519 pre_xml_treatments.callback(data)
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
520 return pre_xml_treatments
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
521
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
522 def _cancelErrorTrap(self, failure):
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
523 """A message sending can be cancelled by a plugin treatment"""
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
524 failure.trap(exceptions.CancelError)
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
525
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
526 def messageAddToHistory(self, data):
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
527 """Store message into database (for local history)
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
528
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
529 @param data: message data dictionnary
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
530 @param client: profile's client
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
531 """
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
532 if data[u"type"] != C.MESS_TYPE_GROUPCHAT:
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
533 # we don't add groupchat message to history, as we get them back
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
534 # and they will be added then
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
535 if data[u"message"] or data[u"subject"]: # we need a message to store
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
536 self.host_app.memory.addToHistory(self, data)
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
537 else:
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
538 log.warning(
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
539 u"No message found"
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
540 ) # empty body should be managed by plugins before this point
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
541 return data
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
542
2701
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages:
Goffi <goffi@goffi.org>
parents: 2694
diff changeset
543 def messageGetBridgeArgs(self, data):
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages:
Goffi <goffi@goffi.org>
parents: 2694
diff changeset
544 """Generate args to use with bridge from data dict"""
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages:
Goffi <goffi@goffi.org>
parents: 2694
diff changeset
545 return (data[u"uid"], data[u"timestamp"], data[u"from"].full(),
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages:
Goffi <goffi@goffi.org>
parents: 2694
diff changeset
546 data[u"to"].full(), data[u"message"], data[u"subject"],
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages:
Goffi <goffi@goffi.org>
parents: 2694
diff changeset
547 data[u"type"], data[u"extra"])
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages:
Goffi <goffi@goffi.org>
parents: 2694
diff changeset
548
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages:
Goffi <goffi@goffi.org>
parents: 2694
diff changeset
549
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
550 def messageSendToBridge(self, data):
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
551 """Send message to bridge, so frontends can display it
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
552
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
553 @param data: message data dictionnary
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
554 @param client: profile's client
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
555 """
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
556 if data[u"type"] != C.MESS_TYPE_GROUPCHAT:
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
557 # we don't send groupchat message to bridge, as we get them back
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
558 # and they will be added the
2701
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages:
Goffi <goffi@goffi.org>
parents: 2694
diff changeset
559 if (data[u"message"] or data[u"subject"]): # we need a message to send
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages:
Goffi <goffi@goffi.org>
parents: 2694
diff changeset
560 # something
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages:
Goffi <goffi@goffi.org>
parents: 2694
diff changeset
561
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
562 # We send back the message, so all frontends are aware of it
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
563 self.host_app.bridge.messageNew(
2701
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages:
Goffi <goffi@goffi.org>
parents: 2694
diff changeset
564 *self.messageGetBridgeArgs(data),
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages:
Goffi <goffi@goffi.org>
parents: 2694
diff changeset
565 profile=self.profile
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
566 )
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
567 else:
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
568 log.warning(_(u"No message found"))
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
569 return data
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
570
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
571
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
572 class SatXMPPClient(SatXMPPEntity, wokkel_client.XMPPClient):
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
573 implements(iwokkel.IDisco)
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
574 trigger_suffix = ""
2498
d6de69da3dd4 core (client): component improvments:
Goffi <goffi@goffi.org>
parents: 2497
diff changeset
575 is_component = False
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
576
2687
e9cd473a2f46 core (xmpp): server certificate validation:
Goffi <goffi@goffi.org>
parents: 2661
diff changeset
577 def __init__(self, host_app, profile, user_jid, password, host=None,
e9cd473a2f46 core (xmpp): server certificate validation:
Goffi <goffi@goffi.org>
parents: 2661
diff changeset
578 port=C.XMPP_C2S_PORT, max_retries=C.XMPP_MAX_RETRIES):
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
579 # XXX: DNS SRV records are checked when the host is not specified.
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
580 # If no SRV record is found, the host is directly extracted from the JID.
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
581 self.started = time.time()
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
582
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
583 # Currently, we use "client/pc/Salut à Toi", but as
2643
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
584 # SàT is multi-frontends and can be used on mobile devices, as a bot,
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
585 # with a web frontend,
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
586 # etc., we should implement a way to dynamically update identities through the
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
587 # bridge
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
588 self.identities = [disco.DiscoIdentity(u"client", u"pc", C.APP_NAME)]
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
589 if sys.platform == "android":
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
590 # FIXME: temporary hack as SRV is not working on android
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
591 # TODO: remove this hack and fix SRV
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
592 log.info(u"FIXME: Android hack, ignoring SRV")
2596
93d64ce7a429 core (xmpp): fixed "Force server" param on Android
Goffi <goffi@goffi.org>
parents: 2594
diff changeset
593 if host is None:
93d64ce7a429 core (xmpp): fixed "Force server" param on Android
Goffi <goffi@goffi.org>
parents: 2594
diff changeset
594 host = user_jid.host
2594
59ba387c17ea core (xmpp): use "phone" type in identities when backend is started from Android
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
595 # for now we consider Android devices to be always phones
59ba387c17ea core (xmpp): use "phone" type in identities when backend is started from Android
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
596 self.identities = [disco.DiscoIdentity(u"client", u"phone", C.APP_NAME)]
2259
f51315500eb1 core: added hosts_dict handling in general config:
Goffi <goffi@goffi.org>
parents: 2172
diff changeset
597
f51315500eb1 core: added hosts_dict handling in general config:
Goffi <goffi@goffi.org>
parents: 2172
diff changeset
598 hosts_map = host_app.memory.getConfig(None, "hosts_dict", {})
f51315500eb1 core: added hosts_dict handling in general config:
Goffi <goffi@goffi.org>
parents: 2172
diff changeset
599 if host is None and user_jid.host in hosts_map:
f51315500eb1 core: added hosts_dict handling in general config:
Goffi <goffi@goffi.org>
parents: 2172
diff changeset
600 host_data = hosts_map[user_jid.host]
f51315500eb1 core: added hosts_dict handling in general config:
Goffi <goffi@goffi.org>
parents: 2172
diff changeset
601 if isinstance(host_data, basestring):
f51315500eb1 core: added hosts_dict handling in general config:
Goffi <goffi@goffi.org>
parents: 2172
diff changeset
602 host = host_data
f51315500eb1 core: added hosts_dict handling in general config:
Goffi <goffi@goffi.org>
parents: 2172
diff changeset
603 elif isinstance(host_data, dict):
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
604 if u"host" in host_data:
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
605 host = host_data[u"host"]
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
606 if u"port" in host_data:
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
607 port = host_data[u"port"]
2259
f51315500eb1 core: added hosts_dict handling in general config:
Goffi <goffi@goffi.org>
parents: 2172
diff changeset
608 else:
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
609 log.warning(
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
610 _(u"invalid data used for host: {data}").format(data=host_data)
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
611 )
2259
f51315500eb1 core: added hosts_dict handling in general config:
Goffi <goffi@goffi.org>
parents: 2172
diff changeset
612 host_data = None
f51315500eb1 core: added hosts_dict handling in general config:
Goffi <goffi@goffi.org>
parents: 2172
diff changeset
613 if host_data is not None:
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
614 log.info(
2643
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
615 u"using {host}:{port} for host {host_ori} as requested in config"
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
616 .format(host_ori=user_jid.host, host=host, port=port)
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
617 )
2259
f51315500eb1 core: added hosts_dict handling in general config:
Goffi <goffi@goffi.org>
parents: 2172
diff changeset
618
2687
e9cd473a2f46 core (xmpp): server certificate validation:
Goffi <goffi@goffi.org>
parents: 2661
diff changeset
619 self.check_certificate = host_app.memory.getParamA(
e9cd473a2f46 core (xmpp): server certificate validation:
Goffi <goffi@goffi.org>
parents: 2661
diff changeset
620 "check_certificate", "Connection", profile_key=profile)
e9cd473a2f46 core (xmpp): server certificate validation:
Goffi <goffi@goffi.org>
parents: 2661
diff changeset
621
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
622 wokkel_client.XMPPClient.__init__(
2687
e9cd473a2f46 core (xmpp): server certificate validation:
Goffi <goffi@goffi.org>
parents: 2661
diff changeset
623 self, user_jid, password, host or None, port or C.XMPP_C2S_PORT,
e9cd473a2f46 core (xmpp): server certificate validation:
Goffi <goffi@goffi.org>
parents: 2661
diff changeset
624 check_certificate = self.check_certificate
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
625 )
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
626 SatXMPPEntity.__init__(self, host_app, profile, max_retries)
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
627
2687
e9cd473a2f46 core (xmpp): server certificate validation:
Goffi <goffi@goffi.org>
parents: 2661
diff changeset
628 if not self.check_certificate:
e9cd473a2f46 core (xmpp): server certificate validation:
Goffi <goffi@goffi.org>
parents: 2661
diff changeset
629 msg = (_(u"Certificate validation is deactivated, this is unsecure and "
e9cd473a2f46 core (xmpp): server certificate validation:
Goffi <goffi@goffi.org>
parents: 2661
diff changeset
630 u"somebody may be spying on you. If you have no good reason to disable "
e9cd473a2f46 core (xmpp): server certificate validation:
Goffi <goffi@goffi.org>
parents: 2661
diff changeset
631 u"certificate validation, please activate \"Check certificate\" in your "
e9cd473a2f46 core (xmpp): server certificate validation:
Goffi <goffi@goffi.org>
parents: 2661
diff changeset
632 u"settings in \"Connection\" tab."))
e9cd473a2f46 core (xmpp): server certificate validation:
Goffi <goffi@goffi.org>
parents: 2661
diff changeset
633 xml_tools.quickNote(host_app, self, msg, _(u"Security notice"),
e9cd473a2f46 core (xmpp): server certificate validation:
Goffi <goffi@goffi.org>
parents: 2661
diff changeset
634 level = C.XMLUI_DATA_LVL_WARNING)
e9cd473a2f46 core (xmpp): server certificate validation:
Goffi <goffi@goffi.org>
parents: 2661
diff changeset
635
e9cd473a2f46 core (xmpp): server certificate validation:
Goffi <goffi@goffi.org>
parents: 2661
diff changeset
636
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
637 def _getPluginsList(self):
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
638 for p in self.host_app.plugins.itervalues():
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
639 if C.PLUG_MODE_CLIENT in p._info[u"modes"]:
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
640 yield p
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
641
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
642 def _createSubProtocols(self):
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
643 self.messageProt = SatMessageProtocol(self.host_app)
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
644 self.messageProt.setHandlerParent(self)
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
645
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
646 self.roster = SatRosterProtocol(self.host_app)
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
647 self.roster.setHandlerParent(self)
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
648
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
649 self.presence = SatPresenceProtocol(self.host_app)
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
650 self.presence.setHandlerParent(self)
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
651
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
652 def entityConnected(self):
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
653 # we want to be sure that we got the roster
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
654 return self.roster.got_roster
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
655
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
656 def addPostXmlCallbacks(self, post_xml_treatments):
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
657 post_xml_treatments.addCallback(self.messageAddToHistory)
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
658 post_xml_treatments.addCallback(self.messageSendToBridge)
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
659
2130
f0bc29dc8157 added "send" trigger point as the last one before sending, can be used for e2e encryption
Goffi <goffi@goffi.org>
parents: 2113
diff changeset
660 def send(self, obj):
f0bc29dc8157 added "send" trigger point as the last one before sending, can be used for e2e encryption
Goffi <goffi@goffi.org>
parents: 2113
diff changeset
661 # original send method accept string
f0bc29dc8157 added "send" trigger point as the last one before sending, can be used for e2e encryption
Goffi <goffi@goffi.org>
parents: 2113
diff changeset
662 # but we restrict to domish.Element to make trigger treatments easier
f0bc29dc8157 added "send" trigger point as the last one before sending, can be used for e2e encryption
Goffi <goffi@goffi.org>
parents: 2113
diff changeset
663 assert isinstance(obj, domish.Element)
f0bc29dc8157 added "send" trigger point as the last one before sending, can be used for e2e encryption
Goffi <goffi@goffi.org>
parents: 2113
diff changeset
664 # XXX: this trigger is the last one before sending stanza on wire
2509
d485e9416493 core (memory/cache): common cache:
Goffi <goffi@goffi.org>
parents: 2498
diff changeset
665 # it is intended for things like end 2 end encryption.
2130
f0bc29dc8157 added "send" trigger point as the last one before sending, can be used for e2e encryption
Goffi <goffi@goffi.org>
parents: 2113
diff changeset
666 # *DO NOT* cancel (i.e. return False) without very good reason
f0bc29dc8157 added "send" trigger point as the last one before sending, can be used for e2e encryption
Goffi <goffi@goffi.org>
parents: 2113
diff changeset
667 # (out of band transmission for instance).
f0bc29dc8157 added "send" trigger point as the last one before sending, can be used for e2e encryption
Goffi <goffi@goffi.org>
parents: 2113
diff changeset
668 # e2e should have a priority of 0 here, and out of band transmission
f0bc29dc8157 added "send" trigger point as the last one before sending, can be used for e2e encryption
Goffi <goffi@goffi.org>
parents: 2113
diff changeset
669 # a lower priority
2643
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
670 #  FIXME: trigger not used yet, can be uncommented when e2e full stanza
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
671 # encryption is implemented
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
672 #  if not self.host_app.trigger.point("send", self, obj):
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
673 #   return
2136
cc3a6aea9508 core (client): added feedback and sendMessage methods:
Goffi <goffi@goffi.org>
parents: 2132
diff changeset
674 super(SatXMPPClient, self).send(obj)
cc3a6aea9508 core (client): added feedback and sendMessage methods:
Goffi <goffi@goffi.org>
parents: 2132
diff changeset
675
2645
f2cf1daa42cb core: added async TriggerManager
Goffi <goffi@goffi.org>
parents: 2643
diff changeset
676 @defer.inlineCallbacks
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
677 def sendMessageData(self, mess_data):
2136
cc3a6aea9508 core (client): added feedback and sendMessage methods:
Goffi <goffi@goffi.org>
parents: 2132
diff changeset
678 """Convenient method to send message data to stream
2130
f0bc29dc8157 added "send" trigger point as the last one before sending, can be used for e2e encryption
Goffi <goffi@goffi.org>
parents: 2113
diff changeset
679
2136
cc3a6aea9508 core (client): added feedback and sendMessage methods:
Goffi <goffi@goffi.org>
parents: 2132
diff changeset
680 This method will send mess_data[u'xml'] to stream, but a trigger is there
cc3a6aea9508 core (client): added feedback and sendMessage methods:
Goffi <goffi@goffi.org>
parents: 2132
diff changeset
681 The trigger can't be cancelled, it's a good place for e2e encryption which
cc3a6aea9508 core (client): added feedback and sendMessage methods:
Goffi <goffi@goffi.org>
parents: 2132
diff changeset
682 don't handle full stanza encryption
2645
f2cf1daa42cb core: added async TriggerManager
Goffi <goffi@goffi.org>
parents: 2643
diff changeset
683 This trigger can return a Deferred (it's an asyncPoint)
2136
cc3a6aea9508 core (client): added feedback and sendMessage methods:
Goffi <goffi@goffi.org>
parents: 2132
diff changeset
684 @param mess_data(dict): message data as constructed by onMessage workflow
cc3a6aea9508 core (client): added feedback and sendMessage methods:
Goffi <goffi@goffi.org>
parents: 2132
diff changeset
685 @return (dict): mess_data (so it can be used in a deferred chain)
cc3a6aea9508 core (client): added feedback and sendMessage methods:
Goffi <goffi@goffi.org>
parents: 2132
diff changeset
686 """
2643
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
687 # XXX: This is the last trigger before u"send" (last but one globally)
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
688 # for sending message.
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
689 # This is intented for e2e encryption which doesn't do full stanza
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
690 # encryption (e.g. OTR)
2136
cc3a6aea9508 core (client): added feedback and sendMessage methods:
Goffi <goffi@goffi.org>
parents: 2132
diff changeset
691 # This trigger point can't cancel the method
2650
3a8e7ec4648a tools (trigger, async_trigger): added no_cancel argument to point and asyncPoint when a trigger must not be cancellable
Goffi <goffi@goffi.org>
parents: 2646
diff changeset
692 yield self.host_app.trigger.asyncPoint("sendMessageData", self, mess_data,
3a8e7ec4648a tools (trigger, async_trigger): added no_cancel argument to point and asyncPoint when a trigger must not be cancellable
Goffi <goffi@goffi.org>
parents: 2646
diff changeset
693 triggers_no_cancel=True)
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
694 self.send(mess_data[u"xml"])
2645
f2cf1daa42cb core: added async TriggerManager
Goffi <goffi@goffi.org>
parents: 2643
diff changeset
695 defer.returnValue(mess_data)
2136
cc3a6aea9508 core (client): added feedback and sendMessage methods:
Goffi <goffi@goffi.org>
parents: 2132
diff changeset
696
cc3a6aea9508 core (client): added feedback and sendMessage methods:
Goffi <goffi@goffi.org>
parents: 2132
diff changeset
697 def feedback(self, to_jid, message):
cc3a6aea9508 core (client): added feedback and sendMessage methods:
Goffi <goffi@goffi.org>
parents: 2132
diff changeset
698 """Send message to frontends
cc3a6aea9508 core (client): added feedback and sendMessage methods:
Goffi <goffi@goffi.org>
parents: 2132
diff changeset
699
cc3a6aea9508 core (client): added feedback and sendMessage methods:
Goffi <goffi@goffi.org>
parents: 2132
diff changeset
700 This message will be an info message, not recorded in history.
cc3a6aea9508 core (client): added feedback and sendMessage methods:
Goffi <goffi@goffi.org>
parents: 2132
diff changeset
701 It can be used to give feedback of a command
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
702 @param to_jid(jid.JID): destinee jid
2136
cc3a6aea9508 core (client): added feedback and sendMessage methods:
Goffi <goffi@goffi.org>
parents: 2132
diff changeset
703 @param message(unicode): message to send to frontends
cc3a6aea9508 core (client): added feedback and sendMessage methods:
Goffi <goffi@goffi.org>
parents: 2132
diff changeset
704 """
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
705 self.host_app.bridge.messageNew(
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
706 uid=unicode(uuid.uuid4()),
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
707 timestamp=time.time(),
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
708 from_jid=self.jid.full(),
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
709 to_jid=to_jid.full(),
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
710 message={u"": message},
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
711 subject={},
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
712 mess_type=C.MESS_TYPE_INFO,
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
713 extra={},
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
714 profile=self.profile,
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
715 )
2130
f0bc29dc8157 added "send" trigger point as the last one before sending, can be used for e2e encryption
Goffi <goffi@goffi.org>
parents: 2113
diff changeset
716
2643
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
717 def _finish_connection(self, __):
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
718 self.roster.requestRoster()
2643
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
719 super(SatXMPPClient, self)._finish_connection(__)
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
720
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
721
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
722 class SatXMPPComponent(SatXMPPEntity, component.Component):
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
723 """XMPP component
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
724
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
725 This component are similar but not identical to clients.
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
726 An entry point plugin is launched after component is connected.
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
727 Component need to instantiate MessageProtocol itself
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
728 """
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
729
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
730 implements(iwokkel.IDisco)
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
731 trigger_suffix = (
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
732 "Component"
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
733 ) # used for to distinguish some trigger points set in SatXMPPEntity
2498
d6de69da3dd4 core (client): component improvments:
Goffi <goffi@goffi.org>
parents: 2497
diff changeset
734 is_component = True
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
735 sendHistory = (
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
736 False
2643
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
737 ) # XXX: set to True from entry plugin to keep messages in history for received
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
738 # messages
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
739
2691
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
740 def __init__(self, host_app, profile, component_jid, password, host=None, port=None,
1ecceac3df96 plugin XEP-0198: Stream Management implementation:
Goffi <goffi@goffi.org>
parents: 2688
diff changeset
741 max_retries=C.XMPP_MAX_RETRIES):
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
742 self.started = time.time()
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
743 if port is None:
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
744 port = C.XMPP_COMPONENT_PORT
13
bd9e9997d540 wokkel integration (not finished yet)
Goffi <goffi@goffi.org>
parents: 12
diff changeset
745
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
746 ## entry point ##
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
747 entry_point = host_app.memory.getEntryPoint(profile)
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
748 try:
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
749 self.entry_plugin = host_app.plugins[entry_point]
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
750 except KeyError:
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
751 raise exceptions.NotFound(
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
752 _(u"The requested entry point ({entry_point}) is not available").format(
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
753 entry_point=entry_point
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
754 )
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
755 )
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 572
diff changeset
756
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
757 self.identities = [disco.DiscoIdentity(u"component", u"generic", C.APP_NAME)]
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
758 # jid is set automatically on bind by Twisted for Client, but not for Component
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
759 self.jid = component_jid
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
760 if host is None:
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
761 try:
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
762 host = component_jid.host.split(u".", 1)[1]
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
763 except IndexError:
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
764 raise ValueError(u"Can't guess host from jid, please specify a host")
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
765 # XXX: component.Component expect unicode jid, while Client expect jid.JID.
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
766 # this is not consistent, so we use jid.JID for SatXMPP*
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
767 component.Component.__init__(self, host, port, component_jid.full(), password)
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
768 SatXMPPEntity.__init__(self, host_app, profile, max_retries)
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 572
diff changeset
769
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
770 def _buildDependencies(self, current, plugins, required=True):
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
771 """build recursively dependencies needed for a plugin
62
93cb45a7420f SàT multi-profile: connection using profiles
Goffi <goffi@goffi.org>
parents: 60
diff changeset
772
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
773 this method build list of plugin needed for a component and raises
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
774 errors if they are not available or not allowed for components
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
775 @param current(object): parent plugin to check
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
776 use entry_point for first call
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
777 @param plugins(list): list of validated plugins, will be filled by the method
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
778 give an empty list for first call
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
779 @param required(bool): True if plugin is mandatory
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
780 for recursive calls only, should not be modified by inital caller
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
781 @raise InternalError: one of the plugin is not handling components
2643
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
782 @raise KeyError: one plugin should be present in self.host_app.plugins but it
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
783 is not
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
784 """
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
785 if C.PLUG_MODE_COMPONENT not in current._info[u"modes"]:
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
786 if not required:
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
787 return
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
788 else:
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
789 log.error(
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
790 _(
2643
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
791 u"Plugin {current_name} is needed for {entry_name}, "
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
792 u"but it doesn't handle component mode"
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
793 ).format(
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
794 current_name=current._info[u"import_name"],
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
795 entry_name=self.entry_plugin._info[u"import_name"],
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
796 )
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
797 )
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
798 raise exceptions.InternalError(_(u"invalid plugin mode"))
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 572
diff changeset
799
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
800 for import_name in current._info.get(C.PI_DEPENDENCIES, []):
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
801 # plugins are already loaded as dependencies
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
802 # so we know they are in self.host_app.plugins
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
803 dep = self.host_app.plugins[import_name]
2498
d6de69da3dd4 core (client): component improvments:
Goffi <goffi@goffi.org>
parents: 2497
diff changeset
804 self._buildDependencies(dep, plugins)
13
bd9e9997d540 wokkel integration (not finished yet)
Goffi <goffi@goffi.org>
parents: 12
diff changeset
805
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
806 for import_name in current._info.get(C.PI_RECOMMENDATIONS, []):
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
807 # here plugins are only recommendations,
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
808 # so they may not exist in self.host_app.plugins
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
809 try:
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
810 dep = self.host_app.plugins[import_name]
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
811 except KeyError:
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
812 continue
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
813 self._buildDependencies(dep, plugins, required=False)
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
814
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
815 if current not in plugins:
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
816 # current can be required for several plugins and so
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
817 # it can already be present in the list
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
818 plugins.append(current)
262
af3d4f11fe43 Added management of connection error
Goffi <goffi@goffi.org>
parents: 260
diff changeset
819
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
820 def _getPluginsList(self):
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
821 # XXX: for component we don't launch all plugins triggers
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
822 # but only the ones from which there is a dependency
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
823 plugins = []
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
824 self._buildDependencies(self.entry_plugin, plugins)
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
825 return plugins
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 572
diff changeset
826
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
827 def entityConnected(self):
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
828 # we can now launch entry point
2498
d6de69da3dd4 core (client): component improvments:
Goffi <goffi@goffi.org>
parents: 2497
diff changeset
829 try:
d6de69da3dd4 core (client): component improvments:
Goffi <goffi@goffi.org>
parents: 2497
diff changeset
830 start_cb = self.entry_plugin.componentStart
d6de69da3dd4 core (client): component improvments:
Goffi <goffi@goffi.org>
parents: 2497
diff changeset
831 except AttributeError:
d6de69da3dd4 core (client): component improvments:
Goffi <goffi@goffi.org>
parents: 2497
diff changeset
832 return
d6de69da3dd4 core (client): component improvments:
Goffi <goffi@goffi.org>
parents: 2497
diff changeset
833 else:
d6de69da3dd4 core (client): component improvments:
Goffi <goffi@goffi.org>
parents: 2497
diff changeset
834 return start_cb(self)
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
835
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
836 def addPostXmlCallbacks(self, post_xml_treatments):
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
837 if self.sendHistory:
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
838 post_xml_treatments.addCallback(self.messageAddToHistory)
0
goffi@necton2
parents:
diff changeset
839
goffi@necton2
parents:
diff changeset
840
13
bd9e9997d540 wokkel integration (not finished yet)
Goffi <goffi@goffi.org>
parents: 12
diff changeset
841 class SatMessageProtocol(xmppim.MessageProtocol):
bd9e9997d540 wokkel integration (not finished yet)
Goffi <goffi@goffi.org>
parents: 12
diff changeset
842 def __init__(self, host):
bd9e9997d540 wokkel integration (not finished yet)
Goffi <goffi@goffi.org>
parents: 12
diff changeset
843 xmppim.MessageProtocol.__init__(self)
bd9e9997d540 wokkel integration (not finished yet)
Goffi <goffi@goffi.org>
parents: 12
diff changeset
844 self.host = host
bd9e9997d540 wokkel integration (not finished yet)
Goffi <goffi@goffi.org>
parents: 12
diff changeset
845
2701
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages:
Goffi <goffi@goffi.org>
parents: 2694
diff changeset
846 def parseMessage(self, message_elt):
2099
ad88808591ef plugin XEP-0280: Message Carbons first draft
Goffi <goffi@goffi.org>
parents: 2089
diff changeset
847 """parse a message XML and return message_data
663
8004c7d4aba7 core: Deferred in onMessage.
Goffi <goffi@goffi.org>
parents: 636
diff changeset
848
2099
ad88808591ef plugin XEP-0280: Message Carbons first draft
Goffi <goffi@goffi.org>
parents: 2089
diff changeset
849 @param message_elt(domish.Element): raw <message> xml
ad88808591ef plugin XEP-0280: Message Carbons first draft
Goffi <goffi@goffi.org>
parents: 2089
diff changeset
850 @param client(SatXMPPClient, None): client to map message id to uid
ad88808591ef plugin XEP-0280: Message Carbons first draft
Goffi <goffi@goffi.org>
parents: 2089
diff changeset
851 if None, mapping will not be done
ad88808591ef plugin XEP-0280: Message Carbons first draft
Goffi <goffi@goffi.org>
parents: 2089
diff changeset
852 @return(dict): message data
ad88808591ef plugin XEP-0280: Message Carbons first draft
Goffi <goffi@goffi.org>
parents: 2089
diff changeset
853 """
2701
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages:
Goffi <goffi@goffi.org>
parents: 2694
diff changeset
854 if message_elt.name != u"message":
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages:
Goffi <goffi@goffi.org>
parents: 2694
diff changeset
855 log.warning(_(
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages:
Goffi <goffi@goffi.org>
parents: 2694
diff changeset
856 u"parseMessage used with a non <message/> stanza, ignoring: {xml}"
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages:
Goffi <goffi@goffi.org>
parents: 2694
diff changeset
857 .format(xml=message_elt.toXml())))
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages:
Goffi <goffi@goffi.org>
parents: 2694
diff changeset
858 return {}
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages:
Goffi <goffi@goffi.org>
parents: 2694
diff changeset
859 client = self.parent
1955
633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished):
Goffi <goffi@goffi.org>
parents: 1934
diff changeset
860 message = {}
633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished):
Goffi <goffi@goffi.org>
parents: 1934
diff changeset
861 subject = {}
633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished):
Goffi <goffi@goffi.org>
parents: 1934
diff changeset
862 extra = {}
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
863 data = {
2701
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages:
Goffi <goffi@goffi.org>
parents: 2694
diff changeset
864 u"from": jid.JID(message_elt["from"]),
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages:
Goffi <goffi@goffi.org>
parents: 2694
diff changeset
865 u"to": jid.JID(message_elt["to"]),
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages:
Goffi <goffi@goffi.org>
parents: 2694
diff changeset
866 u"uid": message_elt.getAttribute(
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages:
Goffi <goffi@goffi.org>
parents: 2694
diff changeset
867 u"uid", unicode(uuid.uuid4())
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
868 ), # XXX: uid is not a standard attribute but may be added by plugins
2701
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages:
Goffi <goffi@goffi.org>
parents: 2694
diff changeset
869 u"message": message,
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages:
Goffi <goffi@goffi.org>
parents: 2694
diff changeset
870 u"subject": subject,
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages:
Goffi <goffi@goffi.org>
parents: 2694
diff changeset
871 u"type": message_elt.getAttribute(u"type", u"normal"),
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages:
Goffi <goffi@goffi.org>
parents: 2694
diff changeset
872 u"extra": extra,
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
873 }
1955
633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished):
Goffi <goffi@goffi.org>
parents: 1934
diff changeset
874
2701
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages:
Goffi <goffi@goffi.org>
parents: 2694
diff changeset
875 try:
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages:
Goffi <goffi@goffi.org>
parents: 2694
diff changeset
876 message_id = data[u"extra"][u"message_id"] = message_elt[u"id"]
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages:
Goffi <goffi@goffi.org>
parents: 2694
diff changeset
877 except KeyError:
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages:
Goffi <goffi@goffi.org>
parents: 2694
diff changeset
878 pass
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages:
Goffi <goffi@goffi.org>
parents: 2694
diff changeset
879 else:
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages:
Goffi <goffi@goffi.org>
parents: 2694
diff changeset
880 client.mess_id2uid[(data["from"], message_id)] = data["uid"]
663
8004c7d4aba7 core: Deferred in onMessage.
Goffi <goffi@goffi.org>
parents: 636
diff changeset
881
1955
633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished):
Goffi <goffi@goffi.org>
parents: 1934
diff changeset
882 # message
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
883 for e in message_elt.elements(C.NS_CLIENT, "body"):
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
884 message[e.getAttribute((C.NS_XML, "lang"), "")] = unicode(e)
1955
633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished):
Goffi <goffi@goffi.org>
parents: 1934
diff changeset
885
633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished):
Goffi <goffi@goffi.org>
parents: 1934
diff changeset
886 # subject
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
887 for e in message_elt.elements(C.NS_CLIENT, "subject"):
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
888 subject[e.getAttribute((C.NS_XML, "lang"), "")] = unicode(e)
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 572
diff changeset
889
1955
633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished):
Goffi <goffi@goffi.org>
parents: 1934
diff changeset
890 # delay and timestamp
633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished):
Goffi <goffi@goffi.org>
parents: 1934
diff changeset
891 try:
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
892 delay_elt = message_elt.elements(delay.NS_DELAY, "delay").next()
1955
633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished):
Goffi <goffi@goffi.org>
parents: 1934
diff changeset
893 except StopIteration:
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
894 data["timestamp"] = time.time()
1955
633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished):
Goffi <goffi@goffi.org>
parents: 1934
diff changeset
895 else:
633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished):
Goffi <goffi@goffi.org>
parents: 1934
diff changeset
896 parsed_delay = delay.Delay.fromElement(delay_elt)
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
897 data["timestamp"] = calendar.timegm(parsed_delay.stamp.utctimetuple())
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
898 data["received_timestamp"] = unicode(time.time())
1955
633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished):
Goffi <goffi@goffi.org>
parents: 1934
diff changeset
899 if parsed_delay.sender:
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
900 data["delay_sender"] = parsed_delay.sender.full()
2701
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages:
Goffi <goffi@goffi.org>
parents: 2694
diff changeset
901
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages:
Goffi <goffi@goffi.org>
parents: 2694
diff changeset
902 self.host.trigger.point("message_parse", client, message_elt, data)
2099
ad88808591ef plugin XEP-0280: Message Carbons first draft
Goffi <goffi@goffi.org>
parents: 2089
diff changeset
903 return data
1955
633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished):
Goffi <goffi@goffi.org>
parents: 1934
diff changeset
904
2645
f2cf1daa42cb core: added async TriggerManager
Goffi <goffi@goffi.org>
parents: 2643
diff changeset
905 def _onMessageStartWorkflow(self, cont, client, message_elt, post_treat):
f2cf1daa42cb core: added async TriggerManager
Goffi <goffi@goffi.org>
parents: 2643
diff changeset
906 """Parse message and do post treatments
f2cf1daa42cb core: added async TriggerManager
Goffi <goffi@goffi.org>
parents: 2643
diff changeset
907
f2cf1daa42cb core: added async TriggerManager
Goffi <goffi@goffi.org>
parents: 2643
diff changeset
908 It is the first callback called after MessageReceived trigger
f2cf1daa42cb core: added async TriggerManager
Goffi <goffi@goffi.org>
parents: 2643
diff changeset
909 @param cont(bool): workflow will continue only if this is True
f2cf1daa42cb core: added async TriggerManager
Goffi <goffi@goffi.org>
parents: 2643
diff changeset
910 @param message_elt(domish.Element): message stanza
f2cf1daa42cb core: added async TriggerManager
Goffi <goffi@goffi.org>
parents: 2643
diff changeset
911 may have be modified by triggers
f2cf1daa42cb core: added async TriggerManager
Goffi <goffi@goffi.org>
parents: 2643
diff changeset
912 @param post_treat(defer.Deferred): post parsing treatments
f2cf1daa42cb core: added async TriggerManager
Goffi <goffi@goffi.org>
parents: 2643
diff changeset
913 """
f2cf1daa42cb core: added async TriggerManager
Goffi <goffi@goffi.org>
parents: 2643
diff changeset
914 if not cont:
f2cf1daa42cb core: added async TriggerManager
Goffi <goffi@goffi.org>
parents: 2643
diff changeset
915 return
2701
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages:
Goffi <goffi@goffi.org>
parents: 2694
diff changeset
916 data = self.parseMessage(message_elt)
2645
f2cf1daa42cb core: added async TriggerManager
Goffi <goffi@goffi.org>
parents: 2643
diff changeset
917 post_treat.addCallback(self.skipEmptyMessage)
f2cf1daa42cb core: added async TriggerManager
Goffi <goffi@goffi.org>
parents: 2643
diff changeset
918 post_treat.addCallback(self.addToHistory, client)
f2cf1daa42cb core: added async TriggerManager
Goffi <goffi@goffi.org>
parents: 2643
diff changeset
919 post_treat.addCallback(self.bridgeSignal, client, data)
f2cf1daa42cb core: added async TriggerManager
Goffi <goffi@goffi.org>
parents: 2643
diff changeset
920 post_treat.addErrback(self.cancelErrorTrap)
f2cf1daa42cb core: added async TriggerManager
Goffi <goffi@goffi.org>
parents: 2643
diff changeset
921 post_treat.callback(data)
f2cf1daa42cb core: added async TriggerManager
Goffi <goffi@goffi.org>
parents: 2643
diff changeset
922
2099
ad88808591ef plugin XEP-0280: Message Carbons first draft
Goffi <goffi@goffi.org>
parents: 2089
diff changeset
923 def onMessage(self, message_elt):
ad88808591ef plugin XEP-0280: Message Carbons first draft
Goffi <goffi@goffi.org>
parents: 2089
diff changeset
924 # TODO: handle threads
ad88808591ef plugin XEP-0280: Message Carbons first draft
Goffi <goffi@goffi.org>
parents: 2089
diff changeset
925 client = self.parent
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
926 if not "from" in message_elt.attributes:
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
927 message_elt["from"] = client.jid.host
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
928 log.debug(_(u"got message from: {from_}").format(from_=message_elt["from"]))
2099
ad88808591ef plugin XEP-0280: Message Carbons first draft
Goffi <goffi@goffi.org>
parents: 2089
diff changeset
929
2645
f2cf1daa42cb core: added async TriggerManager
Goffi <goffi@goffi.org>
parents: 2643
diff changeset
930 # plugin can add their treatments to this deferred
f2cf1daa42cb core: added async TriggerManager
Goffi <goffi@goffi.org>
parents: 2643
diff changeset
931 post_treat = defer.Deferred()
f2cf1daa42cb core: added async TriggerManager
Goffi <goffi@goffi.org>
parents: 2643
diff changeset
932
f2cf1daa42cb core: added async TriggerManager
Goffi <goffi@goffi.org>
parents: 2643
diff changeset
933 d = self.host.trigger.asyncPoint(
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
934 "MessageReceived", client, message_elt, post_treat
2645
f2cf1daa42cb core: added async TriggerManager
Goffi <goffi@goffi.org>
parents: 2643
diff changeset
935 )
1963
a2bc5089c2eb backend, frontends: message refactoring (huge commit):
Goffi <goffi@goffi.org>
parents: 1955
diff changeset
936
2645
f2cf1daa42cb core: added async TriggerManager
Goffi <goffi@goffi.org>
parents: 2643
diff changeset
937 d.addCallback(self._onMessageStartWorkflow, client, message_elt, post_treat)
663
8004c7d4aba7 core: Deferred in onMessage.
Goffi <goffi@goffi.org>
parents: 636
diff changeset
938
1963
a2bc5089c2eb backend, frontends: message refactoring (huge commit):
Goffi <goffi@goffi.org>
parents: 1955
diff changeset
939 def skipEmptyMessage(self, data):
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
940 if not data["message"] and not data["extra"] and not data["subject"]:
1963
a2bc5089c2eb backend, frontends: message refactoring (huge commit):
Goffi <goffi@goffi.org>
parents: 1955
diff changeset
941 raise failure.Failure(exceptions.CancelError("Cancelled empty message"))
a2bc5089c2eb backend, frontends: message refactoring (huge commit):
Goffi <goffi@goffi.org>
parents: 1955
diff changeset
942 return data
a2bc5089c2eb backend, frontends: message refactoring (huge commit):
Goffi <goffi@goffi.org>
parents: 1955
diff changeset
943
a2bc5089c2eb backend, frontends: message refactoring (huge commit):
Goffi <goffi@goffi.org>
parents: 1955
diff changeset
944 def addToHistory(self, data, client):
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
945 if data.pop(u"history", None) == C.HISTORY_SKIP:
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
946 log.info(u"history is skipped as requested")
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
947 data[u"extra"][u"history"] = C.HISTORY_SKIP
2132
c0577837680a core: replaced SkipHistory exception by a key in mess_data:
Goffi <goffi@goffi.org>
parents: 2130
diff changeset
948 else:
c0577837680a core: replaced SkipHistory exception by a key in mess_data:
Goffi <goffi@goffi.org>
parents: 2130
diff changeset
949 return self.host.memory.addToHistory(client, data)
663
8004c7d4aba7 core: Deferred in onMessage.
Goffi <goffi@goffi.org>
parents: 636
diff changeset
950
2643
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
951 def bridgeSignal(self, __, client, data):
1963
a2bc5089c2eb backend, frontends: message refactoring (huge commit):
Goffi <goffi@goffi.org>
parents: 1955
diff changeset
952 try:
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
953 data["extra"]["received_timestamp"] = data["received_timestamp"]
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
954 data["extra"]["delay_sender"] = data["delay_sender"]
1963
a2bc5089c2eb backend, frontends: message refactoring (huge commit):
Goffi <goffi@goffi.org>
parents: 1955
diff changeset
955 except KeyError:
a2bc5089c2eb backend, frontends: message refactoring (huge commit):
Goffi <goffi@goffi.org>
parents: 1955
diff changeset
956 pass
2658
4e130cc9bfc0 core (memore/encryption): new methods and checks:
Goffi <goffi@goffi.org>
parents: 2650
diff changeset
957 if C.MESS_KEY_ENCRYPTION in data:
4e130cc9bfc0 core (memore/encryption): new methods and checks:
Goffi <goffi@goffi.org>
parents: 2650
diff changeset
958 data[u"extra"][u"encrypted"] = C.BOOL_TRUE
1963
a2bc5089c2eb backend, frontends: message refactoring (huge commit):
Goffi <goffi@goffi.org>
parents: 1955
diff changeset
959 if data is not None:
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
960 self.host.bridge.messageNew(
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
961 data["uid"],
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
962 data["timestamp"],
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
963 data["from"].full(),
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
964 data["to"].full(),
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
965 data["message"],
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
966 data["subject"],
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
967 data["type"],
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
968 data["extra"],
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
969 profile=client.profile,
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
970 )
1963
a2bc5089c2eb backend, frontends: message refactoring (huge commit):
Goffi <goffi@goffi.org>
parents: 1955
diff changeset
971 return data
1053
71d63750963e core (XMPP): message received (onMessage) refactoring:
Goffi <goffi@goffi.org>
parents: 1037
diff changeset
972
1963
a2bc5089c2eb backend, frontends: message refactoring (huge commit):
Goffi <goffi@goffi.org>
parents: 1955
diff changeset
973 def cancelErrorTrap(self, failure_):
a2bc5089c2eb backend, frontends: message refactoring (huge commit):
Goffi <goffi@goffi.org>
parents: 1955
diff changeset
974 """A message sending can be cancelled by a plugin treatment"""
a2bc5089c2eb backend, frontends: message refactoring (huge commit):
Goffi <goffi@goffi.org>
parents: 1955
diff changeset
975 failure_.trap(exceptions.CancelError)
636
7ea6d5a86e58 plugin XEP-0085: Chat State Notifications
souliane <souliane@mailoo.org>
parents: 611
diff changeset
976
589
d1b4805124a1 Fix pep8 support in src/core.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 587
diff changeset
977
13
bd9e9997d540 wokkel integration (not finished yet)
Goffi <goffi@goffi.org>
parents: 12
diff changeset
978 class SatRosterProtocol(xmppim.RosterClientProtocol):
bd9e9997d540 wokkel integration (not finished yet)
Goffi <goffi@goffi.org>
parents: 12
diff changeset
979 def __init__(self, host):
bd9e9997d540 wokkel integration (not finished yet)
Goffi <goffi@goffi.org>
parents: 12
diff changeset
980 xmppim.RosterClientProtocol.__init__(self)
bd9e9997d540 wokkel integration (not finished yet)
Goffi <goffi@goffi.org>
parents: 12
diff changeset
981 self.host = host
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
982 self.got_roster = defer.Deferred() # called when roster is received and ready
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
983 # XXX: the two following dicts keep a local copy of the roster
1262
f8a8434dbac7 core: improved roster management + misc:
Goffi <goffi@goffi.org>
parents: 1246
diff changeset
984 self._groups = {} # map from groups to jids: key=group value=set of jids
f8a8434dbac7 core: improved roster management + misc:
Goffi <goffi@goffi.org>
parents: 1246
diff changeset
985 self._jids = None # map from jids to RosterItem: key=jid value=RosterItem
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 572
diff changeset
986
13
bd9e9997d540 wokkel integration (not finished yet)
Goffi <goffi@goffi.org>
parents: 12
diff changeset
987 def rosterCb(self, roster):
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
988 assert roster is not None # FIXME: must be managed with roster versioning
1427
1e833970b7f0 core (xmpp): update the cache for a contact group when a contact is removed from it
souliane <souliane@mailoo.org>
parents: 1426
diff changeset
989 self._groups.clear()
1262
f8a8434dbac7 core: improved roster management + misc:
Goffi <goffi@goffi.org>
parents: 1246
diff changeset
990 self._jids = roster
1398
f8ecce11a0bc core (xmmp): keep the roster groups cache synchronised + fixes a log.warning
souliane <souliane@mailoo.org>
parents: 1396
diff changeset
991 for item in roster.itervalues():
f8ecce11a0bc core (xmmp): keep the roster groups cache synchronised + fixes a log.warning
souliane <souliane@mailoo.org>
parents: 1396
diff changeset
992 if not item.subscriptionTo and not item.subscriptionFrom and not item.ask:
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
993 # XXX: current behaviour: we don't want contact in our roster list
1398
f8ecce11a0bc core (xmmp): keep the roster groups cache synchronised + fixes a log.warning
souliane <souliane@mailoo.org>
parents: 1396
diff changeset
994 # if there is no presence subscription
f8ecce11a0bc core (xmmp): keep the roster groups cache synchronised + fixes a log.warning
souliane <souliane@mailoo.org>
parents: 1396
diff changeset
995 # may change in the future
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
996 log.info(
2643
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
997 u"Removing contact {} from roster because there is no presence "
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
998 u"subscription".format(
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
999 item.jid
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1000 )
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1001 )
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1002 self.removeItem(item.entity) # FIXME: to be checked
1398
f8ecce11a0bc core (xmmp): keep the roster groups cache synchronised + fixes a log.warning
souliane <souliane@mailoo.org>
parents: 1396
diff changeset
1003 else:
f8ecce11a0bc core (xmmp): keep the roster groups cache synchronised + fixes a log.warning
souliane <souliane@mailoo.org>
parents: 1396
diff changeset
1004 self._registerItem(item)
1262
f8a8434dbac7 core: improved roster management + misc:
Goffi <goffi@goffi.org>
parents: 1246
diff changeset
1005
f8a8434dbac7 core: improved roster management + misc:
Goffi <goffi@goffi.org>
parents: 1246
diff changeset
1006 def _registerItem(self, item):
f8a8434dbac7 core: improved roster management + misc:
Goffi <goffi@goffi.org>
parents: 1246
diff changeset
1007 """Register item in local cache
f8a8434dbac7 core: improved roster management + misc:
Goffi <goffi@goffi.org>
parents: 1246
diff changeset
1008
f8a8434dbac7 core: improved roster management + misc:
Goffi <goffi@goffi.org>
parents: 1246
diff changeset
1009 item must be already registered in self._jids before this method is called
f8a8434dbac7 core: improved roster management + misc:
Goffi <goffi@goffi.org>
parents: 1246
diff changeset
1010 @param item (RosterIem): item added
f8a8434dbac7 core: improved roster management + misc:
Goffi <goffi@goffi.org>
parents: 1246
diff changeset
1011 """
1426
614145ef6e60 core (xmpp): RosterItem.jid is deprecated in Wokkel 0.7.1, use RosterItem.entity instead
souliane <souliane@mailoo.org>
parents: 1417
diff changeset
1012 log.debug(u"registering item: {}".format(item.entity.full()))
1262
f8a8434dbac7 core: improved roster management + misc:
Goffi <goffi@goffi.org>
parents: 1246
diff changeset
1013 if item.entity.resource:
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1014 log.warning(
2643
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
1015 u"Received a roster item with a resource, this is not common but not "
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
1016 u"restricted by RFC 6121, this case may be not well tested."
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1017 )
1262
f8a8434dbac7 core: improved roster management + misc:
Goffi <goffi@goffi.org>
parents: 1246
diff changeset
1018 if not item.subscriptionTo:
f8a8434dbac7 core: improved roster management + misc:
Goffi <goffi@goffi.org>
parents: 1246
diff changeset
1019 if not item.subscriptionFrom:
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1020 log.info(
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1021 _(u"There's no subscription between you and [{}]!").format(
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1022 item.entity.full()
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1023 )
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1024 )
1262
f8a8434dbac7 core: improved roster management + misc:
Goffi <goffi@goffi.org>
parents: 1246
diff changeset
1025 else:
1426
614145ef6e60 core (xmpp): RosterItem.jid is deprecated in Wokkel 0.7.1, use RosterItem.entity instead
souliane <souliane@mailoo.org>
parents: 1417
diff changeset
1026 log.info(_(u"You are not subscribed to [{}]!").format(item.entity.full()))
1262
f8a8434dbac7 core: improved roster management + misc:
Goffi <goffi@goffi.org>
parents: 1246
diff changeset
1027 if not item.subscriptionFrom:
1426
614145ef6e60 core (xmpp): RosterItem.jid is deprecated in Wokkel 0.7.1, use RosterItem.entity instead
souliane <souliane@mailoo.org>
parents: 1417
diff changeset
1028 log.info(_(u"[{}] is not subscribed to you!").format(item.entity.full()))
1262
f8a8434dbac7 core: improved roster management + misc:
Goffi <goffi@goffi.org>
parents: 1246
diff changeset
1029
f8a8434dbac7 core: improved roster management + misc:
Goffi <goffi@goffi.org>
parents: 1246
diff changeset
1030 for group in item.groups:
f8a8434dbac7 core: improved roster management + misc:
Goffi <goffi@goffi.org>
parents: 1246
diff changeset
1031 self._groups.setdefault(group, set()).add(item.entity)
13
bd9e9997d540 wokkel integration (not finished yet)
Goffi <goffi@goffi.org>
parents: 12
diff changeset
1032
bd9e9997d540 wokkel integration (not finished yet)
Goffi <goffi@goffi.org>
parents: 12
diff changeset
1033 def requestRoster(self):
bd9e9997d540 wokkel integration (not finished yet)
Goffi <goffi@goffi.org>
parents: 12
diff changeset
1034 """ ask the server for Roster list """
993
301b342c697a core: use of the new core.log module:
Goffi <goffi@goffi.org>
parents: 960
diff changeset
1035 log.debug("requestRoster")
549
2c5ef983f2ef core: client.roster has now a got_roster deferred which is fired when roster is available
Goffi <goffi@goffi.org>
parents: 538
diff changeset
1036 d = self.getRoster().addCallback(self.rosterCb)
2c5ef983f2ef core: client.roster has now a got_roster deferred which is fired when roster is available
Goffi <goffi@goffi.org>
parents: 538
diff changeset
1037 d.chainDeferred(self.got_roster)
13
bd9e9997d540 wokkel integration (not finished yet)
Goffi <goffi@goffi.org>
parents: 12
diff changeset
1038
875
19d7d077478a core (xmpp): fix automatic contact deletion
souliane <souliane@mailoo.org>
parents: 819
diff changeset
1039 def removeItem(self, to_jid):
19d7d077478a core (xmpp): fix automatic contact deletion
souliane <souliane@mailoo.org>
parents: 819
diff changeset
1040 """Remove a contact from roster list
19d7d077478a core (xmpp): fix automatic contact deletion
souliane <souliane@mailoo.org>
parents: 819
diff changeset
1041 @param to_jid: a JID instance
1262
f8a8434dbac7 core: improved roster management + misc:
Goffi <goffi@goffi.org>
parents: 1246
diff changeset
1042 @return: Deferred
346
ca3a041fed30 core: fixed several subscription scheme issues + removed most of profile_key default value in core.sat_main and core.xmmp (source of bugs) + contact update
Goffi <goffi@goffi.org>
parents: 341
diff changeset
1043 """
1262
f8a8434dbac7 core: improved roster management + misc:
Goffi <goffi@goffi.org>
parents: 1246
diff changeset
1044 return xmppim.RosterClientProtocol.removeItem(self, to_jid)
466
448ce3c9e2ac core: Roster cache refactoring: cache is now managed by client's SatRosterProtocol instance.
Goffi <goffi@goffi.org>
parents: 461
diff changeset
1045
448ce3c9e2ac core: Roster cache refactoring: cache is now managed by client's SatRosterProtocol instance.
Goffi <goffi@goffi.org>
parents: 461
diff changeset
1046 def getAttributes(self, item):
448ce3c9e2ac core: Roster cache refactoring: cache is now managed by client's SatRosterProtocol instance.
Goffi <goffi@goffi.org>
parents: 461
diff changeset
1047 """Return dictionary of attributes as used in bridge from a RosterItem
1963
a2bc5089c2eb backend, frontends: message refactoring (huge commit):
Goffi <goffi@goffi.org>
parents: 1955
diff changeset
1048
466
448ce3c9e2ac core: Roster cache refactoring: cache is now managed by client's SatRosterProtocol instance.
Goffi <goffi@goffi.org>
parents: 461
diff changeset
1049 @param item: RosterItem
1963
a2bc5089c2eb backend, frontends: message refactoring (huge commit):
Goffi <goffi@goffi.org>
parents: 1955
diff changeset
1050 @return: dictionary of attributes
a2bc5089c2eb backend, frontends: message refactoring (huge commit):
Goffi <goffi@goffi.org>
parents: 1955
diff changeset
1051 """
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1052 item_attr = {
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1053 "to": unicode(item.subscriptionTo),
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1054 "from": unicode(item.subscriptionFrom),
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1055 "ask": unicode(item.ask),
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1056 }
466
448ce3c9e2ac core: Roster cache refactoring: cache is now managed by client's SatRosterProtocol instance.
Goffi <goffi@goffi.org>
parents: 461
diff changeset
1057 if item.name:
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1058 item_attr["name"] = item.name
466
448ce3c9e2ac core: Roster cache refactoring: cache is now managed by client's SatRosterProtocol instance.
Goffi <goffi@goffi.org>
parents: 461
diff changeset
1059 return item_attr
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 572
diff changeset
1060
1262
f8a8434dbac7 core: improved roster management + misc:
Goffi <goffi@goffi.org>
parents: 1246
diff changeset
1061 def setReceived(self, request):
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1062 # TODO: implement roster versioning (cf RFC 6121 §2.6)
1262
f8a8434dbac7 core: improved roster management + misc:
Goffi <goffi@goffi.org>
parents: 1246
diff changeset
1063 item = request.item
1427
1e833970b7f0 core (xmpp): update the cache for a contact group when a contact is removed from it
souliane <souliane@mailoo.org>
parents: 1426
diff changeset
1064 try: # update the cache for the groups the contact has been removed from
1e833970b7f0 core (xmpp): update the cache for a contact group when a contact is removed from it
souliane <souliane@mailoo.org>
parents: 1426
diff changeset
1065 left_groups = set(self._jids[item.entity].groups).difference(item.groups)
1e833970b7f0 core (xmpp): update the cache for a contact group when a contact is removed from it
souliane <souliane@mailoo.org>
parents: 1426
diff changeset
1066 for group in left_groups:
1e833970b7f0 core (xmpp): update the cache for a contact group when a contact is removed from it
souliane <souliane@mailoo.org>
parents: 1426
diff changeset
1067 jids_set = self._groups[group]
1e833970b7f0 core (xmpp): update the cache for a contact group when a contact is removed from it
souliane <souliane@mailoo.org>
parents: 1426
diff changeset
1068 jids_set.remove(item.entity)
1e833970b7f0 core (xmpp): update the cache for a contact group when a contact is removed from it
souliane <souliane@mailoo.org>
parents: 1426
diff changeset
1069 if not jids_set:
1e833970b7f0 core (xmpp): update the cache for a contact group when a contact is removed from it
souliane <souliane@mailoo.org>
parents: 1426
diff changeset
1070 del self._groups[group]
1e833970b7f0 core (xmpp): update the cache for a contact group when a contact is removed from it
souliane <souliane@mailoo.org>
parents: 1426
diff changeset
1071 except KeyError:
1e833970b7f0 core (xmpp): update the cache for a contact group when a contact is removed from it
souliane <souliane@mailoo.org>
parents: 1426
diff changeset
1072 pass # no previous item registration (or it's been cleared)
1262
f8a8434dbac7 core: improved roster management + misc:
Goffi <goffi@goffi.org>
parents: 1246
diff changeset
1073 self._jids[item.entity] = item
1398
f8ecce11a0bc core (xmmp): keep the roster groups cache synchronised + fixes a log.warning
souliane <souliane@mailoo.org>
parents: 1396
diff changeset
1074 self._registerItem(item)
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1075 self.host.bridge.newContact(
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1076 item.entity.full(), self.getAttributes(item), item.groups, self.parent.profile
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1077 )
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 572
diff changeset
1078
1262
f8a8434dbac7 core: improved roster management + misc:
Goffi <goffi@goffi.org>
parents: 1246
diff changeset
1079 def removeReceived(self, request):
f8a8434dbac7 core: improved roster management + misc:
Goffi <goffi@goffi.org>
parents: 1246
diff changeset
1080 entity = request.item.entity
1299
3360074a2f00 core: fixed some logging calls without unicode strings, and use of print
Goffi <goffi@goffi.org>
parents: 1262
diff changeset
1081 log.info(u"removing %s from roster list" % entity.full())
466
448ce3c9e2ac core: Roster cache refactoring: cache is now managed by client's SatRosterProtocol instance.
Goffi <goffi@goffi.org>
parents: 461
diff changeset
1082
589
d1b4805124a1 Fix pep8 support in src/core.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 587
diff changeset
1083 # we first remove item from local cache (self._groups and self._jids)
466
448ce3c9e2ac core: Roster cache refactoring: cache is now managed by client's SatRosterProtocol instance.
Goffi <goffi@goffi.org>
parents: 461
diff changeset
1084 try:
1262
f8a8434dbac7 core: improved roster management + misc:
Goffi <goffi@goffi.org>
parents: 1246
diff changeset
1085 item = self._jids.pop(entity)
466
448ce3c9e2ac core: Roster cache refactoring: cache is now managed by client's SatRosterProtocol instance.
Goffi <goffi@goffi.org>
parents: 461
diff changeset
1086 except KeyError:
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1087 log.error(
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1088 u"Received a roster remove event for an item not in cache ({})".format(
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1089 entity
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1090 )
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1091 )
466
448ce3c9e2ac core: Roster cache refactoring: cache is now managed by client's SatRosterProtocol instance.
Goffi <goffi@goffi.org>
parents: 461
diff changeset
1092 return
448ce3c9e2ac core: Roster cache refactoring: cache is now managed by client's SatRosterProtocol instance.
Goffi <goffi@goffi.org>
parents: 461
diff changeset
1093 for group in item.groups:
448ce3c9e2ac core: Roster cache refactoring: cache is now managed by client's SatRosterProtocol instance.
Goffi <goffi@goffi.org>
parents: 461
diff changeset
1094 try:
448ce3c9e2ac core: Roster cache refactoring: cache is now managed by client's SatRosterProtocol instance.
Goffi <goffi@goffi.org>
parents: 461
diff changeset
1095 jids_set = self._groups[group]
1262
f8a8434dbac7 core: improved roster management + misc:
Goffi <goffi@goffi.org>
parents: 1246
diff changeset
1096 jids_set.remove(entity)
466
448ce3c9e2ac core: Roster cache refactoring: cache is now managed by client's SatRosterProtocol instance.
Goffi <goffi@goffi.org>
parents: 461
diff changeset
1097 if not jids_set:
448ce3c9e2ac core: Roster cache refactoring: cache is now managed by client's SatRosterProtocol instance.
Goffi <goffi@goffi.org>
parents: 461
diff changeset
1098 del self._groups[group]
448ce3c9e2ac core: Roster cache refactoring: cache is now managed by client's SatRosterProtocol instance.
Goffi <goffi@goffi.org>
parents: 461
diff changeset
1099 except KeyError:
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1100 log.warning(
2643
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
1101 u"there is no cache for the group [{group}] of the removed roster "
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
1102 u"item [{jid_}]".format(group=group, jid=entity)
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1103 )
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 572
diff changeset
1104
589
d1b4805124a1 Fix pep8 support in src/core.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 587
diff changeset
1105 # then we send the bridge signal
1262
f8a8434dbac7 core: improved roster management + misc:
Goffi <goffi@goffi.org>
parents: 1246
diff changeset
1106 self.host.bridge.contactDeleted(entity.full(), self.parent.profile)
50
daa1f01a5332 SàT improvement:
Goffi <goffi@goffi.org>
parents: 41
diff changeset
1107
305
15a12bf2bb62 core: server identities are now save in memory
Goffi <goffi@goffi.org>
parents: 292
diff changeset
1108 def getGroups(self):
466
448ce3c9e2ac core: Roster cache refactoring: cache is now managed by client's SatRosterProtocol instance.
Goffi <goffi@goffi.org>
parents: 461
diff changeset
1109 """Return a list of groups"""
448ce3c9e2ac core: Roster cache refactoring: cache is now managed by client's SatRosterProtocol instance.
Goffi <goffi@goffi.org>
parents: 461
diff changeset
1110 return self._groups.keys()
448ce3c9e2ac core: Roster cache refactoring: cache is now managed by client's SatRosterProtocol instance.
Goffi <goffi@goffi.org>
parents: 461
diff changeset
1111
1300
ba73798317a7 core: fixed items registration in roster management
Goffi <goffi@goffi.org>
parents: 1299
diff changeset
1112 def getItem(self, entity_jid):
466
448ce3c9e2ac core: Roster cache refactoring: cache is now managed by client's SatRosterProtocol instance.
Goffi <goffi@goffi.org>
parents: 461
diff changeset
1113 """Return RosterItem for a given jid
1262
f8a8434dbac7 core: improved roster management + misc:
Goffi <goffi@goffi.org>
parents: 1246
diff changeset
1114
1963
a2bc5089c2eb backend, frontends: message refactoring (huge commit):
Goffi <goffi@goffi.org>
parents: 1955
diff changeset
1115 @param entity_jid(jid.JID): jid of the contact
a2bc5089c2eb backend, frontends: message refactoring (huge commit):
Goffi <goffi@goffi.org>
parents: 1955
diff changeset
1116 @return(RosterItem, None): RosterItem instance
a2bc5089c2eb backend, frontends: message refactoring (huge commit):
Goffi <goffi@goffi.org>
parents: 1955
diff changeset
1117 None if contact is not in cache
1262
f8a8434dbac7 core: improved roster management + misc:
Goffi <goffi@goffi.org>
parents: 1246
diff changeset
1118 """
1300
ba73798317a7 core: fixed items registration in roster management
Goffi <goffi@goffi.org>
parents: 1299
diff changeset
1119 return self._jids.get(entity_jid, None)
466
448ce3c9e2ac core: Roster cache refactoring: cache is now managed by client's SatRosterProtocol instance.
Goffi <goffi@goffi.org>
parents: 461
diff changeset
1120
1262
f8a8434dbac7 core: improved roster management + misc:
Goffi <goffi@goffi.org>
parents: 1246
diff changeset
1121 def getJids(self):
f8a8434dbac7 core: improved roster management + misc:
Goffi <goffi@goffi.org>
parents: 1246
diff changeset
1122 """Return all jids of the roster"""
467
47af60767013 plugin group blog: getMassiveGroupBlog first draft
Goffi <goffi@goffi.org>
parents: 466
diff changeset
1123 return self._jids.keys()
487
e789917fb59d core: added isJidInRoster method
Goffi <goffi@goffi.org>
parents: 484
diff changeset
1124
e789917fb59d core: added isJidInRoster method
Goffi <goffi@goffi.org>
parents: 484
diff changeset
1125 def isJidInRoster(self, entity_jid):
e789917fb59d core: added isJidInRoster method
Goffi <goffi@goffi.org>
parents: 484
diff changeset
1126 """Return True if jid is in roster"""
1262
f8a8434dbac7 core: improved roster management + misc:
Goffi <goffi@goffi.org>
parents: 1246
diff changeset
1127 return entity_jid in self._jids
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 572
diff changeset
1128
2139
f8401024ab28 core (roster): added isPresenceAuthorised to check if an entity is authorised to see our presence
Goffi <goffi@goffi.org>
parents: 2136
diff changeset
1129 def isPresenceAuthorised(self, entity_jid):
f8401024ab28 core (roster): added isPresenceAuthorised to check if an entity is authorised to see our presence
Goffi <goffi@goffi.org>
parents: 2136
diff changeset
1130 """Return True if entity is authorised to see our presence"""
f8401024ab28 core (roster): added isPresenceAuthorised to check if an entity is authorised to see our presence
Goffi <goffi@goffi.org>
parents: 2136
diff changeset
1131 try:
f8401024ab28 core (roster): added isPresenceAuthorised to check if an entity is authorised to see our presence
Goffi <goffi@goffi.org>
parents: 2136
diff changeset
1132 item = self._jids[entity_jid.userhostJID()]
f8401024ab28 core (roster): added isPresenceAuthorised to check if an entity is authorised to see our presence
Goffi <goffi@goffi.org>
parents: 2136
diff changeset
1133 except KeyError:
f8401024ab28 core (roster): added isPresenceAuthorised to check if an entity is authorised to see our presence
Goffi <goffi@goffi.org>
parents: 2136
diff changeset
1134 return False
f8401024ab28 core (roster): added isPresenceAuthorised to check if an entity is authorised to see our presence
Goffi <goffi@goffi.org>
parents: 2136
diff changeset
1135 return item.subscriptionFrom
f8401024ab28 core (roster): added isPresenceAuthorised to check if an entity is authorised to see our presence
Goffi <goffi@goffi.org>
parents: 2136
diff changeset
1136
466
448ce3c9e2ac core: Roster cache refactoring: cache is now managed by client's SatRosterProtocol instance.
Goffi <goffi@goffi.org>
parents: 461
diff changeset
1137 def getItems(self):
448ce3c9e2ac core: Roster cache refactoring: cache is now managed by client's SatRosterProtocol instance.
Goffi <goffi@goffi.org>
parents: 461
diff changeset
1138 """Return all items of the roster"""
467
47af60767013 plugin group blog: getMassiveGroupBlog first draft
Goffi <goffi@goffi.org>
parents: 466
diff changeset
1139 return self._jids.values()
501
e9634d2e7b38 core, quick_frontend, primitivus, wix: Contacts List refactoring phase 1:
Goffi <goffi@goffi.org>
parents: 487
diff changeset
1140
e9634d2e7b38 core, quick_frontend, primitivus, wix: Contacts List refactoring phase 1:
Goffi <goffi@goffi.org>
parents: 487
diff changeset
1141 def getJidsFromGroup(self, group):
e9634d2e7b38 core, quick_frontend, primitivus, wix: Contacts List refactoring phase 1:
Goffi <goffi@goffi.org>
parents: 487
diff changeset
1142 try:
e9634d2e7b38 core, quick_frontend, primitivus, wix: Contacts List refactoring phase 1:
Goffi <goffi@goffi.org>
parents: 487
diff changeset
1143 return self._groups[group]
e9634d2e7b38 core, quick_frontend, primitivus, wix: Contacts List refactoring phase 1:
Goffi <goffi@goffi.org>
parents: 487
diff changeset
1144 except KeyError:
1300
ba73798317a7 core: fixed items registration in roster management
Goffi <goffi@goffi.org>
parents: 1299
diff changeset
1145 raise exceptions.UnknownGroupError(group)
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 572
diff changeset
1146
1450
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet
Goffi <goffi@goffi.org>
parents: 1435
diff changeset
1147 def getJidsSet(self, type_, groups=None):
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet
Goffi <goffi@goffi.org>
parents: 1435
diff changeset
1148 """Helper method to get a set of jids
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet
Goffi <goffi@goffi.org>
parents: 1435
diff changeset
1149
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet
Goffi <goffi@goffi.org>
parents: 1435
diff changeset
1150 @param type_(unicode): one of:
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet
Goffi <goffi@goffi.org>
parents: 1435
diff changeset
1151 C.ALL: get all jids from roster
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet
Goffi <goffi@goffi.org>
parents: 1435
diff changeset
1152 C.GROUP: get jids from groups (listed in "groups")
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet
Goffi <goffi@goffi.org>
parents: 1435
diff changeset
1153 @groups(list[unicode]): list of groups used if type_==C.GROUP
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet
Goffi <goffi@goffi.org>
parents: 1435
diff changeset
1154 @return (set(jid.JID)): set of selected jids
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet
Goffi <goffi@goffi.org>
parents: 1435
diff changeset
1155 """
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet
Goffi <goffi@goffi.org>
parents: 1435
diff changeset
1156 if type_ == C.ALL and groups is not None:
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1157 raise ValueError("groups must not be set for {} type".format(C.ALL))
1450
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet
Goffi <goffi@goffi.org>
parents: 1435
diff changeset
1158
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet
Goffi <goffi@goffi.org>
parents: 1435
diff changeset
1159 if type_ == C.ALL:
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet
Goffi <goffi@goffi.org>
parents: 1435
diff changeset
1160 return set(self.getJids())
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet
Goffi <goffi@goffi.org>
parents: 1435
diff changeset
1161 elif type_ == C.GROUP:
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet
Goffi <goffi@goffi.org>
parents: 1435
diff changeset
1162 jids = set()
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet
Goffi <goffi@goffi.org>
parents: 1435
diff changeset
1163 for group in groups:
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet
Goffi <goffi@goffi.org>
parents: 1435
diff changeset
1164 jids.update(self.getJidsFromGroup(group))
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet
Goffi <goffi@goffi.org>
parents: 1435
diff changeset
1165 return jids
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet
Goffi <goffi@goffi.org>
parents: 1435
diff changeset
1166 else:
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1167 raise ValueError(u"Unexpected type_ {}".format(type_))
1450
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet
Goffi <goffi@goffi.org>
parents: 1435
diff changeset
1168
1963
a2bc5089c2eb backend, frontends: message refactoring (huge commit):
Goffi <goffi@goffi.org>
parents: 1955
diff changeset
1169 def getNick(self, entity_jid):
a2bc5089c2eb backend, frontends: message refactoring (huge commit):
Goffi <goffi@goffi.org>
parents: 1955
diff changeset
1170 """Return a nick name for an entity
a2bc5089c2eb backend, frontends: message refactoring (huge commit):
Goffi <goffi@goffi.org>
parents: 1955
diff changeset
1171
a2bc5089c2eb backend, frontends: message refactoring (huge commit):
Goffi <goffi@goffi.org>
parents: 1955
diff changeset
1172 return nick choosed by user if available
a2bc5089c2eb backend, frontends: message refactoring (huge commit):
Goffi <goffi@goffi.org>
parents: 1955
diff changeset
1173 else return user part of entity_jid
a2bc5089c2eb backend, frontends: message refactoring (huge commit):
Goffi <goffi@goffi.org>
parents: 1955
diff changeset
1174 """
a2bc5089c2eb backend, frontends: message refactoring (huge commit):
Goffi <goffi@goffi.org>
parents: 1955
diff changeset
1175 item = self.getItem(entity_jid)
a2bc5089c2eb backend, frontends: message refactoring (huge commit):
Goffi <goffi@goffi.org>
parents: 1955
diff changeset
1176 if item is None:
a2bc5089c2eb backend, frontends: message refactoring (huge commit):
Goffi <goffi@goffi.org>
parents: 1955
diff changeset
1177 return entity_jid.user
a2bc5089c2eb backend, frontends: message refactoring (huge commit):
Goffi <goffi@goffi.org>
parents: 1955
diff changeset
1178 else:
a2bc5089c2eb backend, frontends: message refactoring (huge commit):
Goffi <goffi@goffi.org>
parents: 1955
diff changeset
1179 return item.name or entity_jid.user
a2bc5089c2eb backend, frontends: message refactoring (huge commit):
Goffi <goffi@goffi.org>
parents: 1955
diff changeset
1180
305
15a12bf2bb62 core: server identities are now save in memory
Goffi <goffi@goffi.org>
parents: 292
diff changeset
1181
13
bd9e9997d540 wokkel integration (not finished yet)
Goffi <goffi@goffi.org>
parents: 12
diff changeset
1182 class SatPresenceProtocol(xmppim.PresenceClientProtocol):
bd9e9997d540 wokkel integration (not finished yet)
Goffi <goffi@goffi.org>
parents: 12
diff changeset
1183 def __init__(self, host):
bd9e9997d540 wokkel integration (not finished yet)
Goffi <goffi@goffi.org>
parents: 12
diff changeset
1184 xmppim.PresenceClientProtocol.__init__(self)
bd9e9997d540 wokkel integration (not finished yet)
Goffi <goffi@goffi.org>
parents: 12
diff changeset
1185 self.host = host
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 572
diff changeset
1186
944
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 934
diff changeset
1187 def send(self, obj):
2543
60758de1c227 plugin XEP-0115: fixed caps initial check
Goffi <goffi@goffi.org>
parents: 2527
diff changeset
1188 presence_d = defer.succeed(None)
60758de1c227 plugin XEP-0115: fixed caps initial check
Goffi <goffi@goffi.org>
parents: 2527
diff changeset
1189 if not self.host.trigger.point("Presence send", self.parent, obj, presence_d):
944
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 934
diff changeset
1190 return
2543
60758de1c227 plugin XEP-0115: fixed caps initial check
Goffi <goffi@goffi.org>
parents: 2527
diff changeset
1191 presence_d.addCallback(lambda __: super(SatPresenceProtocol, self).send(obj))
944
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring:
Goffi <goffi@goffi.org>
parents: 934
diff changeset
1192
13
bd9e9997d540 wokkel integration (not finished yet)
Goffi <goffi@goffi.org>
parents: 12
diff changeset
1193 def availableReceived(self, entity, show=None, statuses=None, priority=0):
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1194 log.debug(
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1195 _(
2643
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
1196 u"presence update for [{entity}] (available, show={show} "
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
1197 u"statuses={statuses} priority={priority})"
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1198 )
2643
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
1199 .format(
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
1200 entity=entity,
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
1201 show=show,
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
1202 statuses=statuses,
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
1203 priority=priority,
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
1204 )
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1205 )
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 572
diff changeset
1206
334
698cbc6ebec8 core: fixed None instead of empty dict in availableReceived
Goffi <goffi@goffi.org>
parents: 333
diff changeset
1207 if not statuses:
698cbc6ebec8 core: fixed None instead of empty dict in availableReceived
Goffi <goffi@goffi.org>
parents: 333
diff changeset
1208 statuses = {}
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 572
diff changeset
1209
589
d1b4805124a1 Fix pep8 support in src/core.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 587
diff changeset
1210 if None in statuses: # we only want string keys
1417
176de79c8c39 core, plugin XEP-0045, frontends: change frontend method "setStatusOnline" for "setPresenceStatus":
souliane <souliane@mailoo.org>
parents: 1409
diff changeset
1211 statuses[C.PRESENCE_STATUSES_DEFAULT] = statuses.pop(None)
13
bd9e9997d540 wokkel integration (not finished yet)
Goffi <goffi@goffi.org>
parents: 12
diff changeset
1212
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1213 if not self.host.trigger.point(
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1214 "presenceReceived", entity, show, priority, statuses, self.parent.profile
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1215 ):
1480
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online
Goffi <goffi@goffi.org>
parents: 1450
diff changeset
1216 return
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online
Goffi <goffi@goffi.org>
parents: 1450
diff changeset
1217
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1218 self.host.memory.setPresenceStatus(
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1219 entity, show or "", int(priority), statuses, self.parent.profile
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1220 )
13
bd9e9997d540 wokkel integration (not finished yet)
Goffi <goffi@goffi.org>
parents: 12
diff changeset
1221
589
d1b4805124a1 Fix pep8 support in src/core.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 587
diff changeset
1222 # now it's time to notify frontends
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1223 self.host.bridge.presenceUpdate(
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1224 entity.full(), show or "", int(priority), statuses, self.parent.profile
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1225 )
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 572
diff changeset
1226
13
bd9e9997d540 wokkel integration (not finished yet)
Goffi <goffi@goffi.org>
parents: 12
diff changeset
1227 def unavailableReceived(self, entity, statuses=None):
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1228 log.debug(
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1229 _(u"presence update for [%(entity)s] (unavailable, statuses=%(statuses)s)")
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1230 % {"entity": entity, C.PRESENCE_STATUSES: statuses}
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1231 )
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 572
diff changeset
1232
333
4c835d614bdb core: fixed a None sent instead of empty dict in unavailableReceived
Goffi <goffi@goffi.org>
parents: 330
diff changeset
1233 if not statuses:
4c835d614bdb core: fixed a None sent instead of empty dict in unavailableReceived
Goffi <goffi@goffi.org>
parents: 330
diff changeset
1234 statuses = {}
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 572
diff changeset
1235
589
d1b4805124a1 Fix pep8 support in src/core.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 587
diff changeset
1236 if None in statuses: # we only want string keys
1417
176de79c8c39 core, plugin XEP-0045, frontends: change frontend method "setStatusOnline" for "setPresenceStatus":
souliane <souliane@mailoo.org>
parents: 1409
diff changeset
1237 statuses[C.PRESENCE_STATUSES_DEFAULT] = statuses.pop(None)
13
bd9e9997d540 wokkel integration (not finished yet)
Goffi <goffi@goffi.org>
parents: 12
diff changeset
1238
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1239 if not self.host.trigger.point(
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1240 "presenceReceived", entity, "unavailable", 0, statuses, self.parent.profile
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1241 ):
1170
2df6427a5299 plugin OTR: forces FINISHED state if we are in ENCRYPTED state on contact disconnection
souliane <souliane@mailoo.org>
parents: 1167
diff changeset
1242 return
2df6427a5299 plugin OTR: forces FINISHED state if we are in ENCRYPTED state on contact disconnection
souliane <souliane@mailoo.org>
parents: 1167
diff changeset
1243
1685
43a127b6a4f2 core: avoid to send presence unavailable signal when it's not necessary
Goffi <goffi@goffi.org>
parents: 1622
diff changeset
1244 # now it's time to notify frontends
2643
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
1245 # if the entity is not known yet in this session or is already unavailable,
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
1246 # there is no need to send an unavailable signal
1685
43a127b6a4f2 core: avoid to send presence unavailable signal when it's not necessary
Goffi <goffi@goffi.org>
parents: 1622
diff changeset
1247 try:
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1248 presence = self.host.memory.getEntityDatum(
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1249 entity, "presence", self.parent.profile
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1250 )
1690
772c8edd1057 core: fixed cache check on presence unavailable
Goffi <goffi@goffi.org>
parents: 1685
diff changeset
1251 except (KeyError, exceptions.UnknownEntityError):
1685
43a127b6a4f2 core: avoid to send presence unavailable signal when it's not necessary
Goffi <goffi@goffi.org>
parents: 1622
diff changeset
1252 # the entity has not been seen yet in this session
43a127b6a4f2 core: avoid to send presence unavailable signal when it's not necessary
Goffi <goffi@goffi.org>
parents: 1622
diff changeset
1253 pass
43a127b6a4f2 core: avoid to send presence unavailable signal when it's not necessary
Goffi <goffi@goffi.org>
parents: 1622
diff changeset
1254 else:
43a127b6a4f2 core: avoid to send presence unavailable signal when it's not necessary
Goffi <goffi@goffi.org>
parents: 1622
diff changeset
1255 if presence.show != C.PRESENCE_UNAVAILABLE:
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1256 self.host.bridge.presenceUpdate(
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1257 entity.full(),
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1258 C.PRESENCE_UNAVAILABLE,
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1259 0,
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1260 statuses,
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1261 self.parent.profile,
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1262 )
1480
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online
Goffi <goffi@goffi.org>
parents: 1450
diff changeset
1263
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1264 self.host.memory.setPresenceStatus(
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1265 entity, C.PRESENCE_UNAVAILABLE, 0, statuses, self.parent.profile
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1266 )
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 572
diff changeset
1267
611
d722778b152c core: added Priority management
Goffi <goffi@goffi.org>
parents: 609
diff changeset
1268 def available(self, entity=None, show=None, statuses=None, priority=None):
1434
b06047e1c1fb primitivus: fix setting the presence and status
souliane <souliane@mailoo.org>
parents: 1431
diff changeset
1269 """Set a presence and statuses.
b06047e1c1fb primitivus: fix setting the presence and status
souliane <souliane@mailoo.org>
parents: 1431
diff changeset
1270
b06047e1c1fb primitivus: fix setting the presence and status
souliane <souliane@mailoo.org>
parents: 1431
diff changeset
1271 @param entity (jid.JID): entity
b06047e1c1fb primitivus: fix setting the presence and status
souliane <souliane@mailoo.org>
parents: 1431
diff changeset
1272 @param show (unicode): value in ('unavailable', '', 'away', 'xa', 'chat', 'dnd')
b06047e1c1fb primitivus: fix setting the presence and status
souliane <souliane@mailoo.org>
parents: 1431
diff changeset
1273 @param statuses (dict{unicode: unicode}): multilingual statuses with
b06047e1c1fb primitivus: fix setting the presence and status
souliane <souliane@mailoo.org>
parents: 1431
diff changeset
1274 the entry key beeing a language code on 2 characters or "default".
b06047e1c1fb primitivus: fix setting the presence and status
souliane <souliane@mailoo.org>
parents: 1431
diff changeset
1275 """
611
d722778b152c core: added Priority management
Goffi <goffi@goffi.org>
parents: 609
diff changeset
1276 if priority is None:
d722778b152c core: added Priority management
Goffi <goffi@goffi.org>
parents: 609
diff changeset
1277 try:
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1278 priority = int(
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1279 self.host.memory.getParamA(
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1280 "Priority", "Connection", profile_key=self.parent.profile
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1281 )
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1282 )
611
d722778b152c core: added Priority management
Goffi <goffi@goffi.org>
parents: 609
diff changeset
1283 except ValueError:
d722778b152c core: added Priority management
Goffi <goffi@goffi.org>
parents: 609
diff changeset
1284 priority = 0
d722778b152c core: added Priority management
Goffi <goffi@goffi.org>
parents: 609
diff changeset
1285
734
b26dfac8e46c core: bad indentation in SatPresenceProtocol.available
souliane <souliane@mailoo.org>
parents: 726
diff changeset
1286 if statuses is None:
562
0bb2e0d1c878 core, plugin XEP-0054: avatar upload:
Goffi <goffi@goffi.org>
parents: 549
diff changeset
1287 statuses = {}
734
b26dfac8e46c core: bad indentation in SatPresenceProtocol.available
souliane <souliane@mailoo.org>
parents: 726
diff changeset
1288
b26dfac8e46c core: bad indentation in SatPresenceProtocol.available
souliane <souliane@mailoo.org>
parents: 726
diff changeset
1289 # default for us is None for wokkel
b26dfac8e46c core: bad indentation in SatPresenceProtocol.available
souliane <souliane@mailoo.org>
parents: 726
diff changeset
1290 # so we must temporarily switch to wokkel's convention...
1417
176de79c8c39 core, plugin XEP-0045, frontends: change frontend method "setStatusOnline" for "setPresenceStatus":
souliane <souliane@mailoo.org>
parents: 1409
diff changeset
1291 if C.PRESENCE_STATUSES_DEFAULT in statuses:
176de79c8c39 core, plugin XEP-0045, frontends: change frontend method "setStatusOnline" for "setPresenceStatus":
souliane <souliane@mailoo.org>
parents: 1409
diff changeset
1292 statuses[None] = statuses.pop(C.PRESENCE_STATUSES_DEFAULT)
379
adcc41e4d6ea core: Fix status update crash
Xavier Maillard <xavier@maillard.im>
parents: 347
diff changeset
1293
734
b26dfac8e46c core: bad indentation in SatPresenceProtocol.available
souliane <souliane@mailoo.org>
parents: 726
diff changeset
1294 presence_elt = xmppim.AvailablePresence(entity, show, statuses, priority)
379
adcc41e4d6ea core: Fix status update crash
Xavier Maillard <xavier@maillard.im>
parents: 347
diff changeset
1295
562
0bb2e0d1c878 core, plugin XEP-0054: avatar upload:
Goffi <goffi@goffi.org>
parents: 549
diff changeset
1296 # ... before switching back
0bb2e0d1c878 core, plugin XEP-0054: avatar upload:
Goffi <goffi@goffi.org>
parents: 549
diff changeset
1297 if None in statuses:
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1298 statuses["default"] = statuses.pop(None)
379
adcc41e4d6ea core: Fix status update crash
Xavier Maillard <xavier@maillard.im>
parents: 347
diff changeset
1299
1167
fe102b4cf275 core (xmpp): fixes SatPresenceProtocol.available to prevent an eventual code skipping
souliane <souliane@mailoo.org>
parents: 1089
diff changeset
1300 if not self.host.trigger.point("presence_available", presence_elt, self.parent):
fe102b4cf275 core (xmpp): fixes SatPresenceProtocol.available to prevent an eventual code skipping
souliane <souliane@mailoo.org>
parents: 1089
diff changeset
1301 return
fe102b4cf275 core (xmpp): fixes SatPresenceProtocol.available to prevent an eventual code skipping
souliane <souliane@mailoo.org>
parents: 1089
diff changeset
1302 self.send(presence_elt)
fe102b4cf275 core (xmpp): fixes SatPresenceProtocol.available to prevent an eventual code skipping
souliane <souliane@mailoo.org>
parents: 1089
diff changeset
1303
1963
a2bc5089c2eb backend, frontends: message refactoring (huge commit):
Goffi <goffi@goffi.org>
parents: 1955
diff changeset
1304 @defer.inlineCallbacks
346
ca3a041fed30 core: fixed several subscription scheme issues + removed most of profile_key default value in core.sat_main and core.xmmp (source of bugs) + contact update
Goffi <goffi@goffi.org>
parents: 341
diff changeset
1305 def subscribed(self, entity):
1963
a2bc5089c2eb backend, frontends: message refactoring (huge commit):
Goffi <goffi@goffi.org>
parents: 1955
diff changeset
1306 yield self.parent.roster.got_roster
346
ca3a041fed30 core: fixed several subscription scheme issues + removed most of profile_key default value in core.sat_main and core.xmmp (source of bugs) + contact update
Goffi <goffi@goffi.org>
parents: 341
diff changeset
1307 xmppim.PresenceClientProtocol.subscribed(self, entity)
ca3a041fed30 core: fixed several subscription scheme issues + removed most of profile_key default value in core.sat_main and core.xmmp (source of bugs) + contact update
Goffi <goffi@goffi.org>
parents: 341
diff changeset
1308 self.host.memory.delWaitingSub(entity.userhost(), self.parent.profile)
466
448ce3c9e2ac core: Roster cache refactoring: cache is now managed by client's SatRosterProtocol instance.
Goffi <goffi@goffi.org>
parents: 461
diff changeset
1309 item = self.parent.roster.getItem(entity)
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1310 if (
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1311 not item or not item.subscriptionTo
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1312 ): # we automatically subscribe to 'to' presence
993
301b342c697a core: use of the new core.log module:
Goffi <goffi@goffi.org>
parents: 960
diff changeset
1313 log.debug(_('sending automatic "from" subscription request'))
346
ca3a041fed30 core: fixed several subscription scheme issues + removed most of profile_key default value in core.sat_main and core.xmmp (source of bugs) + contact update
Goffi <goffi@goffi.org>
parents: 341
diff changeset
1314 self.subscribe(entity)
ca3a041fed30 core: fixed several subscription scheme issues + removed most of profile_key default value in core.sat_main and core.xmmp (source of bugs) + contact update
Goffi <goffi@goffi.org>
parents: 341
diff changeset
1315
ca3a041fed30 core: fixed several subscription scheme issues + removed most of profile_key default value in core.sat_main and core.xmmp (source of bugs) + contact update
Goffi <goffi@goffi.org>
parents: 341
diff changeset
1316 def unsubscribed(self, entity):
ca3a041fed30 core: fixed several subscription scheme issues + removed most of profile_key default value in core.sat_main and core.xmmp (source of bugs) + contact update
Goffi <goffi@goffi.org>
parents: 341
diff changeset
1317 xmppim.PresenceClientProtocol.unsubscribed(self, entity)
ca3a041fed30 core: fixed several subscription scheme issues + removed most of profile_key default value in core.sat_main and core.xmmp (source of bugs) + contact update
Goffi <goffi@goffi.org>
parents: 341
diff changeset
1318 self.host.memory.delWaitingSub(entity.userhost(), self.parent.profile)
ca3a041fed30 core: fixed several subscription scheme issues + removed most of profile_key default value in core.sat_main and core.xmmp (source of bugs) + contact update
Goffi <goffi@goffi.org>
parents: 341
diff changeset
1319
13
bd9e9997d540 wokkel integration (not finished yet)
Goffi <goffi@goffi.org>
parents: 12
diff changeset
1320 def subscribedReceived(self, entity):
1409
3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions
souliane <souliane@mailoo.org>
parents: 1398
diff changeset
1321 log.debug(_(u"subscription approved for [%s]") % entity.userhost())
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1322 self.host.bridge.subscribe("subscribed", entity.userhost(), self.parent.profile)
13
bd9e9997d540 wokkel integration (not finished yet)
Goffi <goffi@goffi.org>
parents: 12
diff changeset
1323
bd9e9997d540 wokkel integration (not finished yet)
Goffi <goffi@goffi.org>
parents: 12
diff changeset
1324 def unsubscribedReceived(self, entity):
1409
3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions
souliane <souliane@mailoo.org>
parents: 1398
diff changeset
1325 log.debug(_(u"unsubscription confirmed for [%s]") % entity.userhost())
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1326 self.host.bridge.subscribe("unsubscribed", entity.userhost(), self.parent.profile)
13
bd9e9997d540 wokkel integration (not finished yet)
Goffi <goffi@goffi.org>
parents: 12
diff changeset
1327
1963
a2bc5089c2eb backend, frontends: message refactoring (huge commit):
Goffi <goffi@goffi.org>
parents: 1955
diff changeset
1328 @defer.inlineCallbacks
13
bd9e9997d540 wokkel integration (not finished yet)
Goffi <goffi@goffi.org>
parents: 12
diff changeset
1329 def subscribeReceived(self, entity):
1409
3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions
souliane <souliane@mailoo.org>
parents: 1398
diff changeset
1330 log.debug(_(u"subscription request from [%s]") % entity.userhost())
1963
a2bc5089c2eb backend, frontends: message refactoring (huge commit):
Goffi <goffi@goffi.org>
parents: 1955
diff changeset
1331 yield self.parent.roster.got_roster
466
448ce3c9e2ac core: Roster cache refactoring: cache is now managed by client's SatRosterProtocol instance.
Goffi <goffi@goffi.org>
parents: 461
diff changeset
1332 item = self.parent.roster.getItem(entity)
448ce3c9e2ac core: Roster cache refactoring: cache is now managed by client's SatRosterProtocol instance.
Goffi <goffi@goffi.org>
parents: 461
diff changeset
1333 if item and item.subscriptionTo:
2643
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
1334 # We automatically accept subscription if we are already subscribed to
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
1335 # contact presence
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1336 log.debug(_("sending automatic subscription acceptance"))
346
ca3a041fed30 core: fixed several subscription scheme issues + removed most of profile_key default value in core.sat_main and core.xmmp (source of bugs) + contact update
Goffi <goffi@goffi.org>
parents: 341
diff changeset
1337 self.subscribed(entity)
ca3a041fed30 core: fixed several subscription scheme issues + removed most of profile_key default value in core.sat_main and core.xmmp (source of bugs) + contact update
Goffi <goffi@goffi.org>
parents: 341
diff changeset
1338 else:
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1339 self.host.memory.addWaitingSub(
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1340 "subscribe", entity.userhost(), self.parent.profile
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1341 )
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1342 self.host.bridge.subscribe(
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1343 "subscribe", entity.userhost(), self.parent.profile
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1344 )
13
bd9e9997d540 wokkel integration (not finished yet)
Goffi <goffi@goffi.org>
parents: 12
diff changeset
1345
1963
a2bc5089c2eb backend, frontends: message refactoring (huge commit):
Goffi <goffi@goffi.org>
parents: 1955
diff changeset
1346 @defer.inlineCallbacks
13
bd9e9997d540 wokkel integration (not finished yet)
Goffi <goffi@goffi.org>
parents: 12
diff changeset
1347 def unsubscribeReceived(self, entity):
1409
3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions
souliane <souliane@mailoo.org>
parents: 1398
diff changeset
1348 log.debug(_(u"unsubscription asked for [%s]") % entity.userhost())
1963
a2bc5089c2eb backend, frontends: message refactoring (huge commit):
Goffi <goffi@goffi.org>
parents: 1955
diff changeset
1349 yield self.parent.roster.got_roster
466
448ce3c9e2ac core: Roster cache refactoring: cache is now managed by client's SatRosterProtocol instance.
Goffi <goffi@goffi.org>
parents: 461
diff changeset
1350 item = self.parent.roster.getItem(entity)
589
d1b4805124a1 Fix pep8 support in src/core.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 587
diff changeset
1351 if item and item.subscriptionFrom: # we automatically remove contact
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1352 log.debug(_("automatic contact deletion"))
875
19d7d077478a core (xmpp): fix automatic contact deletion
souliane <souliane@mailoo.org>
parents: 819
diff changeset
1353 self.host.delContact(entity, self.parent.profile)
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1354 self.host.bridge.subscribe("unsubscribe", entity.userhost(), self.parent.profile)
13
bd9e9997d540 wokkel integration (not finished yet)
Goffi <goffi@goffi.org>
parents: 12
diff changeset
1355
589
d1b4805124a1 Fix pep8 support in src/core.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 587
diff changeset
1356
14
a62d7d453f22 wokkel integration, part II
Goffi <goffi@goffi.org>
parents: 13
diff changeset
1357 class SatDiscoProtocol(disco.DiscoClientProtocol):
2688
943e78e18882 core (xmpp): added missing disco#info namespace to disco info result.
Goffi <goffi@goffi.org>
parents: 2687
diff changeset
1358 implements(iwokkel.IDisco)
943e78e18882 core (xmpp): added missing disco#info namespace to disco info result.
Goffi <goffi@goffi.org>
parents: 2687
diff changeset
1359
14
a62d7d453f22 wokkel integration, part II
Goffi <goffi@goffi.org>
parents: 13
diff changeset
1360 def __init__(self, host):
a62d7d453f22 wokkel integration, part II
Goffi <goffi@goffi.org>
parents: 13
diff changeset
1361 disco.DiscoClientProtocol.__init__(self)
a62d7d453f22 wokkel integration, part II
Goffi <goffi@goffi.org>
parents: 13
diff changeset
1362
2688
943e78e18882 core (xmpp): added missing disco#info namespace to disco info result.
Goffi <goffi@goffi.org>
parents: 2687
diff changeset
1363 def getDiscoInfo(self, requestor, target, nodeIdentifier=""):
2693
f64f1158a26e core (xmpp): added NS_X_DATA to disco features
Goffi <goffi@goffi.org>
parents: 2691
diff changeset
1364 return [disco.DiscoFeature(NS_X_DATA),
f64f1158a26e core (xmpp): added NS_X_DATA to disco features
Goffi <goffi@goffi.org>
parents: 2691
diff changeset
1365 disco.DiscoFeature(NS_DISCO_INFO)]
2688
943e78e18882 core (xmpp): added missing disco#info namespace to disco info result.
Goffi <goffi@goffi.org>
parents: 2687
diff changeset
1366
943e78e18882 core (xmpp): added missing disco#info namespace to disco info result.
Goffi <goffi@goffi.org>
parents: 2687
diff changeset
1367 def getDiscoItems(self, requestor, target, nodeIdentifier=""):
943e78e18882 core (xmpp): added missing disco#info namespace to disco info result.
Goffi <goffi@goffi.org>
parents: 2687
diff changeset
1368 return []
943e78e18882 core (xmpp): added missing disco#info namespace to disco info result.
Goffi <goffi@goffi.org>
parents: 2687
diff changeset
1369
589
d1b4805124a1 Fix pep8 support in src/core.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 587
diff changeset
1370
15
218ec9984fa5 wokkel integration part III + memory saved again
Goffi <goffi@goffi.org>
parents: 14
diff changeset
1371 class SatFallbackHandler(generic.FallbackHandler):
218ec9984fa5 wokkel integration part III + memory saved again
Goffi <goffi@goffi.org>
parents: 14
diff changeset
1372 def __init__(self, host):
218ec9984fa5 wokkel integration part III + memory saved again
Goffi <goffi@goffi.org>
parents: 14
diff changeset
1373 generic.FallbackHandler.__init__(self)
218ec9984fa5 wokkel integration part III + memory saved again
Goffi <goffi@goffi.org>
parents: 14
diff changeset
1374
218ec9984fa5 wokkel integration part III + memory saved again
Goffi <goffi@goffi.org>
parents: 14
diff changeset
1375 def iqFallback(self, iq):
589
d1b4805124a1 Fix pep8 support in src/core.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 587
diff changeset
1376 if iq.handled is True:
292
f7bd973bba5a core: wokkel behavious work around on VersionHandler to avoid XEP-0115 issue with ejabberd (see comments for details)
Goffi <goffi@goffi.org>
parents: 288
diff changeset
1377 return
993
301b342c697a core: use of the new core.log module:
Goffi <goffi@goffi.org>
parents: 960
diff changeset
1378 log.debug(u"iqFallback: xml = [%s]" % (iq.toXml()))
15
218ec9984fa5 wokkel integration part III + memory saved again
Goffi <goffi@goffi.org>
parents: 14
diff changeset
1379 generic.FallbackHandler.iqFallback(self, iq)
16
0a024d5e0cd0 New account creation (in-band registration)
Goffi <goffi@goffi.org>
parents: 15
diff changeset
1380
589
d1b4805124a1 Fix pep8 support in src/core.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 587
diff changeset
1381
292
f7bd973bba5a core: wokkel behavious work around on VersionHandler to avoid XEP-0115 issue with ejabberd (see comments for details)
Goffi <goffi@goffi.org>
parents: 288
diff changeset
1382 class SatVersionHandler(generic.VersionHandler):
2643
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
1383
292
f7bd973bba5a core: wokkel behavious work around on VersionHandler to avoid XEP-0115 issue with ejabberd (see comments for details)
Goffi <goffi@goffi.org>
parents: 288
diff changeset
1384 def getDiscoInfo(self, requestor, target, node):
2643
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
1385 # XXX: We need to work around wokkel's behaviour (namespace not added if there
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
1386 # is a node) as it cause issues with XEP-0115 & PEP (XEP-0163): there is a
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
1387 # node when server ask for disco info, and not when we generate the key, so
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
1388 # the hash is used with different disco features, and when the server (seen
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
1389 # on ejabberd) generate its own hash for security check it reject our
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
1390 # features (resulting in e.g. no notification on PEP)
292
f7bd973bba5a core: wokkel behavious work around on VersionHandler to avoid XEP-0115 issue with ejabberd (see comments for details)
Goffi <goffi@goffi.org>
parents: 288
diff changeset
1391 return generic.VersionHandler.getDiscoInfo(self, requestor, target, None)
666
2a7185b8452c core: added SatIdentityHandler for Disco Identity, and set identity to "client/pc/Salut à Toi"
Goffi <goffi@goffi.org>
parents: 663
diff changeset
1392
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
1393
666
2a7185b8452c core: added SatIdentityHandler for Disco Identity, and set identity to "client/pc/Salut à Toi"
Goffi <goffi@goffi.org>
parents: 663
diff changeset
1394 class SatIdentityHandler(XMPPHandler):
2643
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
1395 """Manage disco Identity of SàT."""
666
2a7185b8452c core: added SatIdentityHandler for Disco Identity, and set identity to "client/pc/Salut à Toi"
Goffi <goffi@goffi.org>
parents: 663
diff changeset
1396 implements(iwokkel.IDisco)
2643
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
1397 # TODO: dynamic identity update (see docstring). Note that a XMPP entity can have
189e38fb11ff core: style improvments (90 chars limit)
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
1398 # several identities
666
2a7185b8452c core: added SatIdentityHandler for Disco Identity, and set identity to "client/pc/Salut à Toi"
Goffi <goffi@goffi.org>
parents: 663
diff changeset
1399
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1400 def getDiscoInfo(self, requestor, target, nodeIdentifier=""):
2144
1d3f73e065e1 core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents: 2139
diff changeset
1401 return self.parent.identities
666
2a7185b8452c core: added SatIdentityHandler for Disco Identity, and set identity to "client/pc/Salut à Toi"
Goffi <goffi@goffi.org>
parents: 663
diff changeset
1402
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2596
diff changeset
1403 def getDiscoItems(self, requestor, target, nodeIdentifier=""):
666
2a7185b8452c core: added SatIdentityHandler for Disco Identity, and set identity to "client/pc/Salut à Toi"
Goffi <goffi@goffi.org>
parents: 663
diff changeset
1404 return []