/*******************************************************************************
* Copyright (c) 2000, 2009 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
* Ferenc Hechler, ferenc_hechler@users.sourceforge.net - 83258 [jar exporter] Deploy java application as executable jar
* Ferenc Hechler, ferenc_hechler@users.sourceforge.net - 262768 [jar exporter] Jardesc for normal Jar contains <fatjar builder="...
*******************************************************************************/
package org.eclipse.jdt.internal.ui.jarpackager;
import java.io.BufferedOutputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.io.UnsupportedEncodingException;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;
import org.w3c.dom.DOMException;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.eclipse.core.runtime.Assert;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Status;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.resources.IResource;
import org.eclipse.ltk.core.refactoring.RefactoringCore;
import org.eclipse.ltk.core.refactoring.RefactoringDescriptor;
import org.eclipse.ltk.core.refactoring.RefactoringDescriptorProxy;
import org.eclipse.ltk.core.refactoring.history.IRefactoringHistoryService;
import org.eclipse.jdt.core.IJavaElement;
import org.eclipse.jdt.core.IPackageFragment;
import org.eclipse.jdt.ui.jarpackager.IJarDescriptionWriter;
import org.eclipse.jdt.ui.jarpackager.JarPackageData;
import org.eclipse.jdt.internal.ui.IJavaStatusConstants;
import org.eclipse.jdt.internal.ui.JavaPlugin;
/**
* Writes a JarPackage to an underlying OutputStream
*/
public class JarPackageWriter extends Object implements IJarDescriptionWriter {
private final OutputStream fOutputStream;
private final String fEncoding;
/**
* Create a JarPackageWriter on the given output stream. It is the clients responsibility to
* close the output stream.
*
* @param outputStream the the output stream
* @param encoding the encoding
*/
public JarPackageWriter(OutputStream outputStream, String encoding) {
Assert.isNotNull(outputStream);
fOutputStream= new BufferedOutputStream(outputStream);
fEncoding= encoding;
}
public void write(JarPackageData jarPackage) throws CoreException {
try {
writeXML(jarPackage);
} catch (IOException ex) {
String message= (ex.getLocalizedMessage() != null ? ex.getLocalizedMessage() : ""); //$NON-NLS-1$
throw new CoreException(new Status(IStatus.ERROR, JavaPlugin.getPluginId(), IJavaStatusConstants.INTERNAL_ERROR, message, ex));
}
}
/**
* Writes a XML representation of the JAR specification to to the underlying stream.
*
* @param jarPackage the JAR package data
* @exception IOException if writing to the underlying stream fails
*/
public void writeXML(JarPackageData jarPackage) throws IOException {
Assert.isNotNull(jarPackage);
DocumentBuilder docBuilder= null;
DocumentBuilderFactory factory= DocumentBuilderFactory.newInstance();
factory.setValidating(false);
try {
docBuilder= factory.newDocumentBuilder();
} catch (ParserConfigurationException ex) {
throw new IOException(JarPackagerMessages.JarWriter_error_couldNotGetXmlBuilder);
}
Document document= docBuilder.newDocument();
// Create the document
Element xmlJarDesc= document.createElement(JarPackagerUtil.DESCRIPTION_EXTENSION);
document.appendChild(xmlJarDesc);
xmlWriteJarLocation(jarPackage, document, xmlJarDesc);
xmlWriteOptions(jarPackage, document, xmlJarDesc);
xmlWriteRefactoring(jarPackage, document, xmlJarDesc);
xmlWriteSelectedProjects(jarPackage, document, xmlJarDesc);
if (jarPackage.areGeneratedFilesExported())
xmlWriteManifest(jarPackage, document, xmlJarDesc);
xmlWriteSelectedElements(jarPackage, document, xmlJarDesc);
try {
// Write the document to the stream
Transformer transformer=TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.METHOD, "xml"); //$NON-NLS-1$
transformer.setOutputProperty(OutputKeys.ENCODING, fEncoding);
transformer.setOutputProperty(OutputKeys.INDENT, "yes"); //$NON-NLS-1$
transformer.setOutputProperty("{http://xml.apache.org/xslt}indent-amount","4"); //$NON-NLS-1$ //$NON-NLS-2$
DOMSource source = new DOMSource(document);
StreamResult result = new StreamResult(fOutputStream);
transformer.transform(source, result);
} catch (TransformerException e) {
throw new IOException(JarPackagerMessages.JarWriter_error_couldNotTransformToXML);
}
}
private void xmlWriteJarLocation(JarPackageData jarPackage, Document document, Element xmlJarDesc) throws DOMException {
Element jar= document.createElement(JarPackagerUtil.JAR_EXTENSION);
xmlJarDesc.appendChild(jar);
jar.setAttribute("path", jarPackage.getJarLocation().toPortableString()); //$NON-NLS-1$
}
private void xmlWriteOptions(JarPackageData jarPackage, Document document, Element xmlJarDesc) throws DOMException {
Element options= document.createElement("options"); //$NON-NLS-1$
xmlJarDesc.appendChild(options);
options.setAttribute("overwrite", "" + jarPackage.allowOverwrite()); //$NON-NLS-2$ //$NON-NLS-1$
options.setAttribute("compress", "" + jarPackage.isCompressed()); //$NON-NLS-2$ //$NON-NLS-1$
options.setAttribute("exportErrors", "" + jarPackage.areErrorsExported()); //$NON-NLS-2$ //$NON-NLS-1$
options.setAttribute("exportWarnings", "" + jarPackage.exportWarnings()); //$NON-NLS-2$ //$NON-NLS-1$
options.setAttribute("saveDescription", "" + jarPackage.isDescriptionSaved()); //$NON-NLS-2$ //$NON-NLS-1$
options.setAttribute("descriptionLocation", jarPackage.getDescriptionLocation().toPortableString()); //$NON-NLS-1$
options.setAttribute("useSourceFolders", "" + jarPackage.useSourceFolderHierarchy()); //$NON-NLS-2$ //$NON-NLS-1$
options.setAttribute("buildIfNeeded", "" + jarPackage.isBuildingIfNeeded()); //$NON-NLS-2$ //$NON-NLS-1$
options.setAttribute("includeDirectoryEntries", "" + jarPackage.areDirectoryEntriesIncluded()); //$NON-NLS-1$//$NON-NLS-2$
options.setAttribute("storeRefactorings", "" + jarPackage.isRefactoringAware()); //$NON-NLS-1$//$NON-NLS-2$
}
private void xmlWriteRefactoring(JarPackageData jarPackage, Document document, Element xmlJarDesc) throws DOMException {
Element refactoring= document.createElement("storedRefactorings"); //$NON-NLS-1$
xmlJarDesc.appendChild(refactoring);
refactoring.setAttribute("structuralOnly", "" + jarPackage.isExportStructuralOnly()); //$NON-NLS-1$ //$NON-NLS-2$
refactoring.setAttribute("deprecationInfo", "" + jarPackage.isDeprecationAware()); //$NON-NLS-1$ //$NON-NLS-2$
final IProject[] projects= jarPackage.getRefactoringProjects();
if (projects != null && projects.length > 0) {
for (int index= 0; index < projects.length; index++)
refactoring.setAttribute("project" + (index + 1), projects[index].getName()); //$NON-NLS-1$
}
final RefactoringDescriptorProxy[] proxies= jarPackage.getRefactoringDescriptors();
if (proxies != null && proxies.length > 0) {
int count= 1;
IRefactoringHistoryService service= RefactoringCore.getHistoryService();
try {
service.connect();
for (int index= 0; index < proxies.length; index++, count++) {
try {
final ByteArrayOutputStream stream= new ByteArrayOutputStream();
service.writeRefactoringDescriptors(new RefactoringDescriptorProxy[] { proxies[index]}, stream, RefactoringDescriptor.NONE, true, null);
refactoring.setAttribute("refactoring" + count, stream.toString("UTF-8")); //$NON-NLS-1$ //$NON-NLS-2$
} catch (CoreException exception) {
JavaPlugin.log(exception);
} catch (UnsupportedEncodingException exception) {
Assert.isTrue(false);
}
}
} finally {
service.disconnect();
}
}
}
private void xmlWriteManifest(JarPackageData jarPackage, Document document, Element xmlJarDesc) throws DOMException {
Element manifest= document.createElement("manifest"); //$NON-NLS-1$
xmlJarDesc.appendChild(manifest);
manifest.setAttribute("manifestVersion", jarPackage.getManifestVersion()); //$NON-NLS-1$
manifest.setAttribute("usesManifest", "" + jarPackage.usesManifest()); //$NON-NLS-2$ //$NON-NLS-1$
manifest.setAttribute("reuseManifest", "" + jarPackage.isManifestReused()); //$NON-NLS-2$ //$NON-NLS-1$
manifest.setAttribute("saveManifest", "" + jarPackage.isManifestSaved()); //$NON-NLS-2$ //$NON-NLS-1$
manifest.setAttribute("generateManifest", "" + jarPackage.isManifestGenerated()); //$NON-NLS-2$ //$NON-NLS-1$
manifest.setAttribute("manifestLocation", jarPackage.getManifestLocation().toPortableString()); //$NON-NLS-1$
if (jarPackage.getManifestMainClass() != null)
manifest.setAttribute("mainClassHandleIdentifier", jarPackage.getManifestMainClass().getHandleIdentifier()); //$NON-NLS-1$
xmlWriteSealingInfo(jarPackage, document, manifest);
}
private void xmlWriteSealingInfo(JarPackageData jarPackage, Document document, Element manifest) throws DOMException {
Element sealing= document.createElement("sealing"); //$NON-NLS-1$
manifest.appendChild(sealing);
sealing.setAttribute("sealJar", "" + jarPackage.isJarSealed()); //$NON-NLS-2$ //$NON-NLS-1$
Element packagesToSeal= document.createElement("packagesToSeal"); //$NON-NLS-1$
sealing.appendChild(packagesToSeal);
add(jarPackage.getPackagesToSeal(), packagesToSeal, document);
Element packagesToUnSeal= document.createElement("packagesToUnSeal"); //$NON-NLS-1$
sealing.appendChild(packagesToUnSeal);
add(jarPackage.getPackagesToUnseal(), packagesToUnSeal, document);
}
private void xmlWriteSelectedElements(JarPackageData jarPackage, Document document, Element xmlJarDesc) throws DOMException {
Element selectedElements= document.createElement("selectedElements"); //$NON-NLS-1$
xmlJarDesc.appendChild(selectedElements);
selectedElements.setAttribute("exportClassFiles", "" + jarPackage.areClassFilesExported()); //$NON-NLS-2$ //$NON-NLS-1$
selectedElements.setAttribute("exportOutputFolder", "" + jarPackage.areOutputFoldersExported()); //$NON-NLS-2$ //$NON-NLS-1$
selectedElements.setAttribute("exportJavaFiles", "" + jarPackage.areJavaFilesExported()); //$NON-NLS-2$ //$NON-NLS-1$
Object[] elements= jarPackage.getElements();
for (int i= 0; i < elements.length; i++) {
Object element= elements[i];
if (element instanceof IResource)
add((IResource)element, selectedElements, document);
else if (element instanceof IJavaElement)
add((IJavaElement)element, selectedElements, document);
// Note: Other file types are not handled by this writer
}
}
private void xmlWriteSelectedProjects(JarPackageData jarPackage, Document document, Element xmlJarDesc) throws DOMException {
Element selectedElements= document.createElement("selectedProjects"); //$NON-NLS-1$
xmlJarDesc.appendChild(selectedElements);
Object[] elements= jarPackage.getRefactoringProjects();
for (int index= 0; index < elements.length; index++) {
Object element= elements[index];
if (element instanceof IResource)
add((IResource)element, selectedElements, document);
}
}
/**
* Closes this stream. It is the client's responsibility to close the stream.
*
* @throws CoreException if closing the stream fails
*/
public void close() throws CoreException {
if (fOutputStream != null) {
try {
fOutputStream.close();
} catch (IOException ex) {
String message= (ex.getLocalizedMessage() != null ? ex.getLocalizedMessage() : ""); //$NON-NLS-1$
throw new CoreException(new Status(IStatus.ERROR, JavaPlugin.getPluginId(), IJavaStatusConstants.INTERNAL_ERROR, message, ex));
}
}
}
private void add(IResource resource, Element parent, Document document) {
if (resource.getType() == IResource.PROJECT) {
Element element= document.createElement("project"); //$NON-NLS-1$
parent.appendChild(element);
element.setAttribute("name", resource.getName()); //$NON-NLS-1$
} else if (resource.getType() == IResource.FILE) {
Element element= document.createElement("file"); //$NON-NLS-1$
parent.appendChild(element);
element.setAttribute("path", resource.getFullPath().toString()); //$NON-NLS-1$
} else if (resource.getType() == IResource.FOLDER) {
Element element= document.createElement("folder"); //$NON-NLS-1$
parent.appendChild(element);
element.setAttribute("path", resource.getFullPath().toString()); //$NON-NLS-1$
}
}
private void add(IJavaElement javaElement, Element parent, Document document) {
Element element= document.createElement("javaElement"); //$NON-NLS-1$
parent.appendChild(element);
element.setAttribute("handleIdentifier", javaElement.getHandleIdentifier()); //$NON-NLS-1$
}
private void add(IPackageFragment[] packages, Element parent, Document document) {
for (int i= 0; i < packages.length; i++) {
Element pkg= document.createElement("package"); //$NON-NLS-1$
parent.appendChild(pkg);
pkg.setAttribute("handleIdentifier", packages[i].getHandleIdentifier()); //$NON-NLS-1$
}
}
/*
* This writer always returns OK
*/
public IStatus getStatus() {
return Status.OK_STATUS;
}
}