feat: 保存画像ファイル名フォーマット指定 (#1477)

- ExportImageCommand の FileNameMode パラメーター廃止
- 代わりに FileNameFormat0,1,2 で指定する

Author: neelabo

NeeView/Archiver/LoosePath.cs

@@ -2,6 +2,7 @@
 using System;
 using System.Collections.Generic;
 using System.Diagnostics.CodeAnalysis;
+using System.Globalization;
 using System.Linq;
 using System.Text.RegularExpressions;
 
@@ -111,6 +112,20 @@ public static string GetFileNameWithoutExtension(string? s)
             }
         }
 
+        public static string WithoutExtension(string? s)
+        {
+            if (string.IsNullOrEmpty(s)) return "";
+            var ext = GetExtension(s);
+            if (string.IsNullOrEmpty(ext))
+            {
+                return s;
+            }
+            else
+            {
+                return s[..^ext.Length];
+            }
+        }
+
 
         //
         public static string GetPathRoot(string? s)
@@ -235,7 +250,7 @@ public static string ValidFileName(string? s)
         {
             if (string.IsNullOrEmpty(s)) return "";
 
-            string valid = s;
+            string valid = s.Trim();
             char[] invalids = System.IO.Path.GetInvalidFileNameChars();
 
             foreach (char c in invalids)
@@ -385,7 +400,7 @@ public static bool TryReplaceStartsWith(string path, string src, string dst, [No
             }
         }
 
-        public static string CreateUniquePath(string name, bool withExtension, Func<string, bool> existsFunc)
+        public static string CreateUniquePath(string name, bool withExtension, Func<string, bool> existsFunc, UniqueNamePolicy policy = UniqueNamePolicy.NumberSuffix)
         {
             if (!existsFunc(name))
             {
@@ -401,15 +416,26 @@ public static string CreateUniquePath(string name, bool withExtension, Func<stri
                 baseName = name[..^ext.Length].TrimEnd();
             }
 
+            var format = policy == UniqueNamePolicy.UnderscoreNumberSuffix ? "{0}_{1}{2}" : "{0} ({1}){2}";
+
             for (int i = 2; ; i++)
             {
-                // TODO: 競合回避の番号の付け方を指定可能にする。 e.g.: "name (2).ext", "name_2.ext" など
-                var newName = $"{baseName} ({i}){ext}";
+                var newName = string.Format(CultureInfo.InvariantCulture, format, baseName, i, ext);
                 if (!existsFunc(newName))
                 {
                     return newName;
                 }
             }
         }
     }
+
+    public enum UniqueNamePolicy
+    {
+        // name (2).ext
+        NumberSuffix,
+        
+        // name_2.ext
+        UnderscoreNumberSuffix,
+    }
+
 }

NeeView/Bitmap/BitmapImageFormat.cs

@@ -12,4 +12,16 @@ public enum BitmapImageFormat
         Png,
     }
 
+    public static class BitmapImageFormatExtensions
+    {
+        public static string GetExtension(this BitmapImageFormat format)
+        {
+            return format switch
+            {
+                BitmapImageFormat.Jpeg => ".jpg",
+                BitmapImageFormat.Png => ".png",
+                _ => throw new System.ArgumentOutOfRangeException(nameof(format), format, null)
+            };
+        }
+    }
 }

NeeView/Book/PagePart.cs

@@ -29,6 +29,16 @@ public static PagePart Reverse(this PagePart pagePart)
                 _ => pagePart,
             };
         }
+
+        public static string ToSuffix(this PagePart pagePart)
+        {
+            return pagePart switch
+            {
+                PagePart.Left => "L",
+                PagePart.Right => "R",
+                _ => "",
+            };
+        }
     }
 
 

NeeView/Command/CommandParameters/ExportImageAsCommandParameter.cs

@@ -12,7 +12,7 @@ namespace NeeView
     [Equatable(Explicit = true)]
     public partial class ExportImageAsCommandParameter : CommandParameter
     {
-        [Obsolete("no used"), Alternative(null, 46, ErrorLevel = ScriptErrorLevel.Warning)]
+        [Obsolete("no used"), Alternative(null, 46, ScriptErrorLevel.Warning)]
         [JsonIgnore(Condition = JsonIgnoreCondition.WhenWriting)]
         [PropertyPath(FileDialogType = FileDialogType.Directory)]
         [DefaultEquality]
@@ -22,7 +22,7 @@ public string ExportFolder
             set => ExportFolderLegacy = value;
         }
 
-        [Obsolete("no used"), Alternative(null, 46, ErrorLevel = ScriptErrorLevel.Warning)]
+        [Obsolete("no used"), Alternative(null, 46, ScriptErrorLevel.Warning)]
         [JsonIgnore(Condition = JsonIgnoreCondition.WhenWriting)]
         [PropertyRange(5, 100, TickFrequency = 5)]
         [DefaultEquality]

NeeView/Command/CommandParameters/ExportImageCommandParameter.cs

@@ -1,6 +1,8 @@
 using Generator.Equals;
 using NeeView.Windows.Controls;
 using NeeView.Windows.Property;
+using System;
+using System.Text.Json.Serialization;
 
 namespace NeeView
 {
@@ -12,7 +14,9 @@ public partial class ExportImageCommandParameter : CommandParameter, IExportImag
         [DefaultEquality] private bool _isOriginalSize = true;
         [DefaultEquality] private bool _isDotKeep;
         [DefaultEquality] private string? _exportFolder;
-        [DefaultEquality] private ExportImageFileNameMode _fileNameMode;
+        [DefaultEquality] private string _fileNameFormat0 = ExportImageParameter.DefaultFileNameFormat0;
+        [DefaultEquality] private string _fileNameFormat1 = ExportImageParameter.DefaultFileNameFormat1;
+        [DefaultEquality] private string _fileNameFormat2 = ExportImageParameter.DefaultFileNameFormat2;
         [DefaultEquality] private BitmapImageFormat _fileFormat;
         [DefaultEquality] private int _qualityLevel = 80;
         [DefaultEquality] private bool _isShowToast = true;
@@ -54,11 +58,25 @@ public string ExportFolder
             set => SetProperty(ref _exportFolder, value);
         }
 
