Commits

commits@gajim.org

17632 discussions

[Git][gajim/python-nbxmpp][master] 10 commits: Add more parsing
by Philipp Hörist 27 Dec '18

27 Dec '18

Philipp Hörist pushed to branch master at gajim / python-nbxmpp Commits: 014d9160 by Philipp Hörist at 2018-12-27T21:17:15Z Add more parsing - Add BaseMessage handler - Add enums for message and presence types - Add enum for presence show - Add detection for muc subjects - - - - - 0e056146 by Philipp Hörist at 2018-12-27T21:17:15Z Add datetime (XEP-0082) module - - - - - 21b3ba1e by Philipp Hörist at 2018-12-27T21:17:15Z Parse MUC config change - - - - - 506d4d41 by Philipp Hörist at 2018-12-27T21:17:15Z groupchat subject - - - - - bb712047 by Philipp Hörist at 2018-12-27T21:17:15Z Add delay (XEP-0203) module - - - - - 122be999 by Philipp Hörist at 2018-12-27T21:17:16Z Add parsing for MUC invites - Move structs into own module - - - - - 123aaf9e by Philipp Hörist at 2018-12-27T21:17:16Z Correctly parse priority start and end of range are not included - - - - - ff758e34 by Philipp Hörist at 2018-12-27T21:17:16Z Add Dataforms (XEP-0004) module - - - - - c6dba1ac by Philipp Hörist at 2018-12-27T21:17:16Z Add Captcha (XEP-0158) module - Adds also a Bits of Binary (XEP-0231) module - - - - - f80bbaa6 by Philipp Hörist at 2018-12-27T21:32:35Z Add more MUC features - get affiliation - set role - set affiliation - set config - set subject - cancel config - request config - send captcha - decline - request voice - destroy - invite - - - - - 17 changed files: - nbxmpp/const.py - nbxmpp/dispatcher_nb.py - + nbxmpp/modules/bits_of_binary.py - + nbxmpp/modules/captcha.py - + nbxmpp/modules/dataforms.py - + nbxmpp/modules/date_and_time.py - + nbxmpp/modules/delay.py - nbxmpp/modules/eme.py - nbxmpp/modules/http_auth.py - + nbxmpp/modules/message.py - nbxmpp/misc.py → nbxmpp/modules/misc.py - nbxmpp/modules/muc.py - nbxmpp/modules/nickname.py - nbxmpp/modules/presence.py - nbxmpp/protocol.py - + nbxmpp/structs.py - nbxmpp/util.py Changes: ===================================== nbxmpp/const.py ===================================== @@ -19,6 +19,7 @@ from enum import Enum from enum import IntEnum from enum import unique + @unique class Realm(Enum): CONNECTING = 'Connecting' @@ -40,6 +41,61 @@ class Event(Enum): def __str__(self): return self.value + class GSSAPIState(IntEnum): STEP = 0 WRAP = 1 + + +class MessageType(Enum): + NORMAL = 'normal' + CHAT = 'chat' + GROUPCHAT = 'groupchat' + HEADLINE = 'headline' + ERROR = 'error' + + +class PresenceType(Enum): + PROBE = 'probe' + SUBSCRIBE = 'subscribe' + SUBSCRIBED = 'subscribed' + AVAILABLE = None + UNAVAILABLE = 'unavailable' + UNSUBSCRIBE = 'unsubscribe' + UNSUBSCRIBED = 'unsubscribed' + ERROR = 'error' + + +class PresenceShow(Enum): + ONLINE = None + CHAT = 'chat' + AWAY = 'away' + XA = 'xa' + DND = 'dnd' + + +class StatusCode(Enum): + NON_ANONYMOUS = '100' + AFFILIATION_CHANGE = '101' + SHOWING_UNAVAILABLE = '102' + NOT_SHOWING_UNAVAILABLE = '103' + CONFIG_NON_PRIVACY_RELATED = '104' + SELF = '110' + CONFIG_ROOM_LOGGING = '170' + CONFIG_NO_ROOM_LOGGING = '171' + CONFIG_NON_ANONYMOUS = '172' + CONFIG_SEMI_ANONYMOUS = '173' + CONFIG_FULL_ANONYMOUS = '174' + CREATED = '201' + REMOVED_BANNED = '301' + NICKNAME_CHANGE = '303' + REMOVED_KICKED = '307' + REMOVED_AFFILIATION_CHANGE = '321' + REMOVED_NONMEMBER_IN_MEMBERS_ONLY = '322' + REMOVED_SERVICE_SHUTDOWN = '332' + REMOVED_ERROR = '333' + + +class InviteType(Enum): + MEDIATED = 'mediated' + DIRECT = 'direct' ===================================== nbxmpp/dispatcher_nb.py ===================================== @@ -44,9 +44,12 @@ from nbxmpp.protocol import ERR_FEATURE_NOT_IMPLEMENTED from nbxmpp.modules.eme import EME from nbxmpp.modules.http_auth import HTTPAuth from nbxmpp.modules.presence import BasePresence +from nbxmpp.modules.message import BaseMessage from nbxmpp.modules.nickname import Nickname +from nbxmpp.modules.delay import Delay from nbxmpp.modules.muc import MUC -from nbxmpp.misc import unwrap_carbon +from nbxmpp.modules.captcha import Captcha +from nbxmpp.modules.misc import unwrap_carbon from nbxmpp.util import get_properties_struct @@ -112,7 +115,7 @@ class XMPPDispatcher(PlugIn): self.RegisterCycleHandler, self.RegisterHandlerOnce, self.UnregisterHandler, self.RegisterProtocol, self.SendAndWaitForResponse, self.SendAndCallForResponse, - self.getAnID, self.Event, self.send] + self.getAnID, self.Event, self.send, self.get_module] # \ufddo -> \ufdef range c = '\ufdd0' @@ -150,12 +153,18 @@ class XMPPDispatcher(PlugIn): """ self.handlers = handlers + def get_module(self, name): + return self._modules[name] + def _register_modules(self): self._modules['BasePresence'] = BasePresence(self._owner) + self._modules['BaseMessage'] = BaseMessage(self._owner) self._modules['EME'] = EME(self._owner) self._modules['HTTPAuth'] = HTTPAuth(self._owner) self._modules['Nickname'] = Nickname(self._owner) self._modules['MUC'] = MUC(self._owner) + self._modules['Delay'] = Delay(self._owner) + self._modules['Captcha'] = Captcha(self._owner) for instance in self._modules.values(): for handler in instance.handlers: ===================================== nbxmpp/modules/bits_of_binary.py ===================================== @@ -0,0 +1,84 @@ +# Copyright (C) 2018 Philipp Hörist <philipp AT hoerist.com> +# +# This file is part of nbxmpp. +# +# This program is free software; you can redistribute it and/or +# modify it under the terms of the GNU General Public License +# as published by the Free Software Foundation; either version 3 +# of the License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; If not, see <http://www.gnu.org/licenses/>. + +import logging +import hashlib + +from nbxmpp.protocol import NS_BOB +from nbxmpp.protocol import InvalidStanza +from nbxmpp.structs import BobData +from nbxmpp.util import b64decode + +log = logging.getLogger('nbxmpp.m.bob') + + +def parse_bob_data(stanza): + data_node = stanza.getTag('data', namespace=NS_BOB) + if data_node is None: + return + + cid = data_node.getAttr('cid') + type_ = data_node.getAttr('type') + max_age = data_node.getAttr('max-age') + if max_age is not None: + try: + max_age = int(max_age) + except Exception: + log.exception(stanza) + raise InvalidStanza + + if cid is None or type_ is None: + log.warning('Invalid data node (no cid or type attr): %s', stanza) + raise InvalidStanza + + try: + algo_hash = cid.split('@')[0] + algo, hash_ = algo_hash.split('+') + except Exception: + log.exception('Invalid cid: %s', stanza) + raise InvalidStanza + + bob_data = data_node.getData() + if not bob_data: + log.warning('No bob data found: %s', stanza) + raise InvalidStanza + + try: + bob_data = b64decode(bob_data, return_type=bytes) + except Exception: + log.warning('Unable to decode data') + log.exception(stanza) + raise InvalidStanza + + try: + sha = hashlib.new(algo) + except ValueError as error: + log.warning(stanza) + log.warning(error) + raise InvalidStanza + + sha.update(bob_data) + if sha.hexdigest() != hash_: + log.warning('Invalid hash: %s', stanza) + raise InvalidStanza + + return BobData(algo=algo, + hash_=hash_, + max_age=max_age, + data=bob_data, + cid=cid, + type=type_) ===================================== nbxmpp/modules/captcha.py ===================================== @@ -0,0 +1,60 @@ +# Copyright (C) 2018 Philipp Hörist <philipp AT hoerist.com> +# +# This file is part of nbxmpp. +# +# This program is free software; you can redistribute it and/or +# modify it under the terms of the GNU General Public License +# as published by the Free Software Foundation; either version 3 +# of the License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; If not, see <http://www.gnu.org/licenses/>. + +import logging + +from nbxmpp.protocol import NS_CAPTCHA +from nbxmpp.protocol import NS_DATA +from nbxmpp.protocol import InvalidStanza +from nbxmpp.structs import StanzaHandler +from nbxmpp.structs import CaptchaData +from nbxmpp.modules.dataforms import extend_form +from nbxmpp.modules.bits_of_binary import parse_bob_data + +log = logging.getLogger('nbxmpp.m.captcha') + + +class Captcha: + def __init__(self, client): + self._client = client + self.handlers = [ + StanzaHandler(name='message', + callback=self._process_captcha, + ns=NS_CAPTCHA, + priority=40), + ] + + @staticmethod + def _process_captcha(_con, stanza, properties): + captcha = stanza.getTag('captcha', namespace=NS_CAPTCHA) + if captcha is None: + return + + data_form = captcha.getTag('x', namespace=NS_DATA) + if data_form is None: + log.warning('Invalid captcha form') + log.warning(stanza) + return + + form = extend_form(node=data_form) + try: + bob_data = parse_bob_data(stanza) + except InvalidStanza: + bob_data = None + + properties.captcha = CaptchaData(form=form, + bob_data=bob_data) ===================================== nbxmpp/modules/dataforms.py ===================================== @@ -0,0 +1,747 @@ +# 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> +# Copyright (C) 2018 Philipp Hörist <philipp AT hoerist.com> +# +# This file is part of nbxmpp. +# +# nbxmpp 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. +# +# nbxmpp 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 nbxmpp. If not, see <http://www.gnu.org/licenses/>. + +# XEP-0004: Data Forms + +from nbxmpp.protocol import NS_DATA +from nbxmpp.protocol import NS_DATA_MEDIA +from nbxmpp.simplexml import Node +from nbxmpp.util import validate_jid + + +# 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(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=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(Node): + def __init__(self, uri_tag): + 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(Node): + def __init__(self, media_tag): + 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: + validate_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: + validate_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 + 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 + Node.__init__(self, 'x', attrs={'xmlns': 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) + + +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 ===================================== nbxmpp/modules/date_and_time.py ===================================== @@ -0,0 +1,195 @@ +# Copyright (C) 2018 Philipp Hörist <philipp AT hoerist.com> +# +# This file is part of nbxmpp. +# +# This program is free software; you can redistribute it and/or +# modify it under the terms of the GNU General Public License +# as published by the Free Software Foundation; either version 3 +# of the License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; If not, see <http://www.gnu.org/licenses/>. + +import re +import time +import logging +from datetime import datetime +from datetime import timedelta +from datetime import timezone +from datetime import tzinfo + +log = logging.getLogger('nbxmpp.m.date_and_time') + +PATTERN_DATETIME = re.compile( + r'([0-9]{4}-[0-9]{2}-[0-9]{2})' + r'T' + r'([0-9]{2}:[0-9]{2}:[0-9]{2})' + r'(\.[0-9]{0,6})?' + r'(?:[0-9]+)?' + r'(?:(Z)|(?:([-+][0-9]{2}):([0-9]{2})))$' +) + +PATTERN_DELAY = re.compile( + r'([0-9]{4}-[0-9]{2}-[0-9]{2})' + r'T' + r'([0-9]{2}:[0-9]{2}:[0-9]{2})' + r'(\.[0-9]{0,6})?' + r'(?:[0-9]+)?' + r'(?:(Z)|(?:([-+][0]{2}):([0]{2})))$' +) + + +ZERO = timedelta(0) +HOUR = timedelta(hours=1) +SECOND = timedelta(seconds=1) + +STDOFFSET = timedelta(seconds=-time.timezone) +if time.daylight: + DSTOFFSET = timedelta(seconds=-time.altzone) +else: + DSTOFFSET = STDOFFSET + +DSTDIFF = DSTOFFSET - STDOFFSET + + +class LocalTimezone(tzinfo): + ''' + A class capturing the platform's idea of local time. + May result in wrong values on historical times in + timezones where UTC offset and/or the DST rules had + changed in the past. + ''' + def fromutc(self, dt): + assert dt.tzinfo is self + stamp = (dt - datetime(1970, 1, 1, tzinfo=self)) // SECOND + args = time.localtime(stamp)[:6] + dst_diff = DSTDIFF // SECOND + # Detect fold + fold = (args == time.localtime(stamp - dst_diff)) + return datetime(*args, microsecond=dt.microsecond, + tzinfo=self, fold=fold) + + def utcoffset(self, dt): + if self._isdst(dt): + return DSTOFFSET + return STDOFFSET + + def dst(self, dt): + if self._isdst(dt): + return DSTDIFF + return ZERO + + def tzname(self, dt): + return 'local' + + @staticmethod + def _isdst(dt): + tt = (dt.year, dt.month, dt.day, + dt.hour, dt.minute, dt.second, + dt.weekday(), 0, 0) + stamp = time.mktime(tt) + tt = time.localtime(stamp) + return tt.tm_isdst > 0 + + +def create_tzinfo(hours=0, minutes=0, tz_string=None): + if tz_string is None: + return timezone(timedelta(hours=hours, minutes=minutes)) + + if tz_string.lower() == 'z': + return timezone.utc + + try: + hours, minutes = map(int, tz_string.split(':')) + except Exception: + log.warning('Wrong tz string: %s', tz_string) + return + + if hours not in range(-24, 24): + log.warning('Wrong tz string: %s', tz_string) + return + + if minutes not in range(0, 59): + log.warning('Wrong tz string: %s', tz_string) + return + + if hours in (24, -24) and minutes != 0: + log.warning('Wrong tz string: %s', tz_string) + return + return timezone(timedelta(hours=hours, minutes=minutes)) + + +def parse_datetime(timestring, check_utc=False, + convert='utc', epoch=False): + ''' + Parse a XEP-0082 DateTime Profile String + + :param timestring: a XEP-0082 DateTime profile formated string + + :param check_utc: if True, returns None if timestring is not + a timestring expressing UTC + + :param convert: convert the given timestring to utc or local time + + :param epoch: if True, returns the time in epoch + + Examples: + '2017-11-05T01:41:20Z' + '2017-11-05T01:41:20.123Z' + '2017-11-05T01:41:20.123+05:00' + + return a datetime or epoch + ''' + if convert not in (None, 'utc', 'local'): + raise TypeError('"%s" is not a valid value for convert') + if check_utc: + match = PATTERN_DELAY.match(timestring) + else: + match = PATTERN_DATETIME.match(timestring) + + if match: + timestring = ''.join(match.groups('')) + strformat = '%Y-%m-%d%H:%M:%S%z' + if match.group(3): + # Fractional second addendum to Time + strformat = '%Y-%m-%d%H:%M:%S.%f%z' + if match.group(4): + # UTC string denoted by addition of the character 'Z' + timestring = timestring[:-1] + '+0000' + try: + date_time = datetime.strptime(timestring, strformat) + except ValueError: + pass + else: + if check_utc: + if convert != 'utc': + raise ValueError( + 'check_utc can only be used with convert="utc"') + date_time.replace(tzinfo=timezone.utc) + if epoch: + return date_time.timestamp() + return date_time + + if convert == 'utc': + date_time = date_time.astimezone(timezone.utc) + if epoch: + return date_time.timestamp() + return date_time + + if epoch: + # epoch is always UTC, use convert='utc' or check_utc=True + raise ValueError( + 'epoch not available while converting to local') + + if convert == 'local': + date_time = date_time.astimezone(LocalTimezone()) + return date_time + + # convert=None + return date_time + return None ===================================== nbxmpp/modules/delay.py ===================================== @@ -0,0 +1,93 @@ +# Copyright (C) 2018 Philipp Hörist <philipp AT hoerist.com> +# +# This file is part of nbxmpp. +# +# This program is free software; you can redistribute it and/or +# modify it under the terms of the GNU General Public License +# as published by the Free Software Foundation; either version 3 +# of the License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; If not, see <http://www.gnu.org/licenses/>. + +import logging + +from nbxmpp.protocol import NS_DELAY2 +from nbxmpp.structs import StanzaHandler +from nbxmpp.modules.date_and_time import parse_datetime + +log = logging.getLogger('nbxmpp.m.delay') + + +class Delay: + def __init__(self, client): + self._client = client + self.handlers = [ + StanzaHandler(name='message', + callback=self._process_delay, + ns=NS_DELAY2, + priority=15) + ] + + def _process_delay(self, _con, stanza, properties): + if properties.is_muc_subject: + # MUC Subjects can have a delay timestamp + # to indicate when the user has set the subject, + # the 'from' attr on these delays is the MUC server + # but we treat it as user timestamp + properties.user_timestamp = parse_delay( + stanza, from_=properties.jid.getBare()) + + else: + jid = self._client.get_bound_jid().getDomain() + timestamp = parse_delay(stanza, from_=jid) + if timestamp is not None: + properties.timestamp = timestamp + + properties.user_timestamp = parse_delay(stanza, not_from=[jid]) + + +def parse_delay(stanza, epoch=True, convert='utc', from_=None, not_from=None): + ''' + Returns the first valid delay timestamp that matches + + :param epoch: Returns the timestamp as epoch + + :param convert: Converts the timestamp to either utc or local + + :param from_: Matches only delays that have the according + from attr set + + :param not_from: Matches only delays that have the according + from attr not set + ''' + delays = stanza.getTags('delay', namespace=NS_DELAY2) + + for delay in delays: + stamp = delay.getAttr('stamp') + if stamp is None: + log.warning('Invalid timestamp received: %s', stamp) + log.warning(stanza) + continue + + delay_from = delay.getAttr('from') + if from_ is not None: + if delay_from != from_: + continue + if not_from is not None: + if delay_from in not_from: + continue + + timestamp = parse_datetime(stamp, check_utc=True, + epoch=epoch, convert=convert) + if timestamp is None: + log.warning('Invalid timestamp received: %s', stamp) + log.warning(stanza) + continue + + return timestamp ===================================== nbxmpp/modules/eme.py ===================================== @@ -18,7 +18,7 @@ import logging from nbxmpp.protocol import NS_EME -from nbxmpp.util import StanzaHandler +from nbxmpp.structs import StanzaHandler log = logging.getLogger('nbxmpp.m.eme') ===================================== nbxmpp/modules/http_auth.py ===================================== @@ -18,7 +18,7 @@ import logging from nbxmpp.protocol import NS_HTTP_AUTH -from nbxmpp.util import StanzaHandler +from nbxmpp.structs import StanzaHandler log = logging.getLogger('nbxmpp.m.http_auth') ===================================== nbxmpp/modules/message.py ===================================== @@ -0,0 +1,59 @@ +# Copyright (C) 2018 Philipp Hörist <philipp AT hoerist.com> +# +# This file is part of nbxmpp. +# +# This program is free software; you can redistribute it and/or +# modify it under the terms of the GNU General Public License +# as published by the Free Software Foundation; either version 3 +# of the License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; If not, see <http://www.gnu.org/licenses/>. + +import logging + +from nbxmpp.protocol import NodeProcessed +from nbxmpp.structs import StanzaHandler +from nbxmpp.const import MessageType + +log = logging.getLogger('nbxmpp.m.message') + + +class BaseMessage: + def __init__(self, client): + self._client = client + self.handlers = [ + StanzaHandler(name='message', + callback=self._process_message_base, + priority=10), + ] + + def _process_message_base(self, _con, stanza, properties): + properties.type = self._parse_type(stanza) + properties.jid = stanza.getFrom() + properties.id = stanza.getID() + properties.body = stanza.getBody() + properties.thread = stanza.getThread() + properties.subject = stanza.getSubject() + + if properties.type == MessageType.ERROR: + properties.error_code = stanza.getErrorCode() + properties.error_message = stanza.getErrorMsg() + + @staticmethod + def _parse_type(stanza): + type_ = stanza.getType() + if type_ is None: + return MessageType.NORMAL + + try: + return MessageType(type_) + except ValueError: + log.warning('Message with invalid type: %s', type_) + log.warning(stanza) + raise NodeProcessed ===================================== nbxmpp/misc.py → nbxmpp/modules/misc.py ===================================== @@ -24,7 +24,8 @@ from nbxmpp.protocol import NodeProcessed from nbxmpp.protocol import InvalidFrom from nbxmpp.protocol import Message -log = logging.getLogger('nbxmpp.misc') + +log = logging.getLogger('nbxmpp.m.misc') def unwrap_carbon(stanza, own_jid): ===================================== nbxmpp/modules/muc.py ===================================== @@ -19,9 +19,36 @@ import logging from nbxmpp.protocol import NS_MUC_USER from nbxmpp.protocol import NS_MUC -from nbxmpp.util import StanzaHandler +from nbxmpp.protocol import NS_CONFERENCE +from nbxmpp.protocol import NS_DATA +from nbxmpp.protocol import NS_MUC_REQUEST +from nbxmpp.protocol import NS_MUC_ADMIN +from nbxmpp.protocol import NS_MUC_OWNER +from nbxmpp.protocol import NS_CAPTCHA +from nbxmpp.protocol import JID +from nbxmpp.protocol import Iq +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 +from nbxmpp.const import MessageType +from nbxmpp.const import StatusCode +from nbxmpp.structs import DeclineData +from nbxmpp.structs import InviteData +from nbxmpp.structs import VoiceRequest +from nbxmpp.structs import AffiliationResult +from nbxmpp.structs import CommonResult +from nbxmpp.structs import MucConfigResult +from nbxmpp.util import validate_jid +from nbxmpp.util import call_on_response +from nbxmpp.util import callback +from nbxmpp.modules.dataforms import extend_form -log = logging.getLogger('nbxmpp.m.presence') +log = logging.getLogger('nbxmpp.m.muc') class MUC: @@ -36,16 +63,375 @@ class MUC: callback=self._process_muc_user_presence, ns=NS_MUC_USER, priority=11), + StanzaHandler(name='message', + callback=self._process_groupchat_message, + typ='groupchat', + priority=11), + StanzaHandler(name='message', + callback=self._process_mediated_invite, + typ='normal', + ns=NS_MUC_USER, + priority=11), + StanzaHandler(name='message', + callback=self._process_direct_invite, + typ='normal', + ns=NS_CONFERENCE, + priority=11), + StanzaHandler(name='message', + callback=self._process_voice_request, + ns=NS_DATA, + priority=11), + StanzaHandler(name='message', + callback=self._process_message, + ns=NS_MUC_USER, + priority=12), ] - def _process_muc_presence(self, _con, stanza, properties): + @staticmethod + def _process_muc_presence(_con, stanza, properties): muc = stanza.getTag('x', namespace=NS_MUC) if muc is None: return properties.from_muc = True - def _process_muc_user_presence(self, _con, stanza, properties): + @staticmethod + def _process_muc_user_presence(_con, stanza, properties): muc = stanza.getTag('x', namespace=NS_MUC_USER) if muc is None: return properties.from_muc = True + + @staticmethod + def _process_groupchat_message(_con, _stanza, properties): + properties.from_muc = True + properties.muc_nickname = properties.jid.getResource() or None + + @staticmethod + def _process_message(_con, stanza, properties): + muc_user = stanza.getTag('x', namespace=NS_MUC_USER) + if muc_user is None: + return + + # MUC Private message + if properties.type == MessageType.CHAT: + properties.muc_private_message = True + return + + if properties.is_muc_invite_or_decline: + return + + properties.from_muc = True + + if not properties.jid.isBare: + return + + # MUC Config change + # https://xmpp.org/extensions/xep-0045.html#registrar-statuscodes + message_status_codes = [ + StatusCode.SHOWING_UNAVAILABLE, + StatusCode.NOT_SHOWING_UNAVAILABLE, + StatusCode.CONFIG_NON_PRIVACY_RELATED, + StatusCode.CONFIG_ROOM_LOGGING, + StatusCode.CONFIG_NO_ROOM_LOGGING, + StatusCode.CONFIG_NON_ANONYMOUS, + StatusCode.CONFIG_SEMI_ANONYMOUS, + StatusCode.CONFIG_FULL_ANONYMOUS + ] + + codes = set() + for status in muc_user.getTags('status'): + try: + code = StatusCode(status.getAttr('code')) + except ValueError: + log.warning('Received invalid status code: %s', + status.getAttr('code')) + log.warning(stanza) + continue + if code in message_status_codes: + codes.add(code) + + if codes: + properties.muc_status_codes = codes + + @staticmethod + def _process_direct_invite(_con, stanza, properties): + direct = stanza.getTag('x', namespace=NS_CONFERENCE) + if direct is None: + return + + muc_jid = direct.getAttr('jid') + if muc_jid is None: + # Not a direct invite + # See https://xmpp.org/extensions/xep-0045.html#example-57 + # read implementation notes + return + + data = {} + data['muc'] = JID(muc_jid) + data['from_'] = properties.jid + data['reason'] = direct.getAttr('reason') + data['password'] = direct.getAttr('password') + data['continued'] = direct.getAttr('continue') == 'true' + data['thread'] = direct.getAttr('thread') + data['type'] = InviteType.DIRECT + properties.muc_invite = InviteData(**data) + + @staticmethod + def _process_mediated_invite(_con, stanza, properties): + muc_user = stanza.getTag('x', namespace=NS_MUC_USER) + if muc_user is None: + return + + if properties.type != MessageType.NORMAL: + return + + properties.from_muc = True + + data = {} + + invite = muc_user.getTag('invite') + if invite is not None: + data['muc'] = JID(properties.jid.getBare()) + data['from_'] = JID(invite.getAttr('from')) + data['reason'] = invite.getTagData('reason') + data['password'] = muc_user.getTagData('password') + data['type'] = InviteType.MEDIATED + + data['continued'] = False + data['thread'] = None + continue_ = invite.getTag('continue') + if continue_ is not None: + data['continued'] = True + data['thread'] = continue_.getAttr('thread') + properties.muc_invite = InviteData(**data) + return + + decline = muc_user.getTag('decline') + if decline is not None: + data['muc'] = JID(properties.jid.getBare()) + data['from_'] = JID(decline.getAttr('from')) + data['reason'] = decline.getTagData('reason') + properties.muc_decline = DeclineData(**data) + return + + @staticmethod + def _process_voice_request(_con, stanza, properties): + data_form = stanza.getTag('x', namespace=NS_DATA) + if data_form is None: + return + + data_form = extend_form(data_form) + try: + if data_form['FORM_TYPE'].value != NS_MUC_REQUEST: + return + except KeyError: + return + + properties.voice_request = VoiceRequest(form=data_form) + + @call_on_response('_affiliation_received') + def get_affiliation(self, jid, affiliation): + iq = Iq(typ='get', to=jid, queryNS=NS_MUC_ADMIN) + item = iq.setQuery().setTag('item') + item.setAttr('affiliation', affiliation) + return iq, {'affiliation': affiliation} + + @callback + def _affiliation_received(self, stanza, affiliation): + if not isResultNode(stanza): + log.info('Affiliation error: %s %s %s', + stanza.getFrom(), + stanza.getError(), + affiliation) + return AffiliationResult(jid=stanza.getFrom(), + affiliation=affiliation, + error=stanza.getError()) + + room_jid = stanza.getFrom() + query = stanza.getTag('query', namespace=NS_MUC_ADMIN) + items = query.getTags('item') + users_dict = {} + for item in items: + try: + jid = validate_jid(item.getAttr('jid')) + except InvalidJid as error: + log.exception(error) + continue + + users_dict[jid] = {} + if item.has_attr('nick'): + users_dict[jid]['nick'] = item.getAttr('nick') + if item.has_attr('role'): + users_dict[jid]['role'] = item.getAttr('role') + reason = item.getTagData('reason') + if reason: + users_dict[jid]['reason'] = reason + + log.info('%s affiliations received from %s: %s', + affiliation, room_jid, users_dict) + + return AffiliationResult(jid=room_jid, + affiliation=affiliation, + users=users_dict) + + @call_on_response('_default_response') + def destroy(self, room_jid, reason='', jid=''): + iq = Iq(typ='set', queryNS=NS_MUC_OWNER, to=room_jid) + destroy = iq.setQuery().setTag('destroy') + if reason: + destroy.setTagData('reason', reason) + if jid: + destroy.setAttr('jid', jid) + log.info('Destroy room: %s, reason: %s, alternate: %s', + room_jid, reason, jid) + return iq + + @call_on_response('_default_response') + def set_config(self, room_jid, form): + iq = Iq(typ='set', to=room_jid, queryNS=NS_MUC_OWNER) + query = iq.setQuery() + form.setAttr('type', 'submit') + query.addChild(node=form) + log.info('Set config for %s', room_jid) + return iq + + @call_on_response('_config_received') + def request_config(self, room_jid, lang): + iq = Iq(typ='get', + queryNS=NS_MUC_OWNER, + to=room_jid) + iq.setAttr('xml:lang', lang) + log.info('Request config for %s', room_jid) + return iq + + @callback + def _config_received(self, stanza): + if not isResultNode(stanza): + log.info('Error: %s', stanza.getError()) + return MucConfigResult(jid=stanza.getFrom(), + error=stanza.getError()) + + jid = stanza.getFrom() + payload = stanza.getQueryPayload() + + for form in payload: + if form.getNamespace() == NS_DATA: + dataform = extend_form(node=form) + log.info('Config form received for %s', jid) + return MucConfigResult(jid=jid, + form=dataform) + return MucConfigResult(jid=jid) + + @call_on_response('_default_response') + def cancel_config(self, room_jid): + cancel = Node(tag='x', attrs={'xmlns': NS_DATA, 'type': 'cancel'}) + iq = Iq(typ='set', + queryNS=NS_MUC_OWNER, + payload=cancel, + to=room_jid) + log.info('Cancel config for %s', room_jid) + return iq + + @call_on_response('_default_response') + def set_affiliation(self, room_jid, users_dict): + iq = Iq(typ='set', to=room_jid, queryNS=NS_MUC_ADMIN) + item = iq.setQuery() + for jid in users_dict: + affiliation = users_dict[jid].get('affiliation') + reason = users_dict[jid].get('reason') + nick = users_dict[jid].get('nick') + item_tag = item.addChild('item', {'jid': jid, + 'affiliation': affiliation}) + if reason is not None: + item_tag.setTagData('reason', reason) + + if nick is not None: + item_tag.setAttr('nick', nick) + log.info('Set affiliation for %s: %s', room_jid, users_dict) + return iq + + @call_on_response('_default_response') + def set_role(self, room_jid, nick, role, reason=''): + iq = Iq(typ='set', to=room_jid, queryNS=NS_MUC_ADMIN) + item = iq.setQuery().setTag('item') + item.setAttr('nick', nick) + item.setAttr('role', role) + if reason: + item.addChild(name='reason', payload=reason) + log.info('Set role for %s: %s %s %s', room_jid, nick, role, reason) + return iq + + def set_subject(self, room_jid, subject): + message = Message(room_jid, typ='groupchat', subject=subject) + log.info('Set subject for %s', room_jid) + self._client.send(message) + + def decline(self, room, to, reason=None): + message = Message(to=room) + muc_user = message.addChild('x', namespace=NS_MUC_USER) + decline = muc_user.addChild('decline', attrs={'to': to}) + if reason: + decline.setTagData('reason', reason) + self._client.send(message) + + def request_voice(self, room): + message = Message(to=room) + xdata = DataForm(typ='submit') + xdata.addChild(node=DataField(name='FORM_TYPE', + value=NS_MUC_REQUEST)) + xdata.addChild(node=DataField(name='muc#role', + value='participant', + typ='text-single')) + message.addChild(node=xdata) + self._client.send(message) + + def invite(self, room, to, password, reason=None, continue_=False, + type_=InviteType.MEDIATED): + if type_ == InviteType.DIRECT: + invite = self._build_direct_invite( + room, to, reason, password, continue_) + else: + invite = self._build_mediated_invite( + room, to, reason, password, continue_) + self._client.send(invite) + + @staticmethod + def _build_direct_invite(room, to, reason, password, continue_): + message = Message(to=to) + attrs = {'jid': room} + if reason: + attrs['reason'] = reason + if continue_: + attrs['continue'] = 'true' + if password: + attrs['password'] = password + message.addChild(name='x', attrs=attrs, + namespace=NS_CONFERENCE) + return message + + @staticmethod + def _build_mediated_invite(room, to, reason, password, continue_): + message = Message(to=room) + muc_user = message.addChild('x', namespace=NS_MUC_USER) + invite = muc_user.addChild('invite', attrs={'to': to}) + if continue_: + invite.addChild(name='continue') + if reason: + invite.setTagData('reason', reason) + if password: + muc_user.setTagData('password', password) + return message + + def send_captcha(self, room_jid, form_node): + iq = Iq(typ='set', to=room_jid) + captcha = iq.addChild(name='captcha', namespace=NS_CAPTCHA) + captcha.addChild(node=form_node) + self._client.send(iq) + + @callback + def _default_response(self, stanza): + if not isResultNode(stanza): + log.info('Error: %s', stanza.getError()) + return CommonResult(jid=stanza.getFrom(), + error=stanza.getError()) + return CommonResult(jid=stanza.getFrom()) ===================================== nbxmpp/modules/nickname.py ===================================== @@ -18,7 +18,8 @@ import logging from nbxmpp.protocol import NS_NICK -from nbxmpp.util import StanzaHandler +from nbxmpp.structs import StanzaHandler +from nbxmpp.const import PresenceType log = logging.getLogger('nbxmpp.m.nickname') @@ -45,7 +46,8 @@ class Nickname: # the nickname MUST NOT be included in presence broadcasts # (i.e., <presence/> stanzas with no 'type' attribute or # of type "unavailable"). - if properties.type in (None, 'unavailable'): + if properties.type in (PresenceType.AVAILABLE, + PresenceType.UNAVAILABLE): return properties.nickname = self._parse_nickname(stanza) ===================================== nbxmpp/modules/presence.py ===================================== @@ -20,8 +20,9 @@ import logging from nbxmpp.protocol import Error from nbxmpp.protocol import ERR_BAD_REQUEST from nbxmpp.protocol import NodeProcessed -from nbxmpp.protocol import presence_types -from nbxmpp.util import StanzaHandler +from nbxmpp.structs import StanzaHandler +from nbxmpp.const import PresenceType +from nbxmpp.const import PresenceShow log = logging.getLogger('nbxmpp.m.presence') @@ -43,7 +44,7 @@ class BasePresence: properties.id = stanza.getID() properties.status = stanza.getStatus() - if properties.type == 'error': + if properties.type == PresenceType.ERROR: properties.error_code = stanza.getErrorCode() properties.error_message = stanza.getErrorMsg() @@ -64,7 +65,7 @@ class BasePresence: log.warning(stanza) return 0 - if priority not in range(-128, 127): + if priority not in range(-129, 128): log.warning('Invalid priority value: %s', priority) log.warning(stanza) return 0 @@ -73,19 +74,19 @@ class BasePresence: def _parse_type(self, stanza): type_ = stanza.getType() - if type_ is None: - return - - if type_ not in presence_types: + try: + return PresenceType(type_) + except ValueError: log.warning('Presence with invalid type received') log.warning(stanza) self._client.send(Error(stanza, ERR_BAD_REQUEST)) raise NodeProcessed - return type_ @staticmethod def _parse_show(stanza): show = stanza.getShow() - if show not in ('chat', 'away', 'xa', 'dnd'): - return - return show + try: + return PresenceShow(show) + except ValueError: + log.warning('Presence with invalid show') + log.warning(stanza) ===================================== nbxmpp/protocol.py ===================================== @@ -496,15 +496,6 @@ _status_conditions = { 'removed-shutdown': 332, } -presence_types = [ - 'error', - 'probe', - 'subscribe', - 'subscribed', - 'unavailable', - 'unsubscribe', - 'unsubscribed' -] 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' @@ -769,6 +760,10 @@ class JID: """ return self.__str__(0) + @property + def isBare(self): + return self.node and self.domain and not self.resource + def __eq__(self, other): """ Compare the JID to another instance or to string for equality ===================================== nbxmpp/structs.py ===================================== @@ -0,0 +1,146 @@ +# Copyright (C) 2018 Philipp Hörist <philipp AT hoerist.com> +# +# This file is part of nbxmpp. +# +# This program is free software; you can redistribute it and/or +# modify it under the terms of the GNU General Public License +# as published by the Free Software Foundation; either version 2 +# of the License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; If not, see <http://www.gnu.org/licenses/>. + +import time +from collections import namedtuple + +from nbxmpp.const import MessageType + +StanzaHandler = namedtuple('StanzaHandler', + 'name callback typ ns xmlns system priority') +StanzaHandler.__new__.__defaults__ = ('', '', None, False, 50) + +InviteData = namedtuple('InviteData', + 'muc from_ reason password type continued thread') + +DeclineData = namedtuple('DeclineData', 'muc from_ reason') + +CaptchaData = namedtuple('CaptchaData', 'form bob_data') + +BobData = namedtuple('BobData', 'algo hash_ max_age data cid type') + +VoiceRequest = namedtuple('VoiceRequest', 'form') + + +class Properties: + pass + + +class MessageProperties: + def __init__(self): + self.carbon_type = None + self.type = MessageType.NORMAL + self.id = None + self.jid = None + self.subject = None + self.body = None + self.thread = None + self.user_timestamp = None + self.timestamp = time.time() + self.error_code = None + self.error_message = None + self.eme = None + self.http_auth = None + self.nickname = None + self.from_muc = False + self.muc_nickname = None + self.muc_status_codes = None + self.muc_private_message = False + self.muc_invite = None + self.muc_decline = None + self.captcha = None + self.voice_request = None + + @property + def is_http_auth(self): + return self.http_auth is not None + + @property + def is_muc_subject(self): + return (self.type == MessageType.GROUPCHAT and + self.body is None and + self.subject is not None) + + @property + def is_muc_config_change(self): + return self.body is None and self.muc_status_codes + + @property + def is_muc_pm(self): + return self.muc_private_message + + @property + def is_muc_invite_or_decline(self): + return (self.muc_invite is not None or + self.muc_decline is not None) + + @property + def is_captcha_challenge(self): + return self.captcha is not None + + @property + def is_voice_request(self): + return self.voice_request is not None + + +class IqProperties: + def __init__(self): + self.http_auth = None + + @property + def is_http_auth(self): + return self.http_auth is not None + + +class PresenceProperties: + def __init__(self): + self.type = None + self.priority = None + self.show = None + self.jid = None + self.resource = None + self.id = None + self.nickname = None + self.self_presence = False + self.from_muc = False + self.status = '' + self.error_message = '' + self.error_code = '' + + +class BaseResult: + @property + def is_error(self): + return self.error is not None + + +class CommonResult(BaseResult, namedtuple('CommonResult', 'jid error')): + pass + +CommonResult.__new__.__defaults__ = (None,) + +class AffiliationResult(BaseResult, namedtuple('AffiliationResult', + 'jid affiliation users error')): + pass + +AffiliationResult.__new__.__defaults__ = (None, None) + +class MucConfigResult(BaseResult, namedtuple('MucConfigResult', + 'jid form error')): + pass + +MucConfigResult.__new__.__defaults__ = (None, None) ===================================== nbxmpp/util.py ===================================== @@ -18,19 +18,21 @@ import logging import socket import base64 -from collections import namedtuple +import weakref +from functools import wraps import precis_i18n.codec from nbxmpp.protocol import JID from nbxmpp.protocol import InvalidJid from nbxmpp.stringprepare import nameprep +from nbxmpp.structs import Properties +from nbxmpp.structs import IqProperties +from nbxmpp.structs import MessageProperties +from nbxmpp.structs import PresenceProperties log = logging.getLogger('nbxmpp.util') -StanzaHandler = namedtuple('StanzaHandler', 'name callback typ ns xmlns system priority') -StanzaHandler.__new__.__defaults__ = ('', '', None, False, 50) - def b64decode(data, return_type=str): if isinstance(data, str): @@ -50,47 +52,6 @@ def b64encode(data, return_type=str): return result.decode() -class Properties: - pass - - -class MessageProperties: - def __init__(self): - self.carbon_type = None - self.eme = None - self.http_auth = None - self.nickname = None - - @property - def is_http_auth(self): - return self.http_auth is not None - - -class IqProperties: - def __init__(self): - self.http_auth = None - - @property - def is_http_auth(self): - return self.http_auth is not None - - -class PresenceProperties: - def __init__(self): - self.type = None - self.priority = None - self.show = None - self.jid = None - self.resource = None - self.id = None - self.nickname = None - self.self_presence = False - self.from_muc = False - self.status = '' - self.error_message = '' - self.error_code = '' - - def get_properties_struct(name): if name == 'message': return MessageProperties() @@ -103,9 +64,9 @@ def get_properties_struct(name): def validate_jid(jid_string): jid = JID(jid_string) - return prep(jid.getNode(), - jid.getDomain(), - jid.getResource()) + return prep(jid.getNode() or None, + jid.getDomain() or None, + jid.getResource() or None) def prep(user, server, resource): @@ -170,3 +131,39 @@ def prep(user, server, resource): if resource: return '%s/%s' % (server, resource) return server + + +def call_on_response(cb): + def response_decorator(func): + @wraps(func) + def func_wrapper(self, *args, **kwargs): + callback_ = kwargs.pop('callback', None) + + stanza = func(self, *args, **kwargs) + if isinstance(stanza, tuple): + stanza, attrs = stanza + else: + stanza, attrs = stanza, {} + + if callback_ is not None: + attrs['callback'] = weakref.WeakMethod(callback_) + + self._client.SendAndCallForResponse(stanza, + getattr(self, cb), + attrs) + return func_wrapper + return response_decorator + + +def callback(func): + @wraps(func) + def func_wrapper(self, _con, stanza, **kwargs): + cb = kwargs.pop('callback', None) + if cb is None: + return + + if cb() is not None: + result = func(self, stanza, **kwargs) + cb()(result) + + return func_wrapper View it on GitLab: https://dev.gajim.org/gajim/python-nbxmpp/compare/72fe5ed6562d6112526d38302… -- View it on GitLab: https://dev.gajim.org/gajim/python-nbxmpp/compare/72fe5ed6562d6112526d38302… You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/python-nbxmpp][master] Revert "fix building nbxmpp"
by Yann Leboulanger 27 Dec '18

