fix(developer): Option to disable prompting for project upgrade

mcdurdin · mcdurdin · commit 6c918e6aa8d2 · 2023-12-06T09:54:12.000+07:00
Fixes #10146. Some developers may wish to stick with kpj-1.0 for now, and the prompt to upgrade would annoying because it cannot be hidden. This resolves that. Note that I haven't at this point renamed UrlRenderer.pas, although it may be worth considering in the future.
diff --git a/common/windows/delphi/general/RegistryKeys.pas b/common/windows/delphi/general/RegistryKeys.pas
@@ -374,6 +374,7 @@ interface
   SRegValue_IDEOptDebuggerAutoResetBeforeCompiling = 'debugger auto reset before compilng'; // CU
   SRegValue_IDEOptAutoSaveBeforeCompiling = 'auto save before compiling'; // CU
   SRegValue_IDEOptOSKAutoSaveBeforeImporting = 'osk auto save before importing'; // CU
+  SRegValue_IDEOptPromptToUpgradeProjects = 'prompt to upgrade projects'; // CU
 
   // Note: keeping 'web host port' reg value name to ensure settings maintained
   //       from version 14.0 and earlier of Keyman Developer. Other values are
diff --git a/developer/src/tike/dialogs/UfrmOptions.dfm b/developer/src/tike/dialogs/UfrmOptions.dfm
@@ -29,7 +29,7 @@ inherited frmOptions: TfrmOptions
         Top = 185
         Width = 125
         Height = 25
-        Caption = '&Proxy Settings...'
+        Caption = 'Prox&y Settings...'
         TabOrder = 4
         OnClick = cmdProxySettingsClick
       end
@@ -38,7 +38,7 @@ inherited frmOptions: TfrmOptions
         Top = 47
         Width = 401
         Height = 45
-        Caption = '&External Editor Path'
+        Caption = 'E&xternal Editor Path'
         TabOrder = 1
         object editExternalEditorPath: TEdit
           Left = 8
@@ -61,7 +61,7 @@ inherited frmOptions: TfrmOptions
         Top = 216
         Width = 125
         Height = 25
-        Caption = 'S&MTP Settings...'
+        Caption = '&SMTP Settings...'
         TabOrder = 5
         OnClick = cmdSMTPSettingsClick
       end
@@ -101,7 +101,7 @@ inherited frmOptions: TfrmOptions
           Top = 16
           Width = 69
           Height = 21
-          Caption = '&Browse...'
+          Caption = 'Bro&wse...'
           TabOrder = 1
           OnClick = cmdBrowseDefaultProjectPathClick
         end
@@ -119,7 +119,7 @@ inherited frmOptions: TfrmOptions
         Top = 181
         Width = 218
         Height = 17
-        Caption = '&Automatically save before importing OSK'
+        Caption = 'Au&tomatically save before importing OSK'
         TabOrder = 7
       end
       object gbPrivacy: TGroupBox
@@ -128,13 +128,13 @@ inherited frmOptions: TfrmOptions
         Width = 401
         Height = 73
         Caption = 'Privacy'
-        TabOrder = 8
+        TabOrder = 9
         object chkReportUsage: TCheckBox
           Left = 8
           Top = 44
           Width = 311
           Height = 17
-          Caption = '&Share anonymous usage statistics with keyman.com'
+          Caption = 'Share anonymous &usage statistics with keyman.com'
           TabOrder = 1
         end
         object chkReportErrors: TCheckBox
@@ -146,6 +146,14 @@ inherited frmOptions: TfrmOptions
           TabOrder = 0
         end
       end
+      object chkPromptToUpgradeProjects: TCheckBox
+        Left = 151
+        Top = 204
+        Width = 218
+        Height = 17
+        Caption = '&Prompt to upgrade projects to 17.0 format'
+        TabOrder = 8
+      end
     end
     object tabEditor: TTabSheet
       Caption = 'Editor'
