Merge branch 'pr511' into stable

* pr511: (GH-519) Install-ChocolateyShortcut Enhancements
chocolatey · Jun 5, 2016 · 65be3f6 · 65be3f6
2 parents 01f1c34 + 84d9578
commit 65be3f6
Show file tree

Hide file tree

Showing 2 changed files with 137 additions and 27 deletions.
diff --git a/docs/generated/HelpersInstallChocolateyShortcut.md b/docs/generated/HelpersInstallChocolateyShortcut.md
@@ -12,6 +12,9 @@ Install-ChocolateyShortcut `
   [-Arguments <String>] `
   [-IconLocation <String>] `
   [-Description <String>] `
+  [-WindowStyle <Int32>] `
+  [-RunAsAdmin] `
+  [-PinToTaskbar] `
   [-IgnoredArguments <Object[]>] [<CommonParameters>]
 ~~~
 
@@ -42,7 +45,7 @@ None
 ## Parameters
 
 ###  -ShortcutFilePath &lt;String&gt;
-The full absolute path to where the shortcut should be created.  This is mandatory.
+The full absolute path to where the shortcut should be created.
 
 Property               | Value
 ---------------------- | -----
@@ -53,7 +56,7 @@ Default Value          |
 Accept Pipeline Input? | false
 
 ###  -TargetPath &lt;String&gt;
-The full absolute path to the target for new shortcut.  This is mandatory.
+The full absolute path to the target for new shortcut.
 
 Property               | Value
 ---------------------- | -----
@@ -64,8 +67,8 @@ Default Value          |
 Accept Pipeline Input? | false
 
 ###  -WorkingDirectory [&lt;String&gt;]
-The full absolute path of the Working Directory that will be used by
-the new shortcut.  This is optional
+OPTIONAL - The full absolute path of the Working Directory that will be
+used by the new shortcut.
 
 Property               | Value
 ---------------------- | -----
@@ -76,8 +79,8 @@ Default Value          |
 Accept Pipeline Input? | false
 
 ###  -Arguments [&lt;String&gt;]
-Additonal arguments that should be passed along to the new shortcut.  This
-is optional.
+OPTIONAL - Additonal arguments that should be passed along to the new
+shortcut.
 
 Property               | Value
 ---------------------- | -----
@@ -88,8 +91,8 @@ Default Value          |
 Accept Pipeline Input? | false
 
 ###  -IconLocation [&lt;String&gt;]
-The full absolute path to an icon file to be used for the new shortcut.  This
-is optional.
+OPTIONAL- The full absolute path to an icon file to be used for the new
+shortcut.
 
 Property               | Value
 ---------------------- | -----
@@ -100,7 +103,7 @@ Default Value          |
 Accept Pipeline Input? | false
 
 ###  -Description [&lt;String&gt;]
-A text description to be associated with the new description.  This is optional.
+OPTIONAL - A text description to be associated with the new description.
 
 Property               | Value
 ---------------------- | -----
@@ -110,6 +113,42 @@ Position?              | 6
 Default Value          | 
 Accept Pipeline Input? | false
 
+###  -WindowStyle [&lt;Int32&gt;]
+OPTIONAL - Type of windows target application should open with.
+0 = Hidden, 1 = Normal Size, 3 = Maximized, 7 - Minimized.
+Full list table 3.9 here: https://technet.microsoft.com/en-us/library/ee156605.aspx
+
+Property               | Value
+---------------------- | -----
+Aliases                | 
+Required?              | false
+Position?              | 7
+Default Value          | 0
+Accept Pipeline Input? | false
+
+###  -RunAsAdmin
+OPTIONAL - Set "Run As Administrator" checkbox for the created the
+shortcut.
+
+Property               | Value
+---------------------- | -----
+Aliases                | 
+Required?              | false
+Position?              | named
+Default Value          | False
+Accept Pipeline Input? | false
+
+###  -PinToTaskbar
+OPTIONAL - Pin the new shortcut to the taskbar.
+
+Property               | Value
+---------------------- | -----
+Aliases                | 
+Required?              | false
+Position?              | named
+Default Value          | False
+Accept Pipeline Input? | false
+
 ###  -IgnoredArguments [&lt;Object[]&gt;]
 Allows splatting with arguments that do not apply. Do not use directly.
 
@@ -156,6 +195,21 @@ Install-ChocolateyShortcut `
   -Description "This is the description"
 ~~~
 
