diff sat/plugins/plugin_misc_lists.py @ 3456:6deea0d8d0e7

plugin tickets, merge_requests: renamed "tickets" feature to "lists": this feature is more generic than only "tickets" for technical stuff, thus the name "lists" seems more appropriate.
author Goffi <goffi@goffi.org>
date Thu, 04 Feb 2021 21:05:21 +0100
parents sat/plugins/plugin_misc_tickets.py@bb0225aaf4e6
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/sat/plugins/plugin_misc_lists.py	Thu Feb 04 21:05:21 2021 +0100
@@ -0,0 +1,154 @@
+#!/usr/bin/env python3
+
+# Copyright (C) 2009-2020 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 twisted.internet import defer
+from sat.tools.common import uri
+import shortuuid
+from sat.core.log import getLogger
+
+log = getLogger(__name__)
+
+# XXX: this plugin was formely named "tickets", thus the namespace keeps this
+# name
+APP_NS_TICKETS = "org.salut-a-toi.tickets:0"
+
+PLUGIN_INFO = {
+    C.PI_NAME: _("Pubsub Lists"),
+    C.PI_IMPORT_NAME: "LISTS",
+    C.PI_TYPE: "EXP",
+    C.PI_PROTOCOLS: [],
+    C.PI_DEPENDENCIES: ["XEP-0060", "XEP-0346", "XEP-0277", "IDENTITY"],
+    C.PI_MAIN: "PubsubLists",
+    C.PI_HANDLER: "no",
+    C.PI_DESCRIPTION: _("""Pubsub lists management plugin"""),
+}
+
+
+class PubsubLists:
+
+    def __init__(self, host):
+        log.info(_("Pubsub lists plugin initialization"))
+        self.host = host
+        self._s = self.host.plugins["XEP-0346"]
+        self.namespace = self._s.getSubmittedNS(APP_NS_TICKETS)
+        host.registerNamespace("tickets", self.namespace)
+        self._p = self.host.plugins["XEP-0060"]
+        self._m = self.host.plugins["XEP-0277"]
+        host.bridge.addMethod(
+            "listGet",
+            ".plugin",
+            in_sign="ssiassa{ss}s",
+            out_sign="s",
+            method=lambda service, node, max_items, items_ids, sub_id, extra, profile_key:
+                self._s._get(
+                service,
+                node,
+                max_items,
+                items_ids,
+                sub_id,
+                extra,
+                default_node=self.namespace,
+                form_ns=APP_NS_TICKETS,
+                filters={
+                    "author": self._s.valueOrPublisherFilter,
+                    "created": self._s.dateFilter,
+                    "updated": self._s.dateFilter,
+                },
+                profile_key=profile_key),
+            async_=True,
+        )
+        host.bridge.addMethod(
+            "listSet",
+            ".plugin",
+            in_sign="ssa{sas}ssss",
+            out_sign="s",
+            method=self._set,
+            async_=True,
+        )
+        host.bridge.addMethod(
+            "listSchemaGet",
+            ".plugin",
+            in_sign="sss",
+            out_sign="s",
+            method=lambda service, nodeIdentifier, profile_key: self._s._getUISchema(
+                service, nodeIdentifier, default_node=self.namespace,
+                profile_key=profile_key),
+            async_=True,
+        )
+
+    def _set(self, service, node, values, schema=None, item_id=None, extra='',
+             profile_key=C.PROF_KEY_NONE):
+        client, service, node, schema, item_id, extra = self._s.prepareBridgeSet(
+            service, node, schema, item_id, extra, profile_key
+        )
+        d = defer.ensureDeferred(self.set(
+            client, service, node, values, schema, item_id, extra, deserialise=True
+        ))
+        d.addCallback(lambda ret: ret or "")
+        return d
+
+    async def set(self, client, service, node, values, schema=None, item_id=None, extra=None,
+            deserialise=False, form_ns=APP_NS_TICKETS):
+        """Publish a tickets
+
+        @param node(unicode, None): Pubsub node to use
+            None to use default tickets node
+        @param values(dict[key(unicode), [iterable[object]|object]]): values of the ticket
+
+            if value is not iterable, it will be put in a list
+            'created' and 'updated' will be forced to current time:
+                - 'created' is set if item_id is None, i.e. if it's a new ticket
+                - 'updated' is set everytime
+        @param extra(dict, None): same as for [XEP-0060.sendItem] with additional keys:
+            - update(bool): if True, get previous item data to merge with current one
+                if True, item_id must be None
+        other arguments are same as for [self._s.sendDataFormItem]
+        @return (unicode): id of the created item
+        """
+        if not node:
+            node = self.namespace
+
+        if not item_id:
+            comments_service = await self._m.getCommentsService(client, service)
+
+            # we need to use uuid for comments node, because we don't know item id in
+            # advance (we don't want to set it ourselves to let the server choose, so we
+            # can have a nicer id if serial ids is activated)
+            comments_node = self._m.getCommentsNode(
+                node + "_" + str(shortuuid.uuid())
+            )
+            options = {
+                self._p.OPT_ACCESS_MODEL: self._p.ACCESS_OPEN,
+                self._p.OPT_PERSIST_ITEMS: 1,
+                self._p.OPT_MAX_ITEMS: -1,
+                self._p.OPT_DELIVER_PAYLOADS: 1,
+                self._p.OPT_SEND_ITEM_SUBSCRIBE: 1,
+                self._p.OPT_PUBLISH_MODEL: self._p.ACCESS_OPEN,
+            }
+            await self._p.createNode(client, comments_service, comments_node, options)
+            values["comments_uri"] = uri.buildXMPPUri(
+                "pubsub",
+                subtype="microblog",
+                path=comments_service.full(),
+                node=comments_node,
+            )
+
+        return await self._s.set(
+            client, service, node, values, schema, item_id, extra, deserialise, form_ns
+        )