plugin XEP-0166: new trigger point + coroutines + helper methods:

- a new `XEP-0166_initiate` async trigger point is available
- `initate` is now a coroutine
- `jingleSessionInit` in applications and transports handlers are now called using
  `utils.adDeferred`
- new `getApplication` helper method, to retrieve application from its namespace
- new `getContentData` helper method to retrieve application and its argument from content
This commit is contained in:
Goffi 2020-11-12 14:53:15 +01:00
commit aab9a8bf91
3 changed files with 72 additions and 42 deletions

View file

@ -17,14 +17,8 @@
# You should have received a copy of the GNU Affero General Public License # You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>. # along with this program. If not, see <http://www.gnu.org/licenses/>.
from sat.core.i18n import _, D_ import errno
from sat.core.constants import Const as C from zope import interface
from sat.core import exceptions
from sat.core.log import getLogger
log = getLogger(__name__)
from sat.tools import xml_tools
from sat.tools import stream
from twisted.words.xish import domish from twisted.words.xish import domish
from twisted.words.protocols.jabber import jid from twisted.words.protocols.jabber import jid
from twisted.internet import defer from twisted.internet import defer
@ -33,8 +27,15 @@ from twisted.internet import endpoints
from twisted.internet import reactor from twisted.internet import reactor
from twisted.internet import error from twisted.internet import error
from twisted.internet import interfaces from twisted.internet import interfaces
from zope import interface from sat.core.i18n import _, D_
import errno from sat.core.constants import Const as C
from sat.core import exceptions
from sat.core.log import getLogger
from sat.tools import xml_tools
from sat.tools import stream
log = getLogger(__name__)
NS_STREAM = "http://salut-a-toi.org/protocol/stream" NS_STREAM = "http://salut-a-toi.org/protocol/stream"
SECURITY_LIMIT = 30 SECURITY_LIMIT = 30
@ -193,10 +194,9 @@ class JingleStream(object):
def _streamOut(self, to_jid_s, profile_key): def _streamOut(self, to_jid_s, profile_key):
client = self.host.getClient(profile_key) client = self.host.getClient(profile_key)
return self.streamOut(client, jid.JID(to_jid_s)) return defer.ensureDeferred(self.streamOut(client, jid.JID(to_jid_s)))
@defer.inlineCallbacks async def streamOut(self, client, to_jid):
def streamOut(self, client, to_jid):
"""send a stream """send a stream
@param peer_jid(jid.JID): recipient @param peer_jid(jid.JID): recipient
@ -207,7 +207,7 @@ class JingleStream(object):
while True: while True:
endpoint = endpoints.TCP4ServerEndpoint(reactor, port) endpoint = endpoints.TCP4ServerEndpoint(reactor, port)
try: try:
port_listening = yield endpoint.listen(factory) port_listening = await endpoint.listen(factory)
except error.CannotListenError as e: except error.CannotListenError as e:
if e.socketError.errno == errno.EADDRINUSE: if e.socketError.errno == errno.EADDRINUSE:
port += 1 port += 1
@ -216,7 +216,8 @@ class JingleStream(object):
else: else:
factory.port_listening = port_listening factory.port_listening = port_listening
break break
self._j.initiate( # we don't want to wait for IQ result of initiate
defer.ensureDeferred(self._j.initiate(
client, client,
to_jid, to_jid,
[ [
@ -226,8 +227,8 @@ class JingleStream(object):
"app_kwargs": {"stream_object": factory}, "app_kwargs": {"stream_object": factory},
} }
], ],
) ))
defer.returnValue(str(port)) return str(port)
def jingleSessionInit(self, client, session, content_name, stream_object): def jingleSessionInit(self, client, session, content_name, stream_object):
content_data = session["contents"][content_name] content_data = session["contents"][content_name]

View file

