Merge pull request #61 from MattEqualsCoder/hardware-msu-settings

MattEqualsCoder · web-flow · commit 47a7ece2f71d · 2024-11-05T23:14:58.000-05:00
Hardware msu settings
diff --git a/MSURandomizer/MSURandomizer.csproj b/MSURandomizer/MSURandomizer.csproj
@@ -6,7 +6,7 @@
         <BuiltInComInteropSupport>true</BuiltInComInteropSupport>
         <ApplicationManifest>app.manifest</ApplicationManifest>
         <AvaloniaUseCompiledBindingsByDefault>true</AvaloniaUseCompiledBindingsByDefault>
-        <Version>3.0.0-rc.1</Version>
+        <Version>3.0.0-rc.2</Version>
         <ApplicationIcon>MSURandomizerIcon.ico</ApplicationIcon>
         <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
         <PackageId>MattEqualsCoder.MSURandomizer.Avalonia</PackageId>
diff --git a/MSURandomizer/Services/MsuDetailsService.cs b/MSURandomizer/Services/MsuDetailsService.cs
@@ -12,7 +12,8 @@ public class MsuDetailsService(
     IMapper mapper,
     IMsuTypeService msuTypeService,
     IMsuCacheService msuCacheService,
-    IMsuLookupService msuLookupService) : ControlService
+    IMsuLookupService msuLookupService,
+    IMsuHardwareService msuHardwareService) : ControlService
 {
     private MsuViewModel _parentModel = new();
     public MsuDetailsWindowViewModel Model { get; set; } = new();
@@ -31,6 +32,7 @@ public MsuDetailsWindowViewModel InitilizeModel(MsuViewModel model)
         Model.TrackCount = Model.Tracks.Count;
         Model.MsuTypeNames = [""];
         Model.MsuTypeNames.AddRange(msuTypeService.MsuTypes.Select(x => x.DisplayName).OrderBy(x => x));
+        Model.MsuPath = _parentModel.MsuPath;
         Model.HasBeenModified = false;
         return Model;
     }
@@ -39,18 +41,29 @@ public void Save()
     {
         if (Model.Msu == null) return;
         mapper.Map(Model, Model.Msu.Settings);
+        Model.Msu.Settings.MsuType = msuTypeService.GetMsuType(Model.MsuTypeName);
         Model.Msu.Settings.IsUserUnknownMsu = string.IsNullOrEmpty(Model.MsuTypeName);
         userOptionsService.SaveMsuSettings(Model.Msu);
         _parentModel.MsuName = Model.Msu?.DisplayName;
         _parentModel.MsuCreator = Model.Msu?.DisplayCreator;
         
         if (_originalMsuTypeName != Model.MsuTypeName)
         {
-            msuCacheService.Remove(Model.MsuPath, false);
-            ITaskService.Run(() =>
+            if (Model.Msu?.IsHardwareMsu != true)
             {
-                msuLookupService.LookupMsus();
-            });
+                msuCacheService.Remove(Model.MsuPath, false);
+                ITaskService.Run(() =>
+                {
+                    msuLookupService.LookupMsus();
+                });
+            }
+            else
+            {
+                ITaskService.Run(() =>
+                {
+                    msuHardwareService.RefreshMsu(Model.MsuPath);
+                });
+            }
         }
         
     }
