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

Add output directory option to `archive extract`

Author: francis-page

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()
     {

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);
     }
-}
+}

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.