Mercurial > libervia-backend
view src/plugins/plugin_misc_watched.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 | 33c8c4973743 |
line wrap: on
line source
#!/usr/bin/env python2 # -*- coding: utf-8 -*- # SàT plugin to be notified on some entities presence # 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/>. from sat.core.i18n import _, D_ from sat.core.constants import Const as C from sat.core.log import getLogger log = getLogger(__name__) from sat.core import exceptions from sat.tools import xml_tools PLUGIN_INFO = { "name": "Watched", "import_name": "WATCHED", "type": "Misc", "protocols": [], "dependencies": [], "main": "Watched", "handler": "no", "description": _("""Watch for entities presence, and send notification accordingly""") } CATEGORY = D_("Misc") NAME = "Watched" NOTIF = D_("Watched entity {entity} is connected") class Watched(object): params = """ <params> <individual> <category name="{category_name}" label="{category_label}"> <param name="{name}" label="{label}" type="jids_list" security="0" /> </category> </individual> </params> """.format(category_name=CATEGORY, category_label=_(CATEGORY), name=NAME, label=_(NAME), ) def __init__(self, host): log.info(_("Watched initialisation")) self.host = host host.memory.updateParams(self.params) host.trigger.add("presenceReceived", self._presenceReceivedTrigger) def _presenceReceivedTrigger(self, entity, show, priority, statuses, profile): if show == C.PRESENCE_UNAVAILABLE: return True # we check that the previous presence was unavailable (no notification else) try: old_show = self.host.memory.getEntityDatum(entity, "presence", profile).show except (KeyError, exceptions.UnknownEntityError): old_show = C.PRESENCE_UNAVAILABLE if old_show == C.PRESENCE_UNAVAILABLE: watched = self.host.memory.getParamA(NAME, CATEGORY, profile_key=profile) if entity in watched or entity.userhostJID() in watched: self.host.actionNew({'xmlui': xml_tools.note(_(NOTIF).format(entity=entity.full())).toXml()}, profile=profile) return True