FuelPhpModuleCustomizerExtender.java

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2012 Oracle and/or its affiliates. All rights reserved.
 *
 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.
 * Other names may be trademarks of their respective owners.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common
 * Development and Distribution License("CDDL") (collectively, the
 * "License"). You may not use this file except in compliance with the
 * License. You can obtain a copy of the License at
 * http://www.netbeans.org/cddl-gplv2.html
 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
 * specific language governing permissions and limitations under the
 * License.  When distributing the software, include this License Header
 * Notice in each file and include the License file at
 * nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the GPL Version 2 section of the License file that
 * accompanied this code. If applicable, add the following below the
 * License Header, with the fields enclosed by brackets [] replaced by
 * your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * If you wish your version of this file to be governed by only the CDDL
 * or only the GPL Version 2, indicate your decision by adding
 * "[Contributor] elects to include this software in this distribution
 * under the [CDDL or GPL Version 2] license." If you do not indicate a
 * single choice of license, a recipient has the option to distribute
 * your version of this file under either the CDDL, the GPL Version 2 or
 * to extend the choice of license to its licensees as provided above.
 * However, if you add GPL Version 2 code and therefore, elected the GPL
 * Version 2 license, then the option applies only if the new code is
 * made subject to such option by the copyright holder.
 *
 * Contributor(s):
 *
 * Portions Copyrighted 2012 Sun Microsystems, Inc.
 */
package org.netbeans.modules.php.fuel;

import java.beans.PropertyChangeEvent;
import java.util.EnumSet;
import javax.swing.JComponent;
import javax.swing.event.ChangeListener;
import org.netbeans.modules.php.api.phpmodule.PhpModule;
import org.netbeans.modules.php.api.validation.ValidationResult;
import org.netbeans.modules.php.fuel.modules.FuelPhpModule;
import org.netbeans.modules.php.fuel.preferences.FuelPhpPreferences;
import org.netbeans.modules.php.fuel.support.ProjectPropertiesSupport;
import org.netbeans.modules.php.fuel.ui.FuelPhpCustomizerPanel;
import org.netbeans.modules.php.fuel.validator.FuelPhpCustomizerValidator;
import org.netbeans.modules.php.spi.framework.PhpModuleCustomizerExtender;
import org.netbeans.modules.php.spi.framework.PhpModuleCustomizerExtender.Change;
import org.openide.filesystems.FileObject;
import org.openide.util.HelpCtx;
import org.openide.util.NbBundle;

/**
 *
 * @author junichi11
 */
public class FuelPhpModuleCustomizerExtender extends PhpModuleCustomizerExtender {

    private FuelPhpCustomizerPanel panel;
    private final PhpModule phpModule;
    private final String fuelName;
    private final String testCasePrefix;
    private final String testCaseSuffix;
    private final String testGroupAnnotation;
    private final boolean isEnabled;
    private final boolean useAutoCreateFile;
    private final boolean useTestCaseMethod;
    private boolean ignoreMVCNode;
    private boolean isValid;
    private String errorMessage;

    public FuelPhpModuleCustomizerExtender(PhpModule phpModule) {
        this.phpModule = phpModule;
        isEnabled = FuelPhpPreferences.isEnabled(phpModule);
        fuelName = FuelPhpPreferences.getFuelName(phpModule);
        useTestCaseMethod = FuelPhpPreferences.useTestCaseMethod(phpModule);
        ignoreMVCNode = FuelPhpPreferences.ignoreMVCNode(phpModule);
        testCasePrefix = FuelPhpPreferences.getTestCasePrefix(phpModule);
        testCaseSuffix = FuelPhpPreferences.getTestCaseSuffix(phpModule);
        testGroupAnnotation = FuelPhpPreferences.getTestGroupAnnotation(phpModule);
        useAutoCreateFile = FuelPhpPreferences.useAutoCreateFile(phpModule);
    }

    @Override
    @NbBundle.Messages("LBL_FuelPHP=Fuel PHP")
    public String getDisplayName() {
        return Bundle.LBL_FuelPHP();
    }

    @Override
    public void addChangeListener(ChangeListener listener) {
        getPanel().addChangeListener(listener);
    }

    @Override
    public void removeChangeListener(ChangeListener listener) {
        getPanel().removeChangeListener(listener);
    }

    @Override
    public JComponent getComponent() {
        return getPanel();
    }

    @Override
    public HelpCtx getHelp() {
        return null;
    }

    @Override
    public boolean isValid() {
        if (isUplaodFilesOnSave() && ignoreMVCNode == true) {
            ignoreMVCNode = false;
            FuelPhpPreferences.setIgnoreMVCNode(phpModule, ignoreMVCNode);
        }
        validate();
        return isValid;
    }

    @Override
    public String getErrorMessage() {
        validate();
        return errorMessage;
    }

