libervia-backend/libervia/backend/tools/async_trigger.py
Goffi e8fb0a8a28 plugin XEP-0353, XEP-0234, jingle: WebRTC data channel signaling implementation:
Implement XEP-0343: Signaling WebRTC Data Channels in Jingle. The current version of the
XEP (0.3.1) has no implementation and contains some flaws. After discussing this on xsf@,
Daniel (from Conversations) mentioned that they had a sprint with Larma (from Dino) to
work on another version and provided me with this link:
https://gist.github.com/iNPUTmice/6c56f3e948cca517c5fb129016d99e74 . I have used it for my
implementation.

This implementation reuses work done on Jingle A/V call (notably XEP-0176 and XEP-0167
plugins), with adaptations. When used, XEP-0234 will not handle the file itself as it
normally does. This is because WebRTC has several implementations (browser for web
interface, GStreamer for others), and file/data must be handled directly by the frontend.
This is particularly important for web frontends, as the file is not sent from the backend
but from the end-user's browser device.

Among the changes, there are:

- XEP-0343 implementation.
- `file_send` bridge method now use serialised dict as output.
- New `BaseTransportHandler.is_usable` method which get content data and returns a boolean
  (default to `True`) to tell if this transport can actually be used in this context (when
  we are initiator). Used in webRTC case to see if call data are available.
- Support of `application` media type, and everything necessary to handle data channels.
- Better confirmation message, with file name, size and description when available.
- When file is accepted in preflight, it is specified in following `action_new` signal for
  actual file transfer. This way, frontend can avoid the display or 2 confirmation
  messages.
- XEP-0166: when not specified, default `content` name is now its index number instead of
  a UUID. This follows the behaviour of browsers.
- XEP-0353: better handling of events such as call taken by another device.
- various other updates.

rel 441
2024-04-06 12:57:23 +02:00

79 lines
2.7 KiB
Python

#!/usr/bin/env python3
# SAT: a jabber client
# Copyright (C) 2009-2021 Jérôme Poisson (goffi@goffi.org)
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
# 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/>.
"""Misc usefull classes"""
from typing import Tuple, Any
from libervia.backend.core.xmpp import SatXMPPEntity
from . import trigger as sync_trigger
from . import utils
from twisted.internet import defer
class TriggerManager(sync_trigger.TriggerManager):
"""This is a TriggerManager with an new async_point method"""
async def async_point(
self,
point_name: str,
*args, **kwargs
) -> bool:
"""This put a trigger point with potentially async Deferred
All the triggers for that point will be run
@param point_name: name of the trigger point
@param *args: args to transmit to trigger
@param *kwargs: kwargs to transmit to trigger
if "triggers_no_cancel" is present, it will be popped out
when set to True, this argument don't let triggers stop
the workflow
@return D(bool): True if the action must be continued, False else
"""
if point_name not in self.__triggers:
return True
can_cancel = not kwargs.pop('triggers_no_cancel', False)
for __, trigger in self.__triggers[point_name]:
try:
cont = await utils.as_deferred(trigger, *args, **kwargs)
if can_cancel and not cont:
return False
except sync_trigger.SkipOtherTriggers:
break
return True
async def async_return_point(
self,
point_name: str,
*args, **kwargs
) -> Tuple[bool, Any]:
"""Async version of return_point"""
if point_name not in self.__triggers:
return True, None
for priority, trigger in self.__triggers[point_name]:
try:
cont, ret_value = await utils.as_deferred(trigger, *args, **kwargs)
if not cont:
return False, ret_value
except sync_trigger.SkipOtherTriggers:
break
return True, None