File size: 12,504 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 | // Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.Management.Automation;
namespace Microsoft.PowerShell.Commands
{
/// <summary>
/// Cmdlet to get available list of results.
/// </summary>
[Cmdlet(VerbsCommon.Get, "Job", DefaultParameterSetName = JobCmdletBase.SessionIdParameterSet, HelpUri = "https://go.microsoft.com/fwlink/?LinkID=2096582")]
[OutputType(typeof(Job))]
public class GetJobCommand : JobCmdletBase
{
#region Parameters
/// <summary>
/// IncludeChildJob parameter.
/// </summary>
[Parameter(ParameterSetName = JobCmdletBase.SessionIdParameterSet)]
[Parameter(ParameterSetName = JobCmdletBase.InstanceIdParameterSet)]
[Parameter(ParameterSetName = JobCmdletBase.NameParameterSet)]
[Parameter(ParameterSetName = JobCmdletBase.StateParameterSet)]
[Parameter(ParameterSetName = JobCmdletBase.CommandParameterSet)]
public SwitchParameter IncludeChildJob { get; set; }
/// <summary>
/// ChildJobState parameter.
/// </summary>
[Parameter(ParameterSetName = JobCmdletBase.SessionIdParameterSet)]
[Parameter(ParameterSetName = JobCmdletBase.InstanceIdParameterSet)]
[Parameter(ParameterSetName = JobCmdletBase.NameParameterSet)]
[Parameter(ParameterSetName = JobCmdletBase.StateParameterSet)]
[Parameter(ParameterSetName = JobCmdletBase.CommandParameterSet)]
public JobState ChildJobState { get; set; }
/// <summary>
/// HasMoreData parameter.
/// </summary>
[Parameter(ParameterSetName = JobCmdletBase.SessionIdParameterSet)]
[Parameter(ParameterSetName = JobCmdletBase.InstanceIdParameterSet)]
[Parameter(ParameterSetName = JobCmdletBase.NameParameterSet)]
[Parameter(ParameterSetName = JobCmdletBase.StateParameterSet)]
[Parameter(ParameterSetName = JobCmdletBase.CommandParameterSet)]
public bool HasMoreData { get; set; }
/// <summary>
/// Before time filter.
/// </summary>
[Parameter(ParameterSetName = JobCmdletBase.SessionIdParameterSet)]
[Parameter(ParameterSetName = JobCmdletBase.InstanceIdParameterSet)]
[Parameter(ParameterSetName = JobCmdletBase.NameParameterSet)]
[Parameter(ParameterSetName = JobCmdletBase.StateParameterSet)]
[Parameter(ParameterSetName = JobCmdletBase.CommandParameterSet)]
public DateTime Before { get; set; }
/// <summary>
/// After time filter.
/// </summary>
[Parameter(ParameterSetName = JobCmdletBase.SessionIdParameterSet)]
[Parameter(ParameterSetName = JobCmdletBase.InstanceIdParameterSet)]
[Parameter(ParameterSetName = JobCmdletBase.NameParameterSet)]
[Parameter(ParameterSetName = JobCmdletBase.StateParameterSet)]
[Parameter(ParameterSetName = JobCmdletBase.CommandParameterSet)]
public DateTime After { get; set; }
/// <summary>
/// Newest returned count.
/// </summary>
[Parameter(ParameterSetName = JobCmdletBase.SessionIdParameterSet)]
[Parameter(ParameterSetName = JobCmdletBase.InstanceIdParameterSet)]
[Parameter(ParameterSetName = JobCmdletBase.NameParameterSet)]
[Parameter(ParameterSetName = JobCmdletBase.StateParameterSet)]
[Parameter(ParameterSetName = JobCmdletBase.CommandParameterSet)]
public int Newest { get; set; }
/// <summary>
/// SessionId for which job
/// need to be obtained.
/// </summary>
[Parameter(ValueFromPipelineByPropertyName = true, Position = 0,
ParameterSetName = JobCmdletBase.SessionIdParameterSet)]
[ValidateNotNullOrEmpty]
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
public override int[] Id
{
get
{
return base.Id;
}
set
{
base.Id = value;
}
}
#endregion Parameters
#region Overrides
/// <summary>
/// Extract result objects corresponding to the specified
/// names or expressions.
/// </summary>
protected override void ProcessRecord()
{
List<Job> jobList = FindJobs();
jobList.Sort(static (x, y) => x != null ? x.Id.CompareTo(y != null ? y.Id : 1) : -1);
WriteObject(jobList, true);
}
#endregion Overrides
#region Protected Members
/// <summary>
/// Helper method to find jobs based on parameter set.
/// </summary>
/// <returns>Matching jobs.</returns>
protected List<Job> FindJobs()
{
List<Job> jobList = new List<Job>();
switch (ParameterSetName)
{
case NameParameterSet:
{
jobList.AddRange(FindJobsMatchingByName(true, false, true, false));
}
break;
case InstanceIdParameterSet:
{
jobList.AddRange(FindJobsMatchingByInstanceId(true, false, true, false));
}
break;
case SessionIdParameterSet:
{
if (Id != null)
{
jobList.AddRange(FindJobsMatchingBySessionId(true, false, true, false));
}
else
{
// Get-Job with no filter.
jobList.AddRange(JobRepository.Jobs);
jobList.AddRange(JobManager.GetJobs(this, true, false, null));
}
}
break;
case CommandParameterSet:
{
jobList.AddRange(FindJobsMatchingByCommand(false));
}
break;
case StateParameterSet:
{
jobList.AddRange(FindJobsMatchingByState(false));
}
break;
case FilterParameterSet:
{
jobList.AddRange(FindJobsMatchingByFilter(false));
}
break;
default:
break;
}
jobList.AddRange(FindChildJobs(jobList));
jobList = ApplyHasMoreDataFiltering(jobList);
return ApplyTimeFiltering(jobList);
}
#endregion
#region Private Members
/// <summary>
/// Filter jobs based on HasMoreData.
/// </summary>
/// <param name="jobList"></param>
/// <returns>Return the list of jobs after applying HasMoreData filter.</returns>
private List<Job> ApplyHasMoreDataFiltering(List<Job> jobList)
{
bool hasMoreDataParameter = MyInvocation.BoundParameters.ContainsKey(nameof(HasMoreData));
if (!hasMoreDataParameter)
{
return jobList;
}
List<Job> matches = new List<Job>();
foreach (Job job in jobList)
{
if (job.HasMoreData == HasMoreData)
{
matches.Add(job);
}
}
return matches;
}
/// <summary>
/// Find the all child jobs with specified ChildJobState in the job list.
/// </summary>
/// <param name="jobList"></param>
/// <returns>Returns job list including all child jobs with ChildJobState or all if IncludeChildJob is specified.</returns>
private List<Job> FindChildJobs(List<Job> jobList)
{
bool childJobStateParameter = MyInvocation.BoundParameters.ContainsKey(nameof(ChildJobState));
bool includeChildJobParameter = MyInvocation.BoundParameters.ContainsKey(nameof(IncludeChildJob));
List<Job> matches = new List<Job>();
if (!childJobStateParameter && !includeChildJobParameter)
{
return matches;
}
// add all child jobs if ChildJobState is not specified
//
if (!childJobStateParameter && includeChildJobParameter)
{
foreach (Job job in jobList)
{
if (job.ChildJobs != null && job.ChildJobs.Count > 0)
{
matches.AddRange(job.ChildJobs);
}
}
}
else
{
foreach (Job job in jobList)
{
foreach (Job childJob in job.ChildJobs)
{
if (childJob.JobStateInfo.State != ChildJobState)
{
continue;
}
matches.Add(childJob);
}
}
}
return matches;
}
/// <summary>
/// Applys the appropriate time filter to each job in the job list.
/// Only Job2 type jobs can be time filtered so older Job types are skipped.
/// </summary>
/// <param name="jobList"></param>
/// <returns></returns>
private List<Job> ApplyTimeFiltering(List<Job> jobList)
{
bool beforeParameter = MyInvocation.BoundParameters.ContainsKey(nameof(Before));
bool afterParameter = MyInvocation.BoundParameters.ContainsKey(nameof(After));
bool newestParameter = MyInvocation.BoundParameters.ContainsKey(nameof(Newest));
if (!beforeParameter && !afterParameter && !newestParameter)
{
return jobList;
}
// Apply filtering.
List<Job> filteredJobs;
if (beforeParameter || afterParameter)
{
filteredJobs = new List<Job>();
foreach (Job job in jobList)
{
if (job.PSEndTime == DateTime.MinValue)
{
// Skip invalid dates.
continue;
}
if (beforeParameter && afterParameter)
{
if (job.PSEndTime < Before &&
job.PSEndTime > After)
{
filteredJobs.Add(job);
}
}
else if ((beforeParameter &&
job.PSEndTime < Before) ||
(afterParameter &&
job.PSEndTime > After))
{
filteredJobs.Add(job);
}
}
}
else
{
filteredJobs = jobList;
}
if (!newestParameter ||
filteredJobs.Count == 0)
{
return filteredJobs;
}
//
// Apply Newest count.
//
// Sort filtered jobs
filteredJobs.Sort((firstJob, secondJob) =>
{
if (firstJob.PSEndTime > secondJob.PSEndTime)
{
return -1;
}
else if (firstJob.PSEndTime < secondJob.PSEndTime)
{
return 1;
}
else
{
return 0;
}
});
List<Job> newestJobs = new List<Job>();
int count = 0;
foreach (Job job in filteredJobs)
{
if (++count > Newest)
{
break;
}
if (!newestJobs.Contains(job))
{
newestJobs.Add(job);
}
}
return newestJobs;
}
#endregion Private Members
}
}
|