/*******************************************************************************
* Copyright (c) 2000, 2015 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
* Sebastian Davids <sdavids@gmx.de> - 19346, 42056
* Remy Chi Jian Suen - bug 204879
* Serge Beauchamp (Freescale Semiconductor) - [229633] Group and Project Path Variable Support
* Helena Halperin (IBM) - bug #299212
*******************************************************************************/
package org.eclipse.ui.internal.ide.dialogs;
import java.net.URI;
import java.util.Set;
import org.eclipse.core.filesystem.IFileInfo;
import org.eclipse.core.filesystem.URIUtil;
import org.eclipse.core.resources.IPathVariableManager;
import org.eclipse.core.resources.IResource;
import org.eclipse.core.resources.ResourcesPlugin;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Path;
import org.eclipse.jface.dialogs.Dialog;
import org.eclipse.jface.dialogs.IDialogConstants;
import org.eclipse.jface.dialogs.IMessageProvider;
import org.eclipse.jface.dialogs.TitleAreaDialog;
import org.eclipse.osgi.util.TextProcessor;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.SelectionAdapter;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.DirectoryDialog;
import org.eclipse.swt.widgets.FileDialog;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.swt.widgets.Text;
import org.eclipse.ui.ide.dialogs.PathVariableSelectionDialog;
import org.eclipse.ui.internal.ide.IDEWorkbenchMessages;
/**
* Dialog that prompts the user for defining a variable's name and value. It
* supports creating a new variable or editing an existing one. The difference
* between the two uses is just a matter of which messages to present to the
* user and whether the "Ok" button starts enabled or not.
*/
public class PathVariableDialog extends TitleAreaDialog {
// UI widgets
private Button okButton;
private Label variableNameLabel;
private Label variableValueLabel;
private Label variableResolvedValueLabel;
private Text variableNameField;
private Text variableValueField;
private Label variableResolvedValueField;
private Button fileButton;
private Button folderButton;
private Button variableButton;
/**
* This dialog type: <code>NEW_VARIABLE</code> or
* <code>EXISTING_VARIABLE</code>.
*/
private int type;
/**
* The type of variable that can be edited in this dialog.
* <code>IResource.FILE</code> or <code>IResource.FOLDER</code>
*/
private int variableType;
/**
* The name of the variable being edited.
*/
private String variableName;
/**
* The value of the variable being edited.
*/
private String variableValue;
/**
* The original name of the variable being edited. It is used when testing
* if the current variable's name is already in use.
*/
private String originalName;
/**
* Used to select the proper message depending on the current mode
* (new/existing variable).
*/
private int operationMode = 0;
/**
* Reference to the path variable manager. It is used for validating
* variable names.
*/
private IPathVariableManager pathVariableManager;
/**
* Set of variable names currently in use. Used when warning the user that
* the currently selected name is already in use by another variable.
*/
private Set namesInUse;
/**
* The current validation status. Its value can be one of the following:<ul>
* <li><code>IMessageProvider.NONE</code> (default);</li>
* <li><code>IMessageProvider.WARNING</code>;</li>
* <li><code>IMessageProvider.ERROR</code>;</li>
* </ul>
* Used when validating the user input.
*/
private int validationStatus;
/**
* The current validation message generated by the last
* call to a <code>validate</code> method.
*/
private String validationMessage;
/**
* Whether a variable name has been entered.
*/
private boolean nameEntered = false;
/**
* Whether a variable location has been entered.
*/
private boolean locationEntered = false;
/**
* The standard message to be shown when there are no problems being
* reported.
*/
final private String standardMessage;
/**
* Constant for defining this dialog as intended to create a new variable
* (value = 1).
*/
public final static int NEW_VARIABLE = 1;
/**
* Constant for defining this dialog as intended to edit an existing
* variable (value = 2).
*/
public final static int EXISTING_VARIABLE = 2;
/**
* Constant for defining this dialog as intended to edit an existing link
* location (value = 3).
*/
public final static int EDIT_LINK_LOCATION = 3;
private IResource currentResource = null;
/**
* Constructs a dialog for editing a new/existing path variable.
*
* @param parentShell the parent shell
* @param type the dialog type: <code>NEW_VARIABLE</code> or
* <code>EXISTING_VARIABLE</code>
* @param variableType the type of variable that can be edited in
* this dialog. <code>IResource.FILE</code> or <code>IResource.FOLDER</code>
* @param pathVariableManager a reference to the path variable manager
* @param namesInUse a set of variable names currently in use
*/
public PathVariableDialog(Shell parentShell, int type, int variableType,
IPathVariableManager pathVariableManager, Set namesInUse) {
super(parentShell);
this.type = type;
this.operationMode = type;
this.variableName = ""; //$NON-NLS-1$
this.variableValue = ""; //$NON-NLS-1$
this.variableType = variableType;
this.pathVariableManager = pathVariableManager;
this.namesInUse = namesInUse;
if (operationMode == NEW_VARIABLE)
this.standardMessage = IDEWorkbenchMessages.PathVariableDialog_message_newVariable;
else if (operationMode == EXISTING_VARIABLE)
this.standardMessage = IDEWorkbenchMessages.PathVariableDialog_message_existingVariable;
else
this.standardMessage = IDEWorkbenchMessages.PathVariableDialog_message_editLocation;
}
/**
* Configures this dialog's shell, setting the shell's text.
*
* @see org.eclipse.jface.window.Window#configureShell(Shell)
*/
@Override
protected void configureShell(Shell shell) {
super.configureShell(shell);
if (operationMode == NEW_VARIABLE)
shell.setText(IDEWorkbenchMessages.PathVariableDialog_shellTitle_newVariable);
else if (operationMode == EXISTING_VARIABLE)
shell.setText(IDEWorkbenchMessages.PathVariableDialog_shellTitle_existingVariable);
else
shell.setText(IDEWorkbenchMessages.PathVariableDialog_shellTitle_editLocation);
}
/**
* Creates and returns the contents of this dialog (except for the button bar).
*
* @see org.eclipse.jface.dialogs.TitleAreaDialog#createDialogArea
*/
@Override
protected Control createDialogArea(Composite parent) {
// top level composite
Composite parentComposite = (Composite) super.createDialogArea(parent);
initializeDialogUnits(parentComposite);
// creates dialog area composite
Composite contents = createComposite(parentComposite);
// creates and lay outs dialog area widgets
createWidgets(contents);
// validate possibly already incorrect variable definitions
if (type == EXISTING_VARIABLE) {
nameEntered = locationEntered = true;
validateVariableValue();
}
Dialog.applyDialogFont(parentComposite);
return contents;
}
/**
* Creates and configures this dialog's main composite.
*
* @param parentComposite parent's composite
* @return this dialog's main composite
*/
private Composite createComposite(Composite parentComposite) {
// creates a composite with standard margins and spacing
Composite contents = new Composite(parentComposite, SWT.NONE);
contents.setLayout(new GridLayout(3, false));
contents.setLayoutData(new GridData(GridData.FILL_BOTH));
if (operationMode == NEW_VARIABLE)
setTitle(IDEWorkbenchMessages.PathVariableDialog_dialogTitle_newVariable);
else if (operationMode == EXISTING_VARIABLE)
setTitle(IDEWorkbenchMessages.PathVariableDialog_dialogTitle_existingVariable);
else
setTitle(IDEWorkbenchMessages.PathVariableDialog_dialogTitle_editLinkLocation);
setMessage(standardMessage);
return contents;
}
/**
* Creates widgets for this dialog.
*
* @param contents the parent composite where to create widgets
*/
private void createWidgets(Composite contents) {
String nameLabelText = IDEWorkbenchMessages.PathVariableDialog_variableName;
String valueLabelText = IDEWorkbenchMessages.PathVariableDialog_variableValue;
String resolvedValueLabelText = IDEWorkbenchMessages.PathVariableDialog_variableResolvedValue;
if (operationMode != EDIT_LINK_LOCATION) {
// variable name label
variableNameLabel = new Label(contents, SWT.LEAD);
variableNameLabel.setText(nameLabelText);
variableNameLabel.setLayoutData(new GridData(SWT.LEFT, SWT.CENTER, false, false));
// variable name field. Attachments done after all widgets created.
variableNameField = new Text(contents, SWT.SINGLE | SWT.BORDER);
variableNameField.setText(variableName);
variableNameField.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, true,
false, 2, 1));
variableNameField.addModifyListener(event -> variableNameModified());
}
// variable value label
variableValueLabel = new Label(contents, SWT.LEAD);
variableValueLabel.setText(valueLabelText);
variableValueLabel.setLayoutData(new GridData(SWT.LEFT, SWT.CENTER, false, false));
// variable value field. Attachments done after all widgets created.
variableValueField = new Text(contents, SWT.SINGLE | SWT.BORDER);
variableValueField.setText(variableValue);
variableValueField.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, true,
false));
variableValueField.addModifyListener(event -> variableValueModified());
Composite buttonsComposite = new Composite(contents, SWT.NONE);
buttonsComposite.setLayoutData(new GridData(SWT.END, SWT.CENTER, false,
false, 1, 1));
GridLayout layout = new GridLayout(0, true);
layout.marginWidth = 0;
layout.marginHeight = 0;
buttonsComposite.setLayout(layout);
if ((variableType & IResource.FILE) != 0) {
layout.numColumns++;
// select file path button
fileButton = new Button(buttonsComposite, SWT.PUSH);
fileButton.setText(IDEWorkbenchMessages.PathVariableDialog_file);
fileButton.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, false,
false));
fileButton.addSelectionListener(new SelectionAdapter() {
@Override
public void widgetSelected(SelectionEvent e) {
selectFile();
}
});
setButtonLayoutData(fileButton);
}
if ((variableType & IResource.FOLDER) != 0) {
layout.numColumns++;
// select folder path button
folderButton = new Button(buttonsComposite, SWT.PUSH);
folderButton.setText(IDEWorkbenchMessages.PathVariableDialog_folder);
folderButton.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, false,
false));
folderButton.addSelectionListener(new SelectionAdapter() {
@Override
public void widgetSelected(SelectionEvent e) {
selectFolder();
}
});
setButtonLayoutData(folderButton);
}
// the workspace path variable manager does not support variables.
if (currentResource != null) {
layout.numColumns++;
variableButton = new Button(buttonsComposite, SWT.PUSH);
variableButton.setText(IDEWorkbenchMessages.PathVariableDialog_variable);
variableButton.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, false,
false));
variableButton.addSelectionListener(new SelectionAdapter() {
@Override
public void widgetSelected(SelectionEvent e) {
selectVariable();
}
});
setButtonLayoutData(variableButton);
// variable value label
variableResolvedValueLabel = new Label(contents, SWT.LEAD);
variableResolvedValueLabel.setText(resolvedValueLabelText);
// variable value field. Attachments done after all widgets created.
variableResolvedValueField = new Label(contents, SWT.LEAD | SWT.SINGLE | SWT.READ_ONLY);
variableResolvedValueField.setText(TextProcessor.process(getVariableResolvedValue()));
variableResolvedValueField.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, true,
false, 2, 1));
}
}
private IPathVariableManager getPathVariableManager() {
if (currentResource != null)
return currentResource.getPathVariableManager();
return ResourcesPlugin.getWorkspace().getPathVariableManager();
}
private String getVariableResolvedValue() {
if (currentResource != null) {
IPathVariableManager pathVariableManager2 = currentResource.getPathVariableManager();
String[] variables = pathVariableManager2.getPathVariableNames();
String internalFormat = pathVariableManager2.convertFromUserEditableFormat(variableValue, operationMode == EDIT_LINK_LOCATION);
URI uri = URIUtil.toURI(Path.fromOSString(internalFormat));
URI resolvedURI = pathVariableManager2.resolveURI(uri);
String resolveValue = URIUtil.toPath(resolvedURI).toOSString();
// Delete intermediate variables that might have been created as
// as a side effect of converting arbitrary relative paths to an internal string.
for (String newVariable : pathVariableManager2.getPathVariableNames()) {
boolean found = false;
for (String variable : variables) {
if (variable.equals(newVariable)) {
found = true;
break;
}
}
if (!found) {
try {
pathVariableManager2.setURIValue(newVariable, null);
} catch (CoreException e) {
// do nothing
}
}
}
return resolveValue;
}
return variableValue;
}
/**
* Fires validations (variable name first) and updates enabled state for the
* "Ok" button accordingly.
*/
private void variableNameModified() {
// updates and validates the variable name
variableName = variableNameField.getText();
validationStatus = IMessageProvider.NONE;
okButton.setEnabled(validateVariableName() && validateVariableValue() && variableValue.length() != 0);
nameEntered = true;
}
/**
* Fires validations (variable value first) and updates enabled state for the
* "Ok" button accordingly.
*/
private void variableValueModified() {
// updates and validates the variable value
variableValue = variableValueField.getText().trim();
validationStatus = IMessageProvider.NONE;
okButton.setEnabled(validateVariableValue() && validateVariableName());
locationEntered = true;
if (variableResolvedValueField != null)
variableResolvedValueField.setText(TextProcessor.process(getVariableResolvedValue()));
}
/**
* Opens a dialog where the user can select a folder path.
*/
private void selectFolder() {
DirectoryDialog dialog = new DirectoryDialog(getShell(), SWT.SHEET);
dialog.setText(IDEWorkbenchMessages.PathVariableDialog_selectFolderTitle);
dialog.setMessage(IDEWorkbenchMessages.PathVariableDialog_selectFolderMessage);
String filterPath = getVariableResolvedValue();
dialog.setFilterPath(filterPath);
String res = dialog.open();
if (res != null) {
variableValue = new Path(res).makeAbsolute().toOSString();
variableValueField.setText(variableValue);
}
}
/**
* Opens a dialog where the user can select a file path.
*/
private void selectFile() {
FileDialog dialog = new FileDialog(getShell(), SWT.SHEET);
dialog.setText(IDEWorkbenchMessages.PathVariableDialog_selectFileTitle);
String filterPath = getVariableResolvedValue();
dialog.setFilterPath(filterPath);
String res = dialog.open();
if (res != null) {
variableValue = new Path(res).makeAbsolute().toOSString();
variableValueField.setText(variableValue);
}
}
private void selectVariable() {
PathVariableSelectionDialog dialog = new PathVariableSelectionDialog(
getShell(), IResource.FILE | IResource.FOLDER);
dialog.setResource(currentResource);
if (dialog.open() == IDialogConstants.OK_ID) {
String[] variableNames = (String[]) dialog.getResult();
if (variableNames != null && variableNames.length == 1) {
String newValue = variableNames[0];
IPath path = Path.fromOSString(newValue);
if (operationMode != EDIT_LINK_LOCATION && currentResource != null && !path.isAbsolute() && path.segmentCount() > 0) {
path = buildVariableMacro(path);
newValue = path.toOSString();
}
variableValue = newValue;
variableValueField.setText(newValue);
}
}
}
private IPath buildVariableMacro(IPath relativeSrcValue) {
String variable = relativeSrcValue.segment(0);
variable = "${" + variable + "}"; //$NON-NLS-1$//$NON-NLS-2$
return Path.fromOSString(variable).append(relativeSrcValue.removeFirstSegments(1));
}
/**
* Adds buttons to this dialog's button bar.
*
* @see org.eclipse.jface.dialogs.Dialog#createButtonsForButtonBar
*/
@Override
protected void createButtonsForButtonBar(Composite parent) {
okButton = createButton(parent, IDialogConstants.OK_ID,
IDialogConstants.OK_LABEL, true);
okButton.setEnabled(type == EXISTING_VARIABLE);
createButton(parent, IDialogConstants.CANCEL_ID,
IDialogConstants.CANCEL_LABEL, false);
}
/**
* Validates the current variable name, and updates this dialog's message.
*
* @return true if the name is valid, false otherwise
*/
private boolean validateVariableName() {
boolean allowFinish = false;
if (operationMode == EDIT_LINK_LOCATION)
return true;
// if the current validationStatus is ERROR, no additional validation applies
if (validationStatus == IMessageProvider.ERROR) {
return false;
}
// assumes everything will be ok
String message = standardMessage;
int newValidationStatus = IMessageProvider.NONE;
if (variableName.length() == 0) {
// the variable name is empty
if (nameEntered) {
// a name was entered before and is now empty
newValidationStatus = IMessageProvider.ERROR;
message = IDEWorkbenchMessages.PathVariableDialog_variableNameEmptyMessage;
}
} else {
IStatus status = pathVariableManager.validateName(variableName);
if (!status.isOK()) {
// the variable name is not valid
newValidationStatus = IMessageProvider.ERROR;
message = status.getMessage();
} else if (namesInUse.contains(variableName)
&& !variableName.equals(originalName)) {
// the variable name is already in use
message = IDEWorkbenchMessages.PathVariableDialog_variableAlreadyExistsMessage;
newValidationStatus = IMessageProvider.ERROR;
} else {
allowFinish = true;
}
}
// overwrite the current validation status / message only if everything is ok (clearing them)
// or if we have a more serious problem than the current one
if (validationStatus == IMessageProvider.NONE
|| newValidationStatus == IMessageProvider.ERROR) {
validationStatus = newValidationStatus;
validationMessage = message;
}
// only set the message here if it is not going to be set in
// validateVariableValue to avoid flashing.
if (allowFinish == false) {
setMessage(validationMessage, validationStatus);
}
return allowFinish;
}
/**
* Validates the current variable value, and updates this dialog's message.
*
* @return true if the value is valid, false otherwise
*/
private boolean validateVariableValue() {
boolean allowFinish = false;
// if the current validationStatus is ERROR, no additional validation applies
if (validationStatus == IMessageProvider.ERROR) {
return false;
}
// assumes everything will be ok
String message = standardMessage;
int newValidationStatus = IMessageProvider.NONE;
if (variableValue.length() == 0) {
// the variable value is empty
if (locationEntered) {
// a location value was entered before and is now empty
newValidationStatus = IMessageProvider.ERROR;
message = IDEWorkbenchMessages.PathVariableDialog_variableValueEmptyMessage;
}
}
if (currentResource != null) {
// While editing project path variables, the variable value can
// contain macros such as "${foo}\etc"
allowFinish = true;
String resolvedValue = getVariableResolvedValue();
IPath resolvedPath = Path.fromOSString(resolvedValue);
if (!IDEResourceInfoUtils.exists(resolvedPath.toOSString())) {
// the path does not exist (warning)
message = IDEWorkbenchMessages.PathVariableDialog_pathDoesNotExistMessage;
newValidationStatus = IMessageProvider.WARNING;
} else {
IFileInfo info = IDEResourceInfoUtils.getFileInfo(resolvedPath
.toOSString());
if ((info.isDirectory() && ((variableType & IResource.FOLDER) == 0)) ||
(!info.isDirectory() && ((variableType & IResource.FILE) == 0))){
allowFinish = false;
newValidationStatus = IMessageProvider.ERROR;
if (((variableType & IResource.FOLDER) != 0))
message = IDEWorkbenchMessages.PathVariableDialog_variableValueIsWrongTypeFolder;
else
message = IDEWorkbenchMessages.PathVariableDialog_variableValueIsWrongTypeFile;
}
}
} else if (!Path.EMPTY.isValidPath(variableValue)) {
// the variable value is an invalid path
message = IDEWorkbenchMessages.PathVariableDialog_variableValueInvalidMessage;
newValidationStatus = IMessageProvider.ERROR;
} else if (!new Path(variableValue).isAbsolute()) {
// the variable value is a relative path
message = IDEWorkbenchMessages.PathVariableDialog_pathIsRelativeMessage;
newValidationStatus = IMessageProvider.ERROR;
} else if (!IDEResourceInfoUtils.exists(variableValue)) {
// the path does not exist (warning)
message = IDEWorkbenchMessages.PathVariableDialog_pathDoesNotExistMessage;
newValidationStatus = IMessageProvider.WARNING;
allowFinish = true;
} else {
allowFinish = true;
}
// overwrite the current validation status / message only if everything is ok (clearing them)
// or if we have a more serious problem than the current one
if (validationStatus == IMessageProvider.NONE
|| newValidationStatus > validationStatus) {
validationStatus = newValidationStatus;
validationMessage = message;
}
setMessage(validationMessage, validationStatus);
return allowFinish;
}
/**
* Returns the variable name.
*
* @return the variable name
*/
public String getVariableName() {
return variableName;
}
/**
* Returns the variable value.
*
* @return the variable value
*/
public String getVariableValue() {
if (currentResource != null) {
String internalFormat = getPathVariableManager().convertFromUserEditableFormat(variableValue, operationMode == EDIT_LINK_LOCATION);
return internalFormat;
}
return variableValue;
}
/**
* Sets the variable name.
*
* @param variableName the new variable name
*/
public void setVariableName(String variableName) {
this.variableName = variableName.trim();
this.originalName = this.variableName;
}
/**
* Sets the variable value.
*
* @param variable the new variable value
*/
public void setVariableValue(String variable) {
String userEditableString = getPathVariableManager().convertToUserEditableFormat(variable, operationMode == EDIT_LINK_LOCATION);
variableValue = userEditableString;
}
/**
* @param resource
*/
public void setResource(IResource resource) {
currentResource = resource;
}
/**
* @param location
*/
public void setLinkLocation(IPath location) {
String userEditableString = getPathVariableManager().convertToUserEditableFormat(location.toOSString(), operationMode == EDIT_LINK_LOCATION);
variableValue = userEditableString;
}
@Override
protected boolean isResizable() {
return true;
}
}