maven-compat/src/main/java/org/apache/maven/repository/metadata/DefaultClasspathTransformation.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.maven.repository.metadata;

import javax.inject.Inject;
import javax.inject.Named;
import javax.inject.Singleton;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

import org.apache.maven.artifact.ArtifactScopeEnum;

/**
 * default implementation of the metadata classpath transformer
 *
 *
 */
@Named
@Singleton
@Deprecated
public class DefaultClasspathTransformation implements ClasspathTransformation {
    @Inject
    GraphConflictResolver conflictResolver;

    // ----------------------------------------------------------------------------------------------------
    public ClasspathContainer transform(MetadataGraph dirtyGraph, ArtifactScopeEnum scope, boolean resolve)
            throws MetadataGraphTransformationException {
        try {
            if (dirtyGraph == null || dirtyGraph.isEmpty()) {
                return null;
            }

            MetadataGraph cleanGraph = conflictResolver.resolveConflicts(dirtyGraph, scope);

            if (cleanGraph == null || cleanGraph.isEmpty()) {
                return null;
            }

            ClasspathContainer cpc = new ClasspathContainer(scope);
            if (cleanGraph.isEmptyEdges()) {
                // single entry in the classpath, populated from itself
                ArtifactMetadata amd = cleanGraph.getEntry().getMd();
                cpc.add(amd);
            } else {
                ClasspathGraphVisitor v = new ClasspathGraphVisitor(cleanGraph, cpc);
                MetadataGraphVertex entry = cleanGraph.getEntry();
                // entry point
                v.visit(entry);
            }

            return cpc;
        } catch (GraphConflictResolutionException e) {
            throw new MetadataGraphTransformationException(e);
        }
    }

    // ===================================================================================================
    /**
     * Helper class to traverse graph. Required to make the containing method thread-safe
     * and yet use class level data to lessen stack usage in recursion
     */
    private class ClasspathGraphVisitor {
        MetadataGraph graph;

        ClasspathContainer cpc;

        List<MetadataGraphVertex> visited;

        // -----------------------------------------------------------------------
        protected ClasspathGraphVisitor(MetadataGraph cleanGraph, ClasspathContainer cpc) {
            this.cpc = cpc;
            this.graph = cleanGraph;

            visited = new ArrayList<>(cleanGraph.getVertices().size());
        }

        // -----------------------------------------------------------------------
        protected void visit(MetadataGraphVertex node) // , String version, String artifactUri )
                {
            ArtifactMetadata md = node.getMd();
            if (visited.contains(node)) {
                return;
            }

            cpc.add(md);
            //
            //            TreeSet<MetadataGraphEdge> deps = new TreeSet<MetadataGraphEdge>(
            //                        new Comparator<MetadataGraphEdge>()
            //                        {
            //                            public int compare( MetadataGraphEdge e1
            //                                              , MetadataGraphEdge e2
            //                                              )
            //                            {
            //                                if( e1.getDepth() == e2.getDepth() )
            //                                {
            //                                    if( e2.getPomOrder() == e1.getPomOrder() )
            //                                        return
            // e1.getTarget().toString().compareTo(e2.getTarget().toString() );
            //
            //                                    return e2.getPomOrder() - e1.getPomOrder();
            //                                }
            //
            //                                return e2.getDepth() - e1.getDepth();
            //                            }
            //                        }
            //                    );

            List<MetadataGraphEdge> exits = graph.getExcidentEdges(node);

            if (exits != null && exits.size() > 0) {
                MetadataGraphEdge[] sortedExits = exits.toArray(new MetadataGraphEdge[0]);
                Arrays.sort(sortedExits, (e1, e2) -> {
                    if (e1.getDepth() == e2.getDepth()) {
                        if (e2.getPomOrder() == e1.getPomOrder()) {
                            return e1.getTarget()
                                    .toString()
                                    .compareTo(e2.getTarget().toString());
                        }
                        return e2.getPomOrder() - e1.getPomOrder();
                    }
                    return e2.getDepth() - e1.getDepth();
                });

                for (MetadataGraphEdge e : sortedExits) {
                    MetadataGraphVertex targetNode = e.getTarget();
                    targetNode.getMd().setArtifactScope(e.getScope());
                    targetNode.getMd().setWhy(e.getSource().getMd().toString());
                    visit(targetNode);
                }
            }
        }
        // -----------------------------------------------------------------------
        // -----------------------------------------------------------------------
    }
    // ----------------------------------------------------------------------------------------------------
    // ----------------------------------------------------------------------------------------------------
}