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

common/windows/delphi/general/utilfiletypes.pas

@@ -91,6 +91,27 @@ function IsProjectFile(const FileName: string): Boolean;
 function IsKeyboardFile(const FileName: string): Boolean;
 function RemoveFileExtension(Filename, Extension: string): string;
 
+(**
+  * Builds the compiled keyboard filename by inserting the base keyboard ID
+  * before the .kmx extension.
+  *
+  * @param  KeyboardFileName       Keyboard filename, in the form '[path\]keyboardid[.kmx]'
+  * @param  BaseKeyboardIDHex      Base keyboard KLID in eight digit hexadecimal form
+  * @return Compiled keyboard filename, in the form '[path\]keyboardid-<KLID>.kmx'
+  *)
+function BuildKeyboardFilenameWithBaseKeyboardID(const KeyboardFileName: string; BaseKeyboardIDHex: string): string;
+
+(**
+  * Builds the dead-key compiled keyboard filename by inserting the base
+  * keyboard ID and -d suffix before the .kmx extension.
+  *
+  * @param  KeyboardFileName       Keyboard filename, in the form '[path]\keyboardid[.kmx]'
+  * @param  BaseKeyboardIDHex      Base keyboard KLID in eight digit hexadecimal form
+  * @return Dead-key compiled keyboard filename, in the form '[path\]keyboardid-<KLID>-d.kmx'
+  *)
+function BuildKeyboardFilenameWithBaseKeyboardIDAndDeadkey(const KeyboardFileName: string; BaseKeyboardIDHex: string): string;
+
+
 type
   TKeymanFileTypeInfo = class
   public
@@ -208,4 +229,14 @@ class function TKeymanFileTypeInfo.IsPackageWelcomeFile(
     SameText(ExtractFileExt(Filename), ExtractFileExt(PackageFile_Welcome)));
 end;
 
+function BuildKeyboardFilenameWithBaseKeyboardID(const KeyboardFileName: string; BaseKeyboardIDHex: string): string;
+begin
+    Result := ChangeFileExt(KeyboardFileName, '') + '-' + BaseKeyboardIDHex + '.kmx';
+end;
+
+function BuildKeyboardFilenameWithBaseKeyboardIDAndDeadkey(const KeyboardFileName: string; BaseKeyboardIDHex: string): string;
+begin
+  Result := ChangeFileExt(KeyboardFileName, '') + '-' + BaseKeyboardIDHex + '-d.kmx';
+end;
+
 end.

common/windows/delphi/general/utilstr.pas

