improve filtering & sorting albums

Author: tryffel

ui/ui.go

@@ -84,7 +84,7 @@ func bindDefaultTheme() {
 		ContrastSecondaryTextColor:  0,
 		PrimitiveBackgroundColor:    colors.Background,
 		ContrastBackgroundColor:     colors.Background,
-		MoreContrastBackgroundColor: colors.Modal.Background,
+		MoreContrastBackgroundColor: colors.Status.ProgressBar,
 		ContextMenuPaddingTop:       0,
 		ContextMenuPaddingBottom:    0,
 		ContextMenuPaddingLeft:      1,

ui/widgets/artist_albums.go

@@ -137,11 +137,12 @@ type AlbumList struct {
 	similarFunc    func(id models.Id)
 	similarEnabled bool
 
-	sort      *sort
-	filter    *filter
-	filterBtn *button
-	queryOpts *interfaces.QueryOpts
-	queryFunc func(opts *interfaces.QueryOpts)
+	sort          *sort
+	filter        *filter
+	filterBtn     *button
+	filterEnabled bool
+	queryOpts     *interfaces.QueryOpts
+	queryFunc     func(opts *interfaces.QueryOpts)
 }
 
 func (a *AlbumList) AddAlbum(c *AlbumCover) {
@@ -153,6 +154,7 @@ func (a *AlbumList) Clear() {
 	a.list.Clear()
 	//a.SetArtist(nil)
 	a.albumCovers = make([]*AlbumCover, 0)
+	a.filter.Clear()
 }
 
 // SetPlaylists sets albumList cover
@@ -194,8 +196,9 @@ func (a *AlbumList) EnableArtistMode(enabled bool) {
 func (a *AlbumList) selectPage(n int) {
 	a.paging.SetPage(n)
 	a.page.CurrentPage = n
-	if a.selectPageFunc != nil {
-		a.selectPageFunc(a.page)
+	a.queryOpts.Paging = a.page
+	if a.queryFunc != nil {
+		a.queryFunc(a.queryOpts)
 	}
 }
 
@@ -243,6 +246,14 @@ func (a *AlbumList) EnableSimilar(enabled bool) {
 	a.setButtons()
 }
 
+func (a *AlbumList) EnableFilter(enabled bool) {
+	a.filterEnabled = enabled
+	if enabled {
+		a.similarEnabled = false
+	}
+	a.setButtons()
+}
+
 func (a *AlbumList) setButtons() {
 	a.Banner.Grid.Clear()
 	selectables := []twidgets.Selectable{a.prevBtn, a.playBtn}
@@ -251,25 +262,29 @@ func (a *AlbumList) setButtons() {
 	a.Grid.AddItem(a.playBtn, 3, 2, 1, 1, 1, 10, false)
 
 	if a.pagingEnabled {
-		selectables = append(selectables, a.paging.Previous, a.paging.Next, a.filterBtn)
+		selectables = append(selectables, a.paging.Previous, a.paging.Next)
 		a.Grid.AddItem(a.paging, 3, 4, 1, 3, 1, 10, false)
-		//a.Grid.AddItem(a.sort, 3, 6, 1, 3, 1, 10, false)
-		a.Grid.AddItem(a.filterBtn, 3, 6, 1, 3, 1, 10, false)
 	}
-	/*
-		if a.similarEnabled {
-			selectables = append(selectables, a.options)
-			col := 4
-			if a.pagingEnabled {
-				col = 6
-			}
-			a.Grid.AddItem(a.options, 3, col, 1, 1, 1, 10, false)
+	if a.similarEnabled {
+		selectables = append(selectables, a.options)
+		col := 4
+		if a.pagingEnabled {
+			col = 6
 		}
+		a.Grid.AddItem(a.options, 3, col, 1, 1, 1, 10, false)
+	} else if a.filterEnabled {
+		selectables = append(selectables, a.sort, a.filterBtn)
+		col := 4
+		if a.pagingEnabled {
+			col = 6
+		}
+		a.Grid.AddItem(a.sort, 3, col, 1, 1, 1, 10, false)
+		a.Grid.AddItem(a.filterBtn, 3, col+2, 1, 1, 1, 10, false)
+	}
 
-	*/
 	selectables = append(selectables, a.list)
 	a.Banner.Selectable = selectables
-	a.Grid.AddItem(a.list, 4, 0, 1, 8, 6, 20, false)
+	a.Grid.AddItem(a.list, 4, 0, 1, 10, 6, 20, false)
 }
 
 //NewAlbumList constructs new albumList view
@@ -302,20 +317,21 @@ func NewAlbumList(selectAlbum func(album *models.Album), context contextOperator
 		)
 	}
 
-	a.filter = newFilter("artist", a.setFilter)
+	a.filter = newFilter("album", a.setFilter, a.filterApplied)
 	a.filterBtn = newButton("Filter")
 	a.filterBtn.SetSelectedFunc(func() {
 		if filterFunc != nil {
 			filterFunc(a.filter, nil)
 		}
 	})
+	a.filterEnabled = true
 
 	selectables := []twidgets.Selectable{a.prevBtn, a.playBtn, a.options,
 		a.paging.Previous, a.paging.Next, a.sort, a.filterBtn, a.list}
 	a.Banner.Selectable = selectables
 
 	a.Grid.SetRows(1, 1, 1, 1, -1)
-	a.Grid.SetColumns(6, 2, 10, -1, 10, -1, 10, -3)
+	a.Grid.SetColumns(6, 2, 10, -1, 10, -1, 15, -1, 10, -3)
 	a.Grid.SetMinSize(1, 6)
 	a.Grid.SetBackgroundColor(config.Color.Background)
 	a.list.Grid.SetColumns(1, -1)
@@ -348,6 +364,14 @@ func NewAlbumList(selectAlbum func(album *models.Album), context contextOperator
 	return a
 }
 
+func (a *AlbumList) filterApplied(status bool) {
+	if status {
+		a.filterBtn.SetLabel("Filter *")
+	} else {
+		a.filterBtn.SetLabel("Filter")
+	}
+}
+
 func (a *AlbumList) InputHandler() func(event *tcell.EventKey, setFocus func(p cview.Primitive)) {
 	return func(event *tcell.EventKey, setFocus func(p cview.Primitive)) {
 		if event.Key() == tcell.KeyEnter && event.Modifiers() == tcell.ModAlt {

ui/widgets/filter.go

@@ -40,6 +40,7 @@ type queryFunc = func(opts *interfaces.QueryOpts)
 type sortFunc = func(sort interfaces.Sort)
 type openFilterFunc = func(m modal.Modal, doneFunc func())
 
+// sort provides dropdown for sorting
 type sort struct {
 	*dropDown
 	currentIndex int
@@ -90,6 +91,7 @@ func (s *sort) toggleMode() {
 	}
 }
 
+// filter provides a modal for defining filters
 type filter struct {
 	*cview.Form
 	filterFunc func(interfaces.Filter)
@@ -103,6 +105,8 @@ type filter struct {
 	itemFavorite *cview.Checkbox
 
 	yearRange *cview.InputField
+
+	filterChangedFunc func(bool)
 }
 
 func (f *filter) SetDoneFunc(doneFunc func()) {
@@ -117,7 +121,7 @@ func (f *filter) SetVisible(visible bool) {
 	f.visible = visible
 }
 
-func newFilter(itemType string, filterFunc func(f interfaces.Filter)) *filter {
+func newFilter(itemType string, filterFunc func(f interfaces.Filter), filterChangedFunc func(bool)) *filter {
 
 	f := &filter{
 		Form:       cview.NewForm(),
@@ -127,10 +131,11 @@ func newFilter(itemType string, filterFunc func(f interfaces.Filter)) *filter {
 		itemNotPlayed: cview.NewCheckbox(),
 		itemFavorite:  cview.NewCheckbox(),
 		yearRange:     cview.NewInputField(),
+
+		filterChangedFunc: filterChangedFunc,
 	}
 
 	f.SetTitle(fmt.Sprintf(" Filter %ss ", itemType))
-
 	f.SetBackgroundColor(config.Color.Modal.Background)
 	f.SetBorder(true)
 	f.AddFormItem(f.itemPlayed)
@@ -153,8 +158,19 @@ func newFilter(itemType string, filterFunc func(f interfaces.Filter)) *filter {
 	f.AddFormItem(f.yearRange)
 
 	f.AddButton("Filter", f.ok)
-	f.AddButton("Cancel", f.closeCb)
+	f.AddButton("Cancel", f.cancel)
+
+	f.GetButton(0).SetInputCapture(f.inputCapture)
+	f.GetButton(1).SetInputCapture(f.inputCapture)
+
+	f.SetInputCapture(f.inputCapture)
+
+	f.itemPlayed.SetInputCapture(f.inputCapture)
+	f.itemNotPlayed.SetInputCapture(f.inputCapture)
+	f.itemFavorite.SetInputCapture(f.inputCapture)
+	f.yearRange.SetInputCapture(f.inputCapture)
 
+	f.SetCancelFunc(f.cancel)
 	return f
 }
 
@@ -232,6 +248,26 @@ func (f *filter) ok() {
 	}
 	f.filterFunc(filt)
 	f.closeCb()
+
+	if f.filterChangedFunc != nil {
+		f.filterChangedFunc(true)
+	}
+}
+
+func (f *filter) cancel() {
+	if f.closeCb != nil {
+		f.closeCb()
+	}
+}
+
+func (f *filter) Clear() {
+	f.itemPlayed.SetChecked(false)
+	f.itemNotPlayed.SetChecked(false)
+	f.itemFavorite.SetChecked(false)
+	f.yearRange.SetText("")
+	if f.filterChangedFunc != nil {
+		f.filterChangedFunc(false)
+	}
 }
 
 func (f *filter) InputHandler() func(event *tcell.EventKey, setFocus func(p cview.Primitive)) {
@@ -243,3 +279,25 @@ func (f *filter) InputHandler() func(event *tcell.EventKey, setFocus func(p cvie
 		f.Form.InputHandler()(event, setFocus)
 	}
 }
+
+func (f *filter) inputCapture(e *tcell.EventKey) *tcell.EventKey {
+	key := e.Key()
+	r := e.Rune()
+
+	switch key {
+	case tcell.KeyUp:
+		return tcell.NewEventKey(tcell.KeyBacktab, e.Rune(), e.Modifiers())
+	case tcell.KeyDown:
+		return tcell.NewEventKey(tcell.KeyTab, e.Rune(), e.Modifiers())
+	}
+
+	switch r {
+	case 'k':
+		return tcell.NewEventKey(tcell.KeyBacktab, e.Rune(), e.Modifiers())
+	case 'j':
+		return tcell.NewEventKey(tcell.KeyTab, e.Rune(), e.Modifiers())
+	}
+
+	return e
+
+}

ui/widgets/util.go

@@ -96,6 +96,7 @@ func newDropDown(text string) *dropDown {
 	d.SetBackgroundColor(config.Color.ButtonBackground)
 	d.SetFieldBackgroundColor(config.Color.ButtonBackground)
 	d.SetFieldTextColor(config.Color.Text)
+	d.SetPrefixTextColor(config.Color.ButtonBackgroundSelected)
 	d.SetBorder(false)
 	d.SetBorderPadding(0, 0, 1, 2)
 

ui/widgets/window.go

@@ -378,6 +378,7 @@ func (w *Window) showSearchResults(itemType models.ItemType, results []models.It
 		}
 		w.albumList.Clear()
 		w.albumList.EnablePaging(false)
+		w.albumList.EnableFilter(false)
 		w.albumList.SetLabel(fmt.Sprintf("[yellow::]Search results for '%s'[-::]\n%d albums", query, len(results)))
 		w.albumList.SetAlbums(albums)
 		w.albumList.EnableSimilar(false)
@@ -600,11 +601,13 @@ func (w *Window) selectMedia(m MediaSelect) {
 			albums, total, err = w.mediaItems.GetAlbums(opts)
 			title = "All Albums"
 			w.albumList.EnablePaging(true)
+			w.albumList.EnableFilter(true)
 		} else if m == MediaFavoriteAlbums {
 			paging.PageSize = 200
 			albums, total, err = w.mediaItems.GetFavoriteAlbums(paging)
 			title = "Favorite albums"
 			w.albumList.EnablePaging(false)
+			w.albumList.EnableFilter(false)
 			list = w.favoriteAlbums
 		}
 
@@ -738,6 +741,7 @@ func (w *Window) showAlbumPage(opts *interfaces.QueryOpts) {
 	w.albumList.SetPage(opts.Paging)
 	w.albumList.Clear()
 	w.albumList.EnablePaging(true)
+	w.albumList.EnableFilter(true)
 	w.albumList.SetAlbums(albums)
 }
 
@@ -787,6 +791,7 @@ func (w *Window) showSimilarAlbums(album *models.Album) {
 		w.similarAlbums.Clear()
 		w.similarAlbums.EnableSimilar(false)
 		w.similarAlbums.EnablePaging(false)
+		w.similarAlbums.EnableFilter(false)
 		w.similarAlbums.SetAlbums(albums)
 		w.similarAlbums.SetText(fmt.Sprintf("Similar albums: %d", len(albums)))
 		w.setViewWidget(w.similarAlbums, true)