/*

* #%L

* SciJava Common shared library for SciJava software.

* %%

* Copyright (C) 2009 - 2023 SciJava developers.

* %%

* Redistribution and use in source and binary forms, with or without

* modification, are permitted provided that the following conditions are met:

*

* 1. Redistributions of source code must retain the above copyright notice,

* this list of conditions and the following disclaimer.

* 2. Redistributions in binary form must reproduce the above copyright notice,

* this list of conditions and the following disclaimer in the documentation

* and/or other materials provided with the distribution.

*

* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"

* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE

* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE

* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR

* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF

* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS

* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN

* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)

* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE

* POSSIBILITY OF SUCH DAMAGE.

* #L%

*/

package org.scijava.util;

import java.io.File;

import java.io.IOException;

import java.io.InputStream;

import java.net.URL;

import java.util.ArrayList;

import java.util.Comparator;

import java.util.Enumeration;

import java.util.List;

import javax.xml.parsers.ParserConfigurationException;

import org.scijava.Context;

import org.scijava.Versioned;

import org.xml.sax.SAXException;

/**

* Helper class for working with Maven POMs.

*

* @author Curtis Rueden

*/

public class POM extends XML implements Comparable<POM>, Versioned {

private String version;

/** Parses a POM from the given file. */

public POM(final File file) throws ParserConfigurationException,

SAXException, IOException

{

super(file);

}

/** Parses a POM from the given URL. */

public POM(final URL url) throws ParserConfigurationException, SAXException,

IOException

{

super(url);

}

/** Parses a POM from the given input stream. */

public POM(final InputStream in) throws ParserConfigurationException,

SAXException, IOException

{

super(in);

}

/** Parses a POM from the given string. */

public POM(final String s) throws ParserConfigurationException, SAXException,

IOException

{

super(s);

}

// -- POM methods --

/** Gets the POM's parent groupId. */

public String getParentGroupId() {

return cdata("//project/parent/groupId");

}

/** Gets the POM's parent artifactId. */

public String getParentArtifactId() {

return cdata("//project/parent/artifactId");

}

/** Gets the POM's parent artifactId. */

public String getParentVersion() {

return cdata("//project/parent/version");

}

/** Gets the POM's groupId. */

public String getGroupId() {

final String groupId = cdata("//project/groupId");

if (groupId != null) return groupId;

return getParentGroupId();

}

/** Gets the POM's artifactId. */

public String getArtifactId() {

return cdata("//project/artifactId");

}

/** Gets the project name. */

public String getProjectName() {

return cdata("//project/name");

}

/** Gets the project description. */

public String getProjectDescription() {

return cdata("//project/description");

}

/** Gets the project URL. */

public String getProjecturl() {

return cdata("//project/url");

}

/** Gets the project inception year. */

public String getProjectInceptionYear() {

return cdata("//project/inceptionYear");

}

/** Gets the organization name. */

public String getOrganizationName() {

return cdata("//project/organization/name");

}

/** Gets the organization URL. */

public String getOrganizationurl() {

return cdata("//project/organization/url");

}

/** Gets the SCM connection string. */

public String getSCMConnection() {

return cdata("//project/scm/connection");

}

/** Gets the SCM developerConnection string. */

public String getSCMDeveloperConnection() {

return cdata("//project/scm/developerConnection");

}

/** Gets the SCM tag. */

public String getSCMTag() {

return cdata("//project/scm/tag");

}

/** Gets the SCM URL. */

public String getSCMurl() {

return cdata("//project/scm/url");

}

/** Gets the issue management system. */

public String getIssueManagementSystem() {

return cdata("//project/issueManagement/system");

}

/** Gets the issue management URL. */

public String getIssueManagementurl() {

return cdata("//project/issueManagement/url");

}

/** Gets the CI management system. */

public String getCIManagementSystem() {

return cdata("//project/ciManagement/system");

}

/** Gets the CI management URL. */

public String getCIManagementurl() {

return cdata("//project/ciManagement/url");

}

// -- Comparable methods --

private static final Comparator<String> STRING_COMPARATOR = //

Comparator.nullsFirst(String::compareTo);

private static final Comparator<POM> POM_COMPARATOR = Comparator//

// sort by groupId first

.comparing(POM::getGroupId, STRING_COMPARATOR)

// sort by artifactId second

.thenComparing(POM::getArtifactId, STRING_COMPARATOR)//

// finally, sort by version

.thenComparing(POM::getVersion, POM::compareVersions);

@Override

public int compareTo(final POM pom) {

return POM_COMPARATOR.compare(this, pom);

}

// -- Versioned methods --

/** Gets the POM's version. */

@Override

public String getVersion() {

if (version == null) {

synchronized (this) {

if (version == null) {

version = cdata("//project/version");

if (version == null) version = getParentVersion();

}

}

}

return version;

}

// -- Utility methods --

/**

* Gets the Maven POM associated with the given class.

*

* @param c The class to use as a base when searching for a pom.xml.

* @return {@link POM} object representing the discovered POM, or null if no

* POM could be found.

*/

public static POM getPOM(final Class<?> c) {

return getPOM(c, null, null);

}

/**

* Gets the Maven POM associated with the given class.

*

* @param c The class to use as a base when searching for a pom.xml.

* @param groupId The Maven groupId of the desired POM.

* @param artifactId The Maven artifactId of the desired POM.

* @return {@link POM} object representing the discovered POM, or null if no

* POM could be found.

*/

public static POM getPOM(final Class<?> c, final String groupId,

final String artifactId)

{

try {

final URL location = Types.location(c);

if (!location.getProtocol().equals("file") ||

location.toString().endsWith(".jar"))

{

// look for pom.xml in JAR's META-INF/maven subdirectory

if (groupId == null || artifactId == null) {

// groupId and/or artifactId is unknown; scan for the POM

final URL pomBase = new url(/sitelet?url=https%3A%2F%2Fgithub.com%2Fscijava%2Fscijava-common%2Fblob%2Fjava-11%2Fsrc%2Fmain%2Fjava%2Forg%2Fscijava%2Futil%2F%26quot%3Bjar%3A%26quot%3B%2520%2B%2520%2F%2F%253C%2Fdiv%253E%253C%2Fdiv%253E%253C%2Fdiv%253E%253Cdiv%2520class%3D%2522react-code-text%2520react-code-line-contents%2522%2520style%3D%2522min-height%3Aauto%2522%253E%253Cdiv%253E%253Cdiv%2520id%3D%2522LC250%2522%2520class%3D%2522react-file-line%2520html-div%2522%2520data-testid%3D%2522code-cell%2522%2520data-line-number%3D%2522250%2522%2520style%3D%2522position%3Arelative%2522%253Elocation.toString%28) + "!/META-INF/maven");

for (final URL url : FileUtils.listContents(pomBase, true, true)) {

if (url.toExternalForm().endsWith("/pom.xml")) {

return new POM(url);

}

}

}

else {

// known groupId and artifactId; grab it directly

final String pomPath =

"META-INF/maven/" + groupId + "/" + artifactId + "/pom.xml";

final URL pomURL =

new url(/sitelet?url=https%3A%2F%2Fgithub.com%2Fscijava%2Fscijava-common%2Fblob%2Fjava-11%2Fsrc%2Fmain%2Fjava%2Forg%2Fscijava%2Futil%2F%26quot%3Bjar%3A%26quot%3B%2520%2B%2520location.toString%28) + "!/" + pomPath);

return new POM(pomURL);

}

}

// look for the POM in the class's base directory

final File file = FileUtils.urlToFile(location);

final File baseDir = AppUtils.getBaseDirectory(file, null);

final File pomFile = new File(baseDir, "pom.xml");

return new POM(pomFile);

}

