View Javadoc
1   package org.apache.maven.model.profile.activation;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import java.io.File;
23  
24  import org.apache.maven.model.Activation;
25  import org.apache.maven.model.ActivationFile;
26  import org.apache.maven.model.Profile;
27  import org.apache.maven.model.building.ModelProblemCollector;
28  import org.apache.maven.model.building.ModelProblem.Severity;
29  import org.apache.maven.model.building.ModelProblem.Version;
30  import org.apache.maven.model.building.ModelProblemCollectorRequest;
31  import org.apache.maven.model.path.PathTranslator;
32  import org.apache.maven.model.profile.ProfileActivationContext;
33  import org.codehaus.plexus.component.annotations.Component;
34  import org.codehaus.plexus.component.annotations.Requirement;
35  import org.codehaus.plexus.interpolation.AbstractValueSource;
36  import org.codehaus.plexus.interpolation.MapBasedValueSource;
37  import org.codehaus.plexus.interpolation.RegexBasedInterpolator;
38  import org.codehaus.plexus.util.StringUtils;
39  
40  /**
41   * Determines profile activation based on the existence/absence of some file.
42   * File name interpolation support is limited to <code>${basedir}</code> (since Maven 3,
43   * see <a href="http://jira.codehaus.org/browse/MNG-2363">MNG-2363</a>),
44   * System properties and request properties.
45   * <code>${project.basedir}</code> is intentionally not supported as this form would suggest that other
46   * <code>${project.*}</code> expressions can be used, which is however beyond the design.
47   *
48   * @author Benjamin Bentmann
49   * @see ActivationFile
50   * @see org.apache.maven.model.validation.DefaultModelValidator#validateRawModel
51   */
52  @Component( role = ProfileActivator.class, hint = "file" )
53  public class FileProfileActivator
54      implements ProfileActivator
55  {
56  
57      @Requirement
58      private PathTranslator pathTranslator;
59  
60      public FileProfileActivator setPathTranslator( PathTranslator pathTranslator )
61      {
62          this.pathTranslator = pathTranslator;
63          return this;
64      }
65  
66      @Override
67      public boolean isActive( Profile profile, ProfileActivationContext context, ModelProblemCollector problems )
68      {
69          Activation activation = profile.getActivation();
70  
71          if ( activation == null )
72          {
73              return false;
74          }
75  
76          ActivationFile file = activation.getFile();
77  
78          if ( file == null )
79          {
80              return false;
81          }
82  
83          String path;
84          boolean missing;
85  
86          if ( StringUtils.isNotEmpty( file.getExists() ) )
87          {
88              path = file.getExists();
89              missing = false;
90          }
91          else if ( StringUtils.isNotEmpty( file.getMissing() ) )
92          {
93              path = file.getMissing();
94              missing = true;
95          }
96          else
97          {
98              return false;
99          }
100 
101         RegexBasedInterpolator interpolator = new RegexBasedInterpolator();
102 
103         final File basedir = context.getProjectDirectory();
104 
105         if ( basedir != null )
106         {
107             interpolator.addValueSource( new AbstractValueSource( false )
108             {
109                 @Override
110                 public Object getValue( String expression )
111                 {
112                     /*
113                      * NOTE: We intentionally only support ${basedir} and not ${project.basedir} as the latter form
114                      * would suggest that other project.* expressions can be used which is however beyond the design.
115                      */
116                     if ( "basedir".equals( expression ) )
117                     {
118                         return basedir.getAbsolutePath();
119                     }
120                     return null;
121                 }
122             } );
123         }
124         else if ( path.contains( "${basedir}" ) )
125         {
126             return false;
127         }
128 
129         interpolator.addValueSource( new MapBasedValueSource( context.getProjectProperties() ) );
130 
131         interpolator.addValueSource( new MapBasedValueSource( context.getUserProperties() ) );
132 
133         interpolator.addValueSource( new MapBasedValueSource( context.getSystemProperties() ) );
134 
135         try
136         {
137             path = interpolator.interpolate( path, "" );
138         }
139         catch ( Exception e )
140         {
141             problems.add( new ModelProblemCollectorRequest( Severity.ERROR, Version.BASE )
142                     .setMessage( "Failed to interpolate file location " + path + " for profile " + profile.getId()
143                                  + ": " + e.getMessage() )
144                     .setLocation( file.getLocation( missing ? "missing" : "exists" ) )
145                     .setException( e ) );
146             return false;
147         }
148 
149         path = pathTranslator.alignToBaseDirectory( path, basedir );
150 
151         // replace activation value with interpolated value
152         if ( missing )
153         {
154             file.setMissing( path );
155         }
156         else
157         {
158             file.setExists( path );
159         }
160 
161         File f = new File( path );
162 
163         if ( !f.isAbsolute() )
164         {
165             return false;
166         }
167 
168         boolean fileExists = f.exists();
169 
170         return missing ? !fileExists : fileExists;
171     }
172 
173     @Override
174     public boolean presentInConfig( Profile profile, ProfileActivationContext context, ModelProblemCollector problems )
175     {
176         Activation activation = profile.getActivation();
177 
178         if ( activation == null )
179         {
180             return false;
181         }
182 
183         ActivationFile file = activation.getFile();
184 
185         if ( file == null )
186         {
187             return false;
188         }
189         return true;
190     }
191 
192 }