Commits June 2019

commits@gajim.org

1 participants
70 discussions

[Git][gajim/gajim][master] Adapt to nbxmpp changes
by Philipp Hörist 30 Jun '19

30 Jun '19

Philipp Hörist pushed to branch master at gajim / gajim Commits: 5ba5bc17 by Philipp Hörist at 2019-06-30T20:14:46Z Adapt to nbxmpp changes nbxmpp returns now in more places JID objects - - - - - 5 changed files: - gajim/common/modules/bookmarks.py - gajim/gtk/bookmarks.py - gajim/gtk/groupchat_config.py - gajim/gui_menu_builder.py - gajim/roster_window.py Changes: ===================================== gajim/common/modules/bookmarks.py ===================================== @@ -203,7 +203,7 @@ class Bookmarks(BaseModule): minimize = app.config.get_per('rooms', bookmark.jid, 'minimize_on_autojoin', True) app.interface.join_gc_room( - self._account, bookmark.jid, bookmark.nick, + self._account, str(bookmark.jid), bookmark.nick, bookmark.password, minimize=minimize) def add_bookmark(self, name, jid, autojoin, password, nick): ===================================== gajim/gtk/bookmarks.py ===================================== @@ -61,7 +61,7 @@ class ManageBookmarksWindow: for bookmark in bookmarks: self.treestore.append(iter_, [account, bookmark.name, - bookmark.jid, + str(bookmark.jid), bookmark.autojoin, bookmark.password, bookmark.nick, ===================================== gajim/gtk/groupchat_config.py ===================================== @@ -368,7 +368,7 @@ class GroupchatConfig(Gtk.ApplicationWindow): if affiliation == 'outcast': reason = attrs.get('reason') self._ui.outcast_store.append( - [jid, + [str(jid), reason, None, affiliation, @@ -381,7 +381,7 @@ class GroupchatConfig(Gtk.ApplicationWindow): nick = attrs.get('nick') role = attrs.get('role') self._ui.affiliation_store.append( - [jid, + [str(jid), nick, role, affiliation, ===================================== gajim/gui_menu_builder.py ===================================== @@ -182,10 +182,10 @@ show_bookmarked=False, force_resource=False): item = Gtk.SeparatorMenuItem.new() # separator invite_to_submenu.append(item) for (room_jid, account) in rooms2: - menuitem = Gtk.MenuItem.new_with_label(room_jid.split('@')[0]) + menuitem = Gtk.MenuItem.new_with_label(room_jid.getNode()) if len(contact_list) > 1: # several resources menuitem.set_submenu(build_resources_submenu( - contact_list, account, roster.on_invite_to_room, room_jid, + contact_list, account, roster.on_invite_to_room, str(room_jid), account)) else: # use resource if it's self contact @@ -194,7 +194,7 @@ show_bookmarked=False, force_resource=False): else: resource = None menuitem.connect('activate', roster.on_invite_to_room, list_, - room_jid, account, resource) + str(room_jid), account, resource) invite_to_submenu.append(menuitem) def get_contact_menu(contact, account, use_multiple_contacts=True, @@ -719,7 +719,7 @@ def get_bookmarks_menu(account, rebuild=False): # Create Variant Dict dict_ = {'account': GLib.Variant('s', account), - 'jid': GLib.Variant('s', bookmark.jid)} + 'jid': GLib.Variant('s', str(bookmark.jid))} if bookmark.nick: dict_['nick'] = GLib.Variant('s', bookmark.nick) if bookmark.password: ===================================== gajim/roster_window.py ===================================== @@ -2687,7 +2687,7 @@ class RosterWindow: def on_bookmark_menuitem_activate(self, widget, account, bookmark): app.interface.join_gc_room( - account, bookmark.jid, bookmark.nick, bookmark.password) + account, str(bookmark.jid), bookmark.nick, bookmark.password) def on_info(self, widget, contact, account): """ View it on GitLab: https://dev.gajim.org/gajim/gajim/commit/5ba5bc179bf9bbb25c10addedc6be12e36… -- View it on GitLab: https://dev.gajim.org/gajim/gajim/commit/5ba5bc179bf9bbb25c10addedc6be12e36… You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/python-nbxmpp][master] 2 commits: Refactor validating JIDs
by Philipp Hörist 30 Jun '19

30 Jun '19

Philipp Hörist pushed to branch master at gajim / python-nbxmpp Commits: c7597a9e by Philipp Hörist at 2019-06-30T19:55:09Z Refactor validating JIDs - Validate while parsing into JID - Add dedicated methods for the different JID parts - Follow RTC7622 exactly - Add unit tests - - - - - 3946f35b by Philipp Hörist at 2019-06-30T20:09:11Z Remove old JID validation code - - - - - 7 changed files: - nbxmpp/modules/annotations.py - nbxmpp/modules/bookmarks.py - nbxmpp/modules/dataforms.py - nbxmpp/modules/muc.py - nbxmpp/protocol.py - nbxmpp/util.py - + test/unit/test_jid_parsing.py Changes: ===================================== nbxmpp/modules/annotations.py ===================================== @@ -22,10 +22,10 @@ from nbxmpp.protocol import NS_ROSTERNOTES from nbxmpp.protocol import Iq from nbxmpp.protocol import Node from nbxmpp.protocol import isResultNode +from nbxmpp.protocol import JID from nbxmpp.structs import AnnotationNote from nbxmpp.structs import CommonResult from nbxmpp.modules.date_and_time import parse_datetime -from nbxmpp.util import validate_jid from nbxmpp.util import call_on_response from nbxmpp.util import callback from nbxmpp.util import raise_error @@ -66,10 +66,10 @@ class Annotations: notes = [] for note in nodes: try: - jid = validate_jid(note.getAttr('jid')) - except Exception: - log.warning('Invalid JID: %s, ignoring it', - note.getAttr('jid')) + jid = JID(note.getAttr('jid')) + except Exception as error: + log.warning('Invalid JID: %s, %s', + note.getAttr('jid'), error) continue cdate = note.getAttr('cdate') ===================================== nbxmpp/modules/bookmarks.py ===================================== @@ -23,12 +23,12 @@ from nbxmpp.protocol import NS_PRIVATE from nbxmpp.protocol import isResultNode from nbxmpp.protocol import Node from nbxmpp.protocol import Iq +from nbxmpp.protocol import JID from nbxmpp.structs import StanzaHandler from nbxmpp.structs import BookmarkData from nbxmpp.const import BookmarkStoreType from nbxmpp.util import from_xs_boolean from nbxmpp.util import to_xs_boolean -from nbxmpp.util import validate_jid from nbxmpp.util import call_on_response from nbxmpp.util import callback from nbxmpp.util import raise_error @@ -87,10 +87,10 @@ class Bookmarks: autojoin = False try: - jid = validate_jid(conf.getAttr('jid')) - except Exception: - log.warning('Invalid JID: %s, ignoring it', - conf.getAttr('jid')) + jid = JID(conf.getAttr('jid')) + except Exception as error: + log.warning('Invalid JID: %s, %s', + conf.getAttr('jid'), error) continue bookmark = BookmarkData( ===================================== nbxmpp/modules/dataforms.py ===================================== @@ -21,8 +21,8 @@ from nbxmpp.protocol import NS_DATA from nbxmpp.protocol import NS_DATA_MEDIA +from nbxmpp.protocol import JID from nbxmpp.simplexml import Node -from nbxmpp.util import validate_jid # exceptions used in this module @@ -426,7 +426,7 @@ class JidSingleField(ListSingleField): def is_valid(self): if self.value: try: - validate_jid(self.value) + JID(self.value) return True, '' except Exception as error: return False, error @@ -481,7 +481,7 @@ class JidMultiField(ListMultiField): if self.values: for value in self.values: try: - validate_jid(value) + JID(value) except Exception as error: return False, error return True, '' ===================================== nbxmpp/modules/muc.py ===================================== @@ -32,7 +32,6 @@ from nbxmpp.protocol import Message from nbxmpp.protocol import DataForm from nbxmpp.protocol import DataField from nbxmpp.protocol import isResultNode -from nbxmpp.protocol import InvalidJid from nbxmpp.simplexml import Node from nbxmpp.structs import StanzaHandler from nbxmpp.const import InviteType @@ -48,7 +47,6 @@ from nbxmpp.structs import CommonResult from nbxmpp.structs import MucConfigResult from nbxmpp.structs import MucUserData from nbxmpp.structs import MucDestroyed -from nbxmpp.util import validate_jid from nbxmpp.util import call_on_response from nbxmpp.util import callback from nbxmpp.util import raise_error @@ -112,9 +110,9 @@ class MUC: alternate = destroy.getAttr('jid') if alternate is not None: try: - alternate = JID(validate_jid(alternate)) - except InvalidJid: - log.warning('Invalid alternate JID provided') + alternate = JID(alternate) + except Exception as error: + log.warning('Invalid alternate JID provided: %s', error) log.warning(stanza) alternate = None properties.muc_destroyed = MucDestroyed( @@ -312,9 +310,10 @@ class MUC: users_dict = {} for item in items: try: - jid = validate_jid(item.getAttr('jid')) - except InvalidJid as error: - log.exception(error) + jid = JID(item.getAttr('jid')) + except Exception as error: + log.warning('Invalid JID: %s, %s', + item.getAttr('jid'), error) continue users_dict[jid] = {} ===================================== nbxmpp/protocol.py ===================================== @@ -20,9 +20,13 @@ sub- stanzas) handling routines import time import hashlib +import socket from base64 import b64encode -from .simplexml import Node, NodeBuilder +from precis_i18n import get_profile +from nbxmpp.stringprepare import nameprep +from nbxmpp.simplexml import Node +from nbxmpp.simplexml import NodeBuilder def ascii_upper(s): return s.upper() @@ -503,6 +507,8 @@ _status_conditions = { 'removed-shutdown': 332, } +_localpart_disallowed_chars = set('"&\'/:<>@') + STREAM_NOT_AUTHORIZED = 'urn:ietf:params:xml:ns:xmpp-streams not-authorized' STREAM_REMOTE_CONNECTION_FAILED = 'urn:ietf:params:xml:ns:xmpp-streams remote-connection-failed' @@ -661,6 +667,30 @@ class InvalidStanza(Exception): class InvalidJid(Exception): pass +class LocalpartByteLimit(InvalidJid): + def __init__(self): + InvalidJid.__init__(self, 'Localpart must be between 1 and 1023 bytes') + +class LocalpartNotAllowedChar(InvalidJid): + def __init__(self): + InvalidJid.__init__(self, 'Not allowed character in localpart') + +class ResourcepartByteLimit(InvalidJid): + def __init__(self): + InvalidJid.__init__(self, 'Resourcepart must be between 1 and 1023 bytes') + +class ResourcepartNotAllowedChar(InvalidJid): + def __init__(self): + InvalidJid.__init__(self, 'Not allowed character in resourcepart') + +class DomainpartByteLimit(InvalidJid): + def __init__(self): + InvalidJid.__init__(self, 'Domainpart must be between 1 and 1023 bytes') + +class DomainpartNotAllowedChar(InvalidJid): + def __init__(self): + InvalidJid.__init__(self, 'Not allowed character in domainpart') + class StanzaMalformed(Exception): pass @@ -693,6 +723,84 @@ stream_exceptions = {'bad-format': BadFormat, 'xml-not-well-formed': XMLNotWellFormed} +def parse_jid(jid): + # https://tools.ietf.org/html/rfc7622#section-3.2 + + # Remove any portion from the first '/' character to the end of the + # string (if there is a '/' character present). + + # Remove any portion from the beginning of the string to the first + # '@' character (if there is an '@' character present). + + if jid.find('/') != -1: + rest, resourcepart = jid.split('/', 1) + resourcepart = validate_resourcepart(resourcepart) + else: + rest, resourcepart = jid, '' + + if rest.find('@') != -1: + localpart, domainpart = rest.split('@', 1) + localpart = validate_localpart(localpart) + else: + localpart, domainpart = '', rest + + domainpart = validate_domainpart(domainpart) + return localpart, domainpart, resourcepart + + +def validate_localpart(localpart): + if not localpart or len(localpart.encode()) > 1023: + raise LocalpartByteLimit + + if _localpart_disallowed_chars & set(localpart): + raise LocalpartNotAllowedChar + + try: + username = get_profile('UsernameCaseMapped') + return username.enforce(localpart) + except Exception: + raise LocalpartNotAllowedChar + + +def validate_resourcepart(resourcepart): + if not resourcepart or len(resourcepart.encode()) > 1023: + raise ResourcepartByteLimit + + try: + opaque = get_profile('OpaqueString') + return opaque.enforce(resourcepart) + except Exception: + raise ResourcepartNotAllowedChar + + +def validate_domainpart(domainpart): + # Check if this is a IPV4 address + try: + socket.inet_aton(domainpart) + return domainpart + except Exception: + pass + + # Check if this is a IPV6 address + if domainpart.startswith('[') and domainpart.endswith(']'): + try: + socket.inet_pton(socket.AF_INET6, domainpart.strip('[]')) + return domainpart + except Exception: + pass + + if not domainpart or len(domainpart.encode()) > 1023: + raise DomainpartByteLimit + + if domainpart.endswith('.'): # RFC7622, 3.2 + domainpart = domainpart[:-1] + + try: + return nameprep.prepare(domainpart) + except Exception: + raise DomainpartNotAllowedChar + + class JID: """ JID can be built from string, modified, compared, serialised into string @@ -714,14 +822,7 @@ class JID: elif domain: self.node, self.domain, self.resource = node, domain, resource else: - if jid.find('@') + 1: - self.node, jid = jid.split('@', 1) - else: - self.node = '' - if jid.find('/')+1: - self.domain, self.resource = jid.split('/', 1) - else: - self.domain, self.resource = jid, '' + self.node, self.domain, self.resource = parse_jid(jid) def getNode(self): """ ===================================== nbxmpp/util.py ===================================== @@ -71,77 +71,6 @@ def get_properties_struct(name): return Properties() -def validate_jid(jid_string): - jid = JID(jid_string) - return prep(jid.getNode() or None, - jid.getDomain() or None, - jid.getResource() or None) - - -def prep(user, server, resource): - """ - Perform stringprep on all JID fragments and return the full jid - """ - - ip_address = False - - try: - socket.inet_aton(server) - ip_address = True - except socket.error: - pass - - if not ip_address and hasattr(socket, 'inet_pton'): - try: - socket.inet_pton(socket.AF_INET6, server.strip('[]')) - server = '[%s]' % server.strip('[]') - ip_address = True - except (socket.error, ValueError): - pass - - if not ip_address: - if server is not None: - if server.endswith('.'): # RFC7622, 3.2 - server = server[:-1] - if not server or len(server.encode('utf-8')) > 1023: - raise InvalidJid('Server must be between 1 and 1023 bytes') - try: - server = nameprep.prepare(server) - except UnicodeError: - raise InvalidJid('Invalid character in hostname') - else: - raise InvalidJid('Server address required') - - if user is not None: - if not user or len(user.encode('utf-8')) > 1023: - raise InvalidJid('Username must be between 1 and 1023 bytes') - try: - user = user.encode('UsernameCaseMapped').decode('utf-8') - except UnicodeError: - raise InvalidJid('Invalid character in username') - else: - user = None - - if resource is not None: - if not resource or len(resource.encode('utf-8')) > 1023: - raise InvalidJid('Resource must be between 1 and 1023 bytes') - try: - resource = resource.encode('OpaqueString').decode('utf-8') - except UnicodeError: - raise InvalidJid('Invalid character in resource') - else: - resource = None - - if user: - if resource: - return '%s@%s/%s' % (user, server, resource) - return '%s@%s' % (user, server) - - if resource: - return '%s/%s' % (server, resource) - return server - - def call_on_response(cb): def response_decorator(func): @wraps(func) ===================================== test/unit/test_jid_parsing.py ===================================== @@ -0,0 +1,60 @@ +import unittest + +from nbxmpp.protocol import LocalpartByteLimit +from nbxmpp.protocol import LocalpartNotAllowedChar +from nbxmpp.protocol import ResourcepartByteLimit +from nbxmpp.protocol import ResourcepartNotAllowedChar +from nbxmpp.protocol import DomainpartByteLimit +from nbxmpp.protocol import DomainpartNotAllowedChar +from nbxmpp.protocol import JID + +class JIDParsing(unittest.TestCase): + + def test_valid_jids(self): + tests = [ + 'juliet(a)example.com', + 'juliet(a)example.com/foo', + 'juliet(a)example.com/foo bar', + 'juliet@example.com/foo@bar', + 'foo\\20bar(a)example.com', + 'fussball(a)example.com', + 'fu\U000000DFball(a)example.com', + '\U000003C0(a)example.com', + '\U000003A3(a)example.com/foo', + '\U000003C3(a)example.com/foo', + '\U000003C2(a)example.com/foo', + 'king(a)example.com/\U0000265A', + 'example.com', + 'example.com/foobar', + 'a.example.com/b@example.net', + ] + + for jid in tests: + JID(jid) + + def test_invalid_jids(self): + tests = [ + ('"juliet"@example.com', LocalpartNotAllowedChar), + ('foo bar(a)example.com', LocalpartNotAllowedChar), + ('henry\U00002163(a)example.com', LocalpartNotAllowedChar), + ('@example.com', LocalpartByteLimit), + ('user(a)example.com/', ResourcepartByteLimit), + ('user(a)example.com/\U00000001', ResourcepartNotAllowedChar), + ('\U0000265A(a)example.com', LocalpartNotAllowedChar), + ('user@host@example.com', DomainpartNotAllowedChar), + ('juliet@', DomainpartByteLimit), + ('/foobar', DomainpartByteLimit), + ] + + for jid, exception in tests: + with self.assertRaises(exception): + JID(jid) + + def test_ip_literals(self): + tests = [ + ('juliet@[2002:4559:1FE2::4559:1FE2]/res'), + ('juliet(a)123.123.123.123/res'), + ] + + for jid in tests: + JID(jid) View it on GitLab: https://dev.gajim.org/gajim/python-nbxmpp/compare/54d8fea2057e5b301ef4ed167… -- View it on GitLab: https://dev.gajim.org/gajim/python-nbxmpp/compare/54d8fea2057e5b301ef4ed167… You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/gajim][master] HTTPUpload: Use units depending on size and speed
by Philipp Hörist 30 Jun '19

30 Jun '19

Philipp Hörist pushed to branch master at gajim / gajim Commits: 3f0ebda2 by Daniel Brötzmann at 2019-06-30T14:50:18Z HTTPUpload: Use units depending on size and speed - - - - - 2 changed files: - gajim/data/gui/httpupload_progress_dialog.ui - gajim/gtk/http_upload_progress.py Changes: ===================================== gajim/data/gui/httpupload_progress_dialog.ui ===================================== @@ -43,6 +43,8 @@ <property name="visible">True</property> <property name="can_focus">False</property> <property name="label"><file name></property> + <property name="ellipsize">end</property> + <property name="max_width_chars">40</property> </object> <packing> <property name="expand">False</property> @@ -172,7 +174,7 @@ <property name="can_focus">True</property> <property name="receives_default">True</property> <property name="halign">center</property> - <property name="margin_top">6</property> + <property name="margin_top">12</property> <property name="use_underline">True</property> <signal name="clicked" handler="_on_cancel_upload_button_clicked" swapped="no"/> <style> ===================================== gajim/gtk/http_upload_progress.py ===================================== @@ -36,11 +36,17 @@ class HTTPUploadProgressWindow(Gtk.ApplicationWindow): self.event = file.event self.file = file - self._ui = get_builder('httpupload_progress_dialog.ui') + + if app.config.get('use_kib_mib'): + self.units = GLib.FormatSizeFlags.IEC_UNITS + else: + self.units = GLib.FormatSizeFlags.DEFAULT file_name = os.path.basename(file.path) - self._ui.file_name_label.set_text(file_name) + self._start_time = time.time() + self._ui = get_builder('httpupload_progress_dialog.ui') + self._ui.file_name_label.set_text(file_name) self.add(self._ui.box) self.pulse = GLib.timeout_add(100, self._pulse_progressbar) @@ -48,6 +54,7 @@ class HTTPUploadProgressWindow(Gtk.ApplicationWindow): self.connect('destroy', self._on_destroy) self._ui.connect_signals(self) + app.ged.register_event_handler('httpupload-progress', ged.CORE, self._on_httpupload_progress) @@ -87,23 +94,27 @@ class HTTPUploadProgressWindow(Gtk.ApplicationWindow): GLib.source_remove(self.pulse) self.pulse = None - size_total = round(total / (1024 * 1024), 1) - size_progress = round(seen / (1024 * 1024), 1) - time_now = time.time() - mbytes_sec = round(size_progress / (time_now - self._start_time), 1) - eta = self._format_eta( - round((size_total - size_progress) / mbytes_sec)) + bytes_sec = round(seen / (time_now - self._start_time), 1) - self._ui.progressbar.set_fraction(float(seen) / total) + size_progress = GLib.format_size_full(seen, self.units) + size_total = GLib.format_size_full(total, self.units) + speed = '%s/s' % GLib.format_size_full(bytes_sec, self.units) + + if bytes_sec == 0: + eta = '∞' + else: + eta = self._format_eta( + round((total - seen) / bytes_sec)) self._ui.progress_label.set_text( - _('%(progress)s of %(total)s MiB') % { - 'progress': str(size_progress), - 'total': str(size_total)}) + _('%(progress)s of %(total)s') % { + 'progress': size_progress, + 'total': size_total}) - self._ui.speed_label.set_text(_('%s MiB/s') % str(mbytes_sec)) - self._ui.eta_label.set_text(str(eta)) + self._ui.speed_label.set_text(speed) + self._ui.eta_label.set_text(eta) + self._ui.progressbar.set_fraction(float(seen) / total) def _format_eta(self, time_): times = {'minutes': 0, 'seconds': 0} @@ -111,6 +122,6 @@ class HTTPUploadProgressWindow(Gtk.ApplicationWindow): times['seconds'] = time_ % 60 if time_ >= 60: time_ /= 60 - times['minutes'] = time_ % 60 + times['minutes'] = round(time_ % 60) return _('%(minutes)s min %(seconds)s sec') % times View it on GitLab: https://dev.gajim.org/gajim/gajim/commit/3f0ebda2237e59e8bf32713e739105a641… -- View it on GitLab: https://dev.gajim.org/gajim/gajim/commit/3f0ebda2237e59e8bf32713e739105a641… You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/gajim][master] Fix caps cache tests
by Philipp Hörist 29 Jun '19

29 Jun '19

Philipp Hörist pushed to branch master at gajim / gajim Commits: d57b4b26 by Philipp Hörist at 2019-06-29T21:22:36Z Fix caps cache tests - - - - - 1 changed file: - test/no_gui/unit/test_caps_cache.py Changes: ===================================== test/no_gui/unit/test_caps_cache.py ===================================== @@ -6,7 +6,9 @@ from unittest.mock import MagicMock, Mock from nbxmpp import NS_MUC, NS_PING, NS_XHTML_IM from nbxmpp.structs import DiscoIdentity +from nbxmpp.structs import DiscoInfo from gajim.common import caps_cache as caps +from gajim.common.structs import CapsData class CommonCapsTest(unittest.TestCase): @@ -25,11 +27,13 @@ class CommonCapsTest(unittest.TestCase): self.features = [NS_MUC, NS_XHTML_IM] # Simulate a filled db - db_caps_cache = [ - (self.caps_method, self.caps_hash, self.identities, self.features), - ('old', self.node + '#' + self.caps_hash, self.identities, self.features)] + db_caps_cache = { + (self.caps_method, self.caps_hash): CapsData(self.identities, self.features, []), + ('old', self.node + '#' + self.caps_hash): CapsData(self.identities, self.features, []) + } + self.logger = Mock() - self.logger.iter_caps_data = Mock(return_value=db_caps_cache) + self.logger.load_caps_data = Mock(return_value=db_caps_cache) self.cc = caps.CapsCache(self.logger) caps.capscache = self.cc @@ -57,13 +61,14 @@ class TestCapsCache(CommonCapsTest): def test_set_and_store(self): ''' Test client_caps update gets logged into db ''' + disco_info = DiscoInfo(None, None, self.identities, self.features, []) + item = self.cc[self.client_caps] - item.set_and_store(self.identities, self.features) + item.set_and_store(disco_info) self.logger.add_caps_entry.assert_called_once_with(self.caps_method, self.caps_hash, - self.identities, - self.features) + disco_info) def test_initialize_from_db(self): ''' Read cashed dummy data from db ''' View it on GitLab: https://dev.gajim.org/gajim/gajim/commit/d57b4b260cfb65cef5a3b9f3c084f5586f… -- View it on GitLab: https://dev.gajim.org/gajim/gajim/commit/d57b4b260cfb65cef5a3b9f3c084f5586f… You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/gajim][master] Refactor entity caps storage
by Philipp Hörist 29 Jun '19

29 Jun '19

Philipp Hörist pushed to branch master at gajim / gajim Commits: 0c7f6072 by Philipp Hörist at 2019-06-29T21:14:20Z Refactor entity caps storage - Use json as storage format - Add JsonEncoder and Decoder for DiscoInfo objects - Add support for storing dataforms - - - - - 4 changed files: - gajim/common/caps_cache.py - gajim/common/logger.py - gajim/common/modules/caps.py - gajim/common/structs.py Changes: ===================================== gajim/common/caps_cache.py ===================================== @@ -261,12 +261,11 @@ class CapsCache: identities = property(_get_identities, _set_identities) - def set_and_store(self, identities, features): - self.identities = identities - self.features = features + def set_and_store(self, info): + self.identities = info.identities + self.features = info.features if self.hash_method != 'no': - self._logger.add_caps_entry(self.hash_method, self.hash, - identities, features) + self._logger.add_caps_entry(self.hash_method, self.hash, info) self.status = CACHED def update_last_seen(self): @@ -288,11 +287,11 @@ class CapsCache: def initialize_from_db(self): self._remove_outdated_caps() - for hash_method, hash_, identities, features in \ - self.logger.iter_caps_data(): - x = self[(hash_method, hash_)] - x.identities = identities - x.features = features + data = self.logger.load_caps_data() + for key, item in data.items(): + x = self[key] + x.identities = item.identities + x.features = item.features x.status = CACHED def _remove_outdated_caps(self): ===================================== gajim/common/logger.py ===================================== @@ -34,11 +34,12 @@ import json import logging import sqlite3 as sqlite from collections import namedtuple -from gzip import GzipFile -from io import BytesIO + from gi.repository import GLib -from nbxmpp.structs import DiscoIdentity +from nbxmpp.protocol import Node +from nbxmpp.structs import DiscoInfo +from nbxmpp.modules.dataforms import extend_form from gajim.common import exceptions from gajim.common import app @@ -48,6 +49,8 @@ from gajim.common.i18n import _ from gajim.common.const import ( JIDConstant, KindConstant, ShowConstant, TypeConstant, SubscriptionConstant) +from gajim.common.structs import CapsData +from gajim.common.structs import CapsIdentity LOGS_SQL_STATEMENT = ''' @@ -99,7 +102,7 @@ CACHE_SQL_STATEMENT = ''' CREATE TABLE caps_cache ( hash_method TEXT, hash TEXT, - data BLOB, + data TEXT, last_seen INTEGER); CREATE TABLE rooms_last_message_time( jid_id INTEGER PRIMARY KEY UNIQUE, @@ -120,12 +123,56 @@ CACHE_SQL_STATEMENT = ''' group_name TEXT, PRIMARY KEY (account_jid_id, jid_id, group_name) ); - PRAGMA user_version=1; + PRAGMA user_version=2; ''' log = logging.getLogger('gajim.c.logger') + +class CapsEncoder(json.JSONEncoder): + def encode(self, obj): + if isinstance(obj, DiscoInfo): + identities = [] + for identity in obj.identities: + identities.append( + {'category': identity.category, + 'type': identity.type, + 'name': identity.name, + 'lang': identity.lang}) + + dataforms = [] + for dataform in obj.dataforms: + # Filter out invalid forms according to XEP-0115 + form_type = dataform.vars.get('FORM_TYPE') + if form_type is None or form_type.type_ != 'hidden': + continue + dataforms.append(str(dataform)) + + obj = {'identities': identities, + 'features': obj.features, + 'dataforms': dataforms} + return json.JSONEncoder.encode(self, obj) + + +def caps_decoder(dict_): + if 'identities' not in dict_: + return dict_ + + identities = [] + for identity in dict_['identities']: + identities.append(CapsIdentity(**identity)) + + features = dict_['features'] + + dataforms = [] + for dataform in dict_['dataforms']: + dataforms.append(extend_form(node=Node(node=dataform))) + return CapsData(identities=identities, + features=features, + dataforms=dataforms) + + class Logger: def __init__(self): self._jid_ids = {} @@ -248,7 +295,12 @@ class Logger: self._execute_multiple(con, statements) if self._get_user_version(con) < 2: - pass + statements = [ + 'DROP TABLE IF EXISTS caps_cache', + 'CREATE TABLE caps_cache (hash_method TEXT, hash TEXT, data TEXT, last_seen INTEGER)', + 'PRAGMA user_version=2' + ] + self._execute_multiple(con, statements) @staticmethod def _execute_multiple(con, statements): @@ -983,108 +1035,45 @@ class Logger: result.type) return answer - # A longer note here: - # The database contains a blob field. Pysqlite seems to need special care for - # such fields. - # When storing, we need to convert string into buffer object (1). - # When retrieving, we need to convert it back to a string to decompress it. - # (2) - # GzipFile needs a file-like object, StringIO emulates file for plain strings - def iter_caps_data(self): - """ - Iterate over caps cache data stored in the database - - The iterator values are pairs of (node, ver, ext, identities, features): - identities == {'category':'foo', 'type':'bar', 'name':'boo'}, - features being a list of feature namespaces. - """ - # get data from table - # the data field contains binary object (gzipped data), this is a hack - # to get that data without trying to convert it to unicode - try: - rows = self._con.execute('SELECT hash_method, hash, data FROM caps_cache;') - except sqlite.OperationalError: - # might happen when there's no caps_cache table yet - # -- there's no data to read anyway then - return + def load_caps_data(self): + ''' + Load caps cache data + ''' + rows = self._con.execute( + 'SELECT hash_method, hash, data FROM caps_cache') - # list of corrupted entries that will be removed - to_be_removed = [] + cache = {} for row in rows: - # for each row: unpack the data field - # (format: (category, type, name, category, type, name, ... - # ..., 'FEAT', feature1, feature2, ...).join(' ')) - # NOTE: if there's a need to do more gzip, put that to a function try: - data = GzipFile(fileobj=BytesIO(row.data)).read().decode('utf-8').split('\0') - except IOError: - # This data is corrupted. It probably contains non-ascii chars - to_be_removed.append((row.hash_method, row.hash)) + data = json.loads(row.data, object_hook=caps_decoder) + except Exception: + log.exception('') continue - i = 0 - identities = list() - features = list() - while i < (len(data) - 3) and data[i] != 'FEAT': - category = data[i] - type_ = data[i + 1] - lang = data[i + 2] - name = data[i + 3] - identities.append(DiscoIdentity(category=category, - type=type_, - lang=lang, - name=name)) - i += 4 - i += 1 - while i < len(data): - features.append(data[i]) - i += 1 - - # yield the row - yield row.hash_method, row.hash, identities, features - for hash_method, hash_ in to_be_removed: - sql = '''DELETE FROM caps_cache WHERE hash_method = "%s" AND - hash = "%s"''' % (hash_method, hash_) - self.simple_commit(sql) + cache[(row.hash_method, row.hash)] = data + return cache - def add_caps_entry(self, hash_method, hash_, identities, features): - data = [] - for identity in identities: - # there is no FEAT category - if identity.category == 'FEAT': - return - data.extend((identity.category, - identity.type, - identity.lang or '', - identity.name or '')) - data.append('FEAT') - data.extend(features) - data = '\0'.join(data) - # if there's a need to do more gzip, put that to a function - string = BytesIO() - gzip = GzipFile(fileobj=string, mode='w') - gzip.write(data.encode('utf-8')) - gzip.close() - data = string.getvalue() + def add_caps_entry(self, hash_method, hash_, caps_data): + serialized = json.dumps(caps_data, cls=CapsEncoder) self._con.execute(''' - INSERT INTO caps_cache ( hash_method, hash, data, last_seen ) - VALUES (?, ?, ?, ?); - ''', (hash_method, hash_, memoryview(data), int(time.time()))) - # (1) -- note above + INSERT INTO caps_cache (hash_method, hash, data, last_seen) + VALUES (?, ?, ?, ?) + ''', (hash_method, hash_, serialized, int(time.time()))) self._timeout_commit() def update_caps_time(self, method, hash_): - sql = '''UPDATE caps_cache SET last_seen = %d - WHERE hash_method = "%s" and hash = "%s"''' % \ - (int(time.time()), method, hash_) - self.simple_commit(sql) + sql = '''UPDATE caps_cache SET last_seen = ? + WHERE hash_method = ? and hash = ?''' + self._con.execute(sql, (int(time.time()), method, hash_)) + self._timeout_commit() def clean_caps_table(self): """ Remove caps which was not seen for 3 months """ - sql = '''DELETE FROM caps_cache WHERE last_seen < %d''' % \ - int(time.time() - 3*30*24*3600) - self.simple_commit(sql) + timestamp = int(time.time()) - 3 * 30 * 24 * 3600 + self._con.execute('DELETE FROM caps_cache WHERE last_seen < ?', + (timestamp,)) + self._timeout_commit() def replace_roster(self, account_name, roster_version, roster): """ ===================================== gajim/common/modules/caps.py ===================================== @@ -126,12 +126,11 @@ class Caps(BaseModule): except Exception as error: self._log.warning('Disco info malformed: %s %s', contact.get_full_jid(), error) - self._log.warning(info) node = caps_hash = hash_method = None contact.client_caps = self._create_suitable_client_caps( node, caps_hash, hash_method) else: - cache_item.set_and_store(info.identities, info.features) + cache_item.set_and_store(info) app.nec.push_incoming_event( NetworkEvent('caps-update', ===================================== gajim/common/structs.py ===================================== @@ -19,6 +19,9 @@ from gajim.common.const import MUCJoinedState URI = namedtuple('URI', 'type action data') URI.__new__.__defaults__ = (None, None) # type: ignore +CapsData = namedtuple('CapsData', 'identities features dataforms') +CapsIdentity = namedtuple('CapsIdentity', 'category type name lang') + class MUCData: def __init__(self, room_jid, nick, password, rejoin): View it on GitLab: https://dev.gajim.org/gajim/gajim/commit/0c7f607223c5acb13474b990945026b72c… -- View it on GitLab: https://dev.gajim.org/gajim/gajim/commit/0c7f607223c5acb13474b990945026b72c… You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/gajim][master] Use nbxmpp's compute_caps_hash()
by Philipp Hörist 29 Jun '19

29 Jun '19

Philipp Hörist pushed to branch master at gajim / gajim Commits: a4c7b013 by Philipp Hörist at 2019-06-29T15:41:23Z Use nbxmpp's compute_caps_hash() - - - - - 4 changed files: - gajim/common/caps_cache.py - gajim/common/helpers.py - gajim/common/modules/caps.py - test/no_gui/unit/test_caps_cache.py Changes: ===================================== gajim/common/caps_cache.py ===================================== @@ -27,8 +27,6 @@ CapsCache caches features to hash relationships. The cache is queried through ClientCaps objects which are hold by contact instances. """ -import base64 -import hashlib import logging import nbxmpp @@ -102,55 +100,6 @@ def create_suitable_client_caps(node, caps_hash, hash_method, fjid=None): client_caps = ClientCaps(caps_hash, node, hash_method) return client_caps -def compute_caps_hash(identities, features, dataforms=None, hash_method='sha-1'): - """ - Compute caps hash according to XEP-0115, V1.5 - """ - if dataforms is None: - dataforms = [] - - def sort_identities_key(i): - return (i.category, i.type, i.lang or '') - - def sort_dataforms_key(dataform): - return dataform['FORM_TYPE'].value - - S = '' - identities.sort(key=sort_identities_key) - for i in identities: - c = i.category - type_ = i.type - lang = i.lang or '' - name = i.name or '' - S += '%s/%s/%s/%s<' % (c, type_, lang, name) - features.sort() - for f in features: - S += '%s<' % f - dataforms.sort(key=sort_dataforms_key) - for dataform in dataforms: - # fields indexed by var - fields = {} - for f in dataform.iter_fields(): - values = f.getTags('value') - fields[f.var] = [value.getData() for value in values] - form_type = fields.get('FORM_TYPE') - if form_type: - S += form_type[0] + '<' - del fields['FORM_TYPE'] - for var in sorted(fields.keys()): - S += '%s<' % var - values = sorted(fields[var]) - for value in values: - S += '%s<' % value - - if hash_method == 'sha-1': - hash_ = hashlib.sha1(S.encode('utf-8')) - elif hash_method == 'md5': - hash_ = hashlib.md5(S.encode('utf-8')) - else: - return '' - return base64.b64encode(hash_.digest()).decode('utf-8') - ################################################################################ ### Internal classes of this module @@ -184,15 +133,6 @@ class AbstractClientCaps: """ raise NotImplementedError - def get_hash_validation_strategy(self): - return self._is_hash_valid - - def _is_hash_valid(self, identities, features, dataforms): - """ - To be implemented by subclasses - """ - raise NotImplementedError - class ClientCaps(AbstractClientCaps): """ @@ -210,12 +150,6 @@ class ClientCaps(AbstractClientCaps): connection.get_module('Discovery').disco_contact( jid, '%s#%s' % (self._node, self._hash)) - def _is_hash_valid(self, identities, features, dataforms): - computed_hash = compute_caps_hash( - identities, features, dataforms=dataforms, - hash_method=self._hash_method) - return computed_hash == self._hash - class OldClientCaps(AbstractClientCaps): """ @@ -231,8 +165,6 @@ class OldClientCaps(AbstractClientCaps): def _discover(self, connection, jid): connection.get_module('Discovery').disco_contact(jid) - def _is_hash_valid(self, identities, features, dataforms): - return True class NoClientCaps(AbstractClientCaps): """ @@ -248,8 +180,6 @@ class NoClientCaps(AbstractClientCaps): def _discover(self, connection, jid): connection.get_module('Discovery').disco_contact(jid) - def _is_hash_valid(self, identities, features, dataforms): - return True class NullClientCaps(AbstractClientCaps): """ @@ -282,9 +212,6 @@ class NullClientCaps(AbstractClientCaps): def _discover(self, connection, jid): pass - def _is_hash_valid(self, identities, features, dataforms): - return False - class CapsCache: """ ===================================== gajim/common/helpers.py ===================================== @@ -56,7 +56,9 @@ from encodings.punycode import punycode_encode from functools import wraps import nbxmpp +from nbxmpp.util import compute_caps_hash from nbxmpp.stringprepare import nameprep +from nbxmpp.structs import DiscoInfo from gi.repository import GLib import precis_i18n.codec # pylint: disable=unused-import @@ -1117,9 +1119,10 @@ def update_optional_features(account=None): # Give plugins the possibility to add their features app.plugin_manager.extension_point('update_caps', account_) - app.caps_hash[account_] = caps_cache.compute_caps_hash( - [app.gajim_identity], - app.gajim_common_features + features) + app.caps_hash[account_] = compute_caps_hash(DiscoInfo( + None, None, [app.gajim_identity], + app.gajim_common_features + features, + []), compare=False) # re-send presence with new hash connected = app.connections[account_].connected if connected > 1 and app.SHOW_LIST[connected] != 'invisible': ===================================== gajim/common/modules/caps.py ===================================== @@ -20,6 +20,7 @@ import nbxmpp from nbxmpp.structs import StanzaHandler from nbxmpp.util import is_error_result +from nbxmpp.util import compute_caps_hash from gajim.common import caps_cache from gajim.common import app @@ -120,18 +121,18 @@ class Caps(BaseModule): # the identities and features return - validate = contact.client_caps.get_hash_validation_strategy() - hash_is_valid = validate(info.identities, info.features, info.dataforms) - - if hash_is_valid: - cache_item.set_and_store(info.identities, info.features) - else: + try: + compute_caps_hash(info) + except Exception as error: + self._log.warning('Disco info malformed: %s %s', + contact.get_full_jid(), error) + self._log.warning(info) node = caps_hash = hash_method = None contact.client_caps = self._create_suitable_client_caps( node, caps_hash, hash_method) - self._log.warning( - 'Computed and retrieved caps hash differ. Ignoring ' - 'caps of contact %s', contact.get_full_jid()) + else: + cache_item.set_and_store(info.identities, info.features) + app.nec.push_incoming_event( NetworkEvent('caps-update', conn=self._con, ===================================== test/no_gui/unit/test_caps_cache.py ===================================== @@ -2,134 +2,12 @@ Tests for capabilities and the capabilities cache ''' import unittest -import weakref - from unittest.mock import MagicMock, Mock -from nbxmpp import NS_MUC, NS_PING, NS_XHTML_IM, Iq + +from nbxmpp import NS_MUC, NS_PING, NS_XHTML_IM from nbxmpp.structs import DiscoIdentity -from nbxmpp.modules.discovery import Discovery from gajim.common import caps_cache as caps -EXAMPLES = [ -'''<iq type='result'> -<query xmlns='http://jabber.org/protocol/disco#info' node='http://psi-im.org#q07IKJEyjvHSyhy//CH0CxmKi8w='> -<identity xml:lang='en' category='client' name='Psi 0.11' type='pc'/> -<identity xml:lang='el' category='client' name='Ψ 0.11' type='pc'/> -<feature var='http://jabber.org/protocol/caps'/> -<feature var='http://jabber.org/protocol/disco#info'/> -<feature var='http://jabber.org/protocol/disco#items'/> -<feature var='http://jabber.org/protocol/muc'/> -<x xmlns='jabber:x:data' type='result'> -<field var='FORM_TYPE' type='hidden'> -<value>urn:xmpp:dataforms:softwareinfo</value> -</field> -<field var='ip_version'> -<value>ipv4</value> -<value>ipv6</value> -</field> -<field var='os'> -<value>Mac</value> -</field> -<field var='os_version'> -<value>10.5.1</value> -</field> -<field var='software'> -<value>Psi</value> -</field> -<field var='software_version'> -<value>0.11</value> -</field> -</x> -</query> -</iq> -''', - -'''<iq type='result'> -<query node="http://bombusmod.net.ru/caps#tbBQGBMv8g8U7kW55TEZZRnMCJ4=" xmlns="http://jabber.org/protocol/disco#info"> -<identity category="client" name="BombusMod" type="mobile"/> -<feature var="http://jabber.org/protocol/chatstates"/> -<feature var="http://jabber.org/protocol/disco#info"/> -<feature var="http://jabber.org/protocol/disco#items"/> -<feature var="http://jabber.org/protocol/rosterx"/> -<feature var="jabber:iq:last"/> -<feature var="jabber:iq:privacy"/> -<feature var="jabber:iq:roster"/> -<feature var="jabber:iq:time"/> -<feature var="jabber:iq:version"/> -<feature var="jabber:x:oob"/> -<feature var="urn:xmpp:ping"/> -<feature var="urn:xmpp:receipts"/> -<feature var="urn:xmpp:time"/> -</query> -</iq> -''', - -'''<iq type='result'> -<query node="http://jappix.org/#qRsaGbKTz8EwAOakYO00InkZUxM=" xmlns="http://jabber.org/protocol/disco#info"> - <identity category="client" name="Jappix" type="web"/> - <feature var="http://jabber.org/protocol/activity"/> - <feature var="http://jabber.org/protocol/activity+notify"/> - <feature var="http://jabber.org/protocol/caps"/> - <feature var="http://jabber.org/protocol/chatstates"/> - <feature var="http://jabber.org/protocol/commands"/> - <feature var="http://jabber.org/protocol/disco#info"/> - <feature var="http://jabber.org/protocol/disco#items"/> - <feature var="http://jabber.org/protocol/geoloc"/> - <feature var="http://jabber.org/protocol/geoloc+notify"/> - <feature var="http://jabber.org/protocol/http-auth"/> - <feature var="http://jabber.org/protocol/httpbind"/> - <feature var="http://jabber.org/protocol/mood"/> - <feature var="http://jabber.org/protocol/mood+notify"/> - <feature var="http://jabber.org/protocol/muc"/> - <feature var="http://jabber.org/protocol/muc#admin"/> - <feature var="http://jabber.org/protocol/muc#owner"/> - <feature var="http://jabber.org/protocol/muc#roomconfig"/> - <feature var="http://jabber.org/protocol/muc#user"/> - <feature var="http://jabber.org/protocol/nick"/> - <feature var="http://jabber.org/protocol/pubsub#retrieve-items"/> - <feature var="http://jabber.org/protocol/rosterx"/> - <feature var="http://jabber.org/protocol/tune"/> - <feature var="http://jabber.org/protocol/tune+notify"/> - <feature var="http://jabber.org/protocol/xhtml-im"/> - <feature var="ipv6"/> - <feature var="jabber:iq:last"/> - <feature var="jabber:iq:oob"/> - <feature var="jabber:iq:privacy"/> - <feature var="jabber:iq:private"/> - <feature var="jabber:iq:register"/> - <feature var="jabber:iq:roster"/> - <feature var="jabber:iq:search"/> - <feature var="jabber:iq:version"/> - <feature var="jabber:x:data"/> - <feature var="jabber:x:oob"/> - <feature var="urn:ietf:params:xml:ns:vcard-4.0"/> - <feature var="urn:ietf:rfc:3264"/> - <feature var="urn:xmpp:avatar:data"/> - <feature var="urn:xmpp:avatar:metadata"/> - <feature var="urn:xmpp:delay"/> - <feature var="urn:xmpp:extdisco:1"/> - <feature var="urn:xmpp:inbox"/> - <feature var="urn:xmpp:inbox+notify"/> - <feature var="urn:xmpp:jingle:1"/> - <feature var="urn:xmpp:jingle:apps:rtp:1"/> - <feature var="urn:xmpp:jingle:apps:rtp:audio"/> - <feature var="urn:xmpp:jingle:apps:rtp:rtcp-fb:0"/> - <feature var="urn:xmpp:jingle:apps:rtp:rtp-hdrext:0"/> - <feature var="urn:xmpp:jingle:apps:rtp:video"/> - <feature var="urn:xmpp:jingle:apps:rtp:zrtp:1"/> - <feature var="urn:xmpp:jingle:transports:ice-udp:1"/> - <feature var="urn:xmpp:mam:0"/> - <feature var="urn:xmpp:microblog:0"/> - <feature var="urn:xmpp:microblog:0+notify"/> - <feature var="urn:xmpp:ping"/> - <feature var="urn:xmpp:receipts"/> - <feature var="urn:xmpp:time"/> - <feature var="urn:xmpp:tmp:jingle:apps:dtls:0"/> - <feature var="vcard-temp"/> -</query> -</iq>''', -] - class CommonCapsTest(unittest.TestCase): @@ -214,19 +92,6 @@ class TestCapsCache(CommonCapsTest): self.assertEqual(0, connection.get_module('Discovery').disco_contact.call_count) - def test_hash(self): - '''tests the hash computation''' - for example in EXAMPLES: - stanza = Iq(node=example) - disco_module = Discovery(None) - weak_callback = weakref.WeakMethod(self.disco_info_received) - disco_module._disco_info_received(None, stanza, callback=weak_callback) - - def disco_info_received(self, info): - computed_hash = caps.compute_caps_hash(info.identities, info.features, info.dataforms) - hash_ = info.node.split('#')[1] - self.assertEqual(hash_, computed_hash) - class TestClientCaps(CommonCapsTest): View it on GitLab: https://dev.gajim.org/gajim/gajim/commit/a4c7b0132f3671a765a8f707bf23840343… -- View it on GitLab: https://dev.gajim.org/gajim/gajim/commit/a4c7b0132f3671a765a8f707bf23840343… You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/python-nbxmpp][master] Add compare argument to compute_caps_hash()
by Philipp Hörist 29 Jun '19

29 Jun '19

Philipp Hörist pushed to branch master at gajim / python-nbxmpp Commits: 54d8fea2 by Philipp Hörist at 2019-06-29T15:37:42Z Add compare argument to compute_caps_hash() - - - - - 2 changed files: - nbxmpp/structs.py - nbxmpp/util.py Changes: ===================================== nbxmpp/structs.py ===================================== @@ -112,13 +112,26 @@ AdHocCommandNote = namedtuple('AdHocCommandNote', 'text type') IBBData = namedtuple('IBBData', 'block_size sid seq type data') IBBData.__new__.__defaults__ = (None, None, None, None, None) -DiscoInfo = namedtuple('DiscoInfo', 'jid node identities features dataforms') - DiscoItems = namedtuple('DiscoItems', 'jid node items') DiscoItem = namedtuple('DiscoItem', 'jid name node') DiscoItem.__new__.__defaults__ = (None, None) +class DiscoInfo(namedtuple('DiscoInfo', 'jid node identities features dataforms')): + + __slots__ = [] + + def __new__(cls, jid, node, identities, features, dataforms): + return super(DiscoInfo, cls).__new__(cls, jid, node, identities, + features, dataforms) + + def get_caps_hash(self): + try: + return self.node.split('#')[1] + except Exception: + return None + + class DiscoIdentity(namedtuple('DiscoIdentity', 'category type name lang')): __slots__ = [] ===================================== nbxmpp/util.py ===================================== @@ -257,12 +257,14 @@ def text_to_color(text, background_color): return rc, gc, bc -def compute_caps_hash(info): +def compute_caps_hash(info, compare=True): """ Compute caps hash according to XEP-0115, V1.5 https://xmpp.org/extensions/xep-0115.html#ver-proc :param: info DiscoInfo + :param: compare If True an exception is raised if the hash announced in + the node attr is not equal to what is calculated """ # Initialize an empty string S. string_ = '' @@ -367,4 +369,8 @@ def compute_caps_hash(info): string_ += '%s<' % value hash_ = hashlib.sha1(string_.encode()) - return b64encode(hash_.digest()) + b64hash = b64encode(hash_.digest()) + if compare and b64hash != info.get_caps_hash(): + raise DiscoInfoMalformed('Caps hashes differ: %s != %s' % ( + b64hash, info.get_caps_hash())) + return b64hash View it on GitLab: https://dev.gajim.org/gajim/python-nbxmpp/commit/54d8fea2057e5b301ef4ed167f… -- View it on GitLab: https://dev.gajim.org/gajim/python-nbxmpp/commit/54d8fea2057e5b301ef4ed167f… You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/python-nbxmpp][master] Add method and tests for entity caps hash computation
by Philipp Hörist 29 Jun '19

29 Jun '19

Philipp Hörist pushed to branch master at gajim / python-nbxmpp Commits: f57bd1ae by Philipp Hörist at 2019-06-29T08:59:48Z Add method and tests for entity caps hash computation - - - - - 5 changed files: - nbxmpp/modules/discovery.py - nbxmpp/protocol.py - nbxmpp/structs.py - nbxmpp/util.py - + test/unit/test_entity_caps.py Changes: ===================================== nbxmpp/modules/discovery.py ===================================== @@ -49,37 +49,7 @@ class Discovery: def _disco_info_received(self, stanza): if not isResultNode(stanza): return raise_error(log.info, stanza) - - idenities = [] - features = [] - dataforms = [] - - query = stanza.getQuery() - for node in query.getTags('identity'): - attrs = node.getAttrs() - try: - idenities.append( - DiscoIdentity(category=attrs['category'], - type=attrs['type'], - name=attrs.get('name'), - lang=attrs.get('xml:lang'))) - except Exception: - return raise_error(log.warning, stanza, 'stanza-malformed') - - for node in query.getTags('feature'): - try: - features.append(node.getAttr('var')) - except Exception: - return raise_error(log.warning, stanza, 'stanza-malformed') - - for node in query.getTags('x', namespace=NS_DATA): - dataforms.append(extend_form(node)) - - return DiscoInfo(jid=stanza.getFrom(), - node=query.getAttr('node'), - identities=idenities, - features=features, - dataforms=dataforms) + return parse_disco_info(stanza) @call_on_response('_disco_items_received') def disco_items(self, jid, node=None): @@ -90,24 +60,59 @@ class Discovery: def _disco_items_received(self, stanza): if not isResultNode(stanza): return raise_error(log.info, stanza) + return parse_disco_items(stanza) - items = [] - - query = stanza.getQuery() - for node in query.getTags('item'): - attrs = node.getAttrs() - try: - items.append( - DiscoItem(jid=attrs['jid'], - name=attrs.get('name'), - node=attrs.get('node'))) - except Exception: - return raise_error(log.warning, stanza, 'stanza-malformed') - return DiscoItems(jid=stanza.getFrom(), - node=query.getAttr('node'), - items=items) +def parse_disco_info(stanza): + idenities = [] + features = [] + dataforms = [] + query = stanza.getQuery() + for node in query.getTags('identity'): + attrs = node.getAttrs() + try: + idenities.append( + DiscoIdentity(category=attrs['category'], + type=attrs['type'], + name=attrs.get('name'), + lang=attrs.get('xml:lang'))) + except Exception: + return raise_error(log.warning, stanza, 'stanza-malformed') + + for node in query.getTags('feature'): + try: + features.append(node.getAttr('var')) + except Exception: + return raise_error(log.warning, stanza, 'stanza-malformed') + + for node in query.getTags('x', namespace=NS_DATA): + dataforms.append(extend_form(node)) + + return DiscoInfo(jid=stanza.getFrom(), + node=query.getAttr('node'), + identities=idenities, + features=features, + dataforms=dataforms) + + +def parse_disco_items(stanza): + items = [] + + query = stanza.getQuery() + for node in query.getTags('item'): + attrs = node.getAttrs() + try: + items.append( + DiscoItem(jid=attrs['jid'], + name=attrs.get('name'), + node=attrs.get('node'))) + except Exception: + return raise_error(log.warning, stanza, 'stanza-malformed') + + return DiscoItems(jid=stanza.getFrom(), + node=query.getAttr('node'), + items=items) def get_disco_request(namespace, jid, node=None): ===================================== nbxmpp/protocol.py ===================================== @@ -664,6 +664,9 @@ class InvalidJid(Exception): class StanzaMalformed(Exception): pass +class DiscoInfoMalformed(Exception): + pass + stream_exceptions = {'bad-format': BadFormat, 'bad-namespace-prefix': BadNamespacePrefix, 'conflict': Conflict, ===================================== nbxmpp/structs.py ===================================== @@ -113,14 +113,35 @@ IBBData = namedtuple('IBBData', 'block_size sid seq type data') IBBData.__new__.__defaults__ = (None, None, None, None, None) DiscoInfo = namedtuple('DiscoInfo', 'jid node identities features dataforms') -DiscoIdentity = namedtuple('DiscoIdentity', 'category type name lang') -DiscoIdentity.__new__.__defaults__ = (None, None) DiscoItems = namedtuple('DiscoItems', 'jid node items') DiscoItem = namedtuple('DiscoItem', 'jid name node') DiscoItem.__new__.__defaults__ = (None, None) +class DiscoIdentity(namedtuple('DiscoIdentity', 'category type name lang')): + + __slots__ = [] + + def __new__(cls, category, type, name=None, lang=None): + return super(DiscoIdentity, cls).__new__(cls, category, type, name, lang) + + def __eq__(self, other): + return str(self) == str(other) + + def __ne__(self, other): + return not self.__eq__(other) + + def __str__(self): + return '%s/%s/%s/%s' % (self.category, + self.type, + self.lang or '', + self.name or '') + + def __hash__(self): + return hash(str(self)) + + class AdHocCommand(namedtuple('AdHocCommand', 'jid node name sessionid status data actions notes')): __slots__ = [] ===================================== nbxmpp/util.py ===================================== @@ -27,6 +27,7 @@ import precis_i18n.codec from nbxmpp.protocol import JID from nbxmpp.protocol import InvalidJid +from nbxmpp.protocol import DiscoInfoMalformed from nbxmpp.stringprepare import nameprep from nbxmpp.structs import Properties from nbxmpp.structs import IqProperties @@ -254,3 +255,116 @@ def text_to_color(text, background_color): bc = 0.2 * bb_inv + 0.8 * blue return rc, gc, bc + + +def compute_caps_hash(info): + """ + Compute caps hash according to XEP-0115, V1.5 + https://xmpp.org/extensions/xep-0115.html#ver-proc + + :param: info DiscoInfo + """ + # Initialize an empty string S. + string_ = '' + + # Sort the service discovery identities by category and then by type and + # then by xml:lang (if it exists), formatted as + # CATEGORY '/' [TYPE] '/' [LANG] '/' [NAME]. Note that each slash is + # included even if the LANG or NAME is not included (in accordance with + # XEP-0030, the category and type MUST be included). + # For each identity, append the 'category/type/lang/name' to S, followed by + # the '<' character. + # Sort the supported service discovery features. + + def sort_identities_key(i): + return (i.category, i.type, i.lang or '') + + identities = sorted(info.identities, key=sort_identities_key) + for identity in identities: + string_ += '%s<' % str(identity) + + # If the response includes more than one service discovery identity with + # the same category/type/lang/name, consider the entire response + # to be ill-formed. + if len(set(identities)) != len(identities): + raise DiscoInfoMalformed('Non-unique identity found') + + # Sort the supported service discovery features. + # For each feature, append the feature to S, followed by the '<' character. + features = sorted(info.features) + for feature in features: + string_ += '%s<' % feature + + # If the response includes more than one service discovery feature with the + # same XML character data, consider the entire response to be ill-formed. + if len(set(features)) != len(features): + raise DiscoInfoMalformed('Non-unique feature found') + + # If the response includes more than one extended service discovery + # information form with the same FORM_TYPE or the FORM_TYPE field contains + # more than one <value/> element with different XML character data, + # consider the entire response to be ill-formed. + + # If the response includes an extended service discovery information form + # where the FORM_TYPE field is not of type "hidden" or the form does not + # include a FORM_TYPE field, ignore the form but continue processing. + + dataforms = [] + form_type_values = [] + for dataform in info.dataforms: + form_type = dataform.vars.get('FORM_TYPE') + if form_type is None: + # Ignore dataform because of missing FORM_TYPE + continue + if form_type.type_ != 'hidden': + # Ignore dataform because of wrong type + continue + + values = form_type.getTags('value') + if len(values) != 1: + raise DiscoInfoMalformed('Form should have exactly ' + 'one FORM_TYPE value') + value = values[0].getData() + + dataforms.append(dataform) + form_type_values.append(value) + + if len(set(form_type_values)) != len(form_type_values): + raise DiscoInfoMalformed('Non-unique FORM_TYPE value found') + + # If the service discovery information response includes XEP-0128 data + # forms, sort the forms by the FORM_TYPE (i.e., by the XML character data + # of the <value/> element). + + # For each extended service discovery information form: + # - Append the XML character data of the FORM_TYPE field's <value/> + # element, followed by the '<' character. + # - Sort the fields by the value of the "var" attribute. + # - For each field other than FORM_TYPE: + # - Append the value of the "var" attribute, followed by the + # '<' character. + # - Sort values by the XML character data of the <value/> element. + # - For each <value/> element, append the XML character data, + # followed by the '<' character. + + def sort_dataforms_key(dataform): + return dataform['FORM_TYPE'].getTagData('value') + + dataforms = sorted(dataforms, key=sort_dataforms_key) + for dataform in dataforms: + string_ += '%s<' % dataform['FORM_TYPE'].getTagData('value') + + fields = {} + for field in dataform.iter_fields(): + if field.var == 'FORM_TYPE': + continue + values = field.getTags('value') + fields[field.var] = sorted([value.getData() for value in values]) + + for var in sorted(fields.keys()): + string_ += '%s<' % var + for value in fields[var]: + string_ += '%s<' % value + + hash_ = hashlib.sha1(string_.encode()) + return b64encode(hash_.digest()) ===================================== test/unit/test_entity_caps.py ===================================== @@ -0,0 +1,197 @@ +import unittest + +from nbxmpp.util import compute_caps_hash +from nbxmpp.modules.discovery import parse_disco_info +from nbxmpp.protocol import Iq +from nbxmpp.protocol import DiscoInfoMalformed + +class EntityCaps(unittest.TestCase): + + def test_multiple_field_values(self): + node = """ + <iq from='benvolio(a)capulet.lit/230193' id='disco1' to='juliet(a)capulet.lit/chamber' type='result'> + <query xmlns='http://jabber.org/protocol/disco#info' node='http://psi-im.org#q07IKJEyjvHSyhy//CH0CxmKi8w='> + <identity xml:lang='en' category='client' name='Psi 0.11' type='pc'/> + <identity xml:lang='el' category='client' name='Ψ 0.11' type='pc'/> + <feature var='http://jabber.org/protocol/caps'/> + <feature var='http://jabber.org/protocol/disco#info'/> + <feature var='http://jabber.org/protocol/disco#items'/> + <feature var='http://jabber.org/protocol/muc'/> + <x xmlns='jabber:x:data' type='result'> + <field var='FORM_TYPE' type='hidden'> + <value>urn:xmpp:dataforms:softwareinfo</value> + </field> + <field var='ip_version'> + <value>ipv4</value> + <value>ipv6</value> + </field> + <field var='os'> + <value>Mac</value> + </field> + <field var='os_version'> + <value>10.5.1</value> + </field> + <field var='software'> + <value>Psi</value> + </field> + <field var='software_version'> + <value>0.11</value> + </field> + </x> + </query> + </iq>""" + + info = parse_disco_info(Iq(node=node)) + hash_ = compute_caps_hash(info) + self.assertEqual(hash_, 'q07IKJEyjvHSyhy//CH0CxmKi8w=') + + def test_ignore_invalid_forms(self): + node = """ + <iq from='benvolio(a)capulet.lit/230193' id='disco1' to='juliet(a)capulet.lit/chamber' type='result'> + <query xmlns='http://jabber.org/protocol/disco#info' node='http://psi-im.org#q07IKJEyjvHSyhy//CH0CxmKi8w='> + <identity xml:lang='en' category='client' name='Psi 0.11' type='pc'/> + <identity xml:lang='el' category='client' name='Ψ 0.11' type='pc'/> + <feature var='http://jabber.org/protocol/caps'/> + <feature var='http://jabber.org/protocol/disco#info'/> + <feature var='http://jabber.org/protocol/disco#items'/> + <feature var='http://jabber.org/protocol/muc'/> + <x xmlns='jabber:x:data' type='result'> + <field var='FORM_TYPE' type='hidden'> + <value>urn:xmpp:dataforms:softwareinfo</value> + </field> + <field var='ip_version'> + <value>ipv4</value> + <value>ipv6</value> + </field> + <field var='os'> + <value>Mac</value> + </field> + <field var='os_version'> + <value>10.5.1</value> + </field> + <field var='software'> + <value>Psi</value> + </field> + <field var='software_version'> + <value>0.11</value> + </field> + </x> + <x xmlns='jabber:x:data' type='result'> + <field var='FORM_TYPE'> + <value>urn:xmpp:dataforms:softwareinfo</value> + </field> + <field var='ip_version'> + <value>ipv4</value> + <value>ipv6</value> + </field> + </x> + <x xmlns='jabber:x:data' type='result'> + <field var='ip_version'> + <value>ipv4</value> + <value>ipv6</value> + </field> + </x> + </query> + </iq>""" + + info = parse_disco_info(Iq(node=node)) + hash_ = compute_caps_hash(info) + self.assertEqual(hash_, 'q07IKJEyjvHSyhy//CH0CxmKi8w=') + + def test_multiple_form_type_values(self): + node = """ + <iq from='benvolio(a)capulet.lit/230193' id='disco1' to='juliet(a)capulet.lit/chamber' type='result'> + <query xmlns='http://jabber.org/protocol/disco#info' node='http://psi-im.org#q07IKJEyjvHSyhy//CH0CxmKi8w='> + <identity xml:lang='en' category='client' name='Psi 0.11' type='pc'/> + <identity xml:lang='el' category='client' name='Ψ 0.11' type='pc'/> + <feature var='http://jabber.org/protocol/caps'/> + <feature var='http://jabber.org/protocol/disco#info'/> + <feature var='http://jabber.org/protocol/disco#items'/> + <feature var='http://jabber.org/protocol/muc'/> + <x xmlns='jabber:x:data' type='result'> + <field var='FORM_TYPE' type='hidden'> + <value>urn:xmpp:dataforms:softwareinfo</value> + <value>urn:xmpp:dataforms:softwareinfo_test</value> + </field> + <field var='ip_version'> + <value>ipv4</value> + <value>ipv6</value> + </field> + </x> + </query> + </iq>""" + + info = parse_disco_info(Iq(node=node)) + with self.assertRaises(DiscoInfoMalformed): + hash_ = compute_caps_hash(info) + + def test_non_unique_form_type_value(self): + node = """ + <iq from='benvolio(a)capulet.lit/230193' id='disco1' to='juliet(a)capulet.lit/chamber' type='result'> + <query xmlns='http://jabber.org/protocol/disco#info' node='http://psi-im.org#q07IKJEyjvHSyhy//CH0CxmKi8w='> + <identity xml:lang='en' category='client' name='Psi 0.11' type='pc'/> + <identity xml:lang='el' category='client' name='Ψ 0.11' type='pc'/> + <feature var='http://jabber.org/protocol/caps'/> + <feature var='http://jabber.org/protocol/disco#info'/> + <feature var='http://jabber.org/protocol/disco#items'/> + <feature var='http://jabber.org/protocol/muc'/> + <x xmlns='jabber:x:data' type='result'> + <field var='FORM_TYPE' type='hidden'> + <value>urn:xmpp:dataforms:softwareinfo</value> + </field> + <field var='ip_version'> + <value>ipv4</value> + <value>ipv6</value> + </field> + </x> + <x xmlns='jabber:x:data' type='result'> + <field var='FORM_TYPE' type='hidden'> + <value>urn:xmpp:dataforms:softwareinfo</value> + </field> + <field var='ip_version'> + <value>ipv4</value> + <value>ipv6</value> + </field> + </x> + </query> + </iq>""" + + info = parse_disco_info(Iq(node=node)) + with self.assertRaises(DiscoInfoMalformed): + hash_ = compute_caps_hash(info) + + def test_non_unique_feature(self): + node = """ + <iq from='benvolio(a)capulet.lit/230193' id='disco1' to='juliet(a)capulet.lit/chamber' type='result'> + <query xmlns='http://jabber.org/protocol/disco#info' node='http://psi-im.org#q07IKJEyjvHSyhy//CH0CxmKi8w='> + <identity xml:lang='en' category='client' name='Psi 0.11' type='pc'/> + <identity xml:lang='el' category='client' name='Ψ 0.11' type='pc'/> + <feature var='http://jabber.org/protocol/caps'/> + <feature var='http://jabber.org/protocol/muc'/> + <feature var='http://jabber.org/protocol/disco#info'/> + <feature var='http://jabber.org/protocol/disco#items'/> + <feature var='http://jabber.org/protocol/muc'/> + </query> + </iq>""" + + info = parse_disco_info(Iq(node=node)) + with self.assertRaises(DiscoInfoMalformed): + hash_ = compute_caps_hash(info) + + def test_non_unique_identity(self): + node = """ + <iq from='benvolio(a)capulet.lit/230193' id='disco1' to='juliet(a)capulet.lit/chamber' type='result'> + <query xmlns='http://jabber.org/protocol/disco#info' node='http://psi-im.org#q07IKJEyjvHSyhy//CH0CxmKi8w='> + <identity xml:lang='en' category='client' name='Psi 0.11' type='pc'/> + <identity xml:lang='en' category='client' name='Psi 0.11' type='pc'/> + <feature var='http://jabber.org/protocol/caps'/> + <feature var='http://jabber.org/protocol/muc'/> + <feature var='http://jabber.org/protocol/disco#info'/> + <feature var='http://jabber.org/protocol/disco#items'/> + <feature var='http://jabber.org/protocol/muc'/> + </query> + </iq>""" + + info = parse_disco_info(Iq(node=node)) + with self.assertRaises(DiscoInfoMalformed): + hash_ = compute_caps_hash(info) View it on GitLab: https://dev.gajim.org/gajim/python-nbxmpp/commit/f57bd1aef78ee7ddb37045efe7… -- View it on GitLab: https://dev.gajim.org/gajim/python-nbxmpp/commit/f57bd1aef78ee7ddb37045efe7… You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/gajim][master] Fix detection of httpupload max-file-size
by Philipp Hörist 28 Jun '19

28 Jun '19

Philipp Hörist pushed to branch master at gajim / gajim Commits: 1e1ced9a by Philipp Hörist at 2019-06-28T22:16:36Z Fix detection of httpupload max-file-size - - - - - 1 changed file: - gajim/common/modules/httpupload.py Changes: ===================================== gajim/common/modules/httpupload.py ===================================== @@ -83,12 +83,13 @@ class HTTPUpload(BaseModule): self._log.info('Discovered component: %s', info.jid) for form in info.dataforms: - form_dict = form.asDict() - if form_dict.get('FORM_TYPE') != self.httpupload_namespace: + form_type = form.vars.get('FORM_TYPE') + if (form_type is None or + form_type.value != self.httpupload_namespace): continue - size = form_dict.get('max-file-size') + size = form.vars.get('max-file-size') if size is not None: - self.max_file_size = int(size) + self.max_file_size = int(size.value) break if self.max_file_size is None: View it on GitLab: https://dev.gajim.org/gajim/gajim/commit/1e1ced9ae712705278d1a2954ece7fd738… -- View it on GitLab: https://dev.gajim.org/gajim/gajim/commit/1e1ced9ae712705278d1a2954ece7fd738… You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/gajim][master] 3 commits: Remove outdated comment
by Philipp Hörist 28 Jun '19

28 Jun '19

Philipp Hörist pushed to branch master at gajim / gajim Commits: 8ce0c62c by Philipp Hörist at 2019-06-28T21:38:13Z Remove outdated comment - - - - - 9caa3aad by Philipp Hörist at 2019-06-28T21:47:21Z Use nbxmpp's dataforms module - - - - - 20301d36 by Philipp Hörist at 2019-06-28T21:47:25Z Remove unused dataforms module This was a copy of nbxmpp's dataforms module - - - - - 12 changed files: - gajim/common/caps_cache.py - gajim/common/connection_handlers_events.py - gajim/common/modules/adhoc_commands.py - − gajim/common/modules/dataforms.py - gajim/common/modules/pubsub.py - gajim/dataforms_widget.py - gajim/gtk/account_wizard.py - gajim/gtk/adhoc.py - gajim/gtk/dataform.py - gajim/gtk/search.py - gajim/gtk/service_registration.py - test/gtk/dataform.py Changes: ===================================== gajim/common/caps_cache.py ===================================== @@ -105,9 +105,6 @@ def create_suitable_client_caps(node, caps_hash, hash_method, fjid=None): def compute_caps_hash(identities, features, dataforms=None, hash_method='sha-1'): """ Compute caps hash according to XEP-0115, V1.5 - - dataforms are nbxmpp.DataForms objects as common.dataforms don't allow several - values without a field type list-multi """ if dataforms is None: dataforms = [] ===================================== gajim/common/connection_handlers_events.py ===================================== @@ -21,6 +21,7 @@ import logging import OpenSSL.crypto import nbxmpp +from nbxmpp.modules import dataforms from gajim.common import nec from gajim.common import helpers @@ -28,7 +29,6 @@ from gajim.common import app from gajim.common import i18n from gajim.common.i18n import _ from gajim.common.helpers import AdditionalDataDict -from gajim.common.modules import dataforms from gajim.common.const import KindConstant, SSLError from gajim.common.jingle_transport import JingleTransportSocks5 from gajim.common.file_props import FilesProp ===================================== gajim/common/modules/adhoc_commands.py ===================================== @@ -21,12 +21,12 @@ import nbxmpp from nbxmpp.structs import StanzaHandler +from nbxmpp.modules import dataforms from gajim.common import app from gajim.common import helpers from gajim.common.i18n import _ from gajim.common.nec import NetworkIncomingEvent -from gajim.common.modules import dataforms from gajim.common.modules.base import BaseModule ===================================== gajim/common/modules/dataforms.py deleted ===================================== @@ -1,760 +0,0 @@ -# Copyright (C) 2006-2007 Tomasz Melcer <liori AT exroot.org> -# Copyright (C) 2006-2014 Yann Leboulanger <asterix AT lagaule.org> -# Copyright (C) 2007 Stephan Erb <steve-e AT h3c.de> -# -# 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-0004: Data Forms - -import nbxmpp - -from gajim.common import helpers - - -# exceptions used in this module -class Error(Exception): - pass - - -# when we get nbxmpp.Node which we do not understand -class UnknownDataForm(Error): - pass - - -# when we get nbxmpp.Node which contains bad fields -class WrongFieldValue(Error): - pass - - -# helper class to change class of already existing object -class ExtendedNode(nbxmpp.Node): - @classmethod - def __new__(cls, *args, **kwargs): - if 'extend' not in kwargs.keys() or not kwargs['extend']: - return object.__new__(cls) - - extend = kwargs['extend'] - assert issubclass(cls, extend.__class__) - extend.__class__ = cls - return extend - - -# helper to create fields from scratch -def create_field(typ, **attrs): - ''' Helper function to create a field of given type. ''' - field = { - 'boolean': BooleanField, - 'fixed': StringField, - 'hidden': StringField, - 'text-private': StringField, - 'text-single': StringField, - 'jid-multi': JidMultiField, - 'jid-single': JidSingleField, - 'list-multi': ListMultiField, - 'list-single': ListSingleField, - 'text-multi': TextMultiField, - }[typ](typ=typ, **attrs) - return field - - -def extend_field(node): - """ - Helper function to extend a node to field of appropriate type - """ - # when validation (XEP-122) will go in, we could have another classes - # like DateTimeField - so that dicts in create_field() and - # extend_field() will be different... - typ = node.getAttr('type') - field = { - 'boolean': BooleanField, - 'fixed': StringField, - 'hidden': StringField, - 'text-private': StringField, - 'text-single': StringField, - 'jid-multi': JidMultiField, - 'jid-single': JidSingleField, - 'list-multi': ListMultiField, - 'list-single': ListSingleField, - 'text-multi': TextMultiField, - } - if typ not in field: - typ = 'text-single' - return field[typ](extend=node) - - -def extend_form(node): - """ - Helper function to extend a node to form of appropriate type - """ - if node.getTag('reported') is not None: - return MultipleDataForm(extend=node) - return SimpleDataForm(extend=node) - - -class DataField(ExtendedNode): - """ - Keeps data about one field - var, field type, labels, instructions... Base - class for different kinds of fields. Use create_field() function to construct one - of these - """ - - def __init__(self, typ=None, var=None, value=None, label=None, desc=None, - required=False, options=None, extend=None): - - if extend is None: - ExtendedNode.__init__(self, 'field') - - self.type_ = typ - self.var = var - if value is not None: - self.value = value - if label is not None: - self.label = label - if desc is not None: - self.desc = desc - self.required = required - self.options = options - - @property - def type_(self): - """ - Type of field. Recognized values are: 'boolean', 'fixed', 'hidden', - 'jid-multi', 'jid-single', 'list-multi', 'list-single', 'text-multi', - 'text-private', 'text-single'. If you set this to something different, - DataField will store given name, but treat all data as text-single - """ - type_ = self.getAttr('type') - if type_ is None: - return 'text-single' - return type_ - - @type_.setter - def type_(self, value): - assert isinstance(value, str) - self.setAttr('type', value) - - @property - def var(self): - """ - Field identifier - """ - return self.getAttr('var') - - @var.setter - def var(self, value): - assert isinstance(value, str) - self.setAttr('var', value) - - @var.deleter - def var(self): - self.delAttr('var') - - @property - def label(self): - """ - Human-readable field name - """ - label_ = self.getAttr('label') - if not label_: - label_ = self.var - return label_ - - @label.setter - def label(self, value): - assert isinstance(value, str) - self.setAttr('label', value) - - @label.deleter - def label(self): - if self.getAttr('label'): - self.delAttr('label') - - @property - def description(self): - """ - Human-readable description of field meaning - """ - return self.getTagData('desc') or '' - - @description.setter - def description(self, value): - assert isinstance(value, str) - if value == '': - del self.description - else: - self.setTagData('desc', value) - - @description.deleter - def description(self): - desc = self.getTag('desc') - if desc is not None: - self.delChild(desc) - - @property - def required(self): - """ - Controls whether this field required to fill. Boolean - """ - return bool(self.getTag('required')) - - @required.setter - def required(self, value): - required = self.getTag('required') - if required and not value: - self.delChild(required) - elif not required and value: - self.addChild('required') - - @property - def media(self): - """ - Media data - """ - media = self.getTag('media', namespace=nbxmpp.NS_DATA_MEDIA) - if media: - return Media(media) - - @media.setter - def media(self, value): - del self.media - self.addChild(node=value) - - @media.deleter - def media(self): - media = self.getTag('media') - if media is not None: - self.delChild(media) - - @staticmethod - def is_valid(): - return True, '' - - -class Uri(nbxmpp.Node): - def __init__(self, uri_tag): - nbxmpp.Node.__init__(self, node=uri_tag) - - @property - def type_(self): - """ - uri type - """ - return self.getAttr('type') - - @type_.setter - def type_(self, value): - self.setAttr('type', value) - - @type_.deleter - def type_(self): - self.delAttr('type') - - @property - def uri_data(self): - """ - uri data - """ - return self.getData() - - @uri_data.setter - def uri_data(self, value): - self.setData(value) - - @uri_data.deleter - def uri_data(self): - self.setData(None) - - -class Media(nbxmpp.Node): - def __init__(self, media_tag): - nbxmpp.Node.__init__(self, node=media_tag) - - @property - def uris(self): - """ - URIs of the media element. - """ - return map(Uri, self.getTags('uri')) - - @uris.setter - def uris(self, value): - del self.uris - for uri in value: - self.addChild(node=uri) - - @uris.deleter - def uris(self): - for element in self.getTags('uri'): - self.delChild(element) - - -class BooleanField(DataField): - @property - def value(self): - """ - Value of field. May contain True, False or None - """ - value = self.getTagData('value') - if value in ('0', 'false'): - return False - if value in ('1', 'true'): - return True - if value is None: - return False # default value is False - raise WrongFieldValue - - @value.setter - def value(self, value): - self.setTagData('value', value and '1' or '0') - - @value.deleter - def value(self): - value = self.getTag('value') - if value is not None: - self.delChild(value) - - -class StringField(DataField): - """ - Covers fields of types: fixed, hidden, text-private, text-single - """ - - @property - def value(self): - """ - Value of field. May be any string - """ - return self.getTagData('value') or '' - - @value.setter - def value(self, value): - assert isinstance(value, str) - if value == '' and not self.required: - del self.value - return - self.setTagData('value', value) - - @value.deleter - def value(self): - try: - self.delChild(self.getTag('value')) - except ValueError: # if there already were no value tag - pass - - def is_valid(self): - if not self.required: - return True, '' - if not self.value: - return False, '' - return True, '' - - -class ListField(DataField): - """ - Covers fields of types: jid-multi, jid-single, list-multi, list-single - """ - - @property - def options(self): - """ - Options - """ - options = [] - for element in self.getTags('option'): - value = element.getTagData('value') - if value is None: - raise WrongFieldValue - label = element.getAttr('label') - if not label: - label = value - options.append((label, value)) - return options - - @options.setter - def options(self, values): - del self.options - for value, label in values: - self.addChild('option', - {'label': label}).setTagData('value', value) - - @options.deleter - def options(self): - for element in self.getTags('option'): - self.delChild(element) - - def iter_options(self): - for element in self.iterTags('option'): - value = element.getTagData('value') - if value is None: - raise WrongFieldValue - label = element.getAttr('label') - if not label: - label = value - yield (value, label) - - -class ListSingleField(ListField, StringField): - """ - Covers list-single field - """ - def is_valid(self): - if not self.required: - return True, '' - if not self.value: - return False, '' - return True, '' - - -class JidSingleField(ListSingleField): - """ - Covers jid-single fields - """ - def is_valid(self): - if self.value: - try: - helpers.parse_jid(self.value) - return True, '' - except Exception as error: - return False, error - if self.required: - return False, '' - return True, '' - - -class ListMultiField(ListField): - """ - Covers list-multi fields - """ - - @property - def values(self): - """ - Values held in field - """ - values = [] - for element in self.getTags('value'): - values.append(element.getData()) - return values - - @values.setter - def values(self, values): - del self.values - for value in values: - self.addChild('value').setData(value) - - @values.deleter - def values(self): - for element in self.getTags('value'): - self.delChild(element) - - def iter_values(self): - for element in self.getTags('value'): - yield element.getData() - - def is_valid(self): - if not self.required: - return True, '' - if not self.values: - return False, '' - return True, '' - - -class JidMultiField(ListMultiField): - """ - Covers jid-multi fields - """ - def is_valid(self): - if self.values: - for value in self.values: - try: - helpers.parse_jid(value) - except Exception as error: - return False, error - return True, '' - if self.required: - return False, '' - return True, '' - - -class TextMultiField(DataField): - @property - def value(self): - """ - Value held in field - """ - value = '' - for element in self.iterTags('value'): - value += '\n' + element.getData() - return value[1:] - - @value.setter - def value(self, value): - del self.value - if value == '': - return - for line in value.split('\n'): - self.addChild('value').setData(line) - - @value.deleter - def value(self): - for element in self.getTags('value'): - self.delChild(element) - - def is_valid(self): - if not self.required: - return True, '' - if not self.value: - return False, '' - return True, '' - - -class DataRecord(ExtendedNode): - """ - The container for data fields - an xml element which has DataField elements - as children - """ - def __init__(self, fields=None, associated=None, extend=None): - self.associated = associated - self.vars = {} - if extend is None: - # we have to build this object from scratch - nbxmpp.Node.__init__(self) - - if fields is not None: - self.fields = fields - else: - # we already have nbxmpp.Node inside - try to convert all - # fields into DataField objects - if fields is None: - for field in self.iterTags('field'): - if not isinstance(field, DataField): - extend_field(field) - self.vars[field.var] = field - else: - for field in self.getTags('field'): - self.delChild(field) - self.fields = fields - - @property - def fields(self): - """ - List of fields in this record - """ - return self.getTags('field') - - @fields.setter - def fields(self, fields): - del self.fields - for field in fields: - if not isinstance(field, DataField): - extend_field(field) - self.addChild(node=field) - - @fields.deleter - def fields(self): - for element in self.getTags('field'): - self.delChild(element) - - def iter_fields(self): - """ - Iterate over fields in this record. Do not take associated into account - """ - for field in self.iterTags('field'): - yield field - - def iter_with_associated(self): - """ - Iterate over associated, yielding both our field and associated one - together - """ - for field in self.associated.iter_fields(): - yield self[field.var], field - - def __getitem__(self, item): - return self.vars[item] - - def is_valid(self): - for field in self.iter_fields(): - if not field.is_valid()[0]: - return False - return True - - -class DataForm(ExtendedNode): - def __init__(self, type_=None, title=None, instructions=None, extend=None): - if extend is None: - # we have to build form from scratch - nbxmpp.Node.__init__(self, 'x', attrs={'xmlns': nbxmpp.NS_DATA}) - - if type_ is not None: - self.type_ = type_ - if title is not None: - self.title = title - if instructions is not None: - self.instructions = instructions - - @property - def type_(self): - """ - Type of the form. Must be one of: 'form', 'submit', 'cancel', 'result'. - 'form' - this form is to be filled in; you will be able soon to do: - filledform = DataForm(replyto=thisform) - """ - return self.getAttr('type') - - @type_.setter - def type_(self, type_): - assert type_ in ('form', 'submit', 'cancel', 'result') - self.setAttr('type', type_) - - @property - def title(self): - """ - Title of the form - - Human-readable, should not contain any \\r\\n. - """ - return self.getTagData('title') - - @title.setter - def title(self, title): - self.setTagData('title', title) - - @title.deleter - def title(self): - try: - self.delChild('title') - except ValueError: - pass - - @property - def instructions(self): - """ - Instructions for this form - - Human-readable, may contain \\r\\n. - """ - # TODO: the same code is in TextMultiField. join them - value = '' - for valuenode in self.getTags('instructions'): - value += '\n' + valuenode.getData() - return value[1:] - - @instructions.setter - def instructions(self, value): - del self.instructions - if value == '': - return - for line in value.split('\n'): - self.addChild('instructions').setData(line) - - @instructions.deleter - def instructions(self): - for value in self.getTags('instructions'): - self.delChild(value) - - @property - def is_reported(self): - return self.getTag('reported') is not None - - -class SimpleDataForm(DataForm, DataRecord): - def __init__(self, type_=None, title=None, instructions=None, fields=None, - extend=None): - DataForm.__init__(self, type_=type_, title=title, - instructions=instructions, extend=extend) - DataRecord.__init__(self, fields=fields, extend=self, associated=self) - - def get_purged(self): - simple_form = SimpleDataForm(extend=self) - del simple_form.title - simple_form.instructions = '' - to_be_removed = [] - for field in simple_form.iter_fields(): - if field.required: - # add <value> if there is not - if hasattr(field, 'value') and not field.value: - field.value = '' - # Keep all required fields - continue - if ((hasattr(field, 'value') and - not field.value and - field.value != 0) or - (hasattr(field, 'values') and not field.values)): - to_be_removed.append(field) - else: - del field.label - del field.description - del field.media - for field in to_be_removed: - simple_form.delChild(field) - return simple_form - - -class MultipleDataForm(DataForm): - def __init__(self, type_=None, title=None, instructions=None, items=None, - extend=None): - DataForm.__init__(self, type_=type_, title=title, - instructions=instructions, extend=extend) - # all records, recorded into DataRecords - if extend is None: - if items is not None: - self.items = items - else: - # we already have nbxmpp.Node inside - try to convert all - # fields into DataField objects - if items is None: - self.items = list(self.iterTags('item')) - else: - for item in self.getTags('item'): - self.delChild(item) - self.items = items - reported_tag = self.getTag('reported') - self.reported = DataRecord(extend=reported_tag) - - @property - def items(self): - """ - A list of all records - """ - return list(self.iter_records()) - - @items.setter - def items(self, records): - del self.items - for record in records: - if not isinstance(record, DataRecord): - DataRecord(extend=record) - self.addChild(node=record) - - @items.deleter - def items(self): - for record in self.getTags('item'): - self.delChild(record) - - def iter_records(self): - for record in self.getTags('item'): - yield record - -# -# @reported.setter -# def reported(self, record): -# try: -# self.delChild('reported') -# except Exception: -# pass -# -# record.setName('reported') -# self.addChild(node=record) ===================================== gajim/common/modules/pubsub.py ===================================== @@ -21,9 +21,9 @@ # XEP-0060: Publish-Subscribe import nbxmpp +from nbxmpp.modules import dataforms from gajim.common import app -from gajim.common.modules import dataforms from gajim.common.nec import NetworkIncomingEvent from gajim.common.modules.base import BaseModule ===================================== gajim/dataforms_widget.py ===================================== @@ -30,8 +30,9 @@ from gi.repository import GdkPixbuf from gi.repository import GObject from gi.repository import GLib +from nbxmpp.modules import dataforms + from gajim import gtkgui_helpers -from gajim.common.modules import dataforms from gajim.common import helpers from gajim.common import app from gajim.common.i18n import _ ===================================== gajim/gtk/account_wizard.py ===================================== @@ -18,13 +18,14 @@ from gi.repository import Gtk from gi.repository import Gdk from gi.repository import GLib +from nbxmpp.modules import dataforms + from gajim.common import app from gajim.common import ged from gajim.common import configpaths from gajim.common import helpers from gajim.common import connection from gajim.common.i18n import _ -from gajim.common.modules import dataforms from gajim import dataforms_widget from gajim import gui_menu_builder ===================================== gajim/gtk/adhoc.py ===================================== @@ -16,14 +16,14 @@ import logging from enum import IntEnum from gi.repository import Gtk + from nbxmpp.util import is_error_result from nbxmpp.const import AdHocAction +from nbxmpp.modules import dataforms from gajim.common import app from gajim.common.i18n import _ -from gajim.common.modules import dataforms - from gajim.gtk.dataform import DataFormWidget from gajim.gtk.util import ensure_not_destroyed from gajim.gtk.util import find_widget ===================================== gajim/gtk/dataform.py ===================================== @@ -17,12 +17,13 @@ from gi.repository import GLib from gi.repository import GObject from gi.repository import Pango +from nbxmpp.modules.dataforms import extend_form + from gajim.gtkgui_helpers import scale_pixbuf_from_data from gajim.common import app from gajim.common.i18n import _ from gajim.common.helpers import open_uri -from gajim.common.modules.dataforms import extend_form from gajim.gtk.util import MultiLineLabel from gajim.gtk.util import MaxWidthComboBoxText ===================================== gajim/gtk/search.py ===================================== @@ -20,12 +20,12 @@ from enum import IntEnum from gi.repository import Gtk +from nbxmpp.modules import dataforms + from gajim.common import app from gajim.common import ged from gajim.common.i18n import _ -from gajim.common.modules import dataforms - from gajim.gui_menu_builder import SearchMenu from gajim.gtk.dataform import DataFormWidget ===================================== gajim/gtk/service_registration.py ===================================== @@ -17,8 +17,9 @@ from enum import IntEnum from gi.repository import Gtk +from nbxmpp.modules import dataforms + from gajim.common import app -from gajim.common.modules import dataforms from gajim.common.i18n import _ from gajim.gtk.dataform import DataFormWidget ===================================== test/gtk/dataform.py ===================================== @@ -2,9 +2,9 @@ from base64 import b64decode from gi.repository import Gtk import nbxmpp +from nbxmpp.modules.dataforms import extend_form from gajim.gtk.dataform import DataFormWidget -from gajim.common.modules.dataforms import extend_form from gajim.common.const import CSSPriority from gajim.common import app View it on GitLab: https://dev.gajim.org/gajim/gajim/compare/9c53fcbd898bd0d61e5d16f8eac586fda… -- View it on GitLab: https://dev.gajim.org/gajim/gajim/compare/9c53fcbd898bd0d61e5d16f8eac586fda… You're receiving this email because of your account on dev.gajim.org.

1 0

2026

2025

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

2007

2006

Commits June 2019