diff --git a/MSURandomizer/Services/MsuListService.cs b/MSURandomizer/Services/MsuListService.cs
@@ -16,7 +16,8 @@ public class MsuListService(AppInitializationService appInitializationService,
     IMsuUserOptionsService userOptions,
     IMsuTypeService msuTypeService,
     IMsuAppSettingsService appSettingsService,
-    IMsuMonitorService msuMonitorService) : ControlService
+    IMsuMonitorService msuMonitorService,
+    IMsuHardwareService msuHardwareService) : ControlService
 {
     public MsuListViewModel Model { get; set; } = new()
     {
@@ -40,11 +41,17 @@ public MsuListViewModel InitializeModel()
         appInitializationService.InitializationComplete += InitializationServiceOnInitializationComplete;
         msuLookupService.OnMsuLookupComplete += MsuLookupServiceOnOnMsuLookupComplete;
         msuLookupService.OnMsuLookupStarted += MsuLookupServiceOnOnMsuLookupStarted;
+        msuHardwareService.HardwareMsusChanged += MsuHardwareServiceOnHardwareMsusChanged;
         Model.IsMsuMonitorDisabled = appSettingsService.MsuAppSettings.DisableMsuMonitorWindow == true;
         CheckIfLoading();
         return Model;
     }
 
+    private void MsuHardwareServiceOnHardwareMsusChanged(object? sender, MsuListEventArgs e)
+    {
+        PopulateMsuViewModels(e.Msus.ToList());
+    }
+
     private void MsuLookupServiceOnOnMsuLookupStarted(object? sender, EventArgs e)
     {
         CheckIfLoading();
@@ -70,8 +77,24 @@ public void FilterMSUs(MsuType msuType, MsuFilter msuFilter)
             userOptions.MsuUserOptions.DefaultMsuPath;
         var rootPath = Model.HardwareMode ? "" : GetMsuTypeBasePath(msuType);
         var useAbsolutePath = string.IsNullOrWhiteSpace(rootPath);
+        
+        // Hardware MSUs are more limited in compatibility
+        List<string>? compatibleMsuNames = null;
+        if (Model.HardwareMode)
+        {
+            if (appSettingsService.MsuAppSettings.HardwareCompatibleMsuTypes.TryGetValue(msuType.DisplayName,
+                    out compatibleMsuNames))
+            {
+                compatibleMsuNames.Add(msuType.DisplayName);
+            }
+            else
+            {
+                compatibleMsuNames = [msuType.DisplayName];
+            }
+        }
+        
         var filteredMsus = Model.MsuViewModels
-            .Where(x => x.Msu.MatchesFilter(msuFilter, msuType, msuTypePath) &&
+            .Where(x => x.Msu.MatchesFilter(msuFilter, msuType, msuTypePath, compatibleMsuNames) &&
                         (x.Msu.NumUniqueTracks > x.Msu.MsuType?.RequiredTrackNumbers.Count / 5 || x.Msu.NumUniqueTracks > 10))
             .OrderBy(x => x.MsuName)
             .ToList();
@@ -159,7 +182,7 @@ public void PopulateMsuViewModels(List<Msu>? msus)
             .Where(x => userOptions.MsuUserOptions.SelectedMsus?.Contains(x.MsuPath) == true).ToList();
 
         Model.DisplayUnknownMsuWindow =
-            Model.Msus.Any(x => x.MsuType == null && x is { NumUniqueTracks: > 15, IgnoreUnknown: false, IsHardwareMsu: false } && string.IsNullOrEmpty(x.Settings.MsuTypeName) );
+            Model.Msus.Any(x => x.MsuType == null && x is { NumUniqueTracks: > 15, IgnoreUnknown: false } && string.IsNullOrEmpty(x.Settings.MsuTypeName) );
 
         if (Model.DisplayUnknownMsuWindow)
         {
diff --git a/MSURandomizer/Services/MsuWindowService.cs b/MSURandomizer/Services/MsuWindowService.cs
@@ -152,6 +152,7 @@ public void UpdateSelectedMsus(ICollection<MsuViewModel>? msus)
 
     public void UpdateHardwareMode(MsuList msuList, List<Msu>? msus)
     {
+        Model.Filter = MsuFilter.Compatible;
         Model.IsHardwareModeEnabled = msus?.Count > 0;
         msuList.ToggleHardwareMode(Model.IsHardwareModeEnabled);
         msuList.PopulateMsuViewModels(msus);
diff --git a/MSURandomizer/Services/UnknownMsuWindowService.cs b/MSURandomizer/Services/UnknownMsuWindowService.cs
@@ -13,19 +13,28 @@ public class UnknownMsuWindowService(
     IMapper mapper,
     IMsuTypeService msuTypeService,
     IMsuCacheService msuCacheService,
-    IMsuLookupService msuLookupService) : ControlService
+    IMsuLookupService msuLookupService,
+    IMsuHardwareService msuHardwareService) : ControlService
 {
     private UnknownMsuWindowViewModel _model = new();
     private const int MaxPathLength = 50;
+    private bool _isHardwareMode;
     
-    public UnknownMsuWindowViewModel InitilizeModel()
+    public UnknownMsuWindowViewModel InitilizeModel(bool isHardwareMode)
     {
+        _isHardwareMode = isHardwareMode;
+        
         List<string> msuTypes = [""];
         msuTypes.AddRange(msuTypeService.MsuTypes.Select(x => x.DisplayName).OrderBy(x => x));
 
         List<MsuDetailsWindowViewModel> msuModels = [];
+
+        var msuList = isHardwareMode ? msuHardwareService.Msus : msuLookupService.Msus;
+        var msus = msuList.Where(x =>
+            x is { IgnoreUnknown: false, MsuType: null, NumUniqueTracks: >= 15 } &&
+            string.IsNullOrEmpty(x.Settings.MsuTypeName));
         
-        foreach (var msu in msuLookupService.Msus.Where(x => x is { IgnoreUnknown: false, MsuType: null, NumUniqueTracks: >= 15 } && string.IsNullOrEmpty(x.Settings.MsuTypeName) ))
+        foreach (var msu in msus)
         {
             var msuModel = mapper.Map<MsuDetailsWindowViewModel>(msu.Settings);
             msuModel.Msu = msu;
@@ -46,6 +55,7 @@ public UnknownMsuWindowViewModel InitilizeModel()
             {
                 _model.HasBeenModified = true;
             };
+            
             msuModels.Add(msuModel);
         }
 
@@ -62,18 +72,29 @@ public void Save()
         foreach (var msuModel in _model.UnknownMsus.Where(x => x.Msu != null))
         {
             mapper.Map(msuModel, msuModel.Msu!.Settings);
+            msuModel.Msu.MsuType = msuTypeService.GetMsuType(msuModel.MsuTypeName);
             msuModel.Msu.Settings.IsUserUnknownMsu = string.IsNullOrEmpty(msuModel.MsuTypeName);
             userOptionsService.UpdateMsuSettings(msuModel.Msu);
-            msuCacheService.Remove(msuModel.Msu.Path, false);
+            
+            if (_isHardwareMode && !string.IsNullOrEmpty(msuModel.MsuTypeName))
+            {
+                msuHardwareService.RefreshMsu(msuModel.MsuPath);
+            }
+            else if (!_isHardwareMode)
+            {
+                msuCacheService.Remove(msuModel.Msu.Path, false);
+            }
         }
 
         userOptionsService.Save();
-        
-        ITaskService.Run(() =>
+
+        if (!_isHardwareMode)
         {
-            msuLookupService.LookupMsus();
-        });
-        
+            ITaskService.Run(() =>
+            {
+                msuLookupService.LookupMsus();
+            });
+        }
     }
 
     public void SaveIgnore()
diff --git a/MSURandomizer/ViewModels/MsuDetailsWindowViewModel.cs b/MSURandomizer/ViewModels/MsuDetailsWindowViewModel.cs
@@ -35,9 +35,9 @@ public class MsuDetailsWindowViewModel : ViewModelBase
 
     public string TrackCountString => $"{TrackCount} Tracks";
 
-    public bool CanEditDetails => Msu?.HasDetails != true && Msu?.IsHardwareMsu != true;
+    public bool CanEditDetails => Msu?.HasDetails != true;
 
-    public bool CanEditMsuType => Msu?.IsHardwareMsu != true;
+    public bool CanEditMsuType => true;
 
     public bool IsNotLast { get; set; } = true;
 }
diff --git a/MSURandomizer/ViewModels/MsuViewModel.cs b/MSURandomizer/ViewModels/MsuViewModel.cs
@@ -28,6 +28,7 @@ public MsuViewModel(Msu msu)
         IsFavorite = msu.Settings.IsFavorite;
         ShuffleFrequency = msu.Settings.ShuffleFrequency;
         IsHardwareMsu = msu.IsHardwareMsu;
+        ShowShuffleFrequency = !IsHardwareMsu;
     }
     
     [Reactive] public Msu Msu { get; init; }
@@ -64,6 +65,8 @@ public MsuViewModel(Msu msu)
     [Reactive]
     [ReactiveLinkedProperties(nameof(ShuffleFrequencyIcon), nameof(ShuffleFrequencyColor))]
     public ShuffleFrequency ShuffleFrequency { get; set; }
+
+    [Reactive] public bool ShowShuffleFrequency { get; set; } = true;
     
     public string ListText => string.IsNullOrEmpty(MsuCreator) ? MsuName ?? "" : $"{MsuName} by {MsuCreator}";
     
diff --git a/MSURandomizer/Views/MsuList.axaml b/MSURandomizer/Views/MsuList.axaml
@@ -33,7 +33,7 @@
                         <controls:ImageButton Grid.Column="0" Name="FavoriteButton" Margin="2" Tag="{Binding}" Click="FavoriteButton_OnClick">
                             <avalonia:MaterialIcon Kind="Star" Width="20" Height="20" Foreground="{Binding FavoriteIconColor}" Background="Transparent" />
                         </controls:ImageButton>
-                        <controls:ImageButton Grid.Column="1" Name="ShuffleFrequencyButton" Margin="2 2 5 2" Click="ShuffleFrequencyButton_OnClick">
+                        <controls:ImageButton Grid.Column="1" Name="ShuffleFrequencyButton" Margin="2 2 5 2" Click="ShuffleFrequencyButton_OnClick" IsVisible="{Binding ShowShuffleFrequency}">
                             <Button.ContextMenu>
                                 <ContextMenu>
                                     <MenuItem Header="Shuffle the default amount" 
diff --git a/MSURandomizer/Views/MsuList.axaml.cs b/MSURandomizer/Views/MsuList.axaml.cs
@@ -5,7 +5,6 @@
 using Avalonia.Interactivity;
 using Avalonia.Threading;
 using AvaloniaControls.Extensions;
-using AvaloniaControls.Services;
 using MSURandomizer.Services;
 using MSURandomizer.ViewModels;
 using MSURandomizerLibrary;
@@ -42,11 +41,11 @@ public MsuList()
         else
         {
             _service = this.GetControlService<MsuListService>();
+            DataContext = _model = _service!.InitializeModel();
             _service!.OnDisplayUnknownMsuWindowRequest += (sender, args) =>
             {
                 OpenUnknownMsuWindow();
             };
-            DataContext = _model = _service!.InitializeModel();
         }
     }
 
@@ -108,7 +107,7 @@ public void OpenUnknownMsuWindow()
         Dispatcher.UIThread.Invoke(() =>
         {
             var parentWindow = TopLevel.GetTopLevel(this) as Window;
-            var unknownMsuWindow = new UnknownMsuWindow();
+            var unknownMsuWindow = new UnknownMsuWindow(_service?.Model.HardwareMode == true);
             unknownMsuWindow.ShowDialog(parentWindow!);
         });
     }
