comparison sat/plugins/plugin_xep_0203.py @ 2562:26edcf3a30eb

core, setup: huge cleaning: - moved directories from src and frontends/src to sat and sat_frontends, which is the recommanded naming convention - move twisted directory to root - removed all hacks from setup.py, and added missing dependencies, it is now clean - use https URL for website in setup.py - removed "Environment :: X11 Applications :: GTK", as wix is deprecated and removed - renamed sat.sh to sat and fixed its installation - added python_requires to specify Python version needed - replaced glib2reactor which use deprecated code by gtk3reactor sat can now be installed directly from virtualenv without using --system-site-packages anymore \o/
author Goffi <goffi@goffi.org>
date Mon, 02 Apr 2018 19:44:50 +0200
parents src/plugins/plugin_xep_0203.py@0046283a285d
children 56f94936df1e
comparison
equal deleted inserted replaced
2561:bd30dc3ffe5a 2562:26edcf3a30eb
1 #!/usr/bin/env python2
2 # -*- coding: utf-8 -*-
3
4 # SAT plugin for Delayed Delivery (XEP-0203)
5 # Copyright (C) 2009-2018 Jérôme Poisson (goffi@goffi.org)
6 # Copyright (C) 2013-2016 Adrien Cossa (souliane@mailoo.org)
7
8 # This program is free software: you can redistribute it and/or modify
9 # it under the terms of the GNU Affero General Public License as published by
10 # the Free Software Foundation, either version 3 of the License, or
11 # (at your option) any later version.
12
13 # This program is distributed in the hope that it will be useful,
14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU Affero General Public License for more details.
17
18 # You should have received a copy of the GNU Affero General Public License
19 # along with this program. If not, see <http://www.gnu.org/licenses/>.
20
21 from sat.core.i18n import _
22 from sat.core.constants import Const as C
23 from sat.core.log import getLogger
24 log = getLogger(__name__)
25
26 from wokkel import disco, iwokkel, delay
27 try:
28 from twisted.words.protocols.xmlstream import XMPPHandler
29 except ImportError:
30 from wokkel.subprotocols import XMPPHandler
31 from zope.interface import implements
32
33
34 NS_DD = 'urn:xmpp:delay'
35
36 PLUGIN_INFO = {
37 C.PI_NAME: "Delayed Delivery",
38 C.PI_IMPORT_NAME: "XEP-0203",
39 C.PI_TYPE: "XEP",
40 C.PI_PROTOCOLS: ["XEP-0203"],
41 C.PI_MAIN: "XEP_0203",
42 C.PI_HANDLER: "yes",
43 C.PI_DESCRIPTION: _("""Implementation of Delayed Delivery""")
44 }
45
46
47 class XEP_0203(object):
48
49 def __init__(self, host):
50 log.info(_("Delayed Delivery plugin initialization"))
51 self.host = host
52
53 def getHandler(self, client):
54 return XEP_0203_handler(self, client.profile)
55
56 def delay(self, stamp, sender=None, desc='', parent=None):
57 """Build a delay element, eventually append it to the given parent element.
58
59 @param stamp (datetime): offset-aware timestamp of the original sending.
60 @param sender (JID): entity that originally sent or delayed the message.
61 @param desc (unicode): optional natural language description.
62 @param parent (domish.Element): add the delay element to this element.
63 @return: the delay element (domish.Element)
64 """
65 elt = delay.Delay(stamp, sender).toElement()
66 if desc:
67 elt.addContent(desc)
68 if parent:
69 parent.addChild(elt)
70 return elt
71
72
73 class XEP_0203_handler(XMPPHandler):
74 implements(iwokkel.IDisco)
75
76 def __init__(self, plugin_parent, profile):
77 self.plugin_parent = plugin_parent
78 self.host = plugin_parent.host
79 self.profile = profile
80
81 def getDiscoInfo(self, requestor, target, nodeIdentifier=''):
82 return [disco.DiscoFeature(NS_DD)]
83
84 def getDiscoItems(self, requestor, target, nodeIdentifier=''):
85 return []