comparison libervia/backend/plugins/plugin_xep_0166/__init__.py @ 4231:e11b13418ba6

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
author Goffi <goffi@goffi.org>
date Sat, 06 Apr 2024 12:57:23 +0200
parents 23fa52acf72c
children 79c8a70e1813
comparison
equal deleted inserted replaced
4230:314d3c02bb67 4231:e11b13418ba6
532 except KeyError: 532 except KeyError:
533 raise exceptions.NotFound( 533 raise exceptions.NotFound(
534 f"No application registered for {namespace}" 534 f"No application registered for {namespace}"
535 ) 535 )
536 536
537 def get_content_data(self, content: dict) -> ContentData: 537 def get_content_data(self, content: dict, content_idx: int) -> ContentData:
538 """"Retrieve application and its argument from content""" 538 """"Retrieve application and its argument from content"""
539 app_ns = content["app_ns"] 539 app_ns = content["app_ns"]
540 try: 540 try:
541 application = self.get_application(app_ns) 541 application = self.get_application(app_ns)
542 except exceptions.NotFound as e: 542 except exceptions.NotFound as e:
545 app_kwargs = content.get("app_kwargs", {}) 545 app_kwargs = content.get("app_kwargs", {})
546 transport_data = content.get("transport_data", {}) 546 transport_data = content.get("transport_data", {})
547 try: 547 try:
548 content_name = content["name"] 548 content_name = content["name"]
549 except KeyError: 549 except KeyError:
550 content_name = content["name"] = str(uuid.uuid4()) 550 content_name = content["name"] = str(content_idx)
551 return ContentData( 551 return ContentData(
552 application, 552 application,
553 app_args, 553 app_args,
554 app_kwargs, 554 app_kwargs,
555 transport_data, 555 transport_data,
609 jingle_elt["initiator"] = initiator.full() 609 jingle_elt["initiator"] = initiator.full()
610 session["jingle_elt"] = jingle_elt 610 session["jingle_elt"] = jingle_elt
611 611
612 session_contents = session["contents"] 612 session_contents = session["contents"]
613 613
614 for content in contents: 614 for content_idx, content in enumerate(contents):
615 # we get the application plugin 615 # we get the application plugin
616 content_data = self.get_content_data(content) 616 content_data = self.get_content_data(content, content_idx)
617 617
618 # and the transport plugin 618 # and the transport plugin
619 transport_type = content.get("transport_type", XEP_0166.TRANSPORT_STREAMING) 619 transport_type = content.get("transport_type", XEP_0166.TRANSPORT_STREAMING)
620 try: 620 for transport in self._type_transports[transport_type]:
621 transport = self._type_transports[transport_type][0] 621 if transport.handler.is_usable(client, content_data):
622 except IndexError: 622 break
623 else:
623 raise exceptions.InternalError( 624 raise exceptions.InternalError(
624 "No transport registered for {}".format(transport_type) 625 "No transport registered for {}".format(transport_type)
625 ) 626 )
626 627
627 # we build the session data for this content 628 # we build the session data for this content