Skip to content

Remove the unused setting key ConsolePrompting and avoid unnecessary string creation when querying ExecutionPolicy setting #10985

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
iSazonov merged 3 commits into from
Nov 6, 2019
Merged

Remove the unused setting key ConsolePrompting and avoid unnecessary string creation when querying ExecutionPolicy setting #10985

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c8c7ad1
Clean up the PowerShellConfig code a bit
daxian-dbw Nov 4, 2019
e75fee9
rename a variable
daxian-dbw Nov 4, 2019
a0e417f
Address Ilya's comment
daxian-dbw Nov 5, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 15 additions & 35 deletions src/System.Management.Automation/engine/PSConfiguration.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,8 @@ public enum ConfigScope
/// </remarks>
internal sealed class PowerShellConfig
{
private const string configFileName = "powershell.config.json";
private const string ConfigFileName = "powershell.config.json";
private const string ExecutionPolicyDefaultShellKey = "Microsoft.PowerShell:ExecutionPolicy";

// Provide a singleton
internal static readonly PowerShellConfig Instance = new PowerShellConfig();
Expand Down Expand Up @@ -79,13 +80,13 @@ private PowerShellConfig()
{
// Sets the system-wide configuration file.
systemWideConfigDirectory = Utils.DefaultPowerShellAppBase;
systemWideConfigFile = Path.Combine(systemWideConfigDirectory, configFileName);
systemWideConfigFile = Path.Combine(systemWideConfigDirectory, ConfigFileName);

// Sets the per-user configuration directory
// Note: This directory may or may not exist depending upon the execution scenario.
// Writes will attempt to create the directory if it does not already exist.
perUserConfigDirectory = Platform.ConfigDirectory;
perUserConfigFile = Path.Combine(perUserConfigDirectory, configFileName);
perUserConfigFile = Path.Combine(perUserConfigDirectory, ConfigFileName);

emptyConfig = new JObject();
configRoots = new JObject[2];
Expand Down Expand Up @@ -153,49 +154,28 @@ internal string GetModulePath(ConfigScope scope)
/// <returns>The execution policy if found. Null otherwise.</returns>
internal string GetExecutionPolicy(ConfigScope scope, string shellId)
{
string execPolicy = null;

string valueName = string.Concat(shellId, ":", "ExecutionPolicy");
string rawExecPolicy = ReadValueFromFile<string>(scope, valueName);

if (!string.IsNullOrEmpty(rawExecPolicy))
{
execPolicy = rawExecPolicy;
}

return execPolicy;
string key = GetExecutionPolicySettingKey(shellId);
string execPolicy = ReadValueFromFile<string>(scope, key);
return string.IsNullOrEmpty(execPolicy) ? null : execPolicy;
}

internal void RemoveExecutionPolicy(ConfigScope scope, string shellId)
{
string valueName = string.Concat(shellId, ":", "ExecutionPolicy");
RemoveValueFromFile<string>(scope, valueName);
string key = GetExecutionPolicySettingKey(shellId);
RemoveValueFromFile<string>(scope, key);
}

internal void SetExecutionPolicy(ConfigScope scope, string shellId, string executionPolicy)
{
string valueName = string.Concat(shellId, ":", "ExecutionPolicy");
WriteValueToFile<string>(scope, valueName, executionPolicy);
}

/// <summary>
/// Existing Key = HKLM\SOFTWARE\Microsoft\PowerShell\1\ShellIds
/// Proposed value = existing default. Probably "1"
///
/// Schema:
/// {
/// "ConsolePrompting" : bool
/// }
/// </summary>
/// <returns>Whether console prompting should happen. If the value cannot be read it defaults to false.</returns>
internal bool GetConsolePrompting()
{
return ReadValueFromFile<bool>(ConfigScope.AllUsers, "ConsolePrompting");
string key = GetExecutionPolicySettingKey(shellId);
WriteValueToFile<string>(scope, key, executionPolicy);
}

internal void SetConsolePrompting(bool shouldPrompt)
private string GetExecutionPolicySettingKey(string shellId)
{
WriteValueToFile<bool>(ConfigScope.AllUsers, "ConsolePrompting", shouldPrompt);
return string.Equals(shellId, Utils.DefaultPowerShellShellID, StringComparison.Ordinal)
? ExecutionPolicyDefaultShellKey
: string.Concat(shellId, ":", "ExecutionPolicy");
}

/// <summary>
Expand Down