libervia-backend: sat_frontends/jp/cmd

comparison sat_frontends/jp/cmd_roster.py @ 3040:fee60f17ebac

jp: jp asyncio port: /!\ this commit is huge. Jp is temporarily not working with `dbus` bridge /!\ This patch implements the port of jp to asyncio, so it is now correctly using the bridge asynchronously, and it can be used with bridges like `pb`. This also simplify the code, notably for things which were previously implemented with many callbacks (like pagination with RSM). During the process, some behaviours have been modified/fixed, in jp and backends, check diff for details.

author	Goffi <goffi@goffi.org>
date	Wed, 25 Sep 2019 08:56:41 +0200
parents	ab2696e34d29
children	9d0df638c8b4

comparison

equal deleted inserted replaced

-:a1bc34f90fa5
+:fee60f17ebac
 # 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 . import base
 from collections import OrderedDict
-from functools import partial
 from sat.core.i18n import _
 from sat_frontends.jp.constants import Const as C
-from twisted.words.protocols.jabber import jid
+from sat_frontends.tools import jid
+from sat.tools.common.ansi import ANSI as A
 __commands__ = ["Roster"]
+class Get(base.CommandBase):
-class Purge(base.CommandBase):
+def __init__(self, host):
-def __init__(self, host):
+super().__init__(
-super(Purge, self).__init__(host, 'purge', help=_('Purge the roster from its contacts with no subscription'))
+host, 'get', use_output=C.OUTPUT_DICT, use_verbose=True,
-self.need_loop = True
+extra_outputs = {"default": self.default_output},
+help=_('retrieve the roster entities'))
-def add_parser_options(self):
-self.parser.add_argument("--no_from", action="store_true", help=_("Also purge contacts with no 'from' subscription"))
+def add_parser_options(self):
-self.parser.add_argument("--no_to", action="store_true", help=_("Also purge contacts with no 'to' subscription"))
+pass
-def start(self):
+def default_output(self, data):
-self.host.bridge.getContacts(profile_key=self.host.profile, callback=self.gotContacts, errback=self.error)
+for contact_jid, contact_data in data.items():
+all_keys = list(contact_data.keys())
-def error(self, failure):
+keys_to_show = []
-print((_("Error while retrieving the contacts [%s]") % failure))
+name = contact_data.get('name', contact_jid.node)
-self.host.quit(1)
+if self.verbosity >= 1:
-def ask_confirmation(self, no_sub, no_from, no_to):
+keys_to_show.append('groups')
-"""Ask the confirmation before removing contacts.
+all_keys.remove('groups')
+if self.verbosity >= 2:
-@param no_sub (list[unicode]): list of contacts with no subscription
+keys_to_show.extend(all_keys)
-@param no_from (list[unicode]): list of contacts with no 'from' subscription
-@param no_to (list[unicode]): list of contacts with no 'to' subscription
+if name is None:
-@return bool
+self.disp(A.color(C.A_HEADER, contact_jid))
-"""
+else:
-if no_sub:
+self.disp(A.color(C.A_HEADER, name, A.RESET, f" ({contact_jid})"))
-print("There's no subscription between profile [%s] and the following contacts:" % self.host.profile)
+for k in keys_to_show:
-print("    " + "\n    ".join(no_sub))
+value = contact_data[k]
-if no_from:
+if value:
-print("There's no 'from' subscription between profile [%s] and the following contacts:" % self.host.profile)
+if isinstance(value, list):
-print("    " + "\n    ".join(no_from))
+value = ', '.join(value)
-if no_to:
+self.disp(A.color(
-print("There's no 'to' subscription between profile [%s] and the following contacts:" % self.host.profile)
+"    ", C.A_SUBHEADER, f"{k}: ", A.RESET, str(value)))
-print("    " + "\n    ".join(no_to))
-message = "REMOVE them from profile [%s]'s roster" % self.host.profile
+async def start(self):
-while True:
+try:
-res = input("%s (y/N)? " % message)
+contacts = await self.host.bridge.getContacts(profile_key=self.host.profile)
-if not res or res.lower() == 'n':
+except Exception as e:
-return False
+self.disp(f"error while retrieving the contacts: {e}", error=True)
-if res.lower() == 'y':
+self.host.quit(C.EXIT_BRIDGE_ERRBACK)
-return True
+contacts_dict = {}
-def gotContacts(self, contacts):
+for contact_jid_s, data, groups in contacts:
-"""Process the list of contacts.
+# FIXME: we have to convert string to bool here for historical reason
+#        getContacts format should be changed and serialised properly
-@param contacts(list[tuple]): list of contacts with their attributes and groups
+for key in ('from', 'to', 'ask'):
-"""
+if key in data:
-no_sub, no_from, no_to = [], [], []
+data[key] = C.bool(data[key])
-for contact, attrs, groups in contacts:
+data['groups'] = list(groups)
-from_, to = C.bool(attrs["from"]), C.bool(attrs["to"])
+contacts_dict[jid.JID(contact_jid_s)] = data
-if not from_:
-if not to:
+await self.output(contacts_dict)
-no_sub.append(contact)
-elif self.args.no_from:
-no_from.append(contact)
-elif not to and self.args.no_to:
-no_to.append(contact)
-if not no_sub and not no_from and not no_to:
-print("Nothing to do - there's a from and/or to subscription(s) between profile [%s] and each of its contacts" % self.host.profile)
-elif self.ask_confirmation(no_sub, no_from, no_to):
-for contact in no_sub + no_from + no_to:
-self.host.bridge.delContact(contact, profile_key=self.host.profile, callback=lambda __: None, errback=lambda failure: None)
 self.host.quit()
 class Stats(base.CommandBase):
 def __init__(self, host):
 super(Stats, self).__init__(host, 'stats', help=_('Show statistics about a roster'))
