/projects/netbeans-7.3/javacard.project/src/org/netbeans/modules/javacard/project/JCProjectSourceNodeFactory.java

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 1997-2010 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]"
 *
 * Contributor(s):
 *
 * The Original Software is NetBeans. The Initial Developer of the Original
 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2009 Sun
 * Microsystems, Inc. All Rights Reserved.
 *
 * 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.
 */
package org.netbeans.modules.javacard.project;

import java.awt.Image;
import java.io.IOException;
import org.netbeans.api.java.project.JavaProjectConstants;
import org.netbeans.api.project.Project;
import org.netbeans.api.project.ProjectUtils;
import org.netbeans.api.project.SourceGroup;
import org.netbeans.api.project.Sources;
import org.netbeans.spi.java.project.support.ui.PackageView;
import org.netbeans.spi.project.ui.support.NodeFactory;
import org.netbeans.spi.project.ui.support.NodeFactorySupport;
import org.netbeans.spi.project.ui.support.NodeList;
import org.openide.filesystems.FileObject;
import org.openide.loaders.DataObject;
import org.openide.loaders.DataObjectNotFoundException;
import org.openide.nodes.AbstractNode;
import org.openide.nodes.FilterNode;
import org.openide.nodes.Node;
import org.openide.util.ChangeSupport;
import org.openide.util.Exceptions;
import org.openide.util.NbBundle;
import org.openide.util.lookup.Lookups;

import javax.swing.event.ChangeEvent;
import javax.swing.event.ChangeListener;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import javax.swing.Action;
import javax.swing.JOptionPane;
import javax.swing.SwingUtilities;
import org.netbeans.modules.javacard.project.deps.ui.DependenciesNode;
import org.netbeans.modules.javacard.spi.ProjectKind;
import org.netbeans.spi.actions.Single;
import org.netbeans.validation.api.Problems;
import org.netbeans.validation.api.builtin.stringvalidation.StringValidators;
import org.openide.DialogDisplayer;
import org.openide.NotifyDescriptor;
import org.openide.actions.NewTemplateAction;
import org.openide.actions.PasteAction;
import org.openide.cookies.EditCookie;
import org.openide.cookies.OpenCookie;
import org.openide.filesystems.FileUtil;
import org.openide.loaders.DataFolder;
import org.openide.util.ImageUtilities;
import org.openide.util.actions.SystemAction;
import org.openide.util.lookup.ProxyLookup;
import org.openide.windows.WindowManager;

public class JCProjectSourceNodeFactory implements NodeFactory {

    public NodeList<?> createNodes(Project p) {
        JCProject project =
                p.getLookup().lookup(JCProject.class);
        assert project != null;
        return new JCNodeList(project);
    }

    private static class ImportantFilesNode extends AbstractNode {

        public ImportantFilesNode(JCProject project) {
            super(NodeFactorySupport.createCompositeChildren(project,
                    project.kind().importantFilesPath()),
                    Lookups.singleton(project));
            setDisplayName(NbBundle.getMessage(JCProjectSourceNodeFactory.class,
                    "LBL_IMPORTANT_FILES")); //NOI18N
            setIconBaseWithExtension(
                    "org/netbeans/modules/javacard/resources/importantfiles.png"); //NOI18N
        }
    }

    static enum ProjectNodeKinds {
        IMPORTANT_FILES,
        SCRIPTS_OR_WEB_PAGES,
        LIBRARIES,
    }

    private static class JCNodeList implements NodeList<Object>, ChangeListener {

        private JCProject project;
        private final ChangeSupport changeSupport = new ChangeSupport(this);

        public JCNodeList(JCProject proj) {
            project = proj;
        }

        public List<Object> keys() {
            if (this.project.getProjectDirectory() == null || !this.project.getProjectDirectory().isValid()) {
                return Collections.<Object>emptyList();
            }
            Sources sources = getSources();
            SourceGroup[] groups = sources.getSourceGroups(
                    JavaProjectConstants.SOURCES_TYPE_JAVA);

            List<Object> result = new ArrayList<Object>(groups.length);
            for (int i = 0; i < groups.length; i++) {
                result.add(new SourceGroupKey(groups[i]));
            }
            if (!project.kind().isLibrary()) {
                result.add(ProjectNodeKinds.SCRIPTS_OR_WEB_PAGES);
            }
            result.add(ProjectNodeKinds.IMPORTANT_FILES);
            result.add(ProjectNodeKinds.LIBRARIES);
            return result;
        }

        public void addChangeListener(ChangeListener l) {
            changeSupport.addChangeListener(l);
        }

        public void removeChangeListener(ChangeListener l) {
            changeSupport.removeChangeListener(l);
        }

