unit Keyman.Configuration.UI.InstallFile;

interface

uses
  System.Classes,

  keymanapi_tlb;

type
  TInstallFile = class sealed
  private
    class procedure AddDefaultLanguageHotkey(
      Keyboard: IKeymanKeyboardInstalled); static;
    class procedure AddDefaultLanguageHotkeys(
      InstalledKeyboards: array of IKeymanKeyboardInstalled); static;
    class procedure RegisterKeyboardPackageLanguage(
      FPackage: IKeymanPackageInstalled; const BCP47: string); static;
  public
    class function BrowseAndInstallKeyboardFromFile(Owner: TComponent): Boolean; static;
    class function Execute(KeyboardFileNames: TStrings; const FirstKeyboardFileName: string; FSilent, FNoWelcome: Boolean; const LogFile: string): Boolean; overload; static;
    class function Execute(Owner: TComponent; const FileName: string; ASilent, ANoWelcome: Boolean; const LogFile, BCP47: string): Boolean; overload; static;
    class function Execute(Owner: TComponent; const FileNames: TStrings; ASilent: Boolean): Boolean; overload; static;
  end;

implementation

uses
  System.SysUtils,
  System.Win.ComObj,
  Vcl.Controls,
  Vcl.Dialogs,

  Keyman.Configuration.System.TIPMaintenance,
  Keyman.Configuration.UI.KeymanProtocolHandler,
  Keyman.Configuration.UI.MitigationForWin10_1803,
  kmint,
  UfrmHTML,
  UfrmInstallKeyboard;

class function TInstallFile.Execute(KeyboardFileNames: TStrings; const FirstKeyboardFileName: string; FSilent, FNoWelcome: Boolean;
  const LogFile: string): Boolean;
begin
  if TKeymanProtocolHandler.CanHandle(FirstKeyboardFileName) then
  begin
    Result := TKeymanProtocolHandler.Handle(nil, FirstKeyboardFileName, FSilent, FNoWelcome, LogFile);
  end
  else if (KeyboardFileNames.Count > 1) or (Pos('=', FirstKeyboardFileName) > 0) then
  begin
    Result := TInstallFile.Execute(nil, KeyboardFileNames, FSilent)
  end
  // TODO: support bare package ids from command line (if it does not include a file extension, assume it is a .kmp and try and download it)
//  else if IsNotPackageOrKeyboardFile then
  else
  begin
    Result := TInstallFile.Execute(nil, FirstKeyboardFileName, FSilent, FNoWelcome, LogFile, '');
  end;
end;

class function TInstallFile.Execute(Owner: TComponent; const FileName: string; ASilent, ANoWelcome: Boolean; const LogFile, BCP47: string): Boolean;
var
  n: Integer;
  InstalledKeyboards: array of IKeymanKeyboardInstalled;
  InstalledPackage: IKeymanPackageInstalled;
  i: Integer;
begin
  // TODO: refactor the UI out of this unit into a wrapper unit
  with TfrmInstallKeyboard.Create(Owner) do
  try
    Silent := ASilent;
    DefaultBCP47Tag := BCP47;
    InstallFile := FileName;
    if ModalResult = mrCancel then
      // failed to start install
      Result := False
    else
    begin
      if ASilent then
      begin
        InstallKeyboard(LogFile, BCP47);
        Result := True;
      end
      else
        Result := ShowModal = mrOk;
    end;
  finally
    Free;
  end;

  if not Result then
    Exit;

  kmcom.Keyboards.Refresh;
  kmcom.Keyboards.Apply;
  kmcom.Packages.Refresh;

  InstalledPackage := nil;
  SetLength(InstalledKeyboards, 0);
  if LowerCase(ExtractFileExt(FileName)) = '.kmp' then
  begin
    n := kmcom.Packages.IndexOf(FileName);
    if (n >= 0) then
    begin
      InstalledPackage := kmcom.Packages[n];
      SetLength(InstalledKeyboards, InstalledPackage.Keyboards.Count);
      for i := 0 to InstalledPackage.Keyboards.Count - 1 do
        InstalledKeyboards[i] := InstalledPackage.Keyboards[i] as IKeymanKeyboardInstalled;
    end;
  end
  else
  begin
    n := kmcom.Keyboards.IndexOf(FileName);
    if n >= 0 then
    begin
      SetLength(InstalledKeyboards, 1);
      InstalledKeyboards[0] := kmcom.Keyboards[n];
    end;
  end;

  kmcom.Languages.Apply;
  AddDefaultLanguageHotkeys(InstalledKeyboards);

  kmcom.Apply;

  if InstalledPackage <> nil then
  begin
    //if not ASilent then SelectLanguage(False);
    if not ASilent and not ANoWelcome then
      DoShowPackageWelcome(Owner, InstalledPackage, False);
  end;
end;

/// <summary>
/// Takes a list of filename + bcp47 pairs (in filename=bcp47 format) and
/// installs each package / keyboard and ensures the associated bcp47 language is
/// registered. If a bcp47 value is not provided, then the default language for
/// the package is registered. If a package contains multiple keyboards, then bcp47
/// should not be provided, and will be ignored if it is.
/// This is the handler for the `-i` parameter, e.g.
///   kmshell -i khmer_angkor.kmp c:\temp\sil_euro_latin.kmp=fr
/// </summary>
class function TInstallFile.Execute(Owner: TComponent; const FileNames: TStrings; ASilent: Boolean): Boolean;
var
  i, j: Integer;
  FPackage: IKeymanPackageInstalled;
  FKeyboard: IKeymanKeyboardInstalled;
  Filename: string;
  FilenameBCP47: TArray<string>;
  IsPackage: Boolean;
  BCP47Tag: string;
