feat(spotify): add linux support

Author: luisegarduno

src/segments/spotify_linux.go

@@ -0,0 +1,86 @@
+//go:build linux && !darwin && !windows
+
+package segments
+
+import (
+	"strings"
+
+	"github.com/jandedobbeleer/oh-my-posh/src/shell"
+)
+
+func (s *Spotify) Enabled() bool {
+	// Check if we're in WSL and handle that separately
+	if s.env.IsWsl() {
+		return s.enabledWsl()
+	}
+
+	// Standard Linux implementation
+	running := s.runLinuxScriptCommand(" string:PlaybackStatus | awk -F '\"' '/string/ {print tolower($2)}'")
+
+	if strings.HasPrefix(running, "Error") {
+		return false
+	}
+
+	if strings.Contains(running, "Error.ServiceUnknown") || strings.HasSuffix(running, "-") {
+		s.Status = stopped
+		return false
+	}
+
+	if running == stopped {
+		s.Status = stopped
+		return false
+	}
+
+	s.Status = running
+	s.Artist = s.runLinuxScriptCommand(" string:Metadata | awk -F '\"' 'BEGIN {RS=\"entry\"}; /'xesam:artist'/ {a=$4} END {print a}'")
+	s.Track = s.runLinuxScriptCommand(" string:Metadata | awk -F '\"' 'BEGIN {RS=\"entry\"}; /'xesam:title'/ {t=$4} END {print t}'")
+	s.resolveIcon()
+
+	return true
+}
+
+func (s *Spotify) runLinuxScriptCommand(command string) string {
+	dbusCMD := "dbus-send --print-reply --dest=org.mpris.MediaPlayer2.spotify /org/mpris/MediaPlayer2 org.freedesktop.DBus.Properties.Get string:org.mpris.MediaPlayer2.Player"
+	val := s.env.RunShellCommand(shell.BASH, dbusCMD+command)
+	return val
+}
+
+// Implementation for WSL - moved from spotify_wsl.go
+func (s *Spotify) enabledWsl() bool {
+	tlist, err := s.env.RunCommand("tasklist.exe", "/V", "/FI", "Imagename eq Spotify.exe", "/FO", "CSV", "/NH")
+	if err != nil || strings.HasPrefix(tlist, "INFO") {
+		return false
+	}
+
+	records := strings.Split(tlist, "\n")
+	if len(records) == 0 {
+		return false
+	}
+
+	for _, record := range records {
+		record = strings.TrimSpace(record)
+		fields := strings.Split(record, ",")
+		if len(fields) == 0 {
+			continue
+		}
+
+		// last elemant is the title
+		title := fields[len(fields)-1]
+		// trim leading and trailing quotes from the field
+		title = strings.TrimPrefix(title, `"`)
+		title = strings.TrimSuffix(title, `"`)
+		if !strings.Contains(title, " - ") {
+			continue
+		}
+
+		infos := strings.Split(title, " - ")
+		s.Artist = infos[0]
+		s.Track = strings.Join(infos[1:], " - ")
+		s.Status = playing
+		s.resolveIcon()
+
+		return true
+	}
+
+	return false
+}

src/segments/spotify_linux_test.go

@@ -0,0 +1,49 @@
+//go:build linux && !darwin && !windows
+
+package segments
+
+import (
+	"errors"
+	"testing"
+
+	"github.com/jandedobbeleer/oh-my-posh/src/properties"
+	"github.com/jandedobbeleer/oh-my-posh/src/runtime/mock"
+	"github.com/jandedobbeleer/oh-my-posh/src/shell"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestSpotifyLinux(t *testing.T) {
+	cases := []struct {
+		Error    error
+		Expected string
+		Status   string
+		Artist   string
+		Track    string
+		Running  bool
+	}{
+		{Running: false, Expected: ""},
+		{Running: false, Expected: "", Error: errors.New("oops")},
+		{Running: true, Expected: "\uF8E3 Candlemass - Spellbreaker", Status: "paused", Artist: "Candlemass", Track: "Spellbreaker"},
+		{Running: true, Expected: "\uE602 Candlemass - Spellbreaker", Status: "playing", Artist: "Candlemass", Track: "Spellbreaker"},
+	}
+	for _, tc := range cases {
+		env := new(mock.Environment)
+		env.On("IsWsl").Return(false)
+
+		dbusCMD := "dbus-send --print-reply --dest=org.mpris.MediaPlayer2.spotify /org/mpris/MediaPlayer2 org.freedesktop.DBus.Properties.Get string:org.mpris.MediaPlayer2.Player"
+		env.On("RunShellCommand", shell.BASH, dbusCMD+" string:PlaybackStatus | awk -F '\"' '/string/ {print tolower($2)}'").Return(tc.Status, nil)
+		env.On("RunShellCommand", shell.BASH, dbusCMD+" string:Metadata | awk -F '\"' 'BEGIN {RS=\"entry\"}; /'xesam:artist'/ {a=$4} END {print a}'").Return(tc.Artist, nil)
+		env.On("RunShellCommand", shell.BASH, dbusCMD+" string:Metadata | awk -F '\"' 'BEGIN {RS=\"entry\"}; /'xesam:title'/ {t=$4} END {print t}'").Return(tc.Track, nil)
+
+		s := &Spotify{}
+		s.Init(properties.Map{}, env)
+
+		enable := s.Enabled()
+		assert.True(t, enable)
+		if tc.Running {
+			assert.True(t, s.Enabled())
+			assert.Equal(t, tc.Expected, renderTemplate(env, s.Template(), s))
+		}
+	}
+}

src/segments/spotify_wsl.go

@@ -6,12 +6,12 @@ sidebar_label: Spotify
 
 ## What
 
-Show the currently playing song in the [Spotify][spotify] macOS/Windows clients.
+Show the currently playing song in the [Spotify][spotify] client.
 
 :::caution
 Be aware this can make the prompt a tad bit slower as it needs to get a response from the Spotify player.
 
-On _macOS_, all states are supported (playing/paused/stopped).
+On _macOS & Linux_, all states are supported (playing/paused/stopped).
 
 On _Windows/WSL_, **only the playing state is supported** (no information when paused/stopped). It supports
 fetching information from the native Spotify application and Edge PWA.