File size: 11,602 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 | // Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System.Management.Automation;
using Dbg = System.Management.Automation;
namespace Microsoft.PowerShell.Commands
{
/// <summary>
/// The get-childitem command class.
/// This command lists the contents of a container.
/// </summary>
/// <remarks>
/// </remarks>
[Cmdlet(VerbsCommon.Get, "ChildItem", DefaultParameterSetName = "Items", SupportsTransactions = true, HelpUri = "https://go.microsoft.com/fwlink/?LinkID=2096492")]
public class GetChildItemCommand : CoreCommandBase
{
/// <summary>
/// The string declaration for the Items parameter set in this command.
/// </summary>
/// <remarks>
/// The "Items" parameter set includes the following parameters:
/// -filter
/// -recurse
/// </remarks>
private const string childrenSet = "Items";
private const string literalChildrenSet = "LiteralItems";
#region Command parameters
/// <summary>
/// Gets or sets the path for the operation.
/// </summary>
[Parameter(Position = 0, ParameterSetName = childrenSet,
ValueFromPipeline = true, ValueFromPipelineByPropertyName = true)]
public string[] Path
{
get
{
return _paths;
}
set
{
_paths = value;
}
}
/// <summary>
/// Gets or sets the literal path parameter to the command.
/// </summary>
[Parameter(ParameterSetName = literalChildrenSet,
Mandatory = true, ValueFromPipeline = false, ValueFromPipelineByPropertyName = true)]
[Alias("PSPath", "LP")]
public string[] LiteralPath
{
get
{
return _paths;
}
set
{
base.SuppressWildcardExpansion = true;
_paths = value;
}
}
/// <summary>
/// Gets or sets the filter property.
/// </summary>
[Parameter(Position = 1)]
public override string Filter
{
get
{
return base.Filter;
}
set
{
base.Filter = value;
}
}
/// <summary>
/// Gets or sets the include property.
/// </summary>
[Parameter]
public override string[] Include
{
get
{
return base.Include;
}
set
{
base.Include = value;
}
}
/// <summary>
/// Gets or sets the exclude property.
/// </summary>
[Parameter]
public override string[] Exclude
{
get
{
return base.Exclude;
}
set
{
base.Exclude = value;
}
}
/// <summary>
/// Gets or sets the recurse switch.
/// </summary>
[Parameter]
[Alias("s", "r")]
public SwitchParameter Recurse
{
get
{
return _recurse;
}
set
{
_recurse = value;
}
}
/// <summary>
/// Gets or sets max depth of recursion; automatically sets Recurse parameter;
/// Value '0' will show only contents of container specified by -Path (same result as running 'Get-ChildItem' without '-Recurse');
/// Value '1' will show 1 level deep, etc...;
/// Default is uint.MaxValue - it performs full recursion (this parameter has no effect).
/// </summary>
[Parameter]
public uint Depth
{
get
{
return _depth;
}
set
{
_depth = value;
this.Recurse = true; // Bug 2391925 - Get-ChildItem -Depth should auto-set -Recurse
}
}
/// <summary>
/// Gets or sets the force property.
/// </summary>
/// <remarks>
/// Gives the provider guidance on how vigorous it should be about performing
/// the operation. If true, the provider should do everything possible to perform
/// the operation. If false, the provider should attempt the operation but allow
/// even simple errors to terminate the operation.
/// For example, if the user tries to copy a file to a path that already exists and
/// the destination is read-only, if force is true, the provider should copy over
/// the existing read-only file. If force is false, the provider should write an error.
/// </remarks>
[Parameter]
public override SwitchParameter Force
{
get
{
return base.Force;
}
set
{
base.Force = value;
}
}
/// <summary>
/// Gets or sets the names switch.
/// </summary>
[Parameter]
public SwitchParameter Name
{
get
{
return _childNames;
}
set
{
_childNames = value;
}
}
/// <summary>
/// A virtual method for retrieving the dynamic parameters for a cmdlet. Derived cmdlets
/// that require dynamic parameters should override this method and return the
/// dynamic parameter object.
/// </summary>
/// <param name="context">
/// The context under which the command is running.
/// </param>
/// <returns>
/// An object representing the dynamic parameters for the cmdlet or null if there
/// are none.
/// </returns>
internal override object GetDynamicParameters(CmdletProviderContext context)
{
object result = null;
string path = string.Empty;
if (_paths != null && _paths.Length > 0)
{
path = _paths[0];
}
else
{
path = ".";
}
switch (ParameterSetName)
{
case childrenSet:
case literalChildrenSet:
if (Name)
{
result = InvokeProvider.ChildItem.GetChildNamesDynamicParameters(path, context);
}
else
{
result = InvokeProvider.ChildItem.GetChildItemsDynamicParameters(path, Recurse, context);
}
break;
default:
result = InvokeProvider.ChildItem.GetChildItemsDynamicParameters(path, Recurse, context);
break;
}
return result;
}
#endregion Command parameters
#region command data
/// <summary>
/// The path for the get-location operation.
/// </summary>
private string[] _paths;
/// <summary>
/// Determines if the command should do recursion.
/// </summary>
private bool _recurse;
/// <summary>
/// Limits the depth of recursion; used with Recurse parameter;
/// Value '0' will show only contents of container specified by -Path (same result as running 'Get-ChildItem' without '-Recurse');
/// Value '1' will show 1 level deep, etc...;
/// Default is uint.MaxValue - it performs full recursion (this parameter has no effect).
/// </summary>
private uint _depth = uint.MaxValue;
/// <summary>
/// The flag that specifies whether to retrieve the child names or the child items.
/// </summary>
private bool _childNames = false;
#endregion command data
#region command code
/// <summary>
/// The main execution method for the get-childitem command.
/// </summary>
protected override void ProcessRecord()
{
CmdletProviderContext currentContext = CmdletProviderContext;
if (_paths == null || _paths.Length == 0)
{
_paths = new string[] { string.Empty };
}
foreach (string path in _paths)
{
switch (ParameterSetName)
{
case childrenSet:
case literalChildrenSet:
try
{
if (Name)
{
// Get the names of the child items using the static namespace method.
// The child names should be written directly to the pipeline using the
// context.WriteObject method.
InvokeProvider.ChildItem.GetNames(path, ReturnContainers.ReturnMatchingContainers, Recurse, Depth, currentContext);
}
else
{
// Get the children using the static namespace method.
// The children should be written directly to the pipeline using
// the context.WriteObject method.
InvokeProvider.ChildItem.Get(path, Recurse, Depth, currentContext);
}
}
catch (PSNotSupportedException notSupported)
{
WriteError(
new ErrorRecord(
notSupported.ErrorRecord,
notSupported));
continue;
}
catch (DriveNotFoundException driveNotFound)
{
WriteError(
new ErrorRecord(
driveNotFound.ErrorRecord,
driveNotFound));
continue;
}
catch (ProviderNotFoundException providerNotFound)
{
WriteError(
new ErrorRecord(
providerNotFound.ErrorRecord,
providerNotFound));
continue;
}
catch (ItemNotFoundException pathNotFound)
{
WriteError(
new ErrorRecord(
pathNotFound.ErrorRecord,
pathNotFound));
continue;
}
break;
default:
Dbg.Diagnostics.Assert(
false,
"Only one of the specified parameter sets should be called.");
break;
}
}
}
#endregion command code
}
}
|