/
githubmirror
/
PowerShell
Обзор
Документация
Войти
/
githubmirror
/
PowerShell
Код
Запросы
0
Пакеты
0
Релизы
0
Аналитика
Безопасность
v7.5.8
src/Microsoft.Management.Infrastructure.CimCmdlets/Utils.cs
435 строк
16 KB
Dongbo Wang
Revert some of the interpolated string changes (#19018)
25 янв 2023, 20:46
Не верифицирован
25 янв 2023, 20:46
b195088
Код
Авторство
О чём код?
// Copyright (c) Microsoft Corporation. // Licensed under the MIT License. // #define LOGENABLE // uncomment this line to enable the log, // create c:\temp\cim.log before invoking cimcmdlets using System; using System.Collections.Generic; using System.Diagnostics; using System.Globalization; using System.IO; using System.Text.RegularExpressions; namespace Microsoft.Management.Infrastructure.CimCmdlets { /// <summary> /// <para> /// Global Non-localization strings /// </para> /// </summary> internal static class ConstValue { /// <summary> /// <para> /// Default computername /// </para> /// </summary> internal static readonly string[] DefaultSessionName = { @"*" }; /// <summary> /// <para> /// Empty computername, which will create DCOM session /// </para> /// </summary> internal static readonly string NullComputerName = null; /// <summary> /// <para> /// Empty computername array, which will create DCOM session /// </para> /// </summary> internal static readonly string[] NullComputerNames = { NullComputerName }; /// <summary> /// <para> /// localhost computername, which will create WSMAN session /// </para> /// </summary> internal static readonly string LocalhostComputerName = @"localhost"; /// <summary> /// <para> /// Default namespace /// </para> /// </summary> internal static readonly string DefaultNameSpace = @"root\cimv2"; /// <summary> /// <para> /// Default namespace /// </para> /// </summary> internal static readonly string DefaultQueryDialect = @"WQL"; /// <summary> /// Name of the note property that controls if "PSComputerName" column is shown. /// </summary> internal static readonly string ShowComputerNameNoteProperty = "PSShowComputerName"; /// <summary> /// <para> /// Whether given computername is either null or empty /// </para> /// </summary> /// <param name="computerName"></param> /// <returns></returns> internal static bool IsDefaultComputerName(string computerName) { return string.IsNullOrEmpty(computerName); } /// <summary> /// <para> /// Get computer names, if it is null then return DCOM one /// </para> /// </summary> /// <param name="computerNames"></param> /// <returns></returns> internal static IEnumerable<string> GetComputerNames(IEnumerable<string> computerNames) { return computerNames ?? NullComputerNames; } /// <summary> /// Get computer name, if it is null then return default one. /// </summary> /// <param name="computerName"></param> /// <returns></returns> internal static string GetComputerName(string computerName) { return string.IsNullOrEmpty(computerName) ? NullComputerName : computerName; } /// <summary> /// <para> /// Get namespace, if it is null then return default one /// </para> /// </summary> /// <param name="nameSpace"></param> /// <returns></returns> internal static string GetNamespace(string nameSpace) { return nameSpace ?? DefaultNameSpace; } /// <summary> /// <para> /// Get queryDialect, if it is null then return default query Dialect /// </para> /// </summary> /// <param name="queryDialect"></param> /// <returns></returns> internal static string GetQueryDialectWithDefault(string queryDialect) { return queryDialect ?? DefaultQueryDialect; } } /// <summary> /// <para> /// Debug helper class used to dump debug message to log file /// </para> /// </summary> internal static class DebugHelper { #region private members /// <summary> /// Flag used to control generating log message into file. /// </summary> internal static bool GenerateLog { get; set; } = true; /// <summary> /// Whether the log been initialized. /// </summary> private static bool logInitialized = false; internal static bool GenerateVerboseMessage { get; set; } = true; /// <summary> /// Flag used to control generating message into powershell. /// </summary> internal static readonly string logFile = @"c:\temp\Cim.log"; /// <summary> /// Indent space string. /// </summary> internal static readonly string space = @" "; /// <summary> /// Indent space strings array. /// </summary> internal static readonly string[] spaces = { string.Empty, space, space + space, space + space + space, space + space + space + space, space + space + space + space + space, }; /// <summary> /// Lock the log file. /// </summary> internal static readonly object logLock = new(); #endregion #region internal strings internal static readonly string runspaceStateChanged = "Runspace {0} state changed to {1}"; internal static readonly string classDumpInfo = @"Class type is {0}"; internal static readonly string propertyDumpInfo = @"Property name {0} of type {1}, its value is {2}"; internal static readonly string defaultPropertyType = @"It is a default property, default value is {0}"; internal static readonly string propertyValueSet = @"This property value is set by user {0}"; internal static readonly string addParameterSetName = @"Add parameter set {0} name to cache"; internal static readonly string removeParameterSetName = @"Remove parameter set {0} name from cache"; internal static readonly string currentParameterSetNameCount = @"Cache have {0} parameter set names"; internal static readonly string currentParameterSetNameInCache = @"Cache have parameter set {0} valid {1}"; internal static readonly string currentnonMandatoryParameterSetInCache = @"Cache have optional parameter set {0} valid {1}"; internal static readonly string optionalParameterSetNameCount = @"Cache have {0} optional parameter set names"; internal static readonly string finalParameterSetName = @"------Final parameter set name of the cmdlet is {0}"; internal static readonly string addToOptionalParameterSet = @"Add to optional ParameterSetNames {0}"; internal static readonly string startToResolveParameterSet = @"------Resolve ParameterSet Name"; internal static readonly string reservedString = @"------"; #endregion #region runtime methods internal static string GetSourceCodeInformation(bool withFileName, int depth) { StackTrace trace = new(); StackFrame frame = trace.GetFrame(depth); return string.Create(CultureInfo.CurrentUICulture, $"{frame.GetMethod().DeclaringType.Name}::{frame.GetMethod().Name} "); } #endregion /// <summary> /// Write message to log file named @logFile. /// </summary> /// <param name="message"></param> internal static void WriteLog(string message) { WriteLog(message, 0); } /// <summary> /// Write blank line to log file named @logFile. /// </summary> /// <param name="message"></param> internal static void WriteEmptyLine() { WriteLog(string.Empty, 0); } /// <summary> /// Write message to log file named @logFile with args. /// </summary> /// <param name="message"></param> internal static void WriteLog(string message, int indent, params object[] args) { string outMessage = string.Empty; FormatLogMessage(ref outMessage, message, args); WriteLog(outMessage, indent); } /// <summary> /// Write message to log file w/o arguments. /// </summary> /// <param name="message"></param> /// <param name="indent"></param> internal static void WriteLog(string message, int indent) { WriteLogInternal(message, indent, -1); } /// <summary> /// Write message to log file named @logFile with args. /// </summary> /// <param name="message"></param> internal static void WriteLogEx(string message, int indent, params object[] args) { string outMessage = string.Empty; WriteLogInternal(string.Empty, 0, -1); FormatLogMessage(ref outMessage, message, args); WriteLogInternal(outMessage, indent, 3); } /// <summary> /// Write message to log file w/o arguments. /// </summary> /// <param name="message"></param> /// <param name="indent"></param> internal static void WriteLogEx(string message, int indent) { WriteLogInternal(string.Empty, 0, -1); WriteLogInternal(message, indent, 3); } /// <summary> /// Write message to log file w/o arguments. /// </summary> /// <param name="message"></param> /// <param name="indent"></param> internal static void WriteLogEx() { WriteLogInternal(string.Empty, 0, -1); WriteLogInternal(string.Empty, 0, 3); } /// <summary> /// Format the message. /// </summary> /// <param name="message"></param> /// <param name="args"></param> /// <returns></returns> [Conditional("LOGENABLE")] private static void FormatLogMessage(ref string outMessage, string message, params object[] args) { outMessage = string.Format(CultureInfo.CurrentCulture, message, args); } /// <summary> /// Write message to log file named @logFile /// with indent space ahead of the message. /// </summary> /// <param name="message"></param> /// <param name="nIndent"></param> [Conditional("LOGENABLE")] private static void WriteLogInternal(string message, int indent, int depth) { if (!logInitialized) { lock (logLock) { if (!logInitialized) { DebugHelper.GenerateLog = File.Exists(logFile); logInitialized = true; } } } if (GenerateLog) { if (indent < 0) { indent = 0; } if (indent > 5) { indent = 5; } string sourceInformation = string.Empty; if (depth != -1) { sourceInformation = string.Format( CultureInfo.InvariantCulture, "Thread {0}#{1}:{2}:{3} {4}", Environment.CurrentManagedThreadId, DateTime.Now.Hour, DateTime.Now.Minute, DateTime.Now.Second, GetSourceCodeInformation(true, depth)); } lock (logLock) { using (FileStream fs = new(logFile, FileMode.OpenOrCreate)) using (StreamWriter writer = new(fs)) { writer.WriteLineAsync(spaces[indent] + sourceInformation + @" " + message); } } } } } /// <summary> /// <para> /// Helper class used to validate given parameter /// </para> /// </summary> internal static class ValidationHelper { /// <summary> /// Validate the argument is not null. /// </summary> /// <param name="obj"></param> /// <param name="argumentName"></param> public static void ValidateNoNullArgument(object obj, string argumentName) { ArgumentNullException.ThrowIfNull(obj, argumentName); } /// <summary> /// Validate the argument is not null and not whitespace. /// </summary> /// <param name="obj"></param> /// <param name="argumentName"></param> public static void ValidateNoNullorWhiteSpaceArgument(string obj, string argumentName) { if (string.IsNullOrWhiteSpace(obj)) { throw new ArgumentException(argumentName); } } /// <summary> /// Validate that given classname/propertyname is a valid name compliance with DMTF standard. /// Only for verifying ClassName and PropertyName argument. /// </summary> /// <param name="parameterName"></param> /// <param name="value"></param> /// <returns></returns> /// <exception cref="ArgumentException">Throw if the given value is not a valid name (class name or property name).</exception> public static string ValidateArgumentIsValidName(string parameterName, string value) { DebugHelper.WriteLogEx(); if (value != null) { string trimed = value.Trim(); // The first character should be contained in set: [A-Za-z_] // Inner characters should be contained in set: [A-Za-z0-9_] Regex regex = new(@"^[a-zA-Z_][a-zA-Z0-9_]*\z"); if (regex.IsMatch(trimed)) { DebugHelper.WriteLogEx("A valid name: {0}={1}", 0, parameterName, value); return trimed; } } DebugHelper.WriteLogEx("An invalid name: {0}={1}", 0, parameterName, value); throw new ArgumentException(string.Format(CultureInfo.CurrentUICulture, CimCmdletStrings.InvalidParameterValue, value, parameterName)); } /// <summary> /// Validate given arry argument contains all valid name (for -SelectProperties). /// * is valid for this case. /// </summary> /// <param name="parameterName"></param> /// <param name="value"></param> /// <returns></returns> /// <exception cref="ArgumentException">Throw if the given value contains any invalid name (class name or property name).</exception> public static string[] ValidateArgumentIsValidName(string parameterName, string[] value) { if (value != null) { foreach (string propertyName in value) { // * is wild char supported in select properties if ((propertyName != null) && string.Equals(propertyName.Trim(), "*", StringComparison.OrdinalIgnoreCase)) { continue; } ValidationHelper.ValidateArgumentIsValidName(parameterName, propertyName); } } return value; } } }