Add some leniency to content validation

Based on some strange but apparently
still valid .unitypackage files.

Author: m35

README.md

@@ -41,14 +41,14 @@ I didn't read any specification (assuming there is one). There could certainly b
 # The `.unitypackage` file format
 
 A `.unitypackage` is just a compressed TAR archive.
-Inside it contains several root directories.
-Each directory name is a GUID.
+Inside it contains several root directories (in most cases).
+Each directory name is a GUID (in most cases).
 
 ![](.github/tar-directories.png?raw=true)
 
 
 Inside each of them is the contents of the asset with that GUID.
-Specifically, each GUID directory contains some of these 4 files.
+Specifically, each GUID directory contains some of these 4 files (among others).
 
 ![](.github/tar-directory-contents.png?raw=true)
 
@@ -70,15 +70,14 @@ As shown in this tool:
 
 # Existing open source tools I found
 
-### https://gist.github.com/yasirkula/dfc43134fbfefb820d0adbc5d7c25fb3
+https://gist.github.com/yasirkula/dfc43134fbfefb820d0adbc5d7c25fb3 A very nice Unity script to explore `.unitypackage`s
 
-A very nice Unity script to explore `.unitypackages`.
+https://github.com/Switch-9867/UnitypackgeExtractor C# command-line tool
 
-### https://github.com/Switch-9867/UnitypackgeExtractor
+https://github.com/ntrf/UnityUnpack Haxe command-line tool
 
-C# command-line tool.
+https://github.com/Cobertos/unitypackage_extractor Python command-line tool. Its associated pypi package at https://pypi.org/project/unitypackage-extractor/
 
-### https://github.com/Cobertos/unitypackage_extractor
-
-Python command-line tool. Its associated pypi package at https://pypi.org/project/unitypackage-extractor/
+https://github.com/FatihBAKIR/UnityPacker C# "Create unitypackages without unity, from command line"
 
+https://github.com/ngyewch/UnityPackager Java library and command line tools to manipulate .unitypackage files. 

pom.xml

@@ -3,7 +3,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>m35-projects</groupId>
     <artifactId>unity-package-viewer</artifactId>
-    <version>0.0.2</version>
+    <version>0.0.3</version>
     <packaging>jar</packaging>
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

src/main/java/unitypackage/model/UnityAsset.java

