Merge remote-tracking branch 'origin/main' into process-stdin

Author: BillyONeal

azure-pipelines/e2e-assets/extract/a-tar-with-plus-x.tar.gz

@@ -0,0 +1,17 @@
+. $PSScriptRoot/../end-to-end-tests-prelude.ps1
+
+$out = Join-Path $TestingRoot "a-tar-with-execute"
+Run-Vcpkg z-extract "$PSScriptRoot/../e2e-assets/extract/a-tar-with-plus-x.tar.gz" $out
+Throw-IfFailed
+
+$extractedFilePath = Join-Path $out "myExe"
+if (-Not (Test-Path $extractedFilePath)) {
+    throw "Extraction Failed"
+}
+
+if (-Not $IsWindows) {
+    $unixMode = (Get-Item $extractedFilePath).UnixMode
+    if ($unixMode -ne "-rwxr-xr-x") {
+        throw "File does not have +x permission. UnixMode: $unixMode"
+    }
+}

azure-pipelines/end-to-end-tests-dir/commands.extract.ps1

@@ -211,7 +211,7 @@
         "features": {
           "type": "array",
           "items": {
-            "$ref": "#/definitions/identifier"
+            "$ref": "#/definitions/dependency-feature"
           }
         },
         "host": {
@@ -239,6 +239,33 @@
       },
       "additionalProperties": false
     },
+    "dependency-feature-object": {
+      "description": "Expanded form of a dependency feature with platform expression.",
+      "type": "object",
+      "properties": {
+        "name": {
+          "$ref": "#/definitions/identifier"
+        },
+        "platform": {
+          "$ref": "#/definitions/platform-expression"
+        }
+      },
+      "required": [
+        "name"
+      ],
+      "additionalProperties": false
+    },
+    "dependency-feature": {
+      "description": "A feature",
+      "oneOf": [
+        {
+          "$ref": "#/definitions/identifier"
+        },
+        {
+          "$ref": "#/definitions/dependency-feature-object"
+        }
+      ]
+    },
     "description-field": {
       "description": "A string or array of strings containing the description of a package or feature.",
       "$ref": "#/definitions/string-or-strings"

docs/vcpkg-schema-definitions.schema.json

@@ -84,7 +84,7 @@
           "description": "Features enabled by default with the package.",
           "type": "array",
           "items": {
-            "$ref": "vcpkg-schema-definitions.schema.json#/definitions/identifier"
+            "$ref": "vcpkg-schema-definitions.schema.json#/definitions/dependency-feature"
           }
         },
         "supports": {

docs/vcpkg.schema.json

@@ -75,6 +75,15 @@ namespace Catch
     {
         static const std::string convert(const vcpkg::Path& value) { return "\"" + value.native() + "\""; }
     };
+
+    template<>
+    struct StringMaker<std::pair<vcpkg::Path, vcpkg::Path>>
+    {
+        static const std::string convert(const std::pair<vcpkg::Path, vcpkg::Path>& value)
+        {
+            return "{\"" + value.first.native() + "\", \"" + value.second.native() + "\"}";
+        }
+    };
 }
 
 namespace vcpkg

include/vcpkg-test/util.h

@@ -13,17 +13,38 @@
 
 namespace vcpkg
 {
+    enum class ExtractionType
+    {
+        Unknown,
+        Tar,
+        Zip,
+        Nupkg,
+        Msi,
+        Exe
+    };
+
     // Extract `archive` to `to_path` using `tar_tool`.
     void extract_tar(const Path& tar_tool, const Path& archive, const Path& to_path);
     // Extract `archive` to `to_path` using `cmake_tool`. (CMake's built in tar)
     void extract_tar_cmake(const Path& cmake_tool, const Path& archive, const Path& to_path);
-    // Extract `archive` to `to_path`, deleting `to_path` first.
     void extract_archive(const Filesystem& fs,
                          const ToolCache& tools,
                          MessageSink& status_sink,
                          const Path& archive,
                          const Path& to_path);
+    // set `to_path` to `archive` contents.
+    void set_directory_to_archive_contents(const Filesystem& fs,
+                                           const ToolCache& tools,
+                                           MessageSink& status_sink,
+                                           const Path& archive,
+                                           const Path& to_path);
+    Path extract_archive_to_temp_subdirectory(const Filesystem& fs,
+                                              const ToolCache& tools,
+                                              MessageSink& status_sink,
+                                              const Path& archive,
+                                              const Path& to_path);
 
+    ExtractionType guess_extraction_type(const Path& archive);
 #ifdef _WIN32
     // Extract the 7z archive part of a self extracting 7z installer
     void win32_extract_self_extracting_7z(const Filesystem& fs, const Path& archive, const Path& to_path);

include/vcpkg/archives.h

@@ -40,6 +40,18 @@ namespace vcpkg
         std::error_code ec;
     };
 
+    struct IsSlash
+    {
+        bool operator()(const char c) const noexcept
+        {
+            return c == '/'
+#if defined(_WIN32)
+                   || c == '\\'
+#endif // _WIN32
+                ;
+        }
+    };
+
     bool is_symlink(FileType s);
     bool is_regular_file(FileType s);
     bool is_directory(FileType s);

include/vcpkg/base/files.h

@@ -4,6 +4,7 @@ DECLARE_MESSAGE(ABoolean, (), "", "a boolean")
 DECLARE_MESSAGE(ABuiltinRegistry, (), "", "a builtin registry")
 DECLARE_MESSAGE(AConfigurationObject, (), "", "a configuration object")
 DECLARE_MESSAGE(ADependency, (), "", "a dependency")
