Mercurial > libervia-backend
view src/plugins/plugin_misc_android.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 | fbeeba721954 |
children | 33c8c4973743 |
line wrap: on
line source
#!/usr/bin/env python2 # -*- coding: utf-8 -*- # SAT plugin for file tansfer # Copyright (C) 2009-2016 Jérôme Poisson (goffi@goffi.org) # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU Affero General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU Affero General Public License for more details. # You should have received a copy of the GNU Affero General Public License # along with this program. If not, see <http://www.gnu.org/licenses/>. from sat.core.i18n import _, D_ from sat.core.constants import Const as C from sat.core.log import getLogger log = getLogger(__name__) from sat.core import exceptions import sys import mmap PLUGIN_INFO = { "name": "Android ", "import_name": "android", "type": C.PLUG_TYPE_MISC, "main": "AndroidPlugin", "handler": "no", "description": D_("""Manage Android platform specificities, like pause or notifications""") } if sys.platform != "android": raise exceptions.CancelError(u"this module is not needed on this platform") from plyer import notification, vibrator PARAM_VIBRATE_CATEGORY = "Notifications" PARAM_VIBRATE_NAME = "vibrate" PARAM_VIBRATE_LABEL = D_(u"Vibrate on notifications") class AndroidPlugin(object): params = """ <params> <individual> <category name="{category_name}" label="{category_label}"> <param name="{param_name}" label="{param_label}" value="true" type="bool" security="0" /> </category> </individual> </params> """.format( category_name = PARAM_VIBRATE_CATEGORY, category_label = D_(PARAM_VIBRATE_CATEGORY), param_name = PARAM_VIBRATE_NAME, param_label = PARAM_VIBRATE_LABEL, ) def __init__(self, host): log.info(_("plugin Android initialization")) self.host = host host.memory.updateParams(self.params) self.cagou_status_fd = open('.cagou_status', 'rb') self.cagou_status = mmap.mmap(self.cagou_status_fd.fileno(), 1, prot=mmap.PROT_READ) # we set a low priority because we want the notification to be sent after all plugins have done their job host.trigger.add("MessageReceived", self.messageReceivedTrigger, priority=-1000) @property def cagou_active(self): # 'R' status means Cagou is running in front return self.cagou_status[0] == 'R' def _notifyMessage(self, mess_data, client): # send notification if there is a message and it is not a groupchat if mess_data['message'] and mess_data['type'] != C.MESS_TYPE_GROUPCHAT: message = mess_data['message'].itervalues().next() try: subject = mess_data['subject'].itervalues().next() except StopIteration: subject = u'Cagou new message' notification.notify( title = subject, message = message ) if self.host.memory.getParamA(PARAM_VIBRATE_NAME, PARAM_VIBRATE_CATEGORY, profile_key=client.profile): vibrator.vibrate() return mess_data def messageReceivedTrigger(self, client, message_elt, post_treat): if not self.cagou_active: # we only send notification is the frontend is not displayed post_treat.addCallback(self._notifyMessage, client) return True