+**EXAMPLE 3**
+
+~~~powershell
+
+# Creates a new notepad shortcut on the root of c: that starts
+# notepad.exe as Administrator.  Shortcut is also pinned to taskbar.
+
+Install-ChocolateyShortcut `
+  -ShortcutFilePath "C:\notepad.lnk" `
+  -TargetPath "C:\Windows\System32\notepad.exe" `
+  -WindowStyle 3 `
+  -RunAsAdmin `
+  -PinToTaskbar
+~~~
+
 ## Links
 
  * [[Install-ChocolateyDesktopLink|HelpersInstallChocolateyDesktopLink]]

diff --git a/src/chocolatey.resources/helpers/functions/Install-ChocolateyShortcut.ps1 b/src/chocolatey.resources/helpers/functions/Install-ChocolateyShortcut.ps1
@@ -34,25 +34,37 @@ None
 None
 
 .PARAMETER ShortcutFilePath
-The full absolute path to where the shortcut should be created.  This is mandatory.
+The full absolute path to where the shortcut should be created.
 
 .PARAMETER TargetPath
-The full absolute path to the target for new shortcut.  This is mandatory.
+The full absolute path to the target for new shortcut.
 
 .PARAMETER WorkingDirectory
-The full absolute path of the Working Directory that will be used by
-the new shortcut.  This is optional
+OPTIONAL - The full absolute path of the Working Directory that will be
+used by the new shortcut.
 
 .PARAMETER Arguments
-Additonal arguments that should be passed along to the new shortcut.  This
-is optional.
+OPTIONAL - Additonal arguments that should be passed along to the new
+shortcut.
 
 .PARAMETER IconLocation
-The full absolute path to an icon file to be used for the new shortcut.  This
-is optional.
+OPTIONAL- The full absolute path to an icon file to be used for the new
+shortcut.
 
 .PARAMETER Description
-A text description to be associated with the new description.  This is optional.
+OPTIONAL - A text description to be associated with the new description.
+
+.PARAMETER WindowStyle
+OPTIONAL - Type of windows target application should open with.
+0 = Hidden, 1 = Normal Size, 3 = Maximized, 7 - Minimized.
+Full list table 3.9 here: https://technet.microsoft.com/en-us/library/ee156605.aspx
+
+.PARAMETER RunAsAdmin
+OPTIONAL - Set "Run As Administrator" checkbox for the created the
+shortcut.
+
+.PARAMETER PinToTaskbar
+OPTIONAL - Pin the new shortcut to the taskbar.
 
 .PARAMETER IgnoredArguments
 Allows splatting with arguments that do not apply. Do not use directly.
@@ -79,6 +91,18 @@ Install-ChocolateyShortcut `
   -IconLocation "C:\test.ico" `
   -Description "This is the description"
 
+.EXAMPLE
+>
+# Creates a new notepad shortcut on the root of c: that starts
+# notepad.exe as Administrator.  Shortcut is also pinned to taskbar.
+
+Install-ChocolateyShortcut `
+  -ShortcutFilePath "C:\notepad.lnk" `
+  -TargetPath "C:\Windows\System32\notepad.exe" `
+  -WindowStyle 3 `
+  -RunAsAdmin `
+  -PinToTaskbar
+
 .LINK
 Install-ChocolateyDesktopLink
 
