fix: avatar names with non-path-safe characters break builds

Fixes: #18

CHANGELOG.md

@@ -13,6 +13,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 
+* Fixed build failures when avatar names contained non-path-safe characters (#18)
+
 ### Changed
 
 ### Removed

Editor/API/BuildContext.cs

@@ -6,6 +6,7 @@
 using System.Diagnostics;
 using System.IO;
 using System.Linq;
+using System.Text.RegularExpressions;
 using nadena.dev.ndmf.reporting;
 using nadena.dev.ndmf.runtime;
 using nadena.dev.ndmf.util;
@@ -93,6 +94,9 @@ public BuildContext(GameObject obj, string assetRootPath)
             {
                 // Ensure the target directory exists
                 Directory.CreateDirectory(assetRootPath);
+
+                var pathAvatarName = FilterAvatarName(avatarName);
+
                 var avatarPath = Path.Combine(assetRootPath, avatarName) + ".asset";
                 AssetDatabase.GenerateUniqueAssetPath(avatarPath);
                 AssetDatabase.CreateAsset(AssetContainer, avatarPath);
@@ -114,6 +118,33 @@ public BuildContext(GameObject obj, string assetRootPath)
             sw.Stop();
         }
 
+        private static readonly Regex WindowsReservedFileNames = new Regex(
+            "(CON|PRN|AUX|NUL|COM[0-9]|LPT[0-9])([.].*)?",
+            RegexOptions.IgnoreCase
+        );
+
+        private static readonly Regex WindowsReservedFileCharacters = new Regex(
+            "[<>:\"/\\\\|?*\x00-\x1f]",
+            RegexOptions.IgnoreCase
+        );
+
+        internal static string FilterAvatarName(string avatarName)
+        {
+            avatarName = WindowsReservedFileCharacters.Replace(avatarName, "_");
+
+            if (WindowsReservedFileNames.IsMatch(avatarName))
+            {
+                avatarName = "_" + avatarName;
+            }
+
+            if (string.IsNullOrEmpty(avatarName))
+            {
+                avatarName = Guid.NewGuid().ToString();
+            }
+
+            return avatarName;
+        }
+
         public bool IsTemporaryAsset(UnityObject obj)
         {
             return !EditorUtility.IsPersistent(obj)

UnitTests~/AvatarNameFilterTests.cs

@@ -0,0 +1,42 @@
+using nadena.dev.ndmf;
+using NUnit.Framework;
+
+namespace UnitTests
+{
+    public class AvatarNameFilterTests
+    {
+        [Test]
+        public void TestAvatarNameFilter()
+        {
+            Assert.AreEqual(
+                "foo",
+                BuildContext.FilterAvatarName("foo")
+            );
+
+            Assert.AreEqual(
+                "_con",
+                BuildContext.FilterAvatarName("con")
+            );
+
+            Assert.AreEqual(
+                "_LPT4",
+                BuildContext.FilterAvatarName("LPT4")
+            );
+
+            Assert.AreEqual(
+                "_AUX.avatar",
+                BuildContext.FilterAvatarName("AUX.avatar")
+            );
+
+            Assert.AreEqual(
+                "foo_bar",
+                BuildContext.FilterAvatarName("foo/bar")
+            );
+
+            Assert.AreEqual(
+                "foo_bar_baz_quux",
+                BuildContext.FilterAvatarName("foo\\bar?baz*quux")
+            );
+        }
+    }
+}