changeset 2146:1bb9bf1b4150

core, frontends: getProfilesList renamed to profilesGetList + behaviour change: - profilesGetList now handles clients and components boolean arguments, to filter profiles - jp: added --clients and --components options to profile/list - profilesGetList now returns sorted profiles
author Goffi <goffi@goffi.org>
date Sun, 12 Feb 2017 19:08:52 +0100
parents 33c8c4973743
children bca699faf416
files frontends/src/bridge/dbus_bridge.py frontends/src/jp/cmd_profile.py frontends/src/primitivus/profile_manager.py frontends/src/quick_frontend/quick_profile_manager.py src/bridge/bridge_constructor/bridge_template.ini src/bridge/dbus_bridge.py src/core/sat_main.py src/memory/memory.py
diffstat 8 files changed, 79 insertions(+), 48 deletions(-) [+]
line wrap: on
line diff
--- a/frontends/src/bridge/dbus_bridge.py	Sun Feb 12 18:59:10 2017 +0100
+++ b/frontends/src/bridge/dbus_bridge.py	Sun Feb 12 19:08:52 2017 +0100
@@ -389,20 +389,6 @@
             kwargs['error_handler'] = error_handler
         return unicode(self.db_core_iface.getProfileName(profile_key, **kwargs))
 
-    def getProfilesList(self, callback=None, errback=None):
-        if callback is None:
-            error_handler = None
-        else:
-            if errback is None:
-                errback = log.error
-            error_handler = lambda err:errback(dbus_to_bridge_exception(err))
-        kwargs={}
-        if callback is not None:
-            kwargs['timeout'] = const_TIMEOUT
-            kwargs['reply_handler'] = callback
-            kwargs['error_handler'] = error_handler
-        return self.db_core_iface.getProfilesList(**kwargs)
-
     def getReady(self, callback=None, errback=None):
         if callback is None:
             error_handler = None
@@ -592,6 +578,20 @@
             error_handler = lambda err:errback(dbus_to_bridge_exception(err))
         return self.db_core_iface.profileStartSession(password, profile_key, timeout=const_TIMEOUT, reply_handler=callback, error_handler=error_handler)
 
+    def profilesListGet(self, clients=True, components=False, callback=None, errback=None):
+        if callback is None:
+            error_handler = None
+        else:
+            if errback is None:
+                errback = log.error
+            error_handler = lambda err:errback(dbus_to_bridge_exception(err))
+        kwargs={}
+        if callback is not None:
+            kwargs['timeout'] = const_TIMEOUT
+            kwargs['reply_handler'] = callback
+            kwargs['error_handler'] = error_handler
+        return self.db_core_iface.profilesListGet(clients, components, **kwargs)
+
     def progressGet(self, id, profile, callback=None, errback=None):
         if callback is None:
             error_handler = None
--- a/frontends/src/jp/cmd_profile.py	Sun Feb 12 18:59:10 2017 +0100
+++ b/frontends/src/jp/cmd_profile.py	Sun Feb 12 19:08:52 2017 +0100
@@ -35,7 +35,7 @@
     def __init__(self, host):
         # it's weird to have a command named "connect" with need_connect=False, but it can be handy to be able
         # to launch just the session, so some paradox don't hurt
-        super(ProfileConnect, self).__init__(host, 'connect', need_connect=False, help=_('connect a profile'))
+        super(ProfileConnect, self).__init__(host, 'connect', need_connect=False, help=(u'connect a profile'))
 
     def add_parser_options(self):
         pass
@@ -43,7 +43,7 @@
 
 class ProfileDefault(base.CommandBase):
     def __init__(self, host):
-        super(ProfileDefault, self).__init__(host, 'default', use_profile=False, help=_('print default profile'))
+        super(ProfileDefault, self).__init__(host, 'default', use_profile=False, help=(u'print default profile'))
 
     def add_parser_options(self):
         pass