+DECLARE_MESSAGE(ADependencyFeature, (), "", "a feature in a dependency")
 DECLARE_MESSAGE(ADemandObject,
                 (),
                 "'demands' are a concept in the schema of a JSON file the user can edit",
@@ -124,6 +125,7 @@ DECLARE_MESSAGE(AnArtifactsGitRegistryUrl, (), "", "an artifacts git registry UR
 DECLARE_MESSAGE(AnArtifactsRegistry, (), "", "an artifacts registry")
 DECLARE_MESSAGE(AnArrayOfDependencies, (), "", "an array of dependencies")
 DECLARE_MESSAGE(AnArrayOfDependencyOverrides, (), "", "an array of dependency overrides")
+DECLARE_MESSAGE(AnArrayOfFeatures, (), "", "an array of features")
 DECLARE_MESSAGE(AnArrayOfIdentifers, (), "", "an array of identifiers")
 DECLARE_MESSAGE(AnArrayOfOverlayPaths, (), "", "an array of overlay paths")
 DECLARE_MESSAGE(AnArrayOfOverlayTripletsPaths, (), "", "an array of overlay triplets paths")
@@ -858,6 +860,10 @@ DECLARE_MESSAGE(ErrorRequirePackagesList,
                 (),
                 "",
                 "`vcpkg install` requires a list of packages to install in classic mode.")
+DECLARE_MESSAGE(ErrorInvalidExtractOption,
+                (msg::option, msg::value),
+                "The keyword 'AUTO' should not be localized",
+                "--{option} must be set to a nonnegative integer or 'AUTO'.")
 DECLARE_MESSAGE(ErrorsFound, (), "", "Found the following errors:")
 DECLARE_MESSAGE(ErrorUnableToDetectCompilerInfo,
                 (),
@@ -929,6 +935,7 @@ DECLARE_MESSAGE(ExportUnsupportedInManifest,
                 "vcpkg export does not support manifest mode, in order to allow for future design considerations. "
                 "You may use export in classic mode by running vcpkg outside of a manifest-based project.")
 DECLARE_MESSAGE(ExtendedDocumentationAtUrl, (msg::url), "", "Extended documentation available at '{url}'.")
+DECLARE_MESSAGE(ExtractHelp, (), "", "Extracts an archive.")
 DECLARE_MESSAGE(ExtractingTool, (msg::tool_name), "", "Extracting {tool_name}...")
 DECLARE_MESSAGE(FailedPostBuildChecks,
                 (msg::count, msg::path),
@@ -2360,6 +2367,10 @@ DECLARE_MESSAGE(StoredBinariesToDestinations,
                 "",
                 "Stored binaries in {count} destinations in {elapsed}.")
 DECLARE_MESSAGE(StoreOptionMissingSha, (), "", "--store option is invalid without a sha512")
+DECLARE_MESSAGE(StripOption,
+                (msg::option),
+                "--{option} is a setting that can be passed to z-extract command.",
+                "--{option} specifies the number of leading directories to strip from all paths.")
 DECLARE_MESSAGE(SuccessfulyExported, (msg::package_name, msg::path), "", "Exported {package_name} to {path}")
 DECLARE_MESSAGE(SuggestGitPull, (), "", "The result may be outdated. Run `git pull` to get the latest results.")
 DECLARE_MESSAGE(SuggestResolution,

include/vcpkg/base/message-data.inc.h

@@ -14,6 +14,7 @@ namespace vcpkg
         BinaryParagraph();
         explicit BinaryParagraph(Paragraph fields);
         BinaryParagraph(const SourceParagraph& spgh,
+                        const std::vector<std::string>& default_features,
                         Triplet triplet,
                         const std::string& abi_tag,
                         std::vector<PackageSpec> deps);

include/vcpkg/binaryparagraph.h

@@ -0,0 +1,60 @@
+#pragma once
+
+#include <vcpkg/fwd/vcpkgcmdarguments.h>
+#include <vcpkg/fwd/vcpkgpaths.h>
+
+#include <vcpkg/base/expected.h>
+#include <vcpkg/base/path.h>
+
+#include <stddef.h>
+
+#include <utility>
+#include <vector>
+namespace vcpkg::Commands
+{
+    enum class StripMode
+    {
+        Manual,
+        Automatic
+    };
+
+    struct StripSetting
+    {
+        StripMode mode;
+        int count;
+
+        // A constructor to enforce the relationship between mode and count
+        StripSetting(StripMode mode, int count) : mode(mode), count(count)
+        {
+            // If mode is Automatic, enforce count to be -1
+            if (mode == StripMode::Automatic) this->count = -1;
+        }
+
+        // Equality comparison
+        bool operator==(const StripSetting& other) const
+        {
+            return this->mode == other.mode && this->count == other.count;
+        }
+    };
+
+    ExpectedL<StripSetting> get_strip_setting(std::map<std::string, std::string, std::less<>> settings);
+
+    struct ExtractedArchive
+    {
+        Path temp_path;
+        Path base_path;
+        std::vector<Path> proximate_to_temp;
+    };
+
+    // Returns athe set of move operations required to deploy an archive after applying a strip operation. Each .first
+    // should be move to .second. If .second is empty, the file should not be deployed.
+    std::vector<std::pair<Path, Path>> get_archive_deploy_operations(const ExtractedArchive& archive,
+                                                                     StripSetting strip_setting);
+    // Returns the number of leading directories that are common to all paths, excluding their last path element.
+    // Pre: There are no duplicate entries in paths.
+    // Pre: Every entry in paths is lexically_normal.
+    // Both conditions are usually met by calling this function with the result of
+    // get_regular_files_recursive_lexically_proximate.
+    size_t get_common_directories_count(std::vector<Path> paths);
+    void command_extract_and_exit(const VcpkgCmdArguments& args, const VcpkgPaths& paths);
+}