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  
38  /**
39   * Determines profile activation based on the existence/absence of some file.
40   * File name interpolation support is limited to <code>${project.basedir}</code>
41   * system properties and user properties.
42   *
43   * @see ActivationFile
44   * @see org.apache.maven.model.validation.DefaultModelValidator#validateRawModel
45   * @deprecated use {@link org.apache.maven.api.services.ModelBuilder} instead
46   */
47  @Named("file")
48  @Singleton
49  @Deprecated(since = "4.0.0")
50  public class FileProfileActivator implements ProfileActivator {
51  
52      private final ProfileActivationFilePathInterpolator profileActivationFilePathInterpolator;
53  
54      @Inject
55      public FileProfileActivator(ProfileActivationFilePathInterpolator profileActivationFilePathInterpolator) {
56          this.profileActivationFilePathInterpolator = profileActivationFilePathInterpolator;
57      }
58  
59      @Override
60      public boolean isActive(Profile profile, ProfileActivationContext context, ModelProblemCollector problems) {
61          Activation activation = profile.getActivation();
62  
63          if (activation == null) {
64              return false;
65          }
66  
67          ActivationFile file = activation.getFile();
68  
69          if (file == null) {
70              return false;
71          }
72  
73          String path;
74          boolean missing;
75  
76          if (file.getExists() != null && !file.getExists().isEmpty()) {
77              path = file.getExists();
78              missing = false;
79          } else if (file.getMissing() != null && !file.getMissing().isEmpty()) {
80              path = file.getMissing();
81              missing = true;
82          } else {
83              return false;
84          }
85  
86          try {
87              path = profileActivationFilePathInterpolator.interpolate(path, context);
88          } catch (InterpolationException e) {
89              problems.add(new ModelProblemCollectorRequest(Severity.ERROR, Version.BASE)
90                      .setMessage("Failed to interpolate file location " + path + " for profile " + profile.getId() + ": "
91                              + e.getMessage())
92                      .setLocation(file.getLocation(missing ? "missing" : "exists"))
93                      .setException(e));
94              return false;
95          }
96  
97          if (path == null) {
98              return false;
99          }
100 
101         File f = new File(path);
102 
103         if (!f.isAbsolute()) {
104             return false;
105         }
106 
107         boolean fileExists = f.exists();
108 
109         return missing != fileExists;
110     }
111 
112     @Override
113     public boolean presentInConfig(Profile profile, ProfileActivationContext context, ModelProblemCollector problems) {
114         Activation activation = profile.getActivation();
115 
116         if (activation == null) {
117             return false;
118         }
119 
120         ActivationFile file = activation.getFile();
121 
122         return file != null;
123     }
124 }