Merge branch 'feature/issue#15-user-db-deletion' into develop

Author: delphidabbler

Src/CodeSnip.dpr

@@ -3,7 +3,7 @@
  * v. 2.0. If a copy of the MPL was not distributed with this file, You can
  * obtain one at https://mozilla.org/MPL/2.0/
  *
- * Copyright (C) 2005-2021, Peter Johnson (gravatar.com/delphidabbler).
+ * Copyright (C) 2005-2022, Peter Johnson (gravatar.com/delphidabbler).
  *
  * CodeSnip application project file.
 }
@@ -369,7 +369,8 @@ uses
   UWindowSettings in 'UWindowSettings.pas',
   UXMLDocConsts in 'UXMLDocConsts.pas',
   UXMLDocHelper in 'UXMLDocHelper.pas',
-  UXMLDocumentEx in 'UXMLDocumentEx.pas';
+  UXMLDocumentEx in 'UXMLDocumentEx.pas',
+  FmDeleteUserDBDlg in 'FmDeleteUserDBDlg.pas' {DeleteUserDBDlg};
 
 // Include resources
 {$Resource ExternalObj.tlb}       // Type library file

Src/CodeSnip.dproj

@@ -572,6 +572,9 @@
 			<DCCReference Include="UXMLDocConsts.pas"/>
 			<DCCReference Include="UXMLDocHelper.pas"/>
 			<DCCReference Include="UXMLDocumentEx.pas"/>
+			<DCCReference Include="FmDeleteUserDBDlg.pas">
+				<Form>DeleteUserDBDlg</Form>
+			</DCCReference>
 			<None Include="CodeSnip.todo"/>
 			<BuildConfiguration Include="Base">
 				<Key>Base</Key>

Src/FmDeleteUserDBDlg.dfm

@@ -0,0 +1,48 @@
+inherited DeleteUserDBDlg: TDeleteUserDBDlg
+  Caption = 'Delete User Database'
+  ExplicitWidth = 474
+  ExplicitHeight = 375
+  PixelsPerInch = 96
+  TextHeight = 13
+  inherited pnlBody: TPanel
+    object edConfirm: TEdit
+      Left = 0
+      Top = 216
+      Width = 201
+      Height = 21
+      TabOrder = 0
+    end
+    inline frmWarning: TFixedHTMLDlgFrame
+      Left = 0
+      Top = 0
+      Width = 369
+      Height = 210
+      Align = alTop
+      TabOrder = 1
+      TabStop = True
+      ExplicitWidth = 369
+      ExplicitHeight = 210
+      inherited pnlBrowser: TPanel
+        Width = 369
+        Height = 210
+        ExplicitWidth = 369
+        ExplicitHeight = 210
+        inherited wbBrowser: TWebBrowser
+          Width = 369
+          Height = 210
+          ExplicitWidth = 369
+          ExplicitHeight = 210
+          ControlData = {
+            4C00000023260000B41500000000000000000000000000000000000000000000
+            000000004C000000000000000000000001000000E0D057007335CF11AE690800
+            2B2E126208000000000000004C0000000114020000000000C000000000000046
+            8000000000000000000000000000000000000000000000000000000000000000
+            00000000000000000100000000000000000000000000000000000000}
+        end
+      end
+    end
+  end
+  inherited btnOK: TButton
+    OnClick = btnOKClick
+  end
+end

Src/FmDeleteUserDBDlg.pas

