Merge pull request #8995 from ivangrek/fix-5797

Resolve PluginSettings key names issue
gitextensions · Mar 26, 2021 · c9b8c73 · c9b8c73
2 parents 643c033 + 7c901fb
commit c9b8c73
Show file tree

Hide file tree

Showing 34 changed files with 266 additions and 209 deletions.
diff --git a/GitUI/CommandsDialogs/BrowseDialog/DashboardControl/Dashboard.cs b/GitUI/CommandsDialogs/BrowseDialog/DashboardControl/Dashboard.cs
@@ -126,7 +126,7 @@ void InitDashboardLayout()
 
                             foreach (var gitHoster in PluginRegistry.GitHosters)
                             {
-                                lastControl = CreateLink(panel, string.Format(_cloneFork.Text, gitHoster.Description), Images.CloneRepoGitHub,
+                                lastControl = CreateLink(panel, string.Format(_cloneFork.Text, gitHoster.Name), Images.CloneRepoGitHub,
                                     (repoSender, eventArgs) => UICommands.StartCloneForkFromHoster(this, gitHoster, GitModuleChanged));
                             }
 

diff --git a/GitUI/CommandsDialogs/FormBrowse.cs b/GitUI/CommandsDialogs/FormBrowse.cs
@@ -949,7 +949,7 @@ private void RegisterPlugins()
 
                     var item = new ToolStripMenuItem
                     {
-                        Text = plugin.Description,
+                        Text = plugin.Name,
                         Image = plugin.Icon,
                         Tag = plugin
                     };
@@ -990,7 +990,7 @@ private void RegisterPlugins()
             _repositoryHostsToolStripMenuItem.Visible = PluginRegistry.GitHosters.Count > 0;
             if (PluginRegistry.GitHosters.Count == 1)
             {
-                _repositoryHostsToolStripMenuItem.Text = PluginRegistry.GitHosters[0].Description;
+                _repositoryHostsToolStripMenuItem.Text = PluginRegistry.GitHosters[0].Name;
             }
 
             UpdatePluginMenu(Module.IsValidGitWorkingDir());

diff --git a/GitUI/CommandsDialogs/RepoHosting/ForkAndCloneForm.cs b/GitUI/CommandsDialogs/RepoHosting/ForkAndCloneForm.cs
@@ -88,7 +88,7 @@ private void Init()
                 });
             }
 
-            Text = _gitHoster.Description + ": " + Text;
+            Text = $"{_gitHoster.Name}: {Text}";
 
             UpdateCloneInfo();
             UpdateMyRepos();
@@ -134,7 +134,7 @@ private void UpdateMyRepos()
                         await this.SwitchToMainThreadAsync();
 
                         myReposLV.Items.Clear();
-                        helpTextLbl.Text = string.Format(_strFailedToGetRepos.Text, _gitHoster.Description) +
+                        helpTextLbl.Text = string.Format(_strFailedToGetRepos.Text, _gitHoster.Name) +
                                             "\r\n\r\nException: " + ex.Message + "\r\n\r\n" + helpTextLbl.Text;
                     }
                 })

diff --git a/GitUI/CommandsDialogs/SettingsDialog/Plugins/PluginSettingsPage.cs b/GitUI/CommandsDialogs/SettingsDialog/Plugins/PluginSettingsPage.cs
@@ -27,10 +27,12 @@ private void CreateSettingsControls()
 
         private void Init(IGitPlugin gitPlugin)
         {
-            Validates.NotNull(gitPlugin.Name);
+            Validates.NotNull(gitPlugin.Description);
 
             _gitPlugin = gitPlugin;
-            _settingsContainer = new GitPluginSettingsContainer(gitPlugin.Name);
+
+            // Description for old plugin setting processing as key
+            _settingsContainer = new GitPluginSettingsContainer(gitPlugin.Id, gitPlugin.Description);
             CreateSettingsControls();
             InitializeComplete();
         }
@@ -52,7 +54,7 @@ protected override ISettingsSource GetCurrentSettings()
 
         public override string GetTitle()
         {
-            return _gitPlugin?.Description ?? string.Empty;
+            return _gitPlugin?.Name ?? string.Empty;
         }
 
         private IEnumerable<ISetting> GetSettings()

