Mercurial > libervia-backend
diff libervia/frontends/quick_frontend/quick_contact_management.py @ 4074:26b7ed2817da
refactoring: rename `sat_frontends` to `libervia.frontends`
author | Goffi <goffi@goffi.org> |
---|---|
date | Fri, 02 Jun 2023 14:12:38 +0200 |
parents | sat_frontends/quick_frontend/quick_contact_management.py@4b842c1fb686 |
children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/libervia/frontends/quick_frontend/quick_contact_management.py Fri Jun 02 14:12:38 2023 +0200 @@ -0,0 +1,104 @@ +#!/usr/bin/env python3 + + +# helper class for making a SAT frontend +# Copyright (C) 2009-2021 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/>. + +from libervia.backend.core.i18n import _ +from libervia.backend.core.log import getLogger + +log = getLogger(__name__) +from libervia.frontends.tools.jid 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""" + self.__contactlist.clear() + + 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: + return + if entity.resource in self.__contactlist[entity.bare]["resources"]: + self.__contactlist[entity.bare]["resources"].remove(entity.resource) + self.__contactlist[entity.bare]["resources"].append(entity.resource) + + def get_cont_from_group(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"]: + result.append(JID(contact)) + return result + + def get_attr(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] + else: + log.debug(_("Trying to get attribute for an unknown contact")) + return None + + def is_connected(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""" + try: + if entity.resource: + self.__contactlist[entity.bare]["resources"].remove(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")) + raise + + 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 + else: + 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]