File size: 17,454 Bytes
8c763fb | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 | // Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System.Collections.ObjectModel;
using System.Management.Automation.Internal;
using System.Runtime.Serialization;
using System.Text;
namespace System.Management.Automation
{
/// <summary>
/// This exception is thrown when a command cannot be found.
/// </summary>
public class CommandNotFoundException : RuntimeException
{
/// <summary>
/// Constructs a CommandNotFoundException. This is the recommended constructor.
/// </summary>
/// <param name="commandName">
/// The name of the command that could not be found.
/// </param>
/// <param name="innerException">
/// The inner exception.
/// </param>
/// <param name="resourceStr">
/// This string is message template string
/// </param>
/// <param name="errorIdAndResourceId">
/// This string is the ErrorId passed to the ErrorRecord, and is also
/// the resourceId used to look up the message template string in
/// DiscoveryExceptions.txt.
/// </param>
/// <param name="messageArgs">
/// Additional arguments to format into the message.
/// </param>
internal CommandNotFoundException(
string commandName,
Exception innerException,
string errorIdAndResourceId,
string resourceStr,
params object[] messageArgs)
: base(BuildMessage(commandName, resourceStr, messageArgs), innerException)
{
_commandName = commandName;
_errorId = errorIdAndResourceId;
}
/// <summary>
/// Constructs a CommandNotFoundException.
/// </summary>
public CommandNotFoundException() : base() { }
/// <summary>
/// Constructs a CommandNotFoundException.
/// </summary>
/// <param name="message">
/// The message used in the exception.
/// </param>
public CommandNotFoundException(string message) : base(message) { }
/// <summary>
/// Constructs a CommandNotFoundException.
/// </summary>
/// <param name="message">
/// The message used in the exception.
/// </param>
/// <param name="innerException">
/// An exception that led to this exception.
/// </param>
public CommandNotFoundException(string message, Exception innerException) : base(message, innerException) { }
/// <summary>
/// Serialization constructor for class CommandNotFoundException.
/// </summary>
/// <param name="info">
/// serialization information
/// </param>
/// <param name="context">
/// streaming context
/// </param>
[Obsolete("Legacy serialization support is deprecated since .NET 8", DiagnosticId = "SYSLIB0051")]
protected CommandNotFoundException(SerializationInfo info,
StreamingContext context)
{
throw new NotSupportedException();
}
#region Properties
/// <summary>
/// Gets the ErrorRecord information for this exception.
/// </summary>
public override ErrorRecord ErrorRecord
{
get
{
_errorRecord ??= new ErrorRecord(
new ParentContainsErrorRecordException(this),
_errorId,
_errorCategory,
_commandName);
return _errorRecord;
}
}
private ErrorRecord _errorRecord;
/// <summary>
/// Gets the name of the command that could not be found.
/// </summary>
public string CommandName
{
get { return _commandName; }
set { _commandName = value; }
}
private string _commandName = string.Empty;
#endregion Properties
#region Private
private readonly string _errorId = "CommandNotFoundException";
private readonly ErrorCategory _errorCategory = ErrorCategory.ObjectNotFound;
private static string BuildMessage(
string commandName,
string resourceStr,
params object[] messageArgs
)
{
object[] a;
if (messageArgs != null && messageArgs.Length > 0)
{
a = new object[messageArgs.Length + 1];
a[0] = commandName;
messageArgs.CopyTo(a, 1);
}
else
{
a = new object[1];
a[0] = commandName;
}
return StringUtil.Format(resourceStr, a);
}
#endregion Private
}
/// <summary>
/// Defines the exception thrown when a script's requirements to run specified by the #requires
/// statements are not met.
/// </summary>
public class ScriptRequiresException : RuntimeException
{
/// <summary>
/// Constructs an ScriptRequiresException. Recommended constructor for the class for
/// #requires -shellId MyShellId.
/// </summary>
/// <param name="commandName">
/// The name of the script containing the #requires statement.
/// </param>
/// <param name="requiresShellId">
/// The ID of the shell that is incompatible with the current shell.
/// </param>
/// <param name="requiresShellPath">
/// The path to the shell specified in the #requires -shellId statement.
/// </param>
/// <param name="errorId">
/// The error id for this exception.
/// </param>
internal ScriptRequiresException(
string commandName,
string requiresShellId,
string requiresShellPath,
string errorId)
: base(BuildMessage(commandName, requiresShellId, requiresShellPath, true))
{
Diagnostics.Assert(!string.IsNullOrEmpty(commandName), "commandName is null or empty when constructing ScriptRequiresException");
Diagnostics.Assert(!string.IsNullOrEmpty(errorId), "errorId is null or empty when constructing ScriptRequiresException");
_commandName = commandName;
_requiresShellId = requiresShellId;
_requiresShellPath = requiresShellPath;
this.SetErrorId(errorId);
this.SetTargetObject(commandName);
this.SetErrorCategory(ErrorCategory.ResourceUnavailable);
}
/// <summary>
/// Constructs an ScriptRequiresException. Recommended constructor for the class for
/// #requires -version N.
/// </summary>
/// <param name="commandName">
/// The name of the script containing the #requires statement.
/// </param>
/// <param name="requiresPSVersion">
/// The Msh version that the script requires.
/// </param>
/// <param name="currentPSVersion">
/// The current Msh version
/// </param>
/// <param name="errorId">
/// The error id for this exception.
/// </param>
internal ScriptRequiresException(
string commandName,
Version requiresPSVersion,
string currentPSVersion,
string errorId)
: base(BuildMessage(commandName, requiresPSVersion.ToString(), currentPSVersion, false))
{
Diagnostics.Assert(!string.IsNullOrEmpty(commandName), "commandName is null or empty when constructing ScriptRequiresException");
Diagnostics.Assert(requiresPSVersion != null, "requiresPSVersion is null or empty when constructing ScriptRequiresException");
Diagnostics.Assert(!string.IsNullOrEmpty(errorId), "errorId is null or empty when constructing ScriptRequiresException");
_commandName = commandName;
_requiresPSVersion = requiresPSVersion;
this.SetErrorId(errorId);
this.SetTargetObject(commandName);
this.SetErrorCategory(ErrorCategory.ResourceUnavailable);
}
/// <summary>
/// Constructs an ScriptRequiresException. Recommended constructor for the class for the
/// #requires -PSSnapin MyPSSnapIn statement.
/// </summary>
/// <param name="commandName">
/// The name of the script containing the #requires statement.
/// </param>
/// <param name="missingItems">
/// The missing snap-ins/modules that the script requires.
/// </param>
/// /// <param name="forSnapins">
/// Indicates whether the error message needs to be constructed for missing snap-ins/ missing modules.
/// </param>
/// <param name="errorId">
/// The error id for this exception.
/// </param>
internal ScriptRequiresException(
string commandName,
Collection<string> missingItems,
string errorId,
bool forSnapins)
: this(commandName, missingItems, errorId, forSnapins, null)
{
}
/// <summary>
/// Constructs an ScriptRequiresException. Recommended constructor for the class for the
/// #requires -PSSnapin MyPSSnapIn statement.
/// </summary>
/// <param name="commandName">
/// The name of the script containing the #requires statement.
/// </param>
/// <param name="missingItems">
/// The missing snap-ins/modules that the script requires.
/// </param>
/// /// <param name="forSnapins">
/// Indicates whether the error message needs to be constructed for missing snap-ins/ missing modules.
/// </param>
/// <param name="errorId">
/// The error id for this exception.
/// </param>
/// <param name="errorRecord">
/// The error Record for this exception.
/// </param>
internal ScriptRequiresException(
string commandName,
Collection<string> missingItems,
string errorId,
bool forSnapins,
ErrorRecord errorRecord)
: base(BuildMessage(commandName, missingItems, forSnapins), null, errorRecord)
{
Diagnostics.Assert(!string.IsNullOrEmpty(commandName), "commandName is null or empty when constructing ScriptRequiresException");
Diagnostics.Assert(missingItems != null && missingItems.Count > 0, "missingItems is null or empty when constructing ScriptRequiresException");
Diagnostics.Assert(!string.IsNullOrEmpty(errorId), "errorId is null or empty when constructing ScriptRequiresException");
_commandName = commandName;
_missingPSSnapIns = new ReadOnlyCollection<string>(missingItems);
this.SetErrorId(errorId);
this.SetTargetObject(commandName);
this.SetErrorCategory(ErrorCategory.ResourceUnavailable);
}
/// <summary>
/// Constructs an ScriptRequiresException. Recommended constructor for the class for
/// #requires -RunAsAdministrator statement.
/// </summary>
/// <param name="commandName">
/// The name of the script containing the #requires statement.
/// </param>
/// <param name="errorId">
/// The error id for this exception.
/// </param>
internal ScriptRequiresException(
string commandName,
string errorId)
: base(BuildMessage(commandName))
{
Diagnostics.Assert(!string.IsNullOrEmpty(commandName), "commandName is null or empty when constructing ScriptRequiresException");
Diagnostics.Assert(!string.IsNullOrEmpty(errorId), "errorId is null or empty when constructing ScriptRequiresException");
_commandName = commandName;
this.SetErrorId(errorId);
this.SetTargetObject(commandName);
this.SetErrorCategory(ErrorCategory.PermissionDenied);
}
/// <summary>
/// Constructs an PSVersionNotCompatibleException.
/// </summary>
public ScriptRequiresException() : base() { }
/// <summary>
/// Constructs an PSVersionNotCompatibleException.
/// </summary>
/// <param name="message">
/// The message used in the exception.
/// </param>
public ScriptRequiresException(string message) : base(message) { }
/// <summary>
/// Constructs an PSVersionNotCompatibleException.
/// </summary>
/// <param name="message">
/// The message used in the exception.
/// </param>
/// <param name="innerException">
/// The exception that led to this exception.
/// </param>
public ScriptRequiresException(string message, Exception innerException) : base(message, innerException) { }
#region Serialization
/// <summary>
/// Constructs an PSVersionNotCompatibleException using serialized data.
/// </summary>
/// <param name="info">
/// serialization information
/// </param>
/// <param name="context">
/// streaming context
/// </param>
[Obsolete("Legacy serialization support is deprecated since .NET 8", DiagnosticId = "SYSLIB0051")]
protected ScriptRequiresException(SerializationInfo info,
StreamingContext context)
{
throw new NotSupportedException();
}
#endregion Serialization
#region Properties
/// <summary>
/// Gets the name of the script that contained the #requires statement.
/// </summary>
public string CommandName
{
get { return _commandName; }
}
private readonly string _commandName = string.Empty;
/// <summary>
/// Gets the PSVersion that the script requires.
/// </summary>
public Version RequiresPSVersion
{
get { return _requiresPSVersion; }
}
private readonly Version _requiresPSVersion;
/// <summary>
/// Gets the missing snap-ins that the script requires.
/// </summary>
public ReadOnlyCollection<string> MissingPSSnapIns
{
get { return _missingPSSnapIns; }
}
private readonly ReadOnlyCollection<string> _missingPSSnapIns = new ReadOnlyCollection<string>(Array.Empty<string>());
/// <summary>
/// Gets or sets the ID of the shell.
/// </summary>
public string RequiresShellId
{
get { return _requiresShellId; }
}
private readonly string _requiresShellId;
/// <summary>
/// Gets or sets the path to the incompatible shell.
/// </summary>
public string RequiresShellPath
{
get { return _requiresShellPath; }
}
private readonly string _requiresShellPath;
#endregion Properties
#region Private
private static string BuildMessage(
string commandName,
Collection<string> missingItems,
bool forSnapins)
{
StringBuilder sb = new StringBuilder();
if (missingItems == null)
{
throw PSTraceSource.NewArgumentNullException(nameof(missingItems));
}
foreach (string missingItem in missingItems)
{
sb.Append(missingItem).Append(", ");
}
if (sb.Length > 1)
{
sb.Remove(sb.Length - 2, 2);
}
if (forSnapins)
{
return StringUtil.Format(
DiscoveryExceptions.RequiresMissingPSSnapIns,
commandName,
sb.ToString());
}
else
{
return StringUtil.Format(
DiscoveryExceptions.RequiresMissingModules,
commandName,
sb.ToString());
}
}
private static string BuildMessage(
string commandName,
string first,
string second,
bool forShellId)
{
string resourceStr = null;
if (forShellId)
{
if (string.IsNullOrEmpty(first))
{
resourceStr = DiscoveryExceptions.RequiresShellIDInvalidForSingleShell;
}
else
{
resourceStr = string.IsNullOrEmpty(second)
? DiscoveryExceptions.RequiresInterpreterNotCompatibleNoPath
: DiscoveryExceptions.RequiresInterpreterNotCompatible;
}
}
else
{
resourceStr = DiscoveryExceptions.RequiresPSVersionNotCompatible;
}
return StringUtil.Format(resourceStr, commandName, first, second);
}
private static string BuildMessage(string commandName)
{
return StringUtil.Format(DiscoveryExceptions.RequiresElevation, commandName);
}
#endregion Private
}
}
|