Merge pull request #75 from nwg-piotr/fix74

sanitize no longer valid pinned items #74

.gitignore

@@ -11,5 +11,11 @@
 # Output of the go coverage tool, specifically when used with LiteIDE
 *.out
 
+# Binaries built with make
+bin
+nwg-drawer
+
+/.idea
+
 # Dependency directories (remove the comment below to include it)
 # vendor/

README.md

@@ -15,9 +15,9 @@ You may pin applications by right-clicking them. Pinned items will appear above
 a pinned item to unpin it. The pinned items cache is shared with [nwg-menu](https://github.com/nwg-piotr/nwg-menu)
 and `nwggrid`.
 
-![screenshot-01.png](https://scrot.cloud/images/2021/05/30/screenshot-01.png)
+![screenshot.png](https://raw.githubusercontent.com/nwg-piotr/nwg-shell-resources/master/images/nwg-shell/nwg-drawer.png)
 
-[more screenshots](https://scrot.cloud/album/nwg-drawer.Bogd) | [see on YouTube](https://youtu.be/iIgxJQhCQf0)
+[see on YouTube](https://youtu.be/iIgxJQhCQf0)
 
 [![Packaging status](https://repology.org/badge/vertical-allrepos/nwg-drawer.svg)](https://repology.org/project/nwg-drawer/versions)
 
@@ -52,9 +52,6 @@ confirmed to work well with the program. Also see **Files** below.
 3. `make build`
 4. `sudo make install`
 
-Building the gotk3 library takes quite a lot of time. If your machine is x86_64, you may skip steps 2-3, and
-install the provided binary by executing step 4.
-
 ## Command line arguments
 
 ```text
@@ -69,6 +66,8 @@ Usage of nwg-drawer:
     	File Search result COLumns (default 2)
   -fslen int
     	File Search name LENgth Limit (default 80)
+  -g string
+    	GTK theme name, eg. "Adwaita-dark"
   -is int
     	Icon Size (default 64)
   -lang string
@@ -135,7 +134,7 @@ Edit `~/.config/nwg-drawer/drawer.css` to your taste.
 
 When the search phrase is at least 3 characters long, your XDG user directories are being searched.
 
-![screenshot-03.png](https://scrot.cloud/images/2021/05/30/screenshot-03.png)
+![screenshot-02.png](https://raw.githubusercontent.com/nwg-piotr/nwg-shell/main/images/nwg-drawer/search.png)
 
 Use the **left mouse button** to open a file with the `xdg-open` command. As configuring file associations for it is
 PITA, you may override them, by creating the `~/.config/nwg-panel/preferred-apps.json` file with your own definitions.

go.mod

@@ -1,6 +1,6 @@
 module github.com/nwg-piotr/nwg-drawer
 
-go 1.16
+go 1.18
 
 require (
 	github.com/allan-simon/go-singleinstance v0.0.0-20210120080615-d0997106ab37
@@ -10,3 +10,11 @@ require (
 	github.com/joshuarubin/go-sway v0.0.4
 	github.com/sirupsen/logrus v1.8.1
 )
+
+require (
+	github.com/joshuarubin/lifecycle v1.0.0 // indirect
+	go.uber.org/atomic v1.3.2 // indirect
+	go.uber.org/multierr v1.1.0 // indirect
+	golang.org/x/sync v0.0.0-20190412183630-56d357773e84 // indirect
+	golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c // indirect
+)

main.go

@@ -21,7 +21,7 @@ import (
 	"github.com/gotk3/gotk3/gtk"
 )
 
-const version = "0.2.5"
+const version = "0.3.4"
 
 var (
 	appDirs         []string
@@ -100,9 +100,8 @@ var (
 	statusLabel             *gtk.Label
 	status                  string
 	ignore                  string
-	showWindowTrigger       bool
 	desktopTrigger          bool
-	pinnedTrigger           bool
+	pinnedItemsChanged      chan interface{} = make(chan interface{}, 1)
 )
 
 func defaultStringIfBlank(s, fallback string) string {
@@ -120,7 +119,12 @@ var cssFileName = flag.String("s", "drawer.css", "Styling: css file name")
 var targetOutput = flag.String("o", "", "name of the Output to display the drawer on (sway only)")
 var displayVersion = flag.Bool("v", false, "display Version information")
 var overlay = flag.Bool("ovl", false, "use OVerLay layer")
+var gtkTheme = flag.String("g", "", "GTK theme name")
 var iconSize = flag.Int("is", 64, "Icon Size")
+var marginTop = flag.Int("mt", 0, "Margin Top")
+var marginLeft = flag.Int("ml", 0, "Margin Left")
+var marginRight = flag.Int("mr", 0, "Margin Right")
+var marginBottom = flag.Int("mb", 0, "Margin Bottom")
 var fsColumns = flag.Uint("fscol", 2, "File Search result COLumns")
 var columnsNumber = flag.Uint("c", 6, "number of Columns")
 var itemSpacing = flag.Uint("spacing", 20, "icon spacing")
@@ -148,6 +152,7 @@ func main() {
 
 	// Gentle SIGTERM handler thanks to reiki4040 https://gist.github.com/reiki4040/be3705f307d3cd136e85
 	// v0.2: we also need to support SIGUSR from now on
+	showWindowChannel := make(chan interface{}, 1)
 	signalChan := make(chan os.Signal, 1)
 	signal.Notify(signalChan, syscall.SIGTERM, syscall.SIGUSR1)
 
@@ -164,7 +169,7 @@ func main() {
 					// let's just set e helper variable here. We'll be checking it with glib.TimeoutAdd.
 					if !win.IsVisible() {
 						log.Debug("SIGUSR1 received, showing the window")
-						showWindowTrigger = true
+						showWindowChannel <- struct{}{}
 					} else {
 						log.Debug("SIGUSR1 received, hiding the window")
 						restoreStateAndHide()
@@ -195,7 +200,10 @@ func main() {
 					log.Warnf("Resident instance already running (PID %v)", i)
 				} else {
 					log.Infof("Showing resident instance (PID %v)", i)
-					syscall.Kill(i, syscall.SIGUSR1)
+					err := syscall.Kill(i, syscall.SIGUSR1)
+					if err != nil {
+						return
+					}
 				}
 			}
 		}
@@ -238,7 +246,10 @@ func main() {
 
 	// Copy default style sheet if not found
 	if !pathExists(filepath.Join(configDirectory, "drawer.css")) {
-		copyFile(filepath.Join(getDataHome(), "nwg-drawer/drawer.css"), filepath.Join(configDirectory, "drawer.css"))
+		err := copyFile("/usr/share/nwg-drawer/drawer.css", filepath.Join(configDirectory, "drawer.css"))
+		if err != nil {
+			log.Errorf("Failed copying 'drawer.css' file: %s", err)
+		}
 	}
 
 	cacheDirectory := cacheDir()
@@ -298,6 +309,23 @@ func main() {
 	// USER INTERFACE
 	gtk.Init(nil)
 
+	settings, _ := gtk.SettingsGetDefault()
+	if *gtkTheme != "" {
+		err = settings.SetProperty("gtk-theme-name", *gtkTheme)
+		if err != nil {
+			log.Error("Unable to set theme:", err)
+		} else {
+			log.Infof("User demanded theme: %s", *gtkTheme)
+		}
+	} else {
+		err := settings.SetProperty("gtk-application-prefer-dark-theme", true)
+		if err != nil {
+			log.Error("Error setting 'gtk-application-prefer-dark-theme' property")
+			return
+		}
+		log.Info("Preferring dark theme variants")
+	}
+
 	cssProvider, _ := gtk.CssProviderNew()
 
 	err = cssProvider.LoadFromPath(*cssFileName)
@@ -343,6 +371,11 @@ func main() {
 			layershell.SetLayer(win, layershell.LAYER_SHELL_LAYER_TOP)
 		}
 
+		layershell.SetMargin(win, layershell.LAYER_SHELL_EDGE_TOP, *marginTop)
+		layershell.SetMargin(win, layershell.LAYER_SHELL_EDGE_LEFT, *marginLeft)
+		layershell.SetMargin(win, layershell.LAYER_SHELL_EDGE_RIGHT, *marginRight)
+		layershell.SetMargin(win, layershell.LAYER_SHELL_EDGE_BOTTOM, *marginBottom)
+
 		layershell.SetKeyboardMode(win, layershell.LAYER_SHELL_KEYBOARD_MODE_EXCLUSIVE)
 	}
 
@@ -492,39 +525,55 @@ func main() {
 	log.Info(fmt.Sprintf("UI created in %v ms. Thank you for your patience.", t.Sub(timeStart).Milliseconds()))
 
 	// Check if showing the window has been requested (SIGUSR1)
-	glib.TimeoutAdd(uint(1), func() bool {
+	go func() {
-		if showWindowTrigger && win != nil && !win.IsVisible() {
+		for {
-			win.ShowAll()
+			select {
-			fileSearchResultWrapper.Hide()
+			case <-showWindowChannel:
-			// focus 1st element
+				log.Debug("Showing window")
-			b := appFlowBox.GetChildAtIndex(0)
+				glib.TimeoutAdd(0, func() bool {
-			if b != nil {
+					if win != nil && !win.IsVisible() {
-				button, err := b.GetChild()
+
-				if err == nil {
+						// Refresh files before displaying the root window
-					button.ToWidget().GrabFocus()
+						// some .desktop file changed
-				}
+						if desktopTrigger {
+							log.Debug(".desktop file changed")
+							desktopFiles = listDesktopFiles()
+							status = parseDesktopFiles(desktopFiles)
+							appFlowBox = setUpAppsFlowBox(nil, "")
+							desktopTrigger = false
+						}
+
+						// Show window and focus the search box
+						win.ShowAll()
+						if fileSearchResultWrapper != nil {
+							fileSearchResultWrapper.Hide()
+						}
+						// focus 1st element
+						var button gtk.IWidget
+						if pinnedFlowBox.GetChildren().Length() > 0 {
+							button, err = pinnedFlowBox.GetChildAtIndex(0).GetChild()
+						} else {
+							button, err = appFlowBox.GetChildAtIndex(0).GetChild()
+						}
+						if err == nil {
+							button.ToWidget().GrabFocus()
+						}
+					}
+
+					return false
+				})
+
+			case <-pinnedItemsChanged:
+				glib.TimeoutAdd(0, func() bool {
+					log.Debug("pinned file changed")
+					pinned, _ = loadTextFile(pinnedFile)
+					pinnedFlowBox = setUpPinnedFlowBox()
+
+					return false
+				})
 			}
 		}
-		showWindowTrigger = false
+	}()
-
-		// some .desktop file changed
-		if desktopTrigger {
-			log.Debug(".desktop file changed")
-			desktopFiles = listDesktopFiles()
-			status = parseDesktopFiles(desktopFiles)
-			appFlowBox = setUpAppsFlowBox(nil, "")
-			desktopTrigger = false
-		}
-
-		// pinned file changed
-		if pinnedTrigger {
-			log.Debug("pinned file changed")
-			pinnedTrigger = false
-			pinned, _ = loadTextFile(pinnedFile)
-			pinnedFlowBox = setUpPinnedFlowBox()
-		}
-		return true
-	})
 
 	go watchFiles()
 
@@ -533,7 +582,9 @@ func main() {
 
 func restoreStateAndHide() {
 	timeStart1 := time.Now()
-	win.Hide()
+	if win != nil {
+		win.Hide()
+	}
 
 	// clear search
 	searchEntry.SetText("")
@@ -546,7 +597,9 @@ func restoreStateAndHide() {
 	}
 
 	// scroll to the top
-	resultWindow.GetVAdjustment().SetValue(0)
+	if resultWindow != nil {
+		resultWindow.GetVAdjustment().SetValue(0)
+	}
 
 	t := time.Now()
 	log.Debugf(fmt.Sprintf("UI hidden and restored in the backgroud in %v ms", t.Sub(timeStart1).Milliseconds()))

tools.go

@@ -7,7 +7,6 @@ import (
 	"fmt"
 	"io"
 	"io/fs"
-	"io/ioutil"
 	"os"
 	"os/exec"
 	"path"
@@ -15,6 +14,7 @@ import (
 	"regexp"
 	"sort"
 	"strings"
+	"syscall"
 	"time"
 
 	log "github.com/sirupsen/logrus"
@@ -142,7 +142,7 @@ func tempDir() string {
 }
 
 func readTextFile(path string) (string, error) {
-	bytes, err := ioutil.ReadFile(path)
+	bytes, err := os.ReadFile(path)
 	if err != nil {
 		return "", err
 	}
@@ -196,12 +196,22 @@ func copyFile(src, dst string) error {
 	if srcfd, err = os.Open(src); err != nil {
 		return err
 	}
-	defer srcfd.Close()
+	defer func(srcfd *os.File) {
+		err := srcfd.Close()
+		if err != nil {
+			log.Errorf("Error closing file: %v", srcfd)
+		}
+	}(srcfd)
 
 	if dstfd, err = os.Create(dst); err != nil {
 		return err
 	}
-	defer dstfd.Close()
+	defer func(dstfd *os.File) {
+		err := dstfd.Close()
+		if err != nil {
+			log.Errorf("Error closing file: %v", dstfd)
+		}
+	}(dstfd)
 
 	if _, err = io.Copy(dstfd, srcfd); err != nil {
 		return err
@@ -212,13 +222,6 @@ func copyFile(src, dst string) error {
 	return os.Chmod(dst, srcinfo.Mode())
 }
 
-func getDataHome() string {
-	if os.Getenv("XDG_DATA_HOME") != "" {
-		return os.Getenv("XDG_DATA_HOME")
-	}
-	return "/usr/share/"
-}
-
 func getAppDirs() []string {
 	var dirs []string
 	xdgDataDirs := ""
@@ -260,12 +263,20 @@ func loadPreferredApps(path string) (map[string]interface{}, error) {
 	if err != nil {
 		return nil, err
 	}
-	defer jsonFile.Close()
+	defer func(jsonFile *os.File) {
+		err := jsonFile.Close()
+		if err != nil {
+			log.Errorf("Error closing file: %v", jsonFile)
+		}
+	}(jsonFile)
 
-	byteValue, _ := ioutil.ReadAll(jsonFile)
+	byteValue, _ := io.ReadAll(jsonFile)
 
 	var result map[string]interface{}
-	json.Unmarshal([]byte(byteValue), &result)
+	err = json.Unmarshal(byteValue, &result)
+	if err != nil {
+		return nil, err
+	}
 
 	if len(result) == 0 {
 		return nil, errors.New("json invalid or empty")
@@ -274,8 +285,8 @@ func loadPreferredApps(path string) (map[string]interface{}, error) {
 	return result, nil
 }
 
-func listFiles(dir string) ([]fs.FileInfo, error) {
+func listFiles(dir string) ([]fs.DirEntry, error) {
-	files, err := ioutil.ReadDir(dir)
+	files, err := os.ReadDir(dir)
 	if err == nil {
 		return files, nil
 	}
@@ -299,12 +310,12 @@ func listDesktopFiles() []string {
 }
 
 func setUpCategories() {
-	path := filepath.Join(getDataHome(), "nwg-drawer/desktop-directories")
 	var other category
 
 	for _, cName := range categoryNames {
 		fileName := fmt.Sprintf("%s.directory", cName)
-		lines, err := loadTextFile(filepath.Join(path, fileName))
+		fp := filepath.Join("/usr/share/nwg-drawer/desktop-directories", fileName)
+		lines, err := loadTextFile(fp)
 		if err == nil {
 			var cat category
 			cat.Name = cName
@@ -349,6 +360,8 @@ func setUpCategories() {
 			} else {
 				other = cat
 			}
+		} else {
+			log.Errorf("Couldn't open %s", fp)
 		}
 	}
 	sort.Slice(categories, func(i, j int) bool {
@@ -462,7 +475,7 @@ func pathExists(name string) bool {
 }
 
 func loadTextFile(path string) ([]string, error) {
-	bytes, err := ioutil.ReadFile(path)
+	bytes, err := os.ReadFile(path)
 	if err != nil {
 		return nil, err
 	}
@@ -513,14 +526,20 @@ func savePinned() {
 		log.Fatal(err)
 	}
 
-	defer f.Close()
+	defer func(f *os.File) {
+		err := f.Close()
+		if err != nil {
+			log.Errorf("Error closing file: %v", f)
+		}
+	}(f)
 
 	for _, line := range pinned {
-		if line != "" {
+		//skip invalid lines
+		if line != "" && id2entry[line].DesktopID != "" {
 			_, err := f.WriteString(line + "\n")
 
 			if err != nil {
-				log.Errorf("Error saving pinned", err)
+				log.Error("Error saving pinned", err)
 			}
 		}
 	}
@@ -578,7 +597,19 @@ func launch(command string, terminal bool) {
 	msg := fmt.Sprintf("env vars: %s; command: '%s'; args: %s\n", envVars, elements[cmdIdx], elements[1+cmdIdx:])
 	log.Info(msg)
 
-	cmd.Start()
+	cmd.SysProcAttr = &syscall.SysProcAttr{
+		Setsid: true,
+	}
+
+	if cmd.Start() != nil {
+		log.Warn("Unable to launch terminal emulator!")
+	} else {
+		// Collect the exit code of the child process to prevent zombies
+		// if the drawer runs in resident mode
+		go func() {
+			_ = cmd.Wait()
+		}()
+	}
 
 	if *resident {
 		restoreStateAndHide()
@@ -604,7 +635,15 @@ func open(filePath string, xdgOpen bool) {
 	}
 	log.Infof("Executing: %s", cmd)
 
-	cmd.Start()
+	if cmd.Start() != nil {
+		log.Warn("Unable to execute command!")
+	} else {
+		// Collect the exit code of the child process to prevent zombies
+		// if the drawer runs in resident mode
+		go func() {
+			_ = cmd.Wait()
+		}()
+	}
 
 	if *resident {
 		restoreStateAndHide()

uicomponents.go

@@ -32,6 +32,10 @@ func setUpPinnedFlowBox() *gtk.FlowBox {
 	if len(pinned) > 0 {
 		for _, desktopID := range pinned {
 			entry := id2entry[desktopID]
+			if entry.DesktopID == "" {
+				log.Debugf("Pinned item doesn't seem to exist: %s", desktopID)
+				continue
+			}
 
 			btn, _ := gtk.ButtonNew()
 
@@ -248,8 +252,8 @@ func flowBoxButton(entry desktopEntry) *gtk.Button {
 	button.SetImagePosition(gtk.POS_TOP)
 	name := entry.NameLoc
 	if len(name) > 20 {
-		r := []rune(name)
+		r := []rune(name[:17])
-		name = string(r[:17])
+		name = string(r)
 		name = fmt.Sprintf("%s…", name)
 	}
 	button.SetLabel(name)
@@ -258,6 +262,11 @@ func flowBoxButton(entry desktopEntry) *gtk.Button {
 	exec := entry.Exec
 	terminal := entry.Terminal
 	desc := entry.CommentLoc
+	if len(desc) > 120 {
+		r := []rune(desc[:117])
+		desc = string(r)
+		desc = fmt.Sprintf("%s…", desc)
+	}
 	button.Connect("button-release-event", func(btn *gtk.Button, e *gdk.Event) bool {
 		btnEvent := gdk.EventButtonNewFromEvent(e)
 		if btnEvent.Button() == 1 {

watcher.go

@@ -41,7 +41,9 @@ func watchFiles() {
 						event.Op.String() == "RENAME") {
 					desktopTrigger = true
 				} else if event.Name == pinnedFile {
-					pinnedTrigger = true
+					// TODO: This can be used to propagate information about the changed file to the
+					//       GUI to avoid recreating everything
+					pinnedItemsChanged <- struct{}{}
 				}
 
 			case err := <-watcher.Errors:

xdgdesktop_parser.go

@@ -54,7 +54,34 @@ func parseDesktopEntry(id string, in io.Reader) (entry desktopEntry, err error)
 		case "Terminal":
 			entry.Terminal, _ = strconv.ParseBool(value)
 		case "NoDisplay":
-			entry.NoDisplay, _ = strconv.ParseBool(value)
+			if !entry.NoDisplay {
+				entry.NoDisplay, _ = strconv.ParseBool(value)
+			}
+		case "Hidden":
+			if !entry.NoDisplay {
+				entry.NoDisplay, _ = strconv.ParseBool(value)
+			}
+		case "OnlyShowIn":
+			if !entry.NoDisplay {
+				entry.NoDisplay = true
+				currentDesktop := os.Getenv("XDG_CURRENT_DESKTOP")
+				if currentDesktop != "" {
+					for _, ele := range strings.Split(value, ";") {
+						if ele == currentDesktop && ele != "" {
+							entry.NoDisplay = false
+						}
+					}
+				}
+			}
+		case "NotShowIn":
+			currentDesktop := os.Getenv("XDG_CURRENT_DESKTOP")
+			if !entry.NoDisplay && currentDesktop != "" {
+				for _, ele := range strings.Split(value, ";") {
+					if ele == currentDesktop && ele != "" {
+						entry.NoDisplay = true
+					}
+				}
+			}
 		case "Exec":
 			entry.Exec = cleanexec.Replace(value)
 		}