Extract the tests and refactor some of the methods.

Extract some of the ACI Tree functionalities, and decouple it from the
main source. Also - create some abstractions from the repeated code
around the enable/disable the schema children object create/edit/delete
functionalities, and also created the dialog wrappers for backup and
restore dialogs.

Reviewed by: Khushboo and Ashesh
Refactored by: Ashesh

web/pgadmin/static/js/alertify/dialog.js

@@ -0,0 +1,150 @@
+/////////////////////////////////////////////////////////////
+//
+// pgAdmin 4 - PostgreSQL Tools
+//
+// Copyright (C) 2013 - 2018, The pgAdmin Development Team
+// This software is released under the PostgreSQL Licence
+//
+//////////////////////////////////////////////////////////////
+
+import gettext from '../gettext';
+import {sprintf} from 'sprintf-js';
+import {DialogFactory} from './dialog_factory';
+import Backform from '../backform.pgadmin';
+import {getTreeNodeHierarchyFromIdentifier} from '../tree/pgadmin_tree_node';
+
+/**
+ * This class can be extended to create new dialog boxes.
+ * Examples of this can be found in:
+ * `web/pgadmin/static/js/backup/backup_dialog.js`
+ *
+ * Do not forget to add the new Dialog type to the `DialogFactory`
+ */
+export class Dialog {
+  constructor(errorAlertTitle,
+              dialogContainerSelector,
+              pgBrowser, $, alertify, DialogModel,
+              backform = Backform) {
+    this.errorAlertTitle = errorAlertTitle;
+    this.alertify = alertify;
+    this.pgBrowser = pgBrowser;
+    this.jquery = $;
+    this.dialogModel = DialogModel;
+    this.backform = backform;
+    this.dialogContainerSelector = dialogContainerSelector;
+  }
+
+  retrieveAncestorOfTypeServer(item) {
+    let serverInformation = null;
+    let aciTreeItem = item || this.pgBrowser.treeMenu.selected();
+    let treeNode = this.pgBrowser.treeMenu.findNodeByDomElement(aciTreeItem);
+
+    if (treeNode) {
+      let nodeData;
+      let databaseNode = treeNode.ancestorNode(
+        (node) => {
+          nodeData = node.getData();
+          return (nodeData._type === 'database');
+        }
+      );
+      let isServerNode = (node) => {
+        nodeData = node.getData();
+        return nodeData._type === 'server';
+      };
+
+      if (databaseNode !== null) {
+        if (nodeData._label.indexOf('=') >= 0) {
+          this.alertify.alert(
+            gettext(this.errorAlertTitle),
+            gettext(
+              'Databases with = symbols in the name cannot be backed up or restored using this utility.'
+            )
+          );
+        } else {
+          if (databaseNode.hasParent(isServerNode))
+            serverInformation = nodeData;
+        }
+      } else {
+        if (treeNode.anyFamilyMember(isServerNode))
+          serverInformation = nodeData;
+      }
+    }
+
+    if (serverInformation === null) {
+      this.alertify.alert(
+        gettext(this.errorAlertTitle),
+        gettext('Please select server or child node from the browser tree.')
+      );
+    }
+
+    return serverInformation;
+  }
+
+  hasBinariesConfiguration(serverInformation) {
+    const module = 'paths';
+    let preference_name = 'pg_bin_dir';
+    let msg = gettext('Please configure the PostgreSQL Binary Path in the Preferences dialog.');
+
+    if ((serverInformation.type && serverInformation.type === 'ppas') ||
+      serverInformation.server_type === 'ppas') {
+      preference_name = 'ppas_bin_dir';
+      msg = gettext('Please configure the EDB Advanced Server Binary Path in the Preferences dialog.');
+    }
+    const preference = this.pgBrowser.get_preference(module, preference_name);
+
+    if (preference) {
+      if (!preference.value) {
+        this.alertify.alert(gettext('Configuration required'), msg);
+        return false;
+      }
+    } else {
+      this.alertify.alert(
+        gettext(this.errorAlertTitle),
+        sprintf(gettext('Failed to load preference %s of module %s'), preference_name, module)
+      );
+      return false;
+    }
+    return true;
+  }
+
+  dialogName() {
+    return undefined;
+  }
+
+  createOrGetDialog(dialogTitle, typeOfDialog) {
+    const dialogName = this.dialogName(typeOfDialog);
+
+    if (!this.alertify[dialogName]) {
+      const self = this;
+      this.alertify.dialog(dialogName, function factory() {
+        return self.dialogFactory(dialogTitle, typeOfDialog);
+      });
+    }
+    return this.alertify[dialogName];
+  }
+
+  dialogFactory(dialogTitle, typeOfDialog) {
+    const factory = new DialogFactory(
+      this.pgBrowser,
+      this.jquery,
+      this.alertify,
+      this.dialogModel,
+      this.backform,
+      this.dialogContainerSelector);
+    return factory.create(dialogTitle, typeOfDialog);
+  }
+
+  canExecuteOnCurrentDatabase(aciTreeItem) {
+    const treeInfo = getTreeNodeHierarchyFromIdentifier.apply(this.pgBrowser, [aciTreeItem]);
+
+    if (treeInfo.database && treeInfo.database._label.indexOf('=') >= 0) {
+      this.alertify.alert(
+        gettext(this.errorAlertTitle),
+        gettext('Databases with = symbols in the name cannot be backed up or restored using this utility.')
+      );
+      return false;
+    }
+
+    return true;
+  }
+}

web/pgadmin/static/js/alertify/dialog_factory.js

@@ -0,0 +1,52 @@
+/////////////////////////////////////////////////////////////
+//
+// pgAdmin 4 - PostgreSQL Tools
+//
+// Copyright (C) 2013 - 2018, The pgAdmin Development Team
+// This software is released under the PostgreSQL Licence
+//
+//////////////////////////////////////////////////////////////
+
+import * as BackupDialog from '../../../tools/backup/static/js/backup_dialog_wrapper';
+import {RestoreDialogWrapper} from '../../../tools/restore/static/js/restore_dialog_wrapper';
+
+export class DialogFactory {
+  constructor(pgBrowser, $,
+              alertify, DialogModel,
+              backform, dialogContainerSelector) {
+    this.pgBrowser = pgBrowser;
+    this.jquery = $;
+    this.alertify = alertify;
+    this.dialogModel = DialogModel;
+    this.backform = backform;
+    this.dialogContainerSelector = dialogContainerSelector;
+  }
+
+  create(dialogTitle, typeOfDialog) {
+    if (typeOfDialog === 'restore') {
+      return this.createRestoreDialog(dialogTitle, typeOfDialog);
+    } else {
+      return this.createBackupDialog(dialogTitle, typeOfDialog);
+    }
+  }
+
+  createRestoreDialog(dialogTitle, typeOfDialog) {
+    return new RestoreDialogWrapper(
+      this.dialogContainerSelector, dialogTitle, typeOfDialog,
+      this.jquery,
+      this.pgBrowser,
+      this.alertify,
+      this.dialogModel,
+      this.backform);
+  }
+
+  createBackupDialog(dialogTitle, typeOfDialog) {
+    return new BackupDialog.BackupDialogWrapper(
+      this.dialogContainerSelector, dialogTitle, typeOfDialog,
+      this.jquery,
+      this.pgBrowser,
+      this.alertify,
+      this.dialogModel,
+      this.backform);
+  }
+}

web/pgadmin/static/js/alertify/dialog_wrapper.js

@@ -0,0 +1,57 @@
+import * as commonUtils from '../utils';
+
+export class DialogWrapper {
+  constructor(
+    dialogContainerSelector, dialogTitle, jquery, pgBrowser,
+    alertify, dialogModel, backform) {
+    this.hooks = {
+      onclose: function () {
+        if (this.view) {
+          this.view.remove({
+            data: true,
+            internal: true,
+            silent: true,
+          });
+        }
+      },
+    };
+    this.dialogContainerSelector = dialogContainerSelector;
+    this.dialogTitle = dialogTitle;
+    this.jquery = jquery;
+    this.pgBrowser = pgBrowser;
+    this.alertify = alertify;
+    this.dialogModel = dialogModel;
+    this.backform = backform;
+  }
+
+  build() {
+    this.alertify.pgDialogBuild.apply(this);
+  }
+
+  wasHelpButtonPressed(e) {
+    return e.button.element.name === 'dialog_help'
+      || e.button.element.name === 'object_help';
+  }
+
+  getSelectedNodeData(selectedTreeNode) {
+    if (!this.isNodeSelected(selectedTreeNode)) {
+      return undefined;
+    }
+    const treeNodeData = selectedTreeNode.getData();
+    if (treeNodeData) {
+      return treeNodeData;
+    }
+    return undefined;
+  }
+
+  focusOnDialog(dialog) {
+    dialog.$el.attr('tabindex', -1);
+    this.pgBrowser.keyboardNavigation.getDialogTabNavigator(dialog);
+    const container = dialog.$el.find('.tab-content:first > .tab-pane.active:first');
+    commonUtils.findAndSetFocus(container);
+  }
+
+  isNodeSelected(selectedTreeNode) {
+    return selectedTreeNode;
+  }
+}