feature: support .issuetracker file

Beforehand issue trackers could be defined in the repository
configuration only.  They were stored in the `.git` directory.  As a
consequence each SourceGit user had to configure issue trackers for
himself.

Now additional issue tracker rules are read from an existing
`.issuetracker` file (#1424).  An issue tracker configured by a user has
a higher priority than an issue tracker read from `.issuetracker`.

This allows to share issue trackers between team members.

SourceGit does not (yet?) write into the `.issuetracker` file.  But
using `git config` allows the user to easily construct issue tracker
rules for the `.issuetracker` file, where even the escaping of the
backslash in '#(\d+)' is done correctly.

A `.issuetracker` file was added to SourceGit.  It was created by
executing the following commands in a bash shell, where the current
directory was the repository root:

```bash
cat >.issuetracker <<EOF
# Integration with Issue Tracker
#
# (note that '\' need to be escaped).

EOF
git config set --file .issuetracker issuetracker.GitHub.regex '#(\d+)'
git config set --file .issuetracker issuetracker.GitHub.url \
  'https://github.com/sourcegit-scm/sourcegit/issues/$1'
```

Author: sina-hide

.issuetracker

@@ -0,0 +1,7 @@
+# Integration with Issue Tracker
+#
+# (note that '\' need to be escaped).
+
+[issuetracker "GitHub"]
+	regex = "#(\\d+)"
+	url = https://github.com/sourcegit-scm/sourcegit/issues/$1

src/Commands/Config.cs

@@ -20,9 +20,9 @@ public Config(string repository)
             }
         }
 
