Added feature to restore preferences to their default values. pgadmin…

…-org#1900
akshay-joshi · Aug 30, 2024 · f88ca89 · f88ca89
1 parent 445e895
commit f88ca89
Show file tree

Hide file tree

Showing 35 changed files with 118 additions and 9 deletions.
diff --git a/docs/en_US/images/preferences_browser_breadcrumbs.png b/docs/en_US/images/preferences_browser_breadcrumbs.png
diff --git a/docs/en_US/images/preferences_browser_display.png b/docs/en_US/images/preferences_browser_display.png
diff --git a/docs/en_US/images/preferences_browser_keyboard_shortcuts.png b/docs/en_US/images/preferences_browser_keyboard_shortcuts.png
diff --git a/docs/en_US/images/preferences_browser_nodes.png b/docs/en_US/images/preferences_browser_nodes.png
diff --git a/docs/en_US/images/preferences_browser_processes.png b/docs/en_US/images/preferences_browser_processes.png
diff --git a/docs/en_US/images/preferences_browser_properties.png b/docs/en_US/images/preferences_browser_properties.png
diff --git a/docs/en_US/images/preferences_browser_tab_settings.png b/docs/en_US/images/preferences_browser_tab_settings.png
diff --git a/docs/en_US/images/preferences_dashboard_display.png b/docs/en_US/images/preferences_dashboard_display.png
diff --git a/docs/en_US/images/preferences_dashboard_graphs.png b/docs/en_US/images/preferences_dashboard_graphs.png
diff --git a/docs/en_US/images/preferences_dashboard_refresh.png b/docs/en_US/images/preferences_dashboard_refresh.png
diff --git a/docs/en_US/images/preferences_debugger_keyboard_shortcuts.png b/docs/en_US/images/preferences_debugger_keyboard_shortcuts.png
diff --git a/docs/en_US/images/preferences_erd_keyboard_shortcuts.png b/docs/en_US/images/preferences_erd_keyboard_shortcuts.png
diff --git a/docs/en_US/images/preferences_erd_options.png b/docs/en_US/images/preferences_erd_options.png
diff --git a/docs/en_US/images/preferences_graph_visualiser.png b/docs/en_US/images/preferences_graph_visualiser.png
diff --git a/docs/en_US/images/preferences_misc_themes.png b/docs/en_US/images/preferences_misc_themes.png
diff --git a/docs/en_US/images/preferences_misc_user_language.png b/docs/en_US/images/preferences_misc_user_language.png
diff --git a/docs/en_US/images/preferences_paths_binary.png b/docs/en_US/images/preferences_paths_binary.png
diff --git a/docs/en_US/images/preferences_paths_help.png b/docs/en_US/images/preferences_paths_help.png
diff --git a/docs/en_US/images/preferences_schema_diff.png b/docs/en_US/images/preferences_schema_diff.png
diff --git a/docs/en_US/images/preferences_sql_auto_completion.png b/docs/en_US/images/preferences_sql_auto_completion.png
diff --git a/docs/en_US/images/preferences_sql_csv_output.png b/docs/en_US/images/preferences_sql_csv_output.png
diff --git a/docs/en_US/images/preferences_sql_display.png b/docs/en_US/images/preferences_sql_display.png
diff --git a/docs/en_US/images/preferences_sql_editor.png b/docs/en_US/images/preferences_sql_editor.png
diff --git a/docs/en_US/images/preferences_sql_explain.png b/docs/en_US/images/preferences_sql_explain.png
diff --git a/docs/en_US/images/preferences_sql_formatting.png b/docs/en_US/images/preferences_sql_formatting.png
diff --git a/docs/en_US/images/preferences_sql_keyboard_shortcuts.png b/docs/en_US/images/preferences_sql_keyboard_shortcuts.png
diff --git a/docs/en_US/images/preferences_sql_options.png b/docs/en_US/images/preferences_sql_options.png
diff --git a/docs/en_US/images/preferences_sql_results_grid.png b/docs/en_US/images/preferences_sql_results_grid.png
diff --git a/docs/en_US/images/preferences_storage_options.png b/docs/en_US/images/preferences_storage_options.png
diff --git a/docs/en_US/preferences.rst b/docs/en_US/preferences.rst
@@ -11,9 +11,7 @@ The left pane of the *Preferences* dialog displays a tree control; each node of
 the tree control provides access to options that are related to the node under
 which they are displayed.
 
-* Use the plus sign (+) to the left of a node name to expand a segment of the
-  tree control.
-* Use the minus sign (-) to the left of a node name to close that node.
+* Click the *Reset all preferences* button to restore all preferences to their default values.
 
 The Browser Node
 ****************

