FileType.psm1
|
$script:ModuleRoot = $PSScriptRoot $script:ModuleVersion = (Import-PowerShellDataFile -Path "$($script:ModuleRoot)\FileType.psd1").ModuleVersion # Detect whether at some level dotsourcing was enforced $script:doDotSource = Get-PSFConfigValue -FullName FileType.Import.DoDotSource -Fallback $false if ($FileType_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 FileType.Import.IndividualFiles -Fallback $false if ($FileType_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 . Import-ModuleFile -Path "$ModuleRoot\internal\scripts\preimport.ps1" # 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 . Import-ModuleFile -Path "$ModuleRoot\internal\scripts\postimport.ps1" # 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 'FileType' -Language 'en-US' function Get-FileType { <# .SYNOPSIS Returns the registered filetypes. .DESCRIPTION Returns the registered filetypes. .PARAMETER Type The type (or extension) to filter by. .EXAMPLE PS C:\> Get-FileType Returns all registered filetypes #> [CmdletBinding()] Param ( [string] $Type = '*' ) process { [FileType.FTHost]::FileTypes | Where-Object Extension -Like $Type } } function Register-FileType { <# .SYNOPSIS Registers a filetype with the parsing instructions to detect it. .DESCRIPTION Registers a filetype with the parsing instructions to detect it. The list populated with this data is used to verify, whether a file is of a specified type. .PARAMETER Type The type / file extension of the file type. .PARAMETER Mime The mime label files of that type have. .PARAMETER Bytes The byte-pattern to use to compare files with. Use $null as a wildcard entry that may be anything. .PARAMETER Offset The offset from where to start looking for the signature, verifying that the file is indeed of this type. Basically, the offset means "how many bytes, starting from the beginning of the file, to skip". .PARAMETER Description A description for the defined filetype. This could be general background or some important piece of extra documentation. .EXAMPLE PS C:\> Register-FileType -Type 'mp3' -Mime 'audio/mpeg' -Offset 0 -Bytes 73, 68, 51 Registers the mp3 file type. #> [CmdletBinding()] param ( [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true)] [AllowEmptyString()] [Alias('Extension')] [string[]] $Type, [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true)] [AllowEmptyString()] [string] $Mime, [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true)] [AllowEmptyCollection()] [AllowNull()] [Nullable[Byte][]] $Bytes, [Parameter(ValueFromPipelineByPropertyName = $true)] [int] $Offset, [Parameter(ValueFromPipelineByPropertyName = $true)] [AllowEmptyString()] [string] $Description ) process { if ($null -eq $Bytes) { $Bytes = @() } foreach ($typeName in $Type) { foreach ($typeElement in $typeName.Split(",")) { $fileType = New-Object FileType.FileType($Bytes, $typeElement.Trim("."), $Mime, $Offset, $Description) [FileType.FTHost]::FileTypes.Add($fileType) if (($Bytes.Length + $Offset) -gt ([FileType.FTHost]::MaxHeader)) { [FileType.FTHost]::MaxHeader = $Bytes.Length + $Offset } } } } } function Resolve-FileType { <# .SYNOPSIS Takes a file and figures out its potential filetypes. .DESCRIPTION Takes a file and figures out its potential filetypes. Ignores folder. .PARAMETER Path Path to the file. .EXAMPLE PS C:\> Get-ChildItem C:\Shares\Data -Recurse | Resolve-FileType Detects the filetype of all files in C:\Shares\Data #> [CmdletBinding()] param ( [Parameter(Mandatory = $true, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true)] [PsfValidateScript('FileType.Validate.Paths', ErrorString = 'FileType.Validate.Paths.Failed')] [Alias('FullName')] [string[]] $Path ) process { foreach ($pathItem in $Path) { foreach ($resolvedPath in $pathItem) { $item = Get-Item -Path $resolvedPath -Force if ($item.PSIsContainer) { continue } New-Object FileType.Resolution -Property @{ FullName = $resolvedPath FileTypes = @([FileType.FTHost]::ResolveType($item) | Where-Object { $_.Header.Count -gt 0 }) } } } } } function Test-FileType { <# .SYNOPSIS Tests, whether a specified file is of the type it proclaims to be. .DESCRIPTION Tests, whether a specified file is of the type it proclaims to be. Files of types that have not been registered will be returned as valid. Note that type determination is not a certain and guaranteed thing. Register detection patterns using Register-FileType. There are file types that share a common detection pattern. For example the common office files (pptx, docx, xslx, ...) share the same file headers and are not distinguishable. Renaming a word document to *.pptx will still test $true. .PARAMETER Path Path to the file to scan. .PARAMETER Quiet Only return $true or $false. By default, this command returns result objects including validity and path. .EXAMPLE PS C:\> Test-FileType -Path 'C:\temp\Presentation.pptx' Returns, whether the presentation.pptx file actually is a legal pptx file. #> [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseOutputTypeCorrectly", "")] [CmdletBinding()] param ( [Parameter(Mandatory = $true, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true)] [PsfValidateScript('FileType.Validate.Paths', ErrorString = 'FileType.Validate.Paths.Failed')] [Alias('FullName')] [string[]] $Path, [switch] $Quiet ) begin { $basePath = '' } process { foreach ($pathString in $Path) { foreach ($resolvedPath in (Resolve-PSFPath $pathString)) { # Skip Folders if ((Get-Item -Path $resolvedPath -Force).PSIsContainer) { continue } if (-not $basePath -or -not $resolvedPath.StartsWith($basePath)) { $basePath = '{0}{1}' -f (Split-Path -Path $resolvedPath), ([System.IO.Path]::DirectorySeparatorChar) } $result = $null try { $result = [FileType.FTHost]::IsValidType($resolvedPath, $true) if ($Quiet) { $result continue } $success = $true } catch { if ($Qiet) { throw } else { $success = $false } } New-Object FileType.TestResult -Property @{ IsValid = $result Success = $success FullName = $resolvedPath BasePath = $basePath } } } } } <# 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 'FileType' -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 'FileType' -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 'FileType' -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." Set-PSFScriptblock -Name 'FileType.Validate.Paths' -Scriptblock { try { Resolve-PSFPath -Path $_ -Provider FileSystem } catch { return $false } return $true } <# # Example: Register-PSFTeppScriptblock -Name "FileType.alcohol" -ScriptBlock { 'Beer','Mead','Whiskey','Wine','Vodka','Rum (3y)', 'Rum (5y)', 'Rum (7y)' } #> <# # Example: Register-PSFTeppArgumentCompleter -Command Get-Alcohol -Parameter Type -Name FileType.alcohol #> New-PSFLicense -Product 'FileType' -Manufacturer 'Friedrich Weinmann' -ProductVersion $script:ModuleVersion -ProductType Module -Name MIT -Version "1.0.0.0" -Date (Get-Date "2019-09-05") -Text @" Copyright (c) 2019 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 |