edncfix/eDNC-SpecialCharFix.ps1

#Requires -Version 5.1
<#
.SYNOPSIS
    eDNC Special Character Fix - Real-time file watcher to strip invalid characters from DNC files.

.DESCRIPTION
    Monitors a specified folder for DNC program files (.pun, .nc, etc.) and automatically
    removes special characters (0xFF and others) that cause issues with CNC machines.

    Some legacy DNC systems and communication protocols add padding or termination bytes
    that modern CNC controllers cannot process correctly.

.PARAMETER WatchFolder
    The folder to monitor for DNC files. Default: C:\Dnc_Files\Q

.PARAMETER FileFilter
    File pattern to watch. Default: *.pun

.PARAMETER IncludeSubfolders
    Whether to watch subfolders. Default: $true

.PARAMETER CharactersToRemove
    Array of byte values to strip from files. Default: @(255) for 0xFF

.EXAMPLE
    .\eDNC-SpecialCharFix.ps1
    Runs with default settings, watching C:\Dnc_Files\Q for *.pun files

.EXAMPLE
    .\eDNC-SpecialCharFix.ps1 -WatchFolder "D:\DNC\Programs" -FileFilter "*.nc"
    Watches D:\DNC\Programs for .nc files

.EXAMPLE
    .\eDNC-SpecialCharFix.ps1 -CharactersToRemove @(255, 0, 26)
    Removes 0xFF, NULL, and SUB (Ctrl+Z) characters

.NOTES
    Author: GE Aerospace - Rutland
    Version: 1.0.0
    Date: 2025-12-12

    Common problematic characters:
    - 0xFF (255) - Padding/fill character
    - 0x00 (0)   - NULL character
    - 0x1A (26)  - SUB/Ctrl+Z (EOF marker in some systems)
    - 0x7F (127) - DEL character
#>

[CmdletBinding()]
param(
    [Parameter()]
    [string]$WatchFolder = "C:\Dnc_Files\Q",

    [Parameter()]
    [string]$FileFilter = "*.pun",

    [Parameter()]
    [bool]$IncludeSubfolders = $true,

    [Parameter()]
    [int[]]$CharactersToRemove = @(255)
)

# Script info
$ScriptVersion = "1.0.0"
$ScriptName = "eDNC Special Character Fix"

# Display banner
Write-Host ""
Write-Host "========================================" -ForegroundColor Cyan
Write-Host " $ScriptName v$ScriptVersion" -ForegroundColor Cyan
Write-Host "========================================" -ForegroundColor Cyan
Write-Host ""

# Validate watch folder exists
if (-not (Test-Path $WatchFolder)) {
    Write-Host "[ERROR] Watch folder does not exist: $WatchFolder" -ForegroundColor Red
    Write-Host "Please create the folder or specify a different path." -ForegroundColor Yellow
    exit 1
}

# Display configuration
Write-Host "Configuration:" -ForegroundColor Yellow
Write-Host "  Watch Folder:    $WatchFolder"
Write-Host "  File Filter:     $FileFilter"
Write-Host "  Subfolders:      $IncludeSubfolders"
Write-Host "  Removing bytes:  $($CharactersToRemove -join ', ') (0x$($CharactersToRemove | ForEach-Object { '{0:X2}' -f $_ } | Join-String -Separator ', 0x'))"
Write-Host ""
Write-Host "Watching for files... Press Ctrl+C to stop" -ForegroundColor Green
Write-Host ""

# Statistics
$script:FilesProcessed = 0
$script:BytesRemoved = 0

# Create file system watcher
$watcher = New-Object System.IO.FileSystemWatcher
$watcher.Path = $WatchFolder
$watcher.Filter = $FileFilter
$watcher.IncludeSubdirectories = $IncludeSubfolders
$watcher.EnableRaisingEvents = $true

# Define the cleanup action
$action = {
    $path = $Event.SourceEventArgs.FullPath
    $changeType = $Event.SourceEventArgs.ChangeType
    $fileName = Split-Path $path -Leaf

    # Get characters to remove from the outer scope
    $charsToRemove = $Event.MessageData.CharsToRemove

    Write-Host "$(Get-Date -Format 'yyyy-MM-dd HH:mm:ss') | $changeType | $fileName" -ForegroundColor White

    # Wait for file to finish writing
    Start-Sleep -Milliseconds 500

    # Retry logic for locked files
    $maxRetries = 3
    $retryCount = 0

    while ($retryCount -lt $maxRetries) {
        try {
            # Read file as bytes
            $bytes = [System.IO.File]::ReadAllBytes($path)
            $originalCount = $bytes.Count

            # Remove specified bytes
            $cleaned = $bytes | Where-Object { $_ -notin $charsToRemove }
            $newCount = $cleaned.Count

            # Only rewrite if we found characters to remove
            if ($originalCount -ne $newCount) {
                [System.IO.File]::WriteAllBytes($path, [byte[]]$cleaned)
                $removed = $originalCount - $newCount
                Write-Host "  [CLEANED] Removed $removed byte(s)" -ForegroundColor Green
                $script:FilesProcessed++
                $script:BytesRemoved += $removed
            } else {
                Write-Host "  [OK] No special characters found" -ForegroundColor Gray
            }
            break
        }
        catch [System.IO.IOException] {
            $retryCount++
            if ($retryCount -lt $maxRetries) {
                Write-Host "  [RETRY] File locked, waiting... ($retryCount/$maxRetries)" -ForegroundColor Yellow
                Start-Sleep -Milliseconds 1000
            } else {
                Write-Host "  [ERROR] Could not access file after $maxRetries attempts" -ForegroundColor Red
            }
        }
        catch {
            Write-Host "  [ERROR] $($_.Exception.Message)" -ForegroundColor Red
            break
        }
    }
}

# Create message data object to pass parameters to the action
$messageData = @{
    CharsToRemove = $CharactersToRemove
}

# Register event handlers
$null = Register-ObjectEvent -InputObject $watcher -EventName Created -Action $action -MessageData $messageData
$null = Register-ObjectEvent -InputObject $watcher -EventName Changed -Action $action -MessageData $messageData

# Keep script running
try {
    while ($true) {
        Start-Sleep -Seconds 1
    }
}
finally {
    # Cleanup on exit
    $watcher.EnableRaisingEvents = $false
    $watcher.Dispose()
    Get-EventSubscriber | Unregister-Event

    Write-Host ""
    Write-Host "========================================" -ForegroundColor Cyan
    Write-Host " Session Summary" -ForegroundColor Cyan
    Write-Host "========================================" -ForegroundColor Cyan
    Write-Host "  Files Cleaned:  $script:FilesProcessed"
    Write-Host "  Bytes Removed:  $script:BytesRemoved"
    Write-Host ""
    Write-Host "Stopped watching folder" -ForegroundColor Yellow
}