// $Id: ActionSaveProject.java,v 1.34 2004/09/28 19:45:07 mvw Exp $
// Copyright (c) 1996-2004 The Regents of the University of California. All
// Rights Reserved. Permission to use, copy, modify, and distribute this
// software and its documentation without fee, and without a written
// agreement is hereby granted, provided that the above copyright notice
// and this paragraph appear in all copies.  This software program and
// documentation are copyrighted by The Regents of the University of
// California. The software program and documentation are supplied "AS
// IS", without any accompanying services from The Regents. The Regents
// does not warrant that the operation of the program will be
// uninterrupted or error-free. The end-user understands that the program
// was developed for research purposes and is advised not to rely
// exclusively on the program for any reason.  IN NO EVENT SHALL THE
// UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
// SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
// ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
// THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
// SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY
// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
// PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
// CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT,
// UPDATES, ENHANCEMENTS, OR MODIFICATIONS.

package org.argouml.uml.ui;

import java.awt.event.ActionEvent;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.net.URL;
import java.text.MessageFormat;

import javax.swing.JOptionPane;

import org.apache.log4j.Logger;
import org.argouml.application.api.Argo;
import org.argouml.application.api.Configuration;
import org.argouml.i18n.Translator;
import org.argouml.kernel.AbstractFilePersister;
import org.argouml.kernel.ArgoFilePersister;
import org.argouml.kernel.Project;
import org.argouml.kernel.ProjectFilePersister;
import org.argouml.kernel.ProjectManager;
import org.argouml.kernel.XmiFilePersister;
import org.argouml.kernel.ZargoFilePersister;
import org.argouml.ui.ProjectBrowser;
import org.argouml.ui.cmd.GenericArgoMenuBar;

/**
 * Action that saves the project.
 *
 * @see ActionOpenProject
 * @stereotype singleton
 */
public class ActionSaveProject extends UMLAction {
    /** logger */
    private static final Logger LOG = Logger.getLogger(ActionSaveProject.class);
  
    ////////////////////////////////////////////////////////////////
    // static variables

    /**
     * The singleton.
     */
    public static final ActionSaveProject SINGLETON = new ActionSaveProject(); 

    /**
     * To persist to and from zargo (zipped file) storage.
     */
    protected AbstractFilePersister zargoPersister = new ZargoFilePersister();
    
    /**
     * To persist to and from argo (xml file) storage.
     */
    protected AbstractFilePersister argoPersister  = new ArgoFilePersister();
    
    /**
     * To persist to and from XMI file storage.
     */
    protected AbstractFilePersister xmiPersister  = new XmiFilePersister();
    
    ////////////////////////////////////////////////////////////////
    // constructors

    /**
     * The constructor.
     */
    protected ActionSaveProject() {
        super("action.save-project");
    }

    /**
     * The constructor.
     * @param title the title for this action
     * @param icon the icon for this action
     */
    protected ActionSaveProject(String title, boolean icon) {
        super(title, icon);
    }


    ////////////////////////////////////////////////////////////////
    // main methods

    /**
     * @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
     */
    public void actionPerformed(ActionEvent e) {
        URL url =
            ProjectManager.getManager().getCurrentProject() != null
            ? ProjectManager.getManager().getCurrentProject().getURL() : null;
        if (url == null) { 
            ActionSaveProjectAs.SINGLETON.actionPerformed(e);
        } else {
            trySave(true);
        }
    }

    /**
     * Try to save the project.
     * @param overwrite if true, then we overwrite without asking
     * @return true if successful
     */
    public boolean trySave (boolean overwrite) {
        URL url = ProjectManager.getManager().getCurrentProject().getURL();
        return url != null && trySave(overwrite, new File(url.getFile()));
    }

