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(org.apache.maven.model.Model, org.apache.maven.model.building.ModelBuildingRequest, ModelProblemCollector)
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      public boolean isActive( Profile profile, ProfileActivationContext context, ModelProblemCollector problems )
67      {
68          Activation activation = profile.getActivation();
69  
70          if ( activation == null )
71          {
72              return false;
73          }
74  
75          ActivationFile file = activation.getFile();
76  
77          if ( file == null )
78          {
79              return false;
80          }
81  
82          String path;
83          boolean missing;
84  
85          if ( StringUtils.isNotEmpty( file.getExists() ) )
86          {
87              path = file.getExists();
88              missing = false;
89          }
90          else if ( StringUtils.isNotEmpty( file.getMissing() ) )
91          {
92              path = file.getMissing();
93              missing = true;
94          }
95          else
96          {
97              return false;
98          }
99  
100         RegexBasedInterpolator interpolator = new RegexBasedInterpolator();
101 
102         final File basedir = context.getProjectDirectory();
103 
104         if ( basedir != null )
105         {
106             interpolator.addValueSource( new AbstractValueSource( false )
107             {
108                 public Object getValue( String expression )
109                 {
110                     /*
111                      * NOTE: We intentionally only support ${basedir} and not ${project.basedir} as the latter form
112                      * would suggest that other project.* expressions can be used which is however beyond the design.
113                      */
114                     if ( "basedir".equals( expression ) )
115                     {
116                         return basedir.getAbsolutePath();
117                     }
118                     return null;
119                 }
120             } );
121         }
122         else if ( path.contains( "${basedir}" ) )
123         {
124             return false;
125         }
126 
127         interpolator.addValueSource( new MapBasedValueSource( context.getProjectProperties() ) );
128 
129         interpolator.addValueSource( new MapBasedValueSource( context.getUserProperties() ) );
130 
131         interpolator.addValueSource( new MapBasedValueSource( context.getSystemProperties() ) );
132 
133         try
134         {
135             path = interpolator.interpolate( path, "" );
136         }
137         catch ( Exception e )
138         {
139             problems.add( new ModelProblemCollectorRequest( Severity.ERROR, Version.BASE )
140                     .setMessage( "Failed to interpolate file location " + path + " for profile " + profile.getId() + ": " + e.getMessage() )
141                     .setLocation( file.getLocation( missing ? "missing" : "exists" ) )
142                     .setException( e ) );
143             return false;
144         }
145 
146         path = pathTranslator.alignToBaseDirectory( path, basedir );
147 
148         // replace activation value with interpolated value
149         if ( missing )
150         {
151             file.setMissing( path );
152         }
153         else
154         {
155             file.setExists( path );
156         }
157 
158         File f = new File( path );
159 
160         if ( !f.isAbsolute() )
161         {
162             return false;
163         }
164 
165         boolean fileExists = f.exists();
166 
167         return missing ? !fileExists : fileExists;
168     }
169 
170     @Override
171     public boolean presentInConfig( Profile profile, ProfileActivationContext context, ModelProblemCollector problems )
172     {
173         Activation activation = profile.getActivation();
174 
175         if ( activation == null )
176         {
177             return false;
178         }
179 
180         ActivationFile file = activation.getFile();
181 
182         if ( file == null )
183         {
184             return false;
185         }
186         return true;
187     }
188 
189 }