Mercurial > libervia-backend

diff src/memory/memory.py @ 2144:1d3f73e065e1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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 d44efd32bc2f
children 1bb9bf1b4150
line wrap: on
line diff
--- a/src/memory/memory.py	Tue Feb 07 00:15:03 2017 +0100
+++ b/src/memory/memory.py	Sun Feb 12 17:55:43 2017 +0100
@@ -453,12 +453,15 @@
 
         self.memory_data['Profile_default'] = profile
 
-    def asyncCreateProfile(self, name, password):
+    def createProfile(self, name, password, component=None):
         """Create a new profile
-        @param name (unicode): profile name
-        @param password (unicode): profile password
+
+        @param name(unicode): profile name
+        @param password(unicode): profile password
             Can be empty to disable password
+        @param component(None, unicode): set to entry point if this is a component
         @return: Deferred
+        @raise exceptions.NotFound: component is not a known plugin import name
         """
         if not name:
             raise ValueError(u"Empty profile name")
@@ -470,7 +473,16 @@
         if name in self._entities_cache:
             raise exceptions.ConflictError(u"A session for this profile exists")
 
-        d = self.params.asyncCreateProfile(name)
+        if component:
+            if not component in self.host.plugins:
+                raise exceptions.NotFound(_(u"Can't find component {component} entry point".format(
+                    component = component)))
+            # FIXME: PLUGIN_INFO is not currently accessible after import, but type shoul be tested here
+            # if self.host.plugins[component].PLUGIN_INFO[u"type"] != C.PLUG_TYPE_ENTRY_POINT:
+            #     raise ValueError(_(u"Plugin {component} is not an entry point !".format(
+            #         component = component)))
+
+        d = self.params.createProfile(name, component)
 
         def initPersonalKey(dummy):
             # be sure to call this after checking that the profile doesn't exist yet
@@ -495,6 +507,7 @@
 
     def asyncDeleteProfile(self, name, force=False):
         """Delete an existing profile
+
         @param name: Name of the profile
         @param force: force the deletion even if the profile is connected.
         To be used for direct calls only (not through the bridge).
@@ -510,6 +523,24 @@
         d.addCallback(cleanMemory)
         return d
 
+    def isComponent(self, profile_name):
+        """Tell if a profile is a component
+
+        @param profile_name(unicode): name of the profile
+        @return (bool): True if profile is a component
+        @raise exceptions.NotFound: profile doesn't exist
+        """
+        return self.storage.profileIsComponent(profile_name)
+
+    def getEntryPoint(self, profile_name):
+        """Get a component entry point
+
+        @param profile_name(unicode): name of the profile
+        @return (bool): True if profile is a component
+        @raise exceptions.NotFound: profile doesn't exist
+        """
+        return self.storage.getEntryPoint(profile_name)
+
     ## History ##
 
     def addToHistory(self, client, data):