begin
  Result := False;
  FPackage := nil;
  FKeyboard := nil;

  for i := 0 to FileNames.Count - 1 do
  begin
    try
      kmcom.Keyboards.Refresh;
      kmcom.Keyboards.Apply;

      FilenameBCP47 := Filenames[i].Split(['=']);
      Filename := FilenameBCP47[0];
      IsPackage := AnsiSameText(ExtractFileExt(FileName), '.kmp');
      if not FileExists(FileName) then
      begin
        if not ASilent then
          ShowMessage('File: ' + Filename + ' location not available to Admin User');
        Exit;
      end;
      if IsPackage then
      begin
        FPackage := (kmcom.Packages as IKeymanPackagesInstalled2).Install2(FileName, True);
        if Length(FilenameBCP47) > 1
          then RegisterKeyboardPackageLanguage(FPackage, FilenameBCP47[1])
          else RegisterKeyboardPackageLanguage(FPackage, '');
        // The keyboard will be installed for current user as a separate step
      end
      else
      begin
        FKeyboard := (kmcom.Keyboards as IKeymanKeyboardsInstalled2).Install2(FileName, True);
        if (Length(FilenameBCP47) > 1) and (Trim(FilenameBCP47[1]) <> '')
          then BCP47Tag := FilenameBCP47[1]
          else BCP47Tag := TTIPMaintenance.GetFirstLanguage(FKeyboard);
        TTIPMaintenance.DoRegister(FKeyboard.ID, BCP47Tag);
        // The keyboard will be installed for current user as a separate step
      end;
      CheckForMitigationWarningFor_Win10_1803(ASilent, '');
    except
      on E:EOleException do
      begin
        if kmcom.Errors.Count = 0 then Raise;
        if not ASilent then
          for j := 0 to kmcom.Errors.Count - 1 do
            ShowMessage(kmcom.Errors[j].Description);
        Exit;
      end;
    end;

    FPackage := nil;
    FKeyboard := nil;
  end;

  kmcom.Keyboards.Refresh;
  kmcom.Keyboards.Apply;
  Result := True;
end;

class function TInstallFile.BrowseAndInstallKeyboardFromFile(Owner: TComponent): Boolean;
var
  dlgOpen: TOpenDialog;
begin
  dlgOpen := TOpenDialog.Create(nil);
  try
    dlgOpen.Filter :=
      'Keyman files (*.kmx, *.kxx, *.kmp)|*.kmx;*.kxx;*.kmp|Keyman keyboards (*.kmx,*.kxx)' +
      '|*.kmx;*.kxx|Keyman packages (*.kmp)|*.kmp|All files (*.*)|*.*';
    dlgOpen.Title := 'Install Keyman Keyboard';

    if dlgOpen.Execute then
      Result := Execute(Owner, dlgOpen.FileName, False, False, '', '')
    else
      Result := False;
  finally
    dlgOpen.Free;
  end;
end;

class procedure TInstallFile.RegisterKeyboardPackageLanguage(FPackage: IKeymanPackageInstalled; const BCP47: string);
var
  DefaultBCP47Language: string;
  i: Integer;
begin
  if (FPackage.Keyboards.Count > 1) or (BCP47 = '') then
  begin
    // We don't attempt to propagate the language association preference
    // when there is more than one keyboard in the package. This means a
    // little bit of nasty hoop jumping in order to get the default
    // language code for each keyboard.
    for i := 0 to FPackage.Keyboards.Count - 1 do
    begin
      DefaultBCP47Language := FPackage.Keyboards[i].DefaultBCP47Languages;
      if DefaultBCP47Language.Contains(' ') then
        DefaultBCP47Language := DefaultBCP47Language.Split([' '])[0];
      TTIPMaintenance.DoRegister(FPackage.Keyboards[i].ID, DefaultBCP47Language);
    end;
  end
  else if FPackage.Keyboards.Count > 0 then
    TTIPMaintenance.DoRegister(FPackage.Keyboards[0].ID, BCP47);
end;

class procedure TInstallFile.AddDefaultLanguageHotkey(Keyboard: IKeymanKeyboardInstalled);
var
  i: Integer;
begin
  if not Keyboard.DefaultHotkey.IsEmpty and (Keyboard.Languages.Count > 0) then
  begin
    for i := 0 to kmcom.Languages.Count - 1 do
    begin
      if kmcom.Languages[i].KeymanKeyboardLanguage = Keyboard.Languages[0] then
      begin
        kmcom.Languages[i].Hotkey.RawValue := Keyboard.DefaultHotkey.RawValue;
        Break;
      end;
    end;
  end;
end;

class procedure TInstallFile.AddDefaultLanguageHotkeys(InstalledKeyboards: array of IKeymanKeyboardInstalled);
var
  i: Integer;
begin
  for i := 0 to High(InstalledKeyboards) do
    AddDefaultLanguageHotkey(InstalledKeyboards[i]);
end;

end.
