view sat/plugins/plugin_xep_0352.py @ 3528:849374e59178

component file sharing: quotas implementation: quotas can now be specified using the `quotas_json` option of `component file_sharing` section in settings. This must be a dict where: - `users` key contains default quotas for all users - `admins` key contains quotas for administrators (not implemented yet) - `jids` contain bare JID to quota mapping, to have user-specific quota The value can be either a int for quota in bytes, or a case insensitive string with an optional multiplier symbol (e.g. "500 Mio"). `None` can be used for explicit unlimited quota (which is the default is `users` is not set). When a file size is too big for quota, upload is refused with an error message indicating allowed quota, used space, and the size of the file that user wants to upload.
author Goffi <goffi@goffi.org>
date Wed, 05 May 2021 15:37:33 +0200
parents be6d91572633
children 524856bd7b19
line wrap: on
line source

#!/usr/bin/env python3


# SAT plugin for Explicit Message Encryption
# Copyright (C) 2009-2021 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 twisted.words.xish import domish
from sat.core.i18n import _, D_
from sat.core.constants import Const as C
from sat.core.log import getLogger

log = getLogger(__name__)

PLUGIN_INFO = {
    C.PI_NAME: "Client State Indication",
    C.PI_IMPORT_NAME: "XEP-0352",
    C.PI_TYPE: C.PLUG_TYPE_XEP,
    C.PI_PROTOCOLS: ["XEP-0352"],
    C.PI_DEPENDENCIES: [],
    C.PI_MAIN: "XEP_0352",
    C.PI_HANDLER: "no",
    C.PI_DESCRIPTION: D_("Notify server when frontend is not actively used, to limit "
                         "traffic and save bandwidth and battery life"),
}

NS_CSI = "urn:xmpp:csi:0"


class XEP_0352(object):

    def __init__(self, host):
        log.info(_("Client State Indication plugin initialization"))
        self.host = host
        host.registerNamespace("csi", NS_CSI)

    def isActive(self, client):
        try:
            if not client._xep_0352_enabled:
                return True
            return client._xep_0352_active
        except AttributeError:
            # _xep_0352_active can not be set if isActive is called before
            # profileConnected has been called
            log.debug("isActive called when XEP-0352 plugin has not yet set the "
                      "attributes")
            return True

    def profileConnected(self, client):
        if (NS_CSI, 'csi') in client.xmlstream.features:
            log.info(_("Client State Indication is available on this server"))
            client._xep_0352_enabled = True
            client._xep_0352_active = True
        else:
            log.warning(_("Client State Indication is not available on this server, some"
                          " bandwidth optimisations can't be used."))
            client._xep_0352_enabled = False

    def setInactive(self, client):
        if self.isActive(client):
            inactive_elt = domish.Element((NS_CSI, 'inactive'))
            client.send(inactive_elt)
            client._xep_0352_active = False
            log.info("inactive state set")

    def setActive(self, client):
        if not self.isActive(client):
            active_elt = domish.Element((NS_CSI, 'active'))
            client.send(active_elt)
            client._xep_0352_active = True
            log.info("active state set")