Merge pull request #24 from nwg-piotr/fix_nodisplay

Fix nodisplay, fix running in terminal

Makefile

@@ -20,4 +20,5 @@ uninstall:
 	rm /usr/bin/nwg-drawer
 
 run:
-	go run *.go
+	go build -o bin/nwg-drawer *.go
+	bin/nwg-drawer

README.md

@@ -25,17 +25,18 @@ and `nwggrid`.
 
 ### Dependencies
 
-- go 1.16 (just to build)
+- go >=1.16 (just to build)
 - gtk3
 - gtk-layer-shell
+- xdg-utils
 
 Optional (recommended):
 
 - thunar
 - alacritty
 
-You may use another file manager and terminal emulator (see command line arguments), but for now the program has
- only been tested with the two mentioned above.
+You may use another file manager and terminal emulator (see command line arguments), but mentioned above have been
+confirmed to work well with the program. Also see **Files** below.
 
 ### Steps
 
@@ -81,10 +82,43 @@ Usage of nwg-drawer:
   -v	display Version information
   ```
 
+  *NOTE: the `$TERM` environment variable overrides the `-term` argument if defined.*
+
 ## Styling
 
 Edit `~/.config/nwg-panel/drawer.css` to your taste.
 
+## Files
+
+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)
+
+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.
+
+### Sample file content
+
+```json
+{
+  "\\.pdf$": "atril",
+  "\\.svg$": "inkscape",
+  "\\.(jpg|png|tiff|gif)$": "feh",
+  "\\.(mp3|ogg|flac|wav|wma)$": "audacious",
+  "\\.(avi|mp4|mkv|mov|wav)$": "mpv",
+  "\\.(doc|docx|xls|xlsx)$": "libreoffice"
+}
+```
+
+Use the **right mouse button** to open the file with your file manager (see `-fm` argument). The result depends on the
+file manager you use.
+
+- thunar will open the file location
+- pcmanfm will open the file with its associated program
+- caja won't open anything, except for directories
+
+I've noy yet tried other file managers.
+
 ## Credits
 
 This program uses some great libraries:

main.go

@@ -19,7 +19,7 @@ import (
 	"github.com/gotk3/gotk3/gtk"
 )
 
-const version = "0.1.5"
+const version = "0.1.10"
 
 var (
 	appDirs         []string
@@ -28,6 +28,7 @@ var (
 	pinned          []string
 	src             glib.SourceHandle
 	id2entry        map[string]desktopEntry
+	preferredApps   map[string]interface{}
 )
 
 var categoryNames = [...]string{
@@ -58,6 +59,7 @@ type desktopEntry struct {
 	CommentLoc string
 	Icon       string
 	Exec       string
+	Category   string
 	Terminal   bool
 	NoDisplay  bool
 }
@@ -97,6 +99,16 @@ var (
 	ignore                  string
 )
 
+func defaultStringIfBlank(s, fallback string) string {
+	s = strings.TrimSpace(s)
+	// os.Getenv("TERM") returns "linux" instead of empty string, if program has been started
+	// from a key binding defined in the config file. See #23.
+	if s == "" || s == "linux" {
+		return fallback
+	}
+	return s
+}
+
 // Flags
 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)")
@@ -108,7 +120,7 @@ var columnsNumber = flag.Uint("c", 6, "number of Columns")
 var itemSpacing = flag.Uint("spacing", 20, "icon spacing")
 var lang = flag.String("lang", "", "force lang, e.g. \"en\", \"pl\"")
 var fileManager = flag.String("fm", "thunar", "File Manager")
-var term = flag.String("term", "alacritty", "Terminal emulator")
+var term = flag.String("term", defaultStringIfBlank(os.Getenv("TERM"), "alacritty"), "Terminal emulator")
 var nameLimit = flag.Int("fslen", 80, "File Search name length Limit")
 var noCats = flag.Bool("nocats", false, "Disable filtering by category")
 var noFS = flag.Bool("nofs", false, "Disable file search")
@@ -188,6 +200,16 @@ func main() {
 
 	status = parseDesktopFiles(desktopFiles)
 
+	// For opening files we use xdg-open. As its configuration is PITA, we may override some associations
+	// in the ~/.config/nwg-panel/preferred-apps.json file.
+	paFile := filepath.Join(configDirectory, "preferred-apps.json")
+	preferredApps, err = loadPreferredApps(paFile)
+	if err != nil {
+		println(fmt.Sprintf("Custom associations file %s not found or invalid", paFile))
+	} else {
+		println(fmt.Sprintf("Found %v associations in %s", len(preferredApps), paFile))
+	}
+
 	// USER INTERFACE
 	gtk.Init(nil)
 
@@ -196,7 +218,7 @@ func main() {
 	err = cssProvider.LoadFromPath(cssFile)
 	if err != nil {
 		println(fmt.Sprintf("ERROR: %s css file not found or erroneous. Using GTK styling.", cssFile))
-		println(fmt.Sprintf(">>> %s", err))
+		println(fmt.Sprintf("%s", err))
 	} else {
 		println(fmt.Sprintf("Using style from %s", cssFile))
 		screen, _ := gdk.ScreenGetDefault()
@@ -220,7 +242,7 @@ func main() {
 				layershell.SetMonitor(win, monitor)
 
 			} else {
-				println(err)
+				println(fmt.Sprintf("%s", err))
 			}
 		}
 
@@ -243,15 +265,6 @@ func main() {
 		gtk.MainQuit()
 	})
 
-	win.Connect("button-release-event", func(sw *gtk.Window, e *gdk.Event) bool {
-		btnEvent := gdk.EventButtonNewFromEvent(e)
-		if btnEvent.Button() == 1 || btnEvent.Button() == 3 {
-			gtk.MainQuit()
-			return true
-		}
-		return false
-	})
-
 	win.Connect("key-press-event", func(window *gtk.Window, event *gdk.Event) bool {
 		key := &gdk.EventKey{Event: event}
 		switch key.KeyVal() {
@@ -270,7 +283,7 @@ func main() {
 
 		default:
 			if !searchEntry.IsFocus() {
-				searchEntry.GrabFocus()
+				searchEntry.GrabFocusWithoutSelecting()
 			}
 			return false
 		}

tools.go

@@ -2,6 +2,8 @@ package main
 
 import (
 	"context"
+	"encoding/json"
+	"errors"
 	"fmt"
 	"io"
 	"io/fs"
@@ -10,6 +12,7 @@ import (
 	"os"
 	"os/exec"
 	"path/filepath"
+	"regexp"
 	"sort"
 	"strings"
 	"time"
@@ -46,7 +49,7 @@ func createPixbuf(icon string, size int) (*gdk.Pixbuf, error) {
 	if strings.Contains(icon, "/") {
 		pixbuf, err := gdk.PixbufNewFromFileAtSize(icon, size, size)
 		if err != nil {
-			println(err)
+			println(fmt.Sprintf("%s", err))
 			return nil, err
 		}
 		return pixbuf, nil
@@ -243,6 +246,25 @@ func getAppDirs() []string {
 	return dirs
 }
 
+func loadPreferredApps(path string) (map[string]interface{}, error) {
+	jsonFile, err := os.Open(path)
+	if err != nil {
+		return nil, err
+	}
+	defer jsonFile.Close()
+
+	byteValue, _ := ioutil.ReadAll(jsonFile)
+
+	var result map[string]interface{}
+	json.Unmarshal([]byte(byteValue), &result)
+
+	if len(result) == 0 {
+		return nil, errors.New("json invalid or empty")
+	}
+
+	return result, nil
+}
+
 func listFiles(dir string) ([]fs.FileInfo, error) {
 	files, err := ioutil.ReadDir(dir)
 	if err == nil {
@@ -328,103 +350,29 @@ func setUpCategories() {
 
 func parseDesktopFiles(desktopFiles []string) string {
 	id2entry = make(map[string]desktopEntry)
-	var added []string
 	skipped := 0
 	hidden := 0
 	for _, file := range desktopFiles {
-		lines, err := loadTextFile(file)
-		if err == nil {
-			parts := strings.Split(file, "/")
-			desktopID := parts[len(parts)-1]
-			name := ""
-			nameLoc := ""
-			comment := ""
-			commentLoc := ""
-			icon := ""
-			exec := ""
-			terminal := false
-			noDisplay := false
+		id := filepath.Base(file)
+		if _, ok := id2entry[id]; ok {
+			skipped++
+			continue
+		}
 
-			categories := ""
+		entry, err := parseDesktopEntryFile(id, file)
+		if err != nil {
+			continue
+		}
 
-			for _, l := range lines {
-				if strings.HasPrefix(l, "[") && l != "[Desktop Entry]" {
-					break
-				}
-				if strings.HasPrefix(l, "Name=") {
-					name = strings.Split(l, "=")[1]
-					continue
-				}
-				if strings.HasPrefix(l, fmt.Sprintf("Name[%s]=", strings.Split(*lang, "_")[0])) {
-					nameLoc = strings.Split(l, "=")[1]
-					continue
-				}
-				if strings.HasPrefix(l, "Comment=") {
-					comment = strings.Split(l, "=")[1]
-					continue
-				}
-				if strings.HasPrefix(l, fmt.Sprintf("Comment[%s]=", strings.Split(*lang, "_")[0])) {
-					commentLoc = strings.Split(l, "=")[1]
-					continue
-				}
-				if strings.HasPrefix(l, "Icon=") {
-					icon = strings.Split(l, "=")[1]
-					continue
-				}
-				if strings.HasPrefix(l, "Exec=") {
-					exec = strings.Split(l, "Exec=")[1]
-					disallowed := [2]string{"\"", "'"}
-					for _, char := range disallowed {
-						exec = strings.Replace(exec, char, "", -1)
-					}
-					continue
-				}
-				if strings.HasPrefix(l, "Categories=") {
-					categories = strings.Split(l, "Categories=")[1]
-					continue
-				}
-				if l == "Terminal=true" {
-					terminal = true
-					continue
-				}
-				if l == "NoDisplay=true" {
-					noDisplay = true
+		if entry.NoDisplay {
 			hidden++
-					continue
+			// We still need hidden entries, so `continue` is disallowed here
+			// Fixes introduced in #19
 		}
-			}
-
-			// if name[ln] not found, let's try to find name[ln_LN]
-			if nameLoc == "" {
-				nameLoc = name
-			}
-			if commentLoc == "" {
-				commentLoc = comment
-			}
-
-			if !isIn(added, desktopID) {
-				added = append(added, desktopID)
-
-				var entry desktopEntry
-				entry.DesktopID = desktopID
-				entry.Name = name
-				entry.NameLoc = nameLoc
-				entry.Comment = comment
-				entry.CommentLoc = commentLoc
-				entry.Icon = icon
-				entry.Exec = exec
-				entry.Terminal = terminal
-				entry.NoDisplay = noDisplay
-				desktopEntries = append(desktopEntries, entry)
 
 		id2entry[entry.DesktopID] = entry
-
-				assignToLists(entry.DesktopID, categories)
-
-			} else {
-				skipped++
-			}
-		}
+		desktopEntries = append(desktopEntries, entry)
+		assignToLists(entry.DesktopID, entry.Category)
 	}
 	sort.Slice(desktopEntries, func(i, j int) bool {
 		return desktopEntries[i].NameLoc < desktopEntries[j].NameLoc
@@ -622,14 +570,25 @@ func launch(command string, terminal bool) {
 	})
 }
 
-func open(filePath string) {
-	cmd := exec.Command(*fileManager, filePath)
+func open(filePath string, xdgOpen bool) {
+	var cmd *exec.Cmd
+	if xdgOpen {
+		cmd = exec.Command("xdg-open", filePath)
+		// Look for possible custom file association
+		for key, element := range preferredApps {
+			r, err := regexp.Compile(key)
+			if err == nil && r.MatchString(filePath) {
+				cmd = exec.Command(fmt.Sprintf("%v", element), filePath)
+				break
+			}
+		}
+	} else {
+		cmd = exec.Command(*fileManager, filePath)
+	}
+	fmt.Printf("Executing: %s", cmd)
 	cmd.Start()
 
-	glib.TimeoutAdd(uint(150), func() bool {
 	gtk.MainQuit()
-		return false
-	})
 }
 
 // Returns map output name -> gdk.Monitor

uicomponents.go

@@ -146,7 +146,9 @@ func setUpCategoriesButtonBox() *gtk.EventBox {
 				w := b.GetAllocatedWidth()
 				b.SetImagePosition(gtk.POS_TOP)
 				b.SetSizeRequest(w, 0)
+				if fileSearchResultWrapper != nil {
 					fileSearchResultWrapper.Hide()
+				}
 			})
 		}
 	}
@@ -349,6 +351,29 @@ func setUpSearchEntry() *gtk.SearchEntry {
 					fileSearchResultWrapper.Hide()
 				}
 			}
+			// focus 1st search result #17
+			var w *gtk.Widget
+			if appFlowBox != nil {
+				b := appFlowBox.GetChildAtIndex(0)
+				if b != nil {
+					button, err := b.GetChild()
+					if err == nil {
+						button.ToWidget().GrabFocus()
+						w = button.ToWidget()
+					}
+				}
+			}
+			if w == nil && fileSearchResultFlowBox != nil {
+				f := fileSearchResultFlowBox.GetChildAtIndex(0)
+				if f != nil {
+					//f.SetCanFocus(false)
+					button, err := f.GetChild()
+					if err == nil {
+						button.ToWidget().SetCanFocus(true)
+						button.ToWidget().GrabFocus()
+					}
+				}
+			}
 		} else {
 			// clear search results
 			appFlowBox = setUpAppsFlowBox(nil, "")
@@ -362,9 +387,9 @@ func setUpSearchEntry() *gtk.SearchEntry {
 			}
 		}
 	})
-	searchEntry.Connect("focus-in-event", func() {
+	/*searchEntry.Connect("focus-in-event", func() {
 		searchEntry.SetText("")
-	})
+	})*/
 
 	return searchEntry
 }
@@ -387,7 +412,8 @@ func searchUserDir(dir string) {
 		}
 		fileSearchResultFlowBox.Hide()
 
-		statusLabel.SetText(fmt.Sprintf("%v results", fileSearchResultFlowBox.GetChildren().Length()))
+		statusLabel.SetText(fmt.Sprintf("%v results | LMB: xdg-open | RMB: file manager",
+			fileSearchResultFlowBox.GetChildren().Length()))
 		num := uint(fileSearchResultFlowBox.GetChildren().Length() / *fsColumns)
 		fileSearchResultFlowBox.SetMinChildrenPerLine(num + 1)
 		fileSearchResultFlowBox.SetMaxChildrenPerLine(num + 1)
@@ -406,6 +432,7 @@ func setUpUserDirButton(iconName, displayName, entryName string, userDirsMap map
 	}
 	box, _ := gtk.BoxNew(gtk.ORIENTATION_HORIZONTAL, 0)
 	button, _ := gtk.ButtonNew()
+	button.SetAlwaysShowImage(true)
 	img, _ := gtk.ImageNewFromIconName(iconName, gtk.ICON_SIZE_MENU)
 	button.SetImage(img)
 
@@ -414,8 +441,16 @@ func setUpUserDirButton(iconName, displayName, entryName string, userDirsMap map
 	}
 	button.SetLabel(displayName)
 
-	button.Connect("clicked", func() {
-		launch(fmt.Sprintf("%s %s", *fileManager, userDirsMap[entryName]), false)
+	button.Connect("button-release-event", func(btn *gtk.Button, e *gdk.Event) bool {
+		btnEvent := gdk.EventButtonNewFromEvent(e)
+		if btnEvent.Button() == 1 {
+			open(userDirsMap[entryName], true)
+			return true
+		} else if btnEvent.Button() == 3 {
+			open(userDirsMap[entryName], false)
+			return true
+		}
+		return false
 	})
 
 	box.PackStart(button, false, true, 0)
@@ -430,6 +465,7 @@ func setUpUserFileSearchResultButton(fileName, filePath string) *gtk.Box {
 	if strings.HasPrefix(filePath, "#is_dir#") {
 		filePath = filePath[8:]
 		img, _ := gtk.ImageNewFromIconName("folder", gtk.ICON_SIZE_MENU)
+		button.SetAlwaysShowImage(true)
 		button.SetImage(img)
 	}
 
@@ -443,8 +479,20 @@ func setUpUserFileSearchResultButton(fileName, filePath string) *gtk.Box {
 		button.SetTooltipText(tooltipText)
 	}
 
-	button.Connect("clicked", func() {
-		open(filePath)
+	button.Connect("button-release-event", func(btn *gtk.Button, e *gdk.Event) bool {
+		btnEvent := gdk.EventButtonNewFromEvent(e)
+		if btnEvent.Button() == 1 {
+			open(filePath, true)
+			return true
+		} else if btnEvent.Button() == 3 {
+			open(filePath, false)
+			return true
+		}
+		return false
+	})
+
+	button.Connect("activate", func() {
+		open(filePath, true)
 	})
 
 	box.PackStart(button, false, true, 0)

xdgdesktop_parser.go

@@ -0,0 +1,78 @@
+package main
+
+import (
+	"bufio"
+	"fmt"
+	"io"
+	"os"
+	"strconv"
+	"strings"
+)
+
+func parseDesktopEntryFile(id string, path string) (e desktopEntry, err error) {
+	o, err := os.Open(path)
+	if err != nil {
+		return e, err
+	}
+	defer o.Close()
+
+	return parseDesktopEntry(id, o)
+}
+
+func parseDesktopEntry(id string, in io.Reader) (entry desktopEntry, err error) {
+	cleanexec := strings.NewReplacer("\"", "", "'", "")
+	entry.DesktopID = id
+	localizedName := fmt.Sprintf("Name[%s]", strings.Split(*lang, "_")[0])
+	localizedComment := fmt.Sprintf("Comment[%s]", strings.Split(*lang, "_")[0])
+	scanner := bufio.NewScanner(in)
+	scanner.Split(bufio.ScanLines)
+
+	for scanner.Scan() {
+		l := scanner.Text()
+		if strings.HasPrefix(l, "[") && l != "[Desktop Entry]" {
+			break
+		}
+
+		name, value := parseKeypair(l)
+		if value == "" {
+			continue
+		}
+
+		switch name {
+		case "Name":
+			entry.Name = value
+		case localizedName:
+			entry.NameLoc = value
+		case "Comment":
+			entry.Comment = value
+		case localizedComment:
+			entry.CommentLoc = value
+		case "Icon":
+			entry.Icon = value
+		case "Categories":
+			entry.Category = value
+		case "Terminal":
+			entry.Terminal, _ = strconv.ParseBool(value)
+		case "NoDisplay":
+			entry.NoDisplay, _ = strconv.ParseBool(value)
+		case "Exec":
+			entry.Exec = cleanexec.Replace(value)
+		}
+	}
+
+	// if name[ln] not found, let's try to find name[ln_LN]
+	if entry.NameLoc == "" {
+		entry.NameLoc = entry.Name
+	}
+	if entry.CommentLoc == "" {
+		entry.CommentLoc = entry.Comment
+	}
+	return entry, err
+}
+
+func parseKeypair(s string) (string, string) {
+	if idx := strings.IndexRune(s, '='); idx > 0 {
+		return strings.TrimSpace(s[:idx]), strings.TrimSpace(s[idx+1:])
+	}
+	return s, ""
+}

xdgdesktop_parser_test.go

@@ -0,0 +1,53 @@
+package main
+
+import (
+	"strings"
+	"testing"
+)
+
+var result desktopEntry
+
+func BenchmarkDesktopEntryParser(b *testing.B) {
+	var entry desktopEntry
+	for n := 0; n < b.N; n++ {
+		entry, _ = parseDesktopEntryFile("id", "./desktop-directories/game.directory")
+	}
+	result = entry
+}
+
+func TestWhitespaceHandling(t *testing.T) {
+	const whitespace = `[Desktop Entry]
+	Categories = Debugger; Development; Git; IDE; Programming; TextEditor; 
+	Comment = Editor for building and debugging modern web and cloud applications
+	Exec = bash -c "code-insiders ~/Workspaces/Linux/Flutter.code-workspace"
+	GenericName = Text Editor
+	Icon = vscode-flutter
+	Keywords = editor; IDE; plaintext; text; write; 
+	MimeType = application/x-shellscript; inode/directory; text/english; text/plain; text/x-c; text/x-c++; text/x-c++hdr; text/x-c++src; text/x-chdr; text/x-csrc; text/x-java; text/x-makefile; text/x-moc; text/x-pascal; text/x-tcl; text/x-tex; 
+	Name = VSCode Insiders with Flutter
+	Name[pt] = VSCode Insiders com Flutter
+	StartupNotify = true
+	StartupWMClass = code - insiders
+	Terminal = false
+	NoDisplay = false
+	Type = Application
+	Version = 1.0`
+
+	*lang = "pt"
+	entry, err := parseDesktopEntry("id", strings.NewReader(whitespace))
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	if entry.Name != "VSCode Insiders with Flutter" {
+		t.Error("failed to parse desktop entry name")
+	}
+
+	if entry.NameLoc != "VSCode Insiders com Flutter" {
+		t.Error("failed to parse localized name")
+	}
+
+	if entry.NoDisplay {
+		t.Error("failed to parse desktop entry no display")
+	}
+}