wrappers: allow snaps to install icon theme icons

dirs/dirs.go

@@ -87,6 +87,7 @@ var (
 	SnapServicesDir     string
 	SnapSystemdConfDir  string
 	SnapDesktopFilesDir string
+	SnapDesktopIconsDir string
 	SnapBusPolicyDir    string
 
 	SystemApparmorDir      string
@@ -232,6 +233,7 @@ func SetRootDir(rootdir string) {
 	SnapMetaDir = filepath.Join(rootdir, snappyDir, "meta")
 	SnapBlobDir = filepath.Join(rootdir, snappyDir, "snaps")
 	SnapDesktopFilesDir = filepath.Join(rootdir, snappyDir, "desktop", "applications")
+	SnapDesktopIconsDir = filepath.Join(rootdir, snappyDir, "desktop", "icons")
 	SnapRunDir = filepath.Join(rootdir, "/run/snapd")
 	SnapRunNsDir = filepath.Join(SnapRunDir, "/ns")
 	SnapRunLockDir = filepath.Join(SnapRunDir, "/lock")

overlord/snapstate/backend/link.go

@@ -170,6 +170,13 @@ func generateWrappers(s *snap.Info) error {
 		wrappers.RemoveSnapBinaries(s)
 		return err
 	}
+	// add the desktop icons
+	if err := wrappers.AddSnapIcons(s); err != nil {
+		wrappers.RemoveSnapDesktopFiles(s)
+		wrappers.RemoveSnapServices(s, progress.Null)
+		wrappers.RemoveSnapBinaries(s)
+		return err
+	}
 
 	return nil
 }
@@ -190,7 +197,12 @@ func removeGeneratedWrappers(s *snap.Info, meter progress.Meter) error {
 		logger.Noticef("Cannot remove desktop files for %q: %v", s.InstanceName(), err3)
 	}
 
-	return firstErr(err1, err2, err3)
+	err4 := wrappers.RemoveSnapIcons(s)
+	if err4 != nil {
+		logger.Noticef("Cannot remove desktop icons for %q: %v", s.InstanceName(), err4)
+	}
+
+	return firstErr(err1, err2, err3, err4)
 }
 
 // UnlinkSnap makes the snap unavailable to the system removing wrappers and symlinks.

tests/lib/snaps/test-snapd-icon-theme/bin/echo

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+echo "From test-snapd-icon-theme snap"

tests/lib/snaps/test-snapd-icon-theme/meta/gui/echo.desktop

@@ -0,0 +1,5 @@
+[Desktop Entry]
+Type=Application
+Name=Echo
+Exec=test-snapd-icon-theme.echo
+Icon=snap.test-snapd-icon-theme.foo

tests/lib/snaps/test-snapd-icon-theme/meta/snap.yaml

@@ -0,0 +1,6 @@
+name: test-snapd-icon-theme
+version: 1.0
+
+apps:
+    echo:
+        command: bin/echo

tests/main/parallel-install-snap-icons/task.yaml

