Change GetPackageDirectory() to support different type of Package path.

* FileUtils.GetPackageDirectory() is now able to convert package folders
  between physical path and logical path only recognizable by
  AssetDatabase.
* Added FileUtils.GetPackageDirectoryType()
* Added unit tests for these functions

Change-Id: I8664321be355e5940edf8c5253f79ca758e214bd

Author: chkuang-g

source/AndroidResolver/src/GradleResolver.cs

@@ -163,21 +163,20 @@ internal static string RepoPathToUri(string repoPath, string sourceLocation=null
 
                 if (FileUtils.IsUnderDirectory(repoPath, FileUtils.ASSETS_FOLDER)) {
                     trimmedRepoPath = repoPath.Substring(FileUtils.ASSETS_FOLDER.Length + 1);
-                } else if (FileUtils.IsUnderDirectory(repoPath, FileUtils.PACKAGES_FOLDER)) {
+                } else if (FileUtils.IsUnderPackageDirectory(repoPath)) {
                     // Trim the Packages/package-id/ part
-                    string packageFolder =
-                        FileUtils.GetPackageDirectory(repoPath, actualPath: false);
+                    string packageFolder = FileUtils.GetPackageDirectory(repoPath);
                     if (!String.IsNullOrEmpty(packageFolder)) {
                         trimmedRepoPath = repoPath.Substring(packageFolder.Length + 1);
                     }
                 }
 
                 // Search under Packages/package-id first if Dependencies.xml is from a UPM package.
-                if (FileUtils.IsUnderDirectory(sourceLocation, FileUtils.PACKAGES_FOLDER)) {
+                if (FileUtils.IsUnderPackageDirectory(sourceLocation)) {
                     // Get the physical package directory.
                     // Ex. Library/PackageCache/[email protected]/
-                    string packageFolder =
-                        FileUtils.GetPackageDirectory(sourceLocation, actualPath: true);
+                    string packageFolder = FileUtils.GetPackageDirectory(
+                            sourceLocation, FileUtils.PackageDirectoryType.PhysicalPath);
                     if (!String.IsNullOrEmpty(packageFolder)) {
                         string repoPathUnderPackages =
                             packageFolder + Path.DirectorySeparatorChar + trimmedRepoPath;

source/VersionHandlerImpl/src/FileUtils.cs

@@ -18,6 +18,7 @@ namespace Google {
     using System;
     using System.IO;
     using System.Collections.Generic;
+    using System.Text.RegularExpressions;
     using UnityEditor;
 
     /// <summary>
@@ -37,7 +38,19 @@ internal class FileUtils {
         /// <summary>
         /// The name of Packages folder
         /// </summary>
-        public readonly static string PACKAGES_FOLDER = "Packages";
+        private readonly static string PACKAGES_FOLDER = "Packages";
+
+        /// <summary>
+        /// Regex to match packages folder like "Packages/com.company.pkg"
+        /// </summary>
+        private static Regex PACKAGES_ASSETDB_PATH_REGEX =
+                new Regex(@"^(Packages[/\\][^/\\]+)([/\\].*)?$");
+
+        /// <summary>
+        /// Regex to match packages folder like "Library/PackageCache/com.company.pkg"
+        /// </summary>
+        private static Regex PACKAGES_PHYSICAL_PATH_REGEX =
+                new Regex(@"^(Library[/\\]PackageCache[/\\])([^/\\]+)(@[^/\\]+)([/\\].*)?$");
 
         /// <summary>
         /// Returns the project directory (e.g contains the Assets folder).
@@ -352,42 +365,99 @@ public static bool CheckoutFile(string path, Logger logger) {
         /// <param name="directory">Directory to check whether the path is under.</param>
         /// <returns>True if the path is under the directory.</returns>
         public static bool IsUnderDirectory(string path, string directory) {
+            if (String.IsNullOrEmpty(directory)) {
+                return false;
+            }
             if (!directory.EndsWith(Path.DirectorySeparatorChar.ToString())) {
                 directory = directory + Path.DirectorySeparatorChar;
             }
             return NormalizePathSeparators(path.ToLower()).StartsWith(directory.ToLower());
         }
 
+        /// <summary>
+        /// Enum of different types of package directory.
+        /// </summary>
+        public enum PackageDirectoryType {
+            None = 0,
+            // Package path like "Packages/package-id", which is logical path only AssetDatabase
+            // can recognize.
+            AssetDatabasePath = 1,
+            // Package path like "Library/PackageCache/package-id@version", which is the physical
+            // path on the disk.
+            PhysicalPath = 2
+        }
+
+        /// <summary>
+        /// Checks if the given path is under the Package directory.
+        /// </summary>
+        /// <param name="path">Path to the file/directory.</param>
+        /// <returns>
+        /// PackageDirectoryType.None if the path is not under Package directory.
+        /// PackageDirectoryType.AssetDatabasePath if path matches "Packages/package-id".
+        /// PackageDirectoryType.PhysicalPath if path matches "Library/PackageCache/package-id".
+        /// </returns>
+        public static PackageDirectoryType GetPackageDirectoryType(string path) {
+            if (PACKAGES_ASSETDB_PATH_REGEX.IsMatch(path)) {
+                return PackageDirectoryType.AssetDatabasePath;
+            }
+            if (PACKAGES_PHYSICAL_PATH_REGEX.IsMatch(path)) {
+                return PackageDirectoryType.PhysicalPath;
+            }
+            return PackageDirectoryType.None;
+        }
+
+        /// <summary>
+        /// Checks if the given path is under the Package directory.
+        /// </summary>
+        /// <param name="path">Path to the file/directory.</param>
+        /// <returns> True if the path is under package directory.</returns>
+        public static bool IsUnderPackageDirectory(string path) {
+            return GetPackageDirectoryType(path) != PackageDirectoryType.None;
+        }
+
         /// <summary>
         /// Get the package directory from the path.
         /// The package directory should look like "Packages/package-id", where package id is
         /// the Unity Package Manager package name.
-        /// Ex. "Packages/com.google.unity-jar-resolver" if actualPath is false, or
-        /// "Library/PackageCache/[email protected]/" if true.
-        /// Logical path is
         /// Note that there is no way to get physical path if the package is installed from disk.
         /// </summary>
         /// <param name="path">Path to the file/directory.</param>
-        /// <param name="actualPath">If false, return logical path only recognizable by
-        /// AssetDatabase. Otherwise, return physical path of the package.</param>
-        /// <returns>Package directory part of the given path. Empty string if the path is not valid
-        /// .</returns>
-        public static string GetPackageDirectory(string path, bool actualPath) {
-            if (!IsUnderDirectory(path, PACKAGES_FOLDER)) {
-                return "";
-            }
-
-            string[] components = SplitPathIntoComponents(path);
-            if (components.Length < 2) {
-                return "";
-            }
-
-            string packageDir = components[0] + Path.DirectorySeparatorChar + components[1];
-            if (actualPath) {
-                // This only works if the package is NOT installed from disk. That is, it should
-                // work if the package is installed from a local tarball or from a registry server.
-                string absolutePath = Path.GetFullPath(packageDir);
-                packageDir = absolutePath.Substring(ProjectDirectory.Length + 1);
+        /// <param name="directoryType">
+        /// If PackageDirectoryType.None, return package directoy as it is in the path.
+        /// If PackageDirectoryType.AssetDatabasePath, return package directory like
+        /// "Packages/package-id".
+        /// If PackageDirectoryType.PhysicalPath, return package directory like
+        /// "Library/PackageCache/package-id@version".
+        /// </param>
+        /// <returns>Package directory part of the given path. Empty string if the path is not under
+        /// package directory.</returns>
+        public static string GetPackageDirectory(
+                string path,
+                PackageDirectoryType directoryType = PackageDirectoryType.None) {
+            string packageDir = null;
+            var nameMatch = PACKAGES_ASSETDB_PATH_REGEX.Match(path);
+            if (nameMatch.Success) {
+                packageDir = nameMatch.Groups[1].Value;
+                if (directoryType == PackageDirectoryType.PhysicalPath) {
+                    // This only works if the package is NOT installed from disk. That is, it should
+                    // work if the package is installed from a local tarball or from a registry
+                    // server.
+                    string absolutePath = Path.GetFullPath(packageDir);
+                    packageDir = absolutePath.Substring(ProjectDirectory.Length + 1);
+                }
+            } else {
+                nameMatch = PACKAGES_PHYSICAL_PATH_REGEX.Match(path);
+                if (nameMatch.Success) {
+                    if (directoryType == PackageDirectoryType.AssetDatabasePath) {
+                        packageDir = Path.Combine(PACKAGES_FOLDER, nameMatch.Groups[2].Value);
+                    } else {
+                        packageDir = nameMatch.Groups[1].Value +
+                                     nameMatch.Groups[2].Value +
+                                     nameMatch.Groups[3].Value;
+                    }
+                } else {
+                    packageDir = "";
+                }
             }
 
             return packageDir;

source/VersionHandlerImpl/src/VersionHandlerImpl.cs

@@ -359,7 +359,7 @@ public string ManifestName {
         /// false otherwise.</return>
         public bool IsReadOnly {
             get {
-                return FileUtils.IsUnderDirectory(filename, FileUtils.PACKAGES_FOLDER);
+                return FileUtils.IsUnderPackageDirectory(filename);
             }
         }
 

source/VersionHandlerImpl/unit_tests/VersionHandlerImplTests.csproj

@@ -43,6 +43,7 @@
    <ItemGroup>
      <Compile Include="src\EditorMeasurementTest.cs" />
      <Compile Include="src\ProjectSettingsTest.cs" />
+     <Compile Include="src\FileUtilsTest.cs" />
    </ItemGroup>
    <Import Project="$(MSBuildBinPath)\Microsoft.CSharp.targets" />
    <ItemGroup>