Mercurial > libervia-backend
annotate src/plugins/plugin_xep_0203.py @ 2532:772447ec070f
jp: pubsub options refactoring:
There is now only "use_pubsub", and specification are set using "pubsub_flags" argument when instantiating CommandBase.
Options are more Python Zen compliant by using explicit arguments for item, draft, url instead of trying to guess with magic keyword and type detection.
Pubsub node and item are now always using respecively "-n" and "-i" even when required, this way shell history can be used to change command more easily, and it's globally less confusing for user.
if --pubsub-url is used, elements can be overwritten with individual option (e.g. change item id with --item).
New "use_draft" argument in CommandBase, to re-use current draft or open a file path as draft.
Item can now be specified when using a draft. If it already exists, its content will be added to current draft (with a separator), to avoid loosing data.
common.BaseEdit.getItemPath could be simplified thanks to those changes.
Pubsub URI handling has been moved to base.py.
author | Goffi <goffi@goffi.org> |
---|---|
date | Wed, 21 Mar 2018 19:13:22 +0100 |
parents | 0046283a285d |
children |
rev | line source |
---|---|
1934
2daf7b4c6756
use of /usr/bin/env instead of /usr/bin/python in shebang
Goffi <goffi@goffi.org>
parents:
1766
diff
changeset
|
1 #!/usr/bin/env python2 |
1273 | 2 # -*- coding: utf-8 -*- |
3 | |
4 # SAT plugin for Delayed Delivery (XEP-0203) | |
2483 | 5 # Copyright (C) 2009-2018 Jérôme Poisson (goffi@goffi.org) |
1766 | 6 # Copyright (C) 2013-2016 Adrien Cossa (souliane@mailoo.org) |
1273 | 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 _ | |
2145
33c8c4973743
core (plugins): added missing contants + use of new constants in PLUGIN_INFO
Goffi <goffi@goffi.org>
parents:
2144
diff
changeset
|
22 from sat.core.constants import Const as C |
1273 | 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 = { | |
2145
33c8c4973743
core (plugins): added missing contants + use of new constants in PLUGIN_INFO
Goffi <goffi@goffi.org>
parents:
2144
diff
changeset
|
37 C.PI_NAME: "Delayed Delivery", |
33c8c4973743
core (plugins): added missing contants + use of new constants in PLUGIN_INFO
Goffi <goffi@goffi.org>
parents:
2144
diff
changeset
|
38 C.PI_IMPORT_NAME: "XEP-0203", |
33c8c4973743
core (plugins): added missing contants + use of new constants in PLUGIN_INFO
Goffi <goffi@goffi.org>
parents:
2144
diff
changeset
|
39 C.PI_TYPE: "XEP", |
33c8c4973743
core (plugins): added missing contants + use of new constants in PLUGIN_INFO
Goffi <goffi@goffi.org>
parents:
2144
diff
changeset
|
40 C.PI_PROTOCOLS: ["XEP-0203"], |
33c8c4973743
core (plugins): added missing contants + use of new constants in PLUGIN_INFO
Goffi <goffi@goffi.org>
parents:
2144
diff
changeset
|
41 C.PI_MAIN: "XEP_0203", |
33c8c4973743
core (plugins): added missing contants + use of new constants in PLUGIN_INFO
Goffi <goffi@goffi.org>
parents:
2144
diff
changeset
|
42 C.PI_HANDLER: "yes", |
33c8c4973743
core (plugins): added missing contants + use of new constants in PLUGIN_INFO
Goffi <goffi@goffi.org>
parents:
2144
diff
changeset
|
43 C.PI_DESCRIPTION: _("""Implementation of Delayed Delivery""") |
1273 | 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 | |
2144
1d3f73e065e1
core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents:
1955
diff
changeset
|
53 def getHandler(self, client): |
1d3f73e065e1
core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents:
1955
diff
changeset
|
54 return XEP_0203_handler(self, client.profile) |
1273 | 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 [] |