27 Dec '18

Yann Leboulanger pushed to branch master at gajim / python-nbxmpp Commits: 72fe5ed6 by Yann Leboulanger at 2018-12-27T10:21:29Z Revert "fix building nbxmpp" This reverts commit 5b825b3b4e0e3d81f832fac2053f526353598dde. - - - - - 1 changed file: - nbxmpp/auth.py Changes: ===================================== nbxmpp/auth.py ===================================== @@ -1,4 +1,4 @@ -# Copyright (C) 2018 Philipp Horist <philipp AT hoerist.com> +# Copyright (C) 2018 Philipp Hörist <philipp AT hoerist.com> # # This file is part of nbxmpp. # View it on GitLab: https://dev.gajim.org/gajim/python-nbxmpp/commit/72fe5ed6562d6112526d38302e… -- View it on GitLab: https://dev.gajim.org/gajim/python-nbxmpp/commit/72fe5ed6562d6112526d38302e… You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/python-nbxmpp][master] fix building nbxmpp
by Yann Leboulanger 27 Dec '18

27 Dec '18

Yann Leboulanger pushed to branch master at gajim / python-nbxmpp Commits: 5b825b3b by Yann Leboulanger at 2018-12-27T10:01:28Z fix building nbxmpp - - - - - 1 changed file: - nbxmpp/auth.py Changes: ===================================== nbxmpp/auth.py ===================================== @@ -1,4 +1,4 @@ -# Copyright (C) 2018 Philipp Hörist <philipp AT hoerist.com> +# Copyright (C) 2018 Philipp Horist <philipp AT hoerist.com> # # This file is part of nbxmpp. # View it on GitLab: https://dev.gajim.org/gajim/python-nbxmpp/commit/5b825b3b4e0e3d81f832fac205… -- View it on GitLab: https://dev.gajim.org/gajim/python-nbxmpp/commit/5b825b3b4e0e3d81f832fac205… You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/gajim][gajim_1.1] Fix status tray notification
by Philipp Hörist 26 Dec '18