catch (final IOException | ParserConfigurationException | SAXException e) {

return null;

}

}

/** Gets all available Maven POMs on the class path. */

public static List<POM> getAllPOMs() {

// find all META-INF/maven/ folders on the classpath

final String pomPrefix = "META-INF/maven/";

final ClassLoader classLoader = Context.getClassLoader();

final Enumeration<URL> resources;

try {

resources = classLoader.getResources(pomPrefix);

}

catch (final IOException exc) {

return null;

}

final ArrayList<POM> poms = new ArrayList<>();

// recursively list contents of META-INF/maven/ directories

for (final URL resource : new IteratorPlus<>(resources)) {

for (final URL url : FileUtils.listContents(resource)) {

// look for pom.xml files amongst the contents

if (url.getPath().endsWith("/pom.xml")) {

try {

poms.add(new POM(url));

}

catch (final IOException exc) {

// ignore and continue

}

catch (final ParserConfigurationException exc) {

// ignore and continue

}

catch (final SAXException exc) {

// ignore and continue

}

}

}

}

return poms;

}

/**

* Compares two version strings.

* <p>

* Given the variation between versioning styles, there is no single

* comparison method that can possibly be correct 100% of the time. So this

* method works on a "best effort" basis; YMMV.

* </p>

* <p>

* The algorithm is as follows:

* </p>

* <ul>

* <li>Split on non-alphameric characters.</li>

* <li>Compare each token one by one.</li>

* <li>Comparison is numerical when possible (i.e., when an integer can be

* parsed from the token), and lexicographic otherwise.</li>

* <li>If one version string runs out of tokens, the version with additional

* tokens remaining is considered <em>greater than</em> the version without

* additional tokens.</li>

* <li>There is one exception: if two version strings are identical except

* that one has a suffix beginning with a dash ({@code -}), the version with

* suffix will be considered <em>less than</em> the one without a suffix. The

* reason for this is to accommodate the <a

* href="https://semver.org/">SemVer</a> versioning scheme's usage of

* "prerelease" version suffixes. For example, {@code 2.0.0} will compare

* greater than {@code 2.0.0-beta-1}, whereas {@code 2.0.0} will compare less

* than {@code 2.0.0.1}.</li>

* </ul>

*

* @return a negative integer, zero, or a positive integer as the first

* argument is less than, equal to, or greater than the second.

* @see Comparator#compare(Object, Object)

*/

public static int compareVersions(final String v1, final String v2) {

final String[] t1 = v1.split("[^\\w]");

final String[] t2 = v2.split("[^\\w]");

final int size = Math.min(t1.length, t2.length);

for (int i = 0; i < size; i++) {

try {

final long n1 = Long.parseLong(t1[i]);

final long n2 = Long.parseLong(t2[i]);

if (n1 < n2) return -1;

if (n1 > n2) return 1;

}

catch (final NumberFormatException exc) {

final int result = t1[i].compareTo(t2[i]);

if (result != 0) return result;

}

}

if (t1.length == t2.length) return 0; // versions match

// check for SemVer prerelease versions

if (v1.startsWith(v2) && v1.charAt(v2.length()) == '-') {

// v1 is a prerelease version of v2

return -1;

}

if (v2.startsWith(v1) && v2.charAt(v1.length()) == '-') {

// v2 is a prerelease version of v1

return 1;

}

return t1.length < t2.length ? -1 : 1;

}

}