@@ -0,0 +1,37 @@
+summary: Parallel installed snaps have non-conflicting icons
+
+restore: |
+    snap set system experimental.parallel-instances=null
+
+execute: |
+    #shellcheck source=tests/lib/snaps.sh
+    . "$TESTSLIB"/snaps.sh
+
+    echo "Install a snap providing icons"
+    install_local test-snapd-icon-theme
+
+    echo "Install additional instances of the snap"
+    snap set system experimental.parallel-instances=true
+    install_local_as test-snapd-icon-theme test-snapd-icon-theme_longname
+    install_local_as test-snapd-icon-theme test-snapd-icon-theme_foo
+
+    echo "Each instance provides its own icons"
+    icondir=/var/lib/snapd/desktop/icons/hicolor/scalable/apps
+    [ -f "$icondir/snap.test-snapd-icon-theme.foo.svg" ]
+    [ -f "$icondir/snap.test-snapd-icon-theme_longname.foo.svg" ]
+    [ -f "$icondir/snap.test-snapd-icon-theme_foo.foo.svg" ]
+
+    echo "Each instance's desktop file references its own icon"
+    desktopdir=/var/lib/snapd/desktop/applications
+    MATCH '^Icon=snap.test-snapd-icon-theme.foo$' < "$desktopdir/test-snapd-icon-theme_echo.desktop"
+    MATCH '^Icon=snap.test-snapd-icon-theme_longname.foo$' < "$desktopdir/test-snapd-icon-theme+longname_echo.desktop"
+    MATCH '^Icon=snap.test-snapd-icon-theme_foo.foo$' < "$desktopdir/test-snapd-icon-theme+foo_echo.desktop"
+
+    echo "Removing once instance does not remove the other instances' icons"
+    snap remove test-snapd-icon-theme_foo
+    [ -f "$icondir/snap.test-snapd-icon-theme.foo.svg" ]
+    [ -f "$icondir/snap.test-snapd-icon-theme_longname.foo.svg" ]
+    [ ! -f "$icondir/snap.test-snapd-icon-theme_foo.foo.svg" ]
+
+    snap remove test-snapd-icon-theme
+    [ -f "$icondir/snap.test-snapd-icon-theme_longname.foo.svg" ]

tests/main/snap-icons/task.yaml

@@ -0,0 +1,29 @@
+summary: Snaps can install icon theme icons
+
+execute: |
+    #shellcheck source=tests/lib/snaps.sh
+    . "$TESTSLIB"/snaps.sh
+
+    echo "Install a snap providing icons"
+    install_local test-snapd-icon-theme
+
+    echo "Icons provided by the snap are installed to a shared location"
+    iconfile=/var/lib/snapd/desktop/icons/hicolor/scalable/apps/snap.test-snapd-icon-theme.foo.svg
+    [ -f "$iconfile" ]
+    MATCH "icon from test-snapd-icon-theme" < "$iconfile"
+
+    echo "Desktop files can reference installed icons"
+    desktopfile=/var/lib/snapd/desktop/applications/test-snapd-icon-theme_echo.desktop
+    MATCH '^Icon=snap.test-snapd-icon-theme.foo$' < "$desktopfile"
+
+    echo "Remove the snap"
+    snap remove test-snapd-icon-theme
+
+    echo "The icon has been removed"
+    [ ! -f "$iconfile" ]
+
+    echo "The empty icon theme subdirectories have also been removed"
+    [ ! -d /var/lib/snapd/desktop/icons/hicolor ]
+
+    echo "But the base icons directory remains"
+    [ -d /var/lib/snapd/desktop/icons ]

wrappers/desktop.go

@@ -142,6 +142,30 @@ func rewriteExecLine(s *snap.Info, desktopFile, line string) (string, error) {
 	return "", fmt.Errorf("invalid exec command: %q", cmd)
 }
 
+func rewriteIconLine(s *snap.Info, line string) (string, error) {
+	icon := strings.SplitN(line, "=", 2)[1]
+
+	// If there is a path separator, assume the icon is a path name
+	if strings.ContainsRune(icon, filepath.Separator) {
+		return line, nil
+	}
+
+	// If the icon is prefixed with "snap.${SNAP_NAME}.", rewrite
+	// to the instance name.
+	snapIconPrefix := fmt.Sprintf("snap.%s.", s.SnapName())
+	if strings.HasPrefix(icon, snapIconPrefix) {
+		return fmt.Sprintf("Icon=snap.%s.%s", s.InstanceName(), icon[len(snapIconPrefix):]), nil
+	}
+
+	// If the icon has any other "snap." prefix, treat this as an error.
+	if strings.HasPrefix(icon, "snap.") {
+		return "", fmt.Errorf("invalid icon name: %q", icon)
+	}
+
+	// Allow other icons names through unchanged.
+	return line, nil
+}
+
 func sanitizeDesktopFile(s *snap.Info, desktopFile string, rawcontent []byte) []byte {
 	var newContent bytes.Buffer
 	mountDir := []byte(s.MountDir())
@@ -165,6 +189,16 @@ func sanitizeDesktopFile(s *snap.Info, desktopFile string, rawcontent []byte) []
 			bline = []byte(line)
 		}
 
