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.path;
20  
21  import java.io.File;
22  import javax.inject.Inject;
23  import javax.inject.Named;
24  import javax.inject.Singleton;
25  import org.apache.maven.api.model.ActivationFile;
26  import org.apache.maven.model.profile.ProfileActivationContext;
27  import org.codehaus.plexus.interpolation.AbstractValueSource;
28  import org.codehaus.plexus.interpolation.InterpolationException;
29  import org.codehaus.plexus.interpolation.MapBasedValueSource;
30  import org.codehaus.plexus.interpolation.RegexBasedInterpolator;
31  
32  /**
33   * Finds an absolute path for {@link ActivationFile#getExists()} or {@link ActivationFile#getMissing()}
34   *
35   * @author Ravil Galeyev
36   */
37  @Named
38  @Singleton
39  public class ProfileActivationFilePathInterpolator {
40  
41      private final PathTranslator pathTranslator;
42  
43      @Inject
44      public ProfileActivationFilePathInterpolator(PathTranslator pathTranslator) {
45          this.pathTranslator = pathTranslator;
46      }
47  
48      /**
49       * Interpolates given {@code path}.
50       *
51       * @return absolute path or {@code null} if the input was {@code null}
52       */
53      public String interpolate(String path, ProfileActivationContext context) throws InterpolationException {
54          if (path == null) {
55              return null;
56          }
57  
58          RegexBasedInterpolator interpolator = new RegexBasedInterpolator();
59  
60          final File basedir = context.getProjectDirectory();
61  
62          if (basedir != null) {
63              interpolator.addValueSource(new AbstractValueSource(false) {
64                  @Override
65                  public Object getValue(String expression) {
66                      /*
67                       * We intentionally only support ${basedir} and not ${project.basedir} as the latter form
68                       * would suggest that other project.* expressions can be used which is beyond the design.
69                       */
70                      if ("basedir".equals(expression)) {
71                          return basedir.getAbsolutePath();
72                      }
73                      return null;
74                  }
75              });
76          } else if (path.contains("${basedir}")) {
77              return null;
78          }
79  
80          interpolator.addValueSource(new MapBasedValueSource(context.getProjectProperties()));
81  
82          interpolator.addValueSource(new MapBasedValueSource(context.getUserProperties()));
83  
84          interpolator.addValueSource(new MapBasedValueSource(context.getSystemProperties()));
85  
86          String absolutePath = interpolator.interpolate(path, "");
87  
88          return pathTranslator.alignToBaseDirectory(absolutePath, basedir);
89      }
90  }