Support configuration of Installation Directory Application

Author: rakillen

electron/app/js/ipcRendererPreload.js

@@ -229,10 +229,12 @@ contextBridge.exposeInMainWorld(
     path: {
       basename: (filePath, ext) => path.basename(filePath, ext),
       dirname: (filePath) => path.dirname(filePath),
+      exists: (filePath) => path.exists(filePath),
       extname: (filePath) => path.extname(filePath),
       isAbsolute: (filePath) => path.isAbsolute(filePath),
       join: (...paths) => path.join(...paths),
       joinAndConvertToUnixPath: (...paths) => path.join(...paths).replaceAll('\\', '/'),
+      relative: (filePath1, filePath2) => path.relative(filePath1, filePath2),
       delimiter: path.delimiter,
       isValidFileName: (fileName) => fsUtils.isValidFileName(fileName),
     },
@@ -263,9 +265,10 @@ contextBridge.exposeInMainWorld(
       }
     },
     'modelEdit': {
-      getReadableLabel: aliasName => {
-        return modelEditUtils.getReadableLabel(aliasName);
-      }
+      exists: path => fsUtils.exists(path),
+      getReadableLabel: aliasName => modelEditUtils.getReadableLabel(aliasName),
+      isDirectory: path => fsUtils.isDirectory(path),
+      isFile: path => fsUtils.isFile(path)
     },
     'utils': {
       generateUuid: () => uuid.v4(),

electron/app/locales/en/modeledit.json

@@ -120,10 +120,27 @@
   "file-select-type-emptyDir": "Empty Directory",
   "file-select-archive-title": "{{attribute}} Location",
   "file-select-archive-label": "Location Type",
-  "file-select-use-file-location": "Use \"{{fileName}}\" on the local file system",
-  "file-select-add-to-archive": "Add \"{{fileName}}\" to archive file",
+  "file-select-add-dir-to-archive": "Add this directory to the archive file",
+  "file-select-add-file-to-archive": "Add this file to the archive file",
+  "file-select-use-dir-location": "Use this directory path on the target file system",
+  "file-select-use-file-location": "Use this file path on the target file system",
   "file-select-archive-empty-dir": "Use a new empty directory in the archive file",
-  "file-select-local-empty-dir": "Use an empty directory on the file system",
+  "file-select-local-empty-dir": "Use a directory on the target file system",
+
+  "add-app-use-app-install-dir-label": "Use Application Installation Directory",
+  "add-app-use-app-install-dir-help": "The application installation directory separates generated configuration files from the core application files, so that configuration files can be easily changed or replaced without disturbing the application itself. The directory structure also helps you to organize and maintain multiple versions of the same application deployment files.",
+
+  "add-install-dir-title": "Set Up Application Installation Directory",
+  "add-install-dir-use-archive-label": "Add Installation Directory to the Archive File",
+  "add-install-dir-use-archive-help": "Add the installation directory to the archive file, and set the associated paths in the model",
+  "add-install-dir-install-dir-label": "Application Installation Directory",
+  "add-install-dir-install-dir-help": "The path to the application's install-root directory",
+  "add-install-dir-not-directory-error": "Must be a local directory to add to archive",
+  "add-install-dir-not-file-error": "Must be a local file to add to archive",
+  "add-install-dir-not-exists-error": "Must exist on local file system to add to archive",
+  "add-install-dir-not-sub-path-error": "Must be a relative path or a subpath of application installation directory",
+  "add-install-dir-required-with-plan-dir-error": "Required if plan directory is specified",
+  "add-install-dir-not-relative-plan-path-error": "Must be a relative path if plan directory is specified",
 
   "options-default-label": "Default",
   "options-persist-label": "Persistent",
@@ -439,6 +456,8 @@
   "attribute-editor-missing-variable": "Missing variable \"{{variable}}\"",
   "attribute-editor-options": "Options",
   "attribute-editor-select": "Select",
+  "attribute-editor-select-directory": "Select Directory",
+  "attribute-editor-select-file": "Select File",
 
   "invalid-integer-error": "Value must be an integer",
   "invalid-double-error": "Value must be a decimal number, such as 4 or 3.5",

webui/src/css/app.css

@@ -58,6 +58,7 @@
 
 oj-navigation-list[id="modelDesignNav"].oj-navigationlist-vertical {
   --oj-navigation-list-item-min-height: 1.75rem;
+  margin: 8px 0 6px 0;
 }
 
 .oj-navigationlist-depth-1 .oj-navigationlist-item-content {
@@ -1064,6 +1065,17 @@ h6.wkt-under-breadcrumb {
   margin-top: 0.5em !important;  /* oj-c-collapsible has no space between header and content */
 }
 
+.wkt-file-select-path-label {
+  font-size: 0.75em;
+  color: var(--wkt-model-edit-label-text-color);
+  font-weight: 600;
+  margin-bottom: 4px;
+}
+
+.wkt-file-select-path {
+  overflow-wrap: break-word;
+}
+
 .wkt-token-error {
   color: red;
   font-weight: bold;

webui/src/js/utils/modelEdit/file-select-helper.js

@@ -5,65 +5,79 @@
  */
 'use strict';
 
-define(['utils/dialog-helper', 'utils/wkt-logger', 'utils/modelEdit/alias-helper', 'utils/wdt-archive-helper',
-  'utils/modelEdit/message-helper'],
-function (DialogHelper, WktLogger, AliasHelper, ArchiveHelper, MessageHelper) {
+define(['utils/dialog-helper', 'utils/wkt-logger', 'utils/modelEdit/model-edit-helper',
+  'utils/modelEdit/alias-helper', 'utils/wdt-archive-helper', 'utils/modelEdit/message-helper'],
+function (DialogHelper, WktLogger, ModelEditHelper, AliasHelper, ArchiveHelper, MessageHelper) {
 
   function FileSelectHelper() {
     // support selecting files for attributes
 
-    this.selectFile = async(attribute, currentValue) => {
+    // matching wdtArchive subtypes
+    const DIR_TYPES = ['dir', 'either', 'emptyDir'];
+    const FILE_TYPES = ['file', 'either'];
+
+    this.canChooseDirectory = attribute => {
+      return canChoose(DIR_TYPES, attribute);
+    };
+
+    this.canChooseFile = attribute => {
+      return canChoose(FILE_TYPES, attribute);
+    };
+
+    function canChoose(matchTypes, attribute) {
+      const archiveTypeKeys = attribute.archiveTypes || [];
+      for(const archiveTypeKey of archiveTypeKeys) {
+        const archiveType = ModelEditHelper.getArchiveType(archiveTypeKey) || {};
+        if(matchTypes.includes(archiveType.subtype)) {
+          return true;
+        }
+      }
+      const fileOptions = attribute.fileOptions || [];
+      for(const fileOption of fileOptions) {
+        if(matchTypes.includes(fileOption.type)) {
+          return true;
+        }
+      }
+      // if no archive or file options found, allow file or dir
+      return !archiveTypeKeys.length && !fileOptions.length;
+    }
+
+    this.chooseDirectory = async(attribute, currentValue) => {
+      return choosePath(attribute, 'dir', currentValue);
+    };
+
+    this.chooseFile = async(attribute, currentValue) => {
+      return choosePath(attribute, 'file', currentValue);
+    };
+
+    async function choosePath(attribute, matchType, currentValue) {
       const aliasPath = AliasHelper.getAliasPath(attribute.path);
       const attributeLabel = MessageHelper.getAttributeLabel(attribute, aliasPath);
 
-      const archiveTypes = await ArchiveHelper.getEntryTypes();
+      // build a list of select options based on archive and file options
       const selectOptions = [];
 
       // possibly multiple archive types (app, custom?)
       const archiveTypeKeys = attribute.archiveTypes || [];
       archiveTypeKeys.forEach(archiveTypeKey => {
-        if (!(archiveTypeKey in archiveTypes)) {
-          WktLogger.error('Invalid archive type: ' + archiveTypeKey);
+        const archiveType = ModelEditHelper.getArchiveType(archiveTypeKey);
+        if (!archiveType) {
           return;
         }
 
-        // file dir either emptyDir
-
-        const archiveType = archiveTypes[archiveTypeKey];
         const subtype = archiveType.subtype;
         const segregateName = getSegregateName(attribute);
+        const segregateLabel = archiveType.segregatedLabel;
+        const segregateHelp = archiveType.segregatedHelp;
 
-        if (['file', 'either'].includes(subtype)) {
-          selectOptions.push({
-            type: 'file',
-            label: archiveType.fileLabel,
-            extensions: archiveType.extensions,
-            archiveType: archiveTypeKey,
-            segregateLabel: archiveType.segregatedLabel,
-            segregateHelp: archiveType.segregatedHelp,
-            segregateName
-          });
-        }
-
-        if (['dir', 'either'].includes(subtype)) {
-          selectOptions.push({
-            type: 'dir',
-            label: archiveType.dirLabel,
-            archiveType: archiveTypeKey,
-            segregateLabel: archiveType.segregatedLabel,
-            segregateHelp: archiveType.segregatedHelp,
-            segregateName
-          });
-        }
-
-        if('emptyDir' === subtype) {
+        if('emptyDir' === subtype) {  // add two specific options
           // bypass file selection and add to archive
           selectOptions.push({
             type: 'emptyDir',
             labelKey: 'file-select-archive-empty-dir',
             archiveType: archiveTypeKey,
-            segregateLabel: archiveType.segregatedLabel,
-            segregateHelp: archiveType.segregatedHelp,
+            segregateLabel,
+            segregateHelp,
             segregateName
           });
 
@@ -73,6 +87,23 @@ function (DialogHelper, WktLogger, AliasHelper, ArchiveHelper, MessageHelper) {
             labelKey: 'file-select-local-empty-dir',
             chooserName: attributeLabel
           });
+
+        } else {  // add one option based on match type
+          const fileMatch = matchType === 'file' && FILE_TYPES.includes(subtype);
+          const dirMatch = matchType === 'dir' && DIR_TYPES.includes(subtype);
+          const label = dirMatch ? archiveType.dirLabel : archiveType.fileLabel;
+
+          if (dirMatch || fileMatch) {
+            selectOptions.push({
+              type: matchType,
+              label,
+              extensions: archiveType.extensions,
+              archiveType: archiveTypeKey,
+              segregateLabel,
+              segregateHelp,
+              segregateName
+            });
+          }
         }
       });
 
@@ -83,11 +114,10 @@ function (DialogHelper, WktLogger, AliasHelper, ArchiveHelper, MessageHelper) {
         selectOptions.push(fileOption);
       });
 
-      // if no options found, default is simple file or directory
+      // if archive or file options found, default is choose specified type
       if(!selectOptions.length) {
         selectOptions.push(
-          { type: 'file', chooserName: attributeLabel },
-          { type: 'dir', chooserName: attributeLabel }
+          { type: matchType, chooserName: attributeLabel }
         );
       }
 
@@ -96,17 +126,14 @@ function (DialogHelper, WktLogger, AliasHelper, ArchiveHelper, MessageHelper) {
         const selectType = selectOption.type;
         if(!['file', 'dir', 'emptyDir'].includes(selectType)) {
           WktLogger.error('Invalid selection type: ' + selectType);
-          return;  // cancel
         }
-
         const defaultLabel = MessageHelper.t('file-select-type-' + selectOption.type);
         selectOption.label = MessageHelper.getLabel(selectOption) || defaultLabel;
       });
 
       let selectOption;
 
-      // prompt for select option if more than one type is present in metadata
-      // const fileSelectOptions = attribute.fileSelectOptions || [];
+      // prompt for select option if more than one type is present.
       if(selectOptions.length === 1) {
         selectOption = selectOptions[0];
       } else {

webui/src/js/utils/modelEdit/meta-helper.js

@@ -88,6 +88,11 @@ define(['utils/modelEdit/metadata/all-metadata'],
         return metadata['noSelect'];
       };
 
+      this.getAddHandler = aliasPath => {
+        const metadata = this.getMetadata(aliasPath);
+        return metadata['addHandler'];
+      };
+
       this.getNameValidators = (/*aliasPath*/) => {
         return [];  // TODO: implement this when needed
       };

webui/src/js/utils/modelEdit/meta-methods.js

@@ -0,0 +1,62 @@
+/**
+ * @license
+ * Copyright (c) 2025, Oracle and/or its affiliates.
+ * Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
+ */
+'use strict';
+
+define(['knockout', 'utils/wkt-logger', 'utils/dialog-helper', 'utils/wdt-archive-helper',
+  'utils/modelEdit/model-edit-helper', 'utils/modelEdit/navigation-helper'
+],
+function (ko, WktLogger, DialogHelper, ArchiveHelper, ModelEditHelper, NavigationHelper) {
+  function MetaMethods() {
+
+    // ask about adding Application Installation Directory (structured) app
+    this.addApplication = async (modelPath, nameValidators) => {
+      const options = {
+        modelPath,
+        nameValidators
+      };
+
+      const newResult = await DialogHelper.promptDialog('modelEdit/new-app-dialog', options);
+      const newName = newResult.instanceName;
+      if (!newName) {  // cancel
+        return;
+      }
+
+      let folderContent = {};
+
+      if(newResult.useAppInstallDir) {
+        const appResult = await DialogHelper.promptDialog('modelEdit/app-install-dir-dialog', options);
+        if (!appResult) {  // cancel
+          return;
+        }
+
+        folderContent = appResult.folderContent;
+
+        if(appResult.addToArchive) {
+          const addOptions = {
+            fileName: appResult.installDir,
+            fileType: 'dir'
+          };
+          const archivePath = await ArchiveHelper.addToArchive('applicationInstallationDirectory', addOptions);
+
+          // absolute paths need correction to wlsdeploy/...
+          for(const [key, path] of Object.entries(folderContent)) {
+            if (path && window.api.path.isAbsolute(path)) {
+              const relativePath = window.api.path.relative(appResult.installDir, path);
+              folderContent[key] = window.api.path.join(archivePath, relativePath);
+            }
+          }
+        }
+      }
+
+      ModelEditHelper.addFolder(modelPath, newName, folderContent);
+
+      NavigationHelper.openNavigation(modelPath);  // open parent
+    };
+  }
+
+  // return a singleton instance
+  return new MetaMethods();
+});

webui/src/js/utils/modelEdit/metadata/Application.json

@@ -1,5 +1,6 @@
 {
   "Application": {
+    "addHandler": "addApplication",
     "summaryAttributes": {
       "SourcePath": {},
       "Target": {}

webui/src/js/utils/modelEdit/metadata/Server.json

@@ -1691,7 +1691,7 @@
         "addRemainingAttributes": true
       },
       {
-        "type": "folderTab",
+        "type": "folder",
         "folder": "ServerFailureTrigger"
       }
     ]

webui/src/js/utils/modelEdit/metadata/ServerTemplate.json

@@ -1688,7 +1688,7 @@
         "addRemainingAttributes": true
       },
       {
-        "type": "folderTab",
+        "type": "folder",
         "folder": "ServerFailureTrigger"
       }
     ]