libervia-backend: sat/plugins/plugin_comp_file

annotate sat/plugins/plugin_comp_file_sharing.py @ 2906:7dbdbd132649

template (i18n): activate ext.i18n.trimmed policy, to have clean translation strings. Set minimal jinja2 version to 2.10

author	Goffi <goffi@goffi.org>
date	Sun, 14 Apr 2019 08:21:51 +0200
parents	003b8b4b56a7
children	e0429ff7f6b6

rev	line source
2504 67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	1 #!/usr/bin/env python2
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	2 # -- coding: utf-8 --
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	3
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	4 # SAT plugin for parrot mode (experimental)
2771 003b8b4b56a7 date update Goffi <goffi@goffi.org> parents: 2765 diff changeset	5 # Copyright (C) 2009-2019 Jérôme Poisson (goffi@goffi.org)
2504 67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	6
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	7 # This program is free software: you can redistribute it and/or modify
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	8 # it under the terms of the GNU Affero General Public License as published by
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	9 # the Free Software Foundation, either version 3 of the License, or
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	10 # (at your option) any later version.
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	11
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	12 # This program is distributed in the hope that it will be useful,
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	15 # GNU Affero General Public License for more details.
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	16
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	17 # You should have received a copy of the GNU Affero General Public License
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	19
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	20 from sat.core.i18n import _
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	21 from sat.core.constants import Const as C
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	22 from sat.core import exceptions
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	23 from sat.core.log import getLogger
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	24
2504 67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	25 log = getLogger(__name__)
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	26 from sat.tools.common import regex
2528 65e278997715 component file sharing: comments metadata: Goffi <goffi@goffi.org> parents: 2527 diff changeset	27 from sat.tools.common import uri
2504 67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	28 from sat.tools import stream
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	29 from twisted.internet import defer
2527 a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	30 from twisted.words.protocols.jabber import error
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	31 from wokkel import pubsub
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	32 from wokkel import generic
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	33 from functools import partial
2504 67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	34 import os
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	35 import os.path
2514 4440ea7047bd file sharing component: thumbnails integration first draft: Goffi <goffi@goffi.org> parents: 2504 diff changeset	36 import mimetypes
2504 67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	37
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	38
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	39 PLUGIN_INFO = {
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	40 C.PI_NAME: "File sharing component",
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	41 C.PI_IMPORT_NAME: "file_sharing",
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	42 C.PI_MODES: [C.PLUG_MODE_COMPONENT],
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	43 C.PI_TYPE: C.PLUG_TYPE_ENTRY_POINT,
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	44 C.PI_PROTOCOLS: [],
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	45 C.PI_DEPENDENCIES: [
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	46 "FILE",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	47 "XEP-0231",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	48 "XEP-0234",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	49 "XEP-0260",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	50 "XEP-0261",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	51 "XEP-0264",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	52 "XEP-0329",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	53 ],
2504 67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	54 C.PI_RECOMMENDATIONS: [],
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	55 C.PI_MAIN: "FileSharing",
2527 a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	56 C.PI_HANDLER: C.BOOL_TRUE,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	57 C.PI_DESCRIPTION: _(u"""Component hosting and sharing files"""),
2504 67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	58 }
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	59
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	60 HASH_ALGO = u"sha-256"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	61 NS_COMMENTS = "org.salut-a-toi.comments"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	62 COMMENT_NODE_PREFIX = "org.salut-a-toi.file_comments/"
2504 67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	63
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	64
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	65 class FileSharing(object):
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	66 def __init__(self, host):
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	67 log.info(_(u"File Sharing initialization"))
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	68 self.host = host
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	69 self._f = host.plugins["FILE"]
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	70 self._jf = host.plugins["XEP-0234"]
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	71 self._h = host.plugins["XEP-0300"]
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	72 self._t = host.plugins["XEP-0264"]
2504 67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	73 host.trigger.add("FILE_getDestDir", self._getDestDirTrigger)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	74 host.trigger.add(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	75 "XEP-0234_fileSendingRequest", self._fileSendingRequestTrigger, priority=1000
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	76 )
2528 65e278997715 component file sharing: comments metadata: Goffi <goffi@goffi.org> parents: 2527 diff changeset	77 host.trigger.add("XEP-0234_buildFileElement", self._addFileComments)
65e278997715 component file sharing: comments metadata: Goffi <goffi@goffi.org> parents: 2527 diff changeset	78 host.trigger.add("XEP-0234_parseFileElement", self._getFileComments)
65e278997715 component file sharing: comments metadata: Goffi <goffi@goffi.org> parents: 2527 diff changeset	79 host.trigger.add("XEP-0329_compGetFilesFromNode", self._addCommentsData)
2504 67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	80 self.files_path = host.getLocalPath(None, C.FILES_DIR, profile=False)
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	81
2527 a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	82 def getHandler(self, client):
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	83 return Comments_handler(self)
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	84
2504 67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	85 def profileConnected(self, client):
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	86 path = client.file_tmp_dir = os.path.join(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	87 self.host.memory.getConfig("", "local_dir"),
2504 67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	88 C.FILES_TMP_DIR,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	89 regex.pathEscape(client.profile),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	90 )
2504 67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	91 if not os.path.exists(path):
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	92 os.makedirs(path)
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	93
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	94 @defer.inlineCallbacks
2765 378188abe941 misc: replaced all "dummy" by the more conventional and readable "__" ("_" being used for gettext) Goffi <goffi@goffi.org> parents: 2624 diff changeset	95 def _fileTransferedCb(self, __, client, peer_jid, file_data, file_path):
2528 65e278997715 component file sharing: comments metadata: Goffi <goffi@goffi.org> parents: 2527 diff changeset	96 """post file reception tasks
65e278997715 component file sharing: comments metadata: Goffi <goffi@goffi.org> parents: 2527 diff changeset	97
65e278997715 component file sharing: comments metadata: Goffi <goffi@goffi.org> parents: 2527 diff changeset	98 on file is received, this method create hash/thumbnails if necessary
65e278997715 component file sharing: comments metadata: Goffi <goffi@goffi.org> parents: 2527 diff changeset	99 move the file to the right location, and create metadata entry in database
65e278997715 component file sharing: comments metadata: Goffi <goffi@goffi.org> parents: 2527 diff changeset	100 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	101 name = file_data[u"name"]
2514 4440ea7047bd file sharing component: thumbnails integration first draft: Goffi <goffi@goffi.org> parents: 2504 diff changeset	102 extra = {}
4440ea7047bd file sharing component: thumbnails integration first draft: Goffi <goffi@goffi.org> parents: 2504 diff changeset	103
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	104 if file_data[u"hash_algo"] == HASH_ALGO:
2504 67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	105 log.debug(_(u"Reusing already generated hash"))
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	106 file_hash = file_data[u"hash_hasher"].hexdigest()
2504 67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	107 else:
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	108 hasher = self._h.getHasher(HASH_ALGO)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	109 with open("file_path") as f:
2504 67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	110 file_hash = yield self._h.calculateHash(f, hasher)
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	111 final_path = os.path.join(self.files_path, file_hash)
2514 4440ea7047bd file sharing component: thumbnails integration first draft: Goffi <goffi@goffi.org> parents: 2504 diff changeset	112
2504 67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	113 if os.path.isfile(final_path):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	114 log.debug(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	115 u"file [{file_hash}] already exists, we can remove temporary one".format(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	116 file_hash=file_hash
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	117 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	118 )
2504 67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	119 os.unlink(file_path)
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	120 else:
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	121 os.rename(file_path, final_path)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	122 log.debug(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	123 u"file [{file_hash}] moved to {files_path}".format(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	124 file_hash=file_hash, files_path=self.files_path
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	125 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	126 )
2514 4440ea7047bd file sharing component: thumbnails integration first draft: Goffi <goffi@goffi.org> parents: 2504 diff changeset	127
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	128 mime_type = file_data.get(u"mime_type")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	129 if not mime_type or mime_type == u"application/octet-stream":
2514 4440ea7047bd file sharing component: thumbnails integration first draft: Goffi <goffi@goffi.org> parents: 2504 diff changeset	130 mime_type = mimetypes.guess_type(name)[0]
4440ea7047bd file sharing component: thumbnails integration first draft: Goffi <goffi@goffi.org> parents: 2504 diff changeset	131
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	132 if mime_type is not None and mime_type.startswith(u"image"):
2514 4440ea7047bd file sharing component: thumbnails integration first draft: Goffi <goffi@goffi.org> parents: 2504 diff changeset	133 thumbnails = extra.setdefault(C.KEY_THUMBNAILS, [])
4440ea7047bd file sharing component: thumbnails integration first draft: Goffi <goffi@goffi.org> parents: 2504 diff changeset	134 for max_thumb_size in (self._t.SIZE_SMALL, self._t.SIZE_MEDIUM):
4440ea7047bd file sharing component: thumbnails integration first draft: Goffi <goffi@goffi.org> parents: 2504 diff changeset	135 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	136 thumb_size, thumb_id = yield self._t.generateThumbnail(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	137 final_path,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	138 max_thumb_size,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	139 # we keep thumbnails for 6 months
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	140 60 * 60 * 24 * 31 * 6,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	141 )
2514 4440ea7047bd file sharing component: thumbnails integration first draft: Goffi <goffi@goffi.org> parents: 2504 diff changeset	142 except Exception as e:
4440ea7047bd file sharing component: thumbnails integration first draft: Goffi <goffi@goffi.org> parents: 2504 diff changeset	143 log.warning(_(u"Can't create thumbnail: {reason}").format(reason=e))
4440ea7047bd file sharing component: thumbnails integration first draft: Goffi <goffi@goffi.org> parents: 2504 diff changeset	144 break
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	145 thumbnails.append({u"id": thumb_id, u"size": thumb_size})
2514 4440ea7047bd file sharing component: thumbnails integration first draft: Goffi <goffi@goffi.org> parents: 2504 diff changeset	146
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	147 self.host.memory.setFile(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	148 client,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	149 name=name,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	150 version=u"",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	151 file_hash=file_hash,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	152 hash_algo=HASH_ALGO,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	153 size=file_data[u"size"],
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	154 path=file_data.get(u"path"),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	155 namespace=file_data.get(u"namespace"),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	156 mime_type=mime_type,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	157 owner=peer_jid,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	158 extra=extra,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	159 )
2504 67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	160
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	161 def _getDestDirTrigger(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	162 self, client, peer_jid, transfer_data, file_data, stream_object
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	163 ):
2528 65e278997715 component file sharing: comments metadata: Goffi <goffi@goffi.org> parents: 2527 diff changeset	164 """This trigger accept file sending request, and store file locally"""
2504 67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	165 if not client.is_component:
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	166 return True, None
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	167 assert stream_object
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	168 assert "stream_object" not in transfer_data
2514 4440ea7047bd file sharing component: thumbnails integration first draft: Goffi <goffi@goffi.org> parents: 2504 diff changeset	169 assert C.KEY_PROGRESS_ID in file_data
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	170 filename = file_data["name"]
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	171 assert filename and not "/" in filename
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	172 file_tmp_dir = self.host.getLocalPath(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	173 client, C.FILES_TMP_DIR, peer_jid.userhost(), component=True, profile=False
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	174 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	175 file_tmp_path = file_data["file_path"] = os.path.join(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	176 file_tmp_dir, file_data["name"]
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	177 )
2504 67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	178
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	179 transfer_data["finished_d"].addCallback(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	180 self._fileTransferedCb, client, peer_jid, file_data, file_tmp_path
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	181 )
2504 67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	182
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	183 self._f.openFileWrite(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	184 client, file_tmp_path, transfer_data, file_data, stream_object
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	185 )
2504 67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	186 return False, defer.succeed(True)
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	187
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	188 @defer.inlineCallbacks
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	189 def _retrieveFiles(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	190 self, client, session, content_data, content_name, file_data, file_elt
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	191 ):
2528 65e278997715 component file sharing: comments metadata: Goffi <goffi@goffi.org> parents: 2527 diff changeset	192 """This method retrieve a file on request, and send if after checking permissions"""
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	193 peer_jid = session[u"peer_jid"]
2504 67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	194 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	195 found_files = yield self.host.memory.getFiles(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	196 client,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	197 peer_jid=peer_jid,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	198 name=file_data.get(u"name"),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	199 file_hash=file_data.get(u"file_hash"),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	200 hash_algo=file_data.get(u"hash_algo"),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	201 path=file_data.get(u"path"),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	202 namespace=file_data.get(u"namespace"),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	203 )
2504 67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	204 except exceptions.NotFound:
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	205 found_files = None
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	206 except exceptions.PermissionError:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	207 log.warning(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	208 _(u"{peer_jid} is trying to access an unauthorized file: {name}").format(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	209 peer_jid=peer_jid, name=file_data.get(u"name")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	210 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	211 )
2504 67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	212 defer.returnValue(False)
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	213
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	214 if not found_files:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	215 log.warning(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	216 _(u"no matching file found ({file_data})").format(file_data=file_data)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	217 )
2504 67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	218 defer.returnValue(False)
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	219
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	220 # we only use the first found file
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	221 found_file = found_files[0]
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	222 file_hash = found_file[u"file_hash"]
2504 67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	223 file_path = os.path.join(self.files_path, file_hash)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	224 file_data[u"hash_hasher"] = hasher = self._h.getHasher(found_file[u"hash_algo"])
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	225 size = file_data[u"size"] = found_file[u"size"]
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	226 file_data[u"file_hash"] = file_hash
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	227 file_data[u"hash_algo"] = found_file[u"hash_algo"]
2504 67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	228
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	229 # we complete file_elt so peer can have some details on the file
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	230 if u"name" not in file_data:
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	231 file_elt.addElement(u"name", content=found_file[u"name"])
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	232 file_elt.addElement(u"size", content=unicode(size))
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	233 content_data["stream_object"] = stream.FileStreamObject(
2504 67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	234 self.host,
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	235 client,
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	236 file_path,
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	237 uid=self._jf.getProgressId(session, content_name),
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	238 size=size,
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	239 data_cb=lambda data: hasher.update(data),
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	240 )
2504 67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	241 defer.returnValue(True)
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	242
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	243 def _fileSendingRequestTrigger(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	244 self, client, session, content_data, content_name, file_data, file_elt
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	245 ):
2504 67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	246 if not client.is_component:
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	247 return True, None
67cc54b01a12 plugin file sharing component: first draft: Goffi <goffi@goffi.org> parents: diff changeset	248 else:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	249 return (
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	250 False,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	251 self._retrieveFiles(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	252 client, session, content_data, content_name, file_data, file_elt
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	253 ),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	254 )
2527 a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	255
2528 65e278997715 component file sharing: comments metadata: Goffi <goffi@goffi.org> parents: 2527 diff changeset	256 ## comments triggers ##
65e278997715 component file sharing: comments metadata: Goffi <goffi@goffi.org> parents: 2527 diff changeset	257
65e278997715 component file sharing: comments metadata: Goffi <goffi@goffi.org> parents: 2527 diff changeset	258 def _addFileComments(self, file_elt, extra_args):
65e278997715 component file sharing: comments metadata: Goffi <goffi@goffi.org> parents: 2527 diff changeset	259 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	260 comments_url = extra_args.pop("comments_url")
2528 65e278997715 component file sharing: comments metadata: Goffi <goffi@goffi.org> parents: 2527 diff changeset	261 except KeyError:
65e278997715 component file sharing: comments metadata: Goffi <goffi@goffi.org> parents: 2527 diff changeset	262 return
65e278997715 component file sharing: comments metadata: Goffi <goffi@goffi.org> parents: 2527 diff changeset	263
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	264 comment_elt = file_elt.addElement((NS_COMMENTS, "comments"), content=comments_url)
2528 65e278997715 component file sharing: comments metadata: Goffi <goffi@goffi.org> parents: 2527 diff changeset	265
65e278997715 component file sharing: comments metadata: Goffi <goffi@goffi.org> parents: 2527 diff changeset	266 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	267 count = len(extra_args[u"extra"][u"comments"])
2528 65e278997715 component file sharing: comments metadata: Goffi <goffi@goffi.org> parents: 2527 diff changeset	268 except KeyError:
65e278997715 component file sharing: comments metadata: Goffi <goffi@goffi.org> parents: 2527 diff changeset	269 count = 0
65e278997715 component file sharing: comments metadata: Goffi <goffi@goffi.org> parents: 2527 diff changeset	270
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	271 comment_elt["count"] = unicode(count)
2528 65e278997715 component file sharing: comments metadata: Goffi <goffi@goffi.org> parents: 2527 diff changeset	272 return True
65e278997715 component file sharing: comments metadata: Goffi <goffi@goffi.org> parents: 2527 diff changeset	273
65e278997715 component file sharing: comments metadata: Goffi <goffi@goffi.org> parents: 2527 diff changeset	274 def _getFileComments(self, file_elt, file_data):
65e278997715 component file sharing: comments metadata: Goffi <goffi@goffi.org> parents: 2527 diff changeset	275 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	276 comments_elt = next(file_elt.elements(NS_COMMENTS, "comments"))
2528 65e278997715 component file sharing: comments metadata: Goffi <goffi@goffi.org> parents: 2527 diff changeset	277 except StopIteration:
65e278997715 component file sharing: comments metadata: Goffi <goffi@goffi.org> parents: 2527 diff changeset	278 return
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	279 file_data["comments_url"] = unicode(comments_elt)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	280 file_data["comments_count"] = comments_elt["count"]
2528 65e278997715 component file sharing: comments metadata: Goffi <goffi@goffi.org> parents: 2527 diff changeset	281 return True
65e278997715 component file sharing: comments metadata: Goffi <goffi@goffi.org> parents: 2527 diff changeset	282
65e278997715 component file sharing: comments metadata: Goffi <goffi@goffi.org> parents: 2527 diff changeset	283 def _addCommentsData(self, client, iq_elt, owner, node_path, files_data):
65e278997715 component file sharing: comments metadata: Goffi <goffi@goffi.org> parents: 2527 diff changeset	284 for file_data in files_data:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	285 file_data["comments_url"] = uri.buildXMPPUri(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	286 "pubsub",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	287 path=client.jid.full(),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	288 node=COMMENT_NODE_PREFIX + file_data["id"],
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	289 )
2528 65e278997715 component file sharing: comments metadata: Goffi <goffi@goffi.org> parents: 2527 diff changeset	290 return True
65e278997715 component file sharing: comments metadata: Goffi <goffi@goffi.org> parents: 2527 diff changeset	291
2527 a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	292
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	293 class Comments_handler(pubsub.PubSubService):
2528 65e278997715 component file sharing: comments metadata: Goffi <goffi@goffi.org> parents: 2527 diff changeset	294 """This class is a minimal Pubsub service handling virtual nodes for comments"""
2527 a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	295
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	296 def __init__(self, plugin_parent):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	297 super(Comments_handler, self).__init__() # PubsubVirtualResource())
2527 a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	298 self.host = plugin_parent.host
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	299 self.plugin_parent = plugin_parent
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	300 self.discoIdentity = {
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	301 "category": "pubsub",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	302 "type": "virtual", # FIXME: non standard, here to avoid this service being considered as main pubsub one
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	303 "name": "files commenting service",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	304 }
2527 a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	305
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	306 def _getFileId(self, nodeIdentifier):
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	307 if not nodeIdentifier.startswith(COMMENT_NODE_PREFIX):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	308 raise error.StanzaError("item-not-found")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	309 file_id = nodeIdentifier[len(COMMENT_NODE_PREFIX) :]
2527 a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	310 if not file_id:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	311 raise error.StanzaError("item-not-found")
2527 a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	312 return file_id
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	313
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	314 @defer.inlineCallbacks
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	315 def getFileData(self, requestor, nodeIdentifier):
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	316 file_id = self._getFileId(nodeIdentifier)
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	317 try:
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	318 files = yield self.host.memory.getFiles(self.parent, requestor, file_id)
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	319 except (exceptions.NotFound, exceptions.PermissionError):
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	320 # we don't differenciate between NotFound and PermissionError
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	321 # to avoid leaking information on existing files
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	322 raise error.StanzaError("item-not-found")
2527 a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	323 if not files:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	324 raise error.StanzaError("item-not-found")
2527 a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	325 if len(files) > 1:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	326 raise error.InternalError("there should be only one file")
2527 a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	327 defer.returnValue(files[0])
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	328
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	329 def commentsUpdate(self, extra, new_comments, peer_jid):
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	330 """update comments (replace or insert new_comments)
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	331
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	332 @param extra(dict): extra data to update
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	333 @param new_comments(list[tuple(unicode, unicode, unicode)]): comments to update or insert
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	334 @param peer_jid(unicode, None): bare jid of the requestor, or None if request is done by owner
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	335 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	336 current_comments = extra.setdefault("comments", [])
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	337 new_comments_by_id = {c[0]: c for c in new_comments}
2527 a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	338 updated = []
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	339 # we now check every current comment, to see if one id in new ones
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	340 # exist, in which case we must update
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	341 for idx, comment in enumerate(current_comments):
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	342 comment_id = comment[0]
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	343 if comment_id in new_comments_by_id:
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	344 # a new comment has an existing id, update is requested
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	345 if peer_jid and comment[1] != peer_jid:
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	346 # requestor has not the right to modify the comment
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	347 raise exceptions.PermissionError
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	348 # we replace old_comment with updated one
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	349 new_comment = new_comments_by_id[comment_id]
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	350 current_comments[idx] = new_comment
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	351 updated.append(new_comment)
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	352
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	353 # we now remove every updated comments, to only keep
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	354 # the ones to insert
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	355 for comment in updated:
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	356 new_comments.remove(comment)
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	357
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	358 current_comments.extend(new_comments)
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	359
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	360 def commentsDelete(self, extra, comments):
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	361 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	362 comments_dict = extra["comments"]
2527 a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	363 except KeyError:
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	364 return
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	365 for comment in comments:
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	366 try:
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	367 comments_dict.remove(comment)
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	368 except ValueError:
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	369 continue
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	370
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	371 def _getFrom(self, item_elt):
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	372 """retrieve published of an item
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	373
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	374 @param item_elt(domish.element): <item> element
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	375 @return (unicode): full jid as string
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	376 """
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	377 iq_elt = item_elt
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	378 while iq_elt.parent != None:
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	379 iq_elt = iq_elt.parent
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	380 return iq_elt["from"]
2527 a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	381
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	382 @defer.inlineCallbacks
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	383 def publish(self, requestor, service, nodeIdentifier, items):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	384 # we retrieve file a first time to check authorisations
2527 a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	385 file_data = yield self.getFileData(requestor, nodeIdentifier)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	386 file_id = file_data["id"]
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	387 comments = [(item["id"], self._getFrom(item), item.toXml()) for item in items]
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	388 if requestor.userhostJID() == file_data["owner"]:
2527 a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	389 peer_jid = None
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	390 else:
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	391 peer_jid = requestor.userhost()
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	392 update_cb = partial(self.commentsUpdate, new_comments=comments, peer_jid=peer_jid)
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	393 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	394 yield self.host.memory.fileUpdate(file_id, "extra", update_cb)
2527 a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	395 except exceptions.PermissionError:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	396 raise error.StanzaError("not-authorized")
2527 a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	397
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	398 @defer.inlineCallbacks
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	399 def items(self, requestor, service, nodeIdentifier, maxItems, itemIdentifiers):
2527 a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	400 file_data = yield self.getFileData(requestor, nodeIdentifier)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	401 comments = file_data["extra"].get("comments", [])
2527 a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	402 if itemIdentifiers:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	403 defer.returnValue(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	404 [generic.parseXml(c[2]) for c in comments if c[0] in itemIdentifiers]
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	405 )
2527 a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	406 else:
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	407 defer.returnValue([generic.parseXml(c[2]) for c in comments])
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	408
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	409 @defer.inlineCallbacks
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	410 def retract(self, requestor, service, nodeIdentifier, itemIdentifiers):
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	411 file_data = yield self.getFileData(requestor, nodeIdentifier)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	412 file_id = file_data["id"]
2527 a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	413 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	414 comments = file_data["extra"]["comments"]
2527 a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	415 except KeyError:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	416 raise error.StanzaError("item-not-found")
2527 a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	417
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	418 to_remove = []
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	419 for comment in comments:
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	420 comment_id = comment[0]
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	421 if comment_id in itemIdentifiers:
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	422 to_remove.append(comment)
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	423 itemIdentifiers.remove(comment_id)
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	424 if not itemIdentifiers:
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	425 break
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	426
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	427 if itemIdentifiers:
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	428 # not all items have been to_remove, we can't continue
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	429 raise error.StanzaError("item-not-found")
2527 a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	430
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	431 if requestor.userhostJID() != file_data["owner"]:
2527 a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	432 if not all([c[1] == requestor.userhost() for c in to_remove]):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	433 raise error.StanzaError("not-authorized")
2527 a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	434
a201194fc461 component file sharing: comments handling first draft: Goffi <goffi@goffi.org> parents: 2522 diff changeset	435 remove_cb = partial(self.commentsDelete, comments=to_remove)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2562 diff changeset	436 yield self.host.memory.fileUpdate(file_id, "extra", remove_cb)

Mercurial > libervia-backend

annotate sat/plugins/plugin_comp_file_sharing.py @ 2906:7dbdbd132649