-self.need_loop = True
 def add_parser_options(self):
 pass
-def start(self):
+async def start(self):
-self.host.bridge.getContacts(profile_key=self.host.profile, callback=self.gotContacts, errback=self.error)
+try:
+contacts = await self.host.bridge.getContacts(profile_key=self.host.profile)
-def error(self, failure):
+except Exception as e:
-print((_("Error while retrieving the contacts [%s]") % failure))
+self.disp(f"error while retrieving the contacts: {e}", error=True)
-self.host.quit(1)
+self.host.quit(C.EXIT_BRIDGE_ERRBACK)
-def gotContacts(self, contacts):
-"""Process the list of contacts.
-@param contacts(list[tuple]): list of contacts with their attributes and groups
-"""
 hosts = {}
 unique_groups = set()
 no_sub, no_from, no_to, no_group, total_group_subscription = 0, 0, 0, 0, 0
 for contact, attrs, groups in contacts:
 from_, to = C.bool(attrs["from"]), C.bool(attrs["to"])
 no_sub += 1
 else:
 no_from += 1
 elif not to:
 no_to += 1
-host = jid.JID(contact).host
+host = jid.JID(contact).domain
 hosts.setdefault(host, 0)
 hosts[host] += 1
 if groups:
 unique_groups.update(groups)
 total_group_subscription += len(groups)
 print()
 print("Total number of contacts: %d" % len(contacts))
 print("Number of different hosts: %d" % len(hosts))
 print()
 for host, count in hosts.items():
-print("Contacts on {host}: {count} ({rate:.1f}%)".format(host=host, count=count, rate=100 * float(count) / len(contacts)))
+print("Contacts on {host}: {count} ({rate:.1f}%)".format(
+host=host, count=count, rate=100 * float(count) / len(contacts)))
 print()
 print("Contacts with no 'from' subscription: %d" % no_from)
 print("Contacts with no 'to' subscription: %d" % no_to)
 print("Contacts with no subscription at all: %d" % no_sub)
 print()
 print("Average contacts per group: {:.1f}".format(contacts_per_group))
 try:
 groups_per_contact = float(total_group_subscription) / len(contacts)
 except ZeroDivisionError:
 groups_per_contact = 0
-print("Average groups' subscriptions per contact: {:.1f}".format(groups_per_contact))
+print(f"Average groups' subscriptions per contact: {groups_per_contact:.1f}")
 print("Contacts not assigned to any group: %d" % no_group)
 self.host.quit()
-class Get(base.CommandBase):
+class Purge(base.CommandBase):
 def __init__(self, host):
