From 4b0af79f7388702fd9fcaf426d6defbef1472feb Mon Sep 17 00:00:00 2001
From: leo <longshuang@msn.cn>
Date: Tue, 4 Jun 2024 10:20:31 +0800
Subject: [PATCH] enhance: GPG signing settings.

* remove gpg format settings from repository's local setting
* add support for X.509 format
* ux style
---
 src/Models/GPGFormat.cs               | 22 ++++++++-------------
 src/Resources/Locales/en_US.axaml     |  2 +-
 src/Resources/Locales/zh_CN.axaml     |  6 +++---
 src/ViewModels/RepositoryConfigure.cs | 15 ++------------
 src/Views/Preference.axaml            | 10 ++++++----
 src/Views/Preference.axaml.cs         | 26 ++++++++++++-------------
 src/Views/RepositoryConfigure.axaml   | 28 ++++-----------------------
 7 files changed, 37 insertions(+), 72 deletions(-)

diff --git a/src/Models/GPGFormat.cs b/src/Models/GPGFormat.cs
index bf3b3678..0ba4e9e2 100644
--- a/src/Models/GPGFormat.cs
+++ b/src/Models/GPGFormat.cs
@@ -2,24 +2,18 @@
 
 namespace SourceGit.Models
 {
-    public class GPGFormat(string name, string value, string desc)
+    public class GPGFormat(string name, string value, string desc, string program, bool needFindProgram)
     {
         public string Name { get; set; } = name;
         public string Value { get; set; } = value;
         public string Desc { get; set; } = desc;
+        public string Program { get; set; } = program;
+        public bool NeedFindProgram { get; set; } = needFindProgram;
 
-        public static readonly GPGFormat OPENPGP = new GPGFormat("OPENPGP", "openpgp", "DEFAULT");
-
-        public static readonly GPGFormat SSH = new GPGFormat("SSH", "ssh", "Git >= 2.34.0");
-
-        public static readonly List<GPGFormat> Supported = new List<GPGFormat>() {
-            OPENPGP,
-            SSH,
-        };
-
-        public bool Equals(GPGFormat other)
-        {
-            return Value == other.Value;
-        }
+        public static readonly List<GPGFormat> Supported = [
+            new GPGFormat("OPENPGP", "openpgp", "DEFAULT", "gpg", true),
+            new GPGFormat("X.509", "x509", "", "gpgsm", true),
+            new GPGFormat("SSH", "ssh", "Requires Git >= 2.34.0", "ssh-keygen", false),
+        ];
     }
 }
diff --git a/src/Resources/Locales/en_US.axaml b/src/Resources/Locales/en_US.axaml
index edf3fe1a..b5a96ecd 100644
--- a/src/Resources/Locales/en_US.axaml
+++ b/src/Resources/Locales/en_US.axaml
@@ -314,7 +314,7 @@
   <x:String x:Key="Text.Preference.GPG.CommitEnabled" xml:space="preserve">Commit GPG signing</x:String>
   <x:String x:Key="Text.Preference.GPG.TagEnabled" xml:space="preserve">Tag GPG signing</x:String>
   <x:String x:Key="Text.Preference.GPG.Format" xml:space="preserve">GPG Format</x:String>
-  <x:String x:Key="Text.Preference.GPG.Path" xml:space="preserve">Install Path</x:String>
+  <x:String x:Key="Text.Preference.GPG.Path" xml:space="preserve">Program Install Path</x:String>
   <x:String x:Key="Text.Preference.GPG.Path.Placeholder" xml:space="preserve">Input path for installed gpg program</x:String>
   <x:String x:Key="Text.Preference.GPG.UserKey" xml:space="preserve">User Signing Key</x:String>
   <x:String x:Key="Text.Preference.GPG.UserKey.Placeholder" xml:space="preserve">User's gpg signing key</x:String>
diff --git a/src/Resources/Locales/zh_CN.axaml b/src/Resources/Locales/zh_CN.axaml
index 015cb6cc..f1c5a95f 100644
--- a/src/Resources/Locales/zh_CN.axaml
+++ b/src/Resources/Locales/zh_CN.axaml
@@ -316,9 +316,9 @@
   <x:String x:Key="Text.Preference.GPG" xml:space="preserve">GPG签名</x:String>
   <x:String x:Key="Text.Preference.GPG.CommitEnabled" xml:space="preserve">启用提交签名</x:String>
   <x:String x:Key="Text.Preference.GPG.TagEnabled" xml:space="preserve">启用标签签名</x:String>
