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

comparison libervia/backend/plugins/plugin_xep_0166/init.py @ 4288:f46891f2c9cb

plugin XEP-0166: handle `content-add` action + expose `get_transport`: - `content-add` is now handled at this plugin level (implementation needs to be done in apps and transports plugins). - `get_transport` is now exposed. rel 447

author	Goffi <goffi@goffi.org>
date	Mon, 29 Jul 2024 03:30:58 +0200
parents	0d7bb4df2343
children	e9971a4b0627

comparison

equal deleted inserted replaced

-:ff88a807852d
+:f46891f2c9cb
 A_SESSION_INITIATE: Final = "session-initiate"
 A_SESSION_ACCEPT: Final = "session-accept"
 A_SESSION_TERMINATE: Final = "session-terminate"
 A_SESSION_INFO: Final = "session-info"
+A_CONTENT_ADD: Final = "content-add"
+A_CONTENT_MODIFY: Final = "content-modify"
+A_CONTENT_REJECT: Final = "content-reject"
+A_CONTENT_REMOVE: Final = "content-remove"
 A_TRANSPORT_REPLACE: Final = "transport-replace"
 A_TRANSPORT_ACCEPT: Final = "transport-accept"
 A_TRANSPORT_REJECT: Final = "transport-reject"
 A_TRANSPORT_INFO: Final = "transport-info"
 "The <iq> element provided doesn't have a <jingle> element"
 )
 else:
 iq_elt, jingle_elt = self._build_jingle_elt(client, session, action)
 # 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
-content_data = session["contents"][content_name]
+if action.startswith("content-"):
+creator = session["role"]
+transport_namespace = None
+else:
+content_data = session["contents"][content_name]
+creator = content_data["creator"]
+transport_namespace = content_data["transport"].namespace
 content_elt = jingle_elt.addElement("content")
 content_elt["name"] = content_name
-content_elt["creator"] = content_data["creator"]
+content_elt["creator"] = creator
 if context_elt is not None:
 if context_elt.parent is None:
 content_elt.addChild(context_elt)
 elif action == XEP_0166.A_TRANSPORT_INFO:
 context_elt = transport_elt = content_elt.addElement(
-"transport", content_data["transport"].namespace
+"transport", transport_namespace
 )
 else:
 raise exceptions.InternalError(f"unmanaged action {action}")
 return iq_elt, context_elt
 try:
 return self._applications[namespace]
 except KeyError:
 raise exceptions.NotFound(f"No application registered for {namespace}")
-def get_content_data(self, content: dict, content_idx: int) -> ContentData:
+def get_content_data(
-""" "Retrieve application and its argument from content"""
+self, content: dict, content_idx: int | None = None
+) -> ContentData:
+"""Retrieve application and its argument from content"""
 app_ns = content["app_ns"]
 try:
 application = self.get_application(app_ns)
 except exceptions.NotFound as e:
 raise exceptions.InternalError(str(e))
 app_kwargs = content.get("app_kwargs", {})
 transport_data = content.get("transport_data", {})
 try:
 content_name = content["name"]
 except KeyError:
+if content_idx is None:
+raise exceptions.InternalError(
+'"content_idx" must be set if "content[\'name\']" is not set.'
+)
 content_name = content["name"] = str(content_idx)
 return ContentData(
 application, app_args, app_kwargs, transport_data, content_name
 )
