Merge pull request Unity-Technologies#9 from davschne-unity/david.schneider/extract-outdir

francis-page · web-flow · commit 0898a8078e3e · 2023-09-25T13:14:37.000-04:00
Add output directory option to `archive extract`
diff --git a/UnityDataTool.Tests/UnityDataToolTests.cs b/UnityDataTool.Tests/UnityDataToolTests.cs
@@ -18,7 +18,7 @@ public class UnityDataToolTests : AssetBundleTestFixture
     public UnityDataToolTests(Context context) : base(context)
     {
     }
-    
+
     protected override void OnLoadExpectedData(Context context)
     {
         // Uncomment to regenerate expected data.
@@ -41,16 +41,17 @@ public void Teardown()
             file.Delete();
         }
     }
-        
+
     [Test]
-    public void ArchiveExtract_FilesExtractedSuccessfully()
+    public void ArchiveExtract_FilesExtractedSuccessfully(
+        [Values("", "-o archive", "--output-path archive")] string options)
     {
         var path = Path.Combine(Context.UnityDataFolder, "assetbundle");
 
-        Assert.AreEqual(0, Program.Main(new string[] { "archive", "extract", path }));
-        Assert.IsTrue(File.Exists(Path.Combine(m_TestOutputFolder, "CAB-5d40f7cad7c871cf2ad2af19ac542994")));
-        Assert.IsTrue(File.Exists(Path.Combine(m_TestOutputFolder, "CAB-5d40f7cad7c871cf2ad2af19ac542994.resS")));
-        Assert.IsTrue(File.Exists(Path.Combine(m_TestOutputFolder, "CAB-5d40f7cad7c871cf2ad2af19ac542994.resource")));
+        Assert.AreEqual(0, Program.Main(new string[] { "archive", "extract", path }.Concat(options.Split(" ", StringSplitOptions.RemoveEmptyEntries)).ToArray()));
+        Assert.IsTrue(File.Exists(Path.Combine(m_TestOutputFolder, "archive", "CAB-5d40f7cad7c871cf2ad2af19ac542994")));
+        Assert.IsTrue(File.Exists(Path.Combine(m_TestOutputFolder, "archive", "CAB-5d40f7cad7c871cf2ad2af19ac542994.resS")));
+        Assert.IsTrue(File.Exists(Path.Combine(m_TestOutputFolder, "archive", "CAB-5d40f7cad7c871cf2ad2af19ac542994.resource")));
     }
 
     [Test]
@@ -197,7 +198,7 @@ private void ValidateDatabase(string databasePath, bool withRefs)
         using (var cmd = db.CreateCommand())
         {
             cmd.CommandText =
-                @"SELECT 
+                @"SELECT
                     (SELECT COUNT(*) FROM animation_clips),
                     (SELECT COUNT(*) FROM asset_bundles),
                     (SELECT COUNT(*) FROM assets),
@@ -259,21 +260,21 @@ public void Teardown()
             file.Delete();
         }
     }
-    
+
     [Test]
     public void Analyze_PlayerData_DatabaseCorrect()
     {
         var databasePath = Path.Combine(m_TestOutputFolder, "database.db");
         var analyzePath = Path.Combine(Context.UnityDataFolder);
 
         Assert.AreEqual(0, Program.Main(new string[] { "analyze", analyzePath, "-r" }));
-        
+
         using var db = new SQLiteConnection($"Data Source={databasePath};Version=3;New=True;Foreign Keys=False;");
         db.Open();
         using var cmd = db.CreateCommand();
 
         cmd.CommandText =
-            @"SELECT 
+            @"SELECT
                 (SELECT COUNT(*) FROM asset_bundles),
                 (SELECT COUNT(*) FROM assets),
                 (SELECT COUNT(*) FROM objects),
@@ -290,7 +291,7 @@ public void Analyze_PlayerData_DatabaseCorrect()
         Assert.Greater(reader.GetInt32(3), 0);
         Assert.AreEqual(1, reader.GetInt32(4));
     }