-  <x:String x:Key="Text.Preference.GPG.Format" xml:space="preserve">GPG签名格式</x:String>
-  <x:String x:Key="Text.Preference.GPG.Path" xml:space="preserve">可执行文件位置</x:String>
-  <x:String x:Key="Text.Preference.GPG.Path.Placeholder" xml:space="preserve">gpg.exe所在路径</x:String>
+  <x:String x:Key="Text.Preference.GPG.Format" xml:space="preserve">签名格式</x:String>
+  <x:String x:Key="Text.Preference.GPG.Path" xml:space="preserve">签名程序位置</x:String>
+  <x:String x:Key="Text.Preference.GPG.Path.Placeholder" xml:space="preserve">签名程序所在路径</x:String>
   <x:String x:Key="Text.Preference.GPG.UserKey" xml:space="preserve">用户签名KEY</x:String>
   <x:String x:Key="Text.Preference.GPG.UserKey.Placeholder" xml:space="preserve">输入签名提交所使用的KEY</x:String>
   <x:String x:Key="Text.Preference.Merger" xml:space="preserve">外部合并工具</x:String>
diff --git a/src/ViewModels/RepositoryConfigure.cs b/src/ViewModels/RepositoryConfigure.cs
index c1bbdcf5..1409dfa2 100644
--- a/src/ViewModels/RepositoryConfigure.cs
+++ b/src/ViewModels/RepositoryConfigure.cs
@@ -17,12 +17,6 @@ namespace SourceGit.ViewModels
             set;
         }
 
-        public Models.GPGFormat GPGFormat
-        {
-            get;
-            set;
-        }
-
         public bool GPGCommitSigningEnabled
         {
             get;
@@ -60,10 +54,6 @@ namespace SourceGit.ViewModels
                 GPGCommitSigningEnabled = gpgCommitSign == "true";
             if (_cached.TryGetValue("tag.gpgSign", out var gpgTagSign))
                 GPGTagSigningEnabled = gpgTagSign == "true";
-            if (_cached.TryGetValue("gpg.format", out var gpgFormat))
-                GPGFormat = Models.GPGFormat.Supported.Find(x => x.Value == gpgFormat);
-            else
-                GPGFormat = Models.GPGFormat.OPENPGP;
             if (_cached.TryGetValue("user.signingkey", out var signingKey))
                 GPGUserSigningKey = signingKey;
             if (_cached.TryGetValue("http.proxy", out var proxy))
@@ -78,20 +68,19 @@ namespace SourceGit.ViewModels
             SetIfChanged("user.email", UserEmail);
             SetIfChanged("commit.gpgsign", GPGCommitSigningEnabled ? "true" : "false");
             SetIfChanged("tag.gpgSign", GPGTagSigningEnabled ? "true" : "false");
-            SetIfChanged("gpg.format", GPGFormat?.Value, Models.GPGFormat.OPENPGP.Value);
             SetIfChanged("user.signingkey", GPGUserSigningKey);
             SetIfChanged("http.proxy", HttpProxy);
             return null;
         }
 
-        private void SetIfChanged(string key, string value, string defaultValue = null)
+        private void SetIfChanged(string key, string value)
         {
             bool changed = false;
             if (_cached.TryGetValue(key, out var old))
             {
                 changed = old != value;
             }
-            else if (!string.IsNullOrEmpty(value) && value != defaultValue)
+            else if (!string.IsNullOrEmpty(value))
             {
                 changed = true;
             }
diff --git a/src/Views/Preference.axaml b/src/Views/Preference.axaml
index 46279470..ab11cca3 100644
--- a/src/Views/Preference.axaml
+++ b/src/Views/Preference.axaml
@@ -409,7 +409,7 @@
             <ac:EnumToBoolConverter x:Key="EnumToBoolConverter"/>
           </TabItem.Resources>
 
-          <Grid Margin="8" RowDefinitions="32,32,32,32,32" ColumnDefinitions="Auto,*">
+          <Grid Margin="8" RowDefinitions="32,Auto,32,32,32" ColumnDefinitions="Auto,*">
             <TextBlock Grid.Row="0" Grid.Column="0"
                        Text="{DynamicResource Text.Preference.GPG.Format}"
                        HorizontalAlignment="Right"
@@ -419,7 +419,7 @@
                       Padding="8,0"
                       HorizontalAlignment="Stretch"
                       ItemsSource="{Binding Source={x:Static m:GPGFormat.Supported}}"
-                      SelectedItem="{Binding #me.GPGFormat, Mode=TwoWay, FallbackValue={x:Static m:GPGFormat.OPENPGP}}">
+                      SelectedItem="{Binding #me.GPGFormat, Mode=TwoWay}">
               <ComboBox.ItemTemplate>
                 <DataTemplate x:DataType="{x:Type m:GPGFormat}">
                   <Grid ColumnDefinitions="Auto,*">
@@ -433,12 +433,14 @@
             <TextBlock Grid.Row="1" Grid.Column="0"
                        Text="{DynamicResource Text.Preference.GPG.Path}"
                        HorizontalAlignment="Right"
-                       Margin="0,0,16,0"/>
+                       Margin="0,0,16,0"
+                       IsVisible="{Binding #me.GPGFormat.NeedFindProgram}"/>
             <TextBox Grid.Row="1" Grid.Column="1"
                      Height="28"
                      CornerRadius="3"
                      Text="{Binding #me.GPGExecutableFile, Mode=TwoWay}"
-                     IsEnabled="{Binding #me.GPGFormat, Mode=TwoWay, Converter={StaticResource EnumToBoolConverter}, ConverterParameter={x:Static m:GPGFormat.OPENPGP}}">
+                     Watermark="{DynamicResource Text.Preference.GPG.Path.Placeholder}"
+                     IsVisible="{Binding #me.GPGFormat.NeedFindProgram}">
               <TextBox.InnerRightContent>
                 <Button Classes="icon_button" Width="30" Height="30" Click="SelectGPGExecutable">
                   <Path Data="{StaticResource Icons.Folder.Open}" Fill="{DynamicResource Brush.FG1}"/>
diff --git a/src/Views/Preference.axaml.cs b/src/Views/Preference.axaml.cs
index 9f4a11f9..ce1f2809 100644
--- a/src/Views/Preference.axaml.cs
+++ b/src/Views/Preference.axaml.cs
@@ -2,6 +2,7 @@ using System;
 using System.Collections.Generic;
 using System.Globalization;
 using System.Threading.Tasks;
+
 using Avalonia;
 using Avalonia.Collections;
 using Avalonia.Controls;
@@ -67,7 +68,7 @@ namespace SourceGit.Views
         }
 
         public static readonly StyledProperty<Models.GPGFormat> GPGFormatProperty =
-            AvaloniaProperty.Register<Preference, Models.GPGFormat>(nameof(GPGFormat));
+            AvaloniaProperty.Register<Preference, Models.GPGFormat>(nameof(GPGFormat), Models.GPGFormat.Supported[0]);
 
         public Models.GPGFormat GPGFormat
         {
@@ -160,10 +161,11 @@ namespace SourceGit.Views
                 if (config.TryGetValue("tag.gpgSign", out var gpgTagSign))
                     EnableGPGTagSigning = (gpgTagSign == "true");
                 if (config.TryGetValue("gpg.format", out var gpgFormat))
-                    GPGFormat = Models.GPGFormat.Supported.Find(x => x.Value == gpgFormat);
-                else
-                    GPGFormat = Models.GPGFormat.OPENPGP;
-                if (config.TryGetValue("gpg.program", out var gpgProgram))
+                    GPGFormat = Models.GPGFormat.Supported.Find(x => x.Value == gpgFormat) ?? Models.GPGFormat.Supported[0];
+
+                if (GPGFormat.Value == "opengpg" && config.TryGetValue("gpg.program", out var opengpg))
+                    GPGExecutableFile = opengpg;
+                else if (config.TryGetValue($"gpg.{GPGFormat.Value}.program", out var gpgProgram))
                     GPGExecutableFile = gpgProgram;
 
                 ver = new Commands.Version().Query();
@@ -187,7 +189,7 @@ namespace SourceGit.Views
             var oldEmail = config.TryGetValue("user.email", out var email) ? email : string.Empty;
             var oldGPGSignKey = config.TryGetValue("user.signingkey", out var signingKey) ? signingKey : string.Empty;
             var oldCRLF = config.TryGetValue("core.autocrlf", out var crlf) ? crlf : string.Empty;
-            var oldGPGFormat = config.TryGetValue("gpg.format", out var gpgFormat) ? gpgFormat : Models.GPGFormat.OPENPGP.Value;
+            var oldGPGFormat = config.TryGetValue("gpg.format", out var gpgFormat) ? gpgFormat : "opengpg";
             var oldGPGCommitSignEnable = config.TryGetValue("commit.gpgsign", out var gpgCommitSign) ? gpgCommitSign : "false";
             var oldGPGTagSignEnable = config.TryGetValue("tag.gpgSign", out var gpgTagSign) ? gpgTagSign : "false";
             var oldGPGExec = config.TryGetValue("gpg.program", out var program) ? program : string.Empty;
@@ -204,10 +206,10 @@ namespace SourceGit.Views
                 cmd.Set("commit.gpgsign", EnableGPGCommitSigning ? "true" : "false");
             if (EnableGPGTagSigning != (oldGPGTagSignEnable == "true"))
                 cmd.Set("tag.gpgSign", EnableGPGTagSigning ? "true" : "false");
-            if (GPGFormat != null && GPGFormat.Value != oldGPGFormat)
+            if (GPGFormat.Value != oldGPGFormat)
                 cmd.Set("gpg.format", GPGFormat.Value);
             if (GPGExecutableFile != oldGPGExec)
-                cmd.Set("gpg.program", GPGExecutableFile);
+                cmd.Set($"gpg.{GPGFormat.Value}.program", GPGExecutableFile);
 
             Close();
         }
