Global search

README.md

@@ -15,6 +15,7 @@ Dev Branch:
 - Browse by folder
 - Queue songs and albums
 - Create and play playlists
+- Search music library
 - Mark favorites
 - Volume control
 - Server-side scrobbling (e.g., on Navidrome, gonic)
@@ -81,7 +82,8 @@ spinner = '▁▂▃▄▅▆▇█▇▆▅▄▃▂▁'
 - `1`: Folder view
 - `2`: Queue view
 - `3`: Playlist view
-- `4`: Log (errors, etc.) view
+- `4`: Search view
+- `5`: Log (errors, etc.) view
 - `Escape`/`Return`: Close modal if open
 
 ### Playback Controls
@@ -133,6 +135,25 @@ spinner = '⣾⣽⣻⢿⡿⣟⣯⣷'
 
 The default is `▉▊▋▌▍▎▏▎▍▌▋▊▉`. Set only one of these at a time, and the glyphs must exist in the font that the terminal running stmps is using.
 
+### Search Controls
+
+The search tab performs a server-side search for text in metadata name fields.
+The search results are filtered into three columns: artist, album, and song. 20
+results (in each column) are fetched at a time; use `n` to load more results.
+
+In any of the columns:
+
+- `/`: Focus search field.
+- `Enter` / `a`: Adds the selected item recursively to the queue.
+- `n`: Load more search results.
+- Left/right arrow keys (`←`, `→`) navigate between the columns
+- Up/down arrow keys (`↓`, `↑`) navigate the selected column list
+
+In the search field:
+
+- `Enter`: Perform the query.
+- `Escape`: Escapes into the columns, where the global key bindings work.
+
 ## Advanced Configuration and Features
 
 ### MPRIS2 Integration

event_loop.go