-    
+
     [Test]
     public void DumpText_PlayerData_TextFileCreatedCorrectly()
     {
diff --git a/UnityDataTool/Program.cs b/UnityDataTool/Program.cs
@@ -14,7 +14,7 @@ public static class Program
     public static int Main(string[] args)
     {
         UnityFileSystem.Init();
-            
+
         var rootCommand = new RootCommand();
 
         {
@@ -86,15 +86,17 @@ public static int Main(string[] args)
 
         {
             var pathArg = new Argument<FileInfo>("filename", "The path of the archive file").ExistingOnly();
+            var oOpt = new Option<DirectoryInfo>(aliases: new[] { "--output-path", "-o" }, description: "Output directory of the extracted archive", getDefaultValue: () => new DirectoryInfo("archive"));
 
             var extractArchiveCommand = new Command("extract", "Extract the archive.")
             {
                 pathArg,
+                oOpt,
             };
 
             extractArchiveCommand.SetHandler(
-                (FileInfo fi) => HandleExtractArchive(fi),
-                pathArg);
+                (FileInfo fi, DirectoryInfo o) => HandleExtractArchive(fi, o),
+                pathArg, oOpt);
 
             var listArchiveCommand = new Command("list", "List the content of an archive.")
             {
@@ -115,7 +117,7 @@ public static int Main(string[] args)
         }
 
         var r = rootCommand.Invoke(args);
-            
+
         UnityFileSystem.Cleanup();
 
         return r;
@@ -129,7 +131,7 @@ enum DumpFormat
     static int HandleAnalyze(DirectoryInfo path, string outputFile, bool extractReferences, string searchPattern)
     {
         var analyzer = new AnalyzerTool();
-        
+
         return analyzer.Analyze(path.FullName, outputFile, searchPattern, extractReferences);
     }
 
@@ -167,15 +169,15 @@ static int HandleDump(FileInfo filename, DumpFormat format, bool skipLargeArrays
         return 1;
     }
 
-    static int HandleExtractArchive(FileInfo filename)
+    static int HandleExtractArchive(FileInfo filename, DirectoryInfo outputFolder)
     {
         try
         {
             using var archive = UnityFileSystem.MountArchive(filename.FullName, "/");
             foreach (var node in archive.Nodes)
             {
                 Console.WriteLine($"Extracting {node.Path}...");
-                CopyFile("/" + node.Path, Path.GetFileName(node.Path));
+                CopyFile("/" + node.Path, Path.Combine(outputFolder.FullName, node.Path));
             }
         }
         catch (NotSupportedException)
@@ -212,6 +214,8 @@ static int HandleListArchive(FileInfo filename)
     static void CopyFile(string source, string dest)
     {
         using var sourceFile = UnityFileSystem.OpenFile(source);
+        // Create the containing directory if it doesn't exist.
+        Directory.CreateDirectory(Path.GetDirectoryName(dest));
         using var destFile = new FileStream(dest, FileMode.Create);
 
         const int blockSize = 256 * 1024;
@@ -225,4 +229,4 @@ static void CopyFile(string source, string dest)
         }
         while (actualSize == blockSize);
     }
-}
+}
diff --git a/UnityDataTool/README.md b/UnityDataTool/README.md
@@ -88,6 +88,7 @@ information about the content of the output file.**
 The archive command offers a set of archive-related sub-commands.
 
 **extract** This sub-command extracts the content of an archive. It takes the archive path as
-argument.
+argument and also provides the following option:
+* -o, --output-path \<path\>: Output directory of the extracted archive (default: archive)
 
 **list** This sub-command lists the content of an archive. It takes the archive path as argument.

Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ public class UnityDataToolTests : AssetBundleTestFixture`
`18`	`18`	`public UnityDataToolTests(Context context) : base(context)`
`19`	`19`	`{`
`20`	`20`	`}`
`21`		`-`
	`21`	`+`
`22`	`22`	`protected override void OnLoadExpectedData(Context context)`
`23`	`23`	`{`
`24`	`24`	`// Uncomment to regenerate expected data.`
`@@ -41,16 +41,17 @@ public void Teardown()`
`41`	`41`	`file.Delete();`
`42`	`42`	`}`
`43`	`43`	`}`
`44`		`-`
	`44`	`+`
`45`	`45`	`[Test]`
`46`		`- public void ArchiveExtract_FilesExtractedSuccessfully()`
	`46`	`+ public void ArchiveExtract_FilesExtractedSuccessfully(`
	`47`	`+ [Values("", "-o archive", "--output-path archive")] string options)`
`47`	`48`	`{`
`48`	`49`	`var path = Path.Combine(Context.UnityDataFolder, "assetbundle");`
`49`	`50`
`50`		`- Assert.AreEqual(0, Program.Main(new string[] { "archive", "extract", path }));`
`51`		`- Assert.IsTrue(File.Exists(Path.Combine(m_TestOutputFolder, "CAB-5d40f7cad7c871cf2ad2af19ac542994")));`
`52`		`- Assert.IsTrue(File.Exists(Path.Combine(m_TestOutputFolder, "CAB-5d40f7cad7c871cf2ad2af19ac542994.resS")));`
`53`		`- Assert.IsTrue(File.Exists(Path.Combine(m_TestOutputFolder, "CAB-5d40f7cad7c871cf2ad2af19ac542994.resource")));`
	`51`	`+ Assert.AreEqual(0, Program.Main(new string[] { "archive", "extract", path }.Concat(options.Split(" ", StringSplitOptions.RemoveEmptyEntries)).ToArray()));`
	`52`	`+ Assert.IsTrue(File.Exists(Path.Combine(m_TestOutputFolder, "archive", "CAB-5d40f7cad7c871cf2ad2af19ac542994")));`
	`53`	`+ Assert.IsTrue(File.Exists(Path.Combine(m_TestOutputFolder, "archive", "CAB-5d40f7cad7c871cf2ad2af19ac542994.resS")));`
	`54`	`+ Assert.IsTrue(File.Exists(Path.Combine(m_TestOutputFolder, "archive", "CAB-5d40f7cad7c871cf2ad2af19ac542994.resource")));`
`54`	`55`	`}`
`55`	`56`
`56`	`57`	`[Test]`
`@@ -197,7 +198,7 @@ private void ValidateDatabase(string databasePath, bool withRefs)`
`197`	`198`	`using (var cmd = db.CreateCommand())`
`198`	`199`	`{`
`199`	`200`	`cmd.CommandText =`
`200`		`- @"SELECT`
	`201`	`+ @"SELECT`
`201`	`202`	`(SELECT COUNT(*) FROM animation_clips),`
`202`	`203`	`(SELECT COUNT(*) FROM asset_bundles),`
`203`	`204`	`(SELECT COUNT(*) FROM assets),`
`@@ -259,21 +260,21 @@ public void Teardown()`
`259`	`260`	`file.Delete();`
`260`	`261`	`}`
`261`	`262`	`}`
`262`		`-`
	`263`	`+`
`263`	`264`	`[Test]`
`264`	`265`	`public void Analyze_PlayerData_DatabaseCorrect()`
`265`	`266`	`{`
`266`	`267`	`var databasePath = Path.Combine(m_TestOutputFolder, "database.db");`
`267`	`268`	`var analyzePath = Path.Combine(Context.UnityDataFolder);`
`268`	`269`
`269`	`270`	`Assert.AreEqual(0, Program.Main(new string[] { "analyze", analyzePath, "-r" }));`
`270`		`-`
	`271`	`+`
`271`	`272`	`using var db = new SQLiteConnection($"Data Source={databasePath};Version=3;New=True;Foreign Keys=False;");`
`272`	`273`	`db.Open();`
`273`	`274`	`using var cmd = db.CreateCommand();`
`274`	`275`
`275`	`276`	`cmd.CommandText =`
`276`		`- @"SELECT`
	`277`	`+ @"SELECT`
`277`	`278`	`(SELECT COUNT(*) FROM asset_bundles),`
`278`	`279`	`(SELECT COUNT(*) FROM assets),`
`279`	`280`	`(SELECT COUNT(*) FROM objects),`
`@@ -290,7 +291,7 @@ public void Analyze_PlayerData_DatabaseCorrect()`
`290`	`291`	`Assert.Greater(reader.GetInt32(3), 0);`
`291`	`292`	`Assert.AreEqual(1, reader.GetInt32(4));`
`292`	`293`	`}`
`293`		`-`
	`294`	`+`
`294`	`295`	`[Test]`
`295`	`296`	`public void DumpText_PlayerData_TextFileCreatedCorrectly()`
`296`	`297`	`{`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ public static class Program`
`14`	`14`	`public static int Main(string[] args)`
`15`	`15`	`{`
`16`	`16`	`UnityFileSystem.Init();`
`17`		`-`
	`17`	`+`
`18`	`18`	`var rootCommand = new RootCommand();`
`19`	`19`
`20`	`20`	`{`
`@@ -86,15 +86,17 @@ public static int Main(string[] args)`
`86`	`86`
`87`	`87`	`{`
`88`	`88`	`var pathArg = new Argument<FileInfo>("filename", "The path of the archive file").ExistingOnly();`
	`89`	`+ var oOpt = new Option<DirectoryInfo>(aliases: new[] { "--output-path", "-o" }, description: "Output directory of the extracted archive", getDefaultValue: () => new DirectoryInfo("archive"));`
`89`	`90`
`90`	`91`	`var extractArchiveCommand = new Command("extract", "Extract the archive.")`
`91`	`92`	`{`
`92`	`93`	`pathArg,`
	`94`	`+ oOpt,`
`93`	`95`	`};`
`94`	`96`
`95`	`97`	`extractArchiveCommand.SetHandler(`
`96`		`- (FileInfo fi) => HandleExtractArchive(fi),`
`97`		`- pathArg);`
	`98`	`+ (FileInfo fi, DirectoryInfo o) => HandleExtractArchive(fi, o),`
	`99`	`+ pathArg, oOpt);`
`98`	`100`
`99`	`101`	`var listArchiveCommand = new Command("list", "List the content of an archive.")`
`100`	`102`	`{`
`@@ -115,7 +117,7 @@ public static int Main(string[] args)`
`115`	`117`	`}`
`116`	`118`
`117`	`119`	`var r = rootCommand.Invoke(args);`
`118`		`-`
	`120`	`+`
`119`	`121`	`UnityFileSystem.Cleanup();`
`120`	`122`
`121`	`123`	`return r;`
`@@ -129,7 +131,7 @@ enum DumpFormat`
`129`	`131`	`static int HandleAnalyze(DirectoryInfo path, string outputFile, bool extractReferences, string searchPattern)`
`130`	`132`	`{`
`131`	`133`	`var analyzer = new AnalyzerTool();`
`132`		`-`
	`134`	`+`
`133`	`135`	`return analyzer.Analyze(path.FullName, outputFile, searchPattern, extractReferences);`
`134`	`136`	`}`
`135`	`137`
`@@ -167,15 +169,15 @@ static int HandleDump(FileInfo filename, DumpFormat format, bool skipLargeArrays`
`167`	`169`	`return 1;`
`168`	`170`	`}`
`169`	`171`
`170`		`- static int HandleExtractArchive(FileInfo filename)`
	`172`	`+ static int HandleExtractArchive(FileInfo filename, DirectoryInfo outputFolder)`
`171`	`173`	`{`
`172`	`174`	`try`
`173`	`175`	`{`
`174`	`176`	`using var archive = UnityFileSystem.MountArchive(filename.FullName, "/");`
`175`	`177`	`foreach (var node in archive.Nodes)`
`176`	`178`	`{`
`177`	`179`	`Console.WriteLine($"Extracting {node.Path}...");`
`178`		`- CopyFile("/" + node.Path, Path.GetFileName(node.Path));`
	`180`	`+ CopyFile("/" + node.Path, Path.Combine(outputFolder.FullName, node.Path));`
`179`	`181`	`}`
`180`	`182`	`}`
`181`	`183`	`catch (NotSupportedException)`
`@@ -212,6 +214,8 @@ static int HandleListArchive(FileInfo filename)`
`212`	`214`	`static void CopyFile(string source, string dest)`
`213`	`215`	`{`
`214`	`216`	`using var sourceFile = UnityFileSystem.OpenFile(source);`
	`217`	`+ // Create the containing directory if it doesn't exist.`
	`218`	`+ Directory.CreateDirectory(Path.GetDirectoryName(dest));`
`215`	`219`	`using var destFile = new FileStream(dest, FileMode.Create);`
`216`	`220`
`217`	`221`	`const int blockSize = 256 * 1024;`
`@@ -225,4 +229,4 @@ static void CopyFile(string source, string dest)`
`225`	`229`	`}`
`226`	`230`	`while (actualSize == blockSize);`
`227`	`231`	`}`
`228`		`-}`
	`232`	`+}`