        public Node node(Object key) {
            if (key instanceof SourceGroupKey) {
                SourceGroupKey sgKey = (SourceGroupKey) key;
                try {
                    return new PackageViewFilterNode(sgKey.group, project);
                } catch (DataObjectNotFoundException ex) {
                    Exceptions.printStackTrace(ex);
                }
            } else if (key instanceof ProjectNodeKinds) {
                switch ((ProjectNodeKinds) key) {
                    case IMPORTANT_FILES :
                        return new ImportantFilesNode(project);
                    case LIBRARIES :
                        return new DependenciesNode(project);
                    case SCRIPTS_OR_WEB_PAGES :
                        try {
                            return new ScriptsNode(project.getProjectDirectory().getFileObject(
                                    project.kind().isApplet() ? "scripts" : "html"), project); //NOI18N
                        } catch (DataObjectNotFoundException ex) {
                            Exceptions.printStackTrace(ex);
                        }
                        break;
                    default :
                        throw new AssertionError(key + ""); //NOI18N

                }
            }
            throw new AssertionError(key.getClass());
        }

        public void addNotify() {
            getSources().addChangeListener(this);
        }

        public void removeNotify() {
            getSources().removeChangeListener(this);
        }

        public void stateChanged(ChangeEvent e) {
            SwingUtilities.invokeLater(new Runnable() {

                public void run() {
                    changeSupport.fireChange();
                }
            });
        }

        private Sources getSources() {
            return ProjectUtils.getSources(project);
        }
    }

    private static class ScriptsNode extends FilterNode {

        ScriptsNode(FileObject fileObject, JCProject project) throws DataObjectNotFoundException {
            this(fileObject == null ? Node.EMPTY : DataObject.find(fileObject).getNodeDelegate(), project);
        }

        private ScriptsNode(Node n, JCProject project) {
            super(n, new FilterNode.Children(n), new ProxyLookup(n.getLookup(), Lookups.fixed(project)));
            disableDelegation(DELEGATE_GET_NAME);
            disableDelegation(DELEGATE_GET_SHORT_DESCRIPTION);
            disableDelegation(DELEGATE_GET_DISPLAY_NAME);
            disableDelegation(DELEGATE_GET_ACTIONS);
            disableDelegation(DELEGATE_SET_NAME);
            disableDelegation(DELEGATE_SET_SHORT_DESCRIPTION);
            disableDelegation(DELEGATE_SET_DISPLAY_NAME);
            setName (n.getName());
            String key = project.kind().isApplet() ? "SCRIPTS_NODE_NAME" : "WEB_PAGES_NODE_NAME"; //NOI18N
            setDisplayName(NbBundle.getMessage(ScriptsNode.class, key));
        }

        @Override
        public Action[] getActions(boolean context) {
            JCProject p = getLookup().lookup(JCProject.class);
            return new Action[]{new AddTemplateAction(p.kind() == ProjectKind.WEB),
                        SystemAction.get(NewTemplateAction.class),
                        SystemAction.get(PasteAction.class)};
        }

        @Override
        public String getHtmlDisplayName() {
            if (getLookup().lookup(DataObject.class) == null) {
                //dir missing
                return "<font color=\"nb.errorForeground\">" + getDisplayName();
            }
            return null;
        }

        @Override
        public Image getIcon(int type) {
            JCProject p = getLookup().lookup(JCProject.class);
            return ImageUtilities.loadImage(p.kind().isApplet() ? "org/netbeans/modules/javacard/resources/scripts.png" : //NOI18N
                    "org/netbeans/modules/javacard/resources/webpages.png"); //NOI18N
        }

        @Override
        public Image getOpenedIcon(int type) {
            return getIcon(type);
        }
    }

    private static final class AddTemplateAction extends Single<DataFolder> {

        private final boolean html;

        AddTemplateAction(boolean html) {
            super(DataFolder.class);
            String key = html ? "ACTION_NEW_HTML" : "ACTION_NEW_SCRIPT"; //NOI18N
            putValue(NAME, NbBundle.getMessage(AddTemplateAction.class, key));
            this.html = html;
        }

