All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.netbeans.modules.maven.execute.ModelRunConfig Maven / Gradle / Ivy

The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.netbeans.modules.maven.execute;

import org.netbeans.modules.maven.runjar.MavenExecuteUtils;
import java.util.Arrays;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.NoSuchElementException;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.codehaus.plexus.component.configurator.expression.ExpressionEvaluator;
import org.codehaus.plexus.util.xml.Xpp3Dom;
import org.netbeans.modules.maven.NbMavenProjectImpl;
import org.netbeans.api.project.Project;
import org.netbeans.api.project.ProjectUtils;
import org.netbeans.modules.maven.api.PluginPropertyUtils;
import org.netbeans.modules.maven.execute.model.NetbeansActionMapping;
import org.openide.filesystems.FileObject;
import org.openide.util.Lookup;

/**
 * run configuration backed up by model
 * @author mkleint
 */
public final class ModelRunConfig extends BeanRunConfig {
    
    private static final Logger LOG = Logger.getLogger(ModelRunConfig.class.getName());
    
    private final NetbeansActionMapping model;
    private final boolean fallback;
    
    public static final String EXEC_MERGED = "exec.args.merged";
    private static final String CP_PLACEHOLDER = "___CP___";
    private static final String EXEC_ARGS = MavenExecuteUtils.RUN_PARAMS;
    
    public ModelRunConfig(Project proj, NetbeansActionMapping mod, String actionName, FileObject selectedFile, Lookup lookup, boolean fallback) {
        model = mod;
        this.fallback = fallback;
        NbMavenProjectImpl nbprj = proj.getLookup().lookup(NbMavenProjectImpl.class);
        setProject(nbprj);
        String label = ProjectUtils.getInformation(proj).getDisplayName();
        setExecutionName(label);        
        setTaskDisplayName(label);
        for (Map.Entry entry : model.getProperties().entrySet()) {
            String key = entry.getKey();
            String value = entry.getValue();
            if(EXEC_ARGS.equals(key)) {     
                String defaultArgsTemplate = MavenExecuteUtils.doesNotSpecifyCustomExecArgs(model);
                if (defaultArgsTemplate != null) {
                    String execArgsByPom = getExecArgsByPom(model, proj);
                    if(execArgsByPom != null) {
                        if(execArgsByPom.contains(CP_PLACEHOLDER)) {
                            value = execArgsByPom.replace(CP_PLACEHOLDER, defaultArgsTemplate);                            
                        } else {
                            value = execArgsByPom; 
                        }  
                        setProperty(EXEC_MERGED, "true");
                    }
                }        
            }
            setProperty(key, value);
        }
        setGoals(model.getGoals());
        setExecutionDirectory(ActionToGoalUtils.resolveProjectExecutionBasedir(mod, proj));
        setRecursive(mod.isRecursive());
        setActivatedProfiles(mod.getActivatedProfiles());
        setActionName(actionName);
        setFileObject(selectedFile);
        setActionContext(lookup);
        if (mod.getPreAction() != null) {
            setPreExecution(ActionToGoalUtils.createRunConfig(mod.getPreAction(), nbprj, lookup));
        }
        String react = mod.getReactor();
        if (react != null) {
            if ("am".equals(react) || "also-make".equals(react)) {
                setReactorStyle(ReactorStyle.ALSO_MAKE);
            } else if ("amd".equals(react) || "also-make-dependents".equals(react)) {
                setReactorStyle(ReactorStyle.ALSO_MAKE_DEPENDENTS);
            }
        }
    }

    public boolean isFallback() {
        return fallback;
    }        

    static String getExecArgsByPom(NetbeansActionMapping model, Project proj) {
        if(Boolean.getBoolean("maven.doNotMergePomExecArgs")) { // NOI18N
            return null;
        }
        List goals = model.getGoals();
        for (String goal : goals) {
            if ( goal.matches("org\\.codehaus\\.mojo\\:exec-maven-plugin\\:(.)+\\:exec")) // NOI18N
            {
                NbMavenProjectImpl projectImpl = proj instanceof NbMavenProjectImpl ? (NbMavenProjectImpl)proj : proj.getLookup().lookup(NbMavenProjectImpl.class);
                assert projectImpl != null : "Requires a maven project instance"; // NOI18N
                return PluginPropertyUtils.getPluginPropertyBuildable(projectImpl, "org.codehaus.mojo", "exec-maven-plugin", "exec", new ExecPluginConfigBuilder()); // NOI18N
            }
        }
        return null;
    }
    
    private static class ExecPluginConfigBuilder implements PluginPropertyUtils.ConfigurationBuilder {
        @Override
        public String build(Xpp3Dom configRoot, ExpressionEvaluator eval) {
            if (configRoot != null) {
                Xpp3Dom domArgs = configRoot.getChild("arguments"); // NOI18N
                if (domArgs != null) {
                    Xpp3Dom[] children = domArgs.getChildren();
                    if(children == null || children.length == 0) {
                        return null;
                    }
                    Iterator it = Arrays.asList(children).iterator();
                    StringBuilder sb = new StringBuilder();
                    try {
                        while(it.hasNext()) {
                            Xpp3Dom xpp3Dom = it.next();                            
                            String val = null;
                            if ("argument".equals(xpp3Dom.getName())) { // NOI18N
                                val = xpp3Dom.getValue();
                                if (val == null || val.trim().isEmpty()) {
                                    continue;
                                }
                                val = val.trim();
                                if(val.contains("${")) {                                    
                                    // not evaluated prop? 
                                    LOG.log(Level.FINE, "skipping not evaluated property: {0}", val); // NOI18N
                                    val = null;
                                }
                                if ("-cp".equals(val) || "-classpath".equals(val)) { // NOI18N
                                    val = null;
                                    // the -cp/-classpath parameter is already in exec.args
                                    // lets assume that the following accords to
                                    // -cp/-classpath %classpath mainClass 
                                    // 1.) the classpath tag
                                    Xpp3Dom dom = it.next();                                    
                                    if (dom != null && "classpath".equals(dom.getName())) { // NOI18N
                                        Xpp3Dom[] deps = dom.getChildren("dependency"); // NOI18N
                                        if (deps == null || deps.length == 0) {
                                            // the classpath argument results to '-classpath %classpath'
                                            // and that is already part of exec.args -> set them in the right 
                                            // position as given by pom
                                            val = CP_PLACEHOLDER;
                                        } else {
                                            for (Xpp3Dom dep : deps) {
                                                if(dep != null) {
                                                    String d = dep.getValue();
                                                    if(d != null && !d.trim().isEmpty()) {
                                                        // explicitely declared deps - skip the whole thing.
                                                        // would need to be resolved and we do not want 
                                                        // to reimplement the whole exec plugin 
                                                        LOG.log(Level.FINE, "skipping whole args evaluation due to explicitely declared deps"); // NOI18N
                                                        return null;                                                                                                    
                                                    }
                                                }
                                            }
                                        }
                                    }
                                    // 2.) the main class
                                    // doesn't necessaryli have to be after "-cp %classpath", so do not skip.
                                    // it.next(); 
                                }
                            }
                            if (val != null && !val.isEmpty()) {
                                if (sb.length() > 0) {
                                    sb.append(" "); // NOI18N
                                }
                                sb.append(val);
                            }                            
                        }  
                    } catch (NoSuchElementException e) {
                        // ignore and return what you got
                    }
                    return sb.length() > 0 ? sb.toString() : null;
                }
            }
            return null;
        }
    }    
    
}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy