Merging input files (App)

src/ElectronBackend/main/__tests__/listeners.test.ts

@@ -29,11 +29,11 @@ import { setGlobalBackendState } from '../globalBackendState';
 import {
   exportFileListener,
   importFileListener,
-  importFileSelectInputListener,
   importFileSelectSaveLocationListener,
   linkHasHttpSchema,
   openLinkListener,
   selectBaseURLListener,
+  selectFileListener,
 } from '../listeners';
 import { importFileFormats } from '../menu/fileMenu';
 
@@ -412,7 +412,7 @@ describe('getImportFileListener', () => {
     listener();
 
     expect(mainWindow.webContents.send).toHaveBeenCalledWith(
-      AllowedFrontendChannels.ImportFileShowDialog,
+      AllowedFrontendChannels.ShowImportDialog,
       fileFormat,
     );
   });
@@ -424,7 +424,7 @@ describe('getImportFileSelectInputListener', () => {
     const fileFormat = importFileFormats[0];
     const selectedFilePath = '/home/input.json';
 
-    const listener = importFileSelectInputListener(mainWindow);
+    const listener = selectFileListener(mainWindow);
 
     jest.mocked(openNonOpossumFileDialog).mockReturnValue([selectedFilePath]);
 
@@ -440,7 +440,7 @@ describe('getImportFileSelectInputListener', () => {
     const mainWindow = await initWindowAndBackendState();
     const fileFormat = importFileFormats[0];
 
-    const listener = importFileSelectInputListener(mainWindow);
+    const listener = selectFileListener(mainWindow);
 
     jest
       .mocked(openNonOpossumFileDialog)

src/ElectronBackend/main/dialogs.ts

@@ -32,7 +32,7 @@ export function openNonOpossumFileDialog(
 ): Array<string> | undefined {
   return openFileDialog([
     {
-      name: `${fileFormat.name}s (${fileFormat.extensions.map((ext) => `.${ext}`).join('/')})`,
+      name: `${fileFormat.name} Files (${fileFormat.extensions.map((ext) => `.${ext}`).join('/')})`,
       extensions: fileFormat.extensions,
     },
   ]);

src/ElectronBackend/main/listeners.ts

@@ -24,6 +24,7 @@ import {
   PackageInfo,
   SaveFileArgs,
 } from '../../shared/shared-types';
+import { text } from '../../shared/text';
 import { writeFile, writeOpossumFile } from '../../shared/write-file';
 import { LoadedFileFormat } from '../enums/enums';
 import {
@@ -32,7 +33,10 @@ import {
 } from '../errorHandling/errorHandling';
 import { loadInputAndOutputFromFilePath } from '../input/importFromFile';
 import { serializeAttributions } from '../input/parseInputData';
-import { convertToOpossum } from '../opossum-file/opossum-file';
+import {
+  convertToOpossum,
+  mergeFileIntoOpossum,
+} from '../opossum-file/opossum-file';
 import { writeCsvToFile } from '../output/writeCsvToFile';
 import { writeSpdxFile } from '../output/writeSpdxFile';
 import { GlobalBackendState, OpossumOutputFile } from '../types/types';
@@ -132,12 +136,20 @@ export async function handleOpeningFile(
 export const importFileListener =
   (mainWindow: BrowserWindow, fileFormat: FileFormatInfo) => (): void => {
     mainWindow.webContents.send(
-      AllowedFrontendChannels.ImportFileShowDialog,
+      AllowedFrontendChannels.ShowImportDialog,
+      fileFormat,
+    );
+  };
+
+export const getMergeListener =
+  (mainWindow: BrowserWindow, fileFormat: FileFormatInfo) => (): void => {
+    mainWindow.webContents.send(
+      AllowedFrontendChannels.ShowMergeDialog,
       fileFormat,
     );
   };
 
-export const importFileSelectInputListener =
+export const selectFileListener =
   (mainWindow: BrowserWindow) =>
   async (
     _: Electron.IpcMainInvokeEvent,
@@ -183,19 +195,31 @@ export const importFileConvertAndLoadListener =
 
     try {
       if (!resourceFilePath.trim() || !fs.existsSync(resourceFilePath)) {
-        throw new Error('Input file does not exist');
+        throw new Error(text.backendError.inputFileDoesNotExist);
+      }
+
+      try {
+        fs.accessSync(resourceFilePath, fs.constants.R_OK);
+      } catch (error) {
+        throw new Error(text.backendError.inputFilePermissionError);
       }
 
       if (!opossumFilePath.trim()) {
-        throw new Error('No .opossum save location selected');
+        throw new Error(text.backendError.opossumFileNotSelected);
       }
 
       if (!opossumFilePath.endsWith('.opossum')) {
-        throw new Error('Output file name must have .opossum extension');
+        throw new Error(text.backendError.opossumFileWrongExtension);
       }
 
       if (!fs.existsSync(path.dirname(opossumFilePath))) {
-        throw new Error('Output directory does not exist');
+        throw new Error(text.backendError.opossumFileDirectoryDoesNotExist);
+      }
+
+      try {
+        fs.accessSync(path.dirname(opossumFilePath), fs.constants.W_OK);
+      } catch (error) {
+        throw new Error(text.backendError.opossumFilePermissionError);
       }
 
       logger.info('Converting input file to .opossum format');
@@ -215,6 +239,59 @@ export const importFileConvertAndLoadListener =
     }
   };
 
+export const mergeFileAndLoadListener =
+  (mainWindow: BrowserWindow) =>
+  async (
+    _: Electron.IpcMainInvokeEvent,
+    inputFilePath: string,
+    fileType: FileType,
+  ): Promise<boolean> => {
+    setLoadingState(mainWindow.webContents, true);
+
+    try {
+      if (!inputFilePath.trim() || !fs.existsSync(inputFilePath)) {
+        throw new Error(text.backendError.inputFileDoesNotExist);
+      }
+
+      try {
+        fs.accessSync(inputFilePath, fs.constants.R_OK);
+      } catch (error) {
+        throw new Error(text.backendError.inputFilePermissionError);
+      }
+
+      const currentOpossumFilePath = getGlobalBackendState().opossumFilePath;
+
+      if (!currentOpossumFilePath) {
+        throw new Error(text.backendError.noOpenFileToMergeInto);
+      }
+
+      try {
+        fs.copyFileSync(
+          currentOpossumFilePath,
+          `${currentOpossumFilePath}.backup`,
+        );
+      } catch (error) {
+        throw new Error(text.backendError.cantCreateBackup);
+      }
+
+      logger.info('Merging input file into current .opossum file');
+      await mergeFileIntoOpossum(
+        inputFilePath,
+        currentOpossumFilePath,
+        fileType,
+      );
+
+      await openFile(mainWindow, currentOpossumFilePath, () => {});
+
+      return true;
+    } catch (error) {
+      sendListenerErrorToFrontend(mainWindow, error);
+      return false;
+    } finally {
+      setLoadingState(mainWindow.webContents, false);
+    }
+  };
+
 function initializeGlobalBackendState(
   filePath: string,
   isOpossumFormat: boolean,

src/ElectronBackend/main/main.ts

@@ -11,14 +11,15 @@ import { createWindow } from './createWindow';
 import {
   exportFileListener,
   importFileConvertAndLoadListener,
-  importFileSelectInputListener,
   importFileSelectSaveLocationListener,
+  mergeFileAndLoadListener,
   openFileListener,
   openLinkListener,
   saveFileListener,
+  selectFileListener,
 } from './listeners';
 import { createMenu } from './menu';
-import { activateMenuItems } from './menu/initiallyDisabledMenuItems';
+import { DisabledMenuItemHandler } from './menu/DisabledMenuItemHandler';
 import { openFileFromCliOrEnvVariableIfProvided } from './openFileFromCliOrEnvVariableIfProvided';
 import { UserSettings } from './user-settings';
 
@@ -65,19 +66,23 @@ export async function main(): Promise<void> {
     });
     ipcMain.handle(
       IpcChannel.OpenFile,
-      openFileListener(mainWindow, activateMenuItems),
-    );
-    ipcMain.handle(
-      IpcChannel.ImportFileSelectInput,
-      importFileSelectInputListener(mainWindow),
+      openFileListener(mainWindow, DisabledMenuItemHandler.activateMenuItems),
     );
+    ipcMain.handle(IpcChannel.SelectFile, selectFileListener(mainWindow));
     ipcMain.handle(
       IpcChannel.ImportFileSelectSaveLocation,
       importFileSelectSaveLocationListener(mainWindow),
     );
     ipcMain.handle(
       IpcChannel.ImportFileConvertAndLoad,
-      importFileConvertAndLoadListener(mainWindow, activateMenuItems),
+      importFileConvertAndLoadListener(
+        mainWindow,
+        DisabledMenuItemHandler.activateMenuItems,
+      ),
+    );
+    ipcMain.handle(
+      IpcChannel.MergeFileAndLoad,
+      mergeFileAndLoadListener(mainWindow),
     );
     ipcMain.handle(IpcChannel.SaveFile, saveFileListener(mainWindow));
     ipcMain.handle(IpcChannel.ExportFile, exportFileListener(mainWindow));

src/ElectronBackend/main/menu/DisabledMenuItemHandler.ts

@@ -0,0 +1,32 @@
+// SPDX-FileCopyrightText: Meta Platforms, Inc. and its affiliates
+// SPDX-FileCopyrightText: TNG Technology Consulting GmbH <https://www.tngtech.com>
+//
+// SPDX-License-Identifier: Apache-2.0
+import { Menu } from 'electron';
+
+export class DisabledMenuItemHandler {
+  private static nextId: number = 0;
+
+  static registerDisabledMenuItem(): string {
+    const idString = DisabledMenuItemHandler.nextId.toString();
+    DisabledMenuItemHandler.nextId++;
+    return idString;
+  }
+
+  private static disabledIds(): Array<string> {
+    return Array(DisabledMenuItemHandler.nextId)
+      .keys()
+      .map((id) => id.toString())
+      .toArray();
+  }
+
+  static activateMenuItems(): void {
+    const menu = Menu.getApplicationMenu();
+    DisabledMenuItemHandler.disabledIds().forEach((id) => {
+      const menuItem = menu?.getMenuItemById(id);
+      if (menuItem) {
+        menuItem.enabled = true;
+      }
+    });
+  }
+}

src/ElectronBackend/main/menu/aboutMenu.ts

@@ -5,6 +5,7 @@
 // SPDX-License-Identifier: Apache-2.0
 import { shell } from 'electron';
 
+import { text } from '../../../shared/text';
 import { getIconBasedOnTheme } from '../iconHelpers';
 import {
   getPathOfChromiumNoticeDocument,
@@ -17,7 +18,7 @@ function getOpenOnGithub() {
       'icons/github-white.png',
       'icons/github-black.png',
     ),
-    label: 'Open on GitHub',
+    label: text.menu.aboutSubmenu.openOnGithub,
     click: () =>
       shell.openExternal('https://github.com/opossum-tool/opossumUI'),
   };
@@ -29,7 +30,7 @@ function getOpossumUiNotices() {
       'icons/notice-white.png',
       'icons/notice-black.png',
     ),
-    label: 'OpossumUI Notices',
+    label: text.menu.aboutSubmenu.opossumUINotices,
     click: () => shell.openPath(getPathOfNoticeDocument()),
   };
 }
@@ -40,14 +41,14 @@ function getChromiumNotices() {
       'icons/chromium-white.png',
       'icons/chromium-black.png',
     ),
-    label: 'Chromium Notices',
+    label: text.menu.aboutSubmenu.chromiumNotices,
     click: () => shell.openPath(getPathOfChromiumNoticeDocument()),
   };
 }
 
 export function getAboutMenu() {
   return {
-    label: 'About',
+    label: text.menu.about,
     submenu: [getOpenOnGithub(), getOpossumUiNotices(), getChromiumNotices()],
   };
 }