view sat_frontends/tools/jid.py @ 3028:ab2696e34d29

Python 3 port: /!\ this is a huge commit /!\ starting from this commit, SàT is needs Python 3.6+ /!\ SàT maybe be instable or some feature may not work anymore, this will improve with time This patch port backend, bridge and frontends to Python 3. Roughly this has been done this way: - 2to3 tools has been applied (with python 3.7) - all references to python2 have been replaced with python3 (notably shebangs) - fixed files not handled by 2to3 (notably the shell script) - several manual fixes - fixed issues reported by Python 3 that where not handled in Python 2 - replaced "async" with "async_" when needed (it's a reserved word from Python 3.7) - replaced zope's "implements" with @implementer decorator - temporary hack to handle data pickled in database, as str or bytes may be returned, to be checked later - fixed hash comparison for password - removed some code which is not needed anymore with Python 3 - deactivated some code which needs to be checked (notably certificate validation) - tested with jp, fixed reported issues until some basic commands worked - ported Primitivus (after porting dependencies like urwid satext) - more manual fixes
author Goffi <goffi@goffi.org>
date Tue, 13 Aug 2019 19:08:41 +0200
parents 003b8b4b56a7
children 9d0df638c8b4
line wrap: on
line source

#!/usr/bin/env python2
# -*- coding: utf-8 -*-

# SAT: a jabber client
# Copyright (C) 2009-2019 Jérôme Poisson (goffi@goffi.org)

# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero 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 Affero General Public License for more details.

# You should have received a copy of the GNU Affero General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.


# hack to use this module with pyjamas
try:
    str("")  # XXX: unicode doesn't exist in pyjamas

    # normal version
    class BaseJID(str):
        def __new__(cls, jid_str):
            self = str.__new__(cls, cls._normalize(jid_str))
            return self

        def __init__(self, jid_str):
            pass

        def _parse(self):
            """Find node domain and resource"""
            node_end = self.find("@")
            if node_end < 0:
                node_end = 0
            domain_end = self.find("/")
            if domain_end == 0:
                raise ValueError("a jid can't start with '/'")
            if domain_end == -1:
                domain_end = len(self)
            self.node = self[:node_end] or None
            self.domain = self[(node_end + 1) if node_end else 0 : domain_end]
            self.resource = self[domain_end + 1 :] or None


except (
    TypeError,
    AttributeError,
):  # Error raised is not the same depending on pyjsbuild options

    # pyjamas version
    class BaseJID(object):
        def __init__(self, jid_str):
            self.__internal_str = JID._normalize(jid_str)

        def __str__(self):
            return self.__internal_str

        def __getattr__(self, name):
            return getattr(self.__internal_str, name)

        def __eq__(self, other):
            if not isinstance(other, JID):
                return False
            return (
                self.node == other.node
                and self.domain == other.domain
                and self.resource == other.resource
            )

        def __hash__(self):
            return hash("JID<{}>".format(self.__internal_str))

        def find(self, *args):
            return self.__internal_str.find(*args)

        def _parse(self):
            """Find node domain and resource"""
            node_end = self.__internal_str.find("@")
            if node_end < 0:
                node_end = 0
            domain_end = self.__internal_str.find("/")
            if domain_end == 0:
                raise ValueError("a jid can't start with '/'")
            if domain_end == -1:
                domain_end = len(self.__internal_str)
            self.node = self.__internal_str[:node_end] or None
            self.domain = self.__internal_str[
                (node_end + 1) if node_end else 0 : domain_end
            ]
            self.resource = self.__internal_str[domain_end + 1 :] or None


class JID(BaseJID):
    """This class help manage JID (Node@Domaine/Resource)"""

    def __init__(self, jid_str):
        super(JID, self).__init__(jid_str)
        self._parse()

    @staticmethod
    def _normalize(jid_str):
        """Naive normalization before instantiating and parsing the JID"""
        if not jid_str:
            return jid_str
        tokens = jid_str.split("/")
        tokens[0] = tokens[0].lower()  # force node and domain to lower-case
        return "/".join(tokens)

    @property
    def bare(self):
        if not self.node:
            return JID(self.domain)
        return JID("{}@{}".format(self.node, self.domain))

    def is_valid(self):
        """
        @return: True if the JID is XMPP compliant
        """
        # TODO: implement real check, according to the RFC http://tools.ietf.org/html/rfc6122
        return self.domain != ""


def newResource(entity, resource):
    """Build a new JID from the given entity and resource.

    @param entity (JID): original JID
    @param resource (unicode): new resource
    @return: a new JID instance
    """
    return JID("%s/%s" % (entity.bare, resource))