ExternalLinksParser rework

GitCommands/ExternalLinks/ConfiguredLinkDefinitionsProvider.cs

@@ -0,0 +1,55 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using GitCommands.Settings;
+
+namespace GitCommands.ExternalLinks
+{
+    /// <summary>
+    /// Provides the ability to retrieves available persisted external link definitions.
+    /// </summary>
+    public interface IConfiguredLinkDefinitionsProvider
+    {
+        /// <summary>
+        /// Loads all persisted external link definitions across all setting layers.
+        /// </summary>
+        IList<ExternalLinkDefinition> Get(RepoDistSettings settings);
+    }
+
+    /// <summary>
+    /// Retrieves available persisted external link definitions.
+    /// </summary>
+    public sealed class ConfiguredLinkDefinitionsProvider : IConfiguredLinkDefinitionsProvider
+    {
+        private readonly IExternalLinksLoader _externalLinksLoader;
+
+
+        public ConfiguredLinkDefinitionsProvider(IExternalLinksLoader externalLinksLoader)
+        {
+            _externalLinksLoader = externalLinksLoader;
+        }
+
+
+        /// <summary>
+        /// Loads all persisted external link definitions across all setting layers.
+        /// </summary>
+        public IList<ExternalLinkDefinition> Get(RepoDistSettings settings)
+        {
+            if (settings == null)
+            {
+                throw new ArgumentNullException(nameof(settings));
+            }
+
+            var cachedSettings = new RepoDistSettings(null, settings.SettingsCache);
+            IEnumerable<ExternalLinkDefinition> effective = _externalLinksLoader.Load(cachedSettings);
+
+            if (settings.LowerPriority != null)
+            {
+                var lowerPriorityLoader = new ConfiguredLinkDefinitionsProvider(_externalLinksLoader);
+                effective = effective.Union(lowerPriorityLoader.Get(settings.LowerPriority));
+            }
+
+            return effective.ToList();
+        }
+    }
+}

GitCommands/GitExtLinks/GitExtLink.cs → GitCommands/ExternalLinks/ExternalLink.cs

@@ -1,11 +1,9 @@
-using System;
-using System.Collections.Generic;
-using System.Text;
+using System.Collections.Generic;
 using GitCommands.Core;
 