    @NbBundle.Messages("FuelPhpModuleCustomizerExtender.error.source.invalid=Can't find source directory. Project might be broken.")
    void validate() {
        FuelPhpCustomizerPanel customizerPanel = getPanel();
        if (!customizerPanel.isFuelEnabled()) {
            isValid = true;
            errorMessage = null;
            return;
        }

        // get source directory
        FileObject sourceDirectory = phpModule.getSourceDirectory();
        if (sourceDirectory == null) {
            // broken project
            isValid = false;
            errorMessage = Bundle.FuelPhpModuleCustomizerExtender_error_source_invalid();
            return;
        }

        FuelPhpCustomizerValidator validator = new FuelPhpCustomizerValidator()
                .validateOilPath(sourceDirectory)
                .validateFuelDirectoryName(sourceDirectory, customizerPanel.getFuelName());
        ValidationResult result = validator.getResult();
        if (result.hasWarnings()) {
            isValid = false;
            errorMessage = result.getWarnings().get(0).getMessage();
            return;
        }

        // no problem
        isValid = true;
        errorMessage = null;
    }

    @Override
    public EnumSet<Change> save(PhpModule phpModule) {
        EnumSet<Change> enumSet = EnumSet.noneOf(Change.class);
        boolean tempIsEnabled = panel.isFuelEnabled();
        if (tempIsEnabled != isEnabled) {
            FuelPhpPreferences.setEnabled(phpModule, tempIsEnabled);
            enumSet.add(Change.FRAMEWORK_CHANGE);
            FuelPhpModule fuelModule = FuelPhpModule.forPhpModule(phpModule);
            fuelModule.notifyPropertyChanged(new PropertyChangeEvent(this, FuelPhpModule.PROPERTY_CHANGE_FUEL, isValid, isValid));
        }

        boolean tempUseTestCaseMethod = panel.useTestCaseMethod();
        if (useTestCaseMethod != tempUseTestCaseMethod) {
            FuelPhpPreferences.setUseTestCaseMethod(phpModule, tempUseTestCaseMethod);
        }

        boolean tempUseAutoCreateFile = panel.useAutoCreateFile();
        if (useAutoCreateFile != tempUseAutoCreateFile) {
            FuelPhpPreferences.setAutoCreateFile(phpModule, tempUseAutoCreateFile);
        }

        boolean tmpIgnoreMVCNode = panel.ignoreMVCNode();
        if (isUplaodFilesOnSave()) {
            tmpIgnoreMVCNode = false;
        }
        if (ignoreMVCNode != tmpIgnoreMVCNode) {
            FuelPhpPreferences.setIgnoreMVCNode(phpModule, tmpIgnoreMVCNode);
            enumSet.add(Change.IGNORED_FILES_CHANGE);
        }

        String newPrefix = panel.getTestCasePrefixTextField();
        if (!newPrefix.equals(testCasePrefix)) {
            FuelPhpPreferences.setTestCasePrefix(phpModule, newPrefix);
        }

        String newSuffix = panel.getTestCaseSuffixTextField();
        if (!newSuffix.equals(testCaseSuffix)) {
            FuelPhpPreferences.setTestCaseSuffix(phpModule, newSuffix);
        }

        String newGroupAnnotation = panel.getTestGroupAnnotation();
        if (!newGroupAnnotation.equals(testGroupAnnotation)) {
            FuelPhpPreferences.setTestGroupAnnotation(phpModule, newGroupAnnotation);
        }

        String newFuelName = panel.getFuelName();
        if (!newFuelName.equals("") && !newFuelName.equals(fuelName)) { // NOI18N
            FuelPhpPreferences.setFuelName(phpModule, newFuelName);
            return EnumSet.of(Change.FRAMEWORK_CHANGE);
        }

        return enumSet;
    }

    private FuelPhpCustomizerPanel getPanel() {
        if (panel == null) {
            panel = new FuelPhpCustomizerPanel();
            panel.setFuelEnebled(isEnabled);
            panel.setFuelNameTextField(fuelName);
            panel.setUseTestCaseMethod(useTestCaseMethod);
            panel.setIgnoreMVCNode(ignoreMVCNode);
            panel.setTestCasePrefixTextField(testCasePrefix);
            panel.setTestCaseSuffixTextField(testCaseSuffix);
            panel.setTestGroupAnnotation(testGroupAnnotation);
            panel.setAutoCreateFile(useAutoCreateFile);
            panel.setAllComponentsEnabled(isEnabled);
        }
        return panel;
    }

    private boolean isUplaodFilesOnSave() {
        String runAs = ProjectPropertiesSupport.getRunAs(phpModule);
        if (runAs != null && runAs.equals("REMOTE")) { // NOI18N
            String remoteUpload = ProjectPropertiesSupport.getRemoteUpload(phpModule);
            if (remoteUpload != null && remoteUpload.equals("ON_SAVE")) { // NOI18N
                return true;
            }
        }
        return false;
    }
}