Classes/StreamingResultsManager.ps1
|
#Requires -Version 5.1 class StreamingResultsManager : System.IDisposable { [string]$TempDirectory [string]$ResultsFile [string]$SummaryFile [int]$BatchSize [int]$CurrentBatch [System.Collections.Generic.List[object]]$CurrentResults # In WhatIf mode nothing is written to disk, so flushed batches are kept here instead [System.Collections.Generic.List[object]]$WhatIfResults # Results already read back from batch files, and how many batch files they cover, so a second # GetAllResults (ExportToCsv after Find-OrphanedSid has emitted) reads no file twice hidden [System.Collections.Generic.List[object]]$ReadBackResults = [System.Collections.Generic.List[object]]::new() hidden [int]$ReadBackBatchCount = 0 [object]$Summary [bool]$Disposed [bool]$WhatIfMode # When true, Dispose() leaves the temp directory and batch files on disk (-PreserveTempFiles) [bool]$PreserveFiles # Constructor with WhatIf support (3-argument version) - placed first StreamingResultsManager([string]$tempDir, [int]$batchSize, [bool]$whatIfMode) { $this.TempDirectory = $tempDir $this.BatchSize = $batchSize $this.CurrentBatch = 0 $this.CurrentResults = [System.Collections.Generic.List[object]]::new() $this.WhatIfResults = [System.Collections.Generic.List[object]]::new() $this.Disposed = $false $this.WhatIfMode = $whatIfMode # Initialize the rest using common logic $this.InitializeManager() } # Constructor without WhatIf support (2-argument version) - safer for compatibility StreamingResultsManager([string]$tempDir, [int]$batchSize) { $this.TempDirectory = $tempDir $this.BatchSize = $batchSize $this.CurrentBatch = 0 $this.CurrentResults = [System.Collections.Generic.List[object]]::new() $this.WhatIfResults = [System.Collections.Generic.List[object]]::new() $this.Disposed = $false $this.WhatIfMode = $false # Don't initialize directory yet - wait for potential WhatIf configuration $this.Summary = [PSCustomObject]@{ TotalResults = 0 BatchFiles = @() OrphanedSIDsFound = 0 UnverifiedSIDsFound = 0 ObjectsProcessed = 0 LastUpdate = Get-Date } } # Method to configure WhatIf mode and complete initialization [void] ConfigureWhatIfMode([bool]$whatIfMode) { $this.WhatIfMode = $whatIfMode $this.InitializeManager() } # Common initialization logic [void] InitializeManager() { # Handle temp directory creation based on WhatIf mode try { if ($this.WhatIfMode) { # In WhatIf mode, simulate directory creation without actually creating it Write-Verbose "WhatIf: Would create temporary directory: $($this.TempDirectory)" } else { # Normal mode: actually create the directory if (-not (Test-Path $this.TempDirectory)) { New-Item -Path $this.TempDirectory -ItemType Directory -Force | Out-Null } # Verify directory was created and is writable if (-not (Test-Path $this.TempDirectory -PathType Container)) { throw "Failed to create or access temporary directory: $($this.TempDirectory)" } } } catch { if (-not $this.WhatIfMode) { throw "StreamingResultsManager initialization failed - cannot create temporary directory '$($this.TempDirectory)': $($_.Exception.Message)" } # In WhatIf mode, don't throw on directory creation errors Write-Verbose "WhatIf: Simulated directory creation error (would fail in real mode): $($_.Exception.Message)" } # Initialize summary $this.Summary = [PSCustomObject]@{ TotalResults = 0 BatchFiles = @() OrphanedSIDsFound = 0 UnverifiedSIDsFound = 0 ObjectsProcessed = 0 LastUpdate = Get-Date } # Set file paths with enhanced error checking $timestamp = Get-Date -Format 'yyyyMMdd_HHmmss' $this.ResultsFile = Join-Path $this.TempDirectory "results_$timestamp.json" $this.SummaryFile = Join-Path $this.TempDirectory "summary_$timestamp.json" # Test write access by creating a placeholder file (only in non-WhatIf mode) try { if ($this.WhatIfMode) { Write-Verbose "WhatIf: Would create summary file: $($this.SummaryFile)" } else { $testContent = @{ initialized = $true; timestamp = Get-Date } | ConvertTo-Json $testContent | Out-File -FilePath $this.SummaryFile -Encoding UTF8 -Force } } catch { if (-not $this.WhatIfMode) { throw "StreamingResultsManager initialization failed - cannot write to temporary directory '$($this.TempDirectory)': $($_.Exception.Message)" } # In WhatIf mode, don't throw on file write errors Write-Verbose "WhatIf: Simulated file write error (would fail in real mode): $($_.Exception.Message)" } } [void]AddResult([object]$result) { if ($this.Disposed) { throw "StreamingResultsManager has been disposed" } $this.CurrentResults.Add($result) $this.Summary.TotalResults++ # Update summary statistics if ($result.PSObject.Properties.Name -contains 'VerificationStatus' -and $result.VerificationStatus -eq 'Unverified') { $this.Summary.UnverifiedSIDsFound++ } elseif ($result.PSObject.Properties.Name -contains 'OrphanedSID') { $this.Summary.OrphanedSIDsFound++ } $this.Summary.ObjectsProcessed++ $this.Summary.LastUpdate = Get-Date # Flush to disk when batch is full if ($this.CurrentResults.Count -ge $this.BatchSize) { $this.FlushBatch() } } [void]FlushBatch() { if ($this.CurrentResults.Count -eq 0) { return } try { if ($this.WhatIfMode) { # In WhatIf mode, simulate batch flushing without actual file operations $this.CurrentBatch++ $batchFile = Join-Path $this.TempDirectory "batch_$($this.CurrentBatch).json" Write-Verbose "WhatIf: Would flush batch $($this.CurrentBatch) with $($this.CurrentResults.Count) results to $batchFile" # Add to summary (simulate) $this.Summary.BatchFiles += $batchFile # Nothing goes to disk, so keep the batch in memory for GetAllResults $this.WhatIfResults.AddRange($this.CurrentResults) $this.CurrentResults.Clear() # Force garbage collection after each batch (always safe to do) [System.GC]::Collect() return } # Normal mode: actual file operations # Ensure directory still exists before writing batch files if (-not (Test-Path $this.TempDirectory -PathType Container)) { # Only recreate directory if not explicitly cleaned up if (-not $this.Disposed) { Write-Warning "Temporary directory no longer exists, recreating: $($this.TempDirectory)" New-Item -Path $this.TempDirectory -ItemType Directory -Force | Out-Null } else { Write-Verbose "Skipping batch flush - object is disposed and temp directory was cleaned up" return } } $this.CurrentBatch++ $batchFile = Join-Path $this.TempDirectory "batch_$($this.CurrentBatch).json" # Convert to JSON and write to file with enhanced error handling $this.CurrentResults | ConvertTo-Json -Depth 10 -Compress | Out-File -FilePath $batchFile -Encoding UTF8 -Force # Add to summary $this.Summary.BatchFiles += $batchFile # Clear current results to free memory, counting them first for the log line $flushedCount = $this.CurrentResults.Count $this.CurrentResults.Clear() # Force garbage collection after each batch [System.GC]::Collect() Write-Verbose "Flushed batch $($this.CurrentBatch) with $flushedCount results to $batchFile" } catch { Write-Warning "Failed to flush batch $($this.CurrentBatch): $($_.Exception.Message)" # Provide diagnostic information for troubleshooting $diagnosticInfo = @{ TempDirectory = $this.TempDirectory CurrentBatch = $this.CurrentBatch ResultsCount = $this.CurrentResults.Count DirectoryExists = (Test-Path $this.TempDirectory -PathType Container) IsDisposed = $this.Disposed WhatIfMode = $this.WhatIfMode ErrorMessage = $_.Exception.Message Timestamp = Get-Date } Write-Verbose "Batch flush diagnostic info: $($diagnosticInfo | ConvertTo-Json -Compress)" } } [void]UpdateSummary() { try { if ($this.WhatIfMode) { # In WhatIf mode, simulate summary update Write-Verbose "WhatIf: Would update summary file: $($this.SummaryFile)" return } # Skip summary update if object is disposed and directory was cleaned up if ($this.Disposed -and (-not (Test-Path $this.TempDirectory -PathType Container))) { Write-Verbose "Skipping summary update - object is disposed and temp directory was cleaned up" return } # Ensure directory still exists before writing if (-not (Test-Path $this.TempDirectory -PathType Container)) { # Only recreate directory if not explicitly disposed if (-not $this.Disposed) { Write-Warning "Temporary directory no longer exists, recreating: $($this.TempDirectory)" New-Item -Path $this.TempDirectory -ItemType Directory -Force | Out-Null } else { Write-Verbose "Cannot recreate temp directory - object is disposed" return } } # Write summary with enhanced error handling $this.Summary | ConvertTo-Json -Depth 5 | Out-File -FilePath $this.SummaryFile -Encoding UTF8 -Force } catch { # Log the error but don't throw - summary updates are not critical for core functionality Write-Warning "Failed to update summary file '$($this.SummaryFile)': $($_.Exception.Message)" # Try to create a diagnostic message for troubleshooting $diagnosticInfo = @{ TempDirectory = $this.TempDirectory SummaryFile = $this.SummaryFile DirectoryExists = (Test-Path $this.TempDirectory -PathType Container) ParentDirectoryExists = (Test-Path (Split-Path $this.TempDirectory -Parent) -PathType Container) IsDisposed = $this.Disposed ErrorMessage = $_.Exception.Message Timestamp = Get-Date } Write-Verbose "Summary update diagnostic info: $($diagnosticInfo | ConvertTo-Json -Compress)" } } [object[]]GetAllResults() { # Flush any remaining results $this.FlushBatch() if ($this.WhatIfMode) { # In WhatIf mode, simulate reading results without actual file access Write-Verbose "WhatIf: Would read results from $($this.Summary.BatchFiles.Count) batch files" return $this.WhatIfResults.ToArray() } # Only batch files flushed since the last call are read; the rest are already in the list $batchFiles = @($this.Summary.BatchFiles) for ($index = $this.ReadBackBatchCount; $index -lt $batchFiles.Count; $index++) { $batchFile = $batchFiles[$index] if (Test-Path $batchFile) { try { $batchContent = Get-Content $batchFile -Raw | ConvertFrom-Json foreach ($item in @($batchContent)) { $this.ReadBackResults.Add($this.RestoreResult($item)) } } catch { Write-Warning "Failed to read batch file $batchFile : $($_.Exception.Message)" } } } $this.ReadBackBatchCount = $batchFiles.Count return $this.ReadBackResults.ToArray() } # JSON loses types: enums come back as numbers, and a DateTime comes back as UTC on Windows # PowerShell 5.1 and as local time on PowerShell 7. A result that came in as an # OrphanedSIDResult is rebuilt as one; anything else is returned as read. [object]RestoreResult([object]$item) { if ($null -eq $item -or $item -isnot [System.Management.Automation.PSCustomObject]) { return $item } $names = @($item.PSObject.Properties.Name) if (-not ($names -contains 'OrphanedSID' -and $names -contains 'VerificationStatus' -and $names -contains 'ObjectDN')) { return $item } # Resolved at run time: a type literal here would bind when this file is parsed. A class # method resolves names in the scope where its class was first compiled; PowerShell 7 reuses # that compiled class when the same file is loaded again, so when that scope does not know # OrphanedSIDResult, the loaded assemblies are searched. Every copy has the same properties. $resultType = 'OrphanedSIDResult' -as [type] if ($null -eq $resultType) { $resultType = [AppDomain]::CurrentDomain.GetAssemblies() | ForEach-Object { $_.GetType('OrphanedSIDResult', $false) } | Where-Object { $_ } | Select-Object -Last 1 } if ($null -eq $resultType) { return $item } $typed = $resultType::new() $declared = @($resultType.GetProperties().Name) foreach ($property in $item.PSObject.Properties) { if ($declared -contains $property.Name) { $value = $property.Value if ($property.Name -eq 'Timestamp' -and $value -is [DateTime] -and $value.Kind -eq [DateTimeKind]::Utc) { $value = $value.ToLocalTime() } elseif ($property.Name -eq 'Timestamp' -and $value -is [string]) { $value = [DateTime]::Parse($value, [System.Globalization.CultureInfo]::InvariantCulture, [System.Globalization.DateTimeStyles]::RoundtripKind) if ($value.Kind -eq [DateTimeKind]::Utc) { $value = $value.ToLocalTime() } } $typed.($property.Name) = $value } else { # Note properties added during processing (ProcessingContext, ProcessingStatistics) $typed | Add-Member -NotePropertyName $property.Name -NotePropertyValue $property.Value -Force } } return $typed } [object]GetSummary() { # Only update summary if object is not disposed and directory exists if (-not $this.Disposed -and (Test-Path $this.TempDirectory -PathType Container)) { $this.UpdateSummary() } return $this.Summary } # True when the file was written: nothing is written under WhatIf or when there are no results, # and the caller's log line has to say which [bool]ExportToCsv([string]$outputPath) { $allResults = $this.GetAllResults() $written = $false if ($this.WhatIfMode) { Write-Verbose "WhatIf: Would export $($allResults.Count) results to $outputPath" } else { if ($allResults.Count -gt 0) { $allResults | Export-Csv -Path $outputPath -NoTypeInformation -Encoding UTF8 Write-Verbose "Exported $($allResults.Count) results to $outputPath" $written = $true } } # Clean up memory $allResults = $null [System.GC]::Collect() return $written } [long]GetCurrentMemoryUsage() { $currentProcess = Get-Process -Id ([System.Diagnostics.Process]::GetCurrentProcess().Id) return [Math]::Round($currentProcess.WorkingSet64 / 1MB, 2) } [void]Dispose() { if (-not $this.Disposed) { # Flush any remaining results $this.FlushBatch() if ($this.WhatIfMode) { Write-Verbose "WhatIf: Would update final summary and cleanup temp directory: $($this.TempDirectory)" } else { # Update final summary only if temp directory still exists if (Test-Path $this.TempDirectory -PathType Container) { $this.UpdateSummary() } else { Write-Verbose "Skipping final summary update - temp directory no longer exists: $($this.TempDirectory)" } # Clean up temporary files during disposal unless the caller asked to keep them if ($this.PreserveFiles) { Write-Verbose "Preserving temporary result files in: $($this.TempDirectory)" } else { $this.Cleanup() } } # Clear references (always safe to do) $this.CurrentResults.Clear() $this.CurrentResults = $null $this.ReadBackResults.Clear() $this.Disposed = $true # Force final cleanup (always safe to do) [System.GC]::Collect() [System.GC]::WaitForPendingFinalizers() [System.GC]::Collect() } } [void]Cleanup() { if ($this.WhatIfMode) { Write-Verbose "WhatIf: Would remove temporary directory: $($this.TempDirectory)" return } # Remove temporary files if (Test-Path $this.TempDirectory) { try { Remove-Item -Path $this.TempDirectory -Recurse -Force Write-Verbose "Cleaned up temporary directory: $($this.TempDirectory)" } catch { Write-Warning "Failed to clean up temporary directory: $($_.Exception.Message)" } } } } |