diff --git a/developer/src/tike/dialogs/UfrmOptions.pas b/developer/src/tike/dialogs/UfrmOptions.pas
@@ -104,6 +104,7 @@   TfrmOptions = class(TTikeForm)
     gbServer: TGroupBox;
     chkListLocalURLs: TCheckBox;
     cmdConfigureServer: TButton;
+    chkPromptToUpgradeProjects: TCheckBox;
     procedure FormCreate(Sender: TObject);
     procedure cmdOKClick(Sender: TObject);
     procedure cmdDefaultFontClick(Sender: TObject);
@@ -192,6 +193,7 @@ procedure TfrmOptions.FormCreate(Sender: TObject);
     chkDebuggerAutoResetBeforeCompiling.Checked := DebuggerAutoResetBeforeCompiling;
     chkAutoSaveBeforeCompiling.Checked :=          AutoSaveBeforeCompiling;
     chkOSKAutoSaveBeforeImporting.Checked :=       OSKAutoSaveBeforeImporting;
+    chkPromptToUpgradeProjects.Checked :=          PromptToUpgradeProjects;
 
     chkCharMapAutoLookup.Checked := CharMapAutoLookup;
     chkCharMapDisableDatabaseLookups.Checked := CharMapDisableDatabaseLookups;
@@ -291,6 +293,7 @@ procedure TfrmOptions.cmdOKClick(Sender: TObject);
     DebuggerAutoResetBeforeCompiling := chkDebuggerAutoResetBeforeCompiling.Checked;
     AutoSaveBeforeCompiling          := chkAutoSaveBeforeCompiling.Checked;
     OSKAutoSaveBeforeImporting       := chkOSKAutoSaveBeforeImporting.Checked;
+    PromptToUpgradeProjects          := chkPromptToUpgradeProjects.Checked;
 
     ServerUseLocalAddresses := chkListLocalURLs.Checked;
 
diff --git a/developer/src/tike/main/KeymanDeveloperOptions.pas b/developer/src/tike/main/KeymanDeveloperOptions.pas
@@ -69,6 +69,7 @@   TKeymanDeveloperOptions = class
     FServerNgrokToken: string;
     FServerNgrokRegion: string;
     FServerKeepAlive: Boolean;
+    FPromptToUpgradeProjects: Boolean;
     procedure CloseRegistry;
     procedure OpenRegistry;
     function regReadString(const nm, def: string): string;
@@ -102,6 +103,7 @@   TKeymanDeveloperOptions = class
     property DebuggerAutoResetBeforeCompiling: Boolean read FDebuggerAutoResetBeforeCompiling write FDebuggerAutoResetBeforeCompiling;
     property AutoSaveBeforeCompiling: Boolean read FAutoSaveBeforeCompiling write FAutoSaveBeforeCompiling;
     property OSKAutoSaveBeforeImporting: Boolean read FOSKAutoSaveBeforeImporting write FOSKAutoSaveBeforeImporting;
+    property PromptToUpgradeProjects: Boolean read FPromptToUpgradeProjects write FPromptToUpgradeProjects;
 
     property ReportErrors: Boolean read FReportErrors write FReportErrors;
     property ReportUsage: Boolean read FReportUsage write FReportUsage;
@@ -211,6 +213,7 @@ procedure TKeymanDeveloperOptions.Read;
     FDebuggerAutoResetBeforeCompiling := regReadBool(SRegValue_IDEOptDebuggerAutoResetBeforeCompiling, False);
     FAutoSaveBeforeCompiling := regReadBool(SRegValue_IDEOptAutoSaveBeforeCompiling, False);
     FOSKAutoSaveBeforeImporting := regReadBool(SRegValue_IDEOptOSKAutoSaveBeforeImporting, False);
+    FPromptToUpgradeProjects := regReadBool(SRegValue_IDEOptPromptToUpgradeProjects, True);
 
     FServerDefaultPort := regReadInt(SRegValue_IDEOptServerPort, 8008);
     FServerKeepAlive := regReadBool(SRegValue_IDEOptServerKeepAlive, False);
