Mercurial > libervia-backend
comparison src/plugins/plugin_xep_0297.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 | 410e7a940a8b |
| children | 33c8c4973743 |
comparison
equal
deleted
inserted
replaced
| 2143:c3cac21157d4 | 2144:1d3f73e065e1 |
|---|---|
| 50 | 50 |
| 51 def __init__(self, host): | 51 def __init__(self, host): |
| 52 log.info(_("Stanza Forwarding plugin initialization")) | 52 log.info(_("Stanza Forwarding plugin initialization")) |
| 53 self.host = host | 53 self.host = host |
| 54 | 54 |
| 55 def getHandler(self, profile): | 55 def getHandler(self, client): |
| 56 return XEP_0297_handler(self, profile) | 56 return XEP_0297_handler(self, client.profile) |
| 57 | 57 |
| 58 @classmethod | 58 @classmethod |
| 59 def updateUri(cls, element, uri): | 59 def updateUri(cls, element, uri): |
| 60 """Update recursively the element URI. | 60 """Update recursively the element URI. |
| 61 | 61 |
| 78 @param stamp (datetime): offset-aware timestamp of the original reception. | 78 @param stamp (datetime): offset-aware timestamp of the original reception. |
| 79 @param body (unicode): optional description. | 79 @param body (unicode): optional description. |
| 80 @param profile_key (unicode): %(doc_profile_key)s | 80 @param profile_key (unicode): %(doc_profile_key)s |
| 81 @return: a Deferred when the message has been sent | 81 @return: a Deferred when the message has been sent |
| 82 """ | 82 """ |
| 83 # FIXME: this method is not used and doesn't use mess_data which should be used for client.sendMessage | 83 # FIXME: this method is not used and doesn't use mess_data which should be used for client.sendMessageData |
| 84 # should it be deprecated? A method constructing the element without sending it seems more natural | 84 # should it be deprecated? A method constructing the element without sending it seems more natural |
| 85 log.warning(u"THIS METHOD IS DEPRECATED") # FIXME: we use this warning until we check the method | 85 log.warning(u"THIS METHOD IS DEPRECATED") # FIXME: we use this warning until we check the method |
| 86 msg = domish.Element((None, 'message')) | 86 msg = domish.Element((None, 'message')) |
| 87 msg['to'] = to_jid.full() | 87 msg['to'] = to_jid.full() |
| 88 msg['type'] = stanza['type'] | 88 msg['type'] = stanza['type'] |
| 100 | 100 |
| 101 msg.addChild(body_elt) | 101 msg.addChild(body_elt) |
| 102 msg.addChild(forwarded_elt) | 102 msg.addChild(forwarded_elt) |
| 103 | 103 |
| 104 client = self.host.getClient(profile_key) | 104 client = self.host.getClient(profile_key) |
| 105 return client.sendMessage({u'xml': msg}) | 105 return client.sendMessageData({u'xml': msg}) |
| 106 | 106 |
| 107 | 107 |
| 108 class XEP_0297_handler(XMPPHandler): | 108 class XEP_0297_handler(XMPPHandler): |
| 109 implements(iwokkel.IDisco) | 109 implements(iwokkel.IDisco) |
| 110 | 110 |