    /**
     * Try to save the project.
     * @param overwrite if true, then we overwrite without asking
     * @param file the File to save to
     * @return true if successful
     */
    public boolean trySave(boolean overwrite, File file) {
	ProjectBrowser pb = ProjectBrowser.getInstance();
	Project project = ProjectManager.getManager().getCurrentProject();

	try {
	    if (file.exists() && !overwrite) {
	        String sConfirm = 
	            MessageFormat.format(Translator.localize("Actions",
	                "optionpane.save-project-confirm-overwrite"),
	                new Object[] {file} );
	        int nResult = 
	            JOptionPane.showConfirmDialog(pb, sConfirm,
                        Translator.localize("Actions", 
            		    "optionpane.save-project-confirm-overwrite-title"),
            				  JOptionPane.YES_NO_OPTION,
            				  JOptionPane.QUESTION_MESSAGE);
            
	        if (nResult != JOptionPane.YES_OPTION) {
	            return false;
	        }
	    }
      
	    String sStatus =
		MessageFormat.format(Translator.localize("Actions",
			"label.save-project-status-writing"),
				     new Object[] {file} );
	    pb.showStatus (sStatus);
		
	    ProjectFilePersister persister = null;
	    String name = file.getName();
	    if (name.endsWith("." + zargoPersister.getExtension())) {
	        persister = zargoPersister;
	    } else if (name.endsWith("." + argoPersister.getExtension())) {
	        persister = argoPersister;
	    } else {
	        throw new IllegalStateException("Filename " + project.getName() 
	        + " is not of a known file type");
	    }
	    
	    project.preSave();
	    persister.save(project, file);
	    project.postSave();

	    sStatus =
		MessageFormat.format(Translator.localize("Actions", 
			"label.save-project-status-wrote"),
				     new Object[] {project.getURL()} );
	    pb.showStatus(sStatus);
	    LOG.debug ("setting most recent project file to "
		       + file.getCanonicalPath());
            
        /* 
         * notification of menu bar
         */
	    GenericArgoMenuBar menuBar = (GenericArgoMenuBar) pb.getJMenuBar();
	    menuBar.addFileSaved( file.getCanonicalPath());
            
	    Configuration.setString(Argo.KEY_MOST_RECENT_PROJECT_FILE,
				    file.getCanonicalPath());
      
	    return true;
	}
	catch (FileNotFoundException fnfe) {
	    String sMessage = 
		MessageFormat.format(Translator.localize("Actions",
		        "optionpane.save-project-file-not-found"),
				     new Object[] {fnfe.getMessage()} );
      
	    JOptionPane.showMessageDialog(pb, sMessage,
	            Translator.localize("Actions",
			    "optionpane.save-project-file-not-found-title"),
					  JOptionPane.ERROR_MESSAGE);
      
	    LOG.error(sMessage, fnfe);
	}
	catch (IOException ioe) {
	    String sMessage = 
		MessageFormat.format(Translator.localize("Actions",
			"optionpane.save-project-io-exception"),
				     new Object[] {ioe.getMessage()} );
      
	    JOptionPane.showMessageDialog(pb, sMessage,
	            Translator.localize("Actions", 
			    "optionpane.save-project-io-exception-title"),
					  JOptionPane.ERROR_MESSAGE);
      
	    LOG.error(sMessage, ioe);
	}
	catch (Exception ex) {
	    String sMessage = 
		MessageFormat.format(Translator.localize("Actions",
			"optionpane.save-project-general-exception"),
				     new Object[] {ex.getMessage()} );
      
	    JOptionPane.showMessageDialog(pb, sMessage,
	            Translator.localize("Actions",
			    "optionpane.save-project-general-exception-title"),
					  JOptionPane.ERROR_MESSAGE);
      
	    LOG.error(sMessage, ex);
	}
    
	return false;
    }

    /**
     * @see org.argouml.uml.ui.UMLAction#shouldBeEnabled()
     */
    public boolean shouldBeEnabled() {
        super.shouldBeEnabled();
        Project p = ProjectManager.getManager().getCurrentProject();
        return (p != null && p.needsSave());
    }
} /* end class ActionSaveProject */