Merge pull request #179 from rommapp/v4.8.0.0

V4.8.0.0

Author: BrandonKowalski

.github/workflows/release.yml

@@ -8,6 +8,7 @@
 # Build
 build64/
 build32/
+dist/
 build-miyoo/
 grout
 app/app
@@ -17,6 +18,7 @@ es_restart_request
 # Local config
 .env
 config.json
+!scripts/**/config.json
 config-*.json
 
 # Cache & temp

.gitignore

@@ -6,9 +6,11 @@
   <br />
   <img src=".github/resources/logotipo.png" height="45px" width="auto" alt="romm grout logotype">
     <h3 style="font-size: 25px;">
-A RomM Client for <a href="https://muos.dev">muOS</a>, <a href="https://knulli.org">Knulli</a>, <a href="https://rocknix.org">ROCKNIX</a>, <a href="https://spruceui.github.io/">Spruce (v4)</a>, <a href="https://nextui.loveretro.games">NextUI</a> and <a href="https://trimui.com">TrimUI</a>.
+      A RomM Client for your retro doo-dad.
     </h3>
 
+[Allium][allium] · [Batocera][batocera] · [Knulli][knulli] · [muOS][muos] · [NextUI][nextui] · [Onion][onion] · [ROCKNIX][rocknix] · [Spruce][spruce] · [TrimUI][trimui]
+
 <br>
 
 
@@ -92,6 +94,18 @@ If you enjoy using Grout and feel inclined to pay it forward, go do something ni
 
 ✌🏻
 
+<!-- CFW Links -->
+
+[allium]: https://github.com/goweiwen/Allium
+[batocera]: https://batocera.org
+[knulli]: https://knulli.org
+[muos]: https://muos.dev
+[nextui]: https://nextui.loveretro.games
+[onion]: https://onionui.github.io
+[rocknix]: https://rocknix.org
+[spruce]: https://spruceui.github.io/
+[trimui]: https://github.com/trimui
+
 <!-- Badges -->
 
 [docs-badge-img]: https://img.shields.io/badge/user%20guide-007C77?style=for-the-badge

README.md

