Skip to content

Commit

Permalink
Improve workspace lock error dialog.
Browse files Browse the repository at this point in the history 
Write workspace lock info like user, host, java process id, display
properties onto a new file .lock_info if the lock was successful.
Read the current lock data in case of lock was unsuccessful and show it
in error dialog.
If the .lock_info does not exist or the file has no info then nothing is
shown. For older eclipse versions.

see #2343
  • Loading branch information
@raghucssit
raghucssit committed Oct 13, 2024
1 parent 1eead54 commit 987ceca
Show file tree
Hide file tree
Showing 3 changed files with 227 additions and 2 deletions.
217 changes: 215 additions & 2 deletions ...clipse.ui.ide.application/src/org/eclipse/ui/internal/ide/application/IDEApplication.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,11 @@
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.net.InetAddress;
import java.net.MalformedURLException;
import java.net.URL;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.Properties;
Expand All @@ -49,7 +52,11 @@
import org.eclipse.osgi.service.datalocation.Location;
import org.eclipse.osgi.util.NLS;
import org.eclipse.swt.SWT;
import org.eclipse.swt.layout.FillLayout;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.ui.IWorkbench;
import org.eclipse.ui.PlatformUI;
Expand Down Expand Up @@ -79,6 +86,22 @@ public class IDEApplication implements IApplication, IExecutableExtension {

private static final String VERSION_FILENAME = "version.ini"; //$NON-NLS-1$

private static final String LOCK_INFO_FILENAME = ".lock_info"; //$NON-NLS-1$

private static final String DISPLAY_VAR = "DISPLAY"; //$NON-NLS-1$

private static final String HOST_NAME_VAR = "HOSTNAME"; //$NON-NLS-1$

private static final String PROCESS_ID = "process-id"; //$NON-NLS-1$

private static final String DISPLAY = "display"; //$NON-NLS-1$

private static final String HOST = "host"; //$NON-NLS-1$

private static final String USER = "user"; //$NON-NLS-1$

private static final String USER_NAME = "user.name"; //$NON-NLS-1$

// Use the branding plug-in of the platform feature since this is most likely
// to change on an update of the IDE.
private static final String WORKSPACE_CHECK_REFERENCE_BUNDLE_NAME = "org.eclipse.platform"; //$NON-NLS-1$
Expand Down Expand Up @@ -225,6 +248,7 @@ protected Object checkInstanceLocation(Shell shell, Map applicationArguments) {
try {
if (instanceLoc.lock()) {
writeWorkspaceVersion();
writeWsLockInfo();
return null;
}

Expand All @@ -237,10 +261,19 @@ protected Object checkInstanceLocation(Shell shell, Map applicationArguments) {
if (isDevLaunchMode(applicationArguments)) {
return EXIT_WORKSPACE_LOCKED;
}

String wsLockedError = NLS.bind(IDEWorkbenchMessages.IDEApplication_workspaceCannotLockMessage,
workspaceDirectory.getAbsolutePath());
// check if there is a lock info then append it to error message.
String lockInfo = getWorkspaceLockInfo(instanceLoc.getURL());
if (lockInfo != null && !lockInfo.isBlank()) {
wsLockedError = wsLockedError + System.lineSeparator() + System.lineSeparator()
+ NLS.bind(IDEWorkbenchMessages.IDEApplication_Ws_Lock_Owner_Message, lockInfo);
}
MessageDialog.openError(
shell,
IDEWorkbenchMessages.IDEApplication_workspaceCannotLockTitle,
NLS.bind(IDEWorkbenchMessages.IDEApplication_workspaceCannotLockMessage, workspaceDirectory.getAbsolutePath()));
wsLockedError);
} else {
MessageDialog.openError(
shell,
Expand Down Expand Up @@ -313,6 +346,7 @@ protected Object checkInstanceLocation(Shell shell, Map applicationArguments) {
if (instanceLoc.set(workspaceUrl, true)) {
launchData.writePersistedData();
writeWorkspaceVersion();
writeWsLockInfo();
return null;
}
} catch (IllegalStateException e) {
Expand All @@ -332,17 +366,196 @@ 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 = getWorkspaceLockInfo(workspaceUrl);

MessageDialog dialog = new MessageDialog(null, IDEWorkbenchMessages.IDEApplication_workspaceInUseTitle,
null, NLS.bind(IDEWorkbenchMessages.IDEApplication_workspaceInUseMessage, workspaceUrl.getFile()),
MessageDialog.ERROR, 1, IDEWorkbenchMessages.IDEApplication_workspaceInUse_Retry,
IDEWorkbenchMessages.IDEApplication_workspaceInUse_Choose);
IDEWorkbenchMessages.IDEApplication_workspaceInUse_Choose) {
@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();
// Remember the locked workspace as recent workspace
launchData.writePersistedData();
}
}

/**
* Read workspace lock file and parse all the properties present. Based on the
* eclipse version and operating system some or all the properties may not
* present. In such scenario it will return empty string.
*
* @return Previous lock owner details.
*/
private String getWorkspaceLockInfo(URL workspaceUrl) {
File lockFile = getLockInfoFile(workspaceUrl, false);
if (lockFile == null) {
return null;
}
StringBuilder sb = new StringBuilder();
Properties props = new Properties();
try (FileInputStream is = new FileInputStream(lockFile)) {
props.load(is);
String prop = props.getProperty(USER);
if (prop != null) {
sb.append(NLS.bind(IDEWorkbenchMessages.IDEApplication_Ws_Lock_Owner_User, prop));
}
prop = props.getProperty(HOST);
if (prop != null) {
sb.append(NLS.bind(IDEWorkbenchMessages.IDEApplication_Ws_Lock_Owner_Host, prop));
}
prop = props.getProperty(DISPLAY);
if (prop != null) {
sb.append(NLS.bind(IDEWorkbenchMessages.IDEApplication_Ws_Lock_Owner_Disp, prop));
}
prop = props.getProperty(PROCESS_ID);
if (prop != null) {
sb.append(NLS.bind(IDEWorkbenchMessages.IDEApplication_Ws_Lock_Owner_P_Id, prop));
}
return sb.toString();
} catch (Exception e) {
IDEWorkbenchPlugin.log("Could not read lock file: ", e); //$NON-NLS-1$
}
return null;
}

/**
* Write lock owner details onto workspace lock file. Data includes user, host,
* display and current java process id.
*/
protected void writeWsLockInfo() {
Properties props = new Properties();

String user = System.getProperty(USER_NAME);
if (user != null) {
props.setProperty(USER, user);
}
String host = getHostName();
if (host != null) {
props.setProperty(HOST, host);
}
String display = getDisplay();
if (display != null) {
props.setProperty(DISPLAY, display);
}
String pid = getProcessId();
if (pid != null) {
props.setProperty(PROCESS_ID, pid);
}

if (props.isEmpty()) {
return;
}

Location instanceLoc = Platform.getInstanceLocation();
if (instanceLoc == null || instanceLoc.isReadOnly()) {
return;
}

File lockFile = getLockInfoFile(instanceLoc.getURL(), true);
if (lockFile == null) {
return;
}

if (lockFile == null || !lockFile.exists()) {
return;
}

try (OutputStream output = new FileOutputStream(lockFile)) {
props.store(output, null);
} catch (IOException e) {
IDEWorkbenchPlugin.log("Could not modify lock file", e); //$NON-NLS-1$
}
}

private String getDisplay() {
String displayEnv = null;
try {
displayEnv = System.getenv(DISPLAY_VAR);
} catch (Exception e) {
IDEWorkbenchPlugin.log("Failed to read DISPLAY variable.", e); //$NON-NLS-1$
}
return displayEnv;
}

private String getProcessId() {
Long pid = null;
try {
pid = ProcessHandle.current().pid();
} catch (Exception e) {
IDEWorkbenchPlugin.log("Failed to read Java process id.", e); //$NON-NLS-1$
}
return pid != null ? pid.toString() : null;
}

private String getHostName() {
String hostName = null;

// Try fast approach first. Some OS(Like Linux) has HOSTNAME environment
// variable set.
try {
hostName = System.getenv(HOST_NAME_VAR);
if (hostName != null && !hostName.isEmpty()) {
return hostName;
}
} catch (Exception e) {
// Ignore here because we will try another method in the next step.
}

try {
hostName = InetAddress.getLocalHost().getHostName();
} catch (Exception e) {
IDEWorkbenchPlugin.log("Failed to read host name.", e); //$NON-NLS-1$
}
return hostName;
}

/**
* Returns the .lock_info file if it is present or it will create new file.
*
* @param workspaceUrl
* @return Create .lock file if it does not present and return.
*/
private File getLockInfoFile(URL workspaceUrl, boolean create) {
if (workspaceUrl == null) {
return null;
}
Path lockInfoPath = Path.of(workspaceUrl.getPath(), METADATA_FOLDER, LOCK_INFO_FILENAME);

if (Files.exists(lockInfoPath)) {
return lockInfoPath.toFile();
}

try {
if (create) {
Path createdPath = Files.createFile(lockInfoPath);
if (createdPath != null) {
return createdPath.toFile();
}
}
} catch (IOException e) {
IDEWorkbenchPlugin.log("Failed to create workspace lock file.", e); //$NON-NLS-1$
return null;
}

return null;
}

@SuppressWarnings("rawtypes")
private static boolean isDevLaunchMode(Map args) {
// see org.eclipse.pde.internal.core.PluginPathFinder.isDevLaunchMode()
Expand Down
6 changes: 6 additions & 0 deletions bundles/org.eclipse.ui.ide/src/org/eclipse/ui/internal/ide/IDEWorkbenchMessages.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1147,6 +1147,12 @@ public class IDEWorkbenchMessages extends NLS {
public static String WorkbenchPreference_maxSimultaneousBuilds;
public static String WorkbenchPreference_maxSimultaneousBuildIntervalError;

public static String IDEApplication_Ws_Lock_Owner_User;
public static String IDEApplication_Ws_Lock_Owner_Host;
public static String IDEApplication_Ws_Lock_Owner_Disp;
public static String IDEApplication_Ws_Lock_Owner_P_Id;
public static String IDEApplication_Ws_Lock_Owner_Message;

static {
// load message values from bundle file
NLS.initializeMessages(BUNDLE_NAME, IDEWorkbenchMessages.class);
Expand Down
6 changes: 6 additions & 0 deletions bundles/org.eclipse.ui.ide/src/org/eclipse/ui/internal/ide/messages.properties
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1150,3 +1150,9 @@ OpenDelayedUrlAction_title=Open URL
editorAssociationOverride_error_couldNotCreate_message=The ''{0}'' extension from plug-in ''{1}'' to the ''org.eclipse.ui.ide.editorAssociationOverride'' extension point failed to load the editor association override class.
editorAssociationOverride_error_invalidElementName_message=An extension from plug-in ''{0}'' to the ''org.eclipse.ui.ide.editorAssociationOverride'' extension point was ignored because it contains the following invalid element: ''{1}''.
editorAssociationOverride_error_invalidExtension_message=The ''{0}'' extension from plug-in ''{1}'' to the ''org.eclipse.ui.ide.editorAssociationOverride'' extension point will be ignored because it contains invalid attributes.

IDEApplication_Ws_Lock_Owner_User=User:\t\t''{0}''\n
IDEApplication_Ws_Lock_Owner_Host=Host:\t\t''{0}''\n
IDEApplication_Ws_Lock_Owner_Disp=Display:\t\t''{0}''\n
IDEApplication_Ws_Lock_Owner_P_Id=Process ID:\t''{0}''\n
IDEApplication_Ws_Lock_Owner_Message=Workspace lock is currently held by:\n{0}

0 comments on commit 987ceca

Please sign in to comment.