fix(windows): set basekeyboard as current user not the admin user on a elevated process.

[rc-swag]

Fixes: #15152

This was quicker fix then I thought the more through issue 15154 still remains to catch discover all the cases the non-admin user configuration changes that may been attempting.

Build-bot: release:windows

User Testing

TEST_BASE_KEYBOARD_CURRENT_USER

1. Login into Windows with and account that is a "standard" user and does not have "Administrator" rights.

2. Install the Keyman from this PR

3. Open Keyman Configuration -> Keyboard Layouts

4. Install a keyboard for example sil_ipa

5. Open Keyman Configuration -> Options

Check C:\ProgramData\Keyman\Keyman Engine\Keyboard\_Package\sil_ipa don't delete the base sil_ipa.kmx but delete any with KLIDs for example sil_ipa-00000409-d.kmx

6. Click Base Keyboard, change the Base Keyboard to German. You will need to enter the login details for a Admin user.

7. Confirm the Keyboard changes for the current user and not the Admin user used for the elevated processs.

8. Check C:\ProgramData\Keyman\Keyman Engine\Keyboard\_Package\sil_ipa there should now be a sil_ipa-????0407-d.kmx and sil_ipa-????0407.kmx

TEST_BASE_KEYBOARD_CURRENT_USER_KMX_EXISTS

After completing the steps in TEST_BASE_KEYBOARD_CURRENT_USER

1. Open Keyman Configuration -> Options
2. Click Base Keyboard, change the Base Keyboard to English. You may need to enter the login details for a Admin user.
3. Close Configuration
   Check German mcomplied kmx is still there i.e. C:\ProgramData\Keyman\Keyman Engine\Keyboard\_Package\sil_ipa there should now be a sil_ipa-????0407-d.kmx and sil_ipa-????0407.kmx
4. Open Keyman Configuration -> Options
   6.Click Base Keyboard, change the Base Keyboard to German. You should Not be asked to enter a admin user.

[keymanapp-test-bot]

User Test Results

Test specification and instructions

• ⬜ TEST_BASE_KEYBOARD_CURRENT_USER (OPEN) (notes)
• ⬜ TEST_BASE_KEYBOARD_CURRENT_USER_KMX_EXISTS (OPEN): notes

Results Template

# Test Results

* **TEST_BASE_KEYBOARD_CURRENT_USER (OPEN):** notes
* **TEST_BASE_KEYBOARD_CURRENT_USER_KMX_EXISTS (OPEN):** notes

Test Artifacts

• Windows
  • Keyman for Windows
  • FirstVoices Keyboards for Windows
  • Text Editor (ARM64)
  • Text Editor (x64)
  • Text Editor (x86)

[mcdurdin]

I don't think this is correct. The base keyboard dialog needs to run elevated -- because when you change the base keyboard, Keyman needs to mcompile each of the installed keyboards against the new base keyboard:

keyman/windows/src/engine/kmcomapi/com/options/keymanoptions.pas

Lines 133 to 135 in 1536a5f

	if FOldBaseLayout <> Get_Items('koBaseLayout').Value then
	for I := 0 to Context.Keyboards.Count - 1 do // I4169
	(Context.Keyboards.Items[I] as IIntKeymanKeyboardInstalled).UpdateBaseLayout;

The problem here is that the base layout setting is saved against the Admin user, but needs to be saved against the current user. This probably is best solved by splitting the admin component -- mcompiling -- out of the TKeymanOptions.Apply function, and running it as a separate step from the Base Keyboard dialog. Then the Base Keyboard dialog does not show elevated, but just elevates when OK is clicked, if it detects that new mcompiles need to be run, and does that as a kmshell -mcompile <basekeylayoutid> call? (implementation calls: TKeymanKeyboardInstalled.UpdateBaseLayout for each installed keyboard).

TKPRecompileMnemonicKeyboard then needs a parameter for the base layout, rather than reading it from the context options:

keyman/windows/src/engine/kmcomapi/processes/keyboard/kprecompilemnemonickeyboard.pas

Lines 87 to 88 in 9779792

	with Context as TKeymanContext do
	BaseKeyboardID := (Options as IKeymanOptions).Items['koBaseLayout'].Value;

