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
This commit is contained in:
Goffi 2017-02-12 17:55:43 +01:00
commit 97337202cb
3 changed files with 839 additions and 523 deletions

View file

@ -453,12 +453,15 @@ class Memory(object):
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 @@ class Memory(object):
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 @@ class Memory(object):
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 @@ class Memory(object):
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):

View file

@ -166,10 +166,11 @@ class Params(object):
self.params = {}
self.params_gen = {}
def asyncCreateProfile(self, profile):
def createProfile(self, profile, component):
"""Create a new profile
@param profile: name of the profile
@param profile(unicode): name of the profile
@param component(unicode): entry point if profile is a component
@param callback: called when the profile actually exists in database and memory
@return: a Deferred instance
"""
@ -178,7 +179,7 @@ class Params(object):
return defer.fail(Failure(exceptions.ConflictError))
if not self.host.trigger.point("ProfileCreation", profile):
return defer.fail(Failure(exceptions.CancelError))
return self.storage.createProfile(profile)
return self.storage.createProfile(profile, component or None)
def asyncDeleteProfile(self, profile, force=False):
"""Delete an existing profile

View file

@ -207,22 +207,37 @@ class SqliteStorage(object):
except KeyError:
raise exceptions.NotFound(u"the requested profile doesn't exists")
def createProfile(self, name):
def getEntryPoint(self, profile_name):
try:
return self.components[self.profiles[profile_name]]
except KeyError:
raise exceptions.NotFound(u"the requested profile doesn't exists or is not a component")
def createProfile(self, name, component=None):
"""Create a new profile
@param name: name of the profile
@param name(unicode): name of the profile
@param component(None, unicode): if not None, must point to a component entry point
@return: deferred triggered once profile is actually created
"""
def getProfileId(ignore):
return self.dbpool.runQuery("SELECT (id) FROM profiles WHERE name = ?", (name, ))
def setComponent(profile_id):
id_ = profile_id[0][0]
d_comp = self.dbpool.runQuery("INSERT INTO components(profile_id, entry_point) VALUES (?, ?)", (id_, component))
d_comp.addCallback(lambda dummy: profile_id)
return d_comp
def profile_created(profile_id):
_id = profile_id[0][0]
self.profiles[name] = _id # we synchronise the cache
id_= profile_id[0][0]
self.profiles[name] = id_ # we synchronise the cache
d = self.dbpool.runQuery("INSERT INTO profiles(name) VALUES (?)", (name, ))
d.addCallback(getProfileId)
if component is not None:
d.addCallback(setComponent)
d.addCallback(profile_created)
return d