diff --git a/MSURandomizer/Views/UnknownMsuWindow.axaml.cs b/MSURandomizer/Views/UnknownMsuWindow.axaml.cs
@@ -12,8 +12,10 @@ public partial class UnknownMsuWindow : ScalableWindow
 {
     private readonly UnknownMsuWindowService? _service;
     private bool _pressedSave;
-    
-    public UnknownMsuWindow()
+
+    public UnknownMsuWindow() : this(false) { }
+        
+    public UnknownMsuWindow(bool isHardwareMode)
     {
         InitializeComponent();
 
@@ -54,7 +56,7 @@ public UnknownMsuWindow()
         }
 
         _service = this.GetControlService<UnknownMsuWindowService>();
-        DataContext = _service!.InitilizeModel();
+        DataContext = _service!.InitilizeModel(isHardwareMode);
     }
 
     private void SaveButton_OnClick(object? sender, RoutedEventArgs e)
diff --git a/MSURandomizerLibrary/Configs/Msu.cs b/MSURandomizerLibrary/Configs/Msu.cs
@@ -182,9 +182,21 @@ public Msu(MsuType? type, string name, string folderName, string fileName, strin
     /// <param name="type">The MSU type being looked for</param>
     /// <param name="path">The path being looked at</param>
     /// <returns>True if matches, false otherwise</returns>
-    public bool MatchesFilter(MsuFilter filter, MsuType type, string? path)
+    public bool MatchesFilter(MsuFilter filter, MsuType type, string? path, List<string>? compatibleMsuTypeNames = null)
     {
-        return MatchesFilterType(filter, type) && MatchesPath(path) && Tracks.Count >= 1;
+        if (MatchesFilterType(filter, type) && MatchesPath(path) && Tracks.Count >= 1)
+        {
+            if (compatibleMsuTypeNames == null || filter == MsuFilter.All)
+            {
+                return true;
+            }
+
+            return compatibleMsuTypeNames.Contains(MsuTypeName);
+        }
+        else
+        {
+            return false;
+        }
     }
 
     private bool MatchesFilterType(MsuFilter filter, MsuType type)
diff --git a/MSURandomizerLibrary/Configs/MsuAppSettings.cs b/MSURandomizerLibrary/Configs/MsuAppSettings.cs
@@ -100,6 +100,11 @@ public class MsuAppSettings
     /// </summary>
     public bool DisableMessageSender { get; set; }
 
+    /// <summary>
+    /// For hardware MSUs, the list of compatible MSU types
+    /// </summary>
+    public Dictionary<string, List<string>> HardwareCompatibleMsuTypes { get; set; } = [];
+
     /// <summary>
     /// Default directory for misc save data
     /// </summary>
diff --git a/MSURandomizerLibrary/MSURandomizerLibrary.csproj b/MSURandomizerLibrary/MSURandomizerLibrary.csproj
@@ -14,7 +14,7 @@
     <PackageRequireLicenseAcceptance>False</PackageRequireLicenseAcceptance>
     <IncludeSymbols>False</IncludeSymbols>
     <SymbolPackageFormat>snupkg</SymbolPackageFormat>
-    <Version>3.0.0-rc.1</Version>
+    <Version>3.0.0-rc.2</Version>
     <PackageId>MattEqualsCoder.MSURandomizer.Library</PackageId>
     <GenerateDocumentationFile>True</GenerateDocumentationFile>
     <TargetFramework>net8.0</TargetFramework>
diff --git a/MSURandomizerLibrary/Services/IMsuHardwareService.cs b/MSURandomizerLibrary/Services/IMsuHardwareService.cs
@@ -21,4 +21,28 @@ public interface IMsuHardwareService
     /// <param name="bootRomAfter"></param>
     /// <returns>Returns the MSU if one was successfully picked and uploaded to</returns>
     public Task<Msu?> UploadMsuRom(List<Msu> msus, string romFilePath, bool bootRomAfter);
+
+    /// <summary>
+    /// Refreshes the MSU matching the given path
+    /// </summary>
+    /// <param name="path">The path of the MSU to refresh</param>
+    /// <returns>The reloaded MSU</returns>
+    public Msu RefreshMsu(string path);
+    
+    /// <summary>
+    /// Gets the current cached MSUs
+    /// </summary>
+    /// <returns></returns>
+    public List<Msu> Msus { get; }
+
+    /// <summary>
+    /// Event fired once the list of hardware MSUs has been updated
+    /// </summary>
+    public event EventHandler<MsuListEventArgs> HardwareMsusLoaded;
+    
+    /// <summary>
+    /// Event fired once the list of hardware MSUs has been updated
+    /// </summary>
+    public event EventHandler<MsuListEventArgs> HardwareMsusChanged;
+
 }
