Mercurial > libervia-backend
comparison src/plugins/plugin_misc_text_commands.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 | aa94f33fd2ad |
| children | 33c8c4973743 |
comparison
equal
deleted
inserted
replaced
| 2143:c3cac21157d4 | 2144:1d3f73e065e1 |
|---|---|
| 58 | 58 |
| 59 def __init__(self, host): | 59 def __init__(self, host): |
| 60 log.info(_("Text commands initialization")) | 60 log.info(_("Text commands initialization")) |
| 61 self.host = host | 61 self.host = host |
| 62 # this is internal command, so we set high priority | 62 # this is internal command, so we set high priority |
| 63 host.trigger.add("messageSend", self.messageSendTrigger, priority=1000000) | 63 host.trigger.add("sendMessage", self.sendMessageTrigger, priority=1000000) |
| 64 self._commands = {} | 64 self._commands = {} |
| 65 self._whois = [] | 65 self._whois = [] |
| 66 self.registerTextCommands(self) | 66 self.registerTextCommands(self) |
| 67 | 67 |
| 68 def _parseDocString(self, cmd, cmd_name): | 68 def _parseDocString(self, cmd, cmd_name): |
| 166 @param priority: priority of the information to show (the highest priority will be displayed first) | 166 @param priority: priority of the information to show (the highest priority will be displayed first) |
| 167 """ | 167 """ |
| 168 self._whois.append((priority, callback)) | 168 self._whois.append((priority, callback)) |
| 169 self._whois.sort(key=lambda item: item[0], reverse=True) | 169 self._whois.sort(key=lambda item: item[0], reverse=True) |
| 170 | 170 |
| 171 def messageSendTrigger(self, client, mess_data, pre_xml_treatments, post_xml_treatments): | 171 def sendMessageTrigger(self, client, mess_data, pre_xml_treatments, post_xml_treatments): |
| 172 """Install SendMessage command hook """ | 172 """Install SendMessage command hook """ |
| 173 pre_xml_treatments.addCallback(self._messageSendCmdHook, client) | 173 pre_xml_treatments.addCallback(self._sendMessageCmdHook, client) |
| 174 return True | 174 return True |
| 175 | 175 |
| 176 def _messageSendCmdHook(self, mess_data, client): | 176 def _sendMessageCmdHook(self, mess_data, client): |
| 177 """ Check text commands in message, and react consequently | 177 """ Check text commands in message, and react consequently |
| 178 | 178 |
| 179 msg starting with / are potential command. If a command is found, it is executed, else and help message is sent | 179 msg starting with / are potential command. If a command is found, it is executed, else and help message is sent |
| 180 msg starting with // are escaped: they are sent with a single / | 180 msg starting with // are escaped: they are sent with a single / |
| 181 commands can abord message sending (if they return anything evaluating to False), or continue it (if they return True), eventually after modifying the message | 181 commands can abord message sending (if they return anything evaluating to False), or continue it (if they return True), eventually after modifying the message |
| 182 an "unparsed" key is added to message, containing part of the message not yet parsed | 182 an "unparsed" key is added to message, containing part of the message not yet parsed |
| 183 commands can be deferred or not | 183 commands can be deferred or not |
| 184 @param mess_data(dict): data comming from messageSend trigger | 184 @param mess_data(dict): data comming from sendMessage trigger |
| 185 @param profile: %(doc_profile)s | 185 @param profile: %(doc_profile)s |
| 186 """ | 186 """ |
| 187 try: | 187 try: |
| 188 msg = mess_data["message"][''] | 188 msg = mess_data["message"][''] |
| 189 msg_lang = '' | 189 msg_lang = '' |
| 252 return d or mess_data # if a command is detected, we should have a deferred, else we send the message normally | 252 return d or mess_data # if a command is detected, we should have a deferred, else we send the message normally |
| 253 | 253 |
| 254 def _contextValid(self, mess_data, cmd_data): | 254 def _contextValid(self, mess_data, cmd_data): |
| 255 """Tell if a command can be used in the given context | 255 """Tell if a command can be used in the given context |
| 256 | 256 |
| 257 @param mess_data(dict): message data as given in messageSend trigger | 257 @param mess_data(dict): message data as given in sendMessage trigger |
| 258 @param cmd_data(dict): command data as returned by self._parseDocString | 258 @param cmd_data(dict): command data as returned by self._parseDocString |
| 259 @return (bool): True if command can be used in this context | 259 @return (bool): True if command can be used in this context |
| 260 """ | 260 """ |
| 261 if ((cmd_data['type'] == "group" and mess_data["type"] != "groupchat") or | 261 if ((cmd_data['type'] == "group" and mess_data["type"] != "groupchat") or |
| 262 (cmd_data['type'] == 'one2one' and mess_data["type"] == "groupchat")): | 262 (cmd_data['type'] == 'one2one' and mess_data["type"] == "groupchat")): |
| 288 mess_data["from"] = mess_data["to"] | 288 mess_data["from"] = mess_data["to"] |
| 289 mess_data["to"] = to_ | 289 mess_data["to"] = to_ |
| 290 mess_data["type"] = C.MESS_TYPE_INFO | 290 mess_data["type"] = C.MESS_TYPE_INFO |
| 291 mess_data["message"] = {'': message} | 291 mess_data["message"] = {'': message} |
| 292 mess_data["extra"]["info_type"] = info_type | 292 mess_data["extra"]["info_type"] = info_type |
| 293 self.host.messageSendToBridge(mess_data, client) | 293 self.host.sendMessageToBridge(mess_data, client) |
| 294 | 294 |
| 295 def cmd_whois(self, client, mess_data): | 295 def cmd_whois(self, client, mess_data): |
| 296 """show informations on entity | 296 """show informations on entity |
| 297 | 297 |
| 298 @command: [JID|ROOM_NICK] | 298 @command: [JID|ROOM_NICK] |