libervia-backend: src/plugins/plugin_misc

annotate src/plugins/plugin_misc_watched.py @ 2395:713cedc99752

plugin pubsub schema: allow any data_form schema: the schema is actually the schema needed for the items, so it should not in pubsub schema namespace.

author	Goffi <goffi@goffi.org>
date	Fri, 27 Oct 2017 17:54:00 +0200
parents	33c8c4973743
children	8b37a62336c3

rev	line source
1934 2daf7b4c6756 use of /usr/bin/env instead of /usr/bin/python in shebang Goffi <goffi@goffi.org> parents: 1766 diff changeset	1 #!/usr/bin/env python2
1480 8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	2 # -- coding: utf-8 --
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	3
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	4 # SàT plugin to be notified on some entities presence
1766 d17772b0fe22 copyright update Goffi <goffi@goffi.org> parents: 1599 diff changeset	5 # Copyright (C) 2009-2016 Jérôme Poisson (goffi@goffi.org)
1480 8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	6
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	7 # This program is free software: you can redistribute it and/or modify
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	8 # it under the terms of the GNU Affero General Public License as published by
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	9 # the Free Software Foundation, either version 3 of the License, or
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	10 # (at your option) any later version.
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	11
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	12 # This program is distributed in the hope that it will be useful,
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	15 # GNU Affero General Public License for more details.
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	16
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	17 # You should have received a copy of the GNU Affero General Public License
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	19
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	20 from sat.core.i18n import _, D_
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	21 from sat.core.constants import Const as C
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	22 from sat.core.log import getLogger
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	23 log = getLogger(__name__)
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	24 from sat.core import exceptions
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	25 from sat.tools import xml_tools
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	26
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	27
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	28 PLUGIN_INFO = {
2145 33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 1934 diff changeset	29 C.PI_NAME: "Watched",
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 1934 diff changeset	30 C.PI_IMPORT_NAME: "WATCHED",
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 1934 diff changeset	31 C.PI_TYPE: "Misc",
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 1934 diff changeset	32 C.PI_PROTOCOLS: [],
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 1934 diff changeset	33 C.PI_DEPENDENCIES: [],
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 1934 diff changeset	34 C.PI_MAIN: "Watched",
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 1934 diff changeset	35 C.PI_HANDLER: "no",
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 1934 diff changeset	36 C.PI_DESCRIPTION: _("""Watch for entities presence, and send notification accordingly""")
1480 8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	37 }
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	38
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	39
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	40 CATEGORY = D_("Misc")
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	41 NAME = "Watched"
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	42 NOTIF = D_("Watched entity {entity} is connected")
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	43
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	44
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	45 class Watched(object):
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	46 params = """
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	47 <params>
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	48 <individual>
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	49 <category name="{category_name}" label="{category_label}">
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	50 <param name="{name}" label="{label}" type="jids_list" security="0" />
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	51 </category>
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	52 </individual>
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	53 </params>
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	54 """.format(category_name=CATEGORY,
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	55 category_label=_(CATEGORY),
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	56 name=NAME,
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	57 label=_(NAME),
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	58 )
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	59
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	60 def __init__(self, host):
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	61 log.info(_("Watched initialisation"))
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	62 self.host = host
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	63 host.memory.updateParams(self.params)
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	64 host.trigger.add("presenceReceived", self._presenceReceivedTrigger)
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	65
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	66 def _presenceReceivedTrigger(self, entity, show, priority, statuses, profile):
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	67 if show == C.PRESENCE_UNAVAILABLE:
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	68 return True
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	69
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	70 # we check that the previous presence was unavailable (no notification else)
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	71 try:
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	72 old_show = self.host.memory.getEntityDatum(entity, "presence", profile).show
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	73 except (KeyError, exceptions.UnknownEntityError):
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	74 old_show = C.PRESENCE_UNAVAILABLE
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	75
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	76 if old_show == C.PRESENCE_UNAVAILABLE:
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	77 watched = self.host.memory.getParamA(NAME, CATEGORY, profile_key=profile)
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	78 if entity in watched or entity.userhostJID() in watched:
1599 e2ed8009e66e backend, bridge, frontends: actionNew has now a security_limit argument + added some docstring to explain data argument Goffi <goffi@goffi.org> parents: 1480 diff changeset	79 self.host.actionNew({'xmlui': xml_tools.note(_(NOTIF).format(entity=entity.full())).toXml()}, profile=profile)
1480 8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	80
8d61160ee4b8 core, plugin watched: new plugin, show an alert when a watched entity goes online Goffi <goffi@goffi.org> parents: diff changeset	81 return True

Mercurial > libervia-backend

annotate src/plugins/plugin_misc_watched.py @ 2395:713cedc99752