Ansible
PS DSC
Downloads:
73
Downloads of v 1.0.0:
73
Last Update:
19 Aug 2023
Package Maintainer(s):
Software Author(s):
- foundata
Tags:
sendmouseclick.extension mouse-events mouse-emulation click non-silent user32.dll- Software Specific:
- Software Site
- Software Source
- Software License
- Software Docs
- Software Issues
- Package Specific:
- Package Source
- Package outdated?
- Package broken?
- Contact Maintainers
- Contact Site Admins
- Software Vendor?
- Report Abuse
- Download
Send-MouseClick extension
- 1
- 2
- 3
1.0.0 | Updated: 19 Aug 2023
- Software Specific:
- Software Site
- Software Source
- Software License
- Software Docs
- Software Issues
- Package Specific:
- Package Source
- Package outdated?
- Package broken?
- Contact Maintainers
- Contact Site Admins
- Software Vendor?
- Report Abuse
- Download
Downloads:
73
Downloads of v 1.0.0:
73
Maintainer(s):
Software Author(s):
- foundata
Send-MouseClick extension 1.0.0
Legal Disclaimer: Neither this package nor Chocolatey Software, Inc. are affiliated with or endorsed by foundata. The inclusion of foundata trademark(s), if any, upon this webpage is solely to identify foundata goods or services and not for commercial purposes.
- 1
- 2
- 3
All Checks are Passing
3 Passing Tests
Deployment Method: Individual Install, Upgrade, & Uninstall
To install Send-MouseClick extension, run the following command from the command line or from PowerShell:
>
To upgrade Send-MouseClick extension, run the following command from the command line or from PowerShell:
>
To uninstall Send-MouseClick extension, run the following command from the command line or from PowerShell:
>
Deployment Method:
NOTE
This applies to both open source and commercial editions of Chocolatey.
1. Enter Your Internal Repository Url
(this should look similar to https://community.chocolatey.org/api/v2/)
2. Setup Your Environment
1. Ensure you are set for organizational deployment
Please see the organizational deployment guide
2. Get the package into your environment
Option 1: Cached Package (Unreliable, Requires Internet - Same As Community)-
Open Source or Commercial:
- Proxy Repository - Create a proxy nuget repository on Nexus, Artifactory Pro, or a proxy Chocolatey repository on ProGet. Point your upstream to https://community.chocolatey.org/api/v2/. Packages cache on first access automatically. Make sure your choco clients are using your proxy repository as a source and NOT the default community repository. See source command for more information.
- You can also just download the package and push it to a repository Download
-
Open Source
-
Download the package:
Download - Follow manual internalization instructions
-
-
Package Internalizer (C4B)
-
Run: (additional options)
choco download sendmouseclick.extension --internalize --source=https://community.chocolatey.org/api/v2/ -
For package and dependencies run:
choco push --source="'INTERNAL REPO URL'" - Automate package internalization
-
Run: (additional options)
3. Copy Your Script
choco upgrade sendmouseclick.extension -y --source="'INTERNAL REPO URL'" [other options]See options you can pass to upgrade.
See best practices for scripting.
Add this to a PowerShell script or use a Batch script with tools and in places where you are calling directly to Chocolatey. If you are integrating, keep in mind enhanced exit codes.
If you do use a PowerShell script, use the following to ensure bad exit codes are shown as failures:
choco upgrade sendmouseclick.extension -y --source="'INTERNAL REPO URL'"
$exitCode = $LASTEXITCODE
Write-Verbose "Exit code was $exitCode"
$validExitCodes = @(0, 1605, 1614, 1641, 3010)
if ($validExitCodes -contains $exitCode) {
Exit 0
}
Exit $exitCode
- name: Install sendmouseclick.extension
win_chocolatey:
name: sendmouseclick.extension
version: '1.0.0'
source: INTERNAL REPO URL
state: present
See docs at https://docs.ansible.com/ansible/latest/modules/win_chocolatey_module.html.
chocolatey_package 'sendmouseclick.extension' do
action :install
source 'INTERNAL REPO URL'
version '1.0.0'
end
See docs at https://docs.chef.io/resource_chocolatey_package.html.
cChocoPackageInstaller sendmouseclick.extension
{
Name = "sendmouseclick.extension"
Version = "1.0.0"
Source = "INTERNAL REPO URL"
}
Requires cChoco DSC Resource. See docs at https://github.com/chocolatey/cChoco.
package { 'sendmouseclick.extension':
ensure => '1.0.0',
provider => 'chocolatey',
source => 'INTERNAL REPO URL',
}
Requires Puppet Chocolatey Provider module. See docs at https://forge.puppet.com/puppetlabs/chocolatey.
4. If applicable - Chocolatey configuration/installation
See infrastructure management matrix for Chocolatey configuration elements and examples.
Package Approved
This package was approved by moderator TheCakeIsNaOH on 21 Aug 2023.
Description
An unofficial Chocolatey extension providing helper functions to send mouse clicks (mouse related SendInput calls). These functions may be used in Chocolatey install and uninstall scripts by declaring this package a dependency in your package's .nuspec.
Files
extensions\Helper.ps1
Add-Type -Language 'CSharp' -ReferencedAssemblies @('System', 'System.Drawing', 'System.Runtime.InteropServices', 'System.Windows.Forms') -TypeDefinition @"
using System;
using System.Drawing;
using System.Runtime.InteropServices;
using System.Windows.Forms;
public static class MouseClick
{
// More info on INPUT structure (winuser.h):
// https://learn.microsoft.com/en-us/windows/win32/api/winuser/ns-winuser-input
[StructLayout(LayoutKind.Sequential)]
public struct INPUT
{
public int type; // 0 = INPUT_MOUSE, 1 = INPUT_KEYBOARD, 2 = INPUT_HARDWARE
public MOUSEINPUT mInput;
}
// More info on MOUSEINPUT structure (winuser.h):
// https://learn.microsoft.com/en-us/windows/win32/api/winuser/ns-winuser-mouseinput
[StructLayout(LayoutKind.Sequential)]
public struct MOUSEINPUT
{
public int dx;
public int dy;
public int mouseData;
public int dwFlags;
public int time;
public IntPtr dwExtraInfo;
}
// See https://learn.microsoft.com/en-us/windows/win32/api/winuser/ns-winuser-mouseinput
// for info about the following bit flags that specify various aspects of mouse motion,
// button clicks and other mouse events or functions.
private const int MOUSEEVENTF_ABSOLUTE = 0x8000;
private const int MOUSEEVENTF_HWHEEL = 0x1000;
private const int MOUSEEVENTF_LEFTDOWN = 0x0002;
private const int MOUSEEVENTF_LEFTUP = 0x0004;
private const int MOUSEEVENTF_MIDDLEDOWN = 0x0020;
private const int MOUSEEVENTF_MIDDLEUP = 0x0040;
private const int MOUSEEVENTF_MOVE = 0x0001;
private const int MOUSEEVENTF_RIGHTDOWN = 0x0008;
private const int MOUSEEVENTF_RIGHTUP = 0x0010;
private const int MOUSEEVENTF_WHEEL = 0x0080;
private const int MOUSEEVENTF_XDOWN = 0x0100;
private const int MOUSEEVENTF_XUP = 0x0200;
[DllImport("user32.dll")]
extern static uint SendInput(uint nInputs, INPUT[] pInputs, int cbSize);
public static void LeftClickAtPoint(int x, int y)
{
// move
INPUT[] input = new INPUT[3];
input[0].mInput.dx = x * (65535 / System.Windows.Forms.Screen.PrimaryScreen.Bounds.Width);
input[0].mInput.dy = y * (65535 / System.Windows.Forms.Screen.PrimaryScreen.Bounds.Height);
input[0].mInput.dwFlags = MOUSEEVENTF_MOVE | MOUSEEVENTF_ABSOLUTE;
// left button down
input[1].mInput.dwFlags = MOUSEEVENTF_LEFTDOWN;
// left button up
input[2].mInput.dwFlags = MOUSEEVENTF_LEFTUP;
SendInput(3, input, Marshal.SizeOf(input[0]));
}
}
"@
extensions\Send-MouseClick.ps1
function Send-MouseClick {
<#
.SYNOPSIS
Sends mouse clicks to the active application with optional, automatic window
focus and optional delays (before and after clicking). Mostly a wrapper
around different mouse click related user32.dll SendInput calls.
.LINK
https://docs.microsoft.com/en-us/dotnet/desktop/winforms/input-mouse/how-to-simulate-events
#>
[CmdletBinding()]
Param(
[Parameter(Mandatory = $False,
HelpMessage = 'Where to send the click (this does not move the cursor, only sending the click as it would have been moved there and back to the original position). Use $False, $null or an empty string to send the click at the current cursor position. Use the string "Center" to send the click to the center of the current primary screen. User an array of integers (x, y) to define coordinates as you whish. Defaults to "Center".')]
$Position = 'Center',
[Parameter(Mandatory = $False,
HelpMessage = 'What kind of mouse click to send. Defaults to "Left".')]
[ValidateSet('Left')]
[String]$Type = 'Left',
[Parameter(Mandatory = $False,
HelpMessage = 'Array of integers. Seconds to wait before executing the mouse event and afterwards. Defaults to (0, 2).')]
[ValidateScript({
if (!($Delay -is [array]) -or ($Delay.count -ne 2)) {
Throw 'Send-MouseClick: -Delay has to be an array of integers with two elements.'
} else {
$True
}
})]
[Array]$Delay = @(0, 2),
[Parameter(Mandatory = $False,
HelpMessage = 'An optional -Query for Use-Window (which will be called before the mouse click if a query is given).')]
[String]$Query = ''
)
Begin {
if (!(Test-Path variable:SendMouseClickInitDone -ErrorAction 'SilentlyContinue')) {
Add-Type -AssemblyName System.Drawing
Add-Type -AssemblyName System.Windows.Forms
Set-Variable -Name 'SendMouseClickInitDone' -Value $True -Option 'Constant' -Scope 'Global' -Force
}
}
Process {
$Coordinates = @(0, 0)
switch ($Position) {
# center of primary screen
'Center' {
# TODO Check if this is DPI aware, not tested yet. Cf. bit.ly/3E7L4Z3, bit.ly/3hsEySV
# TODO Check if PrimaryScreen.WorkingArea is better (which returns the desktop area
# of the display, excluding taskbars, docked windows, and docked tool bars)?
# Clarify where do new windows get placed? Center of screen or working area?
# Cf. System.Windows.WindowStartupLocation.CenterScreen
$Coordinates[0] = [int]([System.Windows.Forms.Screen]::PrimaryScreen.Bounds.Width / 2)
$Coordinates[1] = [int]([System.Windows.Forms.Screen]::PrimaryScreen.Bounds.Height / 2)
}
# user defined position
{(($Position -is [array]) -and ($Position.count -eq 2))} {
$Coordinates[0] = [int]$Position[0]
$Coordinates[1] = [int]$Position[1]
}
# cursor's current position
{($Position -eq $False -or ([string]::IsNullOrEmpty($Position)))} {
$Coordinates[0] = [int]([System.Windows.Forms.Cursor]::Position.X)
$Coordinates[1] = [int]([System.Windows.Forms.Cursor]::Position.Y)
}
default { Throw ('Send-MouseClick: Unknown position "{0}"' -f "${Position}") }
}
# force integer casting
$Delay[0] = [int]$Delay[0]
$Delay[1] = [int]$Delay[1]
# delay before
if ($Delay[0] -gt 0) {
Write-Host ('Send-MouseClick: Will wait {0} seconds (delay before sending the click(s)).' -f $Delay[0])
Start-Sleep $Delay[0]
}
# bring to front and activate a target window
if ($Query -ne $False -and !([string]::IsNullOrEmpty($Query))) {
Use-Window -Query $Query
}
Write-Host ('Send-MouseClick: "{0}" click at (X{1}, Y{2}).' -f "${Type}", $Coordinates[0], $Coordinates[1])
switch ($Type) {
'Left' { [MouseClick]::LeftClickAtPoint($Coordinates[0], $Coordinates[1]) }
# 'LeftDouble' { FIXME to be implemented }
# 'Right' { FIXME to be implemented }
default { Throw ('Send-MouseClick: Unknown click type "{0}"' -f "${Type}") }
}
# delay after
if ($Delay[1] -gt 0) {
Write-Host ('Send-MouseClick: Will wait {0} seconds (delay after sending the click(s)).' -f $Delay[1])
Start-Sleep $Delay[1]
}
}
End { }
}
extensions\sendmouseclick.extension.psm1
$ErrorActionPreference = 'Stop' # stop on all errors
$scriptRoot = Split-Path $MyInvocation.MyCommand.Definition
# get currently defined functions (before dot sourcing additional .ps1 files)
$functionsBefore = Get-ChildItem 'Function:\*'
# dot source files whose names start with a capital letter, ignore others
Get-ChildItem "${scriptRoot}\*.ps1" | Where-Object { $PSItem.Name -cmatch '^[A-Z]+' } | ForEach-Object { . $PSItem }
# get currently defined functions (after dot sourcing additional .ps1 files)
$functionsAfter = Get-ChildItem 'Function:\*'
# export functions whose names start with a capital letter, others are private
$functionsDiff = Compare-Object $functionsBefore $functionsAfter | Select-Object -ExpandProperty 'InputObject' | Select-Object -ExpandProperty 'Name'
$functionsDiff | Where-Object { $PSItem -cmatch '^[A-Z]+'} | ForEach-Object { Export-ModuleMember -Function $PSItem }
Virus Scan Results
Log in or click on link to see number of positives.
In cases where actual malware is found, the packages are subject to removal. Software sometimes has false positives. Moderators do not necessarily validate the safety of the underlying software, only that a package retrieves software from the official distribution point and/or validate embedded software against official distribution point (where distribution rights allow redistribution).
Chocolatey Pro provides runtime protection from possible malware.
Copyright
Copyright (c) 2023 foundata GmbH (https://github.com/foundata/chocolatey-sendmouseclick.extension)
Dependencies
-
- usewindow.extension (≥ 0.0.1)
Discussion for the Send-MouseClick extension Package
Ground Rules:
- This discussion is only about Send-MouseClick extension and the Send-MouseClick extension package. If you have feedback for Chocolatey, please contact the Google Group.
- This discussion will carry over multiple versions. If you have a comment about a particular version, please note that in your comments.
- The maintainers of this Chocolatey Package will be notified about new comments that are posted to this Disqus thread, however, it is NOT a guarantee that you will get a response. If you do not hear back from the maintainers after posting a message below, please follow up by using the link on the left side of this page or follow this link to contact maintainers. If you still hear nothing back, please follow the package triage process.
- Tell us what you love about the package or Send-MouseClick extension, or tell us what needs improvement.
- Share your experiences with the package, or extra configuration or gotchas that you've found.
- If you use a url, the comment will be flagged for moderation until you've been whitelisted. Disqus moderated comments are approved on a weekly schedule if not sooner. It could take between 1-5 days for your comment to show up.