diff --git a/web/pgadmin/preferences/__init__.py b/web/pgadmin/preferences/__init__.py
@@ -320,3 +320,17 @@ def update():
         data={'data': 'Success'},
         status=200
     )
+
+
+@blueprint.route("/", methods=['DELETE'], endpoint="reset_prefs")
+@pga_login_required
+def reset():
+    """
+    Reset preferences to default
+    """
+    res, msg = Preferences.reset()
+
+    if not res:
+        return internal_server_error(errormsg=msg)
+
+    return success_return()
diff --git a/web/pgadmin/preferences/static/js/components/PreferencesComponent.jsx b/web/pgadmin/preferences/static/js/components/PreferencesComponent.jsx
@@ -20,6 +20,7 @@ import getApiInstance from '../../../../static/js/api_instance';
 import CloseSharpIcon from '@mui/icons-material/CloseSharp';
 import HelpIcon from '@mui/icons-material/HelpRounded';
 import SaveSharpIcon from '@mui/icons-material/SaveSharp';
+import SettingsBackupRestoreIcon from'@mui/icons-material/SettingsBackupRestore';
 import pgAdmin from 'sources/pgadmin';
 import { DefaultButton, PgIconButton, PrimaryButton } from '../../../../static/js/components/Buttons';
 import BaseUISchema from 'sources/SchemaView/base_schema.ui';
@@ -589,6 +590,64 @@ export default function PreferencesComponent({ ...props }) {
     window.open(url_for('help.static', { 'filename': 'preferences.html' }), 'pgadmin_help');
   };
 
