Mercurial > libervia-backend
annotate src/plugins/plugin_xep_0203.py @ 2144:1d3f73e065e1
core, jp: component handling + client handling refactoring:
- SàT can now handle components
- plugin have now a "modes" key in PLUGIN_INFO where they declare if they can be used with clients and or components. They default to be client only.
- components are really similar to clients, but with some changes in behaviour:
* component has "entry point", which is a special plugin with a componentStart method, which is called just after component is connected
* trigger end with a different suffixes (e.g. profileConnected vs profileConnectedComponent), so a plugin which manage both clients and components can have different workflow
* for clients, only triggers of plugins handling client mode are launched
* for components, only triggers of plugins needed in dependencies are launched. They all must handle component mode.
* component have a sendHistory attribute (False by default) which can be set to True to allow saving sent messages into history
* for convenience, "client" is still used in method even if it can now be a component
* a new "component" boolean attribute tells if we have a component or a client
* components have to add themselve Message protocol
* roster and presence protocols are not added for components
* component default port is 5347 (which is Prosody's default port)
- asyncCreateProfile has been renamed for profileCreate, both to follow new naming convention and to prepare the transition to fully asynchronous bridge
- createProfile has a new "component" attribute. When used to create a component, it must be set to a component entry point
- jp: added --component argument to profile/create
- disconnect bridge method is now asynchronous, this way frontends can know when disconnection is finished
- new PI_* constants for PLUGIN_INFO values (not used everywhere yet)
- client/component connection workflow has been moved to their classes instead of being a host methods
- host.messageSend is now client.sendMessage, and former client.sendMessage is now client.sendMessageData.
- identities are now handled in client.identities list, so it can be updated dynamically by plugins (in the future, frontends should be able to update them too through bridge)
- profileConnecting* profileConnected* profileDisconnected* and getHandler now all use client instead of profile
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Sun, 12 Feb 2017 17:55:43 +0100 |
| parents | 633b5c21aefd |
| children | 33c8c4973743 |
| 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) | |
| 1766 | 5 # Copyright (C) 2009-2016 Jérôme Poisson (goffi@goffi.org) |
| 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 _ | |
| 22 from sat.core.log import getLogger | |
| 23 log = getLogger(__name__) | |
| 24 | |
| 25 from wokkel import disco, iwokkel, delay | |
| 26 try: | |
| 27 from twisted.words.protocols.xmlstream import XMPPHandler | |
| 28 except ImportError: | |
| 29 from wokkel.subprotocols import XMPPHandler | |
| 30 from zope.interface import implements | |
| 31 | |
| 32 | |
| 33 NS_DD = 'urn:xmpp:delay' | |
| 34 | |
| 35 PLUGIN_INFO = { | |
| 36 "name": "Delayed Delivery", | |
| 37 "import_name": "XEP-0203", | |
| 38 "type": "XEP", | |
| 39 "protocols": ["XEP-0203"], | |
| 40 "main": "XEP_0203", | |
| 41 "handler": "yes", | |
| 42 "description": _("""Implementation of Delayed Delivery""") | |
| 43 } | |
| 44 | |
| 45 | |
| 46 class XEP_0203(object): | |
| 47 | |
| 48 def __init__(self, host): | |
| 49 log.info(_("Delayed Delivery plugin initialization")) | |
| 50 self.host = host | |
| 51 | |
|
2144
1d3f73e065e1
core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents:
1955
diff
changeset
|
52 def getHandler(self, client): |
|
1d3f73e065e1
core, jp: component handling + client handling refactoring:
Goffi <goffi@goffi.org>
parents:
1955
diff
changeset
|
53 return XEP_0203_handler(self, client.profile) |
| 1273 | 54 |
| 55 def delay(self, stamp, sender=None, desc='', parent=None): | |
| 56 """Build a delay element, eventually append it to the given parent element. | |
| 57 | |
| 58 @param stamp (datetime): offset-aware timestamp of the original sending. | |
| 59 @param sender (JID): entity that originally sent or delayed the message. | |
| 60 @param desc (unicode): optional natural language description. | |
| 61 @param parent (domish.Element): add the delay element to this element. | |
| 62 @return: the delay element (domish.Element) | |
| 63 """ | |
| 64 elt = delay.Delay(stamp, sender).toElement() | |
| 65 if desc: | |
| 66 elt.addContent(desc) | |
| 67 if parent: | |
| 68 parent.addChild(elt) | |
| 69 return elt | |
| 70 | |
| 71 | |
| 72 class XEP_0203_handler(XMPPHandler): | |
| 73 implements(iwokkel.IDisco) | |
| 74 | |
| 75 def __init__(self, plugin_parent, profile): | |
| 76 self.plugin_parent = plugin_parent | |
| 77 self.host = plugin_parent.host | |
| 78 self.profile = profile | |
| 79 | |
| 80 def getDiscoInfo(self, requestor, target, nodeIdentifier=''): | |
| 81 return [disco.DiscoFeature(NS_DD)] | |
| 82 | |
| 83 def getDiscoItems(self, requestor, target, nodeIdentifier=''): | |
| 84 return [] |