Merge branch 'epic/windows-updates' into chore/merge-master-into-wind…

…ows-updates
keymanapp · Nov 8, 2024 · e7a8013 · e7a8013
2 parents 2a9f2a3 + 790f4cb
commit e7a8013
Show file tree

Hide file tree

Showing 17 changed files with 810 additions and 89 deletions.
diff --git a/common/windows/delphi/general/Keyman.System.UpdateCheckResponse.pas b/common/windows/delphi/general/Keyman.System.UpdateCheckResponse.pas
@@ -35,6 +35,7 @@   TUpdateCheckResponsePackage = record
 
   TUpdateCheckResponse = record
   private
+    FOriginalData: string;
     FInstallSize: Int64;
     FInstallURL: string;
     FNewVersion: string;
@@ -46,9 +47,13 @@   TUpdateCheckResponse = record
     FFileName: string;
     function ParseKeyboards(nodes: TJSONObject): Boolean;
     function ParseLanguages(i: Integer; v: TJSONValue): Boolean;
+    function DoParse(const message, app, currentVersion: string): Boolean;
   public
     function Parse(const message: AnsiString; const app, currentVersion: string): Boolean;
 
+    procedure SaveToFile(const Filename: string);
+    function LoadFromFile(const Filename, app, currentVersion: string): Boolean;
+
     property CurrentVersion: string read FCurrentVersion;
     property NewVersion: string read FNewVersion;
     property NewVersionWithTag: string read FNewVersionWithTag;
@@ -58,25 +63,32 @@   TUpdateCheckResponse = record
     property ErrorMessage: string read FErrorMessage;
     property Status: TUpdateCheckResponseStatus read FStatus;
     property Packages: TUpdateCheckResponsePackages read FPackages;
+    property OriginalData: string read FOriginalData;
   end;
 
 implementation
 
 uses
+  System.Classes,
   System.Generics.Collections,
   versioninfo;
 
 { TUpdateCheckResponse }
 
 function TUpdateCheckResponse.Parse(const message: AnsiString; const app, currentVersion: string): Boolean;
+begin
+  Result := DoParse(string(UTF8String(message)), app, currentVersion);
+end;
+
+function TUpdateCheckResponse.DoParse(const message, app, currentVersion: string): Boolean;
 var
   node, doc: TJSONObject;
 begin
+  FOriginalData := message;
   FCurrentVersion := currentVersion;
   FStatus := ucrsNoUpdate;
 
