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.plugins.artifact.buildinfo;
20  
21  import java.util.Map;
22  
23  import org.apache.maven.model.Plugin;
24  import org.apache.maven.project.MavenProject;
25  import org.codehaus.plexus.util.xml.Xpp3Dom;
26  
27  /**
28   * Plugin utility to detect if install or deploy is skipped in a build, or even nexus-staging.
29   * It supports both disabling by parameter configuration or property.
30   * Known limitation: it does not look at configuration done more precisely at plugin execution level.
31   */
32  class PluginUtil {
33      private static final String NEXUS_STAGING = "nexus-staging";
34  
35      static boolean isSkip(MavenProject project) {
36          return isSkip(project, "install") || isSkip(project, "deploy") || isSkip(project, NEXUS_STAGING);
37      }
38  
39      private static boolean isSkip(MavenProject project, String id) {
40          String pluginGa;
41          String pluginParameter;
42          String pluginProperty;
43          if (id.equals(NEXUS_STAGING)) {
44              pluginGa = "org.sonatype.plugins:" + id + "-maven-plugin";
45              pluginParameter = "skipNexusStagingDeployMojo";
46              pluginProperty = "skipNexusStagingDeployMojo";
47          } else {
48              pluginGa = "org.apache.maven.plugins:maven-" + id + "-plugin";
49              pluginParameter = "skip";
50              pluginProperty = "maven." + id + ".skip";
51          }
52  
53          Plugin plugin = getPlugin(project, pluginGa);
54          String skip = getPluginParameter(plugin, pluginParameter);
55          if (skip == null) {
56              skip = project.getProperties().getProperty(pluginProperty);
57          }
58          return Boolean.parseBoolean(skip);
59      }
60  
61      private static Plugin getPlugin(MavenProject project, String plugin) {
62          Map<String, Plugin> pluginsAsMap = project.getBuild().getPluginsAsMap();
63          Plugin result = pluginsAsMap.get(plugin);
64          if (result == null) {
65              pluginsAsMap = project.getPluginManagement().getPluginsAsMap();
66              result = pluginsAsMap.get(plugin);
67          }
68          return result;
69      }
70  
71      private static String getPluginParameter(Plugin plugin, String parameter) {
72          if (plugin != null) {
73              Xpp3Dom pluginConf = (Xpp3Dom) plugin.getConfiguration();
74  
75              if (pluginConf != null) {
76                  Xpp3Dom target = pluginConf.getChild(parameter);
77  
78                  if (target != null) {
79                      return target.getValue();
80                  }
81              }
82          }
83  
84          return null;
85      }
86  }