diff --git a/GitUI/Plugin/GitPluginSettingsContainer.cs b/GitUI/Plugin/GitPluginSettingsContainer.cs
@@ -6,11 +6,13 @@ namespace GitUI
 {
     public class GitPluginSettingsContainer : ISettingsSource, IGitPluginSettingsContainer
     {
+        private readonly Guid _pluginId;
         private readonly string _pluginName;
         private ISettingsSource? _settingsSource;
 
-        public GitPluginSettingsContainer(string pluginName)
+        public GitPluginSettingsContainer(Guid pluginId, string pluginName)
         {
+            _pluginId = pluginId;
             _pluginName = pluginName;
         }
 
@@ -34,12 +36,33 @@ public override SettingLevel SettingLevel
 
         public override T GetValue<T>(string name, T defaultValue, Func<string, T> decode)
         {
-            return ExternalSettings.GetValue(_pluginName + name, defaultValue, decode);
+            // for old plugin setting processing
+            if (_pluginId == Guid.Empty)
+            {
+                return ExternalSettings.GetValue($"{_pluginName}{name}", defaultValue, decode);
+            }
+
+            var value = ExternalSettings.GetValue($"{_pluginId}.{name}", defaultValue, decode);
+
+            // for old plugin setting processing
+            if (value is null || value.Equals(defaultValue))
+            {
+                value = ExternalSettings.GetValue($"{_pluginName}{name}", defaultValue, decode);
+            }
+
+            return value;
         }
 
         public override void SetValue<T>(string name, T value, Func<T, string?> encode)
         {
-            ExternalSettings.SetValue(_pluginName + name, value, encode);
+            if (_pluginId == Guid.Empty)
+            {
+                ExternalSettings.SetValue($"{_pluginName}{name}", value, encode);
+            }
+            else
+            {
+                ExternalSettings.SetValue($"{_pluginId}.{name}", value, encode);
+            }
         }
     }
 }