@@ -2,6 +2,7 @@ package main
 
 import (
 	"grout/cfw"
+	"grout/update"
 	"os"
 
 	_ "github.com/BrandonKowalski/certifiable"
@@ -31,5 +32,6 @@ func cleanup() {
 	if err := os.RemoveAll(".tmp"); err != nil {
 		gaba.GetLogger().Error("Failed to clean .tmp directory", "error", err)
 	}
+	update.CleanupUpdateArtifacts()
 	gaba.Close()
 }

app/grout.go

@@ -59,7 +59,7 @@ func handlePlatformMappingUpdateUI(state *AppState, r ui.PlatformMappingOutput)
 	state.Config.PlatformOrder = internal.PrunePlatformOrder(state.Config.PlatformOrder, r.Mappings)
 	internal.SaveConfig(state.Config)
 
-	platforms, err := internal.GetMappedPlatforms(state.Host, r.Mappings, state.Config.ApiTimeout)
+	platforms, err := internal.GetMappedPlatforms(state.Host, r.Mappings, state.Config.ApiTimeout.Duration())
 	if err != nil {
 		gaba.GetLogger().Error("Failed to refresh platforms after mapping update", "error", err)
 		return
@@ -120,7 +120,7 @@ func handleLogout(state *AppState) {
 		screen := ui.NewPlatformMappingScreen()
 		result, err := screen.Draw(ui.PlatformMappingInput{
 			Host:             state.Config.Hosts[0],
-			ApiTimeout:       state.Config.ApiTimeout,
+			ApiTimeout:       state.Config.ApiTimeout.Duration(),
 			CFW:              state.CFW,
 			RomDirectory:     cfw.GetRomDirectory(),
 			AutoSelect:       false,
@@ -135,10 +135,10 @@ func handleLogout(state *AppState) {
 	}
 
 	if err := cache.InitCacheManager(state.Config.Hosts[0], state.Config); err != nil {
-		logger.Error("Failed to initialize cache manager after re-login", "error", err)
+		logger.Error("Failed to re-initialize cache manager", "error", err)
 	}
 
-	platforms, err := internal.GetMappedPlatforms(state.Config.Hosts[0], state.Config.DirectoryMappings, state.Config.ApiTimeout)
+	platforms, err := internal.GetMappedPlatforms(state.Config.Hosts[0], state.Config.DirectoryMappings, state.Config.ApiTimeout.Duration())
 	if err != nil {
 		logger.Error("Failed to load platforms after re-login", "error", err)
 		return

app/helpers.go

@@ -177,7 +177,7 @@ func registerScreens(r *router.Router, state *AppState) {
 	r.Register(ScreenArtworkSync, func(input any) (any, error) {
 		in := input.(ui.ArtworkSyncInput)
 		screen := ui.NewArtworkSyncScreen()
-		screen.Execute(in.Config, in.Host)
+		screen.Execute(in)
 		return ui.ArtworkSyncOutput{}, nil
 	})
 
@@ -228,6 +228,20 @@ func registerScreens(r *router.Router, state *AppState) {
 		return screen.Draw(input.(ui.SaveMappingInput))
 	})
 
+	r.Register(ScreenSwitchToToken, func(input any) (any, error) {
+		screen := ui.NewSwitchToTokenScreen()
+		result := screen.Execute(state.Config, state.Host)
+		if result.Success {
+			state.Host = result.Host
+		}
+		return result, nil
+	})
+
+	r.Register(ScreenToolsSettings, func(input any) (any, error) {
+		screen := ui.NewToolsSettingsScreen()
+		return screen.Draw(input.(ui.ToolsSettingsInput))
+	})
+
 	r.Register(ScreenServerAddress, func(input any) (any, error) {
 		screen := ui.NewServerAddressScreen()
 		return screen.Draw(input.(ui.ServerAddressInput))

app/router.go

@@ -36,4 +36,6 @@ const (
 	ScreenSyncHistory
 	ScreenSaveMapping
 	ScreenServerAddress
+	ScreenToolsSettings
+	ScreenSwitchToToken
 )

app/screens.go

@@ -6,6 +6,7 @@ import (
 	"grout/cfw"
 	"grout/cfw/allium"
 	"grout/cfw/muos"
+	"grout/cfw/onion"
 	"grout/internal"
 	"grout/internal/environment"
 	"grout/internal/fileutil"
@@ -46,6 +47,8 @@ func setup() SetupResult {
 					mappingBytes, mappingErr = muos.GetInputMappingBytes()
 				case cfw.Allium:
 					mappingBytes, mappingErr = allium.GetInputMappingBytes()
+				case cfw.Onion:
+					mappingBytes, mappingErr = onion.GetInputMappingBytes()
 				}
 				if mappingBytes != nil && mappingErr == nil {
 					gaba.SetInputMappingBytes(mappingBytes)
@@ -117,8 +120,8 @@ func setup() SetupResult {
 		if config == nil {
 			config = &internal.Config{
 				ShowRegularCollections: true,
-				ApiTimeout:             30 * time.Minute,
-				DownloadTimeout:        60 * time.Minute,
+				ApiTimeout:             internal.DurationSeconds(30 * time.Second),
+				DownloadTimeout:        internal.DurationSeconds(60 * time.Minute),
 			}
 		}
 		config.Language = selectedLanguage
@@ -130,6 +133,7 @@ func setup() SetupResult {
 		loginConfig, loginErr := ui.LoginFlow(romm.Host{})
 		if loginErr != nil {
 			logger.Error("Login flow failed", "error", loginErr)
+			gaba.Close()
 			log.SetOutput(os.Stderr)
 			log.Fatalf("Login failed: %v", loginErr)
 		}
@@ -176,7 +180,7 @@ func setup() SetupResult {
 		screen := ui.NewPlatformMappingScreen()
 		result, err := screen.Draw(ui.PlatformMappingInput{
 			Host:             config.Hosts[0],
-			ApiTimeout:       config.ApiTimeout,
+			ApiTimeout:       config.ApiTimeout.Duration(),
 			CFW:              currentCFW,
 			RomDirectory:     cfw.GetRomDirectory(),
 			AutoSelect:       false,
@@ -198,32 +202,111 @@ func setup() SetupResult {
 	}
 
 	var platforms []romm.Platform
-	var loadErr error
 
 	splashBytes, _ := resources.GetSplashImageBytes()
 
 	for {
+		var connErr error
+		var authErr error
+		var loadErr error
+
 		gaba.ProcessMessage("", gaba.ProcessMessageOptions{
 			ImageBytes:  splashBytes,
 			ImageWidth:  768,
 			ImageHeight: 540,
 		}, func() (interface{}, error) {
-			// Load platform bindings from RomM server (non-fatal if it fails)
-			if err := config.LoadPlatformsBinding(config.Hosts[0], config.ApiTimeout); err != nil {
+			host := config.Hosts[0]
+
+			// Step 1: Validate server connectivity
+			client := romm.NewClient(host.URL(), romm.WithInsecureSkipVerify(host.InsecureSkipVerify), romm.WithTimeout(internal.ValidationTimeout))
+			if err := client.ValidateConnection(); err != nil {
+				connErr = err
+				return nil, nil
+			}
+
+			// Step 2: Validate credentials/token
+			authClient := romm.NewClientFromHost(host, internal.LoginTimeout)
+			if host.HasTokenAuth() {
+				if err := authClient.ValidateToken(); err != nil {
+					authErr = err
+					return nil, nil
+				}
+				// Re-fetch username if missing
+				if host.Username == "" {
+					if user, err := authClient.GetCurrentUser(); err == nil {
+						host.Username = user.Username
+						config.Hosts[0] = host
+						internal.SaveConfig(config)
+					}
+				}
+			} else {
+				if err := authClient.Login(host.Username, host.Password); err != nil {
+					authErr = err
+					return nil, nil
+				}
+			}
+
+			// Step 3: Load platforms
+			if err := config.LoadPlatformsBinding(config.Hosts[0], config.ApiTimeout.Duration()); err != nil {
 				logger.Debug("Failed to load platform bindings", "error", err)
 			}
 
 			var err error
-			platforms, err = internal.GetMappedPlatforms(config.Hosts[0], config.DirectoryMappings, config.ApiTimeout)
+			platforms, err = internal.GetMappedPlatforms(config.Hosts[0], config.DirectoryMappings, config.ApiTimeout.Duration())
 			if err != nil {
 				loadErr = err
-				return nil, err
+				return nil, nil
 			}
-			loadErr = nil
 			platforms = internal.SortPlatformsByOrder(platforms, config.PlatformOrder)
 			return nil, nil
 		})
 
+		// Handle connectivity failure
+		if connErr != nil {
+			logger.Warn("Server connectivity failed", "error", connErr)
+			errorMessage := classifyStartupError(connErr)
+			errorMsg := i18n.Localize(errorMessage, nil)
+			retry := showStartupError(errorMsg)
+			if !retry {
+				gaba.Close()
+				os.Exit(1)
+			}
+			continue
+		}
+
+		// Handle auth failure — show message and offer re-login
+		if authErr != nil {
+			logger.Warn("Auth validation failed", "error", authErr)
+
+			var msg string
+			if config.Hosts[0].HasTokenAuth() {
+				msg = i18n.Localize(&goi18n.Message{ID: "startup_error_token_invalid", Other: "Your API token is invalid or expired.\nPlease set up a new one."}, nil)
+			} else {
+				msg = i18n.Localize(&goi18n.Message{ID: "startup_error_credentials_invalid", Other: "Your credentials are invalid.\nPlease log in again."}, nil)
+			}
+
+			gaba.ConfirmationMessage(msg, []gaba.FooterHelpItem{
+				{ButtonName: "A", HelpText: i18n.Localize(&goi18n.Message{ID: "button_continue", Other: "Continue"}, nil)},
+			}, gaba.MessageOptions{})
+
+			loginConfig, loginErr := ui.LoginFlow(config.Hosts[0])
+			if loginErr != nil {
+				logger.Error("Re-login failed", "error", loginErr)
+				gaba.Close()
+				log.SetOutput(os.Stderr)
+				log.Fatalf("Login failed: %v", loginErr)
+			}
+			config.Hosts = loginConfig.Hosts
+			config.PlatformsBinding = loginConfig.PlatformsBinding
+			internal.SaveConfig(config)
+
+			// Re-initialize cache manager with new credentials
+			if err := cache.InitCacheManager(config.Hosts[0], config); err != nil {
+				logger.Error("Failed to re-initialize cache manager", "error", err)
+			}
+			continue
+		}
+
 		if loadErr == nil {
 			break
 		}

app/setup.go

@@ -56,6 +56,8 @@ func buildTransitionFunc(state *AppState, quitOnBack bool, initialShowCollection
 			return transitionGeneralSettings(ctx, result)
 		case ScreenCollectionsSettings:
 			return transitionCollectionsSettings(ctx, result)
+		case ScreenToolsSettings:
+			return transitionToolsSettings(ctx, result)
 		case ScreenAdvancedSettings:
 			return transitionAdvancedSettings(ctx, result)
 		case ScreenPlatformMapping:
@@ -70,6 +72,14 @@ func buildTransitionFunc(state *AppState, quitOnBack bool, initialShowCollection
 			return popOrExit(stack)
 		case ScreenArtworkSync:
 			return popOrExit(stack)
+		case ScreenSwitchToToken:
+			// Pop the stacked settings entry so we don't go back to stale state
+			stack.Pop()
+			return ScreenSettings, ui.SettingsInput{
+				Config: ctx.state.Config,
+				CFW:    ctx.state.CFW,
+				Host:   ctx.state.Host,
+			}
 		case ScreenUpdateCheck:
 			return transitionUpdateCheck(ctx, result)
 		case ScreenGameFilters:
@@ -616,6 +626,14 @@ func transitionSettings(ctx *transitionContext, result any) (router.Screen, any)
 		ctx.stack.Push(ScreenSettings, pushInput, r)
 		return ScreenCollectionsSettings, ui.CollectionsSettingsInput{Config: ctx.state.Config}
 
+	case ui.SettingsActionSwitchToToken:
+		ctx.stack.Push(ScreenSettings, pushInput, r)
+		return ScreenSwitchToToken, nil
+
+	case ui.SettingsActionTools:
+		ctx.stack.Push(ScreenSettings, pushInput, r)
+		return ScreenToolsSettings, ui.ToolsSettingsInput{Config: ctx.state.Config, Host: ctx.state.Host}
+
 	case ui.SettingsActionAdvanced:
 		ctx.stack.Push(ScreenSettings, pushInput, r)
 		return ScreenAdvancedSettings, ui.AdvancedSettingsInput{Config: ctx.state.Config, Host: ctx.state.Host}
@@ -624,7 +642,7 @@ func transitionSettings(ctx *transitionContext, result any) (router.Screen, any)
 		ctx.stack.Push(ScreenSettings, pushInput, r)
 		return ScreenPlatformMapping, ui.PlatformMappingInput{
 			Host:             ctx.state.Host,
-			ApiTimeout:       ctx.state.Config.ApiTimeout,
+			ApiTimeout:       ctx.state.Config.ApiTimeout.Duration(),
 			CFW:              ctx.state.CFW,
 			RomDirectory:     cfw.GetRomDirectory(),
 			ExistingMappings: ctx.state.Config.DirectoryMappings,
@@ -689,6 +707,25 @@ func transitionCollectionsSettings(ctx *transitionContext, result any) (router.S
 	return popOrExit(ctx.stack)
 }
 
+func transitionToolsSettings(ctx *transitionContext, result any) (router.Screen, any) {
+	r := result.(ui.ToolsSettingsOutput)
+
+	pushInput := ui.ToolsSettingsInput{Config: ctx.state.Config, Host: ctx.state.Host}
+
+	switch r.Action {
+	case ui.ToolsSettingsActionSyncLocalArtwork:
+		ctx.stack.Push(ScreenToolsSettings, pushInput, r)
+		return ScreenArtworkSync, ui.ArtworkSyncInput{
+			Config:         *ctx.state.Config,
+			Host:           ctx.state.Host,
+			DownloadedOnly: true,
+		}
+
+	default:
+		return popOrExit(ctx.stack)
+	}
+}
+
 func transitionAdvancedSettings(ctx *transitionContext, result any) (router.Screen, any) {
 	r := result.(ui.AdvancedSettingsOutput)
 

app/transitions.go

@@ -138,7 +138,7 @@ func DownloadAndCacheArtwork(rom romm.Rom, kind artutil.ArtKind, host romm.Host)
 	if err != nil {
 		return fmt.Errorf("failed to create request: %w", err)
 	}
-	req.Header.Set("Authorization", host.BasicAuthHeader())
+	req.Header.Set("Authorization", host.AuthHeader())
 
 	client := &http.Client{Timeout: romm.DefaultClientTimeout}
 	resp, err := client.Do(req)