Mercurial > libervia-backend
annotate libervia/backend/tools/common/files_utils.py @ 4231:e11b13418ba6
plugin XEP-0353, XEP-0234, jingle: WebRTC data channel signaling implementation:
Implement XEP-0343: Signaling WebRTC Data Channels in Jingle. The current version of the
XEP (0.3.1) has no implementation and contains some flaws. After discussing this on xsf@,
Daniel (from Conversations) mentioned that they had a sprint with Larma (from Dino) to
work on another version and provided me with this link:
https://gist.github.com/iNPUTmice/6c56f3e948cca517c5fb129016d99e74 . I have used it for my
implementation.
This implementation reuses work done on Jingle A/V call (notably XEP-0176 and XEP-0167
plugins), with adaptations. When used, XEP-0234 will not handle the file itself as it
normally does. This is because WebRTC has several implementations (browser for web
interface, GStreamer for others), and file/data must be handled directly by the frontend.
This is particularly important for web frontends, as the file is not sent from the backend
but from the end-user's browser device.
Among the changes, there are:
- XEP-0343 implementation.
- `file_send` bridge method now use serialised dict as output.
- New `BaseTransportHandler.is_usable` method which get content data and returns a boolean
(default to `True`) to tell if this transport can actually be used in this context (when
we are initiator). Used in webRTC case to see if call data are available.
- Support of `application` media type, and everything necessary to handle data channels.
- Better confirmation message, with file name, size and description when available.
- When file is accepted in preflight, it is specified in following `action_new` signal for
actual file transfer. This way, frontend can avoid the display or 2 confirmation
messages.
- XEP-0166: when not specified, default `content` name is now its index number instead of
a UUID. This follows the behaviour of browsers.
- XEP-0353: better handling of events such as call taken by another device.
- various other updates.
rel 441
author | Goffi <goffi@goffi.org> |
---|---|
date | Sat, 06 Apr 2024 12:57:23 +0200 |
parents | 4b842c1fb686 |
children |
rev | line source |
---|---|
3028 | 1 #!/usr/bin/env python3 |
3137 | 2 |
3368
e86b71b1aa31
core: minor typos, docstring/comments update
Goffi <goffi@goffi.org>
parents:
3246
diff
changeset
|
3 # SaT: an XMPP client |
3479 | 4 # Copyright (C) 2009-2021 Jérôme Poisson (goffi@goffi.org) |
2593
d78eff6b4487
tools (common): new files_utils module:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
5 |
d78eff6b4487
tools (common): new files_utils module:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
6 # This program is free software: you can redistribute it and/or modify |
d78eff6b4487
tools (common): new files_utils module:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
7 # it under the terms of the GNU Affero General Public License as published by |
d78eff6b4487
tools (common): new files_utils module:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
8 # the Free Software Foundation, either version 3 of the License, or |
d78eff6b4487
tools (common): new files_utils module:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
9 # (at your option) any later version. |
d78eff6b4487
tools (common): new files_utils module:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
10 |
d78eff6b4487
tools (common): new files_utils module:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
11 # This program is distributed in the hope that it will be useful, |
d78eff6b4487
tools (common): new files_utils module:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of |
d78eff6b4487
tools (common): new files_utils module:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
d78eff6b4487
tools (common): new files_utils module:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
14 # GNU Affero General Public License for more details. |
d78eff6b4487
tools (common): new files_utils module:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
15 |
d78eff6b4487
tools (common): new files_utils module:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
16 # You should have received a copy of the GNU Affero General Public License |
d78eff6b4487
tools (common): new files_utils module:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
17 # along with this program. If not, see <http://www.gnu.org/licenses/>. |
d78eff6b4487
tools (common): new files_utils module:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
18 |
d78eff6b4487
tools (common): new files_utils module:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
19 """tools to help manipulating files""" |
3091
2e1c3d33099b
tools (common/files_utils): get_unique_name now uses and returns Path instances.
Goffi <goffi@goffi.org>
parents:
3028
diff
changeset
|
20 from pathlib import Path |
2593
d78eff6b4487
tools (common): new files_utils module:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
21 |
d78eff6b4487
tools (common): new files_utils module:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
22 |
d78eff6b4487
tools (common): new files_utils module:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
23 def get_unique_name(path): |
3091
2e1c3d33099b
tools (common/files_utils): get_unique_name now uses and returns Path instances.
Goffi <goffi@goffi.org>
parents:
3028
diff
changeset
|
24 """Generate a path with a name not conflicting with existing file |
2593
d78eff6b4487
tools (common): new files_utils module:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
25 |
3091
2e1c3d33099b
tools (common/files_utils): get_unique_name now uses and returns Path instances.
Goffi <goffi@goffi.org>
parents:
3028
diff
changeset
|
26 @param path(str, Path): path to the file to create |
2e1c3d33099b
tools (common/files_utils): get_unique_name now uses and returns Path instances.
Goffi <goffi@goffi.org>
parents:
3028
diff
changeset
|
27 @return (Path): unique path (can be the same as path if there is no conflict) |
2593
d78eff6b4487
tools (common): new files_utils module:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
28 """ |
3131
d6da17f6e4ce
tools (common/files_utils): fixed get_unique_name when `path` is a str and not a Path
Goffi <goffi@goffi.org>
parents:
3091
diff
changeset
|
29 ori_path = path = Path(path) |
2593
d78eff6b4487
tools (common): new files_utils module:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
30 idx = 1 |
3091
2e1c3d33099b
tools (common/files_utils): get_unique_name now uses and returns Path instances.
Goffi <goffi@goffi.org>
parents:
3028
diff
changeset
|
31 while path.exists(): |
3246
5ba0b1cdd45b
tools (common/files_utils): put extra suffix before file extension
Goffi <goffi@goffi.org>
parents:
3137
diff
changeset
|
32 path = ori_path.with_name(f"{ori_path.stem}_{idx}{ori_path.suffix}") |
2593
d78eff6b4487
tools (common): new files_utils module:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
33 idx += 1 |
d78eff6b4487
tools (common): new files_utils module:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
34 return path |