Commits August 2022

commits@gajim.org

1 participants
208 discussions

[Git][gajim/python-nbxmpp][master] 2 commits: refactor: SASL: Prepare module for XEP-0388
by Philipp Hörist (＠lovetox) 28 Aug '22

28 Aug '22

Philipp Hörist pushed to branch master at gajim / python-nbxmpp Commits: c9969f4f by lovetox at 2022-08-28T07:01:40+00:00 refactor: SASL: Prepare module for XEP-0388 - Move sending stanzas out of mechanism impl - Add missing SHA-512-PLUS method - Add type hints - - - - - 18c408c0 by lovetox at 2022-08-28T09:06:03+02:00 ci: Disable pylint check - - - - - 5 changed files: - .ci/pylint-test.py - nbxmpp/client.py - nbxmpp/protocol.py - nbxmpp/auth.py → nbxmpp/sasl.py - test/unit/test_sasl_scram.py Changes: ===================================== .ci/pylint-test.py ===================================== @@ -14,6 +14,7 @@ DISABLED_CHECKS = [ 'W0201', # attribute-defined-outside-init 'W0212', # protected-access 'W0221', # arguments-differ + 'W0223', # abstract-method 'W0231', # super-init-not-called 'W0233', # non-parent-init-called 'W0621', # redefined-outer-name ===================================== nbxmpp/client.py ===================================== @@ -39,7 +39,7 @@ from nbxmpp.addresses import NoMoreAddresses from nbxmpp.tcp import TCPConnection from nbxmpp.websocket import WebsocketConnection from nbxmpp.smacks import Smacks -from nbxmpp.auth import SASL +from nbxmpp.sasl import SASL from nbxmpp.const import StreamState from nbxmpp.const import StreamError from nbxmpp.const import ConnectionType ===================================== nbxmpp/protocol.py ===================================== @@ -44,6 +44,7 @@ def ascii_upper(s): return s.upper() SASL_AUTH_MECHS = [ + 'SCRAM-SHA-512-PLUS', 'SCRAM-SHA-512', 'SCRAM-SHA-256-PLUS', 'SCRAM-SHA-256', ===================================== nbxmpp/auth.py → nbxmpp/sasl.py ===================================== @@ -21,6 +21,7 @@ import binascii import logging import hashlib from hashlib import pbkdf2_hmac +from typing import Optional from nbxmpp.namespaces import Namespace from nbxmpp.protocol import Node @@ -32,7 +33,7 @@ from nbxmpp.util import LogAdapter from nbxmpp.const import StreamState -log = logging.getLogger('nbxmpp.auth') +log = logging.getLogger('nbxmpp.sasl') try: gssapi = __import__('gssapi') @@ -51,9 +52,20 @@ class SASL: self._password = None + self._mechanism_classes = { + 'PLAIN': PLAIN, + 'EXTERNAL': EXTERNAL, + 'GSSAPI': GSSAPI, + 'SCRAM-SHA-1': SCRAM_SHA_1, + 'SCRAM-SHA-1-PLUS': SCRAM_SHA_1_PLUS, + 'SCRAM-SHA-256': SCRAM_SHA_256, + 'SCRAM-SHA-256-PLUS': SCRAM_SHA_256_PLUS, + 'SCRAM-SHA-512': SCRAM_SHA_512, + 'SCRAM-SHA-512-PLUS': SCRAM_SHA_512_PLUS + } + self._allowed_mechs = None self._enabled_mechs = None - self._method = None self._error = None self._log = LogAdapter(log, {'context': client.log_context}) @@ -82,13 +94,14 @@ class SASL: def start_auth(self, features): self._allowed_mechs = self._client.mechs self._enabled_mechs = self._allowed_mechs - self._method = None + self._mechanism = None self._error = None # -PLUS variants need TLS channel binding data # This is currently not supported via GLib self._enabled_mechs.discard('SCRAM-SHA-1-PLUS') self._enabled_mechs.discard('SCRAM-SHA-256-PLUS') + self._enabled_mechs.discard('SCRAM-SHA-512-PLUS') # channel_binding_data = None if not GSSAPI_AVAILABLE: @@ -127,69 +140,49 @@ class SASL: self._on_sasl_finished(False, 'no-password') return - # if chosen_mechanism == 'SCRAM-SHA-256-PLUS': - # self._method = SCRAM_SHA_256_PLUS(self._client, - # channel_binding_data) - # self._method.initiate(self._client.username, self._password) - - # elif chosen_mechanism == 'SCRAM-SHA-1-PLUS': - # self._method = SCRAM_SHA_1_PLUS(self._client, - # channel_binding_data) - # self._method.initiate(self._client.username, self._password) - - if chosen_mechanism == 'SCRAM-SHA-512': - self._method = SCRAM_SHA_512(self._client, None) - self._method.initiate(self._client.username, self._password) - - elif chosen_mechanism == 'SCRAM-SHA-256': - self._method = SCRAM_SHA_256(self._client, None) - self._method.initiate(self._client.username, self._password) - - elif chosen_mechanism == 'SCRAM-SHA-1': - self._method = SCRAM_SHA_1(self._client, None) - self._method.initiate(self._client.username, self._password) + mech_class = self._mechanism_classes[chosen_mechanism] + self._mechanism = mech_class(self._client.username, + self._password, + domain_based_name or self._client.domain) - elif chosen_mechanism == 'PLAIN': - self._method = PLAIN(self._client) - self._method.initiate(self._client.username, self._password) - - elif chosen_mechanism == 'ANONYMOUS': - self._method = ANONYMOUS(self._client) - self._method.initiate() # pylint: disable=E1120 - - elif chosen_mechanism == 'EXTERNAL': - self._method = EXTERNAL(self._client) - self._method.initiate(self._client.username, self._client.Server) + try: + self._send_initiate() + except AuthFail as error: + self._log.error(error) + self._abort_auth() + return - elif chosen_mechanism == 'GSSAPI': - self._method = GSSAPI(self._client) - if domain_based_name: - hostname = domain_based_name - else: - hostname = self._client.domain - try: - self._method.initiate(hostname) # pylint: disable=E1120 - except AuthFail as error: - self._log.error(error) - self._abort_auth() - return - else: - self._log.error('Unknown auth mech') + def _send_initiate(self) -> None: + data = self._mechanism.get_initiate_data() + node = Node('auth', + attrs={'xmlns': Namespace.SASL, + 'mechanism': self._mechanism.name}) + if data is not None: + node.setData(data) + self._client.send_nonza(node) - def _on_challenge(self, stanza): + def _on_challenge(self, stanza) -> None: try: - self._method.response(stanza.getData()) + data = self._mechanism.get_response_data(stanza.getData()) except AttributeError: self._log.info('Mechanism has no response method') self._abort_auth() + return + except AuthFail as error: self._log.error(error) self._abort_auth() + return + + node = Node('response', + attrs={'xmlns': Namespace.SASL}, + payload=[data]) + self._client.send_nonza(node) def _on_success(self, stanza): self._log.info('Successfully authenticated with remote server') try: - self._method.success(stanza.getData()) + self._mechanism.get_success_data(stanza.getData()) except AttributeError: pass except AuthFail as error: @@ -227,61 +220,59 @@ class SASL: self._client.set_state(StreamState.AUTH_SUCCESSFUL) -class PLAIN: +class BaseMechanism: - _mechanism = 'PLAIN' + name: str - def __init__(self, client): - self._client = client + def __init__(self, username: str, password: str, domain: str): + self._username = username + self._password = password + self._domain = domain - def initiate(self, username, password): - payload = b64encode('\x00%s\x00%s' % (username, password)) - node = Node('auth', - attrs={'xmlns': Namespace.SASL, 'mechanism': 'PLAIN'}, - payload=[payload]) - self._client.send_nonza(node) + def get_initiate_data(self) -> Optional[str]: + raise NotImplementedError + def get_response_data(self, data: str) -> str: + raise NotImplementedError -class EXTERNAL: + def validate_success_data(self, data: str) -> None: + raise NotImplementedError - _mechanism = 'EXTERNAL' - def __init__(self, client): - self._client = client +class PLAIN(BaseMechanism): - def initiate(self, username, server): - payload = b64encode('%s@%s' % (username, server)) - node = Node('auth', - attrs={'xmlns': Namespace.SASL, 'mechanism': 'EXTERNAL'}, - payload=[payload]) - self._client.send_nonza(node) + name = 'PLAIN' + def get_initiate_data(self) -> str: + return b64encode('\x00%s\x00%s' % (self._username, self._password)) -class ANONYMOUS: - _mechanism = 'ANONYMOUS' +class EXTERNAL(BaseMechanism): - def __init__(self, client): - self._client = client + name = 'EXTERNAL' - def initiate(self): - node = Node('auth', attrs={'xmlns': Namespace.SASL, - 'mechanism': 'ANONYMOUS'}) - self._client.send_nonza(node) + def get_initiate_data(self) -> str: + return b64encode('%s@%s' % (self._username, self._domain)) -class GSSAPI: +class ANONYMOUS(BaseMechanism): - # See https://tools.ietf.org/html/rfc4752#section-3.1 + name = 'ANONYMOUS' - _mechanism = 'GSSAPI' + def get_initiate_data(self) -> None: + return None - def __init__(self, client): - self._client = client - def initiate(self, hostname): +class GSSAPI(BaseMechanism): + + # See https://tools.ietf.org/html/rfc4752#section-3.1 + + name = 'GSSAPI' + + def get_initiate_data(self) -> str: service = gssapi.Name( - 'xmpp@%s' % hostname, name_type=gssapi.NameType.hostbased_service) + 'xmpp@%s' % self._domain, + name_type=gssapi.NameType.hostbased_service) try: self.ctx = gssapi.SecurityContext( name=service, usage="initiate", @@ -289,75 +280,66 @@ class GSSAPI: token = self.ctx.step() except (gssapi.exceptions.GeneralError, gssapi.raw.misc.GSSError) as e: raise AuthFail(e) - node = Node('auth', - attrs={'xmlns': Namespace.SASL, 'mechanism': 'GSSAPI'}, - payload=b64encode(token)) - self._client.send_nonza(node) - def response(self, server_message, *args, **kwargs): - server_message = b64decode(server_message) + return b64encode(token) + + def get_response_data(self, data: str) -> str: + byte_data = b64decode(data) try: if not self.ctx.complete: - output_token = self.ctx.step(server_message) + output_token = self.ctx.step(byte_data) else: - _result = self.ctx.unwrap(server_message) + _result = self.ctx.unwrap(byte_data) # TODO(jelmer): Log result.message data = b'\x00\x00\x00\x00' + bytes(self.ctx.initiator_name) output_token = self.ctx.wrap(data, False).message except (gssapi.exceptions.GeneralError, gssapi.raw.misc.GSSError) as e: raise AuthFail(e) - response = b64encode(output_token) - node = Node('response', - attrs={'xmlns': Namespace.SASL}, - payload=response) - self._client.send_nonza(node) + + return b64encode(output_token) -class SCRAM: +class SCRAM(BaseMechanism): - _mechanism = '' + name = '' _channel_binding = '' _hash_method = '' - def __init__(self, client, channel_binding): - self._client = client - self._channel_binding_data = channel_binding + def __init__(self, *args, **kwargs) -> None: + BaseMechanism.__init__(self, *args, **kwargs) + self._channel_binding_data = None self._client_nonce = '%x' % int(binascii.hexlify(os.urandom(24)), 16) self._client_first_message_bare = None self._server_signature = None - self._password = None + + def set_channel_binding_data(self, data: bytes) -> None: + self._channel_binding_data = data @property - def nonce_length(self): + def nonce_length(self) -> int: return len(self._client_nonce) @property - def _b64_channel_binding_data(self): - if self._mechanism.endswith('PLUS'): + def _b64_channel_binding_data(self) -> str: + if self.name.endswith('PLUS'): return b64encode(b'%s%s' % (self._channel_binding.encode(), self._channel_binding_data)) return b64encode(self._channel_binding) @staticmethod - def _scram_parse(scram_data): + def _scram_parse(scram_data: str) -> dict[str, str]: return dict(s.split('=', 1) for s in scram_data.split(',')) - def initiate(self, username, password): - self._password = password - self._client_first_message_bare = 'n=%s,r=%s' % (username, + def get_initiate_data(self) -> str: + self._client_first_message_bare = 'n=%s,r=%s' % (self._username, self._client_nonce) client_first_message = '%s%s' % (self._channel_binding, self._client_first_message_bare) - payload = b64encode(client_first_message) - node = Node('auth', - attrs={'xmlns': Namespace.SASL, - 'mechanism': self._mechanism}, - payload=[payload]) - self._client.send_nonza(node) + return b64encode(client_first_message) - def response(self, server_first_message): - server_first_message = b64decode(server_first_message).decode() + def get_response_data(self, data) -> str: + server_first_message = b64decode(data).decode() challenge = self._scram_parse(server_first_message) client_nonce = challenge['r'][:self.nonce_length] @@ -397,64 +379,66 @@ class SCRAM: server_key = self._hmac(salted_password, 'Server Key') self._server_signature = self._hmac(server_key, auth_message) - payload = b64encode(client_finale_message) - node = Node('response', - attrs={'xmlns': Namespace.SASL}, - payload=[payload]) - self._client.send_nonza(node) + return b64encode(client_finale_message) - def success(self, server_last_message): - server_last_message = b64decode(server_last_message).decode() + def validate_success_data(self, data: str) -> None: + server_last_message = b64decode(data).decode() success = self._scram_parse(server_last_message) server_signature = b64decode(success['v']) if server_signature != self._server_signature: raise AuthFail('Invalid server signature') - def _hmac(self, key, message): + def _hmac(self, key: bytes, message: str) -> bytes: return hmac.new(key=key, msg=message.encode(), digestmod=self._hash_method).digest() @staticmethod - def _xor(x, y): + def _xor(x: bytes, y: bytes) -> bytes: return bytes([px ^ py for px, py in zip(x, y)]) - def _h(self, data): + def _h(self, data: bytes) -> bytes: return hashlib.new(self._hash_method, data).digest() class SCRAM_SHA_1(SCRAM): - _mechanism = 'SCRAM-SHA-1' + name = 'SCRAM-SHA-1' _channel_binding = 'n,,' _hash_method = 'sha1' class SCRAM_SHA_1_PLUS(SCRAM_SHA_1): - _mechanism = 'SCRAM-SHA-1-PLUS' + name = 'SCRAM-SHA-1-PLUS' _channel_binding = 'p=tls-unique,,' class SCRAM_SHA_256(SCRAM): - _mechanism = 'SCRAM-SHA-256' + name = 'SCRAM-SHA-256' _channel_binding = 'n,,' _hash_method = 'sha256' class SCRAM_SHA_256_PLUS(SCRAM_SHA_256): - _mechanism = 'SCRAM-SHA-256-PLUS' + name = 'SCRAM-SHA-256-PLUS' _channel_binding = 'p=tls-unique,,' class SCRAM_SHA_512(SCRAM): - _mechanism = 'SCRAM-SHA-512' + name = 'SCRAM-SHA-512' _channel_binding = 'n,,' _hash_method = 'sha512' +class SCRAM_SHA_512_PLUS(SCRAM_SHA_512): + + name = 'SCRAM-SHA-512-PLUS' + _channel_binding = 'p=tls-unique,,' + + class AuthFail(Exception): pass ===================================== test/unit/test_sasl_scram.py ===================================== @@ -1,33 +1,34 @@ import unittest from unittest.mock import Mock -from nbxmpp.auth import SCRAM_SHA_1 +from nbxmpp.sasl import SCRAM_SHA_1 from nbxmpp.util import b64encode # Test vector from https://wiki.xmpp.org/web/SASL_and_SCRAM-SHA-1 + class SCRAM(unittest.TestCase): def setUp(self): self.con = Mock() - self._method = SCRAM_SHA_1(self.con, None) - self._method._client_nonce = 'fyko+d2lbbFgONRv9qkxdawL' self.maxDiff = None self._username = 'user' self._password = 'pencil' - - self.auth = '<auth xmlns="urn:ietf:params:xml:ns:xmpp-sasl" mechanism="SCRAM-SHA-1">%s</auth>' % b64encode('n,,n=user,r=fyko+d2lbbFgONRv9qkxdawL') - self.challenge = b64encode('r=fyko+d2lbbFgONRv9qkxdawL3rfcNHYJY1ZVvWVs7j,s=QSXCR+Q6sek8bf92,i=4096') - self.response = '<response xmlns="urn:ietf:params:xml:ns:xmpp-sasl">%s</response>' % b64encode('c=biws,r=fyko+d2lbbFgONRv9qkxdawL3rfcNHYJY1ZVvWVs7j,p=v0X8v3Bz2T0CJGbJQyF0X+HI4Ts=') - self.success = b64encode('v=rmF9pqV8S7suAoZWja4dJRkFsKQ=') + self._mechanism = SCRAM_SHA_1(self._username, self._password, None) + self._mechanism._client_nonce = 'fyko+d2lbbFgONRv9qkxdawL' def test_auth(self): - self._method.initiate(self._username, self._password) - self.assertEqual(self.auth, str(self.con.send_nonza.call_args[0][0])) + initial = b64encode('n,,n=user,r=fyko+d2lbbFgONRv9qkxdawL') + data = self._mechanism.get_initiate_data() + self.assertEqual(data, initial) + + challenge = b64encode('r=fyko+d2lbbFgONRv9qkxdawL3rfcNHYJY1ZVvWVs7j,s=QSXCR+Q6sek8bf92,i=4096') + data = self._mechanism.get_response_data(challenge) - self._method.response(self.challenge) - self.assertEqual(self.response, str(self.con.send_nonza.call_args[0][0])) + response = b64encode('c=biws,r=fyko+d2lbbFgONRv9qkxdawL3rfcNHYJY1ZVvWVs7j,p=v0X8v3Bz2T0CJGbJQyF0X+HI4Ts=') + self.assertEqual(data, response) - self._method.success(self.success) + success = b64encode('v=rmF9pqV8S7suAoZWja4dJRkFsKQ=') + self._mechanism.validate_success_data(success) if __name__ == '__main__': View it on GitLab: https://dev.gajim.org/gajim/python-nbxmpp/-/compare/85120e7ccc04e835312b604… -- View it on GitLab: https://dev.gajim.org/gajim/python-nbxmpp/-/compare/85120e7ccc04e835312b604… You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/python-nbxmpp][sasl2] ci: Disable pylint check
by Philipp Hörist (＠lovetox) 28 Aug '22

28 Aug '22

Philipp Hörist pushed to branch sasl2 at gajim / python-nbxmpp Commits: 18c408c0 by lovetox at 2022-08-28T09:06:03+02:00 ci: Disable pylint check - - - - - 1 changed file: - .ci/pylint-test.py Changes: ===================================== .ci/pylint-test.py ===================================== @@ -14,6 +14,7 @@ DISABLED_CHECKS = [ 'W0201', # attribute-defined-outside-init 'W0212', # protected-access 'W0221', # arguments-differ + 'W0223', # abstract-method 'W0231', # super-init-not-called 'W0233', # non-parent-init-called 'W0621', # redefined-outer-name View it on GitLab: https://dev.gajim.org/gajim/python-nbxmpp/-/commit/18c408c07afc6df5dbd5de45… -- View it on GitLab: https://dev.gajim.org/gajim/python-nbxmpp/-/commit/18c408c07afc6df5dbd5de45… You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/python-nbxmpp][sasl2] 2 commits: ci: Don’t use deprecated report type
by Philipp Hörist (＠lovetox) 28 Aug '22

28 Aug '22

Philipp Hörist pushed to branch sasl2 at gajim / python-nbxmpp Commits: 85120e7c by lovetox at 2022-08-28T09:01:11+02:00 ci: Don’t use deprecated report type - - - - - c9969f4f by lovetox at 2022-08-28T07:01:40+00:00 refactor: SASL: Prepare module for XEP-0388 - Move sending stanzas out of mechanism impl - Add missing SHA-512-PLUS method - Add type hints - - - - - 5 changed files: - .gitlab-ci.yml - nbxmpp/client.py - nbxmpp/protocol.py - nbxmpp/auth.py → nbxmpp/sasl.py - test/unit/test_sasl_scram.py Changes: ===================================== .gitlab-ci.yml ===================================== @@ -17,7 +17,9 @@ test-pylint: coverage: "/TOTAL.+ ([0-9]{1,3}%)/" artifacts: reports: - cobertura: coverage.xml + coverage_report: + coverage_format: cobertura + path: coverage.xml build-linux: image: nbxmpp-deb-build:latest ===================================== nbxmpp/client.py ===================================== @@ -39,7 +39,7 @@ from nbxmpp.addresses import NoMoreAddresses from nbxmpp.tcp import TCPConnection from nbxmpp.websocket import WebsocketConnection from nbxmpp.smacks import Smacks -from nbxmpp.auth import SASL +from nbxmpp.sasl import SASL from nbxmpp.const import StreamState from nbxmpp.const import StreamError from nbxmpp.const import ConnectionType ===================================== nbxmpp/protocol.py ===================================== @@ -44,6 +44,7 @@ def ascii_upper(s): return s.upper() SASL_AUTH_MECHS = [ + 'SCRAM-SHA-512-PLUS', 'SCRAM-SHA-512', 'SCRAM-SHA-256-PLUS', 'SCRAM-SHA-256', ===================================== nbxmpp/auth.py → nbxmpp/sasl.py ===================================== @@ -21,6 +21,7 @@ import binascii import logging import hashlib from hashlib import pbkdf2_hmac +from typing import Optional from nbxmpp.namespaces import Namespace from nbxmpp.protocol import Node @@ -32,7 +33,7 @@ from nbxmpp.util import LogAdapter from nbxmpp.const import StreamState -log = logging.getLogger('nbxmpp.auth') +log = logging.getLogger('nbxmpp.sasl') try: gssapi = __import__('gssapi') @@ -51,9 +52,20 @@ class SASL: self._password = None + self._mechanism_classes = { + 'PLAIN': PLAIN, + 'EXTERNAL': EXTERNAL, + 'GSSAPI': GSSAPI, + 'SCRAM-SHA-1': SCRAM_SHA_1, + 'SCRAM-SHA-1-PLUS': SCRAM_SHA_1_PLUS, + 'SCRAM-SHA-256': SCRAM_SHA_256, + 'SCRAM-SHA-256-PLUS': SCRAM_SHA_256_PLUS, + 'SCRAM-SHA-512': SCRAM_SHA_512, + 'SCRAM-SHA-512-PLUS': SCRAM_SHA_512_PLUS + } + self._allowed_mechs = None self._enabled_mechs = None - self._method = None self._error = None self._log = LogAdapter(log, {'context': client.log_context}) @@ -82,13 +94,14 @@ class SASL: def start_auth(self, features): self._allowed_mechs = self._client.mechs self._enabled_mechs = self._allowed_mechs - self._method = None + self._mechanism = None self._error = None # -PLUS variants need TLS channel binding data # This is currently not supported via GLib self._enabled_mechs.discard('SCRAM-SHA-1-PLUS') self._enabled_mechs.discard('SCRAM-SHA-256-PLUS') + self._enabled_mechs.discard('SCRAM-SHA-512-PLUS') # channel_binding_data = None if not GSSAPI_AVAILABLE: @@ -127,69 +140,49 @@ class SASL: self._on_sasl_finished(False, 'no-password') return - # if chosen_mechanism == 'SCRAM-SHA-256-PLUS': - # self._method = SCRAM_SHA_256_PLUS(self._client, - # channel_binding_data) - # self._method.initiate(self._client.username, self._password) - - # elif chosen_mechanism == 'SCRAM-SHA-1-PLUS': - # self._method = SCRAM_SHA_1_PLUS(self._client, - # channel_binding_data) - # self._method.initiate(self._client.username, self._password) - - if chosen_mechanism == 'SCRAM-SHA-512': - self._method = SCRAM_SHA_512(self._client, None) - self._method.initiate(self._client.username, self._password) - - elif chosen_mechanism == 'SCRAM-SHA-256': - self._method = SCRAM_SHA_256(self._client, None) - self._method.initiate(self._client.username, self._password) - - elif chosen_mechanism == 'SCRAM-SHA-1': - self._method = SCRAM_SHA_1(self._client, None) - self._method.initiate(self._client.username, self._password) + mech_class = self._mechanism_classes[chosen_mechanism] + self._mechanism = mech_class(self._client.username, + self._password, + domain_based_name or self._client.domain) - elif chosen_mechanism == 'PLAIN': - self._method = PLAIN(self._client) - self._method.initiate(self._client.username, self._password) - - elif chosen_mechanism == 'ANONYMOUS': - self._method = ANONYMOUS(self._client) - self._method.initiate() # pylint: disable=E1120 - - elif chosen_mechanism == 'EXTERNAL': - self._method = EXTERNAL(self._client) - self._method.initiate(self._client.username, self._client.Server) + try: + self._send_initiate() + except AuthFail as error: + self._log.error(error) + self._abort_auth() + return - elif chosen_mechanism == 'GSSAPI': - self._method = GSSAPI(self._client) - if domain_based_name: - hostname = domain_based_name - else: - hostname = self._client.domain - try: - self._method.initiate(hostname) # pylint: disable=E1120 - except AuthFail as error: - self._log.error(error) - self._abort_auth() - return - else: - self._log.error('Unknown auth mech') + def _send_initiate(self) -> None: + data = self._mechanism.get_initiate_data() + node = Node('auth', + attrs={'xmlns': Namespace.SASL, + 'mechanism': self._mechanism.name}) + if data is not None: + node.setData(data) + self._client.send_nonza(node) - def _on_challenge(self, stanza): + def _on_challenge(self, stanza) -> None: try: - self._method.response(stanza.getData()) + data = self._mechanism.get_response_data(stanza.getData()) except AttributeError: self._log.info('Mechanism has no response method') self._abort_auth() + return + except AuthFail as error: self._log.error(error) self._abort_auth() + return + + node = Node('response', + attrs={'xmlns': Namespace.SASL}, + payload=[data]) + self._client.send_nonza(node) def _on_success(self, stanza): self._log.info('Successfully authenticated with remote server') try: - self._method.success(stanza.getData()) + self._mechanism.get_success_data(stanza.getData()) except AttributeError: pass except AuthFail as error: @@ -227,61 +220,59 @@ class SASL: self._client.set_state(StreamState.AUTH_SUCCESSFUL) -class PLAIN: +class BaseMechanism: - _mechanism = 'PLAIN' + name: str - def __init__(self, client): - self._client = client + def __init__(self, username: str, password: str, domain: str): + self._username = username + self._password = password + self._domain = domain - def initiate(self, username, password): - payload = b64encode('\x00%s\x00%s' % (username, password)) - node = Node('auth', - attrs={'xmlns': Namespace.SASL, 'mechanism': 'PLAIN'}, - payload=[payload]) - self._client.send_nonza(node) + def get_initiate_data(self) -> Optional[str]: + raise NotImplementedError + def get_response_data(self, data: str) -> str: + raise NotImplementedError -class EXTERNAL: + def validate_success_data(self, data: str) -> None: + raise NotImplementedError - _mechanism = 'EXTERNAL' - def __init__(self, client): - self._client = client +class PLAIN(BaseMechanism): - def initiate(self, username, server): - payload = b64encode('%s@%s' % (username, server)) - node = Node('auth', - attrs={'xmlns': Namespace.SASL, 'mechanism': 'EXTERNAL'}, - payload=[payload]) - self._client.send_nonza(node) + name = 'PLAIN' + def get_initiate_data(self) -> str: + return b64encode('\x00%s\x00%s' % (self._username, self._password)) -class ANONYMOUS: - _mechanism = 'ANONYMOUS' +class EXTERNAL(BaseMechanism): - def __init__(self, client): - self._client = client + name = 'EXTERNAL' - def initiate(self): - node = Node('auth', attrs={'xmlns': Namespace.SASL, - 'mechanism': 'ANONYMOUS'}) - self._client.send_nonza(node) + def get_initiate_data(self) -> str: + return b64encode('%s@%s' % (self._username, self._domain)) -class GSSAPI: +class ANONYMOUS(BaseMechanism): - # See https://tools.ietf.org/html/rfc4752#section-3.1 + name = 'ANONYMOUS' - _mechanism = 'GSSAPI' + def get_initiate_data(self) -> None: + return None - def __init__(self, client): - self._client = client - def initiate(self, hostname): +class GSSAPI(BaseMechanism): + + # See https://tools.ietf.org/html/rfc4752#section-3.1 + + name = 'GSSAPI' + + def get_initiate_data(self) -> str: service = gssapi.Name( - 'xmpp@%s' % hostname, name_type=gssapi.NameType.hostbased_service) + 'xmpp@%s' % self._domain, + name_type=gssapi.NameType.hostbased_service) try: self.ctx = gssapi.SecurityContext( name=service, usage="initiate", @@ -289,75 +280,66 @@ class GSSAPI: token = self.ctx.step() except (gssapi.exceptions.GeneralError, gssapi.raw.misc.GSSError) as e: raise AuthFail(e) - node = Node('auth', - attrs={'xmlns': Namespace.SASL, 'mechanism': 'GSSAPI'}, - payload=b64encode(token)) - self._client.send_nonza(node) - def response(self, server_message, *args, **kwargs): - server_message = b64decode(server_message) + return b64encode(token) + + def get_response_data(self, data: str) -> str: + byte_data = b64decode(data) try: if not self.ctx.complete: - output_token = self.ctx.step(server_message) + output_token = self.ctx.step(byte_data) else: - _result = self.ctx.unwrap(server_message) + _result = self.ctx.unwrap(byte_data) # TODO(jelmer): Log result.message data = b'\x00\x00\x00\x00' + bytes(self.ctx.initiator_name) output_token = self.ctx.wrap(data, False).message except (gssapi.exceptions.GeneralError, gssapi.raw.misc.GSSError) as e: raise AuthFail(e) - response = b64encode(output_token) - node = Node('response', - attrs={'xmlns': Namespace.SASL}, - payload=response) - self._client.send_nonza(node) + + return b64encode(output_token) -class SCRAM: +class SCRAM(BaseMechanism): - _mechanism = '' + name = '' _channel_binding = '' _hash_method = '' - def __init__(self, client, channel_binding): - self._client = client - self._channel_binding_data = channel_binding + def __init__(self, *args, **kwargs) -> None: + BaseMechanism.__init__(self, *args, **kwargs) + self._channel_binding_data = None self._client_nonce = '%x' % int(binascii.hexlify(os.urandom(24)), 16) self._client_first_message_bare = None self._server_signature = None - self._password = None + + def set_channel_binding_data(self, data: bytes) -> None: + self._channel_binding_data = data @property - def nonce_length(self): + def nonce_length(self) -> int: return len(self._client_nonce) @property - def _b64_channel_binding_data(self): - if self._mechanism.endswith('PLUS'): + def _b64_channel_binding_data(self) -> str: + if self.name.endswith('PLUS'): return b64encode(b'%s%s' % (self._channel_binding.encode(), self._channel_binding_data)) return b64encode(self._channel_binding) @staticmethod - def _scram_parse(scram_data): + def _scram_parse(scram_data: str) -> dict[str, str]: return dict(s.split('=', 1) for s in scram_data.split(',')) - def initiate(self, username, password): - self._password = password - self._client_first_message_bare = 'n=%s,r=%s' % (username, + def get_initiate_data(self) -> str: + self._client_first_message_bare = 'n=%s,r=%s' % (self._username, self._client_nonce) client_first_message = '%s%s' % (self._channel_binding, self._client_first_message_bare) - payload = b64encode(client_first_message) - node = Node('auth', - attrs={'xmlns': Namespace.SASL, - 'mechanism': self._mechanism}, - payload=[payload]) - self._client.send_nonza(node) + return b64encode(client_first_message) - def response(self, server_first_message): - server_first_message = b64decode(server_first_message).decode() + def get_response_data(self, data) -> str: + server_first_message = b64decode(data).decode() challenge = self._scram_parse(server_first_message) client_nonce = challenge['r'][:self.nonce_length] @@ -397,64 +379,66 @@ class SCRAM: server_key = self._hmac(salted_password, 'Server Key') self._server_signature = self._hmac(server_key, auth_message) - payload = b64encode(client_finale_message) - node = Node('response', - attrs={'xmlns': Namespace.SASL}, - payload=[payload]) - self._client.send_nonza(node) + return b64encode(client_finale_message) - def success(self, server_last_message): - server_last_message = b64decode(server_last_message).decode() + def validate_success_data(self, data: str) -> None: + server_last_message = b64decode(data).decode() success = self._scram_parse(server_last_message) server_signature = b64decode(success['v']) if server_signature != self._server_signature: raise AuthFail('Invalid server signature') - def _hmac(self, key, message): + def _hmac(self, key: bytes, message: str) -> bytes: return hmac.new(key=key, msg=message.encode(), digestmod=self._hash_method).digest() @staticmethod - def _xor(x, y): + def _xor(x: bytes, y: bytes) -> bytes: return bytes([px ^ py for px, py in zip(x, y)]) - def _h(self, data): + def _h(self, data: bytes) -> bytes: return hashlib.new(self._hash_method, data).digest() class SCRAM_SHA_1(SCRAM): - _mechanism = 'SCRAM-SHA-1' + name = 'SCRAM-SHA-1' _channel_binding = 'n,,' _hash_method = 'sha1' class SCRAM_SHA_1_PLUS(SCRAM_SHA_1): - _mechanism = 'SCRAM-SHA-1-PLUS' + name = 'SCRAM-SHA-1-PLUS' _channel_binding = 'p=tls-unique,,' class SCRAM_SHA_256(SCRAM): - _mechanism = 'SCRAM-SHA-256' + name = 'SCRAM-SHA-256' _channel_binding = 'n,,' _hash_method = 'sha256' class SCRAM_SHA_256_PLUS(SCRAM_SHA_256): - _mechanism = 'SCRAM-SHA-256-PLUS' + name = 'SCRAM-SHA-256-PLUS' _channel_binding = 'p=tls-unique,,' class SCRAM_SHA_512(SCRAM): - _mechanism = 'SCRAM-SHA-512' + name = 'SCRAM-SHA-512' _channel_binding = 'n,,' _hash_method = 'sha512' +class SCRAM_SHA_512_PLUS(SCRAM_SHA_512): + + name = 'SCRAM-SHA-512-PLUS' + _channel_binding = 'p=tls-unique,,' + + class AuthFail(Exception): pass ===================================== test/unit/test_sasl_scram.py ===================================== @@ -1,33 +1,34 @@ import unittest from unittest.mock import Mock -from nbxmpp.auth import SCRAM_SHA_1 +from nbxmpp.sasl import SCRAM_SHA_1 from nbxmpp.util import b64encode # Test vector from https://wiki.xmpp.org/web/SASL_and_SCRAM-SHA-1 + class SCRAM(unittest.TestCase): def setUp(self): self.con = Mock() - self._method = SCRAM_SHA_1(self.con, None) - self._method._client_nonce = 'fyko+d2lbbFgONRv9qkxdawL' self.maxDiff = None self._username = 'user' self._password = 'pencil' - - self.auth = '<auth xmlns="urn:ietf:params:xml:ns:xmpp-sasl" mechanism="SCRAM-SHA-1">%s</auth>' % b64encode('n,,n=user,r=fyko+d2lbbFgONRv9qkxdawL') - self.challenge = b64encode('r=fyko+d2lbbFgONRv9qkxdawL3rfcNHYJY1ZVvWVs7j,s=QSXCR+Q6sek8bf92,i=4096') - self.response = '<response xmlns="urn:ietf:params:xml:ns:xmpp-sasl">%s</response>' % b64encode('c=biws,r=fyko+d2lbbFgONRv9qkxdawL3rfcNHYJY1ZVvWVs7j,p=v0X8v3Bz2T0CJGbJQyF0X+HI4Ts=') - self.success = b64encode('v=rmF9pqV8S7suAoZWja4dJRkFsKQ=') + self._mechanism = SCRAM_SHA_1(self._username, self._password, None) + self._mechanism._client_nonce = 'fyko+d2lbbFgONRv9qkxdawL' def test_auth(self): - self._method.initiate(self._username, self._password) - self.assertEqual(self.auth, str(self.con.send_nonza.call_args[0][0])) + initial = b64encode('n,,n=user,r=fyko+d2lbbFgONRv9qkxdawL') + data = self._mechanism.get_initiate_data() + self.assertEqual(data, initial) + + challenge = b64encode('r=fyko+d2lbbFgONRv9qkxdawL3rfcNHYJY1ZVvWVs7j,s=QSXCR+Q6sek8bf92,i=4096') + data = self._mechanism.get_response_data(challenge) - self._method.response(self.challenge) - self.assertEqual(self.response, str(self.con.send_nonza.call_args[0][0])) + response = b64encode('c=biws,r=fyko+d2lbbFgONRv9qkxdawL3rfcNHYJY1ZVvWVs7j,p=v0X8v3Bz2T0CJGbJQyF0X+HI4Ts=') + self.assertEqual(data, response) - self._method.success(self.success) + success = b64encode('v=rmF9pqV8S7suAoZWja4dJRkFsKQ=') + self._mechanism.validate_success_data(success) if __name__ == '__main__': View it on GitLab: https://dev.gajim.org/gajim/python-nbxmpp/-/compare/19e2fff8980fd81270e24d8… -- View it on GitLab: https://dev.gajim.org/gajim/python-nbxmpp/-/compare/19e2fff8980fd81270e24d8… You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/python-nbxmpp][master] ci: Don’t use deprecated report type
by Philipp Hörist (＠lovetox) 28 Aug '22

28 Aug '22

Philipp Hörist pushed to branch master at gajim / python-nbxmpp Commits: 85120e7c by lovetox at 2022-08-28T09:01:11+02:00 ci: Don’t use deprecated report type - - - - - 1 changed file: - .gitlab-ci.yml Changes: ===================================== .gitlab-ci.yml ===================================== @@ -17,7 +17,9 @@ test-pylint: coverage: "/TOTAL.+ ([0-9]{1,3}%)/" artifacts: reports: - cobertura: coverage.xml + coverage_report: + coverage_format: cobertura + path: coverage.xml build-linux: image: nbxmpp-deb-build:latest View it on GitLab: https://dev.gajim.org/gajim/python-nbxmpp/-/commit/85120e7ccc04e835312b6043… -- View it on GitLab: https://dev.gajim.org/gajim/python-nbxmpp/-/commit/85120e7ccc04e835312b6043… You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/python-nbxmpp] Pushed new branch sasl2
by Philipp Hörist (＠lovetox) 28 Aug '22

28 Aug '22

Philipp Hörist pushed new branch sasl2 at gajim / python-nbxmpp -- View it on GitLab: https://dev.gajim.org/gajim/python-nbxmpp/-/tree/sasl2 You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/gajim] Deleted branch sanitize-filenames
by Daniel Brötzmann (＠wurstsalat) 27 Aug '22

27 Aug '22

Daniel Brötzmann deleted branch sanitize-filenames at gajim / gajim -- You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/gajim][master] fix: Preview: Sanitize filename from disallowed chars
by Philipp Hörist (＠lovetox) 27 Aug '22

27 Aug '22

Philipp Hörist pushed to branch master at gajim / gajim Commits: 8431f218 by wurstsalat at 2022-08-27T14:08:08+02:00 fix: Preview: Sanitize filename from disallowed chars Fixes #11105, #10752 - - - - - 3 changed files: - gajim/common/helpers.py - gajim/common/preview_helpers.py - + test/no_gui/test_sanitize_filename.py Changes: ===================================== gajim/common/helpers.py ===================================== @@ -37,7 +37,6 @@ import re import os import subprocess -import base64 import hashlib import shlex import socket @@ -58,10 +57,10 @@ from datetime import timedelta from urllib.parse import unquote from urllib.parse import urlparse -from encodings.punycode import punycode_encode from functools import wraps from pathlib import Path from packaging.version import Version as V +import unicodedata from nbxmpp.namespaces import Namespace from nbxmpp.const import Role @@ -358,28 +357,40 @@ def get_file_path_from_dnd_dropped_uri(uri: str) -> str: def sanitize_filename(filename: str) -> str: ''' - Make sure the filename we will write does contain only acceptable and latin - characters, and is not too long (in that case hash it) + Sanitize filename of elements not allowed on Windows + https://docs.microsoft.com/en-us/windows/win32/fileio/naming-a-file + Limit filename length to 50 chars on all systems ''' - # 48 is the limit - if len(filename) > 48: - hash_ = hashlib.md5(filename.encode('utf-8')) - filename = base64.b64encode(hash_.digest()).decode('utf-8') - - # make it latin chars only - filename = punycode_encode(filename).decode('utf-8') - filename = filename.replace('/', '_') - if os.name == 'nt': - filename = filename.replace('?', '_')\ - .replace(':', '_')\ - .replace('\\', '_')\ - .replace('"', "'")\ - .replace('|', '_')\ - .replace('*', '_')\ - .replace('<', '_')\ - .replace('>', '_') - - return filename + if sys.platform == 'win32': + blacklist = ['\\', '/', ':', '*', '?', '"', '<', '>', '|', '\0'] + reserved_filenames = [ + 'CON', 'PRN', 'AUX', 'NUL', 'COM1', 'COM2', 'COM3', 'COM4', 'COM5', + 'COM6', 'COM7', 'COM8', 'COM9', 'LPT1', 'LPT2', 'LPT3', 'LPT4', + 'LPT5', 'LPT6', 'LPT7', 'LPT8', 'LPT9', + ] + filename = ''.join(char for char in filename if char not in blacklist) + + filename = ''.join(char for char in filename if 31 < ord(char)) + + filename = unicodedata.normalize('NFKD', filename) + filename = filename.rstrip('. ') + filename = filename.strip() + + if all(char == '.' for char in filename): + filename = f'__{filename}' + if filename.upper() in reserved_filenames: + filename = f'__{filename}' + if len(filename) == 0: + filename = '__' + + extension = Path(filename).suffix[:10] + filename = Path(filename).stem + final_length = 50 - len(extension) + + # Many Filesystems have a limit on filename length: keep it short + filename = filename[:final_length] + + return f'{filename}{extension}' def get_contact_dict_for_account(account: str) -> dict[str, types.BareContact]: ===================================== gajim/common/preview_helpers.py ===================================== @@ -45,6 +45,7 @@ from cryptography.hazmat.primitives.ciphers import algorithms from cryptography.hazmat.primitives.ciphers.modes import GCM +from gajim.common.helpers import sanitize_filename from gajim.common.i18n import _ log = logging.getLogger('gajim.c.preview_helpers') @@ -308,12 +309,7 @@ def get_image_paths(uri: str, web_stem = path.stem extension = path.suffix - if len(web_stem) > 90: - # Many Filesystems have a limit on filename length - # Most have 255, some encrypted ones only 143 - # We add around 50 chars for the hash, - # so the filename should not exceed 90 - web_stem = web_stem[:90] + web_stem = sanitize_filename(web_stem) name_hash = hashlib.sha1(str(uri).encode()).hexdigest() ===================================== test/no_gui/test_sanitize_filename.py ===================================== @@ -0,0 +1,61 @@ + +import sys +import unittest +from unittest.mock import patch +from gajim.common.helpers import sanitize_filename + + +class SanitizeTest(unittest.TestCase): + '''Tests for the sanitize_filename function.''' + + @patch.object(sys, 'platform', 'win32') + def test_invalid_chars(self): + '''Make sure invalid characters are removed in filenames''' + self.assertEqual(sanitize_filename('A/B/C'), 'ABC') + self.assertEqual(sanitize_filename('A*C.d'), 'AC.d') + self.assertEqual(sanitize_filename('A?C.d'), 'AC.d') + + @patch.object(sys, 'platform', 'win32') + def test_invalid_suffix(self): + '''Dots are not allowed at the end''' + self.assertEqual(sanitize_filename('def.'), 'def') + self.assertEqual(sanitize_filename('def.ghi'), 'def.ghi') + self.assertTrue(sanitize_filename('X' * 1000 + '.').endswith('X')) + + @patch.object(sys, 'platform', 'win32') + def test_reserved_words(self): + '''Make sure reserved Windows words are prefixed''' + self.assertEqual(sanitize_filename('NUL'), '__NUL') + self.assertEqual(sanitize_filename('..'), '__') + + @patch.object(sys, 'platform', 'win32') + def test_long_names(self): + '''Make sure long names are truncated''' + self.assertEqual(len(sanitize_filename('X' * 300)), 50) + self.assertEqual(len(sanitize_filename( + '.'.join(['X' * 100, 'X' * 100, 'X' * 100]))), 50) + self.assertEqual(len(sanitize_filename( + '.'.join(['X' * 300, 'X' * 300, 'X' * 300]))), 50) + self.assertEqual(len(sanitize_filename('.' * 300 + '.txt')), 50) + + @patch.object(sys, 'platform', 'win32') + def test_unicode_normalization(self): + '''Names should be NFKD normalized''' + self.assertEqual(sanitize_filename('ў'), chr(1091) + chr(774)) + + @patch.object(sys, 'platform', 'win32') + def test_extensions(self): + '''Filename extensions should be preserved when possible.''' + really_long_name = 'X' * 1000 + '.pdf' + self.assertTrue(sanitize_filename(really_long_name).endswith('.pdf')) + self.assertTrue(sanitize_filename('X' * 1000).endswith('X')) + self.assertTrue(sanitize_filename( + 'X' * 100 + '.' + 'X' * 100 + '.pdf').endswith('.pdf')) + self.assertTrue(sanitize_filename( + 'X' * 100 + '.' + 'X' * 400).endswith('X')) + self.assertTrue(sanitize_filename( + 'X' * 100 + '.' + 'X' * 400 + '.pdf').endswith('.pdf')) + + +if __name__ == '__main__': + unittest.main() View it on GitLab: https://dev.gajim.org/gajim/gajim/-/commit/8431f218054de1bfb6ffb29ecd32b24d… -- View it on GitLab: https://dev.gajim.org/gajim/gajim/-/commit/8431f218054de1bfb6ffb29ecd32b24d… You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/gajim][sanitize-filenames] 4 commits: imprv: ChatList: Always show when switching workspace
by Daniel Brötzmann (＠wurstsalat) 27 Aug '22

27 Aug '22

Daniel Brötzmann pushed to branch sanitize-filenames at gajim / gajim Commits: 63c362f5 by wurstsalat at 2022-08-26T23:29:54+02:00 imprv: ChatList: Always show when switching workspace Fixes #11108 - - - - - 2cf04a23 by Daniel Brötzmann at 2022-08-27T11:09:45+00:00 feat: Add drag and drop support for pinned chats - - - - - 5125e2c0 by wurstsalat at 2022-08-27T14:06:16+02:00 chore: Control: Remove obsolete code - - - - - 8431f218 by wurstsalat at 2022-08-27T14:08:08+02:00 fix: Preview: Sanitize filename from disallowed chars Fixes #11105, #10752 - - - - - 10 changed files: - gajim/common/helpers.py - gajim/common/preview_helpers.py - gajim/common/setting_values.py - gajim/common/settings.py - gajim/gtk/chat_list.py - gajim/gtk/chat_list_stack.py - gajim/gtk/chat_page.py - gajim/gtk/control.py - gajim/gtk/main.py - + test/no_gui/test_sanitize_filename.py Changes: ===================================== gajim/common/helpers.py ===================================== @@ -37,7 +37,6 @@ import re import os import subprocess -import base64 import hashlib import shlex import socket @@ -58,10 +57,10 @@ from datetime import timedelta from urllib.parse import unquote from urllib.parse import urlparse -from encodings.punycode import punycode_encode from functools import wraps from pathlib import Path from packaging.version import Version as V +import unicodedata from nbxmpp.namespaces import Namespace from nbxmpp.const import Role @@ -358,28 +357,40 @@ def get_file_path_from_dnd_dropped_uri(uri: str) -> str: def sanitize_filename(filename: str) -> str: ''' - Make sure the filename we will write does contain only acceptable and latin - characters, and is not too long (in that case hash it) + Sanitize filename of elements not allowed on Windows + https://docs.microsoft.com/en-us/windows/win32/fileio/naming-a-file + Limit filename length to 50 chars on all systems ''' - # 48 is the limit - if len(filename) > 48: - hash_ = hashlib.md5(filename.encode('utf-8')) - filename = base64.b64encode(hash_.digest()).decode('utf-8') - - # make it latin chars only - filename = punycode_encode(filename).decode('utf-8') - filename = filename.replace('/', '_') - if os.name == 'nt': - filename = filename.replace('?', '_')\ - .replace(':', '_')\ - .replace('\\', '_')\ - .replace('"', "'")\ - .replace('|', '_')\ - .replace('*', '_')\ - .replace('<', '_')\ - .replace('>', '_') - - return filename + if sys.platform == 'win32': + blacklist = ['\\', '/', ':', '*', '?', '"', '<', '>', '|', '\0'] + reserved_filenames = [ + 'CON', 'PRN', 'AUX', 'NUL', 'COM1', 'COM2', 'COM3', 'COM4', 'COM5', + 'COM6', 'COM7', 'COM8', 'COM9', 'LPT1', 'LPT2', 'LPT3', 'LPT4', + 'LPT5', 'LPT6', 'LPT7', 'LPT8', 'LPT9', + ] + filename = ''.join(char for char in filename if char not in blacklist) + + filename = ''.join(char for char in filename if 31 < ord(char)) + + filename = unicodedata.normalize('NFKD', filename) + filename = filename.rstrip('. ') + filename = filename.strip() + + if all(char == '.' for char in filename): + filename = f'__{filename}' + if filename.upper() in reserved_filenames: + filename = f'__{filename}' + if len(filename) == 0: + filename = '__' + + extension = Path(filename).suffix[:10] + filename = Path(filename).stem + final_length = 50 - len(extension) + + # Many Filesystems have a limit on filename length: keep it short + filename = filename[:final_length] + + return f'{filename}{extension}' def get_contact_dict_for_account(account: str) -> dict[str, types.BareContact]: ===================================== gajim/common/preview_helpers.py ===================================== @@ -45,6 +45,7 @@ from cryptography.hazmat.primitives.ciphers import algorithms from cryptography.hazmat.primitives.ciphers.modes import GCM +from gajim.common.helpers import sanitize_filename from gajim.common.i18n import _ log = logging.getLogger('gajim.c.preview_helpers') @@ -308,12 +309,7 @@ def get_image_paths(uri: str, web_stem = path.stem extension = path.suffix - if len(web_stem) > 90: - # Many Filesystems have a limit on filename length - # Most have 255, some encrypted ones only 143 - # We add around 50 chars for the hash, - # so the filename should not exceed 90 - web_stem = web_stem[:90] + web_stem = sanitize_filename(web_stem) name_hash = hashlib.sha1(str(uri).encode()).hexdigest() ===================================== gajim/common/setting_values.py ===================================== @@ -506,24 +506,33 @@ class _ACCOUNT_DEFAULT: 'name', ] -AllWorkspaceSettings = Literal[StringWorkspaceSettings, 'open_chats'] +AllWorkspaceSettings = Literal[StringWorkspaceSettings, 'chats'] -OpenChatSettingT = list[tuple[str, JID, str, bool]] -AllWorkspaceSettingsT = Union[str, OpenChatSettingT] + +class OpenChatSettingDetails(TypedDict): + account: str + jid: JID + type: str + pinned: bool + position: int + + +OpenChatsSettingT = list[OpenChatSettingDetails] +AllWorkspaceSettingsT = Union[str, OpenChatsSettingT] class WorkspaceSettings(TypedDict): name: str color: str avatar_sha: str - open_chats: OpenChatSettingT + chats: OpenChatsSettingT WORKSPACE_SETTINGS: WorkspaceSettings = { 'name': _('My Workspace'), 'color': '', 'avatar_sha': '', - 'open_chats': [], + 'chats': [], } ===================================== gajim/common/settings.py ===================================== @@ -56,7 +56,7 @@ from gajim.common.setting_values import StringGroupChatSettings from gajim.common.setting_values import AllWorkspaceSettings from gajim.common.setting_values import AllWorkspaceSettingsT -from gajim.common.setting_values import OpenChatSettingT +from gajim.common.setting_values import OpenChatsSettingT from gajim.common.setting_values import StringWorkspaceSettings from gajim.common.setting_values import ACCOUNT_SETTINGS from gajim.common.setting_values import PROXY_SETTINGS @@ -82,6 +82,8 @@ log = logging.getLogger('gajim.c.settings') +CURRENT_USER_VERSION = 2 + CREATE_SQL = ''' CREATE TABLE settings ( name TEXT UNIQUE, @@ -100,10 +102,11 @@ INSERT INTO settings(name, settings) VALUES ('plugins', '{}'); INSERT INTO settings(name, settings) VALUES ('workspaces', '%s'); - PRAGMA user_version=1; + PRAGMA user_version=%s; ''' % (json.dumps(STATUS_PRESET_EXAMPLES), json.dumps(PROXY_EXAMPLES), - json.dumps(INITAL_WORKSPACE)) + json.dumps(INITAL_WORKSPACE), + CURRENT_USER_VERSION) _SignalCallable = Callable[[Any, str, Optional[str], Optional[JID]], Any] @@ -217,6 +220,7 @@ def init(self) -> None: self._commit() self._migrate_database() self._load_app_overrides() + self._commit() @staticmethod def _setup_installation_defaults() -> None: @@ -320,6 +324,23 @@ def _migrate(self) -> None: self._settings['workspaces'] = INITAL_WORKSPACE self._set_user_version(1) + if version < 2: + # Migrate open chats to new key and format + for workspace in self._settings['workspaces'].values(): + open_chats = [] + for open_chat in workspace.get('open_chats', []): + account, jid, type_, pinned = open_chat + open_chats.append({'account': account, + 'jid': jid, + 'type': type_, + 'pinned': pinned, + 'position': -1}) + + workspace['chats'] = open_chats + workspace.pop('open_chats', None) + + self._set_user_version(2) + def _migrate_old_config(self) -> None: config_file = configpaths.get('CONFIG_FILE') if not config_file.exists(): @@ -1180,8 +1201,8 @@ def set_workspace_setting(self, @overload def set_workspace_setting(self, workspace_id: str, - setting: Literal['open_chats'], - value: list[tuple[str, JID, str, bool]] + setting: Literal['chats'], + value: OpenChatsSettingT ) -> None: ... @@ -1207,8 +1228,8 @@ def set_workspace_setting(self, @overload def get_workspace_setting(self, workspace_id: str, - setting: Literal['open_chats'] - ) -> OpenChatSettingT: + setting: Literal['chats'] + ) -> OpenChatsSettingT: ... @overload ===================================== gajim/gtk/chat_list.py ===================================== @@ -26,6 +26,7 @@ from gi.repository import Gio from gi.repository import Gdk from gi.repository import GLib +from gi.repository import GObject from gi.repository import Gtk import cairo @@ -47,6 +48,7 @@ from gajim.common.helpers import AdditionalDataDict from gajim.common.preview_helpers import filename_from_uri from gajim.common.preview_helpers import guess_simple_file_type +from gajim.common.setting_values import OpenChatsSettingT from gajim.common.types import ChatContactT from gajim.common.types import OneOnOneContactT from gajim.common.modules.contacts import BareContact @@ -65,6 +67,13 @@ class ChatList(Gtk.ListBox, EventHelper): + + __gsignals__ = { + 'chat-order-changed': (GObject.SignalFlags.RUN_LAST, + None, + ()), + } + def __init__(self, workspace_id: str) -> None: Gtk.ListBox.__init__(self) EventHelper.__init__(self) @@ -94,12 +103,16 @@ def __init__(self, workspace_id: str) -> None: entries, Gdk.DragAction.MOVE) + self._drag_row: Optional[ChatRow] = None + self._chat_order: list[ChatRow] = [] + self.register_events([ ('account-enabled', ged.GUI2, self._on_account_changed), ('account-disabled', ged.GUI2, self._on_account_changed), ('bookmarks-received', ged.GUI1, self._on_bookmarks_received), ]) + self.connect('drag-data-received', self._on_drag_data_received) self.connect('destroy', self._on_destroy) self._timer_id = GLib.timeout_add_seconds(60, self._update_timer) @@ -146,6 +159,94 @@ def emit_unread_changed(self) -> None: self._workspace_id, count) + def _get_row_before(self, row: ChatRow) -> Optional[ChatRow]: + row_before = self.get_row_at_index(row.get_index() - 1) + if row_before is None: + return + return cast(ChatRow, row_before) + + def _get_row_after(self, row: ChatRow) -> Optional[ChatRow]: + row_after = self.get_row_at_index(row.get_index() + 1) + if row_after is None: + return + return cast(ChatRow, row_after) + + def _get_last_row(self) -> ChatRow: + index = len(self.get_children()) - 1 + last_row = self.get_row_at_index(index) + assert last_row is not None + return cast(ChatRow, last_row) + + def set_drag_row(self, row: ChatRow) -> None: + self._drag_row = row + + def _on_drag_data_received(self, + _widget: Gtk.Widget, + _drag_context: Gdk.DragContext, + _x_coord: int, + y_coord: int, + selection_data: Gtk.SelectionData, + _info: int, + _time: int + ) -> None: + + item_type = selection_data.get_data_type().name() + if item_type != 'CHAT_LIST_ITEM': + log.debug('Unknown item type dropped') + return + + assert self._drag_row is not None + + if not self._drag_row.is_pinned: + log.debug('Dropped row is not pinned') + return + + row = cast(ChatRow, self.get_row_at_y(y_coord)) + if row is not None: + alloc = row.get_allocation() + hover_row_y = alloc.y + hover_row_height = alloc.height + + if y_coord < hover_row_y + hover_row_height / 2: + row_before = self._get_row_before(row) + row_after = row + else: + row_before = row + row_after = self._get_row_after(row) + else: + row_before = self._get_last_row() + row_after = None + + if self._drag_row in (row_before, row_after): + log.debug('Dropped row on self') + return + + if row_before is not None and not row_before.is_pinned: + log.debug('Dropped under not pinned row') + return + + self._change_pinned_order(row_before) + + def _change_pinned_order(self, row_before: Optional[ChatRow]) -> None: + assert self._drag_row is not None + + self._chat_order.remove(self._drag_row) + + if row_before is None: + self._chat_order.insert(0, self._drag_row) + else: + offset = 0 + if row_before.position < self._drag_row.position: + offset = 1 + self._chat_order.insert( + row_before.position + offset, self._drag_row) + + for row in self._chat_order: + row.position = self._chat_order.index(row) + + self.emit('chat-order-changed') + self.invalidate_sort() + def _on_destroy(self, _widget: Gtk.Widget) -> None: GLib.source_remove(self._timer_id) @@ -198,9 +299,11 @@ def _sort_func(self, row1: ChatRow, row2: ChatRow) -> int: log.debug('Mouseover active, don’t sort rows') return 0 - # Don’t sort pinned rows themselves + # Sort pinned rows according to stored order if row1.is_pinned and row2.is_pinned: - return 0 + if row1.position > row2.position: + return 1 + return -1 # Sort pinned rows to top if row1.is_pinned > row2.is_pinned: @@ -250,14 +353,30 @@ def get_chat_type(self, account: str, jid: JID) -> Optional[str]: return row.type return None - def add_chat(self, account: str, jid: JID, type_: str, - pinned: bool = False) -> None: - if self._chats.get((account, jid)) is not None: + def add_chat(self, + account: str, + jid: JID, + type_: str, + pinned: bool, + position: int + ) -> None: + + key = (account, jid) + if self._chats.get(key) is not None: # Chat is already in the List return - row = ChatRow(self._workspace_id, account, jid, type_, pinned) - self._chats[(account, jid)] = row + row = ChatRow(self._workspace_id, + account, + jid, + type_, + pinned, + position) + + self._chats[key] = row + if pinned: + self._chat_order.insert(position, row) + self.add(row) def select_chat(self, account: str, jid: JID) -> None: @@ -332,12 +451,26 @@ def select_chat_number(self, number: int) -> None: def toggle_chat_pinned(self, account: str, jid: JID) -> None: row = self._chats[(account, jid)] + + if row.is_pinned: + self._chat_order.remove(row) + row.position = -1 + else: + self._chat_order.append(row) + row.position = self._chat_order.index(row) + row.toggle_pinned() self.invalidate_sort() - def remove_chat(self, account: str, jid: JID, - emit_unread: bool = True) -> None: + def remove_chat(self, + account: str, + jid: JID, + emit_unread: bool = True + ) -> None: + row = self._chats.pop((account, jid)) + if row.is_pinned: + self._chat_order.remove(row) self.remove(row) row.destroy() if emit_unread: @@ -359,10 +492,15 @@ def get_selected_chat(self) -> Optional[ChatRow]: def contains_chat(self, account: str, jid: JID) -> bool: return self._chats.get((account, jid)) is not None - def get_open_chats(self) -> list[tuple[str, JID, str, bool]]: - open_chats: list[tuple[str, JID, str, bool]] = [] - for key, value in self._chats.items(): - open_chats.append(key + (value.type, value.is_pinned)) + def get_open_chats(self) -> OpenChatsSettingT: + open_chats: OpenChatsSettingT = [] + for key, row in self._chats.items(): + account, jid = key + open_chats.append({'account': account, + 'jid': jid, + 'type': row.type, + 'pinned': row.is_pinned, + 'position': row.position}) return open_chats def update_time(self) -> None: @@ -536,14 +674,22 @@ def _on_bookmarks_received(self, _event: events.BookmarksReceived) -> None: class ChatRow(Gtk.ListBoxRow): - def __init__(self, workspace_id: str, account: str, jid: JID, type_: str, - pinned: bool) -> None: + def __init__(self, + workspace_id: str, + account: str, + jid: JID, + type_: str, + pinned: bool, + position: int + ) -> None: + Gtk.ListBoxRow.__init__(self) self.account = account self.jid = jid self.workspace_id = workspace_id self.type = type_ + self.position = position self.active_label = ActiveHeader() self.conversations_label = ConversationsHeader() @@ -735,6 +881,10 @@ def _on_drag_begin(self, widget: Gtk.Widget, drag_context: Gdk.DragContext ) -> None: + + chat_list = cast(ChatList, self.get_parent()) + chat_list.set_drag_row(self) + # Use rendered ChatListRow as drag icon alloc = self.get_allocation() surface = cairo.ImageSurface( ===================================== gajim/gtk/chat_list_stack.py ===================================== @@ -14,7 +14,6 @@ from __future__ import annotations -from typing import Dict from typing import Optional from typing import cast @@ -66,7 +65,7 @@ def __init__(self, self.set_vexpand(True) self.set_vhomogeneous(False) - self._chat_lists: Dict[str, ChatList] = {} + self._chat_lists: dict[str, ChatList] = {} self._last_visible_child_name: str = 'default' @@ -153,6 +152,7 @@ def _on_search_changed(self, search_entry: Gtk.SearchEntry) -> None: def add_chat_list(self, workspace_id: str) -> ChatList: chat_list = ChatList(workspace_id) chat_list.connect('row-selected', self._on_row_selected) + chat_list.connect('chat-order-changed', self._on_chat_order_changed) self._chat_lists[workspace_id] = chat_list self.add_named(chat_list, workspace_id) @@ -161,8 +161,10 @@ def add_chat_list(self, workspace_id: str) -> ChatList: def remove_chat_list(self, workspace_id: str) -> None: chat_list = self._chat_lists[workspace_id] self.remove(chat_list) - for account, jid, _type, _pinned in chat_list.get_open_chats(): - self.remove_chat(workspace_id, account, jid) + for open_chat in chat_list.get_open_chats(): + self.remove_chat(workspace_id, + open_chat['account'], + open_chat['jid']) self._chat_lists.pop(workspace_id) chat_list.destroy() @@ -177,6 +179,12 @@ def _on_row_selected(self, self.emit('chat-selected', row.workspace_id, row.account, row.jid) + def _on_chat_order_changed(self, + chat_list: ChatList + ) -> None: + + self.store_open_chats(chat_list.workspace_id) + def show_chat_list(self, workspace_id: str) -> None: cur_workspace_id = self.get_visible_child_name() if cur_workspace_id == workspace_id: @@ -187,12 +195,19 @@ def show_chat_list(self, workspace_id: str) -> None: self.set_visible_child_name(workspace_id) - def add_chat(self, workspace_id: str, account: str, jid: JID, type_: str, - pinned: bool = False) -> None: + def add_chat(self, + workspace_id: str, + account: str, + jid: JID, + type_: str, + pinned: bool, + position: int + ) -> None: + chat_list = self._chat_lists.get(workspace_id) if chat_list is None: chat_list = self.add_chat_list(workspace_id) - chat_list.add_chat(account, jid, type_, pinned) + chat_list.add_chat(account, jid, type_, pinned, position) def select_chat(self, account: str, jid: JID) -> None: chat_list = self.find_chat(account, jid) @@ -206,7 +221,7 @@ def store_open_chats(self, workspace_id: str) -> None: chat_list = self._chat_lists[workspace_id] open_chats = chat_list.get_open_chats() app.settings.set_workspace_setting( - workspace_id, 'open_chats', open_chats) + workspace_id, 'chats', open_chats) @structs.actionmethod def _toggle_chat_pinned(self, @@ -235,7 +250,8 @@ def _move_chat_to_workspace(self, current_chatlist.remove_chat(params.account, params.jid) new_chatlist = self.get_chatlist(workspace_id) - new_chatlist.add_chat(params.account, params.jid, type_) + new_chatlist.add_chat(params.account, params.jid, type_, False, -1) + self.store_open_chats(current_chatlist.workspace_id) self.store_open_chats(workspace_id) ===================================== gajim/gtk/chat_page.py ===================================== @@ -221,6 +221,7 @@ def add_chat_for_workspace(self, jid: JID, type_: str, pinned: bool = False, + position: int = -1, select: bool = False) -> None: client = app.get_client(account) @@ -240,7 +241,7 @@ def add_chat_for_workspace(self, return self._chat_list_stack.add_chat(workspace_id, account, jid, type_, - pinned) + pinned, position) if self._startup_finished: if select: @@ -249,18 +250,20 @@ def add_chat_for_workspace(self, def load_workspace_chats(self, workspace_id: str) -> None: open_chats = app.settings.get_workspace_setting(workspace_id, - 'open_chats') + 'chats') active_accounts = app.settings.get_active_accounts() - for account, jid, type_, pinned in open_chats: + for open_chat in open_chats: + account = open_chat['account'] if account not in active_accounts: continue self.add_chat_for_workspace(workspace_id, account, - jid, - type_, - pinned=pinned) + open_chat['jid'], + open_chat['type'], + pinned=open_chat['pinned'], + position=open_chat['position']) def is_chat_active(self, account: str, jid: JID) -> bool: return self._chat_list_stack.is_chat_active(account, jid) ===================================== gajim/gtk/control.py ===================================== @@ -779,15 +779,6 @@ def _on_user_status_show_changed(self, status=status) self.add_info_message(message) - def invite(self, invited_jid: JID) -> None: - # TODO: Remove, used by command system - self.client.get_module('MUC').invite( - self.contact.jid, invited_jid) - invited_contact = self.client.get_module('Contacts').get_contact( - invited_jid) - self.add_info_message( - _('%s has been invited to this group chat') % invited_contact.name) - def _on_room_voice_request(self, _contact: GroupchatContact, _signal_name: str, ===================================== gajim/gtk/main.py ===================================== @@ -653,6 +653,13 @@ def activate_workspace(self, workspace_id: str) -> None: self._main_stack.show_chats(workspace_id) self._workspace_side_bar.activate_workspace(workspace_id) + # Show chatlist if it is hidden + chat_list_stack = self._chat_page.get_chat_list_stack() + chat_list = chat_list_stack.get_current_chat_list() + if chat_list is not None: + if not chat_list.is_visible(): + self._toggle_chat_list() + def update_workspace(self, workspace_id: str) -> None: self._chat_page.update_workspace(workspace_id) self._workspace_side_bar.update_avatar(workspace_id) ===================================== test/no_gui/test_sanitize_filename.py ===================================== @@ -0,0 +1,61 @@ + +import sys +import unittest +from unittest.mock import patch +from gajim.common.helpers import sanitize_filename + + +class SanitizeTest(unittest.TestCase): + '''Tests for the sanitize_filename function.''' + + @patch.object(sys, 'platform', 'win32') + def test_invalid_chars(self): + '''Make sure invalid characters are removed in filenames''' + self.assertEqual(sanitize_filename('A/B/C'), 'ABC') + self.assertEqual(sanitize_filename('A*C.d'), 'AC.d') + self.assertEqual(sanitize_filename('A?C.d'), 'AC.d') + + @patch.object(sys, 'platform', 'win32') + def test_invalid_suffix(self): + '''Dots are not allowed at the end''' + self.assertEqual(sanitize_filename('def.'), 'def') + self.assertEqual(sanitize_filename('def.ghi'), 'def.ghi') + self.assertTrue(sanitize_filename('X' * 1000 + '.').endswith('X')) + + @patch.object(sys, 'platform', 'win32') + def test_reserved_words(self): + '''Make sure reserved Windows words are prefixed''' + self.assertEqual(sanitize_filename('NUL'), '__NUL') + self.assertEqual(sanitize_filename('..'), '__') + + @patch.object(sys, 'platform', 'win32') + def test_long_names(self): + '''Make sure long names are truncated''' + self.assertEqual(len(sanitize_filename('X' * 300)), 50) + self.assertEqual(len(sanitize_filename( + '.'.join(['X' * 100, 'X' * 100, 'X' * 100]))), 50) + self.assertEqual(len(sanitize_filename( + '.'.join(['X' * 300, 'X' * 300, 'X' * 300]))), 50) + self.assertEqual(len(sanitize_filename('.' * 300 + '.txt')), 50) + + @patch.object(sys, 'platform', 'win32') + def test_unicode_normalization(self): + '''Names should be NFKD normalized''' + self.assertEqual(sanitize_filename('ў'), chr(1091) + chr(774)) + + @patch.object(sys, 'platform', 'win32') + def test_extensions(self): + '''Filename extensions should be preserved when possible.''' + really_long_name = 'X' * 1000 + '.pdf' + self.assertTrue(sanitize_filename(really_long_name).endswith('.pdf')) + self.assertTrue(sanitize_filename('X' * 1000).endswith('X')) + self.assertTrue(sanitize_filename( + 'X' * 100 + '.' + 'X' * 100 + '.pdf').endswith('.pdf')) + self.assertTrue(sanitize_filename( + 'X' * 100 + '.' + 'X' * 400).endswith('X')) + self.assertTrue(sanitize_filename( + 'X' * 100 + '.' + 'X' * 400 + '.pdf').endswith('.pdf')) + + +if __name__ == '__main__': + unittest.main() View it on GitLab: https://dev.gajim.org/gajim/gajim/-/compare/2303790445a5d73c0a6867e4af936f5… -- View it on GitLab: https://dev.gajim.org/gajim/gajim/-/compare/2303790445a5d73c0a6867e4af936f5… You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/gajim][master] chore: Control: Remove obsolete code
by Daniel Brötzmann (＠wurstsalat) 27 Aug '22

27 Aug '22

Daniel Brötzmann pushed to branch master at gajim / gajim Commits: 5125e2c0 by wurstsalat at 2022-08-27T14:06:16+02:00 chore: Control: Remove obsolete code - - - - - 1 changed file: - gajim/gtk/control.py Changes: ===================================== gajim/gtk/control.py ===================================== @@ -779,15 +779,6 @@ def _on_user_status_show_changed(self, status=status) self.add_info_message(message) - def invite(self, invited_jid: JID) -> None: - # TODO: Remove, used by command system - self.client.get_module('MUC').invite( - self.contact.jid, invited_jid) - invited_contact = self.client.get_module('Contacts').get_contact( - invited_jid) - self.add_info_message( - _('%s has been invited to this group chat') % invited_contact.name) - def _on_room_voice_request(self, _contact: GroupchatContact, _signal_name: str, View it on GitLab: https://dev.gajim.org/gajim/gajim/-/commit/5125e2c0576dc78d8fbe9eed2a52d18b… -- View it on GitLab: https://dev.gajim.org/gajim/gajim/-/commit/5125e2c0576dc78d8fbe9eed2a52d18b… You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/gajim][archive_cache] Add more events
by Daniel Brötzmann (＠wurstsalat) 27 Aug '22

27 Aug '22

Daniel Brötzmann pushed to branch archive_cache at gajim / gajim Commits: 8af47b1b by wurstsalat at 2022-08-27T14:03:15+02:00 Add more events - - - - - 9 changed files: - gajim/common/events.py - gajim/common/modules/contacts.py - gajim/common/modules/muc.py - gajim/common/storage/events.py - gajim/gtk/chat_stack.py - gajim/gtk/control.py - gajim/gtk/conversation/view.py - gajim/gtk/groupchat_nick_completion.py - gajim/gtk/groupchat_roster.py Changes: ===================================== gajim/common/events.py ===================================== @@ -33,6 +33,7 @@ from nbxmpp.structs import RosterItem from nbxmpp.structs import TuneData from nbxmpp.const import InviteType +from nbxmpp.const import StatusCode from gajim.common.file_props import FileProp from gajim.common.const import JingleState @@ -685,3 +686,35 @@ class MUCNicknameChanged(ApplicationEvent): new_name: str old_name: str timestamp: float + + +@dataclass +class MUCRoomConfigChanged(ApplicationEvent): + name: str = field(init=False, default='room-config-changed') + timestamp: float + status_codes: set[StatusCode] + + +@dataclass +class MUCRoomConfigFinished(ApplicationEvent): + name: str = field(init=False, default='room-config-finished') + timestamp: float + + +@dataclass +class MUCUserJoined(ApplicationEvent): + name: str = field(init=False, default='muc-user-joined') + timestamp: float + is_self: bool + nick: str + status_codes: Optional[set[StatusCode]] + + +@dataclass +class MUCUserLeft(ApplicationEvent): + name: str = field(init=False, default='muc-user-left') + timestamp: float + nick: str + status_codes: Optional[set[StatusCode]] + reason: Optional[str] + actor: Optional[str] ===================================== gajim/common/modules/contacts.py ===================================== @@ -15,11 +15,14 @@ from __future__ import annotations from typing import Any +from typing import cast from typing import Iterator from typing import Optional from typing import Union from typing import overload +import time + import cairo from nbxmpp.const import Affiliation from nbxmpp.const import Chatstate @@ -29,9 +32,11 @@ from nbxmpp.structs import DiscoInfo from nbxmpp.structs import LocationData from nbxmpp.structs import TuneData +from nbxmpp.structs import MessageProperties from nbxmpp.structs import MucSubject from gajim.common import app +from gajim.common import events from gajim.common import types from gajim.common.const import PresenceShowExt from gajim.common.const import SimpleClientState @@ -933,12 +938,31 @@ def update_presence(self, if not self._presence.available and presence.available: self._presence = presence - self.notify('user-joined', *args) + + properties = cast(MessageProperties, args[0]) + event = events.MUCUserJoined( + timestamp=time.time(), + is_self=properties.is_muc_self_presence, + nick=self.name, + status_codes=properties.muc_status_codes) + + app.storage.events.store(self, event) + self.notify('user-joined', event) return if not presence.available: self._presence = presence - self.notify('user-left', *args) + + properties = cast(MessageProperties, args[0]) + event = events.MUCUserLeft( + timestamp=time.time(), + nick=self.name, + status_codes=properties.muc_status_codes, + reason=properties.muc_user.reason, + actor=properties.muc_user.actor) + + app.storage.events.store(self, event) + self.notify('user-left', event) return signals: list[str] = [] ===================================== gajim/common/modules/muc.py ===================================== @@ -44,11 +44,11 @@ from gi.repository import GLib from gajim.common import app +from gajim.common import events from gajim.common import helpers from gajim.common import types from gajim.common.const import ClientState, KindConstant from gajim.common.const import MUCJoinedState -from gajim.common.events import MUCNicknameChanged from gajim.common.events import MessageModerated from gajim.common.events import MucAdded from gajim.common.events import MucDecline @@ -457,7 +457,11 @@ def _on_disco_result_after_config(self, task: Task) -> None: self._log.info('Configuration finished: %s', jid) room = self._get_contact(jid.bare) - room.notify('room-config-finished') + event = events.MUCRoomConfigFinished(timestamp=time.time()) + + assert isinstance(room, GroupchatContact) + app.storage.events.store(room, event) + room.notify('room-config-finished', event) def update_presence(self) -> None: mucs = self._get_mucs_with_state([MUCJoinedState.JOINED, @@ -587,14 +591,15 @@ def _on_muc_user_presence(self, presence = self._process_user_presence(properties) occupant.update_presence(presence, properties) - event = MUCNicknameChanged(is_self=properties.is_self_presence, - new_name=new_occupant.name, - old_name=occupant.name, - timestamp=time.time()) + event = events.MUCNicknameChanged( + is_self=properties.is_self_presence, + new_name=new_occupant.name, + old_name=occupant.name, + timestamp=time.time()) app.storage.events.store(room, event) - room.notify('user-nickname-changed', event) + room.notify('user-nickname-changed', event, occupant, new_occupant) return is_joined = self._is_user_joined(properties.jid) @@ -894,12 +899,21 @@ def _on_config_change(self, if not properties.is_muc_config_change: return - room_jid = str(properties.muc_jid) self._log.info('Received config change: %s %s', - room_jid, properties.muc_status_codes) + properties.muc_jid, properties.muc_status_codes) - room = self._get_contact(room_jid) - room.notify('room-config-changed', properties) + assert properties.muc_status_codes is not None + event = events.MUCRoomConfigChanged( + timestamp=time.time(), + status_codes=properties.muc_status_codes) + + assert properties.muc_jid is not None + room = self._get_contact(properties.muc_jid) + + assert isinstance(room, GroupchatContact) + app.storage.events.store(room, event) + + room.notify('room-config-changed', event) raise nbxmpp.NodeProcessed ===================================== gajim/common/storage/events.py ===================================== @@ -24,8 +24,8 @@ from collections import namedtuple from nbxmpp.protocol import JID -from gajim.common.events import MUCNicknameChanged +from gajim.common import events from gajim.common.storage.base import SqliteStorage from gajim.common.types import ChatContactT @@ -43,6 +43,14 @@ PRAGMA user_version=1; ''' +EVENT_CLASSES: dict[str, Any] = { + 'muc-nickname-changed': events.MUCNicknameChanged, + 'room-config-changed': events.MUCRoomConfigChanged, + 'room-config-finished': events.MUCRoomConfigFinished, + 'muc-user-joined': events.MUCUserJoined, + 'muc-user-left': events.MUCUserLeft, +} + log = logging.getLogger('gajim.c.storage.events') @@ -113,4 +121,5 @@ def load(self, for row in self._con.execute(insert_sql, (contact.account, contact.jid, timestamp)).fetchall(): - yield MUCNicknameChanged(**row.data, timestamp=row.timestamp) + event_class = EVENT_CLASSES[row.event] + yield event_class(**row.data, timestamp=row.timestamp) ===================================== gajim/gtk/chat_stack.py ===================================== @@ -297,8 +297,9 @@ def _on_user_joined(self, contact: GroupchatContact, _signal_name: str, _user_contact: GroupchatParticipant, - _properties: PresenceProperties + _event: events.MUCUserJoined ) -> None: + self._update_group_chat_actions(contact) def _on_user_role_changed(self, ===================================== gajim/gtk/control.py ===================================== @@ -628,6 +628,10 @@ def _fetch_n_lines_history(self, # self._scrolled_view.set_history_complete(before, False) for row in app.storage.events.load(self._contact, before, timestamp): + if isinstance(row, (events.MUCUserJoined, events.MUCUserLeft)): + self._process_join_left_event(row) + continue + self._process_event(row) self._scrolled_view.block_signals(False) @@ -716,16 +720,17 @@ def add_message(self, def _on_user_nickname_changed(self, contact: types.GroupchatContact, _signal_name: str, - # old_contact: types.GroupchatParticipant, - # new_contact: types.GroupchatParticipant, - # properties: PresenceProperties + _old_contact: types.GroupchatParticipant, + _new_contact: types.GroupchatParticipant, event: events.MUCNicknameChanged ) -> None: self._process_event(event) - def _process_event(self, event) -> None: - if event == 'muc-nickname-changed': + def _process_event(self, event: Any) -> None: + message = None + + if isinstance(event, events.MUCNicknameChanged): if event.is_self: message = _('You are now known as %s') % event.new_name else: @@ -733,7 +738,129 @@ def _process_event(self, event) -> None: 'as {new_nick}').format(nick=event.old_name, new_nick=event.new_name) - self.add_info_message(message, event.timestamp) + if isinstance(event, events.MUCRoomConfigChanged): + # http://www.xmpp.org/extensions/xep-0045.html#roomconfig-notify + status_codes = event.status_codes + changes: list[str] = [] + if StatusCode.SHOWING_UNAVAILABLE in status_codes: + changes.append(_('Group chat now shows unavailable members')) + + if StatusCode.NOT_SHOWING_UNAVAILABLE in status_codes: + changes.append(_('Group chat now does not show ' + 'unavailable members')) + + if StatusCode.CONFIG_NON_PRIVACY_RELATED in status_codes: + changes.append(_('A setting not related to privacy has been ' + 'changed')) + self.client.get_module('Discovery').disco_muc(self.contact.jid) + + if StatusCode.CONFIG_ROOM_LOGGING in status_codes: + # Can be a presence + # (see chg_contact_status in groupchat_control.py) + changes.append(_('Conversations are stored on the server')) + + if StatusCode.CONFIG_NO_ROOM_LOGGING in status_codes: + changes.append(_('Conversations are not stored on the server')) + + if StatusCode.CONFIG_NON_ANONYMOUS in status_codes: + changes.append(_('Group chat is now non-anonymous')) + + if StatusCode.CONFIG_SEMI_ANONYMOUS in status_codes: + changes.append(_('Group chat is now semi-anonymous')) + + if StatusCode.CONFIG_FULL_ANONYMOUS in status_codes: + changes.append(_('Group chat is now fully anonymous')) + + for message in changes: + self.add_info_message(message, event.timestamp) + return + + if isinstance(event, events.MUCRoomConfigFinished): + message = _('A new group chat has been created') + + if message is not None: + self.add_info_message(message, event.timestamp) + + def _process_join_left_event(self, + event: Any + ) -> None: + + message = None + + if isinstance(event, events.MUCUserJoined): + assert isinstance(self.contact, GroupchatContact) + + if not event.is_self: + if self.contact.is_joined: + self.conversation_view.add_muc_user_joined(event.nick) + return + + status_codes = event.status_codes or [] + + if not self.contact.is_joined: + # We just joined the room + message = _('You (%s) joined the group chat') % event.nick + + if StatusCode.NON_ANONYMOUS in status_codes: + message = _('Any participant is allowed to see your full ' + 'XMPP Address') + + if StatusCode.CONFIG_ROOM_LOGGING in status_codes: + message = _('Conversations are stored on the server') + + if StatusCode.NICKNAME_MODIFIED in status_codes: + message = _('The server has assigned or modified your ' + 'nickname in this group chat') + + if isinstance(event, events.MUCUserLeft): + status_codes = event.status_codes or [] + nick = event.nick + + reason = event.reason + reason = '' if reason is None else f': {reason}' + + actor = event.actor + # Group Chat: You have been kicked by Alice + actor = '' if actor is None else _(' by {actor}').format( + actor=actor) + + # Group Chat: We have been removed from the room + message = _('{nick} has been removed from the group ' + 'chat{by}{reason}') + + if StatusCode.REMOVED_ERROR in status_codes: + # Handle 333 before 307, some MUCs add both + self.conversation_view.add_muc_user_left( + nick, event.reason, error=True) + + elif StatusCode.REMOVED_KICKED in status_codes: + # Group Chat: User was kicked by Alice: reason + message = _('{nick} has been ' + 'kicked{actor}{reason}').format(nick=nick, + actor=actor, + reason=reason) + + elif StatusCode.REMOVED_BANNED in status_codes: + # Group Chat: User was banned by Alice: reason + message = _('{nick} has been ' + 'banned{actor}{reason}').format(nick=nick, + actor=actor, + reason=reason) + + elif StatusCode.REMOVED_AFFILIATION_CHANGE in status_codes: + reason = _(': Affiliation changed') + message = message.format(nick=nick, by=actor, reason=reason) + + elif StatusCode.REMOVED_NONMEMBER_IN_MEMBERS_ONLY in status_codes: + reason = _(': Group chat configuration changed to members-only') + message = message.format(nick=nick, by=actor, reason=reason) + + else: + self.conversation_view.add_muc_user_left(nick, event.reason) + return + + if message is not None: + self.add_info_message(message, event.timestamp) def _on_muc_user_status_show_changed(self, contact: GroupchatContact, @@ -857,84 +984,29 @@ def _on_room_subject(self, def _on_room_config_changed(self, _contact: GroupchatContact, _signal_name: str, - properties: MessageProperties + event: events.MUCRoomConfigChanged ) -> None: - # http://www.xmpp.org/extensions/xep-0045.html#roomconfig-notify - - status_codes = properties.muc_status_codes - assert status_codes is not None - - changes: list[str] = [] - if StatusCode.SHOWING_UNAVAILABLE in status_codes: - changes.append(_('Group chat now shows unavailable members')) - - if StatusCode.NOT_SHOWING_UNAVAILABLE in status_codes: - changes.append(_('Group chat now does not show ' - 'unavailable members')) - - if StatusCode.CONFIG_NON_PRIVACY_RELATED in status_codes: - changes.append(_('A setting not related to privacy has been ' - 'changed')) - self.client.get_module('Discovery').disco_muc(self.contact.jid) - - if StatusCode.CONFIG_ROOM_LOGGING in status_codes: - # Can be a presence (see chg_contact_status in groupchat_control.py) - changes.append(_('Conversations are stored on the server')) - - if StatusCode.CONFIG_NO_ROOM_LOGGING in status_codes: - changes.append(_('Conversations are not stored on the server')) - - if StatusCode.CONFIG_NON_ANONYMOUS in status_codes: - changes.append(_('Group chat is now non-anonymous')) - - if StatusCode.CONFIG_SEMI_ANONYMOUS in status_codes: - changes.append(_('Group chat is now semi-anonymous')) - if StatusCode.CONFIG_FULL_ANONYMOUS in status_codes: - changes.append(_('Group chat is now fully anonymous')) - - for change in changes: - self.add_info_message(change) + self._process_event(event) def rejoin(self) -> None: self.client.get_module('MUC').join(self.contact.jid) def _on_user_joined(self, - contact: GroupchatContact, + _contact: GroupchatContact, _signal_name: str, - user_contact: GroupchatParticipant, - properties: PresenceProperties + _user_contact: GroupchatParticipant, + event: events.MUCUserJoined ) -> None: - nick = user_contact.name - if not properties.is_muc_self_presence: - if contact.is_joined: - self.conversation_view.add_muc_user_joined(nick) - return - - status_codes = properties.muc_status_codes or [] - - if not contact.is_joined: - # We just joined the room - self.add_info_message(_('You (%s) joined the group chat') % nick) - - if StatusCode.NON_ANONYMOUS in status_codes: - self.add_info_message( - _('Any participant is allowed to see your full XMPP Address')) - - if StatusCode.CONFIG_ROOM_LOGGING in status_codes: - self.add_info_message(_('Conversations are stored on the server')) - - if StatusCode.NICKNAME_MODIFIED in status_codes: - self.add_info_message( - _('The server has assigned or modified your nickname in this ' - 'group chat')) + self._process_join_left_event(event) def _on_room_config_finished(self, _contact: GroupchatContact, - _signal_name: str + _signal_name: str, + event: events.MUCRoomConfigFinished ) -> None: - self.add_info_message(_('A new group chat has been created')) + self._process_event(event) def _on_user_affiliation_changed(self, _contact: GroupchatContact, @@ -1060,57 +1132,11 @@ def _on_room_kicked(self, def _on_user_left(self, _contact: GroupchatContact, _signal_name: str, - user_contact: GroupchatParticipant, - properties: MessageProperties + _user_contact: GroupchatParticipant, + event: events.MUCUserLeft ) -> None: - status_codes = properties.muc_status_codes or [] - nick = user_contact.name - - assert properties.muc_user is not None - reason = properties.muc_user.reason - reason = '' if reason is None else f': {reason}' - - actor = properties.muc_user.actor - # Group Chat: You have been kicked by Alice - actor = '' if actor is None else _(' by {actor}').format(actor=actor) - - # Group Chat: We have been removed from the room - message = _('{nick} has been removed from the group chat{by}{reason}') - if StatusCode.REMOVED_ERROR in status_codes: - # Handle 333 before 307, some MUCs add both - self.conversation_view.add_muc_user_left( - nick, properties.muc_user.reason, error=True) - - elif StatusCode.REMOVED_KICKED in status_codes: - # Group Chat: User was kicked by Alice: reason - message = _('{nick} has been ' - 'kicked{actor}{reason}').format(nick=nick, - actor=actor, - reason=reason) - self.add_info_message(message) - - elif StatusCode.REMOVED_BANNED in status_codes: - # Group Chat: User was banned by Alice: reason - message = _('{nick} has been ' - 'banned{actor}{reason}').format(nick=nick, - actor=actor, - reason=reason) - self.add_info_message(message) - - elif StatusCode.REMOVED_AFFILIATION_CHANGE in status_codes: - reason = _(': Affiliation changed') - message = message.format(nick=nick, by=actor, reason=reason) - self.add_info_message(message) - - elif StatusCode.REMOVED_NONMEMBER_IN_MEMBERS_ONLY in status_codes: - reason = _(': Group chat configuration changed to members-only') - message = message.format(nick=nick, by=actor, reason=reason) - self.add_info_message(message) - - else: - self.conversation_view.add_muc_user_left( - nick, properties.muc_user.reason) + self._process_join_left_event(event) def _on_room_presence_error(self, _contact: GroupchatContact, ===================================== gajim/gtk/conversation/view.py ===================================== @@ -176,7 +176,7 @@ def add_muc_subject(self, def add_muc_user_left(self, nick: str, - reason: str, + reason: Optional[str], error: bool = False) -> None: assert isinstance(self._contact, GroupchatContact) if not self._contact.settings.get('print_join_left'): ===================================== gajim/gtk/groupchat_nick_completion.py ===================================== @@ -18,7 +18,6 @@ import logging -from nbxmpp.structs import PresenceProperties from gi.repository import Gtk from gi.repository import Gdk @@ -27,6 +26,7 @@ from gajim.common import ged from gajim.common import types from gajim.common.events import GcMessageReceived +from gajim.common.events import MUCNicknameChanged from gajim.common.ged import EventHelper from gajim.common.helpers import jid_is_blocked from gajim.common.helpers import message_needs_highlight @@ -70,18 +70,18 @@ def switch_contact(self, contact: types.GroupchatContactT) -> None: self._account = contact.account self._contact = contact - # self._contact.connect( - # 'user-nickname-changed', self._on_user_nickname_changed) + self._contact.connect( + 'user-nickname-changed', self._on_user_nickname_changed) def _on_user_nickname_changed(self, _contact: types.GroupchatContact, _signal_name: str, + event: MUCNicknameChanged, old_contact: types.GroupchatParticipant, - new_contact: types.GroupchatParticipant, - properties: PresenceProperties + new_contact: types.GroupchatParticipant ) -> None: - if properties.is_muc_self_presence: + if event.is_self: return old_name = old_contact.name ===================================== gajim/gtk/groupchat_roster.py ===================================== @@ -25,7 +25,6 @@ from gi.repository import Gtk from gi.repository import GLib from nbxmpp.const import Affiliation -from nbxmpp.structs import PresenceProperties from gajim.common import app from gajim.common import ged @@ -36,6 +35,7 @@ from gajim.common.const import AvatarSize from gajim.common.const import StyleAttr from gajim.common.events import ApplicationEvent +from gajim.common.events import MUCNicknameChanged from gajim.common.modules.contacts import GroupchatContact from .menus import get_groupchat_roster_menu @@ -283,9 +283,9 @@ def _update_contact(self, def _on_user_nickname_changed(self, contact: types.GroupchatContact, _signal_name: str, + _event: MUCNicknameChanged, old_contact: types.GroupchatParticipant, - new_contact: types.GroupchatParticipant, - properties: PresenceProperties + new_contact: types.GroupchatParticipant ) -> None: self._remove_contact(old_contact) @@ -500,7 +500,7 @@ def _load_roster(self) -> None: 'user-avatar-update': self._on_user_avatar_update, 'user-joined': self._on_user_joined, 'user-left': self._on_user_left, - # 'user-nickname-changed': self._on_user_nickname_changed, + 'user-nickname-changed': self._on_user_nickname_changed, 'user-role-changed': self._update_contact, 'user-status-show-changed': self._on_user_status_show_changed, }) View it on GitLab: https://dev.gajim.org/gajim/gajim/-/commit/8af47b1b53332370dba67902d88575c2… -- View it on GitLab: https://dev.gajim.org/gajim/gajim/-/commit/8af47b1b53332370dba67902d88575c2… You're receiving this email because of your account on dev.gajim.org.

1 0

← Newer
1
2
3
4
5
6
7
...
21
Older →

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 August 2022