@@ -89,16 +113,19 @@ Install-ChocolateyExplorerMenuItem
 Install-ChocolateyPinnedTaskBarItem
 #>
 	param(
-	  [parameter(Mandatory=$true, Position=0)][string] $shortcutFilePath,
-	  [parameter(Mandatory=$true, Position=1)][string] $targetPath,
-	  [parameter(Mandatory=$false, Position=2)][string] $workingDirectory,
-	  [parameter(Mandatory=$false, Position=3)][string] $arguments,
-	  [parameter(Mandatory=$false, Position=4)][string] $iconLocation,
-	  [parameter(Mandatory=$false, Position=5)][string] $description,
+    [parameter(Mandatory=$true, Position=0)][string] $shortcutFilePath,
+    [parameter(Mandatory=$true, Position=1)][string] $targetPath,
+    [parameter(Mandatory=$false, Position=2)][string] $workingDirectory,
+    [parameter(Mandatory=$false, Position=3)][string] $arguments,
+    [parameter(Mandatory=$false, Position=4)][string] $iconLocation,
+    [parameter(Mandatory=$false, Position=5)][string] $description,
+    [parameter(Mandatory=$false, Position=6)][int] $windowStyle,
+    [parameter(Mandatory=$false)][switch] $runAsAdmin,
+    [parameter(Mandatory=$false)][switch] $pinToTaskbar,
     [parameter(ValueFromRemainingArguments = $true)][Object[]]$ignoredArguments
 	)
 
-	Write-Debug "Running 'Install-ChocolateyShortcut' with parameters ShortcutFilePath: `'$shortcutFilePath`', TargetPath: `'$targetPath`', WorkingDirectory: `'$workingDirectory`', Arguments: `'$arguments`', IconLocation: `'$iconLocation`', Description: `'$description`'";
+	Write-Debug "Running 'Install-ChocolateyShortcut' with parameters ShortcutFilePath: `'$shortcutFilePath`', TargetPath: `'$targetPath`', WorkingDirectory: `'$workingDirectory`', Arguments: `'$arguments`', IconLocation: `'$iconLocation`', Description: `'$description`', WindowStyle: `'$windowStyle`', RunAsAdmin: `'$runAsAdmin`', PinToTaskbar: `'$pinToTaskbar`'";
 
 	# http://powershell.com/cs/blogs/tips/archive/2009/02/05/validating-a-url.aspx
 	function isURIWeb($address) {
@@ -152,12 +179,41 @@ Install-ChocolateyPinnedTaskBarItem
 		  $lnk.Description = $description
 		}
 
-	    $lnk.Save()
+    if ($windowStyle) {
+      $lnk.WindowStyle = $windowStyle
+    }
+
+    $lnk.Save()
 
 		Write-Debug "Shortcut created."
+
+    [System.IO.FileInfo]$Path = $shortcutFilePath
+    If ($runAsAdmin) {
+      #In order to enable the "Run as Admin" checkbox, this code reads the .LNK as a stream
+      #  and flips a specific bit while writing a new copy.  It then replaces the original
+      #  .LNK with the copy, similar to this example: http://poshcode.org/2513
+      $TempFileName = [IO.Path]::GetRandomFileName()
+      $TempFile = [IO.FileInfo][IO.Path]::Combine($Path.Directory, $TempFileName)
+      $Writer = New-Object System.IO.FileStream $TempFile, ([System.IO.FileMode]::Create)
+      $Reader = $Path.OpenRead()
+      While ($Reader.Position -lt $Reader.Length) {
+        $Byte = $Reader.ReadByte()
+        If ($Reader.Position -eq 22) {$Byte = 34}
+        $Writer.WriteByte($Byte)
+        }
+      $Reader.Close()
+      $Writer.Close()
+      $Path.Delete()
+      Rename-Item -Path $TempFile -NewName $Path.Name | Out-Null
+    }
+
+    If ($pinToTaskbar) {
+      $scfilename = $Path.FullName
+      $pinverb = (new-object -com "shell.application").namespace($(split-path -parent $Path.FullName)).Parsename($(split-path -leaf $Path.FullName)).verbs() | ?{$_.Name -eq 'Pin to Tas&kbar'}
+      If ($pinverb) {$pinverb.doit()}
+    }
 	}
 	catch {
 		Write-Warning "Unable to create shortcut. Error captured was $($_.Exception.Message)."
 	}
 }
-