libervia-backend: libervia/backend/plugins/plugin_xep_0166/__init_

annotate libervia/backend/plugins/plugin_xep_0166/init.py @ 4258:ba28ca268f4a

plugin text syntaxes: fix empty string handling in `_remove_markups`.

author	Goffi <goffi@goffi.org>
date	Wed, 05 Jun 2024 22:33:37 +0200
parents	79c8a70e1813
children	0d7bb4df2343

rev	line source
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	1 #!/usr/bin/env python3
3137 559a625a236b fixed shebangs Goffi <goffi@goffi.org> parents: 3136 diff changeset	2
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	3 # Libervia plugin for Jingle (XEP-0166)
3479 be6d91572633 date update Goffi <goffi@goffi.org> parents: 3404 diff changeset	4 # Copyright (C) 2009-2021 Jérôme Poisson (goffi@goffi.org)
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	5
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	6 # This program is free software: you can redistribute it and/or modify
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	7 # it under the terms of the GNU Affero General Public License as published by
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	8 # the Free Software Foundation, either version 3 of the License, or
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	9 # (at your option) any later version.
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	10
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	11 # This program is distributed in the hope that it will be useful,
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	14 # GNU Affero General Public License for more details.
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	15
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	16 # You should have received a copy of the GNU Affero General Public License
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	17 # along with this program. If not, see <http://www.gnu.org/licenses/>.
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	18
3333 ac9342f359e9 plugin XEP-0329: download thumbnails: Goffi <goffi@goffi.org> parents: 3137 diff changeset	19
ac9342f359e9 plugin XEP-0329: download thumbnails: Goffi <goffi@goffi.org> parents: 3137 diff changeset	20 import time
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	21 from typing import Any, Callable, Dict, Final, List, Optional, Tuple
3969 8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	22 import uuid
8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	23
3333 ac9342f359e9 plugin XEP-0329: download thumbnails: Goffi <goffi@goffi.org> parents: 3137 diff changeset	24 from twisted.internet import defer
ac9342f359e9 plugin XEP-0329: download thumbnails: Goffi <goffi@goffi.org> parents: 3137 diff changeset	25 from twisted.internet import reactor
3969 8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	26 from twisted.python import failure
8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	27 from twisted.words.protocols.jabber import jid
3333 ac9342f359e9 plugin XEP-0329: download thumbnails: Goffi <goffi@goffi.org> parents: 3137 diff changeset	28 from twisted.words.protocols.jabber import error
ac9342f359e9 plugin XEP-0329: download thumbnails: Goffi <goffi@goffi.org> parents: 3137 diff changeset	29 from twisted.words.protocols.jabber import xmlstream
3969 8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	30 from twisted.words.xish import domish
3333 ac9342f359e9 plugin XEP-0329: download thumbnails: Goffi <goffi@goffi.org> parents: 3137 diff changeset	31 from wokkel import disco, iwokkel
3969 8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	32 from zope.interface import implementer
8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	33
4071 4b842c1fb686 refactoring: renamed `sat` package to `libervia.backend` Goffi <goffi@goffi.org> parents: 4053 diff changeset	34 from libervia.backend.core import exceptions
4b842c1fb686 refactoring: renamed `sat` package to `libervia.backend` Goffi <goffi@goffi.org> parents: 4053 diff changeset	35 from libervia.backend.core.constants import Const as C
4b842c1fb686 refactoring: renamed `sat` package to `libervia.backend` Goffi <goffi@goffi.org> parents: 4053 diff changeset	36 from libervia.backend.core.core_types import SatXMPPEntity
4b842c1fb686 refactoring: renamed `sat` package to `libervia.backend` Goffi <goffi@goffi.org> parents: 4053 diff changeset	37 from libervia.backend.core.i18n import D_, _
4b842c1fb686 refactoring: renamed `sat` package to `libervia.backend` Goffi <goffi@goffi.org> parents: 4053 diff changeset	38 from libervia.backend.core.log import getLogger
4b842c1fb686 refactoring: renamed `sat` package to `libervia.backend` Goffi <goffi@goffi.org> parents: 4053 diff changeset	39 from libervia.backend.tools import xml_tools
4b842c1fb686 refactoring: renamed `sat` package to `libervia.backend` Goffi <goffi@goffi.org> parents: 4053 diff changeset	40 from libervia.backend.tools import utils
3333 ac9342f359e9 plugin XEP-0329: download thumbnails: Goffi <goffi@goffi.org> parents: 3137 diff changeset	41
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	42 from .models import (
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	43 ApplicationData,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	44 BaseApplicationHandler,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	45 BaseTransportHandler,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	46 ContentData,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	47 TransportData,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	48 )
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	49
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	50
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	51 log = getLogger(__name__)
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	52
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	53
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	54 IQ_SET : Final = '/iq[@type="set"]'
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	55 NS_JINGLE : Final = "urn:xmpp:jingle:1"
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	56 NS_JINGLE_ERROR : Final = "urn:xmpp:jingle:errors:1"
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	57 JINGLE_REQUEST : Final = f'{IQ_SET}/jingle[@xmlns="{NS_JINGLE}"]'
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	58 CONFIRM_TXT : Final = D_(
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	59 "{entity} want to start a jingle session with you, do you accept ?"
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	60 )
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	61
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	62 PLUGIN_INFO : Final = {
2145 33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 2144 diff changeset	63 C.PI_NAME: "Jingle",
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 2144 diff changeset	64 C.PI_IMPORT_NAME: "XEP-0166",
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 2144 diff changeset	65 C.PI_TYPE: "XEP",
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	66 C.PI_MODES: C.PLUG_MODE_BOTH,
2145 33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 2144 diff changeset	67 C.PI_PROTOCOLS: ["XEP-0166"],
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 2144 diff changeset	68 C.PI_MAIN: "XEP_0166",
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 2144 diff changeset	69 C.PI_HANDLER: "yes",
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	70 C.PI_DESCRIPTION: _("""Implementation of Jingle"""),
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	71 }
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	72
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	73
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	74 class XEP_0166:
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	75 namespace : Final = NS_JINGLE
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	76
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	77 ROLE_INITIATOR : Final = "initiator"
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	78 ROLE_RESPONDER : Final = "responder"
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	79
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	80 TRANSPORT_DATAGRAM : Final = "UDP"
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	81 TRANSPORT_STREAMING : Final = "TCP"
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	82
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	83 REASON_SUCCESS : Final = "success"
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	84 REASON_DECLINE : Final = "decline"
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	85 REASON_FAILED_APPLICATION : Final = "failed-application"
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	86 REASON_FAILED_TRANSPORT : Final = "failed-transport"
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	87 REASON_CONNECTIVITY_ERROR : Final = "connectivity-error"
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	88
4116 23fa52acf72c plugin XEP-0167, XEP-0176: transport-info and ICE candidate sending are delayed if session is not active yet Goffi <goffi@goffi.org> parents: 4114 diff changeset	89 STATE_PENDING : Final = "PENDING"
23fa52acf72c plugin XEP-0167, XEP-0176: transport-info and ICE candidate sending are delayed if session is not active yet Goffi <goffi@goffi.org> parents: 4114 diff changeset	90 STATE_ACTIVE : Final = "ACTIVE"
23fa52acf72c plugin XEP-0167, XEP-0176: transport-info and ICE candidate sending are delayed if session is not active yet Goffi <goffi@goffi.org> parents: 4114 diff changeset	91 STATE_ENDED : Final = "ENDED"
23fa52acf72c plugin XEP-0167, XEP-0176: transport-info and ICE candidate sending are delayed if session is not active yet Goffi <goffi@goffi.org> parents: 4114 diff changeset	92
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	93 # standard actions
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	94
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	95 A_SESSION_INITIATE : Final = "session-initiate"
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	96 A_SESSION_ACCEPT : Final = "session-accept"
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	97 A_SESSION_TERMINATE : Final = "session-terminate"
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	98 A_SESSION_INFO : Final = "session-info"
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	99 A_TRANSPORT_REPLACE : Final = "transport-replace"
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	100 A_TRANSPORT_ACCEPT : Final = "transport-accept"
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	101 A_TRANSPORT_REJECT : Final = "transport-reject"
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	102 A_TRANSPORT_INFO : Final = "transport-info"
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	103
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	104 # non standard actions
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	105
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	106 #: called before the confirmation request, first event for responder, useful for
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	107 #: parsing
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	108 A_PREPARE_CONFIRMATION : Final = "prepare-confirmation"
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	109 #: initiator must prepare tranfer
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	110 A_PREPARE_INITIATOR : Final = "prepare-initiator"
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	111 #: responder must prepare tranfer
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	112 A_PREPARE_RESPONDER : Final = "prepare-responder"
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	113 #; session accepted ack has been received from initiator
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	114 A_ACCEPTED_ACK : Final = (
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	115 "accepted-ack"
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	116 )
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	117 A_START : Final = "start" # application can start
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	118 #: called when a transport is destroyed (e.g. because it is remplaced). Used to do
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	119 #: cleaning operations
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	120 A_DESTROY : Final = (
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	121 "destroy"
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	122 )
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	123
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	124 def __init__(self, host):
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	125 log.info(_("plugin Jingle initialization"))
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	126 self.host = host
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	127 self._applications = {} # key: namespace, value: application data
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	128 self._transports = {} # key: namespace, value: transport data
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	129 # we also keep transports by type, they are then sorted by priority
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	130 self._type_transports = {
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	131 XEP_0166.TRANSPORT_DATAGRAM: [],
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	132 XEP_0166.TRANSPORT_STREAMING: [],
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	133 }
4111 a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	134 host.bridge.add_method(
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	135 "jingle_terminate",
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	136 ".plugin",
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	137 in_sign="ssss",
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	138 out_sign="",
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	139 method=self._terminate,
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	140 async_=True,
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	141 )
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	142
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	143 def profile_connected(self, client):
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	144 client.jingle_sessions = {} # key = sid, value = session_data
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	145
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	146 def get_handler(self, client):
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	147 return XEP_0166_handler(self)
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	148
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	149 def get_session(self, client: SatXMPPEntity, session_id: str) -> dict:
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	150 """Retrieve session from its SID
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	151
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	152 @param session_id: session ID
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	153 @return: found session
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	154
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	155 @raise exceptions.NotFound: no session with this SID has been found
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	156 """
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	157 try:
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	158 return client.jingle_sessions[session_id]
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	159 except KeyError:
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	160 raise exceptions.NotFound(
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	161 f"No session with SID {session_id} found"
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	162 )
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	163
4111 a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	164 def create_session(
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	165 self,
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	166 client: SatXMPPEntity,
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	167 sid: str,
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	168 role: str,
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	169 peer_jid: jid.JID,
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	170 local_jid: jid.JID\|None = None,
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	171 **kwargs
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	172 ) -> dict:
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	173 """Create a new jingle session.
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	174
4111 a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	175 @param client: The client entity.
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	176 @param sid: Session ID.
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	177 @param role: Session role (initiator or responder).
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	178 @param peer_jid: JID of the peer.
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	179 @param local_jid: JID of the local entity.
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	180 If None, defaults to client.jid.
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	181 @param extra_data: Additional data to be added to the session. Defaults to None.
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	182
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	183 @return: The created session.
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	184
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	185 @raise ValueError: If the provided role is neither initiator nor responder.
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	186 """
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	187 # TODO: session cleaning after timeout ?
4114 79ec7d7beef3 plugin XEP-0166: reject session creation is session ID is empty Goffi <goffi@goffi.org> parents: 4112 diff changeset	188
79ec7d7beef3 plugin XEP-0166: reject session creation is session ID is empty Goffi <goffi@goffi.org> parents: 4112 diff changeset	189 if not sid:
79ec7d7beef3 plugin XEP-0166: reject session creation is session ID is empty Goffi <goffi@goffi.org> parents: 4112 diff changeset	190 raise exceptions.DataError("Empty session ID is not allowed")
79ec7d7beef3 plugin XEP-0166: reject session creation is session ID is empty Goffi <goffi@goffi.org> parents: 4112 diff changeset	191
4111 a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	192 if role not in [XEP_0166.ROLE_INITIATOR, XEP_0166.ROLE_RESPONDER]:
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	193 raise ValueError(f"Invalid role {role}. Expected initiator or responder.")
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	194
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	195
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	196 session_data = {
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	197 "id": sid,
4116 23fa52acf72c plugin XEP-0167, XEP-0176: transport-info and ICE candidate sending are delayed if session is not active yet Goffi <goffi@goffi.org> parents: 4114 diff changeset	198 "state": XEP_0166.STATE_PENDING,
4111 a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	199 "initiator": client.jid if role == XEP_0166.ROLE_INITIATOR else peer_jid,
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	200 "role": role,
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	201 "local_jid": local_jid or client.jid,
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	202 "peer_jid": peer_jid,
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	203 "started": time.time(),
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	204 "contents": {}
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	205 }
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	206
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	207 # If extra kw args are provided, merge them into the session_data
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	208 if kwargs:
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	209 session_data.update(kwargs)
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	210
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	211 # Add the session to the client's jingle sessions
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	212 client.jingle_sessions[sid] = session_data
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	213
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	214 return session_data
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	215
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	216
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	217 def delete_session(self, client, sid):
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	218 try:
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	219 del client.jingle_sessions[sid]
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	220 except KeyError:
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	221 log.debug(
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	222 f"Jingle session id {sid!r} is unknown, nothing to delete "
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	223 f"[{client.profile}]")
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	224 else:
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	225 log.debug(f"Jingle session id {sid!r} deleted [{client.profile}]")
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	226
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	227 ## helpers methods to build stanzas ##
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	228
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	229 def _build_jingle_elt(
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	230 self,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	231 client: SatXMPPEntity,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	232 session: dict,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	233 action: str
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	234 ) -> Tuple[xmlstream.IQ, domish.Element]:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	235 iq_elt = client.IQ("set")
2927 69e4716d6268 plugins (jingle) file transfer: use initial "from" attribute as local jid instead of client.jid: Goffi <goffi@goffi.org> parents: 2920 diff changeset	236 iq_elt["from"] = session['local_jid'].full()
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	237 iq_elt["to"] = session["peer_jid"].full()
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	238 jingle_elt = iq_elt.addElement("jingle", NS_JINGLE)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	239 jingle_elt["sid"] = session["id"]
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	240 jingle_elt["action"] = action
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	241 return iq_elt, jingle_elt
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	242
2489 e2a7bb875957 plugin pipe/stream, file transfert: refactoring and improvments: Goffi <goffi@goffi.org> parents: 2487 diff changeset	243 def sendError(self, client, error_condition, sid, request, jingle_condition=None):
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	244 """Send error stanza
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	245
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	246 @param error_condition: one of twisted.words.protocols.jabber.error.STANZA_CONDITIONS keys
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	247 @param sid(unicode,None): jingle session id, or None, if session must not be destroyed
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	248 @param request(domish.Element): original request
1614 1ced93821c35 plugin XEP-0166: sendError now manage jingle conditions Goffi <goffi@goffi.org> parents: 1585 diff changeset	249 @param jingle_condition(None, unicode): if not None, additional jingle-specific error information
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	250 """
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	251 iq_elt = error.StanzaError(error_condition).toResponse(request)
1614 1ced93821c35 plugin XEP-0166: sendError now manage jingle conditions Goffi <goffi@goffi.org> parents: 1585 diff changeset	252 if jingle_condition is not None:
1ced93821c35 plugin XEP-0166: sendError now manage jingle conditions Goffi <goffi@goffi.org> parents: 1585 diff changeset	253 iq_elt.error.addElement((NS_JINGLE_ERROR, jingle_condition))
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	254 if error.STANZA_CONDITIONS[error_condition]["type"] == "cancel" and sid:
4111 a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	255 self.delete_session(client, sid)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	256 log.warning(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	257 "Error while managing jingle session, cancelling: {condition}".format(
2920 945e53cde9b2 plugin XEP-0166: fixed missing key in warning log Goffi <goffi@goffi.org> parents: 2771 diff changeset	258 condition=error_condition
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	259 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	260 )
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	261 return client.send(iq_elt)
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	262
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	263 def _terminate_eb(self, failure_):
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	264 log.warning(_("Error while terminating session: {msg}").format(msg=failure_))
2487 ed1d71b91b29 plugin XEP-0166: added errback to terminate, which only logs issues Goffi <goffi@goffi.org> parents: 2483 diff changeset	265
4111 a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	266 def _terminate(
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	267 self,
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	268 session_id: str,
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	269 reason: str,
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	270 reason_txt: str,
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	271 profile: str
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	272 ) -> defer.Deferred:
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	273 client = self.host.get_client(profile)
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	274 session = self.get_session(client, session_id)
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	275 if reason not in ("", "cancel", "decline", "busy"):
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	276 raise ValueError(
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	277 'only "cancel", "decline" and "busy" and empty value are allowed'
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	278 )
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	279 return self.terminate(
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	280 client,
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	281 reason or None,
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	282 session,
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	283 text=reason_txt or None
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	284 )
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	285
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	286 def terminate(
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	287 self,
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	288 client: SatXMPPEntity,
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	289 reason: str\|list[domish.Element]\|None,
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	290 session: dict,
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	291 text: str\|None = None
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	292 ) -> defer.Deferred:
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	293 """Terminate the session
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	294
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	295 send the session-terminate action, and delete the session data
4111 a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	296 @param reason: if unicode, will be transformed to an element
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	297 if a list of element, add them as children of the <reason/> element
4111 a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	298 @param session: data of the session
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	299 """
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	300 iq_elt, jingle_elt = self._build_jingle_elt(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	301 client, session, XEP_0166.A_SESSION_TERMINATE
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	302 )
4111 a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	303 if reason is not None:
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	304 reason_elt = jingle_elt.addElement("reason")
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	305 if isinstance(reason, str):
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	306 reason_elt.addElement(reason)
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	307 else:
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	308 for elt in reason:
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	309 reason_elt.addChild(elt)
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	310 else:
4111 a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	311 reason_elt = None
3527 bbf92ef05f38 plugin XEP-0166, XEP-0234: better management of `terminate`: Goffi <goffi@goffi.org> parents: 3479 diff changeset	312 if text is not None:
4111 a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	313 if reason_elt is None:
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	314 raise ValueError(
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	315 "You have to specify a reason if text is specified"
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	316 )
3527 bbf92ef05f38 plugin XEP-0166, XEP-0234: better management of `terminate`: Goffi <goffi@goffi.org> parents: 3479 diff changeset	317 reason_elt.addElement("text", content=text)
4111 a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	318 if not self.host.trigger.point(
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	319 "XEP-0166_terminate",
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	320 client, session, reason_elt
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	321 ):
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	322 return defer.succeed(None)
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	323 self.delete_session(client, session["id"])
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	324 d = iq_elt.send()
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	325 d.addErrback(self._terminate_eb)
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	326 return d
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	327
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	328 ## errors which doesn't imply a stanza sending ##
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	329
4240 79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	330 def _jingle_error_cb(
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	331 self,
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	332 failure_: failure.Failure\|BaseException,
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	333 session: dict,
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	334 request: domish.Element,
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	335 client: SatXMPPEntity
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	336 ) -> defer.Deferred:
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	337 """Called when something is going wrong while parsing jingle request
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	338
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	339 The error condition depend of the exceptions raised:
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	340 exceptions.DataError raise a bad-request condition
4240 79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	341 @param fail: the exceptions raised
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	342 @param session: data of the session
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	343 @param request: jingle request
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	344 @param client: SatXMPPEntity instance
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	345 """
4240 79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	346 if not isinstance(failure_, failure.Failure):
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	347 failure_ = failure.Failure(failure_)
4053 dd39e60ca2aa plugin XEP-0166: set `jingle_elt`, `desc_elt` and `transport_elt`: Goffi <goffi@goffi.org> parents: 4044 diff changeset	348 del session["jingle_elt"]
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	349 log.warning(f"Error while processing jingle request [{client.profile}]")
3527 bbf92ef05f38 plugin XEP-0166, XEP-0234: better management of `terminate`: Goffi <goffi@goffi.org> parents: 3479 diff changeset	350 if isinstance(failure_.value, defer.FirstError):
bbf92ef05f38 plugin XEP-0166, XEP-0234: better management of `terminate`: Goffi <goffi@goffi.org> parents: 3479 diff changeset	351 failure_ = failure_.value.subFailure.value
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	352 if isinstance(failure_, exceptions.DataError):
3527 bbf92ef05f38 plugin XEP-0166, XEP-0234: better management of `terminate`: Goffi <goffi@goffi.org> parents: 3479 diff changeset	353 return self.sendError(client, "bad-request", session["id"], request)
bbf92ef05f38 plugin XEP-0166, XEP-0234: better management of `terminate`: Goffi <goffi@goffi.org> parents: 3479 diff changeset	354 elif isinstance(failure_, error.StanzaError):
bbf92ef05f38 plugin XEP-0166, XEP-0234: better management of `terminate`: Goffi <goffi@goffi.org> parents: 3479 diff changeset	355 return self.terminate(client, self.REASON_FAILED_APPLICATION, session,
bbf92ef05f38 plugin XEP-0166, XEP-0234: better management of `terminate`: Goffi <goffi@goffi.org> parents: 3479 diff changeset	356 text=str(failure_))
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	357 else:
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	358 log.error(f"Unmanaged jingle exception: {failure_}")
3527 bbf92ef05f38 plugin XEP-0166, XEP-0234: better management of `terminate`: Goffi <goffi@goffi.org> parents: 3479 diff changeset	359 return self.terminate(client, self.REASON_FAILED_APPLICATION, session,
bbf92ef05f38 plugin XEP-0166, XEP-0234: better management of `terminate`: Goffi <goffi@goffi.org> parents: 3479 diff changeset	360 text=str(failure_))
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	361
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	362 ## methods used by other plugins ##
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	363
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	364 def register_application(
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	365 self,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	366 namespace: str,
4240 79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	367 handler: BaseApplicationHandler,
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	368 priority: int = 0
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	369 ) -> None:
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	370 """Register an application plugin
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	371
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	372 @param namespace(unicode): application namespace managed by the plugin
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	373 @param handler(object): instance of a class which manage the application.
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	374 May have the following methods:
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	375 - request_confirmation(session, desc_elt, client):
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	376 - if present, it is called on when session must be accepted.
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	377 - if it return True the session is accepted, else rejected.
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	378 A Deferred can be returned
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	379 - if not present, a generic accept dialog will be used
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	380 - jingle_session_init(
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	381 client, self, session, content_name[, args, *kwargs]
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	382 ): must return the domish.Element used for initial content
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	383 - jingle_handler(
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	384 client, self, action, session, content_name, transport_elt
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	385 ):
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	386 called on several action to negociate the application or transport
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	387 - jingle_terminate: called on session terminate, with reason_elt
1754 f4e9f2f7fe0f plugin XEP-0166: jingleTerminate is called (if present) on applications and transports plugins on session-terminate action, can be used to do some cleaning Goffi <goffi@goffi.org> parents: 1630 diff changeset	388 May be used to clean session
4240 79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	389 @param priority: Priority of the application. It is used when several contents
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	390 from different applications are used to determine in which order methods must
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	391 be called. An example use case is for remote control: when using remote
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	392 control, contents with call application may be used at the same time, but the
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	393 overall session is a remote control one (and so, a remote control confirmation
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	394 must be requested to the user, not a call one).
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	395 If two applications have the same priority, methods are called in the same
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	396 order as the content appears.
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	397 """
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	398 if namespace in self._applications:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	399 raise exceptions.ConflictError(
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	400 f"Trying to register already registered namespace {namespace}"
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	401 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	402 self._applications[namespace] = ApplicationData(
4240 79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	403 namespace=namespace, handler=handler, priority=priority
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	404 )
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	405 log.debug("new jingle application registered")
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	406
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	407 def register_transport(
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	408 self,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	409 namespace: str,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	410 transport_type: str,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	411 handler: BaseTransportHandler,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	412 priority: int = 0
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	413 ) -> None:
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	414 """Register a transport plugin
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	415
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	416 @param namespace: the XML namespace used for this transport
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	417 @param transport_type: type of transport to use (see XEP-0166 §8)
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	418 @param handler: instance of a class which manage the application.
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	419 @param priority: priority of this transport
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	420 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	421 assert transport_type in (
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	422 XEP_0166.TRANSPORT_DATAGRAM,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	423 XEP_0166.TRANSPORT_STREAMING,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	424 )
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	425 if namespace in self._transports:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	426 raise exceptions.ConflictError(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	427 "Trying to register already registered namespace {}".format(namespace)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	428 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	429 transport_data = TransportData(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	430 namespace=namespace, handler=handler, priority=priority
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	431 )
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	432 self._type_transports[transport_type].append(transport_data)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	433 self._type_transports[transport_type].sort(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	434 key=lambda transport_data: transport_data.priority, reverse=True
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	435 )
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	436 self._transports[namespace] = transport_data
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	437 log.debug("new jingle transport registered")
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	438
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	439 @defer.inlineCallbacks
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	440 def transport_replace(self, client, transport_ns, session, content_name):
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	441 """Replace a transport
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	442
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	443 @param transport_ns(unicode): namespace of the new transport to use
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	444 @param session(dict): jingle session data
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	445 @param content_name(unicode): name of the content
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	446 """
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	447 # XXX: for now we replace the transport before receiving confirmation from other peer
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	448 # this is acceptable because we terminate the session if transport is rejected.
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	449 # this behavious may change in the future.
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	450 content_data = session["contents"][content_name]
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	451 transport_data = content_data["transport_data"]
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	452 try:
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	453 transport = self._transports[transport_ns]
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	454 except KeyError:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	455 raise exceptions.InternalError("Unkown transport")
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	456 yield content_data["transport"].handler.jingle_handler(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	457 client, XEP_0166.A_DESTROY, session, content_name, None
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	458 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	459 content_data["transport"] = transport
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	460 transport_data.clear()
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	461
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	462 iq_elt, jingle_elt = self._build_jingle_elt(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	463 client, session, XEP_0166.A_TRANSPORT_REPLACE
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	464 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	465 content_elt = jingle_elt.addElement("content")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	466 content_elt["name"] = content_name
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	467 content_elt["creator"] = content_data["creator"]
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	468
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	469 transport_elt = transport.handler.jingle_session_init(client, session, content_name)
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	470 content_elt.addChild(transport_elt)
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	471 iq_elt.send()
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	472
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	473 def build_action(
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	474 self,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	475 client: SatXMPPEntity,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	476 action: str,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	477 session: dict,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	478 content_name: str,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	479 iq_elt: Optional[xmlstream.IQ] = None,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	480 context_elt: Optional[domish.Element] = None
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	481 ) -> Tuple[xmlstream.IQ, domish.Element]:
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	482 """Build an element according to requested action
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	483
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	484 @param action: a jingle action (see XEP-0166 §7.2),
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	485 session-* actions are not managed here
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	486 transport-replace is managed in the dedicated [transport_replace] method
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	487 @param session: jingle session data
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	488 @param content_name: name of the content
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	489 @param iq_elt: use this IQ instead of creating a new one if provided
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	490 @param context_elt: use this element instead of creating a new one if provided
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	491 @return: parent <iq> element, <transport> or <description> element, according to action
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	492 """
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	493 # we first build iq, jingle and content element which are the same in every cases
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	494 if iq_elt is not None:
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	495 try:
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	496 jingle_elt = next(iq_elt.elements(NS_JINGLE, "jingle"))
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	497 except StopIteration:
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	498 raise exceptions.InternalError(
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	499 "The <iq> element provided doesn't have a <jingle> element"
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	500 )
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	501 else:
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	502 iq_elt, jingle_elt = self._build_jingle_elt(client, session, action)
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	503 # FIXME: XEP-0260 § 2.3 Ex 5 has an initiator attribute, but it should not according to XEP-0166 §7.1 table 1, must be checked
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	504 content_data = session["contents"][content_name]
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	505 content_elt = jingle_elt.addElement("content")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	506 content_elt["name"] = content_name
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	507 content_elt["creator"] = content_data["creator"]
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	508
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	509 if context_elt is not None:
4116 23fa52acf72c plugin XEP-0167, XEP-0176: transport-info and ICE candidate sending are delayed if session is not active yet Goffi <goffi@goffi.org> parents: 4114 diff changeset	510 if context_elt.parent is None:
23fa52acf72c plugin XEP-0167, XEP-0176: transport-info and ICE candidate sending are delayed if session is not active yet Goffi <goffi@goffi.org> parents: 4114 diff changeset	511 content_elt.addChild(context_elt)
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	512 elif action == XEP_0166.A_TRANSPORT_INFO:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	513 context_elt = transport_elt = content_elt.addElement(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	514 "transport", content_data["transport"].namespace
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	515 )
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	516 else:
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	517 raise exceptions.InternalError(f"unmanaged action {action}")
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	518
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	519 return iq_elt, context_elt
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	520
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	521 def build_session_info(self, client, session):
1616 1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	522 """Build a session-info action
1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	523
1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	524 @param session(dict): jingle session data
1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	525 @return (tuple[domish.Element, domish.Element]): parent <iq> element, <jingle> element
1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	526 """
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	527 return self._build_jingle_elt(client, session, XEP_0166.A_SESSION_INFO)
1616 1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	528
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	529 def get_application(self, namespace: str) -> ApplicationData:
3404 26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	530 """Retreive application corresponding to a namespace
26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	531
26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	532 @raise exceptions.NotFound if application can't be found
26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	533 """
26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	534 try:
26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	535 return self._applications[namespace]
26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	536 except KeyError:
26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	537 raise exceptions.NotFound(
26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	538 f"No application registered for {namespace}"
26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	539 )
26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	540
4231 e11b13418ba6 plugin XEP-0353, XEP-0234, jingle: WebRTC data channel signaling implementation: Goffi <goffi@goffi.org> parents: 4116 diff changeset	541 def get_content_data(self, content: dict, content_idx: int) -> ContentData:
3404 26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	542 """"Retrieve application and its argument from content"""
26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	543 app_ns = content["app_ns"]
26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	544 try:
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	545 application = self.get_application(app_ns)
3404 26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	546 except exceptions.NotFound as e:
26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	547 raise exceptions.InternalError(str(e))
26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	548 app_args = content.get("app_args", [])
26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	549 app_kwargs = content.get("app_kwargs", {})
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	550 transport_data = content.get("transport_data", {})
3404 26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	551 try:
26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	552 content_name = content["name"]
26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	553 except KeyError:
4231 e11b13418ba6 plugin XEP-0353, XEP-0234, jingle: WebRTC data channel signaling implementation: Goffi <goffi@goffi.org> parents: 4116 diff changeset	554 content_name = content["name"] = str(content_idx)
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	555 return ContentData(
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	556 application,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	557 app_args,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	558 app_kwargs,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	559 transport_data,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	560 content_name
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	561 )
3404 26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	562
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	563 async def initiate(
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	564 self,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	565 client: SatXMPPEntity,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	566 peer_jid: jid.JID,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	567 contents: List[dict],
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	568 encrypted: bool = False,
4111 a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	569 sid: str\|None = None,
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	570 **extra_data: Any
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	571 ) -> str:
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	572 """Send a session initiation request
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	573
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	574 @param peer_jid: jid to establith session with
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	575 @param contents: list of contents to use:
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	576 The dict must have the following keys:
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	577 - app_ns(str): namespace of the application
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	578 the following keys are optional:
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	579 - transport_type(str): type of transport to use (see XEP-0166 §8)
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	580 default to TRANSPORT_STREAMING
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	581 - name(str): name of the content
4111 a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	582 - senders(str): One of XEP_0166.ROLE_INITIATOR, XEP_0166.ROLE_RESPONDER,
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	583 both or none
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	584 Defaults to BOTH (see XEP-0166 §7.3)
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	585 - app_args(list): args to pass to the application plugin
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	586 - app_kwargs(dict): keyword args to pass to the application plugin
3969 8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	587 @param encrypted: if True, session must be encrypted and "encryption" must be set
8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	588 to all content data of session
4111 a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	589 @param sid: Session ID.
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	590 If None, one will be generated (and used as return value)
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	591 @return: Sesson ID
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	592 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	593 assert contents # there must be at least one content
2927 69e4716d6268 plugins (jingle) file transfer: use initial "from" attribute as local jid instead of client.jid: Goffi <goffi@goffi.org> parents: 2920 diff changeset	594 if (peer_jid == client.jid
69e4716d6268 plugins (jingle) file transfer: use initial "from" attribute as local jid instead of client.jid: Goffi <goffi@goffi.org> parents: 2920 diff changeset	595 or client.is_component and peer_jid.host == client.jid.host):
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	596 raise ValueError(_("You can't do a jingle session with yourself"))
4111 a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	597 if sid is None:
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	598 sid = str(uuid.uuid4())
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	599 session = self.create_session(
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	600 client, sid, XEP_0166.ROLE_INITIATOR, peer_jid, **extra_data
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	601 )
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	602 initiator = session["initiator"]
3404 26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	603
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	604 if not await self.host.trigger.async_point(
3404 26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	605 "XEP-0166_initiate",
26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	606 client, session, contents
26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	607 ):
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	608 return sid
3404 26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	609
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	610 iq_elt, jingle_elt = self._build_jingle_elt(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	611 client, session, XEP_0166.A_SESSION_INITIATE
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	612 )
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	613 jingle_elt["initiator"] = initiator.full()
4053 dd39e60ca2aa plugin XEP-0166: set `jingle_elt`, `desc_elt` and `transport_elt`: Goffi <goffi@goffi.org> parents: 4044 diff changeset	614 session["jingle_elt"] = jingle_elt
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	615
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	616 session_contents = session["contents"]
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	617
4231 e11b13418ba6 plugin XEP-0353, XEP-0234, jingle: WebRTC data channel signaling implementation: Goffi <goffi@goffi.org> parents: 4116 diff changeset	618 for content_idx, content in enumerate(contents):
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	619 # we get the application plugin
4231 e11b13418ba6 plugin XEP-0353, XEP-0234, jingle: WebRTC data channel signaling implementation: Goffi <goffi@goffi.org> parents: 4116 diff changeset	620 content_data = self.get_content_data(content, content_idx)
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	621
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	622 # and the transport plugin
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	623 transport_type = content.get("transport_type", XEP_0166.TRANSPORT_STREAMING)
4231 e11b13418ba6 plugin XEP-0353, XEP-0234, jingle: WebRTC data channel signaling implementation: Goffi <goffi@goffi.org> parents: 4116 diff changeset	624 for transport in self._type_transports[transport_type]:
e11b13418ba6 plugin XEP-0353, XEP-0234, jingle: WebRTC data channel signaling implementation: Goffi <goffi@goffi.org> parents: 4116 diff changeset	625 if transport.handler.is_usable(client, content_data):
e11b13418ba6 plugin XEP-0353, XEP-0234, jingle: WebRTC data channel signaling implementation: Goffi <goffi@goffi.org> parents: 4116 diff changeset	626 break
e11b13418ba6 plugin XEP-0353, XEP-0234, jingle: WebRTC data channel signaling implementation: Goffi <goffi@goffi.org> parents: 4116 diff changeset	627 else:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	628 raise exceptions.InternalError(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	629 "No transport registered for {}".format(transport_type)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	630 )
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	631
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	632 # we build the session data for this content
4053 dd39e60ca2aa plugin XEP-0166: set `jingle_elt`, `desc_elt` and `transport_elt`: Goffi <goffi@goffi.org> parents: 4044 diff changeset	633 application_data = {}
dd39e60ca2aa plugin XEP-0166: set `jingle_elt`, `desc_elt` and `transport_elt`: Goffi <goffi@goffi.org> parents: 4044 diff changeset	634 transport_data = content_data.transport_data
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	635 session_content = {
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	636 "application": content_data.application,
4053 dd39e60ca2aa plugin XEP-0166: set `jingle_elt`, `desc_elt` and `transport_elt`: Goffi <goffi@goffi.org> parents: 4044 diff changeset	637 "application_data": application_data,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	638 "transport": transport,
4053 dd39e60ca2aa plugin XEP-0166: set `jingle_elt`, `desc_elt` and `transport_elt`: Goffi <goffi@goffi.org> parents: 4044 diff changeset	639 "transport_data": transport_data,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	640 "creator": XEP_0166.ROLE_INITIATOR,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	641 "senders": content.get("senders", "both"),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	642 }
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	643 if content_data.content_name in session_contents:
3404 26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	644 raise exceptions.InternalError(
26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	645 "There is already a content with this name"
26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	646 )
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	647 session_contents[content_data.content_name] = session_content
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	648
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	649 # we construct the content element
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	650 content_elt = jingle_elt.addElement("content")
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	651 content_elt["creator"] = session_content["creator"]
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	652 content_elt["name"] = content_data.content_name
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	653 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	654 content_elt["senders"] = content["senders"]
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	655 except KeyError:
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	656 pass
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	657
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	658 # then the description element
4053 dd39e60ca2aa plugin XEP-0166: set `jingle_elt`, `desc_elt` and `transport_elt`: Goffi <goffi@goffi.org> parents: 4044 diff changeset	659 application_data["desc_elt"] = desc_elt = await utils.as_deferred(
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	660 content_data.application.handler.jingle_session_init,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	661 client, session, content_data.content_name,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	662 content_data.app_args, *content_data.app_kwargs
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	663 )
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	664 content_elt.addChild(desc_elt)
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	665
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	666 # and the transport one
4053 dd39e60ca2aa plugin XEP-0166: set `jingle_elt`, `desc_elt` and `transport_elt`: Goffi <goffi@goffi.org> parents: 4044 diff changeset	667 transport_data["transport_elt"] = transport_elt = await utils.as_deferred(
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	668 transport.handler.jingle_session_init,
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	669 client, session, content_data.content_name,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	670 )
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	671 content_elt.addChild(transport_elt)
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	672
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	673 if not await self.host.trigger.async_point(
3969 8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	674 "XEP-0166_initiate_elt_built",
8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	675 client, session, iq_elt, jingle_elt
8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	676 ):
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	677 return sid
4053 dd39e60ca2aa plugin XEP-0166: set `jingle_elt`, `desc_elt` and `transport_elt`: Goffi <goffi@goffi.org> parents: 4044 diff changeset	678
dd39e60ca2aa plugin XEP-0166: set `jingle_elt`, `desc_elt` and `transport_elt`: Goffi <goffi@goffi.org> parents: 4044 diff changeset	679 # processing is done, we can remove elements
dd39e60ca2aa plugin XEP-0166: set `jingle_elt`, `desc_elt` and `transport_elt`: Goffi <goffi@goffi.org> parents: 4044 diff changeset	680 for content_data in session_contents.values():
dd39e60ca2aa plugin XEP-0166: set `jingle_elt`, `desc_elt` and `transport_elt`: Goffi <goffi@goffi.org> parents: 4044 diff changeset	681 del content_data["application_data"]["desc_elt"]
dd39e60ca2aa plugin XEP-0166: set `jingle_elt`, `desc_elt` and `transport_elt`: Goffi <goffi@goffi.org> parents: 4044 diff changeset	682 del content_data["transport_data"]["transport_elt"]
dd39e60ca2aa plugin XEP-0166: set `jingle_elt`, `desc_elt` and `transport_elt`: Goffi <goffi@goffi.org> parents: 4044 diff changeset	683 del session["jingle_elt"]
dd39e60ca2aa plugin XEP-0166: set `jingle_elt`, `desc_elt` and `transport_elt`: Goffi <goffi@goffi.org> parents: 4044 diff changeset	684
3969 8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	685 if encrypted:
8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	686 for content in session["contents"].values():
8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	687 if "encryption" not in content:
8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	688 raise exceptions.EncryptionError(
8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	689 "Encryption is requested, but no encryption has been set"
8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	690 )
8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	691
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	692 try:
3404 26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	693 await iq_elt.send()
4240 79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	694 except Exception:
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	695 log.exception("Error while sending jingle <iq/> stanza")
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	696 self.delete_session(client, sid)
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	697 raise
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	698 return sid
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	699
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	700 def delayed_content_terminate(self, args, *kwargs):
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	701 """Put content_terminate in queue but don't execute immediately
1617 d05f9179fe22 plugin XEP-0166: added delayedContentTerminate to terminate a content inside a handler Goffi <goffi@goffi.org> parents: 1616 diff changeset	702
d05f9179fe22 plugin XEP-0166: added delayedContentTerminate to terminate a content inside a handler Goffi <goffi@goffi.org> parents: 1616 diff changeset	703 This is used to terminate a content inside a handler, to avoid modifying contents
d05f9179fe22 plugin XEP-0166: added delayedContentTerminate to terminate a content inside a handler Goffi <goffi@goffi.org> parents: 1616 diff changeset	704 """
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	705 reactor.callLater(0, self.content_terminate, args, *kwargs)
1617 d05f9179fe22 plugin XEP-0166: added delayedContentTerminate to terminate a content inside a handler Goffi <goffi@goffi.org> parents: 1616 diff changeset	706
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	707 def content_terminate(self, client, session, content_name, reason=REASON_SUCCESS):
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	708 """Terminate and remove a content
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	709
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	710 if there is no more content, then session is terminated
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	711 @param session(dict): jingle session
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	712 @param content_name(unicode): name of the content terminated
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	713 @param reason(unicode): reason of the termination
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	714 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	715 contents = session["contents"]
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	716 del contents[content_name]
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	717 if not contents:
2489 e2a7bb875957 plugin pipe/stream, file transfert: refactoring and improvments: Goffi <goffi@goffi.org> parents: 2487 diff changeset	718 self.terminate(client, reason, session)
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	719
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	720 ## defaults methods called when plugin doesn't have them ##
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	721
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	722 def jingle_request_confirmation_default(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	723 self, client, action, session, content_name, desc_elt
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	724 ):
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	725 """This method request confirmation for a jingle session"""
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	726 log.debug("Using generic jingle confirmation method")
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	727 return xml_tools.defer_confirm(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	728 self.host,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	729 _(CONFIRM_TXT).format(entity=session["peer_jid"].full()),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	730 _("Confirm Jingle session"),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	731 profile=client.profile,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	732 )
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	733
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	734 ## jingle events ##
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	735
3969 8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	736 def _on_jingle_request(self, request: domish.Element, client: SatXMPPEntity) -> None:
8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	737 defer.ensureDeferred(self.on_jingle_request(client, request))
8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	738
8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	739 async def on_jingle_request(
8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	740 self,
8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	741 client: SatXMPPEntity,
8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	742 request: domish.Element
8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	743 ) -> None:
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	744 """Called when any jingle request is received
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	745
2489 e2a7bb875957 plugin pipe/stream, file transfert: refactoring and improvments: Goffi <goffi@goffi.org> parents: 2487 diff changeset	746 The request will then be dispatched to appropriate method
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	747 according to current state
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	748 @param request(domish.Element): received IQ request
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	749 """
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	750 request.handled = True
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	751 jingle_elt = next(request.elements(NS_JINGLE, "jingle"))
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	752
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	753 # first we need the session id
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	754 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	755 sid = jingle_elt["sid"]
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	756 if not sid:
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	757 raise KeyError
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	758 except KeyError:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	759 log.warning("Received jingle request has no sid attribute")
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	760 self.sendError(client, "bad-request", None, request)
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	761 return
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	762
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	763 # then the action
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	764 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	765 action = jingle_elt["action"]
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	766 if not action:
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	767 raise KeyError
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	768 except KeyError:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	769 log.warning("Received jingle request has no action")
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	770 self.sendError(client, "bad-request", None, request)
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	771 return
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	772
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	773 peer_jid = jid.JID(request["from"])
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	774
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	775 # we get or create the session
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	776 try:
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	777 session = client.jingle_sessions[sid]
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	778 except KeyError:
2489 e2a7bb875957 plugin pipe/stream, file transfert: refactoring and improvments: Goffi <goffi@goffi.org> parents: 2487 diff changeset	779 if action == XEP_0166.A_SESSION_INITIATE:
e2a7bb875957 plugin pipe/stream, file transfert: refactoring and improvments: Goffi <goffi@goffi.org> parents: 2487 diff changeset	780 pass
e2a7bb875957 plugin pipe/stream, file transfert: refactoring and improvments: Goffi <goffi@goffi.org> parents: 2487 diff changeset	781 elif action == XEP_0166.A_SESSION_TERMINATE:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	782 log.debug(
4111 a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	783 "ignoring session terminate action (inexisting session id): "
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	784 "{request_id} [{profile}]".format(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	785 request_id=sid, profile=client.profile
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	786 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	787 )
2489 e2a7bb875957 plugin pipe/stream, file transfert: refactoring and improvments: Goffi <goffi@goffi.org> parents: 2487 diff changeset	788 return
e2a7bb875957 plugin pipe/stream, file transfert: refactoring and improvments: Goffi <goffi@goffi.org> parents: 2487 diff changeset	789 else:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	790 log.warning(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	791 "Received request for an unknown session id: {request_id} [{profile}]".format(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	792 request_id=sid, profile=client.profile
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	793 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	794 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	795 self.sendError(client, "item-not-found", None, request, "unknown-session")
1615 a1e5bcd9a6eb jingle XEP-0166: fixed session creation on non session-initiate actions Goffi <goffi@goffi.org> parents: 1614 diff changeset	796 return
a1e5bcd9a6eb jingle XEP-0166: fixed session creation on non session-initiate actions Goffi <goffi@goffi.org> parents: 1614 diff changeset	797
4111 a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	798 try:
4112 bc60875cb3b8 plugin XEP-0166, XEP-0167, XEP-0234, XEP-0353: call events management to prepare for UI: Goffi <goffi@goffi.org> parents: 4111 diff changeset	799 # session may have been already created in a jingle_preflight, in this
bc60875cb3b8 plugin XEP-0166, XEP-0167, XEP-0234, XEP-0353: call events management to prepare for UI: Goffi <goffi@goffi.org> parents: 4111 diff changeset	800 # case we re-use it.
4111 a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	801 session = self.get_session(client, sid)
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	802 except exceptions.NotFound:
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	803 # XXX: we store local_jid using request['to'] because for a component the
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	804 # jid used may not be client.jid (if a local part is used).
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	805 session = self.create_session(
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	806 client, sid, XEP_0166.ROLE_RESPONDER, peer_jid, jid.JID(request['to'])
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	807 )
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	808 else:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	809 if session["peer_jid"] != peer_jid:
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	810 log.warning(
4111 a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	811 "sid conflict ({}), the jid doesn't match. Can be a collision, a "
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	812 "hack attempt, or a bad sid generation".format(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	813 sid
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	814 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	815 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	816 self.sendError(client, "service-unavailable", sid, request)
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	817 return
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	818 if session["id"] != sid:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	819 log.error("session id doesn't match")
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	820 self.sendError(client, "service-unavailable", sid, request)
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	821 raise exceptions.InternalError
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	822
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	823 if action == XEP_0166.A_SESSION_INITIATE:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	824 await self.on_session_initiate(client, request, jingle_elt, session)
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	825 elif action == XEP_0166.A_SESSION_TERMINATE:
4111 a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	826 await self.on_session_terminate(client, request, jingle_elt, session)
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	827 elif action == XEP_0166.A_SESSION_ACCEPT:
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	828 await self.on_session_accept(client, request, jingle_elt, session)
1616 1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	829 elif action == XEP_0166.A_SESSION_INFO:
4240 79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	830 await self.on_session_info(client, request, jingle_elt, session)
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	831 elif action == XEP_0166.A_TRANSPORT_INFO:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	832 self.on_transport_info(client, request, jingle_elt, session)
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	833 elif action == XEP_0166.A_TRANSPORT_REPLACE:
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	834 await self.on_transport_replace(client, request, jingle_elt, session)
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	835 elif action == XEP_0166.A_TRANSPORT_ACCEPT:
4240 79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	836 await self.on_transport_accept(client, request, jingle_elt, session)
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	837 elif action == XEP_0166.A_TRANSPORT_REJECT:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	838 self.on_transport_reject(client, request, jingle_elt, session)
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	839 else:
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	840 raise exceptions.InternalError(f"Unknown action {action}")
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	841
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	842 ## Actions callbacks ##
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	843
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	844 def _parse_elements(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	845 self,
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	846 jingle_elt: domish.Element,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	847 session: dict,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	848 request: domish.Element,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	849 client: SatXMPPEntity,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	850 new: bool = False,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	851 creator: str = ROLE_INITIATOR,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	852 with_application: bool =True,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	853 with_transport: bool = True,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	854 store_in_session: bool = True,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	855 ) -> Dict[str, dict]:
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	856 """Parse contents elements and fill contents_dict accordingly
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	857
4053 dd39e60ca2aa plugin XEP-0166: set `jingle_elt`, `desc_elt` and `transport_elt`: Goffi <goffi@goffi.org> parents: 4044 diff changeset	858 after the parsing, contents_dict will containt handlers, "desc_elt" and
dd39e60ca2aa plugin XEP-0166: set `jingle_elt`, `desc_elt` and `transport_elt`: Goffi <goffi@goffi.org> parents: 4044 diff changeset	859 "transport_elt"
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	860 @param jingle_elt: parent <jingle> element, containing one or more <content>
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	861 @param session: session data
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	862 @param request: the whole request
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	863 @param client: %(doc_client)s
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	864 @param new: True if the content is new and must be created,
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	865 else the content must exists, and session data will be filled
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	866 @param creator: only used if new is True: creating pear (see § 7.3)
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	867 @param with_application: if True, raise an error if there is no <description>
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	868 element else ignore it
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	869 @param with_transport: if True, raise an error if there is no <transport> element
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	870 else ignore it
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	871 @param store_in_session: if True, the ``session`` contents will be updated with
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	872 the parsed elements.
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	873 Use False when you parse an action which can happen at any time (e.g.
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	874 transport-info) and meaning that a parsed element may already be present in
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	875 the session (e.g. if an authorisation request is waiting for user answer),
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	876 This can't be used when ``new`` is set.
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	877 @return: contents_dict (from session, or a new one if "store_in_session" is False)
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	878 @raise exceptions.CancelError: the error is treated and the calling method can
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	879 cancel the treatment (i.e. return)
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	880 """
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	881 if store_in_session:
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	882 contents_dict = session["contents"]
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	883 else:
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	884 if new:
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	885 raise exceptions.InternalError(
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	886 '"store_in_session" must not be used when "new" is set'
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	887 )
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	888 contents_dict = {n: {} for n in session["contents"]}
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	889 content_elts = jingle_elt.elements(NS_JINGLE, "content")
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	890
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	891 for content_elt in content_elts:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	892 name = content_elt["name"]
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	893
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	894 if new:
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	895 # the content must not exist, we check it
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	896 if not name or name in contents_dict:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	897 self.sendError(client, "bad-request", session["id"], request)
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	898 raise exceptions.CancelError
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	899 content_data = contents_dict[name] = {
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	900 "creator": creator,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	901 "senders": content_elt.attributes.get("senders", "both"),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	902 }
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	903 else:
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	904 # the content must exist, we check it
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	905 try:
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	906 content_data = contents_dict[name]
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	907 except KeyError:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	908 log.warning("Other peer try to access an unknown content")
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	909 self.sendError(client, "bad-request", session["id"], request)
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	910 raise exceptions.CancelError
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	911
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	912 # application
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	913 if with_application:
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	914 desc_elt = content_elt.description
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	915 if not desc_elt:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	916 self.sendError(client, "bad-request", session["id"], request)
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	917 raise exceptions.CancelError
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	918
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	919 if new:
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	920 # the content is new, we need to check and link the application
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	921 app_ns = desc_elt.uri
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	922 if not app_ns or app_ns == NS_JINGLE:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	923 self.sendError(client, "bad-request", session["id"], request)
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	924 raise exceptions.CancelError
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	925
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	926 try:
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	927 application = self._applications[app_ns]
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	928 except KeyError:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	929 log.warning(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	930 "Unmanaged application namespace [{}]".format(app_ns)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	931 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	932 self.sendError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	933 client, "service-unavailable", session["id"], request
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	934 )
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	935 raise exceptions.CancelError
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	936
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	937 content_data["application"] = application
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	938 content_data["application_data"] = {}
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	939 else:
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	940 # the content exists, we check that we have not a former desc_elt
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	941 if "desc_elt" in content_data:
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	942 raise exceptions.InternalError(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	943 "desc_elt should not exist at this point"
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	944 )
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	945
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	946 content_data["desc_elt"] = desc_elt
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	947
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	948 # transport
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	949 if with_transport:
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	950 transport_elt = content_elt.transport
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	951 if not transport_elt:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	952 self.sendError(client, "bad-request", session["id"], request)
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	953 raise exceptions.CancelError
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	954
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	955 if new:
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	956 # the content is new, we need to check and link the transport
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	957 transport_ns = transport_elt.uri
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	958 if not app_ns or app_ns == NS_JINGLE:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	959 self.sendError(client, "bad-request", session["id"], request)
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	960 raise exceptions.CancelError
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	961
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	962 try:
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	963 transport = self._transports[transport_ns]
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	964 except KeyError:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	965 raise exceptions.InternalError(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	966 "No transport registered for namespace {}".format(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	967 transport_ns
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	968 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	969 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	970 content_data["transport"] = transport
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	971 content_data["transport_data"] = {}
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	972 else:
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	973 # the content exists, we check that we have not a former transport_elt
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	974 if "transport_elt" in content_data:
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	975 raise exceptions.InternalError(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	976 "transport_elt should not exist at this point"
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	977 )
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	978
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	979 content_data["transport_elt"] = transport_elt
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	980
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	981 return contents_dict
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	982
2489 e2a7bb875957 plugin pipe/stream, file transfert: refactoring and improvments: Goffi <goffi@goffi.org> parents: 2487 diff changeset	983 def _ignore(self, client, action, session, content_name, elt):
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	984 """Dummy method used when not exception must be raised if a method is not implemented in _call_plugins
1754 f4e9f2f7fe0f plugin XEP-0166: jingleTerminate is called (if present) on applications and transports plugins on session-terminate action, can be used to do some cleaning Goffi <goffi@goffi.org> parents: 1630 diff changeset	985
f4e9f2f7fe0f plugin XEP-0166: jingleTerminate is called (if present) on applications and transports plugins on session-terminate action, can be used to do some cleaning Goffi <goffi@goffi.org> parents: 1630 diff changeset	986 must be used as app_default_cb and/or transp_default_cb
f4e9f2f7fe0f plugin XEP-0166: jingleTerminate is called (if present) on applications and transports plugins on session-terminate action, can be used to do some cleaning Goffi <goffi@goffi.org> parents: 1630 diff changeset	987 """
f4e9f2f7fe0f plugin XEP-0166: jingleTerminate is called (if present) on applications and transports plugins on session-terminate action, can be used to do some cleaning Goffi <goffi@goffi.org> parents: 1630 diff changeset	988 return elt
f4e9f2f7fe0f plugin XEP-0166: jingleTerminate is called (if present) on applications and transports plugins on session-terminate action, can be used to do some cleaning Goffi <goffi@goffi.org> parents: 1630 diff changeset	989
4240 79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	990 async def _call_plugins(
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	991 self,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	992 client: SatXMPPEntity,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	993 action: str,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	994 session: dict,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	995 app_method_name: Optional[str] = "jingle_handler",
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	996 transp_method_name: Optional[str] = "jingle_handler",
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	997 app_default_cb: Optional[Callable] = None,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	998 transp_default_cb: Optional[Callable] = None,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	999 delete: bool = True,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1000 elements: bool = True,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1001 force_element: Optional[domish.Element] = None
4240 79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1002 ) -> list[Any]:
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1003 """Call application and transport plugin methods for all contents
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1004
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1005 @param action: jingle action name
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1006 @param session: jingle session data
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1007 @param app_method_name: name of the method to call for applications
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1008 None to ignore
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1009 @param transp_method_name: name of the method to call for transports
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1010 None to ignore
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1011 @param app_default_cb: default callback to use if plugin has not app_method_name
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1012 None to raise an exception instead
4240 79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1013 @param transp_default_cb: default callback to use if plugin has not
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1014 transp_method_name
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1015 None to raise an exception instead
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1016 @param delete: if True, remove desc_elt and transport_elt from session
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1017 ignored if elements is False
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1018 @param elements: True if elements(desc_elt and tranport_elt) must be managed
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1019 must be True if _call_plugins is used in a request, and False if it is used
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1020 after a request (i.e. on <iq> result or error)
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1021 @param force_element: if elements is False, it is used as element parameter
1616 1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	1022 else it is ignored
4240 79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1023 @return : list of launched methods results
1616 1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	1024 @raise exceptions.NotFound: method is not implemented
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1025 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1026 contents_dict = session["contents"]
4240 79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1027 results = []
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	1028 for content_name, content_data in contents_dict.items():
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1029 for method_name, handler_key, default_cb, elt_name in (
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1030 (app_method_name, "application", app_default_cb, "desc_elt"),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1031 (transp_method_name, "transport", transp_default_cb, "transport_elt"),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1032 ):
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1033 if method_name is None:
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1034 continue
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1035
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	1036 handler = content_data[handler_key].handler
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1037 try:
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1038 method = getattr(handler, method_name)
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1039 except AttributeError:
1754 f4e9f2f7fe0f plugin XEP-0166: jingleTerminate is called (if present) on applications and transports plugins on session-terminate action, can be used to do some cleaning Goffi <goffi@goffi.org> parents: 1630 diff changeset	1040 if default_cb is None:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1041 raise exceptions.NotFound(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	1042 "{} not implemented !".format(method_name)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1043 )
1754 f4e9f2f7fe0f plugin XEP-0166: jingleTerminate is called (if present) on applications and transports plugins on session-terminate action, can be used to do some cleaning Goffi <goffi@goffi.org> parents: 1630 diff changeset	1044 else:
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1045 method = default_cb
1616 1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	1046 if elements:
1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	1047 elt = content_data.pop(elt_name) if delete else content_data[elt_name]
1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	1048 else:
1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	1049 elt = force_element
4240 79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1050 result = await utils.as_deferred(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1051 method, client, action, session, content_name, elt
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1052 )
4240 79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1053 results.append(result)
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1054
4240 79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1055 return results
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1056
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1057 async def on_session_initiate(
3969 8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	1058 self,
8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	1059 client: SatXMPPEntity,
8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	1060 request: domish.Element,
8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	1061 jingle_elt: domish.Element,
8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	1062 session: Dict[str, Any]
8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	1063 ) -> None:
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1064 """Called on session-initiate action
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1065
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1066 The "jingle_request_confirmation" method of each application will be called
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1067 (or self.jingle_request_confirmation_default if the former doesn't exist).
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1068 The session is only accepted if all application are confirmed.
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1069 The application must manage itself multiple contents scenari (e.g. audio/video).
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1070 @param client: %(doc_client)s
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1071 @param request(domish.Element): full request
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1072 @param jingle_elt(domish.Element): <jingle> element
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1073 @param session(dict): session data
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1074 """
4111 a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	1075 contents_dict = session["contents"]
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	1076 if contents_dict:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1077 raise exceptions.InternalError(
4111 a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	1078 "Contents dict should not already be set at this point"
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1079 )
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1080
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1081 try:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1082 self._parse_elements(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1083 jingle_elt, session, request, client, True, XEP_0166.ROLE_INITIATOR
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1084 )
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1085 except exceptions.CancelError:
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1086 return
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1087
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1088 if not contents_dict:
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1089 # there MUST be at least one content
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1090 self.sendError(client, "bad-request", session["id"], request)
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1091 return
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1092
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1093 # at this point we can send the <iq/> result to confirm reception of the request
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1094 client.send(xmlstream.toResponse(request, "result"))
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1095
3969 8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	1096
4053 dd39e60ca2aa plugin XEP-0166: set `jingle_elt`, `desc_elt` and `transport_elt`: Goffi <goffi@goffi.org> parents: 4044 diff changeset	1097 assert "jingle_elt" not in session
dd39e60ca2aa plugin XEP-0166: set `jingle_elt`, `desc_elt` and `transport_elt`: Goffi <goffi@goffi.org> parents: 4044 diff changeset	1098 session["jingle_elt"] = jingle_elt
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1099 if not await self.host.trigger.async_point(
3969 8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	1100 "XEP-0166_on_session_initiate",
8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	1101 client, session, request, jingle_elt
8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	1102 ):
8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	1103 return
8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	1104
4240 79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1105 await self._call_plugins(
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1106 client,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1107 XEP_0166.A_PREPARE_CONFIRMATION,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1108 session,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1109 delete=False
4240 79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1110 )
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1111
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1112 # we now request each application plugin confirmation
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1113 # and if all are accepted, we can accept the session
4240 79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1114 try:
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1115 confirmations = await self._call_plugins(
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1116 client,
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1117 XEP_0166.A_SESSION_INITIATE,
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1118 session,
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1119 "jingle_request_confirmation",
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1120 None,
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1121 self.jingle_request_confirmation_default,
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1122 delete=False,
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1123 )
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1124 except Exception as e:
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1125 await self._jingle_error_cb(e, session, jingle_elt, client)
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1126 else:
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1127 await self._confirmation_cb(confirmations, session, jingle_elt, client)
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1128
4240 79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1129 async def _confirmation_cb(
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1130 self,
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1131 confirmations: list[bool],
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1132 session: dict,
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1133 jingle_elt: domish.Element,
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1134 client: SatXMPPEntity
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1135 ) -> None:
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1136 """Method called when confirmation from user has been received
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1137
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1138 This method is only called for the responder
4240 79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1139 @param confirm_results: all True if session is accepted
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1140 @param session: session data
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1141 @param jingle_elt: jingle data of this session
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1142 @param client: SatXMPPEntity
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1143 """
4053 dd39e60ca2aa plugin XEP-0166: set `jingle_elt`, `desc_elt` and `transport_elt`: Goffi <goffi@goffi.org> parents: 4044 diff changeset	1144 del session["jingle_elt"]
4240 79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1145 confirmed = all(confirmations)
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1146 if not confirmed:
4240 79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1147 await self.terminate(client, XEP_0166.REASON_DECLINE, session)
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1148 return
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1149
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1150 iq_elt, jingle_elt = self._build_jingle_elt(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1151 client, session, XEP_0166.A_SESSION_ACCEPT
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1152 )
2927 69e4716d6268 plugins (jingle) file transfer: use initial "from" attribute as local jid instead of client.jid: Goffi <goffi@goffi.org> parents: 2920 diff changeset	1153 jingle_elt["responder"] = session['local_jid'].full()
4053 dd39e60ca2aa plugin XEP-0166: set `jingle_elt`, `desc_elt` and `transport_elt`: Goffi <goffi@goffi.org> parents: 4044 diff changeset	1154 session["jingle_elt"] = jingle_elt
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1155
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1156 # contents
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1157
4240 79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1158 try:
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1159 for content_name, content_data in session["contents"].items():
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1160 content_elt = jingle_elt.addElement("content")
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1161 content_elt["creator"] = XEP_0166.ROLE_INITIATOR
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1162 content_elt["name"] = content_name
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1163
4240 79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1164 application = content_data["application"]
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1165 app_session_accept_cb = application.handler.jingle_handler
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1166
4240 79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1167 updated_desc_elt = await utils.as_deferred(
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1168 app_session_accept_cb,
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1169 client,
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1170 XEP_0166.A_SESSION_INITIATE,
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1171 session,
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1172 content_name,
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1173 content_data.pop("desc_elt"),
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1174 )
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1175 content_elt.addChild(updated_desc_elt)
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1176
4240 79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1177 transport = content_data["transport"]
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1178 transport_session_accept_cb = transport.handler.jingle_handler
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1179
4240 79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1180 updated_transport_elt = await utils.as_deferred(
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1181 transport_session_accept_cb,
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1182 client,
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1183 XEP_0166.A_SESSION_INITIATE,
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1184 session,
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1185 content_name,
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1186 content_data.pop("transport_elt"),
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1187 )
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1188 content_elt.addChild(updated_transport_elt)
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1189
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1190 await self._call_plugins(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1191 client,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1192 XEP_0166.A_PREPARE_RESPONDER,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1193 session,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1194 app_method_name=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1195 elements=False,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1196 )
4240 79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1197 session.pop("jingle_elt")
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1198 await iq_elt.send()
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1199
4116 23fa52acf72c plugin XEP-0167, XEP-0176: transport-info and ICE candidate sending are delayed if session is not active yet Goffi <goffi@goffi.org> parents: 4114 diff changeset	1200 session["state"] = XEP_0166.STATE_ACTIVE
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1201
4240 79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1202 await self._call_plugins(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1203 client, XEP_0166.A_ACCEPTED_ACK, session, elements=False
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1204 )
4240 79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1205 except Exception:
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1206 log.exception("Error while sending jingle <iq/> stanza")
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1207 self.delete_session(client, session["id"])
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1208
4111 a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	1209 def get_reason_elt(self, parent_elt: domish.Element) -> domish.Element:
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	1210 """Find a <reason> element in parent_elt
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	1211
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	1212 if none is found, add an empty one to the element
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	1213 @return: the <reason> element
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	1214 """
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	1215 try:
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	1216 return next(parent_elt.elements(NS_JINGLE, "reason"))
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	1217 except StopIteration:
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	1218 log.warning("No reason given for session termination")
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	1219 reason_elt = parent_elt.addElement("reason")
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	1220 return reason_elt
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	1221
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	1222 def parse_reason_elt(self, reason_elt: domish.Element) -> tuple[str\|None, str\|None]:
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	1223 """Parse a <reason> element
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	1224
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	1225 @return: reason found, and text if any
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	1226 """
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	1227 reason, text = None, None
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	1228 for elt in reason_elt.elements():
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	1229 if elt.uri == NS_JINGLE:
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	1230 if elt.name == "text":
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	1231 text = str(elt)
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	1232 else:
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	1233 reason = elt.name
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	1234
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	1235 if reason is None:
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	1236 log.debug("no reason specified,")
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	1237
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	1238 return reason, text
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	1239
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	1240 async def on_session_terminate(
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	1241 self,
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	1242 client: SatXMPPEntity,
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	1243 request: domish.Element,
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	1244 jingle_elt: domish.Element,
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	1245 session: dict
a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	1246 ) -> None:
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1247 # TODO: check reason, display a message to user if needed
4053 dd39e60ca2aa plugin XEP-0166: set `jingle_elt`, `desc_elt` and `transport_elt`: Goffi <goffi@goffi.org> parents: 4044 diff changeset	1248 log.debug(f"Jingle Session {session['id']} terminated")
4111 a8ac5e1e5848 plugin XEP-0166: `jingle_terminate`, session handling and reason parsing: Goffi <goffi@goffi.org> parents: 4071 diff changeset	1249 reason_elt = self.get_reason_elt(jingle_elt)
1754 f4e9f2f7fe0f plugin XEP-0166: jingleTerminate is called (if present) on applications and transports plugins on session-terminate action, can be used to do some cleaning Goffi <goffi@goffi.org> parents: 1630 diff changeset	1250
4240 79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1251 await self._call_plugins(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1252 client,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1253 XEP_0166.A_SESSION_TERMINATE,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1254 session,
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1255 "jingle_terminate",
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1256 "jingle_terminate",
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1257 self._ignore,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1258 self._ignore,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1259 elements=False,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1260 force_element=reason_elt,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1261 )
1754 f4e9f2f7fe0f plugin XEP-0166: jingleTerminate is called (if present) on applications and transports plugins on session-terminate action, can be used to do some cleaning Goffi <goffi@goffi.org> parents: 1630 diff changeset	1262
4240 79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1263 self.delete_session(client, session["id"])
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1264 await client.a_send(xmlstream.toResponse(request, "result"))
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1265
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1266 async def on_session_accept(self, client, request, jingle_elt, session):
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	1267 """Method called once session is accepted
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1268
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1269 This method is only called for initiator
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1270 @param client: %(doc_client)s
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1271 @param request(domish.Element): full <iq> request
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1272 @param jingle_elt(domish.Element): the <jingle> element
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1273 @param session(dict): session data
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1274 """
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1275 log.debug(f"Jingle session {session['id']} has been accepted")
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1276
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1277 try:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1278 self._parse_elements(jingle_elt, session, request, client)
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1279 except exceptions.CancelError:
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1280 return
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1281
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1282 # at this point we can send the <iq/> result to confirm reception of the request
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1283 client.send(xmlstream.toResponse(request, "result"))
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1284 # and change the state
4116 23fa52acf72c plugin XEP-0167, XEP-0176: transport-info and ICE candidate sending are delayed if session is not active yet Goffi <goffi@goffi.org> parents: 4114 diff changeset	1285 session["state"] = XEP_0166.STATE_ACTIVE
4053 dd39e60ca2aa plugin XEP-0166: set `jingle_elt`, `desc_elt` and `transport_elt`: Goffi <goffi@goffi.org> parents: 4044 diff changeset	1286 session["jingle_elt"] = jingle_elt
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1287
4240 79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1288 await self._call_plugins(
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1289 client,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1290 XEP_0166.A_PREPARE_INITIATOR,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1291 session,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1292 delete=False
4240 79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1293 )
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1294
4240 79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1295 await self._call_plugins(client, XEP_0166.A_SESSION_ACCEPT, session)
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1296
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1297 # after negociations we start the transfer
4240 79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1298 await self._call_plugins(
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1299 client, XEP_0166.A_START, session, app_method_name=None, elements=False
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1300 )
4240 79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1301 session.pop("jingle_elt")
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1302
4240 79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1303 async def on_session_info(self, client, request, jingle_elt, session):
1616 1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	1304 """Method called when a session-info action is received from other peer
1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	1305
1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	1306 This method is only called for initiator
1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	1307 @param client: %(doc_client)s
1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	1308 @param request(domish.Element): full <iq> request
1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	1309 @param jingle_elt(domish.Element): the <jingle> element
1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	1310 @param session(dict): session data
1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	1311 """
1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	1312 if not jingle_elt.children:
1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	1313 # this is a session ping, see XEP-0166 §6.8
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1314 client.send(xmlstream.toResponse(request, "result"))
1616 1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	1315 return
1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	1316
1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	1317 try:
4240 79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1318 # XXX: session-info is most likely only used for application, so we don't call
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1319 # transport plugins if a future transport use it, this behaviour must be
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1320 # adapted
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1321 await self._call_plugins(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1322 client,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1323 XEP_0166.A_SESSION_INFO,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1324 session,
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1325 "jingle_session_info",
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1326 None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1327 elements=False,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1328 force_element=jingle_elt,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1329 )
1616 1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	1330 except exceptions.NotFound as e:
4240 79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1331 log.exception("Error while handling on_session_info")
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1332 # XXX: only error managed so far, maybe some applications/transports need more
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1333 self.sendError(
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1334 client, "feature-not-implemented", None, request, "unsupported-info"
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1335 )
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1336 except Exception:
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1337 log.exception("Error while managing session info")
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1338 else:
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1339 client.send(xmlstream.toResponse(request, "result"))
1616 1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	1340
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1341 async def on_transport_replace(self, client, request, jingle_elt, session):
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1342 """A transport change is requested
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1343
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1344 The request is parsed, and jingle_handler is called on concerned transport plugin(s)
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1345 @param client: %(doc_client)s
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1346 @param request(domish.Element): full <iq> request
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1347 @param jingle_elt(domish.Element): the <jingle> element
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1348 @param session(dict): session data
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1349 """
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	1350 log.debug("Other peer wants to replace the transport")
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1351 try:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1352 self._parse_elements(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1353 jingle_elt, session, request, client, with_application=False
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1354 )
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1355 except exceptions.CancelError:
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1356 defer.returnValue(None)
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1357
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1358 client.send(xmlstream.toResponse(request, "result"))
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1359
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1360 content_name = None
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1361 to_replace = []
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1362
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	1363 for content_name, content_data in session["contents"].items():
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1364 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1365 transport_elt = content_data.pop("transport_elt")
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1366 except KeyError:
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1367 continue
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1368 transport_ns = transport_elt.uri
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1369 try:
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1370 transport = self._transports[transport_ns]
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1371 except KeyError:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1372 log.warning(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	1373 "Other peer want to replace current transport with an unknown one: {}".format(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1374 transport_ns
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1375 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1376 )
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1377 content_name = None
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1378 break
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1379 to_replace.append((content_name, content_data, transport, transport_elt))
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1380
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1381 if content_name is None:
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1382 # wa can't accept the replacement
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1383 iq_elt, reject_jingle_elt = self._build_jingle_elt(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1384 client, session, XEP_0166.A_TRANSPORT_REJECT
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1385 )
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1386 for child in jingle_elt.children:
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1387 reject_jingle_elt.addChild(child)
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1388
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1389 iq_elt.send()
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1390 defer.returnValue(None)
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1391
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1392 # at this point, everything is alright and we can replace the transport(s)
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1393 # this is similar to an session-accept action, but for transports only
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1394 iq_elt, accept_jingle_elt = self._build_jingle_elt(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1395 client, session, XEP_0166.A_TRANSPORT_ACCEPT
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1396 )
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1397 for content_name, content_data, transport, transport_elt in to_replace:
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1398 # we can now actually replace the transport
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1399 await utils.as_deferred(
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1400 content_data["transport"].handler.jingle_handler,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1401 client, XEP_0166.A_DESTROY, session, content_name, None
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1402 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1403 content_data["transport"] = transport
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1404 content_data["transport_data"].clear()
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1405 # and build the element
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1406 content_elt = accept_jingle_elt.addElement("content")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1407 content_elt["name"] = content_name
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1408 content_elt["creator"] = content_data["creator"]
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1409 # we notify the transport and insert its <transport/> in the answer
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1410 accept_transport_elt = await utils.as_deferred(
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1411 transport.handler.jingle_handler,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1412 client, XEP_0166.A_TRANSPORT_REPLACE, session, content_name, transport_elt
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1413 )
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1414 content_elt.addChild(accept_transport_elt)
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1415 # there is no confirmation needed here, so we can directly prepare it
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1416 await utils.as_deferred(
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1417 transport.handler.jingle_handler,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1418 client, XEP_0166.A_PREPARE_RESPONDER, session, content_name, None
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1419 )
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1420
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1421 iq_elt.send()
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1422
4240 79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1423 async def on_transport_accept(
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1424 self,
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1425 client: SatXMPPEntity,
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1426 request: domish.Element,
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1427 jingle_elt: domish.Element,
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1428 session: dict
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1429 ) -> None:
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1430 """Method called once transport replacement is accepted
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1431
4240 79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1432 @param client: SatXMPPEntity instance
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1433 @param request: full <iq> request
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1434 @param jingle_elt: the <jingle> element
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1435 @param session: session data
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1436 """
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	1437 log.debug("new transport has been accepted")
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1438
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1439 try:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1440 self._parse_elements(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1441 jingle_elt, session, request, client, with_application=False
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1442 )
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1443 except exceptions.CancelError:
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1444 return
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1445
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1446 # at this point we can send the <iq/> result to confirm reception of the request
4240 79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1447 await client.a_send(xmlstream.toResponse(request, "result"))
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1448
4240 79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1449 await self._call_plugins(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1450 client, XEP_0166.A_TRANSPORT_ACCEPT, session, app_method_name=None
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1451 )
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1452
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1453 # after negociations we start the transfer
4240 79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1454 await self._call_plugins(
79c8a70e1813 backend, frontend: prepare remote control: Goffi <goffi@goffi.org> parents: 4231 diff changeset	1455 client, XEP_0166.A_START, session, app_method_name=None, elements=False
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1456 )
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1457
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1458 def on_transport_reject(self, client, request, jingle_elt, session):
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1459 """Method called when a transport replacement is refused
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1460
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1461 @param client: %(doc_client)s
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1462 @param request(domish.Element): full <iq> request
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1463 @param jingle_elt(domish.Element): the <jingle> element
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1464 @param session(dict): session data
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1465 """
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1466 # XXX: for now, we terminate the session in case of transport-reject
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1467 # this behaviour may change in the future
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1468 self.terminate(client, "failed-transport", session)
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1469
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1470 def on_transport_info(
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1471 self,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1472 client: SatXMPPEntity,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1473 request: domish.Element,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1474 jingle_elt: domish.Element,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1475 session: dict
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1476 ) -> None:
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	1477 """Method called when a transport-info action is received from other peer
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	1478
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1479 The request is parsed, and jingle_handler is called on concerned transport
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1480 plugin(s)
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	1481 @param client: %(doc_client)s
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1482 @param request: full <iq> request
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1483 @param jingle_elt: the <jingle> element
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1484 @param session: session data
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	1485 """
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1486 log.debug(f"Jingle session {session['id']} has been accepted")
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	1487
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	1488 try:
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1489 parsed_contents = self._parse_elements(
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1490 jingle_elt, session, request, client, with_application=False,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1491 store_in_session=False
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1492 )
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	1493 except exceptions.CancelError:
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	1494 return
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	1495
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	1496 # The parsing was OK, we send the <iq> result
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1497 client.send(xmlstream.toResponse(request, "result"))
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	1498
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	1499 for content_name, content_data in session["contents"].items():
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	1500 try:
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1501 transport_elt = parsed_contents[content_name]["transport_elt"]
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	1502 except KeyError:
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	1503 continue
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	1504 else:
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1505 utils.as_deferred(
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1506 content_data["transport"].handler.jingle_handler,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1507 client,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1508 XEP_0166.A_TRANSPORT_INFO,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1509 session,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1510 content_name,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1511 transport_elt,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1512 )
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	1513
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1514
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	1515 @implementer(iwokkel.IDisco)
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1516 class XEP_0166_handler(xmlstream.XMPPHandler):
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1517
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1518 def __init__(self, plugin_parent):
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1519 self.plugin_parent = plugin_parent
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1520
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1521 def connectionInitialized(self):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1522 self.xmlstream.addObserver(
3969 8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	1523 JINGLE_REQUEST, self.plugin_parent._on_jingle_request, client=self.parent
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1524 )
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1525
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1526 def getDiscoInfo(self, requestor, target, nodeIdentifier=""):
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1527 return [disco.DiscoFeature(NS_JINGLE)]
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1528
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1529 def getDiscoItems(self, requestor, target, nodeIdentifier=""):
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1530 return []

Mercurial > libervia-backend

annotate libervia/backend/plugins/plugin_xep_0166/__init__.py @ 4258:ba28ca268f4a

annotate libervia/backend/plugins/plugin_xep_0166/init.py @ 4258:ba28ca268f4a