Skip to content

Decompose checkInstanceLocation into focused helper methods #4146

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

Draft
vogella wants to merge 2 commits into
base: master
Choose a base branch
from
+98 −72
Draft

Decompose checkInstanceLocation into focused helper methods #4146

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9580995
Simplify duplicated workspace-lock error handling in IDEApplication
vogella Jun 26, 2026
08c2b7d
Decompose checkInstanceLocation into focused helper methods
vogella Jun 26, 2026
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
170 changes: 98 additions & 72 deletions ...clipse.ui.ide.application/src/org/eclipse/ui/internal/ide/application/IDEApplication.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,55 +263,10 @@ protected Object checkInstanceLocation(Shell shell, Map applicationArguments) {
return EXIT_OK;
}
if (result == ReturnCode.VALID) {
// at this point its valid, so try to lock it and update the
// metadata version information if successful
try {
if (instanceLoc.lock()) {
writeWorkspaceVersion();
writeWsLockInfo(instanceLoc.getURL());
return null;
}

// we failed to create the directory.
// Two possibilities:
// 1. directory is already in use
// 2. directory could not be created
File workspaceDirectory = new File(instanceLoc.getURL().getFile());
if (workspaceDirectory.exists()) {
if (isDevLaunchMode(applicationArguments)) {
return EXIT_WORKSPACE_LOCKED;
}

// check if there is a lock info then append it to error message.
String lockInfo = WorkspaceLock.getWorkspaceLockDetails(instanceLoc.getURL());
if (lockInfo != null) {
hideSplash(shell);
WorkspaceLock.showWorkspaceLockedDialog(shell, workspaceDirectory.getAbsolutePath(),
lockInfo);
} else {
hideSplash(shell);
MessageDialog.openError(shell,
IDEWorkbenchMessages.IDEApplication_workspaceCannotBeSetTitle,
IDEWorkbenchMessages.IDEApplication_workspaceCannotBeSetMessage);
}
} else {
hideSplash(shell);
MessageDialog.openError(
shell,
IDEWorkbenchMessages.IDEApplication_workspaceCannotBeSetTitle,
IDEWorkbenchMessages.IDEApplication_workspaceCannotBeSetMessage);
}
} catch (IOException e) {
hideSplash(shell);
IDEWorkbenchPlugin.log("Could not obtain lock for workspace location", e); //$NON-NLS-1$
MessageDialog.openError(
shell,
IDEWorkbenchMessages.InternalError,
e.getMessage());
}
return EXIT_OK;
return lockExistingWorkspace(shell, instanceLoc, applicationArguments);
}
if (result == ReturnCode.INVALID) {
// prompt the user for a different location
force = true;
}
}
Expand All @@ -328,6 +283,71 @@ protected Object checkInstanceLocation(Shell shell, Map applicationArguments) {
}
}

return promptAndSetWorkspace(shell, instanceLoc, launchData, force);
}

/**
* Locks the already-set workspace and updates its metadata version.
*
* @return <code>null</code> if the workspace was locked successfully, or an
* exit code if locking failed and the application should terminate
*/
@SuppressWarnings("rawtypes")
private Object lockExistingWorkspace(Shell shell, Location instanceLoc, Map applicationArguments) {
// at this point its valid, so try to lock it and update the
// metadata version information if successful
try {
if (instanceLoc.lock()) {
writeWorkspaceVersion();
writeWsLockInfo(instanceLoc.getURL());
return null;
}

// we failed to create the directory.
// Two possibilities:
// 1. directory is already in use
// 2. directory could not be created
File workspaceDirectory = new File(instanceLoc.getURL().getFile());
boolean workspaceDirectoryExists = workspaceDirectory.exists();

// In dev (PDE) launch mode let the launcher report the locked workspace.
if (workspaceDirectoryExists && isDevLaunchMode(applicationArguments)) {
return EXIT_WORKSPACE_LOCKED;
}

// If the directory exists and carries lock info, show it; otherwise
// report that the workspace location could not be set.
String lockInfo = workspaceDirectoryExists
? WorkspaceLock.getWorkspaceLockDetails(instanceLoc.getURL())
: null;
hideSplash(shell);
if (lockInfo != null) {
WorkspaceLock.showWorkspaceLockedDialog(shell, workspaceDirectory.getAbsolutePath(), lockInfo);
} else {
MessageDialog.openError(shell,
IDEWorkbenchMessages.IDEApplication_workspaceCannotBeSetTitle,
IDEWorkbenchMessages.IDEApplication_workspaceCannotBeSetMessage);
}
} catch (IOException e) {
hideSplash(shell);
IDEWorkbenchPlugin.log("Could not obtain lock for workspace location", e); //$NON-NLS-1$
MessageDialog.openError(
shell,
IDEWorkbenchMessages.InternalError,
e.getMessage());
}
return EXIT_OK;
}

