community.general/lib/ansible/modules/windows/win_shortcut.ps1

#!powershell

# Copyright: (c) 2016, Dag Wieers (@dagwieers) <dag@wieers.com>
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

# Based on: http://powershellblogger.com/2016/01/create-shortcuts-lnk-or-url-files-with-powershell/

#Requires -Module Ansible.ModuleUtils.Legacy

$ErrorActionPreference = "Stop"

$params = Parse-Args -arguments $args -supports_check_mode $true
$check_mode = Get-AnsibleParam -obj $params -name "_ansible_check_mode" -type "bool" -default $false

$orig_src = Get-AnsibleParam -obj $params -name "src"
$dest = Get-AnsibleParam -obj $params -name "dest" -type "path" -failifempty $true
$state = Get-AnsibleParam -obj $params -name "state" -type "string" -default "present" -validateset "absent","present"
$orig_args = Get-AnsibleParam -obj $params -name "args" -type "string"
$directory = Get-AnsibleParam -obj $params -name "directory" -type "path"
$hotkey = Get-AnsibleParam -obj $params -name "hotkey" -type "string"
$icon = Get-AnsibleParam -obj $params -name "icon" -type "path"
$orig_description = Get-AnsibleParam -obj $params -name "description" -type "string"
$windowstyle = Get-AnsibleParam -obj $params -name "windowstyle" -type "string" -validateset "maximized","minimized","normal"

# Expand environment variables on non-path types
$args = Expand-Environment($orig_args)
$description = Expand-Environment($orig_description)
$src = Expand-Environment($orig_src)

$result = @{
    changed = $false
    dest = $dest
    state = $state
}

# Convert from window style name to window style id
$windowstyles = @{
    normal = 1
    maximized = 3
    minimized = 7
}

# Convert from window style id to window style name
$windowstyleids = @( "", "normal", "", "maximized", "", "", "", "minimized" )

If ($state -eq "absent") {
    If (Test-Path -Path $dest) {
        # If the shortcut exists, try to remove it
        Try {
            Remove-Item -Path $dest -WhatIf:$check_mode
        } Catch {
            # Report removal failure
            Fail-Json -obj $result -message "Failed to remove shortcut '$dest'. ($($_.Exception.Message))"
        }
        # Report removal success
        $result.changed = $true
    } Else {
        # Nothing to report, everything is fine already
    }
} ElseIf ($state -eq "present") {
    # Create an in-memory object based on the existing shortcut (if any)
    $Shell = New-Object -ComObject ("WScript.Shell")
    $ShortCut = $Shell.CreateShortcut($dest)

    # Compare existing values with new values, report as changed if required

    If ($src -ne $null) {
        # Windows translates executables to absolute path, so do we
        If (Get-Command -Name $src -Type Application -ErrorAction SilentlyContinue) {
            $src = (Get-Command -Name $src -Type Application).Definition
        }
        If (-not (Test-Path -Path $src -IsValid)) {
            If (-not (Split-Path -Path $src -IsAbsolute)) {
                Fail-Json -obj $result -message "Source '$src' is not found in PATH and not a valid or absolute path."
            }
        }
    }

    If ($src -ne $null -and $ShortCut.TargetPath -ne $src) {
        $result.changed = $true
        $ShortCut.TargetPath = $src
    }
    $result.src = $ShortCut.TargetPath

    # Determine if we have a WshShortcut or WshUrlShortcut by checking the Arguments property
    # A WshUrlShortcut objects only consists of a TargetPath property

    If (Get-Member -InputObject $ShortCut -Name Arguments) {

        # This is a full-featured application shortcut !
        If ($orig_args -ne $null -and $ShortCut.Arguments -ne $args) {
            $result.changed = $true
            $ShortCut.Arguments = $args
        }
        $result.args = $ShortCut.Arguments

        If ($directory -ne $null -and $ShortCut.WorkingDirectory -ne $directory) {
            $result.changed = $true
            $ShortCut.WorkingDirectory = $directory
        }
        $result.directory = $ShortCut.WorkingDirectory

        # FIXME: Not all values are accepted here ! Improve docs too.
        If ($hotkey -ne $null -and $ShortCut.Hotkey -ne $hotkey) {
            $result.changed = $true
            $ShortCut.Hotkey = $hotkey
        }
        $result.hotkey = $ShortCut.Hotkey

        If ($icon -ne $null -and $ShortCut.IconLocation -ne $icon) {
            $result.changed = $true
            $ShortCut.IconLocation = $icon
        }
        $result.icon = $ShortCut.IconLocation

        If ($orig_description -ne $null -and $ShortCut.Description -ne $description) {
            $result.changed = $true
            $ShortCut.Description = $description
        }
        $result.description = $ShortCut.Description

        If ($windowstyle -ne $null -and $ShortCut.WindowStyle -ne $windowstyles.$windowstyle) {
            $result.changed = $true
            $ShortCut.WindowStyle = $windowstyles.$windowstyle
        }
        $result.windowstyle = $windowstyleids[$ShortCut.WindowStyle]
    }

    If ($result.changed -eq $true -and $check_mode -ne $true) {
        Try {
            $ShortCut.Save()
        } Catch {
            Fail-Json -obj $result -message "Failed to create shortcut '$dest'. ($($_.Exception.Message))"
        }
    }
}

Exit-Json -obj $result