diff options
Diffstat (limited to 'examples/org.eclipse.swt.examples.launcher/org/eclipse/swt/examples/launcher/ImportProjectTask.java')
| -rwxr-xr-x | examples/org.eclipse.swt.examples.launcher/org/eclipse/swt/examples/launcher/ImportProjectTask.java | 290 |
1 files changed, 0 insertions, 290 deletions
diff --git a/examples/org.eclipse.swt.examples.launcher/org/eclipse/swt/examples/launcher/ImportProjectTask.java b/examples/org.eclipse.swt.examples.launcher/org/eclipse/swt/examples/launcher/ImportProjectTask.java deleted file mode 100755 index b69d15b681..0000000000 --- a/examples/org.eclipse.swt.examples.launcher/org/eclipse/swt/examples/launcher/ImportProjectTask.java +++ /dev/null @@ -1,290 +0,0 @@ -package org.eclipse.swt.examples.launcher;
/*
* (c) Copyright IBM Corp. 2000, 2001.
* All Rights Reserved
*/
import org.eclipse.core.boot.*;
import org.eclipse.core.internal.events.*;
import org.eclipse.core.resources.*;
import org.eclipse.core.runtime.*;
import org.eclipse.jdt.core.*;
import org.eclipse.jdt.launching.*;
import org.eclipse.jface.dialogs.*;
import org.eclipse.swt.widgets.*;
import org.eclipse.ui.dialogs.*;
import org.eclipse.ui.internal.*;
import org.eclipse.ui.wizards.datatransfer.*;
import java.io.*;
import java.lang.reflect.*;
import java.net.*;
import java.util.*;
import java.util.zip.*;
-/**
* ImportProjectTask maintains information about a project import session and provides
* all necessary user interface support.
*/
-public class ImportProjectTask {
// Support for externalized project properties information
private static final String IMPORTPROJECT_PROPERTIES = "import.properties";
private static final String PROPERTYKEY_BUILDERS = "builders";
private static final String PROPERTYKEY_NATURES = "natures";
private static final String PROPERTYKEY_VARIABLES_PREFIX = "var.";
private static final String PROPERTYKEY_ARGS_PREFIX = "args.";
private static final String PROPERTYKEY_VMARGS_PREFIX = "vmargs.";
// Property substitution keywords
private static final String SUBST_KEYWORD_INTRO = "<<";
private static final String SUBST_KEYWORD_EXTRO = ">>";
private static final String SUBST_ECLIPSE_PLUGINS = "<<ECLIPSE_PLUGINS>>";
// path to the primary Eclipse plugins root directory
private static final String SUBST_SWT_LIBRARY_PATH = "<<SWT_LIBRARY_PATH>>";
// path to the Eclipse libraries (java.library.path)
// Default project properties
private static final Properties defaultProjectProperties;
static {
defaultProjectProperties = new Properties();
defaultProjectProperties.setProperty(PROPERTYKEY_NATURES,
"org.eclipse.jdt.core.javanature");
defaultProjectProperties.setProperty(PROPERTYKEY_BUILDERS,
"org.eclipse.jdt.core.javabuilder");
defaultProjectProperties.setProperty(PROPERTYKEY_VARIABLES_PREFIX + "ECLIPSE_PLUGINS",
SUBST_ECLIPSE_PLUGINS);
}
// Internal data
- private Shell parentShell;
- private String defaultProjectName;
- private URL sourceUrl;
-
- /**
- * Creates an ImportProjectTask specifying information about an import operation
- * to be performed.
- *
- * @param parentShell the Shell instance to use in dialogs.
- * @param defaultProjectName the default name of the project to import into
- * @param sourceUrl the URL of the ZIP/JAR file which we will import
- */
- public ImportProjectTask(Shell parentShell, String defaultProjectName, URL sourceUrl) {
- this.parentShell = parentShell;
- this.defaultProjectName = defaultProjectName;
- this.sourceUrl = sourceUrl;
- }
-
- /**
- * Disposes of operating system and platform resources associated with this instance.
- */
- public void dispose() {
- sourceUrl = null;
- }
-
- /**
- * Perform the import.
- *
- * @return true iff the import succeeded
- */
- public boolean execute() {
- String projectName = getNewProjectName(parentShell, defaultProjectName);
- if (projectName == null) return false;
- return doImportZip(projectName);
- }
-
- /**
- * Returns a project name into which to import a new item.
- *
- * @param defaultProjectName the default name to give the project
- * @return the name a new project, null if the user aborted
- */
- private String getNewProjectName(Shell parentShell, final String defaultProjectName) {
- InputDialog inputDialog = new InputDialog(parentShell,
- LauncherPlugin.getResourceString("dialog.ImportPathInput.title"),
- LauncherPlugin.getResourceString("dialog.ImportPathInput.message"),
- defaultProjectName,
- new IInputValidator() {
- public String isValid(String projectPath) {
- // verify that name is well-formed
- IWorkspace workspace = WorkbenchPlugin.getPluginWorkspace();
- projectPath = new Path(projectPath).makeAbsolute().toString();
- IStatus status = workspace.validatePath(projectPath,
- IResource.PROJECT | IResource.FOLDER);
- if (! status.isOK()) {
- return LauncherPlugin.getResourceString("dialog.InvalidTargetProjectPath.interactive");
- }
- // verify that project does not already exist
- IWorkspaceRoot workspaceRoot = workspace.getRoot();
- IProject project = workspaceRoot.getProject(projectPath);
- if (project.exists()) {
- return LauncherPlugin.getResourceString("dialog.ExistingProjectPath.interactive");
- }
- return null;
- }
- });
- inputDialog.setBlockOnOpen(true);
- inputDialog.open();
- String path = inputDialog.getValue();
- inputDialog.close();
-
- return (inputDialog.getReturnCode() == InputDialog.OK) ? path : null;
- }
-
- /**
- * Imports a new project from a Zip file.
- * Note that user feedback is provided when the result is false
- *
- * @param projectName the name to give the new project
- * @return true if the operation succeeds
- */
- private boolean doImportZip(String projectName) {
- final IPath projectPath = new Path(projectName).makeAbsolute();
-
- ZipFile zipFile = null;
- try {
- /* Open the Zip file and get a StructureProvider for it */
File file = urlToFile(sourceUrl);
if (file == null) throw new Exception();
- zipFile = new ZipFile(file);
- ZipFileStructureProvider provider = new ZipFileStructureProvider(zipFile);
-
- return importExecute(projectPath, provider.getRoot(), provider);
- } catch (Exception e) {
- MessageDialog.openError(parentShell,
- LauncherPlugin.getResourceString("dialog.ImportProgramProblems.title"),
- LauncherPlugin.getResourceString("dialog.ErrorAccessingZipFile.message",
- new Object[] { sourceUrl.getFile(), e.getMessage() }));
- return false;
- } finally {
- try {
- if (zipFile != null) zipFile.close();
- } catch (IOException e) { }
- }
- }
-
- /**
- * Performs an import operation
- * Note that user feedback is provided when the result is false
- *
- * @param projectPath the absolute path of the project to create
- * @param source the source node for the import
- * @param provider the structure provider ImportOperation will use to retrieve file contents
- * @return true if the operation succeeds
- */
- private boolean importExecute(IPath projectPath, Object source, IImportStructureProvider provider) {
- /* Validate the target path */
- if (! importValidateProjectPath(projectPath)) return false;
-
- /* Locate the Project we will import into, or create it anew */
- final IWorkspace workspace = WorkbenchPlugin.getPluginWorkspace();
- final IWorkspaceRoot workspaceRoot = workspace.getRoot();
- final String projectName = projectPath.toString();
- final IProject project = workspaceRoot.getProject(projectName);
-
- /* Create a progress monitor for the import process */
- ProgressMonitorDialog progressDialog = new ProgressMonitorDialog(parentShell);
- progressDialog.setCancelable(true);
- progressDialog.open();
-
- /* Manipulate the ProjectDescription so that we can build the example */
- String exceptionMessage = null;
Properties projectProperties = defaultProjectProperties;
- try {
- if (! project.exists()) {
- /* Create the project */
- exceptionMessage = "dialog.ErrorCreatingNewProject.message";
-
- IProjectDescription projectDesc = workspace.newProjectDescription(projectName);
- project.create(projectDesc, progressDialog.getProgressMonitor());
- }
- /* Open Project */
- project.open(progressDialog.getProgressMonitor());
-
/* Import project properties from disk */
try {
Object node = findStructuredChildElement(provider, source, IMPORTPROJECT_PROPERTIES);
if (node != null) {
InputStream is = provider.getContents(node);
Properties properties = new Properties();
properties.load(is);
projectProperties = properties;
}
} catch (Exception e) {
}
- /* Set Project properties */
- exceptionMessage = "dialog.ErrorUpdatingProjectProperties.message";
-
- IProjectDescription projectDesc = project.getDescription();
- updateProjectDescription(projectDesc, projectProperties);
- project.setDescription(projectDesc, progressDialog.getProgressMonitor());
- } catch (Exception e) {
- if (progressDialog != null) progressDialog.close();
- if (exceptionMessage == null) exceptionMessage = "{0}";
- MessageDialog.openError(parentShell,
- LauncherPlugin.getResourceString("dialog.ImportProgramProblems.title"),
- LauncherPlugin.getResourceString(exceptionMessage, new Object[] { e.getMessage() }));
- return false;
- }
-
/* Update the Classpath variables */
updateClasspathVariables(projectProperties, progressDialog.getProgressMonitor());
- /* Create the ImportOperation */
- ImportOperation importOperation = new ImportOperation(projectPath, source, provider,
- new IOverwriteQuery() {
- final String[] responses = new String[] {
- IOverwriteQuery.YES,
- IOverwriteQuery.NO,
- IOverwriteQuery.ALL,
- IOverwriteQuery.CANCEL};
- final String[] labels = new String[] {
- IDialogConstants.YES_LABEL,
- IDialogConstants.NO_LABEL,
- IDialogConstants.YES_TO_ALL_LABEL,
- IDialogConstants.CANCEL_LABEL};
-
- /* called to query user if existing files should be overwritten */
- public String queryOverwrite(String pathString) {
- final MessageDialog dialog =
- new MessageDialog(parentShell,
- LauncherPlugin.getResourceString("dialog.ImportProgramOverwrite.title"),
- null, LauncherPlugin.getResourceString("dialog.FileAlreadyExists.message",
- new Object[] { pathString }),
- MessageDialog.QUESTION, labels, 0);
- // run in syncExec because callback is from an operation,
- // which is probably not running in the UI thread.
- parentShell.getDisplay().syncExec(new Runnable() {
- public void run() {
- dialog.open();
- }
- });
- return dialog.getReturnCode() < 0 ? CANCEL : responses[dialog.getReturnCode()];
- }
- });
- importOperation.setOverwriteResources(false); // ask user before overwriting...
-
- /* Execute the operation */
- try {
- progressDialog.run(true, true, importOperation);
- } catch (InterruptedException e) {
- // aborted
- return false;
- } catch (InvocationTargetException e) {
- // failed
- MessageDialog.openError(parentShell,
- LauncherPlugin.getResourceString("dialog.ImportProgramProblems.title"),
- e.getTargetException().getMessage());
- return false;
- }
-
- /* Verify that the operation succeeded */
- IStatus status = importOperation.getStatus();
- if (! status.isOK()) {
- ErrorDialog.openError(parentShell,
- LauncherPlugin.getResourceString("dialog.ImportProgramProblems.title"),
- LauncherPlugin.getResourceString("dialog.ImportFailed.message"),
- status);
- return false;
- }
/* Get the IJavaProject for this project */
IJavaProject javaProject = JavaCore.create(project);
if (javaProject == null) {
MessageDialog.openError(parentShell,
LauncherPlugin.getResourceString("dialog.ImportProgramProblems.title"),
LauncherPlugin.getResourceString("dialog.UnableToGetJavaProjectHandle.message"));
return false;
}
/* Restore program and VM arguments */
updateProgramAndVMArguments(projectProperties, javaProject);
return true;
- }
-
- /**
- * Updates a ProjectDescription prior to an import.
- *
- * @param projectDesc the IProjectDescription to fix
* @param properties a Properties file containing entries of the form
* natures = <string>[;<string>]
* builders = <string>[;<string>]
*/
- private void updateProjectDescription(IProjectDescription projectDesc, Properties properties) {
if (properties == null) return;
- /* Add natures */
- String[] natureIds = projectDesc.getNatureIds();
final String naturesList = properties.getProperty(PROPERTYKEY_NATURES);
if (naturesList != null) {
StringTokenizer entries = new StringTokenizer(naturesList, "; \t\n\r\f");
while (entries.hasMoreTokens()) {
natureIds = addUniqueString(natureIds, entries.nextToken());
}
projectDesc.setNatureIds(natureIds);
}
-
- /* Add builders */
- ICommand[] buildSpecs = projectDesc.getBuildSpec();
- final String buildersList = properties.getProperty(PROPERTYKEY_BUILDERS);
if (buildersList != null) {
StringTokenizer entries = new StringTokenizer(buildersList, "; \t\n\r\f");
while (entries.hasMoreTokens()) {
buildSpecs = addUniqueCommand(buildSpecs, entries.nextToken(), new HashMap());
}
projectDesc.setBuildSpec(buildSpecs);
}
}
/**
* Updates the Classpath Variables.
*
* @param properties a Properties file containing entries of the form
* var.<varname> = [<string>|<substitution string>]
* @param progressMonitor an IProgressMonitor to use while setting things up
*/
private void updateClasspathVariables(Properties properties, IProgressMonitor progressMonitor) {
Enumeration it = properties.propertyNames();
while (it.hasMoreElements()) {
final String name = (String) it.nextElement();
if (name.startsWith(PROPERTYKEY_VARIABLES_PREFIX)) {
final String varName = name.substring(PROPERTYKEY_VARIABLES_PREFIX.length());
final String path = properties.getProperty(name);
if (path == null || path.length() == 0) continue;
IPath oldValue = JavaCore.getClasspathVariable(varName);
if (oldValue != null) continue; // silently ignore if set
// Variable does not exist, set it.
try {
final IPath varPath = new Path(expandSubstitutionKeywords(path));
varPath.makeAbsolute();
JavaCore.setClasspathVariable(varName, varPath, progressMonitor);
continue;
} catch (Exception e) {
}
MessageDialog.openInformation(parentShell,
LauncherPlugin.getResourceString("dialog.ImportProgramProblems.title"),
LauncherPlugin.getResourceString("dialog.UnableToSetClasspathVariable.message",
new Object[] { varName, path } ));
}
}
}
/**
* Updates the Program and VM Arguments.
*
* @param properties a Properties file containing entries of the form
* args.<resource path>%<class> = [<string>|<substitution string>]
* vmargs.<resource path>%<class> = [<string>|<substitution string>]
* @param javaProject the IJavaProject to work on
*/
private void updateProgramAndVMArguments(Properties properties, IJavaProject javaProject) {
Enumeration it = properties.propertyNames();
while (it.hasMoreElements()) {
final String name = (String) it.nextElement();
final String entry;
final int argId; // 0 is program, 1 is VM
// Get property key
if (name.startsWith(PROPERTYKEY_ARGS_PREFIX)) {
entry = name.substring(PROPERTYKEY_ARGS_PREFIX.length());
argId = 0;
} else if (name.startsWith(PROPERTYKEY_VMARGS_PREFIX)) {
entry = name.substring(PROPERTYKEY_VMARGS_PREFIX.length());
argId = 1;
} else continue;
// Parse entry
int index = entry.indexOf('%');
if (index == -1) continue; // ignore invalid entry
final String resource = entry.substring(0, index);
final String className = entry.substring(index + 1);
String value = properties.getProperty(name);
if (value == null) continue;
value = expandSubstitutionKeywords(value);
try {
IPath resourcePath = new Path(resource);
IJavaElement javaElement = javaProject.findElement(resourcePath);
if (javaElement != null &&
javaElement.getElementType() == IJavaElement.COMPILATION_UNIT &&
javaElement.exists()) {
ICompilationUnit compilationUnit = (ICompilationUnit) javaElement;
IType javaType = compilationUnit.getType(className);
if (javaType != null && javaType.exists()) {
ExecutionArguments oldArgs = ExecutionArguments.getArguments(javaType);
String vmArgs;
String programArgs;
if (oldArgs == null) {
vmArgs = "";
programArgs = "";
} else {
vmArgs = oldArgs.getVMArguments();
programArgs = oldArgs.getProgramArguments();
}
if (argId == 0) {
programArgs = value;
} else {
vmArgs = value;
}
ExecutionArguments newArgs = new ExecutionArguments(vmArgs, programArgs);
ExecutionArguments.setArguments(javaType, newArgs);
continue;
}
}
} catch (Exception e) {
}
MessageDialog.openInformation(parentShell,
LauncherPlugin.getResourceString("dialog.ImportProgramProblems.title"),
LauncherPlugin.getResourceString((argId == 0) ?
"dialog.UnableToProgramArguments.message" : "dialog.UnableToVMArguments.message",
new Object[] { resource, className, value } ));
}
}
/**
* Replaces any substitution keywords with their values.
*
* @param string the string to work on
* @return the expanded string
*/
private String expandSubstitutionKeywords(String string) {
int endIndex = 0;
for (;;) {
int index = string.indexOf(SUBST_KEYWORD_INTRO, endIndex);
if (index == -1) return string;
endIndex = string.indexOf(SUBST_KEYWORD_EXTRO, index);
if (endIndex == -1) return string;
endIndex += SUBST_KEYWORD_EXTRO.length();
final String keyword = string.substring(index, endIndex);
String value = null;
for (int i = 0; i < substitutionKeywords.length; ++i) {
final SubstitutionKeyword subst = substitutionKeywords[i];
if (subst.isMatch(keyword)) {
value = subst.getValue();
break;
}
}
if (value == null) {
MessageDialog.openInformation(parentShell,
LauncherPlugin.getResourceString("dialog.ImportProgramProblems.title"),
LauncherPlugin.getResourceString("dialog.UnableExpandSubstitutionKeyword.message",
new Object[] { keyword, string } ));
} else {
string = string.substring(0, index) + value + string.substring(endIndex);
}
}
}
/** Data for subsitution keywords **/
static abstract class SubstitutionKeyword {
public abstract boolean isMatch(String keyword);
public abstract String getValue();
}
static final SubstitutionKeyword[] substitutionKeywords = new SubstitutionKeyword[] {
// <<ECLIPSE_PLUGINS>>
new SubstitutionKeyword() {
public boolean isMatch(String keyword) {
return keyword.equalsIgnoreCase(SUBST_ECLIPSE_PLUGINS);
}
public String getValue() {
try {
// Guess at primary plugins directory location
// get the platform's public plugin registry
IPluginRegistry pluginRegistry = Platform.getPluginRegistry();
// retrieve plugin descriptor for org.eclipse.core
IPluginDescriptor pd = pluginRegistry.getPluginDescriptor("org.eclipse.core.runtime");
// getInstallUrl() returns the path of the directory with the plugin manifest file(s)
// for a specific plugin, find the parent directory
final URL installUrl = Platform.resolve(pd.getInstallURL());
if (installUrl.getProtocol().equals("file")) {
String pluginPath = installUrl.getFile();
pluginPath = pluginPath.substring(0, pluginPath.lastIndexOf('/'));
// eliminate terminal '/' on directory
pluginPath = pluginPath.substring(0, 1 + pluginPath.lastIndexOf('/'));
// locate parent directory
return pluginPath;
}
} catch (Exception e) {
}
return null;
}
},
// <<SWT_LIBRARY_PATH>>
new SubstitutionKeyword() {
public boolean isMatch(String keyword) {
return keyword.equalsIgnoreCase(SUBST_SWT_LIBRARY_PATH);
}
public String getValue() {
try {
IPluginRegistry pluginRegistry = Platform.getPluginRegistry();
IPluginDescriptor pd = pluginRegistry.getPluginDescriptor("org.eclipse.swt");
final URL installUrl = pd.getInstallURL();
// not supported yet: final URL libraryUrl = new URL(installUrl, "$ws$");
final URL libraryUrl = new URL(installUrl, "ws/" + BootLoader.getWS());
final URL resolveUrl = Platform.resolve(libraryUrl);
if (resolveUrl.getProtocol().equals("file")) {
return resolveUrl.getFile();
}
} catch (Exception e) {
}
return null;
}
}
};
/**
- * Validates the target project path
- *
- * @param projectPath the project path to verify
- * @return true if the path is valid
- * Note that user feedback is provided when the result is false
- */
- private boolean importValidateProjectPath(IPath projectPath) {
- IWorkspace workspace = WorkbenchPlugin.getPluginWorkspace();
- IStatus status = workspace.validatePath(projectPath.toString(), IResource.PROJECT | IResource.FOLDER);
- if (! status.isOK()) {
- ErrorDialog.openError(parentShell,
- LauncherPlugin.getResourceString("dialog.ImportProgramProblems.title"),
- LauncherPlugin.getResourceString("dialog.InvalidTargetProjectPath.message",
- new Object[] { projectPath.toString() }),
- status);
- return false;
- }
- return true;
- }
-
- /**
- * Adds a unique String to a String[].
- *
- * @param array the old String array
- * @param string the new String
- * @return the new String array (may be same as old)
- */
- private String[] addUniqueString(String[] array, String string) {
- for (int i = 0; i < array.length; ++i) {
- if (array[i].equals(string)) return array;
- }
- String[] newArray = new String[array.length + 1];
- System.arraycopy(array, 0, newArray, 0, array.length);
- newArray[array.length] = string;
- return newArray;
- }
-
- /**
- * Adds a unique ICommand to a ICommand[].
- *
- * @param array the old ICommand array
- * @param builderName the new builder name
- * @param builderArgs the new arguments
- * @return the new ICommand array (may be same as old)
- */
- private ICommand[] addUniqueCommand(ICommand[] array, String builderName, Map builderArgs) {
- for (int i = 0; i < array.length; ++i) {
- final String name = array[i].getBuilderName();
- final Map args = array[i].getArguments();
-
- if ((name != null) && (name.equals(builderName))) return array;
- }
- ICommand[] newArray = new ICommand[array.length + 1];
- System.arraycopy(array, 0, newArray, 0, array.length);
- BuildCommand newCommand = new BuildCommand();
- newCommand.setBuilderName(builderName);
- newCommand.setArguments(builderArgs);
- newArray[array.length] = newCommand;
- return newArray;
- }
/**
* Finds a particular child of a container in an IImportStructureProvider.
*
*/
private Object findStructuredChildElement(IImportStructureProvider provider, Object parent, String name) {
if (! provider.isFolder(parent)) return null;
java.util.List list = provider.getChildren(parent);
if (list == null) return null;
for (Iterator it = list.iterator(); it.hasNext(); ) {
Object item = it.next();
if (provider.getLabel(item).equals(name)) return item;
}
return null;
}
/**
* Get a File through which it is possible to access the contents of a URL.
* Use this when you want to be able to access the contents of a URL immediately.
* <p>
* Will automatically cache contents from non-local files or Jars on the local filesystem.
* Cannot resolve paths to non-local [not on filesystem] directories.
* </p>
*
* @param url the URL to convert
* @return a File where the URL's data can be accessed, or null if not accessible
*/
private static File urlToFile(URL url) {
try {
url = Platform.asLocalURL(url);
} catch (IOException e) {
try {
url = Platform.resolve(url); // perhaps it is a directory on the local filesystem
} catch (IOException e2) { }
}
final String urlProtocol = url.getProtocol();
if (urlProtocol.equals("file")) {
return new File(url.getFile()).getAbsoluteFile();
}
return null;
}
-}
|