libervia-backend: libervia/backend/plugins/plugin_xep

annotate libervia/backend/plugins/plugin_xep_0447.py @ 4335:430d5d99a740

plugin XEP-0358: "Publishing Available Jingle Sessions" implementation: rel 453

author	Goffi <goffi@goffi.org>
date	Tue, 03 Dec 2024 00:13:07 +0100
parents	111dce64dcb5
children

rev	line source
3897 4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	1 #!/usr/bin/env python3
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	2
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	3 # Copyright (C) 2009-2022 Jérôme Poisson (goffi@goffi.org)
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	4
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	5 # This program is free software: you can redistribute it and/or modify
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	6 # it under the terms of the GNU Affero General Public License as published by
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	7 # the Free Software Foundation, either version 3 of the License, or
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	8 # (at your option) any later version.
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	9
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	10 # This program is distributed in the hope that it will be useful,
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	13 # GNU Affero General Public License for more details.
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	14
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	15 # You should have received a copy of the GNU Affero General Public License
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	16 # along with this program. If not, see <http://www.gnu.org/licenses/>.
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	17
4334 111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	18 from abc import ABC, abstractmethod
3922 0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	19 from collections import namedtuple
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	20 from functools import partial
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	21 import mimetypes
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	22 from pathlib import Path
4334 111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	23 from typing import (
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	24 Any,
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	25 Callable,
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	26 ClassVar,
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	27 Dict,
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	28 Final,
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	29 List,
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	30 Literal,
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	31 NamedTuple,
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	32 Optional,
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	33 Self,
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	34 Tuple,
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	35 Union,
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	36 cast,
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	37 )
3897 4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	38
4334 111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	39 from pydantic import BaseModel, Field
3922 0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	40 import treq
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	41 from twisted.internet import defer
3897 4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	42 from twisted.words.xish import domish
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	43
4071 4b842c1fb686 refactoring: renamed `sat` package to `libervia.backend` Goffi <goffi@goffi.org> parents: 4051 diff changeset	44 from libervia.backend.core import exceptions
4b842c1fb686 refactoring: renamed `sat` package to `libervia.backend` Goffi <goffi@goffi.org> parents: 4051 diff changeset	45 from libervia.backend.core.constants import Const as C
4b842c1fb686 refactoring: renamed `sat` package to `libervia.backend` Goffi <goffi@goffi.org> parents: 4051 diff changeset	46 from libervia.backend.core.core_types import SatXMPPEntity
4b842c1fb686 refactoring: renamed `sat` package to `libervia.backend` Goffi <goffi@goffi.org> parents: 4051 diff changeset	47 from libervia.backend.core.i18n import _
4b842c1fb686 refactoring: renamed `sat` package to `libervia.backend` Goffi <goffi@goffi.org> parents: 4051 diff changeset	48 from libervia.backend.core.log import getLogger
4334 111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	49 from libervia.backend.plugins.plugin_xep_0103 import URLData, XEP_0103
4335 430d5d99a740 plugin XEP-0358: "Publishing Available Jingle Sessions" implementation: Goffi <goffi@goffi.org> parents: 4334 diff changeset	50 from libervia.backend.plugins.plugin_xep_0358 import JinglePub, XEP_0358
4334 111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	51 from libervia.backend.plugins.plugin_xep_0446 import FileMetadata, XEP_0446
4071 4b842c1fb686 refactoring: renamed `sat` package to `libervia.backend` Goffi <goffi@goffi.org> parents: 4051 diff changeset	52 from libervia.backend.tools import stream
4b842c1fb686 refactoring: renamed `sat` package to `libervia.backend` Goffi <goffi@goffi.org> parents: 4051 diff changeset	53 from libervia.backend.tools.web import treq_client_no_ssl
3897 4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	54
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	55 log = getLogger(__name__)
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	56
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	57
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	58 PLUGIN_INFO = {
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	59 C.PI_NAME: "Stateless File Sharing",
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	60 C.PI_IMPORT_NAME: "XEP-0447",
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	61 C.PI_TYPE: "XEP",
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	62 C.PI_MODES: C.PLUG_MODE_BOTH,
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	63 C.PI_PROTOCOLS: ["XEP-0447"],
4334 111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	64 C.PI_DEPENDENCIES: [
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	65 "XEP-0103",
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	66 "XEP-0334",
4335 430d5d99a740 plugin XEP-0358: "Publishing Available Jingle Sessions" implementation: Goffi <goffi@goffi.org> parents: 4334 diff changeset	67 "XEP-0358",
4334 111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	68 "XEP-0446",
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	69 "ATTACH",
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	70 "DOWNLOAD",
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	71 ],
3922 0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	72 C.PI_RECOMMENDATIONS: ["XEP-0363"],
3897 4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	73 C.PI_MAIN: "XEP_0447",
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	74 C.PI_HANDLER: "no",
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	75 C.PI_DESCRIPTION: _("""Implementation of XEP-0447 (Stateless File Sharing)"""),
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	76 }
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	77
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	78 NS_SFS = "urn:xmpp:sfs:0"
4334 111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	79
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	80
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	81 class Source(ABC, BaseModel):
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	82
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	83 type: ClassVar[str]
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	84 encrypted: ClassVar[bool] = False
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	85
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	86 def __init_subclass__(cls) -> None:
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	87 super().__init_subclass__()
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	88 if not hasattr(cls, "type"):
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	89 raise TypeError(
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	90 f'Can\'t instantiate {cls.__name__} without "type" class attribute.'
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	91 )
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	92
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	93 @classmethod
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	94 @abstractmethod
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	95 def from_element(cls, element: domish.Element) -> Self:
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	96 """Parse an element and return corresponding model
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	97
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	98 @param element: element to parse
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	99 @raise exceptions.DataError: the element is invalid
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	100 """
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	101
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	102 @abstractmethod
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	103 def to_element(self) -> domish.Element:
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	104 """Convert model to an element
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	105
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	106 @return: domish.Element representing the model
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	107 """
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	108
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	109
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	110 class FileSharing(BaseModel):
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	111 """
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	112 Model for handling XEP-0447 <file-sharing> element.
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	113 """
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	114
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	115 file: FileMetadata
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	116 sources: list[Source]
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	117 disposition: str \| None = Field(
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	118 default=None,
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	119 description="Disposition of the file, either 'attachment' or 'inline'.",
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	120 )
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	121 id: str \| None = Field(
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	122 default=None, description="Unique identifier for the file-sharing element."
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	123 )
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	124 _sfs: "XEP_0447 \| None" = None
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	125
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	126 def to_element(self) -> domish.Element:
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	127 """Build the <file-sharing> element from this instance's data.
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	128
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	129 @return: <file-sharing> element.
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	130 """
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	131 file_sharing_elt = domish.Element((NS_SFS, "file-sharing"))
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	132
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	133 if self.disposition:
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	134 file_sharing_elt["disposition"] = self.disposition
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	135
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	136 if self.id:
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	137 file_sharing_elt["id"] = self.id
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	138
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	139 file_sharing_elt.addChild(self.file.to_element())
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	140
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	141 sources_elt = file_sharing_elt.addElement("sources")
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	142 for source in self.sources:
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	143 sources_elt.addChild(source.to_element())
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	144
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	145 return file_sharing_elt
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	146
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	147 @classmethod
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	148 def from_element(cls, file_sharing_elt: domish.Element) -> Self:
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	149 """Create a FileSharing instance from a <file-sharing> element or its parent.
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	150
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	151 @param file_sharing_elt: The <file-sharing> element or a parent element.
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	152 @return: FileSharing instance.
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	153 @raise exceptions.NotFound: If the <file-sharing> element is not found.
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	154 """
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	155 assert cls._sfs is not None
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	156 if file_sharing_elt.uri != NS_SFS or file_sharing_elt.name != "file-sharing":
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	157 child_file_sharing_elt = next(
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	158 file_sharing_elt.elements(NS_SFS, "file-sharing"), None
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	159 )
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	160 if child_file_sharing_elt is None:
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	161 raise exceptions.NotFound("<file-sharing> element not found")
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	162 else:
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	163 file_sharing_elt = child_file_sharing_elt
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	164
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	165 kwargs = {}
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	166 disposition = file_sharing_elt.getAttribute("disposition")
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	167 if disposition:
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	168 kwargs["disposition"] = disposition
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	169
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	170 file_id = file_sharing_elt.getAttribute("id")
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	171 if file_id:
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	172 kwargs["id"] = file_id
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	173
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	174 kwargs["file"] = FileMetadata.from_element(file_sharing_elt)
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	175 kwargs["sources"] = cls._sfs.parse_sources_elt(file_sharing_elt)
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	176
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	177 return cls(**kwargs)
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	178
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	179
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	180 class URLDataSource(URLData, Source):
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	181 type = "url"
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	182
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	183 @classmethod
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	184 def from_element(cls, element: domish.Element) -> Self:
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	185 return super().from_element(element)
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	186
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	187 def to_element(self) -> domish.Element:
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	188 return super().to_element()
3897 4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	189
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	190
4335 430d5d99a740 plugin XEP-0358: "Publishing Available Jingle Sessions" implementation: Goffi <goffi@goffi.org> parents: 4334 diff changeset	191 class JinglePubSource(JinglePub, Source):
430d5d99a740 plugin XEP-0358: "Publishing Available Jingle Sessions" implementation: Goffi <goffi@goffi.org> parents: 4334 diff changeset	192 type = "jingle"
430d5d99a740 plugin XEP-0358: "Publishing Available Jingle Sessions" implementation: Goffi <goffi@goffi.org> parents: 4334 diff changeset	193
430d5d99a740 plugin XEP-0358: "Publishing Available Jingle Sessions" implementation: Goffi <goffi@goffi.org> parents: 4334 diff changeset	194 @classmethod
430d5d99a740 plugin XEP-0358: "Publishing Available Jingle Sessions" implementation: Goffi <goffi@goffi.org> parents: 4334 diff changeset	195 def from_element(cls, element: domish.Element) -> Self:
430d5d99a740 plugin XEP-0358: "Publishing Available Jingle Sessions" implementation: Goffi <goffi@goffi.org> parents: 4334 diff changeset	196 return super().from_element(element)
430d5d99a740 plugin XEP-0358: "Publishing Available Jingle Sessions" implementation: Goffi <goffi@goffi.org> parents: 4334 diff changeset	197
430d5d99a740 plugin XEP-0358: "Publishing Available Jingle Sessions" implementation: Goffi <goffi@goffi.org> parents: 4334 diff changeset	198 def to_element(self) -> domish.Element:
430d5d99a740 plugin XEP-0358: "Publishing Available Jingle Sessions" implementation: Goffi <goffi@goffi.org> parents: 4334 diff changeset	199 return super().to_element()
430d5d99a740 plugin XEP-0358: "Publishing Available Jingle Sessions" implementation: Goffi <goffi@goffi.org> parents: 4334 diff changeset	200
430d5d99a740 plugin XEP-0358: "Publishing Available Jingle Sessions" implementation: Goffi <goffi@goffi.org> parents: 4334 diff changeset	201
3897 4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	202 class XEP_0447:
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	203 namespace = NS_SFS
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	204
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	205 def __init__(self, host):
3922 0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	206 self.host = host
3897 4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	207 log.info(_("XEP-0447 (Stateless File Sharing) plugin initialization"))
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4023 diff changeset	208 host.register_namespace("sfs", NS_SFS)
4334 111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	209 FileSharing._sfs = self
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	210 self._sources_handlers: dict[tuple[str, str], type[Source]] = {}
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	211 self._u = cast(XEP_0103, host.plugins["XEP-0103"])
4335 430d5d99a740 plugin XEP-0358: "Publishing Available Jingle Sessions" implementation: Goffi <goffi@goffi.org> parents: 4334 diff changeset	212 self._jp = cast(XEP_0358, host.plugins["XEP-0358"])
3922 0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	213 self._hints = host.plugins["XEP-0334"]
4334 111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	214 self._m = cast(XEP_0446, host.plugins["XEP-0446"])
3922 0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	215 self._http_upload = host.plugins.get("XEP-0363")
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	216 self._attach = host.plugins["ATTACH"]
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4071 diff changeset	217 self._attach.register(self.can_handle_attachment, self.attach, priority=1000)
4334 111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	218 self.register_source(
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	219 self._u.namespace,
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	220 "url-data",
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	221 URLDataSource,
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	222 )
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	223 self.register_source(
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	224 self._jp.namespace,
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	225 "jinglepub",
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	226 JinglePubSource,
3922 0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	227 )
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4071 diff changeset	228 host.plugins["DOWNLOAD"].register_download_handler(
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4071 diff changeset	229 self._u.namespace, self.download
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4071 diff changeset	230 )
4051 c23cad65ae99 core: renamed `messageReceived` trigger to `message_received` Goffi <goffi@goffi.org> parents: 4037 diff changeset	231 host.trigger.add("message_received", self._message_received_trigger)
3922 0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	232
4334 111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	233 def register_source(
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4071 diff changeset	234 self,
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4071 diff changeset	235 namespace: str,
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4071 diff changeset	236 element_name: str,
4334 111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	237 source: type[Source],
3922 0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	238 ) -> None:
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	239 """Register a handler for file source
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	240
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	241 @param namespace: namespace of the element supported
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	242 @param element_name: name of the element supported
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	243 @param callback: method to call to parse the element
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	244 get the matching element as argument, must return the parsed data
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	245 @param encrypted: if True, the source is encrypted (the transmitting channel
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	246 should then be end2end encrypted to avoir leaking decrypting data to servers).
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	247 """
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	248 key = (namespace, element_name)
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	249 if key in self._sources_handlers:
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	250 raise exceptions.ConflictError(
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	251 f"There is already a resource handler for namespace {namespace!r} and "
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	252 f"name {element_name!r}"
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	253 )
4334 111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	254 self._sources_handlers[key] = source
3922 0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	255
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	256 async def download(
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	257 self,
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	258 client: SatXMPPEntity,
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	259 attachment: Dict[str, Any],
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	260 source: Dict[str, Any],
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	261 dest_path: Union[Path, str],
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4071 diff changeset	262 extra: Optional[Dict[str, Any]] = None,
3922 0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	263 ) -> Tuple[str, defer.Deferred]:
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	264 # TODO: handle url-data headers
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	265 if extra is None:
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	266 extra = {}
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	267 try:
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	268 download_url = source["url"]
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	269 except KeyError:
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	270 raise ValueError(f"{source} has missing URL")
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	271
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4071 diff changeset	272 if extra.get("ignore_tls_errors", False):
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4071 diff changeset	273 log.warning("TLS certificate check disabled, this is highly insecure")
3922 0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	274 treq_client = treq_client_no_ssl
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	275 else:
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	276 treq_client = treq
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	277
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	278 try:
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	279 file_size = int(attachment["size"])
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	280 except (KeyError, ValueError):
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	281 head_data = await treq_client.head(download_url)
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4071 diff changeset	282 file_size = int(head_data.headers.getRawHeaders("content-length")[0])
3922 0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	283
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	284 file_obj = stream.SatFile(
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	285 self.host,
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	286 client,
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	287 dest_path,
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	288 mode="wb",
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4071 diff changeset	289 size=file_size,
3922 0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	290 )
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	291
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	292 progress_id = file_obj.uid
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	293
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	294 resp = await treq_client.get(download_url, unbuffered=True)
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	295 if resp.code == 200:
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	296 d = treq.collect(resp, file_obj.write)
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	297 d.addCallback(lambda __: file_obj.close())
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	298 else:
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	299 d = defer.Deferred()
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	300 self.host.plugins["DOWNLOAD"].errback_download(file_obj, d, resp)
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	301 return progress_id, d
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	302
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	303 async def can_handle_attachment(self, client, data):
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	304 if self._http_upload is None:
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	305 return False
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	306 try:
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4023 diff changeset	307 await self._http_upload.get_http_upload_entity(client)
3922 0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	308 except exceptions.NotFound:
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	309 return False
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	310 else:
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	311 return True
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	312
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	313 def get_sources_elt(
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4071 diff changeset	314 self, children: Optional[List[domish.Element]] = None
3922 0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	315 ) -> domish.Element:
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	316 """Generate <sources> element"""
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	317 sources_elt = domish.Element((NS_SFS, "sources"))
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	318 if children:
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	319 for child in children:
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	320 sources_elt.addChild(child)
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	321 return sources_elt
3897 4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	322
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	323 def get_file_sharing_elt(
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	324 self,
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	325 sources: List[Dict[str, Any]],
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	326 disposition: Optional[str] = None,
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	327 name: Optional[str] = None,
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	328 media_type: Optional[str] = None,
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	329 desc: Optional[str] = None,
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	330 size: Optional[int] = None,
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	331 file_hash: Optional[Tuple[str, str]] = None,
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	332 date: Optional[Union[float, int]] = None,
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	333 width: Optional[int] = None,
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	334 height: Optional[int] = None,
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	335 length: Optional[int] = None,
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	336 thumbnail: Optional[str] = None,
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	337 **kwargs,
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	338 ) -> domish.Element:
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	339 """Generate the <file-sharing/> element
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	340
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	341 @param extra: extra metadata describing how to access the URL
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	342 @return: ``<sfs/>`` element
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	343 """
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	344 file_sharing_elt = domish.Element((NS_SFS, "file-sharing"))
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	345 if disposition is not None:
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	346 file_sharing_elt["disposition"] = disposition
3922 0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	347 if media_type is None and name:
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	348 media_type = mimetypes.guess_type(name, strict=False)[0]
3897 4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	349 file_sharing_elt.addChild(
4334 111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	350 self._m.generate_file_metadata(
3897 4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	351 name=name,
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	352 media_type=media_type,
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	353 desc=desc,
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	354 size=size,
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	355 file_hash=file_hash,
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	356 date=date,
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	357 width=width,
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	358 height=height,
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	359 length=length,
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	360 thumbnail=thumbnail,
4334 111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	361 ).to_element()
3897 4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	362 )
3922 0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	363 sources_elt = self.get_sources_elt()
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	364 file_sharing_elt.addChild(sources_elt)
3897 4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	365 for source_data in sources:
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	366 if "url" in source_data:
4334 111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	367 sources_elt.addChild(
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	368 self._u.generate_url_data(**source_data).to_element()
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	369 )
3897 4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	370 else:
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4071 diff changeset	371 raise NotImplementedError(f"source data not implemented: {source_data}")
3897 4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	372
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	373 return file_sharing_elt
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	374
4334 111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	375 def parse_sources_elt(self, sources_elt: domish.Element) -> List[Source]:
3922 0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	376 """Parse <sources/> element
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	377
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	378 @param sources_elt: <sources/> element, or a direct parent element
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	379 @return: list of found sources data
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	380 @raise: exceptions.NotFound: Can't find <sources/> element
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	381 """
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	382 if sources_elt.name != "sources" or sources_elt.uri != NS_SFS:
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	383 try:
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	384 sources_elt = next(sources_elt.elements(NS_SFS, "sources"))
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	385 except StopIteration:
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	386 raise exceptions.NotFound(
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4071 diff changeset	387 f"<sources/> element is missing: {sources_elt.toXml()}"
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4071 diff changeset	388 )
3922 0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	389 sources = []
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	390 for elt in sources_elt.elements():
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	391 if not elt.uri:
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	392 log.warning("ignoring source element {elt.toXml()}")
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	393 continue
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	394 key = (elt.uri, elt.name)
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	395 try:
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	396 source_handler = self._sources_handlers[key]
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	397 except KeyError:
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	398 log.warning(f"unmanaged file sharing element: {elt.toXml}")
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	399 continue
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	400 else:
4334 111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	401 source = source_handler.from_element(elt)
111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	402 sources.append(source)
3922 0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	403 return sources
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	404
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4071 diff changeset	405 def parse_file_sharing_elt(self, file_sharing_elt: domish.Element) -> Dict[str, Any]:
3897 4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	406 """Parse <file-sharing/> element and return file-sharing data
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	407
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	408 @param file_sharing_elt: <file-sharing/> element
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	409 @return: file-sharing data. It a dict whose keys correspond to
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	410 [get_file_sharing_elt] parameters
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	411 """
4023 78b5f356900c component AP gateway: handle attachments Goffi <goffi@goffi.org> parents: 3922 diff changeset	412 if file_sharing_elt.name != "file-sharing" or file_sharing_elt.uri != NS_SFS:
3897 4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	413 try:
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4071 diff changeset	414 file_sharing_elt = next(file_sharing_elt.elements(NS_SFS, "file-sharing"))
3897 4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	415 except StopIteration:
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	416 raise exceptions.NotFound
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	417 try:
4334 111dce64dcb5 plugins XEP-0300, XEP-0446, XEP-0447, XEP0448 and others: Refactoring to use Pydantic: Goffi <goffi@goffi.org> parents: 4270 diff changeset	418 data = self._m.parse_file_metadata_elt(file_sharing_elt).model_dump()
3897 4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	419 except exceptions.NotFound:
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	420 data = {}
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	421 disposition = file_sharing_elt.getAttribute("disposition")
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	422 if disposition is not None:
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	423 data["disposition"] = disposition
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	424 try:
3922 0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	425 data["sources"] = self.parse_sources_elt(file_sharing_elt)
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	426 except exceptions.NotFound as e:
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	427 raise ValueError(str(e))
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	428
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	429 return data
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	430
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	431 def _add_file_sharing_attachments(
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4071 diff changeset	432 self, client: SatXMPPEntity, message_elt: domish.Element, data: Dict[str, Any]
3922 0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	433 ) -> Dict[str, Any]:
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	434 """Check <message> for a shared file, and add it as an attachment"""
4023 78b5f356900c component AP gateway: handle attachments Goffi <goffi@goffi.org> parents: 3922 diff changeset	435 # XXX: XEP-0447 doesn't support several attachments in a single message, for now
78b5f356900c component AP gateway: handle attachments Goffi <goffi@goffi.org> parents: 3922 diff changeset	436 # however that should be fixed in future version, and so we accept several
78b5f356900c component AP gateway: handle attachments Goffi <goffi@goffi.org> parents: 3922 diff changeset	437 # <file-sharing> element in a message.
78b5f356900c component AP gateway: handle attachments Goffi <goffi@goffi.org> parents: 3922 diff changeset	438 for file_sharing_elt in message_elt.elements(NS_SFS, "file-sharing"):
3922 0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	439 attachment = self.parse_file_sharing_elt(message_elt)
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	440
4023 78b5f356900c component AP gateway: handle attachments Goffi <goffi@goffi.org> parents: 3922 diff changeset	441 if any(
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4071 diff changeset	442 s.get(C.MESS_KEY_ENCRYPTED, False) for s in attachment["sources"]
4023 78b5f356900c component AP gateway: handle attachments Goffi <goffi@goffi.org> parents: 3922 diff changeset	443 ) and client.encryption.isEncrypted(data):
78b5f356900c component AP gateway: handle attachments Goffi <goffi@goffi.org> parents: 3922 diff changeset	444 # we don't add the encrypted flag if the message itself is not encrypted,
78b5f356900c component AP gateway: handle attachments Goffi <goffi@goffi.org> parents: 3922 diff changeset	445 # because the decryption key is part of the link, so sending it over
78b5f356900c component AP gateway: handle attachments Goffi <goffi@goffi.org> parents: 3922 diff changeset	446 # unencrypted channel is like having no encryption at all.
78b5f356900c component AP gateway: handle attachments Goffi <goffi@goffi.org> parents: 3922 diff changeset	447 attachment[C.MESS_KEY_ENCRYPTED] = True
3922 0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	448
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4071 diff changeset	449 attachments = data["extra"].setdefault(C.KEY_ATTACHMENTS, [])
4023 78b5f356900c component AP gateway: handle attachments Goffi <goffi@goffi.org> parents: 3922 diff changeset	450 attachments.append(attachment)
3897 4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	451
4b7106eede0c plugin XEP-0447: Stateless File Sharing implementation: Goffi <goffi@goffi.org> parents: diff changeset	452 return data
3922 0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	453
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	454 async def attach(self, client, data):
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	455 # XXX: for now, XEP-0447 only allow to send one file per <message/>, thus we need
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	456 # to send each file in a separate message
4023 78b5f356900c component AP gateway: handle attachments Goffi <goffi@goffi.org> parents: 3922 diff changeset	457 attachments = data["extra"][C.KEY_ATTACHMENTS]
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4071 diff changeset	458 if not data["message"] or data["message"] == {"": ""}:
3922 0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	459 extra_attachments = attachments[1:]
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	460 del attachments[1:]
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	461 else:
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	462 # we have a message, we must send first attachment separately
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	463 extra_attachments = attachments[:]
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	464 attachments.clear()
4023 78b5f356900c component AP gateway: handle attachments Goffi <goffi@goffi.org> parents: 3922 diff changeset	465 del data["extra"][C.KEY_ATTACHMENTS]
3922 0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	466
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	467 if attachments:
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	468 if len(attachments) > 1:
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	469 raise exceptions.InternalError(
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	470 "There should not be more that one attachment at this point"
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	471 )
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	472 await self._attach.upload_files(client, data)
4037 524856bd7b19 massive refactoring to switch from camelCase to snake_case: Goffi <goffi@goffi.org> parents: 4023 diff changeset	473 self._hints.add_hint_elements(data["xml"], [self._hints.HINT_STORE])
3922 0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	474 for attachment in attachments:
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	475 try:
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	476 file_hash = (attachment["hash_algo"], attachment["hash"])
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	477 except KeyError:
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	478 file_hash = None
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	479 file_sharing_elt = self.get_file_sharing_elt(
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	480 [{"url": attachment["url"]}],
4023 78b5f356900c component AP gateway: handle attachments Goffi <goffi@goffi.org> parents: 3922 diff changeset	481 name=attachment.get("name"),
78b5f356900c component AP gateway: handle attachments Goffi <goffi@goffi.org> parents: 3922 diff changeset	482 size=attachment.get("size"),
78b5f356900c component AP gateway: handle attachments Goffi <goffi@goffi.org> parents: 3922 diff changeset	483 desc=attachment.get("desc"),
78b5f356900c component AP gateway: handle attachments Goffi <goffi@goffi.org> parents: 3922 diff changeset	484 media_type=attachment.get("media_type"),
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4071 diff changeset	485 file_hash=file_hash,
3922 0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	486 )
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	487 data["xml"].addChild(file_sharing_elt)
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	488
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	489 for attachment in extra_attachments:
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	490 # we send all remaining attachment in a separate message
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	491 await client.sendMessage(
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4071 diff changeset	492 to_jid=data["to"],
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4071 diff changeset	493 message={"": ""},
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4071 diff changeset	494 subject=data["subject"],
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4071 diff changeset	495 mess_type=data["type"],
4023 78b5f356900c component AP gateway: handle attachments Goffi <goffi@goffi.org> parents: 3922 diff changeset	496 extra={C.KEY_ATTACHMENTS: [attachment]},
3922 0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	497 )
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	498
4270 0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4071 diff changeset	499 if (
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4071 diff changeset	500 not data["extra"]
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4071 diff changeset	501 and (not data["message"] or data["message"] == {"": ""})
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4071 diff changeset	502 and not data["subject"]
0d7bb4df2343 Reformatted code base using black. Goffi <goffi@goffi.org> parents: 4071 diff changeset	503 ):
3922 0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	504 # nothing left to send, we can cancel the message
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	505 raise exceptions.CancelError("Cancelled by XEP_0447 attachment handling")
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	506
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	507 def _message_received_trigger(self, client, message_elt, post_treat):
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	508 # we use a post_treat callback instead of "message_parse" trigger because we need
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	509 # to check if the "encrypted" flag is set to decide if we add the same flag to the
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	510 # attachment
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	511 post_treat.addCallback(
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	512 partial(self._add_file_sharing_attachments, client, message_elt)
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	513 )
0ff265725489 plugin XEP-0447: handle attachment and download: Goffi <goffi@goffi.org> parents: 3897 diff changeset	514 return True

Mercurial > libervia-backend

annotate libervia/backend/plugins/plugin_xep_0447.py @ 4335:430d5d99a740