001package org.apache.maven.model.profile.activation;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *   http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import java.io.File;
023
024import org.apache.maven.model.Activation;
025import org.apache.maven.model.ActivationFile;
026import org.apache.maven.model.Profile;
027import org.apache.maven.model.building.ModelProblemCollector;
028import org.apache.maven.model.building.ModelProblem.Severity;
029import org.apache.maven.model.building.ModelProblem.Version;
030import org.apache.maven.model.building.ModelProblemCollectorRequest;
031import org.apache.maven.model.path.PathTranslator;
032import org.apache.maven.model.profile.ProfileActivationContext;
033import org.codehaus.plexus.component.annotations.Component;
034import org.codehaus.plexus.component.annotations.Requirement;
035import org.codehaus.plexus.interpolation.AbstractValueSource;
036import org.codehaus.plexus.interpolation.MapBasedValueSource;
037import org.codehaus.plexus.interpolation.RegexBasedInterpolator;
038import org.codehaus.plexus.util.StringUtils;
039
040/**
041 * Determines profile activation based on the existence/absence of some file.
042 * File name interpolation support is limited to <code>${basedir}</code> (since Maven 3,
043 * see <a href="https://issues.apache.org/jira/browse/MNG-2363">MNG-2363</a>),
044 * System properties and request properties.
045 * <code>${project.basedir}</code> is intentionally not supported as this form would suggest that other
046 * <code>${project.*}</code> expressions can be used, which is however beyond the design.
047 *
048 * @author Benjamin Bentmann
049 * @see ActivationFile
050 * @see org.apache.maven.model.validation.DefaultModelValidator#validateRawModel
051 */
052@Component( role = ProfileActivator.class, hint = "file" )
053public class FileProfileActivator
054    implements ProfileActivator
055{
056
057    @Requirement
058    private PathTranslator pathTranslator;
059
060    public FileProfileActivator setPathTranslator( PathTranslator pathTranslator )
061    {
062        this.pathTranslator = pathTranslator;
063        return this;
064    }
065
066    @Override
067    public boolean isActive( Profile profile, ProfileActivationContext context, ModelProblemCollector problems )
068    {
069        Activation activation = profile.getActivation();
070
071        if ( activation == null )
072        {
073            return false;
074        }
075
076        ActivationFile file = activation.getFile();
077
078        if ( file == null )
079        {
080            return false;
081        }
082
083        String path;
084        boolean missing;
085
086        if ( StringUtils.isNotEmpty( file.getExists() ) )
087        {
088            path = file.getExists();
089            missing = false;
090        }
091        else if ( StringUtils.isNotEmpty( file.getMissing() ) )
092        {
093            path = file.getMissing();
094            missing = true;
095        }
096        else
097        {
098            return false;
099        }
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}