Merge pull request #25 from nwg-piotr/logging

Logging + 1 bug fixed

Makefile

@@ -5,6 +5,7 @@ get:
 	go get github.com/dlasky/gotk3-layershell/layershell
 	go get github.com/joshuarubin/go-sway
 	go get github.com/allan-simon/go-singleinstance
+	go get "github.com/sirupsen/logrus"
 
 build:
 	go build -o bin/nwg-drawer *.go
@@ -20,4 +21,5 @@ uninstall:
 	rm /usr/bin/nwg-drawer
 
 run:
-	go run *.go
+	go build -o bin/nwg-drawer *.go
+	bin/nwg-drawer

README.md

@@ -82,6 +82,8 @@ 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.

go.mod

@@ -7,4 +7,5 @@ require (
 	github.com/dlasky/gotk3-layershell v0.0.0-20210331230524-5cca0b819261
 	github.com/gotk3/gotk3 v0.6.0
 	github.com/joshuarubin/go-sway v0.0.4
+	github.com/sirupsen/logrus v1.8.1
 )

go.sum

@@ -1,7 +1,8 @@
 github.com/allan-simon/go-singleinstance v0.0.0-20210120080615-d0997106ab37 h1:28uU3TtuvQ6KRndxg9TrC868jBWmSKgh0GTXkACCXmA=
 github.com/allan-simon/go-singleinstance v0.0.0-20210120080615-d0997106ab37/go.mod h1:6AXRstqK+32jeFmw89QGL2748+dj34Av4xc/I9oo9BY=
-github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/dlasky/gotk3-layershell v0.0.0-20210331230524-5cca0b819261 h1:eoXn91ckLWKMXmQKX34UHEF2XMyQpRnnP80fDiu+kys=
 github.com/dlasky/gotk3-layershell v0.0.0-20210331230524-5cca0b819261/go.mod h1:d56Gslp3IaiT8lqxD/lO1Msz1wYgD8D/HTKHgSdg9tU=
 github.com/gotk3/gotk3 v0.5.3-0.20210223154815-289cfb6dbf32/go.mod h1:/hqFpkNa9T3JgNAE2fLvCdov7c5bw//FHNZrZ3Uv9/Q=
@@ -13,7 +14,10 @@ github.com/joshuarubin/lifecycle v1.0.0 h1:N/lPEC8f+dBZ1Tn99vShqp36LwB+LI7XNAiNa
 github.com/joshuarubin/lifecycle v1.0.0/go.mod h1:sRy++ATvR9Ee21tkRdFkQeywAWvDsue66V70K0Dnl54=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/sirupsen/logrus v1.8.1 h1:dJKuHgqk1NNQlqoA6BTlM1Wf9DOH3NBjQyu0h9+AZZE=
+github.com/sirupsen/logrus v1.8.1/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic61uBYv0=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
 github.com/stretchr/testify v1.3.0 h1:TivCn/peBQ7UY8ooIcPgZFpTNSz0Q2U6UrFlUfqbe0Q=
 github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
 go.uber.org/atomic v1.3.2 h1:2Oa65PReHzfn29GpvgsYwloV9AVFHPDk8tYxt2c2tr4=
@@ -22,3 +26,5 @@ go.uber.org/multierr v1.1.0 h1:HoEmRHQPVSqub6w2z2d2EOVs2fjyFRGyofhKuyDq0QI=
 go.uber.org/multierr v1.1.0/go.mod h1:wR5kodmAFQ0UK8QlbwjlSNy0Z68gJhDJUG5sjR94q/0=
 golang.org/x/sync v0.0.0-20190412183630-56d357773e84 h1:IqXQ59gzdXv58Jmm2xn0tSOR9i6HqroaOFRQ3wR/dJQ=
 golang.org/x/sync v0.0.0-20190412183630-56d357773e84/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
+golang.org/x/sys v0.0.0-20191026070338-33540a1f6037 h1:YyJpGZS1sBuBCzLAR1VEpK193GlqGZbnPFnPV/5Rsb4=
+golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=

main.go