26 Dec '18

Philipp Hörist pushed to branch gajim_1.1 at gajim / gajim Commits: b2cc2147 by Philipp Hörist at 2018-12-26T11:44:18Z Fix status tray notification Clicking on a new message notification in the status tray didnt open the chat - - - - - 1 changed file: - gajim/gui_interface.py Changes: ===================================== gajim/gui_interface.py ===================================== @@ -1645,10 +1645,13 @@ class Interface: app.events.change_jid(account, fjid, jid) resource = None fjid = jid + contact = None if resource: - contact = app.contacts.get_contact(account, jid, resource) or highest_contact - if contact is None: + contact = app.contacts.get_contact(account, jid, resource) + if not contact: + contact = highest_contact + if not contact: # Maybe we deleted the contact from the roster return View it on GitLab: https://dev.gajim.org/gajim/gajim/commit/b2cc2147c3b936cbe4468e9f978942c00c… -- View it on GitLab: https://dev.gajim.org/gajim/gajim/commit/b2cc2147c3b936cbe4468e9f978942c00c… You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/gajim] Pushed new tag gajim-1.1.1
by Yann Leboulanger 24 Dec '18

24 Dec '18

Yann Leboulanger pushed new tag gajim-1.1.1 at gajim / gajim -- View it on GitLab: https://dev.gajim.org/gajim/gajim/tree/gajim-1.1.1 You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/gajim] Deleted tag gajim-1.1.1
by Yann Leboulanger 24 Dec '18

