libervia-backend: src/plugins/plugin_xep

annotate src/plugins/plugin_xep_0163.py @ 375:502489e17685

D-Bus constructor: add Constructors specific flags (--flags argument) dbus-xml constructor now as annotation flag to add Qt annotation usefull for the Qt frontend (bellaciao)

author	Goffi <goffi@goffi.org>
date	Mon, 08 Aug 2011 23:04:19 +0200
parents	f964dcec1611
children	ef9a4453959b

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
286 3b382fa0ac28 plugin xep-0163: added mood publishing Goffi <goffi@goffi.org> parents: 283 diff changeset	27 from twisted.words.xish import domish
283 68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	28
286 3b382fa0ac28 plugin xep-0163: added mood publishing Goffi <goffi@goffi.org> parents: 283 diff changeset	29 from wokkel import disco,pubsub
283 68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	30 from wokkel.formats import Mood
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	31
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	32 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	33
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	34 PLUGIN_INFO = {
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	35 "name": "Personal Eventing Protocol Plugin",
290 59a82af700e2 plugin xep 163: added generic sendPEPEvent method Goffi <goffi@goffi.org> parents: 286 diff changeset	36 "import_name": "XEP-0163",
283 68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	37 "type": "XEP",
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	38 "protocols": ["XEP-0163", "XEP-0107"],
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	39 "dependencies": ["XEP-0060"],
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	40 "main": "XEP_0163",
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	41 "handler": "no",
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	42 "description": _("""Implementation of Personal Eventing Protocol""")
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
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	45 class XEP_0163():
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	46
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	47 def __init__(self, host):
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	48 info(_("PEP plugin initialization"))
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	49 self.host = host
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	50 self.pep_events=set()
290 59a82af700e2 plugin xep 163: added generic sendPEPEvent method Goffi <goffi@goffi.org> parents: 286 diff changeset	51 self.pep_out_cb={}
283 68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	52 host.trigger.add("PubSub Disco Info", self.disoInfoTrigger)
372 f964dcec1611 core: plugins refactored according to bridge + updatedValue now use profile Goffi <goffi@goffi.org> parents: 311 diff changeset	53 host.bridge.addSignal("personalEvent", ".plugin", signature='ssa{ss}s') #args: from (jid), type(MOOD, TUNE, etc), data, profile
f964dcec1611 core: plugins refactored according to bridge + updatedValue now use profile Goffi <goffi@goffi.org> parents: 311 diff changeset	54 host.bridge.addMethod("sendPersonalEvent", ".plugin", in_sign='sa{ss}s', out_sign='i', method=self.sendPersonalEvent) #args: type(MOOD, TUNE, etc), data, profile_key; return 0 or error_code
290 59a82af700e2 plugin xep 163: added generic sendPEPEvent method Goffi <goffi@goffi.org> parents: 286 diff changeset	55 self.addPEPEvent("MOOD", NS_USER_MOOD, self.userMoodCB, self.sendMood)
283 68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	56
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	57 def disoInfoTrigger(self, disco_info, profile):
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	58 """Add info from managed PEP
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	59 @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	60 will be filled with PEP features
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	61 @param profile: profile we are handling"""
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	62 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	63 return True
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	64
311 0aa6ca6cdbdd plugin group blog: group blog now use PEP to take profit of autosubscribe Goffi <goffi@goffi.org> parents: 290 diff changeset	65 def addPEPEvent(self, event_type, name, in_callback, out_callback = None, notify = True):
283 68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	66 """Add a Personal Eventing Protocol event manager
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	67 @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	68 @param name: namespace of the node (e.g. http://jabber.org/protocol/mood for User Mood)
290 59a82af700e2 plugin xep 163: added generic sendPEPEvent method Goffi <goffi@goffi.org> parents: 286 diff changeset	69 @param in_callback: method to call when this event occur
59a82af700e2 plugin xep 163: added generic sendPEPEvent method Goffi <goffi@goffi.org> parents: 286 diff changeset	70 @param out_callback: method to call when we want to publish this event
59a82af700e2 plugin xep 163: added generic sendPEPEvent method Goffi <goffi@goffi.org> parents: 286 diff changeset	71 @param notify: add autosubscribe (+notify) if True"""
311 0aa6ca6cdbdd plugin group blog: group blog now use PEP to take profit of autosubscribe Goffi <goffi@goffi.org> parents: 290 diff changeset	72 if out_callback:
0aa6ca6cdbdd plugin group blog: group blog now use PEP to take profit of autosubscribe Goffi <goffi@goffi.org> parents: 290 diff changeset	73 self.pep_out_cb[event_type] = out_callback
283 68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	74 self.pep_events.add(name)
290 59a82af700e2 plugin xep 163: added generic sendPEPEvent method Goffi <goffi@goffi.org> parents: 286 diff changeset	75 if notify:
59a82af700e2 plugin xep 163: added generic sendPEPEvent method Goffi <goffi@goffi.org> parents: 286 diff changeset	76 self.pep_events.add(name+"+notify")
59a82af700e2 plugin xep 163: added generic sendPEPEvent method Goffi <goffi@goffi.org> parents: 286 diff changeset	77 self.host.plugins["XEP-0060"].addManagedNode(name, in_callback)
59a82af700e2 plugin xep 163: added generic sendPEPEvent method Goffi <goffi@goffi.org> parents: 286 diff changeset	78
59a82af700e2 plugin xep 163: added generic sendPEPEvent method Goffi <goffi@goffi.org> parents: 286 diff changeset	79 def sendPEPEvent(self, namespace, data, profile):
59a82af700e2 plugin xep 163: added generic sendPEPEvent method Goffi <goffi@goffi.org> parents: 286 diff changeset	80 """Publish the event data
59a82af700e2 plugin xep 163: added generic sendPEPEvent method Goffi <goffi@goffi.org> parents: 286 diff changeset	81 @param namespace: node namespace
59a82af700e2 plugin xep 163: added generic sendPEPEvent method Goffi <goffi@goffi.org> parents: 286 diff changeset	82 @param data: domish.Element to use as payload
59a82af700e2 plugin xep 163: added generic sendPEPEvent method Goffi <goffi@goffi.org> parents: 286 diff changeset	83 @param profile: profile which send the data"""
59a82af700e2 plugin xep 163: added generic sendPEPEvent method Goffi <goffi@goffi.org> parents: 286 diff changeset	84
59a82af700e2 plugin xep 163: added generic sendPEPEvent method Goffi <goffi@goffi.org> parents: 286 diff changeset	85 item = pubsub.Item(payload=data)
59a82af700e2 plugin xep 163: added generic sendPEPEvent method Goffi <goffi@goffi.org> parents: 286 diff changeset	86 self.host.plugins["XEP-0060"].publish(None, namespace, [item], profile_key = profile)
283 68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	87
286 3b382fa0ac28 plugin xep-0163: added mood publishing Goffi <goffi@goffi.org> parents: 283 diff changeset	88 def sendPersonalEvent(self, event_type, data, profile_key='@DEFAULT@'):
3b382fa0ac28 plugin xep-0163: added mood publishing Goffi <goffi@goffi.org> parents: 283 diff changeset	89 """Send personal event after checking the data is alright
290 59a82af700e2 plugin xep 163: added generic sendPEPEvent method Goffi <goffi@goffi.org> parents: 286 diff changeset	90 @param event_type: type of event (eg: MOOD, TUNE), must be in self.pep_out_cb.keys()
286 3b382fa0ac28 plugin xep-0163: added mood publishing Goffi <goffi@goffi.org> parents: 283 diff changeset	91 @param data: dict of {string:string} of event_type dependant data
3b382fa0ac28 plugin xep-0163: added mood publishing Goffi <goffi@goffi.org> parents: 283 diff changeset	92 @param profile_key: profile who send the event
3b382fa0ac28 plugin xep-0163: added mood publishing Goffi <goffi@goffi.org> parents: 283 diff changeset	93 @return: 0 if success, error code else"""
3b382fa0ac28 plugin xep-0163: added mood publishing Goffi <goffi@goffi.org> parents: 283 diff changeset	94 profile = self.host.memory.getProfileName(profile_key)
3b382fa0ac28 plugin xep-0163: added mood publishing Goffi <goffi@goffi.org> parents: 283 diff changeset	95 if not profile:
3b382fa0ac28 plugin xep-0163: added mood publishing Goffi <goffi@goffi.org> parents: 283 diff changeset	96 error(_('Trying to send personal event with an unknown profile key [%s]') % profile_key)
3b382fa0ac28 plugin xep-0163: added mood publishing Goffi <goffi@goffi.org> parents: 283 diff changeset	97 return 1
290 59a82af700e2 plugin xep 163: added generic sendPEPEvent method Goffi <goffi@goffi.org> parents: 286 diff changeset	98 if not event_type in self.pep_out_cb.keys():
286 3b382fa0ac28 plugin xep-0163: added mood publishing Goffi <goffi@goffi.org> parents: 283 diff changeset	99 error (_('Trying to send personal event for an unknown type'))
3b382fa0ac28 plugin xep-0163: added mood publishing Goffi <goffi@goffi.org> parents: 283 diff changeset	100 return 2
290 59a82af700e2 plugin xep 163: added generic sendPEPEvent method Goffi <goffi@goffi.org> parents: 286 diff changeset	101 return self.pep_out_cb[event_type](data, profile)
286 3b382fa0ac28 plugin xep-0163: added mood publishing Goffi <goffi@goffi.org> parents: 283 diff changeset	102
283 68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	103 def userMoodCB(self, itemsEvent, profile):
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	104 try:
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	105 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	106 except KeyError:
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	107 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	108 return
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	109 _mood = Mood.fromXml(mood_elem)
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	110 if not _mood:
286 3b382fa0ac28 plugin xep-0163: added mood publishing Goffi <goffi@goffi.org> parents: 283 diff changeset	111 debug(_("No mood found"))
283 68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	112 return
68cd30d982a5 core: added plugins for PubSub et PEP (first drafts) Goffi <goffi@goffi.org> parents: diff changeset	113 self.host.bridge.personalEvent(itemsEvent.sender.full(), "MOOD", {"mood":_mood.value or "", "text":_mood.text or ""}, profile)
286 3b382fa0ac28 plugin xep-0163: added mood publishing Goffi <goffi@goffi.org> parents: 283 diff changeset	114
3b382fa0ac28 plugin xep-0163: added mood publishing Goffi <goffi@goffi.org> parents: 283 diff changeset	115 def sendMood(self, data, profile):
3b382fa0ac28 plugin xep-0163: added mood publishing Goffi <goffi@goffi.org> parents: 283 diff changeset	116 """Send XEP-0107's User Mood
3b382fa0ac28 plugin xep-0163: added mood publishing Goffi <goffi@goffi.org> parents: 283 diff changeset	117 @param data: must include mood and text
3b382fa0ac28 plugin xep-0163: added mood publishing Goffi <goffi@goffi.org> parents: 283 diff changeset	118 @param profile: profile which send the mood"""
3b382fa0ac28 plugin xep-0163: added mood publishing Goffi <goffi@goffi.org> parents: 283 diff changeset	119 try:
3b382fa0ac28 plugin xep-0163: added mood publishing Goffi <goffi@goffi.org> parents: 283 diff changeset	120 value = data['mood'].lower()
3b382fa0ac28 plugin xep-0163: added mood publishing Goffi <goffi@goffi.org> parents: 283 diff changeset	121 text = data['text'] if data.has_key('text') else ''
3b382fa0ac28 plugin xep-0163: added mood publishing Goffi <goffi@goffi.org> parents: 283 diff changeset	122 except KeyError:
3b382fa0ac28 plugin xep-0163: added mood publishing Goffi <goffi@goffi.org> parents: 283 diff changeset	123 error(_("Mood data must contain at least 'mood' key"))
3b382fa0ac28 plugin xep-0163: added mood publishing Goffi <goffi@goffi.org> parents: 283 diff changeset	124 return 3
3b382fa0ac28 plugin xep-0163: added mood publishing Goffi <goffi@goffi.org> parents: 283 diff changeset	125 _mood = UserMood(value, text)
290 59a82af700e2 plugin xep 163: added generic sendPEPEvent method Goffi <goffi@goffi.org> parents: 286 diff changeset	126 self.sendPEPEvent(NS_USER_MOOD, _mood, profile)
286 3b382fa0ac28 plugin xep-0163: added mood publishing Goffi <goffi@goffi.org> parents: 283 diff changeset	127 return 0
3b382fa0ac28 plugin xep-0163: added mood publishing Goffi <goffi@goffi.org> parents: 283 diff changeset	128
3b382fa0ac28 plugin xep-0163: added mood publishing Goffi <goffi@goffi.org> parents: 283 diff changeset	129 class UserMood(Mood, domish.Element):
3b382fa0ac28 plugin xep-0163: added mood publishing Goffi <goffi@goffi.org> parents: 283 diff changeset	130 """Improved wokkel Mood which is also a domish.Element"""
3b382fa0ac28 plugin xep-0163: added mood publishing Goffi <goffi@goffi.org> parents: 283 diff changeset	131
3b382fa0ac28 plugin xep-0163: added mood publishing Goffi <goffi@goffi.org> parents: 283 diff changeset	132 def __init__(self, value, text=None):
3b382fa0ac28 plugin xep-0163: added mood publishing Goffi <goffi@goffi.org> parents: 283 diff changeset	133 Mood.__init__(self, value, text)
3b382fa0ac28 plugin xep-0163: added mood publishing Goffi <goffi@goffi.org> parents: 283 diff changeset	134 domish.Element.__init__(self, (NS_USER_MOOD, 'mood'))
3b382fa0ac28 plugin xep-0163: added mood publishing Goffi <goffi@goffi.org> parents: 283 diff changeset	135 self.addElement(value)
3b382fa0ac28 plugin xep-0163: added mood publishing Goffi <goffi@goffi.org> parents: 283 diff changeset	136 if text:
3b382fa0ac28 plugin xep-0163: added mood publishing Goffi <goffi@goffi.org> parents: 283 diff changeset	137 self.addElement('text', content=text)
3b382fa0ac28 plugin xep-0163: added mood publishing Goffi <goffi@goffi.org> parents: 283 diff changeset	138

Mercurial > libervia-backend

annotate src/plugins/plugin_xep_0163.py @ 375:502489e17685