php/php.phing/src/org/netbeans/modules/php/phing/PhingBuildTool.java

/*
 * 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.php.phing;

import java.util.Iterator;
import java.util.concurrent.CancellationException;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.Future;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.swing.event.ChangeEvent;
import javax.swing.event.ChangeListener;
import org.netbeans.api.annotations.common.CheckForNull;
import org.netbeans.api.annotations.common.NonNull;
import org.netbeans.api.annotations.common.NullAllowed;
import org.netbeans.api.project.Project;
import org.netbeans.modules.php.phing.exec.PhingExecutable;
import org.netbeans.modules.php.phing.file.PhingTargets;
import org.netbeans.modules.php.phing.file.BuildXml;
import org.netbeans.modules.php.phing.preferences.PhingPreferences;
import org.netbeans.modules.php.phing.ui.customizer.PhingCustomizerProvider;
import org.netbeans.modules.php.phing.util.PhingUtils;
import org.netbeans.modules.web.clientproject.spi.build.BuildToolImplementation;
import org.netbeans.spi.project.ProjectServiceProvider;
import org.netbeans.spi.project.ui.CustomizerProvider2;
import org.openide.DialogDisplayer;
import org.openide.NotifyDescriptor;
import org.openide.filesystems.FileObject;
import org.openide.util.NbBundle;
import org.openide.util.WeakListeners;


@ProjectServiceProvider(
        service = {
            BuildToolImplementation.class,
            PhingBuildTool.class,
        }, projectType = "org-netbeans-modules-php-project" // NOI18N
)
public final class PhingBuildTool implements BuildToolImplementation {

    private static final Logger LOGGER = Logger.getLogger(PhingBuildTool.class.getName());

    public static final String IDENTIFIER = "Phing"; // NOI18N

    private final Project project;
    private final BuildXml projectBuildXml;
    private final PhingTargets projectPhingTargets;
    private final PhingPreferences phingPreferences;
    final ConcurrentMap<FileObject, PhingTargets> phingTargets = new ConcurrentHashMap<>();
    private final ChangeListener cleanupListener = new CleanupListener();


    public PhingBuildTool(Project project) {
        assert project != null;
        this.project = project;
        projectBuildXml = new BuildXml(project.getProjectDirectory());
        projectPhingTargets = PhingTargets.create(project, projectBuildXml);
        phingPreferences = new PhingPreferences(project);
    }

    @NonNull
    public static PhingBuildTool forProject(Project project) {
        PhingBuildTool buildTool = inProject(project);
        assert buildTool != null : "PhingBuildTool should be found in project " + project.getClass().getName() + " (lookup: " + project.getLookup() + ")";
        return buildTool;
    }

    @CheckForNull
    public static PhingBuildTool inProject(Project project) {
        assert project != null;
        return project.getLookup().lookup(PhingBuildTool.class);
    }

    @Override
    public String getIdentifier() {
        return IDENTIFIER;
    }

    @NbBundle.Messages("PhingBuildTool.name=Phing")
    @Override
    public String getDisplayName() {
        return Bundle.PhingBuildTool_name();
    }

    public BuildXml getProjectBuildXml() {
        return projectBuildXml;
    }

    public PhingTargets getProjectPhingTargets() {
        return projectPhingTargets;
    }

    public PhingTargets getPhingTargets(@NullAllowed FileObject buildXml) {
        if (buildXml == null
                || buildXml.getParent().equals(project.getProjectDirectory())) {
            return getProjectPhingTargets();
        }
        PhingTargets targets = phingTargets.get(buildXml);
        if (targets != null) {
            return targets;
        }
        BuildXml file = new BuildXml(buildXml.getParent());
        targets = PhingTargets.create(project, file);
        PhingTargets currentTargets = phingTargets.putIfAbsent(buildXml, targets);
        if (currentTargets != null) {
            return currentTargets;
        }
        // register listener
        file.addChangeListener(WeakListeners.change(cleanupListener, file));
        return targets;
    }

    public PhingPreferences getPhingPreferences() {
        return phingPreferences;
    }

    @Override
    public boolean isEnabled() {
        return projectBuildXml.exists();
    }

    @NbBundle.Messages("PhingBuildTool.configure=Do you want to configure project actions to call Phing targets?")
    @Override
    public boolean run(String commandId, boolean waitFinished, boolean warnUser) {
        assert isEnabled() : project.getProjectDirectory().getNameExt();
        assert projectBuildXml.exists() : project.getProjectDirectory().getNameExt();
        String phingBuild = phingPreferences.getTarget(commandId);
        if (phingBuild != null) {
            PhingExecutable phing = PhingExecutable.getDefault(project, warnUser);
            if (phing != null) {
                PhingUtils.logUsagePhingBuild();
                Future<Integer> result = phing.run(phingBuild.split(" ")); // NOI18N
                if (waitFinished) {
                    try {
                        result.get();
                    } catch (InterruptedException ex) {
                        LOGGER.log(Level.INFO, null, ex);
                    } catch (CancellationException ex) {
                        // cancelled by user
                        LOGGER.log(Level.FINE, null, ex);
                    } catch (ExecutionException ex) {
                        LOGGER.log(Level.INFO, null, ex);
                        if (warnUser) {
                            // XXX open customizer? show error dialog?
                        }
                    }
                }
            }
        } else if (warnUser) {
            Object option = DialogDisplayer.getDefault().notify(
                    new NotifyDescriptor.Confirmation(Bundle.PhingBuildTool_configure(), NotifyDescriptor.YES_NO_OPTION));
            if (option == NotifyDescriptor.YES_OPTION) {
                project.getLookup().lookup(CustomizerProvider2.class).showCustomizer(PhingCustomizerProvider.CUSTOMIZER_IDENT, null);
            }
        }
        return true;
    }

    //~ Inner classes

    private final class CleanupListener implements ChangeListener {

        @Override
        public void stateChanged(ChangeEvent e) {
            Iterator<FileObject> iterator = phingTargets.keySet().iterator();
            while (iterator.hasNext()) {
                FileObject buildXml = iterator.next();
                if (!buildXml.isValid()) {
                    LOGGER.log(Level.FINE, "Removing invalid phing file {0}", buildXml);
                    iterator.remove();
                }
            }
        }

    }

}