@@ -0,0 +1,109 @@
+{
+ * This Source Code Form is subject to the terms of the Mozilla Public License,
+ * v. 2.0. If a copy of the MPL was not distributed with this file, You can
+ * obtain one at https://mozilla.org/MPL/2.0/
+ *
+ * Copyright (C) 2022, Peter Johnson (gravatar.com/delphidabbler).
+ *
+ * Implements a dialogue box that asks user to confirm deletion of user-defined
+ * snippets database.
+}
+
+
+unit FmDeleteUserDBDlg;
+
+interface
+
+uses
+  // Delphi
+  Forms, StdCtrls, Controls, ExtCtrls, Classes,
+  // Project
+  FmGenericOKDlg,
+  FrBrowserBase, FrHTMLDlg, FrFixedHTMLDlg,
+  UBaseObjects;
+
+type
+  TDeleteUserDBDlg = class(TGenericOKDlg, INoPublicConstruct)
+    edConfirm: TEdit;
+    frmWarning: TFixedHTMLDlgFrame;
+    procedure btnOKClick(Sender: TObject);
+  strict private
+    const
+      cConfirmText = 'DELETE MY SNIPPETS';
+    var
+      fPermissionGranted: Boolean;
+  strict protected
+    ///  <summary>Protected constructor that sets up form.</summary>
+    constructor InternalCreate(AOwner: TComponent); override;
+    procedure ConfigForm; override;
+    procedure ArrangeForm; override;
+    function IsValidPassword: Boolean;
+  public
+    class function Execute(AOwner: TComponent): Boolean;
+  end;
+
+implementation
+
+uses
+  // Delphi
+  SysUtils,
+  // Project
+  UCtrlArranger, UMessageBox;
+
+{$R *.dfm}
+
+procedure TDeleteUserDBDlg.ArrangeForm;
+begin
+  frmWarning.Height := frmWarning.DocHeight;
+  edConfirm.Left := 0;
+  TCtrlArranger.MoveBelow(frmWarning, edConfirm, 12);
+  TCtrlArranger.AlignHCentresTo([frmWarning], [edConfirm]);
+  pnlBody.ClientHeight := TCtrlArranger.TotalControlHeight(pnlBody) + 8;
+  inherited;
+end;
+
+procedure TDeleteUserDBDlg.btnOKClick(Sender: TObject);
+resourcestring
+  sBadPassword = 'Invalid confirmation text entered';
+begin
+  inherited;
+  fPermissionGranted := IsValidPassword;
+  if not fPermissionGranted then
+  begin
+    TMessageBox.Error(Self, sBadPassword);
+    edConfirm.Text := '';
+    ModalResult := mrNone;
+  end;
+end;
+
+procedure TDeleteUserDBDlg.ConfigForm;
+begin
+  inherited;
+//  frmWarning.OnBuildCSS := BuildCSS;
+  frmWarning.Initialise('dlg-dbdelete.html');
+end;
+
+class function TDeleteUserDBDlg.Execute(AOwner: TComponent): Boolean;
+begin
+  with InternalCreate(AOwner) do
+    try
+      ShowModal;
+      Result := fPermissionGranted;
+    finally
+      Free;
+    end;
+end;
+
+constructor TDeleteUserDBDlg.InternalCreate(AOwner: TComponent);
+begin
+  Assert(Supports(Self, INoPublicConstruct), ClassName + '.InternalCreate: '
+    + 'Form''s protected constructor can''t be called');
+  inherited InternalCreate(AOwner);
+end;
+
+function TDeleteUserDBDlg.IsValidPassword: Boolean;
+begin
+  Result := edConfirm.Text = cConfirmText;
+end;
+
+end.

Src/FmMain.dfm

@@ -8,8 +8,8 @@ inherited MainForm: TMainForm
   Constraints.MinWidth = 480
   Menu = mnuMain
   OnResize = FormResize
-  ExplicitWidth = 613
-  ExplicitHeight = 495
+  ExplicitWidth = 621
+  ExplicitHeight = 503
   PixelsPerInch = 96
   TextHeight = 13
   object sbStatusBar: TStatusBar
@@ -866,6 +866,14 @@ inherited MainForm: TMainForm
         ' default web browser'
       ImageIndex = 6
     end
+    object actDeleteUserDatabase: TAction
+      Category = 'Database'
+      Caption = 'Delete User Database...'
+      Hint = 
+        'Delete User Database|Deletes the user'#39's snippets database - USE ' +
+        'WITH CAUTION'
+      OnExecute = actDeleteUserDatabaseExecute
+    end
   end
   object mnuMain: TMainMenu
     Images = ilMain
@@ -1093,6 +1101,12 @@ inherited MainForm: TMainForm
       object miMoveUserDatabase: TMenuItem
         Action = actMoveUserDatabase
       end
+      object miSpacer21: TMenuItem
+        Caption = '-'
+      end
+      object miDeleteUserDatabase: TMenuItem
+        Action = actDeleteUserDatabase
+      end
     end
     object miCompile: TMenuItem
       Caption = 'Compile'

Src/FmMain.pas

@@ -3,7 +3,7 @@
  * v. 2.0. If a copy of the MPL was not distributed with this file, You can
  * obtain one at https://mozilla.org/MPL/2.0/
  *
- * Copyright (C) 2005-2021, Peter Johnson (gravatar.com/delphidabbler).
+ * Copyright (C) 2005-2022, Peter Johnson (gravatar.com/delphidabbler).
  *
  * Application's main form. Handles the program's main window display and user
  * interaction.
@@ -56,6 +56,7 @@   TMainForm = class(THelpAwareForm)
     actAddFavourite: TAction;
     actAddSnippet: TAction;
     actBackupDatabase: TAction;
+    actBlog: TBrowseURL;
     actBugReport: TAction;
     actCloseAllDetailsTabs: TAction;
     actCloseDetailsTab: TAction;
