libervia-backend: src/plugins/plugin_xep

annotate src/plugins/plugin_xep_0163.py @ 283:68cd30d982a5

core: added plugins for PubSub et PEP (first drafts) - plugin for XEP 0060, 0163 and 0107, based on Wokkel's pubsub - XEP 0115 plugin has been fixed, so generateHash can be called when features have changed (can be usefull to filter PEP)

author	Goffi <goffi@goffi.org>
date	Thu, 03 Feb 2011 18:06:25 +0100
parents
children	3b382fa0ac28

rev	line source
283 68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	1 #!/usr/bin/python
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	2 # -- coding: utf-8 --
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	3
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	4 """
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	5 SAT plugin for Personal Eventing Protocol (xep-0163)
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	6 Copyright (C) 2009, 2010, 2011 Jérôme Poisson (goffi@goffi.org)
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	7
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	8 This program is free software: you can redistribute it and/or modify
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	9 it under the terms of the GNU General Public License as published by
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	10 the Free Software Foundation, either version 3 of the License, or
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	11 (at your option) any later version.
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	12
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	13 This program is distributed in the hope that it will be useful,
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	14 but WITHOUT ANY WARRANTY; without even the implied warranty of
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	16 GNU General Public License for more details.
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	17
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	18 You should have received a copy of the GNU General Public License
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	19 along with this program. If not, see <http://www.gnu.org/licenses/>.
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	20 """
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	21
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	22 from logging import debug, info, error
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	23 from twisted.internet import protocol
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	24 from twisted.words.protocols.jabber import client, jid
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	25 from twisted.words.protocols.jabber import error as jab_error
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	26 import twisted.internet.error
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	27
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	28 from wokkel import disco
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	29 from wokkel.formats import Mood
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	30
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	31 NS_USER_MOOD = 'http://jabber.org/protocol/mood'
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	32
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	33 PLUGIN_INFO = {
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	34 "name": "Personal Eventing Protocol Plugin",
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	35 "import_name": "XEP_0163",
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	36 "type": "XEP",
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	37 "protocols": ["XEP-0163", "XEP-0107"],
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	38 "dependencies": ["XEP-0060"],
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	39 "main": "XEP_0163",
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	40 "handler": "no",
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	41 "description": _("""Implementation of Personal Eventing Protocol""")
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	42 }
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	43
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	44 class XEP_0163():
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	45
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	46 def __init__(self, host):
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	47 info(_("PEP plugin initialization"))
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	48 self.host = host
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	49 self.pep_events=set()
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	50 host.trigger.add("PubSub Disco Info", self.disoInfoTrigger)
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	51 host.bridge.addSignal("personalEvent", ".communication", signature='ssa{ss}s') #args: from (jid), type(MOOD, TUNE, etc), data, profile
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	52 self.addPEPEvent("MOOD", NS_USER_MOOD, self.userMoodCB)
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	53
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	54 def disoInfoTrigger(self, disco_info, profile):
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	55 """Add info from managed PEP
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	56 @param disco_info: list of disco feature as returned by PubSub,
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	57 will be filled with PEP features
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	58 @param profile: profile we are handling"""
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	59 disco_info.extend(map(disco.DiscoFeature, self.pep_events))
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	60 return True
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	61
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	62 def addPEPEvent(self, event_type, name, callback):
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	63 """Add a Personal Eventing Protocol event manager
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	64 @param event_type: type of the event (always uppercase), can be MOOD, TUNE, etc
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	65 @param name: namespace of the node (e.g. http://jabber.org/protocol/mood for User Mood)
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	66 @param callback: method to call when this event occur"""
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	67 self.pep_events.add(name)
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	68 self.pep_events.add(name+"+notify")
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	69 self.host.plugins["XEP_0060"].addManagedNode(name, callback)
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	70
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	71 def userMoodCB(self, itemsEvent, profile):
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	72 try:
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	73 mood_elem = filter(lambda x:x.name == "mood", itemsEvent.items[0].children)[0]
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	74 except KeyError:
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	75 error(_("Can't find mood element in mood event"))
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	76 return
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	77 _mood = Mood.fromXml(mood_elem)
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	78 if not _mood:
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	79 error(_("Error while parsing mood element"))
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	80 return
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	81 self.host.bridge.personalEvent(itemsEvent.sender.full(), "MOOD", {"mood":_mood.value or "", "text":_mood.text or ""}, profile)
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	82

Mercurial > libervia-backend

annotate src/plugins/plugin_xep_0163.py @ 283:68cd30d982a5