/*
 *                 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-2003 Sun
 * Microsystems, Inc. All Rights Reserved.
 */

package org.netbeans.modules.web.dd;

import java.awt.Component;
import java.awt.Dialog;
import java.awt.event.*;
import java.beans.*;
import java.io.*;
import java.util.*;
import javax.swing.JButton;
import javax.swing.event.ChangeListener;

import org.openide.DialogDescriptor;
import org.openide.actions.*;
import org.openide.cookies.*;
import org.openide.filesystems.*;
import org.openide.loaders.*;
import org.openide.nodes.*;
import org.openide.util.HelpCtx;
import org.openide.util.RequestProcessor;

import org.xml.sax.*;
import org.w3c.dom.Document;
import org.openide.ErrorManager;
import org.openide.util.NbBundle;

import org.netbeans.modules.web.xmlutils.SAXParseError;
import org.netbeans.modules.web.xmlutils.XMLJ2eeDataObject.J2eeErrorHandler;
import org.openide.xml.XMLUtil;
import org.openide.xml.EntityCatalog;

import org.netbeans.modules.web.dd.event.*;
import org.netbeans.api.web.dd.*;
import org.netbeans.api.xml.cookies.ValidateXMLCookie;
import org.netbeans.spi.xml.cookies.*;
import org.openide.DialogDisplayer;
import org.netbeans.modules.web.dd.impl.WebAppProxy;
import org.netbeans.api.java.classpath.ClassPath;
import org.netbeans.api.java.project.JavaProjectConstants;
import org.netbeans.api.project.FileOwnerQuery;
import org.netbeans.api.project.Project;
import org.netbeans.api.project.ProjectUtils;

import org.netbeans.modules.web.api.webmodule.WebModule;
import org.netbeans.api.project.SourceGroup;
import org.netbeans.api.project.Sources;

/** Represents a DD object in the Repository.
 *
 * @author  mkuchtiak
 */