+  const reset = () => {
+    pgAdmin.Browser.notifier.confirm(
+      gettext('Reset all preferences'),
+      `${gettext('All preferences will be reset to their default values.')}<br><br>${gettext('Do you want to proceed?')}<br><br>
+       ${gettext('Note:')}<br> <ul style="padding-left:20px"><li style="list-style-type:disc">${gettext('The object explorer tree will be refreshed automatically to reflect the changes.')}</li>
+       <li style="list-style-type:disc">${gettext('If the application language changes, a reload of the application will be required. You can choose to reload later at your convenience.')}</li></ul>`,
+      function () {},
+      function () {},
+      '',
+      'Cancel',
+      function (closeModal) {
+        return [
+          {
+            type: 'default',
+            icon: <SaveSharpIcon />,
+            label: gettext('Save & Reload'),
+            onclick: () => {
+              resetPrefsToDefault(true);
+              closeModal();
+            }
+          }, {
+            type: 'primary',
+            icon: <SaveSharpIcon />,
+            label: gettext('Save & Reload Later'),
+            onclick: () => {
+              resetPrefsToDefault(false);
+              closeModal();
+            }            
+          }
+        ];
+      }
+    );
+  };
+
+  const resetPrefsToDefault = (refresh = false) => {
+    api({
+      url: url_for('preferences.index'),
+      method: 'DELETE'
+    }).then(()=>{
+      if (refresh){
+        location.reload();
+        return true;
+      }
+      preferencesStore.cache();
+      pgAdmin.Browser.tree.destroy().then(
+        () => {
+          pgAdmin.Browser.Events.trigger(
+            'pgadmin-browser:tree:destroyed', undefined, undefined
+          );
+          return true;
+        }
+      );
+      props.closeModal();
+    }).catch((err) => {
+      pgAdmin.Browser.notifier.alert(err.response.data);
+    });
+  };
+
   return (
     <StyledBox height={'100%'}>
       <Box className='PreferencesComponent-root'>
@@ -615,6 +674,9 @@ export default function PreferencesComponent({ ...props }) {
             <PgIconButton data-test="dialog-help" onClick={onDialogHelp} icon={<HelpIcon />} title={gettext('Help for this dialog.')} />
           </Box>
           <Box className='PreferencesComponent-actionBtn' marginLeft="auto">
+            <DefaultButton className='PreferencesComponent-buttonMargin' onClick={reset} startIcon={<SettingsBackupRestoreIcon />}>
+              {gettext('Reset all preferences')}
+            </DefaultButton>
             <DefaultButton className='PreferencesComponent-buttonMargin' onClick={() => { props.closeModal();}} startIcon={<CloseSharpIcon onClick={() => { props.closeModal();}} />}>
               {gettext('Cancel')}
             </DefaultButton>

diff --git a/web/pgadmin/static/js/helpers/ModalProvider.jsx b/web/pgadmin/static/js/helpers/ModalProvider.jsx
@@ -41,15 +41,31 @@ export function useModal() {
   return React.useContext(ModalContext);
 }
 
-function AlertContent({ text, confirm, okLabel = gettext('OK'), cancelLabel = gettext('Cancel'), onOkClick, onCancelClick }) {
+function renderExtraButtons(button) {
+  switch(button.type) {
+  case 'primary':
+    return <PrimaryButton className='Alert-margin' startIcon={button.icon} onClick={button.onclick}>{button.label}</PrimaryButton>;
+  case 'default':
+    return <DefaultButton className='Alert-margin' startIcon={button.icon} onClick={button.onclick}>{button.label}</DefaultButton>;
+  default:
+    return <DefaultButton className='Alert-margin' startIcon={button.icon} onClick={button.onclick}>{button.label}</DefaultButton>;
+  };
+}
+
+function AlertContent({ text, confirm, okLabel = gettext('OK'), cancelLabel = gettext('Cancel'), onOkClick, onCancelClick, extraButtons }) {
   return (
     <StyledBox display="flex" flexDirection="column" height="100%">
       <Box flexGrow="1" p={2}>{typeof (text) == 'string' ? HTMLReactParser(text) : text}</Box>
       <Box className='Alert-footer'>
         {confirm &&
           <DefaultButton startIcon={<CloseIcon />} onClick={onCancelClick} >{cancelLabel}</DefaultButton>
         }
-        <PrimaryButton className='Alert-margin' startIcon={<CheckRoundedIcon />} onClick={onOkClick} autoFocus={true} >{okLabel}</PrimaryButton>
+        {
+          extraButtons?.length ?
+            extraButtons.map(button=>renderExtraButtons(button))
+            :
+            <PrimaryButton className='Alert-margin' startIcon={<CheckRoundedIcon />} onClick={onOkClick} autoFocus={true} >{okLabel}</PrimaryButton>
+        }
       </Box>
     </StyledBox>
   );
@@ -61,6 +77,7 @@ AlertContent.propTypes = {
   onCancelClick: PropTypes.func,
   okLabel: PropTypes.string,
   cancelLabel: PropTypes.string,
+  extraButtons: PropTypes.array
 };
 
 function alert(title, text, onOkClick, okLabel = gettext('OK')) {
@@ -76,7 +93,7 @@ function alert(title, text, onOkClick, okLabel = gettext('OK')) {
   });
 }
 
-function confirm(title, text, onOkClick, onCancelClick, okLabel = gettext('Yes'), cancelLabel = gettext('No')) {
+function confirm(title, text, onOkClick, onCancelClick, okLabel = gettext('Yes'), cancelLabel = gettext('No'), extras = null) {
   // bind the modal provider before calling
   this.showModal(title, (closeModal) => {
     const onCancelClickClose = () => {
@@ -87,8 +104,9 @@ function confirm(title, text, onOkClick, onCancelClick, okLabel = gettext('Yes')
       onOkClick?.();
       closeModal();
     };
+    const extraButtons =  extras?.(closeModal);
     return (
-      <AlertContent text={text} confirm onOkClick={onOkClickClose} onCancelClick={onCancelClickClose} okLabel={okLabel} cancelLabel={cancelLabel} />
+      <AlertContent text={text} confirm onOkClick={onOkClickClose} onCancelClick={onCancelClickClose} okLabel={okLabel} cancelLabel={cancelLabel} extraButtons={extraButtons} />
     );
   });
 }

diff --git a/web/pgadmin/static/js/helpers/Notifier.jsx b/web/pgadmin/static/js/helpers/Notifier.jsx
@@ -175,10 +175,10 @@ class Notifier {
     this.modal.alert(title, text, onOkClick, okLabel);
   }
 
-  confirm(title, text, onOkClick, onCancelClick, okLabel=gettext('Yes'), cancelLabel=gettext('No')) {
+  confirm(title, text, onOkClick, onCancelClick, okLabel=gettext('Yes'), cancelLabel=gettext('No'), extras=null) {
     /* Use this if you want to use pgAdmin global notifier.
     Or else, if you want to use modal inside iframe only then use ModalProvider eg- query tool */
-    this.modal.confirm(title, text, onOkClick, onCancelClick, okLabel, cancelLabel);
+    this.modal.confirm(title, text, onOkClick, onCancelClick, okLabel, cancelLabel, extras);
   }
 
   showModal(title, content, modalOptions) {

diff --git a/web/pgadmin/utils/preferences.py b/web/pgadmin/utils/preferences.py
@@ -694,3 +694,20 @@ def migrate_user_preferences(self, pid, converter_func):
             pref.value = converter_func(pref.value)
 
         db.session.commit()
+
+    @classmethod
+    def reset(cls):
+        """
+        reset
+        Reset the preferences for the current user in the configuration table.
+        """
+        try:
+            db.session.query(UserPrefTable).filter(
+                UserPrefTable.uid == current_user.id).delete()
+            db.session.commit()
+        except Exception as e:
+            db.session.rollback()
+            current_app.logger.exception(e)
+            return False, str(e)
+
+        return True, None