Mercurial > libervia-backend
comparison src/plugins/plugin_xep_0334.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 | c0577837680a |
children | 33c8c4973743 |
comparison
equal
deleted
inserted
replaced
2143:c3cac21157d4 | 2144:1d3f73e065e1 |
---|---|
60 HINTS = (HINT_NO_PERMANENT_STORE, HINT_NO_STORE, HINT_NO_COPY, HINT_STORE) | 60 HINTS = (HINT_NO_PERMANENT_STORE, HINT_NO_STORE, HINT_NO_COPY, HINT_STORE) |
61 | 61 |
62 def __init__(self, host): | 62 def __init__(self, host): |
63 log.info(_("Message Processing Hints plugin initialization")) | 63 log.info(_("Message Processing Hints plugin initialization")) |
64 self.host = host | 64 self.host = host |
65 host.trigger.add("messageSend", self.messageSendTrigger) | 65 host.trigger.add("sendMessage", self.sendMessageTrigger) |
66 host.trigger.add("MessageReceived", self.messageReceivedTrigger, priority=-1000) | 66 host.trigger.add("MessageReceived", self.messageReceivedTrigger, priority=-1000) |
67 | 67 |
68 def getHandler(self, profile): | 68 def getHandler(self, client): |
69 return XEP_0334_handler() | 69 return XEP_0334_handler() |
70 | 70 |
71 def addHint(self, mess_data, hint): | 71 def addHint(self, mess_data, hint): |
72 if hint == self.HINT_NO_COPY and not mess_data['to'].resource: | 72 if hint == self.HINT_NO_COPY and not mess_data['to'].resource: |
73 log.error(u"{hint} can only be used with full jids! Ignoring it.".format(hint=hint)) | 73 log.error(u"{hint} can only be used with full jids! Ignoring it.".format(hint=hint)) |
82 if 'hints' in mess_data: | 82 if 'hints' in mess_data: |
83 for hint in mess_data['hints']: | 83 for hint in mess_data['hints']: |
84 mess_data[u'xml'].addElement((NS_HINTS, hint)) | 84 mess_data[u'xml'].addElement((NS_HINTS, hint)) |
85 return mess_data | 85 return mess_data |
86 | 86 |
87 def messageSendTrigger(self, client, mess_data, pre_xml_treatments, post_xml_treatments): | 87 def sendMessageTrigger(self, client, mess_data, pre_xml_treatments, post_xml_treatments): |
88 """Add the hints element to the message to be sent""" | 88 """Add the hints element to the message to be sent""" |
89 if u'hints' in mess_data[u'extra']: | 89 if u'hints' in mess_data[u'extra']: |
90 for hint in data_format.dict2iter(u'hints', mess_data[u'extra'], pop=True): | 90 for hint in data_format.dict2iter(u'hints', mess_data[u'extra'], pop=True): |
91 self.addHint(hint) | 91 self.addHint(hint) |
92 | 92 |