(#3344) Convert Get-PackageScriptParameter to helper cmdlet

JPRuskin · JPRuskin · commit f60bd7047aad · 2025-06-05T09:28:48.000+01:00
It was pointed out that this PR should be targeted
at including new helper functions into the C# conversion
efforts.

This converts Get-PackageParameter to use a
helper class (shared between this and the new
cmdlet) and adds Get-PackageScriptParameters to the
Chocolatey.PowerShell compiled module.
diff --git a/src/Chocolatey.PowerShell/Chocolatey.PowerShell.csproj b/src/Chocolatey.PowerShell/Chocolatey.PowerShell.csproj
@@ -61,13 +61,15 @@
     <Compile Include="Commands\GetEnvironmentVariableCommand.cs" />
     <Compile Include="Commands\GetEnvironmentVariableNamesCommand.cs" />
     <Compile Include="Commands\GetPackageParameterCommand.cs" />
+    <Compile Include="Commands\GetPackageScriptParametersCommand.cs" />
     <Compile Include="Commands\InstallChocolateyPathCommand.cs" />
     <Compile Include="Commands\SetEnvironmentVariableCommand.cs" />
     <Compile Include="Commands\TestProcessAdminRightsCommand.cs" />
     <Compile Include="Commands\UninstallChocolateyPathCommand.cs" />
     <Compile Include="Commands\UpdateSessionEnvironmentCommand.cs" />
     <Compile Include="Helpers\Elevation.cs" />
     <Compile Include="Helpers\EnvironmentHelper.cs" />
+    <Compile Include="Helpers\PackageParameter.cs" />
     <Compile Include="Helpers\Paths.cs" />
     <Compile Include="Helpers\ProcessInformation.cs" />
     <Compile Include="Helpers\PSHelper.cs" />
diff --git a/src/Chocolatey.PowerShell/Commands/GetPackageParameterCommand.cs b/src/Chocolatey.PowerShell/Commands/GetPackageParameterCommand.cs
@@ -1,182 +1,43 @@
-using Chocolatey.PowerShell.Shared; 
-using System; 
-using System.Collections; 
-using System.Collections.Generic; 
-using System.Management.Automation; 
-using System.Text; 
-using System.Text.RegularExpressions;
- 
+// Copyright © 2017 - 2025 Chocolatey Software, Inc
+// Copyright © 2011 - 2017 RealDimensions Software, LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+//
+// You may obtain a copy of the License at
+//
+// 	http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+using Chocolatey.PowerShell.Shared;
+using System.Collections;
+using System.Management.Automation;
+using Chocolatey.PowerShell.Helpers;
+
 namespace Chocolatey.PowerShell.Commands
-{ 
+{
+    /// <summary>
+    /// Parses a string and returns a hash table array of those values for use in package scripts.
+    /// </summary>
+    /// <param name="Parameters">A string containing parameters to be parsed.</param>
+    /// <returns>A hashtable of parameters that have been passed to <paramref name="Parameters"> and parsed.</returns>
     [Cmdlet(VerbsCommon.Get, "PackageParameter")]
+    [Alias("Get-PackageParameters")]
     [OutputType(typeof(Hashtable))]
     public class GetPackageParameterCommand : ChocolateyCmdlet
     {
-        /*
-.SYNOPSIS
-Parses a string and returns a hash table array of those values for use
-in package scripts.
-
-.DESCRIPTION
-This looks at a string value and parses it into a hash table array for
-use in package scripts. By default this will look at
-`$env:ChocolateyPackageParameters` (`--params="'/ITEM:value'"`) and
-`$env:ChocolateyPackageParametersSensitive`
-(`--package-parameters-sensitive="'/PASSWORD:value'"` in commercial
-editions).
-
-Learn more about using this at https://docs.chocolatey.org/en-us/guides/create/parse-packageparameters-argument
-
-.NOTES
-If you need compatibility with older versions of Chocolatey,
-take a dependency on the `chocolatey-core.extension` package which
-also provides this functionality. If you are pushing to the community
-package repository (https://community.chocolatey.org/packages), you are required
-to take a dependency on the core extension until January 2018. How to
-do this is explained at https://docs.chocolatey.org/en-us/guides/create/parse-packageparameters-argument#step-3---use-core-community-extension.
-
-The differences between this and the `chocolatey-core.extension` package
-functionality is that the extension function can only do one string at a
-time and it only looks at `$env:ChocolateyPackageParameters` by default.
-It also only supports splitting by `:`, with this function you can
-either split by `:` or `=`. For compatibility with the core extension,
-build all docs with `/Item:Value`.
-
-.INPUTS
-None
-
-.OUTPUTS
-[HashTable]
-
-.PARAMETER Parameters
-OPTIONAL - Specify a string to parse. If not set, will use
-`$env:ChocolateyPackageParameters` and
-`$env:ChocolateyPackageParametersSensitive` to parse values from.
-
-Parameters should be passed as "/NAME:value" or "/NAME=value". For
-compatibility with `chocolatey-core.extension`, use `:`.
-
-For example `-Parameters "/ITEM1:value /ITEM2:value with spaces"
-
-To maintain compatibility with the prior art of the chocolatey-core.extension
-function by the same name, quotes and apostrophes surrounding
-parameter values will be removed. When the param is used, those items
-can be added back if desired, but it's most important to ensure that
-existing packages are compatible on upgrade.
-
-.PARAMETER IgnoredArguments
-Allows splatting with arguments that do not apply and future expansion.
-Do not use directly.
-
-.EXAMPLE
->
-# The default way of calling, uses `$env:ChocolateyPackageParameters`
-# and `$env:ChocolateyPackageParametersSensitive` - this is typically
-# how things are passed in from choco.exe
-$pp = Get-PackageParameters
-
-.EXAMPLE
->
-# see https://docs.chocolatey.org/en-us/guides/create/parse-packageparameters-argument
-# command line call: `choco install <pkg_id> --params "'/LICENSE:value'"`
-$pp = Get-PackageParameters
-# Read-Host, PromptForChoice, etc are not blocking calls with Chocolatey.
-# Chocolatey has a custom PowerShell host that will time these calls
-# after 30 seconds, allowing headless operation to continue but offer
-# prompts to users to ask questions during installation.
-if (!$pp['LICENSE']) { $pp['LICENSE'] = Read-Host 'License key?' }
-# set a default if not passed
-if (!$pp['LICENSE']) { $pp['LICENSE'] = '1234' }
-
-.EXAMPLE
->
-$pp = Get-PackageParameters
-if (!$pp['UserName']) { $pp['UserName'] = "$env:UserName" }
-if (!$pp['Password']) { $pp['Password'] = Read-Host "Enter password for $($pp['UserName']):" -AsSecureString}
-# fail the install/upgrade if not value is not determined
-if (!$pp['Password']) { throw "Package needs Password to install, that must be provided in params or in prompt." }
-
-.EXAMPLE
->
-# Pass in your own values
-Get-PackageParameters -Parameters "/Shortcut /InstallDir:'c:\program files\xyz' /NoStartup" | set r
-if ($r.Shortcut) {... }
-Write-Host $r.InstallDir
-
-.LINK
-Install-ChocolateyPackage
-
-.LINK
-Install-ChocolateyInstallPackage
-
-.LINK
-Install-ChocolateyZipPackage
-         */
-
-        private const string PackageParameterPattern = @"(?:^|\s+)\/(?<ItemKey>[^\:\=\s)]+)(?:(?:\:|=){1}(?:\''|\""){0,1}(?<ItemValue>.*?)(?:\''|\""){0,1}(?:(?=\s+\/)|$))?";
-        private static readonly Regex _packageParameterRegex = new Regex(PackageParameterPattern, RegexOptions.Compiled);
-
         [Parameter(Position = 0)]
         [Alias("Params")]
         public string Parameters { get; set; } = string.Empty;
 
         protected override void End()
         {
-            var paramStrings = new List<string>();
-            var logParams = true;
-
-            if (!string.IsNullOrEmpty(Parameters))
-            {
-                paramStrings.Add(Parameters);
-            }
-            else
-            {
-                WriteDebug("Parsing $env:ChocolateyPackageParameters and $env:ChocolateyPackageParametersSensitive for parameters");
-
-                var packageParams = EnvironmentVariable(EnvironmentVariables.ChocolateyPackageParameters);
-                if (!string.IsNullOrEmpty(packageParams))
-                {
-                    paramStrings.Add(packageParams);
-                }
-
-                var sensitiveParams = EnvironmentVariable(EnvironmentVariables.ChocolateyPackageParametersSensitive);
-                if (!string.IsNullOrEmpty(sensitiveParams))
-                {
-                    logParams = false;
-                    WriteDebug("Sensitive parameters detected, no logging of parameters.");
-                    paramStrings.Add(sensitiveParams);
-                }
-            }
-
-            var paramHash = new Hashtable(StringComparer.OrdinalIgnoreCase);
-
-            foreach (var param in paramStrings)
-            {
-                foreach (Match match in _packageParameterRegex.Matches(param))
-                {                    
-                    var name = match.Groups["ItemKey"].Value.Trim();
-                    var valueGroup = match.Groups["ItemValue"];
-
-                    object value;
-                    if (valueGroup.Success)
-                    { 
-                        value = valueGroup.Value.Trim();
-                    }
-                    else
-                    { 
-                        value = (object)true;
-                    }
-
-                    if (logParams)
-                    {
-                        WriteDebug($"Adding package param '{name}'='{value}'");
-                    }
-
-                    paramHash[name] = value;
-                }
-            }
-
-            WriteObject(paramHash);
+            WriteObject(PackageParameter.GetParameters(this, Parameters));
         }
     }
 }
