# HG changeset patch # User souliane # Date 1419505745 -3600 # Node ID d84905c3e124270ef02fd9124a19b3cbc93fd5f2 # Parent 347aee3a3f5c14f7bb0ce13ed3a06501bc2b7b41 plugin XEP-0334: first draft diff -r 347aee3a3f5c -r d84905c3e124 src/plugins/plugin_xep_0334.py --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/plugins/plugin_xep_0334.py Thu Dec 25 12:09:05 2014 +0100 @@ -0,0 +1,111 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- + +# SAT plugin for Delayed Delivery (XEP-0334) +# Copyright (C) 2009, 2010, 2011, 2012, 2013, 2014 Jérôme Poisson (goffi@goffi.org) +# Copyright (C) 2013, 2014 Adrien Cossa (souliane@mailoo.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 . + +from sat.core.i18n import _ +from sat.core.log import getLogger +log = getLogger(__name__) + +from sat.core import exceptions + +from wokkel import disco, iwokkel +try: + from twisted.words.protocols.xmlstream import XMPPHandler +except ImportError: + from wokkel.subprotocols import XMPPHandler +from twisted.python import failure +from zope.interface import implements + + +NS_MPH = 'urn:xmpp:hints' + +PLUGIN_INFO = { + "name": "Message Processing Hints", + "import_name": "XEP-0334", + "type": "XEP", + "protocols": ["XEP-0334"], + "main": "XEP_0334", + "handler": "yes", + "description": _("""Implementation of Message Processing Hints""") +} + + +class XEP_0334(object): + + def __init__(self, host): + log.info(_("Message Processing Hints plugin initialization")) + self.host = host + host.trigger.add("sendMessage", self.sendMessageTrigger) + host.trigger.add("MessageReceived", self.messageReceivedTrigger) + + def getHandler(self, profile): + return XEP_0334_handler(self, profile) + + def sendMessageTrigger(self, mess_data, pre_xml_treatments, post_xml_treatments, profile): + """Add the hints element to the message to be sent""" + hints = [] + for key in ('no-permanent-storage', 'no-storage', 'no-copy'): + if mess_data['extra'].get(key, None): + hints.append(key) + + def treatment(mess_data): + message = mess_data['xml'] + for key in hints: + message.addElement((NS_MPH, key)) + if key in ('no-permanent-storage', 'no-storage'): + mess_data['extra']['no_storage'] = True + # TODO: the core doesn't process this 'no_storage' info yet + # it will be added after the frontends refactorization + return mess_data + + if hints: + post_xml_treatments.addCallback(treatment) + return True + + def messageReceivedTrigger(self, message, post_treat, profile): + """Check for hints in the received message""" + hints = [] + for key in ('no-permanent-storage', 'no-storage'): + try: + message.elements(uri=NS_MPH, name=key).next() + hints.append(key) + except StopIteration: + pass + + def post_treat_hints(data): + raise failure.Failure(exceptions.SkipHistory()) + + if hints: + post_treat.addCallback(post_treat_hints) + return True + + +class XEP_0334_handler(XMPPHandler): + implements(iwokkel.IDisco) + + def __init__(self, plugin_parent, profile): + self.plugin_parent = plugin_parent + self.host = plugin_parent.host + self.profile = profile + + def getDiscoInfo(self, requestor, target, nodeIdentifier=''): + return [disco.DiscoFeature(NS_MPH)] + + def getDiscoItems(self, requestor, target, nodeIdentifier=''): + return [] diff -r 347aee3a3f5c -r d84905c3e124 src/test/test_plugin_xep_0334.py --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/test/test_plugin_xep_0334.py Thu Dec 25 12:09:05 2014 +0100 @@ -0,0 +1,102 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- + +# SAT: a jabber client +# Copyright (C) 2009, 2010, 2011, 2012, 2013, 2014 Jérôme Poisson (goffi@goffi.org) +# Copyright (C) 2013, 2014 Adrien Cossa (souliane@mailoo.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 . + +""" Plugin XEP-0334 """ + +from constants import Const as C +from sat.test import helpers +from sat.plugins.plugin_xep_0334 import XEP_0334 +from twisted.internet import defer +from wokkel.generic import parseXml +from sat.core import exceptions + +HINTS = ('no-permanent-storage', 'no-storage', 'no-copy') + + +class XEP_0334Test(helpers.SatTestCase): + + def setUp(self): + self.host = helpers.FakeSAT() + self.plugin = XEP_0334(self.host) + + def test_sendMessageTrigger(self): + template_xml = """ + + text + %s + + """ + original_xml = template_xml % '' + + d_list = [] + + def cb(data, expected_xml): + result_xml = data['xml'].toXml().encode("utf-8") + self.assertEqualXML(result_xml, expected_xml, True) + + for key in (HINTS + ('', 'dummy_hint')): + mess_data = {'xml': parseXml(original_xml.encode("utf-8")), + 'extra': {key: True} + } + treatments = defer.Deferred() + self.plugin.sendMessageTrigger(mess_data, defer.Deferred(), treatments, C.PROFILE[0]) + if treatments.callbacks: # the trigger added a callback + expected_xml = template_xml % ('<%s xmlns="urn:xmpp:hints"/>' % key) + treatments.addCallback(cb, expected_xml) + treatments.callback(mess_data) + d_list.append(treatments) + + return defer.DeferredList(d_list) + + def test_messageReceivedTrigger(self): + template_xml = """ + + text + %s + + """ + + def cb(dummy): + raise Exception("Errback should not be ran instead of callback!") + + def eb(failure): + failure.trap(exceptions.SkipHistory) + + d_list = [] + + for key in (HINTS + ('dummy_hint',)): + message = parseXml(template_xml % ('<%s xmlns="urn:xmpp:hints"/>' % key)) + post_treat = defer.Deferred() + self.plugin.messageReceivedTrigger(message, post_treat, C.PROFILE[0]) + if post_treat.callbacks: + assert(key in ('no-permanent-storage', 'no-storage')) + post_treat.addCallbacks(cb, eb) + post_treat.callback(None) + d_list.append(post_treat) + else: + assert(key not in ('no-permanent-storage', 'no-storage')) + + return defer.DeferredList(d_list)