Merge pull request #33 from UncleJunVIP/features-play-history

Features play history

Author: BrandonKowalski

app/game_manager.go

@@ -148,12 +148,92 @@ func handleScreenTransition(currentScreen models.Screen, result interface{}, cod
 		return handleArchiveManagementTransition(currentScreen, result, code)
 	case models.ScreenNames.ArchiveOptions:
 		return handleArchiveOptionsTransition(currentScreen, result, code)
+	case models.ScreenNames.PlayHistoryList:
+		return handlePlayHistoryListTransition(result, code)
+	case models.ScreenNames.PlayHistoryGameList:
+		return handlePlayHistoryGameListTransition(currentScreen, result, code)
+	case models.ScreenNames.PlayHistoryGameDetails:
+		return handlePlayHistoryGameDetailsTransition(currentScreen, result, code)
+	case models.ScreenNames.PlayHistoryGameHistory:
+		return handlePlayHistoryGameHistoryTransition(currentScreen, result, code)
 	default:
 		state.ReturnToMain()
 		return ui.InitMainMenu()
 	}
 }
 
+func handlePlayHistoryListTransition(result interface{}, code int) models.Screen {
+	switch code {
+	case ExitCodeSuccess:
+		state.AddNewMenuPosition()
+		return ui.InitPlayHistoryGamesListScreen(result.(string), "")
+	default:
+		state.RemoveMenuPositions(1)
+		return ui.InitToolsScreen()
+	}
+}
+
+func handlePlayHistoryGameListTransition(currentScreen models.Screen, result interface{}, code int) models.Screen {
+	ptgls := currentScreen.(ui.PlayHistoryGamesListScreen)
+
+	switch code {
+	case ExitCodeSuccess:
+		state.AddNewMenuPosition()
+		return ui.InitPlayHistoryGameDetailsScreenFromPlayHistory(ptgls.Console, ptgls.SearchFilter, result.(models.PlayHistoryAggregate))
+	case ExitCodeCancel:
+		if ptgls.SearchFilter != "" {
+			state.UpdateCurrentMenuPosition(0, 0)
+			return ui.InitPlayHistoryGamesListScreen(ptgls.Console, "")
+		}
+
+		state.RemoveMenuPositions(1)
+		return ui.InitPlayHistoryListScreen()
+	case ExitCodeAction, ExitCodeError:
+		searchFilter := result.(string)
+
+		if searchFilter != "" {
+			state.UpdateCurrentMenuPosition(0, 0)
+			return ui.InitPlayHistoryGamesListScreen(ptgls.Console, searchFilter)
+		}
+
+		return ui.InitPlayHistoryGamesListScreen(ptgls.Console, "")
+	case ExitCodeEmpty:
+		if ptgls.SearchFilter != "" {
+			utils.ShowTimedMessage(fmt.Sprintf("No results found for %s!", ptgls.SearchFilter), shortMessageDelay)
+			state.UpdateCurrentMenuPosition(0, 0)
+			return ui.InitPlayHistoryGamesListScreen(ptgls.Console, "")
+		}
+
+		utils.ShowTimedMessage(fmt.Sprintf("%s history is empty!", ptgls.Console), longMessageDelay)
+		state.RemoveMenuPositions(1)
+		return ui.InitPlayHistoryListScreen()
+	default:
+		state.RemoveMenuPositions(1)
+		return ui.InitPlayHistoryListScreen()
+	}
+}
+
+func handlePlayHistoryGameHistoryTransition(currentScreen models.Screen, result interface{}, code int) models.Screen {
+	ptghs := currentScreen.(ui.PlayHistoryGameHistoryScreen)
+	return ui.InitPlayHistoryGameDetailsScreenFromSelf(ptghs.Console, ptghs.SearchFilter, ptghs.GameAggregate, 
+		ptghs.Game, ptghs.RomDirectory, ptghs.PreviousRomDirectory, ptghs.PlayHistoryOrigin)
+}
+
+func handlePlayHistoryGameDetailsTransition(currentScreen models.Screen, result interface{}, code int) models.Screen {
+	ptgds := currentScreen.(ui.PlayHistoryGameDetailsScreen)
+	switch code {
+	case ExitCodeSuccess:
+		return ui.InitPlayHistoryGameHistoryScreen(ptgds.Console, ptgds.SearchFilter, ptgds.GameAggregate, 
+		ptgds.Game, ptgds.RomDirectory, ptgds.PreviousRomDirectory, ptgds.PlayHistoryOrigin)
+	default:
+		state.RemoveMenuPositions(1)
+		if ptgds.PlayHistoryOrigin {
+			return ui.InitPlayHistoryGamesListScreen(ptgds.Console, ptgds.SearchFilter)
+		}
+		return ui.InitActionsScreen(ptgds.Game, ptgds.RomDirectory, ptgds.PreviousRomDirectory, ptgds.SearchFilter)
+	}
+}
+
 func handleMainMenuTransition(result interface{}, code int) models.Screen {
 	switch code {
 	case ExitCodeSuccess:
@@ -340,6 +420,8 @@ func handleToolsTransition(result interface{}, code int) models.Screen {
 		switch selection {
 		case "Global Actions":
 			return ui.InitGlobalActionsScreen()
+		case "Play History":
+			return ui.InitPlayHistoryListScreen()
 		}
 		return ui.InitToolsScreen()
 	case ExitCodeAction:
@@ -481,6 +563,9 @@ func executeGameAction(as ui.ActionsScreen, action sum.Int[models.Action]) model
 		return handleDeleteRomAction(as)
 	case models.Actions.Nuke:
 		return handleNukeAction(as)
+	case models.Actions.PlayHistoryOpen:
+		state.AddNewMenuPosition()
+		return ui.InitPlayHistoryGameDetailsScreenFromActions(as.Game, as.RomDirectory, as.PreviousRomDirectory, as.SearchFilter)
 	default:
 		state.RemoveMenuPositions(1)
 		return ui.InitGamesListWithPreviousDirectory(as.RomDirectory, as.PreviousRomDirectory, as.SearchFilter)
@@ -614,7 +699,7 @@ func handleBulkDownloadArt(ba ui.BulkOptionsScreen) {
 		gaba.ProcessMessageOptions{ShowThemeBackground: true},
 		func() (interface{}, error) {
 			for _, game := range ba.Games {
-				if artPath := utils.FindArt(ba.RomDirectory, game, state.GetAppState().Config.ArtDownloadType); artPath != "" {
+				if artPath := utils.FindArt(ba.RomDirectory, game, state.GetAppState().Config.ArtDownloadType, state.GetAppState().Config.FuzzySearchThreshold); artPath != "" {
 					artPaths = append(artPaths, artPath)
 				}
 			}

models/actions.go

@@ -20,6 +20,9 @@ type Action struct {
 	CollectionDelete,
 	CollectionAdd,
 
+	PlayHistoryOpen,
+	PlayHistoryAdopt,
+
 	GlobalDownloadArt,
 	GlobalClearRecents sum.Int[Action]
 }
@@ -40,6 +43,8 @@ var ActionMap = map[string]sum.Int[Action]{
 	"Rename Collection": Actions.CollectionRename,
 	"Delete Collection": Actions.CollectionDelete,
 	"Add to Collection": Actions.CollectionAdd,
+
+	"View Play Details":	Actions.PlayHistoryOpen,
 }
 
 var GlobalActionMap = map[string]sum.Int[Action]{
@@ -81,6 +86,11 @@ var ArchiveActionKeys = []string{
 	"Delete Archive",
 }
 
+var PlayHistoryActionKeys = []string{
+	//"Rehome Orphaned History",
+	//"Delete Existing History",
+}
+
 var ActionNames = map[sum.Int[Action]]string{}
 
 func init() {

models/app_state.go

@@ -8,6 +8,12 @@ type AppState struct {
 	Config *Config
 
 	MenuPositionList []MenuPositionPointer
+
+	GamePlayMap 	map[string][]PlayHistoryAggregate
+	ConsolePlayMap 	map[string]int
+	TotalPlay 		int
+
+	CollectionMap	map[string][]Collection
 }
 
 func (a AppState) MarshalLogObject(enc zapcore.ObjectEncoder) error {

models/config.go

@@ -7,11 +7,13 @@ import (
 )
 
 type Config struct {
-	ArtDownloadType      sum.Int[shared.ArtDownloadType] `yaml:"art_download_type"`
+	ArtDownloadType 			sum.Int[shared.ArtDownloadType] `yaml:"art_download_type"`
 	FuzzySearchThreshold float64                         `yaml:"fuzzy_search_threshold"`
-	HideEmpty            bool                            `yaml:"hide_empty"`
-	ShowArt              bool                            `yaml:"show_art"`
-	LogLevel             string                          `yaml:"log_level"`
+	HideEmpty       			bool                            `yaml:"hide_empty"`
+	ShowArt         			bool                            `yaml:"show_art"`
+	LogLevel        			string                   		`yaml:"log_level"`
+	PlayHistoryShowCollections	bool                            `yaml:"play_history_show_collections"`
+	PlayHistoryShowArchives     bool                          	`yaml:"play_history_show_archives"`
 }
 
 func (c *Config) MarshalLogObject(enc zapcore.ObjectEncoder) error {

models/play_history.go

@@ -0,0 +1,19 @@
+package models
+
+import "time"
+
+type PlayHistoryAggregate struct {
+	Id 				[]int
+	Name 			string
+	Path			string
+	PlayTimeTotal 	int
+	PlayCountTotal 	int
+	FirstPlayedTime time.Time
+	LastPlayedTime 	time.Time
+}
+
+type PlayHistoryGranular struct {
+	PlayTime	int
+	StartTime	int
+	UpdateTime	int
+}

models/screens.go

@@ -27,6 +27,12 @@ type ScreenName struct {
 	CollectionManagement,
 	CollectionCreate,
 
+	PlayHistoryActions,
+	PlayHistoryGameDetails,
+	PlayHistoryGameHistory,
+	PlayHistoryGameList,
+	PlayHistoryList,
+
 	GlobalActions sum.Int[ScreenName]
 }
 

pak.json

@@ -1,6 +1,6 @@
 {
   "name": "Game Manager",
-  "version": "v2.4.1",
+  "version": "v2.5.0",
   "type": "TOOL",
   "description": "A one-stop pak for all your game management needs.",
   "author": "K-Wall & redria7",
@@ -10,6 +10,7 @@
     "BRICK": ".github/resources/banner.png"
   },
   "changelog": {
+    "v2.5.0": "Added a new Play History tool allowing for viewing of all current game tracking history. Includes total hours, hours by console, hours by game, ROM location tagging, ROM collection tagging, a play summary screen, and a granular detail screen. Play summary and granular detail screens can also be accessed from game actions.",
     "v2.4.1": "Added clear recently played to the global actions tool. Thanks madeleineostoja for the suggestion!",
     "v2.3.0": "Enhanced art searching that uses a fallback Jaccard Similarity with configurable threshold when art with an exact filename match does not exist.",
     "v2.2.2": "Archiving / Unarchiving Multi Disk and BIN/CUE games now works as intended. Nested folders now work with the Global Actions Missing Art tool. Shoved Global Actions into a Tool Menu for future Pak expansion.",

state/state.go

@@ -5,6 +5,7 @@ import (
 	"go.uber.org/atomic"
 	"gopkg.in/yaml.v3"
 	"nextui-game-manager/models"
+	"nextui-game-manager/utils"
 	"os"
 	"sync"
 )
@@ -111,3 +112,47 @@ func GetCurrentMenuPosition() (int, int) {
 
 	return selectedIndex, selectedPosition
 }
+
+func GetPlayMaps() (map[string][]models.PlayHistoryAggregate, map[string]int, int) {
+	temp := GetAppState()
+	if temp.GamePlayMap == nil {
+		updatePlayMaps()
+		temp = GetAppState()
+	}
+	return temp.GamePlayMap, temp.ConsolePlayMap, temp.TotalPlay
+}
+
+func updatePlayMaps() {
+	temp := GetAppState()
+	temp.GamePlayMap, temp.ConsolePlayMap, temp.TotalPlay = utils.GenerateCurrentGameStats()
+	UpdateAppState(temp)
+}
+
+func ClearPlayMaps() {
+	temp := GetAppState()
+	temp.GamePlayMap = nil
+	temp.ConsolePlayMap = nil
+	temp.TotalPlay = 0
+	UpdateAppState(temp)
+}
+
+func GetCollectionMap() map[string][]models.Collection {
+	temp := GetAppState()
+	if temp.CollectionMap == nil {
+		updateCollectionMap()
+		temp = GetAppState()
+	}
+	return temp.CollectionMap
+}
+
+func updateCollectionMap() {
+	temp := GetAppState()
+	temp.CollectionMap = utils.GenerateCollectionMap()
+	UpdateAppState(temp)
+}
+
+func ClearCollectionMap() {
+	temp := GetAppState()
+	temp.CollectionMap = nil
+	UpdateAppState(temp)
+}

ui/actions.go

@@ -49,6 +49,12 @@ func (a ActionsScreen) Draw() (action interface{}, exitCode int, e error) {
 		actions = utils.InsertIntoSlice(actions, 1, "Delete Art")
 	}
 
+	gamePlayMap, _, _ := state.GetPlayMaps()
+	gameAggregate, _ := utils.CollectGameAggregateFromGame(a.Game, gamePlayMap)
+	if gameAggregate.PlayCountTotal != 0 {
+		actions = append(actions, "View Play Details")
+	}
+
 	var actionEntries []gabagool.MenuItem
 	for _, action := range actions {
 		actionEntries = append(actionEntries, gabagool.MenuItem{

ui/add_to_collection.go

@@ -161,6 +161,7 @@ func (a AddToCollectionScreen) Draw() (collection interface{}, exitCode int, e e
 
 	if selection.IsSome() && !selection.Unwrap().ActionTriggered && selection.Unwrap().SelectedIndex != -1 {
 		state.UpdateCurrentMenuPosition(selection.Unwrap().SelectedIndex, selection.Unwrap().VisiblePosition)
+		state.ClearCollectionMap()
 		selectedCol := selection.Unwrap().SelectedItem.Metadata.(models.Collection)
 
 		_, err := utils.AddCollectionGames(selectedCol, a.Games)