Mercurial > libervia-backend
diff src/plugins/plugin_misc_watched.py @ 1480:8d61160ee4b8
core, plugin watched: new plugin, show an alert when a watched entity goes online
author | Goffi <goffi@goffi.org> |
---|---|
date | Thu, 20 Aug 2015 18:43:56 +0200 |
parents | |
children | e2ed8009e66e |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/plugins/plugin_misc_watched.py Thu Aug 20 18:43:56 2015 +0200 @@ -0,0 +1,81 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- + +# SàT plugin to be notified on some entities presence +# Copyright (C) 2009, 2010, 2011, 2012, 2013, 2014, 2015 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) + + return True