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

annotate libervia/backend/plugins/plugin_xep_0166/init.py @ 4108:238e305f2306

plugin JID Search: JID search plugin, first draft

author	Goffi <goffi@goffi.org>
date	Thu, 06 Jul 2023 11:34:51 +0200
parents	4b842c1fb686
children	a8ac5e1e5848

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 STATE_PENDING : Final = "PENDING"
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	59 STATE_ACTIVE : Final = "ACTIVE"
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	60 STATE_ENDED : Final = "ENDED"
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	61 CONFIRM_TXT : Final = D_(
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	62 "{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	63 )
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	64
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	65 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	66 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	67 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	68 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	69 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	70 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	71 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	72 C.PI_HANDLER: "yes",
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	73 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	74 }
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	75
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	76
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	77 class XEP_0166:
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	78 namespace : Final = NS_JINGLE
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	79
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	80 ROLE_INITIATOR : Final = "initiator"
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	81 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	82
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	83 TRANSPORT_DATAGRAM : Final = "UDP"
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	84 TRANSPORT_STREAMING : Final = "TCP"
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	85
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	86 REASON_SUCCESS : Final = "success"
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	87 REASON_DECLINE : Final = "decline"
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	88 REASON_FAILED_APPLICATION : Final = "failed-application"
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	89 REASON_FAILED_TRANSPORT : Final = "failed-transport"
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	90 REASON_CONNECTIVITY_ERROR : Final = "connectivity-error"
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	91
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	92 # standard actions
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	93
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	94 A_SESSION_INITIATE : Final = "session-initiate"
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	95 A_SESSION_ACCEPT : Final = "session-accept"
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	96 A_SESSION_TERMINATE : Final = "session-terminate"
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	97 A_SESSION_INFO : Final = "session-info"
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	98 A_TRANSPORT_REPLACE : Final = "transport-replace"
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	99 A_TRANSPORT_ACCEPT : Final = "transport-accept"
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	100 A_TRANSPORT_REJECT : Final = "transport-reject"
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	101 A_TRANSPORT_INFO : Final = "transport-info"
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	102
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	103 # non standard actions
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	104
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	105 #: 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	106 #: parsing
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	107 A_PREPARE_CONFIRMATION : Final = "prepare-confirmation"
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	108 #: initiator must prepare tranfer
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	109 A_PREPARE_INITIATOR : Final = "prepare-initiator"
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	110 #: responder must prepare tranfer
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	111 A_PREPARE_RESPONDER : Final = "prepare-responder"
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	112 #; session accepted ack has been received from initiator
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	113 A_ACCEPTED_ACK : Final = (
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	114 "accepted-ack"
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	115 )
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	116 A_START : Final = "start" # application can start
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	117 #: 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	118 #: cleaning operations
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	119 A_DESTROY : Final = (
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	120 "destroy"
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	121 )
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	122
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	123 def __init__(self, host):
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	124 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	125 self.host = host
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	126 self._applications = {} # key: namespace, value: application data
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	127 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	128 # 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	129 self._type_transports = {
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	130 XEP_0166.TRANSPORT_DATAGRAM: [],
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	131 XEP_0166.TRANSPORT_STREAMING: [],
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	132 }
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	133
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	134 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	135 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	136
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	137 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	138 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	139
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	140 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	141 """Retrieve session from its SID
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	142
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	143 @param session_id: session ID
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	144 @return: found session
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	145
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	146 @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	147 """
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	148 try:
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	149 return client.jingle_sessions[session_id]
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	150 except KeyError:
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	151 raise exceptions.NotFound(
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	152 f"No session with SID {session_id} found"
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	153 )
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
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	156 def _del_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	157 try:
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	158 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	159 except KeyError:
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	160 log.debug(
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	161 f"Jingle session id {sid!r} is unknown, nothing to delete "
fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	162 f"[{client.profile}]")
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	163 else:
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	164 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	165
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	166 ## 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	167
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	168 def _build_jingle_elt(
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	169 self,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	170 client: SatXMPPEntity,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	171 session: dict,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	172 action: str
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	173 ) -> Tuple[xmlstream.IQ, domish.Element]:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	174 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	175 iq_elt["from"] = session['local_jid'].full()
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	176 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	177 jingle_elt = iq_elt.addElement("jingle", NS_JINGLE)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	178 jingle_elt["sid"] = session["id"]
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	179 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	180 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	181
2489 e2a7bb875957 plugin pipe/stream, file transfert: refactoring and improvments: Goffi <goffi@goffi.org> parents: 2487 diff changeset	182 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	183 """Send error stanza
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	184
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	185 @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	186 @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	187 @param request(domish.Element): original request
1614 1ced93821c35 plugin XEP-0166: sendError now manage jingle conditions Goffi <goffi@goffi.org> parents: 1585 diff changeset	188 @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	189 """
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	190 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	191 if jingle_condition is not None:
1ced93821c35 plugin XEP-0166: sendError now manage jingle conditions Goffi <goffi@goffi.org> parents: 1585 diff changeset	192 iq_elt.error.addElement((NS_JINGLE_ERROR, jingle_condition))
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	193 if error.STANZA_CONDITIONS[error_condition]["type"] == "cancel" and sid:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	194 self._del_session(client, sid)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	195 log.warning(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	196 "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	197 condition=error_condition
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	198 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	199 )
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	200 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	201
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	202 def _terminate_eb(self, failure_):
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	203 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	204
3527 bbf92ef05f38 plugin XEP-0166, XEP-0234: better management of `terminate`: Goffi <goffi@goffi.org> parents: 3479 diff changeset	205 def terminate(self, client, reason, session, text=None):
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	206 """Terminate the session
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	207
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	208 send the session-terminate action, and delete the session data
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	209 @param reason(unicode, list[domish.Element]): if unicode, will be transformed to an element
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	210 if a list of element, add them as children of the <reason/> element
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	211 @param session(dict): data of the session
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	212 """
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	213 iq_elt, jingle_elt = self._build_jingle_elt(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	214 client, session, XEP_0166.A_SESSION_TERMINATE
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	215 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	216 reason_elt = jingle_elt.addElement("reason")
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	217 if isinstance(reason, str):
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	218 reason_elt.addElement(reason)
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	219 else:
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	220 for elt in reason:
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	221 reason_elt.addChild(elt)
3527 bbf92ef05f38 plugin XEP-0166, XEP-0234: better management of `terminate`: Goffi <goffi@goffi.org> parents: 3479 diff changeset	222 if text is not None:
bbf92ef05f38 plugin XEP-0166, XEP-0234: better management of `terminate`: Goffi <goffi@goffi.org> parents: 3479 diff changeset	223 reason_elt.addElement("text", content=text)
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	224 self._del_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	225 d = iq_elt.send()
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	226 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	227 return d
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	228
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	229 ## 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	230
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	231 def _iq_error(self, failure_, sid, client):
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	232 """Called when we got an <iq/> error
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	233
1614 1ced93821c35 plugin XEP-0166: sendError now manage jingle conditions Goffi <goffi@goffi.org> parents: 1585 diff changeset	234 @param failure_(failure.Failure): the exceptions raised
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	235 @param sid(unicode): jingle session id
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	236 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	237 log.warning(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	238 "Error while sending jingle <iq/> stanza: {failure_}".format(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	239 failure_=failure_.value
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	240 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	241 )
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	242 self._del_session(client, sid)
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	243
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	244 def _jingle_error_cb(self, failure_, session, request, client):
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	245 """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	246
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	247 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	248 exceptions.DataError raise a bad-request condition
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	249 @param fail(failure.Failure): the exceptions raised
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	250 @param session(dict): 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	251 @param request(domsih.Element): jingle request
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	252 @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	253 """
4053 dd39e60ca2aa plugin XEP-0166: set `jingle_elt`, `desc_elt` and `transport_elt`: Goffi <goffi@goffi.org> parents: 4044 diff changeset	254 del session["jingle_elt"]
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	255 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	256 if isinstance(failure_.value, defer.FirstError):
bbf92ef05f38 plugin XEP-0166, XEP-0234: better management of `terminate`: Goffi <goffi@goffi.org> parents: 3479 diff changeset	257 failure_ = failure_.value.subFailure.value
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	258 if isinstance(failure_, exceptions.DataError):
3527 bbf92ef05f38 plugin XEP-0166, XEP-0234: better management of `terminate`: Goffi <goffi@goffi.org> parents: 3479 diff changeset	259 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	260 elif isinstance(failure_, error.StanzaError):
bbf92ef05f38 plugin XEP-0166, XEP-0234: better management of `terminate`: Goffi <goffi@goffi.org> parents: 3479 diff changeset	261 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	262 text=str(failure_))
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	263 else:
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	264 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	265 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	266 text=str(failure_))
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	267
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	268 ## 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	269
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	270 def register_application(
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	271 self,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	272 namespace: str,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	273 handler: BaseApplicationHandler
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	274 ) -> None:
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	275 """Register an application plugin
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	276
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	277 @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	278 @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	279 May have the following methods:
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	280 - 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	281 - 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	282 - 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	283 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	284 - 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	285 - jingle_session_init(
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	286 client, self, session, content_name[, args, *kwargs]
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	287 ): 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	288 - jingle_handler(
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	289 client, self, action, session, content_name, transport_elt
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	290 ):
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	291 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	292 - 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	293 May be used to clean session
1523 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 if namespace in self._applications:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	296 raise exceptions.ConflictError(
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	297 f"Trying to register already registered namespace {namespace}"
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	298 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	299 self._applications[namespace] = ApplicationData(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	300 namespace=namespace, handler=handler
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	301 )
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	302 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	303
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	304 def register_transport(
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	305 self,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	306 namespace: str,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	307 transport_type: str,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	308 handler: BaseTransportHandler,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	309 priority: int = 0
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	310 ) -> None:
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	311 """Register a transport plugin
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	312
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	313 @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	314 @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	315 @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	316 @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	317 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	318 assert transport_type in (
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	319 XEP_0166.TRANSPORT_DATAGRAM,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	320 XEP_0166.TRANSPORT_STREAMING,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	321 )
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	322 if namespace in self._transports:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	323 raise exceptions.ConflictError(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	324 "Trying to register already registered namespace {}".format(namespace)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	325 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	326 transport_data = TransportData(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	327 namespace=namespace, handler=handler, priority=priority
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	328 )
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	329 self._type_transports[transport_type].append(transport_data)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	330 self._type_transports[transport_type].sort(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	331 key=lambda transport_data: transport_data.priority, reverse=True
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	332 )
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	333 self._transports[namespace] = transport_data
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	334 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	335
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	336 @defer.inlineCallbacks
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	337 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	338 """Replace a transport
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	339
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	340 @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	341 @param session(dict): jingle session data
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	342 @param content_name(unicode): name of the content
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	343 """
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	344 # 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	345 # 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	346 # this behavious may change in the future.
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	347 content_data = session["contents"][content_name]
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	348 transport_data = content_data["transport_data"]
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	349 try:
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	350 transport = self._transports[transport_ns]
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	351 except KeyError:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	352 raise exceptions.InternalError("Unkown transport")
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	353 yield content_data["transport"].handler.jingle_handler(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	354 client, XEP_0166.A_DESTROY, session, content_name, None
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	355 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	356 content_data["transport"] = transport
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	357 transport_data.clear()
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	358
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	359 iq_elt, jingle_elt = self._build_jingle_elt(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	360 client, session, XEP_0166.A_TRANSPORT_REPLACE
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	361 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	362 content_elt = jingle_elt.addElement("content")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	363 content_elt["name"] = content_name
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	364 content_elt["creator"] = content_data["creator"]
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	365
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	366 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	367 content_elt.addChild(transport_elt)
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	368 iq_elt.send()
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	369
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	370 def build_action(
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	371 self,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	372 client: SatXMPPEntity,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	373 action: str,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	374 session: dict,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	375 content_name: str,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	376 iq_elt: Optional[xmlstream.IQ] = None,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	377 context_elt: Optional[domish.Element] = None
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	378 ) -> Tuple[xmlstream.IQ, domish.Element]:
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	379 """Build an element according to requested action
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	380
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	381 @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	382 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	383 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	384 @param session: jingle session data
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	385 @param content_name: name of the content
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	386 @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	387 @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	388 @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	389 """
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	390 # 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	391 if iq_elt is not None:
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	392 try:
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	393 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	394 except StopIteration:
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	395 raise exceptions.InternalError(
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	396 "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	397 )
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	398 else:
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	399 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	400 # 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	401 content_data = session["contents"][content_name]
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	402 content_elt = jingle_elt.addElement("content")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	403 content_elt["name"] = content_name
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	404 content_elt["creator"] = content_data["creator"]
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	405
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	406 if context_elt is not None:
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	407 pass
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	408 elif action == XEP_0166.A_TRANSPORT_INFO:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	409 context_elt = transport_elt = content_elt.addElement(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	410 "transport", content_data["transport"].namespace
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	411 )
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	412 else:
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	413 raise exceptions.InternalError(f"unmanaged action {action}")
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	414
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	415 return iq_elt, context_elt
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	416
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	417 def build_session_info(self, client, session):
1616 1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	418 """Build a session-info action
1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	419
1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	420 @param session(dict): jingle session data
1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	421 @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	422 """
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	423 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	424
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	425 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	426 """Retreive application corresponding to a namespace
26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	427
26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	428 @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	429 """
26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	430 try:
26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	431 return self._applications[namespace]
26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	432 except KeyError:
26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	433 raise exceptions.NotFound(
26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	434 f"No application registered for {namespace}"
26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	435 )
26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	436
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	437 def get_content_data(self, content: dict) -> ContentData:
3404 26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	438 """"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	439 app_ns = content["app_ns"]
26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	440 try:
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	441 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	442 except exceptions.NotFound as e:
26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	443 raise exceptions.InternalError(str(e))
26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	444 app_args = content.get("app_args", [])
26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	445 app_kwargs = content.get("app_kwargs", {})
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	446 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	447 try:
26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	448 content_name = content["name"]
26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	449 except KeyError:
26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	450 content_name = content["name"] = str(uuid.uuid4())
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	451 return ContentData(
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	452 application,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	453 app_args,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	454 app_kwargs,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	455 transport_data,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	456 content_name
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	457 )
3404 26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	458
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	459 async def initiate(
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	460 self,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	461 client: SatXMPPEntity,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	462 peer_jid: jid.JID,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	463 contents: List[dict],
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	464 encrypted: bool = False,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	465 **extra_data: Any
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	466 ) -> str:
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	467 """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	468
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	469 @param peer_jid: jid to establith session with
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	470 @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	471 The dict must have the following keys:
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	472 - 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	473 the following keys are optional:
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	474 - 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	475 default to TRANSPORT_STREAMING
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	476 - name(str): name of the content
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	477 - senders(str): One of XEP_0166.ROLE_INITIATOR, XEP_0166.ROLE_RESPONDER, both or none
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	478 default 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	479 - 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	480 - 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	481 @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	482 to all content data of session
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	483 @return: jingle session id
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	484 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	485 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	486 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	487 or client.is_component and peer_jid.host == client.jid.host):
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	488 raise ValueError(_("You can't do a jingle session with yourself"))
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	489 initiator = client.jid
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	490 sid = str(uuid.uuid4())
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	491 # TODO: session cleaning after timeout ?
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	492 session = client.jingle_sessions[sid] = {
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	493 "id": sid,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	494 "state": STATE_PENDING,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	495 "initiator": initiator,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	496 "role": XEP_0166.ROLE_INITIATOR,
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	497 "local_jid": client.jid,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	498 "peer_jid": peer_jid,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	499 "started": time.time(),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	500 "contents": {},
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	501 **extra_data,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	502 }
3404 26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	503
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	504 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	505 "XEP-0166_initiate",
26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	506 client, session, contents
26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	507 ):
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	508 return sid
3404 26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	509
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	510 iq_elt, jingle_elt = self._build_jingle_elt(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	511 client, session, XEP_0166.A_SESSION_INITIATE
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	512 )
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	513 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	514 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	515
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	516 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	517
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	518 for content in contents:
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	519 # we get the application plugin
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	520 content_data = self.get_content_data(content)
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	521
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	522 # and the transport plugin
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	523 transport_type = content.get("transport_type", XEP_0166.TRANSPORT_STREAMING)
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	524 try:
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	525 transport = self._type_transports[transport_type][0]
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	526 except IndexError:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	527 raise exceptions.InternalError(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	528 "No transport registered for {}".format(transport_type)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	529 )
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	530
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	531 # 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	532 application_data = {}
dd39e60ca2aa plugin XEP-0166: set `jingle_elt`, `desc_elt` and `transport_elt`: Goffi <goffi@goffi.org> parents: 4044 diff changeset	533 transport_data = content_data.transport_data
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	534 session_content = {
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	535 "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	536 "application_data": application_data,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	537 "transport": transport,
4053 dd39e60ca2aa plugin XEP-0166: set `jingle_elt`, `desc_elt` and `transport_elt`: Goffi <goffi@goffi.org> parents: 4044 diff changeset	538 "transport_data": transport_data,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	539 "creator": XEP_0166.ROLE_INITIATOR,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	540 "senders": content.get("senders", "both"),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	541 }
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	542 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	543 raise exceptions.InternalError(
26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	544 "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	545 )
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	546 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	547
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	548 # we construct the content element
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	549 content_elt = jingle_elt.addElement("content")
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	550 content_elt["creator"] = session_content["creator"]
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	551 content_elt["name"] = content_data.content_name
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	552 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	553 content_elt["senders"] = content["senders"]
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	554 except KeyError:
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	555 pass
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	556
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	557 # 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	558 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	559 content_data.application.handler.jingle_session_init,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	560 client, session, content_data.content_name,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	561 content_data.app_args, *content_data.app_kwargs
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	562 )
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	563 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	564
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	565 # 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	566 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	567 transport.handler.jingle_session_init,
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	568 client, session, content_data.content_name,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	569 )
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	570 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	571
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	572 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	573 "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	574 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	575 ):
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	576 return sid
4053 dd39e60ca2aa plugin XEP-0166: set `jingle_elt`, `desc_elt` and `transport_elt`: Goffi <goffi@goffi.org> parents: 4044 diff changeset	577
dd39e60ca2aa plugin XEP-0166: set `jingle_elt`, `desc_elt` and `transport_elt`: Goffi <goffi@goffi.org> parents: 4044 diff changeset	578 # 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	579 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	580 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	581 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	582 del session["jingle_elt"]
dd39e60ca2aa plugin XEP-0166: set `jingle_elt`, `desc_elt` and `transport_elt`: Goffi <goffi@goffi.org> parents: 4044 diff changeset	583
3969 8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	584 if encrypted:
8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	585 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	586 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	587 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	588 "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	589 )
8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	590
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	591 try:
3404 26a0af6e32c1 plugin XEP-0166: new trigger point + coroutines + helper methods: Goffi <goffi@goffi.org> parents: 3333 diff changeset	592 await iq_elt.send()
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	593 except Exception as e:
7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	594 failure_ = failure.Failure(e)
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	595 self._iq_error(failure_, sid, client)
2502 7ad5f2c4e34a XEP-0065,XEP-0096,XEP-0166,XEP-0235,XEP-0300: file transfer improvments: Goffi <goffi@goffi.org> parents: 2489 diff changeset	596 raise failure_
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	597 return sid
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	598
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	599 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	600 """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	601
d05f9179fe22 plugin XEP-0166: added delayedContentTerminate to terminate a content inside a handler Goffi <goffi@goffi.org> parents: 1616 diff changeset	602 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	603 """
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	604 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	605
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	606 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	607 """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	608
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	609 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	610 @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	611 @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	612 @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	613 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	614 contents = session["contents"]
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	615 del contents[content_name]
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	616 if not contents:
2489 e2a7bb875957 plugin pipe/stream, file transfert: refactoring and improvments: Goffi <goffi@goffi.org> parents: 2487 diff changeset	617 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	618
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	619 ## 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	620
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	621 def jingle_request_confirmation_default(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	622 self, client, action, session, content_name, desc_elt
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	623 ):
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	624 """This method request confirmation for a jingle session"""
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	625 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	626 return xml_tools.defer_confirm(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	627 self.host,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	628 _(CONFIRM_TXT).format(entity=session["peer_jid"].full()),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	629 _("Confirm Jingle session"),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	630 profile=client.profile,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	631 )
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	632
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	633 ## jingle events ##
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	634
3969 8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	635 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	636 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	637
8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	638 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	639 self,
8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	640 client: SatXMPPEntity,
8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	641 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	642 ) -> None:
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	643 """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	644
2489 e2a7bb875957 plugin pipe/stream, file transfert: refactoring and improvments: Goffi <goffi@goffi.org> parents: 2487 diff changeset	645 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	646 according to current state
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	647 @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	648 """
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	649 request.handled = True
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	650 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	651
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	652 # 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	653 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	654 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	655 if not sid:
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	656 raise KeyError
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	657 except KeyError:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	658 log.warning("Received jingle request has no sid attribute")
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	659 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	660 return
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	661
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	662 # then the action
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	663 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	664 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	665 if not action:
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	666 raise KeyError
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	667 except KeyError:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	668 log.warning("Received jingle request has no action")
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	669 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	670 return
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	671
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	672 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	673
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	674 # 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	675 try:
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	676 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	677 except KeyError:
2489 e2a7bb875957 plugin pipe/stream, file transfert: refactoring and improvments: Goffi <goffi@goffi.org> parents: 2487 diff changeset	678 if action == XEP_0166.A_SESSION_INITIATE:
e2a7bb875957 plugin pipe/stream, file transfert: refactoring and improvments: Goffi <goffi@goffi.org> parents: 2487 diff changeset	679 pass
e2a7bb875957 plugin pipe/stream, file transfert: refactoring and improvments: Goffi <goffi@goffi.org> parents: 2487 diff changeset	680 elif action == XEP_0166.A_SESSION_TERMINATE:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	681 log.debug(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	682 "ignoring session terminate action (inexisting session id): {request_id} [{profile}]".format(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	683 request_id=sid, profile=client.profile
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	684 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	685 )
2489 e2a7bb875957 plugin pipe/stream, file transfert: refactoring and improvments: Goffi <goffi@goffi.org> parents: 2487 diff changeset	686 return
e2a7bb875957 plugin pipe/stream, file transfert: refactoring and improvments: Goffi <goffi@goffi.org> parents: 2487 diff changeset	687 else:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	688 log.warning(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	689 "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	690 request_id=sid, profile=client.profile
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	691 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	692 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	693 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	694 return
a1e5bcd9a6eb jingle XEP-0166: fixed session creation on non session-initiate actions Goffi <goffi@goffi.org> parents: 1614 diff changeset	695
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	696 session = client.jingle_sessions[sid] = {
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	697 "id": sid,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	698 "state": STATE_PENDING,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	699 "initiator": peer_jid,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	700 "role": XEP_0166.ROLE_RESPONDER,
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	701 # we store local_jid using request['to'] because for a component the 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	702 # used may not be client.jid (if a local part is used).
69e4716d6268 plugins (jingle) file transfer: use initial "from" attribute as local jid instead of client.jid: Goffi <goffi@goffi.org> parents: 2920 diff changeset	703 "local_jid": jid.JID(request['to']),
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	704 "peer_jid": peer_jid,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	705 "started": time.time(),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	706 }
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	707 else:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	708 if session["peer_jid"] != peer_jid:
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	709 log.warning(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	710 "sid conflict ({}), the jid doesn't match. Can be a collision, a hack attempt, or a bad sid generation".format(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	711 sid
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	712 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	713 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	714 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	715 return
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	716 if session["id"] != sid:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	717 log.error("session id doesn't match")
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	718 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	719 raise exceptions.InternalError
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	720
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	721 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	722 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	723 elif action == XEP_0166.A_SESSION_TERMINATE:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	724 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	725 elif action == XEP_0166.A_SESSION_ACCEPT:
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	726 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	727 elif action == XEP_0166.A_SESSION_INFO:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	728 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	729 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	730 self.on_transport_info(client, request, jingle_elt, session)
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	731 elif action == XEP_0166.A_TRANSPORT_REPLACE:
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	732 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	733 elif action == XEP_0166.A_TRANSPORT_ACCEPT:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	734 self.on_transport_accept(client, request, jingle_elt, session)
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	735 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	736 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	737 else:
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	738 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	739
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	740 ## Actions callbacks ##
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	741
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	742 def _parse_elements(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	743 self,
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	744 jingle_elt: domish.Element,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	745 session: dict,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	746 request: domish.Element,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	747 client: SatXMPPEntity,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	748 new: bool = False,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	749 creator: str = ROLE_INITIATOR,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	750 with_application: bool =True,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	751 with_transport: bool = True,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	752 store_in_session: bool = True,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	753 ) -> Dict[str, dict]:
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	754 """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	755
4053 dd39e60ca2aa plugin XEP-0166: set `jingle_elt`, `desc_elt` and `transport_elt`: Goffi <goffi@goffi.org> parents: 4044 diff changeset	756 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	757 "transport_elt"
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	758 @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	759 @param session: session data
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	760 @param request: the whole request
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	761 @param client: %(doc_client)s
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	762 @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	763 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	764 @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	765 @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	766 element else ignore it
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	767 @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	768 else ignore it
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	769 @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	770 the parsed elements.
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	771 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	772 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	773 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	774 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	775 @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	776 @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	777 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	778 """
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	779 if store_in_session:
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	780 contents_dict = session["contents"]
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	781 else:
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	782 if new:
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	783 raise exceptions.InternalError(
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	784 '"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	785 )
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	786 contents_dict = {n: {} for n in session["contents"]}
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	787 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	788
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	789 for content_elt in content_elts:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	790 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	791
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	792 if new:
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	793 # 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	794 if not name or name in contents_dict:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	795 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	796 raise exceptions.CancelError
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	797 content_data = contents_dict[name] = {
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	798 "creator": creator,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	799 "senders": content_elt.attributes.get("senders", "both"),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	800 }
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	801 else:
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	802 # 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	803 try:
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	804 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	805 except KeyError:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	806 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	807 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	808 raise exceptions.CancelError
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	809
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	810 # application
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	811 if with_application:
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	812 desc_elt = content_elt.description
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	813 if not desc_elt:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	814 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	815 raise exceptions.CancelError
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	816
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	817 if new:
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	818 # 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	819 app_ns = desc_elt.uri
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	820 if not app_ns or app_ns == NS_JINGLE:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	821 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	822 raise exceptions.CancelError
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	823
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	824 try:
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	825 application = self._applications[app_ns]
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	826 except KeyError:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	827 log.warning(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	828 "Unmanaged application namespace [{}]".format(app_ns)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	829 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	830 self.sendError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	831 client, "service-unavailable", session["id"], request
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	832 )
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	833 raise exceptions.CancelError
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	834
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	835 content_data["application"] = application
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	836 content_data["application_data"] = {}
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	837 else:
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	838 # 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	839 if "desc_elt" in content_data:
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	840 raise exceptions.InternalError(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	841 "desc_elt should not exist at this point"
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	842 )
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	843
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	844 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	845
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	846 # transport
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	847 if with_transport:
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	848 transport_elt = content_elt.transport
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	849 if not transport_elt:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	850 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	851 raise exceptions.CancelError
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	852
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	853 if new:
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	854 # 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	855 transport_ns = transport_elt.uri
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	856 if not app_ns or app_ns == NS_JINGLE:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	857 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	858 raise exceptions.CancelError
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	859
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	860 try:
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	861 transport = self._transports[transport_ns]
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	862 except KeyError:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	863 raise exceptions.InternalError(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	864 "No transport registered for namespace {}".format(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	865 transport_ns
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	866 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	867 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	868 content_data["transport"] = transport
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	869 content_data["transport_data"] = {}
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	870 else:
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	871 # 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	872 if "transport_elt" in content_data:
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	873 raise exceptions.InternalError(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	874 "transport_elt should not exist at this point"
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	875 )
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	876
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	877 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	878
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	879 return contents_dict
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	880
2489 e2a7bb875957 plugin pipe/stream, file transfert: refactoring and improvments: Goffi <goffi@goffi.org> parents: 2487 diff changeset	881 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	882 """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	883
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	884 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	885 """
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	886 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	887
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	888 def _call_plugins(
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	889 self,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	890 client: SatXMPPEntity,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	891 action: str,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	892 session: dict,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	893 app_method_name: Optional[str] = "jingle_handler",
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	894 transp_method_name: Optional[str] = "jingle_handler",
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	895 app_default_cb: Optional[Callable] = None,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	896 transp_default_cb: Optional[Callable] = None,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	897 delete: bool = True,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	898 elements: bool = True,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	899 force_element: Optional[domish.Element] = None
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	900 ) -> List[defer.Deferred]:
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	901 """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	902
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	903 @param action: jingle action name
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	904 @param session: jingle session data
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	905 @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	906 None to ignore
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	907 @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	908 None to ignore
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	909 @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	910 None to raise an exception instead
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	911 @param transp_default_cb: default callback to use if plugin has not transp_method_name
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	912 None to raise an exception instead
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	913 @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	914 ignored if elements is False
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	915 @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	916 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	917 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	918 @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	919 else it is ignored
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	920 @return : list of launched Deferred
1616 1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	921 @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	922 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	923 contents_dict = session["contents"]
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	924 defers_list = []
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	925 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	926 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	927 (app_method_name, "application", app_default_cb, "desc_elt"),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	928 (transp_method_name, "transport", transp_default_cb, "transport_elt"),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	929 ):
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	930 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	931 continue
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	932
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	933 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	934 try:
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	935 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	936 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	937 if default_cb is None:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	938 raise exceptions.NotFound(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	939 "{} not implemented !".format(method_name)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	940 )
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	941 else:
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	942 method = default_cb
1616 1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	943 if elements:
1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	944 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	945 else:
1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	946 elt = force_element
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	947 d = utils.as_deferred(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	948 method, client, action, session, content_name, elt
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	949 )
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	950 defers_list.append(d)
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	951
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	952 return defers_list
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	953
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	954 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	955 self,
8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	956 client: SatXMPPEntity,
8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	957 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	958 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	959 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	960 ) -> None:
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	961 """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	962
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	963 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	964 (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	965 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	966 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	967 @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	968 @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	969 @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	970 @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	971 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	972 if "contents" in session:
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	973 raise exceptions.InternalError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	974 "Contents dict should not already exist at this point"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	975 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	976 session["contents"] = contents_dict = {}
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	977
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	978 try:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	979 self._parse_elements(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	980 jingle_elt, session, request, client, True, XEP_0166.ROLE_INITIATOR
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	981 )
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	982 except exceptions.CancelError:
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	983 return
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	984
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	985 if not contents_dict:
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	986 # there MUST be at least one content
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	987 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	988 return
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	989
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	990 # 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	991 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	992
3969 8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	993
4053 dd39e60ca2aa plugin XEP-0166: set `jingle_elt`, `desc_elt` and `transport_elt`: Goffi <goffi@goffi.org> parents: 4044 diff changeset	994 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	995 session["jingle_elt"] = jingle_elt
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	996 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	997 "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	998 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	999 ):
8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	1000 return
8e7d5796fb23 plugin XEP-0391: implement XEP-0391 (Jingle Encrypted Transports) + XEP-0396 (JET-OMEMO): Goffi <goffi@goffi.org> parents: 3527 diff changeset	1001
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1002 await defer.DeferredList(self._call_plugins(
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1003 client,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1004 XEP_0166.A_PREPARE_CONFIRMATION,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1005 session,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1006 delete=False
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1007 ))
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1008
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1009 # 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	1010 # and if all are accepted, we can accept the session
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1011 confirm_defers = self._call_plugins(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1012 client,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1013 XEP_0166.A_SESSION_INITIATE,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1014 session,
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1015 "jingle_request_confirmation",
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1016 None,
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1017 self.jingle_request_confirmation_default,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1018 delete=False,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1019 )
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1020
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1021 confirm_dlist = defer.gatherResults(confirm_defers)
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1022 confirm_dlist.addCallback(self._confirmation_cb, session, jingle_elt, client)
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1023 confirm_dlist.addErrback(self._jingle_error_cb, session, request, client)
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1024
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1025 def _confirmation_cb(self, confirm_results, 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	1026 """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	1027
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1028 This method is only called for the responder
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1029 @param confirm_results(list[bool]): all True if session is accepted
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1030 @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	1031 @param jingle_elt(domish.Element): jingle data of this session
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1032 @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	1033 """
4053 dd39e60ca2aa plugin XEP-0166: set `jingle_elt`, `desc_elt` and `transport_elt`: Goffi <goffi@goffi.org> parents: 4044 diff changeset	1034 del session["jingle_elt"]
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1035 confirmed = all(confirm_results)
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1036 if not confirmed:
2489 e2a7bb875957 plugin pipe/stream, file transfert: refactoring and improvments: Goffi <goffi@goffi.org> parents: 2487 diff changeset	1037 return self.terminate(client, XEP_0166.REASON_DECLINE, session)
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1038
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1039 iq_elt, jingle_elt = self._build_jingle_elt(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1040 client, session, XEP_0166.A_SESSION_ACCEPT
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1041 )
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	1042 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	1043 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	1044
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1045 # contents
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1046
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1047 def addElement(domish_elt, content_elt):
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1048 content_elt.addChild(domish_elt)
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1049
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1050 defers_list = []
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1051
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	1052 for content_name, content_data in session["contents"].items():
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1053 content_elt = jingle_elt.addElement("content")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1054 content_elt["creator"] = XEP_0166.ROLE_INITIATOR
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1055 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	1056
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1057 application = content_data["application"]
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1058 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	1059
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1060 app_d = utils.as_deferred(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1061 app_session_accept_cb,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1062 client,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1063 XEP_0166.A_SESSION_INITIATE,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1064 session,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1065 content_name,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1066 content_data.pop("desc_elt"),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1067 )
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1068 app_d.addCallback(addElement, content_elt)
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1069 defers_list.append(app_d)
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1070
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1071 transport = content_data["transport"]
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1072 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	1073
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1074 transport_d = utils.as_deferred(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1075 transport_session_accept_cb,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1076 client,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1077 XEP_0166.A_SESSION_INITIATE,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1078 session,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1079 content_name,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1080 content_data.pop("transport_elt"),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1081 )
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1082 transport_d.addCallback(addElement, content_elt)
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1083 defers_list.append(transport_d)
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1084
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1085 d_list = defer.DeferredList(defers_list)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1086 d_list.addCallback(
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1087 lambda __: self._call_plugins(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1088 client,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1089 XEP_0166.A_PREPARE_RESPONDER,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1090 session,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1091 app_method_name=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1092 elements=False,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1093 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1094 )
4053 dd39e60ca2aa plugin XEP-0166: set `jingle_elt`, `desc_elt` and `transport_elt`: Goffi <goffi@goffi.org> parents: 4044 diff changeset	1095 d_list.addCallback(lambda __: session.pop("jingle_elt"))
2765 378188abe941 misc: replaced all "dummy" by the more conventional and readable "__" ("_" being used for gettext) Goffi <goffi@goffi.org> parents: 2624 diff changeset	1096 d_list.addCallback(lambda __: iq_elt.send())
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1097
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1098 def change_state(__, session):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1099 session["state"] = STATE_ACTIVE
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1100
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1101 d_list.addCallback(change_state, session)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1102 d_list.addCallback(
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1103 lambda __: self._call_plugins(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1104 client, XEP_0166.A_ACCEPTED_ACK, session, elements=False
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1105 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1106 )
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1107 d_list.addErrback(self._iq_error, session["id"], client)
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1108 return d_list
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1109
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1110 def on_session_terminate(self, 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	1111 # 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	1112 log.debug(f"Jingle Session {session['id']} terminated")
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	1113 try:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	1114 reason_elt = next(jingle_elt.elements(NS_JINGLE, "reason"))
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	1115 except StopIteration:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	1116 log.warning("No reason given for session termination")
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1117 reason_elt = jingle_elt.addElement("reason")
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	1118
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1119 terminate_defers = self._call_plugins(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1120 client,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1121 XEP_0166.A_SESSION_TERMINATE,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1122 session,
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1123 "jingle_terminate",
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1124 "jingle_terminate",
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1125 self._ignore,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1126 self._ignore,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1127 elements=False,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1128 force_element=reason_elt,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1129 )
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	1130 terminate_dlist = defer.DeferredList(terminate_defers)
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	1131
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1132 terminate_dlist.addCallback(lambda __: self._del_session(client, session["id"]))
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1133 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	1134
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1135 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	1136 """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	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 initiator
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1139 @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	1140 @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	1141 @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	1142 @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	1143 """
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1144 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	1145
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1146 try:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1147 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	1148 except exceptions.CancelError:
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1149 return
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1150
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1151 # 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	1152 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	1153 # and change the state
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1154 session["state"] = STATE_ACTIVE
4053 dd39e60ca2aa plugin XEP-0166: set `jingle_elt`, `desc_elt` and `transport_elt`: Goffi <goffi@goffi.org> parents: 4044 diff changeset	1155 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	1156
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1157 await defer.DeferredList(self._call_plugins(
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1158 client,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1159 XEP_0166.A_PREPARE_INITIATOR,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1160 session,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1161 delete=False
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1162 ))
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1163
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1164 negociate_defers = []
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1165 negociate_defers = 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	1166
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	1167 negociate_dlist = defer.gatherResults(negociate_defers)
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1168
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1169 # after negociations we start the transfer
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1170 negociate_dlist.addCallback(
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1171 lambda __: self._call_plugins(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1172 client, XEP_0166.A_START, session, app_method_name=None, elements=False
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1173 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1174 )
4053 dd39e60ca2aa plugin XEP-0166: set `jingle_elt`, `desc_elt` and `transport_elt`: Goffi <goffi@goffi.org> parents: 4044 diff changeset	1175 negociate_dlist.addCallback(lambda __: 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	1176
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1177 def _on_session_cb(self, result, client, request, jingle_elt, session):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1178 client.send(xmlstream.toResponse(request, "result"))
1616 1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	1179
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1180 def _on_session_eb(self, failure_, client, request, jingle_elt, session):
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1181 log.error("Error while handling on_session_info: {}".format(failure_.value))
1616 1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	1182 # XXX: only error managed so far, maybe some applications/transports need more
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1183 self.sendError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1184 client, "feature-not-implemented", None, request, "unsupported-info"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1185 )
1616 1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	1186
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1187 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	1188 """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	1189
1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	1190 This method is only called for initiator
1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	1191 @param client: %(doc_client)s
1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	1192 @param request(domish.Element): full <iq> request
1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	1193 @param jingle_elt(domish.Element): the <jingle> element
1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	1194 @param session(dict): session data
1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	1195 """
1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	1196 if not jingle_elt.children:
1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	1197 # 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	1198 client.send(xmlstream.toResponse(request, "result"))
1616 1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	1199 return
1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	1200
1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	1201 try:
1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	1202 # XXX: session-info is most likely only used for application, so we don't call transport plugins
1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	1203 # if a future transport use it, this behaviour must be adapted
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1204 defers = self._call_plugins(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1205 client,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1206 XEP_0166.A_SESSION_INFO,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1207 session,
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1208 "jingle_session_info",
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1209 None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1210 elements=False,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1211 force_element=jingle_elt,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1212 )
1616 1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	1213 except exceptions.NotFound as e:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1214 self._on_session_eb(failure.Failure(e), client, request, jingle_elt, session)
1616 1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	1215 return
1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	1216
1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	1217 dlist = defer.DeferredList(defers, fireOnOneErrback=True)
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1218 dlist.addCallback(self._on_session_cb, client, request, jingle_elt, session)
524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1219 dlist.addErrback(self._on_session_cb, client, request, jingle_elt, session)
1616 1e05b776a55b plugin XEP-0166: session-info action handling Goffi <goffi@goffi.org> parents: 1615 diff changeset	1220
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1221 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	1222 """A transport change is requested
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1223
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1224 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	1225 @param client: %(doc_client)s
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1226 @param request(domish.Element): full <iq> request
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1227 @param jingle_elt(domish.Element): the <jingle> element
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1228 @param session(dict): session data
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1229 """
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	1230 log.debug("Other peer wants to replace the transport")
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1231 try:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1232 self._parse_elements(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1233 jingle_elt, session, request, client, with_application=False
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1234 )
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1235 except exceptions.CancelError:
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1236 defer.returnValue(None)
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1237
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1238 client.send(xmlstream.toResponse(request, "result"))
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1239
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1240 content_name = None
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1241 to_replace = []
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1242
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	1243 for content_name, content_data in session["contents"].items():
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1244 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1245 transport_elt = content_data.pop("transport_elt")
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1246 except KeyError:
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1247 continue
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1248 transport_ns = transport_elt.uri
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1249 try:
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1250 transport = self._transports[transport_ns]
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1251 except KeyError:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1252 log.warning(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	1253 "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	1254 transport_ns
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1255 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1256 )
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1257 content_name = None
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1258 break
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1259 to_replace.append((content_name, content_data, transport, transport_elt))
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1260
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1261 if content_name is None:
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1262 # 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	1263 iq_elt, reject_jingle_elt = self._build_jingle_elt(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1264 client, session, XEP_0166.A_TRANSPORT_REJECT
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1265 )
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1266 for child in jingle_elt.children:
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1267 reject_jingle_elt.addChild(child)
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1268
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1269 iq_elt.send()
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1270 defer.returnValue(None)
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1271
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1272 # 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	1273 # 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	1274 iq_elt, accept_jingle_elt = self._build_jingle_elt(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1275 client, session, XEP_0166.A_TRANSPORT_ACCEPT
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1276 )
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1277 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	1278 # we can now actually replace the transport
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1279 await utils.as_deferred(
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1280 content_data["transport"].handler.jingle_handler,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1281 client, XEP_0166.A_DESTROY, session, content_name, None
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1282 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1283 content_data["transport"] = transport
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1284 content_data["transport_data"].clear()
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1285 # and build the element
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1286 content_elt = accept_jingle_elt.addElement("content")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1287 content_elt["name"] = content_name
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1288 content_elt["creator"] = content_data["creator"]
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1289 # 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	1290 accept_transport_elt = await utils.as_deferred(
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1291 transport.handler.jingle_handler,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1292 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	1293 )
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1294 content_elt.addChild(accept_transport_elt)
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1295 # 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	1296 await utils.as_deferred(
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1297 transport.handler.jingle_handler,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1298 client, XEP_0166.A_PREPARE_RESPONDER, session, content_name, None
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1299 )
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1300
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1301 iq_elt.send()
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1302
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1303 def on_transport_accept(self, client, request, jingle_elt, session):
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1304 """Method called once transport replacement is accepted
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1305
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1306 @param client: %(doc_client)s
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1307 @param request(domish.Element): full <iq> request
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1308 @param jingle_elt(domish.Element): the <jingle> element
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1309 @param session(dict): session data
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1310 """
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	1311 log.debug("new transport has been accepted")
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1312
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1313 try:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1314 self._parse_elements(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1315 jingle_elt, session, request, client, with_application=False
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1316 )
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1317 except exceptions.CancelError:
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1318 return
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1319
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1320 # 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	1321 client.send(xmlstream.toResponse(request, "result"))
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1322
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1323 negociate_defers = []
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1324 negociate_defers = self._call_plugins(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1325 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	1326 )
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1327
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1328 negociate_dlist = defer.DeferredList(negociate_defers)
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1329
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1330 # after negociations we start the transfer
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1331 negociate_dlist.addCallback(
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1332 lambda __: self._call_plugins(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1333 client, XEP_0166.A_START, session, app_method_name=None, elements=False
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1334 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1335 )
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1336
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 3969 diff changeset	1337 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	1338 """Method called when a transport replacement is refused
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1339
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1340 @param client: %(doc_client)s
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1341 @param request(domish.Element): full <iq> request
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1342 @param jingle_elt(domish.Element): the <jingle> element
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1343 @param session(dict): session data
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1344 """
c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1345 # 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	1346 # this behaviour may change in the future
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1347 self.terminate(client, "failed-transport", session)
1630 c25f63215632 plugin XEP-0166: transport replacement: Goffi <goffi@goffi.org> parents: 1617 diff changeset	1348
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1349 def on_transport_info(
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1350 self,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1351 client: SatXMPPEntity,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1352 request: domish.Element,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1353 jingle_elt: domish.Element,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1354 session: dict
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1355 ) -> None:
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	1356 """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	1357
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1358 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	1359 plugin(s)
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	1360 @param client: %(doc_client)s
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1361 @param request: full <iq> request
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1362 @param jingle_elt: the <jingle> element
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1363 @param session: session data
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	1364 """
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1365 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	1366
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	1367 try:
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1368 parsed_contents = self._parse_elements(
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1369 jingle_elt, session, request, client, with_application=False,
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1370 store_in_session=False
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1371 )
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	1372 except exceptions.CancelError:
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	1373 return
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	1374
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	1375 # The parsing was OK, we send the <iq> result
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1376 client.send(xmlstream.toResponse(request, "result"))
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	1377
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	1378 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	1379 try:
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1380 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	1381 except KeyError:
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	1382 continue
cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	1383 else:
4044 3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1384 utils.as_deferred(
3900626bc100 plugin XEP-0166: refactoring, and various improvments: Goffi <goffi@goffi.org> parents: 4037 diff changeset	1385 content_data["transport"].handler.jingle_handler,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1386 client,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1387 XEP_0166.A_TRANSPORT_INFO,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1388 session,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1389 content_name,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1390 transport_elt,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1391 )
1556 cbfbe028d099 plugin XEP-0166, XEP-0234, XEP-0261: Goffi <goffi@goffi.org> parents: 1523 diff changeset	1392
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1393
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2927 diff changeset	1394 @implementer(iwokkel.IDisco)
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1395 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	1396
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1397 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	1398 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	1399
0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1400 def connectionInitialized(self):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1401 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	1402 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	1403 )
1523 0209f8d35873 plugin XEP-0166: (jingle) first draft. Not all actions are managed yet Goffi <goffi@goffi.org> parents: diff changeset	1404
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1405 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	1406 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	1407
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	1408 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	1409 return []

Mercurial > libervia-backend

annotate libervia/backend/plugins/plugin_xep_0166/__init__.py @ 4108:238e305f2306

annotate libervia/backend/plugins/plugin_xep_0166/init.py @ 4108:238e305f2306