@ -19,6 +19,7 @@
import uuid import uuid
import time import time
from typing import Tuple
from collections import namedtuple from collections import namedtuple
from zope.interface import implementer from zope.interface import implementer
from twisted.words.protocols.jabber import jid from twisted.words.protocols.jabber import jid
@ -336,8 +337,34 @@ class XEP_0166(object):
""" """
return self._buildJingleElt(client, session, XEP_0166.A_SESSION_INFO) return self._buildJingleElt(client, session, XEP_0166.A_SESSION_INFO)
@defer.inlineCallbacks def getApplication(self, namespace: str) -> object:
def initiate(self, client, peer_jid, contents): """Retreive application corresponding to a namespace
@raise exceptions.NotFound if application can't be found
"""
try:
return self._applications[namespace]
except KeyError:
raise exceptions.NotFound(
f"No application registered for {namespace}"
)
def getContentData(self, content: dict) -> Tuple[object, list, dict, str]:
""""Retrieve application and its argument from content"""
app_ns = content["app_ns"]
try:
application = self.getApplication(app_ns)
except exceptions.NotFound as e:
raise exceptions.InternalError(str(e))
app_args = content.get("app_args", [])
app_kwargs = content.get("app_kwargs", {})
try:
content_name = content["name"]
except KeyError:
content_name = content["name"] = str(uuid.uuid4())
return application, app_args, app_kwargs, content_name
async def initiate(self, client, peer_jid, contents):
"""Send a session initiation request """Send a session initiation request
@param peer_jid(jid.JID): jid to establith session with @param peer_jid(jid.JID): jid to establith session with
@ -352,7 +379,7 @@ class XEP_0166(object):
default to BOTH (see XEP-0166 §7.3) default to BOTH (see XEP-0166 §7.3)
- app_args(list): args to pass to the application plugin - app_args(list): args to pass to the application plugin
- app_kwargs(dict): keyword args to pass to the application plugin - app_kwargs(dict): keyword args to pass to the application plugin
@return D(unicode): jingle session id @return (unicode): jingle session id
""" """
assert contents # there must be at least one content assert contents # there must be at least one content
if (peer_jid == client.jid if (peer_jid == client.jid
@ -371,6 +398,13 @@ class XEP_0166(object):
"started": time.time(), "started": time.time(),
"contents": {}, "contents": {},
} }
if not await self.host.trigger.asyncPoint(
"XEP-0166_initiate",
client, session, contents
):
return
iq_elt, jingle_elt = self._buildJingleElt( iq_elt, jingle_elt = self._buildJingleElt(
client, session, XEP_0166.A_SESSION_INITIATE client, session, XEP_0166.A_SESSION_INITIATE
) )
@ -380,13 +414,7 @@ class XEP_0166(object):
for content in contents: for content in contents:
# we get the application plugin # we get the application plugin
app_ns = content["app_ns"] application, app_args, app_kwargs, content_name = self.getContentData(content)
try:
application = self._applications[app_ns]
except KeyError:
raise exceptions.InternalError(
"No application registered for {}".format(app_ns)
)
# and the transport plugin # and the transport plugin
transport_type = content.get("transport_type", XEP_0166.TRANSPORT_STREAMING) transport_type = content.get("transport_type", XEP_0166.TRANSPORT_STREAMING)
@ -406,15 +434,10 @@ class XEP_0166(object):
"creator": XEP_0166.ROLE_INITIATOR, "creator": XEP_0166.ROLE_INITIATOR,
"senders": content.get("senders", "both"), "senders": content.get("senders", "both"),
} }
try: if content_name in contents_dict:
content_name = content["name"] raise exceptions.InternalError(
except KeyError: "There is already a content with this name"
content_name = str(uuid.uuid4()) )
else:
if content_name in contents_dict:
raise exceptions.InternalError(
"There is already a content with this name"
)
contents_dict[content_name] = content_data contents_dict[content_name] = content_data
# we construct the content element # we construct the content element
@ -427,21 +450,21 @@ class XEP_0166(object):
pass pass
# then the description element # then the description element
app_args = content.get("app_args", []) desc_elt = await utils.asDeferred(
app_kwargs = content.get("app_kwargs", {}) application.handler.jingleSessionInit,
desc_elt = yield application.handler.jingleSessionInit(
client, session, content_name, *app_args, **app_kwargs client, session, content_name, *app_args, **app_kwargs
) )
content_elt.addChild(desc_elt) content_elt.addChild(desc_elt)
# and the transport one # and the transport one
transport_elt = yield transport.handler.jingleSessionInit( transport_elt = await utils.asDeferred(
transport.handler.jingleSessionInit,
client, session, content_name client, session, content_name
) )
content_elt.addChild(transport_elt) content_elt.addChild(transport_elt)
try: try:
yield iq_elt.send() await iq_elt.send()
except Exception as e: except Exception as e:
failure_ = failure.Failure(e) failure_ = failure.Failure(e)
self._iqError(failure_, sid, client) self._iqError(failure_, sid, client)

View file

@ -405,6 +405,11 @@ class XEP_0234:
# jingle callbacks # jingle callbacks
def jingleDescriptionElt(
self, client, session, content_name, filepath, name, extra, progress_id_d
):
return domish.Element((NS_JINGLE_FT, "description"))
def jingleSessionInit( def jingleSessionInit(
self, client, session, content_name, filepath, name, extra, progress_id_d self, client, session, content_name, filepath, name, extra, progress_id_d
): ):
@ -423,7 +428,8 @@ class XEP_0234:
assert "file_path" not in application_data assert "file_path" not in application_data
application_data["file_path"] = filepath application_data["file_path"] = filepath
file_data = application_data["file_data"] = {} file_data = application_data["file_data"] = {}
desc_elt = domish.Element((NS_JINGLE_FT, "description")) desc_elt = self.jingleDescriptionElt(
client, session, content_name, filepath, name, extra, progress_id_d)
file_elt = desc_elt.addElement("file") file_elt = desc_elt.addElement("file")
if content_data["senders"] == self._j.ROLE_INITIATOR: if content_data["senders"] == self._j.ROLE_INITIATOR: