Added feature to reset the preferences to default values. #1900

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()

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,39 @@ export default function PreferencesComponent({ ...props }) {
     window.open(url_for('help.static', { 'filename': 'preferences.html' }), 'pgadmin_help');
   };
 
+  const reset = () => {
+    pgAdmin.Browser.notifier.confirm(
+      gettext('Reset preferences'),
+      gettext('All the preferences will be reset to default. Object explorer tree will be automatically refreshed to reflect the changes.')
+      + gettext('Please note, an app reload is required to change the language of the application. You may decide to reload later.') + '<br>' + '<br>'
+      + gettext('Do you want to proceed?'),
+      function () {},
+      function () {},
+      '',
+      'Cancel',
+      [
+        <DefaultButton key="save-reload" className='Alert-margin' onClick={()=>resetPrefsToDefault(true)} startIcon={<SaveSharpIcon />}>{gettext('Save & Reload')}</DefaultButton>,
+        <PrimaryButton key="save-reload-later" className='Alert-margin' onClick={()=>resetPrefsToDefault(false)} startIcon={<SaveSharpIcon />} autoFocus={true} >{gettext('Save & Reload Later')}</PrimaryButton>
+      ]
+    );
+  };
+
+  const resetPrefsToDefault = (refresh = false) => {
+    api({
+      url: url_for('preferences.index'),
+      method: 'DELETE'
+    }).then(()=>{
+      if (refresh){
+        location.reload();
+        return true;
+      }
+      preferencesStore.cache();
+      props.closeModal();
+    }).catch((err) => {
+      pgAdmin.Browser.notifier.alert(err.response.data);
+    });
+  };
+
   return (
     <StyledBox height={'100%'}>
       <Box className='PreferencesComponent-root'>
@@ -618,6 +652,9 @@ export default function PreferencesComponent({ ...props }) {
             <DefaultButton className='PreferencesComponent-buttonMargin' onClick={() => { props.closeModal();}} startIcon={<CloseSharpIcon onClick={() => { props.closeModal();}} />}>
               {gettext('Cancel')}
             </DefaultButton>
+            <DefaultButton className='PreferencesComponent-buttonMargin' onClick={reset} startIcon={<SettingsBackupRestoreIcon />}>
+              {gettext('Reset to default')}
+            </DefaultButton>
             <PrimaryButton className='PreferencesComponent-buttonMargin' startIcon={<SaveSharpIcon />} disabled={disableSave} onClick={() => { savePreferences(prefChangedData, initValues); }}>
               {gettext('Save')}
             </PrimaryButton>

web/pgadmin/static/js/helpers/ModalProvider.jsx

@@ -41,15 +41,19 @@ export function useModal() {
   return React.useContext(ModalContext);
 }
 
-function AlertContent({ text, confirm, okLabel = gettext('OK'), cancelLabel = gettext('Cancel'), onOkClick, onCancelClick }) {
+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 :
+            <PrimaryButton className='Alert-margin' startIcon={<CheckRoundedIcon />} onClick={onOkClick} autoFocus={true} >{okLabel}</PrimaryButton>
+        }
       </Box>
     </StyledBox>
   );
@@ -61,6 +65,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 +81,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'), extraButtons = []) {
   // bind the modal provider before calling
   this.showModal(title, (closeModal) => {
     const onCancelClickClose = () => {
@@ -87,8 +92,9 @@ function confirm(title, text, onOkClick, onCancelClick, okLabel = gettext('Yes')
       onOkClick?.();
       closeModal();
     };
+    extraButtons = extraButtons?.map(button=>React.cloneElement(button, { onClick:()=>{closeModal(); button.props.onClick();}}));
     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} closeModal={closeModal} extraButtons={extraButtons} />
     );
   });
 }

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'), extraButtons=[]) {
     /* 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, extraButtons);
   }
 
   showModal(title, content, modalOptions) {

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