Add option to add explorer context menu in Windows installer #5774

bergmeister · 2018-01-02T22:54:18Z

PR Summary

A new dialogue is added in the Windows installer to offer the option of adding explorer.exe context menus to open PowerShell in the current location as a normal shell or as administrator. The context menu entries are achiveven via registry entries and is available when right-clicking on:

the background of explorer
a folder in explorer
a drive in explorer
on the Desktop

Adding the new custom dialog required copy-pasting the WiX source code of WixUI_InstallDir.wxs as a base as described in the official WiX documentation here.
The registry entries are quite standard but the approach for the context menu of opening PowerShell as an Administrator must be discussed:
The Windows registry has the limitation that it only offers a runas/command structure but not a runas/proogram/command structure, which means there can only be one main context entry to open PowerShell as an Admin. Since a user might have alerady configured this context menu, I decided that it is best to not stomp over it but rather open PowerShell normally but then elevate it. This of course has the disadvantage that it takes a bit longer and a window is visible for a brief moment. The only alternative that would allow to launch PowerShell elevated the first time is to have the 2 context menu in a submenu, see here
The registry keys contain the PowerShell version to cater for side by side installations of future versions.
Some stuff had to be created in a WiX fragment, which means that this XML section could be factored out into its own file (with the disadvantage of having to linkt this file then into the compilation process of candle,, light, etc.)
The best person to review is probably @SteveL-MSFT

This is how it currently looks like:
Installer:

Explorer context menu:

PR Checklist

Note: Please mark anything not applicable to this PR NA.

PR has a meaningful title
- Use the present tense and imperative mood when describing your changes
Summarized changes
[?] User facing Documentation needed Maybe document the WiX parameter to enable users to use this feature as well when installing quietly?
- Issue filed - Issue link: Feature: Windows Installer to offer option of context menu to open PowerShell in explorer #5012
Change is not breaking
[NA] Make sure you've added a new test if existing tests do not effectively test the code changed A test for this would require a UI automation framework like Ranorex or Selenium.
- [NA] Add [feature] if the change is significant or affectes feature tests
This PR is ready to merge and is not Work in Progress.
- If the PR is work in progress, please add the prefix WIP: to the beginning of the title and remove the prefix when the PR is ready.

Because this is the first custom dialog, I had to take in the source code of WixUI_InstallDir and modify as it is officially recommended http://wixtoolset.org/documentation/manual/v3/wixui/wixui_customizations.html

…Name' variable.

…entries as requested by Steve Lee

…o wix_explorer_contextmenu

… in explorer

…he future. refactor common usage of pwsh.exe path

… error). I found that New-MsiPackage does not cleanup the temporary wix files and therefore did not see the errors myself first locally.

Due to a limitation of the registry, the admin prompt has to launch from a PS process. the only alternative would be to use sub menus: https://blogs.msdn.microsoft.com/andrew_richards/2017/03/01/enhancing-the-open-command-prompt-here-shift-right-click-context-menu-experience/

SteveL-MSFT · 2018-01-03T00:42:07Z

@bergmeister Thanks for doing this. I think I prefer the submenu to starting a process to start elevated PowerShell. cc @joeyaiello

bergmeister · 2018-01-03T07:48:51Z

Ok. Any preference on the naming of the menu? I am thinking of PowerShell X.Y.Z for the menu and then Open here and Open here as Administrator here for the 2 submenus.

…o wix_explorer_contextmenu

bergmeister · 2018-01-03T22:38:42Z

@SteveL-MSFT I changed it to use submenus to properly elevate it. This is how it looks now (the logic whether the submenu pops out on the left or right hand side is handled by Windows depending on where one right-clicks):

…for return key. This makes it also possible to tick/untick the checkbox using the space key.

…scaped)

bergmeister · 2018-01-03T23:34:28Z

NB: I also tweaked the tabbing index on the new installer page to be consistent with other WiX dialogues and to be able to use the spacebar to toggle the checkbox. Additionally, the context menus also have accessibility shortcuts now, which means that the top context menu can be selected using the P key (or pressing it multiple times if other menus also have the same key configured) and H or A for the submenus (the latter is the Admin shell). I am done now and the PR can be reviewed again.

