view sat/stdui/ @ 3075:501a1a3c8594

plugin text syntaxes: don't use anymore deprecated cgi.escape
author Goffi <>
date Mon, 18 Nov 2019 20:50:34 +0100
parents ab2696e34d29
children 0c29155ac68b
line wrap: on
line source

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

# SAT standard user interface for managing contacts
# Copyright (C) 2009-2019 Jérôme Poisson (
# Copyright (C) 2013-2016 Adrien Cossa (

# 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
# 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 <>.

from sat.core.i18n import D_
from sat.core.constants import Const as C
from sat.core.log import getLogger

log = getLogger(__name__)
from sat.core import exceptions
from import xml_tools
from sat.memory.memory import ProfileSessions
from twisted.words.protocols.jabber import jid

class ProfileManager(object):
    """Manage profiles."""

    def __init__(self, host): = host
        self.profile_ciphers = {}
        self._sessions = ProfileSessions()
            self._authenticateProfile, force_id=C.AUTHENTICATE_PROFILE_ID, with_data=True
            self._changeXMPPPassword, force_id=C.CHANGE_XMPP_PASSWD_ID, with_data=True
        self.__new_xmpp_passwd_id = host.registerCallback(
            self._changeXMPPPasswordCb, with_data=True

    def _startSessionEb(self, fail, first, profile):
        """Errback method for startSession during profile authentication

        @param first(bool): if True, this is the first try and we have tryied empty password
            in this case we ask for a password to the user.
        @param profile(unicode, None): %(doc_profile)s
            must only be used if first is True
        if first:
            # first call, we ask for the password
            form_ui = xml_tools.XMLUI(
                "form", title=D_("Profile password for {}").format(profile), submit_id=""
            form_ui.addPassword("profile_password", value="")
            d = xml_tools.deferredUI(, form_ui, chained=True)
            d.addCallback(self._authenticateProfile, profile)
            return {"xmlui": form_ui.toXml()}

        assert profile is None

        if fail.check(exceptions.PasswordError):
            dialog = xml_tools.XMLUI("popup", title=D_("Connection error"))
            dialog.addText(D_("The provided profile password doesn't match."))
            log.error("Unexpected exceptions: {}".format(fail))
            dialog = xml_tools.XMLUI("popup", title=D_("Internal error"))
            dialog.addText(D_("Internal error: {}".format(fail)))
        return {"xmlui": dialog.toXml(), "validated": C.BOOL_FALSE}

    def _authenticateProfile(self, data, profile):
        if C.bool(data.get("cancelled", "false")):
            return {}
            return {"validated": C.BOOL_TRUE}
            password = data[xml_tools.formEscape("profile_password")]
        except KeyError:
            # first request, we try empty password
            password = ""
            first = True
            eb_profile = profile
            first = False
            eb_profile = None
        d =, profile)
        d.addCallback(lambda __: {"validated": C.BOOL_TRUE})
        d.addErrback(self._startSessionEb, first, eb_profile)
        return d

    def _changeXMPPPassword(self, data, profile):
        session_data = self._sessions.profileGetUnique(profile)
        if not session_data:
            server =
                C.FORCE_SERVER_PARAM, "Connection", profile_key=profile
            if not server:
                server = jid.parse(
                        "JabberID", "Connection", profile_key=profile
            session_id, session_data = self._sessions.newSession(
                {"count": 0, "server": server}, profile=profile
        if (
            session_data["count"] > 2
        ):  # 3 attempts with a new password after the initial try
            _dialog = xml_tools.XMLUI("popup", title=D_("Connection error"))
                D_("Can't connect to %s. Please check your connection details.")
                % session_data["server"]
            return {"xmlui": _dialog.toXml()}
        session_data["count"] += 1
        counter = " (%d)" % session_data["count"] if session_data["count"] > 1 else ""
        title = D_("XMPP password for %(profile)s%(counter)s") % {
            "profile": profile,
            "counter": counter,
        form_ui = xml_tools.XMLUI(
            "form", title=title, submit_id=self.__new_xmpp_passwd_id
                "Can't connect to %s. Please check your connection details or try with another password."
            % session_data["server"]
        form_ui.addPassword("xmpp_password", value="")
        return {"xmlui": form_ui.toXml()}

    def _changeXMPPPasswordCb(self, data, profile):
        xmpp_password = data[xml_tools.formEscape("xmpp_password")]
        d =
            "Password", xmpp_password, "Connection", profile_key=profile
        d.addCallback(lambda __:
        d.addCallback(lambda __: {})
        d.addErrback(lambda __: self._changeXMPPPassword({}, profile))
        return d