view sat_frontends/quick_frontend/ @ 3029:457ae6381e2a

doc: replaced deprecated installation link in INSTALL
author Goffi <>
date Wed, 14 Aug 2019 08:08:25 +0200
parents ab2696e34d29
children 9d0df638c8b4
line wrap: on
line source

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

# helper class for making a SAT frontend
# Copyright (C) 2009-2019 Jérôme Poisson (

# 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 _
from sat.core.log import getLogger

log = getLogger(__name__)
from import JID

class QuickContactManagement(object):
    """This helper class manage the contacts and ease the use of nicknames and shortcuts"""

    ### FIXME: is SàT a better place for all this stuff ??? ###

    def __init__(self):
        self.__contactlist = {}

    def __contains__(self, entity):
        return entity.bare in self.__contactlist

    def clear(self):
        """Clear all the contact list"""

    def add(self, entity):
        """Add contact to the list, update resources"""
        if entity.bare not in self.__contactlist:
            self.__contactlist[entity.bare] = {"resources": []}
        if not entity.resource:
        if entity.resource in self.__contactlist[entity.bare]["resources"]:

    def getContFromGroup(self, group):
        """Return all contacts which are in given group"""
        result = []
        for contact in self.__contactlist:
            if "groups" in self.__contactlist[contact]:
                if group in self.__contactlist[contact]["groups"]:
        return result

    def getAttr(self, entity, name):
        """Return a specific attribute of contact, or all attributes
        @param entity: jid of the contact
        @param name: name of the attribute
        @return: asked attribute"""
        if entity.bare in self.__contactlist:
            if name == "status":  # FIXME: for the moment, we only use the first status
                if self.__contactlist[entity.bare]["statuses"]:
                    return list(self.__contactlist[entity.bare]["statuses"].values())[0]
            if name in self.__contactlist[entity.bare]:
                return self.__contactlist[entity.bare][name]
            log.debug(_("Trying to get attribute for an unknown contact"))
        return None

    def isConnected(self, entity):
        """Tell if the contact is online"""
        return entity.bare in self.__contactlist

    def remove(self, entity):
        """remove resource. If no more resource is online or is no resource is specified, contact is deleted"""
            if entity.resource:
            if not entity.resource or not self.__contactlist[entity.bare]["resources"]:
                # no more resource available: the contact seems really disconnected
                del self.__contactlist[entity.bare]
        except KeyError:
            log.error(_("INTERNAL ERROR: Key log.error"))

    def update(self, entity, key, value):
        """Update attribute of contact
        @param entity: jid of the contact
        @param key: name of the attribute
        @param value: value of the attribute
        if entity.bare in self.__contactlist:
            self.__contactlist[entity.bare][key] = value
            log.debug(_("Trying to update an unknown contact: %s") % entity.bare)

    def get_full(self, entity):
        return entity.bare + "/" + self.__contactlist[entity.bare]["resources"][-1]