24 Dec '18

Yann Leboulanger deleted tag gajim-1.1.1 at gajim / gajim -- You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/gajim] Deleted tag gajim-1.1.1
by Yann Leboulanger 24 Dec '18

24 Dec '18

Yann Leboulanger deleted tag gajim-1.1.1 at gajim / gajim -- You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/gajim][gajim_1.1] update translations
by Yann Leboulanger 24 Dec '18

24 Dec '18

Yann Leboulanger pushed to branch gajim_1.1 at gajim / gajim Commits: f5a08c89 by Yann Leboulanger at 2018-12-24T12:14:38Z update translations - - - - - 3 changed files: - po/be.po - po/be(a)latin.po - po/bg.po The diff was not included because it is too large. View it on GitLab: https://dev.gajim.org/gajim/gajim/commit/f5a08c8953b5b7abbc801875af67f0281d… -- View it on GitLab: https://dev.gajim.org/gajim/gajim/commit/f5a08c8953b5b7abbc801875af67f0281d… You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/gajim][master] Adapt Zeroconf to nbxmpp changes
by Philipp Hörist 23 Dec '18

23 Dec '18

Philipp Hörist pushed to branch master at gajim / gajim Commits: c63e3263 by Philipp Hörist at 2018-12-23T21:33:10Z Adapt Zeroconf to nbxmpp changes Fixes #9503 - - - - - 2 changed files: - gajim/common/modules/__init__.py - gajim/common/zeroconf/client_zeroconf.py Changes: ===================================== gajim/common/modules/__init__.py ===================================== @@ -26,7 +26,10 @@ from gajim.common.types import ConnectionT log = logging.getLogger('gajim.c.m') -ZEROCONF_MODULES = ['adhoc_commands', 'receipts', 'discovery'] +ZEROCONF_MODULES = ['adhoc_commands', + 'receipts', + 'discovery', + 'chatstates'] _imported_modules = [] # type: List[tuple] _modules = {} # type: Dict[str, Dict[str, Any]] ===================================== gajim/common/zeroconf/client_zeroconf.py ===================================== @@ -15,6 +15,8 @@ # You should have received a copy of the GNU General Public License # along with Gajim. If not, see <http://www.gnu.org/licenses/>. +from unittest.mock import Mock + from gajim.common import app import nbxmpp from nbxmpp.idlequeue import IdleObject @@ -141,6 +143,7 @@ class P2PClient(IdleObject): self.Namespace = 'jabber:client' self.protocol_type = 'XMPP' self.defaultNamespace = self.Namespace + self.Smacks = Mock() self._component = 0 self._registered_name = None self._caller = conn_holder.caller @@ -190,6 +193,9 @@ class P2PClient(IdleObject): self.on_responses = {} + def get_bound_jid(self): + return self._caller.get_own_jid() + def add_stanza(self, stanza, is_message=False): if self.Connection: if self.Connection.state == -1: View it on GitLab: https://dev.gajim.org/gajim/gajim/commit/c63e32634a22f3f488dc984885e3d538cb… -- View it on GitLab: https://dev.gajim.org/gajim/gajim/commit/c63e32634a22f3f488dc984885e3d538cb… You're receiving this email because of your account on dev.gajim.org.

