File size: 17,356 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 486 487 488 489 490 | // Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System;
using System.Collections;
using System.Collections.Generic;
using System.Management.Automation;
using Microsoft.PowerShell.Commands.Internal.Format;
namespace Microsoft.PowerShell.Commands
{
/// <summary>
/// </summary>
[Cmdlet(VerbsData.Compare, "Object", HelpUri = "https://go.microsoft.com/fwlink/?LinkID=2096605",
RemotingCapability = RemotingCapability.None)]
public sealed class CompareObjectCommand : ObjectCmdletBase
{
#region Parameters
/// <summary>
/// </summary>
[Parameter(Position = 0, Mandatory = true)]
[AllowEmptyCollection]
public PSObject[] ReferenceObject { get; set; }
/// <summary>
/// </summary>
[Parameter(Position = 1, Mandatory = true, ValueFromPipeline = true)]
[AllowEmptyCollection]
public PSObject[] DifferenceObject { get; set; }
/// <summary>
/// </summary>
[Parameter]
[ValidateRange(0, int.MaxValue)]
public int SyncWindow { get; set; } = int.MaxValue;
/// <summary>
/// </summary>
/// <value></value>
[Parameter]
public object[] Property { get; set; }
/* not implemented
/// <summary>
/// </summary>
[Parameter]
public SwitchParameter IgnoreWhiteSpace
{
get { return _ignoreWhiteSpace; }
set { _ignoreWhiteSpace = value; }
}
private bool _ignoreWhiteSpace = false;
*/
/// <summary>
/// </summary>
[Parameter]
public SwitchParameter ExcludeDifferent
{
get { return _excludeDifferent; }
set { _excludeDifferent = value; }
}
private bool _excludeDifferent /*=false*/;
/// <summary>
/// </summary>
[Parameter]
public SwitchParameter IncludeEqual
{
get
{
return _includeEqual;
}
set
{
_isIncludeEqualSpecified = true;
_includeEqual = value;
}
}
private bool _includeEqual /* = false */;
private bool _isIncludeEqualSpecified /* = false */;
/// <summary>
/// </summary>
[Parameter]
public SwitchParameter PassThru
{
get { return _passThru; }
set { _passThru = value; }
}
private bool _passThru /* = false */;
#endregion Parameters
#region Internal
private List<OrderByPropertyEntry> _referenceEntries;
private readonly List<OrderByPropertyEntry> _referenceEntryBacklog
= new();
private readonly List<OrderByPropertyEntry> _differenceEntryBacklog
= new();
private OrderByProperty _orderByProperty = null;
private OrderByPropertyComparer _comparer = null;
private int _referenceObjectIndex /* = 0 */;
// These are programmatic strings, not subject to INTL
private const string SideIndicatorPropertyName = "SideIndicator";
private const string SideIndicatorMatch = "==";
private const string SideIndicatorReference = "<=";
private const string SideIndicatorDifference = "=>";
private const string InputObjectPropertyName = "InputObject";
/// <summary>
/// The following is the matching algorithm:
/// Retrieve the incoming object (differenceEntry) if any
/// Retrieve the next reference object (referenceEntry) if any
/// If differenceEntry matches referenceEntry
/// Emit referenceEntry as a match
/// Return
/// If differenceEntry matches any entry in referenceEntryBacklog
/// Emit the backlog entry as a match
/// Remove the backlog entry from referenceEntryBacklog
/// Clear differenceEntry
/// If referenceEntry (if any) matches any entry in differenceEntryBacklog
/// Emit referenceEntry as a match
/// Remove the backlog entry from differenceEntryBacklog
/// Clear referenceEntry
/// If differenceEntry is still present
/// If SyncWindow is 0
/// Emit differenceEntry as unmatched
/// Else
/// While there is no space in differenceEntryBacklog
/// Emit oldest entry in differenceEntryBacklog as unmatched
/// Remove oldest entry from differenceEntryBacklog
/// Add differenceEntry to differenceEntryBacklog
/// If referenceEntry is still present
/// If SyncWindow is 0
/// Emit referenceEntry as unmatched
/// Else
/// While there is no space in referenceEntryBacklog
/// Emit oldest entry in referenceEntryBacklog as unmatched
/// Remove oldest entry from referenceEntryBacklog
/// Add referenceEntry to referenceEntryBacklog.
/// </summary>
/// <param name="differenceEntry"></param>
private void Process(OrderByPropertyEntry differenceEntry)
{
Diagnostics.Assert(_referenceEntries != null, "null referenceEntries");
// Retrieve the next reference object (referenceEntry) if any
OrderByPropertyEntry referenceEntry = null;
if (_referenceObjectIndex < _referenceEntries.Count)
{
referenceEntry = _referenceEntries[_referenceObjectIndex++];
}
// If differenceEntry matches referenceEntry
// Emit referenceEntry as a match
// Return
// 2005/07/19 Switched order of referenceEntry and differenceEntry
// so that we cast differenceEntry to the type of referenceEntry.
if (referenceEntry != null && differenceEntry != null &&
_comparer.Compare(referenceEntry, differenceEntry) == 0)
{
EmitMatch(referenceEntry);
return;
}
// If differenceEntry matches any entry in referenceEntryBacklog
// Emit the backlog entry as a match
// Remove the backlog entry from referenceEntryBacklog
// Clear differenceEntry
OrderByPropertyEntry matchingEntry =
MatchAndRemove(differenceEntry, _referenceEntryBacklog);
if (matchingEntry != null)
{
EmitMatch(matchingEntry);
differenceEntry = null;
}
// If referenceEntry (if any) matches any entry in differenceEntryBacklog
// Emit referenceEntry as a match
// Remove the backlog entry from differenceEntryBacklog
// Clear referenceEntry
matchingEntry =
MatchAndRemove(referenceEntry, _differenceEntryBacklog);
if (matchingEntry != null)
{
EmitMatch(referenceEntry);
referenceEntry = null;
}
// If differenceEntry is still present
// If SyncWindow is 0
// Emit differenceEntry as unmatched
// Else
// While there is no space in differenceEntryBacklog
// Emit oldest entry in differenceEntryBacklog as unmatched
// Remove oldest entry from differenceEntryBacklog
// Add differenceEntry to differenceEntryBacklog
if (differenceEntry != null)
{
if (SyncWindow > 0)
{
while (_differenceEntryBacklog.Count >= SyncWindow)
{
EmitDifferenceOnly(_differenceEntryBacklog[0]);
_differenceEntryBacklog.RemoveAt(0);
}
_differenceEntryBacklog.Add(differenceEntry);
}
else
{
EmitDifferenceOnly(differenceEntry);
}
}
// If referenceEntry is still present
// If SyncWindow is 0
// Emit referenceEntry as unmatched
// Else
// While there is no space in referenceEntryBacklog
// Emit oldest entry in referenceEntryBacklog as unmatched
// Remove oldest entry from referenceEntryBacklog
// Add referenceEntry to referenceEntryBacklog
if (referenceEntry != null)
{
if (SyncWindow > 0)
{
while (_referenceEntryBacklog.Count >= SyncWindow)
{
EmitReferenceOnly(_referenceEntryBacklog[0]);
_referenceEntryBacklog.RemoveAt(0);
}
_referenceEntryBacklog.Add(referenceEntry);
}
else
{
EmitReferenceOnly(referenceEntry);
}
}
}
private void InitComparer()
{
if (_comparer != null)
return;
List<PSObject> referenceObjectList = new(ReferenceObject);
_orderByProperty = new OrderByProperty(
this, referenceObjectList, Property, true, _cultureInfo, CaseSensitive);
Diagnostics.Assert(_orderByProperty.Comparer != null, "no comparer");
Diagnostics.Assert(
_orderByProperty.OrderMatrix != null &&
_orderByProperty.OrderMatrix.Count == ReferenceObject.Length,
"no OrderMatrix");
if (_orderByProperty.Comparer == null || _orderByProperty.OrderMatrix == null || _orderByProperty.OrderMatrix.Count == 0)
{
return;
}
_comparer = _orderByProperty.Comparer;
_referenceEntries = _orderByProperty.OrderMatrix;
}
private OrderByPropertyEntry MatchAndRemove(
OrderByPropertyEntry match,
List<OrderByPropertyEntry> list)
{
if (match == null || list == null)
return null;
Diagnostics.Assert(_comparer != null, "null comparer");
for (int i = 0; i < list.Count; i++)
{
OrderByPropertyEntry listEntry = list[i];
Diagnostics.Assert(listEntry != null, "null listEntry " + i);
if (_comparer.Compare(match, listEntry) == 0)
{
list.RemoveAt(i);
return listEntry;
}
}
return null;
}
#region Emit
private void EmitMatch(OrderByPropertyEntry entry)
{
if (_includeEqual)
Emit(entry, SideIndicatorMatch);
}
private void EmitDifferenceOnly(OrderByPropertyEntry entry)
{
if (!ExcludeDifferent)
Emit(entry, SideIndicatorDifference);
}
private void EmitReferenceOnly(OrderByPropertyEntry entry)
{
if (!ExcludeDifferent)
Emit(entry, SideIndicatorReference);
}
private void Emit(OrderByPropertyEntry entry, string sideIndicator)
{
Diagnostics.Assert(entry != null, "null entry");
PSObject mshobj;
if (PassThru)
{
mshobj = PSObject.AsPSObject(entry.inputObject);
}
else
{
mshobj = new PSObject();
if (Property == null || Property.Length == 0)
{
PSNoteProperty inputNote = new(
InputObjectPropertyName, entry.inputObject);
mshobj.Properties.Add(inputNote);
}
else
{
List<MshParameter> mshParameterList = _orderByProperty.MshParameterList;
Diagnostics.Assert(mshParameterList != null, "null mshParameterList");
Diagnostics.Assert(mshParameterList.Count == Property.Length, "mshParameterList.Count " + mshParameterList.Count);
for (int i = 0; i < Property.Length; i++)
{
// 2005/07/05 This is the closest we can come to
// the string typed by the user
MshParameter mshParameter = mshParameterList[i];
Diagnostics.Assert(mshParameter != null, "null mshParameter");
Hashtable hash = mshParameter.hash;
Diagnostics.Assert(hash != null, "null hash");
object prop = hash[FormatParameterDefinitionKeys.ExpressionEntryKey];
Diagnostics.Assert(prop != null, "null prop");
string propName = prop.ToString();
PSNoteProperty propertyNote = new(
propName,
entry.orderValues[i].PropertyValue);
try
{
mshobj.Properties.Add(propertyNote);
}
catch (ExtendedTypeSystemException)
{
// this is probably a duplicate add
}
}
}
}
mshobj.Properties.Remove(SideIndicatorPropertyName);
PSNoteProperty sideNote = new(
SideIndicatorPropertyName, sideIndicator);
mshobj.Properties.Add(sideNote);
WriteObject(mshobj);
}
#endregion Emit
#endregion Internal
#region Overrides
/// <summary>
/// If the parameter 'ExcludeDifferent' is present, then the 'IncludeEqual'
/// switch is turned on unless it's turned off by the user specifically.
/// </summary>
protected override void BeginProcessing()
{
if (ExcludeDifferent)
{
if (_isIncludeEqualSpecified && !_includeEqual)
{
return;
}
_includeEqual = true;
}
}
/// <summary>
/// </summary>
protected override void ProcessRecord()
{
if (ReferenceObject == null || ReferenceObject.Length == 0)
{
HandleDifferenceObjectOnly();
return;
}
else if (DifferenceObject == null || DifferenceObject.Length == 0)
{
HandleReferenceObjectOnly();
return;
}
if (_comparer == null && DifferenceObject.Length > 0)
{
InitComparer();
}
List<PSObject> differenceList = new(DifferenceObject);
List<OrderByPropertyEntry> differenceEntries =
OrderByProperty.CreateOrderMatrix(
this, differenceList, _orderByProperty.MshParameterList);
foreach (OrderByPropertyEntry incomingEntry in differenceEntries)
{
Process(incomingEntry);
}
}
/// <summary>
/// </summary>
protected override void EndProcessing()
{
// Clear remaining reference objects if there are more
// reference objects than difference objects
if (_referenceEntries != null)
{
while (_referenceObjectIndex < _referenceEntries.Count)
{
Process(null);
}
}
// emit all remaining backlogged objects
foreach (OrderByPropertyEntry differenceEntry in _differenceEntryBacklog)
{
EmitDifferenceOnly(differenceEntry);
}
_differenceEntryBacklog.Clear();
foreach (OrderByPropertyEntry referenceEntry in _referenceEntryBacklog)
{
EmitReferenceOnly(referenceEntry);
}
_referenceEntryBacklog.Clear();
}
#endregion Overrides
private void HandleDifferenceObjectOnly()
{
if (DifferenceObject == null || DifferenceObject.Length == 0)
{
return;
}
List<PSObject> differenceList = new(DifferenceObject);
_orderByProperty = new OrderByProperty(
this, differenceList, Property, true, _cultureInfo, CaseSensitive);
List<OrderByPropertyEntry> differenceEntries =
OrderByProperty.CreateOrderMatrix(
this, differenceList, _orderByProperty.MshParameterList);
foreach (OrderByPropertyEntry entry in differenceEntries)
{
EmitDifferenceOnly(entry);
}
}
private void HandleReferenceObjectOnly()
{
if (ReferenceObject == null || ReferenceObject.Length == 0)
{
return;
}
InitComparer();
Process(null);
}
}
}
|