Mercurial > libervia-backend
view src/tools/trigger.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 | 2daf7b4c6756 |
children | 8b37a62336c3 |
line wrap: on
line source
#!/usr/bin/env python2 # -*- coding: utf-8 -*- # SAT: a jabber client # Copyright (C) 2009-2016 Jérôme Poisson (goffi@goffi.org) # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU Affero General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU Affero General Public License for more details. # You should have received a copy of the GNU Affero General Public License # along with this program. If not, see <http://www.gnu.org/licenses/>. """Misc usefull classes""" from sat.core.i18n import _ from sat.core.log import getLogger log = getLogger(__name__) class TriggerException(Exception): pass class SkipOtherTriggers(Exception): """ Exception to raise if normal behaviour must be followed instead of following triggers list """ pass class TriggerManager(object): """This class manage triggers: code which interact to change the behaviour of SàT""" try: # FIXME: to be removed when a better solution is found MIN_PRIORITY = float('-inf') MAX_PRIORITY = float('+inf') except: # XXX: Pyjamas will bug if you specify ValueError here # Pyjamas uses the JS Float class MIN_PRIORITY = Number.NEGATIVE_INFINITY MAX_PRIORITY = Number.POSITIVE_INFINITY def __init__(self): self.__triggers = {} def add(self, point_name, callback, priority=0): """Add a trigger to a point @param point_name: name of the point when the trigger should be run @param callback: method to call at the trigger point @param priority: callback will be called in priority order, biggest first """ if point_name not in self.__triggers: self.__triggers[point_name] = [] if priority != 0 and priority in [trigger_tuple[0] for trigger_tuple in self.__triggers[point_name]]: if priority in (self.MIN_PRIORITY, self.MAX_PRIORITY): log.warning(_(u"There is already a bound priority [%s]") % point_name) else: log.debug(_(u"There is already a trigger with the same priority [%s]") % point_name) self.__triggers[point_name].append((priority, callback)) self.__triggers[point_name].sort(key=lambda trigger_tuple: trigger_tuple[0], reverse=True) def remove(self, point_name, callback): """Remove a trigger from a point @param point_name: name of the point when the trigger should be run @param callback: method to remove, must exists in the trigger point""" for trigger_tuple in self.__triggers[point_name]: if trigger_tuple[1] == callback: self.__triggers[point_name].remove(trigger_tuple) return raise TriggerException("Trying to remove an unexisting trigger") def point(self, point_name, *args, **kwargs): """This put a trigger point All the trigger for that point will be run @param point_name: name of the trigger point @return: True if the action must be continued, False else""" if point_name not in self.__triggers: return True for priority, trigger in self.__triggers[point_name]: try: if not trigger(*args, **kwargs): return False except SkipOtherTriggers: break return True