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