Mercurial > libervia-backend
annotate sat/plugins/plugin_comp_file_sharing_management.py @ 3502:6132d363f0e9
plugin XEP-0277: user friendly ID:
when publishing a blog post without `id` specified, instead of using uuid, a user friendly
ID based on title or content is used. This allow to have better URLs in web frontend.
There is a (very low) risk of name collision if several articles with the same title or
content are published on the same pubsub node, user friendly ID can be deactivated by
using `user_friendly_id=False` in blog data to avoid that.
author | Goffi <goffi@goffi.org> |
---|---|
date | Fri, 16 Apr 2021 18:33:00 +0200 |
parents | be6d91572633 |
children | 698579bedd6f |
rev | line source |
---|---|
3028 | 1 #!/usr/bin/env python3 |
3137 | 2 |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
3 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
4 # SAT plugin to detect language (experimental) |
3479 | 5 # Copyright (C) 2009-2021 Jérôme Poisson (goffi@goffi.org) |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
6 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
7 # This program is free software: you can redistribute it and/or modify |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
8 # it under the terms of the GNU Affero General Public License as published by |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
9 # the Free Software Foundation, either version 3 of the License, or |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
10 # (at your option) any later version. |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
11 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
12 # This program is distributed in the hope that it will be useful, |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
15 # GNU Affero General Public License for more details. |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
16 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
17 # You should have received a copy of the GNU Affero General Public License |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
18 # along with this program. If not, see <http://www.gnu.org/licenses/>. |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
19 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
20 import os.path |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
21 from functools import partial |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
22 from sat.core.i18n import _, D_ |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
23 from sat.core import exceptions |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
24 from sat.core.constants import Const as C |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
25 from sat.core.log import getLogger |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
26 from wokkel import data_form |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
27 from twisted.internet import defer |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
28 from twisted.words.protocols.jabber import jid |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
29 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
30 log = getLogger(__name__) |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
31 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
32 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
33 PLUGIN_INFO = { |
3028 | 34 C.PI_NAME: "File Sharing Management", |
35 C.PI_IMPORT_NAME: "FILE_SHARING_MANAGEMENT", | |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
36 C.PI_MODES: [C.PLUG_MODE_COMPONENT], |
3028 | 37 C.PI_TYPE: "EXP", |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
38 C.PI_PROTOCOLS: [], |
3028 | 39 C.PI_DEPENDENCIES: ["XEP-0050", "XEP-0264"], |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
40 C.PI_RECOMMENDATIONS: [], |
3028 | 41 C.PI_MAIN: "FileSharingManagement", |
42 C.PI_HANDLER: "no", | |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
43 C.PI_DESCRIPTION: _( |
3028 | 44 "Experimental handling of file management for file sharing. This plugins allows " |
45 "to change permissions of stored files/directories or remove them." | |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
46 ), |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
47 } |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
48 |
3028 | 49 NS_FILE_MANAGEMENT = "https://salut-a-toi.org/protocol/file-management:0" |
50 NS_FILE_MANAGEMENT_PERM = "https://salut-a-toi.org/protocol/file-management:0#perm" | |
51 NS_FILE_MANAGEMENT_DELETE = "https://salut-a-toi.org/protocol/file-management:0#delete" | |
52 NS_FILE_MANAGEMENT_THUMB = "https://salut-a-toi.org/protocol/file-management:0#thumb" | |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
53 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
54 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
55 class WorkflowError(Exception): |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
56 """Raised when workflow can't be completed""" |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
57 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
58 def __init__(self, err_args): |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
59 """ |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
60 @param err_args(tuple): arguments to return to finish the command workflow |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
61 """ |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
62 Exception.__init__(self) |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
63 self.err_args = err_args |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
64 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
65 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
66 class FileSharingManagement(object): |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
67 # This is a temporary way (Q&D) to handle stored files, a better way (using pubsub |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
68 # syntax?) should be elaborated and proposed as a standard. |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
69 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
70 def __init__(self, host): |
3028 | 71 log.info(_("File Sharing Management plugin initialization")) |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
72 self.host = host |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
73 self._c = host.plugins["XEP-0050"] |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
74 self._t = host.plugins["XEP-0264"] |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
75 self.files_path = host.getLocalPath(None, C.FILES_DIR, profile=False) |
3305
04a7d77ed86f
plugin file sharing management: added a fileSharingDelete method
Goffi <goffi@goffi.org>
parents:
3298
diff
changeset
|
76 host.bridge.addMethod( |
04a7d77ed86f
plugin file sharing management: added a fileSharingDelete method
Goffi <goffi@goffi.org>
parents:
3298
diff
changeset
|
77 "fileSharingDelete", |
04a7d77ed86f
plugin file sharing management: added a fileSharingDelete method
Goffi <goffi@goffi.org>
parents:
3298
diff
changeset
|
78 ".plugin", |
04a7d77ed86f
plugin file sharing management: added a fileSharingDelete method
Goffi <goffi@goffi.org>
parents:
3298
diff
changeset
|
79 in_sign="ssss", |
04a7d77ed86f
plugin file sharing management: added a fileSharingDelete method
Goffi <goffi@goffi.org>
parents:
3298
diff
changeset
|
80 out_sign="", |
04a7d77ed86f
plugin file sharing management: added a fileSharingDelete method
Goffi <goffi@goffi.org>
parents:
3298
diff
changeset
|
81 method=self._delete, |
04a7d77ed86f
plugin file sharing management: added a fileSharingDelete method
Goffi <goffi@goffi.org>
parents:
3298
diff
changeset
|
82 async_=True, |
04a7d77ed86f
plugin file sharing management: added a fileSharingDelete method
Goffi <goffi@goffi.org>
parents:
3298
diff
changeset
|
83 ) |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
84 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
85 def profileConnected(self, client): |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
86 self._c.addAdHocCommand( |
3028 | 87 client, self._onChangeFile, "Change Permissions of File(s)", |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
88 node=NS_FILE_MANAGEMENT_PERM, |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
89 allowed_magics=C.ENTITY_ALL, |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
90 ) |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
91 self._c.addAdHocCommand( |
3028 | 92 client, self._onDeleteFile, "Delete File(s)", |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
93 node=NS_FILE_MANAGEMENT_DELETE, |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
94 allowed_magics=C.ENTITY_ALL, |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
95 ) |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
96 self._c.addAdHocCommand( |
3028 | 97 client, self._onGenThumbnails, "Generate Thumbnails", |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
98 node=NS_FILE_MANAGEMENT_THUMB, |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
99 allowed_magics=C.ENTITY_ALL, |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
100 ) |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
101 |
3305
04a7d77ed86f
plugin file sharing management: added a fileSharingDelete method
Goffi <goffi@goffi.org>
parents:
3298
diff
changeset
|
102 def _delete(self, service_jid_s, path, namespace, profile): |
04a7d77ed86f
plugin file sharing management: added a fileSharingDelete method
Goffi <goffi@goffi.org>
parents:
3298
diff
changeset
|
103 client = self.host.getClient(profile) |
04a7d77ed86f
plugin file sharing management: added a fileSharingDelete method
Goffi <goffi@goffi.org>
parents:
3298
diff
changeset
|
104 service_jid = jid.JID(service_jid_s) if service_jid_s else None |
04a7d77ed86f
plugin file sharing management: added a fileSharingDelete method
Goffi <goffi@goffi.org>
parents:
3298
diff
changeset
|
105 return defer.ensureDeferred(self._c.sequence( |
04a7d77ed86f
plugin file sharing management: added a fileSharingDelete method
Goffi <goffi@goffi.org>
parents:
3298
diff
changeset
|
106 client, |
04a7d77ed86f
plugin file sharing management: added a fileSharingDelete method
Goffi <goffi@goffi.org>
parents:
3298
diff
changeset
|
107 [{"path": path, "namespace": namespace}, {"confirm": True}], |
04a7d77ed86f
plugin file sharing management: added a fileSharingDelete method
Goffi <goffi@goffi.org>
parents:
3298
diff
changeset
|
108 NS_FILE_MANAGEMENT_DELETE, |
04a7d77ed86f
plugin file sharing management: added a fileSharingDelete method
Goffi <goffi@goffi.org>
parents:
3298
diff
changeset
|
109 service_jid, |
04a7d77ed86f
plugin file sharing management: added a fileSharingDelete method
Goffi <goffi@goffi.org>
parents:
3298
diff
changeset
|
110 )) |
04a7d77ed86f
plugin file sharing management: added a fileSharingDelete method
Goffi <goffi@goffi.org>
parents:
3298
diff
changeset
|
111 |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
112 def _err(self, reason): |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
113 """Helper method to get argument to return for error |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
114 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
115 workflow will be interrupted with an error note |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
116 @param reason(unicode): reason of the error |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
117 @return (tuple): arguments to use in defer.returnValue |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
118 """ |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
119 status = self._c.STATUS.COMPLETED |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
120 payload = None |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
121 note = (self._c.NOTE.ERROR, reason) |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
122 return payload, status, None, note |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
123 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
124 def _getRootArgs(self): |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
125 """Create the form to select the file to use |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
126 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
127 @return (tuple): arguments to use in defer.returnValue |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
128 """ |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
129 status = self._c.STATUS.EXECUTING |
3028 | 130 form = data_form.Form("form", title="File Management", |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
131 formNamespace=NS_FILE_MANAGEMENT) |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
132 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
133 field = data_form.Field( |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
134 "text-single", "path", required=True |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
135 ) |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
136 form.addField(field) |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
137 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
138 field = data_form.Field( |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
139 "text-single", "namespace", required=False |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
140 ) |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
141 form.addField(field) |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
142 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
143 payload = form.toElement() |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
144 return payload, status, None, None |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
145 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
146 @defer.inlineCallbacks |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
147 def _getFileData(self, client, session_data, command_form): |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
148 """Retrieve field requested in root form |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
149 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
150 "found_file" will also be set in session_data |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
151 @param command_form(data_form.Form): response to root form |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
152 @return (D(dict)): found file data |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
153 @raise WorkflowError: something is wrong |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
154 """ |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
155 fields = command_form.fields |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
156 try: |
3028 | 157 path = fields['path'].value.strip() |
158 namespace = fields['namespace'].value or None | |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
159 except KeyError: |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
160 self._c.adHocError(self._c.ERROR.BAD_PAYLOAD) |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
161 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
162 if not path: |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
163 self._c.adHocError(self._c.ERROR.BAD_PAYLOAD) |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
164 |
3028 | 165 requestor = session_data['requestor'] |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
166 requestor_bare = requestor.userhostJID() |
3028 | 167 path = path.rstrip('/') |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
168 parent_path, basename = os.path.split(path) |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
169 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
170 # TODO: if parent_path and basename are empty, we ask for root directory |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
171 # this must be managed |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
172 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
173 try: |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
174 found_files = yield self.host.memory.getFiles( |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
175 client, requestor_bare, path=parent_path, name=basename, |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
176 namespace=namespace) |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
177 found_file = found_files[0] |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
178 except (exceptions.NotFound, IndexError): |
3028 | 179 raise WorkflowError(self._err(_("file not found"))) |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
180 except exceptions.PermissionError: |
3028 | 181 raise WorkflowError(self._err(_("forbidden"))) |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
182 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
183 if found_file['owner'] != requestor_bare: |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
184 # only owner can manage files |
3028 | 185 log.warning(_("Only owner can manage files")) |
186 raise WorkflowError(self._err(_("forbidden"))) | |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
187 |
3028 | 188 session_data['found_file'] = found_file |
189 session_data['namespace'] = namespace | |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
190 defer.returnValue(found_file) |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
191 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
192 def _updateReadPermission(self, access, allowed_jids): |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
193 if not allowed_jids: |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
194 if C.ACCESS_PERM_READ in access: |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
195 del access[C.ACCESS_PERM_READ] |
3028 | 196 elif allowed_jids == 'PUBLIC': |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
197 access[C.ACCESS_PERM_READ] = { |
3028 | 198 "type": C.ACCESS_TYPE_PUBLIC |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
199 } |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
200 else: |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
201 access[C.ACCESS_PERM_READ] = { |
3028 | 202 "type": C.ACCESS_TYPE_WHITELIST, |
203 "jids": [j.full() for j in allowed_jids] | |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
204 } |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
205 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
206 @defer.inlineCallbacks |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
207 def _updateDir(self, client, requestor, namespace, file_data, allowed_jids): |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
208 """Recursively update permission of a directory and all subdirectories |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
209 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
210 @param file_data(dict): metadata of the file |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
211 @param allowed_jids(list[jid.JID]): list of entities allowed to read the file |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
212 """ |
3028 | 213 assert file_data['type'] == C.FILE_TYPE_DIRECTORY |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
214 files_data = yield self.host.memory.getFiles( |
3028 | 215 client, requestor, parent=file_data['id'], namespace=namespace) |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
216 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
217 for file_data in files_data: |
3028 | 218 if not file_data['access'].get(C.ACCESS_PERM_READ, {}): |
219 log.debug("setting {perm} read permission for {name}".format( | |
220 perm=allowed_jids, name=file_data['name'])) | |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
221 yield self.host.memory.fileUpdate( |
3028 | 222 file_data['id'], 'access', |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
223 partial(self._updateReadPermission, allowed_jids=allowed_jids)) |
3028 | 224 if file_data['type'] == C.FILE_TYPE_DIRECTORY: |
225 yield self._updateDir(client, requestor, namespace, file_data, 'PUBLIC') | |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
226 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
227 @defer.inlineCallbacks |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
228 def _onChangeFile(self, client, command_elt, session_data, action, node): |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
229 try: |
3028 | 230 x_elt = next(command_elt.elements(data_form.NS_X_DATA, "x")) |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
231 command_form = data_form.Form.fromElement(x_elt) |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
232 except StopIteration: |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
233 command_form = None |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
234 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
235 found_file = session_data.get('found_file') |
3028 | 236 requestor = session_data['requestor'] |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
237 requestor_bare = requestor.userhostJID() |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
238 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
239 if command_form is None or len(command_form.fields) == 0: |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
240 # root request |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
241 defer.returnValue(self._getRootArgs()) |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
242 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
243 elif found_file is None: |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
244 # file selected, we retrieve it and ask for permissions |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
245 try: |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
246 found_file = yield self._getFileData(client, session_data, command_form) |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
247 except WorkflowError as e: |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
248 defer.returnValue(e.err_args) |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
249 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
250 # management request |
3028 | 251 if found_file['type'] == C.FILE_TYPE_DIRECTORY: |
252 instructions = D_("Please select permissions for this directory") | |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
253 else: |
3028 | 254 instructions = D_("Please select permissions for this file") |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
255 |
3028 | 256 form = data_form.Form("form", title="File Management", |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
257 instructions=[instructions], |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
258 formNamespace=NS_FILE_MANAGEMENT) |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
259 field = data_form.Field( |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
260 "text-multi", "read_allowed", required=False, |
3028 | 261 desc='list of jids allowed to read this file (beside yourself), or ' |
262 '"PUBLIC" to let a public access' | |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
263 ) |
3028 | 264 read_access = found_file["access"].get(C.ACCESS_PERM_READ, {}) |
265 access_type = read_access.get('type', C.ACCESS_TYPE_WHITELIST) | |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
266 if access_type == C.ACCESS_TYPE_PUBLIC: |
3028 | 267 field.values = ['PUBLIC'] |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
268 else: |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
269 field.values = read_access.get('jids', []) |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
270 form.addField(field) |
3028 | 271 if found_file['type'] == C.FILE_TYPE_DIRECTORY: |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
272 field = data_form.Field( |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
273 "boolean", "recursive", value=False, required=False, |
3028 | 274 desc="Files under it will be made public to follow this dir " |
275 "permission (only if they don't have already a permission set)." | |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
276 ) |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
277 form.addField(field) |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
278 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
279 status = self._c.STATUS.EXECUTING |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
280 payload = form.toElement() |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
281 defer.returnValue((payload, status, None, None)) |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
282 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
283 else: |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
284 # final phase, we'll do permission change here |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
285 try: |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
286 read_allowed = command_form.fields['read_allowed'] |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
287 except KeyError: |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
288 self._c.adHocError(self._c.ERROR.BAD_PAYLOAD) |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
289 |
3028 | 290 if read_allowed.value == 'PUBLIC': |
291 allowed_jids = 'PUBLIC' | |
292 elif read_allowed.value.strip() == '': | |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
293 allowed_jids = None |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
294 else: |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
295 try: |
2934
0bafdbda7f5f
plugin file sharing management: filter out empty values in allowed_jids
Goffi <goffi@goffi.org>
parents:
2929
diff
changeset
|
296 allowed_jids = [jid.JID(v.strip()) for v in read_allowed.values |
0bafdbda7f5f
plugin file sharing management: filter out empty values in allowed_jids
Goffi <goffi@goffi.org>
parents:
2929
diff
changeset
|
297 if v.strip()] |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
298 except RuntimeError as e: |
3028 | 299 log.warning(_("Can't use read_allowed values: {reason}").format( |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
300 reason=e)) |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
301 self._c.adHocError(self._c.ERROR.BAD_PAYLOAD) |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
302 |
3028 | 303 if found_file['type'] == C.FILE_TYPE_FILE: |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
304 yield self.host.memory.fileUpdate( |
3028 | 305 found_file['id'], 'access', |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
306 partial(self._updateReadPermission, allowed_jids=allowed_jids)) |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
307 else: |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
308 try: |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
309 recursive = command_form.fields['recursive'] |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
310 except KeyError: |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
311 self._c.adHocError(self._c.ERROR.BAD_PAYLOAD) |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
312 yield self.host.memory.fileUpdate( |
3028 | 313 found_file['id'], 'access', |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
314 partial(self._updateReadPermission, allowed_jids=allowed_jids)) |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
315 if recursive: |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
316 # we set all file under the directory as public (if they haven't |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
317 # already a permission set), so allowed entities of root directory |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
318 # can read them. |
3028 | 319 namespace = session_data['namespace'] |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
320 yield self._updateDir( |
3028 | 321 client, requestor_bare, namespace, found_file, 'PUBLIC') |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
322 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
323 # job done, we can end the session |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
324 status = self._c.STATUS.COMPLETED |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
325 payload = None |
3028 | 326 note = (self._c.NOTE.INFO, _("management session done")) |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
327 defer.returnValue((payload, status, None, note)) |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
328 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
329 @defer.inlineCallbacks |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
330 def _onDeleteFile(self, client, command_elt, session_data, action, node): |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
331 try: |
3028 | 332 x_elt = next(command_elt.elements(data_form.NS_X_DATA, "x")) |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
333 command_form = data_form.Form.fromElement(x_elt) |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
334 except StopIteration: |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
335 command_form = None |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
336 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
337 found_file = session_data.get('found_file') |
3028 | 338 requestor = session_data['requestor'] |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
339 requestor_bare = requestor.userhostJID() |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
340 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
341 if command_form is None or len(command_form.fields) == 0: |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
342 # root request |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
343 defer.returnValue(self._getRootArgs()) |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
344 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
345 elif found_file is None: |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
346 # file selected, we need confirmation before actually deleting |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
347 try: |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
348 found_file = yield self._getFileData(client, session_data, command_form) |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
349 except WorkflowError as e: |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
350 defer.returnValue(e.err_args) |
3028 | 351 if found_file['type'] == C.FILE_TYPE_DIRECTORY: |
352 msg = D_("Are you sure to delete directory {name} and all files and " | |
353 "directories under it?").format(name=found_file['name']) | |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
354 else: |
3028 | 355 msg = D_("Are you sure to delete file {name}?" |
356 .format(name=found_file['name'])) | |
357 form = data_form.Form("form", title="File Management", | |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
358 instructions = [msg], |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
359 formNamespace=NS_FILE_MANAGEMENT) |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
360 field = data_form.Field( |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
361 "boolean", "confirm", value=False, required=True, |
3028 | 362 desc="check this box to confirm" |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
363 ) |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
364 form.addField(field) |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
365 status = self._c.STATUS.EXECUTING |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
366 payload = form.toElement() |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
367 defer.returnValue((payload, status, None, None)) |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
368 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
369 else: |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
370 # final phase, we'll do deletion here |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
371 try: |
3298
d0e8b0a3ef9c
comp file sharing management: fixed confirmation check
Goffi <goffi@goffi.org>
parents:
3288
diff
changeset
|
372 confirmed = C.bool(command_form.fields['confirm'].value) |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
373 except KeyError: |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
374 self._c.adHocError(self._c.ERROR.BAD_PAYLOAD) |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
375 if not confirmed: |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
376 note = None |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
377 else: |
3028 | 378 recursive = found_file['type'] == C.FILE_TYPE_DIRECTORY |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
379 yield self.host.memory.fileDelete( |
3028 | 380 client, requestor_bare, found_file['id'], recursive) |
381 note = (self._c.NOTE.INFO, _("file deleted")) | |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
382 status = self._c.STATUS.COMPLETED |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
383 payload = None |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
384 defer.returnValue((payload, status, None, note)) |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
385 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
386 def _updateThumbs(self, extra, thumbnails): |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
387 extra[C.KEY_THUMBNAILS] = thumbnails |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
388 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
389 @defer.inlineCallbacks |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
390 def _genThumbs(self, client, requestor, namespace, file_data): |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
391 """Recursively generate thumbnails |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
392 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
393 @param file_data(dict): metadata of the file |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
394 """ |
3028 | 395 if file_data['type'] == C.FILE_TYPE_DIRECTORY: |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
396 sub_files_data = yield self.host.memory.getFiles( |
3028 | 397 client, requestor, parent=file_data['id'], namespace=namespace) |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
398 for sub_file_data in sub_files_data: |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
399 yield self._genThumbs(client, requestor, namespace, sub_file_data) |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
400 |
3028 | 401 elif file_data['type'] == C.FILE_TYPE_FILE: |
3288
780fb8dd07ef
core (memory/sqlite): new database schema (v9):
Goffi <goffi@goffi.org>
parents:
3137
diff
changeset
|
402 media_type = file_data['media_type'] |
3028 | 403 file_path = os.path.join(self.files_path, file_data['file_hash']) |
3288
780fb8dd07ef
core (memory/sqlite): new database schema (v9):
Goffi <goffi@goffi.org>
parents:
3137
diff
changeset
|
404 if media_type == 'image': |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
405 thumbnails = [] |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
406 |
3329
15612c0fb421
plugin XEP-0264: updated size to get values closest to standard one:
Goffi <goffi@goffi.org>
parents:
3305
diff
changeset
|
407 for max_thumb_size in self._t.SIZES: |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
408 try: |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
409 thumb_size, thumb_id = yield self._t.generateThumbnail( |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
410 file_path, |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
411 max_thumb_size, |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
412 # we keep thumbnails for 6 months |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
413 60 * 60 * 24 * 31 * 6, |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
414 ) |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
415 except Exception as e: |
3028 | 416 log.warning(_("Can't create thumbnail: {reason}") |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
417 .format(reason=e)) |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
418 break |
3028 | 419 thumbnails.append({"id": thumb_id, "size": thumb_size}) |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
420 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
421 yield self.host.memory.fileUpdate( |
3028 | 422 file_data['id'], 'extra', |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
423 partial(self._updateThumbs, thumbnails=thumbnails)) |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
424 |
3028 | 425 log.info("thumbnails for [{file_name}] generated" |
426 .format(file_name=file_data['name'])) | |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
427 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
428 else: |
3028 | 429 log.warning("unmanaged file type: {type_}".format(type_=file_data['type'])) |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
430 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
431 @defer.inlineCallbacks |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
432 def _onGenThumbnails(self, client, command_elt, session_data, action, node): |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
433 try: |
3028 | 434 x_elt = next(command_elt.elements(data_form.NS_X_DATA, "x")) |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
435 command_form = data_form.Form.fromElement(x_elt) |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
436 except StopIteration: |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
437 command_form = None |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
438 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
439 found_file = session_data.get('found_file') |
3028 | 440 requestor = session_data['requestor'] |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
441 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
442 if command_form is None or len(command_form.fields) == 0: |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
443 # root request |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
444 defer.returnValue(self._getRootArgs()) |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
445 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
446 elif found_file is None: |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
447 # file selected, we retrieve it and ask for permissions |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
448 try: |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
449 found_file = yield self._getFileData(client, session_data, command_form) |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
450 except WorkflowError as e: |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
451 defer.returnValue(e.err_args) |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
452 |
3028 | 453 log.info("Generating thumbnails as requested") |
454 yield self._genThumbs(client, requestor, found_file['namespace'], found_file) | |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
455 |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
456 # job done, we can end the session |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
457 status = self._c.STATUS.COMPLETED |
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
458 payload = None |
3028 | 459 note = (self._c.NOTE.INFO, _("thumbnails generated")) |
2929
e0429ff7f6b6
plugin comp file sharing: file sharing management first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
460 defer.returnValue((payload, status, None, note)) |