SteveL-MSFT

LGTM, built off your branch and works for me. Great work!

bergmeister · 2018-01-04T06:13:39Z

Thanks. Do you think we should document the new property EXPLORER_CONTEXT_MENU_OPENPOWERSHELL for people who want to install the MSI quietly (/q option of msiexec.exe) to allow them to use this new feature as well?

SteveL-MSFT · 2018-01-04T06:35:48Z

@bergmeister yes, we should document it. However, since this msi is new, we don't have an existing doc to put it. @sdwheeler can you suggest how we should document the property that can be passed to the msi installer for non-interactive (quiet) installs?

sdwheeler · 2018-01-04T15:51:29Z

@bergmeister @SteveL-MSFT Please create an issue for this in the PowerShell-Docs repo. It should probably be assigned to @joeyaiello. He is working on the V6 setup docs. Joey and I can work out how and where this should be documented. Also include all possible MSI properties that could be used so we can be complete.

SteveL-MSFT · 2018-01-04T16:57:53Z

Created MicrosoftDocs/PowerShell-Docs#2007

bergmeister · 2018-01-04T16:59:15Z

@sdwheeler The new property is the only one as far as I am aware. But I thought that this would go only into 6.1 or this a candidate for merge to the release branch @SteveL-MSFT ?

SteveL-MSFT · 2018-01-04T17:59:44Z

@bergmeister this is planned for 6.1

iSazonov · 2018-01-05T10:16:34Z

Currently we have a nuget package to set PSModulePath with Windows PowerShell module paths. It is not obvious. My request (for follow PR) is to add the option to the installer too.

iSazonov · 2018-01-05T11:26:57Z

Do you think we should document the new property EXPLORER_CONTEXT_MENU_OPENPOWERSHELL

Maybe ADD_EXPLORER_CONTEXT_MENU_OPENPOWERSHELL.

…RER_CONTEXT_MENU_OPENPOWERSHELL

bergmeister · 2018-01-05T12:46:48Z

@iSazonov I applied your renaming suggestion. Please open an issue about your PSModulePath request with more details in it, I would be happy to help you by doing the UI/WiX bit of it in case you haven't worked much with WiX much yet.

iSazonov · 2018-01-05T17:40:20Z

@bergmeister Thanks!
I'll open a Issue about PSModulePath if @SteveL-MSFT approve.

KalleOlaviNiemitalo · 2020-03-06T16:10:23Z

assets/Product.wxs

+      <Publish Dialog="LicenseAgreementDlg" Control="Back" Event="NewDialog" Value="WelcomeDlg">1</Publish>
+      <Publish Dialog="LicenseAgreementDlg" Control="Next" Event="NewDialog" Value="InstallDirDlg">LicenseAccepted = "1"</Publish>
+
+      <Publish Dialog="ExplorerContextMenuDialog" Control="Back" Event="NewDialog" Value="InstallDirDlg">1</Publish>


This implementation of the Back button looks OK, does not have bug #12055 yet.

bergmeister added 15 commits November 5, 2017 12:43

Add new dialog after installation directory dialog with 2 checkboxes.

4696695

Because this is the first custom dialog, I had to take in the source code of WixUI_InstallDir and modify as it is officially recommended http://wixtoolset.org/documentation/manual/v3/wixui/wixui_customizations.html

Replace hard-coded 'PowerShell' string with the already used 'Product…

be20458

…Name' variable.

Make it only 1 checkbox for admin and non-admin context context menu …

1a868c3

…entries as requested by Steve Lee

Merge branch 'master' of https://github.com/PowerShell/PowerShell int…

b61d1a7

…o wix_explorer_contextmenu

fix typo in comment

57c98b5

add context menu implementation when clicking on folder or background…

5a3ef50

… in explorer

renaming and refactoring

b249a7a

fix variable reference and add icon to context menu

603e2d2

fix syntax error

cbae803

default value gets set automatically and we end up with 2 -> remove

1205c78

remove trailing spaces before xml ending

8796384

incorporate versioning in registry key to cater for side by side in t…

53b9924

