diff src/plugins/plugin_xep_0071.py @ 2144:1d3f73e065e1

core, jp: component handling + client handling refactoring: - SàT can now handle components - plugin have now a "modes" key in PLUGIN_INFO where they declare if they can be used with clients and or components. They default to be client only. - components are really similar to clients, but with some changes in behaviour: * component has "entry point", which is a special plugin with a componentStart method, which is called just after component is connected * trigger end with a different suffixes (e.g. profileConnected vs profileConnectedComponent), so a plugin which manage both clients and components can have different workflow * for clients, only triggers of plugins handling client mode are launched * for components, only triggers of plugins needed in dependencies are launched. They all must handle component mode. * component have a sendHistory attribute (False by default) which can be set to True to allow saving sent messages into history * for convenience, "client" is still used in method even if it can now be a component * a new "component" boolean attribute tells if we have a component or a client * components have to add themselve Message protocol * roster and presence protocols are not added for components * component default port is 5347 (which is Prosody's default port) - asyncCreateProfile has been renamed for profileCreate, both to follow new naming convention and to prepare the transition to fully asynchronous bridge - createProfile has a new "component" attribute. When used to create a component, it must be set to a component entry point - jp: added --component argument to profile/create - disconnect bridge method is now asynchronous, this way frontends can know when disconnection is finished - new PI_* constants for PLUGIN_INFO values (not used everywhere yet) - client/component connection workflow has been moved to their classes instead of being a host methods - host.messageSend is now client.sendMessage, and former client.sendMessage is now client.sendMessageData. - identities are now handled in client.identities list, so it can be updated dynamically by plugins (in the future, frontends should be able to update them too through bridge) - profileConnecting* profileConnected* profileDisconnected* and getHandler now all use client instead of profile
author Goffi <goffi@goffi.org>
date Sun, 12 Feb 2017 17:55:43 +0100
parents 2d633b3c923d
children 33c8c4973743
line wrap: on
line diff
--- a/src/plugins/plugin_xep_0071.py	Tue Feb 07 00:15:03 2017 +0100
+++ b/src/plugins/plugin_xep_0071.py	Sun Feb 12 17:55:43 2017 +0100
@@ -81,9 +81,9 @@
         self._s = self.host.plugins["TEXT-SYNTAXES"]
         self._s.addSyntax(self.SYNTAX_XHTML_IM, lambda xhtml: xhtml, self.XHTML2XHTML_IM, [self._s.OPT_HIDDEN])
         host.trigger.add("MessageReceived", self.messageReceivedTrigger)
-        host.trigger.add("messageSend", self.messageSendTrigger)
+        host.trigger.add("sendMessage", self.sendMessageTrigger)
 
-    def getHandler(self, profile):
+    def getHandler(self, client):
         return XEP_0071_handler(self)
 
     def _messagePostTreat(self, data, message_elt, body_elts, client):
@@ -129,10 +129,10 @@
             d.addCallback(self._fill_body_text, data, lang)
             defers.append(d)
 
-    def _messageSendAddRich(self, data, client):
+    def _sendMessageAddRich(self, data, client):
         """ Construct XHTML-IM node and add it XML element
 
-        @param data: message data as sended by messageSend callback
+        @param data: message data as sended by sendMessage callback
         """
         # at this point, either ['extra']['rich'] or ['extra']['xhtml'] exists
         # but both can't exist at the same time
@@ -183,7 +183,7 @@
             post_treat.addCallback(self._messagePostTreat, message, body_elts, client)
         return True
 
-    def messageSendTrigger(self, client, data, pre_xml_treatments, post_xml_treatments):
+    def sendMessageTrigger(self, client, data, pre_xml_treatments, post_xml_treatments):
         """ Check presence of rich text in extra """
         rich = {}
         xhtml = {}
@@ -199,7 +199,7 @@
                 data['rich'] = rich
             else:
                 data['xhtml'] = xhtml
-            post_xml_treatments.addCallback(self._messageSendAddRich, client)
+            post_xml_treatments.addCallback(self._sendMessageAddRich, client)
         return True
 
     def _purgeStyle(self, styles_raw):