-        public async Task<Dictionary<string, string>> ReadAllAsync()
+        public async Task<Dictionary<string, string>> ReadAllAsync(string file = null)
         {
-            Args = "config -l";
+            Args = string.IsNullOrEmpty(file) ? "config -l" : $"config -l -f {file}";
 
             var output = await ReadToEndAsync().ConfigureAwait(false);
             var rs = new Dictionary<string, string>();

src/Models/IRepository.cs

@@ -4,6 +4,8 @@ public interface IRepository
     {
         bool MayHaveSubmodules();
 
+        void LoadSharedIssueTrackerRules();
+
         void RefreshBranches();
         void RefreshWorktrees();
         void RefreshTags();

src/Models/Watcher.cs

@@ -260,6 +260,12 @@ private void HandleWorkingCopyFileChanged(string name)
                 return;
             }
 
+            if (name == ".issuetracker")
+            {
+                _repo.LoadSharedIssueTrackerRules();
+                return;
+            }
+
             lock (_lockSubmodule)
             {
                 foreach (var submodule in _submodules)

src/ViewModels/CommitDetail.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.ComponentModel;
 using System.IO;
 using System.Text.RegularExpressions;
 using System.Threading;
@@ -145,10 +146,12 @@ public CommitDetail(Repository repo, bool rememberActivePageIndex)
             _repo = repo;
             _rememberActivePageIndex = rememberActivePageIndex;
             WebLinks = Models.CommitLink.Get(repo.Remotes);
+            _repo.PropertyChanged += OnRepoPropertyChanged;
         }
 
         public void Dispose()
         {
+            _repo.PropertyChanged -= OnRepoPropertyChanged;
             _repo = null;
             _commit = null;
             _changes = null;
@@ -666,6 +669,12 @@ public ContextMenu CreateRevisionFileContextMenu(Models.Object file)
             return menu;
         }
 
+        private void OnRepoPropertyChanged(object sender, PropertyChangedEventArgs e)
+        {
+            if (e.PropertyName == nameof(Repository.SharedIssueTrackerRules))
+                Refresh();
+        }
+
         private void Refresh()
         {
             _changes = null;
@@ -770,6 +779,12 @@ private void Refresh()
                     rule.Matches(inlines, message);
             }
 
+            if (_repo.SharedIssueTrackerRules is { Count: > 0 } sharedRules)
+            {
+                foreach (var rule in sharedRules)
+                    rule.Matches(inlines, message);
+            }
+
             var urlMatches = REG_URL_FORMAT().Matches(message);
             foreach (Match match in urlMatches)
             {

src/ViewModels/InteractiveRebase.cs

@@ -95,6 +95,11 @@ public AvaloniaList<Models.IssueTrackerRule> IssueTrackerRules
             get => _repo.Settings.IssueTrackerRules;
         }
 
+        public AvaloniaList<Models.IssueTrackerRule> SharedIssueTrackerRules
+        {
+            get => _repo.SharedIssueTrackerRules;
+        }
+
         public bool IsLoading
         {
             get => _isLoading;

src/ViewModels/Repository.cs

@@ -51,6 +51,12 @@ public Models.RepositorySettings Settings
             get => _settings;
         }
 
+        public AvaloniaList<Models.IssueTrackerRule> SharedIssueTrackerRules
+        {
+            get => _sharedIssueTrackerRules;
+            set => SetProperty(ref _sharedIssueTrackerRules, value);
+        }
+
         public Models.GitFlow GitFlow
         {
             get;
@@ -505,6 +511,8 @@ public void Open()
                 _settings = new Models.RepositorySettings();
             }
 
+            LoadSharedIssueTrackerRules();
+
             try
             {
                 // For worktrees, we need to watch the $GIT_COMMON_DIR instead of the $GIT_DIR.
@@ -590,6 +598,51 @@ public void Close()
             _matchedFilesForSearching = null;
         }
 
+        public void LoadSharedIssueTrackerRules()
+        {
+            var issueTrackerFile = Path.Combine(_fullpath, ".issuetracker");
+            if (File.Exists(issueTrackerFile))
+            {
+                Task.Run(async () =>
+                {
+                    AvaloniaList<Models.IssueTrackerRule> rules;
+
+                    try
+                    {
+                        var config = new Commands.Config(_fullpath);
+                        var trackers = await config.ReadAllAsync(".issuetracker").ConfigureAwait(false);
+
+                        var map = new Dictionary<string, Models.IssueTrackerRule>();
+                        var lookup = map.GetAlternateLookup<ReadOnlySpan<char>>();
+
+                        foreach (var entry in trackers)
+                        {
+                            var key = entry.Key.AsSpan();
+                            if (!key.StartsWith("issuetracker."))
+                                continue;
+
+                            if (key.EndsWith(".regex"))
+                                GetOrCreateIssueTrackerRule(lookup, key[13 .. ^6]).RegexString = entry.Value;
+                            else if (key.EndsWith(".url"))
+                                GetOrCreateIssueTrackerRule(lookup, key[13 .. ^4]).URLTemplate = entry.Value;
+                        }
+
+                        rules = new AvaloniaList<Models.IssueTrackerRule>(map.Values);
+                    }
+                    catch
+                    {
+                        rules = [];
+                    }
+
+                    Dispatcher.UIThread.Post(() => SharedIssueTrackerRules = rules);
+                });
+            }
+            else
+            {
+                SharedIssueTrackerRules = [];
+            }
+        }
+
         public bool CanCreatePopup()
         {
             var page = GetOwnerPage();
@@ -2803,6 +2856,17 @@ public ContextMenu CreateContextMenuForWorktree(Models.Worktree worktree)
             return menu;
         }
 
+        private static Models.IssueTrackerRule GetOrCreateIssueTrackerRule(
+            Dictionary<string, Models.IssueTrackerRule>.AlternateLookup<ReadOnlySpan<char>> lookup,
+            ReadOnlySpan<char> name)
+        {
+            if (lookup.TryGetValue(name, out var existingRule))
+                return existingRule;
+
+            var newRule = new Models.IssueTrackerRule { Name = name.ToString() };
+            return lookup[name] = newRule;
+        }
+
         private LauncherPage GetOwnerPage()
         {
             var launcher = App.GetLauncher();
@@ -3101,6 +3165,7 @@ private async void AutoFetchImpl(object sender)
         private string _fullpath = string.Empty;
         private string _gitDir = string.Empty;
         private Models.RepositorySettings _settings = null;
+        private AvaloniaList<Models.IssueTrackerRule> _sharedIssueTrackerRules = null;
         private Models.FilterMode _historiesFilterMode = Models.FilterMode.None;
         private bool _hasAllowedSignersFile = false;
 

src/Views/CommitSubjectPresenter.cs

@@ -93,6 +93,15 @@ public AvaloniaList<Models.IssueTrackerRule> IssueTrackerRules
             set => SetValue(IssueTrackerRulesProperty, value);
         }
 
+        public static readonly StyledProperty<AvaloniaList<Models.IssueTrackerRule>> SharedIssueTrackerRulesProperty =
+            AvaloniaProperty.Register<CommitSubjectPresenter, AvaloniaList<Models.IssueTrackerRule>>(nameof(SharedIssueTrackerRules));
+
+        public AvaloniaList<Models.IssueTrackerRule> SharedIssueTrackerRules
+        {
+            get => GetValue(SharedIssueTrackerRulesProperty);
+            set => SetValue(SharedIssueTrackerRulesProperty, value);
+        }
+
         public override void Render(DrawingContext context)
         {
             if (_needRebuildInlines)
@@ -138,7 +147,9 @@ protected override void OnPropertyChanged(AvaloniaPropertyChangedEventArgs chang
         {
             base.OnPropertyChanged(change);
 
-            if (change.Property == SubjectProperty || change.Property == IssueTrackerRulesProperty)
+            if (change.Property == SubjectProperty ||
+                change.Property == IssueTrackerRulesProperty ||
+                change.Property == SharedIssueTrackerRulesProperty)
             {
                 _elements.Clear();
                 ClearHoveredIssueLink();
@@ -155,6 +166,10 @@ protected override void OnPropertyChanged(AvaloniaPropertyChangedEventArgs chang
                 foreach (var rule in rules)
                     rule.Matches(_elements, subject);
 
+                var sharedRules = SharedIssueTrackerRules ?? [];
+                foreach (var rule in sharedRules)
+                    rule.Matches(_elements, subject);
+
                 var keywordMatch = REG_KEYWORD_FORMAT1().Match(subject);
                 if (!keywordMatch.Success)
                     keywordMatch = REG_KEYWORD_FORMAT2().Match(subject);

src/Views/Histories.axaml

@@ -142,6 +142,7 @@
                                               LinkForeground="{DynamicResource Brush.Link}"
                                               Subject="{Binding Subject}"
                                               IssueTrackerRules="{Binding $parent[v:Histories].IssueTrackerRules}"
+                                              SharedIssueTrackerRules="{Binding $parent[v:Histories].SharedIssueTrackerRules}"
                                               FontWeight="{Binding FontWeight}"
                                               Opacity="{Binding Opacity}"/>
                   </Grid>

src/Views/Histories.axaml.cs

@@ -103,6 +103,15 @@ public AvaloniaList<Models.IssueTrackerRule> IssueTrackerRules
             set => SetValue(IssueTrackerRulesProperty, value);
         }
 
+        public static readonly StyledProperty<AvaloniaList<Models.IssueTrackerRule>> SharedIssueTrackerRulesProperty =
+            AvaloniaProperty.Register<Histories, AvaloniaList<Models.IssueTrackerRule>>(nameof(SharedIssueTrackerRules));
+
+        public AvaloniaList<Models.IssueTrackerRule> SharedIssueTrackerRules
+        {
+            get => GetValue(SharedIssueTrackerRulesProperty);
+            set => SetValue(SharedIssueTrackerRulesProperty, value);
+        }
+
         public static readonly StyledProperty<bool> OnlyHighlightCurrentBranchProperty =
             AvaloniaProperty.Register<Histories, bool>(nameof(OnlyHighlightCurrentBranch), true);