/*
* Freeplane - mind map editor
* Copyright (C) 2009 Volker Boerchers
*
* This file author is Volker Boerchers
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package org.freeplane.plugin.script;
import java.awt.event.ActionEvent;
import java.io.File;
import java.util.ArrayList;
import java.util.List;
import org.freeplane.core.ui.AFreeplaneAction;
import org.freeplane.core.util.LogUtils;
import org.freeplane.features.map.IMapSelection;
import org.freeplane.features.map.NodeModel;
import org.freeplane.features.mode.Controller;
import org.freeplane.features.mode.ModeController;
import org.freeplane.features.mode.mindmapmode.MModeController;
/**
* Action that executes a script defined by filename.
*
* @author vboerchers
*/
public class ExecuteScriptAction extends AFreeplaneAction {
private static final long serialVersionUID = 1L;
/** controls how often a script is executed in case of a multi selection. */
public enum ExecutionMode {
/** once with <code>node</code> set to one selected (random) node. */
ON_SINGLE_NODE,
/** n times for n selected nodes, once for each node. */
ON_SELECTED_NODE,
/** script on every selected node and recursively on all of its children. */
ON_SELECTED_NODE_RECURSIVELY
}
private final File scriptFile;
private final ExecutionMode mode;
private final IScript script;
public ExecuteScriptAction(final String scriptName, final String menuItemName, final String scriptFile,
final ExecutionMode mode, final boolean cacheContent, ScriptingPermissions permissions) {
super(ExecuteScriptAction.makeMenuItemKey(scriptName, mode), menuItemName, null);
this.scriptFile = new File(scriptFile);
this.mode = mode;
script = ScriptingEngine.createScriptForFile(this.scriptFile, permissions);
}
public static String makeMenuItemKey(final String scriptName, final ExecutionMode mode) {
return scriptName + "_" + mode.toString().toLowerCase();
}
@Override
public void actionPerformed(final ActionEvent e) {
Controller.getCurrentController().getViewController().setWaitingCursor(true);
try {
final List<NodeModel> nodes = new ArrayList<NodeModel>();
final IMapSelection selection = Controller.getCurrentController().getSelection();
if (mode == ExecutionMode.ON_SINGLE_NODE) {
nodes.add(selection.getSelected());
}
else {
nodes.addAll(selection.getSelection());
}
final MModeController modeController = (MModeController) Controller.getCurrentModeController();
modeController.startTransaction();
for (final NodeModel node : nodes) {
try {
if (mode == ExecutionMode.ON_SELECTED_NODE_RECURSIVELY) {
// TODO: ensure that a script is invoked only once on every node?
// (might be a problem with recursive actions if parent and child
// are selected.)
executeScriptRecursive(node);
}
else {
script.execute(node);
}
}
catch (ExecuteScriptException ex) {
final String cause;
// The ExecuteScriptException should have a cause. Print
// that, it is what we want to know.
if (ex.getCause() != null) {
if (ex.getCause().getCause() != null) {
LogUtils.warn("ExecuteScriptAction failed:", ex.getCause().getCause());
cause = ex.getCause().getCause().toString();
} else {
LogUtils.warn("ExecuteScriptAction failed:", ex.getCause());
cause = ex.getCause().toString();
}
}
else {
LogUtils.warn("ExecuteScriptAction failed:", ex);
cause = ex.toString();
}
LogUtils.warn("error executing script " + scriptFile + " - giving up\n" + cause);
modeController.delayedRollback();
ScriptingEngine.showScriptExceptionErrorMessage(ex);
return;
}
}
modeController.delayedCommit();
}
finally {
Controller.getCurrentController().getViewController().setWaitingCursor(false);
}
}
private void executeScriptRecursive(final NodeModel node) {
ModeController modeController = Controller.getCurrentModeController();
final NodeModel[] children = modeController.getMapController().childrenUnfolded(node)
.toArray(new NodeModel[] {});
for (final NodeModel child : children) {
executeScriptRecursive(child);
}
script.execute(node);
}
}