@@ -270,6 +273,7 @@ procedure TKeymanDeveloperOptions.Write;
     regWriteBool(SRegValue_IDEOptDebuggerAutoResetBeforeCompiling, FDebuggerAutoResetBeforeCompiling);
     regWriteBool(SRegValue_IDEOptAutoSaveBeforeCompiling, FAutoSaveBeforeCompiling);
     regWriteBool(SRegValue_IDEOptOSKAutoSaveBeforeImporting, FOSKAutoSaveBeforeImporting);
+    regWriteBool(SRegValue_IDEOptPromptToUpgradeProjects, FPromptToUpgradeProjects);
 
     regWriteInt(SRegValue_IDEOptServerPort, FServerDefaultPort);
     regWriteBool(SRegValue_IDEOptServerKeepAlive, FServerKeepAlive);
diff --git a/developer/src/tike/project/Keyman.Developer.System.Project.ProjectFile.pas b/developer/src/tike/project/Keyman.Developer.System.Project.ProjectFile.pas
@@ -922,6 +922,7 @@ function TProject.Render: WideString;
       //
 
       TProjectUrlRenderer.AddUrls(doc.documentElement);
+      TProjectUrlRenderer.AddProcessState(doc.documentElement);
 
       xsl := MSXMLDOMDocumentFactory.CreateDOMDocument;
       try
diff --git a/developer/src/tike/project/Keyman.Developer.System.Project.UrlRenderer.pas b/developer/src/tike/project/Keyman.Developer.System.Project.UrlRenderer.pas
@@ -8,15 +8,26 @@ interface
 type
   TProjectUrlRenderer = class
     class procedure AddUrls(root: IXMLDomNode);
+    class procedure AddProcessState(root: IXMLDomNode);
   end;
 
 implementation
 
 uses
+  KeymanDeveloperOptions,
   Upload_Settings;
 
 { TProjectUrlRenderer }
 
+class procedure TProjectUrlRenderer.AddProcessState(root: IXMLDomNode);
+var
+  node: IXMLDomElement;
+begin
+  node := root.ownerDocument.createElement('DeveloperState');
+  node.setAttribute('promptToUpgradeProjects', FKeymanDeveloperOptions.PromptToUpgradeProjects);
+  root.appendChild(node);
+end;
+
 class procedure TProjectUrlRenderer.AddUrls(root: IXMLDomNode);
 var
   node: IXMLDomNode;
diff --git a/developer/src/tike/project/Keyman.Developer.UI.Project.UfrmProject.pas b/developer/src/tike/project/Keyman.Developer.UI.Project.UfrmProject.pas
@@ -94,6 +94,7 @@   TfrmProject = class(TfrmTikeChild)  // I2721
     procedure SetGlobalProject;
     procedure StartClose; override;
     procedure CompileAll;
+    procedure RefreshOptions; override;
   end;
 
 implementation
@@ -202,6 +203,12 @@ procedure TfrmProject.RefreshHTML;
   RefreshCaption;
 end;
 
+procedure TfrmProject.RefreshOptions;
+begin
+  inherited;
+  ProjectRefresh(nil);
+end;
+
 procedure TfrmProject.ProjectRefresh(Sender: TObject);
 begin
   if frmKeymanDeveloper.ActiveChild <> Self
diff --git a/developer/src/tike/xml/project/elements.xsl b/developer/src/tike/xml/project/elements.xsl
@@ -278,7 +278,8 @@
   <!-- Upgrades -->
 
   <xsl:template name="upgrade-warning">
-    <xsl:if test="KeymanDeveloperProject/Options/Version != '2.0' or not(KeymanDeveloperProject/Options/Version)">
+    <xsl:if test="KeymanDeveloperProject/DeveloperState/@promptToUpgradeProjects != '0' and
+       (KeymanDeveloperProject/Options/Version != '2.0' or not(KeymanDeveloperProject/Options/Version))">
     <div class="upgrade-warning">
       <p>⚠️ This project file is in an old format. You should upgrade it to the Keyman Developer 17.0 project format.
         <xsl:call-template name="button">
