Merge pull request #9 from frtello/issue/PPSS-41997

PPSS-41997 Release application browser 4.0.3

Author: ARobertsAtPros

RELEASENOTES.md

@@ -9,9 +9,12 @@
 - [Launch the Application Browser with an ID parameter](#Launch-the-Application-Browser-with-an-ID-parameter)
 - [How to Configure PPSS DO Email Approval](#How-to-Configure-PPSS-DO-Email-Approval)
 - [How to enable servers to automatic NTLM authentication](#How-to-enable-servers-to-automatic-NTLM-authentication)
+- [What to do if extension is not shown when exporting a file](#What-to-do-if-extension-is-not-shown-when-exporting-a-file)
+- [How to let Application Browser work with Pepper after EOL](#How-to-let-Application-Browser-work-with-Pepper-after-EOL)
 - [Changes](#Changes)
   - [4.0.1](#4.0.1)
   - [4.0.2](#4.0.2)
+  - [4.0.3](#4.0.3)
 - [Known Issues](#Known-Issues)
 
 ## How to Install on Windows
@@ -162,6 +165,40 @@ To enable servers to use automatic NTLM authentication add the **authServerWhite
 
 Without * prefix the URL has to match exactly. If you use only **"*"** wildcard, this integration will be globally enabled. If you don't want this integration to be turned on, remove the property from the config.json file.
 
+## What to do if extension is not shown when exporting a file
+For users that are experiencing problems with lack of extension when exporting a file, open Windows explorer and check the File name extensions box to unhide the extension.
+Users can also add the **saveDialogFilters** property in the config.json file, associating an allowed extensions filter array. For example:
+
+- "saveDialogFilters":[
+    {"name":"Excel", "extensions":["xlsx", "xls"]},
+    {"name":"Document", "extensions":["docx", "doc"]},
+    {"name":"Text", "extensions":["txt", "text"]},
+    {"name":"All Files", "extensions":["*"]}
+  ]
+
+The first attribute "name" let you to group extensions. It will be shown in the download dialog.
+The second attribute is "extensions". This is an array of extensions and should not contain wildcards or dots (e.g. 'png' is good but '.png' and '*.png' are bad). To show all files, use the '*' wildcard (no other wildcard is supported).
+
+## How to let Application Browser work with Pepper after EOL
+To let Application Browser work with Pepper Flash Player after EOL, mms.cfg file must exist in the path:
+
+**C:\Users\<user>\AppData\Roaming\ApplicationBrowser\Pepper Data\Shockwave Flash\System**
+
+Upgrading to version 4.0.3 or later and starting the application will automatically create an mms.config file if missing. See notes below for more detail or customization.
+
+This file must contain the following entries:
+
+EOLUninstallDisable=1
+SilentAutoUpdateEnable=0
+EnableAllowList=1
+AutoUpdateDisable=1
+ErrorReportingEnable=1
+AllowListURLPattern=<Base URL to your application instance>
+
+AllowListURLPattern rules are explained with more detail here: https://www.adobe.com/content/dam/acom/en/devnet/flashplayer/articles/flash_player_admin_guide/pdf/latest/flash_player_32_0_admin_guide.pdf
+
+When you start Application Browser, the mms.cfg file is automatically created and filled using the protocol and host of the existing URLs of config.json file environments. If mms.cfg already exists, it will be filled with the information that does not exist. It means, previous entries are not going to be overwritten. To take effect any change, this application must be restarted. To disable auto fill mms.cfg file, add the disableAutoFillMmsFile property as false to the config.json file. This is enabled by default.
+
 ## Changes
 
 ### 4.0.1
@@ -173,9 +210,9 @@ Without * prefix the URL has to match exactly. If you use only **"*"** wildcard,
  - PPSS-40347 Update readme file with FAQ and release notes for Application Browser.
  - PPSS-39787 Remove spaces and concatenate version to the installer name for Application Browser.
 
+### 4.0.3
+- PPSS-38383 Excel export file lacks name and extension using Application Browser.
+- PPSS-42118 PROS Application Browser - Flash Content Blocked from Jan 12 2021.
+
 ## Known Issues
 - PPSS-35717 When using an ID value with a blank space the PPSS login page is not displayed.
-- PPSS-38383 Excel export file lacks name and extension using Application Browser. 
-
-### Workaround for PPSS-38383
-For users that are experiencing problems with lack of extension when exporting a file, please open Windows explorer and check the File name extensions box to unhide the extension.

package.json

@@ -1,7 +1,7 @@
 {
     "name": "ApplicationBrowser",
     "productName": "Application Browser",
-    "version": "4.0.2",
+    "version": "4.0.3",
     "description": "A simple application that provides flash support",
     "main": "src/index.js",
     "scripts": {

src/environmentSetup.js

@@ -175,6 +175,88 @@ const validateParams = (json) => {
   return errorMessages;
 };
 
+const containsValidUrl = (url) => {
+  const urlValidator = /^(ftp|file|http|https):\/\/(\w+:{0,1}\w*@)?(\S+)(:[0-9]+)?(\/|\/([\w#!:.?+=&%@!\-/]))?/;
+  return urlValidator.test(url);
+}
+
+const getProtocolAndHostFromUrl = (url) => {
+  const [protocolScheme, protocolPath] = url.split('://');
+  const [protocolHost] = protocolPath.split('/');
+  return `${protocolScheme}://${protocolHost}`;
+}
+
+/**
+ * Automatically fills the mms.cfg file using the url of each environment from config.json file.
+ * Each time the application is launched this file is updated with config.json URL environments that
+ * do not exist on mms.cfg file. If a new change is made, the application must be restarted.
+ * 
+ * This is an example of the AllowListURLPattern output in the mms.cfg file:
+ *
+ * For config.json url: "http://<server>:<port>/application/index.html"
+ *
+ * This is the mms.cfg new entry: "AllowListURLPattern=http://<server>:<port>"
+ *
+ * SilentAutoUpdateEnable=0, AutoUpdateDisable=1, EOLUninstallDisable=1, ErrorReportingEnable=1
+ * and EnableAllowList=1 are added when mms.cfg file does not exist.
+ *
+ * To disable this functionality add the disableAutoFillMmsFile property as false to the config.json file
+ * 
+ * This document presents more information about how to configure the AllowListURLPattern entry:
+ * https://www.adobe.com/content/dam/acom/en/devnet/flashplayer/articles/flash_player_admin_guide/pdf/latest/flash_player_32_0_admin_guide.pdf
+ *
+ */
+const fillMmsFile = () => {
+  const MMS_FOLDER = app.getPath('userData') + "\\Pepper Data\\Shockwave Flash\\System\\";
+  const MMS_FILE_NAME = "mms.cfg";
+  const MMS_PATH = MMS_FOLDER + MMS_FILE_NAME;
+  console.log(MMS_PATH);
+  let mmsEntries = "";
+
+  if (!fs.existsSync(MMS_PATH)) {
+    if (!fs.existsSync(MMS_FOLDER)) {
+      fs.mkdirSync(MMS_FOLDER);
+    }
+    mmsEntries = "SilentAutoUpdateEnable=0\n";
+    mmsEntries += "AutoUpdateDisable=1\n";
+    mmsEntries += "EOLUninstallDisable=1\n";
+    mmsEntries += "ErrorReportingEnable=1\n";
+    mmsEntries += "EnableAllowList=1\n";
+  }
+  else {
+    const mmsFileEntries = fs.readFileSync(MMS_PATH, 'utf8').split("\n");
+    mmsFileEntries.forEach(element => {
+      if (element.trim() != "") {
+        mmsEntries += element + "\n";
+      }
+    });
+  }
+
+  if (fs.existsSync(CONFIG_FILE_PATH)) {
+    let json = {};
+    const file = fs.readFileSync(CONFIG_FILE_PATH);
+    json = JSON.parse(file);
+    if (json.environments) {
+      for (let i = 0; i < json.environments.length; i += 1) {
+        if(containsValidUrl(json.environments[i].url)) {
+          const allowedEntry = "AllowListURLPattern=" + getProtocolAndHostFromUrl(json.environments[i].url) + "\n";
+          if (mmsEntries.indexOf(allowedEntry.trim()) === -1) {
+            mmsEntries += allowedEntry;
+          }
+        }
+      }
+      try {
+        fs.writeFileSync(MMS_PATH, mmsEntries);
+      }
+      catch(error) {
+        app.globalContext.error.push(`Could not write to ${MMS_PATH} file.`)
+      }
+    }
+  } else {
+    console.log("fillMmsFile# configuration file not found.");
+  }
+}
+
 const initEnv = () => {
   try {
     const { json, configErrors } = validateConfigFile();
@@ -212,6 +294,10 @@ const initEnv = () => {
     app.commandLine.appendSwitch('ppapi-flash-path', flashPath);
     app.commandLine.appendSwitch('ppapi-flash-version', '27.0.0.130');
     mainConsole.log(`Using flash path: ${flashPath}`);
+
+    if (!json.disableAutoFillMmsFile) {
+      fillMmsFile();
+    }
   } catch (ex) {
     app.globalContext.error = [];
     app.globalContext.error.push(startupError);

src/index.js

@@ -205,6 +205,7 @@ if (!gotTheLock) {
  */
 const newTopWindow = () => {
   environment.mainConsole.log('loading top window...');
+  const {config} = app.globalContext;
 
   const win = new BrowserWindow({
     minWidth: 1024,
@@ -295,7 +296,6 @@ const newTopWindow = () => {
   win.on('page-title-updated', (ev, newTitle) => {
     ev.preventDefault();
     devToolsLog(`Change title: ${newTitle}`);
-    const {config} = app.globalContext;
 
     if (deeplinkingUrl) {
       let deepLinkEnvironment = config.environments.find(
@@ -314,6 +314,17 @@ const newTopWindow = () => {
     }
   });
 
+  // If saveDialogFilters configuration property is set, then the filters are passed to the
+  // save dialog. This is a example of the configuration:
+  // "saveDialogFilters": [{"name":"Excel", "extensions":["xlsx", "xls"]}]
+  if (config && config.saveDialogFilters) {
+    win.webContents.session.on('will-download', (event, item, webContents) => {
+      item.setSaveDialogOptions({
+        filters: config.saveDialogFilters
+      });
+    });
+  }
+
   return win;
 };