Merge pull request #524 from dweymouth/feature/toasts

dweymouth · web-flow · commit f1621feaa6c3 · 2025-01-05T17:29:21.000-08:00
Show success/error "toast" message when adding tracks to playlists
diff --git a/res/translations/de.json b/res/translations/de.json
@@ -239,5 +239,10 @@
     "Sept": "Sept",
     "Oct": "Okt",
     "Nov": "Nov",
-    "Dec": "Dec"
+    "Dec": "Dec",
+
+    "playlist.addedtracks": {
+        "one": "Added {{.trackCount}} track to playlist",
+        "other": "Added {{.trackCount}} tracks to playlist"
+    }
 }
diff --git a/res/translations/en.json b/res/translations/en.json
@@ -17,6 +17,7 @@
     "All": "All",
     "All Tracks": "All Tracks",
     "Alt. URL": "Alt. URL",
+    "An error occurred adding tracks to the playlist": "An error occurred adding tracks to the playlist",
     "Are you sure you want to delete the server": "Are you sure you want to delete the server",
     "Artist": "Artist",
     "Artist (A-Z)": "Artist (A-Z)",
@@ -69,6 +70,7 @@
     "Enter": "Enter",
     "EP": "EP",
     "Equalizer": "Equalizer",
+    "Error": "Error",
     "Exclusive mode": "Exclusive mode",
     "Favorites": "Favorites",
     "Field Recording": "Field Recording",
@@ -188,6 +190,7 @@
     "Spoken Word": "Spoken Word",
     "Startup page": "Startup page",
     "Stopped": "Stopped",
+    "Success": "Success",
     "Support the project": "Support the project",
     "Switch Servers": "Switch Servers",
     "Testing connection": "Testing connection",
@@ -242,5 +245,10 @@
     "Sept": "Sept",
     "Oct": "Oct",
     "Nov": "Nov",
-    "Dec": "Dec"
+    "Dec": "Dec",
+
+    "playlist.addedtracks": {
+        "one": "Added one track to playlist",
+        "other": "Added {{.trackCount}} tracks to playlist"
+    }
 }
diff --git a/res/translations/es.json b/res/translations/es.json
@@ -17,6 +17,7 @@
     "All": "Todos",
     "All Tracks": "Todas las pistas",
     "Alt. URL": "URL alternativa",
+    "An error occurred adding tracks to the playlist": "Ha ocurrido un error al añadir pistas a la lista de reproducción",
     "Are you sure you want to delete the server": "¿Estás seguro de que quieres eliminar el servidor?",
     "Artist": "Artista",
     "Artist (A-Z)": "Artista (A-Z)",
@@ -69,6 +70,7 @@
     "Enter": "Ingresar",
     "EP": "EP",
     "Equalizer": "Ecualizador",
+    "Error": "Error",
     "Exclusive mode": "Modo exclusivo",
     "Favorites": "Favoritos",
     "Field Recording": "Grabación en campo",
@@ -187,6 +189,7 @@
     "Spoken Word": "Palabra Hablada",
     "Startup page": "Página de inicio",
     "Stopped": "Detenida",
+    "Success": "Éxito",
     "Support the project": "Apoya el proyecto",
     "Switch Servers": "Cambiar servidores",
     "Testing connection": "Probando conexión",
@@ -241,5 +244,10 @@
     "Sept": "Set",
     "Oct": "Oct",
     "Nov": "Nov",
-    "Dec": "Dic"
+    "Dec": "Dic",
+
+    "playlist.addedtracks": {
+        "one": "Se ha añadido una pista a la lista de reproducción",
+        "other": "Se han añadido {{.trackCount}} pistas a la lista de reproducción"
+    }
 }
diff --git a/res/translations/fr.json b/res/translations/fr.json
@@ -240,5 +240,10 @@
     "Sept": "Sept",
     "Oct": "Oct",
     "Nov": "Nov",
-    "Dec": "Déc"
+    "Dec": "Déc",
+
+    "playlist.addedtracks": {
+        "one": "Une piste ajoutée à la liste de lecture",
+        "other": "{{.trackCount}} pistes ajoutées à la liste de lecture"
+    }
 }
diff --git a/res/translations/it.json b/res/translations/it.json
@@ -238,5 +238,10 @@
     "Sept": "Set",
     "Oct": "Ott",
     "Nov": "Nov",
-    "Dec": "Dic"
+    "Dec": "Dic",
+
+    "playlist.addedtracks": {
+        "one": "Added {{.trackCount}} track to playlist",
+        "other": "Added {{.trackCount}} tracks to playlist"
+    }
 }
