File size: 12,568 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 | // 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;
namespace Microsoft.PowerShell.Commands
{
/// <summary>
/// The formats that export-alias supports.
/// </summary>
public enum ExportAliasFormat
{
/// <summary>
/// Aliases will be exported to a CSV file.
/// </summary>
Csv,
/// <summary>
/// Aliases will be exported as a script.
/// </summary>
Script
}
/// <summary>
/// The implementation of the "export-alias" cmdlet.
/// </summary>
[Cmdlet(VerbsData.Export, "Alias", SupportsShouldProcess = true, DefaultParameterSetName = "ByPath", HelpUri = "https://go.microsoft.com/fwlink/?LinkID=2096597")]
[OutputType(typeof(AliasInfo))]
public class ExportAliasCommand : PSCmdlet
{
#region Parameters
/// <summary>
/// The Path of the file to export the aliases to.
/// </summary>
[Parameter(Mandatory = true, Position = 0, ParameterSetName = "ByPath")]
public string Path
{
get { return _path; }
set { _path = value ?? "."; }
}
private string _path = ".";
/// <summary>
/// The literal path of the file to export the aliases to.
/// </summary>
[Parameter(Mandatory = true, ValueFromPipelineByPropertyName = true, ParameterSetName = "ByLiteralPath")]
[Alias("PSPath", "LP")]
public string LiteralPath
{
get
{
return _path;
}
set
{
if (value == null)
{
_path = ".";
}
else
{
_path = value;
_isLiteralPath = true;
}
}
}
private bool _isLiteralPath = false;
/// <summary>
/// The Name parameter for the command.
/// </summary>
[Parameter(Position = 1, ValueFromPipelineByPropertyName = true)]
public string[] Name
{
get { return _names; }
set { _names = value ?? new string[] { "*" }; }
}
private string[] _names = new string[] { "*" };
/// <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>
/// Parameter that determines the format of the file created.
/// </summary>
[Parameter]
public ExportAliasFormat As { get; set; } = ExportAliasFormat.Csv;
/// <summary>
/// Property that sets append parameter.
/// </summary>
[Parameter]
public SwitchParameter Append
{
get
{
return _append;
}
set
{
_append = value;
}
}
private bool _append;
/// <summary>
/// Property that sets force parameter.
/// </summary>
[Parameter]
public SwitchParameter Force
{
get
{
return _force;
}
set
{
_force = value;
}
}
private bool _force;
/// <summary>
/// Property that prevents file overwrite.
/// </summary>
[Parameter]
[Alias("NoOverwrite")]
public SwitchParameter NoClobber
{
get
{
return _noclobber;
}
set
{
_noclobber = value;
}
}
private bool _noclobber;
/// <summary>
/// The description that gets added to the file as a comment.
/// </summary>
/// <value></value>
[Parameter]
public string Description { get; set; }
/// <summary>
/// The scope parameter for the command determines
/// which scope the aliases are retrieved from.
/// </summary>
[Parameter]
[ArgumentCompleter(typeof(ScopeArgumentCompleter))]
public string Scope { get; set; }
#endregion Parameters
#region Command code
/// <summary>
/// The main processing loop of the command.
/// </summary>
protected override void ProcessRecord()
{
// First get the alias table (from the proper scope if necessary)
IDictionary<string, AliasInfo> aliasTable = null;
if (!string.IsNullOrEmpty(Scope))
{
// This can throw PSArgumentException and PSArgumentOutOfRangeException
// but just let them go as this is terminal for the pipeline and the
// exceptions are already properly adorned with an ErrorRecord.
aliasTable = SessionState.Internal.GetAliasTableAtScope(Scope);
}
else
{
aliasTable = SessionState.Internal.GetAliasTable();
}
foreach (string aliasName in _names)
{
bool resultFound = false;
// Create the name pattern
WildcardPattern namePattern =
WildcardPattern.Get(
aliasName,
WildcardOptions.IgnoreCase);
// Now loop through the table and write out any aliases that
// match the name and don't match the exclude filters and are
// visible to the caller...
CommandOrigin origin = MyInvocation.CommandOrigin;
foreach (KeyValuePair<string, AliasInfo> tableEntry in aliasTable)
{
if (!namePattern.IsMatch(tableEntry.Key))
{
continue;
}
if (SessionState.IsVisible(origin, tableEntry.Value))
{
resultFound = true;
_matchingAliases.Add(tableEntry.Value);
}
}
if (!resultFound &&
!WildcardPattern.ContainsWildcardCharacters(aliasName))
{
// Need to write an error if the user tries to get an alias
// that doesn't exist and they are not globbing.
ItemNotFoundException itemNotFound =
new(
aliasName,
"AliasNotFound",
SessionStateStrings.AliasNotFound);
WriteError(
new ErrorRecord(
itemNotFound.ErrorRecord,
itemNotFound));
}
}
}
/// <summary>
/// Writes the aliases to the file.
/// </summary>
protected override void EndProcessing()
{
StreamWriter writer = null;
FileInfo readOnlyFileInfo = null;
try
{
if (ShouldProcess(Path))
{
writer = OpenFile(out readOnlyFileInfo);
}
if (writer != null)
WriteHeader(writer);
// Now write out the aliases
foreach (AliasInfo alias in _matchingAliases)
{
string line = null;
if (this.As == ExportAliasFormat.Csv)
{
line = GetAliasLine(alias, "\"{0}\",\"{1}\",\"{2}\",\"{3}\"");
}
else
{
line = GetAliasLine(alias, "set-alias -Name:\"{0}\" -Value:\"{1}\" -Description:\"{2}\" -Option:\"{3}\"");
}
writer?.WriteLine(line);
if (PassThru)
{
WriteObject(alias);
}
}
}
finally
{
writer?.Dispose();
// reset the read-only attribute
if (readOnlyFileInfo != null)
readOnlyFileInfo.Attributes |= FileAttributes.ReadOnly;
}
}
/// <summary>
/// Holds all the matching aliases for writing to the file.
/// </summary>
private readonly Collection<AliasInfo> _matchingAliases = new();
private static string GetAliasLine(AliasInfo alias, string formatString)
{
// Using the invariant culture here because we don't want the
// file to vary based on locale.
string result =
string.Format(
System.Globalization.CultureInfo.InvariantCulture,
formatString,
alias.Name,
alias.Definition,
alias.Description,
alias.Options);
return result;
}
private void WriteHeader(StreamWriter writer)
{
WriteFormattedResourceString(writer, AliasCommandStrings.ExportAliasHeaderTitle);
string user = Environment.UserName;
WriteFormattedResourceString(writer, AliasCommandStrings.ExportAliasHeaderUser, user);
DateTime now = DateTime.Now;
WriteFormattedResourceString(writer, AliasCommandStrings.ExportAliasHeaderDate, now);
string machine = Environment.MachineName;
WriteFormattedResourceString(writer, AliasCommandStrings.ExportAliasHeaderMachine, machine);
// Now write the description if there is one
if (Description != null)
{
// First we need to break up the description on newlines and add a
// # for each line.
Description = Description.Replace("\n", "\n# ");
// Now write out the description
writer.WriteLine("#");
writer.Write("# ");
writer.WriteLine(Description);
}
}
private static void WriteFormattedResourceString(
StreamWriter writer,
string resourceId,
params object[] args)
{
string line = StringUtil.Format(resourceId, args);
writer.Write("# ");
writer.WriteLine(line);
}
/// <summary>
/// Open the file to which aliases should be exported.
/// </summary>
/// <param name="readOnlyFileInfo">
/// If not null, this is the file whose read-only attribute
/// was cleared (due to the -Force parameter). The attribute
/// should be reset.
/// </param>
/// <returns></returns>
private StreamWriter OpenFile(out FileInfo readOnlyFileInfo)
{
StreamWriter result = null;
FileStream file = null;
readOnlyFileInfo = null;
PathUtils.MasterStreamOpen(
this,
this.Path,
EncodingConversion.Unicode,
false, // defaultEncoding
Append,
Force,
NoClobber,
out file,
out result,
out readOnlyFileInfo,
_isLiteralPath
);
return result;
}
private void ThrowFileOpenError(Exception e, string pathWithError)
{
string message = StringUtil.Format(AliasCommandStrings.ExportAliasFileOpenFailed, pathWithError, e.Message);
ErrorRecord errorRecord = new(
e,
"FileOpenFailure",
ErrorCategory.OpenError,
pathWithError);
errorRecord.ErrorDetails = new ErrorDetails(message);
this.ThrowTerminatingError(errorRecord);
}
#endregion Command code
}
}
|