-super(Get, self).__init__(host, 'get', help=_('Retrieve the roster contacts'))
+super(Purge, self).__init__(
-self.need_loop = True
+host, 'purge',
+help=_('purge the roster from its contacts with no subscription'))
-def add_parser_options(self):
-self.parser.add_argument("--subscriptions", action="store_true", help=_("Show the contacts' subscriptions"))
+def add_parser_options(self):
-self.parser.add_argument("--groups", action="store_true", help=_("Show the contacts' groups"))
+self.parser.add_argument(
-self.parser.add_argument("--name", action="store_true", help=_("Show the contacts' names"))
+"--no_from", action="store_true",
+help=_("also purge contacts with no 'from' subscription"))
-def start(self):
+self.parser.add_argument(
-self.host.bridge.getContacts(profile_key=self.host.profile, callback=self.gotContacts, errback=self.error)
+"--no_to", action="store_true",
+help=_("also purge contacts with no 'to' subscription"))
-def error(self, failure):
-print((_("Error while retrieving the contacts [%s]") % failure))
+async def start(self):
-self.host.quit(1)
+try:
+contacts = await self.host.bridge.getContacts(self.host.profile)
-def gotContacts(self, contacts):
+except Exception as e:
-"""Process the list of contacts.
+self.disp(f"error while retrieving the contacts: {e}", error=True)
+self.host.quit(C.EXIT_BRIDGE_ERRBACK)
-@param contacts(list[tuple]): list of contacts with their attributes and groups
+no_sub, no_from, no_to = [], [], []
+for contact, attrs, groups in contacts:
+from_, to = C.bool(attrs["from"]), C.bool(attrs["to"])
+if not from_:
+if not to:
+no_sub.append(contact)
+elif self.args.no_from:
+no_from.append(contact)
+elif not to and self.args.no_to:
+no_to.append(contact)
+if not no_sub and not no_from and not no_to:
+self.disp(
+f"Nothing to do - there's a from and/or to subscription(s) between "
+f"profile {self.host.profile!r} and each of its contacts"
+)
+elif await self.ask_confirmation(no_sub, no_from, no_to):
+for contact in no_sub + no_from + no_to:
+try:
+await self.host.bridge.delContact(
+contact, profile_key=self.host.profile)
+except Exception as e:
+self.disp(f"can't delete contact {contact!r}: {e}", error=True)
+else:
+self.disp(f"contact {contact!r} has been removed")
+self.host.quit()
+async def ask_confirmation(self, no_sub, no_from, no_to):
+"""Ask the confirmation before removing contacts.
+@param no_sub (list[unicode]): list of contacts with no subscription
+@param no_from (list[unicode]): list of contacts with no 'from' subscription
+@param no_to (list[unicode]): list of contacts with no 'to' subscription
+@return bool
 """
-field_count = 1  # only display the contact by default
+if no_sub:
-if self.args.subscriptions:
+self.disp(
-field_count += 3  # ask, from, to
+f"There's no subscription between profile {self.host.profile!r} and the "
-if self.args.name:
+f"following contacts:")
-field_count += 1
+self.disp("    " + "\n    ".join(no_sub))
-if self.args.groups:
+if no_from:
-field_count += 1
+self.disp(
-for contact, attrs, groups in contacts:
+f"There's no 'from' subscription between profile {self.host.profile!r} "
-args = [contact]
+f"and the following contacts:")
-if self.args.subscriptions:
+self.disp("    " + "\n    ".join(no_from))
-args.append("ask" if C.bool(attrs["ask"]) else "")
+if no_to:
-args.append("from" if C.bool(attrs["from"]) else "")
+self.disp(
-args.append("to" if C.bool(attrs["to"]) else "")
+f"There's no 'to' subscription between profile {self.host.profile!r} and "
-if self.args.name:
+f"the following contacts:")
-args.append(str(attrs.get("name", "")))
+self.disp("    " + "\n    ".join(no_to))
-if self.args.groups:
+message = f"REMOVE them from profile {self.host.profile}'s roster"
-args.append("\t".join(groups) if groups else "")
+while True:
-print(";".join(["{}"] * field_count).format(*args).encode("utf-8"))
+res = await self.host.ainput(f"{message} (y/N)? ")
-self.host.quit()
+if not res or res.lower() == 'n':
+return False
+if res.lower() == 'y':
+return True
 class Resync(base.CommandBase):
 def __init__(self, host):
 super(Resync, self).__init__(
 host, 'resync', help=_('do a full resynchronisation of roster with server'))
-self.need_loop = True
 def add_parser_options(self):
 pass
-def rosterResyncCb(self):
+async def start(self):
-self.disp(_("Roster resynchronized"))
+try:
-self.host.quit(C.EXIT_OK)
+await self.host.bridge.rosterResync(profile_key=self.host.profile)
+except Exception as e:
-def start(self):
+self.disp(f"can't resynchronise roster: {e}", error=True)
-self.host.bridge.rosterResync(profile_key=self.host.profile,
+self.host.quit(C.EXIT_BRIDGE_ERRBACK)
-callback=self.rosterResyncCb,
+else:
-errback=partial(
+self.disp(_("Roster resynchronized"))
-self.errback,
+self.host.quit(C.EXIT_OK)
-msg=_("can't resynchronise roster: {}"),
-exit_code=C.EXIT_BRIDGE_ERRBACK,
-))
 class Roster(base.CommandBase):
 subcommands = (Get, Stats, Purge, Resync)
 def __init__(self, host):
-super(Roster, self).__init__(host, 'roster', use_profile=True, help=_("Manage an entity's roster"))
+super(Roster, self).__init__(
+host, 'roster', use_profile=True, help=_("Manage an entity's roster"))

Mercurial > libervia-backend

comparison sat_frontends/jp/cmd_roster.py @ 3040:fee60f17ebac