Commits

commits@gajim.org

17632 discussions

[Git][gajim/python-nbxmpp][soup3] More http stuff
by Philipp Hörist (＠lovetox) 09 Dec '22

09 Dec '22

Philipp Hörist pushed to branch soup3 at gajim / python-nbxmpp Commits: af207e3d by Philipp Hörist at 2022-12-09T22:04:37+01:00 More http stuff - - - - - 3 changed files: - nbxmpp/const.py - + nbxmpp/http.py - + test/unit/test_http.py Changes: ===================================== nbxmpp/const.py ===================================== @@ -453,6 +453,15 @@ class Mode(IntEnum): return self == Mode.ANONYMOUS_TEST +class HTTPRequestError(IntEnum): + UNKNOWN = 0 + MISSING_CONTENT_LENGTH = 1 + INCOMPLETE = 2 + STATUS = 3 + CANCELLED = 4 + CONTENT_OVERFLOW = 5 + + MOODS = [ 'afraid', 'amazed', ===================================== nbxmpp/http.py ===================================== @@ -0,0 +1,394 @@ +# This file is part of Gajim. +# +# Gajim is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published +# by the Free Software Foundation; version 3 only. +# +# Gajim is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with Gajim. If not, see <http://www.gnu.org/licenses/>. + +# XEP-0363: HTTP File Upload + +from __future__ import annotations +from pathlib import Path + +from typing import Any +from typing import Literal +from typing import Callable +from typing import Optional + +import logging +import threading +from threading import Thread + +from gi.repository import Soup +from gi.repository import Gio +from gi.repository import GLib + +import nbxmpp +from nbxmpp.const import HTTPRequestError +from nbxmpp.util import Observable + + +log = logging.getLogger('nbxmpp.http') + + +HTTP_METHODS_T = Literal['GET', 'POST'] +CHUNK_SIZE = 32768 +DEFAULT_USER_AGENT = f'nbxmpp/{nbxmpp.__version__}' + + +class HTTPLogAdapter(logging.LoggerAdapter): + def process(self, msg: str, kwargs: Any) -> tuple[str, Any]: + return f'{self.extra["request"]}: {msg}', kwargs + + +class HTTPSessionManager: + def __init__(self) -> None: + pass + + +class HTTPSession: + def __init__(self, user_agent: str = DEFAULT_USER_AGENT) -> None: + self._session = Soup.Session() + self._session.set_user_agent(user_agent) + + self._requests: list[HTTPRequest] = [] + + def get_soup_session(self) -> Soup.Session: + return self._session + + def set_proxy_resolver(self, + resolver: Optional[Gio.SimpleProxyResolver] + ) -> None: + + self._session.set_proxy_resolver(resolver) + + def create_request(self) -> HTTPRequest: + request = HTTPRequest(self) + request.subscribe('destroyed', self._on_request_destroyed) + self._requests.append(request) + return request + + def _on_request_destroyed(self, + request: HTTPRequest, + _signal_name: str + ) -> None: + + self._requests.remove(request) + + +class HTTPRequest(Observable): + + ''' + Signals + - started + - complete + - failed + - cancelled + - destroyed + ''' + + def __init__(self, session: HTTPSession) -> None: + Observable.__init__(self, HTTPLogAdapter(log, extra={'request': self})) + self._session = session + + self._data = b'' + self._received_size = 0 + self._uri: Optional[GLib.Uri] = None + + self._cancellable = Gio.Cancellable() + self._input_stream: Optional[Gio.InputStream] = None + self._output_stream: Optional[Gio.OutputStream] = None + self._file: Optional[Path] = None + self._is_finished = False + + self._content_length = 0 + self._content_type = '' + + self._message = None + self._progress_callback: Optional[Callable[..., None]] = None + + self._lock = threading.Lock() + self._log.info('Created') + + def get_content_length(self) -> int: + return self._content_length + + def get_content_type(self) -> str: + return self._content_type + + def get_data(self) -> bytes: + return self._data + + def get_uri(self) -> Optional[GLib.Uri]: + return self._uri + + def get_file_path(self) -> Optional[Gio.File]: + return self._file + + def get_status(self) -> Soup.Status: + return self._message.get_status() + + def get_progress(self) -> float: + if self._received_size == 0: + return 0 + return self._received_size / self._content_length + + def cancel(self) -> None: + if self._is_finished: + raise ValueError('Session already finished') + + self._cancellable.cancel() + + def set_progress_callback(self, func: Any) -> None: + self._progress_callback = func + + def send(self, + method: HTTP_METHODS_T, + uri_string: str, + file_path: Optional[Path] = None + ) -> None: + + if self._is_finished: + raise ValueError('Session already finished') + + if file_path is not None: + self._file = Gio.File.new_for_path(str(file_path)) + self._output_stream = self._file.replace(None, + False, + Gio.FileCreateFlags.REPLACE_DESTINATION, + self._cancellable) + + self._uri = GLib.Uri.parse(uri_string, GLib.UriFlags.HAS_PASSWORD) + self._message = Soup.Message.new_from_uri(method, self._uri) + self._message.connect('finished', self._on_finished) + + soup_session = self._session.get_soup_session() + soup_session.send_async(self._message, + GLib.PRIORITY_DEFAULT, + self._cancellable, + self._on_response) + + self._log.info('Request sent') + + def _on_response(self, + session: Soup.Session, + result: Gio.AsyncResult + ) -> None: + + self._log.info('Request response received') + try: + self._input_stream = session.send_finish(result) + except Exception as error: + self._log.error(error) + quark = GLib.quark_try_string('g-io-error-quark') + if error.matches(quark, Gio.IOErrorEnum.CANCELLED): + self._set_cancelled() + else: + self._set_failed(HTTPRequestError.UNKNOWN) + return + + response_headers = self._message.get_response_headers() + self._content_length = response_headers.get_content_length() + self._content_type = response_headers.get_content_type() + + if self._message.get_status() != Soup.Status.OK: + self._set_failed(HTTPRequestError.STATUS) + return + + if self._content_length == 0: + self._set_failed(HTTPRequestError.MISSING_CONTENT_LENGTH) + return + + self.notify('started') + + if self._file is not None: + thread = Thread(target=self._thread_write_to_file, + args=(self._content_length,)) + thread.start() + + else: + self._read_bytes_async() + + def _thread_write_to_file(self, content_length: int) -> None: + received_size = 0 + + while True: + try: + data = self._input_stream.read_bytes(CHUNK_SIZE, + self._cancellable) + except GLib.Error as error: + self._log.error(error) + quark = GLib.quark_try_string('g-io-error-quark') + if error.matches(quark, Gio.IOErrorEnum.CANCELLED): + result = HTTPRequestError.CANCELLED + else: + result = HTTPRequestError.UNKNOWN + + GLib.idle_add(self._set_thread_result, result) + return + + bytes_ = data.get_data() + if not bytes_: + GLib.idle_add(self._set_thread_result) + return + + length = len(bytes_) + received_size += length + if received_size > content_length: + GLib.idle_add(self._set_thread_result, + HTTPRequestError.CONTENT_OVERFLOW) + return + + try: + self._output_stream.write_all(bytes_, self._cancellable) + except Exception as error: + self._log.error(error) + quark = GLib.quark_try_string('g-io-error-quark') + if error.matches(quark, Gio.IOErrorEnum.CANCELLED): + result = HTTPRequestError.CANCELLED + else: + result = HTTPRequestError.UNKNOWN + + GLib.idle_add(self._set_thread_result, result) + return + + GLib.idle_add(self._set_thread_progress, received_size) + + def _set_thread_progress(self, received_size: int): + self._received_size = received_size + if self._progress_callback is not None: + self._progress_callback(self, self.get_progress()) + + def _set_thread_result(self, + error: Optional[HTTPRequestError] = None + ) -> None: + + if error is None: + self._close_all_streams() + return + + if error == HTTPRequestError.CANCELLED: + self._set_cancelled() + + else: + self._set_failed(error) + + def _read_bytes_async(self) -> None: + self._input_stream.read_bytes_async(CHUNK_SIZE, + GLib.PRIORITY_LOW, + self._cancellable, + self._on_read_bytes_async_result) + + def _on_read_bytes_async_result(self, + input_stream: Gio.InputStream, + result: Gio.AsyncResult + ) -> None: + + try: + chunk = input_stream.read_bytes_finish(result) + except GLib.Error as error: + self._log.error(error) + quark = GLib.quark_try_string('g-io-error-quark') + if error.matches(quark, Gio.IOErrorEnum.CANCELLED): + self._set_cancelled() + else: + self._set_failed(HTTPRequestError.UNKNOWN) + return + + data = chunk.get_data() + size = len(data) + if size == 0: + self._close_all_streams() + return + + self._received_size += size + self._data += data + + if self._received_size > self._content_length: + self._log.warning('More data received than the' + 'advertised content length') + self._set_failed(HTTPRequestError.CONTENT_OVERFLOW) + return + + if self._progress_callback is not None: + self._progress_callback(self, self.get_progress()) + + self._read_bytes_async() + + def _on_finished(self, message: Soup.Message) -> None: + self._set_finished() + + def _set_finished(self) -> None: + status = self._message.get_status() + if status == Soup.Status.NONE: + # Message has not been sent, can happen when we cancel the message + # before it is sent. The finished signal triggers before the + # cancelled exception. + return + + if self._is_finished: + return + + if self._received_size != self._content_length: + self._set_failed(HTTPRequestError.INCOMPLETE) + return + + if status != Soup.Status.OK: + self._set_failed(HTTPRequestError.STATUS) + return + + self._set_complete() + + def _set_failed(self, error: HTTPRequestError) -> None: + self._close_all_streams() + self.notify('failed', error) + self._cleanup() + + def _set_cancelled(self) -> None: + self._close_all_streams() + self.notify('cancelled') + self._cleanup() + + def _set_complete(self) -> None: + self._close_all_streams() + self.notify('complete') + self._cleanup() + + def _close_all_streams(self) -> None: + if self._input_stream is not None: + if not self._input_stream.is_closed(): + self._input_stream.close(None) + + if self._output_stream is not None: + if not self._output_stream.is_closed(): + self._output_stream.close(None) + + def _cleanup(self) -> None: + if self._is_finished: + raise ValueError('Request already finished') + + self._log.info('Run cleanup') + self._is_finished = True + + self._data = b'' + self._message.run_dispose() + + self._cancellable = None + self._session = None + self._progress_callback = None + self._input_stream = None + self._output_stream = None + self._file = None + + self.notify('destroyed') + self.remove_subscriptions() + + def __repr__(self) -> str: + return f'Request({id(self)})' ===================================== test/unit/test_http.py ===================================== @@ -0,0 +1,153 @@ +import unittest +from unittest.mock import call +from unittest.mock import Mock +from unittest.mock import patch +import os + +from gi.repository import GLib +from gi.repository import Soup + +from nbxmpp.const import HTTPRequestError +from nbxmpp.http import HTTPSession + + +TEST_DOWNLOAD_FILE = 'https://gajim.org/downloads/snap/win/build/pybonjour-1.1.1.zip' +FILE_DOES_NOT_EXIST = 'https://gajim.org/downloads/1.4/no-file.tar.gz' + + +import logging +consoleloghandler = logging.StreamHandler() +log = logging.getLogger('nbxmpp.http') +log.setLevel(logging.DEBUG) +log.addHandler(consoleloghandler) + + +(a)unittest.skipUnless(os.environ.get('NBXMPP_EXTERNAL_UNIT_TESTS'), + 'ENV var for external tests not set') +class HTTP(unittest.TestCase): + + @classmethod + def setUpClass(cls): + pass + + @classmethod + def tearDownClass(cls): + pass + + def test_in_memory_download_to_file(self): + + mainloop = GLib.MainLoop() + + session = HTTPSession() + request = session.create_request() + + with patch.object(request, 'notify', wraps=request.notify) as n_mock: + + progress_func = Mock() + request.set_progress_callback(progress_func) + request.subscribe('destroyed', lambda *args: mainloop.quit()) + request.send('GET', TEST_DOWNLOAD_FILE, '/home/lovetox/Downloads/test123') + + GLib.timeout_add_seconds(10, mainloop.quit) + mainloop.run() + + progress_func.assert_called() + n_mock.assert_has_calls([call('started'), + call('complete'), + call('destroyed')]) + + def test_in_memory_download(self): + + mainloop = GLib.MainLoop() + + session = HTTPSession() + request = session.create_request() + + with patch.object(request, 'notify', wraps=request.notify) as n_mock: + + progress_func = Mock() + request.set_progress_callback(progress_func) + request.subscribe('destroyed', lambda *args: mainloop.quit()) + request.send('GET', TEST_DOWNLOAD_FILE) + + GLib.timeout_add_seconds(10, mainloop.quit) + mainloop.run() + + progress_func.assert_called() + n_mock.assert_has_calls([call('started'), + call('complete'), + call('destroyed')]) + + def test_download_cancelled_before_start(self): + + mainloop = GLib.MainLoop() + + session = HTTPSession() + request = session.create_request() + + with patch.object(request, 'notify', wraps=request.notify) as n_mock: + + progress_func = Mock() + request.set_progress_callback(progress_func) + request.subscribe('destroyed', lambda *args: mainloop.quit()) + request.send('GET', TEST_DOWNLOAD_FILE) + + GLib.timeout_add(10, request.cancel) + GLib.timeout_add_seconds(2, mainloop.quit) + + mainloop.run() + + progress_func.assert_not_called() + n_mock.assert_has_calls([call('cancelled'), + call('destroyed')]) + + def test_download_cancelled_after_start(self): + + mainloop = GLib.MainLoop() + + session = HTTPSession() + request = session.create_request() + + def _on_progress(req, progress): + req.cancel() + + with patch.object(request, 'notify', wraps=request.notify) as n_mock: + + request.set_progress_callback(_on_progress) + request.subscribe('destroyed', lambda *args: mainloop.quit()) + request.send('GET', TEST_DOWNLOAD_FILE) + + GLib.timeout_add_seconds(10, mainloop.quit) + + mainloop.run() + + n_mock.assert_has_calls([call('started'), + call('cancelled'), + call('destroyed')]) + + def test_download_failed_404(self): + + mainloop = GLib.MainLoop() + + session = HTTPSession() + request = session.create_request() + + with patch.object(request, 'notify', wraps=request.notify) as n_mock: + + progress_func = Mock() + request.set_progress_callback(progress_func) + request.subscribe('destroyed', lambda *args: mainloop.quit()) + request.send('GET', FILE_DOES_NOT_EXIST) + + GLib.timeout_add_seconds(5, mainloop.quit) + + mainloop.run() + + progress_func.assert_not_called() + n_mock.assert_has_calls([call('failed', HTTPRequestError.STATUS), + call('destroyed')]) + self.assertEqual(request.get_status(), Soup.Status.NOT_FOUND) + + +if __name__ == '__main__': + unittest.main() View it on GitLab: https://dev.gajim.org/gajim/python-nbxmpp/-/commit/af207e3deb812e666d1b88b2… -- View it on GitLab: https://dev.gajim.org/gajim/python-nbxmpp/-/commit/af207e3deb812e666d1b88b2… You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/python-nbxmpp][soup3] 3 commits: feat: Add message reactions (XEP-0444) support
by Philipp Hörist (＠lovetox) 09 Dec '22

09 Dec '22

Philipp Hörist pushed to branch soup3 at gajim / python-nbxmpp Commits: 8293ab4c by Nicoco at 2022-12-09T09:59:46+00:00 feat: Add message reactions (XEP-0444) support - - - - - 3258caa9 by Philipp Hörist at 2022-12-09T11:00:43+01:00 change: Port to libsoup3 - - - - - cb6e84ad by Philipp Hörist at 2022-12-09T11:00:43+01:00 More http stuff - - - - - 15 changed files: - nbxmpp/__init__.py - nbxmpp/addresses.py - nbxmpp/const.py - nbxmpp/dispatcher.py - + nbxmpp/http.py - nbxmpp/modules/muclumbus.py - + nbxmpp/modules/reactions.py - nbxmpp/namespaces.py - nbxmpp/protocol.py - nbxmpp/structs.py - nbxmpp/task.py - nbxmpp/websocket.py - python-nbxmpp.doap - + test/unit/test_http.py - + test/unit/test_reactions.py Changes: ===================================== nbxmpp/__init__.py ===================================== @@ -2,6 +2,6 @@ import gi from .protocol import * -gi.require_version('Soup', '2.4') +gi.require_version('Soup', '3.0') __version__: str = '3.2.5' ===================================== nbxmpp/addresses.py ===================================== @@ -19,6 +19,8 @@ import logging from collections import namedtuple from gi.repository import Soup +from gi.repository import GLib +from gi.repository import Gio import nbxmpp from nbxmpp.util import Observable @@ -137,31 +139,43 @@ class ServerAddresses(Observable): def _resolve_alternatives(self) -> None: session = Soup.Session() - session.props.timeout = 5 - session.props.user_agent = f'nbxmpp/{nbxmpp.__version__}' + session.set_timeout(5) + session.set_user_agent(f'nbxmpp/{nbxmpp.__version__}') message = Soup.Message.new( 'GET', f'https://{self._domain}/.well-known/host-meta') - session.queue_message(message, self._on_alternatives_result) + session.send_and_read_async(message, + GLib.PRIORITY_DEFAULT, + None, + self._on_alternatives_result, + message) def _on_alternatives_result(self, - _session: Soup.Session, + session: Soup.Session, + result: Gio.AsyncResult, message: Soup.Message) -> None: - status = message.props.status_code + try: + response = session.send_and_read_finish(result) + except Exception as error: + log.error('Failed to read response: %s', error) + self._on_request_resolved() + return + + status = message.get_status() if status != Soup.Status.OK: - error = message.props.reason_phrase + error = message.get_reason_phrase() log.info('Failed to retrieve host-meta file: %s %s', status, error) self._on_request_resolved() return - response_body = message.props.response_body - if response_body is None or not response_body.data: + response_body = response.get_data() + if response_body is None: log.info('No response body data found') self._on_request_resolved() return try: - uri = parse_websocket_uri(response_body.data) + uri = parse_websocket_uri(response_body.decode()) except Exception as error: log.info('Error parsing websocket uri: %s', error) self._on_request_resolved() ===================================== nbxmpp/const.py ===================================== @@ -453,6 +453,13 @@ class Mode(IntEnum): return self == Mode.ANONYMOUS_TEST +class HTTPSessionError(IntEnum): + UNKNOWN = 0 + MISSING_CONTENT_LENGTH = 1 + INCOMPLETE = 2 + STATUS = 3 + + MOODS = [ 'afraid', 'amazed', ===================================== nbxmpp/dispatcher.py ===================================== @@ -85,6 +85,7 @@ from nbxmpp.modules.delimiter import Delimiter from nbxmpp.modules.roster import Roster from nbxmpp.modules.last_activity import LastActivity from nbxmpp.modules.entity_time import EntityTime +from nbxmpp.modules.reactions import Reactions from nbxmpp.modules.misc import unwrap_carbon from nbxmpp.modules.misc import unwrap_mam from nbxmpp.util import get_properties_struct @@ -199,6 +200,7 @@ class StanzaDispatcher(Observable): self._modules['Roster'] = Roster(self._client) self._modules['LastActivity'] = LastActivity(self._client) self._modules['EntityTime'] = EntityTime(self._client) + self._modules['Reactions'] = Reactions(self._client) for instance in self._modules.values(): for handler in instance.handlers: ===================================== nbxmpp/http.py ===================================== @@ -0,0 +1,264 @@ +# This file is part of Gajim. +# +# Gajim is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published +# by the Free Software Foundation; version 3 only. +# +# Gajim is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with Gajim. If not, see <http://www.gnu.org/licenses/>. + +# XEP-0363: HTTP File Upload + +from __future__ import annotations + +from typing import Any +from typing import Literal +from typing import Callable +from typing import Optional + +import logging + +from gi.repository import Soup +from gi.repository import Gio +from gi.repository import GLib + +import nbxmpp +from nbxmpp.const import HTTPSessionError +from nbxmpp.util import Observable + + +log = logging.getLogger('gajim.c.http') + + +HTTP_METHODS_T = Literal['GET', 'POST'] +CHUNK_SIZE = 32768 + + +class HTTPLogAdapter(logging.LoggerAdapter): + def process(self, msg: str, kwargs: Any) -> tuple[str, Any]: + return f'{self.extra["session"]}: {msg}', kwargs + + +class HTTPSessionManager: + def __init__(self) -> None: + pass + + + +class HTTPSession(Observable): + + ''' + Signals + - started + - complete + - failed + - cancelled + ''' + + def __init__(self) -> None: + Observable.__init__(self, HTTPLogAdapter(log, extra={'session': self})) + self._session = Soup.Session() + self._session.set_user_agent(f'nbxmpp/{nbxmpp.__version__}') + + self._data = b'' + self._received_size = 0 + self._uri = '' + + self._cancellable = Gio.Cancellable() + self._input_stream = None + self._is_finished = False + + self._content_length = 0 + self._content_type = '' + + self._message = None + self._progress_callback: Optional[Callable[..., None]] = None + + self._log.info('Created') + + def get_content_length(self) -> int: + return self._content_length + + def get_content_type(self) -> str: + return self._content_type + + def get_data(self) -> bytes: + return self._data + + def get_uri(self) -> str: + return self._uri + + def get_status(self) -> Soup.Status: + return self._message.get_status() + + def get_progress(self) -> float: + if self._received_size == 0: + return 0 + return self._received_size / self._content_length + + def cancel(self) -> None: + if self._is_finished: + raise ValueError('Session already finished') + + self._cancellable.cancel() + + def set_proxy_resolver(self, + resolver: Optional[Gio.SimpleProxyResolver] + ) -> None: + + self._session.set_proxy_resolver(resolver) + + def set_progress_callback(self, func: Any) -> None: + self._progress_callback = func + + def _check_data_overflow(self) -> bool: + return self._received_size > self._content_length + + def make_request(self, method: HTTP_METHODS_T, uri: str) -> None: + if self._is_finished: + raise ValueError('Session already finished') + + self._uri = uri + self._message = Soup.Message.new(method, uri) + self._message.connect('finished', self._on_finished) + self._session.send_async(self._message, + GLib.PRIORITY_DEFAULT, + self._cancellable, + self._on_response) + + self._log.info('Request sent') + + def _on_response(self, + session: Soup.Session, + result: Gio.AsyncResult + ) -> None: + + try: + self._input_stream = session.send_finish(result) + except Exception as error: + self._log.error(error) + quark = GLib.quark_try_string('g-io-error-quark') + if error.matches(quark, Gio.IOErrorEnum.CANCELLED): + self._set_cancelled() + else: + self._set_failed(HTTPSessionError.UNKNOWN) + return + + response_headers = self._message.get_response_headers() + self._content_length = response_headers.get_content_length() + self._content_type = response_headers.get_content_type() + + if self._message.get_status() != Soup.Status.OK: + self._set_failed(HTTPSessionError.STATUS) + return + + if self._content_length == 0: + self._set_failed(HTTPSessionError.MISSING_CONTENT_LENGTH) + return + + self.notify('started') + + self._read_bytes_async() + + def _read_bytes_async(self) -> None: + self._input_stream.read_bytes_async(CHUNK_SIZE, + GLib.PRIORITY_LOW, + self._cancellable, + self._on_read_bytes_async_result) + + def _on_read_bytes_async_result(self, + input_stream: Gio.InputStream, + result: Gio.AsyncResult + ) -> None: + + try: + chunk = input_stream.read_bytes_finish(result) + except GLib.Error as error: + self._log.error(error) + quark = GLib.quark_try_string('g-io-error-quark') + if error.matches(quark, Gio.IOErrorEnum.CANCELLED): + self._set_cancelled() + else: + self._set_failed(HTTPSessionError.UNKNOWN) + return + + data = chunk.get_data() + size = len(data) + if size == 0: + input_stream.close(None) + return + + self._received_size += size + self._data += data + + if self._check_data_overflow(): + self._log.warning('More data received than the' + 'advertised content length') + self.cancel() + return + + if self._progress_callback is not None: + self._progress_callback(self, self.get_progress()) + + self._read_bytes_async() + + def _on_finished(self, message: Soup.Message) -> None: + self._set_finished() + + def _set_finished(self) -> None: + status = self._message.get_status() + if status == Soup.Status.NONE: + # Message has not been sent, can happen when we cancel the message + # before it is sent. The finished signal triggers before the + # cancelled exception. + return + + if self._is_finished: + return + + if self._received_size != self._content_length: + self._set_failed(HTTPSessionError.INCOMPLETE) + return + + if status != Soup.Status.OK: + self._set_failed(HTTPSessionError.STATUS) + return + + self._set_complete() + + def _set_failed(self, error: HTTPSessionError) -> None: + self.notify('failed', error) + self._cleanup() + + def _set_cancelled(self) -> None: + self.notify('cancelled') + self._cleanup() + + def _set_complete(self) -> None: + self.notify('complete') + self._cleanup() + + def _cleanup(self) -> None: + if self._is_finished: + raise ValueError('Session already finished') + + self._log.info('Run cleanup') + self._is_finished = True + if self._input_stream is not None: + if not self._input_stream.is_closed(): + self._input_stream.close() + + self._data = b'' + self._message.run_dispose() + self._cancellable = None + self._session = None + self._progress_callback = None + self.remove_subscriptions() + + def __repr__(self) -> str: + return f'Session({id(self)})' ===================================== nbxmpp/modules/muclumbus.py ===================================== @@ -51,7 +51,7 @@ class Muclumbus(BaseModule): if proxy is None: return self._proxy_resolver = proxy.get_resolver() - self._soup_session.props.proxy_resolver = self._proxy_resolver + self._soup_session.set_proxy_resolver(self._proxy_resolver) @iq_request_task def request_parameters(self, jid): @@ -141,24 +141,21 @@ class Muclumbus(BaseModule): if after is not None: search['after'] = after + body = json.dumps(search).encode() message = Soup.Message.new('POST', uri) - message.set_request('application/json', - Soup.MemoryUse.COPY, - json.dumps(search).encode()) + message.set_request_body_from_bytes('application/json', body) - response_message = yield message + response_body = yield message - soup_body = response_message.get_property('response-body') - - if response_message.status_code != 200: - self._log.warning(soup_body.data) + if message.props.status_code != Soup.Status.OK: + self._log.warning(response_body) yield MuclumbusResult(first=None, last=None, max=None, end=True, items=[]) - response = json.loads(soup_body.data) + response = json.loads(response_body) result = response['result'] items = result.get('items') ===================================== nbxmpp/modules/reactions.py ===================================== @@ -0,0 +1,69 @@ +# Copyright (C) 2022 Philipp Hörist <philipp AT hoerist.com> +# +# This file is part of nbxmpp. +# +# This program is free software; you can redistribute it and/or +# modify it under the terms of the GNU General Public License +# as published by the Free Software Foundation; either version 3 +# of the License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; If not, see <http://www.gnu.org/licenses/>. +import typing + +from nbxmpp.namespaces import Namespace +from nbxmpp.structs import StanzaHandler, MessageProperties +from nbxmpp.structs import Reactions as ReactionStruct +from nbxmpp.modules.base import BaseModule + +if typing.TYPE_CHECKING: + from nbxmpp.client import Client + from nbxmpp.protocol import Message + + +class Reactions(BaseModule): + def __init__(self, client: 'Client'): + BaseModule.__init__(self, client) + + self._client = client + self.handlers = [ + StanzaHandler( + name='message', + callback=self._process_message_reaction, + ns=Namespace.REACTIONS, + priority=15, + ), + ] + + def _process_message_reaction( + self, + _client: 'Client', + stanza: 'Message', + properties: MessageProperties + ) -> None: + reactions = stanza.getTag('reactions', namespace=Namespace.REACTIONS) + + if reactions is None: + return + + id_ = reactions.getAttr('id') + if not id_: + self._log.warning('Reactions without ID') + return + + emojis = set() + for reaction in reactions.getTags('reaction'): + # we strip for clients that might add white spaces and/or + # new lines in the reaction content. + emoji = reaction.getData().strip() + if emoji: + emojis.add(emoji) + else: + self._log.warning('Empty reaction') + + properties.reactions = ReactionStruct(id_, emojis) ===================================== nbxmpp/namespaces.py ===================================== @@ -134,6 +134,7 @@ class _Namespaces: PUBSUB_OWNER: str = 'http://jabber.org/protocol/pubsub#owner' PUBSUB_PUBLISH_OPTIONS: str = 'http://jabber.org/protocol/pubsub#publish-options' PUBSUB_NODE_MAX: str = 'http://jabber.org/protocol/pubsub#config-node-max' + REACTIONS: str = 'urn:xmpp:reactions:0' RECEIPTS: str = 'urn:xmpp:receipts' REGISTER: str = 'jabber:iq:register' REGISTER_FEATURE: str = 'http://jabber.org/features/iq-register' ===================================== nbxmpp/protocol.py ===================================== @@ -21,6 +21,7 @@ sub- stanzas) handling routines from __future__ import annotations from typing import Any +from typing import Iterable from typing import Union from typing import Optional from typing import cast @@ -1272,6 +1273,27 @@ class Message(Protocol): def setHint(self, hint): self.setTag(hint, namespace=Namespace.HINTS) + def setReactions(self, target_id: str, emojis: Iterable[str]): + reactions = self.addChild( + 'reactions', namespace=Namespace.REACTIONS, attrs={"id": target_id}) + for e in emojis: + reactions.addChild( + 'reaction', namespace=Namespace.REACTIONS, payload=[e]) + + def getReactions(self) -> Optional[tuple[str, set[str]]]: + reactions = self.getTag('reactions', namespace=Namespace.REACTIONS) + if not reactions: + return None + + react_to = reactions.getAttr('id') + if not react_to: + return None + + tags = reactions.getTags('reaction', namespace=Namespace.REACTIONS) + + # strip() in case clients surround emojis with whitespace + return react_to, {t.getData().strip() for t in tags} + class Presence(Protocol): ===================================== nbxmpp/structs.py ===================================== @@ -30,8 +30,8 @@ from dataclasses import dataclass from dataclasses import field from datetime import datetime -from gi.repository import Soup from gi.repository import Gio +from gi.repository import GLib from nbxmpp.simplexml import Node from nbxmpp.namespaces import Namespace @@ -708,8 +708,8 @@ class ProxyData(NamedTuple): def get_uri(self) -> str: if self.username is not None: - user_pass = Soup.uri_encode('%s:%s' % (self.username, - self.password)) + user_pass = f'{self.username}:{self.password}' + user_pass = GLib.uri_escape_string(user_pass, None, False) return '%s://%s@%s' % (self.type, user_pass, self.host) @@ -746,6 +746,11 @@ class ChatMarker(NamedTuple): return self.type == 'acknowledged' +class Reactions(NamedTuple): + id: str + emojis: set[str] + + class CommonError: def __init__(self, stanza): self._stanza_name = stanza.getName() @@ -993,6 +998,7 @@ class MessageProperties: xhtml: Optional[str] = None security_label = None chatstate = None + reactions: Optional[Reactions] = None def is_from_us(self, bare_match: bool = True): if self.from_ is None: ===================================== nbxmpp/task.py ===================================== @@ -29,6 +29,7 @@ from functools import wraps from gi.repository import Soup from gi.repository import GLib +from gi.repository import Gio from nbxmpp.modules.base import BaseModule from nbxmpp.simplexml import Node @@ -385,11 +386,32 @@ class HTTPRequestTask(Task): def _run_async(self, message): # pylint: disable=arguments-renamed - self._session.queue_message(message, self._async_finished, None) + self._session.send_and_read_async(message, + GLib.PRIORITY_DEFAULT, + None, + self._async_finished, + message) - def _async_finished(self, _session, message, _user_data): - if self._state != TaskState.CANCELLED: - self._next_step(message) + def _async_finished(self, + session: Soup.Session, + result: Gio.AsyncResult, + _message: Soup.Message): + + if self._state == TaskState.CANCELLED: + return + + try: + response = session.send_and_read_finish(result) + except Exception as error: + self._log.error('Failed to read response: %s', error) + response_body = None + + else: + response_body = response.get_data() + if response_body is not None: + response_body = response_body.decode() + + self._next_step(response_body) def _finalize(self): self._session = None ===================================== nbxmpp/websocket.py ===================================== @@ -22,7 +22,6 @@ from gi.repository import GLib from gi.repository import Gio from nbxmpp.const import TCPState -from nbxmpp.const import ConnectionType from nbxmpp.util import get_websocket_close_string from nbxmpp.util import convert_tls_error_flags from nbxmpp.connection import Connection @@ -35,11 +34,10 @@ class WebsocketConnection(Connection): Connection.__init__(self, *args, **kwargs) self._session = Soup.Session() - self._session.props.ssl_strict = False if self._log.getEffectiveLevel() == logging.INFO: self._session.add_feature( - Soup.Logger.new(Soup.LoggerLogLevel.BODY, -1)) + Soup.Logger.new(Soup.LoggerLogLevel.BODY)) self._websocket = None self._cancellable = Gio.Cancellable() @@ -53,11 +51,12 @@ class WebsocketConnection(Connection): self.state = TCPState.CONNECTING message = Soup.Message.new('GET', self._address.uri) - message.connect('starting', self._check_certificate) + message.connect('accept-certificate', self._check_certificate) message.set_flags(Soup.MessageFlags.NO_REDIRECT) self._session.websocket_connect_async(message, None, ['xmpp'], + GLib.PRIORITY_DEFAULT, self._cancellable, self._on_connect, None) @@ -91,19 +90,20 @@ class WebsocketConnection(Connection): # Soup.Session does this automatically raise NotImplementedError - def _check_certificate(self, message): - https_used, certificate, errors = message.get_https_status() - if not https_used and self._address.type == ConnectionType.PLAIN: - return + def _check_certificate(self, + _message, + certificate, + errors): self._peer_certificate = certificate self._peer_certificate_errors = convert_tls_error_flags(errors) if self._accept_certificate(): - return + return True self.notify('bad-certificate') self._cancellable.cancel() + return False def _on_websocket_message(self, _websocket, _type, message): data = message.get_data().decode() ===================================== python-nbxmpp.doap ===================================== @@ -415,5 +415,12 @@ <xmpp:version>0.2.1</xmpp:version> </xmpp:SupportedXep> </implements> + <implements> + <xmpp:SupportedXep> + <xmpp:xep rdf:resource="https://xmpp.org/extensions/xep-0444.html"/> + <xmpp:status>complete</xmpp:status> + <xmpp:version>0.1.0</xmpp:version> + </xmpp:SupportedXep> + </implements> </Project> </rdf:RDF> ===================================== test/unit/test_http.py ===================================== @@ -0,0 +1,108 @@ +import unittest +from unittest.mock import call +from unittest.mock import Mock + +from gi.repository import GLib +from gi.repository import Soup + +from nbxmpp.const import HTTPSessionError +from nbxmpp.http import HTTPSession + + +TEST_DOWNLOAD_FILE = 'https://gajim.org/downloads/1.4/gajim-1.4.0.tar.gz' +FILE_DOES_NOT_EXIST = 'https://gajim.org/downloads/1.4/no-file.tar.gz' + + +import logging +consoleloghandler = logging.StreamHandler() +log = logging.getLogger('nbxmpp') +log.setLevel(logging.CRITICAL) +log.addHandler(consoleloghandler) + + +class HTTP(unittest.TestCase): + + @classmethod + def setUpClass(cls): + pass + + @classmethod + def tearDownClass(cls): + pass + + def test_in_memory_download(self): + + mainloop = GLib.MainLoop() + + session = HTTPSession() + session.notify = Mock() + progress_func = Mock() + session.set_progress_callback(progress_func) + session.make_request('GET', TEST_DOWNLOAD_FILE) + + GLib.timeout_add_seconds(10, mainloop.quit) + mainloop.run() + + progress_func.assert_called() + session.notify.assert_has_calls([call('started'), + call('complete')]) + + def test_download_cancelled_before_start(self): + + mainloop = GLib.MainLoop() + + session = HTTPSession() + session.notify = Mock() + progress_func = Mock() + session.set_progress_callback(progress_func) + session.make_request('GET', TEST_DOWNLOAD_FILE) + + GLib.timeout_add(10, session.cancel) + GLib.timeout_add_seconds(2, mainloop.quit) + + mainloop.run() + + progress_func.assert_not_called() + session.notify.assert_has_calls([call('cancelled')]) + + def test_download_cancelled_after_start(self): + + mainloop = GLib.MainLoop() + + session = HTTPSession() + session.notify = Mock() + progress_func = Mock() + session.set_progress_callback(progress_func) + session.make_request('GET', TEST_DOWNLOAD_FILE) + + GLib.timeout_add(500, session.cancel) + GLib.timeout_add_seconds(2, mainloop.quit) + + mainloop.run() + + progress_func.assert_called() + session.notify.assert_has_calls([call('started'), + call('cancelled')]) + + def test_download_failed_404(self): + + mainloop = GLib.MainLoop() + + session = HTTPSession() + session.notify = Mock() + progress_func = Mock() + session.set_progress_callback(progress_func) + session.make_request('GET', FILE_DOES_NOT_EXIST) + + GLib.timeout_add_seconds(2, mainloop.quit) + + mainloop.run() + + progress_func.assert_not_called() + session.notify.assert_has_calls( + [call('failed', HTTPSessionError.STATUS)]) + self.assertEqual(session.get_status(), Soup.Status.NOT_FOUND) + + +if __name__ == '__main__': + unittest.main() ===================================== test/unit/test_reactions.py ===================================== @@ -0,0 +1,137 @@ +from test.lib.util import StanzaHandlerTest + +from nbxmpp.structs import Reactions as ReactionStruct +from nbxmpp.modules.reactions import Reactions +from nbxmpp.protocol import Message + + +class MockLog: + @staticmethod + def warning(_): + pass + + +class MockModule: + _log = MockLog + + @staticmethod + def is_emoji(s): + return Reactions.is_emoji(s) + + +class ReactionsTest(StanzaHandlerTest): + def test_reaction_parsing(self): + class P: + reactions: ReactionStruct + + xml = ''' + <message to='romeo(a)capulet.net/orchard' id='96d73204-a57a-11e9-88b8-4889e7820c76' type='chat'> + <reactions id='744f6e18-a57a-11e9-a656-4889e7820c76' xmlns='urn:xmpp:reactions:0'> + <reaction>👋 + </reaction> + <reaction>🐢</reaction> + </reactions> + <store xmlns='urn:xmpp:hints'/> + </message> + ''' + msg = Message(node=xml) + Reactions._process_message_reaction(MockModule, self, msg, P) + + self.assertEqual(P.reactions.id, '744f6e18-a57a-11e9-a656-4889e7820c76') + self.assertEqual(P.reactions.emojis, {'👋', '🐢'}) + + def test_no_reactions(self): + class P: + reactions: ReactionStruct = None + + xml = ''' + <message to='romeo(a)capulet.net/orchard' id='96d73204-a57a-11e9-88b8-4889e7820c76' type='chat'> + <store xmlns='urn:xmpp:hints'/> + </message> + ''' + msg = Message(node=xml) + Reactions._process_message_reaction(MockModule, self, msg, P) + + self.assertIsNone(P.reactions) + + def test_empty_reactions(self): + class P: + reactions: ReactionStruct + + xml = ''' + <message to='romeo(a)capulet.net/orchard' id='96d73204-a57a-11e9-88b8-4889e7820c76' type='chat'> + <reactions id='744f6e18-a57a-11e9-a656-4889e7820c76' xmlns='urn:xmpp:reactions:0' /> + <store xmlns='urn:xmpp:hints'/> + </message> + ''' + msg = Message(node=xml) + Reactions._process_message_reaction(MockModule, self, msg, P) + + self.assertEqual(len(P.reactions.emojis), 0) + + def test_invalid_reactions_no_id(self): + class P: + reactions: ReactionStruct + + xml = ''' + <message to='romeo(a)capulet.net/orchard' id='96d73204-a57a-11e9-88b8-4889e7820c76' type='chat'> + <reactions xmlns='urn:xmpp:reactions:0'> + <reaction>👋</reaction> + <reaction>🐢</reaction> + </reactions> + <store xmlns='urn:xmpp:hints'/> + </message> + ''' + msg = Message(node=xml) + Reactions._process_message_reaction(MockModule, self, msg, P) + self.assertFalse(hasattr(P, 'reactions')) + + def test_invalid_reactions_empty_id(self): + class P: + reactions: ReactionStruct + + xml = ''' + <message to='romeo(a)capulet.net/orchard' id='96d73204-a57a-11e9-88b8-4889e7820c76' type='chat'> + <reactions id='' xmlns='urn:xmpp:reactions:0'> + <reaction>👋</reaction> + <reaction>🐢</reaction> + </reactions> + <store xmlns='urn:xmpp:hints'/> + </message> + ''' + msg = Message(node=xml) + Reactions._process_message_reaction(MockModule, self, msg, P) + self.assertFalse(hasattr(P, 'reactions')) + + def test_invalid_reactions_empty_emoji(self): + class P: + reactions: ReactionStruct + + xml = ''' + <message to='romeo(a)capulet.net/orchard' id='96d73204-a57a-11e9-88b8-4889e7820c76' type='chat'> + <reactions id='sadfsadf' xmlns='urn:xmpp:reactions:0'> + <reaction></reaction> + <reaction>🐢</reaction> + </reactions> + <store xmlns='urn:xmpp:hints'/> + </message> + ''' + msg = Message(node=xml) + Reactions._process_message_reaction(MockModule, self, msg, P) + self.assertEqual(P.reactions.emojis, {'🐢'}) + + def test_set_reactions(self): + x = Message() + x.setReactions('id', '🐢') + self.assertEqual(x.getReactions(), ('id', {'🐢'})) + + x = Message() + x.setReactions('id', '🐢👋') + self.assertEqual(x.getReactions(), ('id', {'🐢', '👋'})) + + x = Message() + x.setReactions('id', '') + self.assertEqual(x.getReactions(), ('id', set())) + + x = Message() + self.assertIsNone(x.getReactions()) View it on GitLab: https://dev.gajim.org/gajim/python-nbxmpp/-/compare/e47074bc576c362d258e52f… -- View it on GitLab: https://dev.gajim.org/gajim/python-nbxmpp/-/compare/e47074bc576c362d258e52f… You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/python-nbxmpp][master] feat: Add message reactions (XEP-0444) support
by Philipp Hörist (＠lovetox) 09 Dec '22

09 Dec '22

Philipp Hörist pushed to branch master at gajim / python-nbxmpp Commits: 8293ab4c by Nicoco at 2022-12-09T09:59:46+00:00 feat: Add message reactions (XEP-0444) support - - - - - 7 changed files: - nbxmpp/dispatcher.py - + nbxmpp/modules/reactions.py - nbxmpp/namespaces.py - nbxmpp/protocol.py - nbxmpp/structs.py - python-nbxmpp.doap - + test/unit/test_reactions.py Changes: ===================================== nbxmpp/dispatcher.py ===================================== @@ -85,6 +85,7 @@ from nbxmpp.modules.delimiter import Delimiter from nbxmpp.modules.roster import Roster from nbxmpp.modules.last_activity import LastActivity from nbxmpp.modules.entity_time import EntityTime +from nbxmpp.modules.reactions import Reactions from nbxmpp.modules.misc import unwrap_carbon from nbxmpp.modules.misc import unwrap_mam from nbxmpp.util import get_properties_struct @@ -199,6 +200,7 @@ class StanzaDispatcher(Observable): self._modules['Roster'] = Roster(self._client) self._modules['LastActivity'] = LastActivity(self._client) self._modules['EntityTime'] = EntityTime(self._client) + self._modules['Reactions'] = Reactions(self._client) for instance in self._modules.values(): for handler in instance.handlers: ===================================== nbxmpp/modules/reactions.py ===================================== @@ -0,0 +1,69 @@ +# Copyright (C) 2022 Philipp Hörist <philipp AT hoerist.com> +# +# This file is part of nbxmpp. +# +# This program is free software; you can redistribute it and/or +# modify it under the terms of the GNU General Public License +# as published by the Free Software Foundation; either version 3 +# of the License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; If not, see <http://www.gnu.org/licenses/>. +import typing + +from nbxmpp.namespaces import Namespace +from nbxmpp.structs import StanzaHandler, MessageProperties +from nbxmpp.structs import Reactions as ReactionStruct +from nbxmpp.modules.base import BaseModule + +if typing.TYPE_CHECKING: + from nbxmpp.client import Client + from nbxmpp.protocol import Message + + +class Reactions(BaseModule): + def __init__(self, client: 'Client'): + BaseModule.__init__(self, client) + + self._client = client + self.handlers = [ + StanzaHandler( + name='message', + callback=self._process_message_reaction, + ns=Namespace.REACTIONS, + priority=15, + ), + ] + + def _process_message_reaction( + self, + _client: 'Client', + stanza: 'Message', + properties: MessageProperties + ) -> None: + reactions = stanza.getTag('reactions', namespace=Namespace.REACTIONS) + + if reactions is None: + return + + id_ = reactions.getAttr('id') + if not id_: + self._log.warning('Reactions without ID') + return + + emojis = set() + for reaction in reactions.getTags('reaction'): + # we strip for clients that might add white spaces and/or + # new lines in the reaction content. + emoji = reaction.getData().strip() + if emoji: + emojis.add(emoji) + else: + self._log.warning('Empty reaction') + + properties.reactions = ReactionStruct(id_, emojis) ===================================== nbxmpp/namespaces.py ===================================== @@ -134,6 +134,7 @@ class _Namespaces: PUBSUB_OWNER: str = 'http://jabber.org/protocol/pubsub#owner' PUBSUB_PUBLISH_OPTIONS: str = 'http://jabber.org/protocol/pubsub#publish-options' PUBSUB_NODE_MAX: str = 'http://jabber.org/protocol/pubsub#config-node-max' + REACTIONS: str = 'urn:xmpp:reactions:0' RECEIPTS: str = 'urn:xmpp:receipts' REGISTER: str = 'jabber:iq:register' REGISTER_FEATURE: str = 'http://jabber.org/features/iq-register' ===================================== nbxmpp/protocol.py ===================================== @@ -21,6 +21,7 @@ sub- stanzas) handling routines from __future__ import annotations from typing import Any +from typing import Iterable from typing import Union from typing import Optional from typing import cast @@ -1272,6 +1273,27 @@ class Message(Protocol): def setHint(self, hint): self.setTag(hint, namespace=Namespace.HINTS) + def setReactions(self, target_id: str, emojis: Iterable[str]): + reactions = self.addChild( + 'reactions', namespace=Namespace.REACTIONS, attrs={"id": target_id}) + for e in emojis: + reactions.addChild( + 'reaction', namespace=Namespace.REACTIONS, payload=[e]) + + def getReactions(self) -> Optional[tuple[str, set[str]]]: + reactions = self.getTag('reactions', namespace=Namespace.REACTIONS) + if not reactions: + return None + + react_to = reactions.getAttr('id') + if not react_to: + return None + + tags = reactions.getTags('reaction', namespace=Namespace.REACTIONS) + + # strip() in case clients surround emojis with whitespace + return react_to, {t.getData().strip() for t in tags} + class Presence(Protocol): ===================================== nbxmpp/structs.py ===================================== @@ -746,6 +746,11 @@ class ChatMarker(NamedTuple): return self.type == 'acknowledged' +class Reactions(NamedTuple): + id: str + emojis: set[str] + + class CommonError: def __init__(self, stanza): self._stanza_name = stanza.getName() @@ -993,6 +998,7 @@ class MessageProperties: xhtml: Optional[str] = None security_label = None chatstate = None + reactions: Optional[Reactions] = None def is_from_us(self, bare_match: bool = True): if self.from_ is None: ===================================== python-nbxmpp.doap ===================================== @@ -415,5 +415,12 @@ <xmpp:version>0.2.1</xmpp:version> </xmpp:SupportedXep> </implements> + <implements> + <xmpp:SupportedXep> + <xmpp:xep rdf:resource="https://xmpp.org/extensions/xep-0444.html"/> + <xmpp:status>complete</xmpp:status> + <xmpp:version>0.1.0</xmpp:version> + </xmpp:SupportedXep> + </implements> </Project> </rdf:RDF> ===================================== test/unit/test_reactions.py ===================================== @@ -0,0 +1,137 @@ +from test.lib.util import StanzaHandlerTest + +from nbxmpp.structs import Reactions as ReactionStruct +from nbxmpp.modules.reactions import Reactions +from nbxmpp.protocol import Message + + +class MockLog: + @staticmethod + def warning(_): + pass + + +class MockModule: + _log = MockLog + + @staticmethod + def is_emoji(s): + return Reactions.is_emoji(s) + + +class ReactionsTest(StanzaHandlerTest): + def test_reaction_parsing(self): + class P: + reactions: ReactionStruct + + xml = ''' + <message to='romeo(a)capulet.net/orchard' id='96d73204-a57a-11e9-88b8-4889e7820c76' type='chat'> + <reactions id='744f6e18-a57a-11e9-a656-4889e7820c76' xmlns='urn:xmpp:reactions:0'> + <reaction>👋 + </reaction> + <reaction>🐢</reaction> + </reactions> + <store xmlns='urn:xmpp:hints'/> + </message> + ''' + msg = Message(node=xml) + Reactions._process_message_reaction(MockModule, self, msg, P) + + self.assertEqual(P.reactions.id, '744f6e18-a57a-11e9-a656-4889e7820c76') + self.assertEqual(P.reactions.emojis, {'👋', '🐢'}) + + def test_no_reactions(self): + class P: + reactions: ReactionStruct = None + + xml = ''' + <message to='romeo(a)capulet.net/orchard' id='96d73204-a57a-11e9-88b8-4889e7820c76' type='chat'> + <store xmlns='urn:xmpp:hints'/> + </message> + ''' + msg = Message(node=xml) + Reactions._process_message_reaction(MockModule, self, msg, P) + + self.assertIsNone(P.reactions) + + def test_empty_reactions(self): + class P: + reactions: ReactionStruct + + xml = ''' + <message to='romeo(a)capulet.net/orchard' id='96d73204-a57a-11e9-88b8-4889e7820c76' type='chat'> + <reactions id='744f6e18-a57a-11e9-a656-4889e7820c76' xmlns='urn:xmpp:reactions:0' /> + <store xmlns='urn:xmpp:hints'/> + </message> + ''' + msg = Message(node=xml) + Reactions._process_message_reaction(MockModule, self, msg, P) + + self.assertEqual(len(P.reactions.emojis), 0) + + def test_invalid_reactions_no_id(self): + class P: + reactions: ReactionStruct + + xml = ''' + <message to='romeo(a)capulet.net/orchard' id='96d73204-a57a-11e9-88b8-4889e7820c76' type='chat'> + <reactions xmlns='urn:xmpp:reactions:0'> + <reaction>👋</reaction> + <reaction>🐢</reaction> + </reactions> + <store xmlns='urn:xmpp:hints'/> + </message> + ''' + msg = Message(node=xml) + Reactions._process_message_reaction(MockModule, self, msg, P) + self.assertFalse(hasattr(P, 'reactions')) + + def test_invalid_reactions_empty_id(self): + class P: + reactions: ReactionStruct + + xml = ''' + <message to='romeo(a)capulet.net/orchard' id='96d73204-a57a-11e9-88b8-4889e7820c76' type='chat'> + <reactions id='' xmlns='urn:xmpp:reactions:0'> + <reaction>👋</reaction> + <reaction>🐢</reaction> + </reactions> + <store xmlns='urn:xmpp:hints'/> + </message> + ''' + msg = Message(node=xml) + Reactions._process_message_reaction(MockModule, self, msg, P) + self.assertFalse(hasattr(P, 'reactions')) + + def test_invalid_reactions_empty_emoji(self): + class P: + reactions: ReactionStruct + + xml = ''' + <message to='romeo(a)capulet.net/orchard' id='96d73204-a57a-11e9-88b8-4889e7820c76' type='chat'> + <reactions id='sadfsadf' xmlns='urn:xmpp:reactions:0'> + <reaction></reaction> + <reaction>🐢</reaction> + </reactions> + <store xmlns='urn:xmpp:hints'/> + </message> + ''' + msg = Message(node=xml) + Reactions._process_message_reaction(MockModule, self, msg, P) + self.assertEqual(P.reactions.emojis, {'🐢'}) + + def test_set_reactions(self): + x = Message() + x.setReactions('id', '🐢') + self.assertEqual(x.getReactions(), ('id', {'🐢'})) + + x = Message() + x.setReactions('id', '🐢👋') + self.assertEqual(x.getReactions(), ('id', {'🐢', '👋'})) + + x = Message() + x.setReactions('id', '') + self.assertEqual(x.getReactions(), ('id', set())) + + x = Message() + self.assertIsNone(x.getReactions()) View it on GitLab: https://dev.gajim.org/gajim/python-nbxmpp/-/commit/8293ab4cbeb94bd25525a119… -- View it on GitLab: https://dev.gajim.org/gajim/python-nbxmpp/-/commit/8293ab4cbeb94bd25525a119… You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/gajim][master] cfix: AudioPreview: Use symbolic icons
by Philipp Hörist (＠lovetox) 08 Dec '22

08 Dec '22

Philipp Hörist pushed to branch master at gajim / gajim Commits: 38ed7621 by Philipp Hörist at 2022-12-09T00:26:52+01:00 cfix: AudioPreview: Use symbolic icons - - - - - 1 changed file: - gajim/data/gui/preview_audio.ui Changes: ===================================== gajim/data/gui/preview_audio.ui ===================================== @@ -140,7 +140,7 @@ <object class="GtkImage"> <property name="visible">True</property> <property name="can-focus">False</property> - <property name="icon-name">media-seek-backward</property> + <property name="icon-name">media-seek-backward-symbolic</property> </object> </child> </object> @@ -161,7 +161,7 @@ <property name="visible">True</property> <property name="can-focus">False</property> <property name="tooltip-text" translatable="yes">Start/stop playback</property> - <property name="icon-name">media-playback-start</property> + <property name="icon-name">media-playback-start-symbolic</property> </object> </child> </object> @@ -182,7 +182,7 @@ <property name="visible">True</property> <property name="can-focus">False</property> <property name="tooltip-text" translatable="yes">Forward 10 seconds</property> - <property name="icon-name">media-seek-forward</property> + <property name="icon-name">media-seek-forward-symbolic</property> </object> </child> </object> @@ -219,7 +219,7 @@ <property name="can-focus">False</property> <property name="halign">center</property> <property name="valign">center</property> - <property name="icon-name">list-remove</property> + <property name="icon-name">list-remove-symbolic</property> </object> </child> </object> @@ -300,7 +300,7 @@ <property name="can-focus">False</property> <property name="halign">center</property> <property name="valign">center</property> - <property name="icon-name">list-add</property> + <property name="icon-name">list-add-symbolic</property> </object> </child> </object> View it on GitLab: https://dev.gajim.org/gajim/gajim/-/commit/38ed76210f509541ba970e51bed28d1d… -- View it on GitLab: https://dev.gajim.org/gajim/gajim/-/commit/38ed76210f509541ba970e51bed28d1d… You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/gajim][master] fix: Remember last folder correctly after sending file
by Philipp Hörist (＠lovetox) 08 Dec '22

08 Dec '22

Philipp Hörist pushed to branch master at gajim / gajim Commits: 2b5ab697 by Philipp Hörist at 2022-12-09T00:13:08+01:00 fix: Remember last folder correctly after sending file - - - - - 1 changed file: - gajim/gtk/file_transfer_selector.py Changes: ===================================== gajim/gtk/file_transfer_selector.py ===================================== @@ -168,7 +168,7 @@ def add_files(self, uris: list[str]) -> None: row = FileRow(path, size_warning, jingle_warning) self._ui.listbox.add(row) - app.settings.set('last_send_dir', str(path)) + app.settings.set('last_send_dir', str(path.parent)) self._ui.listbox.show_all() View it on GitLab: https://dev.gajim.org/gajim/gajim/-/commit/2b5ab69751f687f6dd188d7346ff8833… -- View it on GitLab: https://dev.gajim.org/gajim/gajim/-/commit/2b5ab69751f687f6dd188d7346ff8833… You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/gajim][master] fix: Preview: Don't treat multi-line message body as previewable URL
by Philipp Hörist (＠lovetox) 08 Dec '22

08 Dec '22

Philipp Hörist pushed to branch master at gajim / gajim Commits: 2a595826 by mjk at 2022-12-08T22:55:46+00:00 fix: Preview: Don't treat multi-line message body as previewable URL - - - - - 1 changed file: - gajim/common/preview.py Changes: ===================================== gajim/common/preview.py ===================================== @@ -21,6 +21,7 @@ import logging import os +import re from pathlib import Path from urllib.parse import urlparse from urllib.parse import ParseResult @@ -33,6 +34,7 @@ from gajim.common import app from gajim.common import configpaths +from gajim.common import regex from gajim.common.const import MIME_TYPES from gajim.common.helpers import AdditionalDataDict from gajim.common.helpers import load_file_async @@ -53,6 +55,8 @@ log = logging.getLogger('gajim.c.preview') +IRI_RX = re.compile(regex.IRI) + PREVIEWABLE_MIME_TYPES = get_previewable_mime_types() mime_types = set(MIME_TYPES) # Merge both: if it’s a previewable image, it should be allowed @@ -333,8 +337,9 @@ def _accept_uri(urlparts: ParseResult, def is_previewable(self, text: str, additional_data: AdditionalDataDict) -> bool: - if len(text.split(' ')) > 1: - # urlparse doesn't recognise spaces as URL delimiter + if not IRI_RX.fullmatch(text): + # urlparse removes whitespace (and who knows what else) from URLs, + # so can't be used for validation. return False uri = text View it on GitLab: https://dev.gajim.org/gajim/gajim/-/commit/2a5958265717a72181156511bb8521c4… -- View it on GitLab: https://dev.gajim.org/gajim/gajim/-/commit/2a5958265717a72181156511bb8521c4… You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/gajim][master] feat: Allow sending files by copy-pasting them from file managers
by Philipp Hörist (＠lovetox) 08 Dec '22

08 Dec '22

Philipp Hörist pushed to branch master at gajim / gajim Commits: 84ff274e by mjk at 2022-12-08T22:38:34+00:00 feat: Allow sending files by copy-pasting them from file managers - - - - - 5 changed files: - gajim/gtk/chat_stack.py - gajim/gtk/control.py - gajim/gtk/file_transfer_selector.py - gajim/gtk/filechoosers.py - gajim/gtk/message_actions_box.py Changes: ===================================== gajim/gtk/chat_stack.py ===================================== @@ -574,11 +574,11 @@ def _on_action(self, if 'jingle' in name: method = 'jingle' - file_paths = None + uris = None if param is not None: - file_paths = param.get_strv() or None + uris = param.get_strv() or None self._show_chat_function_page( - FunctionMode.SEND_FILE, method, file_paths) + FunctionMode.SEND_FILE, method, uris) elif action_name == 'add-to-roster': if (isinstance(contact, GroupchatParticipant) and ===================================== gajim/gtk/control.py ===================================== @@ -36,7 +36,6 @@ from gajim.common import ged from gajim.common import helpers from gajim.common import types -from gajim.common.helpers import get_file_path_from_dnd_dropped_uri from gajim.common.helpers import to_user_string from gajim.common.i18n import _ from gajim.common.ged import EventHelper @@ -496,18 +495,8 @@ def _on_jump_to_end(self, _button: Gtk.Button) -> None: self.reset_view() def drag_data_file_transfer(self, selection: Gtk.SelectionData) -> None: - uris = selection.get_uris() - paths: list[str] = [] - for uri in uris: - path = get_file_path_from_dnd_dropped_uri(uri) - if path is None or not path.is_file(): - self.add_info_message( - _('You dropped something Gajim could not ' - 'process: %s' % path)) - continue - paths.append(str(path)) - - app.window.activate_action('send-file', GLib.Variant('as', paths)) + app.window.activate_action('send-file', + GLib.Variant('as', selection.get_uris())) def get_our_nick(self) -> str: if isinstance(self.contact, GroupchatParticipant): ===================================== gajim/gtk/file_transfer_selector.py ===================================== @@ -17,7 +17,6 @@ from typing import Any from typing import cast from typing import Optional -from typing import Union import logging from pathlib import Path @@ -154,12 +153,13 @@ def get_catalog(self) -> list[tuple[Path, str, JID]]: return catalog - def add_files(self, file_paths: Union[list[Path], list[str]]) -> None: - for path in file_paths: - if isinstance(path, str): - path = Path(path) - - if path.is_dir(): + def add_files(self, uris: list[str]) -> None: + for uri in uris: + path = get_file_path_from_dnd_dropped_uri(uri) + if path is None or not path.is_file(): + self._add_warning_message( + 'Could not add %s' + % (str(path) if path else uri)) continue size_warning = bool(self._method == 'httpupload' and @@ -172,6 +172,9 @@ def add_files(self, file_paths: Union[list[Path], list[str]]) -> None: self._ui.listbox.show_all() + def _add_warning_message(self, msg: str) -> None: + log.warning(msg) # TODO: replace with UI + def _on_destroy(self, _widget: FileTransferSelector) -> None: app.check_finalize(self) @@ -195,16 +198,7 @@ def _on_drag_data_received(self, return if target_type == 80: - uris = selection.get_uris() - paths: list[Path] = [] - for uri in uris: - path = get_file_path_from_dnd_dropped_uri(uri) - if path is None or not path.is_file(): - log.warning('Could not add file %s', str(path)) - continue - paths.append(path) - - self.add_files(paths) + self.add_files(selection.get_uris()) def _on_files_changed(self, _listbox: Gtk.ListBox, _row: FileRow) -> None: file_paths = self._get_file_paths() ===================================== gajim/gtk/filechoosers.py ===================================== @@ -51,14 +51,11 @@ class BaseFileChooser: def _on_response(self, dialog: Union[Gtk.FileChooser, Gtk.FileChooserNative], response: Gtk.ResponseType, - accept_cb: Callable[..., Any], + accept_cb: Callable[[list[str]], None], cancel_cb: Optional[Callable[..., Any]] ) -> None: if response == Gtk.ResponseType.ACCEPT: - if self.get_select_multiple(): - accept_cb(dialog.get_filenames()) - else: - accept_cb(dialog.get_filename()) + accept_cb(dialog.get_uris()) if response in (Gtk.ResponseType.CANCEL, Gtk.ResponseType.DELETE_EVENT): @@ -182,7 +179,7 @@ class GtkFileChooserDialog(Gtk.FileChooserDialog, BaseFileChooser): _preview_size = (200, 200) def __init__(self, - accept_cb: Callable[..., Any], + accept_cb: Callable[[list[str]], None], cancel_cb: Optional[Callable[..., Any]] = None, transient_for: Optional[Gtk.Window] = None, path: Optional[str] = None, ===================================== gajim/gtk/message_actions_box.py ===================================== @@ -17,7 +17,7 @@ from typing import Any from typing import Optional -import os +from pathlib import Path import tempfile import logging import uuid @@ -531,22 +531,30 @@ def _on_msg_textview_key_press_event(self, return False def _on_paste_clipboard(self, - _texview: MessageInputTextView + texview: MessageInputTextView ) -> None: clipboard = Gtk.Clipboard.get(Gdk.SELECTION_CLIPBOARD) + + uris = clipboard.wait_for_uris() + if uris: + app.window.activate_action('send-file', GLib.Variant('as', uris)) + # prevent TextView from pasting the URIs as text: + texview.stop_emission_by_name('paste-clipboard') + return + log.info('No URIs pasted') + image = clipboard.wait_for_image() if image is None: log.info('No image pasted') return - temp_dir = tempfile.gettempdir() - image_path = os.path.join(temp_dir, f'{uuid.uuid4()}.png') + temp_dir = Path(tempfile.gettempdir()) + image_path = temp_dir / f'{uuid.uuid4()}.png' - image.savev(image_path, 'png', [], []) - if image is None: + if not image.savev(str(image_path), 'png', [], []): log.error('Could not process pasted image') return app.window.activate_action( - 'send-file', GLib.Variant('as', [image_path])) + 'send-file', GLib.Variant('as', [image_path.as_uri()])) View it on GitLab: https://dev.gajim.org/gajim/gajim/-/commit/84ff274e345da79e075589d48026ec76… -- View it on GitLab: https://dev.gajim.org/gajim/gajim/-/commit/84ff274e345da79e075589d48026ec76… You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/gajim][master] feat: Preview: Add audio preview controls and visualization
by Philipp Hörist (＠lovetox) 08 Dec '22

08 Dec '22

Philipp Hörist pushed to branch master at gajim / gajim Commits: ca5f6104 by mesonium at 2022-12-08T12:14:05+00:00 feat: Preview: Add audio preview controls and visualization * Remove the delay when starting a playback * Don't scrub during seek when dragging the slider * Don't open audio stream connections before playing * Determine the duration early to prevent missing duration info + Show total duration + Add option to display remaining play time + Add possibility to seek by clicking into the seekbar + Add possibility to seek by scrolling with the mouse wheel + Add fast forward and rewind buttons + Add buttons to change the playback speed + Add automatic restoration of the audio player settings in a session + Add automatic stop of other streams when starting to play + Add a visualization of the RMS peaks - - - - - 10 changed files: - gajim/common/preview.py - gajim/common/text_helpers.py - + gajim/data/gui/preview_audio.ui - gajim/data/style/gajim.css - gajim/gtk/builder.pyi - gajim/gtk/preview_audio.py - + gajim/gtk/preview_audio_analyzer.py - + gajim/gtk/preview_audio_visualizer.py - pyproject.toml - test/no_gui/test_text_helpers.py Changes: ===================================== gajim/common/preview.py ===================================== @@ -12,7 +12,11 @@ # You should have received a copy of the GNU General Public License # along with Gajim. If not, see <http://www.gnu.org/licenses/>. +from __future__ import annotations + +from dataclasses import dataclass, field from typing import Any +from typing import Callable from typing import Optional import logging @@ -54,6 +58,19 @@ # Merge both: if it’s a previewable image, it should be allowed ALLOWED_MIME_TYPES = mime_types.union(PREVIEWABLE_MIME_TYPES) +AudioSampleT = list[tuple[float, float]] + + +@dataclass +class AudioPreviewState: + duration: float = 0.0 + position: float = 0.0 + is_eos: bool = False + speed: float = 1.0 + is_timestamp_positive: bool = True + samples: AudioSampleT = field(default_factory=list) + is_audio_analyzed = False + class Preview: def __init__(self, @@ -198,20 +215,55 @@ def __init__(self) -> None: self._orig_dir = Path(configpaths.get('MY_DATA')) / 'downloads' self._thumb_dir = Path(configpaths.get('MY_CACHE')) / 'downloads.thumb' - self._previews: dict[str, Preview] = {} - if GLib.mkdir_with_parents(str(self._orig_dir), 0o700) != 0: log.error('Failed to create: %s', self._orig_dir) if GLib.mkdir_with_parents(str(self._thumb_dir), 0o700) != 0: log.error('Failed to create: %s', self._thumb_dir) + self._previews: dict[str, Preview] = {} + + # Holds active audio preview sessions + # for resuming after switching chats + self._audio_sessions: dict[int, AudioPreviewState] = {} + + # References a stop function for each audio preview, which allows us + # to stop previews by preview_id, see stop_audio_except(preview_id) + self._audio_stop_functions: dict[int, Callable[..., None]] = {} + def get_preview(self, preview_id: str) -> Optional[Preview]: return self._previews.get(preview_id) def clear_previews(self) -> None: self._previews.clear() + def get_audio_state(self, + preview_id: int + ) -> AudioPreviewState: + + state = self._audio_sessions.get(preview_id) + if state is not None: + return state + self._audio_sessions[preview_id] = AudioPreviewState() + return self._audio_sessions[preview_id] + + def register_audio_stop_func(self, + preview_id: int, + stop_func: Callable[..., None] + ) -> None: + + self._audio_stop_functions[preview_id] = stop_func + + def unregister_audio_stop_func(self, preview_id: int) -> None: + self._audio_stop_functions.pop(preview_id, None) + + def stop_audio_except(self, preview_id: int) -> None: + # Stops playback of all audio previews except of for preview_id. + # This makes sure that only one preview is played at the time. + for id_, stop_func in self._audio_stop_functions.items(): + if id_ != preview_id: + stop_func() + def _get_session(self, account: str) -> Soup.Session: if account not in self._sessions: self._sessions[account] = self._create_session(account) ===================================== gajim/common/text_helpers.py ===================================== @@ -36,3 +36,26 @@ def escape_iri_query(s: str) -> str: def jid_to_iri(jid: str) -> str: return 'xmpp:' + escape_iri_path(jid) + + +def format_duration(ns: float, total_ns: float) -> str: + seconds = ns / 1e9 + minutes = seconds / 60 + hours = minutes / 60 + + total_minutes = total_ns / 1e9 / 60 + total_hours = total_minutes / 60 + + i_seconds = int(seconds) % 60 + i_minutes = int(minutes) % 60 + i_hours = int(hours) + + if total_hours >= 1: + width = len(str(int(total_hours))) + return (f'%0{width}d' % i_hours) + f':{i_minutes:02d}:{i_seconds:02d}' + + if total_minutes >= 1: + width = len(str(int(total_minutes))) + return (f'%0{width}d' % i_minutes) + f':{i_seconds:02d}' + + return f'0:{i_seconds:02d}' ===================================== gajim/data/gui/preview_audio.ui ===================================== @@ -0,0 +1,378 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<interface> + <requires lib="gtk+" version="3.24"/> + <object class="GtkAdjustment" id="seek_bar_adj"> + <property name="upper">100</property> + <property name="step-increment">1</property> + <property name="page-increment">1</property> + </object> + <object class="GtkAdjustment" id="speed_bar_adj"> + <property name="lower">0.25</property> + <property name="upper">2</property> + <property name="value">1</property> + <property name="step-increment">0.25</property> + <property name="page-increment">0.25</property> + </object> + <object class="GtkBox" id="preview_box"> + <property name="visible">True</property> + <property name="can-focus">False</property> + <property name="orientation">vertical</property> + <property name="spacing">12</property> + <child> +  + <object class="GtkGrid"> + <property name="visible">True</property> + <property name="can-focus">False</property> + <property name="margin-end">6</property> + <child> + <object class="GtkBox" id="drawing_box"> + <property name="width-request">300</property> + <property name="height-request">30</property> + <property name="visible">True</property> + <property name="can-focus">False</property> + <property name="valign">center</property> + <property name="orientation">vertical</property> + <child> + <placeholder/> + </child> + </object> + <packing> + <property name="left-attach">0</property> + <property name="top-attach">0</property> + </packing> + </child> + <child> + <object class="GtkEventBox"> + <property name="visible">True</property> + <property name="app-paintable">True</property> + <property name="can-focus">False</property> + <property name="events">GDK_STRUCTURE_MASK | GDK_SCROLL_MASK</property> + <signal name="realize" handler="_on_realize" swapped="no"/> + <child> + <object class="GtkScale" id="seek_bar"> + <property name="width-request">300</property> + <property name="height-request">-1</property> + <property name="visible">True</property> + <property name="can-focus">True</property> + <property name="events">GDK_KEY_PRESS_MASK | GDK_SCROLL_MASK</property> + <property name="adjustment">seek_bar_adj</property> + <property name="lower-stepper-sensitivity">on</property> + <property name="upper-stepper-sensitivity">on</property> + <property name="restrict-to-fill-level">False</property> + <property name="fill-level">0</property> + <property name="digits">2</property> + <property name="draw-value">False</property> + <property name="value-pos">bottom</property> + <signal name="button-press-event" handler="_on_seek_bar_button_pressed" swapped="no"/> + <signal name="button-release-event" handler="_on_seek_bar_button_released" swapped="no"/> + <signal name="change-value" handler="_on_seek" swapped="no"/> + <signal name="motion-notify-event" handler="_on_seek_bar_cursor_move" swapped="no"/> + <signal name="scroll-event" handler="_on_seek_bar_scrolled" swapped="no"/> + <signal name="value-changed" handler="_on_seek_bar_moved" swapped="no"/> + </object> + </child> + </object> + <packing> + <property name="left-attach">0</property> + <property name="top-attach">1</property> + </packing> + </child> + <child> + <object class="GtkEventBox"> + <property name="visible">True</property> + <property name="can-focus">False</property> + <signal name="button-press-event" handler="_on_timestamp_label_clicked" swapped="no"/> + <signal name="realize" handler="_on_realize" swapped="no"/> + <child> + <object class="GtkLabel" id="progress_label"> + <property name="name">progressbar_label</property> + <property name="visible">True</property> + <property name="can-focus">False</property> + <property name="tooltip-text" translatable="yes">Click to change time display</property> + <property name="halign">end</property> + <property name="valign">center</property> + <property name="label">-0:00/0:00</property> + <property name="justify">fill</property> + <property name="single-line-mode">True</property> + <style> + <class name="dim-label"/> + <class name="small-label"/> + <class name="tabular-digits"/> + </style> + </object> + </child> + </object> + <packing> + <property name="left-attach">1</property> + <property name="top-attach">1</property> + </packing> + </child> + <child> + <placeholder/> + </child> + </object> + <packing> + <property name="expand">False</property> + <property name="fill">True</property> + <property name="position">0</property> + </packing> + </child> + <child> + <object class="GtkBox" id="control_box"> + <property name="visible">True</property> + <property name="can-focus">False</property> + <property name="margin-end">6</property> + <property name="spacing">10</property> + <child> + <object class="GtkBox"> + <property name="visible">True</property> + <property name="can-focus">False</property> + <property name="homogeneous">True</property> + <child> + <object class="GtkButton" id="rewind_button"> + <property name="visible">True</property> + <property name="can-focus">True</property> + <property name="receives-default">True</property> + <property name="tooltip-text" translatable="yes">Rewind 10 seconds</property> + <signal name="clicked" handler="_on_rewind_clicked" swapped="no"/> + <child> + <object class="GtkImage"> + <property name="visible">True</property> + <property name="can-focus">False</property> + <property name="icon-name">media-seek-backward</property> + </object> + </child> + </object> + <packing> + <property name="expand">False</property> + <property name="fill">True</property> + <property name="position">0</property> + </packing> + </child> + <child> + <object class="GtkButton" id="play_pause_button"> + <property name="visible">True</property> + <property name="can-focus">True</property> + <property name="receives-default">True</property> + <signal name="clicked" handler="_on_play_clicked" swapped="no"/> + <child> + <object class="GtkImage" id="play_icon"> + <property name="visible">True</property> + <property name="can-focus">False</property> + <property name="tooltip-text" translatable="yes">Start/stop playback</property> + <property name="icon-name">media-playback-start</property> + </object> + </child> + </object> + <packing> + <property name="expand">False</property> + <property name="fill">True</property> + <property name="position">1</property> + </packing> + </child> + <child> + <object class="GtkButton" id="forward_button"> + <property name="visible">True</property> + <property name="can-focus">True</property> + <property name="receives-default">True</property> + <signal name="clicked" handler="_on_forward_clicked" swapped="no"/> + <child> + <object class="GtkImage"> + <property name="visible">True</property> + <property name="can-focus">False</property> + <property name="tooltip-text" translatable="yes">Forward 10 seconds</property> + <property name="icon-name">media-seek-forward</property> + </object> + </child> + </object> + <packing> + <property name="expand">False</property> + <property name="fill">True</property> + <property name="position">2</property> + </packing> + </child> + <style> + <class name="linked"/> + </style> + </object> + <packing> + <property name="expand">False</property> + <property name="fill">True</property> + <property name="position">0</property> + </packing> + </child> + <child> + <object class="GtkBox"> + <property name="visible">True</property> + <property name="can-focus">False</property> + <child> + <object class="GtkButton" id="speed_dec_button"> + <property name="visible">True</property> + <property name="can-focus">True</property> + <property name="receives-default">True</property> + <property name="tooltip-text" translatable="yes">Decrease playback speed</property> + <signal name="clicked" handler="_on_speed_dec_clicked" swapped="no"/> + <child> + <object class="GtkImage"> + <property name="visible">True</property> + <property name="can-focus">False</property> + <property name="halign">center</property> + <property name="valign">center</property> + <property name="icon-name">list-remove</property> + </object> + </child> + </object> + <packing> + <property name="expand">False</property> + <property name="fill">True</property> + <property name="position">0</property> + </packing> + </child> + <child> + <object class="GtkMenuButton" id="speed_menubutton"> + <property name="visible">True</property> + <property name="can-focus">True</property> + <property name="focus-on-click">False</property> + <property name="receives-default">True</property> + <property name="tooltip-text" translatable="yes">Select playback speed</property> + <property name="halign">center</property> + <property name="valign">center</property> + <property name="popover">speed_popover</property> + <child> + <object class="GtkBox"> + <property name="visible">True</property> + <property name="can-focus">False</property> + <property name="spacing">1</property> + <child> + <object class="GtkLabel" id="speed_label"> + <property name="visible">True</property> + <property name="can-focus">False</property> + <property name="halign">center</property> + <property name="valign">center</property> + <property name="margin-start">2</property> + <property name="label">1.00x</property> + <property name="single-line-mode">True</property> + </object> + <packing> + <property name="expand">False</property> + <property name="fill">True</property> + <property name="position">1</property> + </packing> + </child> + <child> + <object class="GtkImage"> + <property name="visible">True</property> + <property name="can-focus">False</property> + <property name="halign">center</property> + <property name="valign">center</property> + <property name="margin-start">2</property> + <property name="icon-name">go-down</property> + </object> + <packing> + <property name="expand">False</property> + <property name="fill">True</property> + <property name="position">2</property> + </packing> + </child> + <style> + <class name="linked"/> + </style> + </object> + </child> + </object> + <packing> + <property name="expand">False</property> + <property name="fill">True</property> + <property name="position">1</property> + </packing> + </child> + <child> + <object class="GtkButton" id="speed_inc_button"> + <property name="visible">True</property> + <property name="can-focus">True</property> + <property name="receives-default">True</property> + <property name="tooltip-text" translatable="yes">Increase playback speed</property> + <signal name="clicked" handler="_on_speed_inc_clicked" swapped="no"/> + <child> + <object class="GtkImage"> + <property name="visible">True</property> + <property name="can-focus">False</property> + <property name="halign">center</property> + <property name="valign">center</property> + <property name="icon-name">list-add</property> + </object> + </child> + </object> + <packing> + <property name="expand">False</property> + <property name="fill">True</property> + <property name="position">2</property> + </packing> + </child> + <style> + <class name="linked"/> + </style> + </object> + <packing> + <property name="expand">False</property> + <property name="fill">True</property> + <property name="pack-type">end</property> + <property name="position">3</property> + </packing> + </child> + </object> + <packing> + <property name="expand">False</property> + <property name="fill">True</property> + <property name="position">3</property> + </packing> + </child> + </object> + <object class="GtkPopover" id="speed_popover"> + <property name="can-focus">False</property> + <property name="relative-to">speed_menubutton</property> + <property name="position">bottom</property> + <child> + <object class="GtkBox"> + <property name="visible">True</property> + <property name="can-focus">False</property> + <property name="orientation">vertical</property> + <child> + <object class="GtkEventBox"> + <property name="visible">True</property> + <property name="can-focus">False</property> + <child> + <object class="GtkScale" id="speed_bar"> + <property name="width-request">225</property> + <property name="height-request">-1</property> + <property name="visible">True</property> + <property name="can-focus">True</property> + <property name="margin-start">3</property> + <property name="margin-end">3</property> + <property name="adjustment">speed_bar_adj</property> + <property name="restrict-to-fill-level">False</property> + <property name="fill-level">1</property> + <property name="round-digits">0</property> + <property name="digits">2</property> + <property name="draw-value">False</property> + <property name="has-origin">False</property> + <property name="value-pos">right</property> + <signal name="change-value" handler="_on_speed_change" swapped="no"/> + <signal name="realize" handler="_on_realize" swapped="no"/> + </object> + </child> + </object> + <packing> + <property name="expand">False</property> + <property name="fill">True</property> + <property name="position">0</property> + </packing> + </child> + <style> + <class name="padding-6"/> + </style> + </object> + </child> + </object> +</interface> ===================================== gajim/data/style/gajim.css ===================================== @@ -33,6 +33,8 @@ treeview.space { padding: 6px; } /* GtkLinkButton style */ button.flat.link { padding: 0; border: 0; } +.tabular-digits { font-feature-settings: "tnum"; } + messagedialog.confirmation-dialog > box { margin-top: 18px; } /* InfoBar */ ===================================== gajim/gtk/builder.pyi ===================================== @@ -652,7 +652,6 @@ class PreferencesBuilder(Builder): status_message: Gtk.Grid automatic_status: Gtk.Grid themes: Gtk.Grid - emoji: Gtk.Grid av_info_bar: Gtk.InfoBar button1: Gtk.Button av_info_bar_label: Gtk.Label @@ -687,6 +686,26 @@ class PreviewBuilder(Builder): info_message: Gtk.Label +class PreviewAudioBuilder(Builder): + seek_bar_adj: Gtk.Adjustment + speed_bar_adj: Gtk.Adjustment + preview_box: Gtk.Box + drawing_box: Gtk.Box + seek_bar: Gtk.Scale + progress_label: Gtk.Label + control_box: Gtk.Box + rewind_button: Gtk.Button + play_pause_button: Gtk.Button + play_icon: Gtk.Image + forward_button: Gtk.Button + speed_dec_button: Gtk.Button + speed_menubutton: Gtk.MenuButton + speed_label: Gtk.Label + speed_inc_button: Gtk.Button + speed_popover: Gtk.Popover + speed_bar: Gtk.Scale + + class ProfileBuilder(Builder): privacy_popover: Gtk.Popover avatar_nick_access: Gtk.Switch @@ -1011,6 +1030,8 @@ def get_builder(file_name: Literal['preferences.ui'], widgets: list[str] = ...) @overload def get_builder(file_name: Literal['preview.ui'], widgets: list[str] = ...) -> PreviewBuilder: ... @overload +def get_builder(file_name: Literal['preview_audio.ui'], widgets: list[str] = ...) -> PreviewAudioBuilder: ... +@overload def get_builder(file_name: Literal['profile.ui'], widgets: list[str] = ...) -> ProfileBuilder: ... @overload def get_builder(file_name: Literal['roster.ui'], widgets: list[str] = ...) -> RosterBuilder: ... ===================================== gajim/gtk/preview_audio.py ===================================== @@ -14,171 +14,605 @@ from __future__ import annotations -from typing import Optional +from typing import Any import logging from pathlib import Path +from gi.repository import Gdk from gi.repository import GLib from gi.repository import Gtk + try: from gi.repository import Gst except Exception: pass +from gajim.common import app from gajim.common.i18n import _ +from gajim.common.text_helpers import format_duration +from gajim.common.preview import AudioSampleT +from .builder import get_builder +from .preview_audio_analyzer import AudioAnalyzer +from .preview_audio_visualizer import AudioVisualizerWidget from .util import get_cursor log = logging.getLogger('gajim.gui.preview_audio') +# Padding to align the visualizer drawing with the seekbar +SEEK_BAR_PADDING = 11 + class AudioWidget(Gtk.Box): def __init__(self, file_path: Path) -> None: + Gtk.Box.__init__(self, orientation=Gtk.Orientation.HORIZONTAL, spacing=6) - self._playbin: Optional[Gst.Element] = Gst.ElementFactory.make( - 'playbin', 'bin') + + self._playbin = Gst.ElementFactory.make('playbin', 'bin') + self._bus_watch_id: int = 0 + self._timeout_id: int = -1 + if self._playbin is None: + log.warning('Could not create GST playbin') label = Gtk.Label(label=_('Audio preview is not available')) self.add(label) - log.debug('Could not create GST playbin') + self.show_all() return - self._query: Gst.Query = Gst.Query.new_position(Gst.Format.TIME) - self._has_timeout: bool = False + self._file_path = file_path + self._id = hash(self._file_path) - self._build_audio_widget() + app.preview_manager.register_audio_stop_func(self._id, self._set_ready) + + self._seek_pos = -1.0 + self._offset_backward = -10e9 # in ns + self._offset_forward = 10e9 + self._pause_seek = False + self._is_ready = True + self._next_state_is_playing = False + + # Constants which define player's behaviour + self._speed_min = 0.25 + self._speed_max = 2.00 + self._speed_inc_step = 0.25 + self._speed_dec_step = 0.25 + + self._query = Gst.Query.new_position(Gst.Format.TIME) self._setup_audio_player(file_path) - def _build_audio_widget(self) -> None: - play_button = Gtk.Button() - play_button.get_style_context().add_class('flat') - play_button.get_style_context().add_class('border') - play_button.set_tooltip_text(_('Start/stop playback')) - self._play_icon = Gtk.Image.new_from_icon_name( - 'media-playback-start-symbolic', - Gtk.IconSize.BUTTON) - play_button.add(self._play_icon) - play_button.connect('clicked', self._on_play_clicked) - event_box = Gtk.EventBox() - event_box.connect('realize', self._on_realize) - event_box.add(play_button) - self.add(event_box) - - self._seek_bar = Gtk.Scale( - orientation=Gtk.Orientation.HORIZONTAL) - self._seek_bar.set_range(0.0, 1.0) - self._seek_bar.set_size_request(300, -1) - self._seek_bar.set_value_pos(Gtk.PositionType.RIGHT) - self._seek_bar.connect('change-value', self._on_seek) - self._seek_bar.connect( - 'format-value', self._format_audio_timestamp) - event_box = Gtk.EventBox() - event_box.connect('realize', self._on_realize) - event_box.add(self._seek_bar) - self.add(event_box) + self._ui = get_builder('preview_audio.ui') + self._is_LTR = \ + (self._ui.seek_bar.get_direction() == Gtk.TextDirection.LTR) + self._enable_controls(False) + + self._ui.connect_signals(self) + self.add(self._ui.preview_box) + self._setup_audio_visualizer() + + # Initialize with restored audio state or defaults + self._state = app.preview_manager.get_audio_state(self._id) + self._audio_analyzer = None + + if not self._state.is_audio_analyzed: + # Analyze the audio to determine samples and duration, + # calls self._update_audio_data when done. + self._audio_analyzer = AudioAnalyzer( + file_path, self._update_duration, self._update_samples) + else: + self._update_ui() + + self._ui.speed_bar_adj.configure( + value=self._state.speed, + lower=self._speed_min, + upper=self._speed_max, + step_increment=self._speed_inc_step, + page_increment=self._speed_inc_step, + page_size=0 + ) + + self._ui.speed_bar.set_value(self._state.speed) + self._set_playback_speed(self._state.speed) + + self._ui.speed_bar.add_mark(0.25, Gtk.PositionType.BOTTOM, '0.25') + self._ui.speed_bar.add_mark(0.5, Gtk.PositionType.BOTTOM, '') + self._ui.speed_bar.add_mark(0.75, Gtk.PositionType.BOTTOM, '') + self._ui.speed_bar.add_mark(1, Gtk.PositionType.BOTTOM, '1.0') + self._ui.speed_bar.add_mark(1.25, Gtk.PositionType.BOTTOM, '') + self._ui.speed_bar.add_mark(1.5, Gtk.PositionType.BOTTOM, '1.5') + self._ui.speed_bar.add_mark(1.75, Gtk.PositionType.BOTTOM, '') + self._ui.speed_bar.add_mark(2, Gtk.PositionType.BOTTOM, '2') + + if self._is_LTR: + self._ui.progress_label.set_xalign(1.0) + else: + self._ui.progress_label.set_xalign(0.0) self.connect('destroy', self._on_destroy) self.show_all() + def _enable_controls(self, status: bool) -> None: + self._ui.seek_bar.set_sensitive(status) + self._ui.progress_label.set_sensitive(status) + self._ui.play_pause_button.set_sensitive(status) + self._ui.rewind_button.set_sensitive(status) + self._ui.forward_button.set_sensitive(status) + self._ui.speed_dec_button.set_sensitive(status) + self._ui.speed_inc_button.set_sensitive(status) + self._ui.speed_menubutton.set_sensitive(status) + + def _update_ui(self) -> None: + if not self._state.duration > 0: + log.debug('Could not successfully load audio. Duration is zero.') + return + + self._enable_controls(True) + + if len(self._state.samples) > 0: + self._audio_visualizer.update_params( + self._state.samples, + self._state.position / self._state.duration) + self._audio_visualizer.draw_graph( + self._state.position / self._state.duration) + + self._ui.seek_bar_adj.configure( + value=self._state.position, + lower=0.0, + upper=self._state.duration, + step_increment=5e9, # for hold+position left/right + page_increment=0, # determines scrolling and click behaviour + page_size=0 + ) + + # Calculate max string length to prevent timestamp label from jumping + formatted = format_duration(0.0, self._state.duration) + self._ui.progress_label.set_width_chars( + len(f'-{formatted}/{formatted}')) + self._update_timestamp_label() + + def _update_samples(self, + samples: AudioSampleT, + ) -> None: + self._state.samples = samples + self._state.is_audio_analyzed = True + self._update_ui() + + def _update_duration(self, duration: float): + self._state.duration = duration + self._update_ui() + def _setup_audio_player(self, file_path: Path) -> None: assert self._playbin is not None + + # Set up the whole pipline + # For reference see + # https://gstreamer.freedesktop.org/ + # documentation/audiofx/scaletempo.html + audio_sink = Gst.Bin.new('audiosink') + audioconvert = Gst.ElementFactory.make('audioconvert', 'audioconvert') + scaletempo = Gst.ElementFactory.make('scaletempo', 'scaletempo') + audioresample = Gst.ElementFactory.make( + 'audioresample', 'audioresample') + autoaudiosink = Gst.ElementFactory.make( + 'autoaudiosink', 'autoaudiosink') + + pipeline_elements = [ + audio_sink, audioconvert, scaletempo, audioresample, autoaudiosink] + if any(element is None for element in pipeline_elements): + # If it fails there will be + # * a delay until playback starts + # * a chipmunk effect when speeding up the playback + log.warning('Could not set up full audio preview pipeline.') + else: + assert autoaudiosink is not None + assert audioconvert is not None + assert scaletempo is not None + assert audioresample is not None + autoaudiosink.set_property('sync', False) + + audio_sink.add(audioconvert) + audio_sink.add(scaletempo) + audio_sink.add(audioresample) + audio_sink.add(autoaudiosink) + + audioconvert.link(scaletempo) + scaletempo.link(audioresample) + audioresample.link(autoaudiosink) + + sink_pad = audioconvert.get_static_pad('sink') + assert sink_pad is not None + ghost_pad = Gst.GhostPad.new('sink', sink_pad) + assert ghost_pad is not None + audio_sink.add_pad(ghost_pad) + self._playbin.set_property('audio-sink', audio_sink) + self._playbin.set_property('uri', file_path.as_uri()) - state_return = self._playbin.set_state(Gst.State.PAUSED) + self._playbin.no_more_pads() + + state_return = self._playbin.set_state(Gst.State.READY) if state_return == Gst.StateChangeReturn.FAILURE: log.debug('Could not setup GST playbin') return - bus: Optional[Gst.Bus] = self._playbin.get_bus() + bus = self._playbin.get_bus() if bus is None: log.debug('Could not get GST Bus') return + bus.add_signal_watch() - bus.connect('message', self._on_bus_message) + self._bus_watch_id = bus.connect('message', self._on_bus_message) - def _on_bus_message(self, _bus: Gst.Bus, message: Gst.Message) -> None: - assert self._playbin is not None - if message.type == Gst.MessageType.EOS: - self._set_pause(True) - self._playbin.seek_simple( - Gst.Format.TIME, Gst.SeekFlags.FLUSH, 0) - elif message.type == Gst.MessageType.STATE_CHANGED: - success, duration = self._playbin.query_duration( - Gst.Format.TIME) - if not success: - return - assert duration is not None - if duration > 0: - self._seek_bar.set_range(0.0, duration) + def _setup_audio_visualizer(self) -> None: + width, height = self._ui.seek_bar.get_size_request() - is_paused = self._get_paused() - if (duration > 0 and not is_paused and - not self._has_timeout): - GLib.timeout_add(50, self._update_seek_bar) - self._has_timeout = True + if width == -1: + width = self._ui.seek_bar.get_preferred_width()[1] - def _on_seek(self, - _range: Gtk.Range, - _scroll: Gtk.ScrollType, - value: float - ) -> bool: + if height == -1: + height = self._ui.seek_bar.get_preferred_height()[1] + + if width is None or height is None: + return + + width -= 2 * SEEK_BAR_PADDING + seek_bar_rgba = self._ui.seek_bar.get_style_context().get_color( + Gtk.StateFlags.LINK) + self._audio_visualizer = AudioVisualizerWidget( + width, + height, + SEEK_BAR_PADDING, + seek_bar_rgba) + + self._ui.drawing_box.add(self._audio_visualizer) + + def _update_timestamp_label(self) -> None: + cur = self._state.position + dur = self._state.duration + + dur_str = format_duration(dur, dur) + ltr_char = u'\u202B' + pop_char = u'\u202C' + + if self._state.is_timestamp_positive: + cur_str = f'{format_duration(cur, dur)}' + self._ui.progress_label.set_text(f'{cur_str}/{dur_str}') + else: + cur_str = f'{format_duration(dur - cur, dur)}' + if self._is_LTR: + self._ui.progress_label.set_text(f'-{cur_str}/{dur_str}') + else: + self._ui.progress_label.set_text( + f'{cur_str}{ltr_char}/-{pop_char}{dur_str}' + ) + + def _update_seek_bar_and_visualisation(self) -> bool: assert self._playbin is not None - self._playbin.seek_simple( - Gst.Format.TIME, Gst.SeekFlags.FLUSH, int(value)) - return False + if self._playbin.query(self._query): + _fmt, position = self._query.parse_position() - def _on_play_clicked(self, _button: Gtk.Button) -> None: - self._set_pause(not self._get_paused()) + if position is None: + self._timeout_id = -1 + return False + + if not self._pause_seek: + self._state.position = position + self._ui.seek_bar.set_value(self._state.position) + + if not self._get_ready() and not self._get_paused(): + self._audio_visualizer.draw_graph( + position / self._state.duration, + self._seek_pos / self._state.duration) + return True + + def _add_seek_bar_update_idle(self) -> None: + if self._timeout_id != -1: + return + + self._timeout_id = \ + GLib.timeout_add(80, self._update_seek_bar_and_visualisation) + + def _remove_seek_bar_update_idle(self) -> None: + if self._timeout_id != -1: + GLib.source_remove(self._timeout_id) + self._timeout_id = -1 + + def _get_constrained_position(self, pos: float) -> float: + if pos >= self._state.duration: + return self._state.duration + if pos < 0: + return 0.0 + return pos + + def _get_constrained_speed(self, speed: float) -> tuple[bool, float]: + if self._speed_min <= speed <= self._speed_max: + return True, speed + return False, self._state.speed + + def _set_playback_speed(self, speed: float) -> bool: + success, self._state.speed = self._get_constrained_speed(speed) + if not success: + return False + + self._ui.speed_label.set_text(f'{self._state.speed:.2f}x') - def _on_destroy(self, _widget: Gtk.Widget) -> None: assert self._playbin is not None - self._playbin.set_state(Gst.State.NULL) + self._playbin.seek(self._state.speed, + Gst.Format.TIME, + Gst.SeekFlags.FLUSH, + Gst.SeekType.SET, + int(self._state.position), + Gst.SeekType.NONE, + 0) + return True def _get_paused(self) -> bool: assert self._playbin is not None - _, state, _ = self._playbin.get_state(20) + _, state, _ = self._playbin.get_state(timeout=40) return state == Gst.State.PAUSED + def _get_ready(self) -> bool: + assert self._playbin is not None + _, state, _ = self._playbin.get_state(timeout=40) + return state == Gst.State.READY + def _set_pause(self, paused: bool) -> None: assert self._playbin is not None if paused: self._playbin.set_state(Gst.State.PAUSED) - self._play_icon.set_from_icon_name( + self._remove_seek_bar_update_idle() + self._ui.play_icon.set_from_icon_name( 'media-playback-start-symbolic', Gtk.IconSize.BUTTON) else: self._playbin.set_state(Gst.State.PLAYING) - self._play_icon.set_from_icon_name( + self._add_seek_bar_update_idle() + self._ui.play_icon.set_from_icon_name( 'media-playback-pause-symbolic', Gtk.IconSize.BUTTON) - def _update_seek_bar(self) -> bool: - if self._get_paused(): - self._has_timeout = False - return False + def _set_ready(self) -> None: + assert self._playbin is not None + self._playbin.set_state(Gst.State.READY) + self._is_ready = True + + # State order is READY -> PAUSE -> PLAYING + # I.e. we need to pause first, but keep in mind, that we want to + # go a state further + self._next_state_is_playing = True + self._ui.play_icon.set_from_icon_name( + 'media-playback-start-symbolic', + Gtk.IconSize.BUTTON) + + def _seek(self, position: float) -> None: + ''' + Used in: + * _on_seek: When the slider is dragged + * _on_seek_bar_button_released: + * _on_play_clicked + ''' assert self._playbin is not None - if self._playbin.query(self._query): - _fmt, cur_pos = self._query.parse_position() - if cur_pos is not None: - self._seek_bar.set_value(cur_pos) - return True - @staticmethod - def _format_audio_timestamp(_widget: Gtk.Scale, ns: float) -> str: - seconds = ns / 1000000000 - minutes = seconds / 60 - hours = minutes / 60 - - i_seconds = int(seconds) % 60 - i_minutes = int(minutes) % 60 - i_hours = int(hours) - - if i_hours > 0: - return f'{i_hours:d}:{i_minutes:02d}:{i_seconds:02d}' - return f'{i_minutes:d}:{i_seconds:02d}' + self._state.position = self._get_constrained_position(position) + self._state.is_eos = self._state.position >= self._state.duration + + if self._pause_seek: + return + + self._playbin.seek(self._state.speed, + Gst.Format.TIME, + Gst.SeekFlags.FLUSH, + Gst.SeekType.SET, + int(self._state.position), Gst.SeekType.NONE, 0 + ) + + if self._state.position >= self._state.duration: + self._playbin.send_event(Gst.Event.new_eos()) + + def _seek_unconditionally(self, position: float) -> None: + ''' + Used in: + * _on_seek_bar_button_pressed + * _on_rewind_clicked + * _on_forward_clicked + ''' + assert self._playbin is not None + + self._state.position = self._get_constrained_position(position) + self._state.is_eos = self._state.position >= self._state.duration + + if not self._is_ready: + self._playbin.seek(self._state.speed, + Gst.Format.TIME, + Gst.SeekFlags.FLUSH, + Gst.SeekType.SET, + int(self._state.position), + Gst.SeekType.NONE, + 0) + + self._ui.seek_bar.set_value(self._state.position) + self._audio_visualizer.draw_graph( + self._state.position / self._state.duration) + + def _on_bus_message(self, _bus: Gst.Bus, message: Gst.Message) -> None: + assert self._playbin is not None + + if message.type == Gst.MessageType.EOS: + self._state.is_eos = True + self._set_pause(True) + self._ui.seek_bar.set_value(self._state.duration) + self._audio_visualizer.draw_graph(1.0) + + elif message.type == Gst.MessageType.STATE_CHANGED: + is_paused = self._get_paused() + + if self._is_ready and is_paused: + # State changed from READY --> PAUSED + self._is_ready = False + self._playbin.seek(self._state.speed, + Gst.Format.TIME, + Gst.SeekFlags.FLUSH, + Gst.SeekType.SET, + int(self._state.position), + Gst.SeekType.NONE, + 0) + self._ui.seek_bar.set_value(self._state.position) + + if self._next_state_is_playing: + # Continue from state PAUSED --> PLAYING + self._set_pause(False) + self._next_state_is_playing = False + + return + + def _on_speed_change(self, + _range: Gtk.Range, + _scroll: Gtk.ScrollType, + value: float + ) -> None: + + self._set_playback_speed(value) + + def _on_speed_inc_clicked(self, _button: Gtk.Button) -> None: + speed = self._state.speed + self._speed_inc_step + if self._set_playback_speed(speed): + self._ui.speed_bar.set_value(speed) + + def _on_speed_dec_clicked(self, _button: Gtk.Button) -> None: + speed = self._state.speed - self._speed_inc_step + if self._set_playback_speed(speed): + self._ui.speed_bar.set_value(speed) + else: + log.debug('Could not set speed!') + + def _on_seek_bar_moved(self, _scake: Gtk.Scale) -> None: + self._update_timestamp_label() + + def _on_timestamp_label_clicked(self, + _label: Gtk.Label, + *args: Any + ) -> None: + + self._state.is_timestamp_positive = \ + not self._state.is_timestamp_positive + self._update_timestamp_label() + + def _on_seek_bar_button_pressed(self, + _scale: Gtk.Scale, + event: Gdk.EventButton, + ) -> None: + assert self._cursor_pos is not None + # There are two cases when the user clicks on the seek bar: + # 1) Press and immediately release: Jump to the new position and + # continue playing + # 2) Start of dragging the slider + # In case of 2) pause active seeking to prevent audio scrubbing and + # instead continue playing + self._pause_seek = True + width = self._ui.seek_bar.get_allocation().width - 2 * SEEK_BAR_PADDING + new_pos = self._state.duration * self._cursor_pos / width + self._seek_unconditionally(new_pos) + + def _on_seek_bar_button_released(self, + _scale: Gtk.Scale, + event: Gdk.EventButton, + ) -> None: + self._pause_seek = False + self._seek(self._state.position) + + # Set the seek position to -1 to indicate that the user isn't about + # to change the position + self._seek_pos = -1 + + def _on_seek_bar_cursor_move(self, + _scale: Gtk.Scale, + event: Gdk.EventMotion + ) -> None: + # Used to determine the click position on the seekbar + if self._is_LTR: + self._cursor_pos = event.x - SEEK_BAR_PADDING + else: + width = self._ui.seek_bar.get_allocation().width + self._cursor_pos = width - (event.x + SEEK_BAR_PADDING) + + def _on_seek_bar_scrolled(self, + _scale: Gtk.Scale, + event: Gdk.EventMotion + ) -> None: + _is_smooth, _delta_x, delta_y = event.get_scroll_deltas() + if delta_y > 0: + new_pos = self._state.position + self._offset_backward + else: + new_pos = self._state.position + self._offset_forward + self._seek_unconditionally(new_pos) + + def _on_seek(self, + _scale: Gtk.Scale, + _scroll: Gtk.ScrollType, + value: float + ) -> None: + self._seek(value) + + if not (self._get_paused() or self._get_ready()): + self._seek_pos = value + else: + self._audio_visualizer.draw_graph( + self._state.position / self._state.duration) + + def _on_play_clicked(self, _button: Gtk.Button) -> None: + app.preview_manager.stop_audio_except(self._id) + if self._get_ready(): + # The order is always READY -> PAUSE -> PLAYING + self._set_pause(True) + self._next_state_is_playing = True + + if self._state.is_eos: + new_pos = 0.0 + else: + new_pos = self._state.position + + self._seek(new_pos) + self._query.set_position(Gst.Format.TIME, int(new_pos)) + self._ui.seek_bar.set_value(new_pos) + return + + if self._state.is_eos and self._get_paused(): + self._seek(0.0) + self._ui.seek_bar.set_value(0.0) + + self._set_pause(not self._get_paused()) + + def _on_rewind_clicked(self, _button: Gtk.Button) -> None: + new_pos = self._get_constrained_position( + self._state.position + self._offset_backward) + self._seek_unconditionally(new_pos) + + def _on_forward_clicked(self, _button: Gtk.Button) -> None: + new_pos = self._get_constrained_position( + self._state.position + self._offset_forward) + self._seek_unconditionally(new_pos) + + def _on_destroy(self, _widget: Gtk.Widget) -> None: + if self._playbin is not None: + self._playbin.set_state(Gst.State.NULL) + bus = self._playbin.get_bus() + + if bus is not None: + bus.remove_signal_watch() + bus.disconnect(self._bus_watch_id) + + if self._audio_analyzer is not None: + self._audio_analyzer.destroy() + + if self._ui.speed_popover is not None: + self._ui.speed_popover.destroy() + + self._remove_seek_bar_update_idle() + + app.preview_manager.unregister_audio_stop_func(self._id) + app.check_finalize(self) @staticmethod def _on_realize(event_box: Gtk.EventBox) -> None: ===================================== gajim/gtk/preview_audio_analyzer.py ===================================== @@ -0,0 +1,167 @@ +# This file is part of Gajim. +# +# Gajim is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published +# by the Free Software Foundation; version 3 only. +# +# Gajim is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with Gajim. If not, see <http://www.gnu.org/licenses/>. + +from __future__ import annotations + +from typing import Callable +from typing import cast +from typing import Optional + +import logging +import math +from pathlib import Path + +try: + from gi.repository import Gst +except Exception: + pass + +from gajim.common import app +from gajim.common.preview import AudioSampleT + +log = logging.getLogger('gajim.gui.preview_audio_analyzer') + + +class AudioAnalyzer: + def __init__(self, + filepath: Path, + duration_callback: Callable[[float], None], + samples_callback: Callable[[AudioSampleT], None] + ) -> None: + + self._playbin = Gst.ElementFactory.make('playbin', 'bin') + + if self._playbin is None: + log.debug('Could not create GST playbin for AudioAnalyzer') + return + + self._duration_callback = duration_callback + self._duration_updated = False + self._samples_callback = samples_callback + self._query = Gst.Query.new_position(Gst.Format.TIME) + self._duration = Gst.CLOCK_TIME_NONE # in ns + self._num_channels = 1 + self._samples: list[tuple[float, float]] = [] + self._level: Optional[Gst.Element] = None + self._bus_watch_id: int = 0 + + self._setup_audio_analyzer(filepath) + + def _setup_audio_analyzer(self, file_path: Path) -> None: + assert isinstance(self._playbin, Gst.Bin) + + audio_sink = Gst.Bin.new('audiosink') + audioconvert = Gst.ElementFactory.make('audioconvert', 'audioconvert') + self._level = Gst.ElementFactory.make('level', 'level') + fakesink = Gst.ElementFactory.make('fakesink', 'fakesink') + + pipeline_elements = [audio_sink, audioconvert, self._level, fakesink] + if any(element is None for element in pipeline_elements): + log.error('Could not set up pipeline for AudioAnalyzer') + return + + assert audioconvert is not None + assert self._level is not None + assert fakesink is not None + + audio_sink.add(audioconvert) + audio_sink.add(self._level) + audio_sink.add(fakesink) + + audioconvert.link(self._level) + self._level.link(fakesink) + + sink_pad = audioconvert.get_static_pad('sink') + assert sink_pad is not None + ghost_pad = Gst.GhostPad.new('sink', sink_pad) + assert ghost_pad is not None + audio_sink.add_pad(ghost_pad) + + self._playbin.set_property('audio-sink', audio_sink) + file_uri = file_path.as_uri() + self._playbin.set_property('uri', file_uri) + self._playbin.no_more_pads() + + self._level.set_property('message', True) + fakesink.set_property('sync', False) + + state_return = self._playbin.set_state(Gst.State.PLAYING) + if state_return == Gst.StateChangeReturn.FAILURE: + log.warning('Could not set up GST playbin') + return + + self._level_element = self._playbin.get_by_name('level') + bus = self._playbin.get_bus() + if bus is None: + log.debug('Could not get GST Bus') + return + + bus.add_signal_watch() + self._bus_watch_id = bus.connect('message', self._on_bus_message) + + def _on_bus_message(self, _bus: Gst.Bus, message: Gst.Message) -> None: + assert self._playbin is not None + + if message.type == Gst.MessageType.EOS: + self._samples_callback(self._samples) + self._playbin.set_state(Gst.State.NULL) + return + + if (message.type in (Gst.MessageType.STATE_CHANGED, + Gst.MessageType.DURATION_CHANGED)): + _success, self._duration = self._playbin.query_duration( + Gst.Format.TIME) + if not self._duration_updated: + if _success: + assert self._duration is not None + self._duration_callback(float(self._duration)) + self._duration_updated = True + return + + if message.src is self._level: + structure = message.get_structure() + if structure is None or structure.get_name() != 'level': + return + + if not structure.has_field('rms'): + return + + # RMS: Root Mean Square = Average Power + rms_values = cast(list[float], structure.get_value('rms')) + assert rms_values is not None + self._num_channels = min(2, len(rms_values)) + + # Convert from dB to a linear scale. + # The sound pressure level L is defined as + # L = 10 log_10((p/p_0)^2) dB, where p is the RMS value + # of the sound pressure. + if self._num_channels == 1: + lin_val = math.pow(10, rms_values[0] / 10 / 2) + self._samples.append((lin_val, lin_val)) + else: + lin_val1 = math.pow(10, rms_values[0] / 10 / 2) + lin_val2 = math.pow(10, rms_values[1] / 10 / 2) + self._samples.append((lin_val1, lin_val2)) + + def destroy(self) -> None: + if self._playbin is not None: + self._playbin.set_state(Gst.State.NULL) + bus = self._playbin.get_bus() + + if bus is not None: + bus.remove_signal_watch() + bus.disconnect(self._bus_watch_id) + + del self._duration_callback, self._samples_callback + app.check_finalize(self) ===================================== gajim/gtk/preview_audio_visualizer.py ===================================== @@ -0,0 +1,255 @@ +# This file is part of Gajim. +# +# Gajim is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published +# by the Free Software Foundation; version 3 only. +# +# Gajim is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with Gajim. If not, see <http://www.gnu.org/licenses/>. + +from __future__ import annotations + +from typing import Optional + +import logging +import cairo +import math +from statistics import mean + +from gi.repository import Gdk +from gi.repository import Gtk + +from gajim.common.preview import AudioSampleT + +from .util import rgba_to_float + + +log = logging.getLogger('gajim.gui.preview_audio_visualizer') + + +class AudioVisualizerWidget(Gtk.DrawingArea): + def __init__(self, + width: int, + height: int, + x_offset: int, + seek_bar_color: Gdk.RGBA + ) -> None: + + Gtk.DrawingArea.__init__(self) + + self._x_offset = x_offset + self._width = width + self._height = height + self._is_LTR = (self.get_direction() == Gtk.TextDirection.LTR) + self._amplitude_width = 2 + + self._num_samples = 0 + self._samples: AudioSampleT = [] + self._seek_position = -1.0 + self._position = 0.0 + + self._default_color = (0.6, 0.6, 0.6) # gray + self._progress_color = rgba_to_float(seek_bar_color) + + # Use a 50% lighter color to the seeking indicator + self._seek_color = tuple( + min(1.0, color * 1.5) for color in self._progress_color + ) + + self._surface: Optional[cairo.ImageSurface] = None + + self.set_size_request(self._width, self._height) + + self.connect('draw', self._on_drawingarea_draw) + self.connect('configure-event', self._on_drawingarea_changed) + + self._setup_surface() + + def update_params(self, + samples: AudioSampleT, + position: float + ) -> None: + + self._samples = samples + self._position = position + self._process_samples() + self._num_samples = len(self._samples) + + def draw_graph(self, position: float, seek_position: float = -1.0) -> None: + if self._num_samples == 0: + return + + self._position = position + self._seek_position = seek_position + + self.queue_draw() + + def _setup_surface(self) -> None: + if self._surface: + self._surface.finish() + + self._surface = cairo.ImageSurface( + cairo.FORMAT_ARGB32, + self._width, + self._height) + ctx: cairo.Context[cairo.ImageSurface] = cairo.Context(self._surface) + + if self._num_samples != 0: + self._draw_surface(ctx) + + def _process_samples(self) -> None: + # Pick a subset of all samples and average over three samples + w = int(self._width / (self._amplitude_width * 2)) + n = math.floor(len(self._samples) / w) + 1 + + if n >= 2: + samples: AudioSampleT = [] + samples1, samples2 = zip(*self._samples) + for i in range(2, int(len(self._samples) - n / 2), n): + index = int(i + n / 2) + avg1 = mean(samples1[index - 1:index + 1]) + avg2 = mean(samples2[index - 1:index + 1]) + samples.append((avg1, avg2)) + else: + samples = self._samples + + # Normalize both channels using the same scale + max_elem = max(max(samples)) + self._samples = [ + (val1 / max_elem, val2 / max_elem) for val1, val2 in samples + ] + + def _draw_surface(self, ctx: cairo.Context[cairo.ImageSurface]) -> None: + # First draw the progress part from left + end = min(round(self._position * self._num_samples), self._num_samples) + self._draw_rms_amplitudes(ctx, + start=0, + end=end, + color=self._progress_color) + + if self._seek_position >= 0: + # If state is PLAYING and the user seeks, determine whether the + # seek position lies in the past, i.e. on the left side of current + # position or in the future, i.e. on the right side. + # Highlight the skipped area from seek + # to the current position on the determined site. + play_pos = min(round( + self._position * self._num_samples), self._num_samples) + seek_pos = min(round( + self._seek_position * self._num_samples), self._num_samples) + if play_pos > seek_pos: + start = seek_pos + end = play_pos + else: + start = play_pos + end = seek_pos + + self._draw_rms_amplitudes(ctx, + start=start, + end=end, + color=self._seek_color) + + # Draw the default amplitudes for the rest of the timeline + play_pos = min(round( + self._position * self._num_samples), self._num_samples) + seek_pos = min(round( + self._seek_position * self._num_samples), self._num_samples) + start_default = max(play_pos, seek_pos) + + self._draw_rms_amplitudes(ctx, + start=start_default, + end=self._num_samples, + color=self._default_color) + + def _draw_rms_amplitudes(self, + ctx: cairo.Context[cairo.ImageSurface], + start: int, + end: int, + color: tuple[float, float, float] + ) -> None: + + ctx.set_source_rgb(*color) + + w = self._amplitude_width + + # determines the spacing between the amplitudes + o = (self._width - 2 * w) / self._num_samples + y = self._height / 2 + r = 1 # radius of the arcs on top and bottom of the amplitudes + s = self._height / 2 - r # amplitude scaling factor + + if self._is_LTR: + o = (self._width - 2 * w) / self._num_samples + x = self._x_offset + o * (start + 1) + else: + o = -(self._width - 2 * w) / self._num_samples + x = -o * (self._num_samples - start) + self._x_offset + + for i in range(start, end): + # Ensure that no empty area is drawn, + # thus use a minimum sample value + + if self._is_LTR: + sample1 = max(0.05, self._samples[i][0]) + sample2 = max(0.05, self._samples[i][1]) + else: + sample1 = max(0.05, self._samples[i][1]) + sample2 = max(0.05, self._samples[i][0]) + + self._draw_rounded_rec2(ctx, x, y, w, sample1 * s, sample2 * s, r) + ctx.fill() + x += o + + def _on_drawingarea_draw(self, + _drawing_area: Gtk.DrawingArea, + ctx: cairo.Context[cairo.ImageSurface], + ) -> None: + + if self._num_samples != 0: + self._draw_surface(ctx) + + def _on_drawingarea_changed(self, + _drawing_area: Gtk.DrawingArea, + _event: Gdk.EventConfigure, + ) -> None: + + self._is_LTR = (self.get_direction() == Gtk.TextDirection.LTR) + self._setup_surface() + self.queue_draw() + + def _draw_rounded_rec2(self, + context: cairo.Context[cairo.ImageSurface], + x: float, + y: float, + w: float, + h1: float, + h2: float, + r: float + ) -> None: + + ''' + Draws a rectangle of width w and total height of h1+h2 + The top and bottom edges are curved to the outside + ''' + m = w / 2 + + if not self._is_LTR: + m = -m + w = -w + + context.curve_to(x, y + h1, + x + m, y + h1 + r, + x + w, y + h1) + + context.line_to(x + w, y - h2) + + context.curve_to(x + w, y - h2, + x + m, y - h2 - r, + x, y - h2) + + context.line_to(x, y + h1) ===================================== pyproject.toml ===================================== @@ -125,6 +125,8 @@ include = [ "gajim/gtk/plugins.py", "gajim/gtk/preview.py", "gajim/gtk/preview_audio.py", + "gajim/gtk/preview_audio_analyzer.py", + "gajim/gtk/preview_audio_visualizer.py", "gajim/gtk/proxies.py", "gajim/gtk/remove_account.py", "gajim/gtk/resource_selector.py", ===================================== test/no_gui/test_text_helpers.py ===================================== @@ -2,6 +2,7 @@ from gajim.common.text_helpers import escape_iri_path_segment from gajim.common.text_helpers import jid_to_iri +from gajim.common.text_helpers import format_duration class Test(unittest.TestCase): @@ -30,6 +31,30 @@ def test_jid_to_iri(self): self.assertEqual(jid_to_iri(jid), r'xmpp:my%5C20self@%5B::1%5D/home', jid) + def test_format_duration_width(self): + def do(total_seconds, expected): + self.assertEqual(format_duration(0.0, total_seconds*1e9), expected) + + do( 0, '0:00') + do( 60, '0:00') + do( 10*60, '00:00') + do( 60*60, '0:00:00') + do( 10*60*60, '00:00:00') + do(100*60*60, '000:00:00') + + def test_format_duration(self): + def do(duration, expected): + self.assertEqual(format_duration(duration, 100*60*60*1e9), expected) + + do( 1.0, '000:00:00') + do( 999999999.0, '000:00:00') + do( 1000000000.0, '000:00:01') + do( 59999999999.0, '000:00:59') + do( 60000000000.0, '000:01:00') + do( 3599999999999.0, '000:59:59') + do( 3600000000000.0, '001:00:00') + do(3599999999999999.0, '999:59:59') + if __name__ == '__main__': unittest.main() View it on GitLab: https://dev.gajim.org/gajim/gajim/-/commit/ca5f6104ddd79801ce800c9870664736… -- View it on GitLab: https://dev.gajim.org/gajim/gajim/-/commit/ca5f6104ddd79801ce800c9870664736… You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/gajim][master] refactor: Harmonize groupchat-join/open-chat action
by Philipp Hörist (＠lovetox) 08 Dec '22

08 Dec '22

Philipp Hörist pushed to branch master at gajim / gajim Commits: 278ea276 by Philipp Hörist at 2022-12-08T13:11:46+01:00 refactor: Harmonize groupchat-join/open-chat action We want the behavior of groupchat-join, but not only for group chats. This consolidates the code into the open-chat action. - - - - - 3 changed files: - gajim/gtk/application.py - gajim/gtk/const.py - gajim/gtk/menus.py Changes: ===================================== gajim/gtk/application.py ===================================== @@ -302,7 +302,7 @@ def _open_uris(self, uris: list[str]) -> None: if cmd == 'join': if len(accounts) == 1: self.activate_action( - 'groupchat-join', + 'open-chat', GLib.Variant('as', [accounts[0], jid])) else: self.activate_action( @@ -418,7 +418,7 @@ def _connect_app_actions(self) -> None: ('remove-history', self._on_remove_history_action), ('create-groupchat', self._on_create_groupchat_action), ('forget-groupchat', self._on_forget_groupchat_action), - ('groupchat-join', self._on_groupchat_join_action), + ('open-chat', self._on_open_chat_action), ('show', self._on_show), ] @@ -445,7 +445,6 @@ def add_account_actions(self, account: str) -> None: def _connect_account_actions(self, account: str) -> None: actions = [ ('bookmarks', self._on_bookmarks_action), - ('open-chat', self._on_open_chat_action), ('add-contact', self._on_add_contact_account_action), ('services', self._on_services_action), ('profile', self._on_profile_action), @@ -854,12 +853,6 @@ def _on_forget_groupchat_action(_action: Gio.SimpleAction, app.storage.archive.remove_history(params.account, params.jid) - @staticmethod - def _on_groupchat_join_action(_action: Gio.SimpleAction, - param: GLib.Variant) -> None: - account, jid = param.get_strv() - app.window.start_chat_from_jid(account, jid) - @staticmethod def _on_show(_action: Gio.SimpleAction, param: GLib.Variant) -> None: app.window.show() ===================================== gajim/gtk/const.py ===================================== @@ -169,7 +169,6 @@ def __str__(self): ('features', None), ('file-transfer', None), ('forget-groupchat', 'a{sv}'), - ('groupchat-join', 'as'), ('join-support-chat', None), ('manage-proxies', None), ('open-link', 'as'), @@ -180,6 +179,7 @@ def __str__(self): ('shortcuts', None), ('show', None), ('start-chat', 'as'), + ('open-chat', 'as'), ('xml-console', None), ] @@ -274,7 +274,6 @@ def __str__(self): ('export-history', 's'), ('import-contacts', 's'), ('mark-as-read', 'a{sv}'), - ('open-chat', 'as'), ('open-event', 'a{sv}'), ('pep-config', 's'), ('profile', 's'), @@ -299,7 +298,6 @@ def __str__(self): 'modify-gateway', 'bookmarks', 'import-contacts', - 'open-chat', 'pep-config', 'profile', 'server-info', ===================================== gajim/gtk/menus.py ===================================== @@ -296,7 +296,7 @@ def _xmpp_message_query_context_menu(uri: URI, account: str) -> UriMenuItemsT: return [ ('copy-text', [uri.source], _('Copy Link Location')), ('copy-text', [jid], _('Copy XMPP Address')), - (f'{account}-open-chat', [account, jid], _('Start Chat…')), + ('open-chat', [account, jid], _('Start Chat…')), # ^ TODO: pass qparams ^ (f'{account}-add-contact', [account, jid], _('Add to Contact List…')), ] @@ -306,7 +306,7 @@ def _xmpp_join_query_context_menu(uri: URI, account: str) -> UriMenuItemsT: return [ ('copy-text', [uri.source], _('Copy Link Location')), ('copy-text', [uri.data['jid']], _('Copy XMPP Address')), - ('groupchat-join', [account, uri.data['jid']], + ('open-chat', [account, uri.data['jid']], # ^ TODO: pass qparams ^ _('Join Groupchat…')), ] @@ -352,8 +352,7 @@ def _ambiguous_addr_context_menu(uri: URI, account: str) -> UriMenuItemsT: return [ ('copy-text', [addr], _('Copy XMPP Address/Email')), ('open-link', ['', mailto], _('Open Email Composer')), - (f'{account}-open-chat', [account, addr], _('Start Chat…')), - ('groupchat-join', [account, addr], _('Join Groupchat…')), + ('open-chat', [account, addr], _('Start Chat…')), (f'{account}-add-contact', [account, addr], _('Add to Contact List…')), ] View it on GitLab: https://dev.gajim.org/gajim/gajim/-/commit/278ea27680f87a36a1d2eb14a7bfe520… -- View it on GitLab: https://dev.gajim.org/gajim/gajim/-/commit/278ea27680f87a36a1d2eb14a7bfe520… You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/gajim][master] 7 commits: feat: Resurrect URI-specific context menus
by Philipp Hörist (＠lovetox) 08 Dec '22

08 Dec '22

Philipp Hörist pushed to branch master at gajim / gajim Commits: f681bcee by mjk at 2022-12-07T17:03:40+03:00 feat: Resurrect URI-specific context menus - - - - - dfac89f7 by mjk at 2022-12-07T17:03:40+03:00 refactor: Make URI context menus more data-driven ...and cover missing URITypes, adding "coverage" tests. - - - - - 340e33d0 by mjk at 2022-12-08T11:00:12+00:00 refactor: Simplify the type of URI.data No casts/type assertions needed now. - - - - - e65badc7 by mjk at 2022-12-08T11:00:56+00:00 imprv: Use the unified Start/Join Chat flow for ?join links * Immediately switch to the chat if already open. * Don't "crash" if current account is offline. - - - - - 753e8345 by mjk at 2022-12-08T11:00:56+00:00 refactor: Make xmpp query type handling in open_uri more change-proof - - - - - def536da by mjk at 2022-12-08T11:00:56+00:00 imprv: Restore ability to manually disambiguate JID-like addresses ...by storing them in `href` attributes as internal-use `about:ambiguous-address?a@b.c` URIs. Storing raw `a(a)b.c` in `href` wouldn't make a lot of semantic sense, as that's a relative-path URI with the meaning of "the thing named 'a(a)b.c' in the same directory as the current document". Plus, it would either entail handling these addresses outside `parse_uri()`, or changing its purpose of parsing only absolute URIs. - - - - - 66e748fd by mjk at 2022-12-08T11:00:56+00:00 imprv: Add dedicated context menu for non-specific URI types - - - - - 12 changed files: - gajim/common/const.py - gajim/common/helpers.py - gajim/common/structs.py - gajim/common/styling.py - gajim/common/text_helpers.py - gajim/gtk/application.py - gajim/gtk/const.py - gajim/gtk/conversation/plain_widget.py - gajim/gtk/menus.py - + test/no_gui/test_gtk_menus.py - test/no_gui/test_styling.py - + test/no_gui/test_uri_util.py Changes: ===================================== gajim/common/const.py ===================================== @@ -224,6 +224,7 @@ class URIType(Enum): FILE = 'file' AT = 'at' TEL = 'tel' + OTHER = 'other' # https://xmpp.org/registrar/querytypes.html @@ -239,6 +240,13 @@ def from_str(s: str) -> Optional[XmppUriQuery]: except ValueError: return None + @staticmethod + def from_str_or_none(s: str) -> XmppUriQuery: + qtype = XmppUriQuery.from_str(s) + if qtype: + return qtype + return XmppUriQuery.NONE + class MUCJoinedState(Enum): JOINED = 'joined' ===================================== gajim/common/helpers.py ===================================== @@ -942,7 +942,7 @@ def parse_uri(uri: str) -> URI: if not urlparts.netloc: err = f'No host or empty host in an {scheme} URI' return URI(URIType.INVALID, uri, data={'error': err}) - return URI(URIType.WEB, uri, data=uri) + return URI(URIType.WEB, uri) if scheme == 'xmpp': if not urlparts.path.startswith('/'): @@ -965,17 +965,19 @@ def parse_uri(uri: str) -> URI: data=data) if scheme == 'mailto': + data: dict[str, str] = {} try: - data = unquote(urlparts.path, errors='strict') - validate_jid(data, 'bare') # meh, good enuf + data['addr'] = unquote(urlparts.path, errors='strict') + validate_jid(data['addr'], 'bare') # meh, good enuf except ValueError as err: - data = {'error': str(err)} + data['error'] = str(err) return URI(URIType.INVALID, uri, data=data) return URI(URIType.MAIL, uri, data=data) if scheme == 'tel': - data = uri[4:] - return URI(URIType.TEL, uri, data=data) + # https://rfc-editor.org/rfc/rfc3966#section-3 + # TODO: extract number + return URI(URIType.TEL, uri) if scheme == 'geo': # TODO: unify with .preview_helpers.split_geo_uri @@ -984,19 +986,15 @@ def parse_uri(uri: str) -> URI: if not lat or not lon_alt: return URI(URIType.INVALID, uri, data={ 'error': 'No latitude or longitude'}) - lon, _, _alt = lon_alt.partition(',') + lon, _, alt = lon_alt.partition(',') if not lon: return URI(URIType.INVALID, uri, data={'error': 'No longitude'}) - # TODO: move redirection to open_uri, parsing needs to be unit-testable - if Gio.AppInfo.get_default_for_uri_scheme('geo'): - return URI(URIType.GEO, uri, data=uri) - - data = geo_provider_from_location(lat, lon) + data = {'lat': lat, 'lon': lon, 'alt': alt} return URI(URIType.GEO, uri, data=data) if scheme == 'file': - # https://rfc-editor.org/rfc/rfc8089.html + # https://rfc-editor.org/rfc/rfc8089.html#section-2 data: dict[str, str] = {} try: data['netloc'] = urlparts.netloc @@ -1007,7 +1005,35 @@ def parse_uri(uri: str) -> URI: return URI(URIType.INVALID, uri, data=data) return URI(URIType.FILE, uri, data=data) - return URI(URIType.WEB, uri, data=uri) + if scheme == 'about': + # https://rfc-editor.org/rfc/rfc6694#section-2.1 + data: dict[str, str] = {} + try: + token = unquote(urlparts.path, errors='strict') + if token == 'ambiguous-address': # noqa S105 + data['addr'] = unquote(urlparts.query, errors='strict') + validate_jid(data['addr'], 'bare') + return URI(URIType.AT, uri, data=data) + raise Exception(f'Unrecognized about-token "{token}"') + except Exception as err: + data['error'] = str(err) + return URI(URIType.INVALID, uri, data=data) + + return URI(URIType.OTHER, uri) + + +def _handle_message_qtype( + jid: str, params: dict[str, str], account: str) -> None: + body = params.get('body') + # ^ For JOIN, this is a non-standard, but nice extension + app.window.start_chat_from_jid(account, jid, message=body) + + +_xmpp_query_type_handlers = { + XmppUriQuery.NONE: _handle_message_qtype, + XmppUriQuery.MESSAGE: _handle_message_qtype, + XmppUriQuery.JOIN: _handle_message_qtype, +} @catch_exceptions @@ -1022,11 +1048,15 @@ def open_uri(uri: Union[URI, str], account: Optional[str] = None) -> None: else: log.info('Blocked opening a file URI, see %s option', opt_name) - elif uri.type in (URIType.MAIL, URIType.TEL): + elif uri.type in (URIType.MAIL, URIType.TEL, URIType.WEB, URIType.OTHER): open_uri_externally(uri.source) - elif uri.type in (URIType.WEB, URIType.GEO): - open_uri_externally(uri.data) + elif uri.type == URIType.GEO: + if Gio.AppInfo.get_default_for_uri_scheme('geo'): + open_uri_externally(uri.source) + else: + open_uri( + geo_provider_from_location(uri.data['lat'], uri.data['lon'])) elif uri.type in (URIType.XMPP, URIType.AT): if account is None: @@ -1036,7 +1066,7 @@ def open_uri(uri: Union[URI, str], account: Optional[str] = None) -> None: if uri.type == URIType.XMPP: jid = uri.data['jid'] else: - jid = uri.data + jid = uri.data['addr'] qtype, qparams = XmppUriQuery.from_str(uri.query_type), uri.query_params if not qtype: @@ -1049,14 +1079,7 @@ def open_uri(uri: Union[URI, str], account: Optional[str] = None) -> None: # > <xmpp:example-node@example.com> rather than # > <xmpp:example-node@example.com?query>." qtype, qparams = XmppUriQuery.NONE, {} - - if qtype == XmppUriQuery.JOIN: - app.app.activate_action( - 'groupchat-join', - GLib.Variant('as', [account, jid])) - else: - message = qparams.get('body') - app.window.start_chat_from_jid(account, jid, message=message) + _xmpp_query_type_handlers[qtype](jid, qparams, account) elif uri.type == URIType.INVALID: log.warning('open_uri: Invalid %s', uri) ===================================== gajim/common/structs.py ===================================== @@ -18,7 +18,6 @@ from typing import TypeVar from typing import NamedTuple from typing import Optional -from typing import Union import time from dataclasses import dataclass @@ -51,7 +50,7 @@ class URI(NamedTuple): source: str query_type: str = '' query_params: dict[str, str] = {} - data: Optional[Union[dict[str, str], str]] = None + data: dict[str, str] = {} class MUCData: ===================================== gajim/common/styling.py ===================================== @@ -29,7 +29,7 @@ from gajim.common.const import URIType from gajim.common.helpers import parse_uri as analyze_uri from gajim.common.helpers import validate_jid -from gajim.common.text_helpers import jid_to_iri +from gajim.common.text_helpers import escape_iri_query PRE = '`' STRONG = '*' @@ -73,8 +73,7 @@ class BaseHyperlink(StyleObject): def get_markup_string(self) -> str: href = GLib.markup_escape_text(self.uri) text = GLib.markup_escape_text(self.text) - title = '' if href == text else f' title="{href}"' - return f'<a href="{href}"{title}>{text}</a>' + return f'<a href="{href}">{text}</a>' @dataclass @@ -82,6 +81,11 @@ class Hyperlink(BaseHyperlink): name: str = field(default='uri', init=False) +@dataclass +class Address(BaseHyperlink): + name: str = field(default='address', init=False) + + @dataclass class XMPPAddress(BaseHyperlink): name: str = field(default='xmppadr', init=False) @@ -406,12 +410,12 @@ def _make_hyperlink(line: str, uri = text if is_jid: - cls_ = XMPPAddress + cls_ = Address try: validate_jid(text) except ValueError: return None - uri = jid_to_iri(text) + uri = 'about:ambiguous-address?' + escape_iri_query(text) else: uri = text ===================================== gajim/common/text_helpers.py ===================================== @@ -29,5 +29,10 @@ def escape_iri_path(s: str) -> str: s, _reserved_chars_allowed_in_path_segment + '/', True) +def escape_iri_query(s: str) -> str: + return GLib.Uri.escape_string( + s, _reserved_chars_allowed_in_path_segment + '/?', True) + + def jid_to_iri(jid: str) -> str: return 'xmpp:' + escape_iri_path(jid) ===================================== gajim/gtk/application.py ===================================== @@ -415,7 +415,6 @@ def _connect_app_actions(self) -> None: ('add-contact', self._on_add_contact_action), ('copy-text', self._on_copy_text_action), ('open-link', self._on_open_link_action), - ('open-mail', self._on_open_mail_action), ('remove-history', self._on_remove_history_action), ('create-groupchat', self._on_create_groupchat_action), ('forget-groupchat', self._on_forget_groupchat_action), @@ -798,14 +797,6 @@ def _on_mark_as_read_action(self, app.window.mark_as_read(params.account, params.jid) - @staticmethod - def _on_open_mail_action(_action: Gio.SimpleAction, - param: GLib.Variant) -> None: - uri = param.get_string() - if not uri.startswith('mailto:'): - uri = 'mailto:%s' % uri - open_uri(uri) - @staticmethod def _on_open_link_action(_action: Gio.SimpleAction, param: GLib.Variant) -> None: @@ -867,7 +858,7 @@ def _on_forget_groupchat_action(_action: Gio.SimpleAction, def _on_groupchat_join_action(_action: Gio.SimpleAction, param: GLib.Variant) -> None: account, jid = param.get_strv() - open_window('GroupchatJoin', account=account, jid=jid) + app.window.start_chat_from_jid(account, jid) @staticmethod def _on_show(_action: Gio.SimpleAction, param: GLib.Variant) -> None: ===================================== gajim/gtk/const.py ===================================== @@ -173,7 +173,6 @@ def __str__(self): ('join-support-chat', None), ('manage-proxies', None), ('open-link', 'as'), - ('open-mail', 's'), ('plugins', None), ('preferences', None), ('quit', None), ===================================== gajim/gtk/conversation/plain_widget.py ===================================== @@ -22,16 +22,19 @@ from gi.repository import GLib from gajim.common.helpers import open_uri +from gajim.common.helpers import parse_uri +from gajim.common.structs import URIType from gajim.common.styling import BaseHyperlink from gajim.common.styling import PlainBlock from gajim.common.styling import process_uris from ..menus import get_conv_action_context_menu +from ..menus import populate_uri_context_menu from ..util import make_pango_attributes log = logging.getLogger('gajim.gui.conversaion.plain_widget') -URI_TAGS = ['uri', 'xmppadr', 'mailadr'] +URI_TAGS = ['uri', 'address', 'xmppadr', 'mailadr'] STYLE_TAGS = ['strong', 'emphasis', 'strike', 'pre'] @@ -75,15 +78,18 @@ def __init__(self, account: str, selectable: bool) -> None: self.connect('focus-out-event', self._on_focus_out) def _on_populate_popup(self, label: Gtk.Label, menu: Gtk.Menu) -> None: + uri = label.get_current_uri() selected, start, end = label.get_selection_bounds() - if not selected: - menu.show_all() - return - - selected_text = label.get_text()[start:end] - action_menu_item = get_conv_action_context_menu( - self._account, selected_text) - menu.prepend(action_menu_item) + if uri: + puri = parse_uri(uri) + assert puri.type != URIType.INVALID # would be a common.styling bug + menu.foreach(menu.remove) + populate_uri_context_menu(menu, self._account, puri) + elif selected: + selected_text = label.get_text()[start:end] + action_menu_item = get_conv_action_context_menu( + self._account, selected_text) + menu.prepend(action_menu_item) menu.show_all() def _build_link_markup(self, text: str, uris: list[BaseHyperlink]) -> str: @@ -114,7 +120,8 @@ def add_action_phrase(self, text: str, nickname: str) -> None: self.set_markup(f'<i>{text}</i>') def _on_activate_link(self, _label: Gtk.Label, uri: str) -> int: - open_uri(uri, self._account) + puri = parse_uri(uri) + open_uri(puri, self._account) return Gdk.EVENT_STOP @staticmethod ===================================== gajim/gtk/menus.py ===================================== @@ -17,6 +17,7 @@ from __future__ import annotations from typing import Iterator +from typing import Callable from typing import cast from typing import Optional from typing import Union @@ -33,6 +34,7 @@ from gajim.common import app from gajim.common import types +from gajim.common.helpers import filesystem_path_from_uri from gajim.common.helpers import from_one_line from gajim.common.helpers import is_affiliation_change_allowed from gajim.common.helpers import is_retraction_allowed @@ -46,6 +48,7 @@ from gajim.common.preview import Preview from gajim.common.structs import URI from gajim.common.structs import VariantMixin +from gajim.common.text_helpers import escape_iri_path_segment from gajim.common.modules.contacts import GroupchatContact from gajim.common.modules.contacts import can_add_to_roster @@ -59,6 +62,8 @@ MenuValueT = Union[None, str, GLib.Variant, VariantMixin] MenuItemListT = list[tuple[str, str, MenuValueT]] +UriMenuItemsT = list[tuple[str, list[str], str]] +UriMenuBuilderT = Callable[[URI, str], UriMenuItemsT] def get_self_contact_menu(contact: types.BareContact) -> GajimMenu: @@ -285,77 +290,125 @@ def get_conv_action_context_menu(account: str, return action_menu_item -def get_conv_uri_context_menu(account: str, uri: URI) -> Optional[Gtk.Menu]: - if uri.type == URIType.XMPP: - if XmppUriQuery.from_str(uri.query_type) == XmppUriQuery.JOIN: - context_menu = [ - ('copy-text', _('Copy XMPP Address')), - ('groupchat-join', _('Join Groupchat')), - ] - else: - context_menu = [ - ('copy-text', _('Copy XMPP Address')), - ('-open-chat', _('Start Chat')), - ('-add-contact', _('Add to Contact List…')), - ] - - elif uri.type == URIType.WEB: - context_menu = [ - ('copy-text', _('Copy Link Location')), - ('open-link', _('Open Link in Browser')), - ] - - elif uri.type == URIType.MAIL: - context_menu = [ - ('copy-text', _('Copy Email Address')), - ('open-mail', _('Open Email Composer')), - ] - - elif uri.type == URIType.GEO: - context_menu = [ - ('copy-text', _('Copy Location')), - ('open-link', _('Show Location')), - ] - - elif uri.type == URIType.AT: - context_menu = [ - ('copy-text', _('Copy XMPP Address/Email')), - ('open-mail', _('Open Email Composer')), - ('-open-chat', _('Start Chat')), - ('groupchat-join', _('Join Groupchat')), - ('-add-contact', _('Add to Contact List…')), - ] - else: - return None +def _xmpp_message_query_context_menu(uri: URI, account: str) -> UriMenuItemsT: + jid = uri.data['jid'] + # qparams = uri.query_params + return [ + ('copy-text', [uri.source], _('Copy Link Location')), + ('copy-text', [jid], _('Copy XMPP Address')), + (f'{account}-open-chat', [account, jid], _('Start Chat…')), + # ^ TODO: pass qparams ^ + (f'{account}-add-contact', [account, jid], _('Add to Contact List…')), + ] - menu = Gtk.Menu() - for item in context_menu: - action, label = item + +def _xmpp_join_query_context_menu(uri: URI, account: str) -> UriMenuItemsT: + return [ + ('copy-text', [uri.source], _('Copy Link Location')), + ('copy-text', [uri.data['jid']], _('Copy XMPP Address')), + ('groupchat-join', [account, uri.data['jid']], + # ^ TODO: pass qparams ^ + _('Join Groupchat…')), + ] + + +_xmpp_uri_context_menus: dict[XmppUriQuery, UriMenuBuilderT] = { + XmppUriQuery.NONE: _xmpp_message_query_context_menu, + XmppUriQuery.MESSAGE: _xmpp_message_query_context_menu, + XmppUriQuery.JOIN: _xmpp_join_query_context_menu, +} + + +def _xmpp_uri_context_menu(uri: URI, account: str) -> UriMenuItemsT: + return _xmpp_uri_context_menus[XmppUriQuery.from_str_or_none(uri.query_type) + ](uri, account) + + +def _web_uri_context_menu(uri: URI, _account: str) -> UriMenuItemsT: + return [ + ('copy-text', [uri.source], _('Copy Link Location')), + ('open-link', ['', uri.source], _('Open Link in Browser')), + ] + + +def _mailto_uri_context_menu(uri: URI, _account: str) -> UriMenuItemsT: + return [ + ('copy-text', [uri.source], _('Copy Link Location')), + ('copy-text', [uri.data['addr']], _('Copy Email Address')), + ('open-link', ['', uri.source], _('Open Email Composer')), + ] + + +def _geo_uri_context_menu(uri: URI, _account: str) -> UriMenuItemsT: + return [ + ('copy-text', [uri.source], _('Copy Link Location')), + ('open-link', ['', uri.source], _('Show Location')), + ] + + +def _ambiguous_addr_context_menu(uri: URI, account: str) -> UriMenuItemsT: + addr = uri.data['addr'] + mailto = 'mailto:' + escape_iri_path_segment(addr) + return [ + ('copy-text', [addr], _('Copy XMPP Address/Email')), + ('open-link', ['', mailto], _('Open Email Composer')), + (f'{account}-open-chat', [account, addr], _('Start Chat…')), + ('groupchat-join', [account, addr], _('Join Groupchat…')), + (f'{account}-add-contact', [account, addr], _('Add to Contact List…')), + ] + + +def _file_uri_context_menu(uri: URI, _account: str) -> UriMenuItemsT: + canopen = app.settings.get('allow_open_file_uris') + pathobj = filesystem_path_from_uri(uri.source) + return [ + ('copy-text', [uri.source], _('Copy Link Location')), + ('open-link' if canopen else '-', ['', uri.source], _('Open Path')), + ('copy-text' if pathobj else '-', [str(pathobj)], _('Copy Path')), + ] + + +def _tel_uri_context_menu(uri: URI, account: str) -> UriMenuItemsT: + return [ + ('copy-text', [uri.source], _('Copy Link Location')), + ('open-link', [account, uri.source], _('Dial Number')), + # TODO: + # ('copy-text', [uri.data['number']], _('Copy Number')), + ] + + +def _other_uri_context_menu(uri: URI, account: str) -> UriMenuItemsT: + return [ + ('copy-text', [uri.source], _('Copy Link Location')), + ('open-link', [account, uri.source], _('Open Link')), + ] + + +_uri_context_menus: dict[URIType, UriMenuBuilderT] = { + URIType.XMPP: _xmpp_uri_context_menu, + URIType.MAIL: _mailto_uri_context_menu, + URIType.GEO: _geo_uri_context_menu, + URIType.WEB: _web_uri_context_menu, + URIType.FILE: _file_uri_context_menu, + URIType.AT: _ambiguous_addr_context_menu, + URIType.TEL: _tel_uri_context_menu, + URIType.OTHER: _other_uri_context_menu, +} + + +def populate_uri_context_menu(menu: Gtk.Menu, account: str, uri: URI) -> None: + assert uri.type != URIType.INVALID # it really begs to be a separate class + for action, args, label in _uri_context_menus[uri.type](uri, account): menuitem = Gtk.MenuItem() menuitem.set_label(label) - - if action.startswith('-'): - action = f'app.{account}{action}' + menuitem.set_action_name(f'app.{action}') + if len(args) == 1: + value = GLib.Variant.new_string(args[0]) else: - action = f'app.{action}' - menuitem.set_action_name(action) - - data = uri.data - if uri.type == URIType.XMPP: - if isinstance(uri.data, dict): - data = uri.data['jid'] - else: - data = '' - assert isinstance(data, str) - - if action in ('app.open-mail', 'app.copy-text'): - value = GLib.Variant.new_string(data) - else: - value = GLib.Variant.new_strv([account, data]) + value = GLib.Variant.new_strv(args) menuitem.set_action_target_value(value) menuitem.show() menu.append(menuitem) - return menu def get_roster_menu(account: str, jid: str, gateway: bool = False) -> GajimMenu: ===================================== test/no_gui/test_gtk_menus.py ===================================== @@ -0,0 +1,25 @@ +import unittest + +from gajim import gui +gui.init('gtk') + +from gajim.common.const import URIType +from gajim.common.const import XmppUriQuery +from gajim.gtk.menus import _uri_context_menus +from gajim.gtk.menus import _xmpp_uri_context_menus + + +class Test(unittest.TestCase): + def test_uri_menus_dict(self): + for t in URIType: + if t == URIType.INVALID: + continue # doesn't need to be present + self.assertIn(t, _uri_context_menus) + + def test_xmpp_uri_menus_dict(self): + for t in XmppUriQuery: + self.assertIn(t, _xmpp_uri_context_menus) + + +if __name__ == '__main__': + unittest.main() ===================================== test/no_gui/test_styling.py ===================================== @@ -15,7 +15,7 @@ from gajim.common.styling import StrikeSpan from gajim.common.styling import Hyperlink from gajim.common.styling import process_uris -from gajim.common.text_helpers import jid_to_iri +from gajim.common.text_helpers import escape_iri_query app.settings = MagicMock() @@ -313,6 +313,7 @@ 'file:///x:/foo/bar/baz', # windows 'file://localhost/foo/bar/baz', 'file://nonlocalhost/foo/bar/baz', + 'about:ambiguous-address?a@b.c', # These seem to be from https://mathiasbynens.be/demo/url-regex 'http://foo.com/blah_blah', @@ -437,6 +438,11 @@ 'file:a/', 'file:a/b', + 'about:', + 'about:asdfasdf', + 'about:ambiguous-address', + 'about:ambiguous-address?', + 'mailtomailto:foo@bar.com.uk', ] @@ -539,12 +545,12 @@ def test_invalid_uris(self): self.assertEqual([link.text for link in hlinks], [], text) def test_jids(self): - for jid in JIDS: - text = self.wrap(jid) - uri = jid_to_iri(jid) + for jidlike in JIDS: + text = self.wrap(jidlike) + uri = 'about:ambiguous-address?' + escape_iri_query(jidlike) hlinks = process_uris(text) self.assertEqual([(link.text, link.uri) for link in hlinks], - [(jid, uri)], text) + [(jidlike, uri)], text) def test_nonjids(self): for foo in NONJIDS: ===================================== test/no_gui/test_uri_util.py ===================================== @@ -0,0 +1,15 @@ +import unittest + +from gajim.common import app # noqa F401 (avoid circular imports) +from gajim.common.const import XmppUriQuery +from gajim.common.helpers import _xmpp_query_type_handlers + + +class Test(unittest.TestCase): + def test_xmpp_query_type_handlers_dict(self): + for t in XmppUriQuery: + self.assertIn(t, _xmpp_query_type_handlers) + + +if __name__ == '__main__': + unittest.main() View it on GitLab: https://dev.gajim.org/gajim/gajim/-/compare/9e9101a738b29a7e246ada1ba72b9df… -- View it on GitLab: https://dev.gajim.org/gajim/gajim/-/compare/9e9101a738b29a7e246ada1ba72b9df… You're receiving this email because of your account on dev.gajim.org.

1 0

Jump to page:

2026

2025

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

2007

2006

Commits