LargeFiles.psm1
|
$script:ModuleRoot = $PSScriptRoot $script:ModuleVersion = (Import-PowerShellDataFile -Path "$($script:ModuleRoot)\LargeFiles.psd1").ModuleVersion # Detect whether at some level dotsourcing was enforced $script:doDotSource = Get-PSFConfigValue -FullName LargeFiles.Import.DoDotSource -Fallback $false if ($LargeFiles_dotsourcemodule) { $script:doDotSource = $true } <# Note on Resolve-Path: All paths are sent through Resolve-Path/Resolve-PSFPath in order to convert them to the correct path separator. This allows ignoring path separators throughout the import sequence, which could otherwise cause trouble depending on OS. Resolve-Path can only be used for paths that already exist, Resolve-PSFPath can accept that the last leaf my not exist. This is important when testing for paths. #> # Detect whether at some level loading individual module files, rather than the compiled module was enforced $importIndividualFiles = Get-PSFConfigValue -FullName LargeFiles.Import.IndividualFiles -Fallback $false if ($LargeFiles_importIndividualFiles) { $importIndividualFiles = $true } if (Test-Path (Resolve-PSFPath -Path "$($script:ModuleRoot)\..\.git" -SingleItem -NewChild)) { $importIndividualFiles = $true } if ("<was compiled>" -eq '<was not compiled>') { $importIndividualFiles = $true } function Import-ModuleFile { <# .SYNOPSIS Loads files into the module on module import. .DESCRIPTION This helper function is used during module initialization. It should always be dotsourced itself, in order to proper function. This provides a central location to react to files being imported, if later desired .PARAMETER Path The path to the file to load .EXAMPLE PS C:\> . Import-ModuleFile -File $function.FullName Imports the file stored in $function according to import policy #> [CmdletBinding()] Param ( [string] $Path ) $resolvedPath = $ExecutionContext.SessionState.Path.GetResolvedPSPathFromPSPath($Path).ProviderPath if ($doDotSource) { . $resolvedPath } else { $ExecutionContext.InvokeCommand.InvokeScript($false, ([scriptblock]::Create([io.file]::ReadAllText($resolvedPath))), $null, $null) } } #region Load individual files if ($importIndividualFiles) { # Execute Preimport actions foreach ($path in (& "$ModuleRoot\internal\scripts\preimport.ps1")) { . Import-ModuleFile -Path $path } # Import all internal functions foreach ($function in (Get-ChildItem "$ModuleRoot\internal\functions" -Filter "*.ps1" -Recurse -ErrorAction Ignore)) { . Import-ModuleFile -Path $function.FullName } # Import all public functions foreach ($function in (Get-ChildItem "$ModuleRoot\functions" -Filter "*.ps1" -Recurse -ErrorAction Ignore)) { . Import-ModuleFile -Path $function.FullName } # Execute Postimport actions foreach ($path in (& "$ModuleRoot\internal\scripts\postimport.ps1")) { . Import-ModuleFile -Path $path } # End it here, do not load compiled code below return } #endregion Load individual files #region Load compiled code <# This file loads the strings documents from the respective language folders. This allows localizing messages and errors. Load psd1 language files for each language you wish to support. Partial translations are acceptable - when missing a current language message, it will fallback to English or another available language. #> Import-PSFLocalizedString -Path "$($script:ModuleRoot)\en-us\*.psd1" -Module 'LargeFiles' -Language 'en-US' function Get-LargeFile { <# .SYNOPSIS Searches files exceeding the specified threshold. .DESCRIPTION Searches files exceeding the specified threshold. Scans a folder and everything beneath it. .PARAMETER Path The path(s) under which to search for files. .PARAMETER SizeLimit The maximum size a file may be without being included. .EXAMPLE PS C:\> Get-LargeFile -Path \\server\share -SizeLimit 2GB Returns all files under "\\server\share" that are larger than 2GB #> [CmdletBinding()] param ( [Parameter(Mandatory = $true, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true)] [ValidateScript({ $filePath = $_ try { Resolve-Path -Path $filePath -ErrorAction Stop } catch { throw "Invalid Path: $filePath" } })] [Alias('FullName')] [string[]] $Path, [Parameter(Mandatory = $true)] [ValidateRange(1,9223372036854775807)] [Int64] $SizeLimit ) process { # Begin & End (und Process) optional, falls kein Inhalt vorgesehen Write-PSFMessage -Message "Path: $Path" $Path | Resolve-Path | Get-ChildItem -Recurse -Force -File | Where-Object -Property Length -gt $SizeLimit } } function Rename-LargeFile { <# .SYNOPSIS Renames files provided by adding a prefix. .DESCRIPTION Renames files provided by adding a prefix. .PARAMETER Path The Path to the file to rename. .PARAMETER Prefix The Prefix to apply (if it has not already been applied) .PARAMETER WhatIf Do a trial run without actually changing anything .PARAMETER Confirm Ask for confirmation before renaming files .EXAMPLE PS C:\> Rename-LargeFile -Path $file.FullName -Prefix 'TOO_LARGE_' Renames the file specified in $file, adding the 'TOO_LARGE_' prefix #> [CmdletBinding(SupportsShouldProcess = $true)] param ( [Parameter(Mandatory = $true, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true)] [ValidateScript({ if (Test-Path -LiteralPath $_) { return $true } throw "Path not found: $_" })] [Alias('FullName')] [string[]] $Path, [Parameter(Mandatory = $true)] [string] $Prefix ) process { foreach ($fileObject in Get-Item -LiteralPath $Path) { if ($fileObject.PSIsContainer) { Write-PSFMessage -Level Warning -Message "Not a file: $($fileObject.FullName)" continue } $object = [PSCUstomObject]@{ FullName = $fileObject.FullName Name = $fileObject.Name NewName = $fileObject.Name Size = $fileObject.Length Extension = $fileObject.Extension Success = $false Renamed = $false Error = $null } if ($object.NewName -notlike "$Prefix*") { $object.NewName = $Prefix, $object.NewName -join "" if ($object.NewName.Length -gt 250) { $object.NewName = $object.NewName.SubString(0,250) } } if ($object.Name -eq $object.NewName) { $object.Success = $true $object continue } if (-not $PSCmdlet.ShouldProcess($object.FullName, "Rename to $($object.NewName)")) { $object continue } Write-PSFMessage -Message "Renaming $($object.FullName) to $($object.NewName)" try { Rename-Item -LiteralPath $object.FullName -NewName $object.NewName -ErrorAction Stop } catch { $object.Error = $_ $object continue } $object.Renamed = $true $object.Success = $true $object } } } <# This is an example configuration file By default, it is enough to have a single one of them, however if you have enough configuration settings to justify having multiple copies of it, feel totally free to split them into multiple files. #> <# # Example Configuration Set-PSFConfig -Module 'LargeFiles' -Name 'Example.Setting' -Value 10 -Initialize -Validation 'integer' -Handler { } -Description "Example configuration setting. Your module can then use the setting using 'Get-PSFConfigValue'" #> Set-PSFConfig -Module 'LargeFiles' -Name 'Import.DoDotSource' -Value $false -Initialize -Validation 'bool' -Description "Whether the module files should be dotsourced on import. By default, the files of this module are read as string value and invoked, which is faster but worse on debugging." Set-PSFConfig -Module 'LargeFiles' -Name 'Import.IndividualFiles' -Value $false -Initialize -Validation 'bool' -Description "Whether the module files should be imported individually. During the module build, all module code is compiled into few files, which are imported instead by default. Loading the compiled versions is faster, using the individual files is easier for debugging and testing out adjustments." <# Stored scriptblocks are available in [PsfValidateScript()] attributes. This makes it easier to centrally provide the same scriptblock multiple times, without having to maintain it in separate locations. It also prevents lengthy validation scriptblocks from making your parameter block hard to read. Set-PSFScriptblock -Name 'LargeFiles.ScriptBlockName' -Scriptblock { } #> <# # Example: Register-PSFTeppScriptblock -Name "LargeFiles.alcohol" -ScriptBlock { 'Beer','Mead','Whiskey','Wine','Vodka','Rum (3y)', 'Rum (5y)', 'Rum (7y)' } #> <# # Example: Register-PSFTeppArgumentCompleter -Command Get-Alcohol -Parameter Type -Name LargeFiles.alcohol #> New-PSFLicense -Product 'LargeFiles' -Manufacturer 'Friedrich Weinmann' -ProductVersion $script:ModuleVersion -ProductType Module -Name MIT -Version "1.0.0.0" -Date (Get-Date "2022-04-13") -Text @" Copyright (c) 2022 Friedrich Weinmann Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. "@ #endregion Load compiled code |