Mercurial > libervia-backend
comparison src/plugins/plugin_xep_0280.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 | 7de291c3cd0c |
| children | 33c8c4973743 |
comparison
equal
deleted
inserted
replaced
| 2143:c3cac21157d4 | 2144:1d3f73e065e1 |
|---|---|
| 74 log.info(_("Plugin XEP_0280 initialization")) | 74 log.info(_("Plugin XEP_0280 initialization")) |
| 75 self.host = host | 75 self.host = host |
| 76 host.memory.updateParams(self.params) | 76 host.memory.updateParams(self.params) |
| 77 host.trigger.add("MessageReceived", self.messageReceivedTrigger, priority=1000) | 77 host.trigger.add("MessageReceived", self.messageReceivedTrigger, priority=1000) |
| 78 | 78 |
| 79 def getHandler(self, profile): | 79 def getHandler(self, client): |
| 80 return XEP_0280_handler() | 80 return XEP_0280_handler() |
| 81 | 81 |
| 82 def setPrivate(self, message_elt): | 82 def setPrivate(self, message_elt): |
| 83 """Add a <private/> element to a message | 83 """Add a <private/> element to a message |
| 84 | 84 |
| 90 log.error(u"addPrivateElt must be used with <message> stanzas") | 90 log.error(u"addPrivateElt must be used with <message> stanzas") |
| 91 return | 91 return |
| 92 message_elt.addElement((NS_CARBONS, u'private')) | 92 message_elt.addElement((NS_CARBONS, u'private')) |
| 93 | 93 |
| 94 @defer.inlineCallbacks | 94 @defer.inlineCallbacks |
| 95 def profileConnected(self, profile): | 95 def profileConnected(self, client): |
| 96 """activate message carbons on connection if possible and activated in config""" | 96 """activate message carbons on connection if possible and activated in config""" |
| 97 client = self.host.getClient(profile) | 97 activate = self.host.memory.getParamA(PARAM_NAME, PARAM_CATEGORY, profile_key=client.profile) |
| 98 activate = self.host.memory.getParamA(PARAM_NAME, PARAM_CATEGORY, profile_key=profile) | |
| 99 if not activate: | 98 if not activate: |
| 100 log.info(_(u"Not activating message carbons as requested in params")) | 99 log.info(_(u"Not activating message carbons as requested in params")) |
| 101 return | 100 return |
| 102 try: | 101 try: |
| 103 yield self.host.checkFeatures((NS_CARBONS,), profile=profile) | 102 yield self.host.checkFeatures((NS_CARBONS,), profile=client.profile) |
| 104 except exceptions.FeatureNotFound: | 103 except exceptions.FeatureNotFound: |
| 105 log.warning(_(u"server doesn't handle message carbons")) | 104 log.warning(_(u"server doesn't handle message carbons")) |
| 106 else: | 105 else: |
| 107 log.info(_(u"message carbons available, enabling it")) | 106 log.info(_(u"message carbons available, enabling it")) |
| 108 iq_elt = client.IQ() | 107 iq_elt = client.IQ() |
| 147 # and send it to frontends (without normal sending treatments) | 146 # and send it to frontends (without normal sending treatments) |
| 148 mess_data = SatMessageProtocol.parseMessage(cc_message_elt, client) | 147 mess_data = SatMessageProtocol.parseMessage(cc_message_elt, client) |
| 149 if not mess_data['message'] and not mess_data['subject']: | 148 if not mess_data['message'] and not mess_data['subject']: |
| 150 return False | 149 return False |
| 151 self.host.messageAddToHistory(mess_data, client) | 150 self.host.messageAddToHistory(mess_data, client) |
| 152 self.host.messageSendToBridge(mess_data, client) | 151 self.host.sendMessageToBridge(mess_data, client) |
| 153 else: | 152 else: |
| 154 log.warning(u"invalid message carbons received:\n{xml}".format( | 153 log.warning(u"invalid message carbons received:\n{xml}".format( |
| 155 xml = message_elt.toXml())) | 154 xml = message_elt.toXml())) |
| 156 return False | 155 return False |
| 157 | 156 |