Mercurial > libervia-backend

comparison sat/plugins/plugin_xep_0352.py @ 2871:9a019db21f3c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
plugin XEP-0352: implementation of Client State Indication
author Goffi <goffi@goffi.org>
date Mon, 25 Mar 2019 07:08:23 +0100
parents
children 0c54970d8e6e
comparison
equal deleted inserted replaced
2870:2f39682f6d40 2871:9a019db21f3c
1 #!/usr/bin/env python2
2 # -*- coding: utf-8 -*-
3
4 # SAT plugin for Explicit Message Encryption
5 # Copyright (C) 2009-2019 Jérôme Poisson (goffi@goffi.org)
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 twisted.words.xish import domish
21 from sat.core.i18n import _, D_
22 from sat.core.constants import Const as C
23 from sat.core.log import getLogger
24
25 log = getLogger(__name__)
26
27 PLUGIN_INFO = {
28 C.PI_NAME: u"Client State Indication",
29 C.PI_IMPORT_NAME: u"XEP-0352",
30 C.PI_TYPE: C.PLUG_TYPE_XEP,
31 C.PI_PROTOCOLS: [u"XEP-0352"],
32 C.PI_DEPENDENCIES: [],
33 C.PI_MAIN: u"XEP_0352",
34 C.PI_HANDLER: u"no",
35 C.PI_DESCRIPTION: D_(u"Notify server when frontend is not actively used, to limit "
36 u"traffic and save bandwidth and battery life"),
37 }
38
39 NS_CSI = u"urn:xmpp:csi:0"
40
41
42 class XEP_0352(object):
43
44 def __init__(self, host):
45 log.info(_(u"Client State Indication plugin initialization"))
46 self.host = host
47 host.registerNamespace(u"csi", NS_CSI)
48
49 def isActive(self, client):
50 if not client._xep_0352_enabled:
51 return True
52 return client._xep_0352_active
53
54 def profileConnected(self, client):
55 if (NS_CSI, u'csi') in client.xmlstream.features:
56 log.info(_(u"Client State Indication is available on this server"))
57 client._xep_0352_enabled = True
58 client._xep_0352_active = True
59 else:
60 log.warning(_(u"Client State Indication is not available on this server, some"
61 u" bandwidth optimisations can't be used."))
62 client._xep_0352_enabled = False
63
64 def setInactive(self, client):
65 if self.isActive(client):
66 inactive_elt = domish.Element((NS_CSI, u'inactive'))
67 client.send(inactive_elt)
68 client._xep_0352_active = False
69 log.info(u"inactive state set")
70
71 def setActive(self, client):
72 if not self.isActive(client):
73 active_elt = domish.Element((NS_CSI, u'active'))
74 client.send(active_elt)
75 client._xep_0352_active = True
76 log.info(u"active state set")