@@ -69,6 +70,7 @@   TMainForm = class(THelpAwareForm)
     actCopySource: TAction;
     actDeleteCategory: TAction;
     actDeleteSnippet: TAction;
+    actDeleteUserDatabase: TAction;
     actDuplicateSnippet: TAction;
     actEditSnippet: TAction;
     actExit: TFileExit;
@@ -125,6 +127,7 @@   TMainForm = class(THelpAwareForm)
     miAddFavourite: TMenuItem;
     miAddSnippet: TMenuItem;
     miBackupDatabase: TMenuItem;
+    miBlog: TMenuItem;
     miCategories: TMenuItem;
     miCloseAllDetailsTabs: TMenuItem;
     miCloseDetailsTab: TMenuItem;
@@ -138,6 +141,7 @@   TMainForm = class(THelpAwareForm)
     miDatabase: TMenuItem;
     miDeleteCategory: TMenuItem;
     miDeleteSnippet: TMenuItem;
+    miDeleteUserDatabase: TMenuItem;
     miDuplicateSnippet: TMenuItem;
     miEdit: TMenuItem;
     miEditSnippet: TMenuItem;
@@ -195,6 +199,7 @@   TMainForm = class(THelpAwareForm)
     miSpacer17: TMenuItem;
     miSpacer18: TMenuItem;
     miSpacer20: TMenuItem;
+    miSpacer21: TMenuItem;
     miSWAGImport: TMenuItem;
     miTestCompile: TMenuItem;
     miTools: TMenuItem;
@@ -236,8 +241,6 @@   TMainForm = class(THelpAwareForm)
     tbSpacer7: TToolButton;
     tbSpacer8: TToolButton;
     tbTestCompile: TToolButton;
-    actBlog: TBrowseURL;
-    miBlog: TMenuItem;
     ///  <summary>Displays About Box.</summary>
     procedure actAboutExecute(Sender: TObject);
     ///  <summary>Gets a new category from user and adds to database.</summary>
@@ -294,6 +297,9 @@   TMainForm = class(THelpAwareForm)
     ///  <summary>Attempts to delete the current user defined snippet from the
     ///  database.</summary>
     procedure actDeleteSnippetExecute(Sender: TObject);
+    ///  <summary>Requests permission then attempts to delete the user defined
+    ///  snippets database.</summary>
+    procedure actDeleteUserDatabaseExecute(Sender: TObject);
     ///  <summary>Displays a dialogue box that can be used to duplicate the
     ///  selected snippet.</summary>
     procedure actDuplicateSnippetExecute(Sender: TObject);
@@ -713,6 +719,12 @@ procedure TMainForm.actDeleteSnippetExecute(Sender: TObject);
   // display update is handled by snippets change event handler
 end;
 
+procedure TMainForm.actDeleteUserDatabaseExecute(Sender: TObject);
+begin
+  if TUserDBMgr.DeleteDatabase then
+    ReloadDatabase;
+end;
+
 procedure TMainForm.actDuplicateSnippetExecute(Sender: TObject);
 begin
   TUserDBMgr.DuplicateSnippet(fMainDisplayMgr.CurrentView);

Src/HTML.hrc

@@ -2,7 +2,7 @@
 # v. 2.0. If a copy of the MPL was not distributed with this file, You can
 # obtain one at https://mozilla.org/MPL/2.0/
 #
-# Copyright (C) 2005-2021, Peter Johnson (gravatar.com/delphidabbler).
+# Copyright (C) 2005-2022, Peter Johnson (gravatar.com/delphidabbler).
 #
 # Manifest file used to generate HTML.res resource file.
 
@@ -38,9 +38,10 @@ Res\HTML\dlg-dbupdate-load.html
 Res\HTML\dlg-dbupdate-finish.html
 
 # what's new dialogue
-# -------------------
 Res\HTML\dlg-whatsnew.html
 
+# delete database dialogue
+Res\HTML\dlg-dbdelete.html
 
 
 # Detail pane pages, scripts and CSS

Src/Help/CodeSnip.hhp

@@ -25,6 +25,7 @@ HTML\dlg_addcategory.htm
 HTML\dlg_backup.htm
 HTML\dlg_configcompilers.htm
 HTML\dlg_deletecategory.htm
+HTML\dlg_deleteuserdb.htm
 HTML\dlg_dependencies.htm
 HTML\dlg_dependencies_edit.htm
 HTML\dlg_duplicatesnippet.htm
@@ -96,6 +97,7 @@ HTML\task_addsnippets.htm
 HTML\task_backup.htm
 HTML\task_copysnippet.htm
 HTML\task_customise.htm
+HTML\task_deleteuserdb.htm
 HTML\task_export.htm
 HTML\task_generateunit.htm
 HTML\task_printroutine.htm