Skip to content

Login and client command line refactoring #175

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mgaffigan wants to merge 3 commits into
base: main
Choose a base branch
from
+220 −187
Open

Login and client command line refactoring #175

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6e3bda7
Moved handleSuccess to Mirth.java - boots app, not related to panel
mgaffigan Sep 3, 2025
2714614
Removed duplicated error handling logic to separate method, avoid rel…
mgaffigan Sep 3, 2025
e738ced
Remove LoginPanel singleton to separate class to allow other implemen…
mgaffigan Sep 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions client/src/com/mirth/connect/client/ui/AbstractLoginPanel.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
package com.mirth.connect.client.ui;

/**
* Public interface for the login panel so alternative implementations can be provided.
*/
public abstract class AbstractLoginPanel extends javax.swing.JFrame {

/**
* Initialize and show the login UI.
*/
public abstract void initialize(String mirthServer, String version, String user, String pass);

/**
* Update the status text shown on the login UI.
*/
public abstract void setStatus(String status);
}
8 changes: 4 additions & 4 deletions client/src/com/mirth/connect/client/ui/Frame.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -543,7 +543,7 @@ public void eventDispatched(AWTEvent e)
*/
public void setupFrame(Client mirthClient) throws ClientException {

LoginPanel login = LoginPanel.getInstance();
AbstractLoginPanel login = LoginPanelFactory.getInstance();

// Initialize the send message dialog
editMessageDialog = new EditMessageDialog();
Expand Down Expand Up @@ -1524,7 +1524,7 @@ public void alertThrowable(Component parentComponent, Throwable t, String custom
}
mirthClient.close();
this.dispose();
LoginPanel.getInstance().initialize(PlatformUI.SERVER_URL, PlatformUI.CLIENT_VERSION, "", "");
LoginPanelFactory.getInstance().initialize(PlatformUI.SERVER_URL, PlatformUI.CLIENT_VERSION, "", "");
return;
} else if (t.getCause() != null && t.getCause() instanceof HttpHostConnectException && (StringUtils.contains(t.getCause().getMessage(), "Connection refused") || StringUtils.contains(t.getCause().getMessage(), "Host is down"))) {
connectionError = true;
Expand All @@ -1542,7 +1542,7 @@ public void alertThrowable(Component parentComponent, Throwable t, String custom
}
mirthClient.close();
this.dispose();
LoginPanel.getInstance().initialize(PlatformUI.SERVER_URL, PlatformUI.CLIENT_VERSION, "", "");
LoginPanelFactory.getInstance().initialize(PlatformUI.SERVER_URL, PlatformUI.CLIENT_VERSION, "", "");
return;
}
}
Expand Down Expand Up @@ -2292,7 +2292,7 @@ public boolean logout(boolean quit, boolean confirmFirst) {
this.dispose();

if (!quit) {
LoginPanel.getInstance().initialize(PlatformUI.SERVER_URL, PlatformUI.CLIENT_VERSION, "", "");
LoginPanelFactory.getInstance().initialize(PlatformUI.SERVER_URL, PlatformUI.CLIENT_VERSION, "", "");
}

return true;
Expand Down
204 changes: 24 additions & 180 deletions client/src/com/mirth/connect/client/ui/LoginPanel.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,46 +4,33 @@

package com.mirth.connect.client.ui;

import static com.mirth.connect.client.core.BrandingConstants.CHECK_FOR_NOTIFICATIONS;

import java.awt.Color;
import java.awt.Cursor;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Properties;
import java.util.Set;
import java.util.prefs.Preferences;

import javax.swing.ImageIcon;
import javax.swing.SwingWorker;

import org.apache.commons.lang3.BooleanUtils;
import org.apache.commons.lang3.StringUtils;

import com.mirth.connect.client.core.Client;
import com.mirth.connect.client.core.ClientException;
import com.mirth.connect.client.core.ConnectServiceUtil;
import com.mirth.connect.client.core.UnauthorizedException;
import com.mirth.connect.client.core.api.servlets.UserServletInterface;
import com.mirth.connect.client.ui.util.DisplayUtil;
import com.mirth.connect.model.ExtendedLoginStatus;
import com.mirth.connect.model.LoginStatus;
import com.mirth.connect.model.PublicServerSettings;
import com.mirth.connect.model.User;
import com.mirth.connect.model.converters.ObjectXMLSerializer;
import com.mirth.connect.plugins.MultiFactorAuthenticationClientPlugin;
import com.mirth.connect.util.MirthSSLUtil;

public class LoginPanel extends javax.swing.JFrame {
public class LoginPanel extends AbstractLoginPanel {

private Client client;
private static final String ERROR_MESSAGE = "There was an error connecting to the server at the specified address. Please verify that the server is up and running.";
private static LoginPanel instance = null;

private LoginPanel() {
public LoginPanel() {
initComponents();
DisplayUtil.setResizable(this, false);
jLabel2.setForeground(UIConstants.HEADER_TITLE_TEXT_COLOR);
Expand Down Expand Up @@ -81,24 +68,14 @@ public void mouseClicked(java.awt.event.MouseEvent evt) {
errorTextArea.setDisabledTextColor(Color.RED);
}

public static LoginPanel getInstance() {
synchronized (LoginPanel.class) {
if (instance == null) {
instance = new LoginPanel();
}
return instance;
}
}

@Override
public void initialize(String mirthServer, String version, String user, String pass) {
synchronized (this) {
// Do not initialize another login window if one is already visible
if (isVisible()) {
return;
}

PlatformUI.CLIENT_VERSION = version;

setTitle(String.format("%s %s - Login", BrandingConstants.PRODUCT_NAME, version));
setIconImage(BrandingConstants.FAVICON.getImage());

Expand Down Expand Up @@ -415,6 +392,7 @@ private void passwordActionPerformed(java.awt.event.ActionEvent evt)// GEN-FIRST
private void loginButtonActionPerformed(java.awt.event.ActionEvent evt)// GEN-FIRST:event_loginButtonActionPerformed
{// GEN-HEADEREND:event_loginButtonActionPerformed
errorPane.setVisible(false);
LoginPanel loginPanel = this;

SwingWorker<Void, Void> worker = new SwingWorker<Void, Void>() {

Expand All @@ -423,7 +401,7 @@ public Void doInBackground() {

try {
String server = serverName.getText();
client = new Client(server, PlatformUI.HTTPS_PROTOCOLS, PlatformUI.HTTPS_CIPHER_SUITES);
Client client = new Client(server, PlatformUI.HTTPS_PROTOCOLS, PlatformUI.HTTPS_CIPHER_SUITES);
PlatformUI.SERVER_URL = server;

// Attempt to login
Expand All @@ -447,9 +425,9 @@ public Void doInBackground() {

// If SUCCESS or SUCCESS_GRACE_PERIOD
if (loginStatus != null && loginStatus.isSuccess()) {
if (!handleSuccess(loginStatus)) {
LoginPanel.getInstance().setVisible(false);
LoginPanel.getInstance().initialize(PlatformUI.SERVER_URL, PlatformUI.CLIENT_VERSION, "", "");
if (!Mirth.handleLoginSuccess(client, loginStatus, username.getText())) {
loginPanel.setVisible(false);
loginPanel.initialize(PlatformUI.SERVER_URL, PlatformUI.CLIENT_VERSION, "", "");
}
} else {
// Assume failure unless overridden by a plugin
Expand All @@ -466,9 +444,9 @@ public Void doInBackground() {

if (loginStatus != null && loginStatus.isSuccess()) {
errorOccurred = false;
if (!handleSuccess(loginStatus)) {
LoginPanel.getInstance().setVisible(false);
LoginPanel.getInstance().initialize(PlatformUI.SERVER_URL, PlatformUI.CLIENT_VERSION, "", "");
if (!Mirth.handleLoginSuccess(client, loginStatus, username.getText())) {
loginPanel.setVisible(false);
loginPanel.initialize(PlatformUI.SERVER_URL, PlatformUI.CLIENT_VERSION, "", "");
}
}
}
Expand All @@ -477,163 +455,19 @@ public Void doInBackground() {

if (errorOccurred) {
if (loginStatus != null) {
errorTextArea.setText(loginStatus.getMessage());
setError(loginStatus.getMessage());
} else {
errorTextArea.setText(ERROR_MESSAGE);
setError(ERROR_MESSAGE);
}
}
} catch (Throwable t) {
errorOccurred = true;
errorTextArea.setText(ERROR_MESSAGE);
setError(ERROR_MESSAGE);
t.printStackTrace();
}

if (errorOccurred) {
errorPane.setVisible(true);
loggingIn.setVisible(false);
loginMain.setVisible(true);
loginProgress.setIndeterminate(false);
password.grabFocus();
}

return null;
}

private boolean handleSuccess(LoginStatus loginStatus) throws ClientException {
try {
PublicServerSettings publicServerSettings = client.getPublicServerSettings();

if (publicServerSettings.getLoginNotificationEnabled() == true) {
CustomBannerPanelDialog customBannerPanelDialog = new CustomBannerPanelDialog(LoginPanel.getInstance(), "Login Notification", publicServerSettings.getLoginNotificationMessage());
boolean isAccepted = customBannerPanelDialog.isAccepted();

if (isAccepted == true) {
client.setUserNotificationAcknowledged(client.getCurrentUser().getId());
}
else {
return false;
}
}

String environmentName = publicServerSettings.getEnvironmentName();
if (!StringUtils.isBlank(environmentName)) {
PlatformUI.ENVIRONMENT_NAME = environmentName;
}

String serverName = publicServerSettings.getServerName();
if (!StringUtils.isBlank(serverName)) {
PlatformUI.SERVER_NAME = serverName;
} else {
PlatformUI.SERVER_NAME = null;
}

Color defaultBackgroundColor = publicServerSettings.getDefaultAdministratorBackgroundColor();
if (defaultBackgroundColor != null) {
PlatformUI.DEFAULT_BACKGROUND_COLOR = defaultBackgroundColor;
}
} catch (ClientException e) {
PlatformUI.SERVER_NAME = null;
}

try {
String database = (String) client.getAbout().get("database");
if (!StringUtils.isBlank(database)) {
PlatformUI.SERVER_DATABASE = database;
} else {
PlatformUI.SERVER_DATABASE = null;
}
} catch (ClientException e) {
PlatformUI.SERVER_DATABASE = null;
}

try {
Map<String, String[]> map = client.getProtocolsAndCipherSuites();
PlatformUI.SERVER_HTTPS_SUPPORTED_PROTOCOLS = map.get(MirthSSLUtil.KEY_SUPPORTED_PROTOCOLS);
PlatformUI.SERVER_HTTPS_ENABLED_CLIENT_PROTOCOLS = map.get(MirthSSLUtil.KEY_ENABLED_CLIENT_PROTOCOLS);
PlatformUI.SERVER_HTTPS_ENABLED_SERVER_PROTOCOLS = map.get(MirthSSLUtil.KEY_ENABLED_SERVER_PROTOCOLS);
PlatformUI.SERVER_HTTPS_SUPPORTED_CIPHER_SUITES = map.get(MirthSSLUtil.KEY_SUPPORTED_CIPHER_SUITES);
PlatformUI.SERVER_HTTPS_ENABLED_CIPHER_SUITES = map.get(MirthSSLUtil.KEY_ENABLED_CIPHER_SUITES);
} catch (ClientException e) {
}

PlatformUI.USER_NAME = StringUtils.defaultString(loginStatus.getUpdatedUsername(), username.getText());
setStatus("Authenticated...");
new Mirth(client);
LoginPanel.getInstance().setVisible(false);

User currentUser = PlatformUI.MIRTH_FRAME.getCurrentUser(PlatformUI.MIRTH_FRAME);
Properties userPreferences = new Properties();
Set<String> preferenceNames = new HashSet<String>();
preferenceNames.add("firstlogin");
preferenceNames.add("checkForNotifications");
preferenceNames.add("showNotificationPopup");
preferenceNames.add("archivedNotifications");
try {
userPreferences = client.getUserPreferences(currentUser.getId(), preferenceNames);

// Display registration dialog if it's the user's first time logging in
String firstlogin = userPreferences.getProperty("firstlogin");
if (firstlogin == null || BooleanUtils.toBoolean(firstlogin)) {
if (Integer.valueOf(currentUser.getId()) == 1) {
// if current user is user 1:
// 1. check system preferences for user information
// 2. if system preferences exist, populate screen using currentUser
Preferences preferences = Preferences.userNodeForPackage(Mirth.class);
String systemUserInfo = preferences.get("userLoginInfo", null);
if (systemUserInfo != null) {
String info[] = systemUserInfo.split(",", 0);
currentUser.setUsername(info[0]);
currentUser.setFirstName(info[1]);
currentUser.setLastName(info[2]);
currentUser.setEmail(info[3]);
currentUser.setCountry(info[4]);
currentUser.setStateTerritory(info[5]);
currentUser.setPhoneNumber(info[6]);
currentUser.setOrganization(info[7]);
currentUser.setRole(info[8]);
currentUser.setIndustry(info[9]);
currentUser.setDescription(info[10]);
}
}
FirstLoginDialog firstLoginDialog = new FirstLoginDialog(currentUser);
// if leaving the first login dialog without saving
if (!firstLoginDialog.getResult()) {
return false;
}
} else if (loginStatus.getStatus() == LoginStatus.Status.SUCCESS_GRACE_PERIOD) {
new ChangePasswordDialog(currentUser, loginStatus.getMessage());
}

// Check for new notifications from update server if enabled
String checkForNotifications = userPreferences.getProperty("checkForNotifications");
if (CHECK_FOR_NOTIFICATIONS
&& (checkForNotifications == null || BooleanUtils.toBoolean(checkForNotifications))) {
Set<Integer> archivedNotifications = new HashSet<Integer>();
String archivedNotificationString = userPreferences.getProperty("archivedNotifications");
if (archivedNotificationString != null) {
archivedNotifications = ObjectXMLSerializer.getInstance().deserialize(archivedNotificationString, Set.class);
}
// Update the Other Tasks pane with the unarchived notification count
int unarchivedNotifications = ConnectServiceUtil.getNotificationCount(PlatformUI.SERVER_ID, PlatformUI.SERVER_VERSION, LoadedExtensions.getInstance().getExtensionVersions(), archivedNotifications, PlatformUI.HTTPS_PROTOCOLS, PlatformUI.HTTPS_CIPHER_SUITES);
PlatformUI.MIRTH_FRAME.updateNotificationTaskName(unarchivedNotifications);

// Display notification dialog if enabled and if there are new notifications
String showNotificationPopup = userPreferences.getProperty("showNotificationPopup");
if (showNotificationPopup == null || BooleanUtils.toBoolean(showNotificationPopup)) {
if (unarchivedNotifications > 0) {
new NotificationDialog();
}
}
}
} catch (ClientException e) {
PlatformUI.MIRTH_FRAME.alertThrowable(PlatformUI.MIRTH_FRAME, e);
}

PlatformUI.MIRTH_FRAME.sendUsageStatistics();

return true;
}

public void done() {}
};
worker.execute();
Expand All @@ -653,10 +487,20 @@ private void closeButtonActionPerformed(java.awt.event.ActionEvent evt)// GEN-FI
System.exit(0);
}// GEN-LAST:event_closeButtonActionPerformed

@Override
public void setStatus(String status) {
this.status.setText("Please wait: " + status);
}

public void setError(String status) {
errorTextArea.setText(status);
errorPane.setVisible(true);
loggingIn.setVisible(false);
loginMain.setVisible(true);
loginProgress.setIndeterminate(false);
password.grabFocus();
}

// Variables declaration - do not modify//GEN-BEGIN:variables
private javax.swing.JButton closeButton;
private javax.swing.JScrollPane errorPane;
Expand Down
23 changes: 23 additions & 0 deletions client/src/com/mirth/connect/client/ui/LoginPanelFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
package com.mirth.connect.client.ui;

/**
* Factory for obtaining the application's LoginPanel implementation.
*/
public class LoginPanelFactory {

private static AbstractLoginPanel provider = null;

public static synchronized AbstractLoginPanel getInstance() {
if (provider == null) {
provider = new LoginPanel();
}
return provider;
}

/**
* Replace the current provider. This is used to switch between login implementations at runtime.
*/
public static synchronized void setProvider(AbstractLoginPanel newProvider) {
provider = newProvider;
}
}
Loading