/*
 *                 Sun Public License Notice
 * 
 * The contents of this file are subject to the Sun Public License
 * Version 1.0 (the "License"). You may not use this file except in
 * compliance with the License. A copy of the License is available at
 * http://www.sun.com/
 * 
 * The Original Code is NetBeans. The Initial Developer of the Original
 * Code is Sun Microsystems, Inc. Portions Copyright 1997-2004 Sun
 * Microsystems, Inc. All Rights Reserved.
 */


package org.netbeans.modules.group;

import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;
import java.io.IOException;
import java.text.MessageFormat;
import java.util.ArrayList;
import java.util.List;
import java.util.ListIterator;
import org.openide.ErrorManager;
import org.openide.filesystems.FileObject;
import org.openide.loaders.DataObject;
import org.openide.nodes.Children;
import org.openide.nodes.FilterNode;
import org.openide.nodes.Node;
import org.openide.util.NbBundle;

/** Node representing one link. */
class LinkNode extends FilterNode implements PropertyChangeListener {

    /**
     * pattern for names of nodes - include names of linked objects
     *
     * @see  #displayFormatWOLink
     */
    private static MessageFormat displayFormatWLink;
    /**
     * pattern for names of nodes - names of linked objects missing
     *
     * @see  #displayFormatWLink
     */
    private static MessageFormat displayFormatWOLink;
    /** group this node's link pertains to */
    private final GroupShadow group;
    /**  */
    private String linkedFileName = null;
    /** data object (represented by a node) this link points to */
    private DataObject linkedDataObj = null;


    /**
     * Creates a new LinkNode pointing to a given node.
     *
     * @param  original  node to create a link to
     */
    public LinkNode(GroupShadow group, Node original) {
        super(original);
        
        this.group = group;

        linkedDataObj = (DataObject) original.getCookie(DataObject.class);
        if (linkedDataObj == null) {
            return; // should not happen
        }
        FileObject originalFO = linkedDataObj.getPrimaryFile();
        if (originalFO == null) {
            return; // should not happen
        }
        linkedFileName = GroupShadow.getLinkName(originalFO);

        linkedDataObj.addPropertyChangeListener(this);
    }


    /**
     * LinkNode can be always destroyed, when Group is also allow delete.
     *
     * @return true if Group allow delete.
     */
    public boolean canDestroy () {
        return group.isDeleteAllowed();
    }

    /** Destroys node. */
    public void destroy() throws IOException {
        linkedDataObj.removePropertyChangeListener(this);

        List list = group.readLinks();
        for (int i = 0; i < list.size(); i++) {
            String fileName = (String) list.get(i);
            if (fileName.equals(linkedFileName)) {
                list.remove(i);
                i--;
            }
        }
        group.writeLinks(list);
    }

    /**
     * @return true if the node can be renamed
     */
    public boolean canRename () {
        return super.canRename() && group.isRenameAllowed();
    }

    /**
     * @returns true if this object allows cutting.
     */
    public boolean canCut () {
        return super.canCut() && group.isMoveAllowed();
    }


    /**
     */
    public String getDisplayName() {
        String foldername;
        FileObject primary = linkedDataObj.getPrimaryFile();
        String fullname = primary.getPath();
        int index = fullname.lastIndexOf('/');
        if (index != -1) {
            foldername = fullname.substring(0, index + 1);
        } else {
            foldername = "";                                            //NOI18N
        }
        Object[] objs = new Object[] {linkedDataObj.getName(),
                                      fullname,
                                      foldername,
                                      linkedDataObj.getNodeDelegate()
                                            .getDisplayName()};

        if (group.showLinks) {
            if (displayFormatWLink == null) {
                String pattern = NbBundle.getMessage(
                        LinkNode.class,
                        "FMT_linkWithTarget");                          //NOI18N
                displayFormatWLink = new MessageFormat(pattern);
            }
            return displayFormatWLink.format(objs);
        } else {
            if (displayFormatWOLink == null) {
                String pattern = NbBundle.getMessage(
                        LinkNode.class,
                        "FMT_linkWithoutTarget");                       //NOI18N
                displayFormatWOLink = new MessageFormat(pattern);
            }
            return displayFormatWOLink.format(objs);
        }
    }

    /** Implements PropertyChangeListener. */
    public void propertyChange(PropertyChangeEvent evt) {
        String propertyName = evt.getPropertyName();
        if (propertyName == null) {
            return;
        }
        if (propertyName.equals(DataObject.PROP_PRIMARY_FILE)) {
            
            /* the linked DataObject's primary file has been renamed or moved */
            try {
                List fileNames = new ArrayList(group.readLinks());
                String newFileName = GroupShadow.getLinkName(
                        linkedDataObj.getPrimaryFile());

                for (ListIterator i = fileNames.listIterator(); i.hasNext(); ) {
                    String fileName = (String) i.next();
                    if (fileName.equals(linkedFileName)) {
                        i.set(newFileName);
                    }
                }
                linkedFileName = newFileName;
                group.writeLinks(fileNames);
                fireDisplayNameChange(null, null);
            } catch (IOException ex) {
                ErrorManager errMgr = ErrorManager.getDefault();
                String msg = NbBundle.getMessage(
                        LinkNode.class,
                        "MSG_Cannot_rename_link",                       //NOI18N
                        group.getPrimaryFile().getPath());
                errMgr.notify(ErrorManager.INFORMATIONAL,
                              errMgr.annotate(ex, msg));
            }
        } else if (propertyName.equals(DataObject.PROP_VALID)) {
            
            /* the linked DataObject might have been deleted */
            if (!linkedDataObj.isValid()) {
                linkedDataObj.removePropertyChangeListener(this);
                ((GroupNodeChildren) group.getNodeDelegate().getChildren())
                        .update();
            }
        }
    }
}