diff --git a/MSURandomizerLibrary/Services/IMsuLookupService.cs b/MSURandomizerLibrary/Services/IMsuLookupService.cs
@@ -14,6 +14,11 @@ public interface IMsuLookupService
     /// </summary>
     /// <returns>A collection of all MSUs found</returns>
     public IReadOnlyCollection<Msu> LookupMsus();
+    
+    /// <summary>
+    /// Instructs the UI that some MSU display information has been updated
+    /// </summary>
+    public void RefreshMsuDisplay();
 
     /// <summary>
     /// Loads all MSUs within a directory and all subdirectories
diff --git a/MSURandomizerLibrary/Services/MsuHardwareService.cs b/MSURandomizerLibrary/Services/MsuHardwareService.cs
diff --git a/MSURandomizerLibrary/Services/MsuLookupService.cs b/MSURandomizerLibrary/Services/MsuLookupService.cs
diff --git a/MSURandomizerLibrary/settings.yaml b/MSURandomizerLibrary/settings.yaml

Original file line number	Diff line number	Diff line change
`@@ -152,6 +152,7 @@ public void UpdateSelectedMsus(ICollection<MsuViewModel>? msus)`
`152`	`152`
`153`	`153`	`public void UpdateHardwareMode(MsuList msuList, List<Msu>? msus)`
`154`	`154`	`{`
	`155`	`+ Model.Filter = MsuFilter.Compatible;`
