# encoding: ascii
# api: powershell
# title: Find-Replace
# description: Finds and Replaces multiple entries, in multiple files.
# version: 0.1
# type: script
# author: Nathan Hartley
# license: CC0
# x-poshcode-id: 3773
# x-archived: 2014-08-23T00:23:17
# x-published: 2014-11-21T08:32:00
#
#
<#
.SYNOPSIS
Finds and Replaces multiple entries, in multiple files.
.DESCRIPTION
By default, performs an ordinal (case-sensitive and culture-insensitive) search to find an old value and replace it.
.PARAMETER Path
One or more files Paths to process. Excepts values from the Pipeline. Will except the output from Get-ChildItem.
.PARAMETER Object
Any object or array of objects with Find and Replace properties that will be used to make the swap.
-Object (Import-CSV SomeFile.csv)
-Object @{Find = 'this'; Replace = 'that'}, @{Find = 'something'; Replace = 'other'}
.PARAMETER Find
One or more strings to Find.
.PARAMETER Replace
A string to replace those matching -Find.
.PARAMETER Regex
Treat find values as Regular Expressions.
.PARAMETER WhatIf
Test Find and Replace without making any changes.
.PARAMETER Backup
Backup the original file to <OriginalFileName>_yyyyMMddHHmmss.
.PARAMETER PassThru
Passes changed (or needing to be changed with WhatIf enabled) files through the pipeline.
.PARAMETER Encoding
.INPUTS
Excepts file names and file objects for the Path parameter.
.OUTPUTS
None, unless PassThru specified. With PassThru, passes changed (or needing to be changed with WhatIf enabled) files through the pipeline.
.EXAMPLE
Get-ChildItem SomePath\* -recurse -include *.config,*.xslt,*.xml,*.txt | Find-Replace.ps1 -Object (Import-Csv Replacements.csv) -PassThru | set-content ChangedFiles.txt
#>
[CmdletBinding(DefaultParametersetName="string")]
param (
[Parameter(
Mandatory=$True,
ValueFromPipeline=$True,
ValueFromPipelineByPropertyName=$True,
Position=0,
HelpMessage="One or more file Paths to process."
)]
[string[]]$Path,
[Parameter(
ParameterSetName="object",
Mandatory=$True,
Position=1,
HelpMessage="Any object or array of objects with Find and Replace properties that will be used to make the swap."
)]
$Object,
[Parameter(
ParameterSetName="string",
Mandatory=$True,
Position=1,
HelpMessage="An array of strings to Find."
)]
[string[]]$Find,
[Parameter(
ParameterSetName="string",
Mandatory=$False,
Position=2,
HelpMessage="A string to replace those matching -Find."
)]
[string]$Replace,
[Parameter( HelpMessage="Treat find values as Regular Expressions." )]
[switch]$Regex,
[Parameter( HelpMessage="Test Find and Replace without making any changes." )]
[switch]$WhatIf,
[Parameter( HelpMessage="Backup the original file to <OriginalFileName>_yyyyMMddHHmmss." )]
[switch]$Backup,
[Parameter( HelpMessage="Passes changed (or needing to be changed with WhatIf enabled) files through the pipeline." )]
[switch]$PassThru,
[string]$Encoding = 'ASCII'
)
BEGIN {
$replaceCache = $null
if ($PsCmdlet.ParameterSetName -eq 'string') {
$replaceCache = $Find | Foreach { @{find=$_; replace=$Replace} }
} else {
$replaceCache = $Object | Where {$_.Find -is [string] -and $_.Find.length -gt 0 -and $_.Replace -is [string] } | Foreach { @{find=$_.find; replace=$_.replace}}
}
if ($replaceCache -eq $null) {
Write-Warning 'No find values found or specified.'
Exit
}
$numFiles = 0
$numLines = 0
$numFilesChanged = 0
$numLinesChanged = 0
$RunTime = Get-Date
}
PROCESS {
$Path
foreach ($file in @($Path)){
Write-Verbose "Processing $file"
$numFiles++
$lineNum = 0
$changesNum = 0
Get-Content $file | Foreach {
$line = $_
$lineNum++
Write-Debug ('{0: 0}: {1}' -f $lineNum, $line)
Foreach ($replace in @($replaceCache)) {
Write-Debug ('Find: [{0}] Replace: [{1}]' -f $replace.find, $replace.replace)
if ($Regex) {
$line = $line -replace $replace.find, $replace.replace
} else {
$line = $line.Replace($replace.find, $replace.replace)
}
}
if ($_ -cne $line) {
$changesNum++
Write-Verbose " Changed line $lineNum from '$_' to '$line' in $file."
}
$line
} | Where {-not $WhatIf} | Set-Content -encoding:$Encoding -Path ($file + '_FindReplace')
$numLines += $lineNum
$numLinesChanged += $changesNum
if ($changesNum -gt 0) {
$numFilesChanged++
if (-not $WhatIf) {
if ($Backup) {
Copy-Item ($file + '_FindReplace') ('{0}_{1:yyyyMMddHHmmss}' -f $file, $RunTime) -Verbose:$Verbose
}
Remove-Item $file
Rename-Item ($file + '_FindReplace') $file
Write-Verbose " Changed $changesNum of $lineNum Lines"
}
if ($PassThru) { $file }
}
}
}
END {
$totals = "Totals: Changed $numFilesChanged of $numFiles Files Changed $numLinesChanged of $numLines Lines"
if ($WhatIf) {
Write-Host "What if: $totals"
} else {
Write-Verbose $totals
}
}