Merge pull request #76 from oracle/release-2.4.15

Release 2.4.15

Author: moreaut

README.md

@@ -33,5 +33,5 @@ See the following list of [Known Issues](https://oracle.github.io/weblogic-remot
 
 ## Need more help? Have a suggestion? Come and say, "Hello!"
 
-We have a **Slack channel** where you can get in touch with us to ask questions about using WebLogic Remote Console or give us feedback or suggestions about what features and improvements you'd like to see.  We would love to hear from you. To join our channel, [click here to get an invitation](https://join.slack.com/t/oracle-weblogic/shared_invite/zt-1lnz4kpci-WdY2gWfeJc5jS_a_1Z06MA).
-The invitation email includes details on how to access our Slack workspace. After you are logged in, join us over at `#remote-console` and say, "Hello!"
+We have a **Slack channel** where you can get in touch with us to ask questions about using WebLogic Remote Console or give us feedback or suggestions about what features and improvements you'd like to see.  We would love to hear from you. To join our channel, [click here to get an invitation](https://join.slack.com/t/oracle-weblogic/shared_invite/zt-1ni1gtjv6-PGC6CQ4uIte3KBdm_67~aQ).
+The invitation email includes details on how to access our Slack workspace. After you are logged in, join us over at `#remote-console` and say, "Hello!"

assembly/pom.xml

@@ -9,7 +9,7 @@
   <parent>
     <artifactId>console-backend</artifactId>
     <groupId>com.oracle.weblogic</groupId>
-    <version>2.4.14</version>
+    <version>2.4.15</version>
   </parent>
 
   <packaging>pom</packaging>

build-tools/pom.xml

@@ -6,13 +6,13 @@
 
   <groupId>com.oracle.weblogic.console-backend</groupId>
   <artifactId>build-tools</artifactId>
-  <version>2.4.14</version>
+  <version>2.4.15</version>
   <name>Build Tools</name>
 
   <parent>
       <groupId>com.oracle.weblogic</groupId>
       <artifactId>console-backend</artifactId>
-      <version>2.4.14</version>
+      <version>2.4.15</version>
   </parent>
 
   <properties>

electron/app/js/settings-editor.js

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright (c) 2023,2024, Oracle and/or its affiliates.
+ * Copyright (c) 2023,2025, Oracle and/or its affiliates.
  * Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
  * @ignore
  */
@@ -21,6 +21,7 @@ const SettingsEditor = (() => {
   const { app, ipcMain, dialog } = require('electron');
   let preferences;
   let beforeEditingPreferences;
+  let configSender;
   const scratchPath = `${app.getPath('userData')}/scratch-settings.json`;
 
   const dontNeedStoreFile = (preferences) => {
@@ -65,8 +66,8 @@ const SettingsEditor = (() => {
       else if (key === 'javax.net.ssl.trustStore') {
         preferences.value('networking.trustStore', data[key]);
       }
-      else if (key === 'javax.net.ssl.trustStorePassword') {
-        preferences.value('networking.trustStorePassword', data[key]);
+      else if (key === 'javax.net.ssl.trustStorePasswordEncrypted') {
+        preferences.value('networking.trustStorePasswordEncrypted', data[key]);
       }
       else if (key === 'console.connectTimeoutMillis') {
         preferences.value('networking.connectTimeoutMillis', data[key]);
@@ -93,14 +94,24 @@ const SettingsEditor = (() => {
     }
   }
 
+  function decryptData(data) {
+    for (const key in data) {
+      if (key.endsWith('Encrypted')) {
+        const value = data[key];
+        delete data[key];
+        data[key.replace('Encrypted', '')] = preferences.decrypt(value);
+      }
+    }
+  }
+
   function save() {
     const path = ConfigJSON.getPath();
     let data = {};
     addValue(data, 'proxy', preferences.value('networking.proxy'));
     addValue(data, 'javax.net.ssl.trustStoreType', preferences.value('networking.trustStoreType'));
     if (trustStoreTypeRequiresStore()) {
       addValue(data, 'javax.net.ssl.trustStore', preferences.value('networking.trustStore'));
-      addValue(data, 'javax.net.ssl.trustStorePassword', preferences.value('networking.trustStorePassword'));
+      addValue(data, 'javax.net.ssl.trustStorePasswordEncrypted', preferences.value('networking.trustStorePasswordEncrypted'));
     }
     addValue(data, 'console.connectTimeoutMillis', preferences.value('networking.connectTimeoutMillis'));
     addValue(data, 'console.readTimeoutMillis', preferences.value('networking.readTimeoutMillis'));
@@ -113,6 +124,9 @@ const SettingsEditor = (() => {
       data[pair.substring(0, pair.indexOf('='))]= pair.substring(pair.indexOf('=') + 1);
     }
     fs.writeFileSync(path, JSON.stringify(data, null, 4));
+    decryptData(data);
+    if (configSender)
+      configSender(data);
   }
 
   function valid(showMessage) {
@@ -163,6 +177,23 @@ const SettingsEditor = (() => {
       ipcMain.removeAllListeners('encrypt');
       ipcMain.removeAllListeners('decrypt');
     },
+    setConfigSender: (configSenderParam) => {
+      // This is just a dummy for startup.  It will be destroyed when we
+      // create one for real in show()
+      preferences = new ElectronPreferences({ dataStore: `${scratchPath}`});
+      configSender = configSenderParam;
+      const path = ConfigJSON.getPath();
+      if (fs.existsSync(path)) {
+        try {
+          const data = JSON.parse(fs.readFileSync(path).toString());
+          decryptData(data);
+          configSender(data);
+        }
+        catch (err) {
+          console.error(err);
+        }
+      }
+    },
     show: (parentWindow) => {
       SettingsEditor.destroy(preferences);
       const preferencesTemplate = {
@@ -217,9 +248,9 @@ const SettingsEditor = (() => {
                       hideFunction: dontNeedStoreFile
                     },
                     {
-                      label: `${I18NUtils.get('wrc-electron.menus.settings.trust-store.key.label')}`,
-                      key: 'trustStorePassword',
-                      type: 'text',
+                      label: `${I18NUtils.get('wrc-electron.menus.settings.trust-store.password.label')}`,
+                      key: 'trustStorePasswordEncrypted',
+                      type: 'secret',
                       hideFunction: dontNeedStoreFile
                     },
                     {

electron/app/js/user-prefs-json.js

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright (c) 2022, 2024, Oracle and/or its affiliates.
+ * Copyright (c) 2022, 2025, Oracle and/or its affiliates.
  * Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
  * @ignore
  */
@@ -57,7 +57,8 @@ const UserPrefs = (() => {
       const preferencesTemplate = {
         defaults: {
           credentials: { storage: true },
-          unsaved: { appExit: true, unload: true }
+          unsaved: { appExit: true, unload: true },
+          startup: { checkForUpdates: true }
         },
         dataStore: `${app.getPath('userData')}/user-prefs.json`,
         browserWindowOverrides: {
@@ -153,10 +154,61 @@ const UserPrefs = (() => {
                 }
               ]
             }
+          },
+          {
+            id: 'language',
+            label: `${I18NUtils.get('wrc-electron.menus.preferences.section.language.label')}`,
+            form: {
+              groups: [
+                {
+                  fields: [
+                    {
+                      label: `${I18NUtils.get('wrc-electron.menus.preferences.language.field.label')}`,
+                      help: `${I18NUtils.get('wrc-electron.menus.preferences.language.field.help')}`,
+                      key: 'language',
+                      type: 'radio',
+                      options: [
+                        {label: `${I18NUtils.get('wrc-electron.menus.preferences.language.system.label')}`, value: 'System'},
+                        {label: `${I18NUtils.get('wrc-electron.menus.preferences.language.en.label')}`, value: 'en'},
+                        {label: `${I18NUtils.get('wrc-electron.menus.preferences.language.de.label')}`, value: 'de'},
+                        {label: `${I18NUtils.get('wrc-electron.menus.preferences.language.es.label')}`, value: 'es'},
+                        {label: `${I18NUtils.get('wrc-electron.menus.preferences.language.fr.label')}`, value: 'fr'},
+                        {label: `${I18NUtils.get('wrc-electron.menus.preferences.language.it.label')}`, value: 'it'},
+                        {label: `${I18NUtils.get('wrc-electron.menus.preferences.language.ja.label')}`, value: 'ja'},
+                        {label: `${I18NUtils.get('wrc-electron.menus.preferences.language.ko.label')}`, value: 'ko'},
+                        {label: `${I18NUtils.get('wrc-electron.menus.preferences.language.pt.label')}`, value: 'pt-BR'},
+                        {label: `${I18NUtils.get('wrc-electron.menus.preferences.language.zh-CN.label')}`, value: 'zh-CN'},
+                        {label: `${I18NUtils.get('wrc-electron.menus.preferences.language.zh-TW.label')}`, value: 'zh-TW'}
+                      ]
+                    }
+                  ]
+                }
+              ]
+            }
+          },
+          {
+            id: 'startup',
+            label: `${I18NUtils.get('wrc-electron.menus.preferences.section.startup.label')}`,
+            form: {
+              groups: [
+                {
+                  fields: [
+                    {
+                      label: `${I18NUtils.get('wrc-electron.menus.preferences.check-for-update.field.label')}`,
+                      key: 'checkForUpdates',
+                      type: 'radio',
+                      options: [
+                        {label: `${I18NUtils.get('wrc-electron.menus.preferences.yes')}`, value: true},
+                        {label: `${I18NUtils.get('wrc-electron.menus.preferences.no')}`, value: false}
+                      ]
+                    }
+                  ]
+                }
+              ]
+            }
           }
         ]
       };
-  
       preferences = new ElectronPreferences(preferencesTemplate);
     },
     read: (userDataPath) => {

electron/app/js/window-management.js

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright (c) 2022, 2024, Oracle and/or its affiliates.
+ * Copyright (c) 2022, 2025, Oracle and/or its affiliates.
  * Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
  * @ignore
  */
@@ -62,13 +62,12 @@ const WindowManagement = (() => {
       }
     });
   }
-  
+
   /**
    *
    * @private
    */
   function generateAppMenu() {
-    
     let appMenuTemplate = [
       {
         // Provide an id field, so we can use Array.find() to
@@ -772,7 +771,7 @@ const WindowManagement = (() => {
       if (params.feedURL)
         downloadURL = params.feedURL;
 
-      if (_params.supportsUpgradeCheck) {
+      if (_params.supportsUpgradeCheck && _params.upgradeCheckAtStart) {
         AutoUpdateUtils.checkForUpdates()
           .then(result => {
             newVersion = (result !== null ? result.versionInfo.version : null);
@@ -785,7 +784,7 @@ const WindowManagement = (() => {
 
       _window = createBrowserWindow(title, AutoPrefs.get('width'), AutoPrefs.get('height'));
       _window.webContents.session.clearCache();
-      
+
       _window.on('resize', () => {
         AutoPrefs.set({width: _window.getSize()[0], height: _window.getSize()[1]});
         AutoPrefs.write();

electron/app/main.js

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright (c) 2021, 2024, Oracle and/or its affiliates.
+ * Copyright (c) 2021, 2025, Oracle and/or its affiliates.
  * Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
  * @ignore
  */
@@ -32,8 +32,9 @@ const UserPrefs = require('./js/user-prefs-json');
 // persisted in the auto-prefs.json file
 const AutoPrefs = require('./js/auto-prefs-json');
 // Declare variable for IIFE class used to manage data
-// persisted in the config.json file
+// persisted in the config.json file as well as its editor
 const AppConfig = require('./js/config-json');
+const SettingsEditor = require('./js/settings-editor');
 // Declare variable for IIFE class used to manage projects
 const ProjectManagement = require('./js/project-management');
 // Declare variable for IIFE class used to read and write projects
@@ -86,6 +87,7 @@ let showPort = false;
 let useTokenNotCookie = false;
 let quiet = false;
 let lines = [];
+let cbe;
 
 (() => {
   function updateUserDataPath() {
@@ -128,6 +130,30 @@ let lines = [];
   };
   AppConfig.initialize(options);
 
+  // This seems complicated, but really isn't.
+  // There are three ways that the language may be set (in precedence order):
+  // 1. The command line option --lang=<lang>
+  // 2. The value of "language.language" in user-prefs.json
+  // 3. On Linux, the environment variable LANGUAGE
+  // To implement this, it would be simple enough to set the --lang option if #2
+  // or #3 applies. However, there is a bug in electron where --lang doesn't
+  // work on Linux.  The solution is to make sure LANGUAGE is set on Linux to
+  // the right value, as well as setting the command-line option in every
+  // platform.
+  const file = userDataPath + "/user-prefs.json";
+  if (!app.commandLine.hasSwitch('lang') && fs.existsSync(file)) {
+    const userPrefsEarly = require(file);
+    if ((userPrefsEarly?.language?.language !== undefined) &&
+        userPrefsEarly.language.language !== 'System' &&
+        userPrefsEarly.language.language !== ''
+      ) {
+        app.commandLine.appendSwitch('lang', userPrefsEarly.language.language);
+    }
+  }
+  if (app.commandLine.hasSwitch('lang')) {
+    process.env['LANGUAGE'] = app.commandLine.getSwitchValue('lang');
+  }
+
   ProjectManagement.readProjects(userDataPath);
   ProjectManagement.selectCurrentProject();
 })();
@@ -212,6 +238,22 @@ function processCmdLineOptions() {
   quiet = app.commandLine.hasSwitch('quiet');
 }
 
+function sendConfig(data) {
+  if (!cbe)
+    return;
+  let buffer = 'START\n';
+  for (const key in data) {
+    buffer += key + '=' + data[key] + '\n';
+  }
+  buffer += 'END\n';
+  try {
+    cbe.stdin.write(buffer);
+  } catch (err) {
+    // If the writes fail, we're about to die anyway
+    return;
+  }
+}
+
 function start_cbe() {
   var instDir = path.dirname(app.getPath('exe'));
   let filename = AppConfig.getPath();
@@ -232,14 +274,12 @@ function start_cbe() {
     '--persistenceDirectory',
     `${app.getPath('userData')}`,
     '--showPort',
-    '--stdin',
-    '--properties',
-    filename,
+    '--stdin'
   ];
   if (useTokenNotCookie) {
     spawnArgs.push('--useTokenNotCookie');
   }
-  const cbe = spawn(AppConfig.get('javaPath'), spawnArgs);
+  cbe = spawn(AppConfig.get('javaPath'), spawnArgs);
 
   let readlineStderr = readline.createInterface({
     input: cbe.stderr,
@@ -280,6 +320,7 @@ function start_cbe() {
     }
     logger.log('debug', line);
   });
+  SettingsEditor.setConfigSender(sendConfig);
 }
 
 // This is only used on Mac
@@ -328,13 +369,21 @@ app.whenReady()
       if (supportsUpgradeCheck && OSUtils.isLinuxOS && !process.env.APPIMAGE)
         process.env.APPIMAGE = `/${Math.random()}/${Math.random()}`;
 
+      const file = app.getPath('userData') + "/user-prefs.json";
+      const userPrefsEarly = fs.existsSync(file) ? require(file) : null;
+      const upgradeCheckAtStart =
+        (userPrefsEarly?.startup?.checkForUpdates === undefined)
+        ? true
+        : userPrefsEarly.startup.checkForUpdates;
+
       const params = {
         version: version,
         productName: productName,
         copyright: copyright,
         homepage: homepage,
         feedURL: feedURL,
         supportsUpgradeCheck: supportsUpgradeCheck,
+        upgradeCheckAtStart: upgradeCheckAtStart,
         supportsAutoUpgrades: supportsAutoUpgrades
       };