Mercurial > libervia-backend
comparison src/plugins/plugin_misc_maildir.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 | 633b5c21aefd |
| children | 33c8c4973743 |
comparison
equal
deleted
inserted
replaced
| 2143:c3cac21157d4 | 2144:1d3f73e065e1 |
|---|---|
| 43 } | 43 } |
| 44 | 44 |
| 45 MAILDIR_PATH = "Maildir" | 45 MAILDIR_PATH = "Maildir" |
| 46 CATEGORY = D_("Mail Server") | 46 CATEGORY = D_("Mail Server") |
| 47 NAME = D_('Block "normal" messages propagation') | 47 NAME = D_('Block "normal" messages propagation') |
| 48 # FIXME: (very) old and (very) experimental code, need a big cleaning/review | 48 # FIXME: (very) old and (very) experimental code, need a big cleaning/review or to be deprecated |
| 49 | 49 |
| 50 | 50 |
| 51 class MaildirError(Exception): | 51 class MaildirError(Exception): |
| 52 pass | 52 pass |
| 53 | 53 |
| 80 self.__mailboxes = {} # key: profile, value: {boxname: MailboxUser instance} | 80 self.__mailboxes = {} # key: profile, value: {boxname: MailboxUser instance} |
| 81 | 81 |
| 82 #the triggers | 82 #the triggers |
| 83 host.trigger.add("MessageReceived", self.messageReceivedTrigger) | 83 host.trigger.add("MessageReceived", self.messageReceivedTrigger) |
| 84 | 84 |
| 85 def profileConnected(self, profile): | 85 def profileConnected(self, client): |
| 86 """Called on profile connection, create profile data""" | 86 """Called on client connection, create profile data""" |
| 87 profile = client.profile | |
| 87 self.data[profile] = PersistentBinaryDict("plugin_maildir", profile) | 88 self.data[profile] = PersistentBinaryDict("plugin_maildir", profile) |
| 88 self.__mailboxes[profile] = {} | 89 self.__mailboxes[profile] = {} |
| 89 | 90 |
| 90 def dataLoaded(ignore): | 91 def dataLoaded(ignore): |
| 91 if not self.data[profile]: | 92 if not self.data[profile]: |
| 92 #the mailbox is new, we initiate the data | 93 #the mailbox is new, we initiate the data |
| 93 self.data[profile]["INBOX"] = {"cur_idx": 0} | 94 self.data[profile]["INBOX"] = {"cur_idx": 0} |
| 94 self.data[profile].load().addCallback(dataLoaded) | 95 self.data[profile].load().addCallback(dataLoaded) |
| 95 | 96 |
| 96 def profileDisconnected(self, profile): | 97 def profileDisconnected(self, client): |
| 97 """Called on profile disconnection, free profile's resources""" | 98 """Called on profile disconnection, free profile's resources""" |
| 99 profile = client.profile | |
| 98 del self.__mailboxes[profile] | 100 del self.__mailboxes[profile] |
| 99 del self.data[profile] | 101 del self.data[profile] |
| 100 | 102 |
| 101 def messageReceivedTrigger(self, client, message, post_treat): | 103 def messageReceivedTrigger(self, client, message, post_treat): |
| 102 """This trigger catch normal message and put the in the Maildir box. | 104 """This trigger catch normal message and put the in the Maildir box. |