-        [PropertyMember(Name = "ExportImageParameter.FileNameMode")]
-        public ExportImageFileNameMode FileNameMode
+        [PropertyMember]
+        public string FileNameFormat0
+        {
+            get { return _fileNameFormat0; }
+            set { SetProperty(ref _fileNameFormat0, value); }
+        }
+
+        [PropertyMember]
+        public string FileNameFormat1
         {
-            get => _fileNameMode;
-            set => SetProperty(ref _fileNameMode, value);
+            get { return _fileNameFormat1; }
+            set { SetProperty(ref _fileNameFormat1, value); }
+        }
+
+        [PropertyMember]
+        public string FileNameFormat2
+        {
+            get { return _fileNameFormat2; }
+            set { SetProperty(ref _fileNameFormat2, value); }
         }
 
         [PropertyMember(Name = "ExportImageParameter.FileFormat")]
@@ -88,15 +106,43 @@ public ExportImageOverwriteMode OverwriteMode
             get { return _overwriteMode; }
             set { SetProperty(ref _overwriteMode, value); }
         }
+
+
+        #region Obsolete
+
+        [Obsolete, Alternative("FileNameFormat0,1,2", 46, ScriptErrorLevel.Warning)] // ver.46
+        [JsonIgnore(Condition = JsonIgnoreCondition.WhenWriting)]
+        [PropertyMember(Name = "ExportImageParameter.FileNameMode")]
+        public ExportImageFileNameMode FileNameMode
+        {
+            get => default;
+            set
+            {
+                if (value == ExportImageFileNameMode.BookPageNumber)
+                { 
+                    FileNameFormat0 = "{Book}_{Page:000}";
+                    FileNameFormat1 = "{Book}_{Page:000}";
+                    FileNameFormat2 = "{Book}_{Page1:000}-{Page2:000}";
+                }
+                else
+                {
+                    FileNameFormat0 = ExportImageParameter.DefaultFileNameFormat0;
+                    FileNameFormat1 = ExportImageParameter.DefaultFileNameFormat1;
+                    FileNameFormat2 = ExportImageParameter.DefaultFileNameFormat1;
+                }
+            }
+        }
+
+        #endregion
     }
 
 
     public enum ExportImageOverwriteMode
     {
         Confirm,
-
+        
         AddNumber,
 
-        Invalid,
+        Disallow,
     }
 }

NeeView/Config/Config.cs

@@ -143,7 +143,7 @@ public string? Pagemark
             set { }
         }
 
-        [Obsolete("no used"), Alternative(null, 46, ErrorLevel = ScriptErrorLevel.Error)] // ver.46
+        [Obsolete("no used"), Alternative(null, 46, ScriptErrorLevel.Error)] // ver.46
         [JsonIgnore]
         public string? Control
         {

NeeView/Controls/XHtmlTextBlock.cs

@@ -135,7 +135,8 @@ private static void Hyperlink_RequestNavigate(object sender, System.Windows.Navi
             }
             else
             {
-                ExternalProcess.Start(e.Uri.LocalPath);
+                var path = e.Uri.Scheme == "file" ? e.Uri.LocalPath : e.Uri.AbsoluteUri;
+                ExternalProcess.Start(path);
             }
             e.Handled = true;
         }

NeeView/ExportImage/ExportBook.cs

@@ -169,7 +169,7 @@ private async Task<bool> ExportViewPageAsync(IExportImageWriter writer, ExportIm
             using var service = new ExportImageService(source, parameter);
             service.ThrowIfCannotExport();
 
-            var pageSource = new ExportPageSource(service.Source.BookAddress, service.Source.Pages);
+            var pageSource = new ExportPageSource(service.Source.BookAddress, service.Source.Direction, service.Source.Elements);
             using (var stream = await writer.OpenEntryAsync(pageSource, service, parameter, overwritePolicy, token))
             {
                 var page = pages.First();

NeeView/ExportImage/ExportBookDialog.xaml.cs

@@ -24,25 +24,35 @@ public ExportBookDialog(ExportBookParameter parameter, string bookName) : this()
         {
             _vm = new ExportBookDialogViewModel(parameter, bookName);
             this.DataContext = _vm;
-
-            this.Loaded += ExportBookDialog_Loaded;
-            this.KeyDown += ExportBookDialog_KeyDown;
         }
 
         public string FileName => _vm?.FileName ?? "";
 
-        private void ExportBookDialog_Loaded(object sender, RoutedEventArgs e)
+
+        protected override void OnClosed(EventArgs e)
+        {
+            _vm?.Dispose();
+
+            base.OnClosed(e);
+        }
+
+        protected override void OnContentRendered(EventArgs e)
         {
+            base.OnContentRendered(e);
+
             this.SaveButton.Focus();
         }
 
-        private void ExportBookDialog_KeyDown(object sender, KeyEventArgs e)
+        protected override void OnKeyDown(KeyEventArgs e)
         {
             if (e.Key == Key.Escape && Keyboard.Modifiers == ModifierKeys.None)
             {
                 this.Close();
                 e.Handled = true;
+                return;
             }
+
+            base.OnKeyDown(e);
         }
 
         private async void SaveButton_Click(object sender, RoutedEventArgs e)