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.model.profile.activation;
20  
21  import javax.inject.Inject;
22  import javax.inject.Named;
23  import javax.inject.Singleton;
24  
25  import java.io.File;
26  
27  import org.apache.maven.model.Activation;
28  import org.apache.maven.model.ActivationFile;
29  import org.apache.maven.model.Profile;
30  import org.apache.maven.model.building.ModelProblem.Severity;
31  import org.apache.maven.model.building.ModelProblem.Version;
32  import org.apache.maven.model.building.ModelProblemCollector;
33  import org.apache.maven.model.building.ModelProblemCollectorRequest;
34  import org.apache.maven.model.path.ProfileActivationFilePathInterpolator;
35  import org.apache.maven.model.profile.ProfileActivationContext;
36  import org.codehaus.plexus.interpolation.InterpolationException;
37  import org.codehaus.plexus.util.StringUtils;
38  
39  /**
40   * Determines profile activation based on the existence/absence of some file.
41   * File name interpolation support is limited to <code>${basedir}</code> (since Maven 3,
42   * see <a href="https://issues.apache.org/jira/browse/MNG-2363">MNG-2363</a>),
43   * system properties and user properties.
44   * <code>${project.basedir}</code> is intentionally not supported as this form would suggest that other
45   * <code>${project.*}</code> expressions can be used, which is however beyond the design.
46   *
47   * @author Benjamin Bentmann
48   * @see ActivationFile
49   * @see org.apache.maven.model.validation.DefaultModelValidator#validateRawModel
50   */
51  @Named("file")
52  @Singleton
53  public class FileProfileActivator implements ProfileActivator {
54  
55      @Inject
56      private ProfileActivationFilePathInterpolator profileActivationFilePathInterpolator;
57  
58      public FileProfileActivator setProfileActivationFilePathInterpolator(
59              ProfileActivationFilePathInterpolator profileActivationFilePathInterpolator) {
60          this.profileActivationFilePathInterpolator = profileActivationFilePathInterpolator;
61          return this;
62      }
63  
64      @Override
65      public boolean isActive(Profile profile, ProfileActivationContext context, ModelProblemCollector problems) {
66          Activation activation = profile.getActivation();
67  
68          if (activation == null) {
69              return false;
70          }
71  
72          ActivationFile file = activation.getFile();
73  
74          if (file == null) {
75              return false;
76          }
77  
78          String path;
79          boolean missing;
80  
81          if (StringUtils.isNotEmpty(file.getExists())) {
82              path = file.getExists();
83              missing = false;
84          } else if (StringUtils.isNotEmpty(file.getMissing())) {
85              path = file.getMissing();
86              missing = true;
87          } else {
88              return false;
89          }
90  
91          try {
92              path = profileActivationFilePathInterpolator.interpolate(path, context);
93          } catch (InterpolationException e) {
94              problems.add(new ModelProblemCollectorRequest(Severity.ERROR, Version.BASE)
95                      .setMessage("Failed to interpolate file location " + path + " for profile " + profile.getId() + ": "
96                              + e.getMessage())
97                      .setLocation(file.getLocation(missing ? "missing" : "exists"))
98                      .setException(e));
99              return false;
100         }
101 
102         if (path == null) {
103             return false;
104         }
105 
106         File f = new File(path);
107 
108         if (!f.isAbsolute()) {
109             return false;
110         }
111 
112         boolean fileExists = f.exists();
113 
114         return missing ? !fileExists : fileExists;
115     }
116 
117     @Override
118     public boolean presentInConfig(Profile profile, ProfileActivationContext context, ModelProblemCollector problems) {
119         Activation activation = profile.getActivation();
120 
121         if (activation == null) {
122             return false;
123         }
124 
125         ActivationFile file = activation.getFile();
126 
127         if (file == null) {
128             return false;
129         }
130         return true;
131     }
132 }