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