├── log └── .gitkeep ├── resources ├── version.txt ├── Test-FileIsLocked.psm1 ├── UpdateInfo.psm1 ├── VBRSessionInfo.psm1 ├── Logger.psm1 ├── ConvertTo-ByteUnit.psm1 └── DeployVeeamConfiguration.ps1 ├── .gitignore ├── asset ├── embeds.png ├── example.png ├── thumb01.png ├── installer.png └── embeds-small.png ├── .github ├── workflows │ └── main.yml ├── ISSUE_TEMPLATE │ ├── feature_request.md │ └── bug_report.md └── scripts │ ├── pssa.ps1 │ └── pssa-settings.psd1 ├── config ├── conf.json └── conf.schema.json ├── Installer.ps1 ├── Bootstrap.ps1 ├── README.md ├── Updater.ps1 ├── AlertSender.ps1 └── LICENSE /log/.gitkeep: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /resources/version.txt: -------------------------------------------------------------------------------- 1 | v2.0 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .vscode 2 | notes.md 3 | ExampleData 4 | -------------------------------------------------------------------------------- /asset/embeds.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tigattack/VeeamDiscordNotifications/HEAD/asset/embeds.png -------------------------------------------------------------------------------- /asset/example.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tigattack/VeeamDiscordNotifications/HEAD/asset/example.png -------------------------------------------------------------------------------- /asset/thumb01.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tigattack/VeeamDiscordNotifications/HEAD/asset/thumb01.png -------------------------------------------------------------------------------- /asset/installer.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tigattack/VeeamDiscordNotifications/HEAD/asset/installer.png -------------------------------------------------------------------------------- /asset/embeds-small.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tigattack/VeeamDiscordNotifications/HEAD/asset/embeds-small.png -------------------------------------------------------------------------------- /.github/workflows/main.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: CI 3 | on: 4 | push: 5 | pull_request: 6 | workflow_dispatch: 7 | 8 | jobs: 9 | lint: 10 | name: Run PSScriptAnalyzer 11 | runs-on: ubuntu-latest 12 | steps: 13 | - uses: actions/checkout@v2 14 | - name: Lint with PSScriptAnalyzer 15 | shell: pwsh 16 | run: ./.github/scripts/pssa.ps1 17 | -------------------------------------------------------------------------------- /config/conf.json: -------------------------------------------------------------------------------- 1 | { 2 | "webhook": "DiscordWebook", 3 | "thumbnail": "https://raw.githubusercontent.com/tigattack/VeeamDiscordNotifications/master/asset/thumb01.png", 4 | "userId": "123456789", 5 | "mention_on_fail": false, 6 | "mention_on_warning": false, 7 | "debug_log": false, 8 | "notify_update": true, 9 | "self_update": false, 10 | "comment": "Self-updater is still experimental. Use at your own risk." 11 | } 12 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature request 3 | about: Suggest an idea for this project 4 | title: "[FEAT] " 5 | labels: enhancement 6 | assignees: tigattack 7 | 8 | --- 9 | 10 | **Is your feature request related to a problem? Please describe.** 11 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] 12 | 13 | **Describe the solution you'd like** 14 | - Definition of done 15 | A short, concise definition of how this feature would look or work when done. 16 | - Stretch 17 | Any additional functionality that isn't required by would be nice. 18 | 19 | **Additional context** 20 | Add any other context or screenshots about the feature request here. 21 | -------------------------------------------------------------------------------- /config/conf.schema.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "http://json-schema.org/draft-04/schema#", 3 | "type": "object", 4 | "properties": { 5 | "webhook": { 6 | "type": "string" 7 | }, 8 | "thumbnail": { 9 | "type": "string" 10 | }, 11 | "userid": { 12 | "type": "string" 13 | }, 14 | "mention_on_fail": { 15 | "type": "boolean" 16 | }, 17 | "mention_on_warning": { 18 | "type": "boolean" 19 | }, 20 | "debug_log": { 21 | "type": "boolean" 22 | }, 23 | "notify_update": { 24 | "type": "boolean" 25 | }, 26 | "self_update": { 27 | "type": "boolean" 28 | }, 29 | "comment": { 30 | "type": "string" 31 | } 32 | }, 33 | "required": [ 34 | "webhook", 35 | "thumbnail" 36 | ] 37 | } 38 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report 3 | about: Create a report to help us improve 4 | title: "[BUG] " 5 | labels: bug 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Describe the bug** 11 | A clear and concise description of what the bug is. 12 | 13 | **To Reproduce** 14 | Steps to reproduce the behavior: 15 | 16 | **Expected behavior** 17 | A clear and concise description of what you expected to happen. 18 | 19 | **Relevant part of `log/debug.log`** 20 | _If you don't see a `debug.log`, set `debug_log` to true in `config/conf.json` and reproduce the issue._ 21 | 22 | **Screenshots** 23 | If applicable, add screenshots to help explain your problem. 24 | 25 | **Additional context** 26 | Add any other context about the problem here. 27 | -------------------------------------------------------------------------------- /resources/Test-FileIsLocked.psm1: -------------------------------------------------------------------------------- 1 | Function Test-FileIsLocked { 2 | [cmdletbinding()] 3 | Param ( 4 | [parameter(Mandatory=$True,ValueFromPipeline=$True,ValueFromPipelineByPropertyName=$True)] 5 | [Alias('FullName','PSPath')] 6 | [string[]]$Path 7 | ) 8 | Process { 9 | ForEach ($Item in $Path) { 10 | #Ensure this is a full path 11 | $Item = Convert-Path $Item 12 | #Verify that this is a file and not a directory 13 | If ([System.IO.File]::Exists($Item)) { 14 | Try { 15 | $FileStream = [System.IO.File]::Open($Item,'Open','Write') 16 | $FileStream.Close() 17 | $FileStream.Dispose() 18 | $IsLocked = $False 19 | } 20 | Catch [System.UnauthorizedAccessException] { 21 | $IsLocked = 'AccessDenied' 22 | } 23 | Catch { 24 | $IsLocked = $True 25 | } 26 | [pscustomobject]@{ 27 | File = $Item 28 | IsLocked = $IsLocked 29 | } 30 | } 31 | } 32 | } 33 | } 34 | -------------------------------------------------------------------------------- /resources/UpdateInfo.psm1: -------------------------------------------------------------------------------- 1 | function Get-UpdateStatus { 2 | 3 | process { 4 | # Get currently downloaded version of this project. 5 | $currentVersion = (Get-Content "$PSScriptRoot\version.txt" -Raw).Replace("`n",'') 6 | 7 | # Get latest release from GitHub. 8 | [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 9 | $latestRelease = Invoke-WebRequest -Uri https://github.com/tigattack/VeeamDiscordNotifications/releases/latest ` 10 | -Headers @{'Accept'='application/json'} -UseBasicParsing 11 | 12 | # Release IDs are returned in a format of {"id":3622206,"tag_name":"v1.0"}, so we need to extract tag_name. 13 | $latestVersion = ConvertFrom-Json $latestRelease.Content | ForEach-Object {$_.tag_name} 14 | 15 | If ($currentVersion -gt $latestVersion) { 16 | $status = 'Ahead' 17 | } 18 | elseif ($currentVersion -lt $latestVersion) { 19 | $status = 'Behind' 20 | } 21 | else { 22 | $status = 'Current' 23 | } 24 | 25 | # Create PSObject to return. 26 | $out = New-Object PSObject -Property @{ 27 | CurrentVersion = $currentVersion 28 | LatestVersion = $latestVersion 29 | Status = $status 30 | } 31 | 32 | # Return PSObject. 33 | return $out 34 | } 35 | } 36 | -------------------------------------------------------------------------------- /resources/VBRSessionInfo.psm1: -------------------------------------------------------------------------------- 1 | Function Get-VBRSessionInfo { 2 | param ( 3 | [Parameter(Mandatory=$true)]$SessionId, 4 | [Parameter(Mandatory=$true)]$JobType 5 | ) 6 | 7 | # Import VBR module 8 | Import-Module Veeam.Backup.PowerShell -DisableNameChecking 9 | 10 | If (($null -ne $SessionId) -and ($null -ne $JobType)) { 11 | 12 | # Switch on job type. 13 | Switch ($JobType) { 14 | 15 | # VM job 16 | {$_ -in 'Backup','Replica'} { 17 | 18 | # Get the session details. 19 | $session = Get-VBRBackupSession | Where-Object {$_.Id.Guid -eq $SessionId} 20 | 21 | # Get the job's name from the session details. 22 | $jobName = $session.Name 23 | } 24 | 25 | # Agent job 26 | {$_ -eq 'EpAgentBackup'} { 27 | # Get the session details. 28 | $session = [Veeam.Backup.Core.CBackupSession]::GetByOriginalSessionId($SessionId) 29 | 30 | # Copy the job's name to it's own variable. 31 | $jobName = $job.Info.Name 32 | } 33 | } 34 | 35 | # Create PSObject to return. 36 | New-Object PSObject -Property @{ 37 | Session = $session 38 | JobName = $jobName 39 | } 40 | } 41 | 42 | Elseif ($null -eq $SessionId) { 43 | Write-LogMessage -Tag 'Warning' -Message 'SessionId is null.' 44 | } 45 | 46 | Elseif ($null -eq $JobType) { 47 | Write-LogMessage -Tag 'Warning' -Message 'JobType is null.' 48 | } 49 | } 50 | -------------------------------------------------------------------------------- /resources/Logger.psm1: -------------------------------------------------------------------------------- 1 | # This function log messages with a type tag 2 | Function Write-LogMessage { 3 | [CmdletBinding( 4 | SupportsShouldProcess, 5 | ConfirmImpact = 'Low' 6 | )] 7 | Param ( 8 | $Tag, 9 | $Message 10 | ) 11 | $time = Get-Date -Format 'HH:mm:ss.ff' 12 | If ($PSCmdlet.ShouldProcess('Output stream', 'Write log message')) { 13 | Write-Output "[$time] $($Tag.ToUpper()): $Message" 14 | } 15 | } 16 | 17 | # These functions handle Logging 18 | Function Start-Logging { 19 | [CmdletBinding( 20 | SupportsShouldProcess, 21 | ConfirmImpact = 'Low' 22 | )] 23 | Param( 24 | [Parameter(Mandatory)] 25 | $Path, 26 | [Switch] 27 | $Append 28 | ) 29 | If ($PSCmdlet.ShouldProcess($Path, 'Start-Transcript')) { 30 | Try { 31 | Start-Transcript -Path $Path -Force -Append | Out-Null 32 | Write-LogMessage -Tag 'INFO' -Message "Transcript is being logged to '$Path'." 33 | } 34 | Catch [System.IO.IOException] { 35 | Write-LogMessage -Tag 'INFO' -Message "Transcript is already being logged to '$Path'." 36 | } 37 | } 38 | } 39 | 40 | Function Stop-Logging { 41 | [CmdletBinding( 42 | SupportsShouldProcess, 43 | ConfirmImpact = 'Low' 44 | )] 45 | Param() 46 | If ($PSCmdlet.ShouldProcess('log file', 'Stop-Transcript')) { 47 | Write-LogMessage -Tag 'INFO' -Message 'Stopping transcript logging.' 48 | Stop-Transcript 49 | } 50 | } 51 | -------------------------------------------------------------------------------- /resources/ConvertTo-ByteUnit.psm1: -------------------------------------------------------------------------------- 1 | function ConvertTo-ByteUnit { 2 | <# 3 | .Synopsis 4 | Converts raw numbers to byte units. 5 | .DESCRIPTION 6 | Converts raw numbers to byte units, dynamically deciding which unit (i.e. B, KB, MB, etc.) based on the input figure. 7 | .EXAMPLE 8 | ConvertTo-ByteUnit -Data 1024 9 | .EXAMPLE 10 | ConvertTo-ByteUnit -Data ((Get-ChildItem -Path ./ -Recurse | Measure-Object -Property Length -Sum).Sum) 11 | #> 12 | [CmdletBinding()] 13 | Param ( 14 | [Parameter (Mandatory)] 15 | $Data 16 | ) 17 | 18 | begin {} 19 | 20 | process { 21 | switch ($Data) { 22 | {$_ -ge 1TB } { 23 | $Value = $Data / 1TB 24 | [String]$Value = [math]::Round($Value,2) 25 | $Value += ' TB' 26 | break 27 | } 28 | {$_ -ge 1GB } { 29 | $Value = $Data / 1GB 30 | [String]$Value = [math]::Round($Value,2) 31 | $Value += ' GB' 32 | break 33 | } 34 | {$_ -ge 1MB } { 35 | $Value = $Data / 1MB 36 | [String]$Value = [math]::Round($Value,2) 37 | $Value += ' MB' 38 | break 39 | } 40 | {$_ -ge 1KB } { 41 | $Value = $Data / 1KB 42 | [String]$Value = [math]::Round($Value,2) 43 | $Value += ' KB' 44 | break 45 | } 46 | {$_ -lt 1KB} { 47 | $Value = $Data 48 | [String]$Value = [math]::Round($Value,2) 49 | $Value += ' B' 50 | break 51 | } 52 | default { 53 | $Value = $Data 54 | break 55 | } 56 | } 57 | Write-Output $Value 58 | } 59 | 60 | end {} 61 | } 62 | -------------------------------------------------------------------------------- /.github/scripts/pssa.ps1: -------------------------------------------------------------------------------- 1 | # Install PSSA module 2 | Set-PSRepository PSGallery -InstallationPolicy Trusted 3 | Install-Module PSScriptAnalyzer -ErrorAction Stop 4 | 5 | # Get all relevant PowerShell files 6 | $psFiles = Get-ChildItem -Path ./* -Include *.ps1,*.psm1 -Recurse 7 | 8 | # Run PSSA 9 | $issues = foreach ($i in $psFiles.FullName) { 10 | Invoke-ScriptAnalyzer -Path $i -Recurse -Settings ./.github/scripts/pssa-settings.psd1 11 | } 12 | 13 | # init and set variables 14 | $errors = $warnings = $infos = $unknowns = 0 15 | 16 | # Get results, types and report to GitHub Actions 17 | foreach ($i in $issues) { 18 | switch ($i.Severity) { 19 | {$_ -eq 'Error' -or $_ -eq 'ParseError'} { 20 | Write-Output "::error file=$($i.ScriptName),line=$($i.Line),col=$($i.Column)::$($i.RuleName) - $($i.Message)" 21 | $errors++ 22 | } 23 | {$_ -eq 'Warning'} { 24 | Write-Output "::warning file=$($i.ScriptName),line=$($i.Line),col=$($i.Column)::$($i.RuleName) - $($i.Message)" 25 | $warnings++ 26 | } 27 | {$_ -eq 'Information'} { 28 | Write-Output "::warning file=$($i.ScriptName),line=$($i.Line),col=$($i.Column)::$($i.RuleName) - $($i.Message)" 29 | $infos++ 30 | } 31 | Default { 32 | Write-Output "::debug file=$($i.ScriptName),line=$($i.Line),col=$($i.Column)::$($i.RuleName) - $($i.Message)" 33 | $unknowns++ 34 | } 35 | } 36 | } 37 | 38 | # Report summary to GitHub Actions 39 | If ($unknowns -gt 0) { 40 | Write-Output "There were $errors errors, $warnings warnings, $infos infos, and $unknowns unknowns in total." 41 | } 42 | Else { 43 | Write-Output "There were $errors errors, $warnings warnings, and $infos infos in total." 44 | } 45 | 46 | # Exit with error if any PSSA errors 47 | If ($errors -gt 0) { 48 | exit 1 49 | } 50 | -------------------------------------------------------------------------------- /.github/scripts/pssa-settings.psd1: -------------------------------------------------------------------------------- 1 | # Settings for PSScriptAnalyzer invocation. 2 | @{ 3 | ExcludeRules = @( 4 | 'PSReviewUnusedParameter' # Required due to PowerShell/PSScriptAnalyzer#1472. 5 | ) 6 | Rules = @{ 7 | PSAvoidUsingDoubleQuotesForConstantString = @{ 8 | Enable = $true 9 | } 10 | PSAvoidUsingPositionalParameters = @{ 11 | Enable = $true 12 | } 13 | PSUseCompatibleCommands = @{ 14 | Enable = $true 15 | # PowerShell platforms we want to check compatibility with 16 | TargetProfiles = @( 17 | 'win-8_x64_10.0.14393.0_5.1.14393.2791_x64_4.0.30319.42000_framework', # PowerShell 5.1 on Windows Server 2016 18 | 'win-8_x64_10.0.17763.0_5.1.17763.316_x64_4.0.30319.42000_framework', # PowerShell 5.1 on Windows Server 2019 19 | 'win-48_x64_10.0.17763.0_5.1.17763.316_x64_4.0.30319.42000_framework'#, # PowerShell 5.1 on Windows 10 20 | #'win-8_x64_10.0.14393.0_6.2.4_x64_4.0.30319.42000_core', # PowerShell 6.2 on Windows Server 2016 21 | #'win-8_x64_10.0.17763.0_6.2.4_x64_4.0.30319.42000_core', # PowerShell 6.2 on Windows Server 2019 22 | #'win-4_x64_10.0.18362.0_6.2.4_x64_4.0.30319.42000_core', # PowerShell 6.2 on Windows 10 23 | #'win-8_x64_10.0.14393.0_7.0.0_x64_3.1.2_core', # PowerShell 7.0 on Windows Server 2016 24 | #'win-8_x64_10.0.17763.0_7.0.0_x64_3.1.2_core', # PowerShell 7.0 on Server 2019 25 | #'win-4_x64_10.0.18362.0_7.0.0_x64_3.1.2_core' # PowerShell 7.0 on Windows 10 26 | ) 27 | } 28 | PSUseCompatibleSyntax = @{ 29 | Enable = $true 30 | # PowerShell versions we want to check compatibility with 31 | TargetVersions = @( 32 | '5.1'#, 33 | #'6.2', 34 | #'7.1' 35 | ) 36 | } 37 | PSPlaceCloseBrace = @{ 38 | Enable = $true 39 | NoEmptyLineBefore = $false 40 | IgnoreOneLineBlock = $true 41 | NewLineAfter = $true 42 | } 43 | PSPlaceOpenBrace = @{ 44 | Enable = $true 45 | OnSameLine = $true 46 | NewLineAfter = $true 47 | IgnoreOneLineBlock = $true 48 | } 49 | PSUseConsistentIndentation = @{ 50 | Enable = $true 51 | IndentationSize = 4 52 | PipelineIndentation = 'IncreaseIndentationForFirstPipeline' 53 | Kind = 'tab' 54 | } 55 | PSAvoidLongLines = @{ 56 | Enable = $true 57 | MaximumLineLength = 155 58 | } 59 | } 60 | } 61 | -------------------------------------------------------------------------------- /Installer.ps1: -------------------------------------------------------------------------------- 1 | #Requires -RunAsAdministrator 2 | 3 | # Prepare variables 4 | $rootPath = 'C:\VeeamScripts' 5 | $project = 'VeeamDiscordNotifications' 6 | $webhookRegex = 'https:\/\/(.*\.)?discord(app)?\.com\/api\/webhooks\/([^\/]+)\/([^\/]+)' 7 | 8 | # Get latest release from GitHub 9 | [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 10 | $latestVersion = ((Invoke-WebRequest -Uri "https://github.com/tigattack/$project/releases/latest" ` 11 | -Headers @{'Accept'='application/json'} -UseBasicParsing).Content | ConvertFrom-Json).tag_name 12 | 13 | # Check if this project is already installed and, if so, whether it's the latest version. 14 | if (Test-Path $rootPath\$project) { 15 | Write-Output 'VeeamDiscordNotifications is already installed; Checking version.' 16 | $installedVersion = Get-Content -Raw "$rootPath\$project\resources\version.txt" 17 | If ($installedVersion -ge $latestVersion) { 18 | Write-Output "VeeamDiscordNotifications is already up to date.`nExiting." 19 | exit 20 | } 21 | } 22 | 23 | # Check user has webhook URL ready 24 | $userPrompt = Read-Host -Prompt 'Do you have your Discord webhook URL ready? Y/N' 25 | 26 | # Prompt user to create webhook first if not ready 27 | If ($userPrompt -ne 'Y') { 28 | Write-Output 'Please create a Discord webhook before continuing.' 29 | Write-Output 'Full instructions available at https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks' 30 | 31 | # Prompt user to launch URL 32 | $launchPrompt = Read-Host -Prompt 'Open URL? Y/N' 33 | If ($launchPrompt -eq 'Y') { 34 | Start-Process 'https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks' 35 | } 36 | 37 | exit 38 | } 39 | 40 | # Prompt user with config options 41 | do { 42 | $webhookUrl = Read-Host -Prompt 'Please enter your Discord webhook URL' 43 | If ($webhookUrl -notmatch $webhookRegex) { 44 | Write-Output "`nInvalid webhook URL. Please try again." 45 | } 46 | } 47 | until ($webhookUrl -match $webhookRegex) 48 | 49 | Write-Output "`nDo you wish to be mentioned in Discord when a job fails or finishes with warnings?" 50 | 51 | do { 52 | $mentionPreference = Read-Host -Prompt "1 = No`n2 = On warn`n3 = On fail`n4 = On fail and on warn`nYour choice" 53 | If (1..4 -notcontains $mentionPreference) { 54 | Write-Output "`nInvalid choice. Please try again." 55 | } 56 | } 57 | until (1..4 -contains $mentionPreference) 58 | 59 | If ($mentionPreference -ne 1) { 60 | do { 61 | try { 62 | [Int64]$userId = Read-Host -Prompt "`nPlease enter your Discord user ID" 63 | } 64 | catch [System.Management.Automation.ArgumentTransformationMetadataException] { 65 | Write-Output "`nInvalid user ID. Please try again." 66 | } 67 | } 68 | until ($userId.ToString().Length -gt 1) 69 | } 70 | 71 | # Pull latest version of script from GitHub 72 | Invoke-WebRequest -Uri ` 73 | "https://github.com/tigattack/$project/releases/download/$latestVersion/$project-$latestVersion.zip" ` 74 | -OutFile "$env:TEMP\$project-$latestVersion.zip" 75 | 76 | # Unblock downloaded ZIP 77 | Unblock-File -Path "$env:TEMP\$project-$latestVersion.zip" 78 | 79 | # Extract release to destination path 80 | Expand-Archive -Path "$env:TEMP\$project-$latestVersion.zip" -DestinationPath "$rootPath" 81 | 82 | # Rename destination and tidy up 83 | Rename-Item -Path "$rootPath\$project-$latestVersion" -NewName "$rootPath\$project" 84 | Remove-Item -Path "$env:TEMP\$project-$latestVersion.zip" 85 | 86 | # Get config 87 | $config = Get-Content "$rootPath\$project\config\conf.json" -Raw | ConvertFrom-Json 88 | $config.webhook = $webhookUrl 89 | 90 | Switch ($mentionPreference) { 91 | 1 { 92 | $config.mention_on_fail = $false 93 | $config.mention_on_warning = $false 94 | } 95 | 2 { 96 | $config.mention_on_fail = $false 97 | $config.mention_on_warning = $true 98 | $config.userId = $userId 99 | } 100 | 3 { 101 | $config.mention_on_fail = $true 102 | $config.mention_on_warning = $false 103 | $config.userId = $userId 104 | } 105 | 4 { 106 | $config.mention_on_fail = $true 107 | $config.mention_on_warning = $true 108 | $config.userId = $userId 109 | } 110 | } 111 | 112 | # Write config 113 | ConvertTo-Json $config | Set-Content "$rootPath\$project\config\conf.json" 114 | 115 | # Run Post Script action. 116 | & "$rootPath\$project\resources\DeployVeeamConfiguration.ps1" 117 | -------------------------------------------------------------------------------- /Bootstrap.ps1: -------------------------------------------------------------------------------- 1 | # Import modules 2 | Import-Module Veeam.Backup.PowerShell -DisableNameChecking 3 | Import-Module "$PSScriptRoot\resources\Logger.psm1" 4 | Import-Module "$PSScriptRoot\resources\VBRSessionInfo.psm1" 5 | 6 | # Set vars 7 | $configFile = "$PSScriptRoot\config\conf.json" 8 | $date = (Get-Date -UFormat %Y-%m-%d_%T).Replace(':','.') 9 | $logFile = "$PSScriptRoot\log\$($date)_Bootstrap.log" 10 | $idRegex = '[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}' 11 | $supportedTypes = 'Backup', 'EpAgentBackup','Replica' 12 | 13 | # Start logging to file 14 | Start-Logging -Path $logFile 15 | 16 | # Log version 17 | Write-LogMessage -Tag 'INFO' -Message "Version: $(Get-Content "$PSScriptRoot\resources\version.txt" -Raw)" 18 | 19 | # Retrieve configuration. 20 | ## Pull config to PSCustomObject 21 | $config = Get-Content -Raw $configFile | ConvertFrom-Json # TODO: import config from param instead of later as file. Can then improve logging flow. 22 | 23 | # Stop logging and remove log file if logging is disable in config. 24 | If (-not $config.debug_log) { 25 | Stop-Logging 26 | Remove-Item $logFile -Force -ErrorAction SilentlyContinue 27 | } 28 | 29 | ## Pull raw config and format for later. 30 | ## This is necessary since $config as a PSCustomObject was not passed through correctly with Start-Process and $powershellArguments. 31 | $configRaw = (Get-Content -Raw $configFile).Replace('"','\"').Replace("`n",'').Replace("`t",'').Replace(' ',' ') 32 | 33 | ## Test config. 34 | Try { 35 | $configSchema = Get-Content -Raw "$PSScriptRoot\config\conf.schema.json" | ConvertFrom-Json 36 | foreach ($i in $configSchema.required) { 37 | If (-not (Get-Member -InputObject $config -Name "$i" -Membertype NoteProperty)) { 38 | throw "Required configuration property is missing. Property: $i" 39 | } 40 | } 41 | } 42 | Catch { 43 | Write-LogMessage -Tag 'ERROR' -Message "Failed to validate configuration: $_" 44 | } 45 | 46 | # Get the command line used to start the Veeam session. 47 | $parentPid = (Get-CimInstance Win32_Process -Filter "processid='$PID'").parentprocessid.ToString() 48 | $parentCmd = (Get-CimInstance Win32_Process -Filter "processid='$parentPID'").CommandLine 49 | 50 | # Get the Veeam job and session IDs 51 | $jobId = ([regex]::Matches($parentCmd, $idRegex)).Value[0] 52 | $sessionId = ([regex]::Matches($parentCmd, $idRegex)).Value[1] 53 | 54 | # Get the Veeam job details and hide warnings to mute the warning regarding deprecation of the use of this cmdlet to get Agent job details. 55 | # At time of writing, there is no alternative way to discover the job time. 56 | $job = Get-VBRJob -WarningAction SilentlyContinue | Where-Object {$_.Id.Guid -eq $jobId} 57 | 58 | # Quit if job type is not supported. 59 | If ($job.JobType -notin $supportedTypes) { 60 | Write-LogMessage -Tag 'ERROR' -Message "Job type '$($job.JobType)' is not supported." 61 | Exit 1 62 | } 63 | 64 | # Get the session information and name. 65 | $sessionInfo = Get-VBRSessionInfo -SessionID $sessionId -JobType $job.JobType 66 | $jobName = $sessionInfo.JobName 67 | 68 | Write-LogMessage -Tag 'INFO' -Message "Bootstrap script for Veeam job '$jobName' (job $jobId session $sessionId) - Session & job detection complete." 69 | 70 | # Set log file name based on job 71 | ## Replace spaces if any in the job name 72 | If ($jobName -match ' ') { 73 | $logJobName = $jobName.Replace(' ', '_') 74 | } 75 | Else { 76 | $logJobName = $jobName 77 | } 78 | $newLogfile = "$PSScriptRoot\log\$($date)-$($logJobName).log" 79 | 80 | # Build argument string for the alert sender script. 81 | $powershellArguments = "-file $PSScriptRoot\AlertSender.ps1", "-JobName `"$jobName`"", "-Id `"$sessionId`"","-JobType `"$($job.JobType)`"", ` 82 | "-Config `"$($configRaw)`"", "-Logfile `"$newLogfile`"" 83 | 84 | # Start a new new script in a new process with some of the information gathered here. 85 | # This allows Veeam to finish the current session faster and allows us gather information from the completed job. 86 | Start-Process -FilePath 'powershell' -Verb runAs -ArgumentList $powershellArguments -WindowStyle hidden 87 | 88 | # Stop logging. 89 | If ($config.debug_log) { 90 | Stop-Logging 91 | 92 | # Rename log file to include the job name. 93 | Try { 94 | Rename-Item -Path $logFile -NewName "$newLogfile" 95 | } 96 | Catch { 97 | Write-LogMessage -Tag 'ERROR' -Message "Failed to rename log file: $_" 98 | } 99 | } 100 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Veeam Backup & Replication Notifications for Discord 2 | 3 | ## VeeamDiscordNotifications has been replaced by [VeeamNotify](https://github.com/tigattack/VeeamNotify). 4 | 5 | This repository is now archived. 6 | 7 | --- 8 | 9 | Send Veeam Backup & Replication session summary notifications to Discord, detailing session result and statistics and optionally alerting you via mention when a job finishes in a warning or failed state. 10 | 11 | Notification Example 12 | 13 | ## Installing 14 | 15 | * Option 1 - Install script. This option will also optionally configure your any supported jobs to send Discord notifications. 16 | 1. Download [Installer.ps1](Installer.ps1). 17 | 2. Open PowerShell (as Administrator) on your Veeam server. 18 | 3. Run the following commands: 19 | ```powershell 20 | PS> Set-ExecutionPolicy -Scope Process -ExecutionPolicy Unrestricted -Force 21 | PS> Unblock-File C:\path\to\Installer.ps1 22 | PS> C:\path\to\Installer.ps1 23 | ``` 24 | Installer Example 25 | 26 | * Option 2 - Manual install 27 | * Follow the [setup instructions](https://blog.tiga.tech/veeam-b-r-notifications-in-discord/). 28 | 29 | ### Looking for volunteers 30 | 31 | If you enjoy this project and would like to help out, please do so. If you're interested in helping out, contact me on Discord - `tigatack#7987` 32 | 33 | As much as I love this project, free time is hard to find and some work is needed to add functionality for more types of jobs, add more optional detail to outputs, and to bring this project in-line with recent changes in Veeam Backup & Replication (VBR) and VBR's PowerShell module. 34 | 35 | ## Supported Job Types 36 | 37 | * VM Backup 38 | * VM Replication 39 | * Agent jobs managed by backup server 40 | 41 | ### Agent job caveats 42 | 43 | Due to limitations caused by the way some types of Veeam Agent jobs are executed, only Agent jobs of type "Managed by backup server" support post-job scripts. 44 | Such jobs will show up as follows: 45 | * In Veeam Backup & Replication Console, with type "Windows/Linux Agent Backup". 46 | If you see "Windows/Linux Agent _Policy_", this job is not supported. 47 | * In Veeam Backup & Replication PowerShell module, with type "EpAgentBackup". 48 | If you see "EpAgentPolicy", this job is not supported. 49 | 50 | You can read about the difference between these two Agent job types [here](https://helpcenter.veeam.com/docs/backup/agents/agent_job_protection_mode.html?ver=110#selecting-job-mode). 51 | 52 | Unfortunately, even Agent job sessions managed by the backup server, while supported, are limited in data output. 53 | As much relevant information as I've been able to discover from such job sessions is included in the Discord embed, but I welcome any suggestions for improvement in this area. 54 | 55 | ## Configuration options 56 | 57 | Configuration can be found in `C:\VeeamScripts\VeeamDiscordNotifications\config\conf.json` 58 | 59 | | Name | Type | Required | Default | Description | 60 | |--------------------- |-------- |--------- |------------------ | ---------------------------------------------------------------------------------------------------------- | 61 | | `webhook` | string | True | null | Your Discord webhook URL. | 62 | | `thumbnail` | string | False | See example above | Image URL for the thumbnail shown in the report embed. | 63 | | `userid` | string | False | null | Your Discord user ID. Required if either of the following two options are `true`. | 64 | | `mention_on_fail` | boolean | False | False | When `true`, you will be mentioned when a job finishes in a failed state. Requires that `userid` is set. | 65 | | `mention_on_warning` | boolean | False | False | When `true`, you will be mentioned when a job finishes in a warning state. Requires that `userid` is set. | 66 | | `debug_log` | boolean | False | False | When `true`, the script will log to a file in ./log/ | 67 | | `notify_update` | boolean | False | True | When `true`, the script will notify (but not mention) you on Discord if there's a newer version available. | 68 | | `self_update` | boolean | False | False | When `true`, the script will update itself if there's a newer version available. | 69 | 70 | --- 71 | 72 | ## [Slack fork.](https://github.com/tigattack/VeeamSlackNotifications) 73 | 74 | ## [MS Teams fork.](https://github.com/tigattack/VeeamTeamsNotifications) 75 | 76 | ## Credits 77 | 78 | [MelonSmasher](https://github.com/MelonSmasher)//[TheSageColleges](https://github.com/TheSageColleges) for [the project](https://github.com/TheSageColleges/VeeamSlackNotifications) on which this is (now loosely) based. 79 | [dantho281](https://github.com/dantho281) for various things - Assistance with silly little issues, the odd bugfix here and there, and the inspiration for and first works on the `Updater.ps1` script. 80 | [Lee_Dailey](https://reddit.com/u/Lee_Dailey) for general pointers and the [first revision](https://pastebin.com/srN5CKty) of the `ConvertTo-ByteUnit` function. 81 | [philenst](https://github.com/philenst) for the `DeployVeeamConfiguration.ps1` script. 82 | [s0yun](https://github.com/s0yun) for the `Installer.ps1` script. 83 | 84 | Thank you all. 85 | -------------------------------------------------------------------------------- /resources/DeployVeeamConfiguration.ps1: -------------------------------------------------------------------------------- 1 | # Function to be used when an error is encountered 2 | function DeploymentError { 3 | $issues = 'https://github.com/tigattack/VeeamDiscordNotifications/issues' 4 | 5 | Write-Output "An error occured: $($_.ScriptStackTrace)" 6 | Write-Output "Please raise an issue at $issues" 7 | 8 | do { 9 | $launchIssues = Read-Host -Prompt 'Do you wish to launch this URL? Y/N' 10 | } 11 | until ($launchIssues -eq 'Y' -or $launchIssues -eq 'N') 12 | If ($launchIssues -eq 'Y') { 13 | Start-Process "$issues/new?assignees=tigattack&labels=bug&template=bug_report.md&title=[BUG]+Veeam%20configuration%20deployment%20error" 14 | } 15 | } 16 | 17 | # Post-job script for Discord notifications 18 | $newPostScriptCmd = 'C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe -ExecutionPolicy Bypass -File C:\VeeamScripts\VeeamDiscordNotifications\Bootstrap.ps1' 19 | 20 | # Import Veeam module 21 | Import-Module Veeam.Backup.PowerShell -DisableNameChecking 22 | 23 | # Get all supported jobs 24 | $backupJobs = Get-VBRJob -WarningAction SilentlyContinue | Where-Object { 25 | $_.JobType -in 'Backup', 'Replica', 'EpAgentBackup' 26 | } 27 | 28 | # Make sure we found some jobs 29 | if ($backupJobs.Count -eq 0) { 30 | Write-Output 'No supported jobs found; Exiting.' 31 | Start-Sleep 10 32 | exit 33 | } 34 | else { 35 | Write-Output "Found $($backupJobs.count) supported jobs:" 36 | Format-Table -InputObject $backupJobs -Property Name,@{Name='Type'; Expression={$_.TypeToString}} -AutoSize 37 | } 38 | 39 | # Query configure all or selected jobs 40 | do { 41 | $configChoice = Read-Host -Prompt 'Do you wish to configure all supported jobs, make a decision for each job, or configure none? A(ll)/D(ecide)/N(one)' 42 | } 43 | until ($configChoice -in 'A', 'All', 'D', 'Decide', 'N', 'None') 44 | 45 | If ($configChoice -in 'D', 'Decide') { 46 | # Run foreach loop for all found backup jobs 47 | foreach ($job in $backupJobs) { 48 | # Set name string 49 | $jobName = "`"$($job.Name)`"" 50 | 51 | # Get post-job script options for job 52 | $jobOptions = $job.GetOptions() 53 | $postScriptEnabled = $jobOptions.JobScriptCommand.PostScriptEnabled 54 | $postScriptCmd = $jobOptions.JobScriptCommand.PostScriptCommandLine 55 | 56 | # Check if job is already configured with correct post-job script 57 | if ($postScriptCmd.EndsWith('\Bootstrap.ps1') -or $postScriptCmd.EndsWith("\Bootstrap.ps1'")) { 58 | Write-Output "`n$($jobName) is already configured for Discord notifications; Skipping." 59 | Continue 60 | } 61 | elseif ($postScriptCmd.EndsWith('\DiscordNotificationBootstrap.ps1') -or $postScriptCmd.EndsWith("\DiscordNotificationBootstrap.ps1'")) { 62 | Write-Output "`n$($jobName) is configured for an older version of Discord notifications; Updating..." 63 | try { 64 | # Sets post-job script to Enabled and sets the command line to full command including path. 65 | $jobOptions.JobScriptCommand.PostScriptEnabled = $true 66 | $jobOptions.JobScriptCommand.PostScriptCommandLine = $newPostScriptCmd 67 | Set-VBRJobOptions -Job $job -Options $jobOptions | Out-Null 68 | 69 | Write-Output "$($jobName) is now updated." 70 | } 71 | catch { 72 | DeploymentError 73 | } 74 | Continue 75 | } 76 | 77 | # Different actions whether post-job script is already enabled. If yes we ask to modify it, if not we ask to enable & set it. 78 | if ($postScriptEnabled) { 79 | Write-Output "`n$($jobName) has an existing post-job script.`nScript: $postScriptCmd" 80 | Write-Output "`nIf you wish to receive Discord notifications for this job, you must overwrite the existing post-job script." 81 | 82 | do { 83 | $overWriteCurrentCmd = Read-Host -Prompt 'Do you wish to overwrite it? Y/N' 84 | } 85 | until ($overWriteCurrentCmd -in 'Y', 'N') 86 | 87 | switch ($overWriteCurrentCmd) { 88 | 89 | # Default action will be to skip the job. 90 | default { Write-Output "`nSkipping job $($jobName)`n"} 91 | Y { 92 | try { 93 | # Check to see if the script has even changed 94 | if ($postScriptCmd -ne $newPostScriptCmd) { 95 | 96 | # Script is not the same. Update the script command line. 97 | $jobOptions.JobScriptCommand.PostScriptCommandLine = $newPostScriptCmd 98 | Set-VBRJobOptions -Job $job -Options $jobOptions | Out-Null 99 | 100 | Write-Output "Updated post-job script for job $($jobName).`nOld: $postScriptCmd`nNew: $newPostScriptCmd" 101 | Write-Output "$($jobName) is now configured for Discord notifications." 102 | } 103 | else { 104 | # Script hasn't changed. Notify user of this and continue. 105 | Write-Output "$($jobName) is already configured for Discord notifications; Skipping." 106 | } 107 | } 108 | catch { 109 | DeploymentError 110 | } 111 | } 112 | } 113 | } 114 | else { 115 | do { 116 | $setNewPostScript = Read-Host -Prompt "`nDo you wish to receive Discord notifications for $($jobName) ($($job.TypeToString))? Y/N" 117 | } 118 | until ($setNewPostScript -in 'Y', 'N') 119 | 120 | Switch ($setNewPostScript) { 121 | # Default action will be to skip the job. 122 | default { Write-Output "Skipping job $($jobName)"} 123 | Y { 124 | try { 125 | # Sets post-job script to Enabled and sets the command line to full command including path. 126 | $jobOptions.JobScriptCommand.PostScriptEnabled = $true 127 | $jobOptions.JobScriptCommand.PostScriptCommandLine = $newPostScriptCmd 128 | Set-VBRJobOptions -Job $job -Options $jobOptions | Out-Null 129 | 130 | Write-Output "`n$($jobName) is now configured for Discord notifications." 131 | } 132 | catch { 133 | DeploymentError 134 | } 135 | } 136 | } 137 | } 138 | } 139 | } 140 | 141 | elseif ($configChoice -in 'A', 'All') { 142 | # Run foreach loop for all found backup jobs 143 | foreach ($job in $backupJobs) { 144 | # Set name string 145 | $jobName = "`"$($job.Name)`"" 146 | 147 | # Get post-job script options for job 148 | $jobOptions = $job.GetOptions() 149 | $postScriptEnabled = $jobOptions.JobScriptCommand.PostScriptEnabled 150 | $postScriptCmd = $jobOptions.JobScriptCommand.PostScriptCommandLine 151 | 152 | # Check if job is already configured with correct post-job script 153 | if ($postScriptCmd.EndsWith('\Bootstrap.ps1') -or $postScriptCmd.EndsWith("\Bootstrap.ps1'")) { 154 | Write-Output "`n$($jobName) is already configured for Discord notifications; Skipping." 155 | Continue 156 | } 157 | elseif ($postScriptCmd.EndsWith('\DiscordNotificationBootstrap.ps1') -or $postScriptCmd.EndsWith("\DiscordNotificationBootstrap.ps1'")) { 158 | Write-Output "`n$($jobName) is configured for an older version of Discord notifications; Updating..." 159 | try { 160 | # Sets post-job script to Enabled and sets the command line to full command including path. 161 | $jobOptions.JobScriptCommand.PostScriptEnabled = $true 162 | $jobOptions.JobScriptCommand.PostScriptCommandLine = $newPostScriptCmd 163 | Set-VBRJobOptions -Job $job -Options $jobOptions | Out-Null 164 | 165 | Write-Output "$($jobName) is now updated." 166 | } 167 | catch { 168 | DeploymentError 169 | } 170 | Continue 171 | } 172 | 173 | # Different actions whether post-job script is already enabled. If yes we ask to modify it, if not we ask to enable & set it. 174 | if ($postScriptEnabled) { 175 | Write-Output "`n$($jobName) has an existing post-job script.`nScript: $postScriptCmd" 176 | Write-Output "`nIf you wish to receive Discord notifications for this job, you must overwrite the existing post-job script." 177 | 178 | do { 179 | $overWriteCurrentCmd = Read-Host -Prompt 'Do you wish to overwrite it? Y/N' 180 | } 181 | until ($overWriteCurrentCmd -in 'Y', 'N') 182 | 183 | switch ($overWriteCurrentCmd) { 184 | 185 | # Default action will be to skip the job. 186 | default { Write-Output "`nSkipping job $($jobName)`n"} 187 | Y { 188 | try { 189 | # Check to see if the script has even changed 190 | if ($postScriptCmd -ne $newPostScriptCmd) { 191 | 192 | # Script is not the same. Update the script command line. 193 | $jobOptions.JobScriptCommand.PostScriptCommandLine = $newPostScriptCmd 194 | Set-VBRJobOptions -Job $job -Options $jobOptions | Out-Null 195 | 196 | Write-Output "Updated post-job script for job $($jobName).`nOld: $postScriptCmd`nNew: $newPostScriptCmd" 197 | Write-Output "$($jobName) is now configured for Discord notifications." 198 | } 199 | else { 200 | # Script hasn't changed. Notify user of this and continue. 201 | Write-Output "$($jobName) is already configured for Discord notifications; Skipping." 202 | } 203 | } 204 | catch { 205 | DeploymentError 206 | } 207 | } 208 | } 209 | } 210 | else { 211 | try { 212 | # Sets post-job script to Enabled and sets the command line to full command including path. 213 | $jobOptions.JobScriptCommand.PostScriptEnabled = $true 214 | $jobOptions.JobScriptCommand.PostScriptCommandLine = $newPostScriptCmd 215 | Set-VBRJobOptions -Job $job -Options $jobOptions | Out-Null 216 | 217 | Write-Output "`n$($jobName) is now configured for Discord notifications." 218 | } 219 | catch { 220 | DeploymentError 221 | } 222 | } 223 | } 224 | } 225 | 226 | elseif ($configChoice -in 'N', 'None') { 227 | Write-Output 'Skipping Discord notifications configuration deployment for all jobs.' 228 | } 229 | 230 | Write-Output "`n`Finished. Exiting." 231 | Start-Sleep 10 232 | exit 233 | -------------------------------------------------------------------------------- /Updater.ps1: -------------------------------------------------------------------------------- 1 | # Pull version from script trigger 2 | Param ( 3 | [string]$LatestVersion 4 | ) 5 | 6 | # Import functions 7 | Import-Module "$PSScriptRoot\VeeamDiscordNotifications\resources\Logger.psm1" 8 | 9 | # Logging 10 | ## Set log file name 11 | $date = (Get-Date -UFormat %Y-%m-%d_%T).Replace(':','.') 12 | $logFile = "$PSScriptRoot\$($date)_Update.log" 13 | ## Start logging to file 14 | Start-Logging $logFile 15 | 16 | # Set error action preference. 17 | Write-LogMessage -Tag 'INFO' -Message 'Set error action preference.' 18 | $ErrorActionPreference = 'Stop' 19 | 20 | # Notification function 21 | function Update-Notification { 22 | [CmdletBinding( 23 | SupportsShouldProcess, 24 | ConfirmImpact = 'Low' 25 | )] 26 | Param () 27 | If ($PSCmdlet.ShouldProcess('Discord', 'Send update notification')) { 28 | Write-LogMessage -Tag 'INFO' -Message 'Building notification.' 29 | # Create embed and fields array 30 | [System.Collections.ArrayList]$embedArray = @() 31 | [System.Collections.ArrayList]$fieldArray = @() 32 | # Thumbnail object 33 | $thumbObject = [PSCustomObject]@{ 34 | url = $currentConfig.thumbnail 35 | } 36 | # Field objects 37 | $resultField = [PSCustomObject]@{ 38 | name = 'Update Result' 39 | value = $result 40 | inline = 'false' 41 | } 42 | $newVersionField = [PSCustomObject]@{ 43 | name = 'New version' 44 | value = $newVersion 45 | inline = 'false' 46 | } 47 | $oldVersionField = [PSCustomObject]@{ 48 | name = 'Old version' 49 | value = $oldVersion 50 | inline = 'false' 51 | } 52 | # Add field objects to the field array 53 | $fieldArray.Add($oldVersionField) | Out-Null 54 | $fieldArray.Add($newVersionField) | Out-Null 55 | $fieldArray.Add($resultField) | Out-Null 56 | # Send error if exist 57 | If ($null -ne $errorVar) { 58 | $errorField = [PSCustomObject]@{ 59 | name = 'Update Error' 60 | value = $errorVar 61 | inline = 'false' 62 | } 63 | $fieldArray.Add($errorField) | Out-Null 64 | } 65 | # Embed object including field and thumbnail vars from above 66 | $embedObject = [PSCustomObject]@{ 67 | title = 'Update' 68 | color = '1267393' 69 | thumbnail = $thumbObject 70 | fields = $fieldArray 71 | } 72 | # Add embed object to the array created above 73 | $embedArray.Add($embedObject) | Out-Null 74 | # Build payload 75 | $payload = [PSCustomObject]@{ 76 | embeds = $embedArray 77 | } 78 | Write-LogMessage -Tag 'INFO' -Message 'Sending notification.' 79 | # Send iiit 80 | Try { 81 | Invoke-RestMethod -Uri $currentConfig.webhook -Body ($payload | ConvertTo-Json -Depth 4) -Method Post -ContentType 'application/json' 82 | } 83 | Catch { 84 | $errorVar = $_.CategoryInfo.Activity + ' : ' + $_.ToString() 85 | Write-Warning 'Update notification failed to send to Discord.' 86 | Write-LogMessage -Tag 'ERROR' -Message "$errorVar" 87 | } 88 | } 89 | } 90 | 91 | # Success function 92 | function Update-Success { 93 | [CmdletBinding( 94 | SupportsShouldProcess, 95 | ConfirmImpact = 'Low' 96 | )] 97 | Param () 98 | If ($PSCmdlet.ShouldProcess('Updater', 'Update success process')) { 99 | # Set error action preference so that errors while ending the script don't end the script prematurely. 100 | Write-LogMessage -Tag 'INFO' -Message 'Set error action preference.' 101 | $ErrorActionPreference = 'Continue' 102 | 103 | # Set result var for notification and script output 104 | $script:result = 'Success!' 105 | 106 | # Copy logs directory from copy of previously installed version to new install 107 | Write-LogMessage -Tag 'INFO' -Message 'Copying logs from old version to new version.' 108 | Copy-Item -Path $PSScriptRoot\VeeamDiscordNotifications-old\log -Destination $PSScriptRoot\VeeamDiscordNotifications\ -Recurse -Force 109 | 110 | # Remove copy of previously installed version 111 | Write-LogMessage -Tag 'INFO' -Message 'Removing old version.' 112 | Remove-Item -Path $PSScriptRoot\VeeamDiscordNotifications-old -Recurse -Force 113 | 114 | # Trigger the Update-Notification function and then End-Script function. 115 | Update-Notification 116 | End-Script 117 | } 118 | } 119 | 120 | # Failure function 121 | function Update-Fail { 122 | [CmdletBinding( 123 | SupportsShouldProcess, 124 | ConfirmImpact = 'Low' 125 | )] 126 | Param () 127 | If ($PSCmdlet.ShouldProcess('Updater', 'Update failure process')) { 128 | # Set error action preference so that errors while ending the script don't end the script prematurely. 129 | Write-LogMessage -Tag 'INFO' -Message 'Set error action preference.' 130 | $ErrorActionPreference = 'Continue' 131 | 132 | # Set result var for notification and script output 133 | $script:result = 'Failure!' 134 | 135 | # Take action based on the stage at which the error occured 136 | Switch ($fail) { 137 | download { 138 | Write-Warning 'Failed to download update.' 139 | } 140 | unzip { 141 | Write-Warning 'Failed to unzip update. Cleaning up and reverting.' 142 | Remove-Item -Path $PSScriptRoot\VeeamDiscordNotifications-$LatestVersion.zip -Force 143 | } 144 | rename_old { 145 | Write-Warning 'Failed to rename old version. Cleaning up and reverting.' 146 | Remove-Item -Path $PSScriptRoot\VeeamDiscordNotifications-$LatestVersion.zip -Force 147 | Remove-Item -Path $PSScriptRoot\VeeamDiscordNotifications-$LatestVersion -Recurse -Force 148 | } 149 | rename_new { 150 | Write-Warning 'Failed to rename new version. Cleaning up and reverting.' 151 | Remove-Item -Path $PSScriptRoot\VeeamDiscordNotifications-$LatestVersion.zip -Force 152 | Remove-Item -Path $PSScriptRoot\VeeamDiscordNotifications-$LatestVersion -Recurse -Force 153 | Rename-Item $PSScriptRoot\VeeamDiscordNotifications-old $PSScriptRoot\VeeamDiscordNotifications 154 | } 155 | after_rename_new { 156 | Write-Warning 'Failed after renaming new version. Cleaning up and reverting.' 157 | Remove-Item -Path $PSScriptRoot\VeeamDiscordNotifications-$LatestVersion.zip -Force 158 | Remove-Item -Path $PSScriptRoot\VeeamDiscordNotifications -Recurse -Force 159 | Rename-Item $PSScriptRoot\VeeamDiscordNotifications-old $PSScriptRoot\VeeamDiscordNotifications 160 | } 161 | } 162 | 163 | # Trigger the Update-Notification function and then End-Script function. 164 | Update-Notification 165 | End-Script 166 | } 167 | } 168 | 169 | # End of script function 170 | function Stop-Script { 171 | [CmdletBinding( 172 | SupportsShouldProcess, 173 | ConfirmImpact = 'Low' 174 | )] 175 | Param () 176 | If ($PSCmdlet.ShouldProcess('Updater', 'Cleanup & stop')) { 177 | # Clean up. 178 | Write-LogMessage -Tag 'INFO' -Message 'Remove downloaded ZIP.' 179 | If (Test-Path "$PSScriptRoot\VeeamDiscordNotifications-$LatestVersion.zip") { 180 | Remove-Item "$PSScriptRoot\VeeamDiscordNotifications-$LatestVersion.zip" 181 | } 182 | Write-LogMessage -Tag 'INFO' -Message 'Remove Updater.ps1.' 183 | Remove-Item -LiteralPath $PSCommandPath -Force 184 | 185 | # Report result 186 | Write-LogMessage -Tag 'INFO' -Message "Update result: $result" 187 | 188 | # Stop logging 189 | Write-LogMessage -Tag 'INFO' -Message 'Stop logging.' 190 | Stop-Logging $logFile 191 | 192 | # Move log file 193 | Write-Output 'Move log file to log directory in VeeamDiscordNotifications.' 194 | Move-Item $logFile "$PSScriptRoot\VeeamDiscordNotifications\log\" 195 | 196 | # Exit script 197 | Write-Output 'Exiting.' 198 | Exit 199 | } 200 | } 201 | 202 | # Pull current config to variable 203 | Try { 204 | Write-LogMessage -Tag 'INFO' -Message 'Pull current config to variable.' 205 | $currentConfig = (Get-Content "$PSScriptRoot\VeeamDiscordNotifications\config\conf.json") -Join "`n" | ConvertFrom-Json 206 | } 207 | Catch { 208 | $errorVar = $_.CategoryInfo.Activity + ' : ' + $_.ToString() 209 | Write-LogMessage -Tag 'ERROR' -Message "$errorVar" 210 | Update-Fail 211 | } 212 | 213 | # Get currently downloaded version 214 | Try { 215 | Write-LogMessage -Tag 'INFO' -Message 'Getting currently downloaded version of the script.' 216 | [String]$oldVersion = Get-Content "$PSScriptRoot\VeeamDiscordNotifications\resources\version.txt" -Raw 217 | } 218 | Catch { 219 | $errorVar = $_.CategoryInfo.Activity + ' : ' + $_.ToString() 220 | Write-LogMessage -Tag 'ERROR' -Message "$errorVar" 221 | Update-Fail 222 | } 223 | 224 | # Wait until the alert sender has finished running, or quit this if it's still running after 60s. It should never take that long. 225 | while (Get-CimInstance win32_process -filter "name='powershell.exe' and commandline like '%AlertSender.ps1%'") { 226 | $timer++ 227 | Start-Sleep -Seconds 1 228 | If ($timer -eq '90') { 229 | Write-LogMessage -Tag 'INFO' -Message "Timeout reached. Updater quitting as AlertSender.ps1 is still running after $timer seconds." 230 | } 231 | Update-Fail 232 | } 233 | 234 | # Pull latest version of script from GitHub 235 | Try { 236 | Write-LogMessage -Tag 'INFO' -Message 'Pull latest version of script from GitHub.' 237 | [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 238 | Invoke-WebRequest -Uri ` 239 | https://github.com/tigattack/VeeamDiscordNotifications/releases/download/$LatestVersion/VeeamDiscordNotifications-$LatestVersion.zip ` 240 | -OutFile $PSScriptRoot\VeeamDiscordNotifications-$LatestVersion.zip 241 | } 242 | Catch { 243 | $errorVar = $_.CategoryInfo.Activity + ' : ' + $_.ToString() 244 | Write-LogMessage -Tag 'ERROR' -Message "$errorVar" 245 | $fail = 'download' 246 | Update-Fail 247 | } 248 | 249 | # Expand downloaded ZIP 250 | Try { 251 | Write-LogMessage -Tag 'INFO' -Message 'Expand downloaded ZIP.' 252 | Expand-Archive $PSScriptRoot\VeeamDiscordNotifications-$LatestVersion.zip -DestinationPath $PSScriptRoot 253 | } 254 | Catch { 255 | $errorVar = $_.CategoryInfo.Activity + ' : ' + $_.ToString() 256 | Write-LogMessage -Tag 'ERROR' -Message "$errorVar" 257 | $fail = 'unzip' 258 | Update-Fail 259 | } 260 | 261 | # Rename old version to keep as a backup while the update is in progress. 262 | Try { 263 | Write-LogMessage -Tag 'INFO' -Message 'Rename current to avoid conflict with new version.' 264 | Rename-Item $PSScriptRoot\VeeamDiscordNotifications $PSScriptRoot\VeeamDiscordNotifications-old 265 | } 266 | Catch { 267 | $errorVar = $_.CategoryInfo.Activity + ' : ' + $_.ToString() 268 | Write-LogMessage -Tag 'ERROR' -Message "$errorVar" 269 | $fail = 'rename_old' 270 | Update-Fail 271 | } 272 | 273 | # Rename extracted update 274 | Try { 275 | Write-LogMessage -Tag 'INFO' -Message 'Rename extracted download.' 276 | Rename-Item $PSScriptRoot\VeeamDiscordNotifications-$LatestVersion $PSScriptRoot\VeeamDiscordNotifications 277 | } 278 | Catch { 279 | $errorVar = $_.CategoryInfo.Activity + ' : ' + $_.ToString() 280 | Write-LogMessage -Tag 'ERROR' -Message "$errorVar" 281 | $fail = 'rename_new' 282 | Update-Fail 283 | } 284 | 285 | # Pull configuration from new conf file 286 | Try { 287 | Write-LogMessage -Tag 'INFO' -Message 'Pull configuration from new conf file.' 288 | $newConfig = (Get-Content "$PSScriptRoot\VeeamDiscordNotifications\config\conf.json") -Join "`n" | ConvertFrom-Json 289 | } 290 | Catch { 291 | $errorVar = $_.CategoryInfo.Activity + ' : ' + $_.ToString() 292 | Write-LogMessage -Tag 'ERROR' -Message "$errorVar" 293 | $fail = 'after_rename_new' 294 | Update-Fail 295 | } 296 | 297 | # Unblock script files 298 | Write-LogMessage -Tag 'INFO' -Message 'Unblock script files.' 299 | 300 | ## Get script files 301 | $pwshFiles = Get-ChildItem $PSScriptRoot\VeeamDiscordNotifications\* -Recurse | Where-Object { $_.Name -match '^.*\.ps(m)?1$' } 302 | 303 | ## Unblock them 304 | Try { 305 | foreach ($i in $pwshFiles) { 306 | Unblock-File -Path $i.FullName 307 | } 308 | } 309 | Catch { 310 | $errorVar = $_.CategoryInfo.Activity + ' : ' + $_.ToString() 311 | Write-LogMessage -Tag 'ERROR' -Message "$errorVar" 312 | $fail = 'unblock_scripts' 313 | Update-Fail 314 | } 315 | 316 | # Populate conf.json with previous configuration 317 | Try { 318 | Write-LogMessage -Tag 'INFO' -Message 'Populate conf.json with previous configuration.' 319 | $newConfig.webhook = $currentConfig.webhook 320 | $newConfig.userid = $currentConfig.userid 321 | if ($currentConfig.mention_on_fail -ne $newConfig.mention_on_fail) { 322 | $newConfig.mention_on_fail = $currentConfig.mention_on_fail 323 | } 324 | if ($currentConfig.debug_log -ne $newConfig.debug_log) { 325 | $newConfig.debug_log = $currentConfig.debug_log 326 | } 327 | if ($currentConfig.self_update -ne $newConfig.self_update) { 328 | $newConfig.self_update = $currentConfig.self_update 329 | } 330 | ConvertTo-Json $newConfig | Set-Content "$PSScriptRoot\VeeamDiscordNotifications\config\conf.json" 331 | } 332 | Catch { 333 | $errorVar = $_.CategoryInfo.Activity + ' : ' + $_.ToString() 334 | Write-LogMessage -Tag 'ERROR' -Message "$errorVar" 335 | $fail = 'after_rename_new' 336 | Update-Fail 337 | } 338 | 339 | # Get newly downloaded version 340 | Try { 341 | Write-LogMessage -Tag 'INFO' -Message 'Get newly downloaded version.' 342 | [String]$newVersion = Get-Content "$PSScriptRoot\VeeamDiscordNotifications\resources\version.txt" -Raw 343 | } 344 | Catch { 345 | $errorVar = $_.CategoryInfo.Activity + ' : ' + $_.ToString() 346 | Write-LogMessage -Tag 'ERROR' -Message "$errorVar" 347 | $fail = 'after_rename_new' 348 | Update-Fail 349 | } 350 | 351 | # Send notification 352 | If ($newVersion -eq $LatestVersion) { 353 | Update-Success 354 | } 355 | Else { 356 | Update-Fail 357 | } 358 | -------------------------------------------------------------------------------- /AlertSender.ps1: -------------------------------------------------------------------------------- 1 | # Define parameters 2 | Param( 3 | [String]$jobName, 4 | [String]$id, 5 | [String]$jobType, 6 | $Config, 7 | $Logfile 8 | ) 9 | 10 | # Convert config from JSON 11 | $Config = $Config | ConvertFrom-Json 12 | 13 | # Import modules. 14 | Import-Module Veeam.Backup.PowerShell -DisableNameChecking 15 | Import-Module "$PSScriptRoot\resources\Logger.psm1" 16 | Import-Module "$PSScriptRoot\resources\ConvertTo-ByteUnit.psm1" 17 | Import-Module "$PSScriptRoot\resources\VBRSessionInfo.psm1" 18 | Import-Module "$PSScriptRoot\resources\UpdateInfo.psm1" 19 | Import-Module "$PSScriptRoot\resources\Test-FileIsLocked.psm1" 20 | 21 | 22 | # Start logging if logging is enabled in config 23 | If ($Config.debug_log) { 24 | ## Wait until log file is closed by Bootstrap.ps1 25 | do { 26 | $logLocked = $(Test-FileIsLocked -Path "$Logfile").IsLocked 27 | Start-Sleep -Seconds 1 28 | } 29 | until (-not $logLocked) 30 | 31 | ## Start logging to file 32 | Start-Logging -Path $Logfile -Append 33 | } 34 | 35 | 36 | # Initialise some variables. 37 | $fieldArray = @() 38 | $mention = $false 39 | 40 | 41 | # Determine if an update is required 42 | $updateStatus = Get-UpdateStatus 43 | 44 | 45 | # Define static output objects. 46 | 47 | ## Footer message. 48 | Switch ($updateStatus.Status) { 49 | Current { 50 | $footerMessage = "tigattack's VeeamDiscordNotifications $($updateStatus.CurrentVersion) - Up to date." 51 | } 52 | Behind { 53 | $footerMessage = "tigattack's VeeamDiscordNotifications $($updateStatus.CurrentVersion) - Update to $($updateStatus.LatestVersion) is available!" 54 | } 55 | Ahead { 56 | $footerMessage = "tigattack's VeeamDiscordNotifications $($updateStatus.CurrentVersion) - Pre-release." 57 | } 58 | Default { 59 | $footerMessage = "tigattack's VeeamDiscordNotifications $($updateStatus.CurrentVersion)." 60 | } 61 | } 62 | 63 | ## Footer object. 64 | $footerObject = [PSCustomObject]@{ 65 | text = $footerMessage 66 | icon_url = 'https://avatars0.githubusercontent.com/u/10629864' 67 | } 68 | 69 | ## Define thumbnail object. 70 | If ($Config.thumbnail) { 71 | $thumbObject = [PSCustomObject]@{ 72 | url = $Config.thumbnail 73 | } 74 | } 75 | Else { 76 | $thumbObject = [PSCustomObject]@{ 77 | url = 'https://raw.githubusercontent.com/tigattack/VeeamDiscordNotifications/master/asset/thumb01.png' 78 | } 79 | } 80 | 81 | 82 | # Job info preparation 83 | 84 | ## Get the backup session information. 85 | $session = (Get-VBRSessionInfo -SessionId $id -JobType $jobType).Session 86 | 87 | ## Wait for the backup session to finish. 88 | If ($session.State -ne 'Stopped') { 89 | $nonStoppedStates = 'Idle','Pausing','Postprocessing','Resuming','Starting','Stopping','WaitingRepository','WaitingTape ','Working' 90 | $timeout = New-TimeSpan -Minutes 5 91 | $stopwatch = [System.Diagnostics.Stopwatch]::StartNew() 92 | Do { 93 | Write-LogMessage -Tag 'INFO' -Message 'Session not finished. Sleeping...' 94 | Start-Sleep -Seconds 10 95 | $session = (Get-VBRSessionInfo -SessionId $id -JobType $jobType).Session 96 | } 97 | While ($session.State -in $nonStoppedStates -and $stopwatch.elapsed -lt $timeout) 98 | $stopwatch.Stop() 99 | } 100 | 101 | ## Quit if still not stopped 102 | If ($session.State -ne 'Stopped') { 103 | Write-LogMessage -Tag 'ERROR' -Message 'Session not stopped. Aborting.' 104 | Exit 1 105 | } 106 | 107 | ## Gather generic session info. 108 | [String]$status = $session.Result 109 | 110 | 111 | # Define session statistics for the report. 112 | 113 | ## If VM backup, gather and include session info. 114 | if ($jobType -in 'Backup','Replica') { 115 | # Gather session data sizes and timing. 116 | [Float]$jobSize = $session.BackupStats.DataSize 117 | [Float]$transferSize = $session.BackupStats.BackupSize 118 | [Float]$speed = $session.Info.Progress.AvgSpeed 119 | $jobEndTime = $session.Info.EndTime 120 | $jobStartTime = $session.Info.CreationTime 121 | 122 | # Convert bytes to closest unit. 123 | $jobSizeRound = ConvertTo-ByteUnit -Data $jobSize 124 | $transferSizeRound = ConvertTo-ByteUnit -Data $transferSize 125 | $speedRound = (ConvertTo-ByteUnit -Data $speed).ToString() + '/s' 126 | 127 | # Set processing speed "Unknown" if 0B/s to avoid confusion. 128 | If ($speedRound -eq '0 B/s') { 129 | $speedRound = 'Unknown' 130 | } 131 | 132 | # Define bottleneck 133 | Switch ($session.Info.Progress.BottleneckInfo.Bottleneck) { 134 | 'NotDefined' { 135 | $bottleneck = 'Undefined' 136 | } 137 | Default { 138 | $bottleneck = $_ 139 | } 140 | } 141 | 142 | <# TODO: utilise this. 143 | # Get objects in session. 144 | $sessionObjects = $session.GetTaskSessions() 145 | 146 | ## Count total 147 | $sessionObjectsCount = $sessionObjects.Count 148 | 149 | ## Count warns and fails 150 | $sessionObjectWarns = 0 151 | $sessionObjectFails = 0 152 | 153 | foreach ($object in $sessionObjects) { 154 | If ($object.Status -eq 'Warning') { 155 | $sessionObjectWarns++ 156 | } 157 | # TODO: check if 'Failed' is a valid state. 158 | If ($object.Status -eq 'Failed') { 159 | $sessionObjectFails++ 160 | } 161 | } 162 | #> 163 | 164 | # Add session information to fieldArray. 165 | $fieldArray = @( 166 | [PSCustomObject]@{ 167 | name = 'Backup Size' 168 | value = [String]$jobSizeRound 169 | inline = 'true' 170 | }, 171 | [PSCustomObject]@{ 172 | name = 'Transferred Data' 173 | value = [String]$transferSizeRound 174 | inline = 'true' 175 | } 176 | [PSCustomObject]@{ 177 | name = 'Dedup Ratio' 178 | value = [String]$session.BackupStats.DedupRatio 179 | inline = 'true' 180 | } 181 | [PSCustomObject]@{ 182 | name = 'Compression Ratio' 183 | value = [String]$session.BackupStats.CompressRatio 184 | inline = 'true' 185 | } 186 | [PSCustomObject]@{ 187 | name = 'Processing Rate' 188 | value = $speedRound 189 | inline = 'true' 190 | } 191 | [PSCustomObject]@{ 192 | name = 'Bottleneck' 193 | value = [String]$bottleneck 194 | inline = 'true' 195 | } 196 | ) 197 | 198 | <# TODO: utilise this. 199 | # Add object warns/fails to fieldArray if any. 200 | If ($sessionObjectWarns -gt 0) { 201 | $fieldArray += @( 202 | [PSCustomObject]@{ 203 | name = 'Warnings' 204 | value = "$sessionObjectWarns/$sessionobjectsCount" 205 | inline = 'true' 206 | } 207 | ) 208 | } 209 | If ($sessionObjectFails -gt 0) { 210 | $fieldArray += @( 211 | [PSCustomObject]@{ 212 | name = 'Fails' 213 | value = "$sessionObjectFails/$sessionobjectsCount" 214 | inline = 'true' 215 | } 216 | ) 217 | } 218 | #> 219 | } 220 | 221 | # If agent backup, gather and include session info. 222 | If ($jobType -eq 'EpAgentBackup') { 223 | # Gather session data sizes and timings. 224 | [Float]$jobProcessedSize = $session.Info.Progress.ProcessedSize 225 | [Float]$jobTransferredSize = $session.Info.Progress.TransferedSize 226 | [Float]$speed = $session.Info.Progress.AvgSpeed 227 | $jobEndTime = $session.EndTime 228 | $jobStartTime = $session.CreationTime 229 | 230 | # Convert bytes to closest unit. 231 | $jobProcessedSizeRound = ConvertTo-ByteUnit -Data $jobProcessedSize 232 | $jobTransferredSizeRound = ConvertTo-ByteUnit -Data $jobTransferredSize 233 | $speedRound = (ConvertTo-ByteUnit -Data $speed).ToString() + '/s' 234 | 235 | # Add session information to fieldArray. 236 | $fieldArray = @( 237 | [PSCustomObject]@{ 238 | name = 'Processed Size' 239 | value = [String]$jobProcessedSizeRound 240 | inline = 'true' 241 | }, 242 | [PSCustomObject]@{ 243 | name = 'Transferred Data' 244 | value = [String]$jobTransferredSizeRound 245 | inline = 'true' 246 | }, 247 | [PSCustomObject]@{ 248 | name = 'Processing Rate' 249 | value = $speedRound 250 | inline = 'true' 251 | } 252 | ) 253 | } 254 | 255 | 256 | # Job timings 257 | 258 | ## Calculate difference between job start and end time. 259 | $duration = $jobEndTime - $jobStartTime 260 | 261 | ## Switch for job duration; define pretty output. 262 | Switch ($duration) { 263 | {$_.Days -ge '1'} { 264 | $durationFormatted = '{0}d {1}h {2}m {3}s' -f $_.Days, $_.Hours, $_.Minutes, $_.Seconds 265 | break 266 | } 267 | {$_.Hours -ge '1'} { 268 | $durationFormatted = '{0}h {1}m {2}s' -f $_.Hours, $_.Minutes, $_.Seconds 269 | break 270 | } 271 | {$_.Minutes -ge '1'} { 272 | $durationFormatted = '{0}m {1}s' -f $_.Minutes, $_.Seconds 273 | break 274 | } 275 | {$_.Seconds -ge '1'} { 276 | $durationFormatted = '{0}s' -f $_.Seconds 277 | break 278 | } 279 | Default { 280 | $durationFormatted = '{0}d {1}h {2}m {3}s' -f $_.Days, $_.Hours, $_.Minutes, $_.Seconds 281 | } 282 | } 283 | 284 | ## Add job times to fieldArray. 285 | $fieldArray += @( 286 | [PSCustomObject]@{ 287 | name = 'Job Duration' 288 | value = $durationFormatted 289 | inline = 'true' 290 | } 291 | [PSCustomObject]@{ 292 | name = 'Time Started' 293 | value = "" 294 | inline = 'true' 295 | } 296 | [PSCustomObject]@{ 297 | name = 'Time Ended' 298 | value = "" 299 | inline = 'true' 300 | } 301 | ) 302 | 303 | 304 | # If agent backup, add notice to fieldArray. 305 | If ($jobType -eq 'EpAgentBackup') { 306 | $fieldArray += @( 307 | [PSCustomObject]@{ 308 | name = 'Notice' 309 | value = "Further details are missing due to limitations in Veeam's PowerShell module." 310 | inline = 'false' 311 | } 312 | ) 313 | } 314 | 315 | # Define nice job type name 316 | Switch ($jobType) { 317 | Backup {$jobTypeNice = 'VM Backup'} 318 | Replica {$jobTypeNice = 'VM Replication'} 319 | EpAgentBackup {$jobTypeNice = 'Agent Backup'} 320 | } 321 | 322 | # Switch for the session status to decide the embed colour. 323 | Switch ($status) { 324 | None {$colour = '16777215'} 325 | Warning {$colour = '16776960'} 326 | Success {$colour = '65280'} 327 | Failed {$colour = '16711680'} 328 | Default {$colour = '16777215'} 329 | } 330 | 331 | # Decide whether to mention user 332 | ## On fail 333 | Try { 334 | If ($Config.mention_on_fail -and $status -eq 'Failed') { 335 | $mention = $true 336 | } 337 | } 338 | Catch { 339 | Write-LogMessage -Tag 'WARN' -Message "Unable to determine 'mention on fail' configuration. User will not be mentioned." 340 | } 341 | 342 | ## On warning 343 | Try { 344 | If ($Config.mention_on_warning -and $status -eq 'Warning') { 345 | $mention = $true 346 | } 347 | } 348 | Catch { 349 | Write-LogMessage -Tag 'WARN' -Message "Unable to determine 'mention on warning' configuration. User will not be mentioned." 350 | } 351 | 352 | 353 | # Build embed object. 354 | $embedArray = @( 355 | [PSCustomObject]@{ 356 | title = $jobName 357 | description = "Session result: $status`nJob type: $jobTypeNice" 358 | color = $colour 359 | thumbnail = $thumbObject 360 | fields = $fieldArray 361 | footer = $footerObject 362 | timestamp = $((Get-Date).ToUniversalTime().ToString('yyyy-MM-ddTHH:mm:ss.fffK')) 363 | } 364 | ) 365 | 366 | # Create payload object. 367 | Switch ($mention) { 368 | ## Mention user on job failure if configured to do so. 369 | $true { 370 | $payload = [PSCustomObject]@{ 371 | content = "<@!$($Config.userid)> Job $status!" 372 | embeds = $embedArray 373 | } 374 | } 375 | ## Otherwise do not mention user. 376 | $False { 377 | $payload = [PSCustomObject]@{ embeds = $embedArray } 378 | } 379 | } 380 | 381 | 382 | # Send iiiit. 383 | Try { 384 | Invoke-RestMethod -Uri $Config.webhook -Body ($payload | ConvertTo-Json -Depth 4) -Method Post -ContentType 'application/json' -ErrorAction Stop 385 | } 386 | Catch [System.Net.WebException] { 387 | Write-LogMessage -Tag 'ERROR' -Message 'Unable to send webhook. Check your webhook URL or network connection.' 388 | } 389 | 390 | 391 | # If newer version available... 392 | If ($updateStatus.CurrentVersion -lt $updateStatus.latestVersion) { 393 | 394 | # Trigger update if configured to do so. 395 | If ($Config.self_update) { 396 | 397 | # Copy update script out of working directory. 398 | Copy-Item $PSScriptRoot\Updater.ps1 $PSScriptRoot\..\VDNotifs-Updater.ps1 399 | Unblock-File $PSScriptRoot\..\VDNotifs-Updater.ps1 400 | 401 | # Run update script. 402 | $updateArgs = "-file $PSScriptRoot\..\VDNotifs-Updater.ps1", "-LatestVersion $latestVersion" 403 | Start-Process -FilePath 'powershell' -Verb runAs -ArgumentList $updateArgs -WindowStyle hidden 404 | } 405 | 406 | # Send update notice if configured to do so. 407 | If ($false -ne $Config.notify_update) { 408 | 409 | # Define 410 | $updateNotice = [PSCustomObject]@{ 411 | embeds = @( 412 | [PSCustomObject]@{ 413 | title = 'Update Available' 414 | description = 'A new version of VeeamDiscordNotifications is available!' 415 | color = 3429867 416 | thumbnail = $thumbObject 417 | fields = @( 418 | [PSCustomObject]@{ 419 | name = 'Download' 420 | value = '[Link.](https://github.com/tigattack/VeeamDiscordNotifications/releases/latest)' 421 | } 422 | ) 423 | footer = [PSCustomObject]@{ 424 | text = "tigattack's VeeamDiscordNotifications $($updateStatus.CurrentVersion)." 425 | icon_url = 'https://avatars0.githubusercontent.com/u/10629864' 426 | } 427 | timestamp = $((Get-Date).ToUniversalTime().ToString('yyyy-MM-ddTHH:mm:ss.fffK')) 428 | } 429 | ) 430 | } 431 | 432 | # Send 433 | Try { 434 | Invoke-RestMethod -Uri $Config.webhook -Body ($updateNotice | ConvertTo-Json -Depth 4) -Method Post -ContentType 'application/json' 435 | } 436 | Catch [System.Net.WebException] { 437 | Write-LogMessage -Tag 'ERROR' -Message 'Unable to send webhook. Check your webhook URL or network connection.' 438 | } 439 | } 440 | } 441 | 442 | # Stop logging. 443 | If ($Config.debug_log) { 444 | Stop-Logging 445 | } 446 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------