/**
* Repeatedly prompts the user for a workspace location until one is set, the
* user cancels, or a restart is required.
*
* @return <code>null</code> if a workspace was set successfully, or an exit
* code otherwise
*/
private Object promptAndSetWorkspace(Shell shell, Location instanceLoc, ChooseWorkspaceData launchData,
boolean force) {
int returnValue = -1;
URL workspaceUrl = null;
while (true) {
Expand Down Expand Up @@ -385,31 +405,7 @@ protected Object checkInstanceLocation(Shell shell, Map applicationArguments) {

// by this point it has been determined that the workspace is
// already in use -- force the user to choose again

String lockInfo = WorkspaceLock.getWorkspaceLockDetails(workspaceUrl);

MessageDialog dialog = new MessageDialog(null, IDEWorkbenchMessages.IDEApplication_workspaceInUseTitle,
null, NLS.bind(IDEWorkbenchMessages.IDEApplication_workspaceInUseMessage, workspaceUrl.getFile()),
MessageDialog.ERROR, 2, IDEWorkbenchMessages.IDEApplication_workspaceInUse_Retry,
IDEWorkbenchMessages.IDEApplication_workspaceInUse_Choose,
IDEWorkbenchMessages.IDEApplication_workspaceInUse_Cancel) {
@Override
protected Control createCustomArea(Composite parent) {
if (lockInfo == null || lockInfo.isBlank()) {
return null;
}

Composite container = new Composite(parent, SWT.NONE);
container.setLayout(new FillLayout());

Label multiLineText = new Label(container, SWT.NONE);
multiLineText.setText(NLS.bind(IDEWorkbenchMessages.IDEApplication_Ws_Lock_Owner_Message, lockInfo));

return container;
}
};
// the return value influences the next loop's iteration
returnValue = dialog.open();
returnValue = openWorkspaceInUseDialog(workspaceUrl);

if (returnValue == CANCEL_LAUNCH || returnValue == CANCEL_LAUNCH_DEFAULT) {
return EXIT_OK;
Expand All @@ -420,6 +416,36 @@ protected Control createCustomArea(Composite parent) {
}
}

/**
* Opens the "workspace in use" dialog and returns the index of the button the
* user selected.
*/
private int openWorkspaceInUseDialog(URL workspaceUrl) {
String lockInfo = WorkspaceLock.getWorkspaceLockDetails(workspaceUrl);

MessageDialog dialog = new MessageDialog(null, IDEWorkbenchMessages.IDEApplication_workspaceInUseTitle,
null, NLS.bind(IDEWorkbenchMessages.IDEApplication_workspaceInUseMessage, workspaceUrl.getFile()),
MessageDialog.ERROR, 2, IDEWorkbenchMessages.IDEApplication_workspaceInUse_Retry,
IDEWorkbenchMessages.IDEApplication_workspaceInUse_Choose,
IDEWorkbenchMessages.IDEApplication_workspaceInUse_Cancel) {
@Override
protected Control createCustomArea(Composite parent) {
if (lockInfo == null || lockInfo.isBlank()) {
return null;
}

Composite container = new Composite(parent, SWT.NONE);
container.setLayout(new FillLayout());

Label multiLineText = new Label(container, SWT.NONE);
multiLineText.setText(NLS.bind(IDEWorkbenchMessages.IDEApplication_Ws_Lock_Owner_Message, lockInfo));

return container;
}
};
return dialog.open();
}

/**
* Write lock owner details onto workspace lock file. Data includes user, host,
* display and current java process id.
Expand Down
Loading