@@ -45,7 +45,7 @@ func (ui *Ui) guiEventLoop() {
 		select {
 		case <-fpsTimer.C:
 			fpsTimer.Reset(10 * time.Second)
-			ui.logger.Printf("guiEventLoop: %f events per second", events/10.0)
+			// ui.logger.Printf("guiEventLoop: %f events per second", events/10.0)
 			events = 0
 
 		case msg := <-ui.logger.Prints:

gui.go

@@ -35,6 +35,9 @@ type Ui struct {
 	// playlist page
 	playlistPage *PlaylistPage
 
+	// search page
+	searchPage *SearchPage
+
 	// log page
 	logPage *LogPage
 
@@ -61,6 +64,7 @@ const (
 	PageBrowser   = "browser"
 	PageQueue     = "queue"
 	PagePlaylists = "playlists"
+	PageSearch    = "search"
 	PageLog       = "log"
 
 	PageDeletePlaylist = "deletePlaylist"
@@ -149,12 +153,16 @@ func InitGui(indexes *[]subsonic.SubsonicIndex,
 	// playlist page
 	ui.playlistPage = ui.createPlaylistPage()
 
+	// search page
+	ui.searchPage = ui.createSearchPage()
+
 	// log page
 	ui.logPage = ui.createLogPage()
 
 	ui.pages.AddPage(PageBrowser, ui.browserPage.Root, true, true).
 		AddPage(PageQueue, ui.queuePage.Root, true, false).
 		AddPage(PagePlaylists, ui.playlistPage.Root, true, false).
+		AddPage(PageSearch, ui.searchPage.Root, true, false).
 		AddPage(PageDeletePlaylist, ui.playlistPage.DeletePlaylistModal, true, false).
 		AddPage(PageNewPlaylist, ui.playlistPage.NewPlaylistModal, true, false).
 		AddPage(PageAddToPlaylist, ui.browserPage.AddToPlaylistModal, true, false).

gui_handlers.go

@@ -12,7 +12,7 @@ import (
 func (ui *Ui) handlePageInput(event *tcell.EventKey) *tcell.EventKey {
 	// we don't want any of these firing if we're trying to add a new playlist
 	focused := ui.app.GetFocus()
-	if ui.playlistPage.IsNewPlaylistInputFocused(focused) || ui.browserPage.IsSearchFocused(focused) {
+	if ui.playlistPage.IsNewPlaylistInputFocused(focused) || ui.browserPage.IsSearchFocused(focused) || focused == ui.searchPage.searchField {
 		return event
 	}
 
@@ -27,6 +27,9 @@ func (ui *Ui) handlePageInput(event *tcell.EventKey) *tcell.EventKey {
 		ui.ShowPage(PagePlaylists)
 
 	case '4':
+		ui.ShowPage(PageSearch)
+
+	case '5':
 		ui.ShowPage(PageLog)
 
 	case '?':
@@ -50,7 +53,6 @@ func (ui *Ui) handlePageInput(event *tcell.EventKey) *tcell.EventKey {
 		if err != nil {
 			ui.logger.PrintError("handlePageInput: Pause", err)
 		}
-		return nil
 
 	case 'P':
 		// stop playing without changes to queue
@@ -59,52 +61,49 @@ func (ui *Ui) handlePageInput(event *tcell.EventKey) *tcell.EventKey {
 		if err != nil {
 			ui.logger.PrintError("handlePageInput: Stop", err)
 		}
-		return nil
 
 	case 'X':
 		// debug stuff
 		ui.logger.Print("test")
 		//ui.player.Test()
 		ui.showMessageBox("foo bar")
-		return nil
 
 	case '-':
 		// volume-
 		if err := ui.player.AdjustVolume(-5); err != nil {
 			ui.logger.PrintError("handlePageInput: AdjustVolume-", err)
 		}
-		return nil
 
 	case '+', '=':
 		// volume+
 		if err := ui.player.AdjustVolume(5); err != nil {
 			ui.logger.PrintError("handlePageInput: AdjustVolume+", err)
 		}
-		return nil
 
 	case '.':
 		// <<
 		if err := ui.player.Seek(10); err != nil {
 			ui.logger.PrintError("handlePageInput: Seek+", err)
 		}
-		return nil
 
 	case ',':
 		// >>
 		if err := ui.player.Seek(-10); err != nil {
 			ui.logger.PrintError("handlePageInput: Seek-", err)
 		}
-		return nil
 
 	case '>':
 		// skip to next track
 		if err := ui.player.PlayNextTrack(); err != nil {
 			ui.logger.PrintError("handlePageInput: Next", err)
 		}
 		ui.queuePage.UpdateQueue()
+
+	default:
+		return event
 	}
 
-	return event
+	return nil
 }
 
 func (ui *Ui) ShowPage(name string) {

help_text.go

@@ -39,3 +39,16 @@ n     new playlist
 d     delete playlist
 a     add playlist or song to queue
 `
+
+const helpSearchPage = `
+artist, album, or song tab
+  Down    focus search field
+  Left    previous column
+  Right   next column
+  Enter   recursively add item to quue
+  a       recursively add item to quue
+  /       start search
+  n       load more results
+search field
+  Enter   search for text
+`

page_browser.go

@@ -82,7 +82,6 @@ func (ui *Ui) createBrowserPage(indexes *[]subsonic.SubsonicIndex) *BrowserPage
 		AddItem(browserPage.artistList, 0, 1, true).
 		AddItem(browserPage.entityList, 0, 1, false)
 
-	// TODO (A) add search-for-song, if feasible. Might be able to do server-side then drill-down, but we might also have all entities cached on the client already. To investigate.
 	browserPage.Root = tview.NewFlex().SetDirection(tview.FlexRow)
 	browserPage.showSearchField(false) // add artist/search items
 
@@ -254,8 +253,7 @@ func (b *BrowserPage) UpdateStars() {
 }
 
 func (b *BrowserPage) handleAddArtistToQueue() {
-	currentIndex := b.artistList.GetCurrentItem()
-	if currentIndex < 0 {
+	if b.artistList.GetCurrentItem() < 0 {
 		return
 	}
 

page_playlist.go

@@ -203,7 +203,7 @@ func (p *PlaylistPage) UpdatePlaylists() {
 		spinnerText = []rune("▉▊▋▌▍▎▏▎▍▌▋▊▉")
 	}
 	spinnerMax := len(spinnerText) - 1
-	playlistsButton := buttonOrder[2]
+	playlistsButton := buttonOrder[PAGE_PLAYLISTS]
 	stop := make(chan bool)
 	go func() {
 		var idx int
@@ -219,7 +219,7 @@ func (p *PlaylistPage) UpdatePlaylists() {
 					} else {
 						format = "%d: [red]%c[white]%s"
 					}
-					label := fmt.Sprintf(format, 3, spinnerText[idx], playlistsButton)
+					label := fmt.Sprintf(format, PAGE_PLAYLISTS+1, spinnerText[idx], playlistsButton)
 					p.ui.menuWidget.buttons[playlistsButton].SetLabel(label)
 					idx++
 					if idx > spinnerMax {
@@ -234,7 +234,7 @@ func (p *PlaylistPage) UpdatePlaylists() {
 					} else {
 						format = "%d: %s"
 					}
-					label := fmt.Sprintf(format, 3, playlistsButton)
+					label := fmt.Sprintf(format, PAGE_PLAYLISTS+1, playlistsButton)
 					p.ui.menuWidget.buttons[playlistsButton].SetLabel(label)
 				})
 				close(stop)