View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.maven.cli.internal;
20  
21  import javax.inject.Inject;
22  import javax.inject.Named;
23  
24  import java.io.File;
25  import java.util.ArrayList;
26  import java.util.Collections;
27  import java.util.List;
28  import java.util.Set;
29  import java.util.stream.Collectors;
30  
31  import org.apache.maven.RepositoryUtils;
32  import org.apache.maven.cli.internal.extension.model.CoreExtension;
33  import org.apache.maven.execution.MavenExecutionRequest;
34  import org.apache.maven.extension.internal.CoreExports;
35  import org.apache.maven.extension.internal.CoreExtensionEntry;
36  import org.apache.maven.internal.aether.DefaultRepositorySystemSessionFactory;
37  import org.apache.maven.model.Plugin;
38  import org.apache.maven.plugin.PluginResolutionException;
39  import org.apache.maven.plugin.internal.PluginDependenciesResolver;
40  import org.codehaus.plexus.DefaultPlexusContainer;
41  import org.codehaus.plexus.PlexusContainer;
42  import org.codehaus.plexus.classworlds.ClassWorld;
43  import org.codehaus.plexus.classworlds.realm.ClassRealm;
44  import org.codehaus.plexus.interpolation.InterpolationException;
45  import org.codehaus.plexus.interpolation.Interpolator;
46  import org.codehaus.plexus.interpolation.MapBasedValueSource;
47  import org.codehaus.plexus.interpolation.StringSearchInterpolator;
48  import org.codehaus.plexus.logging.Logger;
49  import org.eclipse.aether.RepositorySystemSession;
50  import org.eclipse.aether.artifact.Artifact;
51  import org.eclipse.aether.graph.DependencyFilter;
52  import org.eclipse.aether.repository.RemoteRepository;
53  import org.eclipse.aether.resolution.ArtifactResult;
54  import org.eclipse.aether.resolution.DependencyResult;
55  import org.eclipse.aether.util.filter.ExclusionsDependencyFilter;
56  
57  /**
58   * BootstrapCoreExtensionManager
59   */
60  @Named
61  public class BootstrapCoreExtensionManager {
62      public static final String STRATEGY_PARENT_FIRST = "parent-first";
63      public static final String STRATEGY_PLUGIN = "plugin";
64      public static final String STRATEGY_SELF_FIRST = "self-first";
65  
66      private final Logger log;
67  
68      private final PluginDependenciesResolver pluginDependenciesResolver;
69  
70      private final DefaultRepositorySystemSessionFactory repositorySystemSessionFactory;
71  
72      private final CoreExports coreExports;
73  
74      private final ClassWorld classWorld;
75  
76      private final ClassRealm parentRealm;
77  
78      @Inject
79      public BootstrapCoreExtensionManager(
80              Logger log,
81              PluginDependenciesResolver pluginDependenciesResolver,
82              DefaultRepositorySystemSessionFactory repositorySystemSessionFactory,
83              CoreExports coreExports,
84              PlexusContainer container) {
85          this.log = log;
86          this.pluginDependenciesResolver = pluginDependenciesResolver;
87          this.repositorySystemSessionFactory = repositorySystemSessionFactory;
88          this.coreExports = coreExports;
89          this.classWorld = ((DefaultPlexusContainer) container).getClassWorld();
90          this.parentRealm = container.getContainerRealm();
91      }
92  
93      public List<CoreExtensionEntry> loadCoreExtensions(
94              MavenExecutionRequest request, Set<String> providedArtifacts, List<CoreExtension> extensions)
95              throws Exception {
96          try (RepositorySystemSession.CloseableSession repoSession = repositorySystemSessionFactory
97                  .newRepositorySessionBuilder(request)
98                  .build()) {
99              List<RemoteRepository> repositories = RepositoryUtils.toRepos(request.getPluginArtifactRepositories());
100             Interpolator interpolator = createInterpolator(request);
101 
102             return resolveCoreExtensions(repoSession, repositories, providedArtifacts, extensions, interpolator);
103         }
104     }
105 
106     private List<CoreExtensionEntry> resolveCoreExtensions(
107             RepositorySystemSession repoSession,
108             List<RemoteRepository> repositories,
109             Set<String> providedArtifacts,
110             List<CoreExtension> configuration,
111             Interpolator interpolator)
112             throws Exception {
113         List<CoreExtensionEntry> extensions = new ArrayList<>();
114 
115         DependencyFilter dependencyFilter = new ExclusionsDependencyFilter(providedArtifacts);
116 
117         for (CoreExtension extension : configuration) {
118             List<Artifact> artifacts =
119                     resolveExtension(extension, repoSession, repositories, dependencyFilter, interpolator);
120             if (!artifacts.isEmpty()) {
121                 extensions.add(createExtension(extension, artifacts));
122             }
123         }
124 
125         return Collections.unmodifiableList(extensions);
126     }
127 
128     private CoreExtensionEntry createExtension(CoreExtension extension, List<Artifact> artifacts) throws Exception {
129         String realmId = "coreExtension>" + extension.getGroupId() + ":" + extension.getArtifactId() + ":"
130                 + extension.getVersion();
131         final ClassRealm realm = classWorld.newRealm(realmId, null);
132         Set<String> providedArtifacts = Collections.emptySet();
133         String classLoadingStrategy = extension.getClassLoadingStrategy();
134         if (STRATEGY_PARENT_FIRST.equals(classLoadingStrategy)) {
135             realm.importFrom(parentRealm, "");
136         } else if (STRATEGY_PLUGIN.equals(classLoadingStrategy)) {
137             coreExports.getExportedPackages().forEach((p, cl) -> realm.importFrom(cl, p));
138             providedArtifacts = coreExports.getExportedArtifacts();
139         } else if (STRATEGY_SELF_FIRST.equals(classLoadingStrategy)) {
140             realm.setParentRealm(parentRealm);
141         } else {
142             throw new IllegalArgumentException("Unsupported class-loading strategy '"
143                     + classLoadingStrategy + "'. Supported values are: " + STRATEGY_PARENT_FIRST
144                     + ", " + STRATEGY_PLUGIN + " and " + STRATEGY_SELF_FIRST);
145         }
146         log.debug("Populating class realm " + realm.getId());
147         for (Artifact artifact : artifacts) {
148             String id = artifact.getGroupId() + ":" + artifact.getArtifactId();
149             if (providedArtifacts.contains(id)) {
150                 log.debug("  Excluded " + id);
151             } else {
152                 File file = artifact.getFile();
153                 log.debug("  Included " + id + " located at " + file);
154                 realm.addURL(file.toURI().toURL());
155             }
156         }
157         return CoreExtensionEntry.discoverFrom(
158                 realm, Collections.singleton(artifacts.get(0).getFile()));
159     }
160 
161     private List<Artifact> resolveExtension(
162             CoreExtension extension,
163             RepositorySystemSession repoSession,
164             List<RemoteRepository> repositories,
165             DependencyFilter dependencyFilter,
166             Interpolator interpolator)
167             throws ExtensionResolutionException {
168         try {
169             /* TODO: Enhance the PluginDependenciesResolver to provide a
170              * resolveCoreExtension method which uses a CoreExtension
171              * object instead of a Plugin as this makes no sense.
172              */
173             Plugin plugin = new Plugin();
174             plugin.setGroupId(interpolator.interpolate(extension.getGroupId()));
175             plugin.setArtifactId(interpolator.interpolate(extension.getArtifactId()));
176             plugin.setVersion(interpolator.interpolate(extension.getVersion()));
177 
178             DependencyResult result = pluginDependenciesResolver.resolveCoreExtensionAndFlatten(
179                     plugin, dependencyFilter, repositories, repoSession);
180             return result.getArtifactResults().stream()
181                     .filter(ArtifactResult::isResolved)
182                     .map(ArtifactResult::getArtifact)
183                     .collect(Collectors.toList());
184         } catch (PluginResolutionException | InterpolationException e) {
185             throw new ExtensionResolutionException(extension, e);
186         }
187     }
188 
189     private static Interpolator createInterpolator(MavenExecutionRequest request) {
190         StringSearchInterpolator interpolator = new StringSearchInterpolator();
191         interpolator.addValueSource(new MapBasedValueSource(request.getUserProperties()));
192         interpolator.addValueSource(new MapBasedValueSource(request.getSystemProperties()));
193         return interpolator;
194     }
195 }