Add InstallationMetadata to manifests for future deep installation de…

…tection (#2350)
microsoft · Jul 20, 2022 · 6aff1fb · 6aff1fb
1 parent c62be2f
commit 6aff1fb
Show file tree

Hide file tree

Showing 11 changed files with 287 additions and 2 deletions.
diff --git a/schemas/JSON/manifests/v1.2.0/manifest.singleton.1.2.0.json b/schemas/JSON/manifests/v1.2.0/manifest.singleton.1.2.0.json
@@ -606,6 +606,9 @@
         "RequireExplicitUpgrade": {
           "$ref": "#/definitions/RequireExplicitUpgrade"
         },
+        "DisplayInstallWarnings": {
+          "$ref": "#/definitions/DisplayInstallWarnings"
+        },
         "UnsupportedOSArchitectures": {
           "$ref": "#/definitions/UnsupportedOSArchitectures"
         },
@@ -822,6 +825,9 @@
     "RequireExplicitUpgrade": {
       "$ref": "#/definitions/RequireExplicitUpgrade"
     },
+    "DisplayInstallWarnings": {
+      "$ref": "#/definitions/DisplayInstallWarnings"
+    },
     "UnsupportedOSArchitectures": {
       "$ref": "#/definitions/UnsupportedOSArchitectures"
     },

diff --git a/schemas/JSON/manifests/v1.3.0/manifest.installer.1.3.0.json b/schemas/JSON/manifests/v1.3.0/manifest.installer.1.3.0.json
@@ -103,6 +103,7 @@
             "description": "The command alias to be used for calling the package. Only applies to the nested portable package"
           }
         },
+        "required": [ "RelativeFilePath" ],
         "description": "A nested installer file contained inside an archive"
       },
       "maxItems": 1024,
@@ -513,6 +514,58 @@
       ],
       "description": "The installer's elevation requirement"
     },
+    "InstallationMetadata": {
+      "type": "object",
+      "title": "InstallationMetadata",
+      "properties": {
+        "DefaultInstallLocation": {
+          "type": [ "string", "null" ],
+          "minLength": 1,
+          "maxLength": 2048,
+          "description": "Represents the default installed package location. Used for deeper installation detection."
+        },
+        "Files": {
+          "type": [ "array", "null" ],
+          "uniqueItems": true,
+          "items": {
+            "type": "object",
+            "title": "InstalledFile",
+            "properties": {
+              "RelativeFilePath": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 2048,
+                "description": "The relative path to the installed file."
+              },
+              "FileSha256": {
+                "type": [ "string", "null" ],
+                "pattern": "^[A-Fa-f0-9]{64}$",
+                "description": "Optional Sha256 of the installed file."
+              },
+              "FileType": {
+                "type": [ "string", "null" ],
+                "enum": [
+                  "launch",
+                  "uninstall",
+                  "other"
+                ],
+                "description": "The optional installed file type. If not specified, the file is treated as other."
+              },
+              "InvocationParameter": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 2048,
+                "description": "Optional parameter for invocable files."
+              }
+            },
+            "required": [ "RelativeFilePath" ],
+            "description": "Represents an installed file."
+          },
+          "description": "List of installed files."
+        }
+      },
+      "description": "Details about the installation. Used for deeper installation detection."
+    },
     "Installer": {
       "type": "object",
       "properties": {
@@ -624,6 +677,9 @@
         },
         "ElevationRequirement": {
           "$ref": "#/definitions/ElevationRequirement"
+        },
+        "InstallationMetadata": {
+          "$ref": "#/definitions/InstallationMetadata"
         }
       },
       "required": [
@@ -719,6 +775,9 @@
     "RequireExplicitUpgrade": {
       "$ref": "#/definitions/RequireExplicitUpgrade"
     },
+    "DisplayInstallWarnings": {
+      "$ref": "#/definitions/DisplayInstallWarnings"
+    },
     "UnsupportedOSArchitectures": {
       "$ref": "#/definitions/UnsupportedOSArchitectures"
     },
@@ -731,8 +790,8 @@
     "ElevationRequirement": {
       "$ref": "#/definitions/ElevationRequirement"
     },
-    "DisplayInstallWarnings": {
-      "$ref": "#/definitions/DisplayInstallWarnings"
+    "InstallationMetadata": {
+      "$ref": "#/definitions/InstallationMetadata"
     },
     "Installers": {
       "type": "array",

diff --git a/schemas/JSON/manifests/v1.3.0/manifest.singleton.1.3.0.json b/schemas/JSON/manifests/v1.3.0/manifest.singleton.1.3.0.json
@@ -145,6 +145,7 @@
             "description": "The command alias to be used for calling the package. Only applies to the nested portable package"
           }
         },
+        "required": [ "RelativeFilePath" ],
         "description": "A nested installer file contained inside an archive"
       },
       "maxItems": 1024,
@@ -554,6 +555,58 @@
       ],
       "description": "The installer's elevation requirement"
     },