+def get_transport(
+self,
+client: SatXMPPEntity,
+content: dict,
+content_data: ContentData,
+) -> TransportData:
+"""Find a suitable transport for given content"""
+transport_type = content.get("transport_type", XEP_0166.TRANSPORT_STREAMING)
+for transport in self._type_transports[transport_type]:
+if transport.handler.is_usable(client, content_data):
+break
+else:
+raise exceptions.InternalError(
+"No transport registered for {}".format(transport_type)
+)
+return transport
 async def initiate(
 self,
 client: SatXMPPEntity,
 peer_jid: jid.JID,
 for content_idx, content in enumerate(contents):
 # we get the application plugin
 content_data = self.get_content_data(content, content_idx)
 # and the transport plugin
-transport_type = content.get("transport_type", XEP_0166.TRANSPORT_STREAMING)
+transport = self.get_transport(client, content, content_data)
-for transport in self._type_transports[transport_type]:
-if transport.handler.is_usable(client, content_data):
-break
-else:
-raise exceptions.InternalError(
-"No transport registered for {}".format(transport_type)
-)
 # we build the session data for this content
 application_data = {}
 transport_data = content_data.transport_data
 session_content = {
 await self.on_session_terminate(client, request, jingle_elt, session)
 elif action == XEP_0166.A_SESSION_ACCEPT:
 await self.on_session_accept(client, request, jingle_elt, session)
 elif action == XEP_0166.A_SESSION_INFO:
 await self.on_session_info(client, request, jingle_elt, session)
+elif action == XEP_0166.A_CONTENT_ADD:
+await self.on_content_add(client, request, jingle_elt, session)
 elif action == XEP_0166.A_TRANSPORT_INFO:
 self.on_transport_info(client, request, jingle_elt, session)
 elif action == XEP_0166.A_TRANSPORT_REPLACE:
 await self.on_transport_replace(client, request, jingle_elt, session)
 elif action == XEP_0166.A_TRANSPORT_ACCEPT:
 @param force_element: if elements is False, it is used as element parameter
 else it is ignored
 @return : list of launched methods results
 @raise exceptions.NotFound: method is not implemented
 """
-contents_dict = session["contents"]
+if action == self.A_CONTENT_ADD:
+contents_dict = session["contents_new"]
+else:
+contents_dict = session["contents"]
 results = []
 for content_name, content_data in contents_dict.items():
 for method_name, handler_key, default_cb, elt_name in (
 (app_method_name, "application", app_default_cb, "desc_elt"),
 (transp_method_name, "transport", transp_default_cb, "transport_elt"),
 result = await utils.as_deferred(
 method, client, action, session, content_name, elt
 )
 results.append(result)
+if action == self.A_CONTENT_ADD:
+del session["contents_new"]
 return results
 async def on_session_initiate(
 self,
 client: SatXMPPEntity,
 )
 except Exception:
 log.exception("Error while managing session info")
 else:
 client.send(xmlstream.toResponse(request, "result"))
+async def on_content_add(
+self,
+client: SatXMPPEntity,
+request: domish.Element,
+jingle_elt: domish.Element,
+session: Dict[str, Any],
+) -> None:
+"""Called on content-add action
+The "jingle_request_confirmation" method of each application will be called
+(or self.jingle_request_confirmation_default if the former doesn't exist).
+The session is only accepted if all application are confirmed.
+The application must manage itself multiple contents scenari (e.g. audio/video).
+@param client: %(doc_client)s
+@param request(domish.Element): full request
+@param jingle_elt(domish.Element): <jingle> element
+@param session(dict): session data
+"""
+return
+try:
+contents_dict = self._parse_elements(
+jingle_elt,
+{"id": session["id"], "contents": {}},
+request,
+client,
+True,
+XEP_0166.ROLE_INITIATOR,
+)
+except exceptions.CancelError:
+return
+if not contents_dict:
+# there MUST be at least one content
+self.sendError(client, "bad-request", session["id"], request)
+return
+session["contents_new"] = contents_dict
+# at this point we can send the <iq/> result to confirm reception of the request
+client.send(xmlstream.toResponse(request, "result"))
+assert "jingle_elt" not in session
+session["jingle_elt"] = jingle_elt
+await self._call_plugins(client, XEP_0166.A_CONTENT_ADD, session, delete=False)
 async def on_transport_replace(self, client, request, jingle_elt, session):
 """A transport change is requested
 The request is parsed, and jingle_handler is called on concerned transport plugin(s)

Mercurial > libervia-backend

comparison libervia/backend/plugins/plugin_xep_0166/__init__.py @ 4288:f46891f2c9cb

comparison libervia/backend/plugins/plugin_xep_0166/init.py @ 4288:f46891f2c9cb