diff --git a/res/translations/ja.json b/res/translations/ja.json
@@ -228,5 +228,10 @@
     "Remove from queue": "キューから削除",
     "Play song radio": "曲をラジオで再生",
     "to":"to",
-    "by":"by"
+    "by":"by",
+
+    "playlist.addedtracks": {
+        "one": "Added {{.trackCount}} track to playlist",
+        "other": "Added {{.trackCount}} tracks to playlist"
+    }
 }
diff --git a/res/translations/pl.json b/res/translations/pl.json
@@ -228,5 +228,10 @@
     "Remove from queue": "Usuń z kolejki odtwarzania",
     "Play song radio": "Odtwórz mix utworów",
     "to":"do",
-    "by":"przez"
+    "by":"przez",
+
+    "playlist.addedtracks": {
+        "one": "Added {{.trackCount}} track to playlist",
+        "other": "Added {{.trackCount}} tracks to playlist"
+    }
 }
diff --git a/res/translations/pt_BR.json b/res/translations/pt_BR.json
@@ -228,5 +228,10 @@
     "Remove from queue": "Remover da fila",
     "Play song radio": "Reproduzir rádio da faixa",
     "to":"a",
-    "by":"de"
+    "by":"de",
+
+    "playlist.addedtracks": {
+        "one": "Added {{.trackCount}} track to playlist",
+        "other": "Added {{.trackCount}} tracks to playlist"
+    }
 }
diff --git a/res/translations/ro.json b/res/translations/ro.json
@@ -230,5 +230,10 @@
     "Sept": "Sept",
     "Oct": "Oct",
     "Nov": "Noiem",
-    "Dec": "Dec"
+    "Dec": "Dec",
+
+    "playlist.addedtracks": {
+        "one": "Added {{.trackCount}} track to playlist",
+        "other": "Added {{.trackCount}} tracks to playlist"
+    }
 }
diff --git a/res/translations/zh.json b/res/translations/zh.json
@@ -216,5 +216,10 @@
     "Unset favorite": "取消收藏",
     "Remove from queue": "从队列中移除",
     "Size": "大小",
-    "Play song radio": "播放歌曲电台"
+    "Play song radio": "播放歌曲电台",
+
+    "playlist.addedtracks": {
+        "one": "Added {{.trackCount}} track to playlist",
+        "other": "Added {{.trackCount}} tracks to playlist"
+    }
 }
diff --git a/res/translations/zhHans.json b/res/translations/zhHans.json
@@ -216,5 +216,10 @@
     "Unset favorite": "取消收藏",
     "Remove from queue": "从队列中移除",
     "Size": "大小",
-    "Play song radio": "播放歌曲电台"
+    "Play song radio": "播放歌曲电台",
+
+    "playlist.addedtracks": {
+        "one": "Added {{.trackCount}} track to playlist",
+        "other": "Added {{.trackCount}} tracks to playlist"
+    }
 }