-  // TODO: test with UTF8 characters in response
-  doc := TJSONObject.ParseJSONValue(UTF8String(message)) as TJSONObject;
+  doc := TJSONObject.ParseJSONValue(UTF8String(FOriginalData)) as TJSONObject;
   if doc = nil then
   begin
     FErrorMessage := Format('Invalid response:'#13#10'%s', [string(message)]);
@@ -168,4 +180,29 @@ function TUpdateCheckResponse.ParseLanguages(i: Integer; v: TJSONValue): Boolean
   Result := True;
 end;
 
+function TUpdateCheckResponse.LoadFromFile(const Filename, app, currentVersion: string): Boolean;
+var
+  ss: TStringStream;
+begin
+  ss := TStringStream.Create('', TEncoding.UTF8);
+  try
+    ss.LoadFromFile(Filename);
+    Result := DoParse(ss.DataString, app, currentVersion);
+  finally
+    ss.Free;
+  end;
+end;
+
+procedure TUpdateCheckResponse.SaveToFile(const Filename: string);
+var
+  ss: TStringStream;
+begin
+  ss := TStringStream.Create(FOriginalData, TEncoding.UTF8);
+  try
+    ss.SaveToFile(Filename);
+  finally
+    ss.Free;
+  end;
+end;
+
 end.
diff --git a/common/windows/delphi/general/KeymanPaths.pas b/common/windows/delphi/general/KeymanPaths.pas
@@ -17,6 +17,8 @@   TKeymanPaths = class
     const S_CEF_SubProcess = 'kmbrowserhost.exe';
     const S_CEF_SubProcess_Developer = 'kmdbrowserhost.exe';
     const S_CustomisationFilename = 'desktop_pro.pxx';
+
+    const S_KeymanAppData_UpdateCache = 'Keyman\UpdateCache\';
   public
     const S_KMShell = 'kmshell.exe';
     const S_TSysInfoExe = 'tsysinfo.exe';
@@ -27,8 +29,10 @@   TKeymanPaths = class
     const S_FallbackKeyboardPath = 'Keyboards\';
     const S__Package = '_Package\';
     const S_MCompileExe = 'mcompile.exe';
+    const S_UpdateCache_Metadata = 'cache.json';
     class function ErrorLogPath(const app: string = ''): string; static;
     class function KeymanHelpPath(const HelpFile: string): string; static;
+    class function KeymanUpdateCachePath(const filename: string = ''): string; static;
     class function KeymanDesktopInstallPath(const filename: string = ''): string; static;
     class function KeymanEngineInstallPath(const filename: string = ''): string; static;
     class function KeymanDesktopInstallDir: string; static;
@@ -423,6 +427,11 @@ class function TKeymanPaths.KeymanHelpPath(const HelpFile: string): string;
   Result := '';
 end;
 
+class function TKeymanPaths.KeymanUpdateCachePath(const filename: string): string;
+begin
+  Result := GetFolderPath(CSIDL_LOCAL_APPDATA) + S_KeymanAppData_UpdateCache + filename;
+end;
+
 class function TKeymanPaths.RunningFromSource(var keyman_root: string): Boolean;
 begin
   // On developer machines, if we are running within the source repo, then use

diff --git a/windows/src/desktop/kmshell/kmshell.dpr b/windows/src/desktop/kmshell/kmshell.dpr
@@ -177,7 +177,10 @@ uses
   Keyman.Configuration.System.HttpServer.App.TextEditorFonts in 'startup\help\Keyman.Configuration.System.HttpServer.App.TextEditorFonts.pas',
   Keyman.Configuration.System.HttpServer.App.Locale in 'web\Keyman.Configuration.System.HttpServer.App.Locale.pas',
   Keyman.System.AndroidStringToKeymanLocaleString in '..\..\..\..\common\windows\delphi\general\Keyman.System.AndroidStringToKeymanLocaleString.pas',
-  Keyman.Configuration.System.Main in 'main\Keyman.Configuration.System.Main.pas';
+  Keyman.Configuration.System.Main in 'main\Keyman.Configuration.System.Main.pas',
+  UpdateXMLRenderer in 'render\UpdateXMLRenderer.pas',
+  Keyman.System.UpdateCheckStorage in 'main\Keyman.System.UpdateCheckStorage.pas',
+  Keyman.System.RemoteUpdateCheck in 'main\Keyman.System.RemoteUpdateCheck.pas';
 
 {$R VERSION.RES}
 {$R manifest.res}

diff --git a/windows/src/desktop/kmshell/kmshell.dproj b/windows/src/desktop/kmshell/kmshell.dproj
@@ -354,6 +354,9 @@
         <DCCReference Include="web\Keyman.Configuration.System.HttpServer.App.Locale.pas"/>
         <DCCReference Include="..\..\..\..\common\windows\delphi\general\Keyman.System.AndroidStringToKeymanLocaleString.pas"/>
         <DCCReference Include="main\Keyman.Configuration.System.Main.pas"/>
+        <DCCReference Include="render\UpdateXMLRenderer.pas"/>
+        <DCCReference Include="main\Keyman.System.UpdateCheckStorage.pas"/>
+        <DCCReference Include="main\Keyman.System.RemoteUpdateCheck.pas"/>
         <None Include="Profiling\AQtimeModule1.aqt"/>
         <BuildConfiguration Include="Debug">
             <Key>Cfg_2</Key>
@@ -415,9 +418,9 @@
                 <Platform value="Win64">False</Platform>
             </Platforms>
             <Deployment Version="3">
-                <DeployFile LocalName="kmshell.rsm" Configuration="Debug" Class="DebugSymbols">
+                <DeployFile LocalName="bin\Win32\Debug\kmshell.exe" Configuration="Debug" Class="ProjectOutput">
                     <Platform Name="Win32">
-                        <RemoteName>kmshell.rsm</RemoteName>
+                        <RemoteName>kmshell.exe</RemoteName>
                         <Overwrite>true</Overwrite>
                     </Platform>
                 </DeployFile>
@@ -427,9 +430,9 @@
                         <Overwrite>true</Overwrite>
                     </Platform>
                 </DeployFile>
-                <DeployFile LocalName="Profiling\AQtimeModule1.aqt" Configuration="Debug" Class="ProjectFile">
+                <DeployFile LocalName="bin\Win32\Debug\kmshell.rsm" Configuration="Debug" Class="DebugSymbols">
                     <Platform Name="Win32">
-                        <RemoteDir>.\</RemoteDir>
+                        <RemoteName>kmshell.rsm</RemoteName>
                         <Overwrite>true</Overwrite>
                     </Platform>
                 </DeployFile>