File size: 9,551 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 | // Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System.IO;
using System.Management.Automation;
using System.Management.Automation.Internal;
using System.Text;
using Microsoft.PowerShell.Commands.Internal.Format;
namespace Microsoft.PowerShell.Commands
{
internal static class InputFileOpenModeConversion
{
internal static FileMode Convert(OpenMode openMode)
{
return SessionStateUtilities.GetFileModeFromOpenMode(openMode);
}
}
/// <summary>
/// Implementation for the out-file command.
/// </summary>
[Cmdlet(VerbsData.Out, "File", SupportsShouldProcess = true, DefaultParameterSetName = "ByPath", HelpUri = "https://go.microsoft.com/fwlink/?LinkID=2096621")]
public class OutFileCommand : FrontEndCommandBase
{
/// <summary>
/// Initializes a new instance of the <see cref="OutFileCommand"/> class
/// and sets the inner command.
/// </summary>
public OutFileCommand()
{
this.implementation = new OutputManagerInner();
}
#region Command Line Parameters
/// <summary>
/// Mandatory file name to write to.
/// </summary>
[Alias("Path")]
[Parameter(Mandatory = true, Position = 0, ParameterSetName = "ByPath")]
public string FilePath
{
get { return _fileName; }
set { _fileName = value; }
}
private string _fileName;
/// <summary>
/// Mandatory file name to write to.
/// </summary>
[Parameter(Mandatory = true, ValueFromPipelineByPropertyName = true, ParameterSetName = "ByLiteralPath")]
[Alias("PSPath", "LP")]
public string LiteralPath
{
get
{
return _fileName;
}
set
{
_fileName = value;
_isLiteralPath = true;
}
}
private bool _isLiteralPath = false;
/// <summary>
/// Encoding optional flag.
/// </summary>
[Parameter(Position = 1)]
[ArgumentToEncodingTransformation]
[ArgumentEncodingCompletions]
[ValidateNotNullOrEmpty]
public Encoding Encoding
{
get
{
return _encoding;
}
set
{
EncodingConversion.WarnIfObsolete(this, value);
_encoding = value;
}
}
private Encoding _encoding = Encoding.Default;
/// <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>
/// Optional, number of columns to use when writing to device.
/// </summary>
[ValidateRange(2, int.MaxValue)]
[Parameter]
public int Width
{
get { return (_width != null) ? _width.Value : 0; }
set { _width = value; }
}
private int? _width = null;
/// <summary>
/// False to add a newline to the end of the output string, true if not.
/// </summary>
[Parameter]
public SwitchParameter NoNewline
{
get
{
return _suppressNewline;
}
set
{
_suppressNewline = value;
}
}
private bool _suppressNewline = false;
#endregion
/// <summary>
/// Read command line parameters.
/// </summary>
protected override void BeginProcessing()
{
// set up the Screen Host interface
OutputManagerInner outInner = (OutputManagerInner)this.implementation;
// NOTICE: if any exception is thrown from here to the end of the method, the
// cleanup code will be called in IDisposable.Dispose()
outInner.LineOutput = InstantiateLineOutputInterface();
if (_sw == null)
{
return;
}
// finally call the base class for general hookup
base.BeginProcessing();
}
/// <summary>
/// One-time initialization: acquire a screen host interface
/// by creating one on top of a file.
/// NOTICE: we assume that at this time the file name is
/// available in the CRO. JonN recommends: file name has to be
/// a MANDATORY parameter on the command line.
/// </summary>
private LineOutput InstantiateLineOutputInterface()
{
string action = StringUtil.Format(FormatAndOut_out_xxx.OutFile_Action);
if (ShouldProcess(FilePath, action))
{
PathUtils.MasterStreamOpen(
this,
FilePath,
Encoding,
false, // defaultEncoding
Append,
Force,
NoClobber,
out _fs,
out _sw,
out _readOnlyFileInfo,
_isLiteralPath
);
}
else
return null;
// compute the # of columns available
int computedWidth = int.MaxValue;
if (_width != null)
{
// use the value from the command line
computedWidth = _width.Value;
}
// use the stream writer to create and initialize the Line Output writer
TextWriterLineOutput twlo = new(_sw, computedWidth, _suppressNewline);
// finally have the ILineOutput interface extracted
return (LineOutput)twlo;
}
/// <summary>
/// Execution entry point.
/// </summary>
protected override void ProcessRecord()
{
_processRecordExecuted = true;
if (_sw == null)
{
return;
}
// NOTICE: if any exception is thrown, the
// cleanup code will be called in IDisposable.Dispose()
base.ProcessRecord();
_sw.Flush();
}
/// <summary>
/// Execution entry point.
/// </summary>
protected override void EndProcessing()
{
// When the Out-File is used in a redirection pipelineProcessor,
// its ProcessRecord method may not be called when nothing is written to the
// output pipe, for example:
// Write-Error error > test.txt
// In this case, the EndProcess method should return immediately as if it's
// never been called. The cleanup work will be done in IDisposable.Dispose()
if (!_processRecordExecuted)
{
return;
}
if (_sw == null)
{
return;
}
// NOTICE: if any exception is thrown, the
// cleanup code will be called in IDisposable.Dispose()
base.EndProcessing();
_sw.Flush();
CleanUp();
}
/// <summary>
/// InternalDispose.
/// </summary>
protected override void InternalDispose()
{
base.InternalDispose();
CleanUp();
}
private void CleanUp()
{
if (_fs != null)
{
_fs.Dispose();
_fs = null;
}
// reset the read-only attribute
if (_readOnlyFileInfo != null)
{
_readOnlyFileInfo.Attributes |= FileAttributes.ReadOnly;
_readOnlyFileInfo = null;
}
}
/// <summary>
/// Handle to file stream.
/// </summary>
private FileStream _fs;
/// <summary>
/// Stream writer used to write to file.
/// </summary>
private StreamWriter _sw = null;
/// <summary>
/// Indicate whether the ProcessRecord method was executed.
/// When the Out-File is used in a redirection pipelineProcessor,
/// its ProcessRecord method may not be called when nothing is written to the
/// output pipe, for example:
/// Write-Error error > test.txt
/// In this case, the EndProcess method should return immediately as if it's
/// never been called.
/// </summary>
private bool _processRecordExecuted = false;
/// <summary>
/// FileInfo of file to clear read-only flag when operation is complete.
/// </summary>
private FileInfo _readOnlyFileInfo = null;
}
}
|