Mercurial > libervia-backend
annotate sat/plugins/plugin_misc_android.py @ 2807:0b7ce5daee9b
plugin XEP-0277: blog items data are now entirely serialised before going to bridge:
So far, and for historical reasons, blog items data where serialised using a unicode: unicode dict, which was causing trouble for many types of values (timestamps, booleans, lists).
This patch changes it by serialising the whole items before going to bridge, and deserialising it when going back. This way, complex data can be used easily in items.
This impact psEvent and serItemsData* methods which are renamed transItemsData* because there are not always serialising anymore (a new argument "serialise" allows to specify it).
When editing a blog post in jp, metadata are now more easy to manipulate, specially lists like tags.
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Sat, 23 Feb 2019 18:59:00 +0100 |
| parents | 003b8b4b56a7 |
| children | 90115cf4e731 |
| rev | line source |
|---|---|
| 2100 | 1 #!/usr/bin/env python2 |
| 2 # -*- coding: utf-8 -*- | |
| 3 | |
| 4 # SAT plugin for file tansfer | |
| 2771 | 5 # Copyright (C) 2009-2019 Jérôme Poisson (goffi@goffi.org) |
| 2100 | 6 |
| 7 # This program is free software: you can redistribute it and/or modify | |
| 8 # it under the terms of the GNU Affero General Public License as published by | |
| 9 # the Free Software Foundation, either version 3 of the License, or | |
| 10 # (at your option) any later version. | |
| 11 | |
| 12 # This program is distributed in the hope that it will be useful, | |
| 13 # but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 15 # GNU Affero General Public License for more details. | |
| 16 | |
| 17 # You should have received a copy of the GNU Affero General Public License | |
| 18 # along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 19 | |
| 20 from sat.core.i18n import _, D_ | |
| 21 from sat.core.constants import Const as C | |
| 22 from sat.core.log import getLogger | |
|
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
23 |
| 2100 | 24 log = getLogger(__name__) |
| 25 from sat.core import exceptions | |
| 26 import sys | |
| 27 import mmap | |
| 28 | |
| 29 | |
| 30 PLUGIN_INFO = { | |
|
2145
33c8c4973743
core (plugins): added missing contants + use of new constants in PLUGIN_INFO
Goffi <goffi@goffi.org>
parents:
2100
diff
changeset
|
31 C.PI_NAME: "Android ", |
|
33c8c4973743
core (plugins): added missing contants + use of new constants in PLUGIN_INFO
Goffi <goffi@goffi.org>
parents:
2100
diff
changeset
|
32 C.PI_IMPORT_NAME: "android", |
|
33c8c4973743
core (plugins): added missing contants + use of new constants in PLUGIN_INFO
Goffi <goffi@goffi.org>
parents:
2100
diff
changeset
|
33 C.PI_TYPE: C.PLUG_TYPE_MISC, |
|
33c8c4973743
core (plugins): added missing contants + use of new constants in PLUGIN_INFO
Goffi <goffi@goffi.org>
parents:
2100
diff
changeset
|
34 C.PI_MAIN: "AndroidPlugin", |
|
33c8c4973743
core (plugins): added missing contants + use of new constants in PLUGIN_INFO
Goffi <goffi@goffi.org>
parents:
2100
diff
changeset
|
35 C.PI_HANDLER: "no", |
|
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
36 C.PI_DESCRIPTION: D_( |
|
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
37 """Manage Android platform specificities, like pause or notifications""" |
|
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
38 ), |
| 2100 | 39 } |
| 40 | |
| 41 if sys.platform != "android": | |
| 42 raise exceptions.CancelError(u"this module is not needed on this platform") | |
| 43 | |
| 44 from plyer import notification, vibrator | |
| 45 | |
| 46 PARAM_VIBRATE_CATEGORY = "Notifications" | |
| 47 PARAM_VIBRATE_NAME = "vibrate" | |
| 48 PARAM_VIBRATE_LABEL = D_(u"Vibrate on notifications") | |
| 49 | |
|
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
50 |
| 2100 | 51 class AndroidPlugin(object): |
| 52 | |
| 53 params = """ | |
| 54 <params> | |
| 55 <individual> | |
| 56 <category name="{category_name}" label="{category_label}"> | |
| 57 <param name="{param_name}" label="{param_label}" value="true" type="bool" security="0" /> | |
| 58 </category> | |
| 59 </individual> | |
| 60 </params> | |
| 61 """.format( | |
|
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
62 category_name=PARAM_VIBRATE_CATEGORY, |
|
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
63 category_label=D_(PARAM_VIBRATE_CATEGORY), |
|
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
64 param_name=PARAM_VIBRATE_NAME, |
|
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
65 param_label=PARAM_VIBRATE_LABEL, |
|
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
66 ) |
| 2100 | 67 |
| 68 def __init__(self, host): | |
| 69 log.info(_("plugin Android initialization")) | |
| 70 self.host = host | |
| 71 host.memory.updateParams(self.params) | |
|
2756
1048d8dc8a9d
plugin android: fixed path for .cagou_status
Goffi <goffi@goffi.org>
parents:
2624
diff
changeset
|
72 self.cagou_status_fd = open("app/.cagou_status", "rb") |
|
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
73 self.cagou_status = mmap.mmap( |
|
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
74 self.cagou_status_fd.fileno(), 1, prot=mmap.PROT_READ |
|
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
75 ) |
| 2100 | 76 # we set a low priority because we want the notification to be sent after all plugins have done their job |
| 77 host.trigger.add("MessageReceived", self.messageReceivedTrigger, priority=-1000) | |
| 78 | |
| 79 @property | |
| 80 def cagou_active(self): | |
|
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
81 # 'R' status means Cagou is running in front |
|
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
82 return self.cagou_status[0] == "R" |
| 2100 | 83 |
| 84 def _notifyMessage(self, mess_data, client): | |
| 85 # send notification if there is a message and it is not a groupchat | |
|
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
86 if mess_data["message"] and mess_data["type"] != C.MESS_TYPE_GROUPCHAT: |
|
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
87 message = mess_data["message"].itervalues().next() |
| 2100 | 88 try: |
|
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
89 subject = mess_data["subject"].itervalues().next() |
| 2100 | 90 except StopIteration: |
|
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
91 subject = u"Cagou new message" |
| 2100 | 92 |
|
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
93 notification.notify(title=subject, message=message) |
|
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
94 if self.host.memory.getParamA( |
|
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
95 PARAM_VIBRATE_NAME, PARAM_VIBRATE_CATEGORY, profile_key=client.profile |
|
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
96 ): |
| 2100 | 97 vibrator.vibrate() |
| 98 return mess_data | |
| 99 | |
| 100 def messageReceivedTrigger(self, client, message_elt, post_treat): | |
| 101 if not self.cagou_active: | |
| 102 # we only send notification is the frontend is not displayed | |
| 103 post_treat.addCallback(self._notifyMessage, client) | |
| 104 | |
| 105 return True |