diff --git a/GitUI/Plugin/PluginRegistry.cs b/GitUI/Plugin/PluginRegistry.cs
@@ -33,8 +33,10 @@ public static void Initialize()
 
                     foreach (var plugin in ManagedExtensibility.GetExports<IGitPlugin>().Select(lazy => lazy.Value))
                     {
-                        Validates.NotNull(plugin.Name);
-                        plugin.SettingsContainer = new GitPluginSettingsContainer(plugin.Name);
+                        Validates.NotNull(plugin.Description);
+
+                        // Description for old plugin setting processing as key
+                        plugin.SettingsContainer = new GitPluginSettingsContainer(plugin.Id, plugin.Description);
 
                         if (plugin is IRepositoryHostPlugin repositoryHostPlugin)
                         {

diff --git a/GitUI/Script/ScriptRunner.cs b/GitUI/Script/ScriptRunner.cs
@@ -117,7 +117,7 @@ private static CommandStatus RunScriptInternal(IWin32Window owner, IGitModule mo
                 {
                     foreach (var plugin in PluginRegistry.Plugins)
                     {
-                        if (string.Equals(plugin.Description, command, StringComparison.CurrentCultureIgnoreCase))
+                        if (string.Equals(plugin.Name, command, StringComparison.CurrentCultureIgnoreCase))
                         {
                             var eventArgs = new GitUIEventArgs(owner, uiCommands);
                             return new CommandStatus(executed: true, needsGridRefresh: plugin.Execute(eventArgs));

diff --git a/GitUI/Translation/Czech.Plugins.xlf b/GitUI/Translation/Czech.Plugins.xlf
@@ -10,7 +10,7 @@
   </file>
   <file datatype="plaintext" original="AutoCompileSubModulesPlugin" source-language="en" target-language="cs">
     <body>
-      <trans-unit id="Description.Text">
+      <trans-unit id="Name.Text">
         <source>Auto compile SubModules</source>
         <target>Automaticky přeložit podmoduly</target>
 
@@ -48,7 +48,7 @@
   </file>
   <file datatype="plaintext" original="BackgroundFetchPlugin" source-language="en" target-language="cs">
     <body>
-      <trans-unit id="Description.Text">
+      <trans-unit id="Name.Text">
         <source>Periodic background fetch</source>
         <target>Pravidelné přenášení na pozadí</target>
 
@@ -97,7 +97,7 @@
         <target>Uživatelské jméno na Bitbucket</target>
 
       </trans-unit>
-      <trans-unit id="Description.Text">
+      <trans-unit id="Name.Text">
         <source>Bitbucket Server</source>
         <target>Bitbucket server</target>
 
@@ -296,7 +296,7 @@
   </file>
   <file datatype="plaintext" original="CreateLocalBranchesPlugin" source-language="en" target-language="cs">
     <body>
-      <trans-unit id="Description.Text">
+      <trans-unit id="Name.Text">
         <source>Create local tracking branches</source>
         <target>Vytvořit místní sledovací větve</target>
 
@@ -458,7 +458,7 @@ Opravdu chcete pokračovat?</target>
   </file>
   <file datatype="plaintext" original="DeleteUnusedBranchesPlugin" source-language="en" target-language="cs">
     <body>
-      <trans-unit id="Description.Text">
+      <trans-unit id="Name.Text">
         <source>Delete obsolete branches</source>
         <target>Smazat zastaralé větve</target>
 
@@ -577,7 +577,7 @@ Opravdu chcete pokračovat?</target>
   </file>
   <file datatype="plaintext" original="FindLargeFilesPlugin" source-language="en" target-language="cs">
     <body>
-      <trans-unit id="Description.Text">
+      <trans-unit id="Name.Text">
         <source>Find large files</source>
         <target>Najít velké soubory</target>
 
@@ -1022,7 +1022,7 @@ To enable Gerrit support for a repository, a .gitreview file must be created. Th
   </file>
   <file datatype="plaintext" original="GerritPlugin" source-language="en" target-language="cs">
     <body>
-      <trans-unit id="Description.Text">
+      <trans-unit id="Name.Text">
         <source>Gerrit Code Review</source>
         <target>Gerrit - Revize kódu</target>
 
@@ -1230,7 +1230,7 @@ To enable Gerrit support for a repository, a .gitreview file must be created. Th
   </file>
   <file datatype="plaintext" original="GitFlowPlugin" source-language="en" target-language="cs">
     <body>
-      <trans-unit id="Description.Text">
+      <trans-unit id="Name.Text">
         <source>GitFlow</source>
         <target>GitFlow</target>
 
@@ -1239,7 +1239,7 @@ To enable Gerrit support for a repository, a .gitreview file must be created. Th
   </file>
   <file datatype="plaintext" original="GitHub3Plugin" source-language="en" target-language="cs">
     <body>
-      <trans-unit id="Description.Text">
+      <trans-unit id="Name.Text">
         <source>GitHub</source>
         <target>GitHub</target>
 
@@ -1265,7 +1265,7 @@ To enable Gerrit support for a repository, a .gitreview file must be created. Th
   </file>
   <file datatype="plaintext" original="GitImpactPlugin" source-language="en" target-language="cs">
     <body>
-      <trans-unit id="Description.Text">
+      <trans-unit id="Name.Text">
         <source>Impact Graph</source>
         <target>Graf vlivu</target>
 
@@ -1274,7 +1274,7 @@ To enable Gerrit support for a repository, a .gitreview file must be created. Th
   </file>
   <file datatype="plaintext" original="GitStatisticsPlugin" source-language="en" target-language="cs">
     <body>
-      <trans-unit id="Description.Text">
+      <trans-unit id="Name.Text">
         <source>Statistics</source>
         <target>Statistiky</target>
 
@@ -1298,7 +1298,7 @@ To enable Gerrit support for a repository, a .gitreview file must be created. Th
   </file>
   <file datatype="plaintext" original="GourcePlugin" source-language="en" target-language="cs">
     <body>
-      <trans-unit id="Description.Text">
+      <trans-unit id="Name.Text">
         <source>Gource</source>
         <target>Gource</target>
 
@@ -1445,7 +1445,7 @@ Chcete znovu nastavit cestu?</target>
   </file>
   <file datatype="plaintext" original="JiraCommitHintPlugin" source-language="en" target-language="cs">
     <body>
-      <trans-unit id="Description.Text">
+      <trans-unit id="Name.Text">
         <source>Jira Commit Hint</source>
 
       </trans-unit>
@@ -1553,7 +1553,7 @@ Chcete znovu nastavit cestu?</target>
   </file>
   <file datatype="plaintext" original="ProxySwitcherPlugin" source-language="en" target-language="cs">
     <body>
-      <trans-unit id="Description.Text">
+      <trans-unit id="Name.Text">
         <source>Proxy Switcher</source>
         <target>Přepínač proxy serverů</target>
 
@@ -1708,7 +1708,7 @@ název větve, nebo značky)</target>
   </file>
   <file datatype="plaintext" original="ReleaseNotesGeneratorPlugin" source-language="en" target-language="cs">
     <body>
-      <trans-unit id="Description.Text">
+      <trans-unit id="Name.Text">
         <source>Release Notes Generator</source>
         <target>Generátor poznámek k vydání</target>