TeamsExtension.psm1
|
$script:ModuleRoot = $PSScriptRoot $script:ModuleVersion = (Import-PowerShellDataFile -Path "$($script:ModuleRoot)\TeamsExtension.psd1").ModuleVersion # Detect whether at some level dotsourcing was enforced $script:doDotSource = Get-PSFConfigValue -FullName TeamsExtension.Import.DoDotSource -Fallback $false if ($TeamsExtension_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 TeamsExtension.Import.IndividualFiles -Fallback $false if ($TeamsExtension_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 'TeamsExtension' -Language 'en-US' function Export-TeamMessage { <# .SYNOPSIS Exports all messages in all channels within a team. .DESCRIPTION Exports all messages in all channels within a team. This command takes any number of team IDs, iterates over all messages in each of them and then exports them. This is of course subject to the current user's access rights. It will create one sub-folder per team. In this subfolder it will then generate one json file per channel, including all the messages. .PARAMETER Team The team to export. .PARAMETER Path The path in which to generate the json-file-backed export. Specify a folder, it will create one subfolder per team exported. Defaults to the current path. .PARAMETER EnableException This parameters disables user-friendly warnings and enables the throwing of exceptions. This is less user friendly, but allows catching exceptions in calling scripts. .PARAMETER Confirm If this switch is enabled, you will be prompted for confirmation before executing any operations that change state. .PARAMETER WhatIf If this switch is enabled, no actions are performed but informational messages will be displayed that explain what would happen if the command were to run. .EXAMPLE PS C:\> Get-Team | Export-TeamMessage Export all messages in all teams you have access to to the current folder. #> [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssignments', '')] [CmdletBinding(SupportsShouldProcess = $true)] param ( [Parameter(Mandatory = $true, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true)] [Alias('GroupID')] [string[]] $Team, [string] $Path = '.', [switch] $EnableException ) process { foreach ($teamID in $Team) { Write-PSFMessage -String 'Export-TeamMessage.Processing' -StringValues $teamID -Target $teamID Invoke-PSFProtectedCommand -ActionString 'Export-TeamMessage.Create.ExportFolder' -ActionStringValues $path, $teamID -ScriptBlock { $teamFolder = New-Item -Path $Path -Name $teamID -ItemType Directory -Force -ErrorAction Stop } -Target $teamID -EnableException $EnableException -PSCmdlet $PSCmdlet -Continue $channelIndex = @{ } Write-PSFMessage -String 'Export-TeamMessage.Read.Channels' -StringValue $teeamID -Target $teamID try { $channels = Get-TeamChannel -GroupId $teamID -ErrorAction Stop } catch { Stop-PSFFunction -String 'Export-TeamMessage.Read.Channels.Failed' -StringValue $teeamID -Target $teamID -ErrorRecord $_ -EnableException $EnableException -Continue } foreach ($channel in $channels) { $fileName = "$($channel.DisplayName -replace "[^\d\w]",'_').json" $channelIndex[$channel.Id] = $channel | Add-Member -MemberType NoteProperty -Name ExportFile -Value $fileName -Force -PassThru Invoke-PSFProtectedCommand -ActionString 'Export-TeamMessage.Read.Channel.Message' -ActionStringValues $teamID, $channel.DisplayName, $channel.Id -ScriptBlock { $messages = Get-TeamChannelMessage -TeamID $teamID -ChannelID $channel.Id -ErrorAction Stop Write-PSFMessage -Level Debug -String 'Export-TeamMessage.Read.Channel.Message.Count' -StringValues $channel.Id, @($messages).Count -FunctionName Export-TeamMessage -ModuleName TeamsExtension $messages | ConvertTo-Json -Depth 99 | Set-Content -Path "$($teamFolder.FullName)/$fileName" -Encoding UTF8 -ErrorAction Stop } -Target $teamID -EnableException $EnableException -PSCmdlet $PSCmdlet -Continue } Invoke-PSFProtectedCommand -ActionString 'Export-TeamMessage.Read.Channel.Index' -ActionStringValues $teamID -ScriptBlock { $channelIndex | ConvertTo-Json -Depth 99 | Set-Content -Path "$($teamFolder.FullName)/channelIndex.json" -Encoding UTF8 -ErrorAction Stop } -Target $teamID -EnableException $EnableException -PSCmdlet $PSCmdlet -Continue } } } function Get-TeamChannelMessage { <# .SYNOPSIS Returns all messages in a specified channel's messages. .DESCRIPTION Returns all messages in a specified channel's messages. Note that the replies to a message are part of the "Replies" property. So expect one output object per conversation. .PARAMETER TeamID The ID of the team to process. .PARAMETER ChannelID The ID of the channel within the team to process. .EXAMPLE PS C:\> Get-TeamChannelMessage -TeamID $team.GroupID -ChannelID $channel.ID Retrieve all the messages in the specified channel of the specified team. #> [CmdletBinding()] param ( [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true)] [string] $TeamID, [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName = $true)] [string] $ChannelID ) process { Write-PSFMessage -String 'Get-TeamChannelMessage.Message' -StringValues $TeamID, $ChannelID $messages = Invoke-TeamRequest -Uri "teams/$TeamID/channels/$ChannelID/messages" foreach ($message in $messages) { Write-PSFMessage -String 'Get-TeamChannelMessage.Message.Replies' -StringValues $TeamID, $ChannelID, $message.ID $replies = Invoke-TeamRequest -Uri "teams/$TeamID/channels/$ChannelID/messages/$($message.ID)/replies" Add-Member -InputObject $message -MemberType NoteProperty -Name Replies -Value $replies -PassThru } } } function Invoke-TeamRequest { <# .SYNOPSIS Execute a Teams graph API Request. .DESCRIPTION Execute a Teams graph API Request. This uses (and requires) the integrated authentication provided by the MicrosoftTeams module. .PARAMETER Uri The relative URI to execute, including all parameters. .PARAMETER Method Which REST method to execute. Defaults to "GET" .PARAMETER Body A body to include with the actual request. Usually needed with POST or PATCH requests. .PARAMETER Endpoint Whether to execute against the beta or 1.0 api. Defaults to "beta" .PARAMETER Confirm If this switch is enabled, you will be prompted for confirmation before executing any operations that change state. .PARAMETER WhatIf If this switch is enabled, no actions are performed but informational messages will be displayed that explain what would happen if the command were to run. .EXAMPLE PS C:\> Invoke-TeamRequest -Uri "teams/$TeamID/channels/$ChannelID/messages" Retrieve all messages from the specified channel in the specified team. #> [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssignments', '')] [CmdletBinding(SupportsShouldProcess = $true)] param ( [Parameter(Mandatory = $true)] [string] $Uri, [ValidateSet('GET','POST','DELETE','PATCH')] [string] $Method = "GET", $Body, [ValidateSet('beta', '1.0')] [string] $Endpoint = 'beta' ) $command = [Microsoft.TeamsCmdlets.PowerShell.Custom.GetTeam]::new() $arguments = @( # cmdletName "Get-TeamChannel" # endPoint [Microsoft.TeamsCmdlets.Powershell.Connect.Common.Endpoint]::MsGraphEndpointResourceId #IEnumerable<string> requiredScopes = null $null ) $null = [PSFramework.Utility.UtilityHost]::InvokePrivateMethod("PerformAuthorization", $command, $arguments) $authorization = [PSFramework.Utility.UtilityHost]::GetPrivateProperty("Authorization", $command) $resource = [Microsoft.TeamsCmdlets.Powershell.Connect.TeamsPowerShellSession]::GetResource( [Microsoft.TeamsCmdlets.Powershell.Connect.Common.Endpoint]::MsGraphEndpointResourceId ) $params = @{ Method = $Method ErrorAction = 'Stop' } if ($Body) { $params.Body = $Body } $nextUri = "$resource/$Endpoint/$($Uri.TrimStart("/"))" while ($nextUri) { Invoke-PSFProtectedCommand -ActionString 'Invoke-TeamRequest.Request' -ActionStringValues $Method, $nextUri -ScriptBlock { $results = Invoke-RestMethod @params -Uri $nextUri -Headers @{ Authorization = $authorization } } -Target $nextUri -EnableException $true -PSCmdlet $PSCmdlet $results.Value $nextUri = $results.'@odata.nextLink' } } <# 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 'TeamsExtension' -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 'TeamsExtension' -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 'TeamsExtension' -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 'TeamsExtension.ScriptBlockName' -Scriptblock { } #> <# # Example: Register-PSFTeppScriptblock -Name "TeamsExtension.alcohol" -ScriptBlock { 'Beer','Mead','Whiskey','Wine','Vodka','Rum (3y)', 'Rum (5y)', 'Rum (7y)' } #> <# # Example: Register-PSFTeppArgumentCompleter -Command Get-Alcohol -Parameter Type -Name TeamsExtension.alcohol #> New-PSFLicense -Product 'TeamsExtension' -Manufacturer 'Friedrich Weinmann' -ProductVersion $script:ModuleVersion -ProductType Module -Name MIT -Version "1.0.0.0" -Date (Get-Date "2021-06-01") -Text @" Copyright (c) 2021 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 |