-namespace GitCommands.GitExtLinks
+namespace GitCommands.ExternalLinks
 {
-    public class GitExtLink: SimpleStructured
+    public class ExternalLink: SimpleStructured
     {
         public string Caption { get; set; }
         public string URI { get; set; }

GitCommands/GitExtLinks/GitExtLinkDef.cs → GitCommands/ExternalLinks/ExternalLinkDefinition.cs

@@ -7,9 +7,10 @@
 using GitCommands.Core;
 using GitCommands.Remote;
 
-namespace GitCommands.GitExtLinks
+namespace GitCommands.ExternalLinks
 {
-    public class GitExtLinkDef : SimpleStructured
+    [XmlType("GitExtLinkDef")]
+    public class ExternalLinkDefinition : SimpleStructured
     {
         //revision's parts that can be searched for candidates for a link
         public enum RevisionPart
@@ -177,26 +178,26 @@ public string UseRemotesPattern
         /// </summary>
         public BindingList<GitExtLinkFormat> LinkFormats = new BindingList<GitExtLinkFormat>();
 
-        public GitExtLinkDef()
+        public ExternalLinkDefinition()
         {
         }
 
-        public IEnumerable<GitExtLink> Parse(GitRevision revision)
+        public IEnumerable<ExternalLink> Parse(GitRevision revision)
         {
             GitRemoteManager remoteManager = new GitRemoteManager(revision.Module);
             return Parse(revision, remoteManager);
         }
 
-        internal IEnumerable<GitExtLink> Parse(GitRevision revision, IGitRemoteManager remoteManager)
+        internal IEnumerable<ExternalLink> Parse(GitRevision revision, IGitRemoteManager remoteManager)
         {
             IEnumerable<Match> remoteMatches = ParseRemotes(remoteManager);
 
             return remoteMatches.SelectMany(remoteMatch => ParseRevision(remoteMatch, revision));
         }
 
-        public IEnumerable<GitExtLink> ParseRevision(Match remoteMatch, GitRevision revision)
+        public IEnumerable<ExternalLink> ParseRevision(Match remoteMatch, GitRevision revision)
         {
-            List<IEnumerable<GitExtLink>> links = new List<IEnumerable<GitExtLink>>();
+            List<IEnumerable<ExternalLink>> links = new List<IEnumerable<ExternalLink>>();
 
             if (SearchInParts.Contains(RevisionPart.LocalBranches))
             {
@@ -294,7 +295,7 @@ private IEnumerable<GitRemote> OrderByPositionInUseRemotePattern(IEnumerable<Git
             return remotes.OrderBy(r => UseRemotesPattern.IndexOf(r.Name, StringComparison.OrdinalIgnoreCase));
         }
 
-        public IEnumerable<GitExtLink> ParseRevisionPart(Match remoteMatch, string part, GitRevision revision)
+        public IEnumerable<ExternalLink> ParseRevisionPart(Match remoteMatch, string part, GitRevision revision)
         {
             if (SearchPattern.IsNullOrEmpty() || SearchPatternRegex.Value == null || part == null)
                 yield break;
@@ -362,9 +363,9 @@ public class GitExtLinkFormat : SimpleStructured
         [XmlIgnore]
         public bool IsValid { get; private set; }
 
-        public GitExtLink ToGitExtLink(Match remoteMatch, Match revisionMatch, GitRevision revision)
+        public ExternalLink ToGitExtLink(Match remoteMatch, Match revisionMatch, GitRevision revision)
         {
-            GitExtLink link = new GitExtLink();
+            ExternalLink link = new ExternalLink();
 
             var groups = new List<string>();
             AddGroupsFromMatches(remoteMatch, groups);

GitCommands/ExternalLinks/ExternalLinksLoader.cs

@@ -0,0 +1,99 @@
+using System;
+using System.Collections.Generic;
+using System.Diagnostics;
+using System.IO;
+using System.Linq;
+using System.Xml;
+using System.Xml.Serialization;
+using GitCommands.Settings;
+
+namespace GitCommands.ExternalLinks
+{
+    public interface IExternalLinksLoader
+    {
+        /// <summary>
+        /// Loads external link definitions from the settings.
+        /// </summary>
+        IList<ExternalLinkDefinition> Load(RepoDistSettings settings);
+
+        /// <summary>
+        /// Saves the provided external link definitions to the settings.
+        /// </summary>
+        void Save(RepoDistSettings settings, IList<ExternalLinkDefinition> definitions);
+    }
+
+    public sealed class ExternalLinksLoader : IExternalLinksLoader
+    {
+        private const string SettingName = "RevisionLinkDefs";
+
+
+        /// <summary>
+        /// Loads external link definitions from the settings.
+        /// </summary>
+        public IList<ExternalLinkDefinition> Load(RepoDistSettings settings)
+        {
+            var cachedSettings = new RepoDistSettings(null, settings.SettingsCache);
+            var xml = cachedSettings.GetString(SettingName, null);
+            return LoadFromXmlString(xml);
+        }
+
+        /// <summary>
+        /// Saves the provided external link definitions to the settings.
+        /// </summary>
+        public void Save(RepoDistSettings settings, IList<ExternalLinkDefinition> definitions)
+        {
+            try
+            {
+                string xml;
+                if (definitions.Count == 0)
+                {
+                    xml = null;
+                }
+                else
+                {
+                    definitions.ForEach(linkDef => linkDef.RemoveEmptyFormats());
+
+                    var sw = new StringWriter();
+                    var serializer = new XmlSerializer(typeof(List<ExternalLinkDefinition>));
+                    serializer.Serialize(sw, definitions);
+                    xml = sw.ToString();
+                }
+
+                var cachedSettings = new RepoDistSettings(null, settings.SettingsCache);
+                cachedSettings.SetString(SettingName, xml);
+            }
+            catch (Exception e)
+            {
+                Debug.WriteLine(e);
+            }
+        }
+
+
+        // TODO: refactor and outsource to the centralised SettingsSerialiser implementations.
+        private static IList<ExternalLinkDefinition> LoadFromXmlString(string xmlString)
+        {
+            if (string.IsNullOrWhiteSpace(xmlString))
+            {
+                return new List<ExternalLinkDefinition>();
+            }
+
+            try
+            {
+                var serializer = new XmlSerializer(typeof(List<ExternalLinkDefinition>));
+                using (var stringReader = new StringReader(xmlString))
+                {
+                    using (var xmlReader = new XmlTextReader(stringReader))
+                    {
+                        return serializer.Deserialize(xmlReader) as List<ExternalLinkDefinition>;
+                    }
+                }
+            }
+            catch (Exception ex)
+            {
+                Debug.WriteLine(ex.Message);
+            }
+
+            return new List<ExternalLinkDefinition>();
+        }
+    }
+}

GitCommands/ExternalLinks/ExternalLinksManager.cs

@@ -0,0 +1,95 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using GitCommands.Settings;
+
+namespace GitCommands.ExternalLinks
+{
+    // NB: this implementation is stateful
+    public sealed class ExternalLinksManager
+    {
+        private readonly RepoDistSettings _cachedSettings;
+        private readonly ExternalLinksManager _lowerPriority;
+        private readonly IExternalLinksLoader _externalLinksLoader = new ExternalLinksLoader();
+        private readonly IList<ExternalLinkDefinition> _definitions;
+
+
+        public ExternalLinksManager(RepoDistSettings settings)
+        {
+            _cachedSettings = new RepoDistSettings(null, settings.SettingsCache);
+            _definitions = _externalLinksLoader.Load(_cachedSettings);
+
+            if (settings.LowerPriority != null)
+            {
+                _lowerPriority = new ExternalLinksManager(settings.LowerPriority);
+            }
+        }
+
+
+        /// <summary>
+        /// Adds the provided definition at the lowest available level.
+        /// </summary>
+        /// <param name="definition">External link defintion.</param>
+        public void Add(ExternalLinkDefinition definition)
+        {
+            if (definition == null)
+            {
+                throw new ArgumentNullException(nameof(definition));
+            }
+
+            if (_lowerPriority == null || _lowerPriority.Contains(definition.Name))
+            {
+                if (!Contains(definition.Name))
+                {
+                    _definitions.Add(definition);
+                }
+                // TODO: else notify the user?
+            }
+            else
+            {
+                _lowerPriority.Add(definition);
+            }
+        }
+
+        /// <summary>
+        /// Checks if a definition with the supplied name exists in any level of available settings.
+        /// </summary>
+        /// <param name="definitionName">The name of the defintion to find.</param>
+        /// <returns><see langword="true"/> if a definition already exists; otherwise <see langword="false"/>.</returns>
+        public bool Contains(string definitionName)
+        {
+            return _definitions.Any(linkDef => linkDef.Name.Equals(definitionName));
+        }
+
+        /// <summary>
+        /// Loads all settings from all available levels.
+        /// </summary>
+        /// <returns>A collection of all available definitions.</returns>
+        public IList<ExternalLinkDefinition> GetEffectiveSettings()
+        {
+            var effective = _definitions.Union(_lowerPriority?.GetEffectiveSettings() ?? Enumerable.Empty<ExternalLinkDefinition>()).ToList();
+            return effective.ToList();
+        }
+
+        /// <summary>
+        /// Removes the supplied deifintion.
+        /// </summary>
+        /// <param name="definition">External link defintion.</param>
+        public void Remove(ExternalLinkDefinition definition)
+        {
+            if (!_definitions.Remove(definition))
+            {
+                _lowerPriority?.Remove(definition);
+            }
+        }
+
+        /// <summary>
+        /// Saves the provided external link definitions to the settings.
+        /// </summary>
+        public void Save()
+        {
+            _lowerPriority?.Save();
+            _externalLinksLoader.Save(_cachedSettings, _definitions);
+        }
+    }
+}

GitCommands/ExternalLinks/GitRevisionExternalLinksParser.cs

@@ -0,0 +1,30 @@
+using System.Collections.Generic;
+using System.Linq;
+using GitCommands.Settings;
+
+namespace GitCommands.ExternalLinks
+{
+    public interface IGitRevisionExternalLinksParser
+    {
+        IEnumerable<ExternalLink> Parse(GitRevision revision, RepoDistSettings settings);
+    }
+
+    public sealed class GitRevisionExternalLinksParser : IGitRevisionExternalLinksParser
+    {
+        private readonly IConfiguredLinkDefinitionsProvider _effectiveLinkDefinitionsProvider;
+
+
+        public GitRevisionExternalLinksParser(IConfiguredLinkDefinitionsProvider effectiveLinkDefinitionsProvider)
+        {
+            _effectiveLinkDefinitionsProvider = effectiveLinkDefinitionsProvider;
+        }
+
+
+        public IEnumerable<ExternalLink> Parse(GitRevision revision, RepoDistSettings settings)
+        {
+            var definitions = _effectiveLinkDefinitionsProvider.Get(settings);
+            return definitions.Where(definition => definition.Enabled)
+                              .SelectMany(linkDef => linkDef.Parse(revision));
+        }
+    }
+}

GitCommands/GitCommands.csproj

@@ -93,6 +93,11 @@
     <Compile Include="EnvironmentAbstraction.cs" />
     <Compile Include="EnvironmentPathsProvider.cs" />
     <Compile Include="ExceptionUtils.cs" />
+    <Compile Include="ExternalLinks\ConfiguredLinkDefinitionsProvider.cs" />
+    <Compile Include="ExternalLinks\ExternalLinkDefinition.cs" />
+    <Compile Include="ExternalLinks\ExternalLinksLoader.cs" />
+    <Compile Include="ExternalLinks\ExternalLinksManager.cs" />
+    <Compile Include="ExternalLinks\GitRevisionExternalLinksParser.cs" />
     <Compile Include="FileAssociatedIconProvider.cs" />
     <Compile Include="FileHelper.cs" />
     <Compile Include="FullPathResolver.cs" />
@@ -135,9 +140,7 @@
     <Compile Include="Settings\SettingsContainer.cs" />
     <Compile Include="Settings\SettingsPath.cs" />
     <Compile Include="Utils\EnvUtils.cs" />
-    <Compile Include="GitExtLinks\GitExtLink.cs" />
-    <Compile Include="GitExtLinks\GitExtLinkDef.cs" />
-    <Compile Include="GitExtLinks\GitExtLinksParser.cs" />
+    <Compile Include="ExternalLinks\ExternalLink.cs" />
     <Compile Include="Git\GitBisectOption.cs" />
     <Compile Include="Git\GitCheckoutBranchCmd.cs" />
     <Compile Include="Git\GitCommand.cs" />