From dfff19ffbfecae9817437121ed1d8bfb9d847800 Mon Sep 17 00:00:00 2001 From: Lance Stout Date: Mon, 24 Sep 2012 22:59:19 -0700 Subject: Add XEP-0297: Stanza Forwarding support --- setup.py | 1 + sleekxmpp/plugins/__init__.py | 1 + sleekxmpp/plugins/xep_0297/__init__.py | 16 +++++++++ sleekxmpp/plugins/xep_0297/forwarded.py | 59 +++++++++++++++++++++++++++++++++ sleekxmpp/plugins/xep_0297/stanza.py | 34 +++++++++++++++++++ 5 files changed, 111 insertions(+) create mode 100644 sleekxmpp/plugins/xep_0297/__init__.py create mode 100644 sleekxmpp/plugins/xep_0297/forwarded.py create mode 100644 sleekxmpp/plugins/xep_0297/stanza.py diff --git a/setup.py b/setup.py index 369566ac..d8fd6ef9 100755 --- a/setup.py +++ b/setup.py @@ -102,6 +102,7 @@ packages = [ 'sleekxmpp', 'sleekxmpp/plugins/xep_0249', 'sleekxmpp/plugins/xep_0258', 'sleekxmpp/plugins/xep_0279', + 'sleekxmpp/plugins/xep_0297', 'sleekxmpp/features', 'sleekxmpp/features/feature_mechanisms', 'sleekxmpp/features/feature_mechanisms/stanza', diff --git a/sleekxmpp/plugins/__init__.py b/sleekxmpp/plugins/__init__.py index ed82c185..f09a26f1 100644 --- a/sleekxmpp/plugins/__init__.py +++ b/sleekxmpp/plugins/__init__.py @@ -68,5 +68,6 @@ __all__ = [ 'xep_0258', # Security Labels in XMPP 'xep_0270', # XMPP Compliance Suites 2010 'xep_0279', # Server IP Check + 'xep_0297', # Stanza Forwarding 'xep_0302', # XMPP Compliance Suites 2012 ] diff --git a/sleekxmpp/plugins/xep_0297/__init__.py b/sleekxmpp/plugins/xep_0297/__init__.py new file mode 100644 index 00000000..551d9420 --- /dev/null +++ b/sleekxmpp/plugins/xep_0297/__init__.py @@ -0,0 +1,16 @@ +""" + SleekXMPP: The Sleek XMPP Library + Copyright (C) 2012 Nathanael C. Fritz, Lance J.T. Stout + This file is part of SleekXMPP. + + See the file LICENSE for copying permission. +""" + +from sleekxmpp.plugins.base import register_plugin + +from sleekxmpp.plugins.xep_0297 import stanza +from sleekxmpp.plugins.xep_0297.stanza import Forwarded +from sleekxmpp.plugins.xep_0297.forwarded import XEP_0297 + + +register_plugin(XEP_0297) diff --git a/sleekxmpp/plugins/xep_0297/forwarded.py b/sleekxmpp/plugins/xep_0297/forwarded.py new file mode 100644 index 00000000..7876967c --- /dev/null +++ b/sleekxmpp/plugins/xep_0297/forwarded.py @@ -0,0 +1,59 @@ +""" + SleekXMPP: The Sleek XMPP Library + Copyright (C) 2012 Nathanael C. Fritz, Lance J.T. Stout + This file is part of SleekXMPP. + + See the file LICENSE for copying permission. +""" + + +import logging + +from sleekxmpp import Iq, Message, Presence +from sleekxmpp.plugins import BasePlugin +from sleekxmpp.xmlstream import register_stanza_plugin +from sleekxmpp.xmlstream.handler import Callback +from sleekxmpp.xmlstream.matcher import StanzaPath +from sleekxmpp.plugins.xep_0297 import stanza, Forwarded + + +class XEP_0297(BasePlugin): + + name = 'xep_0297' + description = 'XEP-0297: Stanza Forwarding' + dependencies = set(['xep_0030', 'xep_0203']) + stanza = stanza + + def plugin_init(self): + register_stanza_plugin(Message, Forwarded) + register_stanza_plugin(Forwarded, Message) + register_stanza_plugin(Forwarded, Presence) + register_stanza_plugin(Forwarded, Iq) + register_stanza_plugin(Forwarded, self.xmpp['xep_0203'].stanza.Delay) + + self.xmpp.register_handler( + Callback('Forwarded Stanza', + StanzaPath('message/forwarded'), + self._handle_forwarded)) + + def session_bind(self, jid): + self.xmpp['xep_0030'].add_feature('urn:xmpp:forward:0') + + def plugin_end(self): + self.xmpp['xep_0030'].del_feature(feature='urn:xmpp:forward:0') + self.xmpp.remove_handler('Forwarded Stanza') + + def forward(self, stanza=None, mto=None, mbody=None, mfrom=None, delay=None): + stanza.stream = None + + msg = self.xmpp.Message() + msg['to'] = mto + msg['from'] = mfrom + msg['body'] = mbody + msg['forwarded']['stanza'] = stanza + if delay is not None: + msg['forwarded']['delay']['stamp'] = delay + msg.send() + + def _handle_forwarded(self, msg): + self.xmpp.event('forwarded_stanza', msg) diff --git a/sleekxmpp/plugins/xep_0297/stanza.py b/sleekxmpp/plugins/xep_0297/stanza.py new file mode 100644 index 00000000..1cf02f74 --- /dev/null +++ b/sleekxmpp/plugins/xep_0297/stanza.py @@ -0,0 +1,34 @@ +""" + SleekXMPP: The Sleek XMPP Library + Copyright (C) 2012 Nathanael C. Fritz, Lance J.T. Stout + This file is part of SleekXMPP. + + See the file LICENSE for copying permission. +""" + +from sleekxmpp.xmlstream import ElementBase + + +class Forwarded(ElementBase): + name = 'forwarded' + namespace = 'urn:xmpp:forward:0' + plugin_attrib = 'forwarded' + interfaces = set(['stanza']) + + def get_stanza(self): + if self.xml.find('{jabber:client}message') is not None: + return self['message'] + elif self.xml.find('{jabber:client}presence') is not None: + return self['presence'] + elif self.xml.find('{jabber:client}iq') is not None: + return self['iq'] + return '' + + def set_stanza(self, value): + self.del_stanza() + self.append(value) + + def del_stanza(self): + del self['message'] + del self['presence'] + del self['iq'] -- cgit v1.2.3