@@ -3,7 +3,6 @@ package main
 import (
 	"flag"
 	"fmt"
-	"log"
 	"os"
 	"os/signal"
 	"path/filepath"
@@ -12,6 +11,8 @@ import (
 	"syscall"
 	"time"
 
+	log "github.com/sirupsen/logrus"
+
 	"github.com/allan-simon/go-singleinstance"
 	"github.com/dlasky/gotk3-layershell/layershell"
 	"github.com/gotk3/gotk3/gdk"
@@ -19,7 +20,7 @@ import (
 	"github.com/gotk3/gotk3/gtk"
 )
 
-const version = "0.1.9"
+const version = "0.1.12"
 
 var (
 	appDirs         []string
@@ -59,6 +60,7 @@ type desktopEntry struct {
 	CommentLoc string
 	Icon       string
 	Exec       string
+	Category   string
 	Terminal   bool
 	NoDisplay  bool
 }
@@ -98,6 +100,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)")
@@ -109,7 +121,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")
@@ -130,7 +142,7 @@ func main() {
 		for {
 			s := <-signalChan
 			if s == syscall.SIGTERM {
-				println("SIGTERM received, bye bye!")
+				log.Info("SIGTERM received, bye bye!")
 				gtk.MainQuit()
 			}
 		}
@@ -144,7 +156,7 @@ func main() {
 		if err == nil {
 			i, err := strconv.Atoi(pid)
 			if err == nil {
-				println("Running instance found, sending SIGTERM and exiting...")
+				log.Info("Running instance found, sending SIGTERM and exiting...")
 				syscall.Kill(i, syscall.SIGTERM)
 			}
 		}
@@ -156,7 +168,7 @@ func main() {
 	if *lang == "" && os.Getenv("LANG") != "" {
 		*lang = strings.Split(os.Getenv("LANG"), ".")[0]
 	}
-	println(fmt.Sprintf("lang: %s", *lang))
+	log.Info(fmt.Sprintf("lang: %s", *lang))
 
 	// ENVIRONMENT
 	configDirectory = configDir()
@@ -176,7 +188,7 @@ func main() {
 	if err != nil {
 		pinned = nil
 	}
-	println(fmt.Sprintf("Found %v pinned items", len(pinned)))
+	log.Info(fmt.Sprintf("Found %v pinned items", len(pinned)))
 
 	cssFile := filepath.Join(configDirectory, *cssFileName)
 
@@ -185,7 +197,7 @@ func main() {
 	setUpCategories()
 
 	desktopFiles := listDesktopFiles()
-	println(fmt.Sprintf("Found %v desktop files", len(desktopFiles)))
+	log.Info(fmt.Sprintf("Found %v desktop files", len(desktopFiles)))
 
 	status = parseDesktopFiles(desktopFiles)
 
@@ -194,9 +206,9 @@ func main() {
 	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))
+		log.Error(fmt.Sprintf("Custom associations file %s not found or invalid", paFile))
 	} else {
-		println(fmt.Sprintf("Found %v associations in %s", len(preferredApps), paFile))
+		log.Info(fmt.Sprintf("Found %v associations in %s", len(preferredApps), paFile))
 	}
 
 	// USER INTERFACE
@@ -206,10 +218,10 @@ 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))
+		log.Errorf("ERROR: %s css file not found or erroneous. Using GTK styling.", cssFile)
+		log.Errorf("%s", err)
 	} else {
-		println(fmt.Sprintf("Using style from %s", cssFile))
+		log.Info(fmt.Sprintf("Using style from %s", cssFile))
 		screen, _ := gdk.ScreenGetDefault()
 		gtk.AddProviderForScreen(screen, cssProvider, gtk.STYLE_PROVIDER_PRIORITY_APPLICATION)
 	}
@@ -231,7 +243,7 @@ func main() {
 				layershell.SetMonitor(win, monitor)
 
 			} else {
-				println(err)
+				log.Errorf("%s", err)
 			}
 		}
 
@@ -296,7 +308,7 @@ func main() {
 		This feature is not really supported and will stay undocumented.
 	*/
 	if !wayland() {
-		println("Not Wayland, oh really?")
+		log.Info("Not Wayland, oh really?")
 		win.SetDecorated(false)
 		win.Maximize()
 	}
@@ -389,6 +401,6 @@ func main() {
 	}
 
 	t := time.Now()
-	println(fmt.Sprintf("UI created in %v ms. Thank you for your patience.", t.Sub(timeStart).Milliseconds()))
+	log.Info(fmt.Sprintf("UI created in %v ms. Thank you for your patience.", t.Sub(timeStart).Milliseconds()))
 	gtk.Main()
 }

tools.go

@@ -8,7 +8,6 @@ import (
 	"io"
 	"io/fs"
 	"io/ioutil"
-	"log"
 	"os"
 	"os/exec"
 	"path/filepath"
@@ -17,6 +16,8 @@ import (
 	"strings"
 	"time"
 
+	log "github.com/sirupsen/logrus"
+
 	"github.com/gotk3/gotk3/gdk"
 	"github.com/gotk3/gotk3/glib"
 	"github.com/gotk3/gotk3/gtk"
@@ -49,7 +50,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)
+			log.Errorf("%s", err)
 			return nil, err
 		}
 		return pixbuf, nil
@@ -92,7 +93,7 @@ func mapXdgUserDirs() map[string]string {
 
 	userDirsFile := filepath.Join(home, ".config/user-dirs.dirs")
 	if pathExists(userDirsFile) {
-		println(fmt.Sprintf("Using XDG user dirs from %s", userDirsFile))
+		log.Info(fmt.Sprintf("Using XDG user dirs from %s", userDirsFile))
 		lines, _ := loadTextFile(userDirsFile)
 		for _, l := range lines {
 			if strings.HasPrefix(l, "XDG_DOCUMENTS_DIR") {
@@ -116,7 +117,7 @@ func mapXdgUserDirs() map[string]string {
 			}
 		}
 	} else {
-		println(fmt.Sprintf("%s file not found, using defaults", userDirsFile))
+		log.Warnf("%s file not found, using defaults", userDirsFile)
 	}
 
 	return result
@@ -177,13 +178,13 @@ func createDir(dir string) {
 	if _, err := os.Stat(dir); os.IsNotExist(err) {
 		err := os.MkdirAll(dir, os.ModePerm)
 		if err == nil {
-			fmt.Println("Creating dir:", dir)
+			log.Infof("Creating dir: %s", dir)
 		}
 	}
 }
 
 func copyFile(src, dst string) error {
-	fmt.Println("Copying file:", dst)
+	log.Infof("Copying file: %s", dst)
 
 	var err error
 	var srcfd *os.File
@@ -350,109 +351,35 @@ 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
 	})
 	summary := fmt.Sprintf("%v entries (+%v hidden)", len(desktopEntries)-hidden, hidden)
-	println(fmt.Sprintf("Skipped %v duplicates; %v .desktop entries hidden by \"NoDisplay=true\"", skipped, hidden))
+	log.Infof("Skipped %v duplicates; %v .desktop entries hidden by \"NoDisplay=true\"", skipped, hidden)
 	return summary
 }
 
@@ -545,20 +472,20 @@ func loadTextFile(path string) ([]string, error) {
 func pinItem(itemID string) {
 	for _, item := range pinned {
 		if item == itemID {
-			println(item, "already pinned")
+			log.Warn(item, "already pinned")
 			return
 		}
 	}
 	pinned = append(pinned, itemID)
 	savePinned()
-	println(itemID, "pinned")
+	log.Infof("%s pinned", itemID)
 }
 
 func unpinItem(itemID string) {
 	if isIn(pinned, itemID) {
 		pinned = remove(pinned, itemID)
 		savePinned()
-		println(itemID, "unpinned")
+		log.Infof("%s unpinned", itemID)
 	}
 }
 
@@ -584,7 +511,7 @@ func savePinned() {
 			_, err := f.WriteString(line + "\n")
 
 			if err != nil {
-				println("Error saving pinned", err)
+				log.Errorf("Error saving pinned", err)
 			}
 		}
 	}
@@ -634,7 +561,7 @@ func launch(command string, terminal bool) {
 	}
 
 	msg := fmt.Sprintf("env vars: %s; command: '%s'; args: %s\n", envVars, elements[cmdIdx], elements[1+cmdIdx:])
-	println(msg)
+	log.Info(msg)
 
 	go cmd.Run()
 

uicomponents.go

@@ -263,6 +263,7 @@ func flowBoxButton(entry desktopEntry) *gtk.Button {
 		} else if btnEvent.Button() == 3 {
 			pinItem(ID)
 			pinnedFlowBox = setUpPinnedFlowBox()
+			return true
 		}
 		return false
 	})

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")
+	}
+}