libervia-backend: sat/core/xmpp.py annotate

annotate sat/core/xmpp.py @ 3370:2157880ba3b4

core: plugins can now be loaded from a directory: A plugin can now be a directory with a name starting by `plugin_`. It will then be loaded as a module. The `__init__.py` file must contain the `PLUGIN_INFO` dict with metadata.

author	Goffi <goffi@goffi.org>
date	Sun, 20 Sep 2020 14:05:40 +0200
parents	e09cb08166a3
children	dea30b1eb166

rev	line source
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1 #!/usr/bin/env python3
3137 559a625a236b fixed shebangs Goffi <goffi@goffi.org> parents: 3136 diff changeset	2
3170 39d7327583e1 core: use serialised dict for `extra` in messageNew and historyGet Goffi <goffi@goffi.org> parents: 3162 diff changeset	3 # SàT: a XMPP client
3136 9d0df638c8b4 dates update Goffi <goffi@goffi.org> parents: 3135 diff changeset	4 # Copyright (C) 2009-2020 Jérôme Poisson (goffi@goffi.org)
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	5
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 589 diff changeset	6 # 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	7 # 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	8 # 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	9 # (at your option) any later version.
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	10
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 589 diff changeset	11 # 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	12 # 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	13 # 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	14 # GNU Affero General Public License for more details.
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	15
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 589 diff changeset	16 # 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	17 # along with this program. If not, see <http://www.gnu.org/licenses/>.
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	18
2984 4bac4e734666 core (xmpp): set message timestamp on message reception: Goffi <goffi@goffi.org> parents: 2983 diff changeset	19 import sys
4bac4e734666 core (xmpp): set message timestamp on message reception: Goffi <goffi@goffi.org> parents: 2983 diff changeset	20 import time
4bac4e734666 core (xmpp): set message timestamp on message reception: Goffi <goffi@goffi.org> parents: 2983 diff changeset	21 import calendar
4bac4e734666 core (xmpp): set message timestamp on message reception: Goffi <goffi@goffi.org> parents: 2983 diff changeset	22 import uuid
3173 343b8076e967 core (xmpp): new message key to handle attachments Goffi <goffi@goffi.org> parents: 3172 diff changeset	23 import mimetypes
3366 e09cb08166a3 plugin XEP-0329, core(xmpp): moved `_compParseJids` to `SatXMPPComponent`: Goffi <goffi@goffi.org> parents: 3316 diff changeset	24 from typing import Tuple
3175 b9a2dd4d750a core (xmpp): add `name` and `media_type` in attachements if they are missing. Goffi <goffi@goffi.org> parents: 3173 diff changeset	25 from urllib.parse import urlparse, unquote
2885 e9016bfd8cb2 core (xmpp): advanced handling of connection termination Goffi <goffi@goffi.org> parents: 2884 diff changeset	26 from functools import partial
3184 e8ce30798d15 core (xmpp): use pathlib.Path to complete attachments names, and use name to guess type Goffi <goffi@goffi.org> parents: 3183 diff changeset	27 from pathlib import Path
3149 f3700175c6a3 core (xmpp): use a stable resource (sat.[shortuuid]) instead of server one if nothing is specified Goffi <goffi@goffi.org> parents: 3138 diff changeset	28 import shortuuid
1053 71d63750963e core (XMPP): message received (onMessage) refactoring: Goffi <goffi@goffi.org> parents: 1037 diff changeset	29 from sat.core.i18n import _
923 e77948faaef3 core: removed default_config: Goffi <goffi@goffi.org> parents: 875 diff changeset	30 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	31 from sat.memory import cache
2885 e9016bfd8cb2 core (xmpp): advanced handling of connection termination Goffi <goffi@goffi.org> parents: 2884 diff changeset	32 from twisted.internet import defer, error as internet_error
3044 691283719bb2 core (patches): updated TLS patches: Goffi <goffi@goffi.org> parents: 3040 diff changeset	33 from twisted.internet import ssl
1955 633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished): Goffi <goffi@goffi.org> parents: 1934 diff changeset	34 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	35 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	36 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	37 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	38 from twisted.words.xish import domish
1955 633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished): Goffi <goffi@goffi.org> parents: 1934 diff changeset	39 from twisted.python import failure
1963 a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	40 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	41 from wokkel import component
1955 633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished): Goffi <goffi@goffi.org> parents: 1934 diff changeset	42 from wokkel import delay
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 960 diff changeset	43 from sat.core.log import getLogger
501 e9634d2e7b38 core, quick_frontend, primitivus, wix: Contacts List refactoring phase 1: Goffi <goffi@goffi.org> parents: 487 diff changeset	44 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	45 from sat.memory import encryption
2891 6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	46 from sat.memory import persistent
2687 e9cd473a2f46 core (xmpp): server certificate validation: Goffi <goffi@goffi.org> parents: 2661 diff changeset	47 from sat.tools import xml_tools
3238 199fc4c551e9 core (xmpp): use asDeferred for profileConnecting and profileConnected Goffi <goffi@goffi.org> parents: 3228 diff changeset	48 from sat.tools import utils
3170 39d7327583e1 core: use serialised dict for `extra` in messageNew and historyGet Goffi <goffi@goffi.org> parents: 3162 diff changeset	49 from sat.tools.common import data_format
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	50 from zope.interface import implementer
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	51
2891 6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	52 log = getLogger(__name__)
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	53
333 4c835d614bdb core: fixed a None sent instead of empty dict in unavailableReceived Goffi <goffi@goffi.org> parents: 330 diff changeset	54
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	55 NS_X_DATA = "jabber:x:data"
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	56 NS_DISCO_INFO = "http://jabber.org/protocol/disco#info"
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	57 NS_XML_ELEMENT = "urn:xmpp:xml-element"
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	58 NS_ROSTER_VER = "urn:xmpp:features:rosterver"
2891 6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	59 # we use 2 "@" which is illegal in a jid, to be sure we are not mixing keys
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	60 # with roster jids
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	61 ROSTER_VER_KEY = "@version@"
2688 943e78e18882 core (xmpp): added missing disco#info namespace to disco info result. Goffi <goffi@goffi.org> parents: 2687 diff changeset	62
943e78e18882 core (xmpp): added missing disco#info namespace to disco info result. Goffi <goffi@goffi.org> parents: 2687 diff changeset	63
3249 f16c96c7a91a core (xmpp): helper method to launch a plugin method: Goffi <goffi@goffi.org> parents: 3244 diff changeset	64 class ClientPluginWrapper:
f16c96c7a91a core (xmpp): helper method to launch a plugin method: Goffi <goffi@goffi.org> parents: 3244 diff changeset	65 """Use a plugin with default value if plugin is missing"""
f16c96c7a91a core (xmpp): helper method to launch a plugin method: Goffi <goffi@goffi.org> parents: 3244 diff changeset	66
f16c96c7a91a core (xmpp): helper method to launch a plugin method: Goffi <goffi@goffi.org> parents: 3244 diff changeset	67 def __init__(self, client, plugin_name, missing):
f16c96c7a91a core (xmpp): helper method to launch a plugin method: Goffi <goffi@goffi.org> parents: 3244 diff changeset	68 self.client = client
f16c96c7a91a core (xmpp): helper method to launch a plugin method: Goffi <goffi@goffi.org> parents: 3244 diff changeset	69 self.plugin = client.host_app.plugins.get(plugin_name)
f16c96c7a91a core (xmpp): helper method to launch a plugin method: Goffi <goffi@goffi.org> parents: 3244 diff changeset	70 if self.plugin is None:
f16c96c7a91a core (xmpp): helper method to launch a plugin method: Goffi <goffi@goffi.org> parents: 3244 diff changeset	71 self.plugin_name = plugin_name
f16c96c7a91a core (xmpp): helper method to launch a plugin method: Goffi <goffi@goffi.org> parents: 3244 diff changeset	72 self.missing = missing
f16c96c7a91a core (xmpp): helper method to launch a plugin method: Goffi <goffi@goffi.org> parents: 3244 diff changeset	73
f16c96c7a91a core (xmpp): helper method to launch a plugin method: Goffi <goffi@goffi.org> parents: 3244 diff changeset	74 def __getattr__(self, attr):
f16c96c7a91a core (xmpp): helper method to launch a plugin method: Goffi <goffi@goffi.org> parents: 3244 diff changeset	75 if self.plugin is None:
f16c96c7a91a core (xmpp): helper method to launch a plugin method: Goffi <goffi@goffi.org> parents: 3244 diff changeset	76 missing = self.missing
f16c96c7a91a core (xmpp): helper method to launch a plugin method: Goffi <goffi@goffi.org> parents: 3244 diff changeset	77 if isinstance(missing, type) and issubclass(missing, Exception):
f16c96c7a91a core (xmpp): helper method to launch a plugin method: Goffi <goffi@goffi.org> parents: 3244 diff changeset	78 raise missing(f"plugin {self.plugin_name!r} is not available")
f16c96c7a91a core (xmpp): helper method to launch a plugin method: Goffi <goffi@goffi.org> parents: 3244 diff changeset	79 elif isinstance(missing, Exception):
f16c96c7a91a core (xmpp): helper method to launch a plugin method: Goffi <goffi@goffi.org> parents: 3244 diff changeset	80 raise missing
f16c96c7a91a core (xmpp): helper method to launch a plugin method: Goffi <goffi@goffi.org> parents: 3244 diff changeset	81 else:
f16c96c7a91a core (xmpp): helper method to launch a plugin method: Goffi <goffi@goffi.org> parents: 3244 diff changeset	82 return lambda args, *kwargs: missing
f16c96c7a91a core (xmpp): helper method to launch a plugin method: Goffi <goffi@goffi.org> parents: 3244 diff changeset	83 return partial(getattr(self.plugin, attr), self.client)
f16c96c7a91a core (xmpp): helper method to launch a plugin method: Goffi <goffi@goffi.org> parents: 3244 diff changeset	84
f16c96c7a91a core (xmpp): helper method to launch a plugin method: Goffi <goffi@goffi.org> parents: 3244 diff changeset	85
3153 2c7b42f53e9a core (xmpp): avoid starting several clients at the same time: Goffi <goffi@goffi.org> parents: 3149 diff changeset	86 class SatXMPPEntity:
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	87 """Common code for Client and Component"""
3153 2c7b42f53e9a core (xmpp): avoid starting several clients at the same time: Goffi <goffi@goffi.org> parents: 3149 diff changeset	88 # profile is added there when startConnection begins and removed when it is finished
2c7b42f53e9a core (xmpp): avoid starting several clients at the same time: Goffi <goffi@goffi.org> parents: 3149 diff changeset	89 profiles_connecting = set()
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	90
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	91 def __init__(self, host_app, profile, max_retries):
2691 1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2688 diff changeset	92 factory = self.factory
2885 e9016bfd8cb2 core (xmpp): advanced handling of connection termination Goffi <goffi@goffi.org> parents: 2884 diff changeset	93
e9016bfd8cb2 core (xmpp): advanced handling of connection termination Goffi <goffi@goffi.org> parents: 2884 diff changeset	94 # we monkey patch clientConnectionLost to handle networkEnabled/networkDisabled
e9016bfd8cb2 core (xmpp): advanced handling of connection termination Goffi <goffi@goffi.org> parents: 2884 diff changeset	95 # and to allow plugins to tune reconnection mechanism
e9016bfd8cb2 core (xmpp): advanced handling of connection termination Goffi <goffi@goffi.org> parents: 2884 diff changeset	96 clientConnectionFailed_ori = factory.clientConnectionFailed
e9016bfd8cb2 core (xmpp): advanced handling of connection termination Goffi <goffi@goffi.org> parents: 2884 diff changeset	97 clientConnectionLost_ori = factory.clientConnectionLost
e9016bfd8cb2 core (xmpp): advanced handling of connection termination Goffi <goffi@goffi.org> parents: 2884 diff changeset	98 factory.clientConnectionFailed = partial(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	99 self.connectionTerminated, term_type="failed", cb=clientConnectionFailed_ori)
2885 e9016bfd8cb2 core (xmpp): advanced handling of connection termination Goffi <goffi@goffi.org> parents: 2884 diff changeset	100 factory.clientConnectionLost = partial(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	101 self.connectionTerminated, term_type="lost", cb=clientConnectionLost_ori)
2885 e9016bfd8cb2 core (xmpp): advanced handling of connection termination Goffi <goffi@goffi.org> parents: 2884 diff changeset	102
2691 1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2688 diff changeset	103 factory.maxRetries = max_retries
1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2688 diff changeset	104 factory.maxDelay = 30
1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2688 diff changeset	105 # 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	106 # 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	107 self._connected_d = None
62 93cb45a7420f SàT multi-profile: connection using profiles Goffi <goffi@goffi.org> parents: 60 diff changeset	108 self.profile = profile
64 d46f849664aa SàT: multi-profile, plugins updated Goffi <goffi@goffi.org> parents: 63 diff changeset	109 self.host_app = host_app
2109 85f3e12e984d core (memory/cache): file caching handling, first draft: Goffi <goffi@goffi.org> parents: 2099 diff changeset	110 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	111 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	112 # Key: (full_jid, message_id) Value: uid
2691 1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2688 diff changeset	113 # this Deferred fire when entity is connected
341 9eebdc655b8b code: added asyncConnect Goffi <goffi@goffi.org> parents: 336 diff changeset	114 self.conn_deferred = defer.Deferred()
2643 189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	115 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	116 # (key = progress id)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	117 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	118 self.encryption = encryption.EncryptionHandler(self)
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	119
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	120 def __str__(self):
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	121 return f"Client for profile {self.profile}"
2742 1f5b02623355 core (xmpp): implemented human friendly __unicode__ for client Goffi <goffi@goffi.org> parents: 2736 diff changeset	122
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	123 def __repr__(self):
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	124 return f"{super().__repr__()} - profile: {self.profile!r}"
2742 1f5b02623355 core (xmpp): implemented human friendly __unicode__ for client Goffi <goffi@goffi.org> parents: 2736 diff changeset	125
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	126 ## initialisation ##
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	127
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	128 @defer.inlineCallbacks
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	129 def _callConnectionTriggers(self):
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	130 """Call conneting trigger prepare connected trigger
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	131
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	132 @param plugins(iterable): plugins to use
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	133 @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	134 - plugin instance
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	135 - profileConnected* triggers (to call after connection)
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	136 """
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	137 plugin_conn_cb = []
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	138 for plugin in self._getPluginsList():
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	139 # we check if plugin handle client mode
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	140 if plugin.is_handler:
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	141 plugin.getHandler(self).setHandlerParent(self)
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	142
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	143 # profileConnecting/profileConnected methods handling
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	144
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	145 # profile connecting is called right now (before actually starting client)
2498 d6de69da3dd4 core (client): component improvments: Goffi <goffi@goffi.org> parents: 2497 diff changeset	146 connecting_cb = getattr(plugin, "profileConnecting", None)
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	147 if connecting_cb is not None:
3238 199fc4c551e9 core (xmpp): use asDeferred for profileConnecting and profileConnected Goffi <goffi@goffi.org> parents: 3228 diff changeset	148 yield utils.asDeferred(connecting_cb, self)
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	149
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	150 # 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	151 connected_cb = getattr(plugin, "profileConnected", None)
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	152 if connected_cb is not None:
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	153 plugin_conn_cb.append((plugin, connected_cb))
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 defer.returnValue(plugin_conn_cb)
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 def _getPluginsList(self):
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	158 """Return list of plugin to use
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	159
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	160 need to be implemented by subclasses
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	161 this list is used to call profileConnect* triggers
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	162 @return(iterable[object]): plugins to use
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	163 """
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	164 raise NotImplementedError
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 def _createSubProtocols(self):
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	167 return
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	168
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	169 def entityConnected(self):
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	170 """Called once connection is done
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	171
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	172 may return a Deferred, to perform initialisation tasks
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 return
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	175
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	176 @classmethod
3224 0404b306641d core (xmpp): use async corouting for startConnection Goffi <goffi@goffi.org> parents: 3221 diff changeset	177 async def startConnection(cls, host, profile, max_retries):
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	178 """instantiate the entity and start the connection"""
2643 189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	179 # FIXME: reconnection doesn't seems to be handled correclty
189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	180 # (client is deleted then recreated from scratch)
189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	181 # 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	182 # (e.g. adding subprotocols)
189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	183 # 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	184 # (independently of connection/deconnection)
3153 2c7b42f53e9a core (xmpp): avoid starting several clients at the same time: Goffi <goffi@goffi.org> parents: 3149 diff changeset	185 if profile in cls.profiles_connecting:
2c7b42f53e9a core (xmpp): avoid starting several clients at the same time: Goffi <goffi@goffi.org> parents: 3149 diff changeset	186 raise exceptions.CancelError(f"{profile} is already being connected")
2c7b42f53e9a core (xmpp): avoid starting several clients at the same time: Goffi <goffi@goffi.org> parents: 3149 diff changeset	187 cls.profiles_connecting.add(profile)
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	188 try:
3244 b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	189 try:
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	190 port = int(
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	191 host.memory.getParamA(
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	192 C.FORCE_PORT_PARAM, "Connection", profile_key=profile
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	193 )
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	194 )
3244 b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	195 except ValueError:
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	196 log.debug(_("Can't parse port value, using default value"))
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	197 port = (
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	198 None
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	199 ) # will use default value 5222 or be retrieved from a DNS SRV record
3149 f3700175c6a3 core (xmpp): use a stable resource (sat.[shortuuid]) instead of server one if nothing is specified Goffi <goffi@goffi.org> parents: 3138 diff changeset	200
3244 b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	201 password = await host.memory.asyncGetParamA(
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	202 "Password", "Connection", profile_key=profile
2691 1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2688 diff changeset	203 )
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	204
3244 b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	205 entity_jid_s = await host.memory.asyncGetParamA(
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	206 "JabberID", "Connection", profile_key=profile)
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	207 entity_jid = jid.JID(entity_jid_s)
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	208
3244 b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	209 if not entity_jid.resource and not cls.is_component and entity_jid.user:
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	210 # if no resource is specified, we create our own instead of using
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	211 # server returned one, as it will then stay stable in case of
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	212 # reconnection. we only do that for client and if there is a user part, to
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	213 # let server decide for anonymous login
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	214 resource_dict = await host.memory.storage.getPrivates(
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	215 "core:xmpp", ["resource"] , profile=profile)
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	216 try:
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	217 resource = resource_dict["resource"]
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	218 except KeyError:
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	219 resource = f"{C.APP_NAME_FILE}.{shortuuid.uuid()}"
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	220 await host.memory.storage.setPrivateValue(
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	221 "core:xmpp", "resource", resource, profile=profile)
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	222
3244 b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	223 log.info(_("We'll use the stable resource {resource}").format(
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	224 resource=resource))
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	225 entity_jid.resource = resource
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	226
3244 b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	227 if profile in host.profiles:
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	228 if host.profiles[profile].isConnected():
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	229 raise exceptions.InternalError(
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	230 f"There is already a connected profile of name {profile!r} in "
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	231 f"host")
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	232 log.debug(
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	233 "removing unconnected profile {profile!r}")
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	234 del host.profiles[profile]
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	235 entity = host.profiles[profile] = cls(
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	236 host, profile, entity_jid, password,
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	237 host.memory.getParamA(C.FORCE_SERVER_PARAM, "Connection",
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	238 profile_key=profile) or None,
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	239 port, max_retries,
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	240 )
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	241
3244 b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	242 await entity.encryption.loadSessions()
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	243
3244 b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	244 entity._createSubProtocols()
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	245
3244 b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	246 entity.fallBack = SatFallbackHandler(host)
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	247 entity.fallBack.setHandlerParent(entity)
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	248
3244 b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	249 entity.versionHandler = SatVersionHandler(C.APP_NAME_FULL, host.full_version)
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	250 entity.versionHandler.setHandlerParent(entity)
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	251
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	252 entity.identityHandler = SatIdentityHandler()
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	253 entity.identityHandler.setHandlerParent(entity)
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	254
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	255 log.debug(_("setting plugins parents"))
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	256
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	257 plugin_conn_cb = await entity._callConnectionTriggers()
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	258
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	259 entity.startService()
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	260
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	261 await entity.conn_deferred
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	262
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	263 await defer.maybeDeferred(entity.entityConnected)
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	264
3244 b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	265 # Call profileConnected callback for all plugins,
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	266 # and print error message if any of them fails
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	267 conn_cb_list = []
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	268 for __, callback in plugin_conn_cb:
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	269 conn_cb_list.append(utils.asDeferred(callback, entity))
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	270 list_d = defer.DeferredList(conn_cb_list)
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	271
3244 b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	272 def logPluginResults(results):
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	273 all_succeed = all([success for success, result in results])
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	274 if not all_succeed:
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	275 log.error(_("Plugins initialisation error"))
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	276 for idx, (success, result) in enumerate(results):
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	277 if not success:
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	278 log.error(
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	279 "error (plugin %(name)s): %(failure)s"
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	280 % {
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	281 "name": plugin_conn_cb[idx][0]._info["import_name"],
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	282 "failure": result,
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	283 }
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	284 )
341 9eebdc655b8b code: added asyncConnect Goffi <goffi@goffi.org> parents: 336 diff changeset	285
3244 b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	286 await list_d.addCallback(
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	287 logPluginResults
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	288 ) # FIXME: we should have a timeout here, and a way to know if a plugin freeze
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	289 # TODO: mesure launch time of each plugin
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	290 finally:
b10d207f95f9 core (xmpp): properly clean profile data in case of startConnection failure: Goffi <goffi@goffi.org> parents: 3238 diff changeset	291 cls.profiles_connecting.remove(profile)
3153 2c7b42f53e9a core (xmpp): avoid starting several clients at the same time: Goffi <goffi@goffi.org> parents: 3149 diff changeset	292
2643 189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	293 def _disconnectionCb(self, __):
2691 1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2688 diff changeset	294 self._connected_d = None
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	295
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	296 def _disconnectionEb(self, failure_):
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	297 log.error(_("Error while disconnecting: {}".format(failure_)))
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	298
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	299 def _authd(self, xmlstream):
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	300 super(SatXMPPEntity, self)._authd(xmlstream)
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	301 log.debug(_("{profile} identified").format(profile=self.profile))
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	302 self.streamInitialized()
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	303
2643 189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	304 def _finish_connection(self, __):
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	305 self.conn_deferred.callback(None)
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	306
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	307 def streamInitialized(self):
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	308 """Called after _authd"""
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	309 log.debug(_("XML stream is initialized"))
2691 1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2688 diff changeset	310 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	311 return
1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2688 diff changeset	312 self.postStreamInit()
1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2688 diff changeset	313
1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2688 diff changeset	314 def postStreamInit(self):
1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2688 diff changeset	315 """Workflow after stream initalisation."""
1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2688 diff changeset	316 log.info(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	317 _("******** [{profile}] CONNECTED ********").format(profile=self.profile)
2691 1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2688 diff changeset	318 )
1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2688 diff changeset	319
1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2688 diff changeset	320 # 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	321 # 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	322 self._connected_d = defer.Deferred()
1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2688 diff changeset	323 self._connected_d.addCallback(self._cleanConnection)
1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2688 diff changeset	324 self._connected_d.addCallback(self._disconnectionCb)
1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2688 diff changeset	325 self._connected_d.addErrback(self._disconnectionEb)
1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2688 diff changeset	326
2894 c7c52c0dc13a core, quick_frontend(app): fixed connected signal handling Goffi <goffi@goffi.org> parents: 2892 diff changeset	327 # we send the signal to the clients
c7c52c0dc13a core, quick_frontend(app): fixed connected signal handling Goffi <goffi@goffi.org> parents: 2892 diff changeset	328 self.host_app.bridge.connected(self.jid.full(), self.profile)
2691 1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2688 diff changeset	329
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	330 self.disco = SatDiscoProtocol(self)
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	331 self.disco.setHandlerParent(self)
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	332 self.discoHandler = disco.DiscoHandler()
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	333 self.discoHandler.setHandlerParent(self)
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	334 disco_d = defer.succeed(None)
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	335
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	336 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	337 return
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	338
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	339 disco_d.addCallback(self._finish_connection)
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	340
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	341 def initializationFailed(self, reason):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	342 log.error(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	343 _(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	344 "ERROR: XMPP connection failed for profile '%(profile)s': %(reason)s"
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	345 % {"profile": self.profile, "reason": reason}
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	346 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	347 )
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	348 self.conn_deferred.errback(reason.value)
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	349 try:
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	350 super(SatXMPPEntity, self).initializationFailed(reason)
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	351 except:
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	352 # 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	353 pass
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	354
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	355 ## connection ##
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	356
2885 e9016bfd8cb2 core (xmpp): advanced handling of connection termination Goffi <goffi@goffi.org> parents: 2884 diff changeset	357 def connectionTerminated(self, connector, reason, term_type, cb):
e9016bfd8cb2 core (xmpp): advanced handling of connection termination Goffi <goffi@goffi.org> parents: 2884 diff changeset	358 """Display disconnection reason, and call factory method
e9016bfd8cb2 core (xmpp): advanced handling of connection termination Goffi <goffi@goffi.org> parents: 2884 diff changeset	359
e9016bfd8cb2 core (xmpp): advanced handling of connection termination Goffi <goffi@goffi.org> parents: 2884 diff changeset	360 This method is monkey patched to factory, allowing plugins to handle finely
e9016bfd8cb2 core (xmpp): advanced handling of connection termination Goffi <goffi@goffi.org> parents: 2884 diff changeset	361 reconnection with the triggers.
e9016bfd8cb2 core (xmpp): advanced handling of connection termination Goffi <goffi@goffi.org> parents: 2884 diff changeset	362 @param connector(twisted.internet.base.BaseConnector): current connector
e9016bfd8cb2 core (xmpp): advanced handling of connection termination Goffi <goffi@goffi.org> parents: 2884 diff changeset	363 @param reason(failure.Failure): why connection has been terminated
e9016bfd8cb2 core (xmpp): advanced handling of connection termination Goffi <goffi@goffi.org> parents: 2884 diff changeset	364 @param term_type(unicode): on of 'failed' or 'lost'
e9016bfd8cb2 core (xmpp): advanced handling of connection termination Goffi <goffi@goffi.org> parents: 2884 diff changeset	365 @param cb(callable): original factory method
e9016bfd8cb2 core (xmpp): advanced handling of connection termination Goffi <goffi@goffi.org> parents: 2884 diff changeset	366
e9016bfd8cb2 core (xmpp): advanced handling of connection termination Goffi <goffi@goffi.org> parents: 2884 diff changeset	367 @trigger connection_failed(connector, reason): connection can't be established
e9016bfd8cb2 core (xmpp): advanced handling of connection termination Goffi <goffi@goffi.org> parents: 2884 diff changeset	368 @trigger connection_lost(connector, reason): connection was available but it not
e9016bfd8cb2 core (xmpp): advanced handling of connection termination Goffi <goffi@goffi.org> parents: 2884 diff changeset	369 anymore
e9016bfd8cb2 core (xmpp): advanced handling of connection termination Goffi <goffi@goffi.org> parents: 2884 diff changeset	370 """
e9016bfd8cb2 core (xmpp): advanced handling of connection termination Goffi <goffi@goffi.org> parents: 2884 diff changeset	371 # we save connector because it may be deleted when connection will be dropped
e9016bfd8cb2 core (xmpp): advanced handling of connection termination Goffi <goffi@goffi.org> parents: 2884 diff changeset	372 # if reconnection is disabled
e9016bfd8cb2 core (xmpp): advanced handling of connection termination Goffi <goffi@goffi.org> parents: 2884 diff changeset	373 self._saved_connector = connector
e9016bfd8cb2 core (xmpp): advanced handling of connection termination Goffi <goffi@goffi.org> parents: 2884 diff changeset	374 if reason is not None and not isinstance(reason.value,
e9016bfd8cb2 core (xmpp): advanced handling of connection termination Goffi <goffi@goffi.org> parents: 2884 diff changeset	375 internet_error.ConnectionDone):
e9016bfd8cb2 core (xmpp): advanced handling of connection termination Goffi <goffi@goffi.org> parents: 2884 diff changeset	376 try:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	377 reason_str = str(reason.value)
2885 e9016bfd8cb2 core (xmpp): advanced handling of connection termination Goffi <goffi@goffi.org> parents: 2884 diff changeset	378 except Exception:
e9016bfd8cb2 core (xmpp): advanced handling of connection termination Goffi <goffi@goffi.org> parents: 2884 diff changeset	379 # FIXME: workaround for Android were p4a strips docstrings
e9016bfd8cb2 core (xmpp): advanced handling of connection termination Goffi <goffi@goffi.org> parents: 2884 diff changeset	380 # while Twisted use docstring in __str__
e9016bfd8cb2 core (xmpp): advanced handling of connection termination Goffi <goffi@goffi.org> parents: 2884 diff changeset	381 # TODO: create a ticket upstream, Twisted should work when optimization
e9016bfd8cb2 core (xmpp): advanced handling of connection termination Goffi <goffi@goffi.org> parents: 2884 diff changeset	382 # is used
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	383 reason_str = str(reason.value.__class__)
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	384 log.warning("Connection {term_type}: {reason}".format(
2885 e9016bfd8cb2 core (xmpp): advanced handling of connection termination Goffi <goffi@goffi.org> parents: 2884 diff changeset	385 term_type = term_type,
e9016bfd8cb2 core (xmpp): advanced handling of connection termination Goffi <goffi@goffi.org> parents: 2884 diff changeset	386 reason=reason_str))
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	387 if not self.host_app.trigger.point("connection_" + term_type, connector, reason):
2885 e9016bfd8cb2 core (xmpp): advanced handling of connection termination Goffi <goffi@goffi.org> parents: 2884 diff changeset	388 return
e9016bfd8cb2 core (xmpp): advanced handling of connection termination Goffi <goffi@goffi.org> parents: 2884 diff changeset	389 return cb(connector, reason)
e9016bfd8cb2 core (xmpp): advanced handling of connection termination Goffi <goffi@goffi.org> parents: 2884 diff changeset	390
2886 b06cb71079fa core (xmpp): new networkEnabled() and networkDisabled() methods: Goffi <goffi@goffi.org> parents: 2885 diff changeset	391 def networkDisabled(self):
b06cb71079fa core (xmpp): new networkEnabled() and networkDisabled() methods: Goffi <goffi@goffi.org> parents: 2885 diff changeset	392 """Indicate that network has been completely disabled
b06cb71079fa core (xmpp): new networkEnabled() and networkDisabled() methods: Goffi <goffi@goffi.org> parents: 2885 diff changeset	393
b06cb71079fa core (xmpp): new networkEnabled() and networkDisabled() methods: Goffi <goffi@goffi.org> parents: 2885 diff changeset	394 In other words, internet is not available anymore and transport must be stopped.
b06cb71079fa core (xmpp): new networkEnabled() and networkDisabled() methods: Goffi <goffi@goffi.org> parents: 2885 diff changeset	395 Retrying is disabled too, as it makes no sense to try without network, and it may
b06cb71079fa core (xmpp): new networkEnabled() and networkDisabled() methods: Goffi <goffi@goffi.org> parents: 2885 diff changeset	396 use resources (notably battery on mobiles).
b06cb71079fa core (xmpp): new networkEnabled() and networkDisabled() methods: Goffi <goffi@goffi.org> parents: 2885 diff changeset	397 """
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	398 log.info(_("stopping connection because of network disabled"))
2886 b06cb71079fa core (xmpp): new networkEnabled() and networkDisabled() methods: Goffi <goffi@goffi.org> parents: 2885 diff changeset	399 self.factory.continueTrying = 0
b06cb71079fa core (xmpp): new networkEnabled() and networkDisabled() methods: Goffi <goffi@goffi.org> parents: 2885 diff changeset	400 self._network_disabled = True
b06cb71079fa core (xmpp): new networkEnabled() and networkDisabled() methods: Goffi <goffi@goffi.org> parents: 2885 diff changeset	401 if self.xmlstream is not None:
b06cb71079fa core (xmpp): new networkEnabled() and networkDisabled() methods: Goffi <goffi@goffi.org> parents: 2885 diff changeset	402 self.xmlstream.transport.abortConnection()
b06cb71079fa core (xmpp): new networkEnabled() and networkDisabled() methods: Goffi <goffi@goffi.org> parents: 2885 diff changeset	403
b06cb71079fa core (xmpp): new networkEnabled() and networkDisabled() methods: Goffi <goffi@goffi.org> parents: 2885 diff changeset	404 def networkEnabled(self):
b06cb71079fa core (xmpp): new networkEnabled() and networkDisabled() methods: Goffi <goffi@goffi.org> parents: 2885 diff changeset	405 """Indicate that network has been (re)enabled
b06cb71079fa core (xmpp): new networkEnabled() and networkDisabled() methods: Goffi <goffi@goffi.org> parents: 2885 diff changeset	406
b06cb71079fa core (xmpp): new networkEnabled() and networkDisabled() methods: Goffi <goffi@goffi.org> parents: 2885 diff changeset	407 This happens when e.g. user activate WIFI connection.
b06cb71079fa core (xmpp): new networkEnabled() and networkDisabled() methods: Goffi <goffi@goffi.org> parents: 2885 diff changeset	408 """
b06cb71079fa core (xmpp): new networkEnabled() and networkDisabled() methods: Goffi <goffi@goffi.org> parents: 2885 diff changeset	409 try:
b06cb71079fa core (xmpp): new networkEnabled() and networkDisabled() methods: Goffi <goffi@goffi.org> parents: 2885 diff changeset	410 connector = self._saved_connector
b06cb71079fa core (xmpp): new networkEnabled() and networkDisabled() methods: Goffi <goffi@goffi.org> parents: 2885 diff changeset	411 network_disabled = self._network_disabled
b06cb71079fa core (xmpp): new networkEnabled() and networkDisabled() methods: Goffi <goffi@goffi.org> parents: 2885 diff changeset	412 except AttributeError:
b06cb71079fa core (xmpp): new networkEnabled() and networkDisabled() methods: Goffi <goffi@goffi.org> parents: 2885 diff changeset	413 # connection has not been stopped by networkDisabled
b06cb71079fa core (xmpp): new networkEnabled() and networkDisabled() methods: Goffi <goffi@goffi.org> parents: 2885 diff changeset	414 # we don't have to restart it
3125 c3ce8c997fdf plugin android: reconnect profiles with autoconnect if network is activated: Goffi <goffi@goffi.org> parents: 3059 diff changeset	415 log.debug(f"no connection to restart [{self.profile}]")
2886 b06cb71079fa core (xmpp): new networkEnabled() and networkDisabled() methods: Goffi <goffi@goffi.org> parents: 2885 diff changeset	416 return
b06cb71079fa core (xmpp): new networkEnabled() and networkDisabled() methods: Goffi <goffi@goffi.org> parents: 2885 diff changeset	417 else:
b06cb71079fa core (xmpp): new networkEnabled() and networkDisabled() methods: Goffi <goffi@goffi.org> parents: 2885 diff changeset	418 del self._network_disabled
b06cb71079fa core (xmpp): new networkEnabled() and networkDisabled() methods: Goffi <goffi@goffi.org> parents: 2885 diff changeset	419 if not network_disabled:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	420 raise exceptions.InternalError("network_disabled should be True")
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	421 log.info(_("network is available, trying to connect"))
2886 b06cb71079fa core (xmpp): new networkEnabled() and networkDisabled() methods: Goffi <goffi@goffi.org> parents: 2885 diff changeset	422 # we want to be sure to start fresh
b06cb71079fa core (xmpp): new networkEnabled() and networkDisabled() methods: Goffi <goffi@goffi.org> parents: 2885 diff changeset	423 self.factory.resetDelay()
b06cb71079fa core (xmpp): new networkEnabled() and networkDisabled() methods: Goffi <goffi@goffi.org> parents: 2885 diff changeset	424 # we have a saved connector, meaning the connection has been stopped previously
b06cb71079fa core (xmpp): new networkEnabled() and networkDisabled() methods: Goffi <goffi@goffi.org> parents: 2885 diff changeset	425 # we can now try to reconnect
b06cb71079fa core (xmpp): new networkEnabled() and networkDisabled() methods: Goffi <goffi@goffi.org> parents: 2885 diff changeset	426 connector.connect()
b06cb71079fa core (xmpp): new networkEnabled() and networkDisabled() methods: Goffi <goffi@goffi.org> parents: 2885 diff changeset	427
2691 1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2688 diff changeset	428 def _connected(self, xs):
1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2688 diff changeset	429 send_hooks = []
1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2688 diff changeset	430 receive_hooks = []
1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2688 diff changeset	431 self.host_app.trigger.point(
1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2688 diff changeset	432 "stream_hooks", self, receive_hooks, send_hooks)
1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2688 diff changeset	433 for hook in receive_hooks:
1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2688 diff changeset	434 xs.addHook(C.STREAM_HOOK_RECEIVE, hook)
1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2688 diff changeset	435 for hook in send_hooks:
1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2688 diff changeset	436 xs.addHook(C.STREAM_HOOK_SEND, hook)
1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2688 diff changeset	437 super(SatXMPPEntity, self)._connected(xs)
2687 e9cd473a2f46 core (xmpp): server certificate validation: Goffi <goffi@goffi.org> parents: 2661 diff changeset	438
2691 1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2688 diff changeset	439 def disconnectProfile(self, reason):
1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2688 diff changeset	440 if self._connected_d is not None:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	441 self.host_app.bridge.disconnected(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	442 self.profile
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	443 ) # we send the signal to the clients
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	444 log.info(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	445 _("******** [{profile}] DISCONNECTED ********").format(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	446 profile=self.profile
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	447 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	448 )
3135 b9395c4df8b9 core (xmpp): don't purge entity on disconnect if continueTrying is set Goffi <goffi@goffi.org> parents: 3125 diff changeset	449 # we purge only if no new connection attempt is expected
b9395c4df8b9 core (xmpp): don't purge entity on disconnect if continueTrying is set Goffi <goffi@goffi.org> parents: 3125 diff changeset	450 if not self.factory.continueTrying:
b9395c4df8b9 core (xmpp): don't purge entity on disconnect if continueTrying is set Goffi <goffi@goffi.org> parents: 3125 diff changeset	451 log.debug("continueTrying not set, purging entity")
b9395c4df8b9 core (xmpp): don't purge entity on disconnect if continueTrying is set Goffi <goffi@goffi.org> parents: 3125 diff changeset	452 self._connected_d.callback(None)
b9395c4df8b9 core (xmpp): don't purge entity on disconnect if continueTrying is set Goffi <goffi@goffi.org> parents: 3125 diff changeset	453 # and we remove references to this client
b9395c4df8b9 core (xmpp): don't purge entity on disconnect if continueTrying is set Goffi <goffi@goffi.org> parents: 3125 diff changeset	454 self.host_app.purgeEntity(self.profile)
b9395c4df8b9 core (xmpp): don't purge entity on disconnect if continueTrying is set Goffi <goffi@goffi.org> parents: 3125 diff changeset	455
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	456 if not self.conn_deferred.called:
2691 1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2688 diff changeset	457 if reason is None:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	458 err = error.StreamError("Server unexpectedly closed the connection")
2687 e9cd473a2f46 core (xmpp): server certificate validation: Goffi <goffi@goffi.org> parents: 2661 diff changeset	459 else:
2691 1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2688 diff changeset	460 err = reason
2687 e9cd473a2f46 core (xmpp): server certificate validation: Goffi <goffi@goffi.org> parents: 2661 diff changeset	461 try:
e9cd473a2f46 core (xmpp): server certificate validation: Goffi <goffi@goffi.org> parents: 2661 diff changeset	462 if err.value.args[0][0][2] == "certificate verify failed":
e9cd473a2f46 core (xmpp): server certificate validation: Goffi <goffi@goffi.org> parents: 2661 diff changeset	463 err = exceptions.InvalidCertificate(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	464 _("Your server certificate is not valid "
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	465 "(its identity can't be checked).\n\n"
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	466 "This should never happen and may indicate that "
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	467 "somebody is trying to spy on you.\n"
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	468 "Please contact your server administrator."))
2884 368a60f05d0e core (xmpp): use the cleaner stopTrying() instead of setting `continueTrying = 0` when connection is not possible due to invalid certificate. Goffi <goffi@goffi.org> parents: 2820 diff changeset	469 self.factory.stopTrying()
2886 b06cb71079fa core (xmpp): new networkEnabled() and networkDisabled() methods: Goffi <goffi@goffi.org> parents: 2885 diff changeset	470 try:
b06cb71079fa core (xmpp): new networkEnabled() and networkDisabled() methods: Goffi <goffi@goffi.org> parents: 2885 diff changeset	471 # with invalid certificate, we should not retry to connect
b06cb71079fa core (xmpp): new networkEnabled() and networkDisabled() methods: Goffi <goffi@goffi.org> parents: 2885 diff changeset	472 # so we delete saved connector to avoid reconnection if
b06cb71079fa core (xmpp): new networkEnabled() and networkDisabled() methods: Goffi <goffi@goffi.org> parents: 2885 diff changeset	473 # networkEnabled is called.
b06cb71079fa core (xmpp): new networkEnabled() and networkDisabled() methods: Goffi <goffi@goffi.org> parents: 2885 diff changeset	474 del self._saved_connector
b06cb71079fa core (xmpp): new networkEnabled() and networkDisabled() methods: Goffi <goffi@goffi.org> parents: 2885 diff changeset	475 except AttributeError:
b06cb71079fa core (xmpp): new networkEnabled() and networkDisabled() methods: Goffi <goffi@goffi.org> parents: 2885 diff changeset	476 pass
2687 e9cd473a2f46 core (xmpp): server certificate validation: Goffi <goffi@goffi.org> parents: 2661 diff changeset	477 except (IndexError, TypeError):
e9cd473a2f46 core (xmpp): server certificate validation: Goffi <goffi@goffi.org> parents: 2661 diff changeset	478 pass
e9cd473a2f46 core (xmpp): server certificate validation: Goffi <goffi@goffi.org> parents: 2661 diff changeset	479 self.conn_deferred.errback(err)
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	480
2691 1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2688 diff changeset	481 def _disconnected(self, reason):
1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2688 diff changeset	482 super(SatXMPPEntity, self)._disconnected(reason)
1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2688 diff changeset	483 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	484 return
1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2688 diff changeset	485 self.disconnectProfile(reason)
1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2688 diff changeset	486
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	487 @defer.inlineCallbacks
2643 189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	488 def _cleanConnection(self, __):
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	489 """method called on disconnection
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	490
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	491 used to call profileDisconnected* triggers
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	492 """
2498 d6de69da3dd4 core (client): component improvments: Goffi <goffi@goffi.org> parents: 2497 diff changeset	493 trigger_name = "profileDisconnected"
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	494 for plugin in self._getPluginsList():
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	495 disconnected_cb = getattr(plugin, trigger_name, None)
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	496 if disconnected_cb is not None:
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	497 yield disconnected_cb(self)
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	498
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	499 def isConnected(self):
3203 fee8e33e2b3f core (xmpp): isConnected now returns True when full connection is done: Goffi <goffi@goffi.org> parents: 3197 diff changeset	500 """Return True is client is fully connected
fee8e33e2b3f core (xmpp): isConnected now returns True when full connection is done: Goffi <goffi@goffi.org> parents: 3197 diff changeset	501
fee8e33e2b3f core (xmpp): isConnected now returns True when full connection is done: Goffi <goffi@goffi.org> parents: 3197 diff changeset	502 client is considered fully connected if transport is started and all plugins
fee8e33e2b3f core (xmpp): isConnected now returns True when full connection is done: Goffi <goffi@goffi.org> parents: 3197 diff changeset	503 are initialised
fee8e33e2b3f core (xmpp): isConnected now returns True when full connection is done: Goffi <goffi@goffi.org> parents: 3197 diff changeset	504 """
2691 1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2688 diff changeset	505 try:
3203 fee8e33e2b3f core (xmpp): isConnected now returns True when full connection is done: Goffi <goffi@goffi.org> parents: 3197 diff changeset	506 transport_connected = bool(self.xmlstream.transport.connected)
2691 1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2688 diff changeset	507 except AttributeError:
1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2688 diff changeset	508 return False
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	509
3203 fee8e33e2b3f core (xmpp): isConnected now returns True when full connection is done: Goffi <goffi@goffi.org> parents: 3197 diff changeset	510 return self._connected_d is not None and transport_connected
fee8e33e2b3f core (xmpp): isConnected now returns True when full connection is done: Goffi <goffi@goffi.org> parents: 3197 diff changeset	511
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	512 def entityDisconnect(self):
2691 1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2688 diff changeset	513 if not self.host_app.trigger.point("disconnecting", self):
1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2688 diff changeset	514 return
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	515 log.info(_("Disconnecting..."))
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	516 self.stopService()
2691 1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2688 diff changeset	517 if self._connected_d is not None:
1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2688 diff changeset	518 return self._connected_d
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	519 else:
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	520 return defer.succeed(None)
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 ## sending ##
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	523
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	524 def IQ(self, type_="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	525 """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	526
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	527 @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	528 @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	529 @return((D)domish.Element: result stanza
3221 b1c90eedbc12 core (xmpp): fixed workflow with post_xml_treatments in sendMessage: Goffi <goffi@goffi.org> parents: 3203 diff changeset	530 errback is called if an 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	531 """
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	532 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	533 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	534 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	535
3316 5369ce5bcecf core (xmpp): text can now be specified in `sendError` Goffi <goffi@goffi.org> parents: 3254 diff changeset	536 def sendError(self, iq_elt, condition, text=None):
1573 6338677f3a89 core (client): added a sendError method to easily build error response from <IQ\> stanza Goffi <goffi@goffi.org> parents: 1564 diff changeset	537 """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	538
6338677f3a89 core (client): added a sendError method to easily build error response from <IQ\> stanza Goffi <goffi@goffi.org> parents: 1564 diff changeset	539 @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	540 @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	541 """
3316 5369ce5bcecf core (xmpp): text can now be specified in `sendError` Goffi <goffi@goffi.org> parents: 3254 diff changeset	542 iq_error_elt = error.StanzaError(condition, text=text).toResponse(iq_elt)
1573 6338677f3a89 core (client): added a sendError method to easily build error response from <IQ\> stanza Goffi <goffi@goffi.org> parents: 1564 diff changeset	543 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	544
3221 b1c90eedbc12 core (xmpp): fixed workflow with post_xml_treatments in sendMessage: Goffi <goffi@goffi.org> parents: 3203 diff changeset	545 def generateMessageXML(self, data, post_xml_treatments=None):
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	546 """Generate <message/> stanza from message data
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	547
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	548 @param data(dict): message data
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	549 domish element will be put in data['xml']
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	550 following keys are needed:
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	551 - from
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	552 - to
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	553 - 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	554 - message
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	555 - type
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	556 - subject
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	557 - extra
3221 b1c90eedbc12 core (xmpp): fixed workflow with post_xml_treatments in sendMessage: Goffi <goffi@goffi.org> parents: 3203 diff changeset	558 @param post_xml_treatments(Deferred): a Deferred which will be called with data
b1c90eedbc12 core (xmpp): fixed workflow with post_xml_treatments in sendMessage: Goffi <goffi@goffi.org> parents: 3203 diff changeset	559 one XML is generated
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	560 @return (dict) message data
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	561 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	562 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	563 message_elt["to"] = data["to"].full()
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	564 message_elt["from"] = data["from"].full()
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	565 message_elt["type"] = data["type"]
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	566 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	567 # by a plugin to avoid id on purpose
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	568 message_elt["id"] = data["uid"]
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	569 for lang, subject in data["subject"].items():
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	570 subject_elt = message_elt.addElement("subject", content=subject)
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	571 if lang:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	572 subject_elt[(C.NS_XML, "lang")] = lang
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	573 for lang, message in data["message"].items():
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	574 body_elt = message_elt.addElement("body", content=message)
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	575 if lang:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	576 body_elt[(C.NS_XML, "lang")] = lang
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	577 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	578 thread = data["extra"]["thread"]
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	579 except KeyError:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	580 if "thread_parent" in data["extra"]:
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	581 raise exceptions.InternalError(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	582 "thread_parent found while there is not associated thread"
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	583 )
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	584 else:
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	585 thread_elt = message_elt.addElement("thread", content=thread)
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	586 try:
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	587 thread_elt["parent"] = data["extra"]["thread_parent"]
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	588 except KeyError:
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	589 pass
3221 b1c90eedbc12 core (xmpp): fixed workflow with post_xml_treatments in sendMessage: Goffi <goffi@goffi.org> parents: 3203 diff changeset	590
b1c90eedbc12 core (xmpp): fixed workflow with post_xml_treatments in sendMessage: Goffi <goffi@goffi.org> parents: 3203 diff changeset	591 if post_xml_treatments is not None:
b1c90eedbc12 core (xmpp): fixed workflow with post_xml_treatments in sendMessage: Goffi <goffi@goffi.org> parents: 3203 diff changeset	592 post_xml_treatments.callback(data)
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	593 return data
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	594
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	595 def addPostXmlCallbacks(self, post_xml_treatments):
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	596 """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	597
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	598 @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	599 """
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	600 raise NotImplementedError
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	601
3179 84a94b385760 bridge: messageSend's extra is now serialised Goffi <goffi@goffi.org> parents: 3175 diff changeset	602 def sendMessage(
84a94b385760 bridge: messageSend's extra is now serialised Goffi <goffi@goffi.org> parents: 3175 diff changeset	603 self, to_jid, message, subject=None, mess_type="auto", extra=None, uid=None,
84a94b385760 bridge: messageSend's extra is now serialised Goffi <goffi@goffi.org> parents: 3175 diff changeset	604 no_trigger=False):
2643 189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	605 r"""Send a message to an entity
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	606
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	607 @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	608 @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	609 @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	610 @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	611 - auto: for automatic type detection
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	612 - 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	613 @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	614 - info_type: information type, can be
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	615 TODO
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	616 @param uid(unicode, None): unique id:
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	617 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	618 if None, an uuid will be generated
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	619 @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	620 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	621 /!\ this will also skip encryption methods!
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	622 """
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	623 if subject is None:
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	624 subject = {}
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	625 if extra is None:
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	626 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	627
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	628 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	629
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	630 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	631 "from": self.jid,
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	632 "to": to_jid,
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	633 "uid": uid or str(uuid.uuid4()),
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	634 "message": message,
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	635 "subject": subject,
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	636 "type": mess_type,
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	637 "extra": extra,
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	638 "timestamp": time.time(),
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	639 }
2645 f2cf1daa42cb core: added async TriggerManager Goffi <goffi@goffi.org> parents: 2643 diff changeset	640 # XXX: plugin can add their pre XML treatments to this deferred
f2cf1daa42cb core: added async TriggerManager Goffi <goffi@goffi.org> parents: 2643 diff changeset	641 pre_xml_treatments = defer.Deferred()
f2cf1daa42cb core: added async TriggerManager Goffi <goffi@goffi.org> parents: 2643 diff changeset	642 # XXX: plugin can add their post XML treatments to this deferred
f2cf1daa42cb core: added async TriggerManager Goffi <goffi@goffi.org> parents: 2643 diff changeset	643 post_xml_treatments = defer.Deferred()
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	644
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	645 if data["type"] == C.MESS_TYPE_AUTO:
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	646 # we try to guess the type
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	647 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	648 data["type"] = C.MESS_TYPE_NORMAL
2645 f2cf1daa42cb core: added async TriggerManager Goffi <goffi@goffi.org> parents: 2643 diff changeset	649 elif not data["to"].resource: # if to JID has a resource,
f2cf1daa42cb core: added async TriggerManager Goffi <goffi@goffi.org> parents: 2643 diff changeset	650 # the type is not 'groupchat'
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	651 # 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	652 try:
2994 94708a7d3ecf core, plugin XEP-0045: fixed message type autodetection + ENTITY_TYPE_MUC constant: Goffi <goffi@goffi.org> parents: 2985 diff changeset	653 entity_type = self.host_app.memory.getEntityDatum(
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3249 diff changeset	654 self, data["to"], C.ENTITY_TYPE
2994 94708a7d3ecf core, plugin XEP-0045: fixed message type autodetection + ENTITY_TYPE_MUC constant: Goffi <goffi@goffi.org> parents: 2985 diff changeset	655 )
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	656 # FIXME: should entity_type manage resources ?
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	657 except (exceptions.UnknownEntityError, KeyError):
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	658 entity_type = "contact"
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	659
2994 94708a7d3ecf core, plugin XEP-0045: fixed message type autodetection + ENTITY_TYPE_MUC constant: Goffi <goffi@goffi.org> parents: 2985 diff changeset	660 if entity_type == C.ENTITY_TYPE_MUC:
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	661 data["type"] = C.MESS_TYPE_GROUPCHAT
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	662 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	663 data["type"] = C.MESS_TYPE_CHAT
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	664 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	665 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	666 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	667
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	668 # 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	669 # 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	670 # thing internally, this could be unified
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	671 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	672
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	673 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	674 # 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	675 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	676
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	677 if not self.host_app.trigger.point(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	678 "sendMessage" + self.trigger_suffix,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	679 self,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	680 data,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	681 pre_xml_treatments,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	682 post_xml_treatments,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	683 ):
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	684 return defer.succeed(None)
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	685
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	686 log.debug(_("Sending message (type {type}, to {to})")
2643 189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	687 .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	688
3221 b1c90eedbc12 core (xmpp): fixed workflow with post_xml_treatments in sendMessage: Goffi <goffi@goffi.org> parents: 3203 diff changeset	689 pre_xml_treatments.addCallback(lambda __: self.generateMessageXML(data, post_xml_treatments))
b1c90eedbc12 core (xmpp): fixed workflow with post_xml_treatments in sendMessage: Goffi <goffi@goffi.org> parents: 3203 diff changeset	690 pre_xml_treatments.addCallback(lambda __: post_xml_treatments)
b1c90eedbc12 core (xmpp): fixed workflow with post_xml_treatments in sendMessage: Goffi <goffi@goffi.org> parents: 3203 diff changeset	691 post_xml_treatments.addCallback(lambda __: self.sendMessageData(data))
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	692 if send_only:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	693 log.debug(_("Triggers, storage and echo have been inhibited by the "
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	694 "'send_only' parameter"))
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	695 else:
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	696 self.addPostXmlCallbacks(post_xml_treatments)
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	697 post_xml_treatments.addErrback(self._cancelErrorTrap)
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	698 post_xml_treatments.addErrback(self.host_app.logErrback)
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	699 pre_xml_treatments.callback(data)
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	700 return pre_xml_treatments
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	701
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	702 def _cancelErrorTrap(self, failure):
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	703 """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	704 failure.trap(exceptions.CancelError)
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	705
3173 343b8076e967 core (xmpp): new message key to handle attachments Goffi <goffi@goffi.org> parents: 3172 diff changeset	706 def isMessagePrintable(self, mess_data):
343b8076e967 core (xmpp): new message key to handle attachments Goffi <goffi@goffi.org> parents: 3172 diff changeset	707 """Return True if a message contain payload to show in frontends"""
343b8076e967 core (xmpp): new message key to handle attachments Goffi <goffi@goffi.org> parents: 3172 diff changeset	708 return (
343b8076e967 core (xmpp): new message key to handle attachments Goffi <goffi@goffi.org> parents: 3172 diff changeset	709 mess_data["message"] or mess_data["subject"]
343b8076e967 core (xmpp): new message key to handle attachments Goffi <goffi@goffi.org> parents: 3172 diff changeset	710 or mess_data["extra"].get(C.MESS_KEY_ATTACHMENTS)
343b8076e967 core (xmpp): new message key to handle attachments Goffi <goffi@goffi.org> parents: 3172 diff changeset	711 or mess_data["type"] == C.MESS_TYPE_INFO
343b8076e967 core (xmpp): new message key to handle attachments Goffi <goffi@goffi.org> parents: 3172 diff changeset	712 )
343b8076e967 core (xmpp): new message key to handle attachments Goffi <goffi@goffi.org> parents: 3172 diff changeset	713
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	714 def messageAddToHistory(self, data):
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	715 """Store message into database (for local history)
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	716
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	717 @param data: message data dictionnary
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	718 @param client: profile's client
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	719 """
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	720 if data["type"] != C.MESS_TYPE_GROUPCHAT:
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	721 # 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	722 # and they will be added then
3173 343b8076e967 core (xmpp): new message key to handle attachments Goffi <goffi@goffi.org> parents: 3172 diff changeset	723
343b8076e967 core (xmpp): new message key to handle attachments Goffi <goffi@goffi.org> parents: 3172 diff changeset	724 # we need a message to store
343b8076e967 core (xmpp): new message key to handle attachments Goffi <goffi@goffi.org> parents: 3172 diff changeset	725 if self.isMessagePrintable(data):
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	726 self.host_app.memory.addToHistory(self, data)
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	727 else:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	728 log.warning(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	729 "No message found"
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	730 ) # 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	731 return data
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	732
2701 2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2694 diff changeset	733 def messageGetBridgeArgs(self, data):
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2694 diff changeset	734 """Generate args to use with bridge from data dict"""
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	735 return (data["uid"], data["timestamp"], data["from"].full(),
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	736 data["to"].full(), data["message"], data["subject"],
3170 39d7327583e1 core: use serialised dict for `extra` in messageNew and historyGet Goffi <goffi@goffi.org> parents: 3162 diff changeset	737 data["type"], data_format.serialise(data["extra"]))
2701 2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2694 diff changeset	738
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2694 diff changeset	739
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	740 def messageSendToBridge(self, data):
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	741 """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	742
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	743 @param data: message data dictionnary
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	744 @param client: profile's client
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	745 """
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	746 if data["type"] != C.MESS_TYPE_GROUPCHAT:
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	747 # 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	748 # and they will be added the
3173 343b8076e967 core (xmpp): new message key to handle attachments Goffi <goffi@goffi.org> parents: 3172 diff changeset	749
343b8076e967 core (xmpp): new message key to handle attachments Goffi <goffi@goffi.org> parents: 3172 diff changeset	750 # we need a message to send something
343b8076e967 core (xmpp): new message key to handle attachments Goffi <goffi@goffi.org> parents: 3172 diff changeset	751 if self.isMessagePrintable(data):
2701 2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2694 diff changeset	752
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	753 # 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	754 self.host_app.bridge.messageNew(
2701 2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2694 diff changeset	755 *self.messageGetBridgeArgs(data),
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2694 diff changeset	756 profile=self.profile
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	757 )
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	758 else:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	759 log.warning(_("No message found"))
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	760 return data
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	761
3249 f16c96c7a91a core (xmpp): helper method to launch a plugin method: Goffi <goffi@goffi.org> parents: 3244 diff changeset	762 ## helper methods ##
f16c96c7a91a core (xmpp): helper method to launch a plugin method: Goffi <goffi@goffi.org> parents: 3244 diff changeset	763
f16c96c7a91a core (xmpp): helper method to launch a plugin method: Goffi <goffi@goffi.org> parents: 3244 diff changeset	764 def p(self, plugin_name, missing=exceptions.MissingModule):
f16c96c7a91a core (xmpp): helper method to launch a plugin method: Goffi <goffi@goffi.org> parents: 3244 diff changeset	765 """Get a plugin if available
f16c96c7a91a core (xmpp): helper method to launch a plugin method: Goffi <goffi@goffi.org> parents: 3244 diff changeset	766
f16c96c7a91a core (xmpp): helper method to launch a plugin method: Goffi <goffi@goffi.org> parents: 3244 diff changeset	767 @param plugin_name(str): name of the plugin
f16c96c7a91a core (xmpp): helper method to launch a plugin method: Goffi <goffi@goffi.org> parents: 3244 diff changeset	768 @param missing(object): value to return if plugin is missing
f16c96c7a91a core (xmpp): helper method to launch a plugin method: Goffi <goffi@goffi.org> parents: 3244 diff changeset	769 if it is a subclass of Exception, it will be raised with a helping str as
f16c96c7a91a core (xmpp): helper method to launch a plugin method: Goffi <goffi@goffi.org> parents: 3244 diff changeset	770 argument.
f16c96c7a91a core (xmpp): helper method to launch a plugin method: Goffi <goffi@goffi.org> parents: 3244 diff changeset	771 @return (object): requested plugin wrapper, or default value
f16c96c7a91a core (xmpp): helper method to launch a plugin method: Goffi <goffi@goffi.org> parents: 3244 diff changeset	772 The plugin wrapper will return the method with client set as first
f16c96c7a91a core (xmpp): helper method to launch a plugin method: Goffi <goffi@goffi.org> parents: 3244 diff changeset	773 positional argument
f16c96c7a91a core (xmpp): helper method to launch a plugin method: Goffi <goffi@goffi.org> parents: 3244 diff changeset	774 """
f16c96c7a91a core (xmpp): helper method to launch a plugin method: Goffi <goffi@goffi.org> parents: 3244 diff changeset	775 return ClientPluginWrapper(self, plugin_name, missing)
f16c96c7a91a core (xmpp): helper method to launch a plugin method: Goffi <goffi@goffi.org> parents: 3244 diff changeset	776
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	777
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	778 @implementer(iwokkel.IDisco)
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	779 class SatXMPPClient(SatXMPPEntity, wokkel_client.XMPPClient):
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	780 trigger_suffix = ""
2498 d6de69da3dd4 core (client): component improvments: Goffi <goffi@goffi.org> parents: 2497 diff changeset	781 is_component = False
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	782
2687 e9cd473a2f46 core (xmpp): server certificate validation: Goffi <goffi@goffi.org> parents: 2661 diff changeset	783 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	784 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	785 # 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	786 # 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	787 self.started = time.time()
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	788
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	789 # 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	790 # 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	791 # with a web frontend,
189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	792 # 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	793 # bridge
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	794 self.identities = [disco.DiscoIdentity("client", "pc", C.APP_NAME)]
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	795 if sys.platform == "android":
2594 59ba387c17ea core (xmpp): use "phone" type in identities when backend is started from Android Goffi <goffi@goffi.org> parents: 2562 diff changeset	796 # for now we consider Android devices to be always phones
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	797 self.identities = [disco.DiscoIdentity("client", "phone", C.APP_NAME)]
2259 f51315500eb1 core: added hosts_dict handling in general config: Goffi <goffi@goffi.org> parents: 2172 diff changeset	798
f51315500eb1 core: added hosts_dict handling in general config: Goffi <goffi@goffi.org> parents: 2172 diff changeset	799 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	800 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	801 host_data = hosts_map[user_jid.host]
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	802 if isinstance(host_data, str):
2259 f51315500eb1 core: added hosts_dict handling in general config: Goffi <goffi@goffi.org> parents: 2172 diff changeset	803 host = host_data
f51315500eb1 core: added hosts_dict handling in general config: Goffi <goffi@goffi.org> parents: 2172 diff changeset	804 elif isinstance(host_data, dict):
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	805 if "host" in host_data:
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	806 host = host_data["host"]
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	807 if "port" in host_data:
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	808 port = host_data["port"]
2259 f51315500eb1 core: added hosts_dict handling in general config: Goffi <goffi@goffi.org> parents: 2172 diff changeset	809 else:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	810 log.warning(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	811 _("invalid data used for host: {data}").format(data=host_data)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	812 )
2259 f51315500eb1 core: added hosts_dict handling in general config: Goffi <goffi@goffi.org> parents: 2172 diff changeset	813 host_data = None
f51315500eb1 core: added hosts_dict handling in general config: Goffi <goffi@goffi.org> parents: 2172 diff changeset	814 if host_data is not None:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	815 log.info(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	816 "using {host}:{port} for host {host_ori} as requested in config"
2643 189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	817 .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	818 )
2259 f51315500eb1 core: added hosts_dict handling in general config: Goffi <goffi@goffi.org> parents: 2172 diff changeset	819
2687 e9cd473a2f46 core (xmpp): server certificate validation: Goffi <goffi@goffi.org> parents: 2661 diff changeset	820 self.check_certificate = host_app.memory.getParamA(
e9cd473a2f46 core (xmpp): server certificate validation: Goffi <goffi@goffi.org> parents: 2661 diff changeset	821 "check_certificate", "Connection", profile_key=profile)
e9cd473a2f46 core (xmpp): server certificate validation: Goffi <goffi@goffi.org> parents: 2661 diff changeset	822
3044 691283719bb2 core (patches): updated TLS patches: Goffi <goffi@goffi.org> parents: 3040 diff changeset	823 if self.check_certificate:
691283719bb2 core (patches): updated TLS patches: Goffi <goffi@goffi.org> parents: 3040 diff changeset	824 tls_required, configurationForTLS = True, None
691283719bb2 core (patches): updated TLS patches: Goffi <goffi@goffi.org> parents: 3040 diff changeset	825 else:
691283719bb2 core (patches): updated TLS patches: Goffi <goffi@goffi.org> parents: 3040 diff changeset	826 tls_required = False
691283719bb2 core (patches): updated TLS patches: Goffi <goffi@goffi.org> parents: 3040 diff changeset	827 configurationForTLS = ssl.CertificateOptions(trustRoot=None)
691283719bb2 core (patches): updated TLS patches: Goffi <goffi@goffi.org> parents: 3040 diff changeset	828
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	829 wokkel_client.XMPPClient.__init__(
2687 e9cd473a2f46 core (xmpp): server certificate validation: Goffi <goffi@goffi.org> parents: 2661 diff changeset	830 self, user_jid, password, host or None, port or C.XMPP_C2S_PORT,
3044 691283719bb2 core (patches): updated TLS patches: Goffi <goffi@goffi.org> parents: 3040 diff changeset	831 tls_required=tls_required, configurationForTLS=configurationForTLS
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	832 )
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	833 SatXMPPEntity.__init__(self, host_app, profile, max_retries)
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	834
2687 e9cd473a2f46 core (xmpp): server certificate validation: Goffi <goffi@goffi.org> parents: 2661 diff changeset	835 if not self.check_certificate:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	836 msg = (_("Certificate validation is deactivated, this is unsecure and "
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	837 "somebody may be spying on you. If you have no good reason to disable "
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	838 "certificate validation, please activate \"Check certificate\" in your "
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	839 "settings in \"Connection\" tab."))
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	840 xml_tools.quickNote(host_app, self, msg, _("Security notice"),
2687 e9cd473a2f46 core (xmpp): server certificate validation: Goffi <goffi@goffi.org> parents: 2661 diff changeset	841 level = C.XMLUI_DATA_LVL_WARNING)
e9cd473a2f46 core (xmpp): server certificate validation: Goffi <goffi@goffi.org> parents: 2661 diff changeset	842
e9cd473a2f46 core (xmpp): server certificate validation: Goffi <goffi@goffi.org> parents: 2661 diff changeset	843
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	844 def _getPluginsList(self):
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	845 for p in self.host_app.plugins.values():
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	846 if C.PLUG_MODE_CLIENT in p._info["modes"]:
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	847 yield p
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	848
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	849 def _createSubProtocols(self):
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	850 self.messageProt = SatMessageProtocol(self.host_app)
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	851 self.messageProt.setHandlerParent(self)
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	852
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	853 self.roster = SatRosterProtocol(self.host_app)
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	854 self.roster.setHandlerParent(self)
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	855
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	856 self.presence = SatPresenceProtocol(self.host_app)
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	857 self.presence.setHandlerParent(self)
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	858
2915 d1fcb8e9aced core: fixed component connexion: Goffi <goffi@goffi.org> parents: 2901 diff changeset	859 @classmethod
3224 0404b306641d core (xmpp): use async corouting for startConnection Goffi <goffi@goffi.org> parents: 3221 diff changeset	860 async def startConnection(cls, host, profile, max_retries):
3153 2c7b42f53e9a core (xmpp): avoid starting several clients at the same time: Goffi <goffi@goffi.org> parents: 3149 diff changeset	861 try:
3224 0404b306641d core (xmpp): use async corouting for startConnection Goffi <goffi@goffi.org> parents: 3221 diff changeset	862 await super(SatXMPPClient, cls).startConnection(host, profile, max_retries)
3153 2c7b42f53e9a core (xmpp): avoid starting several clients at the same time: Goffi <goffi@goffi.org> parents: 3149 diff changeset	863 except exceptions.CancelError as e:
2c7b42f53e9a core (xmpp): avoid starting several clients at the same time: Goffi <goffi@goffi.org> parents: 3149 diff changeset	864 log.warning(f"startConnection cancelled: {e}")
2c7b42f53e9a core (xmpp): avoid starting several clients at the same time: Goffi <goffi@goffi.org> parents: 3149 diff changeset	865 return
2915 d1fcb8e9aced core: fixed component connexion: Goffi <goffi@goffi.org> parents: 2901 diff changeset	866 entity = host.profiles[profile]
d1fcb8e9aced core: fixed component connexion: Goffi <goffi@goffi.org> parents: 2901 diff changeset	867 # we finally send our presence
d1fcb8e9aced core: fixed component connexion: Goffi <goffi@goffi.org> parents: 2901 diff changeset	868 entity.presence.available()
d1fcb8e9aced core: fixed component connexion: Goffi <goffi@goffi.org> parents: 2901 diff changeset	869
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	870 def entityConnected(self):
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	871 # 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	872 return self.roster.got_roster
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	873
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	874 def addPostXmlCallbacks(self, post_xml_treatments):
3183 8565af209234 core (xmpp): complete attachments for sent attachments: Goffi <goffi@goffi.org> parents: 3179 diff changeset	875 post_xml_treatments.addCallback(self.messageProt.completeAttachments)
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	876 post_xml_treatments.addCallback(self.messageAddToHistory)
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	877 post_xml_treatments.addCallback(self.messageSendToBridge)
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	878
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	879 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	880 # 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	881 # 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	882 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	883 # 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	884 # 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	885 # 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	886 # (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	887 # 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	888 # a lower priority
2643 189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	889 # 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	890 # encryption is implemented
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	891 # if not self.host_app.trigger.point("send", self, obj):
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	892 # return
2136 cc3a6aea9508 core (client): added feedback and sendMessage methods: Goffi <goffi@goffi.org> parents: 2132 diff changeset	893 super(SatXMPPClient, self).send(obj)
cc3a6aea9508 core (client): added feedback and sendMessage methods: Goffi <goffi@goffi.org> parents: 2132 diff changeset	894
2645 f2cf1daa42cb core: added async TriggerManager Goffi <goffi@goffi.org> parents: 2643 diff changeset	895 @defer.inlineCallbacks
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	896 def sendMessageData(self, mess_data):
2136 cc3a6aea9508 core (client): added feedback and sendMessage methods: Goffi <goffi@goffi.org> parents: 2132 diff changeset	897 """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	898
2136 cc3a6aea9508 core (client): added feedback and sendMessage methods: Goffi <goffi@goffi.org> parents: 2132 diff changeset	899 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	900 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	901 don't handle full stanza encryption
2645 f2cf1daa42cb core: added async TriggerManager Goffi <goffi@goffi.org> parents: 2643 diff changeset	902 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	903 @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	904 @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	905 """
2643 189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	906 # 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	907 # for sending message.
189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	908 # 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	909 # encryption (e.g. OTR)
2136 cc3a6aea9508 core (client): added feedback and sendMessage methods: Goffi <goffi@goffi.org> parents: 2132 diff changeset	910 # 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	911 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	912 triggers_no_cancel=True)
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	913 self.send(mess_data["xml"])
2645 f2cf1daa42cb core: added async TriggerManager Goffi <goffi@goffi.org> parents: 2643 diff changeset	914 defer.returnValue(mess_data)
2136 cc3a6aea9508 core (client): added feedback and sendMessage methods: Goffi <goffi@goffi.org> parents: 2132 diff changeset	915
2748 ec9445c04a36 core (xmpp): added "extra" argument to client.feedback Goffi <goffi@goffi.org> parents: 2742 diff changeset	916 def feedback(self, to_jid, message, extra=None):
2136 cc3a6aea9508 core (client): added feedback and sendMessage methods: Goffi <goffi@goffi.org> parents: 2132 diff changeset	917 """Send message to frontends
cc3a6aea9508 core (client): added feedback and sendMessage methods: Goffi <goffi@goffi.org> parents: 2132 diff changeset	918
cc3a6aea9508 core (client): added feedback and sendMessage methods: Goffi <goffi@goffi.org> parents: 2132 diff changeset	919 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	920 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	921 @param to_jid(jid.JID): destinee jid
2136 cc3a6aea9508 core (client): added feedback and sendMessage methods: Goffi <goffi@goffi.org> parents: 2132 diff changeset	922 @param message(unicode): message to send to frontends
2748 ec9445c04a36 core (xmpp): added "extra" argument to client.feedback Goffi <goffi@goffi.org> parents: 2742 diff changeset	923 @param extra(None, dict): extra data to use
ec9445c04a36 core (xmpp): added "extra" argument to client.feedback Goffi <goffi@goffi.org> parents: 2742 diff changeset	924 in particular, info subtype can be specified with MESS_EXTRA_INFO
2136 cc3a6aea9508 core (client): added feedback and sendMessage methods: Goffi <goffi@goffi.org> parents: 2132 diff changeset	925 """
2748 ec9445c04a36 core (xmpp): added "extra" argument to client.feedback Goffi <goffi@goffi.org> parents: 2742 diff changeset	926 if extra is None:
ec9445c04a36 core (xmpp): added "extra" argument to client.feedback Goffi <goffi@goffi.org> parents: 2742 diff changeset	927 extra = {}
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	928 self.host_app.bridge.messageNew(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	929 uid=str(uuid.uuid4()),
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	930 timestamp=time.time(),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	931 from_jid=self.jid.full(),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	932 to_jid=to_jid.full(),
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	933 message={"": message},
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	934 subject={},
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	935 mess_type=C.MESS_TYPE_INFO,
3170 39d7327583e1 core: use serialised dict for `extra` in messageNew and historyGet Goffi <goffi@goffi.org> parents: 3162 diff changeset	936 extra=data_format.serialise(extra),
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	937 profile=self.profile,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	938 )
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	939
2643 189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	940 def _finish_connection(self, __):
2891 6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	941 d = self.roster.requestRoster()
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	942 d.addCallback(lambda __: super(SatXMPPClient, self)._finish_connection(__))
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	943
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	944
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	945 @implementer(iwokkel.IDisco)
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	946 class SatXMPPComponent(SatXMPPEntity, component.Component):
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	947 """XMPP component
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	948
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	949 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	950 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	951 Component need to instantiate MessageProtocol itself
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	952 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	953
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	954 trigger_suffix = (
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	955 "Component"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	956 ) # used for to distinguish some trigger points set in SatXMPPEntity
2498 d6de69da3dd4 core (client): component improvments: Goffi <goffi@goffi.org> parents: 2497 diff changeset	957 is_component = True
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	958 sendHistory = (
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	959 False
2643 189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	960 ) # 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	961 # messages
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	962
2691 1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2688 diff changeset	963 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	964 max_retries=C.XMPP_MAX_RETRIES):
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	965 self.started = time.time()
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	966 if port is None:
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	967 port = C.XMPP_COMPONENT_PORT
13 bd9e9997d540 wokkel integration (not finished yet) Goffi <goffi@goffi.org> parents: 12 diff changeset	968
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	969 ## entry point ##
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	970 entry_point = host_app.memory.getEntryPoint(profile)
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	971 try:
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	972 self.entry_plugin = host_app.plugins[entry_point]
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	973 except KeyError:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	974 raise exceptions.NotFound(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	975 _("The requested entry point ({entry_point}) is not available").format(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	976 entry_point=entry_point
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	977 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	978 )
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	979
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	980 self.identities = [disco.DiscoIdentity("component", "generic", C.APP_NAME)]
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	981 # 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	982 self.jid = component_jid
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	983 if host is None:
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	984 try:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	985 host = component_jid.host.split(".", 1)[1]
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	986 except IndexError:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	987 raise ValueError("Can't guess host from jid, please specify a host")
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	988 # 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	989 # 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	990 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	991 SatXMPPEntity.__init__(self, host_app, profile, max_retries)
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	992
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	993 def _buildDependencies(self, current, plugins, required=True):
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	994 """build recursively dependencies needed for a plugin
62 93cb45a7420f SàT multi-profile: connection using profiles Goffi <goffi@goffi.org> parents: 60 diff changeset	995
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	996 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	997 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	998 @param current(object): parent plugin to check
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	999 use entry_point for first call
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	1000 @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	1001 give an empty list for first call
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	1002 @param required(bool): True if plugin is mandatory
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	1003 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	1004 @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	1005 @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	1006 is not
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	1007 """
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1008 if C.PLUG_MODE_COMPONENT not in current._info["modes"]:
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	1009 if not required:
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	1010 return
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	1011 else:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1012 log.error(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1013 _(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1014 "Plugin {current_name} is needed for {entry_name}, "
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1015 "but it doesn't handle component mode"
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1016 ).format(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1017 current_name=current._info["import_name"],
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1018 entry_name=self.entry_plugin._info["import_name"],
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1019 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1020 )
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1021 raise exceptions.InternalError(_("invalid plugin mode"))
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	1022
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	1023 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	1024 # plugins are already loaded as dependencies
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	1025 # 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	1026 dep = self.host_app.plugins[import_name]
2498 d6de69da3dd4 core (client): component improvments: Goffi <goffi@goffi.org> parents: 2497 diff changeset	1027 self._buildDependencies(dep, plugins)
13 bd9e9997d540 wokkel integration (not finished yet) Goffi <goffi@goffi.org> parents: 12 diff changeset	1028
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	1029 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	1030 # here plugins are only recommendations,
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	1031 # 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	1032 try:
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	1033 dep = self.host_app.plugins[import_name]
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	1034 except KeyError:
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	1035 continue
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1036 self._buildDependencies(dep, plugins, required=False)
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	1037
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	1038 if current not in plugins:
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	1039 # 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	1040 # it can already be present in the list
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	1041 plugins.append(current)
262 af3d4f11fe43 Added management of connection error Goffi <goffi@goffi.org> parents: 260 diff changeset	1042
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	1043 def _getPluginsList(self):
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	1044 # 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	1045 # 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	1046 plugins = []
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	1047 self._buildDependencies(self.entry_plugin, plugins)
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	1048 return plugins
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	1049
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	1050 def entityConnected(self):
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	1051 # we can now launch entry point
2498 d6de69da3dd4 core (client): component improvments: Goffi <goffi@goffi.org> parents: 2497 diff changeset	1052 try:
d6de69da3dd4 core (client): component improvments: Goffi <goffi@goffi.org> parents: 2497 diff changeset	1053 start_cb = self.entry_plugin.componentStart
d6de69da3dd4 core (client): component improvments: Goffi <goffi@goffi.org> parents: 2497 diff changeset	1054 except AttributeError:
d6de69da3dd4 core (client): component improvments: Goffi <goffi@goffi.org> parents: 2497 diff changeset	1055 return
d6de69da3dd4 core (client): component improvments: Goffi <goffi@goffi.org> parents: 2497 diff changeset	1056 else:
d6de69da3dd4 core (client): component improvments: Goffi <goffi@goffi.org> parents: 2497 diff changeset	1057 return start_cb(self)
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	1058
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	1059 def addPostXmlCallbacks(self, post_xml_treatments):
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	1060 if self.sendHistory:
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	1061 post_xml_treatments.addCallback(self.messageAddToHistory)
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	1062
3366 e09cb08166a3 plugin XEP-0329, core(xmpp): moved `_compParseJids` to `SatXMPPComponent`: Goffi <goffi@goffi.org> parents: 3316 diff changeset	1063 def getOwnerFromJid(self, to_jid: jid.JID) -> jid.JID:
e09cb08166a3 plugin XEP-0329, core(xmpp): moved `_compParseJids` to `SatXMPPComponent`: Goffi <goffi@goffi.org> parents: 3316 diff changeset	1064 """Retrieve "owner" of a component resource from the destination jid of the request
e09cb08166a3 plugin XEP-0329, core(xmpp): moved `_compParseJids` to `SatXMPPComponent`: Goffi <goffi@goffi.org> parents: 3316 diff changeset	1065
e09cb08166a3 plugin XEP-0329, core(xmpp): moved `_compParseJids` to `SatXMPPComponent`: Goffi <goffi@goffi.org> parents: 3316 diff changeset	1066 This method needs plugin XEP-0106 for unescaping, if you use it you must add the
e09cb08166a3 plugin XEP-0329, core(xmpp): moved `_compParseJids` to `SatXMPPComponent`: Goffi <goffi@goffi.org> parents: 3316 diff changeset	1067 plugin to your dependencies.
e09cb08166a3 plugin XEP-0329, core(xmpp): moved `_compParseJids` to `SatXMPPComponent`: Goffi <goffi@goffi.org> parents: 3316 diff changeset	1068 A "user" part must be present in "to_jid" (otherwise, the component itself is addressed)
e09cb08166a3 plugin XEP-0329, core(xmpp): moved `_compParseJids` to `SatXMPPComponent`: Goffi <goffi@goffi.org> parents: 3316 diff changeset	1069 @param to_jid: destination JID of the request
e09cb08166a3 plugin XEP-0329, core(xmpp): moved `_compParseJids` to `SatXMPPComponent`: Goffi <goffi@goffi.org> parents: 3316 diff changeset	1070 """
e09cb08166a3 plugin XEP-0329, core(xmpp): moved `_compParseJids` to `SatXMPPComponent`: Goffi <goffi@goffi.org> parents: 3316 diff changeset	1071 try:
e09cb08166a3 plugin XEP-0329, core(xmpp): moved `_compParseJids` to `SatXMPPComponent`: Goffi <goffi@goffi.org> parents: 3316 diff changeset	1072 unescape = self.host_app.plugins['XEP-0106'].unescape
e09cb08166a3 plugin XEP-0329, core(xmpp): moved `_compParseJids` to `SatXMPPComponent`: Goffi <goffi@goffi.org> parents: 3316 diff changeset	1073 except KeyError:
e09cb08166a3 plugin XEP-0329, core(xmpp): moved `_compParseJids` to `SatXMPPComponent`: Goffi <goffi@goffi.org> parents: 3316 diff changeset	1074 raise exceptions.MissingPlugin("Plugin XEP-0106 is needed to retrieve owner")
e09cb08166a3 plugin XEP-0329, core(xmpp): moved `_compParseJids` to `SatXMPPComponent`: Goffi <goffi@goffi.org> parents: 3316 diff changeset	1075 else:
e09cb08166a3 plugin XEP-0329, core(xmpp): moved `_compParseJids` to `SatXMPPComponent`: Goffi <goffi@goffi.org> parents: 3316 diff changeset	1076 user = unescape(to_jid.user)
e09cb08166a3 plugin XEP-0329, core(xmpp): moved `_compParseJids` to `SatXMPPComponent`: Goffi <goffi@goffi.org> parents: 3316 diff changeset	1077 if '@' in user:
e09cb08166a3 plugin XEP-0329, core(xmpp): moved `_compParseJids` to `SatXMPPComponent`: Goffi <goffi@goffi.org> parents: 3316 diff changeset	1078 # a full jid is specified
e09cb08166a3 plugin XEP-0329, core(xmpp): moved `_compParseJids` to `SatXMPPComponent`: Goffi <goffi@goffi.org> parents: 3316 diff changeset	1079 return jid.JID(user)
e09cb08166a3 plugin XEP-0329, core(xmpp): moved `_compParseJids` to `SatXMPPComponent`: Goffi <goffi@goffi.org> parents: 3316 diff changeset	1080 else:
e09cb08166a3 plugin XEP-0329, core(xmpp): moved `_compParseJids` to `SatXMPPComponent`: Goffi <goffi@goffi.org> parents: 3316 diff changeset	1081 # only user part is specified, we use our own host to build the full jid
e09cb08166a3 plugin XEP-0329, core(xmpp): moved `_compParseJids` to `SatXMPPComponent`: Goffi <goffi@goffi.org> parents: 3316 diff changeset	1082 return jid.JID(None, (user, self.host, None))
e09cb08166a3 plugin XEP-0329, core(xmpp): moved `_compParseJids` to `SatXMPPComponent`: Goffi <goffi@goffi.org> parents: 3316 diff changeset	1083
e09cb08166a3 plugin XEP-0329, core(xmpp): moved `_compParseJids` to `SatXMPPComponent`: Goffi <goffi@goffi.org> parents: 3316 diff changeset	1084 def getOwnerAndPeer(self, iq_elt: domish.Element) -> Tuple[jid.JID, jid.JID]:
e09cb08166a3 plugin XEP-0329, core(xmpp): moved `_compParseJids` to `SatXMPPComponent`: Goffi <goffi@goffi.org> parents: 3316 diff changeset	1085 """Retrieve owner of a component jid, and the jid of the requesting peer
e09cb08166a3 plugin XEP-0329, core(xmpp): moved `_compParseJids` to `SatXMPPComponent`: Goffi <goffi@goffi.org> parents: 3316 diff changeset	1086
e09cb08166a3 plugin XEP-0329, core(xmpp): moved `_compParseJids` to `SatXMPPComponent`: Goffi <goffi@goffi.org> parents: 3316 diff changeset	1087 "owner" is found by either unescaping full jid from node, or by combining node
e09cb08166a3 plugin XEP-0329, core(xmpp): moved `_compParseJids` to `SatXMPPComponent`: Goffi <goffi@goffi.org> parents: 3316 diff changeset	1088 with our host.
e09cb08166a3 plugin XEP-0329, core(xmpp): moved `_compParseJids` to `SatXMPPComponent`: Goffi <goffi@goffi.org> parents: 3316 diff changeset	1089 Peer jid is the requesting jid from the IQ element
e09cb08166a3 plugin XEP-0329, core(xmpp): moved `_compParseJids` to `SatXMPPComponent`: Goffi <goffi@goffi.org> parents: 3316 diff changeset	1090 @param iq_elt: IQ stanza sent from the requested
e09cb08166a3 plugin XEP-0329, core(xmpp): moved `_compParseJids` to `SatXMPPComponent`: Goffi <goffi@goffi.org> parents: 3316 diff changeset	1091 @return: owner and peer JIDs
e09cb08166a3 plugin XEP-0329, core(xmpp): moved `_compParseJids` to `SatXMPPComponent`: Goffi <goffi@goffi.org> parents: 3316 diff changeset	1092 """
e09cb08166a3 plugin XEP-0329, core(xmpp): moved `_compParseJids` to `SatXMPPComponent`: Goffi <goffi@goffi.org> parents: 3316 diff changeset	1093 to_jid = jid.JID(iq_elt['to'])
e09cb08166a3 plugin XEP-0329, core(xmpp): moved `_compParseJids` to `SatXMPPComponent`: Goffi <goffi@goffi.org> parents: 3316 diff changeset	1094 if to_jid.user:
e09cb08166a3 plugin XEP-0329, core(xmpp): moved `_compParseJids` to `SatXMPPComponent`: Goffi <goffi@goffi.org> parents: 3316 diff changeset	1095 owner = self.getOwnerFromJid(to_jid)
e09cb08166a3 plugin XEP-0329, core(xmpp): moved `_compParseJids` to `SatXMPPComponent`: Goffi <goffi@goffi.org> parents: 3316 diff changeset	1096 else:
e09cb08166a3 plugin XEP-0329, core(xmpp): moved `_compParseJids` to `SatXMPPComponent`: Goffi <goffi@goffi.org> parents: 3316 diff changeset	1097 owner = jid.JID(iq_elt["from"]).userhostJID()
e09cb08166a3 plugin XEP-0329, core(xmpp): moved `_compParseJids` to `SatXMPPComponent`: Goffi <goffi@goffi.org> parents: 3316 diff changeset	1098
e09cb08166a3 plugin XEP-0329, core(xmpp): moved `_compParseJids` to `SatXMPPComponent`: Goffi <goffi@goffi.org> parents: 3316 diff changeset	1099 peer_jid = jid.JID(iq_elt["from"])
e09cb08166a3 plugin XEP-0329, core(xmpp): moved `_compParseJids` to `SatXMPPComponent`: Goffi <goffi@goffi.org> parents: 3316 diff changeset	1100 return peer_jid, owner
e09cb08166a3 plugin XEP-0329, core(xmpp): moved `_compParseJids` to `SatXMPPComponent`: Goffi <goffi@goffi.org> parents: 3316 diff changeset	1101
e09cb08166a3 plugin XEP-0329, core(xmpp): moved `_compParseJids` to `SatXMPPComponent`: Goffi <goffi@goffi.org> parents: 3316 diff changeset	1102
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	1103
13 bd9e9997d540 wokkel integration (not finished yet) Goffi <goffi@goffi.org> parents: 12 diff changeset	1104 class SatMessageProtocol(xmppim.MessageProtocol):
2714 57eac4fd0ec0 core (xmpp): check <message> namespace in parseMessage, and accept empty namespace (happen with Wokkel) Goffi <goffi@goffi.org> parents: 2701 diff changeset	1105
13 bd9e9997d540 wokkel integration (not finished yet) Goffi <goffi@goffi.org> parents: 12 diff changeset	1106 def __init__(self, host):
bd9e9997d540 wokkel integration (not finished yet) Goffi <goffi@goffi.org> parents: 12 diff changeset	1107 xmppim.MessageProtocol.__init__(self)
bd9e9997d540 wokkel integration (not finished yet) Goffi <goffi@goffi.org> parents: 12 diff changeset	1108 self.host = host
bd9e9997d540 wokkel integration (not finished yet) Goffi <goffi@goffi.org> parents: 12 diff changeset	1109
3197 f4a28767ec35 core (xmpp): check that entity_jid is actually a jid in SatRosterProtocol.isJidInRoster Goffi <goffi@goffi.org> parents: 3196 diff changeset	1110 @property
f4a28767ec35 core (xmpp): check that entity_jid is actually a jid in SatRosterProtocol.isJidInRoster Goffi <goffi@goffi.org> parents: 3196 diff changeset	1111 def client(self):
f4a28767ec35 core (xmpp): check that entity_jid is actually a jid in SatRosterProtocol.isJidInRoster Goffi <goffi@goffi.org> parents: 3196 diff changeset	1112 return self.parent
f4a28767ec35 core (xmpp): check that entity_jid is actually a jid in SatRosterProtocol.isJidInRoster Goffi <goffi@goffi.org> parents: 3196 diff changeset	1113
2701 2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2694 diff changeset	1114 def parseMessage(self, message_elt):
3173 343b8076e967 core (xmpp): new message key to handle attachments Goffi <goffi@goffi.org> parents: 3172 diff changeset	1115 """Parse a message XML and return message_data
663 8004c7d4aba7 core: Deferred in onMessage. Goffi <goffi@goffi.org> parents: 636 diff changeset	1116
2099 ad88808591ef plugin XEP-0280: Message Carbons first draft Goffi <goffi@goffi.org> parents: 2089 diff changeset	1117 @param message_elt(domish.Element): raw <message> xml
ad88808591ef plugin XEP-0280: Message Carbons first draft Goffi <goffi@goffi.org> parents: 2089 diff changeset	1118 @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	1119 if None, mapping will not be done
ad88808591ef plugin XEP-0280: Message Carbons first draft Goffi <goffi@goffi.org> parents: 2089 diff changeset	1120 @return(dict): message data
ad88808591ef plugin XEP-0280: Message Carbons first draft Goffi <goffi@goffi.org> parents: 2089 diff changeset	1121 """
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1122 if message_elt.name != "message":
2701 2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2694 diff changeset	1123 log.warning(_(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1124 "parseMessage used with a non <message/> stanza, ignoring: {xml}"
2701 2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2694 diff changeset	1125 .format(xml=message_elt.toXml())))
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2694 diff changeset	1126 return {}
2714 57eac4fd0ec0 core (xmpp): check <message> namespace in parseMessage, and accept empty namespace (happen with Wokkel) Goffi <goffi@goffi.org> parents: 2701 diff changeset	1127
57eac4fd0ec0 core (xmpp): check <message> namespace in parseMessage, and accept empty namespace (happen with Wokkel) Goffi <goffi@goffi.org> parents: 2701 diff changeset	1128 if message_elt.uri is None:
57eac4fd0ec0 core (xmpp): check <message> namespace in parseMessage, and accept empty namespace (happen with Wokkel) Goffi <goffi@goffi.org> parents: 2701 diff changeset	1129 # wokkel element parsing strip out root namespace
2794 33fa70c102de plugin XEP-0045: fixed crash when <delay> is used at an unexpected time. Goffi <goffi@goffi.org> parents: 2778 diff changeset	1130 message_elt.defaultUri = message_elt.uri = C.NS_CLIENT
2979 f44a95f566d2 core, plugin XEP-0045: fix crashes when changing URIs: Goffi <goffi@goffi.org> parents: 2915 diff changeset	1131 for c in message_elt.elements():
2794 33fa70c102de plugin XEP-0045: fixed crash when <delay> is used at an unexpected time. Goffi <goffi@goffi.org> parents: 2778 diff changeset	1132 if c.uri is None:
2983 97a1faca8f58 core (xmpp): fixed URI correction while parsing messages: Goffi <goffi@goffi.org> parents: 2979 diff changeset	1133 c.uri = C.NS_CLIENT
2714 57eac4fd0ec0 core (xmpp): check <message> namespace in parseMessage, and accept empty namespace (happen with Wokkel) Goffi <goffi@goffi.org> parents: 2701 diff changeset	1134 elif message_elt.uri != C.NS_CLIENT:
57eac4fd0ec0 core (xmpp): check <message> namespace in parseMessage, and accept empty namespace (happen with Wokkel) Goffi <goffi@goffi.org> parents: 2701 diff changeset	1135 log.warning(_(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1136 "received <message> with a wrong namespace: {xml}"
2714 57eac4fd0ec0 core (xmpp): check <message> namespace in parseMessage, and accept empty namespace (happen with Wokkel) Goffi <goffi@goffi.org> parents: 2701 diff changeset	1137 .format(xml=message_elt.toXml())))
57eac4fd0ec0 core (xmpp): check <message> namespace in parseMessage, and accept empty namespace (happen with Wokkel) Goffi <goffi@goffi.org> parents: 2701 diff changeset	1138
2701 2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2694 diff changeset	1139 client = self.parent
2731 a58e380c1c37 core (xmpp): set "to" attribute to <message> element when it's missing: Goffi <goffi@goffi.org> parents: 2715 diff changeset	1140
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1141 if not message_elt.hasAttribute('to'):
2731 a58e380c1c37 core (xmpp): set "to" attribute to <message> element when it's missing: Goffi <goffi@goffi.org> parents: 2715 diff changeset	1142 message_elt['to'] = client.jid.full()
a58e380c1c37 core (xmpp): set "to" attribute to <message> element when it's missing: Goffi <goffi@goffi.org> parents: 2715 diff changeset	1143
1955 633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished): Goffi <goffi@goffi.org> parents: 1934 diff changeset	1144 message = {}
633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished): Goffi <goffi@goffi.org> parents: 1934 diff changeset	1145 subject = {}
633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished): Goffi <goffi@goffi.org> parents: 1934 diff changeset	1146 extra = {}
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1147 data = {
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1148 "from": jid.JID(message_elt["from"]),
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1149 "to": jid.JID(message_elt["to"]),
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1150 "uid": message_elt.getAttribute(
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1151 "uid", str(uuid.uuid4())
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1152 ), # XXX: uid is not a standard attribute but may be added by plugins
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1153 "message": message,
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1154 "subject": subject,
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1155 "type": message_elt.getAttribute("type", "normal"),
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1156 "extra": extra,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1157 }
1955 633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished): Goffi <goffi@goffi.org> parents: 1934 diff changeset	1158
2701 2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2694 diff changeset	1159 try:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1160 message_id = data["extra"]["message_id"] = message_elt["id"]
2701 2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2694 diff changeset	1161 except KeyError:
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2694 diff changeset	1162 pass
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2694 diff changeset	1163 else:
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2694 diff changeset	1164 client.mess_id2uid[(data["from"], message_id)] = data["uid"]
663 8004c7d4aba7 core: Deferred in onMessage. Goffi <goffi@goffi.org> parents: 636 diff changeset	1165
1955 633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished): Goffi <goffi@goffi.org> parents: 1934 diff changeset	1166 # message
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1167 for e in message_elt.elements(C.NS_CLIENT, "body"):
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1168 message[e.getAttribute((C.NS_XML, "lang"), "")] = str(e)
1955 633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished): Goffi <goffi@goffi.org> parents: 1934 diff changeset	1169
633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished): Goffi <goffi@goffi.org> parents: 1934 diff changeset	1170 # subject
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1171 for e in message_elt.elements(C.NS_CLIENT, "subject"):
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1172 subject[e.getAttribute((C.NS_XML, "lang"), "")] = str(e)
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	1173
1955 633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished): Goffi <goffi@goffi.org> parents: 1934 diff changeset	1174 # delay and timestamp
633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished): Goffi <goffi@goffi.org> parents: 1934 diff changeset	1175 try:
2984 4bac4e734666 core (xmpp): set message timestamp on message reception: Goffi <goffi@goffi.org> parents: 2983 diff changeset	1176 received_timestamp = message_elt._received_timestamp
4bac4e734666 core (xmpp): set message timestamp on message reception: Goffi <goffi@goffi.org> parents: 2983 diff changeset	1177 except AttributeError:
4bac4e734666 core (xmpp): set message timestamp on message reception: Goffi <goffi@goffi.org> parents: 2983 diff changeset	1178 # message_elt._received_timestamp should have been set in onMessage
4bac4e734666 core (xmpp): set message timestamp on message reception: Goffi <goffi@goffi.org> parents: 2983 diff changeset	1179 # but if parseMessage is called directly, it can be missing
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1180 log.debug("missing received timestamp for {message_elt}".format(
2984 4bac4e734666 core (xmpp): set message timestamp on message reception: Goffi <goffi@goffi.org> parents: 2983 diff changeset	1181 message_elt=message_elt))
4bac4e734666 core (xmpp): set message timestamp on message reception: Goffi <goffi@goffi.org> parents: 2983 diff changeset	1182 received_timestamp = time.time()
4bac4e734666 core (xmpp): set message timestamp on message reception: Goffi <goffi@goffi.org> parents: 2983 diff changeset	1183
4bac4e734666 core (xmpp): set message timestamp on message reception: Goffi <goffi@goffi.org> parents: 2983 diff changeset	1184 try:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1185 delay_elt = next(message_elt.elements(delay.NS_DELAY, "delay"))
1955 633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished): Goffi <goffi@goffi.org> parents: 1934 diff changeset	1186 except StopIteration:
2984 4bac4e734666 core (xmpp): set message timestamp on message reception: Goffi <goffi@goffi.org> parents: 2983 diff changeset	1187 data["timestamp"] = received_timestamp
1955 633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished): Goffi <goffi@goffi.org> parents: 1934 diff changeset	1188 else:
633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished): Goffi <goffi@goffi.org> parents: 1934 diff changeset	1189 parsed_delay = delay.Delay.fromElement(delay_elt)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1190 data["timestamp"] = calendar.timegm(parsed_delay.stamp.utctimetuple())
2984 4bac4e734666 core (xmpp): set message timestamp on message reception: Goffi <goffi@goffi.org> parents: 2983 diff changeset	1191 data["received_timestamp"] = received_timestamp
1955 633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished): Goffi <goffi@goffi.org> parents: 1934 diff changeset	1192 if parsed_delay.sender:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1193 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	1194
2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2694 diff changeset	1195 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	1196 return data
1955 633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished): Goffi <goffi@goffi.org> parents: 1934 diff changeset	1197
2645 f2cf1daa42cb core: added async TriggerManager Goffi <goffi@goffi.org> parents: 2643 diff changeset	1198 def _onMessageStartWorkflow(self, cont, client, message_elt, post_treat):
f2cf1daa42cb core: added async TriggerManager Goffi <goffi@goffi.org> parents: 2643 diff changeset	1199 """Parse message and do post treatments
f2cf1daa42cb core: added async TriggerManager Goffi <goffi@goffi.org> parents: 2643 diff changeset	1200
3172 dcebc585c29f core: renamed "MessageReceived" trigger to "messageReceived" for consistency. Goffi <goffi@goffi.org> parents: 3170 diff changeset	1201 It is the first callback called after messageReceived trigger
2645 f2cf1daa42cb core: added async TriggerManager Goffi <goffi@goffi.org> parents: 2643 diff changeset	1202 @param cont(bool): workflow will continue only if this is True
f2cf1daa42cb core: added async TriggerManager Goffi <goffi@goffi.org> parents: 2643 diff changeset	1203 @param message_elt(domish.Element): message stanza
f2cf1daa42cb core: added async TriggerManager Goffi <goffi@goffi.org> parents: 2643 diff changeset	1204 may have be modified by triggers
f2cf1daa42cb core: added async TriggerManager Goffi <goffi@goffi.org> parents: 2643 diff changeset	1205 @param post_treat(defer.Deferred): post parsing treatments
f2cf1daa42cb core: added async TriggerManager Goffi <goffi@goffi.org> parents: 2643 diff changeset	1206 """
f2cf1daa42cb core: added async TriggerManager Goffi <goffi@goffi.org> parents: 2643 diff changeset	1207 if not cont:
f2cf1daa42cb core: added async TriggerManager Goffi <goffi@goffi.org> parents: 2643 diff changeset	1208 return
2701 2ea2369ae7de plugin XEP-0313: implementation of MAM for messages: Goffi <goffi@goffi.org> parents: 2694 diff changeset	1209 data = self.parseMessage(message_elt)
3175 b9a2dd4d750a core (xmpp): add `name` and `media_type` in attachements if they are missing. Goffi <goffi@goffi.org> parents: 3173 diff changeset	1210 post_treat.addCallback(self.completeAttachments)
2645 f2cf1daa42cb core: added async TriggerManager Goffi <goffi@goffi.org> parents: 2643 diff changeset	1211 post_treat.addCallback(self.skipEmptyMessage)
2715 b35c84ea73cf plugin XEP-0045: MAM implementation for MUC Goffi <goffi@goffi.org> parents: 2714 diff changeset	1212 post_treat.addCallback(self.addToHistory)
b35c84ea73cf plugin XEP-0045: MAM implementation for MUC Goffi <goffi@goffi.org> parents: 2714 diff changeset	1213 post_treat.addCallback(self.bridgeSignal, data)
2645 f2cf1daa42cb core: added async TriggerManager Goffi <goffi@goffi.org> parents: 2643 diff changeset	1214 post_treat.addErrback(self.cancelErrorTrap)
f2cf1daa42cb core: added async TriggerManager Goffi <goffi@goffi.org> parents: 2643 diff changeset	1215 post_treat.callback(data)
f2cf1daa42cb core: added async TriggerManager Goffi <goffi@goffi.org> parents: 2643 diff changeset	1216
2099 ad88808591ef plugin XEP-0280: Message Carbons first draft Goffi <goffi@goffi.org> parents: 2089 diff changeset	1217 def onMessage(self, message_elt):
ad88808591ef plugin XEP-0280: Message Carbons first draft Goffi <goffi@goffi.org> parents: 2089 diff changeset	1218 # TODO: handle threads
2984 4bac4e734666 core (xmpp): set message timestamp on message reception: Goffi <goffi@goffi.org> parents: 2983 diff changeset	1219 message_elt._received_timestamp = time.time()
2099 ad88808591ef plugin XEP-0280: Message Carbons first draft Goffi <goffi@goffi.org> parents: 2089 diff changeset	1220 client = self.parent
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1221 if not "from" in message_elt.attributes:
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1222 message_elt["from"] = client.jid.host
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1223 log.debug(_("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	1224
2645 f2cf1daa42cb core: added async TriggerManager Goffi <goffi@goffi.org> parents: 2643 diff changeset	1225 # plugin can add their treatments to this deferred
f2cf1daa42cb core: added async TriggerManager Goffi <goffi@goffi.org> parents: 2643 diff changeset	1226 post_treat = defer.Deferred()
f2cf1daa42cb core: added async TriggerManager Goffi <goffi@goffi.org> parents: 2643 diff changeset	1227
f2cf1daa42cb core: added async TriggerManager Goffi <goffi@goffi.org> parents: 2643 diff changeset	1228 d = self.host.trigger.asyncPoint(
3172 dcebc585c29f core: renamed "MessageReceived" trigger to "messageReceived" for consistency. Goffi <goffi@goffi.org> parents: 3170 diff changeset	1229 "messageReceived", client, message_elt, post_treat
2645 f2cf1daa42cb core: added async TriggerManager Goffi <goffi@goffi.org> parents: 2643 diff changeset	1230 )
1963 a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	1231
2645 f2cf1daa42cb core: added async TriggerManager Goffi <goffi@goffi.org> parents: 2643 diff changeset	1232 d.addCallback(self._onMessageStartWorkflow, client, message_elt, post_treat)
663 8004c7d4aba7 core: Deferred in onMessage. Goffi <goffi@goffi.org> parents: 636 diff changeset	1233
3175 b9a2dd4d750a core (xmpp): add `name` and `media_type` in attachements if they are missing. Goffi <goffi@goffi.org> parents: 3173 diff changeset	1234 def completeAttachments(self, data):
b9a2dd4d750a core (xmpp): add `name` and `media_type` in attachements if they are missing. Goffi <goffi@goffi.org> parents: 3173 diff changeset	1235 """Complete missing metadata of attachments"""
b9a2dd4d750a core (xmpp): add `name` and `media_type` in attachements if they are missing. Goffi <goffi@goffi.org> parents: 3173 diff changeset	1236 for attachment in data['extra'].get(C.MESS_KEY_ATTACHMENTS, []):
b9a2dd4d750a core (xmpp): add `name` and `media_type` in attachements if they are missing. Goffi <goffi@goffi.org> parents: 3173 diff changeset	1237 if "name" not in attachment:
3184 e8ce30798d15 core (xmpp): use pathlib.Path to complete attachments names, and use name to guess type Goffi <goffi@goffi.org> parents: 3183 diff changeset	1238 name = (Path(unquote(urlparse(attachment['url']).path)).name
e8ce30798d15 core (xmpp): use pathlib.Path to complete attachments names, and use name to guess type Goffi <goffi@goffi.org> parents: 3183 diff changeset	1239 or C.FILE_DEFAULT_NAME)
3175 b9a2dd4d750a core (xmpp): add `name` and `media_type` in attachements if they are missing. Goffi <goffi@goffi.org> parents: 3173 diff changeset	1240 attachment["name"] = name
3196 adf1aeaa0d37 core (constants): renamed `MESS_KEY_MEDIA_TYPE` to `MESS_KEY_ATTACHMENTS_MEDIA_TYPE` Goffi <goffi@goffi.org> parents: 3184 diff changeset	1241 if C.MESS_KEY_ATTACHMENTS_MEDIA_TYPE not in attachment:
3184 e8ce30798d15 core (xmpp): use pathlib.Path to complete attachments names, and use name to guess type Goffi <goffi@goffi.org> parents: 3183 diff changeset	1242 media_type = mimetypes.guess_type(attachment['name'], strict=False)[0]
3175 b9a2dd4d750a core (xmpp): add `name` and `media_type` in attachements if they are missing. Goffi <goffi@goffi.org> parents: 3173 diff changeset	1243 if media_type:
3196 adf1aeaa0d37 core (constants): renamed `MESS_KEY_MEDIA_TYPE` to `MESS_KEY_ATTACHMENTS_MEDIA_TYPE` Goffi <goffi@goffi.org> parents: 3184 diff changeset	1244 attachment[C.MESS_KEY_ATTACHMENTS_MEDIA_TYPE] = media_type
3197 f4a28767ec35 core (xmpp): check that entity_jid is actually a jid in SatRosterProtocol.isJidInRoster Goffi <goffi@goffi.org> parents: 3196 diff changeset	1245
3175 b9a2dd4d750a core (xmpp): add `name` and `media_type` in attachements if they are missing. Goffi <goffi@goffi.org> parents: 3173 diff changeset	1246 return data
b9a2dd4d750a core (xmpp): add `name` and `media_type` in attachements if they are missing. Goffi <goffi@goffi.org> parents: 3173 diff changeset	1247
1963 a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	1248 def skipEmptyMessage(self, data):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1249 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	1250 raise failure.Failure(exceptions.CancelError("Cancelled empty message"))
a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	1251 return data
a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	1252
2715 b35c84ea73cf plugin XEP-0045: MAM implementation for MUC Goffi <goffi@goffi.org> parents: 2714 diff changeset	1253 def addToHistory(self, data):
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1254 if data.pop("history", None) == C.HISTORY_SKIP:
3059 aa728dc7b0ce core: `history is skipped as requested` log message is now at debug level Goffi <goffi@goffi.org> parents: 3044 diff changeset	1255 log.debug("history is skipped as requested")
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1256 data["extra"]["history"] = C.HISTORY_SKIP
2132 c0577837680a core: replaced SkipHistory exception by a key in mess_data: Goffi <goffi@goffi.org> parents: 2130 diff changeset	1257 else:
3173 343b8076e967 core (xmpp): new message key to handle attachments Goffi <goffi@goffi.org> parents: 3172 diff changeset	1258 # we need a message to store
343b8076e967 core (xmpp): new message key to handle attachments Goffi <goffi@goffi.org> parents: 3172 diff changeset	1259 if self.parent.isMessagePrintable(data):
2751 286a32a187e7 core (xmpp): don't add to history a message if there is no message and no subject. Goffi <goffi@goffi.org> parents: 2748 diff changeset	1260 return self.host.memory.addToHistory(self.parent, data)
286a32a187e7 core (xmpp): don't add to history a message if there is no message and no subject. Goffi <goffi@goffi.org> parents: 2748 diff changeset	1261 else:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1262 log.debug("not storing empty message to history: {data}"
2751 286a32a187e7 core (xmpp): don't add to history a message if there is no message and no subject. Goffi <goffi@goffi.org> parents: 2748 diff changeset	1263 .format(data=data))
663 8004c7d4aba7 core: Deferred in onMessage. Goffi <goffi@goffi.org> parents: 636 diff changeset	1264
2715 b35c84ea73cf plugin XEP-0045: MAM implementation for MUC Goffi <goffi@goffi.org> parents: 2714 diff changeset	1265 def bridgeSignal(self, __, data):
1963 a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	1266 try:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1267 data["extra"]["received_timestamp"] = str(data["received_timestamp"])
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1268 data["extra"]["delay_sender"] = data["delay_sender"]
1963 a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	1269 except KeyError:
a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	1270 pass
3228 cc3fea71c365 core (memory/encryption): set encrypted flag also for outgoing messages and put it in extra: Goffi <goffi@goffi.org> parents: 3226 diff changeset	1271 if self.client.encryption.isEncrypted(data):
cc3fea71c365 core (memory/encryption): set encrypted flag also for outgoing messages and put it in extra: Goffi <goffi@goffi.org> parents: 3226 diff changeset	1272 data["extra"]["encrypted"] = True
1963 a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	1273 if data is not None:
3173 343b8076e967 core (xmpp): new message key to handle attachments Goffi <goffi@goffi.org> parents: 3172 diff changeset	1274 if self.parent.isMessagePrintable(data):
2736 df2bc2e704bc core (xmpp): don't send message without message or subject to bridge (and log a warning in frontends if such a message is received) Goffi <goffi@goffi.org> parents: 2731 diff changeset	1275 self.host.bridge.messageNew(
df2bc2e704bc core (xmpp): don't send message without message or subject to bridge (and log a warning in frontends if such a message is received) Goffi <goffi@goffi.org> parents: 2731 diff changeset	1276 data["uid"],
df2bc2e704bc core (xmpp): don't send message without message or subject to bridge (and log a warning in frontends if such a message is received) Goffi <goffi@goffi.org> parents: 2731 diff changeset	1277 data["timestamp"],
df2bc2e704bc core (xmpp): don't send message without message or subject to bridge (and log a warning in frontends if such a message is received) Goffi <goffi@goffi.org> parents: 2731 diff changeset	1278 data["from"].full(),
df2bc2e704bc core (xmpp): don't send message without message or subject to bridge (and log a warning in frontends if such a message is received) Goffi <goffi@goffi.org> parents: 2731 diff changeset	1279 data["to"].full(),
df2bc2e704bc core (xmpp): don't send message without message or subject to bridge (and log a warning in frontends if such a message is received) Goffi <goffi@goffi.org> parents: 2731 diff changeset	1280 data["message"],
df2bc2e704bc core (xmpp): don't send message without message or subject to bridge (and log a warning in frontends if such a message is received) Goffi <goffi@goffi.org> parents: 2731 diff changeset	1281 data["subject"],
df2bc2e704bc core (xmpp): don't send message without message or subject to bridge (and log a warning in frontends if such a message is received) Goffi <goffi@goffi.org> parents: 2731 diff changeset	1282 data["type"],
3170 39d7327583e1 core: use serialised dict for `extra` in messageNew and historyGet Goffi <goffi@goffi.org> parents: 3162 diff changeset	1283 data_format.serialise(data["extra"]),
2736 df2bc2e704bc core (xmpp): don't send message without message or subject to bridge (and log a warning in frontends if such a message is received) Goffi <goffi@goffi.org> parents: 2731 diff changeset	1284 profile=self.parent.profile,
df2bc2e704bc core (xmpp): don't send message without message or subject to bridge (and log a warning in frontends if such a message is received) Goffi <goffi@goffi.org> parents: 2731 diff changeset	1285 )
df2bc2e704bc core (xmpp): don't send message without message or subject to bridge (and log a warning in frontends if such a message is received) Goffi <goffi@goffi.org> parents: 2731 diff changeset	1286 else:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1287 log.debug("Discarding bridge signal for empty message: {data}".format(
2736 df2bc2e704bc core (xmpp): don't send message without message or subject to bridge (and log a warning in frontends if such a message is received) Goffi <goffi@goffi.org> parents: 2731 diff changeset	1288 data=data))
1963 a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	1289 return data
1053 71d63750963e core (XMPP): message received (onMessage) refactoring: Goffi <goffi@goffi.org> parents: 1037 diff changeset	1290
1963 a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	1291 def cancelErrorTrap(self, failure_):
a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	1292 """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	1293 failure_.trap(exceptions.CancelError)
636 7ea6d5a86e58 plugin XEP-0085: Chat State Notifications souliane <souliane@mailoo.org> parents: 611 diff changeset	1294
589 d1b4805124a1 Fix pep8 support in src/core. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 587 diff changeset	1295
13 bd9e9997d540 wokkel integration (not finished yet) Goffi <goffi@goffi.org> parents: 12 diff changeset	1296 class SatRosterProtocol(xmppim.RosterClientProtocol):
2891 6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1297
13 bd9e9997d540 wokkel integration (not finished yet) Goffi <goffi@goffi.org> parents: 12 diff changeset	1298 def __init__(self, host):
bd9e9997d540 wokkel integration (not finished yet) Goffi <goffi@goffi.org> parents: 12 diff changeset	1299 xmppim.RosterClientProtocol.__init__(self)
bd9e9997d540 wokkel integration (not finished yet) Goffi <goffi@goffi.org> parents: 12 diff changeset	1300 self.host = host
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1301 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	1302 # XXX: the two following dicts keep a local copy of the roster
2891 6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1303 self._jids = {} # map from jids to RosterItem: key=jid value=RosterItem
1262 f8a8434dbac7 core: improved roster management + misc: Goffi <goffi@goffi.org> parents: 1246 diff changeset	1304 self._groups = {} # map from groups to jids: key=group value=set of jids
2891 6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1305
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1306 @property
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1307 def versioning(self):
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1308 """True if server support roster versioning"""
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1309 return (NS_ROSTER_VER, 'ver') in self.parent.xmlstream.features
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	1310
2891 6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1311 @property
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1312 def roster_cache(self):
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1313 """Cache of roster from storage
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1314
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1315 This property return a new PersistentDict on each call, it must be loaded
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1316 manually if necessary
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1317 """
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1318 return persistent.PersistentDict(NS_ROSTER_VER, self.parent.profile)
1262 f8a8434dbac7 core: improved roster management + misc: Goffi <goffi@goffi.org> parents: 1246 diff changeset	1319
f8a8434dbac7 core: improved roster management + misc: Goffi <goffi@goffi.org> parents: 1246 diff changeset	1320 def _registerItem(self, item):
f8a8434dbac7 core: improved roster management + misc: Goffi <goffi@goffi.org> parents: 1246 diff changeset	1321 """Register item in local cache
f8a8434dbac7 core: improved roster management + misc: Goffi <goffi@goffi.org> parents: 1246 diff changeset	1322
f8a8434dbac7 core: improved roster management + misc: Goffi <goffi@goffi.org> parents: 1246 diff changeset	1323 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	1324 @param item (RosterIem): item added
f8a8434dbac7 core: improved roster management + misc: Goffi <goffi@goffi.org> parents: 1246 diff changeset	1325 """
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1326 log.debug("registering item: {}".format(item.entity.full()))
1262 f8a8434dbac7 core: improved roster management + misc: Goffi <goffi@goffi.org> parents: 1246 diff changeset	1327 if item.entity.resource:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1328 log.warning(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1329 "Received a roster item with a resource, this is not common but not "
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1330 "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	1331 )
1262 f8a8434dbac7 core: improved roster management + misc: Goffi <goffi@goffi.org> parents: 1246 diff changeset	1332 if not item.subscriptionTo:
f8a8434dbac7 core: improved roster management + misc: Goffi <goffi@goffi.org> parents: 1246 diff changeset	1333 if not item.subscriptionFrom:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1334 log.info(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1335 _("There's no subscription between you and [{}]!").format(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1336 item.entity.full()
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1337 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1338 )
1262 f8a8434dbac7 core: improved roster management + misc: Goffi <goffi@goffi.org> parents: 1246 diff changeset	1339 else:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1340 log.info(_("You are not subscribed to [{}]!").format(item.entity.full()))
1262 f8a8434dbac7 core: improved roster management + misc: Goffi <goffi@goffi.org> parents: 1246 diff changeset	1341 if not item.subscriptionFrom:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1342 log.info(_("[{}] is not subscribed to you!").format(item.entity.full()))
1262 f8a8434dbac7 core: improved roster management + misc: Goffi <goffi@goffi.org> parents: 1246 diff changeset	1343
f8a8434dbac7 core: improved roster management + misc: Goffi <goffi@goffi.org> parents: 1246 diff changeset	1344 for group in item.groups:
f8a8434dbac7 core: improved roster management + misc: Goffi <goffi@goffi.org> parents: 1246 diff changeset	1345 self._groups.setdefault(group, set()).add(item.entity)
13 bd9e9997d540 wokkel integration (not finished yet) Goffi <goffi@goffi.org> parents: 12 diff changeset	1346
2891 6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1347 @defer.inlineCallbacks
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1348 def _cacheRoster(self, version):
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1349 """Serialise local roster and save it to storage
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1350
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1351 @param version(unicode): version of roster in local cache
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1352 """
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1353 roster_cache = self.roster_cache
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1354 yield roster_cache.clear()
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1355 roster_cache[ROSTER_VER_KEY] = version
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1356 for roster_jid, roster_item in self._jids.items():
2891 6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1357 roster_jid_s = roster_jid.full()
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1358 roster_item_elt = roster_item.toElement().toXml()
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1359 roster_cache[roster_jid_s] = roster_item_elt
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1360
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1361 @defer.inlineCallbacks
2892 82b781c46841 core: added a rosterResync method to bridge: Goffi <goffi@goffi.org> parents: 2891 diff changeset	1362 def resync(self):
82b781c46841 core: added a rosterResync method to bridge: Goffi <goffi@goffi.org> parents: 2891 diff changeset	1363 """Ask full roster to resync database
82b781c46841 core: added a rosterResync method to bridge: Goffi <goffi@goffi.org> parents: 2891 diff changeset	1364
82b781c46841 core: added a rosterResync method to bridge: Goffi <goffi@goffi.org> parents: 2891 diff changeset	1365 this should not be necessary, but may be used if user suspsect roster
82b781c46841 core: added a rosterResync method to bridge: Goffi <goffi@goffi.org> parents: 2891 diff changeset	1366 to be somehow corrupted
82b781c46841 core: added a rosterResync method to bridge: Goffi <goffi@goffi.org> parents: 2891 diff changeset	1367 """
82b781c46841 core: added a rosterResync method to bridge: Goffi <goffi@goffi.org> parents: 2891 diff changeset	1368 roster_cache = self.roster_cache
82b781c46841 core: added a rosterResync method to bridge: Goffi <goffi@goffi.org> parents: 2891 diff changeset	1369 yield roster_cache.clear()
82b781c46841 core: added a rosterResync method to bridge: Goffi <goffi@goffi.org> parents: 2891 diff changeset	1370 self._jids.clear()
82b781c46841 core: added a rosterResync method to bridge: Goffi <goffi@goffi.org> parents: 2891 diff changeset	1371 self._groups.clear()
82b781c46841 core: added a rosterResync method to bridge: Goffi <goffi@goffi.org> parents: 2891 diff changeset	1372 yield self.requestRoster()
82b781c46841 core: added a rosterResync method to bridge: Goffi <goffi@goffi.org> parents: 2891 diff changeset	1373
82b781c46841 core: added a rosterResync method to bridge: Goffi <goffi@goffi.org> parents: 2891 diff changeset	1374 @defer.inlineCallbacks
13 bd9e9997d540 wokkel integration (not finished yet) Goffi <goffi@goffi.org> parents: 12 diff changeset	1375 def requestRoster(self):
2891 6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1376 """Ask the server for Roster list """
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1377 if self.versioning:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1378 log.info(_("our server support roster versioning, we use it"))
2891 6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1379 roster_cache = self.roster_cache
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1380 yield roster_cache.load()
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1381 try:
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1382 version = roster_cache[ROSTER_VER_KEY]
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1383 except KeyError:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1384 log.info(_("no roster in cache, we start fresh"))
2891 6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1385 # u"" means we use versioning without valid roster in cache
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1386 version = ""
2891 6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1387 else:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1388 log.info(_("We have roster v{version} in cache").format(version=version))
2891 6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1389 # we deserialise cached roster to our local cache
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1390 for roster_jid_s, roster_item_elt_s in roster_cache.items():
2891 6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1391 if roster_jid_s == ROSTER_VER_KEY:
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1392 continue
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1393 roster_jid = jid.JID(roster_jid_s)
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1394 roster_item_elt = generic.parseXml(roster_item_elt_s.encode('utf-8'))
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1395 roster_item = xmppim.RosterItem.fromElement(roster_item_elt)
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1396 self._jids[roster_jid] = roster_item
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1397 self._registerItem(roster_item)
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1398 else:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1399 log.warning(_("our server doesn't support roster versioning"))
2891 6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1400 version = None
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1401
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1402 log.debug("requesting roster")
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1403 roster = yield self.getRoster(version=version)
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1404 if roster is None:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1405 log.debug("empty roster result received, we'll get roster item with roster "
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1406 "pushes")
2891 6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1407 else:
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1408 # a full roster is received
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1409 self._groups.clear()
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1410 self._jids = roster
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1411 for item in roster.values():
2891 6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1412 if not item.subscriptionTo and not item.subscriptionFrom and not item.ask:
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1413 # XXX: current behaviour: we don't want contact in our roster list
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1414 # if there is no presence subscription
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1415 # may change in the future
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1416 log.info(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1417 "Removing contact {} from roster because there is no presence "
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1418 "subscription".format(
2891 6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1419 item.jid
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1420 )
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1421 )
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1422 self.removeItem(item.entity) # FIXME: to be checked
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1423 else:
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1424 self._registerItem(item)
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1425 yield self._cacheRoster(roster.version)
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1426
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1427 if not self.got_roster.called:
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1428 # got_roster may already be called if we use resync()
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1429 self.got_roster.callback(None)
13 bd9e9997d540 wokkel integration (not finished yet) Goffi <goffi@goffi.org> parents: 12 diff changeset	1430
875 19d7d077478a core (xmpp): fix automatic contact deletion souliane <souliane@mailoo.org> parents: 819 diff changeset	1431 def removeItem(self, to_jid):
19d7d077478a core (xmpp): fix automatic contact deletion souliane <souliane@mailoo.org> parents: 819 diff changeset	1432 """Remove a contact from roster list
19d7d077478a core (xmpp): fix automatic contact deletion souliane <souliane@mailoo.org> parents: 819 diff changeset	1433 @param to_jid: a JID instance
1262 f8a8434dbac7 core: improved roster management + misc: Goffi <goffi@goffi.org> parents: 1246 diff changeset	1434 @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	1435 """
1262 f8a8434dbac7 core: improved roster management + misc: Goffi <goffi@goffi.org> parents: 1246 diff changeset	1436 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	1437
448ce3c9e2ac core: Roster cache refactoring: cache is now managed by client's SatRosterProtocol instance. Goffi <goffi@goffi.org> parents: 461 diff changeset	1438 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	1439 """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	1440
466 448ce3c9e2ac core: Roster cache refactoring: cache is now managed by client's SatRosterProtocol instance. Goffi <goffi@goffi.org> parents: 461 diff changeset	1441 @param item: RosterItem
1963 a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	1442 @return: dictionary of attributes
a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	1443 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1444 item_attr = {
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1445 "to": str(item.subscriptionTo),
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1446 "from": str(item.subscriptionFrom),
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1447 "ask": str(item.ask),
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1448 }
466 448ce3c9e2ac core: Roster cache refactoring: cache is now managed by client's SatRosterProtocol instance. Goffi <goffi@goffi.org> parents: 461 diff changeset	1449 if item.name:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1450 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	1451 return item_attr
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	1452
1262 f8a8434dbac7 core: improved roster management + misc: Goffi <goffi@goffi.org> parents: 1246 diff changeset	1453 def setReceived(self, request):
f8a8434dbac7 core: improved roster management + misc: Goffi <goffi@goffi.org> parents: 1246 diff changeset	1454 item = request.item
2891 6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1455 entity = item.entity
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1456 log.info(_("adding {entity} to roster").format(entity=entity.full()))
2891 6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1457 if request.version is not None:
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1458 # we update the cache in storage
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1459 roster_cache = self.roster_cache
2901 f6b0088ce247 code (xmpp): store version after roster item update + fix item removal: Goffi <goffi@goffi.org> parents: 2894 diff changeset	1460 roster_cache[entity.full()] = item.toElement().toXml()
2891 6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1461 roster_cache[ROSTER_VER_KEY] = request.version
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1462
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	1463 try: # update the cache for the groups the contact has been removed from
2891 6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1464 left_groups = set(self._jids[entity].groups).difference(item.groups)
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	1465 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	1466 jids_set = self._groups[group]
2891 6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1467 jids_set.remove(entity)
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	1468 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	1469 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	1470 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	1471 pass # no previous item registration (or it's been cleared)
2891 6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1472 self._jids[entity] = item
1398 f8ecce11a0bc core (xmmp): keep the roster groups cache synchronised + fixes a log.warning souliane <souliane@mailoo.org> parents: 1396 diff changeset	1473 self._registerItem(item)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1474 self.host.bridge.newContact(
2891 6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1475 entity.full(), self.getAttributes(item), item.groups, self.parent.profile
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1476 )
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	1477
1262 f8a8434dbac7 core: improved roster management + misc: Goffi <goffi@goffi.org> parents: 1246 diff changeset	1478 def removeReceived(self, request):
f8a8434dbac7 core: improved roster management + misc: Goffi <goffi@goffi.org> parents: 1246 diff changeset	1479 entity = request.item.entity
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1480 log.info(_("removing {entity} from roster").format(entity=entity.full()))
2891 6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1481 if request.version is not None:
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1482 # we update the cache in storage
6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1483 roster_cache = self.roster_cache
2901 f6b0088ce247 code (xmpp): store version after roster item update + fix item removal: Goffi <goffi@goffi.org> parents: 2894 diff changeset	1484 try:
f6b0088ce247 code (xmpp): store version after roster item update + fix item removal: Goffi <goffi@goffi.org> parents: 2894 diff changeset	1485 del roster_cache[request.item.entity.full()]
f6b0088ce247 code (xmpp): store version after roster item update + fix item removal: Goffi <goffi@goffi.org> parents: 2894 diff changeset	1486 except KeyError:
f6b0088ce247 code (xmpp): store version after roster item update + fix item removal: Goffi <goffi@goffi.org> parents: 2894 diff changeset	1487 # because we don't use load(), cache won't have the key, but it
f6b0088ce247 code (xmpp): store version after roster item update + fix item removal: Goffi <goffi@goffi.org> parents: 2894 diff changeset	1488 # will be deleted from storage anyway
f6b0088ce247 code (xmpp): store version after roster item update + fix item removal: Goffi <goffi@goffi.org> parents: 2894 diff changeset	1489 pass
2891 6a0f42e9410a core (xmpp): implemented roster versioning Goffi <goffi@goffi.org> parents: 2886 diff changeset	1490 roster_cache[ROSTER_VER_KEY] = request.version
466 448ce3c9e2ac core: Roster cache refactoring: cache is now managed by client's SatRosterProtocol instance. Goffi <goffi@goffi.org> parents: 461 diff changeset	1491
589 d1b4805124a1 Fix pep8 support in src/core. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 587 diff changeset	1492 # 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	1493 try:
1262 f8a8434dbac7 core: improved roster management + misc: Goffi <goffi@goffi.org> parents: 1246 diff changeset	1494 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	1495 except KeyError:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1496 log.error(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1497 "Received a roster remove event for an item not in cache ({})".format(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1498 entity
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1499 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1500 )
466 448ce3c9e2ac core: Roster cache refactoring: cache is now managed by client's SatRosterProtocol instance. Goffi <goffi@goffi.org> parents: 461 diff changeset	1501 return
448ce3c9e2ac core: Roster cache refactoring: cache is now managed by client's SatRosterProtocol instance. Goffi <goffi@goffi.org> parents: 461 diff changeset	1502 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	1503 try:
448ce3c9e2ac core: Roster cache refactoring: cache is now managed by client's SatRosterProtocol instance. Goffi <goffi@goffi.org> parents: 461 diff changeset	1504 jids_set = self._groups[group]
1262 f8a8434dbac7 core: improved roster management + misc: Goffi <goffi@goffi.org> parents: 1246 diff changeset	1505 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	1506 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	1507 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	1508 except KeyError:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1509 log.warning(
3316 5369ce5bcecf core (xmpp): text can now be specified in `sendError` Goffi <goffi@goffi.org> parents: 3254 diff changeset	1510 f"there is no cache for the group [{group}] of the removed roster "
5369ce5bcecf core (xmpp): text can now be specified in `sendError` Goffi <goffi@goffi.org> parents: 3254 diff changeset	1511 f"item [{entity}]"
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1512 )
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	1513
589 d1b4805124a1 Fix pep8 support in src/core. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 587 diff changeset	1514 # then we send the bridge signal
1262 f8a8434dbac7 core: improved roster management + misc: Goffi <goffi@goffi.org> parents: 1246 diff changeset	1515 self.host.bridge.contactDeleted(entity.full(), self.parent.profile)
50 daa1f01a5332 SàT improvement: Goffi <goffi@goffi.org> parents: 41 diff changeset	1516
305 15a12bf2bb62 core: server identities are now save in memory Goffi <goffi@goffi.org> parents: 292 diff changeset	1517 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	1518 """Return a list of groups"""
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1519 return list(self._groups.keys())
466 448ce3c9e2ac core: Roster cache refactoring: cache is now managed by client's SatRosterProtocol instance. Goffi <goffi@goffi.org> parents: 461 diff changeset	1520
1300 ba73798317a7 core: fixed items registration in roster management Goffi <goffi@goffi.org> parents: 1299 diff changeset	1521 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	1522 """Return RosterItem for a given jid
1262 f8a8434dbac7 core: improved roster management + misc: Goffi <goffi@goffi.org> parents: 1246 diff changeset	1523
1963 a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	1524 @param entity_jid(jid.JID): jid of the contact
a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	1525 @return(RosterItem, None): RosterItem instance
a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	1526 None if contact is not in cache
1262 f8a8434dbac7 core: improved roster management + misc: Goffi <goffi@goffi.org> parents: 1246 diff changeset	1527 """
1300 ba73798317a7 core: fixed items registration in roster management Goffi <goffi@goffi.org> parents: 1299 diff changeset	1528 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	1529
1262 f8a8434dbac7 core: improved roster management + misc: Goffi <goffi@goffi.org> parents: 1246 diff changeset	1530 def getJids(self):
f8a8434dbac7 core: improved roster management + misc: Goffi <goffi@goffi.org> parents: 1246 diff changeset	1531 """Return all jids of the roster"""
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1532 return list(self._jids.keys())
487 e789917fb59d core: added isJidInRoster method Goffi <goffi@goffi.org> parents: 484 diff changeset	1533
e789917fb59d core: added isJidInRoster method Goffi <goffi@goffi.org> parents: 484 diff changeset	1534 def isJidInRoster(self, entity_jid):
e789917fb59d core: added isJidInRoster method Goffi <goffi@goffi.org> parents: 484 diff changeset	1535 """Return True if jid is in roster"""
3197 f4a28767ec35 core (xmpp): check that entity_jid is actually a jid in SatRosterProtocol.isJidInRoster Goffi <goffi@goffi.org> parents: 3196 diff changeset	1536 if not isinstance(entity_jid, jid.JID):
f4a28767ec35 core (xmpp): check that entity_jid is actually a jid in SatRosterProtocol.isJidInRoster Goffi <goffi@goffi.org> parents: 3196 diff changeset	1537 raise exceptions.InternalError(
f4a28767ec35 core (xmpp): check that entity_jid is actually a jid in SatRosterProtocol.isJidInRoster Goffi <goffi@goffi.org> parents: 3196 diff changeset	1538 f"a JID is expected, not {type(entity_jid)}: {entity_jid!r}")
1262 f8a8434dbac7 core: improved roster management + misc: Goffi <goffi@goffi.org> parents: 1246 diff changeset	1539 return entity_jid in self._jids
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	1540
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	1541 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	1542 """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	1543 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	1544 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	1545 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	1546 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	1547 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	1548
466 448ce3c9e2ac core: Roster cache refactoring: cache is now managed by client's SatRosterProtocol instance. Goffi <goffi@goffi.org> parents: 461 diff changeset	1549 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	1550 """Return all items of the roster"""
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1551 return list(self._jids.values())
501 e9634d2e7b38 core, quick_frontend, primitivus, wix: Contacts List refactoring phase 1: Goffi <goffi@goffi.org> parents: 487 diff changeset	1552
e9634d2e7b38 core, quick_frontend, primitivus, wix: Contacts List refactoring phase 1: Goffi <goffi@goffi.org> parents: 487 diff changeset	1553 def getJidsFromGroup(self, group):
e9634d2e7b38 core, quick_frontend, primitivus, wix: Contacts List refactoring phase 1: Goffi <goffi@goffi.org> parents: 487 diff changeset	1554 try:
e9634d2e7b38 core, quick_frontend, primitivus, wix: Contacts List refactoring phase 1: Goffi <goffi@goffi.org> parents: 487 diff changeset	1555 return self._groups[group]
e9634d2e7b38 core, quick_frontend, primitivus, wix: Contacts List refactoring phase 1: Goffi <goffi@goffi.org> parents: 487 diff changeset	1556 except KeyError:
1300 ba73798317a7 core: fixed items registration in roster management Goffi <goffi@goffi.org> parents: 1299 diff changeset	1557 raise exceptions.UnknownGroupError(group)
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	1558
1450 7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1435 diff changeset	1559 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	1560 """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	1561
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1435 diff changeset	1562 @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	1563 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	1564 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	1565 @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	1566 @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	1567 """
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1435 diff changeset	1568 if type_ == C.ALL and groups is not None:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1569 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	1570
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1435 diff changeset	1571 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	1572 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	1573 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	1574 jids = set()
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1435 diff changeset	1575 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	1576 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	1577 return jids
7797dda847ae plugins xep-0277, groupblog: added subscriteToMany to replace massiveSubscribeGroupBlogs + added SatRosterProtocol.getJidsSet Goffi <goffi@goffi.org> parents: 1435 diff changeset	1578 else:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1579 raise ValueError("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	1580
1963 a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	1581 def getNick(self, entity_jid):
a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	1582 """Return a nick name for an entity
a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	1583
a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	1584 return nick choosed by user if available
a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	1585 else return user part of entity_jid
a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	1586 """
a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	1587 item = self.getItem(entity_jid)
a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	1588 if item is None:
a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	1589 return entity_jid.user
a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	1590 else:
a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	1591 return item.name or entity_jid.user
a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	1592
305 15a12bf2bb62 core: server identities are now save in memory Goffi <goffi@goffi.org> parents: 292 diff changeset	1593
13 bd9e9997d540 wokkel integration (not finished yet) Goffi <goffi@goffi.org> parents: 12 diff changeset	1594 class SatPresenceProtocol(xmppim.PresenceClientProtocol):
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3249 diff changeset	1595
13 bd9e9997d540 wokkel integration (not finished yet) Goffi <goffi@goffi.org> parents: 12 diff changeset	1596 def __init__(self, host):
bd9e9997d540 wokkel integration (not finished yet) Goffi <goffi@goffi.org> parents: 12 diff changeset	1597 xmppim.PresenceClientProtocol.__init__(self)
bd9e9997d540 wokkel integration (not finished yet) Goffi <goffi@goffi.org> parents: 12 diff changeset	1598 self.host = host
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	1599
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3249 diff changeset	1600 @property
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3249 diff changeset	1601 def client(self):
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3249 diff changeset	1602 return self.parent
6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3249 diff changeset	1603
944 e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 934 diff changeset	1604 def send(self, obj):
2543 60758de1c227 plugin XEP-0115: fixed caps initial check Goffi <goffi@goffi.org> parents: 2527 diff changeset	1605 presence_d = defer.succeed(None)
60758de1c227 plugin XEP-0115: fixed caps initial check Goffi <goffi@goffi.org> parents: 2527 diff changeset	1606 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	1607 return
2543 60758de1c227 plugin XEP-0115: fixed caps initial check Goffi <goffi@goffi.org> parents: 2527 diff changeset	1608 presence_d.addCallback(lambda __: super(SatPresenceProtocol, self).send(obj))
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3249 diff changeset	1609 return presence_d
944 e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 934 diff changeset	1610
13 bd9e9997d540 wokkel integration (not finished yet) Goffi <goffi@goffi.org> parents: 12 diff changeset	1611 def availableReceived(self, entity, show=None, statuses=None, priority=0):
334 698cbc6ebec8 core: fixed None instead of empty dict in availableReceived Goffi <goffi@goffi.org> parents: 333 diff changeset	1612 if not statuses:
698cbc6ebec8 core: fixed None instead of empty dict in availableReceived Goffi <goffi@goffi.org> parents: 333 diff changeset	1613 statuses = {}
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	1614
589 d1b4805124a1 Fix pep8 support in src/core. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 587 diff changeset	1615 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	1616 statuses[C.PRESENCE_STATUSES_DEFAULT] = statuses.pop(None)
13 bd9e9997d540 wokkel integration (not finished yet) Goffi <goffi@goffi.org> parents: 12 diff changeset	1617
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1618 if not self.host.trigger.point(
2820 7ab8684784c6 core: renamed presenceReceived to presence_reveiced + use "client" as first arguments instead of "profile" Goffi <goffi@goffi.org> parents: 2794 diff changeset	1619 "presence_received", self.parent, entity, show, priority, statuses
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1620 ):
1480 8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: 1450 diff changeset	1621 return
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: 1450 diff changeset	1622
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1623 self.host.memory.setPresenceStatus(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1624 entity, show or "", int(priority), statuses, self.parent.profile
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1625 )
13 bd9e9997d540 wokkel integration (not finished yet) Goffi <goffi@goffi.org> parents: 12 diff changeset	1626
589 d1b4805124a1 Fix pep8 support in src/core. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 587 diff changeset	1627 # now it's time to notify frontends
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1628 self.host.bridge.presenceUpdate(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1629 entity.full(), show or "", int(priority), statuses, self.parent.profile
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1630 )
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	1631
13 bd9e9997d540 wokkel integration (not finished yet) Goffi <goffi@goffi.org> parents: 12 diff changeset	1632 def unavailableReceived(self, entity, statuses=None):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1633 log.debug(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1634 _("presence update for [%(entity)s] (unavailable, statuses=%(statuses)s)")
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1635 % {"entity": entity, C.PRESENCE_STATUSES: statuses}
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1636 )
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	1637
333 4c835d614bdb core: fixed a None sent instead of empty dict in unavailableReceived Goffi <goffi@goffi.org> parents: 330 diff changeset	1638 if not statuses:
4c835d614bdb core: fixed a None sent instead of empty dict in unavailableReceived Goffi <goffi@goffi.org> parents: 330 diff changeset	1639 statuses = {}
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	1640
589 d1b4805124a1 Fix pep8 support in src/core. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 587 diff changeset	1641 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	1642 statuses[C.PRESENCE_STATUSES_DEFAULT] = statuses.pop(None)
13 bd9e9997d540 wokkel integration (not finished yet) Goffi <goffi@goffi.org> parents: 12 diff changeset	1643
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1644 if not self.host.trigger.point(
2820 7ab8684784c6 core: renamed presenceReceived to presence_reveiced + use "client" as first arguments instead of "profile" Goffi <goffi@goffi.org> parents: 2794 diff changeset	1645 "presence_received", self.parent, entity, C.PRESENCE_UNAVAILABLE, 0, statuses,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1646 ):
1170 2df6427a5299 plugin OTR: forces FINISHED state if we are in ENCRYPTED state on contact disconnection souliane <souliane@mailoo.org> parents: 1167 diff changeset	1647 return
2df6427a5299 plugin OTR: forces FINISHED state if we are in ENCRYPTED state on contact disconnection souliane <souliane@mailoo.org> parents: 1167 diff changeset	1648
1685 43a127b6a4f2 core: avoid to send presence unavailable signal when it's not necessary Goffi <goffi@goffi.org> parents: 1622 diff changeset	1649 # now it's time to notify frontends
2643 189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	1650 # 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	1651 # 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	1652 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1653 presence = self.host.memory.getEntityDatum(
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3249 diff changeset	1654 self.client, entity, "presence"
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1655 )
1690 772c8edd1057 core: fixed cache check on presence unavailable Goffi <goffi@goffi.org> parents: 1685 diff changeset	1656 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	1657 # 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	1658 pass
43a127b6a4f2 core: avoid to send presence unavailable signal when it's not necessary Goffi <goffi@goffi.org> parents: 1622 diff changeset	1659 else:
43a127b6a4f2 core: avoid to send presence unavailable signal when it's not necessary Goffi <goffi@goffi.org> parents: 1622 diff changeset	1660 if presence.show != C.PRESENCE_UNAVAILABLE:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1661 self.host.bridge.presenceUpdate(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1662 entity.full(),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1663 C.PRESENCE_UNAVAILABLE,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1664 0,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1665 statuses,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1666 self.parent.profile,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1667 )
1480 8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: 1450 diff changeset	1668
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1669 self.host.memory.setPresenceStatus(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1670 entity, C.PRESENCE_UNAVAILABLE, 0, statuses, self.parent.profile
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1671 )
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 572 diff changeset	1672
611 d722778b152c core: added Priority management Goffi <goffi@goffi.org> parents: 609 diff changeset	1673 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	1674 """Set a presence and statuses.
b06047e1c1fb primitivus: fix setting the presence and status souliane <souliane@mailoo.org> parents: 1431 diff changeset	1675
b06047e1c1fb primitivus: fix setting the presence and status souliane <souliane@mailoo.org> parents: 1431 diff changeset	1676 @param entity (jid.JID): entity
b06047e1c1fb primitivus: fix setting the presence and status souliane <souliane@mailoo.org> parents: 1431 diff changeset	1677 @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	1678 @param statuses (dict{unicode: unicode}): multilingual statuses with
b06047e1c1fb primitivus: fix setting the presence and status souliane <souliane@mailoo.org> parents: 1431 diff changeset	1679 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	1680 """
611 d722778b152c core: added Priority management Goffi <goffi@goffi.org> parents: 609 diff changeset	1681 if priority is None:
d722778b152c core: added Priority management Goffi <goffi@goffi.org> parents: 609 diff changeset	1682 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1683 priority = int(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1684 self.host.memory.getParamA(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1685 "Priority", "Connection", profile_key=self.parent.profile
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1686 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1687 )
611 d722778b152c core: added Priority management Goffi <goffi@goffi.org> parents: 609 diff changeset	1688 except ValueError:
d722778b152c core: added Priority management Goffi <goffi@goffi.org> parents: 609 diff changeset	1689 priority = 0
d722778b152c core: added Priority management Goffi <goffi@goffi.org> parents: 609 diff changeset	1690
734 b26dfac8e46c core: bad indentation in SatPresenceProtocol.available souliane <souliane@mailoo.org> parents: 726 diff changeset	1691 if statuses is None:
562 0bb2e0d1c878 core, plugin XEP-0054: avatar upload: Goffi <goffi@goffi.org> parents: 549 diff changeset	1692 statuses = {}
734 b26dfac8e46c core: bad indentation in SatPresenceProtocol.available souliane <souliane@mailoo.org> parents: 726 diff changeset	1693
b26dfac8e46c core: bad indentation in SatPresenceProtocol.available souliane <souliane@mailoo.org> parents: 726 diff changeset	1694 # default for us is None for wokkel
b26dfac8e46c core: bad indentation in SatPresenceProtocol.available souliane <souliane@mailoo.org> parents: 726 diff changeset	1695 # 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	1696 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	1697 statuses[None] = statuses.pop(C.PRESENCE_STATUSES_DEFAULT)
379 adcc41e4d6ea core: Fix status update crash Xavier Maillard <xavier@maillard.im> parents: 347 diff changeset	1698
734 b26dfac8e46c core: bad indentation in SatPresenceProtocol.available souliane <souliane@mailoo.org> parents: 726 diff changeset	1699 presence_elt = xmppim.AvailablePresence(entity, show, statuses, priority)
379 adcc41e4d6ea core: Fix status update crash Xavier Maillard <xavier@maillard.im> parents: 347 diff changeset	1700
562 0bb2e0d1c878 core, plugin XEP-0054: avatar upload: Goffi <goffi@goffi.org> parents: 549 diff changeset	1701 # ... before switching back
0bb2e0d1c878 core, plugin XEP-0054: avatar upload: Goffi <goffi@goffi.org> parents: 549 diff changeset	1702 if None in statuses:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1703 statuses["default"] = statuses.pop(None)
379 adcc41e4d6ea core: Fix status update crash Xavier Maillard <xavier@maillard.im> parents: 347 diff changeset	1704
1167 fe102b4cf275 core (xmpp): fixes SatPresenceProtocol.available to prevent an eventual code skipping souliane <souliane@mailoo.org> parents: 1089 diff changeset	1705 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	1706 return
3254 6cf4bd6972c2 core, frontends: avatar refactoring: Goffi <goffi@goffi.org> parents: 3249 diff changeset	1707 return self.send(presence_elt)
1167 fe102b4cf275 core (xmpp): fixes SatPresenceProtocol.available to prevent an eventual code skipping souliane <souliane@mailoo.org> parents: 1089 diff changeset	1708
1963 a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	1709 @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	1710 def subscribed(self, entity):
1963 a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	1711 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	1712 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	1713 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	1714 item = self.parent.roster.getItem(entity)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1715 if (
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1716 not item or not item.subscriptionTo
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1717 ): # we automatically subscribe to 'to' presence
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 960 diff changeset	1718 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	1719 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	1720
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	1721 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	1722 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	1723 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	1724
13 bd9e9997d540 wokkel integration (not finished yet) Goffi <goffi@goffi.org> parents: 12 diff changeset	1725 def subscribedReceived(self, entity):
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1726 log.debug(_("subscription approved for [%s]") % entity.userhost())
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1727 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	1728
bd9e9997d540 wokkel integration (not finished yet) Goffi <goffi@goffi.org> parents: 12 diff changeset	1729 def unsubscribedReceived(self, entity):
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1730 log.debug(_("unsubscription confirmed for [%s]") % entity.userhost())
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1731 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	1732
1963 a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	1733 @defer.inlineCallbacks
13 bd9e9997d540 wokkel integration (not finished yet) Goffi <goffi@goffi.org> parents: 12 diff changeset	1734 def subscribeReceived(self, entity):
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1735 log.debug(_("subscription request from [%s]") % entity.userhost())
1963 a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	1736 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	1737 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	1738 if item and item.subscriptionTo:
2643 189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	1739 # 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	1740 # contact presence
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1741 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	1742 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	1743 else:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1744 self.host.memory.addWaitingSub(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1745 "subscribe", entity.userhost(), self.parent.profile
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1746 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1747 self.host.bridge.subscribe(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1748 "subscribe", entity.userhost(), self.parent.profile
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1749 )
13 bd9e9997d540 wokkel integration (not finished yet) Goffi <goffi@goffi.org> parents: 12 diff changeset	1750
1963 a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	1751 @defer.inlineCallbacks
13 bd9e9997d540 wokkel integration (not finished yet) Goffi <goffi@goffi.org> parents: 12 diff changeset	1752 def unsubscribeReceived(self, entity):
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1753 log.debug(_("unsubscription asked for [%s]") % entity.userhost())
1963 a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	1754 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	1755 item = self.parent.roster.getItem(entity)
589 d1b4805124a1 Fix pep8 support in src/core. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 587 diff changeset	1756 if item and item.subscriptionFrom: # we automatically remove contact
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1757 log.debug(_("automatic contact deletion"))
875 19d7d077478a core (xmpp): fix automatic contact deletion souliane <souliane@mailoo.org> parents: 819 diff changeset	1758 self.host.delContact(entity, self.parent.profile)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1759 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	1760
589 d1b4805124a1 Fix pep8 support in src/core. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 587 diff changeset	1761
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1762 @implementer(iwokkel.IDisco)
14 a62d7d453f22 wokkel integration, part II Goffi <goffi@goffi.org> parents: 13 diff changeset	1763 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	1764
14 a62d7d453f22 wokkel integration, part II Goffi <goffi@goffi.org> parents: 13 diff changeset	1765 def __init__(self, host):
a62d7d453f22 wokkel integration, part II Goffi <goffi@goffi.org> parents: 13 diff changeset	1766 disco.DiscoClientProtocol.__init__(self)
a62d7d453f22 wokkel integration, part II Goffi <goffi@goffi.org> parents: 13 diff changeset	1767
2688 943e78e18882 core (xmpp): added missing disco#info namespace to disco info result. Goffi <goffi@goffi.org> parents: 2687 diff changeset	1768 def getDiscoInfo(self, requestor, target, nodeIdentifier=""):
2778 f7deb1c36b47 core, XEP-0315: move XML element handling to sat_tmp: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1769 # those features are implemented in Wokkel (or sat_tmp.wokkel)
f7deb1c36b47 core, XEP-0315: move XML element handling to sat_tmp: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1770 # and thus are always available
2693 f64f1158a26e core (xmpp): added NS_X_DATA to disco features Goffi <goffi@goffi.org> parents: 2691 diff changeset	1771 return [disco.DiscoFeature(NS_X_DATA),
2778 f7deb1c36b47 core, XEP-0315: move XML element handling to sat_tmp: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1772 disco.DiscoFeature(NS_XML_ELEMENT),
2693 f64f1158a26e core (xmpp): added NS_X_DATA to disco features Goffi <goffi@goffi.org> parents: 2691 diff changeset	1773 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	1774
943e78e18882 core (xmpp): added missing disco#info namespace to disco info result. Goffi <goffi@goffi.org> parents: 2687 diff changeset	1775 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	1776 return []
943e78e18882 core (xmpp): added missing disco#info namespace to disco info result. Goffi <goffi@goffi.org> parents: 2687 diff changeset	1777
589 d1b4805124a1 Fix pep8 support in src/core. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 587 diff changeset	1778
15 218ec9984fa5 wokkel integration part III + memory saved again Goffi <goffi@goffi.org> parents: 14 diff changeset	1779 class SatFallbackHandler(generic.FallbackHandler):
218ec9984fa5 wokkel integration part III + memory saved again Goffi <goffi@goffi.org> parents: 14 diff changeset	1780 def __init__(self, host):
218ec9984fa5 wokkel integration part III + memory saved again Goffi <goffi@goffi.org> parents: 14 diff changeset	1781 generic.FallbackHandler.__init__(self)
218ec9984fa5 wokkel integration part III + memory saved again Goffi <goffi@goffi.org> parents: 14 diff changeset	1782
218ec9984fa5 wokkel integration part III + memory saved again Goffi <goffi@goffi.org> parents: 14 diff changeset	1783 def iqFallback(self, iq):
589 d1b4805124a1 Fix pep8 support in src/core. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 587 diff changeset	1784 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	1785 return
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1786 log.debug("iqFallback: xml = [%s]" % (iq.toXml()))
15 218ec9984fa5 wokkel integration part III + memory saved again Goffi <goffi@goffi.org> parents: 14 diff changeset	1787 generic.FallbackHandler.iqFallback(self, iq)
16 0a024d5e0cd0 New account creation (in-band registration) Goffi <goffi@goffi.org> parents: 15 diff changeset	1788
589 d1b4805124a1 Fix pep8 support in src/core. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 587 diff changeset	1789
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	1790 class SatVersionHandler(generic.VersionHandler):
2643 189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	1791
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	1792 def getDiscoInfo(self, requestor, target, node):
2643 189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	1793 # 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	1794 # 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	1795 # 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	1796 # 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	1797 # 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	1798 # 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	1799 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	1800
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	1801
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2994 diff changeset	1802 @implementer(iwokkel.IDisco)
666 2a7185b8452c core: added SatIdentityHandler for Disco Identity, and set identity to "client/pc/Salut à Toi" Goffi <goffi@goffi.org> parents: 663 diff changeset	1803 class SatIdentityHandler(XMPPHandler):
2643 189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	1804 """Manage disco Identity of SàT."""
189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	1805 # 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	1806 # 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	1807
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1808 def getDiscoInfo(self, requestor, target, nodeIdentifier=""):
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2139 diff changeset	1809 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	1810
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2596 diff changeset	1811 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	1812 return []

Mercurial > libervia-backend

annotate sat/core/xmpp.py @ 3370:2157880ba3b4