Merge lp:~mvo/command-not-found/snap-support into lp:command-not-found

[Michael Vogt]

This is a first preview for snap support in command-not-found. The idea is that snapd will populate /usr/share/command-not-found/snaps.d/all-main.db for command-not-found to consume.

[Brian Murray (brian-murray)]

I believe this landed in Bionic.

command-not-found (0.3ubuntu18.04.0~pre3) bionic; urgency=medium

  * CommandNotFound/CommandNotFound.py:
    - limit input to 256 chars to avoid DoS (LP: #1605732)
    - add support for suggesting commands snap from snaps
      (needs snapd 2.31+ to work)
    - add "snapd" to suggests

 -- Michael Vogt <email address hidden> Thu, 15 Feb 2018 09:15:40 +0100

[Brian Murray (brian-murray)]

I'm setting this to merged to take it off the sponsorship list. Feel free to flip it back if I'm wrong.

=== modified file 'CommandNotFound/CommandNotFound.py'
--- CommandNotFound/CommandNotFound.py	2017-12-21 10:34:37 +0000
+++ CommandNotFound/CommandNotFound.py	2017-12-21 11:57:34 +0000
@@ -41,45 +41,39 @@
             key = key.encode('utf-8', 'xmlcharrefreplace')
         if self.db and key in self.db:
             return self.db[key].decode('utf-8')
-        else:
-            return None
+        return None
 
 
 class FlatDatabase(object):
 
     def __init__(self, filename):
-        self.rows = []
+        self.cmd_to_pkgs = {}
         with open(filename) as dbfile:
-            for line in (line.strip() for line in dbfile):
-                self.rows.append(line.split("|"))
-
-    def lookup(self, column, text):
-        result = []
-        for row in self.rows:
-            if row[column] == text:
-                result.append(row)
-        return result
-
-    def createColumnByCallback(self, cb, column):
-        for row in self.rows:
-            row.append(cb(row[column]))
-
-    def lookupWithCallback(self, column, cb, text):
-        result = []
-        for row in self.rows:
-            if cb(row[column], text):
-                result.append(row)
-        return result
+            for line in dbfile:
+                line = line.strip()
+                cmd, pkgs = line.split(":", 2)
+                self.cmd_to_pkgs[cmd] = pkgs
+
+    def lookup(self, key):
+        if key in self.cmd_to_pkgs:
+            return self.cmd_to_pkgs[key]
+        return None
 
 
 class ProgramDatabase(object):
 
     (PACKAGE, BASENAME_PATH) = range(2)
 
-    def __init__(self, filename):
+    def __init__(self, filename, pkgmanager):
+        if filename.endswith(".db"):
+            self.db = BinaryDatabase(filename)
+        elif filename.endswith(".txt"):
+            self.db = FlatDatabase(filename)
+        else:
+            raise Exception("unsupported database %s" % filename)
+        self.pkgmanager = pkgmanager
         basename = os.path.basename(filename)
-        (self.arch, self.component) = basename.split(".")[0].split("-")
-        self.db = BinaryDatabase(filename)
+        self.arch, self.component = basename.split(".")[0].split("-")
 
     def lookup(self, command):
         result = self.db.lookup(command)
@@ -107,6 +101,7 @@
 class CommandNotFound(object):
 
     programs_dir = "programs.d"
+    snaps_dir = "snaps.d"
 
     prefixes = (
         "/bin",
@@ -128,8 +123,10 @@
                            'non-free', 'multiverse']
         self.components.reverse()
         self.sources_list = self._getSourcesList()
-        for filename in os.listdir(os.path.sep.join([data_dir, self.programs_dir])):
-            self.programs.append(ProgramDatabase(os.path.sep.join([data_dir, self.programs_dir, filename])))
+        for filename in os.listdir(os.path.join(data_dir, self.programs_dir)):
+            self.programs.append(ProgramDatabase(os.path.join(data_dir, self.programs_dir, filename), "apt"))
+        for fn in os.listdir(os.path.join(data_dir, self.snaps_dir)):
+            self.programs.append(ProgramDatabase(os.path.join(data_dir, self.snaps_dir, fn), "snap"))
         try:
             self.user_can_sudo = grp.getgrnam("sudo")[2] in posix.getgroups() or grp.getgrnam("admin")[2] in posix.getgroups()
         except KeyError:
@@ -141,7 +138,7 @@
             return
         possible_alternatives = []
         for w in similar_words(word):
-            packages = self.getPackages(w)
+            packages = self.get_packages(w)
             for (package, comp) in packages:
                 possible_alternatives.append((w, package, comp))
         if len(possible_alternatives) > max_alt:
@@ -151,9 +148,11 @@
             for (w, p, c) in possible_alternatives:
                 print(_(" Command '%s' from package '%s' (%s)") % (w, p, c), file=sys.stderr)
 
-    def getPackages(self, command):
+    def get_packages(self, command, pkgmanager):
         result = set()
         for db in self.programs:
+            if db.pkgmanager != pkgmanager:
+                continue
             result.update([(pkg, db.component) for pkg in db.lookup(command)])
         return list(result)
 
@@ -263,35 +262,57 @@
 
         if command in self.getBlacklist():
             return False
-        packages = self.getPackages(command)
-        if len(packages) == 0:
+        
+        packages_apt = self.get_packages(command, "apt")
+        packages_snap = self.get_packages(command, "snap")
+        if len(packages_apt) == 0 and len(packages_snap) == 0:
             self.print_spelling_suggestion(command)
-        elif len(packages) == 1:
+            return
+        self.advice_on_apt(command, packages_apt)
+        # advice on snaps as well
+        if len(packages_snap) > 0:
+            pkgmanager="snap"
+            print()
+            print(_("It is also available as a snap package:"))
+            for package in packages_snap:
+                print(" * %s" % package[0])
+            if posix.geteuid() == 0:
+                print(_("Try: %s <selected package>") % "%s install" % pkgmanager, file=sys.stderr)
+            elif self.user_can_sudo:
+                print(_("Try: %s <selected package>") % "sudo %s install" % pkgmanager, file=sys.stderr)
+            else:
+                print(_("Ask your administrator to install one of them"), file=sys.stderr)
+        return len(packages_apt) + len(packages_snap)
+
+    def advice_on_apt(self, command, packages):
+        pkgmanager = "apt"
+        if len(packages) == 1:
             print(_("The program '%s' is currently not installed. ") % command, end="", file=sys.stderr)
             if posix.geteuid() == 0:
                 print(_("You can install it by typing:"), file=sys.stderr)
-                print("apt install %s" % packages[0][0], file=sys.stderr)
+                print("%s install %s" % (packages[0][0], pkgmanager), file=sys.stderr)
                 self.install_prompt(packages[0][0])
             elif self.user_can_sudo:
                 print(_("You can install it by typing:"), file=sys.stderr)
-                print("sudo apt install %s" % packages[0][0], file=sys.stderr)
+                print("sudo %s install %s" % (pkgmanager, packages[0][0]), file=sys.stderr)
                 self.install_prompt(packages[0][0])
             else:
-                print(_("To run '%(command)s' please ask your administrator to install the package '%(package)s'") % {'command': command, 'package': packages[0][0]}, file=sys.stderr)
+                print(_("To run '%(command)s' please ask your administrator to install the %(pkgmanager)s package '%(package)s'") % {'command': command, 'package': packages[0][0], 'pkgmanager': pkgmanager}, file=sys.stderr)
             if not packages[0][1] in self.sources_list:
                 print(_("You will have to enable the component called '%s'") % packages[0][1], file=sys.stderr)
         elif len(packages) > 1:
             packages.sort(key=cmp_to_key(self.sortByComponent))
             print(_("The program '%s' can be found in the following packages:") % command, file=sys.stderr)
+            # FIXME: deal with mixed apt/snap results
             for package in packages:
                 if package[1] in self.sources_list:
                     print(" * %s" % package[0], file=sys.stderr)
                 else:
                     print(" * %s" % package[0] + " (" + _("You will have to enable component called '%s'") % package[1] + ")", file=sys.stderr)
             if posix.geteuid() == 0:
-                print(_("Try: %s <selected package>") % "apt install", file=sys.stderr)
+                print(_("Try: %s <selected package>") % "%s install" % pkgmanager, file=sys.stderr)
             elif self.user_can_sudo:
-                print(_("Try: %s <selected package>") % "sudo apt install", file=sys.stderr)
+                print(_("Try: %s <selected package>") % "sudo %s install" % pkgmanager, file=sys.stderr)
             else:
                 print(_("Ask your administrator to install one of them"), file=sys.stderr)
         return len(packages) > 0

=== modified file 'command-not-found'
--- command-not-found	2016-06-17 14:51:57 +0000
+++ command-not-found	2017-12-21 11:57:34 +0000
@@ -25,7 +25,7 @@
     from optparse import OptionParser
 
     from CommandNotFound.util import crash_guard
-    from CommandNotFound import CommandNotFound
+    from CommandNotFound.CommandNotFound import CommandNotFound
 except KeyboardInterrupt:
     import sys
     sys.exit(127)

=== modified file 'debian/dirs'
--- debian/dirs	2017-08-30 13:32:56 +0000
+++ debian/dirs	2017-12-21 11:57:34 +0000
@@ -1,1 +1,3 @@
 usr/bin
+usr/share/command-not-found/programs.d
+usr/share/command-not-found/snaps.d