@@ -24,7 +24,7 @@
 import java.util.Date;
 
 /**
- * An asset as it would appear in the tree of stuff you see when you import a .unitypackage into unity.
+ * An asset as it would appear in the tree of stuff you see when you import a .unitypackage into Unity.
  * This could be a directory or a file.
  */
 public class UnityAsset {
@@ -51,6 +51,9 @@ public String getFileName() {
         return getFileNameAsPath().toString();
     }
 
+    /**
+     * Returns -1 if the asset is not a file.
+     */
     public long getSize() {
         return source.getAsset_fileSize();
     }
@@ -63,10 +66,17 @@ public String getDirectoryGuid() {
         return source.getGuidBaseDirectory();
     }
 
+    /**
+     * May be null.
+     */
     public BufferedImage getPreview() {
         return source.getPreview();
     }
 
+    /**
+     * In the .unitypackage, the originating directory does not contain a file named "asset",
+     * which probably means it represents a directory (in practice this seems to be the case).
+     */
     public boolean isProbablyDirectory() {
         return source.getRawPathTo_asset_file() == null;
     }

src/main/java/unitypackage/model/UnityAssetBuilder.java

@@ -20,7 +20,6 @@
 
 import java.awt.image.BufferedImage;
 import java.io.BufferedReader;
-import java.io.File;
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.InputStreamReader;
@@ -34,13 +33,14 @@
 
 /**
  * Collects information about the files inside one directory in the .unitypackage tar file.
+ * Each directory in the .unitypackage tar file represents one asset file or directory that appears in Unity.
  */
 class UnityAssetBuilder {
 
-    private static final boolean STRICT = false;
+    private static final boolean STRICT_DIRECTORY_GUID = false;
 
     /**
-     * The directory name, which is also the GUID of the asset.
+     * The directory name, which is also usually the GUID of the asset.
      */
     private final String guidBaseDirectory;
 
@@ -128,8 +128,8 @@ public void assertGuidMatchesDirectoryName(String directoryGuidName) {
         }
     }
 
-    public void addFileFoundInDirectory(String directoryGuidName, String fileName, TarArchiveEntry tarEntry,
-                                        TarArchiveInputStream tarInputStream) throws IOException {
+    final public void addFileFoundInDirectory(String directoryGuidName, String fileName, TarArchiveEntry tarEntry,
+                                              TarArchiveInputStream tarInputStream) throws IOException {
 
         assertGuidMatchesDirectoryName(directoryGuidName);
 
@@ -142,9 +142,9 @@ public void addFileFoundInDirectory(String directoryGuidName, String fileName, T
             case "asset.meta":
                 asset_meta_guid = findGuidIn_asset_meta_File(tarEntry, tarInputStream);
                 if (!asset_meta_guid.equals(guidBaseDirectory)) {
-                    // Usually the directory guid matches the guid in the asset.meta file, but not always
-                    String s = "Corrupted .unitypackage? directory guid" + " " + guidBaseDirectory + " != " + "asset.meta guid " + asset_meta_guid;
-                    if (STRICT) {
+                    // Usually the directory guid matches the guid in the asset.meta file, but not always it seems
+                    String s = "[WARN] Corrupted .unitypackage? directory guid " + guidBaseDirectory + " != asset.meta guid " + asset_meta_guid;
+                    if (STRICT_DIRECTORY_GUID) {
                         throw new RuntimeException(s);
                     } else {
                         System.out.println(s);
@@ -157,8 +157,11 @@ public void addFileFoundInDirectory(String directoryGuidName, String fileName, T
             case "preview.png":
                 _preview = ImageIO.read(tarInputStream);
                 break;
+            case "metaData":
+                System.out.println("[WARN] Found metaData file \"" + tarEntry.getName() + "\"");
+                break;
             default:
-                throw new RuntimeException("File name not recognized " + tarEntry.getName());
+                throw new RuntimeException("[ERROR] File name not recognized in tar file \"" + tarEntry.getName() + "\"");
         }
     }
 
@@ -189,7 +192,7 @@ private static String readFirstLine(TarArchiveEntry tarEntry, InputStream inputS
         if (lines.size() == 2 && "00".equals(lines.get(1))) {
             // Sometimes there's a second line with "00"?
         } else if (lines.size() != 1) {
-            throw new RuntimeException(tarEntry.getName() + ": File expected to have 1 line, but found " + lines.size() + " lines: " + lines);
+            System.out.println("[WARN] \"" + tarEntry.getName() + ": File expected to have 1 line, but found " + lines.size() + " lines: " + lines);
         }
 
         return lines.get(0);

src/main/java/unitypackage/model/UnityPackage.java

@@ -88,7 +88,7 @@ public UnityPackage(File unitypackageFile) throws IOException {
 
                 if (isDirectory) {
                     if (rawPathParent != null) {
-                        throw new RuntimeException("Found nested directory " + rawFilePathString);
+                        throw new RuntimeException("Found nested directory \"" + rawFilePathString + "\"");
                     }
                     guidDirectory = rawPath.toString();
                     fileName = null;
@@ -104,7 +104,7 @@ public UnityPackage(File unitypackageFile) throws IOException {
                         // For now ignore it
                         continue;
                     } else {
-                        throw new RuntimeException("Found nested directory " + rawFilePathString);
+                        throw new RuntimeException("Found nested directory \"" + rawFilePathString + "\"");
                     }
                 }
 

src/main/java/unitypackage/viewer/Main.java

@@ -31,12 +31,11 @@
 import unitypackage.model.UnityAsset;
 import unitypackage.model.UnityPackage;
 import unitypackage.viewer.gui.MainWindow;
-import unitypackage.viewer.gui.UnitypackageFileName;
 
 public class Main {
 
     private static final String VERSION_PROPERTY_FILE = "app.properties";
-    public static String DEVELOPMENT_VERSION = "(development)";
+    private static final String DEVELOPMENT_VERSION = "(development)";
     public static String VERSION = DEVELOPMENT_VERSION;
 
     private static final String EXTRACT_ALL_COMMAND = "--extract-all";
@@ -92,9 +91,6 @@ public static void main(String[] args) throws IOException {
 
     private static void extractAll(String fileToOpen) throws IOException {
         File file = new File(fileToOpen);
-        if (!UnitypackageFileName.isUnitypackage(file)) {
-            System.out.println("File \""+fileToOpen+"\" doesn't have a normal unitypackage file name.");
-        }
 
         UnityPackage unityPackage = new UnityPackage(file);
         try (UnityArchiveInputStream unityIS = unityPackage.getUnityArchiveInputStream()) {

src/main/java/unitypackage/viewer/gui/HistoryIni.java

@@ -18,17 +18,16 @@
 
 package unitypackage.viewer.gui;
 
-import java.io.BufferedReader;
 import java.io.File;
-import java.io.FileInputStream;
 import java.io.FileNotFoundException;
 import java.io.FileOutputStream;
-import java.io.InputStreamReader;
+import java.io.IOException;
 import java.io.PrintStream;
 import java.nio.charset.StandardCharsets;
-import java.util.ArrayList;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.util.Collections;
 import java.util.List;
-import java.util.stream.Collectors;
 
 /**
  * Just stores the last .unitypackage file that was opened.
@@ -42,7 +41,8 @@ public static void addLastFile(File file) {
         try (PrintStream p = new PrintStream(new FileOutputStream(INI_FILE))) {
             p.println(file.toString());
         } catch (FileNotFoundException ex) {
-            System.out.println("Unable to save " + INI_FILE);
+            System.out.println("[ERROR] Unable to save " + INI_FILE);
+            ex.printStackTrace(System.out);
         }
     }
 
@@ -59,14 +59,10 @@ public static File getLastDirectory() {
 
     private static List<String> getLastFiles() {
         try {
-            List<String> text = new BufferedReader(
-                    new InputStreamReader(new FileInputStream(INI_FILE), StandardCharsets.UTF_8))
-                    .lines()
-                    .collect(Collectors.toList());
-            return text;
-        } catch (FileNotFoundException ex) {
-            ex.printStackTrace();
-            return new ArrayList<>();
+            return Files.readAllLines(Paths.get(INI_FILE), StandardCharsets.UTF_8);
+        } catch (IOException ex) {
+            ex.printStackTrace(System.out);
+            return Collections.emptyList();
         }
     }
 

src/main/java/unitypackage/viewer/gui/MainWindow.java

@@ -76,13 +76,13 @@ public synchronized void drop(DropTargetDropEvent evt) {
                 List<File> droppedFiles = (List<File>)evt.getTransferable().getTransferData(DataFlavor.javaFileListFlavor);
                 if (droppedFiles.size() == 1) {
                     File f = droppedFiles.get(0);
-                    if (UnitypackageFileName.isUnitypackage(f)) {
+                    if (f.isFile()) {
                         openFile(f);
                     } else {
-                        System.out.println("Weird file name " + droppedFiles);
+                        System.out.println("File \""+f+"\" is not a file.");
                     }
                 } else {
-                    System.out.println("Weird # of files " + droppedFiles);
+                    System.out.println("Only drop 1 file instead of "+droppedFiles.size()+": " + droppedFiles);
                 }
             } catch (UnsupportedFlavorException | IOException ex) {
                 ex.printStackTrace();
@@ -150,8 +150,10 @@ public void componentShown(ComponentEvent e) {
 
         if (fileToOpen != null) {
             File file = new File(fileToOpen);
-            if (UnitypackageFileName.isUnitypackage(file)) {
+            if (file.isFile()) {
                 openFile(file);
+            } else {
+                System.out.println("File \""+fileToOpen+"\" is not a file.");
             }
         }
     }

src/main/java/unitypackage/viewer/gui/UnitypackageFileName.java

@@ -24,11 +24,13 @@
 public class UnitypackageFileName {
 
     public static boolean isUnitypackage(File file) {
-        return file.isFile() && isUnitypackage(file.getName());
+        return file.isFile() && hasUnitypackageExtension(file.getName());
     }
 
-    public static boolean isUnitypackage(String fileName) {
-        return fileName.toLowerCase().endsWith(".unitypackage");
+    public static boolean hasUnitypackageExtension(String fileName) {
+        final String lowerCase = fileName.toLowerCase();
+        return lowerCase.endsWith(".unitypackage") ||
+               lowerCase.endsWith(".gz");
     }
 
     public static class UnitypackageFileFilter extends FileFilter {

src/main/java/unitypackage/viewer/gui/model/UnityTreeNode.java

@@ -173,7 +173,7 @@ public String toString() {
             } else {
                 // I've seen some .unitypackage where directories get their own GUID and associated data.
                 // I've also seen some where directories have no GUID, but are implied to exist by the asset paths.
-                sb.append(" <i><font color=#ffaaaa>{missing directory .meta}</font></i>");
+                sb.append(" <i><font color=#ffaaaa>{missing directory asset.meta}</font></i>");
             }
 
             sb.append("</html>");
@@ -243,8 +243,15 @@ public String getStringForSearchingAndSorting() {
          */
         @Override
         public String toString() {
-            String s = String.format("<html>%s <font color=#bbbbbb>(%,d bytes) <i>{%s}</i> %s</font></html>",
-                                     getAssetName(), getAssetSize(), getGuid(), getDateModified());
+            String guid = getGuid();
+            if (guid == null) {
+                guid = "<font color=#ffaaaa>{missing asset.meta}</font>";
+            } else {
+                guid = "{"+guid+"}";
+            }
+
+            String s = String.format("<html>%s <font color=#bbbbbb>(%,d bytes) <i>%s</i> %s</font></html>",
+                                     getAssetName(), getAssetSize(), guid, getDateModified());
             return s;
         }