@@ -1,18 +1,18 @@
 (*
   Name:             utilstr
   Copyright:        Copyright (C) SIL International.
-  Documentation:    
-  Description:      
+  Documentation:
+  Description:
   Create Date:      1 Aug 2006
 
   Modified Date:    8 Jun 2012
   Authors:          mcdurdin
-  Related Files:    
-  Dependencies:     
+  Related Files:
+  Dependencies:
 
-  Bugs:             
-  Todo:             
-  Notes:            
+  Bugs:
+  Todo:
+  Notes:
   History:          01 Aug 2006 - mcdurdin - Refactor util functions into multiple units
                     23 Aug 2006 - mcdurdin - Add StringToExtString and WideQuotedStr functions
                     14 Sep 2006 - mcdurdin - Add RectToString, StringToRect, use widestrings for some functions
@@ -58,8 +58,6 @@ function GetTokenFromCaret(line: string; var selx, sellen: Integer): string;
 
 function WideQuotedStr(const str: WideString): WideString; deprecated;  // I3310
 
-
-
 implementation
 
 uses
@@ -78,7 +76,7 @@ function CommaToken(var s: WideString): WideString;
     Result := '';
     Exit;
   end;
-  
+
   if s[1] = '"' then
   begin
     Delete(s,1,1);

windows/src/desktop/kmshell/install/UpgradeMnemonicLayout.pas

@@ -1,18 +1,18 @@
 (*
   Name:             UpgradeMnemonicLayout
   Copyright:        Copyright (C) SIL International.
-  Documentation:    
-  Description:      
+  Documentation:
+  Description:
   Create Date:      31 Dec 2014
 
   Modified Date:    2 Jun 2015
   Authors:          mcdurdin
-  Related Files:    
-  Dependencies:     
+  Related Files:
+  Dependencies:
 
-  Bugs:             
-  Todo:             
-  Notes:            
+  Bugs:
+  Todo:
+  Notes:
   History:          31 Dec 2014 - mcdurdin - I4553 - V9.0 - Upgrade to 476 or later requires recompile of all mnemonic layouts
                     06 Feb 2015 - mcdurdin - I4552 - V9.0 - Add mnemonic recompile option to ignore deadkeys
                     08 Apr 2015 - mcdurdin - I4651 - V9.0 - Mnemonic layout recompiler maps AltGr+VK_BKSLASH rather than VK_OEM_102
@@ -46,7 +46,8 @@ implementation
   kmint,
   RegistryKeys,
   utilexecute,
-  utilkmshell;
+  utilkmshell,
+  utilfiletypes;
 
 const
   { CurrentMnemonicLayoutVersion = 476;  // First 9.0 build with fixes for mnemonic layouts }
@@ -171,7 +172,7 @@ class procedure TUpgradeMnemonicLayout.UpgradeLayoutLanguage(
   FBaseKeyboardIDHex := IntToHex(BaseKeyboardID, 8);
   FBaseFileName := Keyboard.Filename;
   FDestFileName := OutputFileName;
-  FDestDeadkeyFileName := ChangeFileExt(FDestFileName, '') + '-d.kmx';   // I4552
+  FDestDeadkeyFileName := BuildKeyboardFilenameWithBaseKeyboardIDAndDeadkey(FBaseFileName, FBaseKeyboardIDHex);   // I4552
   FMCompilePath := TKeymanPaths.KeymanEngineInstallPath(TKeymanPaths.S_MCompileExe);
   FDestPath := ExtractFileDir(Keyboard.Filename);
 

windows/src/desktop/kmshell/kmshell.dpr

@@ -183,7 +183,8 @@ uses
   Keyman.System.DownloadUpdate in 'main\Keyman.System.DownloadUpdate.pas',
   Keyman.System.ExecutionHistory in '..\..\..\..\common\windows\delphi\general\Keyman.System.ExecutionHistory.pas',
   Keyman.Configuration.UI.UfrmStartInstall in 'main\Keyman.Configuration.UI.UfrmStartInstall.pas' {frmStartInstall},
-  Keyman.Configuration.Util.NetworkConnection in 'util\Keyman.Configuration.Util.NetworkConnection.pas';
+  Keyman.Configuration.Util.NetworkConnection in 'util\Keyman.Configuration.Util.NetworkConnection.pas',
+  Keyman.Configuration.System.BaseKeyboard in 'main\Keyman.Configuration.System.BaseKeyboard.pas';
 
 {$R VERSION.RES}
 {$R manifest.res}

windows/src/desktop/kmshell/kmshell.dproj

@@ -358,6 +358,7 @@
             <Form>frmStartInstall</Form>
         </DCCReference>
         <DCCReference Include="util\Keyman.Configuration.Util.NetworkConnection.pas"/>
+        <DCCReference Include="main\Keyman.Configuration.System.BaseKeyboard.pas"/>
         <None Include="Profiling\AQtimeModule1.aqt"/>
         <BuildConfiguration Include="Debug">
             <Key>Cfg_2</Key>
@@ -419,21 +420,21 @@
                 <Platform value="Win64">False</Platform>
             </Platforms>
             <Deployment Version="3">
-                <DeployFile LocalName="Profiling\AQtimeModule1.aqt" Configuration="Debug" Class="ProjectFile">
+                <DeployFile LocalName="bin\Win32\Debug\kmshell.exe" Configuration="Debug" Class="ProjectOutput">
                     <Platform Name="Win32">
-                        <RemoteDir>.\</RemoteDir>
+                        <RemoteName>kmshell.exe</RemoteName>
                         <Overwrite>true</Overwrite>
                     </Platform>
                 </DeployFile>
-                <DeployFile LocalName="bin\Win32\Debug\kmshell.rsm" Configuration="Debug" Class="DebugSymbols">
+                <DeployFile LocalName="Profiling\AQtimeModule1.aqt" Configuration="Debug" Class="ProjectFile">
                     <Platform Name="Win32">
-                        <RemoteName>kmshell.rsm</RemoteName>
+                        <RemoteDir>.\</RemoteDir>
                         <Overwrite>true</Overwrite>
                     </Platform>
                 </DeployFile>
-                <DeployFile LocalName="bin\Win32\Debug\kmshell.exe" Configuration="Debug" Class="ProjectOutput">
+                <DeployFile LocalName="bin\Win32\Debug\kmshell.rsm" Configuration="Debug" Class="DebugSymbols">
                     <Platform Name="Win32">
-                        <RemoteName>kmshell.exe</RemoteName>
+                        <RemoteName>kmshell.rsm</RemoteName>
                         <Overwrite>true</Overwrite>
                     </Platform>
                 </DeployFile>

windows/src/desktop/kmshell/main/Keyman.Configuration.System.BaseKeyboard.pas

@@ -0,0 +1,108 @@
+(*
+ * Keyman is copyright (C) SIL Global. MIT License.
+ *
+ * Created by Ross Cruickshank on 2026-09-12
+ *
+ *
+ * This unit assists in setting the base keyboard configuration,
+ * including compiling the installed keyboard layouts against
+ * the selected base keyboard.
+ *)
+unit Keyman.Configuration.System.BaseKeyboard;
+
+interface
+
+uses
+  Winapi.Windows,
+  System.SysUtils,
+  keymanapi_TLB;
+
+(**
+ * Returns true if the keyboard files need to be compiled for the specified KLID.
+ * @param  BaseKeyboardID  KLID of the base keyboard to compile.
+ * @returns  True  If the keyboard files need to be compiled.
+ *)
+function BaseKeyboardNeedsMCompile(BaseKeyboardID: Integer): Boolean;
+
+(**
+ * Sets the base keyboard KLID for the current user and compiles the keyboard
+ * layout files if necessary. In the case the compiled keyboard files are
+ *not present, it will require elevation.
+ * @param  WindowHandle  Window handle to own the elevation prompt.
+ * @param  BaseKeyboardID  KLID of the base keyboard KLID to set.
+ * @returns  True  when the base keyboard setting has been applied.
+ *)
+function SetBaseKeyboard(WindowHandle: THandle; BaseKeyboardID: Integer): Boolean;
+
+(**
+ * Compiles the installed keyboard layouts for the specified KLID.
+ * Must run elevated.
+ *
+ * @param  BaseKeyboardID  KLID of the base keyboard to compile.
+ * @returns  True  when the compilation is successful.
+ *)
+function MCompileBaseKeyboard(BaseKeyboardID: Integer): Boolean;
+
+implementation
+
+uses
+  kmint,
+  utilkmshell,
+  utilfiletypes;
+
+function BaseKeyboardNeedsMCompile(BaseKeyboardID: Integer): Boolean;
+var
+  I: Integer;
+  Keyboard: IKeymanKeyboardInstalled;
+  KeyboardFileName: string;
+  BaseKeyboardIDHex: string;
+begin
+  BaseKeyboardIDHex := IntToHex(BaseKeyboardID, 8);
+  for I := 0 to kmcom.Keyboards.Count - 1 do
+  begin
+    Keyboard := kmcom.Keyboards.Items[I];
+    KeyboardFileName := Keyboard.Filename;
+    if FileExists(KeyboardFileName) and
+      (not FileExists(BuildKeyboardFilenameWithBaseKeyboardID(KeyboardFileName, BaseKeyboardIDHex)) or
+       not FileExists(BuildKeyboardFilenameWithBaseKeyboardIDAndDeadkey(KeyboardFileName, BaseKeyboardIDHex))) then
+      Exit(True);
+  end;
+  Result := False;
+end;
+
+function SetBaseKeyboard(WindowHandle: THandle; BaseKeyboardID: Integer): Boolean;
+begin
+  Result := True;
+  if BaseKeyboardNeedsMCompile(BaseKeyboardID) then
+  begin
+    if not kmcom.SystemInfo.IsAdministrator then
+    begin
+      Result := WaitForElevatedConfiguration(WindowHandle, '-mcompilekbds ' + IntToHex(BaseKeyboardID, 8)) = 0;
+    end
+    else
+      Result := MCompileBaseKeyboard(BaseKeyboardID);
+  end;
+  if not Result then
+      Exit;
+  kmcom.Options['koBaseLayout'].Value := BaseKeyboardID;
+  kmcom.Options.Apply;
+end;
+
+function MCompileBaseKeyboard(BaseKeyboardID: Integer): Boolean;
+var
+  i: Integer;
+  kbd: IKeymanKeyboardInstalled;
+begin
+  Result := False;
+  // can be called from command line so test for admin
+  if not kmcom.SystemInfo.IsAdministrator then
+    Exit;
+  for i := 0 to kmcom.Keyboards.Count - 1 do
+  begin
+    kbd := kmcom.Keyboards[i];
+    (kbd as IKeymanKeyboardInstalled2).MCompileForBaseKeyboard(BaseKeyboardID);
+  end;
+  Result := True;
+end;
+
+end.

windows/src/desktop/kmshell/main/UfrmBaseKeyboard.pas

@@ -11,29 +11,44 @@ interface
   TfrmBaseKeyboard = class(TfrmWebContainer)
     procedure TntFormCreate(Sender: TObject);
   private
+    FBaseKeyboardID: Integer;
     procedure Footer_Cancel;
     procedure Footer_OK(params: TStringList);
   protected
     procedure FireCommand(const command: WideString; params: TStringList); override;
   end;
 
-function ConfigureBaseKeyboard: Boolean;
+(**
+ * Displays a form for the user to select a base keyboard. If the user selects a base
+ * keyboard, the KLID is used to Set the Base Keyboard.
+ *
+ * @returns  True  if the user selected base keyboard has been set.
+ *)
+function ConfigureAndSetBaseKeyboard(WindowHandle: THandle): Boolean;
+
 
 implementation
 
 {$R *.dfm}
 
 uses
   BaseKeyboards,
-  kmint;
+  ErrorControlledRegistry,
+  RegistryKeys,
+  keymanapi_TLB,
+  Keyman.Configuration.System.BaseKeyboard,
+  kmint,
+  utilkmshell;
+
 
-function ConfigureBaseKeyboard: Boolean;
+function ConfigureAndSetBaseKeyboard(WindowHandle: THandle): Boolean;
+var BaseKeyboardID: Integer;
 begin
   with TfrmBaseKeyboard.Create(nil) do
   try
     Result := ShowModal = mrOk;
     if Result then
-      kmcom.Apply;
+      SetBaseKeyboard(WindowHandle, FBaseKeyboardID)
   finally
     Free;
   end;
@@ -65,9 +80,9 @@ procedure TfrmBaseKeyboard.Footer_OK(params: TStringList);
   v: Integer;
 begin
   if not TryStrToInt('$'+params.Values['id'], v) then Exit;
-  kmcom.Options['koBaseLayout'].Value := v;
-  kmcom.Options.Apply;
+  FBaseKeyboardID := v;
   ModalResult := mrOk;
 end;
 
+
 end.

windows/src/desktop/kmshell/main/UfrmMain.pas

@@ -174,6 +174,7 @@ implementation
   Hints,
   HotkeyUtils,
   initprog,
+  Keyman.Configuration.System.BaseKeyboard,
   Keyman.Configuration.System.TIPMaintenance,
   Keyman.Configuration.UI.UfrmDiagnosticTests,
   KeymanOptionNames,
@@ -198,6 +199,7 @@ implementation
   Keyman.Configuration.UI.UfrmStartInstall,
   RegistryKeys,
   SupportXMLRenderer,
+  UfrmBaseKeyboard,
   UfrmChangeHotkey,
   UfrmHTML,
   UfrmInstallKeyboardFromWeb,
@@ -661,9 +663,14 @@ procedure TfrmMain.cefBeforeBrowseSync(Sender: TObject; const Url: string;
  ------------------------------------------------------------------------------}
 
 procedure TfrmMain.Options_BaseKeyboard;   // I4169
+var
+  BaseKeyboardID: Integer;
 begin
-  WaitForElevatedConfiguration(Handle, '-basekeyboard');
-  // Refresh will be triggered by elevated process
+  if ConfigureAndSetBaseKeyboard(Handle) then
+  begin
+    DoRefresh;
+  end;
+
 end;
 
 procedure TfrmMain.Options_SettingsManager;