org.eclipse.tycho.versions.pom.PomFile Maven / Gradle / Ivy
/*******************************************************************************
* Copyright (c) 2008, 2016 Sonatype Inc. 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:
* Sonatype Inc. - initial API and implementation
* Bachmann electronic GmbH. - #472579 - Support setting the version for pomless builds
*******************************************************************************/
package org.eclipse.tycho.versions.pom;
import java.io.BufferedInputStream;
import java.io.BufferedOutputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.io.Writer;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.LinkedHashSet;
import java.util.List;
import org.codehaus.plexus.util.IOUtil;
import de.pdark.decentxml.Document;
import de.pdark.decentxml.Element;
import de.pdark.decentxml.Node;
import de.pdark.decentxml.Text;
import de.pdark.decentxml.XMLIOSource;
import de.pdark.decentxml.XMLParseException;
import de.pdark.decentxml.XMLParser;
import de.pdark.decentxml.XMLWriter;
public class PomFile {
public static final String POM_XML = "pom.xml";
public static final String POLYGLOT_POM_XML = ".polyglot.build.properties";
private static final String DEFAULT_XML_ENCODING = "UTF-8";
private static XMLParser parser = new XMLParser();
private Document document;
private Element project;
/** The (effective) project version */
private String version;
private final boolean preferExplicitProjectVersion;
private final boolean isMutable;
public PomFile(Document pom, boolean isMutable) {
this.document = pom;
this.isMutable = isMutable;
this.project = document.getRootElement();
this.version = this.getExplicitVersionFromXML();
if (this.version == null) {
this.version = this.getParentVersion();
this.preferExplicitProjectVersion = false;
} else {
this.preferExplicitProjectVersion = this.version.equals(this.getParentVersion());
}
}
public static PomFile read(File file, boolean isMutable) throws IOException {
InputStream is = new BufferedInputStream(new FileInputStream(file));
try {
return read(is, isMutable);
} catch (XMLParseException xpe) {
throw new XMLParseException("This Pom " + file.getAbsolutePath() + " is in the Wrong Format", xpe);
} finally {
IOUtil.close(is);
}
}
public static PomFile read(InputStream input, boolean isMutable) throws IOException {
return new PomFile(parser.parse(new XMLIOSource(input)), isMutable);
}
public static void write(PomFile pom, OutputStream out) throws IOException {
String encoding = pom.document.getEncoding() != null ? pom.document.getEncoding() : DEFAULT_XML_ENCODING;
Writer w = new OutputStreamWriter(out, encoding);
XMLWriter xw = new XMLWriter(w);
try {
pom.setVersionInXML();
pom.document.toXML(xw);
} finally {
xw.flush();
}
}
public static void write(PomFile pom, File file) throws IOException {
OutputStream os = new BufferedOutputStream(new FileOutputStream(file));
try {
write(pom, os);
} finally {
IOUtil.close(os);
}
}
private String getExplicitVersionFromXML() {
return getElementValue("version");
}
private void setVersionInXML() {
boolean writeProjectVersion = preferExplicitProjectVersion || !version.equals(getParentVersion());
if (writeProjectVersion) {
Element versionElement = project.getChild("version");
if (versionElement == null) {
versionElement = addEmptyVersionElementToXML(project);
}
versionElement.setText(version);
} else {
removeVersionElementFromXML(project);
}
}
private static Element addEmptyVersionElementToXML(Element project) {
Element result = new Element(project, "version");
// TODO proper indentation
project.addNode(new Text("\n"));
return result;
}
private static void removeVersionElementFromXML(Element project) {
List elements = project.getNodes();
for (Iterator iterator = elements.iterator(); iterator.hasNext();) {
Node node = iterator.next();
if (node instanceof Element) {
if ("version".equals(((Element) node).getName())) {
iterator.remove();
// also return newline after the element
if (iterator.hasNext() && iterator.next() instanceof Text) {
iterator.remove();
}
return;
}
}
}
}
/**
* Sets the version in the parent POM declaration. This never affects the (effective) version of
* the project itself.
*
* @see #setVersion(String)
*/
public void setParentVersion(String newVersion) {
Element element = project.getChild("parent/version");
if (element == null) {
throw new IllegalArgumentException("No parent/version");
}
element.setText(newVersion);
}
/**
* Sets the version of the project.
*/
public void setVersion(String version) {
this.version = version;
}
/**
* Returns the (effective) version of the project.
*/
public String getVersion() {
return version;
}
public String getPackaging() {
String packaging = getElementValue("packaging");
return packaging != null ? packaging : "jar";
}
public String getParentVersion() {
GAV parent = getParent();
return parent != null ? parent.getVersion() : null;
}
private String getExplicitGroupId() {
return getElementValue("groupId");
}
/**
* Returns the (effective) groupId of the project.
*/
public String getGroupId() {
String groupId = getExplicitGroupId();
if (groupId == null) {
groupId = getParent().getGroupId();
}
return groupId;
}
public String getArtifactId() {
return getElementValue("artifactId");
}
public GAV getParent() {
Element element = project.getChild("parent");
return element != null ? new GAV(element) : null;
}
public List getModules() {
LinkedHashSet result = new LinkedHashSet<>();
for (Element modules : project.getChildren("modules")) {
for (Element module : modules.getChildren("module")) {
result.add(module.getTrimmedText());
}
}
return new ArrayList<>(result);
}
public List getProfiles() {
ArrayList result = new ArrayList<>();
for (Element profiles : project.getChildren("profiles")) {
for (Element profile : profiles.getChildren("profile")) {
result.add(new Profile(profile));
}
}
return result;
}
public DependencyManagement getDependencyManagement() {
return DependencyManagement.getDependencyManagement(project);
}
public List getDependencies() {
return Dependencies.getDependencies(project);
}
public Build getBuild() {
return Build.getBuild(project);
}
public List getProperties() {
return Property.getProperties(project);
}
private String getElementValue(String name) {
Element child = project.getChild(name);
return child != null ? child.getTrimmedText() : null;
}
public boolean isMutable() {
return isMutable;
}
}