/*
* $Id: RunJettyRunTab.java 39 2009-05-03 22:38:57Z james.synge@gmail.com $
* $HeadURL: https://run-jetty-run.googlecode.com/svn/trunk/plugin/src/runjettyrun/RunJettyRunTab.java $
*
* ==============================================================================
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
package runjettyrun;
import static org.eclipse.jdt.launching.IJavaLaunchConfigurationConstants.ATTR_PROJECT_NAME;
import java.io.File;
import java.text.MessageFormat;
import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IFolder;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.resources.IResource;
import org.eclipse.core.resources.IWorkspace;
import org.eclipse.core.resources.IWorkspaceRoot;
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.debug.core.ILaunchConfiguration;
import org.eclipse.debug.core.ILaunchConfigurationWorkingCopy;
import org.eclipse.jdt.core.IJavaElement;
import org.eclipse.jdt.core.IJavaProject;
import org.eclipse.jdt.core.JavaCore;
import org.eclipse.jdt.core.JavaModelException;
import org.eclipse.jdt.debug.ui.launchConfigurations.JavaLaunchTab;
import org.eclipse.jdt.launching.IJavaLaunchConfigurationConstants;
import org.eclipse.jdt.ui.JavaElementLabelProvider;
import org.eclipse.jface.viewers.ILabelProvider;
import org.eclipse.jface.window.Window;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.ModifyEvent;
import org.eclipse.swt.events.ModifyListener;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.events.SelectionListener;
import org.eclipse.swt.graphics.Font;
import org.eclipse.swt.graphics.GC;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.graphics.Point;
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.FileDialog;
import org.eclipse.swt.widgets.Group;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Text;
import org.eclipse.ui.dialogs.ContainerSelectionDialog;
import org.eclipse.ui.dialogs.ElementListSelectionDialog;
/**
* Launch tab for the RunJettyRun plugin.
*
* @author hillenius, James Synge
*/
public class RunJettyRunTab extends JavaLaunchTab {
private static abstract class ButtonListener implements SelectionListener {
public void widgetDefaultSelected(SelectionEvent e) {
}
}
private Text fProjText;
private Button fProjButton;
private Text fPortText;
private Text fSSLPortText;
private Text fKeystoreText;
private Button fKeystoreButton;
private Text fKeyPasswordText;
private Text fPasswordText;
private Text fContextText;
private Text fWebAppDirText;
private Button fWebappDirButton;
/**
* Construct.
*/
public RunJettyRunTab() {
}
public void createControl(Composite parent) {
Composite comp = new Composite(parent, SWT.NONE);
comp.setFont(parent.getFont());
GridData gd = new GridData(1);
gd.horizontalSpan = GridData.FILL_BOTH;
comp.setLayoutData(gd);
GridLayout layout = new GridLayout(1, false);
layout.verticalSpacing = 0;
comp.setLayout(layout);
createProjectEditor(comp);
createVerticalSpacer(comp, 1);
createPortEditor(comp);
createVerticalSpacer(comp, 1);
createJettyOptionsEditor(comp);
createVerticalSpacer(comp, 1);
setControl(comp);
// PlatformUI.getWorkbench().getHelpSystem().setHelp(getControl(),
// IJavaDebugHelpContextIds.LAUNCH_CONFIGURATION_DIALOG_MAIN_TAB);
return;
}
/**
* Creates the widgets for specifying a main type.
*
* @param parent
* the parent composite
*/
private void createProjectEditor(Composite parent) {
Font font = parent.getFont();
Group group = new Group(parent, SWT.NONE);
group.setText("Project");
GridData gd = createHFillGridData();
group.setLayoutData(gd);
GridLayout layout = new GridLayout();
layout.numColumns = 2;
group.setLayout(layout);
group.setFont(font);
fProjText = new Text(group, SWT.SINGLE | SWT.BORDER);
gd = createHFillGridData();
fProjText.setLayoutData(gd);
fProjText.setFont(font);
fProjText.addModifyListener(new ModifyListener() {
public void modifyText(ModifyEvent e) {
updateLaunchConfigurationDialog();
}
});
fProjButton = createPushButton(group, "&Browse...", null);
fProjButton.addSelectionListener(new ButtonListener() {
public void widgetSelected(SelectionEvent e) {
handleProjectButtonSelected();
}
});
}
private GridData createHFillGridData() {
GridData gd = new GridData();
gd.horizontalAlignment = SWT.FILL;
gd.grabExcessHorizontalSpace = true;
return gd;
}
/**
* Creates the widgets for specifying the ports:
*
* HTTP Port: Text....... HTTPS Port: Text.......
* Keystore: Text.................. Browse Button
* Store Password: Text.. Key Password: Text.....
*
* @param parent
* the parent composite
*/
private void createPortEditor(Composite parent) {
// Create group, container for widgets
Font font = parent.getFont();
Group group = new Group(parent, SWT.NONE);
group.setText("Ports");
GridData gd = createHFillGridData();
group.setLayoutData(gd);
GridLayout layout = new GridLayout();
layout.numColumns = 4;
group.setLayout(layout);
group.setFont(font);
// HTTP and HTTPS ports
new Label(group, SWT.LEFT).setText("HTTP");
fPortText = new Text(group, SWT.SINGLE | SWT.BORDER);
fPortText.addModifyListener(new ModifyListener() {
public void modifyText(ModifyEvent e) {
updateLaunchConfigurationDialog();
}
});
gd = createHFillGridData();
fPortText.setLayoutData(gd);
fPortText.setFont(font);
fPortText.setTextLimit(5);
setWidthForSampleText(fPortText, " 65535 ");
Label lbl = new Label(group, SWT.LEFT);
lbl.setText("HTTPS");
gd = new GridData();
gd.horizontalAlignment = SWT.RIGHT;
lbl.setLayoutData(gd);
fSSLPortText = new Text(group, SWT.SINGLE | SWT.BORDER);
fSSLPortText.addModifyListener(new ModifyListener() {
public void modifyText(ModifyEvent e) {
if (fSSLPortText.getText().trim().length() == 0) {
setKeystoreEnabled(false);
}
else {
setKeystoreEnabled(true);
}
updateLaunchConfigurationDialog();
}
});
gd = createHFillGridData();
fSSLPortText.setLayoutData(gd);
fSSLPortText.setFont(font);
// keystore
new Label(group, SWT.LEFT).setText("Keystore");
fKeystoreText = new Text(group, SWT.SINGLE | SWT.BORDER);
fKeystoreText.addModifyListener(new ModifyListener() {
public void modifyText(ModifyEvent e) {
updateLaunchConfigurationDialog();
}
});
gd = createHFillGridData();
gd.horizontalSpan = 2;
fKeystoreText.setLayoutData(gd);
fKeystoreText.setFont(font);
fKeystoreText.setEnabled(false);
fKeystoreButton = createPushButton(group, "&Browse...", null);
fKeystoreButton.addSelectionListener(new ButtonListener() {
public void widgetSelected(SelectionEvent e) {
handleBrowseFileSystem();
}
});
fKeystoreButton.setEnabled(false);
gd = new GridData();
fKeystoreButton.setLayoutData(gd);
// Password and Key Password (not sure exactly how used by keystore)
new Label(group, SWT.LEFT).setText("Password");
fPasswordText = new Text(group, SWT.SINGLE | SWT.BORDER);
fPasswordText.addModifyListener(new ModifyListener() {
public void modifyText(ModifyEvent e) {
updateLaunchConfigurationDialog();
}
});
gd = createHFillGridData();
fPasswordText.setLayoutData(gd);
fPasswordText.setFont(font);
fPasswordText.setEnabled(false);
new Label(group, SWT.LEFT).setText("Key Password");
fKeyPasswordText = new Text(group, SWT.SINGLE | SWT.BORDER);
fKeyPasswordText.addModifyListener(new ModifyListener() {
public void modifyText(ModifyEvent e) {
updateLaunchConfigurationDialog();
}
});
gd = createHFillGridData();
fKeyPasswordText.setLayoutData(gd);
fKeyPasswordText.setFont(font);
fKeyPasswordText.setEnabled(false);
return;
}
private void setWidthForSampleText(Text control, String sampleText)
{
GC gc = new GC (control);
try {
Point sampleSize = gc.textExtent (sampleText);
Point currentSize = control.getSize();
sampleSize.y = currentSize.y;
control.setSize(sampleSize);
return;
}
finally {
gc.dispose ();
}
}
/**
* Creates the widgets for specifying the directory, context and port for
* the web application.
*
* @param parent
* the parent composite
*/
private void createJettyOptionsEditor(Composite parent) {
Font font = parent.getFont();
Group group = new Group(parent, SWT.NONE);
group.setText("Web Application");
GridData gd = createHFillGridData();
group.setLayoutData(gd);
GridLayout layout = new GridLayout();
layout.numColumns = 3;
group.setLayout(layout);
group.setFont(font);
// Row 1: "Context", Text field (2 columns)
new Label(group, SWT.LEFT).setText("Context");
fContextText = new Text(group, SWT.SINGLE | SWT.BORDER);
fContextText.addModifyListener(new ModifyListener() {
public void modifyText(ModifyEvent e) {
updateLaunchConfigurationDialog();
}
});
gd = createHFillGridData();
gd.horizontalSpan = 2;
fContextText.setLayoutData(gd);
fContextText.setFont(font);
// Row 2: "WebApp dir", Text field, "Browse..." Button
new Label(group, SWT.LEFT).setText("WebApp dir");
fWebAppDirText = new Text(group, SWT.SINGLE | SWT.BORDER);
fWebAppDirText.addModifyListener(new ModifyListener() {
public void modifyText(ModifyEvent e) {
updateLaunchConfigurationDialog();
}
});
gd = createHFillGridData();
fWebAppDirText.setLayoutData(gd);
fWebAppDirText.setFont(font);
fWebappDirButton = createPushButton(group, "&Browse...", null);
fWebappDirButton.addSelectionListener(new ButtonListener() {
public void widgetSelected(SelectionEvent e) {
chooseWebappDir();
}
});
fWebappDirButton.setEnabled(false);
gd = new GridData();
fWebappDirButton.setLayoutData(gd);
return;
}
@Override
public Image getImage() {
return Plugin.getJettyIcon();
}
@Override
public String getMessage() {
return "Create a configuration to launch a web application with Jetty.";
}
public String getName() {
return "Jetty";
}
protected void setKeystoreEnabled(boolean b) {
fKeystoreText.setEnabled(b);
fKeystoreButton.setEnabled(b);
fPasswordText.setEnabled(b);
fKeyPasswordText.setEnabled(b);
return;
}
public void initializeFrom(ILaunchConfiguration configuration) {
super.initializeFrom(configuration);
try {
fProjText.setText(configuration.getAttribute(ATTR_PROJECT_NAME, ""));
fPortText.setText(configuration.getAttribute(Plugin.ATTR_PORT, ""));
fSSLPortText.setText(configuration.getAttribute(Plugin.ATTR_SSL_PORT, ""));
fKeystoreText.setText(configuration.getAttribute(Plugin.ATTR_KEYSTORE, ""));
fPasswordText.setText(configuration.getAttribute(Plugin.ATTR_PWD, ""));
fKeyPasswordText.setText(configuration.getAttribute(Plugin.ATTR_KEY_PWD, ""));
fContextText.setText(configuration.getAttribute(Plugin.ATTR_CONTEXT, ""));
fWebAppDirText.setText(configuration.getAttribute(Plugin.ATTR_WEBAPPDIR, ""));
} catch (CoreException e) {
Plugin.logError(e);
}
}
public boolean isValid(ILaunchConfiguration config) {
setErrorMessage(null);
setMessage(null);
String projectName = fProjText.getText().trim();
IProject project = null;
if (projectName.length() > 0) {
IWorkspace workspace = ResourcesPlugin.getWorkspace();
IStatus status = workspace.validateName(projectName,
IResource.PROJECT);
if (status.isOK()) {
project = ResourcesPlugin.getWorkspace().getRoot().getProject(
projectName);
if (!project.exists()) {
setErrorMessage(MessageFormat.format(
"Project {0} does not exist", projectName));
fWebappDirButton.setEnabled(false);
return false;
}
if (!project.isOpen()) {
setErrorMessage(MessageFormat.format(
"Project {0} is closed", projectName));
fWebappDirButton.setEnabled(false);
return false;
}
} else {
setErrorMessage(MessageFormat.format(
"Illegal project name: {0}", status.getMessage()));
fWebappDirButton.setEnabled(false);
return false;
}
fWebappDirButton.setEnabled(true);
} else {
setErrorMessage("No project selected");
return false;
}
String directory = fWebAppDirText.getText().trim();
if (!"".equals(directory.trim())) {
IFolder folder = project.getFolder(directory);
if (!folder.exists()) {
setErrorMessage(MessageFormat.format(
"Folder {0} does not exist in project {1}", directory,
project.getName()));
return false;
}
IFile file = project.getFile(new Path(directory
+ "/WEB-INF/web.xml"));
if (!file.exists()) {
setErrorMessage(MessageFormat
.format(
"Directory {0} does not contain WEB-INF/web.xml; it is not a valid web application directory",
directory));
return false;
}
} else {
setErrorMessage("Web application directory is not set");
return false;
}
String port = fPortText.getText().trim();
String sslPort = fSSLPortText.getText().trim();
if (port.length() == 0 && sslPort.length() == 0)
{
setErrorMessage("Must specify at least one port");
return false;
}
if (isInvalidPort(port))
return false;
if (isInvalidPort(sslPort))
return false;
if (sslPort.length() > 0)
{
// Validate that we have the necessary key store info.
String keystore = fKeystoreText.getText().trim();
String keyPwd = fKeyPasswordText.getText().trim();
String password = fPasswordText.getText().trim();
if (keystore.length() == 0)
{
setErrorMessage("Keystore location is not set");
return false;
}
else if (!new File(keystore).isFile())
{
setErrorMessage(MessageFormat
.format(
"Keystore file {0} does not exist",
keystore));
return false;
}
if (keyPwd.length() == 0)
{
setErrorMessage("Key Password is not set");
return false;
}
if (password.length() == 0)
{
setErrorMessage("Password is not set");
return false;
}
}
return true;
}
private boolean isInvalidPort(String s)
{
if (s.length() == 0)
return false;
try {
int p = Integer.parseInt(s);
if (1 <= p && p <= 65535)
return false;
}
catch (NumberFormatException e) {
}
setErrorMessage(MessageFormat.format("Not a valid TCP port number: {0}", s));
return true;
}
public void performApply(ILaunchConfigurationWorkingCopy configuration) {
configuration.setAttribute(ATTR_PROJECT_NAME, fProjText.getText());
configuration.setAttribute(Plugin.ATTR_PORT, fPortText.getText());
configuration.setAttribute(Plugin.ATTR_SSL_PORT, fSSLPortText.getText());
configuration.setAttribute(Plugin.ATTR_KEYSTORE, fKeystoreText.getText());
configuration.setAttribute(Plugin.ATTR_PWD, fPasswordText.getText());
configuration.setAttribute(Plugin.ATTR_KEY_PWD, fKeyPasswordText.getText());
configuration.setAttribute(Plugin.ATTR_CONTEXT, fContextText.getText());
configuration.setAttribute(Plugin.ATTR_WEBAPPDIR, fWebAppDirText.getText());
return;
}
public void setDefaults(ILaunchConfigurationWorkingCopy configuration) {
IJavaElement javaElement = getContext();
if (javaElement != null) {
initializeJavaProject(javaElement, configuration);
} else {
configuration.setAttribute(ATTR_PROJECT_NAME, "");
}
configuration.setAttribute(
IJavaLaunchConfigurationConstants.ATTR_MAIN_TYPE_NAME,
Plugin.BOOTSTRAP_CLASS_NAME);
// set the class path provider so that Jetty and the bootstrap jar are
// added to the run time class path. Value has to be the same as the one
// defined for the extension point
configuration.setAttribute(
IJavaLaunchConfigurationConstants.ATTR_CLASSPATH_PROVIDER,
"RunJettyRunWebAppClassPathProvider");
// get the name for this launch configuration
String launchConfigName = "";
try {
// try to base the launch config name on the current project
launchConfigName = configuration.getAttribute(
IJavaLaunchConfigurationConstants.ATTR_PROJECT_NAME, "");
} catch (CoreException e) {
// ignore
}
if (launchConfigName == null || launchConfigName.length() == 0) {
// if no project name was found, base on a default name
launchConfigName = "Jetty Webapp";
}
// generate an unique name (e.g. myproject(2))
launchConfigName = getLaunchConfigurationDialog().generateName(
launchConfigName);
configuration.rename(launchConfigName); // and rename the config
configuration.setAttribute(Plugin.ATTR_PORT, "8080");
configuration.setAttribute(Plugin.ATTR_SSL_PORT, "8443");
File userHomeDir = new File(System.getProperty("user.home"));
File keystoreFile = new File(userHomeDir, ".keystore");
String keystore = keystoreFile.getAbsolutePath();
configuration.setAttribute(Plugin.ATTR_KEYSTORE, keystore );
configuration.setAttribute(Plugin.ATTR_PWD, "changeit");
configuration.setAttribute(Plugin.ATTR_KEY_PWD, "changeit");
configuration.setAttribute(Plugin.ATTR_CONTEXT, "/");
configuration.setAttribute(Plugin.ATTR_WEBAPPDIR, "");
return;
}
private IJavaProject chooseJavaProject() {
ILabelProvider labelProvider = new JavaElementLabelProvider(
JavaElementLabelProvider.SHOW_DEFAULT);
ElementListSelectionDialog dialog = new ElementListSelectionDialog(
getShell(), labelProvider);
dialog.setTitle("Project Selection");
dialog.setMessage("Select a project to constrain your search.");
try {
dialog
.setElements(JavaCore.create(
ResourcesPlugin.getWorkspace().getRoot())
.getJavaProjects());
} catch (JavaModelException jme) {
Plugin.logError(jme);
}
IJavaProject javaProject = null;
String projectName = fProjText.getText().trim();
if (projectName.length() > 0) {
javaProject = JavaCore.create(getWorkspaceRoot()).getJavaProject(
projectName);
}
if (javaProject != null) {
dialog.setInitialSelections(new Object[] { javaProject });
}
if (dialog.open() == Window.OK) {
return (IJavaProject) dialog.getFirstResult();
}
return null;
}
private void chooseWebappDir() {
IProject project = ResourcesPlugin.getWorkspace().getRoot().getProject(
fProjText.getText());
ContainerSelectionDialog dialog = new ContainerSelectionDialog(
getShell(), project, false, "Select Web Application Directory");
dialog.setTitle("Folder Selection");
if (project != null) {
IPath path = project.getFullPath();
dialog.setInitialSelections(new Object[] { path });
}
dialog.showClosedProjects(false);
dialog.open();
Object[] results = dialog.getResult();
if ((results != null) && (results.length > 0)
&& (results[0] instanceof IPath)) {
IPath path = (IPath) results[0];
path = path.removeFirstSegments(1);
String containerName = path.makeRelative().toString();
fWebAppDirText.setText(containerName);
}
}
private IWorkspaceRoot getWorkspaceRoot() {
return ResourcesPlugin.getWorkspace().getRoot();
}
private void handleProjectButtonSelected() {
IJavaProject project = chooseJavaProject();
if (project == null) {
return;
}
String projectName = project.getElementName();
fProjText.setText(projectName);
}
protected void handleBrowseFileSystem() {
String current = fKeystoreText.getText();
if (current == null || current.trim().equals(""))
{
String userHome = System.getProperty("user.home");
String fileSeparator = System.getProperty("file.separator");
current = userHome + fileSeparator + ".keystore";
}
FileDialog dialog = new FileDialog(getControl().getShell());
dialog.setFilterExtensions(new String[] {"*.keystore", "*"}); //$NON-NLS-1$
dialog.setFilterPath(fKeystoreText.getText());
dialog.setText("Choose a keystore file");
String res = dialog.open();
if (res != null)
fKeystoreText.setText(res);
}
}