+    "InstallationMetadata": {
+      "type": "object",
+      "title": "InstallationMetadata",
+      "properties": {
+        "DefaultInstallLocation": {
+          "type": [ "string", "null" ],
+          "minLength": 1,
+          "maxLength": 2048,
+          "description": "Represents the default installed package location. Used for deeper installation detection."
+        },
+        "Files": {
+          "type": [ "array", "null" ],
+          "uniqueItems": true,
+          "items": {
+            "type": "object",
+            "title": "InstalledFile",
+            "properties": {
+              "RelativeFilePath": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 2048,
+                "description": "The relative path to the installed file."
+              },
+              "FileSha256": {
+                "type": [ "string", "null" ],
+                "pattern": "^[A-Fa-f0-9]{64}$",
+                "description": "Optional Sha256 of the installed file."
+              },
+              "FileType": {
+                "type": [ "string", "null" ],
+                "enum": [
+                  "launch",
+                  "uninstall",
+                  "other"
+                ],
+                "description": "The optional installed file type. If not specified, the file is treated as other."
+              },
+              "InvocationParameter": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 2048,
+                "description": "Optional parameter for invocable files."
+              }
+            },
+            "required": [ "RelativeFilePath" ],
+            "description": "Represents an installed file."
+          },
+          "description": "List of installed files."
+        }
+      },
+      "description": "Details about the installation. Used for deeper installation detection."
+    },
     "Installer": {
       "type": "object",
       "properties": {
@@ -651,6 +704,9 @@
         "RequireExplicitUpgrade": {
           "$ref": "#/definitions/RequireExplicitUpgrade"
         },
+        "DisplayInstallWarnings": {
+          "$ref": "#/definitions/DisplayInstallWarnings"
+        },
         "UnsupportedOSArchitectures": {
           "$ref": "#/definitions/UnsupportedOSArchitectures"
         },
@@ -662,6 +718,9 @@
         },
         "ElevationRequirement": {
           "$ref": "#/definitions/ElevationRequirement"
+        },
+        "InstallationMetadata": {
+          "$ref": "#/definitions/InstallationMetadata"
         }
       },
       "required": [
@@ -873,6 +932,9 @@
     "RequireExplicitUpgrade": {
       "$ref": "#/definitions/RequireExplicitUpgrade"
     },
+    "DisplayInstallWarnings": {
+      "$ref": "#/definitions/DisplayInstallWarnings"
+    },
     "UnsupportedOSArchitectures": {
       "$ref": "#/definitions/UnsupportedOSArchitectures"
     },
@@ -885,6 +947,9 @@
     "ElevationRequirement": {
       "$ref": "#/definitions/ElevationRequirement"
     },
+    "InstallationMetadata": {
+      "$ref": "#/definitions/InstallationMetadata"
+    },
     "Installers": {
       "type": "array",
       "items": {

diff --git a/src/AppInstallerCLITests/TestData/ManifestV1_3-Singleton.yaml b/src/AppInstallerCLITests/TestData/ManifestV1_3-Singleton.yaml
@@ -107,6 +107,13 @@ NestedInstallerType: msi
 NestedInstallerFiles:
   - RelativeFilePath: RelativeFilePath
     PortableCommandAlias: PortableCommandAlias
+InstallationMetadata:
+  DefaultInstallLocation: "%ProgramFiles%\\TestApp"
+  Files:
+    - RelativeFilePath: "main.exe"
+      FileSha256: 69D84CA8899800A5575CE31798293CD4FEBAB1D734A07C2E51E56A28E0DF8C82
+      FileType: launch
+      InvocationParameter: "/arg"
 
 Installers:
   - Architecture: x86

diff --git a/...AppInstallerCLITests/TestData/MultiFileManifestV1_3/ManifestV1_3-MultiFile-Installer.yaml b/...AppInstallerCLITests/TestData/MultiFileManifestV1_3/ManifestV1_3-MultiFile-Installer.yaml
@@ -78,6 +78,13 @@ NestedInstallerType: msi
 NestedInstallerFiles:
   - RelativeFilePath: RelativeFilePath
     PortableCommandAlias: PortableCommandAlias
+InstallationMetadata:
+  DefaultInstallLocation: "%ProgramFiles%\\TestApp"
+  Files:
+    - RelativeFilePath: "main.exe"
+      FileSha256: 69D84CA8899800A5575CE31798293CD4FEBAB1D734A07C2E51E56A28E0DF8C82
+      FileType: launch
+      InvocationParameter: "/arg"
 
 Installers:
   - Architecture: x86
@@ -171,5 +178,12 @@ Installers:
         PortableCommandAlias: portableAlias1
       - RelativeFilePath: relativeFilePath2
         PortableCommandAlias: portableAlias2
+    InstallationMetadata:
+      DefaultInstallLocation: "%ProgramFiles%\\TestApp2"
+      Files:
+      - RelativeFilePath: "main2.exe"
+        FileSha256: 69D84CA8899800A5575CE31798293CD4FEBAB1D734A07C2E51E56A28E0DF8C82
+        FileType: other
+        InvocationParameter: "/arg2"
 ManifestType: installer
 ManifestVersion: 1.3.0
diff --git a/src/AppInstallerCLITests/YamlManifest.cpp b/src/AppInstallerCLITests/YamlManifest.cpp
@@ -483,6 +483,12 @@ void VerifyV1ManifestContent(const Manifest& manifest, bool isSingleton, Manifes
         REQUIRE(manifest.DefaultInstallerInfo.NestedInstallerFiles.size() == 1);
         REQUIRE(manifest.DefaultInstallerInfo.NestedInstallerFiles.at(0).RelativeFilePath == "RelativeFilePath");
         REQUIRE(manifest.DefaultInstallerInfo.NestedInstallerFiles.at(0).PortableCommandAlias == "PortableCommandAlias");
+        REQUIRE(manifest.DefaultInstallerInfo.InstallationMetadata.DefaultInstallLocation == "%ProgramFiles%\\TestApp");
+        REQUIRE(manifest.DefaultInstallerInfo.InstallationMetadata.Files.size() == 1);
+        REQUIRE(manifest.DefaultInstallerInfo.InstallationMetadata.Files.at(0).RelativeFilePath == "main.exe");
+        REQUIRE(manifest.DefaultInstallerInfo.InstallationMetadata.Files.at(0).FileType == InstalledFileTypeEnum::Launch);
+        REQUIRE(manifest.DefaultInstallerInfo.InstallationMetadata.Files.at(0).FileSha256 == SHA256::ConvertToBytes("69D84CA8899800A5575CE31798293CD4FEBAB1D734A07C2E51E56A28E0DF8C82"));
+        REQUIRE(manifest.DefaultInstallerInfo.InstallationMetadata.Files.at(0).InvocationParameter == "/arg");
     }
 
     if (isSingleton)
@@ -572,6 +578,13 @@ void VerifyV1ManifestContent(const Manifest& manifest, bool isSingleton, Manifes
         // NestedInstaller metadata should not be populated unless the InstallerType is zip.
         REQUIRE(installer1.NestedInstallerType == InstallerTypeEnum::Unknown);
         REQUIRE(installer1.NestedInstallerFiles.size() == 0);
+
+        REQUIRE(installer1.InstallationMetadata.DefaultInstallLocation == "%ProgramFiles%\\TestApp");
+        REQUIRE(installer1.InstallationMetadata.Files.size() == 1);
+        REQUIRE(installer1.InstallationMetadata.Files.at(0).RelativeFilePath == "main.exe");
+        REQUIRE(installer1.InstallationMetadata.Files.at(0).FileType == InstalledFileTypeEnum::Launch);
+        REQUIRE(installer1.InstallationMetadata.Files.at(0).FileSha256 == SHA256::ConvertToBytes("69D84CA8899800A5575CE31798293CD4FEBAB1D734A07C2E51E56A28E0DF8C82"));
+        REQUIRE(installer1.InstallationMetadata.Files.at(0).InvocationParameter == "/arg");
     }
 
     if (!isSingleton)
@@ -634,6 +647,12 @@ void VerifyV1ManifestContent(const Manifest& manifest, bool isSingleton, Manifes
             REQUIRE(installer4.NestedInstallerFiles.at(0).PortableCommandAlias == "portableAlias1");
             REQUIRE(installer4.NestedInstallerFiles.at(1).RelativeFilePath == "relativeFilePath2");
             REQUIRE(installer4.NestedInstallerFiles.at(1).PortableCommandAlias == "portableAlias2");
+            REQUIRE(installer4.InstallationMetadata.DefaultInstallLocation == "%ProgramFiles%\\TestApp2");
+            REQUIRE(installer4.InstallationMetadata.Files.size() == 1);
+            REQUIRE(installer4.InstallationMetadata.Files.at(0).RelativeFilePath == "main2.exe");
+            REQUIRE(installer4.InstallationMetadata.Files.at(0).FileType == InstalledFileTypeEnum::Other);
+            REQUIRE(installer4.InstallationMetadata.Files.at(0).FileSha256 == SHA256::ConvertToBytes("69D84CA8899800A5575CE31798293CD4FEBAB1D734A07C2E51E56A28E0DF8C82"));
+            REQUIRE(installer4.InstallationMetadata.Files.at(0).InvocationParameter == "/arg2");
         }
 
         // Localization

diff --git a/src/AppInstallerCommonCore/Manifest/ManifestCommon.cpp b/src/AppInstallerCommonCore/Manifest/ManifestCommon.cpp
@@ -375,6 +375,27 @@ namespace AppInstaller::Manifest
         return result;
     }
 
+    InstalledFileTypeEnum ConvertToInstalledFileTypeEnum(const std::string& in)
+    {
+        std::string inStrLower = Utility::ToLower(in);
+        InstalledFileTypeEnum result = InstalledFileTypeEnum::Unknown;
+
+        if (inStrLower == "launch")
+        {
+            result = InstalledFileTypeEnum::Launch;
+        }
+        else if (inStrLower == "uninstall")
+        {
+            result = InstalledFileTypeEnum::Uninstall;
+        }
+        else if (inStrLower == "other")
+        {
+            result = InstalledFileTypeEnum::Other;
+        }
+
+        return result;
+    }
+
     std::string_view InstallerTypeToString(InstallerTypeEnum installerType)
     {
         switch (installerType)