SpecialKHelper: Fix plugin failing to load if custom install path has not been set

Author: darklinkpower

source/Generic/SpecialKHelper/Core/Application/SpecialKHelper.cs

@@ -48,7 +48,7 @@ public class SpecialKHelper : GenericPlugin
         public SpecialKHelper(IPlayniteAPI api) : base(api)
         {
             _specialKServiceManager = new SpecialKServiceManager(_logger);
-            settings = new SpecialKHelperSettingsViewModel(this, _specialKServiceManager);
+            settings = new SpecialKHelperSettingsViewModel(this, _specialKServiceManager, _logger);
             Properties = new GenericPluginProperties
             {
                 HasSettings = true
@@ -59,7 +59,6 @@ public SpecialKHelper(IPlayniteAPI api) : base(api)
             _sidebarItemSwitcherViewModel = new SidebarItemSwitcherViewModel(true, _pluginInstallPath, _specialKServiceManager, _specialKProfilesEditor);
             _easyAnticheatHelper = new EasyAnticheatService(new EasyAnticheatCache(GetPluginUserDataPath()));
             _steamHelper = new SteamHelper(GetPluginUserDataPath(), PlayniteApi);
-            _specialKServiceManager.SetSpecialKInstallDirectory(Path.GetDirectoryName(settings.Settings.CustomSpecialKPath));
         }
 
         public override IEnumerable<SidebarItem> GetSidebarItems()

source/Generic/SpecialKHelper/Core/Application/SpecialKHelperSettings.cs

@@ -53,25 +53,27 @@ public class SpecialKHelperSettings : ObservableObject
     public class SpecialKHelperSettingsViewModel : ObservableObject, ISettings
     {
         private readonly SpecialKHelper _plugin;
+        private readonly ILogger _logger;
         private readonly SpecialKServiceManager _specialKServiceManager;
 
-        private SpecialKHelperSettings editingClone { get; set; }
+        private SpecialKHelperSettings _editingClone;
 
-        private SpecialKHelperSettings settings;
+        private SpecialKHelperSettings _settings;
         public SpecialKHelperSettings Settings
         {
-            get => settings;
+            get => _settings;
             set
             {
-                settings = value;
+                _settings = value;
                 OnPropertyChanged();
             }
         }
 
-        public SpecialKHelperSettingsViewModel(SpecialKHelper plugin, SpecialKServiceManager specialKServiceManager)
+        public SpecialKHelperSettingsViewModel(SpecialKHelper plugin, SpecialKServiceManager specialKServiceManager, ILogger logger)
         {
             // Injecting your plugin instance is required for Save/Load method because Playnite saves data to a location based on what plugin requested the operation.
             _plugin = plugin;
+            _logger = logger;
             _specialKServiceManager = specialKServiceManager;
             // Load saved settings.
             var savedSettings = plugin.LoadPluginSettings<SpecialKHelperSettings>();
@@ -85,27 +87,48 @@ public SpecialKHelperSettingsViewModel(SpecialKHelper plugin, SpecialKServiceMan
             {
                 Settings = new SpecialKHelperSettings();
             }
+            UpdateSpecialKServiceSettings();
         }
 
         public void BeginEdit()
         {
             // Code executed when settings view is opened and user starts editing values.
-            editingClone = Serialization.GetClone(Settings);
+            _editingClone = Serialization.GetClone(Settings);
         }
 
         public void CancelEdit()
         {
             // Code executed when user decides to cancel any changes made since BeginEdit was called.
             // This method should revert any changes made to Option1 and Option2.
-            Settings = editingClone;
+            Settings = _editingClone;
         }
 
         public void EndEdit()
         {
             // Code executed when user decides to confirm changes made since BeginEdit was called.
             // This method should save settings made to Option1 and Option2.
             _plugin.SavePluginSettings(Settings);
-            _specialKServiceManager.SetSpecialKInstallDirectory(Path.GetDirectoryName(settings.CustomSpecialKPath));
+            UpdateSpecialKServiceSettings();
+        }
+
+        private void UpdateSpecialKServiceSettings()
+        {
+            try
+            {
+                if (!_settings.CustomSpecialKPath.IsNullOrEmpty() && FileSystem.FileExists(_settings.CustomSpecialKPath))
+                {
+                    var directory = Path.GetDirectoryName(string.Empty);
+                    _specialKServiceManager.SetSpecialKInstallDirectory(directory);
+                }
+                else
+                {
+                    _specialKServiceManager.ResetSpecialKInstallDirectory();
+                }
+            }
+            catch (Exception ex)
+            {
+                _logger.Error(ex, $"Failed to set Special K installation from executable: {_settings.CustomSpecialKPath ?? "null"}");
+            }
         }
 
         public bool VerifySettings(out List<string> errors)
@@ -132,7 +155,7 @@ public RelayCommand BrowseSelectSpecialKExecutableCommand
                 var filePath = _plugin.PlayniteApi.Dialogs.SelectFile("SKIF|SKIF.exe");
                 if (!filePath.IsNullOrEmpty())
                 {
-                    settings.CustomSpecialKPath = filePath;
+                    _settings.CustomSpecialKPath = filePath;
                 }
             });
         }
@@ -141,7 +164,7 @@ public RelayCommand RemoveSpecialKExecutableCommand
         {
             get => new RelayCommand(() =>
             {
-                settings.CustomSpecialKPath = string.Empty;
+                _settings.CustomSpecialKPath = string.Empty;
             });
         }
     }

source/Generic/SpecialKHelper/SpecialKHandler/Application/SpecialKServiceManager.cs

@@ -127,16 +127,30 @@ public bool Is64BitsServiceRunning()
             return IsProcessRunning(_64BitsServiceProcessName);
         }
 
-        internal void SetSpecialKInstallDirectory(string customSpecialKPath)
+        public void ResetSpecialKInstallDirectory()
+        {
+            if (!_customSpecialKInstallationPath.IsNullOrEmpty())
+            {
+                _customSpecialKInstallationPath = string.Empty;
+                _logger.Info($"Special K installation path has been reset");
+            }
+        }
+
+        internal bool SetSpecialKInstallDirectory(string customSpecialKPath)
         {
             if (customSpecialKPath.IsNullOrWhiteSpace() || !FileSystem.DirectoryExists(customSpecialKPath))
             {
                 _logger.Info($"Failed to set Special K installation path: {customSpecialKPath ?? "null"}. Directory does not exist.");
-                return;
+                return false;
+            }
+
+            if (_customSpecialKInstallationPath != customSpecialKPath)
+            {
+                _customSpecialKInstallationPath = customSpecialKPath;
+                _logger.Info($"Special K installation path successfully set to: {_customSpecialKInstallationPath}");
             }
 
-            _customSpecialKInstallationPath = customSpecialKPath;
-            _logger.Info($"Special K installation path successfully set to: {_customSpecialKInstallationPath}");
+            return true;
         }
 
         public string GetInstallDirectory()