Merge branch 'main' into maint/update-third-party-licenses

jonbartels · web-flow · commit fe2e579b82db · 2026-04-02T10:45:48.000-04:00
diff --git a/client/src/com/mirth/connect/client/ui/Frame.java b/client/src/com/mirth/connect/client/ui/Frame.java
@@ -724,14 +724,15 @@ public void dispose() {
     private void loadExtensionMetaData() throws ClientException {
         loadedPlugins = mirthClient.getPluginMetaData();
         loadedConnectors = mirthClient.getConnectorMetaData();
+        Set<String> disabledExtensions = mirthClient.getDisabledExtensions();
 
         // Register extension JAX-RS providers with the client
         Set<String> apiProviderPackages = new HashSet<String>();
         Set<String> apiProviderClasses = new HashSet<String>();
 
         for (Object extensionMetaData : CollectionUtils.union(loadedPlugins.values(), loadedConnectors.values())) {
             MetaData metaData = (MetaData) extensionMetaData;
-            if (mirthClient.isExtensionEnabled(metaData.getName())) {
+            if (!disabledExtensions.contains(metaData.getName())) {
                 for (ApiProvider provider : metaData.getApiProviders(Version.getLatest())) {
                     switch (provider.getType()) {
                         case SERVLET_INTERFACE_PACKAGE:
diff --git a/client/src/com/mirth/connect/client/ui/LoadedExtensions.java b/client/src/com/mirth/connect/client/ui/LoadedExtensions.java
@@ -102,12 +102,20 @@ public void initialize() {
         // initialized again
         clearExtensionMaps();
 
+        Set<String> disabledExtensions;
+        try {
+            disabledExtensions = PlatformUI.MIRTH_FRAME.mirthClient.getDisabledExtensions();
+        } catch (Exception e) {
+            PlatformUI.MIRTH_FRAME.alertThrowable(PlatformUI.MIRTH_FRAME, e);
+            return;
+        }
+
         // Order all the plugins by their weight before loading any of them.
         Map<String, String> pluginNameMap = new HashMap<String, String>();
         NavigableMap<Integer, List<String>> weightedPlugins = new TreeMap<Integer, List<String>>();
         for (PluginMetaData metaData : PlatformUI.MIRTH_FRAME.getPluginMetaData().values()) {
             try {
-                if (PlatformUI.MIRTH_FRAME.mirthClient.isExtensionEnabled(metaData.getName())) {
+                if (!disabledExtensions.contains(metaData.getName())) {
                     extensionVersions.put(metaData.getName(), metaData.getPluginVersion());
                     if (metaData.getClientClasses() != null) {
                         for (PluginClass pluginClass : metaData.getClientClasses()) {
@@ -150,7 +158,7 @@ public void initialize() {
         // Load connector code template plugins before anything else
         for (ConnectorMetaData metaData : PlatformUI.MIRTH_FRAME.getConnectorMetaData().values()) {
             try {
-                if (PlatformUI.MIRTH_FRAME.mirthClient.isExtensionEnabled(metaData.getName())) {
+                if (!disabledExtensions.contains(metaData.getName())) {
                     extensionVersions.put(metaData.getName(), metaData.getPluginVersion());
                     if (StringUtils.isNotEmpty(metaData.getTemplateClassName())) {
                         Class<?> clazz = Class.forName(metaData.getTemplateClassName());
@@ -205,7 +213,7 @@ public void initialize() {
 
         for (ConnectorMetaData metaData : PlatformUI.MIRTH_FRAME.getConnectorMetaData().values()) {
             try {
-                if (PlatformUI.MIRTH_FRAME.mirthClient.isExtensionEnabled(metaData.getName())) {
+                if (!disabledExtensions.contains(metaData.getName())) {
 
                     String connectorName = metaData.getName();
                     ConnectorSettingsPanel connectorSettingsPanel = (ConnectorSettingsPanel) Class.forName(metaData.getClientClassName()).newInstance();
diff --git a/donkey/src/main/java/com/mirth/connect/donkey/server/data/jdbc/JdbcDao.java b/donkey/src/main/java/com/mirth/connect/donkey/server/data/jdbc/JdbcDao.java
@@ -2935,6 +2935,15 @@ private Map<Long, Map<Integer, Map<String, Object>>> getMetaDataMaps(String chan
             statement = connection.prepareStatement(querySource.getQuery("getMetaDataMapByMessageId", values));
             resultSet = statement.executeQuery();
 
+            ResultSetMetaData resultSetMetaData = resultSet.getMetaData();
+            int columnCount = resultSetMetaData.getColumnCount();
+            MetaDataColumnType[] columnTypes = new MetaDataColumnType[columnCount + 1];
+            String[] columnNames = new String[columnCount + 1];
+            for (int i = 1; i <= columnCount; i++) {
+                columnTypes[i] = MetaDataColumnType.fromSqlType(resultSetMetaData.getColumnType(i));
+                columnNames[i] = resultSetMetaData.getColumnName(i).toUpperCase();
+            }
+
             while (resultSet.next()) {
                 Long messageId = resultSet.getLong("message_id");
                 Integer metaDataId = resultSet.getInt("metadata_id");
@@ -2951,28 +2960,24 @@ private Map<Long, Map<Integer, Map<String, Object>>> getMetaDataMaps(String chan
                     connectorMetaDataMap.put(metaDataId, metaDataMap);
                 }
 
-                ResultSetMetaData resultSetMetaData = resultSet.getMetaData();
-                int columnCount = resultSetMetaData.getColumnCount();
-
                 for (int i = 1; i <= columnCount; i++) {
-                    MetaDataColumnType metaDataColumnType = MetaDataColumnType.fromSqlType(resultSetMetaData.getColumnType(i));
                     Object value = null;
 
-                    switch (metaDataColumnType) {//@formatter:off
+                    switch (columnTypes[i]) {//@formatter:off
                         case STRING:
                             value = resultSet.getString(i);
                             if (encryptor != null && StringUtils.startsWith((String) value, Encryptor.HEADER_INDICATOR)) {
                                 try {
                                     value = encryptor.decrypt((String) value);
                                 } catch (Exception e) {
-                                    logger.debug("Unable to decrypt custom metadata column " + resultSetMetaData.getColumnName(i).toUpperCase() + " for channel " + channelId + ", messsage " + messageId + "-" + metaDataId, e);
+                                    logger.debug("Unable to decrypt custom metadata column " + columnNames[i] + " for channel " + channelId + ", messsage " + messageId + "-" + metaDataId, e);
                                 }
                             }
                             break;
                         case NUMBER: value = resultSet.getBigDecimal(i); break;
                         case BOOLEAN: value = resultSet.getBoolean(i); break;
                         case TIMESTAMP:
-                            
+
                             Timestamp timestamp = resultSet.getTimestamp(i);
                             if (timestamp != null) {
                                 value = Calendar.getInstance();
@@ -2983,7 +2988,7 @@ private Map<Long, Map<Integer, Map<String, Object>>> getMetaDataMaps(String chan
                         default: throw new Exception("Unrecognized MetaDataColumnType");
                     } //@formatter:on
 
-                    metaDataMap.put(resultSetMetaData.getColumnName(i).toUpperCase(), value);
+                    metaDataMap.put(columnNames[i], value);
                 }
             }
 
diff --git a/server/src/com/mirth/connect/client/core/Client.java b/server/src/com/mirth/connect/client/core/Client.java
@@ -2622,6 +2622,16 @@ public boolean isExtensionEnabled(String extensionName) throws ClientException {
         return getServlet(ExtensionServletInterface.class).isExtensionEnabled(extensionName);
     }
 
+    /**
+     * Returns the disabled extensions on the classpath.
+     * 
+     * @see ExtensionServletInterface#getDisabledExtensions
+     */
+    @Override
+    public Set<String> getDisabledExtensions() throws ClientException {
+        return getServlet(ExtensionServletInterface.class).getDisabledExtensions();
+    }
+
     /**
      * Enables or disables an extension.
      * 
diff --git a/server/src/com/mirth/connect/client/core/api/servlets/ExtensionServletInterface.java b/server/src/com/mirth/connect/client/core/api/servlets/ExtensionServletInterface.java
@@ -111,6 +111,16 @@ public void uninstallExtension(@Param("extensionPath") @RequestBody(description
     @MirthOperation(name = "isExtensionEnabled", display = "Check if extension is enabled", auditable = false)
     public boolean isExtensionEnabled(@Param("extensionName") @Parameter(description = "The name of the extension to retrieve.", required = true) @PathParam("extensionName") String extensionName) throws ClientException;
 
+    @GET
+    @Path("/disabled")
+    @Operation(summary = "Returns the disabled extensions on the classpath.")
+    @ApiResponse(content = { @Content(mediaType = MediaType.APPLICATION_XML, examples = {
+            @ExampleObject(name = "disabledExtensions", value = "<set><string>Channel Reader</string></set>") }),
+            @Content(mediaType = MediaType.APPLICATION_JSON, examples = {
+                    @ExampleObject(name = "disabledExtensions", value = "[\"Channel Reader\"]") }) })
+    @MirthOperation(name = "getDisabledExtensions", display = "Get disabled extensions", auditable = false)
+    public Set<String> getDisabledExtensions() throws ClientException;
+
     @POST
     @Path("/{extensionName}/_setEnabled")
     @Operation(summary = "Enables or disables an extension.")
diff --git a/server/src/com/mirth/connect/server/api/servlets/ExtensionServlet.java b/server/src/com/mirth/connect/server/api/servlets/ExtensionServlet.java
@@ -102,6 +102,11 @@ public boolean isExtensionEnabled(String extensionName) {
         return extensionController.isExtensionEnabled(extensionName);
     }
 
+    @Override
+    public Set<String> getDisabledExtensions() {
+        return extensionController.getDisabledExtensions();
+    }
+
     @Override
     public void setExtensionEnabled(String extensionName, boolean enabled) {
         try {
diff --git a/server/src/com/mirth/connect/server/controllers/DefaultExtensionController.java b/server/src/com/mirth/connect/server/controllers/DefaultExtensionController.java
@@ -23,6 +23,7 @@
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.LinkedHashMap;
+import java.util.LinkedHashSet;
 import java.util.List;
 import java.util.Map;
 import java.util.NavigableMap;
@@ -364,6 +365,25 @@ public boolean isExtensionEnabled(String extensionName) {
         return extensionStatuses.isEnabled(extensionName);
     }
 
+    @Override
+    public Set<String> getDisabledExtensions() {
+        Set<String> disabledExtensions = new LinkedHashSet<String>();
+
+        for (MetaData metaData : getPluginMetaData().values()) {
+            if (!isExtensionEnabled(metaData.getName())) {
+                disabledExtensions.add(metaData.getName());
+            }
+        }
+
+        for (MetaData metaData : getConnectorMetaData().values()) {
+            if (!isExtensionEnabled(metaData.getName())) {
+                disabledExtensions.add(metaData.getName());
+            }
+        }
+
+        return disabledExtensions;
+    }
+
     @Override
     public void startPlugins() {
         for (ServerPlugin serverPlugin : serverPlugins) {
diff --git a/server/src/com/mirth/connect/server/controllers/ExtensionController.java b/server/src/com/mirth/connect/server/controllers/ExtensionController.java
@@ -86,6 +86,11 @@ public static ExtensionController getInstance() {
      */
     public abstract boolean isExtensionEnabled(String name);
 
+    /**
+     * Returns the names of disabled extensions on the classpath.
+     */
+    public abstract Set<String> getDisabledExtensions();
+
     /**
      * Invokes the start method on all loaded server plugins.
      */
diff --git a/server/src/com/mirth/connect/server/launcher/Log4jMigrations.java b/server/src/com/mirth/connect/server/launcher/Log4jMigrations.java
@@ -0,0 +1,43 @@
+// SPDX-License-Identifier: MPL-2.0
+// SPDX-FileCopyrightText: 2026 Mitch Gaffigan <mitch@gaffigan.net>
+
+package com.mirth.connect.server.launcher;
+
+import java.io.File;
+import java.io.IOException;
+import java.nio.charset.StandardCharsets;
+import java.util.List;
+
+import org.apache.commons.io.FileUtils;
+
+public class Log4jMigrations {
+    private static final String INVALID_LOG4J_PROPERTY = "dir.logs";
+
+    private Log4jMigrations() {}
+
+    public static void migrateConfiguration(File propertiesFile) {
+        if (!propertiesFile.exists() || !propertiesFile.isFile()) {
+            return;
+        }
+
+        try {
+            List<String> lines = FileUtils.readLines(propertiesFile, StandardCharsets.UTF_8);
+            if (stripDirLogs(lines)) {
+                FileUtils.writeLines(propertiesFile, StandardCharsets.UTF_8.name(), lines, System.lineSeparator(), false);
+            }
+        } catch (IOException e) {
+            System.err.println("Failed to migrate Log4j configuration: " + propertiesFile.getAbsolutePath());
+            e.printStackTrace();
+        }
+    }
+
+    private static boolean stripDirLogs(List<String> lines) {
+        return lines.removeIf(line -> isPropertyLine(line, INVALID_LOG4J_PROPERTY));
+    }
+
+    private static boolean isPropertyLine(String line, String propertyName) {
+        String trimmedLine = line.trim();
+        int equalsIndex = trimmedLine.indexOf('=');
+        return equalsIndex >= 0 && trimmedLine.substring(0, equalsIndex).trim().equals(propertyName);
+    }
+}
diff --git a/server/src/com/mirth/connect/server/launcher/MirthLauncher.java b/server/src/com/mirth/connect/server/launcher/MirthLauncher.java
@@ -40,6 +40,7 @@ public class MirthLauncher {
     private static final String EXTENSIONS_DIR = "./extensions";
     private static final String SERVER_LAUNCHER_LIB_DIR = "./server-launcher-lib";
     private static final String MIRTH_PROPERTIES_FILE = "./conf/mirth.properties";
+    private static final String LOG4J_PROPERTIES_FILE = "./conf/log4j2.properties";
     private static final String PROPERTY_APP_DATA_DIR = "dir.appdata";
     private static final String PROPERTY_INCLUDE_CUSTOM_LIB = "server.includecustomlib";
     private static final String[] LOG4J_JAR_FILES = { "./server-lib/log4j/log4j-core-2.25.3.jar",
@@ -53,6 +54,8 @@ public class MirthLauncher {
     public static void main(String[] args) {
         JarFile mirthClientCoreJarFile = null;
         try {
+            Log4jMigrations.migrateConfiguration(new File(LOG4J_PROPERTIES_FILE));
+
             List<URL> classpathUrls = new ArrayList<>();
             // Always add log4j
             for (String log4jJar : LOG4J_JAR_FILES) {
diff --git a/server/test/com/mirth/connect/server/launcher/Log4jMigrationsTest.java b/server/test/com/mirth/connect/server/launcher/Log4jMigrationsTest.java
@@ -0,0 +1,108 @@
+// SPDX-License-Identifier: MPL-2.0
+// SPDX-FileCopyrightText: 2026 Mitch Gaffigan <mitch@gaffigan.net>
+
+package com.mirth.connect.server.launcher;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
+
+import java.io.ByteArrayOutputStream;
+import java.io.File;
+import java.io.PrintStream;
+import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.attribute.FileTime;
+import java.nio.file.attribute.PosixFilePermission;
+import java.util.EnumSet;
+import java.util.Set;
+
+import org.junit.Assume;
+import org.junit.Test;
+
+public class Log4jMigrationsTest {
+
+    @Test
+    public void testMigrateLog4jRemovesDirLogs() throws Exception {
+        File file = File.createTempFile("log4j2", ".properties");
+        file.deleteOnExit();
+        Files.writeString(file.toPath(), String.join(System.lineSeparator(),
+                "rootLogger = ERROR,stdout,fout",
+                "dir.logs   = logs",
+                "property.log.dir = logs",
+                "appender.rolling.fileName = ${log.dir}/mirth.log"), StandardCharsets.UTF_8);
+
+        Log4jMigrations.migrateConfiguration(file);
+
+        String fileContents = Files.readString(file.toPath(), StandardCharsets.UTF_8);
+        assertFalse(fileContents.contains("dir.logs"));
+        assertTrue(fileContents.contains("property.log.dir = logs"));
+        assertTrue(fileContents.contains("appender.rolling.fileName = ${log.dir}/mirth.log"));
+    }
+
+    @Test
+    public void testMigrateLog4jDoesNotRewriteCleanFile() throws Exception {
+        File file = File.createTempFile("log4j2-clean", ".properties");
+        file.deleteOnExit();
+        String contents = String.join(System.lineSeparator(),
+                "rootLogger = ERROR,stdout,fout",
+                "property.log.dir = logs",
+                "appender.rolling.fileName = ${log.dir}/mirth.log");
+        Files.writeString(file.toPath(), contents, StandardCharsets.UTF_8);
+
+        FileTime expectedModifiedTime = FileTime.fromMillis(1_700_000_000_000L);
+        Files.setLastModifiedTime(file.toPath(), expectedModifiedTime);
+
+        Log4jMigrations.migrateConfiguration(file);
+
+        assertEquals(expectedModifiedTime, Files.getLastModifiedTime(file.toPath()));
+        assertEquals(contents, Files.readString(file.toPath(), StandardCharsets.UTF_8));
+    }
+
+    @Test
+    public void testMigrateLog4jFailsGracefullyWithReadOnlyFile() throws Exception {
+        File file = File.createTempFile("log4j2-readonly", ".properties");
+        file.deleteOnExit();
+        String contents = String.join(System.lineSeparator(),
+                "rootLogger = ERROR,stdout,fout",
+                "dir.logs   = logs",
+                "property.log.dir = logs");
+        Path path = file.toPath();
+        Files.writeString(path, contents, StandardCharsets.UTF_8);
+
+        Assume.assumeTrue(Files.getFileStore(path).supportsFileAttributeView("posix"));
+
+        ByteArrayOutputStream errBytes = new ByteArrayOutputStream();
+        PrintStream originalErr = System.err;
+        Set<PosixFilePermission> originalPermissions = Files.getPosixFilePermissions(path);
+
+        try {
+            Files.setPosixFilePermissions(path, EnumSet.of(PosixFilePermission.OWNER_READ));
+            assertFalse(Files.isWritable(path));
+            System.setErr(new PrintStream(errBytes, true, StandardCharsets.UTF_8.name()));
+
+            Log4jMigrations.migrateConfiguration(file);
+        } finally {
+            Files.setPosixFilePermissions(path, originalPermissions);
+            System.setErr(originalErr);
+        }
+
+        String errOutput = errBytes.toString(StandardCharsets.UTF_8.name());
+        assertTrue(errOutput.contains("Failed to migrate Log4j configuration"));
+        assertEquals(contents, Files.readString(path, StandardCharsets.UTF_8));
+    }
+
+    @Test
+    public void testMigrateLog4jIgnoresMissingFile() throws Exception {
+        File parentDir = Files.createTempDirectory("log4j2-missing").toFile();
+        parentDir.deleteOnExit();
+        File file = new File(parentDir, "missing-log4j2.properties");
+
+        assertFalse(file.exists());
+
+        Log4jMigrations.migrateConfiguration(file);
+
+        assertFalse(file.exists());
+    }
+}
