File size: 16,730 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 479 480 481 482 483 484 485 | // Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.IO;
using System.Management.Automation;
using System.Management.Automation.Internal;
using System.Security;
namespace Microsoft.PowerShell.Commands
{
/// <summary>
/// The implementation of the "import-alias" cmdlet.
/// </summary>
[Cmdlet(VerbsData.Import, "Alias", SupportsShouldProcess = true, DefaultParameterSetName = "ByPath", HelpUri = "https://go.microsoft.com/fwlink/?LinkID=2097125")]
[OutputType(typeof(AliasInfo))]
public class ImportAliasCommand : PSCmdlet
{
#region Statics
private const string LiteralPathParameterSetName = "ByLiteralPath";
#endregion
#region Parameters
/// <summary>
/// The path from which to import the aliases.
/// </summary>
[Parameter(Position = 0, Mandatory = true, ValueFromPipeline = true, ValueFromPipelineByPropertyName = true, ParameterSetName = "ByPath")]
public string Path { get; set; }
/// <summary>
/// The literal path from which to import the aliases.
/// </summary>
[Parameter(Mandatory = true, ValueFromPipeline = true, ValueFromPipelineByPropertyName = true, ParameterSetName = LiteralPathParameterSetName)]
[Alias("PSPath", "LP")]
public string LiteralPath
{
get
{
return Path;
}
set
{
Path = value;
}
}
/// <summary>
/// The scope to import the aliases to.
/// </summary>
[Parameter]
[ValidateNotNullOrEmpty]
[ArgumentCompleter(typeof(ScopeArgumentCompleter))]
public string Scope { get; set; }
/// <summary>
/// If set to true, the alias that is set is passed to the pipeline.
/// </summary>
[Parameter]
public SwitchParameter PassThru
{
get
{
return _passThru;
}
set
{
_passThru = value;
}
}
private bool _passThru;
/// <summary>
/// If set to true and an existing alias of the same name exists
/// and is ReadOnly, the alias will be overwritten.
/// </summary>
[Parameter]
public SwitchParameter Force
{
get
{
return _force;
}
set
{
_force = value;
}
}
private bool _force;
#endregion Parameters
#region Command code
/// <summary>
/// The main processing loop of the command.
/// </summary>
protected override void ProcessRecord()
{
Collection<AliasInfo> importedAliases = GetAliasesFromFile(this.ParameterSetName.Equals(LiteralPathParameterSetName,
StringComparison.OrdinalIgnoreCase));
CommandOrigin origin = MyInvocation.CommandOrigin;
foreach (AliasInfo alias in importedAliases)
{
// If not force, then see if the alias already exists
// NTRAID#Windows Out Of Band Releases-906910-2006/03/17-JonN
string action = AliasCommandStrings.ImportAliasAction;
string target = StringUtil.Format(AliasCommandStrings.ImportAliasTarget, alias.Name, alias.Definition);
if (!ShouldProcess(target, action))
continue;
if (!Force)
{
AliasInfo existingAlias = null;
if (string.IsNullOrEmpty(Scope))
{
existingAlias = SessionState.Internal.GetAlias(alias.Name);
}
else
{
existingAlias = SessionState.Internal.GetAliasAtScope(alias.Name, Scope);
}
if (existingAlias != null)
{
// Write an error for aliases that aren't visible...
try
{
SessionState.ThrowIfNotVisible(origin, existingAlias);
}
catch (SessionStateException sessionStateException)
{
WriteError(
new ErrorRecord(
sessionStateException.ErrorRecord,
sessionStateException));
// Only report the error once...
continue;
}
// Since the alias already exists, write an error.
SessionStateException aliasExists =
new(
alias.Name,
SessionStateCategory.Alias,
"AliasAlreadyExists",
SessionStateStrings.AliasAlreadyExists,
ErrorCategory.ResourceExists);
WriteError(
new ErrorRecord(
aliasExists.ErrorRecord,
aliasExists));
continue;
}
if (VerifyShadowingExistingCommandsAndWriteError(alias.Name))
{
continue;
}
}
// Set the alias in the specified scope or the
// current scope.
AliasInfo result = null;
try
{
if (string.IsNullOrEmpty(Scope))
{
result = SessionState.Internal.SetAliasItem(alias, Force, MyInvocation.CommandOrigin);
}
else
{
result = SessionState.Internal.SetAliasItemAtScope(alias, Scope, Force, MyInvocation.CommandOrigin);
}
}
catch (SessionStateException sessionStateException)
{
WriteError(
new ErrorRecord(
sessionStateException.ErrorRecord,
sessionStateException));
continue;
}
catch (PSArgumentOutOfRangeException argOutOfRange)
{
WriteError(
new ErrorRecord(
argOutOfRange.ErrorRecord,
argOutOfRange));
continue;
}
catch (PSArgumentException argException)
{
WriteError(
new ErrorRecord(
argException.ErrorRecord,
argException));
continue;
}
// Write the alias to the pipeline if PassThru was specified
if (PassThru && result != null)
{
WriteObject(result);
}
}
}
private Dictionary<string, CommandTypes> _existingCommands;
private Dictionary<string, CommandTypes> ExistingCommands
{
get
{
if (_existingCommands == null)
{
_existingCommands = new Dictionary<string, CommandTypes>(StringComparer.OrdinalIgnoreCase);
CommandSearcher searcher = new(
"*",
SearchResolutionOptions.CommandNameIsPattern | SearchResolutionOptions.ResolveAliasPatterns | SearchResolutionOptions.ResolveFunctionPatterns,
CommandTypes.All ^ CommandTypes.Alias,
this.Context);
foreach (CommandInfo commandInfo in searcher)
{
_existingCommands[commandInfo.Name] = commandInfo.CommandType;
}
// Also add commands from the analysis cache
foreach (CommandInfo commandInfo in System.Management.Automation.Internal.ModuleUtils.GetMatchingCommands("*", this.Context, this.MyInvocation.CommandOrigin))
{
if (!_existingCommands.ContainsKey(commandInfo.Name))
{
_existingCommands[commandInfo.Name] = commandInfo.CommandType;
}
}
}
return _existingCommands;
}
}
private bool VerifyShadowingExistingCommandsAndWriteError(string aliasName)
{
CommandSearcher searcher = new(aliasName, SearchResolutionOptions.None, CommandTypes.All ^ CommandTypes.Alias, this.Context);
foreach (string expandedCommandName in searcher.ConstructSearchPatternsFromName(aliasName))
{
CommandTypes commandTypeOfExistingCommand;
if (this.ExistingCommands.TryGetValue(expandedCommandName, out commandTypeOfExistingCommand))
{
// Since the alias already exists, write an error.
SessionStateException aliasExists =
new(
aliasName,
SessionStateCategory.Alias,
"AliasAlreadyExists",
SessionStateStrings.AliasWithCommandNameAlreadyExists,
ErrorCategory.ResourceExists,
commandTypeOfExistingCommand);
WriteError(
new ErrorRecord(
aliasExists.ErrorRecord,
aliasExists));
return true;
}
}
return false;
}
private Collection<AliasInfo> GetAliasesFromFile(bool isLiteralPath)
{
Collection<AliasInfo> result = new();
string filePath = null;
using (StreamReader reader = OpenFile(out filePath, isLiteralPath))
{
CSVHelper csvHelper = new(',');
long lineNumber = 0;
string line = null;
while ((line = reader.ReadLine()) != null)
{
++lineNumber;
// Ignore blank lines
if (line.Length == 0)
{
continue;
}
// Ignore lines that only contain whitespace
if (OnlyContainsWhitespace(line))
{
continue;
}
// Ignore comment lines
if (line[0] == '#')
{
continue;
}
Collection<string> values = csvHelper.ParseCsv(line);
if (values.Count != 4)
{
string message = StringUtil.Format(AliasCommandStrings.ImportAliasFileInvalidFormat, filePath, lineNumber);
FormatException formatException =
new(message);
ErrorRecord errorRecord =
new(
formatException,
"ImportAliasFileFormatError",
ErrorCategory.ReadError,
filePath);
errorRecord.ErrorDetails = new ErrorDetails(message);
ThrowTerminatingError(errorRecord);
}
ScopedItemOptions options = ScopedItemOptions.None;
try
{
options = (ScopedItemOptions)Enum.Parse(typeof(ScopedItemOptions), values[3], true);
}
catch (ArgumentException argException)
{
string message = StringUtil.Format(AliasCommandStrings.ImportAliasOptionsError, filePath, lineNumber);
ErrorRecord errorRecord =
new(
argException,
"ImportAliasOptionsError",
ErrorCategory.ReadError,
filePath);
errorRecord.ErrorDetails = new ErrorDetails(message);
WriteError(errorRecord);
continue;
}
AliasInfo newAlias =
new(
values[0],
values[1],
Context,
options);
if (!string.IsNullOrEmpty(values[2]))
{
newAlias.Description = values[2];
}
result.Add(newAlias);
}
reader.Dispose();
}
return result;
}
private StreamReader OpenFile(out string filePath, bool isLiteralPath)
{
StreamReader result = null;
filePath = null;
ProviderInfo provider = null;
Collection<string> paths = null;
if (isLiteralPath)
{
paths = new Collection<string>();
PSDriveInfo drive;
paths.Add(SessionState.Path.GetUnresolvedProviderPathFromPSPath(this.Path, out provider, out drive));
}
else
{
// first resolve the path
paths = SessionState.Path.GetResolvedProviderPathFromPSPath(this.Path, out provider);
}
// We can only export aliases to the file system
if (!provider.NameEquals(this.Context.ProviderNames.FileSystem))
{
throw
PSTraceSource.NewNotSupportedException(
AliasCommandStrings.ImportAliasFromFileSystemOnly,
this.Path,
provider.FullName);
}
// We can only write to a single file at a time.
if (paths.Count != 1)
{
throw
PSTraceSource.NewNotSupportedException(
AliasCommandStrings.ImportAliasPathResolvedToMultiple,
this.Path);
}
filePath = paths[0];
try
{
FileStream file = new(filePath, FileMode.Open, FileAccess.Read, FileShare.Read);
result = new StreamReader(file);
}
catch (IOException ioException)
{
ThrowFileOpenError(ioException, filePath);
}
catch (SecurityException securityException)
{
ThrowFileOpenError(securityException, filePath);
}
catch (UnauthorizedAccessException unauthorizedAccessException)
{
ThrowFileOpenError(unauthorizedAccessException, filePath);
}
return result;
}
private void ThrowFileOpenError(Exception e, string pathWithError)
{
string message =
StringUtil.Format(AliasCommandStrings.ImportAliasFileOpenFailed, pathWithError, e.Message);
ErrorRecord errorRecord = new(
e,
"FileOpenFailure",
ErrorCategory.OpenError,
pathWithError);
errorRecord.ErrorDetails = new ErrorDetails(message);
this.ThrowTerminatingError(errorRecord);
}
private static bool OnlyContainsWhitespace(string line)
{
bool result = true;
foreach (char c in line)
{
if (char.IsWhiteSpace(c) && c != '\n' && c != '\r')
{
continue;
}
result = false;
break;
}
return result;
}
#endregion Command code
}
}
|