…he future. refactor common usage of pwsh.exe path

use brackets for WixShellExecTarget (compilation error)

a5b8dd4

use full path to pwsh.exe since it does not seem to work (compilation…

f1e4c2f

… error). I found that New-MsiPackage does not cleanup the temporary wix files and therefore did not see the errors myself first locally.

bergmeister added 2 commits January 3, 2018 21:27

Merge branch 'master' of https://github.com/PowerShell/PowerShell int…

77206b1

…o wix_explorer_contextmenu

Use submenus for explorer context menus as agreed in PR.

55040ee

bergmeister added 4 commits January 3, 2018 22:51

make tab index consistent with standard wix dialogs, default to next …

8158ee1

…for return key. This makes it also possible to tick/untick the checkbox using the space key.

minor renaming of submenu

7a4a069

Add keyboard shortcuts for sub menus

d70c451

keyboard shortcut for top context menu as well (ampersand had to be e…

ae39c16

…scaped)

SteveL-MSFT approved these changes Jan 4, 2018

View reviewed changes

SteveL-MSFT added the Documentation Needed in this repo Documentation is needed in this repo label Jan 4, 2018

SteveL-MSFT mentioned this pull request Jan 4, 2018

Document PSCore6 MSI properties MicrosoftDocs/PowerShell-Docs#2007

Closed

7 tasks

iSazonov self-assigned this Jan 5, 2018

iSazonov approved these changes Jan 5, 2018 •

edited

Loading

View reviewed changes

Rename Wix property EXPLORER_CONTEXT_MENU_OPENPOWERSHELL to ADD_EXPLO…

72e5751

…RER_CONTEXT_MENU_OPENPOWERSHELL

iSazonov merged commit ceb8f50 into PowerShell:master Jan 5, 2018

bergmeister mentioned this pull request Jan 7, 2018

Fix x86 installer bug: it gets installed as an x64 component and has the same UpgradeCode as the x64 installer leading to an uninstallation of an x64 installation (and vice versa) #5812

Merged

8 tasks

bergmeister mentioned this pull request Apr 28, 2018

Do not provide two submenus in file explorer integration #6599

Closed

joeyaiello mentioned this pull request Oct 15, 2018

Docs needed for 'Add option to add explorer context menu in Windows installer' MicrosoftDocs/PowerShell-Docs#3056

Closed

joeyaiello removed Documentation Needed in this repo Documentation is needed in this repo labels Oct 15, 2018

KalleOlaviNiemitalo reviewed Mar 6, 2020

View reviewed changes

Add option to add explorer context menu in Windows installer #5774

Add option to add explorer context menu in Windows installer #5774

Uh oh!

Conversation

bergmeister commented Jan 2, 2018 • edited by iSazonov Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Summary

PR Checklist

Uh oh!

SteveL-MSFT commented Jan 3, 2018

Uh oh!

bergmeister commented Jan 3, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bergmeister commented Jan 3, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bergmeister commented Jan 3, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

SteveL-MSFT left a comment

Choose a reason for hiding this comment

Uh oh!

bergmeister commented Jan 4, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

SteveL-MSFT commented Jan 4, 2018

Uh oh!

sdwheeler commented Jan 4, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

SteveL-MSFT commented Jan 4, 2018

Uh oh!

bergmeister commented Jan 4, 2018

Uh oh!

SteveL-MSFT commented Jan 4, 2018

Uh oh!

iSazonov commented Jan 5, 2018

Uh oh!

iSazonov commented Jan 5, 2018

Uh oh!

Uh oh!

bergmeister commented Jan 5, 2018

Uh oh!

iSazonov commented Jan 5, 2018

Uh oh!

KalleOlaviNiemitalo Mar 6, 2020

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

bergmeister commented Jan 2, 2018 •

edited by iSazonov

Loading

bergmeister commented Jan 3, 2018 •

edited

Loading

bergmeister commented Jan 3, 2018 •

edited

Loading

bergmeister commented Jan 3, 2018 •

edited

Loading

bergmeister commented Jan 4, 2018 •

edited

Loading

sdwheeler commented Jan 4, 2018 •

edited

Loading