`155`	`156`	`Model.IsHardwareModeEnabled = msus?.Count > 0;`
`156`	`157`	`msuList.ToggleHardwareMode(Model.IsHardwareModeEnabled);`
`157`	`158`	`msuList.PopulateMsuViewModels(msus);`
Original file line number	Diff line number	Diff line change
`@@ -35,9 +35,9 @@ public class MsuDetailsWindowViewModel : ViewModelBase`
`35`	`35`
`36`	`36`	`public string TrackCountString => $"{TrackCount} Tracks";`
`37`	`37`
`38`		`- public bool CanEditDetails => Msu?.HasDetails != true && Msu?.IsHardwareMsu != true;`
	`38`	`+ public bool CanEditDetails => Msu?.HasDetails != true;`
`39`	`39`
`40`		`- public bool CanEditMsuType => Msu?.IsHardwareMsu != true;`
	`40`	`+ public bool CanEditMsuType => true;`
`41`	`41`
`42`	`42`	`public bool IsNotLast { get; set; } = true;`
`43`	`43`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,6 @@`
`5`	`5`	`using Avalonia.Interactivity;`
`6`	`6`	`using Avalonia.Threading;`
`7`	`7`	`using AvaloniaControls.Extensions;`
`8`		`-using AvaloniaControls.Services;`
`9`	`8`	`using MSURandomizer.Services;`
`10`	`9`	`using MSURandomizer.ViewModels;`
`11`	`10`	`using MSURandomizerLibrary;`
`@@ -42,11 +41,11 @@ public MsuList()`
`42`	`41`	`else`
`43`	`42`	`{`
`44`	`43`	`_service = this.GetControlService<MsuListService>();`
	`44`	`+ DataContext = _model = _service!.InitializeModel();`
`45`	`45`	`_service!.OnDisplayUnknownMsuWindowRequest += (sender, args) =>`
`46`	`46`	`{`
`47`	`47`	`OpenUnknownMsuWindow();`
`48`	`48`	`};`
`49`		`- DataContext = _model = _service!.InitializeModel();`
`50`	`49`	`}`
`51`	`50`	`}`
`52`	`51`
`@@ -108,7 +107,7 @@ public void OpenUnknownMsuWindow()`
`108`	`107`	`Dispatcher.UIThread.Invoke(() =>`
`109`	`108`	`{`
`110`	`109`	`var parentWindow = TopLevel.GetTopLevel(this) as Window;`
`111`		`- var unknownMsuWindow = new UnknownMsuWindow();`
	`110`	`+ var unknownMsuWindow = new UnknownMsuWindow(_service?.Model.HardwareMode == true);`
`112`	`111`	`unknownMsuWindow.ShowDialog(parentWindow!);`
`113`	`112`	`});`
`114`	`113`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,8 +12,10 @@ public partial class UnknownMsuWindow : ScalableWindow`
`12`	`12`	`{`
`13`	`13`	`private readonly UnknownMsuWindowService? _service;`
`14`	`14`	`private bool _pressedSave;`
`15`		`-`
`16`		`- public UnknownMsuWindow()`
	`15`	`+`
	`16`	`+ public UnknownMsuWindow() : this(false) { }`
	`17`	`+`
	`18`	`+ public UnknownMsuWindow(bool isHardwareMode)`
`17`	`19`	`{`
`18`	`20`	`InitializeComponent();`
`19`	`21`
`@@ -54,7 +56,7 @@ public UnknownMsuWindow()`
`54`	`56`	`}`
`55`	`57`
`56`	`58`	`_service = this.GetControlService<UnknownMsuWindowService>();`
`57`		`- DataContext = _service!.InitilizeModel();`
	`59`	`+ DataContext = _service!.InitilizeModel(isHardwareMode);`
`58`	`60`	`}`
`59`	`61`
`60`	`62`	`private void SaveButton_OnClick(object? sender, RoutedEventArgs e)`