+		// rewrite icon line if it references an icon theme icon
+		if bytes.HasPrefix(bline, []byte("Icon=")) {
+			line, err := rewriteIconLine(s, string(bline))
+			if err != nil {
+				logger.Debugf("ignoring icon in source desktop file %q: %s", filepath.Base(desktopFile), err)
+				continue
+			}
+			bline = []byte(line)
+		}
+
 		// do variable substitution
 		bline = bytes.Replace(bline, []byte("${SNAP}"), mountDir, -1)
 

wrappers/desktop_test.go

@@ -482,6 +482,59 @@ func (s *sanitizeDesktopFileSuite) TestLangLang(c *C) {
 	}
 }
 
+func (s *sanitizeDesktopFileSuite) TestRewriteIconLine(c *C) {
+	snap, err := snap.InfoFromSnapYaml([]byte(`
+name: snap
+version: 1.0
+`))
+	c.Assert(err, IsNil)
+
+	newl, err := wrappers.RewriteIconLine(snap, "Icon=${SNAP}/icon.png")
+	c.Check(err, IsNil)
+	c.Check(newl, Equals, "Icon=${SNAP}/icon.png")
+
+	newl, err = wrappers.RewriteIconLine(snap, "Icon=snap.snap.icon")
+	c.Check(err, IsNil)
+	c.Check(newl, Equals, "Icon=snap.snap.icon")
+
+	newl, err = wrappers.RewriteIconLine(snap, "Icon=other-icon")
+	c.Check(err, IsNil)
+	c.Check(newl, Equals, "Icon=other-icon")
+
+	snap.InstanceKey = "bar"
+	newl, err = wrappers.RewriteIconLine(snap, "Icon=snap.snap.icon")
+	c.Check(err, IsNil)
+	c.Check(newl, Equals, "Icon=snap.snap_bar.icon")
+
+	_, err = wrappers.RewriteIconLine(snap, "Icon=snap.othersnap.icon")
+	c.Check(err, ErrorMatches, `invalid icon name: "snap.othersnap.icon"`)
+}
+
+func (s *sanitizeDesktopFileSuite) TestSanitizeParallelInstancesIconName(c *C) {
+	snap, err := snap.InfoFromSnapYaml([]byte(`
+name: snap
+version: 1.0
+apps:
+ app:
+  command: cmd
+`))
+	snap.InstanceKey = "bar"
+	c.Assert(err, IsNil)
+	desktopContent := []byte(`[Desktop Entry]
+Name=foo
+Icon=snap.snap.icon
+Exec=snap.app
+`)
+	df := filepath.Base(snap.Apps["app"].DesktopFile())
+	e := wrappers.SanitizeDesktopFile(snap, df, desktopContent)
+	c.Assert(string(e), Equals, fmt.Sprintf(`[Desktop Entry]
+X-SnapInstanceName=snap_bar
+Name=foo
+Icon=snap.snap_bar.icon
+Exec=env BAMF_DESKTOP_FILE_HINT=snap_bar_app.desktop %s/bin/snap_bar.app
+`, dirs.SnapMountDir))
+}
+
 func (s *desktopSuite) TestAddRemoveDesktopFiles(c *C) {
 	var tests = []struct {
 		instance                string

wrappers/export_test.go

@@ -33,10 +33,14 @@ var (
 	// desktop
 	SanitizeDesktopFile    = sanitizeDesktopFile
 	RewriteExecLine        = rewriteExecLine
+	RewriteIconLine        = rewriteIconLine
 	IsValidDesktopFileLine = isValidDesktopFileLine
 
 	// timers
 	GenerateOnCalendarSchedules = generateOnCalendarSchedules
+
+	// icons
+	FindIconFiles = findIconFiles
 )
 
 func MockKillWait(wait time.Duration) (restore func()) {

wrappers/icons.go

@@ -0,0 +1,125 @@
+// -*- Mode: Go; indent-tabs-mode: t -*-
+
+/*
+ * Copyright (C) 2019 Canonical Ltd
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 3 as
+ * published by the Free Software Foundation.
+ *
+ * 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+package wrappers
+
+import (
+	"fmt"
+	"io/ioutil"
+	"os"
+	"path/filepath"
+	"strings"
+
+	"github.com/snapcore/snapd/dirs"
+	"github.com/snapcore/snapd/osutil"
+	"github.com/snapcore/snapd/snap"
+)
+
+func findIconFiles(s *snap.Info, rootDir string) (icons []string, err error) {
+	if !osutil.IsDirectory(rootDir) {
+		return nil, nil
+	}
+	iconGlob := fmt.Sprintf("snap.%s.*", s.SnapName())
+	forbiddenDirGlob := "snap.*"
+	err = filepath.Walk(rootDir, func(path string, info os.FileInfo, err error) error {
+		if err != nil {
+			return err
+		}
+		rel, err := filepath.Rel(rootDir, path)
+		if err != nil {
+			return err
+		}
+		base := filepath.Base(path)
+		if info.IsDir() {
+			// Ignore directories that could match an icon glob
+			if ok, err := filepath.Match(forbiddenDirGlob, base); ok || err != nil {
+				return filepath.SkipDir
+			}
+		} else {
+			if ok, err := filepath.Match(iconGlob, base); err != nil {
+				return err
+			} else if ok {
+				ext := filepath.Ext(base)
+				if ext == ".png" || ext == ".svg" {
+					icons = append(icons, rel)
+				}
+			}
+		}
+		return nil
+	})
+	return icons, err
+}
+
+func deriveIconContent(s *snap.Info, rootDir string, icons []string) (content map[string]map[string]*osutil.FileState, err error) {
+	content = make(map[string]map[string]*osutil.FileState)
+	snapPrefix := fmt.Sprintf("snap.%s.", s.SnapName())
+	instancePrefix := fmt.Sprintf("snap.%s.", s.InstanceName())
+
+	for _, iconFile := range icons {
+		dir := filepath.Dir(iconFile)
+		base := filepath.Base(iconFile)
+		dirContent := content[dir]
+		if dirContent == nil {
+			dirContent = make(map[string]*osutil.FileState)
+			content[dir] = dirContent
+		}
+		data, err := ioutil.ReadFile(filepath.Join(rootDir, iconFile))
+		if err != nil {
+			return nil, err
+		}
+		// rename icons to match snap instance name
+		if strings.HasPrefix(base, snapPrefix) {
+			base = instancePrefix + base[len(snapPrefix):]
+		}
+		dirContent[base] = &osutil.FileState{
+			Content: data,
+			Mode:    0644,
+		}
+	}
+	return content, nil
+}
+
+func AddSnapIcons(s *snap.Info) error {
+	if err := os.MkdirAll(dirs.SnapDesktopIconsDir, 0755); err != nil {
+		return err
+	}
+
+	rootDir := filepath.Join(s.MountDir(), "meta", "gui", "icons")
+	icons, err := findIconFiles(s, rootDir)
+	if err != nil {
+		return err
+	}
+
+	content, err := deriveIconContent(s, rootDir, icons)
+	if err != nil {
+		return err
+	}
+	iconGlob := fmt.Sprintf("snap.%s.*", s.InstanceName())
+	_, _, err = osutil.EnsureTreeState(dirs.SnapDesktopIconsDir, []string{iconGlob}, content)
+	return err
+}
+
+func RemoveSnapIcons(s *snap.Info) error {
+	if !osutil.IsDirectory(dirs.SnapDesktopIconsDir) {
+		return nil
+	}
+	iconGlob := fmt.Sprintf("snap.%s.*", s.InstanceName())
+	_, _, err := osutil.EnsureTreeState(dirs.SnapDesktopIconsDir, []string{iconGlob}, nil)
+	return err
+}