So some plumbing required, sadly.

[rc-swag]

I don't think this is correct. The base keyboard dialog needs to run elevated -- because when you change the base keyboard, Keyman needs to mcompile each of the installed keyboards against the new base keyboard:

This change may not have been the prefered change but it worked. It does run as an elevated but the process is created as a current user.
I tested it last week and it changed the base keyboard for the non admin user. Not the admin. I will look into it again.

[mcdurdin]

Did you verify that this worked with a baselayout you had never selected previously? How could the mcompiled .kmx files be written to the C:\ProgramData folder if the base layout steps are run non-elevated?

One reasonably straightforward way to address this, for starting as a non-elevated user:

1. CU: The Base Keyboard dialog itself should not be elevated - launch from the current process.
2. CU: After clicking OK, verify if any mcompile is needed by looking to see if the needed .kmx files are already present in ProgramData.
3. CU: If mcompile is required, then wait for elevated kmshell -mcompile <baseklid> should be called to run the mcompile process.
4. LM: kmshell -mcompile will need to temporarily set the option[koBaseLayout] for the admin user in order to run the process. This will cause mcompile to be run. Reset option afterwards.
5. CU: After the wait for elevated process step completes, set option[koBaseLayout] for current user.

Also:

• If Keyman Configuration is started as an elevated user, skip steps 3 and 4.
• Need to update kmcomapi to only run mcompile if elevated

[mcdurdin]

5. Confirm the Keyboard changes for the current user and not the Admin user used for the elevated processs

Need to verify that the relevant files are saved in ProgramData too and that the base keyboard is mapped as expected!

[Meng-Heng]

Test Prerequisites

1. Setup a non-admin local user by following this https://www.wikihow.com/Create-a-New-Local-User-Account-in-Windows-10

Test Specs

1. Windows 10 Bootcamp

Test Results

• TEST_BASE_KEYBOARD_CURRENT_USER (PASSED):

1. Launch Keyman version 19.0.249
2. Open Keyman Configuration -> Options
3. Click Base Keyboard -> Enter Admin's password -> Change the Base Keyboard to English - Irish

Note

The Keyman Configuration window becomes unclickable until I click out of the app and click back. It does not show unresponding.

5. Confirmed: the Keyboard changes for the current user and not the Admin user.
6. To clarify, log into Admin account
7. Verified: The Base keyboard does not change to English - Irish.

Note

The 2nd and later attempts of changing the Base keyboard, this error pop up

The Base keyboard does not change until I click X, and then open Keyman again.

[mcdurdin]

The 2nd and later attempts of changing the Base keyboard, this error pop up

Note, if a crash dialog appears, FAIL the test. Also, please Copy to Clipboard and paste it into the test report.

TEST_BASE_KEYBOARD_CURRENT_USER (FAIL): a crash dialog appeared

[rc-swag]

Test-bot: retest TEST_BASE_KEYBOARD_CURRENT_USER

[Meng-Heng]

Test Specs

1. Keyman for Windows v19.9.260-alpha-test-16162

Test Results

• TEST_BASE_KEYBOARD_CURRENT_USER (OPEN):
  Login into Windows with and account that is a "standard" user
  Install the Keyman from this PR
  Dialog pops up asking for the Admin Authentication
  Open Keyman Configuration -> Keyboard Layouts
  Install a sil_ipa keyboard
  Open Keyman Configuration -> Options
  Go to C:\ProgramData\Keyman\Keyman Engine\Keyboard\_Package\sil_ipa
  Delete sil_ipa-00000409-d.kmx and sil_ipa-00000409.kmx both time asked for Admin login details
  Click Base Keyboard -> change the Base Keyboard to German -> provide Admin login details
  Confirm the Keyboard changes for the current user and not the Admin user used for the elevated processs.
  Check C:\ProgramData\Keyman\Keyman Engine\Keyboard\_Package\sil_ipa
  VERIFIED: There are sil_ipa-00000407-d.kmx and sil_ipa-00000407.kmx` files

• TEST_BASE_KEYBOARD_CURRENT_USER_KMX_EXISTS (OPEN): notes