/*
 * Copyright (c) 2009-2010 The Regents of the University of California.
 * All rights reserved.
 *
 * '$Author: crawl $'
 * '$Date: 2015-08-24 22:49:48 +0000 (Mon, 24 Aug 2015) $' 
 * '$Revision: 33636 $'
 * 
 * Permission is hereby granted, without written agreement and without
 * license or royalty fees, to use, copy, modify, and distribute this
 * software and its documentation for any purpose, provided that the above
 * copyright notice and the following two paragraphs appear in all copies
 * of this software.
 *
 * IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
 * FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
 * 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 OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
 * ENHANCEMENTS, OR MODIFICATIONS.
 *
 */

package org.kepler.provenance.gui;

import java.awt.event.ActionEvent;
import java.net.URL;

import javax.swing.ImageIcon;
import javax.swing.JButton;

import org.kepler.gui.KeplerGraphFrame;
import org.kepler.provenance.ProvenanceEnabledListener;
import org.kepler.provenance.ProvenanceRecorder;
import org.kepler.tagging.gui.TagBarUI;

import diva.gui.GUIUtilities;
import ptolemy.actor.CompositeActor;
import ptolemy.actor.gui.Effigy;
import ptolemy.kernel.util.NamedObj;
import ptolemy.util.MessageHandler;
import ptolemy.vergil.toolbox.FigureAction;

/** An action that toggles the default provenance recorder in the top
 *  level workflow container.
 *
 *  @author Daniel Crawl
 *  @version $Id: ProvenanceConfigureAction.java 33636 2015-08-24 22:49:48Z crawl $
 */
public class ProvenanceConfigureAction extends FigureAction implements ProvenanceEnabledListener
{
    public ProvenanceConfigureAction(KeplerGraphFrame owner)
    {
        super("Configure Provenance");

        _button = null;

        // see if the top-level provenance recorder is present so we can
        // set the appropriate icon.

        // get the top-level composite actor
        _top = owner.getModel().toplevel();
        
        _effigy = owner.getEffigy();

        _enabled = turnOnProvenanceRecorder();
        
        String iconStr = OFF_ICON_STR;
        if(_enabled)
        {
            iconStr = ON_ICON_STR;
            
            TagBarUI.addTagEventListener(_recorder, owner);
        }

        // configure the button icons
        GUIUtilities.addIcons(this, new String[][] {
            { iconStr, GUIUtilities.LARGE_ICON },
            { OVER_ICON_STR, GUIUtilities.ROLLOVER_ICON },
            { OVER_ICON_STR, GUIUtilities.ROLLOVER_SELECTED_ICON },
            { OVER_ICON_STR, GUIUtilities.SELECTED_ICON } });
    }

    ///////////////////////////////////////////////////////////////////
    ////                         public methods                    ////

    public void actionPerformed(ActionEvent event)
    {
        super.actionPerformed(event);

        String iconStr = OFF_ICON_STR;
        
        // see if provenance is turned on
        if(_enabled)
        {
            try
            {
                // turn provenance off
                _recorder.recordingType.setToken(ProvenanceRecorder.DEFAULT_REC_TYPE_IGNORE);
                // set the recording type to be persistent so that 
                // provenance is off when reloading the model
               // _recorder.recordingType.setPersistent(true);
                _enabled = false;
                //_effigy.setModified(true);
            }
            catch(Throwable t)
            {
                MessageHandler.error("Error disabling provenance.", t);
                iconStr = ON_ICON_STR;
            }
        }
        else if(!ProvenanceRecorder.containsSupportedDirector((CompositeActor)_top))
        {
            MessageHandler.error("Cannot record provenance for director " +
                ((CompositeActor)_top).getDirector().getName());
        }
        else if(turnOnProvenanceRecorder())
        {
            iconStr = ON_ICON_STR;
        }

        URL img = getClass().getResource(iconStr);
        ImageIcon icon = new ImageIcon(img);
        _button.setIcon(icon);
    }

    /** This method is called when provenance is enabled or disabled.
     *  @param enabled True if provenance is enabled.
     */
        public void toggle(boolean enabled)
        {               
                // see if provenance was turned off, but button is in on state.
                if(!enabled && _enabled)
                {
                URL img = getClass().getResource(OFF_ICON_STR);
                ImageIcon icon = new ImageIcon(img);
                _button.setIcon(icon);
                _enabled = false;
                }
        }

    /** Set the button. */
    public void setButton(JButton button)
    {
        _button = button;
    }

    ///////////////////////////////////////////////////////////////////
    ////                         public fields                     ////

    /** Icon when top-level recorder is present. */
    public static final String ON_ICON_STR =
        "/org/kepler/provenance/gui/img/prov_on.gif";

    /** Icon when top-level recorder is not present. */
    public static final String OFF_ICON_STR =
        "/org/kepler/provenance/gui/img/prov_off.gif";

    /** Icon when cursor over button. */
    public static final String OVER_ICON_STR =
        "/org/kepler/provenance/gui/img/prov_ov.gif";

    ///////////////////////////////////////////////////////////////////
    ////                         private methods                   ////

    /** Add the default provenance recorder if it does not exist, and
     *  turn on provenance recording unless the director is not supported,
     *  or the default recording type is set to ignore.
     *  @return True if the recorder was successfully added and the recording
     *  type was not set to ignore.
     */
    private boolean turnOnProvenanceRecorder()
    {
        try
        {
            _enabled = ProvenanceRecorder.addProvenanceRecorder((CompositeActor)_top, this, _effigy);
            if(_recorder == null)
            {
                _recorder = ProvenanceRecorder.getDefaultProvenanceRecorder(_top);
            }
        }
        catch(Exception e)
        {
            MessageHandler.error("ERROR: Unable to create and configure " +
                "default provenance recorder.", e);
        }

        return _enabled;
    }

    ///////////////////////////////////////////////////////////////////
    ////                         private fields                    ////

    /** The button for this action. */
    private JButton _button;

    /** True if TOP provenance recorder is turned on. */
    private boolean _enabled;

    /** Effigy of top level. */
    private Effigy _effigy;
   
    /** Top-level provenance recorder, if found. */
    private ProvenanceRecorder _recorder;

    /** Top-level NamedObj. */
    private NamedObj _top;
}