@@ -54,14 +54,14 @@
 
 class ProfileDelete(base.CommandBase):
     def __init__(self, host):
-        super(ProfileDelete, self).__init__(host, 'delete', use_profile=False, help=_('delete a profile'))
+        super(ProfileDelete, self).__init__(host, 'delete', use_profile=False, help=(u'delete a profile'))
 
     def add_parser_options(self):
         self.parser.add_argument('profile', type=str, help=PROFILE_HELP)
         self.parser.add_argument('-f', '--force', action='store_true', help=_(u'delete profile without confirmation'))
 
     def start(self):
-        if self.args.profile not in self.host.bridge.getProfilesList():
+        if self.args.profile not in self.host.bridge.profilesListGet():
             log.error("Profile %s doesn't exist." % self.args.profile)
             self.host.quit(1)
         message = u"Are you sure to delete profile [{}] ?".format(self.args.profile)
@@ -76,7 +76,7 @@
 
 class ProfileInfo(base.CommandBase):
     def __init__(self, host):
-        super(ProfileInfo, self).__init__(host, 'info', need_connect=False, help=_('get information about a profile'))
+        super(ProfileInfo, self).__init__(host, 'info', need_connect=False, help=_(u'get information about a profile'))
         self.need_loop = True
         self.to_show = [(_(u"jid"), "Connection", "JabberID"),]
         self.largest = max([len(item[0]) for item in self.to_show])
@@ -105,25 +105,34 @@
 
 class ProfileList(base.CommandBase):
     def __init__(self, host):
-        super(ProfileList, self).__init__(host, 'list', use_profile=False, use_output='list', help=_('list profiles'))
+        super(ProfileList, self).__init__(host, 'list', use_profile=False, use_output='list', help=(u'list profiles'))
 
     def add_parser_options(self):
-        pass
+        group = self.parser.add_mutually_exclusive_group()
+        group.add_argument('-c', '--clients', action='store_true', help=_(u'the password of the profile'))
+        group.add_argument('-C', '--components', action='store_true', help=(u'the password of the profile'))
+
 
     def start(self):
-        self.output(self.host.bridge.getProfilesList())
+        if self.args.clients:
+            clients, components = True, False
+        elif self.args.components:
+            clients, components = False, True
+        else:
+            clients, components = True, True
+        self.output(self.host.bridge.profilesListGet(clients, components))
 
 
 class ProfileCreate(base.CommandBase):
     def __init__(self, host):
-        super(ProfileCreate, self).__init__(host, 'create', use_profile=False, help=_('create a new profile'))
+        super(ProfileCreate, self).__init__(host, 'create', use_profile=False, help=(u'create a new profile'))
         self.need_loop = True
 
     def add_parser_options(self):
