libervia-backend: sat/plugins/plugin_misc

annotate sat/plugins/plugin_misc_tickets.py @ 2910:b2f323237fce

jp, plugin merge-requests: used u'' as default for item id in pubsub arguments + fixed some required arguments: u"" is now used as defaut item id instead of node, as it needs to be serialised anyway. This is temporary solution, as empty string can be used for item id (not forbidden by XEP-0060), but for now this is not handled correctly in jp/SàT (see https://bugs.goffi.org/bugs/view/289). Correct solution will probably need to use a special key in extra to mark empty string in id. Added/removed some required values for node or item when it made sense.

author	Goffi <goffi@goffi.org>
date	Sun, 14 Apr 2019 08:21:51 +0200
parents	f18d8315929e
children	989b622faff6

rev	line source
2404 f05c884cd3ef plugin tickets: high level tickets handling, first draft: Goffi <goffi@goffi.org> parents: diff changeset	1 #!/usr/bin/env python2
f05c884cd3ef plugin tickets: high level tickets handling, first draft: Goffi <goffi@goffi.org> parents: diff changeset	2 # -- coding: utf-8 --
f05c884cd3ef plugin tickets: high level tickets handling, first draft: Goffi <goffi@goffi.org> parents: diff changeset	3
f05c884cd3ef plugin tickets: high level tickets handling, first draft: Goffi <goffi@goffi.org> parents: diff changeset	4 # SAT plugin for Pubsub Schemas
2771 003b8b4b56a7 date update Goffi <goffi@goffi.org> parents: 2624 diff changeset	5 # Copyright (C) 2009-2019 Jérôme Poisson (goffi@goffi.org)
2404 f05c884cd3ef plugin tickets: high level tickets handling, first draft: Goffi <goffi@goffi.org> parents: diff changeset	6
f05c884cd3ef plugin tickets: high level tickets handling, first draft: Goffi <goffi@goffi.org> parents: diff changeset	7 # This program is free software: you can redistribute it and/or modify
f05c884cd3ef plugin tickets: high level tickets handling, first draft: Goffi <goffi@goffi.org> parents: diff changeset	8 # it under the terms of the GNU Affero General Public License as published by
f05c884cd3ef plugin tickets: high level tickets handling, first draft: Goffi <goffi@goffi.org> parents: diff changeset	9 # the Free Software Foundation, either version 3 of the License, or
f05c884cd3ef plugin tickets: high level tickets handling, first draft: Goffi <goffi@goffi.org> parents: diff changeset	10 # (at your option) any later version.
f05c884cd3ef plugin tickets: high level tickets handling, first draft: Goffi <goffi@goffi.org> parents: diff changeset	11
f05c884cd3ef plugin tickets: high level tickets handling, first draft: Goffi <goffi@goffi.org> parents: diff changeset	12 # This program is distributed in the hope that it will be useful,
f05c884cd3ef plugin tickets: high level tickets handling, first draft: Goffi <goffi@goffi.org> parents: diff changeset	13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
f05c884cd3ef plugin tickets: high level tickets handling, first draft: Goffi <goffi@goffi.org> parents: diff changeset	14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
f05c884cd3ef plugin tickets: high level tickets handling, first draft: Goffi <goffi@goffi.org> parents: diff changeset	15 # GNU Affero General Public License for more details.
f05c884cd3ef plugin tickets: high level tickets handling, first draft: Goffi <goffi@goffi.org> parents: diff changeset	16
f05c884cd3ef plugin tickets: high level tickets handling, first draft: Goffi <goffi@goffi.org> parents: diff changeset	17 # You should have received a copy of the GNU Affero General Public License
f05c884cd3ef plugin tickets: high level tickets handling, first draft: Goffi <goffi@goffi.org> parents: diff changeset	18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
f05c884cd3ef plugin tickets: high level tickets handling, first draft: Goffi <goffi@goffi.org> parents: diff changeset	19
f05c884cd3ef plugin tickets: high level tickets handling, first draft: Goffi <goffi@goffi.org> parents: diff changeset	20 from sat.core.i18n import _
f05c884cd3ef plugin tickets: high level tickets handling, first draft: Goffi <goffi@goffi.org> parents: diff changeset	21 from sat.core.constants import Const as C
f05c884cd3ef plugin tickets: high level tickets handling, first draft: Goffi <goffi@goffi.org> parents: diff changeset	22 from twisted.internet import defer
2471 544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2447 diff changeset	23 from sat.tools.common import uri
2404 f05c884cd3ef plugin tickets: high level tickets handling, first draft: Goffi <goffi@goffi.org> parents: diff changeset	24 from sat.tools import utils
2471 544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2447 diff changeset	25 import shortuuid
2404 f05c884cd3ef plugin tickets: high level tickets handling, first draft: Goffi <goffi@goffi.org> parents: diff changeset	26 from sat.core.log import getLogger
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	27
2404 f05c884cd3ef plugin tickets: high level tickets handling, first draft: Goffi <goffi@goffi.org> parents: diff changeset	28 log = getLogger(__name__)
f05c884cd3ef plugin tickets: high level tickets handling, first draft: Goffi <goffi@goffi.org> parents: diff changeset	29
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	30 NS_TICKETS = "org.salut-a-toi.tickets:0"
2404 f05c884cd3ef plugin tickets: high level tickets handling, first draft: Goffi <goffi@goffi.org> parents: diff changeset	31
f05c884cd3ef plugin tickets: high level tickets handling, first draft: Goffi <goffi@goffi.org> parents: diff changeset	32 PLUGIN_INFO = {
f05c884cd3ef plugin tickets: high level tickets handling, first draft: Goffi <goffi@goffi.org> parents: diff changeset	33 C.PI_NAME: _("Tickets management"),
f05c884cd3ef plugin tickets: high level tickets handling, first draft: Goffi <goffi@goffi.org> parents: diff changeset	34 C.PI_IMPORT_NAME: "TICKETS",
f05c884cd3ef plugin tickets: high level tickets handling, first draft: Goffi <goffi@goffi.org> parents: diff changeset	35 C.PI_TYPE: "EXP",
f05c884cd3ef plugin tickets: high level tickets handling, first draft: Goffi <goffi@goffi.org> parents: diff changeset	36 C.PI_PROTOCOLS: [],
2430 3faf18111d61 plugin tickets: fill reporter field when it is not already filled Goffi <goffi@goffi.org> parents: 2420 diff changeset	37 C.PI_DEPENDENCIES: ["XEP-0060", "PUBSUB_SCHEMA", "XEP-0277", "IDENTITY"],
2404 f05c884cd3ef plugin tickets: high level tickets handling, first draft: Goffi <goffi@goffi.org> parents: diff changeset	38 C.PI_MAIN: "Tickets",
f05c884cd3ef plugin tickets: high level tickets handling, first draft: Goffi <goffi@goffi.org> parents: diff changeset	39 C.PI_HANDLER: "no",
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	40 C.PI_DESCRIPTION: _("""Tickets management plugin"""),
2404 f05c884cd3ef plugin tickets: high level tickets handling, first draft: Goffi <goffi@goffi.org> parents: diff changeset	41 }
f05c884cd3ef plugin tickets: high level tickets handling, first draft: Goffi <goffi@goffi.org> parents: diff changeset	42
f05c884cd3ef plugin tickets: high level tickets handling, first draft: Goffi <goffi@goffi.org> parents: diff changeset	43
f05c884cd3ef plugin tickets: high level tickets handling, first draft: Goffi <goffi@goffi.org> parents: diff changeset	44 class Tickets(object):
f05c884cd3ef plugin tickets: high level tickets handling, first draft: Goffi <goffi@goffi.org> parents: diff changeset	45 def __init__(self, host):
f05c884cd3ef plugin tickets: high level tickets handling, first draft: Goffi <goffi@goffi.org> parents: diff changeset	46 log.info(_(u"Tickets plugin initialization"))
f05c884cd3ef plugin tickets: high level tickets handling, first draft: Goffi <goffi@goffi.org> parents: diff changeset	47 self.host = host
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	48 host.registerNamespace("tickets", NS_TICKETS)
2404 f05c884cd3ef plugin tickets: high level tickets handling, first draft: Goffi <goffi@goffi.org> parents: diff changeset	49 self._p = self.host.plugins["XEP-0060"]
f05c884cd3ef plugin tickets: high level tickets handling, first draft: Goffi <goffi@goffi.org> parents: diff changeset	50 self._s = self.host.plugins["PUBSUB_SCHEMA"]
2420 03da3ef5fb5b plugin tickets: added ticketsSet and ticketsSchemaGet methods: Goffi <goffi@goffi.org> parents: 2404 diff changeset	51 self._m = self.host.plugins["XEP-0277"]
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	52 host.bridge.addMethod(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	53 "ticketsGet",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	54 ".plugin",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	55 in_sign="ssiassa{ss}s",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	56 out_sign="(asa{ss})",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	57 method=utils.partial(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	58 self._s._get,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	59 default_node=NS_TICKETS,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	60 form_ns=NS_TICKETS,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	61 filters={
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	62 u"author": self._s.valueOrPublisherFilter,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	63 u"created": self._s.dateFilter,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	64 u"updated": self._s.dateFilter,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	65 },
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	66 ),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	67 async=True,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	68 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	69 host.bridge.addMethod(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	70 "ticketSet",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	71 ".plugin",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	72 in_sign="ssa{sas}ssa{ss}s",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	73 out_sign="s",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	74 method=self._set,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	75 async=True,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	76 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	77 host.bridge.addMethod(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	78 "ticketsSchemaGet",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	79 ".plugin",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	80 in_sign="sss",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	81 out_sign="s",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	82 method=utils.partial(self._s._getUISchema, default_node=NS_TICKETS),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	83 async=True,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	84 )
2471 544c4d2fec45 plugins schema, merge_requests, tickets: factorisation Goffi <goffi@goffi.org>* parents: 2447 diff changeset	85
2785 f18d8315929e merge_requests: use XHTML for body Goffi <goffi@goffi.org> parents: 2771 diff changeset	86 def _set(self, service, node, values, schema=None, item_id=None, extra=None,
f18d8315929e merge_requests: use XHTML for body Goffi <goffi@goffi.org> parents: 2771 diff changeset	87 profile_key=C.PROF_KEY_NONE):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	88 client, service, node, schema, item_id, extra = self._s.prepareBridgeSet(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	89 service, node, schema, item_id, extra, profile_key
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	90 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	91 d = self.set(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	92 client, service, node, values, schema, item_id, extra, deserialise=True
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	93 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	94 d.addCallback(lambda ret: ret or u"")
2420 03da3ef5fb5b plugin tickets: added ticketsSet and ticketsSchemaGet methods: Goffi <goffi@goffi.org> parents: 2404 diff changeset	95 return d
03da3ef5fb5b plugin tickets: added ticketsSet and ticketsSchemaGet methods: Goffi <goffi@goffi.org> parents: 2404 diff changeset	96
03da3ef5fb5b plugin tickets: added ticketsSet and ticketsSchemaGet methods: Goffi <goffi@goffi.org> parents: 2404 diff changeset	97 @defer.inlineCallbacks
2785 f18d8315929e merge_requests: use XHTML for body Goffi <goffi@goffi.org> parents: 2771 diff changeset	98 def set(self, client, service, node, values, schema=None, item_id=None, extra=None,
f18d8315929e merge_requests: use XHTML for body Goffi <goffi@goffi.org> parents: 2771 diff changeset	99 deserialise=False, form_ns=NS_TICKETS):
2420 03da3ef5fb5b plugin tickets: added ticketsSet and ticketsSchemaGet methods: Goffi <goffi@goffi.org> parents: 2404 diff changeset	100 """Publish a tickets
03da3ef5fb5b plugin tickets: added ticketsSet and ticketsSchemaGet methods: Goffi <goffi@goffi.org> parents: 2404 diff changeset	101
03da3ef5fb5b plugin tickets: added ticketsSet and ticketsSchemaGet methods: Goffi <goffi@goffi.org> parents: 2404 diff changeset	102 @param node(unicode, None): Pubsub node to use
03da3ef5fb5b plugin tickets: added ticketsSet and ticketsSchemaGet methods: Goffi <goffi@goffi.org> parents: 2404 diff changeset	103 None to use default tickets node
2554 0062d3e79d12 plugin uri finder, jp (merge-request): labels handling: Goffi <goffi@goffi.org> parents: 2483 diff changeset	104 @param values(dict[key(unicode), [iterable[object]\|object]]): values of the ticket
0062d3e79d12 plugin uri finder, jp (merge-request): labels handling: Goffi <goffi@goffi.org> parents: 2483 diff changeset	105 if value is not iterable, it will be put in a list
2420 03da3ef5fb5b plugin tickets: added ticketsSet and ticketsSchemaGet methods: Goffi <goffi@goffi.org> parents: 2404 diff changeset	106 'created' and 'updated' will be forced to current time:
03da3ef5fb5b plugin tickets: added ticketsSet and ticketsSchemaGet methods: Goffi <goffi@goffi.org> parents: 2404 diff changeset	107 - 'created' is set if item_id is None, i.e. if it's a new ticket
03da3ef5fb5b plugin tickets: added ticketsSet and ticketsSchemaGet methods: Goffi <goffi@goffi.org> parents: 2404 diff changeset	108 - 'updated' is set everytime
2447 9e692f09f367 plugin tickets: handle "update" flag + various improvments: Goffi <goffi@goffi.org> parents: 2443 diff changeset	109 @param extra(dict, None): same as for [XEP-0060.sendItem] with additional keys:
9e692f09f367 plugin tickets: handle "update" flag + various improvments: Goffi <goffi@goffi.org> parents: 2443 diff changeset	110 - update(bool): if True, get previous item data to merge with current one
9e692f09f367 plugin tickets: handle "update" flag + various improvments: Goffi <goffi@goffi.org> parents: 2443 diff changeset	111 if True, item_id must be None
2420 03da3ef5fb5b plugin tickets: added ticketsSet and ticketsSchemaGet methods: Goffi <goffi@goffi.org> parents: 2404 diff changeset	112 other arguments are same as for [self._s.sendDataFormItem]
03da3ef5fb5b plugin tickets: added ticketsSet and ticketsSchemaGet methods: Goffi <goffi@goffi.org> parents: 2404 diff changeset	113 @return (unicode): id of the created item
03da3ef5fb5b plugin tickets: added ticketsSet and ticketsSchemaGet methods: Goffi <goffi@goffi.org> parents: 2404 diff changeset	114 """
03da3ef5fb5b plugin tickets: added ticketsSet and ticketsSchemaGet methods: Goffi <goffi@goffi.org> parents: 2404 diff changeset	115 if not node:
03da3ef5fb5b plugin tickets: added ticketsSet and ticketsSchemaGet methods: Goffi <goffi@goffi.org> parents: 2404 diff changeset	116 node = NS_TICKETS
03da3ef5fb5b plugin tickets: added ticketsSet and ticketsSchemaGet methods: Goffi <goffi@goffi.org> parents: 2404 diff changeset	117 if not item_id:
2434 7fa9456032e7 plugin tickets: specify parent service when using getCommentsService + fill reporter_jid is missing (will be discarded later if not in the schema) Goffi <goffi@goffi.org> parents: 2430 diff changeset	118 comments_service = yield self._m.getCommentsService(client, service)
2420 03da3ef5fb5b plugin tickets: added ticketsSet and ticketsSchemaGet methods: Goffi <goffi@goffi.org> parents: 2404 diff changeset	119
2785 f18d8315929e merge_requests: use XHTML for body Goffi <goffi@goffi.org> parents: 2771 diff changeset	120 # we need to use uuid for comments node, because we don't know item id in
f18d8315929e merge_requests: use XHTML for body Goffi <goffi@goffi.org> parents: 2771 diff changeset	121 # advance (we don't want to set it ourselves to let the server choose, so we
f18d8315929e merge_requests: use XHTML for body Goffi <goffi@goffi.org> parents: 2771 diff changeset	122 # can have a nicer id if serial ids is activated)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	123 comments_node = self._m.getCommentsNode(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	124 node + u"_" + unicode(shortuuid.uuid())
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	125 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	126 options = {
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	127 self._p.OPT_ACCESS_MODEL: self._p.ACCESS_OPEN,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	128 self._p.OPT_PERSIST_ITEMS: 1,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	129 self._p.OPT_MAX_ITEMS: -1,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	130 self._p.OPT_DELIVER_PAYLOADS: 1,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	131 self._p.OPT_SEND_ITEM_SUBSCRIBE: 1,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	132 self._p.OPT_PUBLISH_MODEL: self._p.ACCESS_OPEN,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	133 }
2420 03da3ef5fb5b plugin tickets: added ticketsSet and ticketsSchemaGet methods: Goffi <goffi@goffi.org> parents: 2404 diff changeset	134 yield self._p.createNode(client, comments_service, comments_node, options)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	135 values["comments_uri"] = uri.buildXMPPUri(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	136 u"pubsub",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	137 subtype="microblog",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	138 path=comments_service.full(),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	139 node=comments_node,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	140 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	141 item_id = yield self._s.set(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	142 client, service, node, values, schema, item_id, extra, deserialise, form_ns
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2603 diff changeset	143 )
2420 03da3ef5fb5b plugin tickets: added ticketsSet and ticketsSchemaGet methods: Goffi <goffi@goffi.org> parents: 2404 diff changeset	144 defer.returnValue(item_id)

Mercurial > libervia-backend

annotate sat/plugins/plugin_misc_tickets.py @ 2910:b2f323237fce