Mercurial > libervia-backend
annotate sat/plugins/plugin_misc_lists.py @ 3463:483bcfeb11c9
plugin misc list: register lists for pubsub invitations
author | Goffi <goffi@goffi.org> |
---|---|
date | Fri, 19 Feb 2021 15:52:28 +0100 |
parents | 02a8d227d5bb |
children | 54b9cdbeb335 |
rev | line source |
---|---|
3458 | 1 #!/usr/bin/env python3 |
2 | |
3 # Copyright (C) 2009-2020 Jérôme Poisson (goffi@goffi.org) | |
4 | |
5 # This program is free software: you can redistribute it and/or modify | |
6 # it under the terms of the GNU Affero General Public License as published by | |
7 # the Free Software Foundation, either version 3 of the License, or | |
8 # (at your option) any later version. | |
9 | |
10 # This program is distributed in the hope that it will be useful, | |
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
13 # GNU Affero General Public License for more details. | |
14 | |
15 # You should have received a copy of the GNU Affero General Public License | |
16 # along with this program. If not, see <http://www.gnu.org/licenses/>. | |
17 | |
3460 | 18 import shortuuid |
3463
483bcfeb11c9
plugin misc list: register lists for pubsub invitations
Goffi <goffi@goffi.org>
parents:
3461
diff
changeset
|
19 from typing import List, Tuple, Optional |
3460 | 20 from twisted.internet import defer |
21 from twisted.words.xish import domish | |
22 from twisted.words.protocols.jabber import jid | |
23 from wokkel import data_form | |
3459
8dc26e5edcd3
plugin tickets, merge_requests: renamed "tickets" feature to "lists":
Goffi <goffi@goffi.org>
parents:
3458
diff
changeset
|
24 from sat.core.i18n import _, D_ |
3463
483bcfeb11c9
plugin misc list: register lists for pubsub invitations
Goffi <goffi@goffi.org>
parents:
3461
diff
changeset
|
25 from sat.core.xmpp import SatXMPPEntity |
3458 | 26 from sat.core.constants import Const as C |
27 from sat.tools.common import uri | |
3460 | 28 from sat.tools.common import data_format |
3458 | 29 from sat.core.log import getLogger |
30 | |
31 log = getLogger(__name__) | |
32 | |
3459
8dc26e5edcd3
plugin tickets, merge_requests: renamed "tickets" feature to "lists":
Goffi <goffi@goffi.org>
parents:
3458
diff
changeset
|
33 # XXX: this plugin was formely named "tickets", thus the namespace keeps this |
8dc26e5edcd3
plugin tickets, merge_requests: renamed "tickets" feature to "lists":
Goffi <goffi@goffi.org>
parents:
3458
diff
changeset
|
34 # name |
3458 | 35 APP_NS_TICKETS = "org.salut-a-toi.tickets:0" |
3460 | 36 NS_TICKETS_TYPE = "org.salut-a-toi.tickets#type:0" |
3458 | 37 |
38 PLUGIN_INFO = { | |
3459
8dc26e5edcd3
plugin tickets, merge_requests: renamed "tickets" feature to "lists":
Goffi <goffi@goffi.org>
parents:
3458
diff
changeset
|
39 C.PI_NAME: _("Pubsub Lists"), |
8dc26e5edcd3
plugin tickets, merge_requests: renamed "tickets" feature to "lists":
Goffi <goffi@goffi.org>
parents:
3458
diff
changeset
|
40 C.PI_IMPORT_NAME: "LISTS", |
3458 | 41 C.PI_TYPE: "EXP", |
42 C.PI_PROTOCOLS: [], | |
3463
483bcfeb11c9
plugin misc list: register lists for pubsub invitations
Goffi <goffi@goffi.org>
parents:
3461
diff
changeset
|
43 C.PI_DEPENDENCIES: ["XEP-0060", "XEP-0346", "XEP-0277", "IDENTITY", |
483bcfeb11c9
plugin misc list: register lists for pubsub invitations
Goffi <goffi@goffi.org>
parents:
3461
diff
changeset
|
44 "PUBSUB_INVITATION"], |
3459
8dc26e5edcd3
plugin tickets, merge_requests: renamed "tickets" feature to "lists":
Goffi <goffi@goffi.org>
parents:
3458
diff
changeset
|
45 C.PI_MAIN: "PubsubLists", |
3458 | 46 C.PI_HANDLER: "no", |
3459
8dc26e5edcd3
plugin tickets, merge_requests: renamed "tickets" feature to "lists":
Goffi <goffi@goffi.org>
parents:
3458
diff
changeset
|
47 C.PI_DESCRIPTION: _("""Pubsub lists management plugin"""), |
3458 | 48 } |
49 | |
3460 | 50 TEMPLATES = { |
51 "todo": { | |
52 "name": D_("TODO List"), | |
53 "icon": "check", | |
54 "fields": [ | |
55 {"name": "title"}, | |
56 {"name": "author"}, | |
57 {"name": "created"}, | |
58 {"name": "updated"}, | |
59 {"name": "time_limit"}, | |
60 {"name": "labels", "type": "text-multi"}, | |
61 { | |
62 "name": "status", | |
63 "label": D_("status"), | |
64 "type": "list-single", | |
65 "options": [ | |
66 { | |
67 "label": D_("to do"), | |
68 "value": "todo" | |
69 }, | |
70 { | |
71 "label": D_("in progress"), | |
72 "value": "in_progress" | |
73 }, | |
74 { | |
75 "label": D_("done"), | |
76 "value": "done" | |
77 }, | |
78 ], | |
79 "value": "todo" | |
80 }, | |
81 { | |
82 "name": "priority", | |
83 "label": D_("priority"), | |
84 "type": "list-single", | |
85 "options": [ | |
86 { | |
87 "label": D_("major"), | |
88 "value": "major" | |
89 }, | |
90 { | |
91 "label": D_("normal"), | |
92 "value": "normal" | |
93 }, | |
94 { | |
95 "label": D_("minor"), | |
96 "value": "minor" | |
97 }, | |
98 ], | |
99 "value": "normal" | |
100 }, | |
101 {"name": "body", "type": "xhtml"}, | |
102 {"name": "comments_uri"}, | |
103 ] | |
104 }, | |
105 "shopping": { | |
106 "name": D_("Shopping List"), | |
107 "icon": "basket", | |
108 "fields": [ | |
109 {"name": "name", "label": D_("name")}, | |
110 {"name": "quantity", "label": D_("quantity")}, | |
111 { | |
112 "name": "status", | |
113 "label": D_("status"), | |
114 "type": "list-single", | |
115 "options": [ | |
116 { | |
117 "label": D_("to buy"), | |
118 "value": "to_buy" | |
119 }, | |
120 { | |
121 "label": D_("bought"), | |
122 "value": "bought" | |
123 }, | |
124 ], | |
125 "value": "to_buy" | |
126 }, | |
127 ] | |
128 }, | |
129 "tickets": { | |
130 "name": D_("Tickets"), | |
131 "icon": "clipboard", | |
132 "fields": [ | |
133 {"name": "title"}, | |
134 {"name": "author"}, | |
135 {"name": "created"}, | |
136 {"name": "updated"}, | |
137 {"name": "labels", "type": "text-multi"}, | |
138 { | |
139 "name": "type", | |
140 "label": D_("type"), | |
141 "type": "list-single", | |
142 "options": [ | |
143 { | |
144 "label": D_("bug"), | |
145 "value": "bug" | |
146 }, | |
147 { | |
148 "label": D_("feature request"), | |
149 "value": "feature" | |
150 }, | |
151 ], | |
152 "value": "bug" | |
153 }, | |
154 { | |
155 "name": "status", | |
156 "label": D_("status"), | |
157 "type": "list-single", | |
158 "options": [ | |
159 { | |
160 "label": D_("queued"), | |
161 "value": "queued" | |
162 }, | |
163 { | |
164 "label": D_("started"), | |
165 "value": "started" | |
166 }, | |
167 { | |
168 "label": D_("review"), | |
169 "value": "review" | |
170 }, | |
171 { | |
172 "label": D_("closed"), | |
173 "value": "closed" | |
174 }, | |
175 ], | |
176 "value": "queued" | |
177 }, | |
178 { | |
179 "name": "priority", | |
180 "label": D_("priority"), | |
181 "type": "list-single", | |
182 "options": [ | |
183 { | |
184 "label": D_("major"), | |
185 "value": "major" | |
186 }, | |
187 { | |
188 "label": D_("normal"), | |
189 "value": "normal" | |
190 }, | |
191 { | |
192 "label": D_("minor"), | |
193 "value": "minor" | |
194 }, | |
195 ], | |
196 "value": "normal" | |
197 }, | |
198 {"name": "body", "type": "xhtml"}, | |
199 {"name": "comments_uri"}, | |
200 ] | |
201 } | |
202 } | |
203 | |
3458 | 204 |
3459
8dc26e5edcd3
plugin tickets, merge_requests: renamed "tickets" feature to "lists":
Goffi <goffi@goffi.org>
parents:
3458
diff
changeset
|
205 class PubsubLists: |
3458 | 206 |
207 def __init__(self, host): | |
3459
8dc26e5edcd3
plugin tickets, merge_requests: renamed "tickets" feature to "lists":
Goffi <goffi@goffi.org>
parents:
3458
diff
changeset
|
208 log.info(_("Pubsub lists plugin initialization")) |
3458 | 209 self.host = host |
210 self._s = self.host.plugins["XEP-0346"] | |
211 self.namespace = self._s.getSubmittedNS(APP_NS_TICKETS) | |
3461
02a8d227d5bb
plugin misc lists: register app NS for "tickets" NS instead of XEP-0346 submitted one
Goffi <goffi@goffi.org>
parents:
3460
diff
changeset
|
212 host.registerNamespace("tickets", APP_NS_TICKETS) |
3463
483bcfeb11c9
plugin misc list: register lists for pubsub invitations
Goffi <goffi@goffi.org>
parents:
3461
diff
changeset
|
213 self.host.plugins["PUBSUB_INVITATION"].register( |
483bcfeb11c9
plugin misc list: register lists for pubsub invitations
Goffi <goffi@goffi.org>
parents:
3461
diff
changeset
|
214 APP_NS_TICKETS, self |
483bcfeb11c9
plugin misc list: register lists for pubsub invitations
Goffi <goffi@goffi.org>
parents:
3461
diff
changeset
|
215 ) |
3458 | 216 self._p = self.host.plugins["XEP-0060"] |
217 self._m = self.host.plugins["XEP-0277"] | |
218 host.bridge.addMethod( | |
3459
8dc26e5edcd3
plugin tickets, merge_requests: renamed "tickets" feature to "lists":
Goffi <goffi@goffi.org>
parents:
3458
diff
changeset
|
219 "listGet", |
3458 | 220 ".plugin", |
221 in_sign="ssiassa{ss}s", | |
222 out_sign="s", | |
223 method=lambda service, node, max_items, items_ids, sub_id, extra, profile_key: | |
224 self._s._get( | |
225 service, | |
226 node, | |
227 max_items, | |
228 items_ids, | |
229 sub_id, | |
230 extra, | |
231 default_node=self.namespace, | |
232 form_ns=APP_NS_TICKETS, | |
233 filters={ | |
234 "author": self._s.valueOrPublisherFilter, | |
235 "created": self._s.dateFilter, | |
236 "updated": self._s.dateFilter, | |
3460 | 237 "time_limit": self._s.dateFilter, |
3458 | 238 }, |
239 profile_key=profile_key), | |
240 async_=True, | |
241 ) | |
242 host.bridge.addMethod( | |
3459
8dc26e5edcd3
plugin tickets, merge_requests: renamed "tickets" feature to "lists":
Goffi <goffi@goffi.org>
parents:
3458
diff
changeset
|
243 "listSet", |
3458 | 244 ".plugin", |
245 in_sign="ssa{sas}ssss", | |
246 out_sign="s", | |
247 method=self._set, | |
248 async_=True, | |
249 ) | |
250 host.bridge.addMethod( | |
3459
8dc26e5edcd3
plugin tickets, merge_requests: renamed "tickets" feature to "lists":
Goffi <goffi@goffi.org>
parents:
3458
diff
changeset
|
251 "listSchemaGet", |
3458 | 252 ".plugin", |
253 in_sign="sss", | |
254 out_sign="s", | |
255 method=lambda service, nodeIdentifier, profile_key: self._s._getUISchema( | |
256 service, nodeIdentifier, default_node=self.namespace, | |
257 profile_key=profile_key), | |
258 async_=True, | |
259 ) | |
3460 | 260 host.bridge.addMethod( |
261 "listTemplatesNamesGet", | |
262 ".plugin", | |
263 in_sign="ss", | |
264 out_sign="s", | |
265 method=self._getTemplatesNames, | |
266 ) | |
267 host.bridge.addMethod( | |
268 "listTemplateGet", | |
269 ".plugin", | |
270 in_sign="sss", | |
271 out_sign="s", | |
272 method=self._getTemplate, | |
273 ) | |
274 host.bridge.addMethod( | |
275 "listTemplateCreate", | |
276 ".plugin", | |
277 in_sign="ssss", | |
278 out_sign="(ss)", | |
279 method=self._createTemplate, | |
280 async_=True, | |
281 ) | |
3458 | 282 |
3463
483bcfeb11c9
plugin misc list: register lists for pubsub invitations
Goffi <goffi@goffi.org>
parents:
3461
diff
changeset
|
283 async def onInvitationPreflight( |
483bcfeb11c9
plugin misc list: register lists for pubsub invitations
Goffi <goffi@goffi.org>
parents:
3461
diff
changeset
|
284 self, |
483bcfeb11c9
plugin misc list: register lists for pubsub invitations
Goffi <goffi@goffi.org>
parents:
3461
diff
changeset
|
285 client: SatXMPPEntity, |
483bcfeb11c9
plugin misc list: register lists for pubsub invitations
Goffi <goffi@goffi.org>
parents:
3461
diff
changeset
|
286 namespace: str, |
483bcfeb11c9
plugin misc list: register lists for pubsub invitations
Goffi <goffi@goffi.org>
parents:
3461
diff
changeset
|
287 name: str, |
483bcfeb11c9
plugin misc list: register lists for pubsub invitations
Goffi <goffi@goffi.org>
parents:
3461
diff
changeset
|
288 extra: dict, |
483bcfeb11c9
plugin misc list: register lists for pubsub invitations
Goffi <goffi@goffi.org>
parents:
3461
diff
changeset
|
289 service: jid.JID, |
483bcfeb11c9
plugin misc list: register lists for pubsub invitations
Goffi <goffi@goffi.org>
parents:
3461
diff
changeset
|
290 node: str, |
483bcfeb11c9
plugin misc list: register lists for pubsub invitations
Goffi <goffi@goffi.org>
parents:
3461
diff
changeset
|
291 item_id: Optional[str], |
483bcfeb11c9
plugin misc list: register lists for pubsub invitations
Goffi <goffi@goffi.org>
parents:
3461
diff
changeset
|
292 item_elt: domish.Element |
483bcfeb11c9
plugin misc list: register lists for pubsub invitations
Goffi <goffi@goffi.org>
parents:
3461
diff
changeset
|
293 ) -> None: |
483bcfeb11c9
plugin misc list: register lists for pubsub invitations
Goffi <goffi@goffi.org>
parents:
3461
diff
changeset
|
294 try: |
483bcfeb11c9
plugin misc list: register lists for pubsub invitations
Goffi <goffi@goffi.org>
parents:
3461
diff
changeset
|
295 schema = await self._s.getSchemaForm(client, service, node) |
483bcfeb11c9
plugin misc list: register lists for pubsub invitations
Goffi <goffi@goffi.org>
parents:
3461
diff
changeset
|
296 except Exception as e: |
483bcfeb11c9
plugin misc list: register lists for pubsub invitations
Goffi <goffi@goffi.org>
parents:
3461
diff
changeset
|
297 log.warning(f"Can't retrive node schema as {node!r} [{service}]: {e}") |
483bcfeb11c9
plugin misc list: register lists for pubsub invitations
Goffi <goffi@goffi.org>
parents:
3461
diff
changeset
|
298 else: |
483bcfeb11c9
plugin misc list: register lists for pubsub invitations
Goffi <goffi@goffi.org>
parents:
3461
diff
changeset
|
299 try: |
483bcfeb11c9
plugin misc list: register lists for pubsub invitations
Goffi <goffi@goffi.org>
parents:
3461
diff
changeset
|
300 field_type = schema[NS_TICKETS_TYPE] |
483bcfeb11c9
plugin misc list: register lists for pubsub invitations
Goffi <goffi@goffi.org>
parents:
3461
diff
changeset
|
301 except KeyError: |
483bcfeb11c9
plugin misc list: register lists for pubsub invitations
Goffi <goffi@goffi.org>
parents:
3461
diff
changeset
|
302 log.debug("no type found in list schema") |
483bcfeb11c9
plugin misc list: register lists for pubsub invitations
Goffi <goffi@goffi.org>
parents:
3461
diff
changeset
|
303 else: |
483bcfeb11c9
plugin misc list: register lists for pubsub invitations
Goffi <goffi@goffi.org>
parents:
3461
diff
changeset
|
304 list_elt = extra["element"] = domish.Element((APP_NS_TICKETS, "list")) |
483bcfeb11c9
plugin misc list: register lists for pubsub invitations
Goffi <goffi@goffi.org>
parents:
3461
diff
changeset
|
305 list_elt["type"] = field_type |
483bcfeb11c9
plugin misc list: register lists for pubsub invitations
Goffi <goffi@goffi.org>
parents:
3461
diff
changeset
|
306 |
3458 | 307 def _set(self, service, node, values, schema=None, item_id=None, extra='', |
308 profile_key=C.PROF_KEY_NONE): | |
309 client, service, node, schema, item_id, extra = self._s.prepareBridgeSet( | |
310 service, node, schema, item_id, extra, profile_key | |
311 ) | |
312 d = defer.ensureDeferred(self.set( | |
313 client, service, node, values, schema, item_id, extra, deserialise=True | |
314 )) | |
315 d.addCallback(lambda ret: ret or "") | |
316 return d | |
317 | |
3460 | 318 async def set( |
319 self, client, service, node, values, schema=None, item_id=None, extra=None, | |
320 deserialise=False, form_ns=APP_NS_TICKETS | |
321 ): | |
3458 | 322 """Publish a tickets |
323 | |
324 @param node(unicode, None): Pubsub node to use | |
325 None to use default tickets node | |
326 @param values(dict[key(unicode), [iterable[object]|object]]): values of the ticket | |
327 | |
328 if value is not iterable, it will be put in a list | |
329 'created' and 'updated' will be forced to current time: | |
330 - 'created' is set if item_id is None, i.e. if it's a new ticket | |
331 - 'updated' is set everytime | |
332 @param extra(dict, None): same as for [XEP-0060.sendItem] with additional keys: | |
333 - update(bool): if True, get previous item data to merge with current one | |
334 if True, item_id must be None | |
335 other arguments are same as for [self._s.sendDataFormItem] | |
336 @return (unicode): id of the created item | |
337 """ | |
338 if not node: | |
339 node = self.namespace | |
340 | |
341 if not item_id: | |
342 comments_service = await self._m.getCommentsService(client, service) | |
343 | |
344 # we need to use uuid for comments node, because we don't know item id in | |
345 # advance (we don't want to set it ourselves to let the server choose, so we | |
346 # can have a nicer id if serial ids is activated) | |
347 comments_node = self._m.getCommentsNode( | |
348 node + "_" + str(shortuuid.uuid()) | |
349 ) | |
350 options = { | |
351 self._p.OPT_ACCESS_MODEL: self._p.ACCESS_OPEN, | |
352 self._p.OPT_PERSIST_ITEMS: 1, | |
353 self._p.OPT_MAX_ITEMS: -1, | |
354 self._p.OPT_DELIVER_PAYLOADS: 1, | |
355 self._p.OPT_SEND_ITEM_SUBSCRIBE: 1, | |
356 self._p.OPT_PUBLISH_MODEL: self._p.ACCESS_OPEN, | |
357 } | |
358 await self._p.createNode(client, comments_service, comments_node, options) | |
359 values["comments_uri"] = uri.buildXMPPUri( | |
360 "pubsub", | |
361 subtype="microblog", | |
362 path=comments_service.full(), | |
363 node=comments_node, | |
364 ) | |
365 | |
366 return await self._s.set( | |
367 client, service, node, values, schema, item_id, extra, deserialise, form_ns | |
368 ) | |
3460 | 369 |
370 def _getTemplatesNames(self, language, profile): | |
371 client = self.host.getClient(profile) | |
372 return data_format.serialise(self.getTemplatesNames(client, language)) | |
373 | |
374 def getTemplatesNames(self, client, language: str) -> list: | |
375 """Retrieve well known list templates""" | |
376 | |
377 templates = [{"id": tpl_id, "name": d["name"], "icon": d["icon"]} | |
378 for tpl_id, d in TEMPLATES.items()] | |
379 return templates | |
380 | |
381 def _getTemplate(self, name, language, profile): | |
382 client = self.host.getClient(profile) | |
383 return data_format.serialise(self.getTemplate(client, name, language)) | |
384 | |
385 def getTemplate(self, client, name: str, language: str) -> dict: | |
386 """Retrieve a well known template""" | |
387 return TEMPLATES[name] | |
388 | |
389 def _createTemplate(self, template_id, name, access_model, profile): | |
390 client = self.host.getClient(profile) | |
391 d = defer.ensureDeferred(self.createTemplate( | |
392 client, template_id, name, access_model | |
393 )) | |
394 d.addCallback(lambda node_data: (node_data[0].full(), node_data[1])) | |
395 return d | |
396 | |
397 async def createTemplate( | |
398 self, client, template_id: str, name: str, access_model: str | |
399 ) -> Tuple[jid.JID, str]: | |
400 """Create a list from a template""" | |
401 name = name.strip() | |
402 if not name: | |
403 name = shortuuid.uuid() | |
404 template = TEMPLATES[template_id] | |
405 | |
406 fields = [ | |
407 data_form.Field(fieldType="hidden", var=NS_TICKETS_TYPE, value=template_id) | |
408 ] | |
409 for field_data in template['fields']: | |
410 field_type = field_data.get('type', 'text-single') | |
411 kwargs = { | |
412 "fieldType": field_type, | |
413 "var": field_data["name"], | |
414 "label": field_data.get('label'), | |
415 "value": field_data.get("value"), | |
416 } | |
417 if field_type == "xhtml": | |
418 kwargs.update({ | |
419 "fieldType": None, | |
420 "ext_type": "xml", | |
421 }) | |
422 if kwargs["value"] is None: | |
423 kwargs["value"] = domish.Element((C.NS_XHTML, "div")) | |
424 elif "options" in field_data: | |
425 kwargs["options"] = [ | |
426 data_form.Option(o["value"], o.get("label")) | |
427 for o in field_data["options"] | |
428 ] | |
429 field = data_form.Field(**kwargs) | |
430 fields.append(field) | |
431 | |
432 schema = data_form.Form( | |
433 "form", | |
434 formNamespace=APP_NS_TICKETS, | |
435 fields=fields | |
436 ).toElement() | |
437 | |
438 service = client.jid.userhostJID() | |
439 node = self._s.getSubmittedNS(f"{APP_NS_TICKETS}_{name}") | |
440 options = { | |
441 self._p.OPT_ACCESS_MODEL: access_model | |
442 } | |
443 await self._p.createNode(client, service, node, options) | |
444 await self._s.setSchema(client, service, node, schema) | |
445 list_elt = domish.Element((APP_NS_TICKETS, "list")) | |
446 list_elt["type"] = template_id | |
447 try: | |
448 await self.host.plugins['LIST_INTEREST'].registerPubsub( | |
449 client, APP_NS_TICKETS, service, node, creator=True, | |
450 name=name, element=list_elt) | |
451 except Exception as e: | |
452 log.warning(f"Can't add list to interests: {e}") | |
453 return service, node |