diff libervia/backend/plugins/plugin_misc_groupblog.py @ 4071:4b842c1fb686

refactoring: renamed `sat` package to `libervia.backend`
author Goffi <goffi@goffi.org>
date Fri, 02 Jun 2023 11:49:51 +0200
parents sat/plugins/plugin_misc_groupblog.py@524856bd7b19
children 0d7bb4df2343
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/libervia/backend/plugins/plugin_misc_groupblog.py	Fri Jun 02 11:49:51 2023 +0200
@@ -0,0 +1,149 @@
+#!/usr/bin/env python3
+
+
+# SAT plugin for microbloging with roster access
+# 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 libervia.backend.core.i18n import _
+from libervia.backend.core.constants import Const as C
+from libervia.backend.core.log import getLogger
+
+log = getLogger(__name__)
+from twisted.internet import defer
+from libervia.backend.core import exceptions
+from wokkel import disco, data_form, iwokkel
+from zope.interface import implementer
+
+try:
+    from twisted.words.protocols.xmlstream import XMPPHandler
+except ImportError:
+    from wokkel.subprotocols import XMPPHandler
+
+NS_PUBSUB = "http://jabber.org/protocol/pubsub"
+NS_GROUPBLOG = "http://salut-a-toi.org/protocol/groupblog"
+# NS_PUBSUB_EXP = 'http://goffi.org/protocol/pubsub' #for non official features
+NS_PUBSUB_EXP = (
+    NS_PUBSUB
+)  # XXX: we can't use custom namespace as Wokkel's PubSubService use official NS
+NS_PUBSUB_GROUPBLOG = NS_PUBSUB_EXP + "#groupblog"
+NS_PUBSUB_ITEM_CONFIG = NS_PUBSUB_EXP + "#item-config"
+
+
+PLUGIN_INFO = {
+    C.PI_NAME: "Group blogging through collections",
+    C.PI_IMPORT_NAME: "GROUPBLOG",
+    C.PI_TYPE: "MISC",
+    C.PI_PROTOCOLS: [],
+    C.PI_DEPENDENCIES: ["XEP-0277"],
+    C.PI_MAIN: "GroupBlog",
+    C.PI_HANDLER: "yes",
+    C.PI_DESCRIPTION: _("""Implementation of microblogging fine permissions"""),
+}
+
+
+class GroupBlog(object):
+    """This class use a SàT PubSub Service to manage access on microblog"""
+
+    def __init__(self, host):
+        log.info(_("Group blog plugin initialization"))
+        self.host = host
+        self._p = self.host.plugins["XEP-0060"]
+        host.trigger.add("XEP-0277_item2data", self._item_2_data_trigger)
+        host.trigger.add("XEP-0277_data2entry", self._data_2_entry_trigger)
+        host.trigger.add("XEP-0277_comments", self._comments_trigger)
+
+    ## plugin management methods ##
+
+    def get_handler(self, client):
+        return GroupBlog_handler()
+
+    @defer.inlineCallbacks
+    def profile_connected(self, client):
+        try:
+            yield self.host.check_features(client, (NS_PUBSUB_GROUPBLOG,))
+        except exceptions.FeatureNotFound:
+            client.server_groupblog_available = False
+            log.warning(
+                _(
+                    "Server is not able to manage item-access pubsub, we can't use group blog"
+                )
+            )
+        else:
+            client.server_groupblog_available = True
+            log.info(_("Server can manage group blogs"))
+
+    def features_get(self, profile):
+        try:
+            client = self.host.get_client(profile)
+        except exceptions.ProfileNotSetError:
+            return {}
+        try:
+            return {"available": C.bool_const(client.server_groupblog_available)}
+        except AttributeError:
+            if self.host.is_connected(profile):
+                log.debug("Profile is not connected, service is not checked yet")
+            else:
+                log.error("client.server_groupblog_available should be available !")
+            return {}
+
+    def _item_2_data_trigger(self, item_elt, entry_elt, microblog_data):
+        """Parse item to find group permission elements"""
+        config_form = data_form.findForm(item_elt, NS_PUBSUB_ITEM_CONFIG)
+        if config_form is None:
+            return
+        access_model = config_form.get(self._p.OPT_ACCESS_MODEL, self._p.ACCESS_OPEN)
+        if access_model == self._p.ACCESS_PUBLISHER_ROSTER:
+            opt = self._p.OPT_ROSTER_GROUPS_ALLOWED
+            microblog_data['groups'] = config_form.fields[opt].values
+
+    def _data_2_entry_trigger(self, client, mb_data, entry_elt, item_elt):
+        """Build fine access permission if needed
+
+        This trigger check if "group*" key are present,
+        and create a fine item config to restrict view to these groups
+        """
+        groups = mb_data.get('groups', [])
+        if not groups:
+            return
+        if not client.server_groupblog_available:
+            raise exceptions.CancelError("GroupBlog is not available")
+        log.debug("This entry use group blog")
+        form = data_form.Form("submit", formNamespace=NS_PUBSUB_ITEM_CONFIG)
+        access = data_form.Field(
+            None, self._p.OPT_ACCESS_MODEL, value=self._p.ACCESS_PUBLISHER_ROSTER
+        )
+        allowed = data_form.Field(None, self._p.OPT_ROSTER_GROUPS_ALLOWED, values=groups)
+        form.addField(access)
+        form.addField(allowed)
+        item_elt.addChild(form.toElement())
+
+    def _comments_trigger(self, client, mb_data, options):
+        """This method is called when a comments node is about to be created
+
+        It changes the access mode to roster if needed, and give the authorized groups
+        """
+        if "group" in mb_data:
+            options[self._p.OPT_ACCESS_MODEL] = self._p.ACCESS_PUBLISHER_ROSTER
+            options[self._p.OPT_ROSTER_GROUPS_ALLOWED] = mb_data['groups']
+
+@implementer(iwokkel.IDisco)
+class GroupBlog_handler(XMPPHandler):
+
+    def getDiscoInfo(self, requestor, target, nodeIdentifier=""):
+        return [disco.DiscoFeature(NS_GROUPBLOG)]
+
+    def getDiscoItems(self, requestor, target, nodeIdentifier=""):
+        return []