public class DDDataObject extends DD2beansDataObject 
    implements DDChangeListener, WebAppProxy.OutputProvider, FileChangeListener, ChangeListener {
    private WebApp webApp;
    private FileObject srcRoots[];
    protected final static RequestProcessor RP = new RequestProcessor("XML Parsing");   // NOI18N

    private static final long serialVersionUID = 8857563089355069362L;
    
    /** Property name for documentDTD property */
    public static final String PROP_DOCUMENT_DTD = "documentDTD";   // NOI18N

    //private HashMap webSupportMap,customDataMap;
    private boolean unparsable=true;
    
    /** Holder of documentDTD property value */
    private String documentDTD;
    
    /** List of updates to servlets that should be processed */
    private Vector updates;
    
    private RequestProcessor.Task updateTask;
    private FileObjectObserver fileListener;
    
    public DDDataObject (FileObject pf, DDDataLoader loader) throws DataObjectExistsException {
        super (pf, loader);
        init (pf,loader);
    }
    public boolean isRenameAllowed(){
        return false;
    }
    public boolean isUnparsable(){
        return unparsable;
    }
    
    private void init (FileObject fo,DDDataLoader loader) {
        // added ValidateXMLCookie        
        InputSource in = DataObjectAdapters.inputSource(this);
        ValidateXMLCookie validateCookie = new ValidateXMLSupport(in);
        getCookieSet().add(validateCookie);
        
        //setPrefixMark(""); // NOI18N

        fileListener = new FileObjectObserver(fo);
        
        Project project = FileOwnerQuery.getOwner (getPrimaryFile ());
        if (project != null) {
            Sources sources = ProjectUtils.getSources(project);
            sources.addChangeListener (this);
        }
        refreshSourceFolders ();
    }

    private void refreshSourceFolders () {
        ArrayList srcRootList = new ArrayList ();
        
        Project project = FileOwnerQuery.getOwner (getPrimaryFile ());
        if (project != null) {
            Sources sources = ProjectUtils.getSources(project);
            SourceGroup[] groups = sources.getSourceGroups(JavaProjectConstants.SOURCES_TYPE_JAVA);
            for (int i = 0; i < groups.length; i++) {
                if (WebModule.getWebModule (groups [i].getRootFolder ()) != null) {
                    try {
                        FileObject fo = groups [i].getRootFolder ();
                        srcRootList.add (groups [i].getRootFolder ());
                        FileSystem fs = fo.getFileSystem ();
                        fs.removeFileChangeListener(this); //avoid being added multiple times
                        fs.addFileChangeListener (this);
                    } catch (FileStateInvalidException ex) {
                        ErrorManager.getDefault ().notify (ex);
                    }
                }
            }
        }
        srcRoots = (FileObject []) srcRootList.toArray (new FileObject [srcRootList.size ()]);
    }
    
    private String getPackageName (FileObject clazz) {
        for (int i = 0; i < srcRoots.length; i++) {
            String rp = FileUtil.getRelativePath (srcRoots [i], clazz);
            if (rp != null) {
                if (clazz.getExt ().length () > 0) {
                    rp = rp.substring (0, rp.length () - clazz.getExt ().length () - 1);
                }
                return rp.replace ('/', '.');
            }
        }
        return null;
    }
    
    public WebApp getWebApp(){
        if (webApp==null){
            parsingDocument();
        }

        return webApp;
    }
    
    public WebApp getOriginalWebApp() throws IOException {
        return DDProvider.getDefault().getDDRoot(getPrimaryFile());
    }
    
    protected org.openide.nodes.Node createNodeDelegate () {
        return new DDDataNode(this);
    }

    /**
     * Sets only reasonable mappings (mappings with existing servlet element
     * @param mappings - all mappings
     */    
    public void setReasonableMappings(ServletMapping[] mappings) {
        List newMappings = new ArrayList();
        Servlet[] servlets = webApp.getServlet();
        for (int i=0;inull if documentDTD cannot be obtained.
     */
    public String getDocumentDTD () {
        if (documentDTD == null) {
            WebApp wa = getWebApp ();
        }
        return documentDTD;
    }

    /** This methods gets called when servlet is changed
     * @param evt - object that describes the change.
     */
    public void deploymentChange (DDChangeEvent evt) {
        // fix of #28542, don't add servlet, if it's already defined in DD
        if ( evt.getType() == DDChangeEvent.SERVLET_ADDED && servletDefined( evt.getNewValue() ) )
            return;
        
        synchronized (this) {
            if (updates == null) {
                updates = new Vector ();
            }
            updates.addElement (evt);
        }
        
        // schedule processDDChangeEvent
        if (updateTask == null) {
            updateTask = RequestProcessor.getDefault().post (new Runnable () {
                public void run () {
                    java.util.List changes = null;
                    synchronized (DDDataObject.this) {
                        if (!DDDataObject.this.isValid())
                            return;
                        if (updates != null) {
                            changes = updates;
                            updates = null;
                        }
                    }
                    if (changes != null)
                        showDDChangesDialog (changes);
                }
            }, 2000, Thread.MIN_PRIORITY);
        }
        else {
            updateTask.schedule (2000);
        }
    }
    
    private boolean servletDefined(String classname) {
        WebApp webApp = getWebApp();
        if (webApp==null) return true;
        Servlet[] servlets = webApp.getServlet();
        for ( int i = 0; i < servlets.length; i++ ) {
            if ( servlets[i].getServletClass() != null && servlets[i].getServletClass().equals( classname ) )
                return true;
        }
        return false;
    }
    
    private void showDDChangesDialog (List changes) {
        final JButton processButton;
        final JButton processAllButton;
        final JButton closeButton;
        final DDChangesPanel connectionPanel;
        final DialogDescriptor confirmChangesDescriptor;
        final Dialog confirmChangesDialog[] = { null };
        
        processButton = new JButton (NbBundle.getMessage (DDDataObject.class, "LAB_processButton"));
        processButton.setMnemonic (NbBundle.getMessage (DDDataObject.class, "LAB_processButton_Mnemonic").charAt (0));
        processButton.setToolTipText (NbBundle.getMessage (DDDataObject.class, "ACS_processButtonA11yDesc"));
        processAllButton = new JButton (NbBundle.getMessage (DDDataObject.class, "LAB_processAllButton"));
        processAllButton.setMnemonic (NbBundle.getMessage (DDDataObject.class, "LAB_processAllButton_Mnemonic").charAt (0));
        processAllButton.setToolTipText (NbBundle.getMessage (DDDataObject.class, "ACS_processAllButtonA11yDesc"));
        closeButton = new JButton (NbBundle.getMessage (DDDataObject.class, "LAB_closeButton"));
        closeButton.setMnemonic (NbBundle.getMessage (DDDataObject.class, "LAB_closeButton_Mnemonic").charAt (0));
        closeButton.setToolTipText (NbBundle.getMessage (DDDataObject.class, "ACS_closeButtonA11yDesc"));
        final Object [] options = new Object [] {
            processButton,
            processAllButton
        };
        final Object [] additionalOptions = new Object [] {
            closeButton
        };
        WebModule wm = WebModule.getWebModule(getPrimaryFile ());
        String fsname=""; // NOI18N
        if (wm!=null) {
            fsname=wm.getContextPath();
        }
        String caption = NbBundle.getMessage (DDDataObject.class, "MSG_SynchronizeCaption", fsname);
        connectionPanel = new DDChangesPanel (caption, processButton);
        confirmChangesDescriptor = new DialogDescriptor (
            connectionPanel,
            NbBundle.getMessage (DDDataObject.class, "LAB_ConfirmDialog"),
            true,
            options,
            processButton,
            DialogDescriptor.RIGHT_ALIGN,
            HelpCtx.DEFAULT_HELP,
            new ActionListener () {
                public void actionPerformed (ActionEvent e) {
                    if (e.getSource () instanceof Component) {
                        Component root;

                        // hack to avoid multiple calls for disposed dialogs:
                        root = javax.swing.SwingUtilities.getRoot ((Component)e.getSource ());
                        if (!root.isDisplayable ()) {
                            return;
                        }
                    }
                    if (options[0].equals (e.getSource ())) {
                        int min = connectionPanel.changesList.getMinSelectionIndex ();
                        int max = connectionPanel.changesList.getMaxSelectionIndex ();
                        for (int i = max; i >= min; i--) {
                            if (connectionPanel.changesList.isSelectedIndex (i)) {
                                final DDChangeEvent ev = (DDChangeEvent)connectionPanel.listModel.getElementAt (i);
                                processDDChangeEvent (ev);
                                connectionPanel.listModel.removeElementAt (i);
                            }
                        }
                        if (connectionPanel.listModel.isEmpty ()) {
                            confirmChangesDialog[0].setVisible (false);
                        }
                        else {
                            processButton.setEnabled (false);
                        }
                    }
                    else if (options[1].equals (e.getSource ())) {
                        Enumeration en = connectionPanel.listModel.elements ();
                        while (en.hasMoreElements ()) {
                            processDDChangeEvent ((DDChangeEvent)en.nextElement ());
                        }
                        confirmChangesDialog[0].setVisible (false);
                        connectionPanel.setChanges (null);
                    }
                    else if (additionalOptions[0].equals (e.getSource ())) {
                        confirmChangesDialog[0].setVisible (false);
                        connectionPanel.setChanges (null);
                    }
                }
            }
        );
        confirmChangesDescriptor.setAdditionalOptions (additionalOptions);
        
        processButton.setEnabled (false);
        processAllButton.requestFocus ();
        connectionPanel.setChanges (changes);
        
        try {
            confirmChangesDialog[0] = DialogDisplayer.getDefault ().createDialog (confirmChangesDescriptor);
            confirmChangesDialog[0].show ();
        } finally {
            confirmChangesDialog[0].dispose ();
        }
    }
    
    private void processDDChangeEvent (DDChangeEvent evt) {
        if (!isValid())
            return;
        
        if (evt.getType () == DDChangeEvent.SERVLET_ADDED) {
            String clz = evt.getNewValue ();

            // new from template or copy of another servlet
            String urimapping = "/servlet/"+clz;    // NOI18N
            createDefaultServletConfiguration (clz, urimapping);
        }
        else if (evt.getType () == DDChangeEvent.SERVLET_CHANGED) {
            // update servlet-class in servlet element
            String old = evt.getOldValue ();
            if (old == null)
                return;
            
            Servlet [] servlets = getWebApp ().getServlet ();
            for (int i=0; i0) deletedName = deletedServletName.substring(index+1);
                            boolean found = false;
                            for (int j=0;j0) newName = newFileName.substring(ind+1);
                                if (deletedName.equals(newName)) { // servlet was removed
                                    found=true;
                                    DDChangeEvent ddEvent = 
                                        new DDChangeEvent(DDDataObject.this,DDDataObject.this,deletedServletName,newFileName,DDChangeEvent.SERVLET_CHANGED);
                                    deploymentChange (ddEvent);
                                    synchronized (DDDataObject.this) {
                                        newFileNames.remove(newFileName);
                                    }
                                    break;
                                }
                            }
                            if (!found) {
                                DDChangeEvent ddEvent = 
                                    new DDChangeEvent(DDDataObject.this,DDDataObject.this,null,deletedServletName,DDChangeEvent.SERVLET_DELETED);
                                deploymentChange (ddEvent);                                
                            }
                        } //end for
                        synchronized (DDDataObject.this) {
                            deletedServletNames=null;
                        }
                    } // servlets
                    if (deletedFilterNames!=null) {
                        for (int i=0;i0) deletedName = deletedFilterName.substring(index+1);
                            boolean found = false;
                            for (int j=0;j0) newName = newFileName.substring(ind+1);
                                if (deletedName.equals(newName)) { // filter was removed
                                    found=true;
                                    DDChangeEvent ddEvent = 
                                        new DDChangeEvent(DDDataObject.this,DDDataObject.this,deletedFilterName,newFileName,DDChangeEvent.FILTER_CHANGED);
                                    deploymentChange (ddEvent);
                                    synchronized (DDDataObject.this) {
                                        newFileNames.remove(newFileName);
                                    }
                                    break;
                                }
                            }
                            if (!found) {
                                DDChangeEvent ddEvent = 
                                    new DDChangeEvent(DDDataObject.this,DDDataObject.this,null,deletedFilterName,DDChangeEvent.FILTER_DELETED);
                                deploymentChange (ddEvent);                                
                            }
                        } //end for
                        synchronized (DDDataObject.this) {
                            deletedFilterNames=null;
                        }
                    } // filters
                    if (deletedListenerNames!=null) {
                        for (int i=0;i0) deletedName = deletedListenerName.substring(index+1);
                            boolean found = false;
                            for (int j=0;j0) newName = newFileName.substring(ind+1);
                                if (deletedName.equals(newName)) { // listener was moved
                                    found=true;
                                    DDChangeEvent ddEvent = 
                                        new DDChangeEvent(DDDataObject.this,DDDataObject.this,deletedListenerName,newFileName,DDChangeEvent.LISTENER_CHANGED);
                                    deploymentChange (ddEvent);
                                    synchronized (DDDataObject.this) {
                                        newFileNames.remove(newFileName);
                                    }
                                    break;
                                }
                            }
                            if (!found) {
                                DDChangeEvent ddEvent = 
                                    new DDChangeEvent(DDDataObject.this,DDDataObject.this,null,deletedListenerName,DDChangeEvent.LISTENER_DELETED);
                                deploymentChange (ddEvent);                                
                            }
                        } //end for
                        synchronized (DDDataObject.this) {
                            deletedListenerNames=null;
                        }
                    } // listeners
                    synchronized (DDDataObject.this) {
                        newFileNames=null;
                    }
                }//end run
            }, 1500, Thread.MIN_PRIORITY);
        }
        else {
            elementTask.schedule (1500);
        }        
    }

    public void fileRenamed(org.openide.filesystems.FileRenameEvent fileRenameEvent) {
        String oldName = fileRenameEvent.getName();
        FileObject fo = fileRenameEvent.getFile();
        String resourceName = getPackageName (fo);
        if (resourceName != null && "java".equals(fo.getExt())) { //NOI18N
            int index = resourceName.lastIndexOf("."); //NOI18N
            String oldResourceName = (index>=0?resourceName.substring(0,index+1):"")+oldName;
            WebApp webApp = getWebApp();
            if (webApp.getStatus()==WebApp.STATE_VALID) {
                Servlet servlet = (Servlet)webApp.findBeanByName("Servlet","ServletClass",oldResourceName); //NOI18N
                if (servlet!=null) {
                    DDChangeEvent ddEvent = 
                        new DDChangeEvent(this,this,oldResourceName,resourceName,DDChangeEvent.SERVLET_CHANGED);
                    deploymentChange (ddEvent);
                }
                Listener listener = (Listener)webApp.findBeanByName("Listener","ListenerClass",oldResourceName); //NOI18N
                if (listener!=null) {
                    DDChangeEvent ddEvent = 
                        new DDChangeEvent(this,this,oldResourceName,resourceName,DDChangeEvent.LISTENER_CHANGED);
                    deploymentChange (ddEvent);
                }
                Filter filter = (Filter)webApp.findBeanByName("Filter","FilterClass",oldResourceName); //NOI18N
                if (filter!=null) {
                    DDChangeEvent ddEvent = 
                        new DDChangeEvent(this,this,oldResourceName,resourceName,DDChangeEvent.FILTER_CHANGED);
                    deploymentChange (ddEvent);
                }
            }
        }
    }
    
    public void fileFolderCreated(org.openide.filesystems.FileEvent fileEvent) {
    }
    
    public void fileDeleted(org.openide.filesystems.FileEvent fileEvent) {
        FileObject fo = fileEvent.getFile();
        String resourceName = getPackageName (fo);
        if (resourceName != null && "java".equals(fo.getExt())) { //NOI18N
            boolean foundElement=false;
            if (newFileNames==null) {
                Servlet[] servlets = getWebApp().getServlet();
                for (int i=0;i