1 0

[Git][gajim/gajim][gajim_1.1] Add chatstates module to zeroconf
by Philipp Hörist 23 Dec '18

23 Dec '18

Philipp Hörist pushed to branch gajim_1.1 at gajim / gajim Commits: d1bad012 by Philipp Hörist at 2018-12-23T13:08:07Z Add chatstates module to zeroconf Fixes #9503 - - - - - 1 changed file: - gajim/common/modules/__init__.py Changes: ===================================== gajim/common/modules/__init__.py ===================================== @@ -26,7 +26,10 @@ from gajim.common.types import ConnectionT log = logging.getLogger('gajim.c.m') -ZEROCONF_MODULES = ['adhoc_commands', 'receipts', 'discovery'] +ZEROCONF_MODULES = ['adhoc_commands', + 'receipts', + 'discovery', + 'chatstates'] _imported_modules = [] # type: List[tuple] _modules = {} # type: Dict[str, Dict[str, Any]] View it on GitLab: https://dev.gajim.org/gajim/gajim/commit/d1bad01256f23f94b8e104a3df304bda0e… -- View it on GitLab: https://dev.gajim.org/gajim/gajim/commit/d1bad01256f23f94b8e104a3df304bda0e… You're receiving this email because of your account on dev.gajim.org.

1 0

Jump to page:

2026

2025

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

2007

2006

Commits