-        self.parser.add_argument('profile', type=str, help=_('the name of the profile'))
-        self.parser.add_argument('-p', '--password', type=str, default='', help=_('the password of the profile'))
-        self.parser.add_argument('-j', '--jid', type=str, help=_('the jid of the profile'))
-        self.parser.add_argument('-x', '--xmpp-password', type=str, help=_('the password of the XMPP account (use profile password if not specified)'),
+        self.parser.add_argument('profile', type=str, help=(u'the name of the profile'))
+        self.parser.add_argument('-p', '--password', type=str, default='', help=(u'the password of the profile'))
+        self.parser.add_argument('-j', '--jid', type=str, help=(u'the jid of the profile'))
+        self.parser.add_argument('-x', '--xmpp-password', type=str, help=(u'the password of the XMPP account (use profile password if not specified)'),
                                  metavar='PASSWORD')
         self.parser.add_argument('-C', '--component', type=base.unicode_decoder, default='',
                                  help=_(u'set to component import name (entry point) if this is a component'))
@@ -141,7 +150,7 @@
 
     def start(self):
         """Create a new profile"""
-        if self.args.profile in self.host.bridge.getProfilesList():
+        if self.args.profile in self.host.bridge.profilesListGet():
             log.error("Profile %s already exists." % self.args.profile)
             self.host.quit(1)
         self.host.bridge.profileCreate(self.args.profile, self.args.password, self.args.component, callback=self._profile_created, errback=None)
@@ -149,14 +158,14 @@
 
 class ProfileModify(base.CommandBase):
     def __init__(self, host):
-        super(ProfileModify, self).__init__(host, 'modify', need_connect=False, help=_('modify an existing profile'))
+        super(ProfileModify, self).__init__(host, 'modify', need_connect=False, help=(u'modify an existing profile'))
 
     def add_parser_options(self):
         profile_pwd_group = self.parser.add_mutually_exclusive_group()
-        profile_pwd_group.add_argument('-w', '--password', type=base.unicode_decoder, help=_('change the password of the profile'))
-        profile_pwd_group.add_argument('--disable-password', action='store_true', help=_('disable profile password (dangerous!)'))
-        self.parser.add_argument('-j', '--jid', type=base.unicode_decoder, help=_('the jid of the profile'))
-        self.parser.add_argument('-x', '--xmpp-password', type=base.unicode_decoder, help=_('change the password of the XMPP account'),
+        profile_pwd_group.add_argument('-w', '--password', type=base.unicode_decoder, help=(u'change the password of the profile'))
+        profile_pwd_group.add_argument('--disable-password', action='store_true', help=(u'disable profile password (dangerous!)'))
+        self.parser.add_argument('-j', '--jid', type=base.unicode_decoder, help=(u'the jid of the profile'))
+        self.parser.add_argument('-x', '--xmpp-password', type=base.unicode_decoder, help=(u'change the password of the XMPP account'),
                                  metavar='PASSWORD')
         self.parser.add_argument('-D', '--default', action='store_true', help=_(u'set as default profile'))
 
@@ -177,4 +186,4 @@
     subcommands = (ProfileConnect, ProfileCreate, ProfileDefault, ProfileDelete, ProfileInfo, ProfileList, ProfileModify)
 
     def __init__(self, host):
-        super(Profile, self).__init__(host, 'profile', use_profile=False, help=_('Profile commands'))
+        super(Profile, self).__init__(host, 'profile', use_profile=False, help=(u'Profile commands'))
--- a/frontends/src/primitivus/profile_manager.py	Sun Feb 12 18:59:10 2017 +0100
+++ b/frontends/src/primitivus/profile_manager.py	Sun Feb 12 19:08:52 2017 +0100
@@ -37,7 +37,7 @@
         self.pass_wid = sat_widgets.Password(_('Password:'), align='center')
 
         style = ['no_first_select']
-        profiles = host.bridge.getProfilesList()
+        profiles = host.bridge.profilesListGet()
         profiles.sort()
         self.list_profile = sat_widgets.List(profiles, style=style, align='center', on_change=self.onProfileChange)
 
--- a/frontends/src/quick_frontend/quick_profile_manager.py	Sun Feb 12 18:59:10 2017 +0100
+++ b/frontends/src/quick_frontend/quick_profile_manager.py	Sun Feb 12 19:08:52 2017 +0100
@@ -202,7 +202,7 @@
 
     def refillProfiles(self):
         """Rebuild the list of profiles"""
-        profiles = self.host.bridge.getProfilesList()
+        profiles = self.host.bridge.profilesListGet()
         profiles.sort()
         self.setProfiles(profiles)
 
--- a/src/bridge/bridge_constructor/bridge_template.ini	Sun Feb 12 18:59:10 2017 +0100
+++ b/src/bridge/bridge_constructor/bridge_template.ini	Sun Feb 12 19:08:52 2017 +0100
@@ -197,12 +197,16 @@
 doc_param_0=%(doc_profile_key)s
 doc_return=Real profile name
 
-[getProfilesList]
+[profilesListGet]
 type=method
 category=core
-sig_in=
+sig_in=bb
 sig_out=as
-doc=Get all profiles
+param_0_default=True
+param_1_default=False
+doc_param_0=clients: get clients profiles
+doc_param_1=components: get components profiles
+doc=Get list of profiles
 
 [profileSetDefault]
 type=method
--- a/src/bridge/dbus_bridge.py	Sun Feb 12 18:59:10 2017 +0100
+++ b/src/bridge/dbus_bridge.py	Sun Feb 12 19:08:52 2017 +0100
@@ -324,12 +324,6 @@
         return self._callback("getProfileName", unicode(profile_key))
 
     @dbus.service.method(const_INT_PREFIX+const_CORE_SUFFIX,
-                         in_signature='', out_signature='as',
-                         async_callbacks=None)
-    def getProfilesList(self, ):
-        return self._callback("getProfilesList", )
-
-    @dbus.service.method(const_INT_PREFIX+const_CORE_SUFFIX,
                          in_signature='', out_signature='',
                          async_callbacks=('callback', 'errback'))
     def getReady(self, callback=None, errback=None):
@@ -426,6 +420,12 @@
         return self._callback("profileStartSession", unicode(password), unicode(profile_key), callback=callback, errback=errback)
 
     @dbus.service.method(const_INT_PREFIX+const_CORE_SUFFIX,
+                         in_signature='bb', out_signature='as',
+                         async_callbacks=None)
+    def profilesListGet(self, clients=True, components=False):
+        return self._callback("profilesListGet", clients, components)
+
+    @dbus.service.method(const_INT_PREFIX+const_CORE_SUFFIX,
                          in_signature='ss', out_signature='a{ss}',
                          async_callbacks=None)
     def progressGet(self, id, profile):
--- a/src/core/sat_main.py	Sun Feb 12 18:59:10 2017 +0100
+++ b/src/core/sat_main.py	Sun Feb 12 19:08:52 2017 +0100
@@ -76,7 +76,7 @@
         self.bridge.register_method("getVersion", lambda: self.full_version)
         self.bridge.register_method("getFeatures", self.getFeatures)
         self.bridge.register_method("getProfileName", self.memory.getProfileName)
-        self.bridge.register_method("getProfilesList", self.memory.getProfilesList)
+        self.bridge.register_method("profilesListGet", self.memory.getProfilesList)
         self.bridge.register_method("getEntityData", lambda jid_, keys, profile: self.memory.getEntityData(jid.JID(jid_), keys, profile))
         self.bridge.register_method("getEntitiesData", self.memory._getEntitiesData)
         self.bridge.register_method("profileCreate", self.memory.createProfile)
--- a/src/memory/memory.py	Sun Feb 12 18:59:10 2017 +0100
+++ b/src/memory/memory.py	Sun Feb 12 19:08:52 2017 +0100
@@ -430,8 +430,26 @@
         except KeyError:
             log.error(_(u"Trying to purge roster status cache for a profile not in memory: [%s]") % profile)
 
-    def getProfilesList(self):
-        return self.storage.getProfilesList()
+    def getProfilesList(self, clients=True, components=False):
+        """retrieve profiles list
+
+        @param clients(bool): if True return clients profiles
+        @param components(bool): if True return components profiles
+        @return (list[unicode]): selected profiles
+        """
+        if not clients and not components:
+            log.warning(_(u"requesting no profiles at all"))
+            return []
+        profiles = self.storage.getProfilesList()
+        if clients and components:
+            return sorted(profiles)
+        isComponent = self.storage.profileIsComponent
+        if clients:
+            p_filter = lambda p: not isComponent(p)
+        else:
+            p_filter = lambda p: isComponent(p)
+
+        return sorted(p for p in profiles if p_filter(p))
 
     def getProfileName(self, profile_key, return_profile_keys=False):
         """Return name of profile from keyword