changeset 971:8ca5c990ed92

jp: "disco" subcommand, moved into a new "info" subcommand + added "version" subcommand which get software version
author Goffi <goffi@goffi.org>
date Wed, 02 Apr 2014 12:31:15 +0200
parents 2e052998c7eb
children 07b817f5a197
files frontends/src/jp/base.py frontends/src/jp/cmd_disco.py frontends/src/jp/cmd_info.py src/core/constants.py src/plugins/plugin_xep_0092.py
diffstat 5 files changed, 136 insertions(+), 82 deletions(-) [+]
line wrap: on
line diff
--- a/frontends/src/jp/base.py	Wed Apr 02 12:11:07 2014 +0200
+++ b/frontends/src/jp/base.py	Wed Apr 02 12:31:15 2014 +0200
@@ -223,8 +223,8 @@
         """
         # FIXME: need better exit codes
 
-        def cant_connect():
-            error(_(u"Can't connect profile"))
+        def cant_connect(failure):
+            error(_(u"Can't connect profile [%s]") % failure)
             self.quit(1)
 
         self.profile = self.bridge.getProfileName(self.args.profile)
--- a/frontends/src/jp/cmd_disco.py	Wed Apr 02 12:11:07 2014 +0200
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,78 +0,0 @@
-#! /usr/bin/python
-# -*- coding: utf-8 -*-
-
-# jp: a SAT command line tool
-# Copyright (C) 2009, 2010, 2011, 2012, 2013, 2014 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 logging import debug, info, error, warning
-
-import base
-from sat.core.i18n import _
-
-__commands__ = ["Disco"]
-
-class Disco(base.CommandBase):
-
-    def __init__(self, host):
-        super(Disco, self).__init__(host, 'disco', help=_('Service discovery'))
-
-    def add_parser_options(self):
-        self.parser.add_argument("jid", type=str, help=_("Entity to discover"))
-
-    def connected(self):
-        super(Disco, self).connected()
-        self.need_loop=True
-        jids = self.host.check_jids([self.args.jid])
-        jid = jids[0]
-        self.host.bridge.discoInfos(jid, profile_key=self.host.profile, callback=lambda infos: self.gotInfos(infos, jid), errback=lambda ignore: ignore)
-
-    def gotInfos(self, infos, jid):
-        self.host.bridge.discoItems(jid, profile_key=self.host.profile, callback=lambda items: self.gotItems(infos, items), errback=lambda ignore: ignore)
-
-    def gotItems(self, infos, items):
-        features, identities = infos
-        features.sort()
-        identities.sort(key=lambda identity: identity[2])
-        items.sort(key=lambda item: item[2])
-        identities_lst = []
-        items_lst = []
-        for identity in identities:
-            category, type_, name = identity
-            identities_lst.append(u"%(name)s(%(cat)s/%(type)s)" %
-                                 {'name': (name+' ') if name else '',
-                                  'cat': category,
-                                  'type': type_})
-        for item in items:
-            entity, node_id, name = item
-            items_lst.append(u"%(name)s[%(entity)s%(node_id)s]" %
-                                 {'name': (name+' ') if name else '',
-                                  'entity': entity,
-                                  'node_id': (', ' + node_id) if node_id else ''
-                                 })
-
-        template = []
-        if features:
-            template.append(_(u"Features:\n\n%(features)s"))
-        if identities:
-            template.append(_(u"Identities:\n\n%(identities)s"))
-        if items:
-            template.append(_(u"Items:\n\n%(items)s"))
-
-        print "\n--\n".join(template) % { 'features': '\n'.join(features),
-                                          'identities': '\n'.join(identities_lst),
-                                          'items': '\n'.join(items_lst),
-                                        }
-        self.host.quit()
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/frontends/src/jp/cmd_info.py	Wed Apr 02 12:31:15 2014 +0200
@@ -0,0 +1,123 @@
+#! /usr/bin/python
+# -*- coding: utf-8 -*-
+
+# jp: a SAT command line tool
+# Copyright (C) 2009, 2010, 2011, 2012, 2013, 2014 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 logging import debug, info, error, warning
+
+import base
+from sat.core.i18n import _
+
+__commands__ = ["Info"]
+
+
+class Disco(base.CommandBase):
+
+    def __init__(self, host):
+        super(Disco, self).__init__(host, 'disco', help=_('Service discovery'))
+
+    def add_parser_options(self):
+        self.parser.add_argument("jid", type=str, help=_("Entity to discover"))
+
+    def connected(self):
+        super(Disco, self).connected()
+        self.need_loop=True
+        jids = self.host.check_jids([self.args.jid])
+        jid = jids[0]
+        self.host.bridge.discoInfos(jid, profile_key=self.host.profile, callback=lambda infos: self.gotInfos(infos, jid), errback=self.error)
+
+    def error(self, failure):
+        print (_("Error while doing discovery"))
+        self.host.quit(1)
+
+    def gotInfos(self, infos, jid):
+        self.host.bridge.discoItems(jid, profile_key=self.host.profile, callback=lambda items: self.gotItems(infos, items), errback=self.error)
+
+    def gotItems(self, infos, items):
+        features, identities = infos
+        features.sort()
+        identities.sort(key=lambda identity: identity[2])
+        items.sort(key=lambda item: item[2])
+        identities_lst = []
+        items_lst = []
+        for identity in identities:
+            category, type_, name = identity
+            identities_lst.append(u"%(name)s(%(cat)s/%(type)s)" %
+                                 {'name': (name+' ') if name else '',
+                                  'cat': category,
+                                  'type': type_})
+        for item in items:
+            entity, node_id, name = item
+            items_lst.append(u"%(name)s[%(entity)s%(node_id)s]" %
+                                 {'name': (name+' ') if name else '',
+                                  'entity': entity,
+                                  'node_id': (', ' + node_id) if node_id else ''
+                                 })
+
+        template = []
+        if features:
+            template.append(_(u"Features:\n\n%(features)s"))
+        if identities:
+            template.append(_(u"Identities:\n\n%(identities)s"))
+        if items:
+            template.append(_(u"Items:\n\n%(items)s"))
+
+        print "\n--\n".join(template) % { 'features': '\n'.join(features),
+                                          'identities': '\n'.join(identities_lst),
+                                          'items': '\n'.join(items_lst),
+                                        }
+        self.host.quit()
+
+
+class Version(base.CommandBase):
+
+    def __init__(self, host):
+        super(Version, self).__init__(host, 'version', help=_('Client version'))
+
+    def add_parser_options(self):
+        self.parser.add_argument("jid", type=str, help=_("Entity to request"))
+
+    def connected(self):
+        self.need_loop=True
+        super(Version, self).connected()
+        jids = self.host.check_jids([self.args.jid])
+        jid = jids[0]
+        self.host.bridge.getSoftwareVersion(jid, self.host.profile, callback=self.gotVersion, errback=self.error)
+
+    def error(self, failure):
+        print (_("Error while trying to get version [%s]") % failure)
+        self.host.quit(1)
+
+    def gotVersion(self, data):
+        infos = []
+        name, version, os = data
+        if name:
+            infos.append(_("Client name: %s") %  name)
+        if version:
+            infos.append(_("Client version: %s") %  version)
+        if os:
+            infos.append(_("Operating System: %s") %  os)
+
+        print "\n".join(infos)
+        self.host.quit()
+
+
+class Info(base.CommandBase):
+    subcommands = (Disco, Version)
+
+    def __init__(self, host):
+        super(Info, self).__init__(host, 'info', use_profile=False, help=_('Get various informations on entities'))
--- a/src/core/constants.py	Wed Apr 02 12:11:07 2014 +0200
+++ b/src/core/constants.py	Wed Apr 02 12:31:15 2014 +0200
@@ -72,7 +72,6 @@
     # names of widely used plugins
     TEXT_CMDS = 'TEXT-COMMANDS'
 
-
     ## Misc ##
     SAVEFILE_DATABASE = "sat.db"
     IQ_SET = '/iq[@type="set"]'
--- a/src/plugins/plugin_xep_0092.py	Wed Apr 02 12:11:07 2014 +0200
+++ b/src/plugins/plugin_xep_0092.py	Wed Apr 02 12:31:15 2014 +0200
@@ -20,6 +20,7 @@
 from sat.core.i18n import _
 from sat.core.constants import Const as C
 from twisted.internet import reactor, defer
+from twisted.words.protocols.jabber import jid
 from wokkel import compat
 from sat.core import exceptions
 from logging import debug, info, warning, error
@@ -45,16 +46,25 @@
     def __init__(self, host):
         info(_("Plugin XEP_0092 initialization"))
         self.host = host
+        host.bridge.addMethod("getSoftwareVersion", ".plugin", in_sign='ss', out_sign='(sss)', method=self._getVersion, async=True)
         try:
             self.host.plugins[C.TEXT_CMDS].addWhoIsCb(self._whois, 50)
         except KeyError:
             info(_("Text commands not available"))
 
+    def _getVersion(self, entity_jid_s, profile_key):
+        def prepareForBridge(data):
+            name, version, os = data
+            return (name or '', version or '', os or '')
+        d = self.getVersion(jid.JID(entity_jid_s), profile_key)
+        d.addCallback(prepareForBridge)
+        return d
+
     def getVersion(self, jid_, profile_key=C.PROF_KEY_NONE):
         """ Ask version of the client that jid_ is running
         @param jid_: jid from who we want to know client's version
         @param profile_key: %(doc_profile_key)s
-        @return: a defered which fire tuple with the following data (None if not available):
+        @return (tuple): a defered which fire a tuple with the following data (None if not available):
                  - name: Natural language name of the software
                  - version: specific version of the software
                  - os: operating system of the queried entity