@@ -245,15 +247,13 @@ namespace SourceGit.Views
         {
             var patterns = new List<string>();
             if (OperatingSystem.IsWindows())
-                patterns.Add("gpg.exe");
-            else if (OperatingSystem.IsLinux())
-                patterns.AddRange(new string[] { "gpg", "gpg2" });
+                patterns.Add($"{GPGFormat.Program}.exe");
             else
-                patterns.Add("gpg");
+                patterns.Add(GPGFormat.Program);
 
             var options = new FilePickerOpenOptions()
             {
-                FileTypeFilter = [new FilePickerFileType("GPG Executable") { Patterns = patterns }],
+                FileTypeFilter = [new FilePickerFileType("GPG Program") { Patterns = patterns }],
                 AllowMultiple = false,
             };
 
diff --git a/src/Views/RepositoryConfigure.axaml b/src/Views/RepositoryConfigure.axaml
index 871a632a..2d466a08 100644
--- a/src/Views/RepositoryConfigure.axaml
+++ b/src/Views/RepositoryConfigure.axaml
@@ -14,7 +14,7 @@
                Classes="bold"
                Text="{DynamicResource Text.Configure}"/>
 
-    <Grid Margin="0,16,0,0" RowDefinitions="32,32,32,32,32,32,32" ColumnDefinitions="150,*">
+    <Grid Margin="0,16,0,0" RowDefinitions="32,32,32,32,32,32" ColumnDefinitions="150,*">
       <TextBlock Grid.Column="0"
                  HorizontalAlignment="Right" VerticalAlignment="Center"
                  Margin="0,0,8,0"
@@ -47,40 +47,20 @@
                Text="{Binding HttpProxy, Mode=TwoWay}"/>
 
       <TextBlock Grid.Row="3" Grid.Column="0"
-                 Text="{DynamicResource Text.Preference.GPG.Format}"
-                 HorizontalAlignment="Right"
-                 Margin="0,0,16,0"/>
-      <ComboBox Grid.Row="3" Grid.Column="1"
-                MinHeight="28"
-                Padding="8,0"
-                HorizontalAlignment="Stretch"
-                ItemsSource="{Binding Source={x:Static m:GPGFormat.Supported}}"
-                SelectedItem="{Binding GPGFormat, Mode=TwoWay, FallbackValue={x:Static m:GPGFormat.OPENPGP}}">
-        <ComboBox.ItemTemplate>
-          <DataTemplate x:DataType="{x:Type m:GPGFormat}">
-            <Grid ColumnDefinitions="Auto,*">
-              <TextBlock Grid.Column="0" Text="{Binding Name}"/>
-              <TextBlock Grid.Column="1" Text="{Binding Desc}" Foreground="{DynamicResource Brush.FG2}" HorizontalAlignment="Right"/>
-            </Grid>
-          </DataTemplate>
-        </ComboBox.ItemTemplate>
-      </ComboBox>
-
-      <TextBlock Grid.Row="4" Grid.Column="0"
                  HorizontalAlignment="Right" VerticalAlignment="Center"
                  Margin="0,0,8,0"
                  Text="{DynamicResource Text.Preference.GPG.UserKey}"/>
-      <TextBox Grid.Row="4" Grid.Column="1"
+      <TextBox Grid.Row="3" Grid.Column="1"
                Height="28"
                CornerRadius="3"
                Watermark="{DynamicResource Text.Preference.GPG.UserKey.Placeholder}"
                Text="{Binding GPGUserSigningKey, Mode=TwoWay}"/>
 
-      <CheckBox Grid.Row="5" Grid.Column="1"
+      <CheckBox Grid.Row="4" Grid.Column="1"
                 Content="{DynamicResource Text.Preference.GPG.CommitEnabled}"
                 IsChecked="{Binding GPGCommitSigningEnabled, Mode=TwoWay}"/>
 
-      <CheckBox Grid.Row="6" Grid.Column="1"
+      <CheckBox Grid.Row="5" Grid.Column="1"
                 Content="{DynamicResource Text.Preference.GPG.TagEnabled}"
                 IsChecked="{Binding GPGTagSigningEnabled, Mode=TwoWay}"/>
     </Grid>