Mercurial > libervia-backend
annotate sat/plugins/plugin_misc_tickets.py @ 3431:5d7569378914
doc (testing): typos
author | Goffi <goffi@goffi.org> |
---|---|
date | Fri, 04 Dec 2020 12:27:38 +0100 |
parents | 71761e9fb984 |
children | bb0225aaf4e6 |
rev | line source |
---|---|
3028 | 1 #!/usr/bin/env python3 |
3137 | 2 |
2404
f05c884cd3ef
plugin tickets: high level tickets handling, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
3 # SAT plugin for Pubsub Schemas |
3136 | 4 # Copyright (C) 2009-2020 Jérôme Poisson (goffi@goffi.org) |
2404
f05c884cd3ef
plugin tickets: high level tickets handling, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
5 |
f05c884cd3ef
plugin tickets: high level tickets handling, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
6 # 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
|
7 # 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
|
8 # 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
|
9 # (at your option) any later version. |
f05c884cd3ef
plugin tickets: high level tickets handling, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
10 |
f05c884cd3ef
plugin tickets: high level tickets handling, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
11 # 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
|
12 # 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
|
13 # 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
|
14 # GNU Affero General Public License for more details. |
f05c884cd3ef
plugin tickets: high level tickets handling, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
15 |
f05c884cd3ef
plugin tickets: high level tickets handling, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
16 # 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
|
17 # 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
|
18 |
f05c884cd3ef
plugin tickets: high level tickets handling, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
19 from sat.core.i18n import _ |
f05c884cd3ef
plugin tickets: high level tickets handling, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
20 from sat.core.constants import Const as C |
f05c884cd3ef
plugin tickets: high level tickets handling, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
21 from twisted.internet import defer |
2471
544c4d2fec45
plugins schema, merge_requests, tickets*: factorisation
Goffi <goffi@goffi.org>
parents:
2447
diff
changeset
|
22 from sat.tools.common import uri |
544c4d2fec45
plugins schema, merge_requests, tickets*: factorisation
Goffi <goffi@goffi.org>
parents:
2447
diff
changeset
|
23 import shortuuid |
2404
f05c884cd3ef
plugin tickets: high level tickets handling, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
24 from sat.core.log import getLogger |
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2603
diff
changeset
|
25 |
2404
f05c884cd3ef
plugin tickets: high level tickets handling, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
26 log = getLogger(__name__) |
f05c884cd3ef
plugin tickets: high level tickets handling, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
27 |
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2603
diff
changeset
|
28 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
|
29 |
f05c884cd3ef
plugin tickets: high level tickets handling, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
30 PLUGIN_INFO = { |
3028 | 31 C.PI_NAME: _("Tickets management"), |
32 C.PI_IMPORT_NAME: "TICKETS", | |
33 C.PI_TYPE: "EXP", | |
2404
f05c884cd3ef
plugin tickets: high level tickets handling, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
34 C.PI_PROTOCOLS: [], |
3028 | 35 C.PI_DEPENDENCIES: ["XEP-0060", "PUBSUB_SCHEMA", "XEP-0277", "IDENTITY"], |
36 C.PI_MAIN: "Tickets", | |
37 C.PI_HANDLER: "no", | |
38 C.PI_DESCRIPTION: _("""Tickets management plugin"""), | |
2404
f05c884cd3ef
plugin tickets: high level tickets handling, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
39 } |
f05c884cd3ef
plugin tickets: high level tickets handling, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
40 |
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 class Tickets(object): |
f05c884cd3ef
plugin tickets: high level tickets handling, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
43 def __init__(self, host): |
3028 | 44 log.info(_("Tickets plugin initialization")) |
2404
f05c884cd3ef
plugin tickets: high level tickets handling, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
45 self.host = host |
3028 | 46 host.registerNamespace("tickets", NS_TICKETS) |
47 self._p = self.host.plugins["XEP-0060"] | |
48 self._s = self.host.plugins["PUBSUB_SCHEMA"] | |
49 self._m = self.host.plugins["XEP-0277"] | |
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2603
diff
changeset
|
50 host.bridge.addMethod( |
3028 | 51 "ticketsGet", |
52 ".plugin", | |
53 in_sign="ssiassa{ss}s", | |
3309
71761e9fb984
plugins tickets, merge-requests: `ticketsGet` and `mergeRequestsGet` serialisation:
Goffi <goffi@goffi.org>
parents:
3137
diff
changeset
|
54 out_sign="s", |
3028 | 55 method=lambda service, node, max_items, items_ids, sub_id, extra, profile_key: |
56 self._s._get( | |
57 service, | |
58 node, | |
59 max_items, | |
60 items_ids, | |
61 sub_id, | |
62 extra, | |
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2603
diff
changeset
|
63 default_node=NS_TICKETS, |
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2603
diff
changeset
|
64 form_ns=NS_TICKETS, |
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2603
diff
changeset
|
65 filters={ |
3028 | 66 "author": self._s.valueOrPublisherFilter, |
67 "created": self._s.dateFilter, | |
68 "updated": self._s.dateFilter, | |
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2603
diff
changeset
|
69 }, |
3028 | 70 profile_key=profile_key), |
71 async_=True, | |
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2603
diff
changeset
|
72 ) |
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2603
diff
changeset
|
73 host.bridge.addMethod( |
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2603
diff
changeset
|
74 "ticketSet", |
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2603
diff
changeset
|
75 ".plugin", |
2959
989b622faff6
plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes
Goffi <goffi@goffi.org>
parents:
2785
diff
changeset
|
76 in_sign="ssa{sas}ssss", |
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2603
diff
changeset
|
77 out_sign="s", |
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2603
diff
changeset
|
78 method=self._set, |
3028 | 79 async_=True, |
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2603
diff
changeset
|
80 ) |
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2603
diff
changeset
|
81 host.bridge.addMethod( |
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2603
diff
changeset
|
82 "ticketsSchemaGet", |
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2603
diff
changeset
|
83 ".plugin", |
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2603
diff
changeset
|
84 in_sign="sss", |
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2603
diff
changeset
|
85 out_sign="s", |
3028 | 86 method=lambda service, nodeIdentifier, profile_key: self._s._getUISchema( |
87 service, nodeIdentifier, default_node=NS_TICKETS, | |
88 profile_key=profile_key), | |
89 async_=True, | |
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2603
diff
changeset
|
90 ) |
2471
544c4d2fec45
plugins schema, merge_requests, tickets*: factorisation
Goffi <goffi@goffi.org>
parents:
2447
diff
changeset
|
91 |
3028 | 92 def _set(self, service, node, values, schema=None, item_id=None, extra='', |
2785
f18d8315929e
merge_requests: use XHTML for body
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
93 profile_key=C.PROF_KEY_NONE): |
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2603
diff
changeset
|
94 client, service, node, schema, item_id, extra = self._s.prepareBridgeSet( |
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2603
diff
changeset
|
95 service, node, schema, item_id, extra, profile_key |
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2603
diff
changeset
|
96 ) |
3309
71761e9fb984
plugins tickets, merge-requests: `ticketsGet` and `mergeRequestsGet` serialisation:
Goffi <goffi@goffi.org>
parents:
3137
diff
changeset
|
97 d = defer.ensureDeferred(self.set( |
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2603
diff
changeset
|
98 client, service, node, values, schema, item_id, extra, deserialise=True |
3309
71761e9fb984
plugins tickets, merge-requests: `ticketsGet` and `mergeRequestsGet` serialisation:
Goffi <goffi@goffi.org>
parents:
3137
diff
changeset
|
99 )) |
3028 | 100 d.addCallback(lambda ret: ret or "") |
2420
03da3ef5fb5b
plugin tickets: added ticketsSet and ticketsSchemaGet methods:
Goffi <goffi@goffi.org>
parents:
2404
diff
changeset
|
101 return d |
03da3ef5fb5b
plugin tickets: added ticketsSet and ticketsSchemaGet methods:
Goffi <goffi@goffi.org>
parents:
2404
diff
changeset
|
102 |
3309
71761e9fb984
plugins tickets, merge-requests: `ticketsGet` and `mergeRequestsGet` serialisation:
Goffi <goffi@goffi.org>
parents:
3137
diff
changeset
|
103 async def set(self, client, service, node, values, schema=None, item_id=None, extra=None, |
2785
f18d8315929e
merge_requests: use XHTML for body
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
104 deserialise=False, form_ns=NS_TICKETS): |
2420
03da3ef5fb5b
plugin tickets: added ticketsSet and ticketsSchemaGet methods:
Goffi <goffi@goffi.org>
parents:
2404
diff
changeset
|
105 """Publish a tickets |
03da3ef5fb5b
plugin tickets: added ticketsSet and ticketsSchemaGet methods:
Goffi <goffi@goffi.org>
parents:
2404
diff
changeset
|
106 |
03da3ef5fb5b
plugin tickets: added ticketsSet and ticketsSchemaGet methods:
Goffi <goffi@goffi.org>
parents:
2404
diff
changeset
|
107 @param node(unicode, None): Pubsub node to use |
03da3ef5fb5b
plugin tickets: added ticketsSet and ticketsSchemaGet methods:
Goffi <goffi@goffi.org>
parents:
2404
diff
changeset
|
108 None to use default tickets node |
2554
0062d3e79d12
plugin uri finder, jp (merge-request): labels handling:
Goffi <goffi@goffi.org>
parents:
2483
diff
changeset
|
109 @param values(dict[key(unicode), [iterable[object]|object]]): values of the ticket |
2959
989b622faff6
plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes
Goffi <goffi@goffi.org>
parents:
2785
diff
changeset
|
110 |
2554
0062d3e79d12
plugin uri finder, jp (merge-request): labels handling:
Goffi <goffi@goffi.org>
parents:
2483
diff
changeset
|
111 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
|
112 '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
|
113 - '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
|
114 - 'updated' is set everytime |
2447
9e692f09f367
plugin tickets: handle "update" flag + various improvments:
Goffi <goffi@goffi.org>
parents:
2443
diff
changeset
|
115 @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
|
116 - 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
|
117 if True, item_id must be None |
2420
03da3ef5fb5b
plugin tickets: added ticketsSet and ticketsSchemaGet methods:
Goffi <goffi@goffi.org>
parents:
2404
diff
changeset
|
118 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
|
119 @return (unicode): id of the created item |
03da3ef5fb5b
plugin tickets: added ticketsSet and ticketsSchemaGet methods:
Goffi <goffi@goffi.org>
parents:
2404
diff
changeset
|
120 """ |
03da3ef5fb5b
plugin tickets: added ticketsSet and ticketsSchemaGet methods:
Goffi <goffi@goffi.org>
parents:
2404
diff
changeset
|
121 if not node: |
03da3ef5fb5b
plugin tickets: added ticketsSet and ticketsSchemaGet methods:
Goffi <goffi@goffi.org>
parents:
2404
diff
changeset
|
122 node = NS_TICKETS |
2959
989b622faff6
plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes
Goffi <goffi@goffi.org>
parents:
2785
diff
changeset
|
123 |
2420
03da3ef5fb5b
plugin tickets: added ticketsSet and ticketsSchemaGet methods:
Goffi <goffi@goffi.org>
parents:
2404
diff
changeset
|
124 if not item_id: |
3309
71761e9fb984
plugins tickets, merge-requests: `ticketsGet` and `mergeRequestsGet` serialisation:
Goffi <goffi@goffi.org>
parents:
3137
diff
changeset
|
125 comments_service = await self._m.getCommentsService(client, service) |
2420
03da3ef5fb5b
plugin tickets: added ticketsSet and ticketsSchemaGet methods:
Goffi <goffi@goffi.org>
parents:
2404
diff
changeset
|
126 |
2785
f18d8315929e
merge_requests: use XHTML for body
Goffi <goffi@goffi.org>
parents:
2771
diff
changeset
|
127 # 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
|
128 # 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
|
129 # 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
|
130 comments_node = self._m.getCommentsNode( |
3028 | 131 node + "_" + str(shortuuid.uuid()) |
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2603
diff
changeset
|
132 ) |
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2603
diff
changeset
|
133 options = { |
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2603
diff
changeset
|
134 self._p.OPT_ACCESS_MODEL: self._p.ACCESS_OPEN, |
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2603
diff
changeset
|
135 self._p.OPT_PERSIST_ITEMS: 1, |
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2603
diff
changeset
|
136 self._p.OPT_MAX_ITEMS: -1, |
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2603
diff
changeset
|
137 self._p.OPT_DELIVER_PAYLOADS: 1, |
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2603
diff
changeset
|
138 self._p.OPT_SEND_ITEM_SUBSCRIBE: 1, |
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2603
diff
changeset
|
139 self._p.OPT_PUBLISH_MODEL: self._p.ACCESS_OPEN, |
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2603
diff
changeset
|
140 } |
3309
71761e9fb984
plugins tickets, merge-requests: `ticketsGet` and `mergeRequestsGet` serialisation:
Goffi <goffi@goffi.org>
parents:
3137
diff
changeset
|
141 await self._p.createNode(client, comments_service, comments_node, options) |
3028 | 142 values["comments_uri"] = uri.buildXMPPUri( |
143 "pubsub", | |
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2603
diff
changeset
|
144 subtype="microblog", |
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2603
diff
changeset
|
145 path=comments_service.full(), |
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2603
diff
changeset
|
146 node=comments_node, |
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2603
diff
changeset
|
147 ) |
2959
989b622faff6
plugins schema, tickets, merge_requests: use serialised data for extra dict + some cosmetic changes
Goffi <goffi@goffi.org>
parents:
2785
diff
changeset
|
148 |
3309
71761e9fb984
plugins tickets, merge-requests: `ticketsGet` and `mergeRequestsGet` serialisation:
Goffi <goffi@goffi.org>
parents:
3137
diff
changeset
|
149 return await self._s.set( |
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2603
diff
changeset
|
150 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
|
151 ) |