Mercurial > libervia-backend
comparison src/plugins/plugin_misc_welcome.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 | 2daf7b4c6756 |
| children | 33c8c4973743 |
comparison
equal
deleted
inserted
replaced
| 2143:c3cac21157d4 | 2144:1d3f73e065e1 |
|---|---|
| 68 def __init__(self, host): | 68 def __init__(self, host): |
| 69 log.info(_("plugin Welcome initialization")) | 69 log.info(_("plugin Welcome initialization")) |
| 70 self.host = host | 70 self.host = host |
| 71 host.memory.updateParams(PARAMS) | 71 host.memory.updateParams(PARAMS) |
| 72 | 72 |
| 73 def profileConnected(self, profile): | 73 def profileConnected(self, client): |
| 74 # XXX: if you wan to try first_start again, you'll have to remove manually | 74 # XXX: if you wan to try first_start again, you'll have to remove manually |
| 75 # the welcome value from your profile params in sat.db | 75 # the welcome value from your profile params in sat.db |
| 76 welcome = self.host.memory.params.getParamA(WELCOME_PARAM_NAME, WELCOME_PARAM_CATEGORY, use_default=False, profile_key=profile) | 76 welcome = self.host.memory.params.getParamA(WELCOME_PARAM_NAME, WELCOME_PARAM_CATEGORY, use_default=False, profile_key=client.profile) |
| 77 if welcome is None: | 77 if welcome is None: |
| 78 first_start = True | 78 first_start = True |
| 79 welcome = True | 79 welcome = True |
| 80 else: | 80 else: |
| 81 first_start = False | 81 first_start = False |
| 82 | 82 |
| 83 if welcome: | 83 if welcome: |
| 84 xmlui = xml_tools.note(WELCOME_MSG, WELCOME_MSG_TITLE) | 84 xmlui = xml_tools.note(WELCOME_MSG, WELCOME_MSG_TITLE) |
| 85 self.host.actionNew({'xmlui': xmlui.toXml()}, profile=profile) | 85 self.host.actionNew({'xmlui': xmlui.toXml()}, profile=client.profile) |
| 86 self.host.memory.setParam(WELCOME_PARAM_NAME, C.BOOL_FALSE, WELCOME_PARAM_CATEGORY, profile_key=profile) | 86 self.host.memory.setParam(WELCOME_PARAM_NAME, C.BOOL_FALSE, WELCOME_PARAM_CATEGORY, profile_key=client.profile) |
| 87 | 87 |
| 88 self.host.trigger.point("WELCOME", first_start, welcome, profile) | 88 self.host.trigger.point("WELCOME", first_start, welcome, client.profile) |
| 89 | 89 |
| 90 | 90 |
| 91 | 91 |
| 92 | 92 |
| 93 | 93 |