diff --git a/src/Chocolatey.PowerShell/Commands/GetPackageScriptParametersCommand.cs b/src/Chocolatey.PowerShell/Commands/GetPackageScriptParametersCommand.cs
@@ -0,0 +1,69 @@
+// Copyright © 2017 - 2025 Chocolatey Software, Inc
+// Copyright © 2011 - 2017 RealDimensions Software, LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+//
+// You may obtain a copy of the License at
+//
+// 	http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+using System;
+using System.Collections;
+using System.Collections.Generic;
+using System.Linq;
+using System.Management.Automation;
+using System.Management.Automation.Language;
+using Chocolatey.PowerShell.Helpers;
+using Chocolatey.PowerShell.Shared;
+
+namespace Chocolatey.PowerShell.Commands
+{
+    /// <summary>
+    /// Parses a script and returns a hash table of parameters that are present in the package params, along with their values.
+    /// </summary>
+    /// <param name="ScriptPath">A path to a script to parse parameters from.</param>
+    /// <param name="Parameters">A string containing parameters to be parsed.</param>
+    /// <returns>A hashtable of parameters present in <paramref name="ScriptPath"> and also in <paramref name="Parameters"> (or the envvar).</returns>
+    [Cmdlet(VerbsCommon.Get, "PackageScriptParameters")]
+    [OutputType(typeof(Hashtable))]
+    public class GetScriptParametersCommand : ChocolateyCmdlet
+    {
+        [Parameter(Mandatory = true, Position = 0)]
+        public string ScriptPath { get; set; }
+
+        [Parameter(Mandatory = false, Position = 1)]
+        public string Parameters { get; set; } = string.Empty;
+
+        protected override void End()
+        {
+            var packageParameters = PackageParameter.GetParameters(this, Parameters);
+            var splatHash = new Hashtable(StringComparer.OrdinalIgnoreCase);
+
+            // Check what parameters the script has
+            Token[] tokensRef = null;
+            ParseError[] errorsRef = null;
+            var parsedAst = Parser.ParseFile(ScriptPath, out tokensRef, out errorsRef);
+            var scriptParameters = parsedAst.ParamBlock != null ? parsedAst.ParamBlock.Parameters.Select(p => p.Name.VariablePath.UserPath.ToString()).ToList() : new List<string>();
+            WriteVerbose($"Found {scriptParameters.Count()} parameter(s) in '{ScriptPath}'");
+
+            // For each of those in PackageParameters, add it to the splat
+            foreach (var parameter in scriptParameters)
+            {
+                if (packageParameters.ContainsKey(parameter))
+                {
+                    splatHash.Add(parameter, packageParameters[parameter]);
+                }
+            }
+
+            // Return the splat
+            WriteObject(splatHash);
+        }
+    }
+}
diff --git a/src/Chocolatey.PowerShell/Helpers/PackageParameter.cs b/src/Chocolatey.PowerShell/Helpers/PackageParameter.cs
@@ -0,0 +1,93 @@
+﻿// Copyright © 2017 - 2025 Chocolatey Software, Inc
+// Copyright © 2011 - 2017 RealDimensions Software, LLC
+// 
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// 
+// You may obtain a copy of the License at
+// 
+// 	http://www.apache.org/licenses/LICENSE-2.0
+// 
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+using System;
+using System.Collections;
+using System.Collections.Generic;
+using System.Management.Automation;
+using System.Text.RegularExpressions;
+
+namespace Chocolatey.PowerShell.Helpers
+{
+    public static class PackageParameter
+    {
+        private const string PackageParameterPattern = @"(?:^|\s+)\/(?<ItemKey>[^\:\=\s)]+)(?:(?:\:|=){1}(?:\'|\""){0,1}(?<ItemValue>.*?)(?:\'|\""){0,1}(?:(?=\s+\/)|$))?";
+        private static readonly Regex _packageParameterRegex = new Regex(PackageParameterPattern, RegexOptions.Compiled);
+        
+        public static Hashtable GetParameters(PSCmdlet cmdlet, string parameters)
+        {
+            var paramStrings = new List<string>();
+            var logParams = true;
+            
+            if (!string.IsNullOrEmpty(parameters))
+            {
+                paramStrings.Add(parameters);
+            }
+            else
+            {
+                var packageParameters = EnvironmentHelper.GetVariable(
+                    cmdlet,
+                    "ChocolateyPackageParameters",
+                    EnvironmentVariableTarget.Process);
+                if (!string.IsNullOrEmpty(packageParameters))
+                {
+                    paramStrings.Add(packageParameters);
+                }
+
+                // This should possibly only be implemented in the CLE codebase
+                var sensitivePackageParameters = EnvironmentHelper.GetVariable(
+                    cmdlet,
+                    "ChocolateyPackageParametersSensitive",
+                    EnvironmentVariableTarget.Process);
+                if (!string.IsNullOrEmpty(sensitivePackageParameters))
+                {
+                    logParams = false;
+                    paramStrings.Add(sensitivePackageParameters);
+                }
+            }
+
+            var paramHash = new Hashtable(StringComparer.OrdinalIgnoreCase);
+
+            foreach (var param in paramStrings)
+            {
+                foreach (Match match in _packageParameterRegex.Matches(param))
+                {
+                    var name = match.Groups["ItemKey"].Value.Trim();
+                    var valueGroup = match.Groups["ItemValue"];
+
+                    object value;
+                    if (valueGroup.Success)
+                    {
+                        value = valueGroup.Value.Trim();
+                    }
+                    else
+                    {
+                        value = (object)true;
+                    }
+
+                    if (logParams)
+                    {
+                        cmdlet.WriteDebug($"Adding package param '{name}'='{value}'");
+                    }
+
+                    paramHash[name] = value;
+                }
+            }
+
+            return paramHash;
+        }
+    }
+}
diff --git a/src/chocolatey.resources/helpers/functions/Get-PackageScriptParameters.ps1 b/src/chocolatey.resources/helpers/functions/Get-PackageScriptParameters.ps1