diff --git a/ui/controller/controller.go b/ui/controller/controller.go
@@ -11,6 +11,7 @@ import (
 	"net/url"
 	"os"
 	"path/filepath"
+	"strconv"
 	"sync"
 	"time"
 
@@ -39,17 +40,25 @@ type NavigationHandler func(Route)
 
 type CurPageFunc func() Route
 
+type ToastProvider interface {
+	ShowSuccessToast(string)
+	ShowErrorToast(string)
+}
+
 type Controller struct {
 	visualizationData
-	AppVersion          string
-	App                 *backend.App
-	MainWindow          fyne.Window
+	AppVersion string
+	App        *backend.App
+	MainWindow fyne.Window
+
+	// dependencies injected from MainWindow
 	NavHandler          NavigationHandler
 	CurPageFunc         CurPageFunc
 	ReloadFunc          func()
 	RefreshPageFunc     func()
 	SelectAllPageFunc   func()
 	UnselectAllPageFunc func()
+	ToastProvider       ToastProvider
 
 	popUpQueueMutex    sync.Mutex
 	popUpQueue         *widget.PopUp
@@ -297,17 +306,36 @@ func (m *Controller) DoAddTracksToPlaylistWorkflow(trackIDs []string) {
 		m.doModalClosed()
 	})
 	sp.SetOnNavigateTo(func(contentType mediaprovider.ContentType, id string) {
+		notifySuccess := func(n int) {
+			msg := lang.LocalizePluralKey("playlist.addedtracks",
+				"Added tracks to playlist", n, map[string]string{"trackCount": strconv.Itoa(n)})
+			m.ToastProvider.ShowSuccessToast(msg)
+		}
+		notifyError := func() {
+			m.ToastProvider.ShowErrorToast(
+				lang.L("An error occurred adding tracks to the playlist"),
+			)
+		}
 		pop.Hide()
 		m.App.Config.Application.AddToPlaylistSkipDuplicates = sp.SkipDuplicates
 		if id == "" /* creating new playlist */ {
-			go m.App.ServerManager.Server.CreatePlaylist(sp.SearchDialog.SearchQuery(), trackIDs)
+			go func() {
+				err := m.App.ServerManager.Server.CreatePlaylist(sp.SearchDialog.SearchQuery(), trackIDs)
+				if err == nil {
+					notifySuccess(len(trackIDs))
+				} else {
+					log.Println("error adding tracks to playlist: %s", err.Error())
+					notifyError()
+				}
+			}()
 		} else {
 			m.App.Config.Application.DefaultPlaylistID = id
 			if sp.SkipDuplicates {
 				go func() {
 					currentTrackIDs := make(map[string]struct{})
 					if selectedPlaylist, err := m.App.ServerManager.Server.GetPlaylist(id); err != nil {
 						log.Printf("error getting playlist: %s", err.Error())
+						notifyError()
 					} else {
 						for _, track := range selectedPlaylist.Tracks {
 							currentTrackIDs[track.ID] = struct{}{}
@@ -316,11 +344,25 @@ func (m *Controller) DoAddTracksToPlaylistWorkflow(trackIDs []string) {
 							_, ok := currentTrackIDs[trackID]
 							return !ok
 						})
-						m.App.ServerManager.Server.AddPlaylistTracks(id, filterTrackIDs)
+						err := m.App.ServerManager.Server.AddPlaylistTracks(id, filterTrackIDs)
+						if err == nil {
+							notifySuccess(len(filterTrackIDs))
+						} else {
+							log.Println("error adding tracks to playlist: %s", err.Error())
+							notifyError()
+						}
 					}
 				}()
 			} else {
-				go m.App.ServerManager.Server.AddPlaylistTracks(id, trackIDs)
+				go func() {
+					err := m.App.ServerManager.Server.AddPlaylistTracks(id, trackIDs)
+					if err == nil {
+						notifySuccess(len(trackIDs))
+					} else {
+						log.Println("error adding tracks to playlist: %s", err.Error())
+						notifyError()
+					}
+				}()
 			}
 		}
 
diff --git a/ui/mainwindow.go b/ui/mainwindow.go
@@ -34,6 +34,7 @@ type MainWindow struct {
 	Controller   *controller.Controller
 	BrowsingPane *browsing.BrowsingPane
 	BottomPanel  *BottomPanel
+	ToastOverlay *ToastOverlay
 
 	theme            *theme.MyTheme
 	haveSystemTray   bool
@@ -61,6 +62,7 @@ func NewMainWindow(fyneApp fyne.App, appName, displayAppName, appVersion string,
 	}
 	m.Controller = controller.New(app, appVersion, m.Window)
 	m.BrowsingPane = browsing.NewBrowsingPane(app, m.Controller, func() { m.Router.NavigateTo(m.StartupPage()) })
+	m.ToastOverlay = NewToastOverlay()
 	m.Router = browsing.NewRouter(app, m.Controller, m.BrowsingPane)
 	// inject controller dependencies
 	m.Controller.NavHandler = m.Router.NavigateTo
@@ -69,6 +71,7 @@ func NewMainWindow(fyneApp fyne.App, appName, displayAppName, appVersion string,
 	m.Controller.RefreshPageFunc = m.BrowsingPane.RefreshPage
 	m.Controller.SelectAllPageFunc = m.BrowsingPane.SelectAll
 	m.Controller.UnselectAllPageFunc = m.BrowsingPane.UnselectAll
+	m.Controller.ToastProvider = m.ToastOverlay
 
 	if runtime.GOOS == "darwin" {
 		// Fyne will extract out an "About" menu item and
@@ -137,10 +140,12 @@ func NewMainWindow(fyneApp fyne.App, appName, displayAppName, appVersion string,
 	m.BrowsingPane.DisableNavigationButtons()
 	m.addShortcuts()
 
-	m.content = newMainWindowContent(container.NewBorder(nil, m.BottomPanel, nil, nil, m.BrowsingPane),
+	center := container.NewStack(m.BrowsingPane, m.ToastOverlay)
+	m.content = newMainWindowContent(container.NewBorder(nil, m.BottomPanel, nil, nil, center),
 		m.Controller.UnselectAll)
 	m.Window.SetContent(fynetooltip.AddWindowToolTipLayer(m.content, m.Window.Canvas()))
 	m.setInitialSize()
+
 	m.Window.SetCloseIntercept(func() {
 		m.SaveWindowSize()
 		// save settings in case we crash during shutdown
diff --git a/ui/toastoverlay.go b/ui/toastoverlay.go
