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   * 
43   * @author Benjamin Bentmann
44   */
45  @Component( role = ProfileActivator.class, hint = "file" )
46  public class FileProfileActivator
47      implements ProfileActivator
48  {
49  
50      @Requirement
51      private PathTranslator pathTranslator;
52  
53      public FileProfileActivator setPathTranslator( PathTranslator pathTranslator )
54      {
55          this.pathTranslator = pathTranslator;
56          return this;
57      }
58  
59      public boolean isActive( Profile profile, ProfileActivationContext context, ModelProblemCollector problems )
60      {
61          Activation activation = profile.getActivation();
62  
63          if ( activation == null )
64          {
65              return false;
66          }
67  
68          ActivationFile file = activation.getFile();
69  
70          if ( file == null )
71          {
72              return false;
73          }
74  
75          String path;
76          boolean missing;
77  
78          if ( StringUtils.isNotEmpty( file.getExists() ) )
79          {
80              path = file.getExists();
81              missing = false;
82          }
83          else if ( StringUtils.isNotEmpty( file.getMissing() ) )
84          {
85              path = file.getMissing();
86              missing = true;
87          }
88          else
89          {
90              return false;
91          }
92  
93          RegexBasedInterpolator interpolator = new RegexBasedInterpolator();
94  
95          final File basedir = context.getProjectDirectory();
96  
97          if ( basedir != null )
98          {
99              interpolator.addValueSource( new AbstractValueSource( false )
100             {
101                 public Object getValue( String expression )
102                 {
103                     /*
104                      * NOTE: We intentionally only support ${basedir} and not ${project.basedir} as the latter form
105                      * would suggest that other project.* expressions can be used which is however beyond the design.
106                      */
107                     if ( "basedir".equals( expression ) )
108                     {
109                         return basedir.getAbsolutePath();
110                     }
111                     return null;
112                 }
113             } );
114         }
115         else if ( path.indexOf( "${basedir}" ) >= 0 )
116         {
117             return false;
118         }
119 
120         interpolator.addValueSource( new MapBasedValueSource( context.getUserProperties() ) );
121 
122         interpolator.addValueSource( new MapBasedValueSource( context.getSystemProperties() ) );
123 
124         try
125         {
126             path = interpolator.interpolate( path, "" );
127         }
128         catch ( Exception e )
129         {
130             problems.add( new ModelProblemCollectorRequest( Severity.ERROR, Version.BASE)
131                     .setMessage( "Failed to interpolate file location " + path + " for profile " + profile.getId() + ": " + e.getMessage())
132                     .setLocation( file.getLocation( missing ? "missing" : "exists" ))
133                     .setException( e ));
134             return false;
135         }
136 
137         path = pathTranslator.alignToBaseDirectory( path, basedir );
138 
139         File f = new File( path );
140 
141         if ( !f.isAbsolute() )
142         {
143             return false;
144         }
145 
146         boolean fileExists = f.exists();
147 
148         return missing ? !fileExists : fileExists;
149     }
150 
151 }