        @Override
        protected void actionPerformed(DataFolder target) {
            DataObject tpl = getTemplate();
            assert tpl != null;
            NotifyDescriptor.InputLine line = new NotifyDescriptor.InputLine(
                    NbBundle.getMessage(AddTemplateAction.class,
                    "TTL_NEW_FILE_ACTION"), //NOI18N
                    NbBundle.getMessage(AddTemplateAction.class,
                    "NEW_FILE_ACTION", tpl.getName())); //NOI18N
            if (NotifyDescriptor.OK_OPTION.equals(DialogDisplayer.getDefault().notify(line))) {
                String filename = line.getInputText();
                Problems problems = new Problems();
                StringValidators.REQUIRE_VALID_FILENAME.validate(problems,
                        NbBundle.getMessage(JCProjectSourceNodeFactory.class, 
                        "FILENAME"), filename); //NOI18N
                // TODO validator doesn't work, investigate
                if (filename.length() == 0) {
                    NotifyDescriptor nd = new NotifyDescriptor.Message(
                            NbBundle.getMessage(JCProjectSourceNodeFactory.class, "WARN_FILENAME_INCORRECT"), // NOI18N
                            NotifyDescriptor.WARNING_MESSAGE);

                    DialogDisplayer.getDefault().notify(nd);
                    return;
                }
                
                if (problems.hasFatal()) {
                    NotifyDescriptor nd = new NotifyDescriptor.Message(
                            problems.getLeadProblem().getMessage(), 
                            NotifyDescriptor.WARNING_MESSAGE);

                    DialogDisplayer.getDefault().notify(nd);
                    return;
                }
                try {
                    DataObject ob = tpl.createFromTemplate(target, filename);
                    EditCookie ec = ob.getLookup().lookup(EditCookie.class);
                    if (ec == null) {
                        OpenCookie oc = ob.getLookup().lookup(OpenCookie.class);
                        if (oc != null) {
                            oc.open();
                        }
                    } else {
                        ec.edit();
                    }

                } catch (IOException ex) {
                    JOptionPane.showMessageDialog(WindowManager.getDefault().getMainWindow(),
                            ex.getLocalizedMessage());
                }
            }
        }

        private DataObject getTemplate() {
            String template = html ? "Templates/Other/html.html" : "Templates/Other/ApduTemplate.scr"; //NOI18N
            FileObject fo = FileUtil.getConfigFile(template);
            if (fo != null) {
                try {
                    return DataObject.find(fo);
                } catch (DataObjectNotFoundException ex) {
                    Exceptions.printStackTrace(ex);
                }
            }
            return null;
        }

        @Override
        protected boolean isEnabled(DataFolder target) {
            return getTemplate() != null && target.getPrimaryFile().canWrite();
        }
    }

    private static class SourceGroupKey {

        public final SourceGroup group;
        public final FileObject fileObject;

        SourceGroupKey(SourceGroup group) {
            this.group = group;
            this.fileObject = group.getRootFolder();
        }

        @Override
        public int hashCode() {
            int hash = 5;
            String disp = this.group.getDisplayName();
            hash = 79 * hash + (fileObject != null ? fileObject.hashCode() : 0);
            hash = 79 * hash + (disp != null ? disp.hashCode() : 0);
            return hash;
        }

        @Override
        public boolean equals(Object obj) {
            if (!(obj instanceof SourceGroupKey)) {
                return false;
            } else {
                SourceGroupKey otherKey = (SourceGroupKey) obj;

                if (fileObject != otherKey.fileObject &&
                        (fileObject == null || !fileObject.equals(otherKey.fileObject))) {
                    return false;
                }
                String thisDisplayName = this.group.getDisplayName();
                String otherDisplayName = otherKey.group.getDisplayName();
                boolean oneNull = thisDisplayName == null;
                boolean twoNull = otherDisplayName == null;
                if (oneNull != twoNull || thisDisplayName != null && !thisDisplayName.equals(otherDisplayName)) {
                    return false;
                }
                return true;
            }
        }
    }

    /** Yet another cool filter node just to add properties action
     */
    private static class PackageViewFilterNode extends FilterNode {

        Action[] actions;

        public PackageViewFilterNode(SourceGroup sourceGroup, Project project) throws DataObjectNotFoundException {
            super(sourceGroup instanceof ScriptsSourceGroup ? DataObject.find(sourceGroup.getRootFolder()).getNodeDelegate() : PackageView.createPackageView(sourceGroup));
            if (sourceGroup instanceof ScriptsSourceGroup) {
                super.disableDelegation(DELEGATE_SET_DISPLAY_NAME |
                        DELEGATE_GET_DISPLAY_NAME);
                setDisplayName(sourceGroup.getDisplayName());
            }
        }

        @Override
        public Action[] getActions(boolean context) {
            if (!context) {
                if (actions == null) {
                    Action superActions[] = super.getActions(context);
                    actions = new Action[superActions.length + 1];
                    System.arraycopy(superActions, 0,
                            actions, 0, superActions.length);
                    actions[superActions.length] = null;
                }
                return actions;
            } else {
                return super.getActions(context);
            }
        }
    }
}