Improved scripting support.

Dieser Commit ist enthalten in:
sk89q 2011-01-22 15:38:04 -08:00
Ursprung 9e0bb0730c
Commit 213f1e19f1
4 geänderte Dateien mit 181 neuen und 14 gelöschten Zeilen

Datei anzeigen

@ -2114,8 +2114,10 @@ public class WorldEditController {
* @param player * @param player
* @param filename * @param filename
* @param args * @param args
* @throws WorldEditException
*/ */
public void runScript(LocalPlayer player, String filename, String[] args) { public void runScript(LocalPlayer player, String filename, String[] args)
throws WorldEditException {
File dir = new File("craftscripts"); File dir = new File("craftscripts");
File f = new File(dir, filename); File f = new File(dir, filename);
@ -2174,7 +2176,7 @@ public class WorldEditController {
LocalSession session = getSession(player); LocalSession session = getSession(player);
CraftScriptContext scriptContext = CraftScriptContext scriptContext =
new CraftScriptContext(this, server, config, session, player); new CraftScriptContext(this, server, config, session, player, args);
CraftScriptEngine engine = null; CraftScriptEngine engine = null;
@ -2199,10 +2201,17 @@ public class WorldEditController {
try { try {
engine.evaluate(script, filename, vars); engine.evaluate(script, filename, vars);
} catch (ScriptException e) { } catch (ScriptException e) {
player.printError("Failed to execute:"); player.printError("Failed to execute:");;
player.printRaw(e.getMessage()); player.printRaw(e.getMessage());
} catch (NumberFormatException e) {
throw e;
} catch (WorldEditException e) {
throw e;
} catch (Throwable e) {
player.printError("Failed to execute (exception):");
player.printRaw(e.getClass().getCanonicalName());
} finally { } finally {
for (EditSession editSession : scriptContext._getEditSessions()) { for (EditSession editSession : scriptContext.getEditSessions()) {
session.remember(editSession); session.remember(editSession);
} }
} }

Datei anzeigen

@ -19,10 +19,15 @@
package com.sk89q.worldedit.scripting; package com.sk89q.worldedit.scripting;
import java.io.File;
import java.io.IOException;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.Collections;
import java.util.List; import java.util.List;
import java.util.Set;
import com.sk89q.worldedit.DisallowedItemException; import com.sk89q.worldedit.DisallowedItemException;
import com.sk89q.worldedit.EditSession; import com.sk89q.worldedit.EditSession;
import com.sk89q.worldedit.InsufficientArgumentsException;
import com.sk89q.worldedit.LocalConfiguration; import com.sk89q.worldedit.LocalConfiguration;
import com.sk89q.worldedit.LocalPlayer; import com.sk89q.worldedit.LocalPlayer;
import com.sk89q.worldedit.LocalSession; import com.sk89q.worldedit.LocalSession;
@ -30,17 +35,31 @@ import com.sk89q.worldedit.ServerInterface;
import com.sk89q.worldedit.UnknownItemException; import com.sk89q.worldedit.UnknownItemException;
import com.sk89q.worldedit.WorldEditController; import com.sk89q.worldedit.WorldEditController;
import com.sk89q.worldedit.blocks.BaseBlock; import com.sk89q.worldedit.blocks.BaseBlock;
import com.sk89q.worldedit.patterns.Pattern;
/**
* The context given to scripts.
*
* @author sk89q
*/
public class CraftScriptContext extends CraftScriptEnvironment { public class CraftScriptContext extends CraftScriptEnvironment {
private List<EditSession> editSessions = new ArrayList<EditSession>(); private List<EditSession> editSessions = new ArrayList<EditSession>();
private String[] args;
public CraftScriptContext(WorldEditController controller, public CraftScriptContext(WorldEditController controller,
ServerInterface server, LocalConfiguration config, ServerInterface server, LocalConfiguration config,
LocalSession session, LocalPlayer player) { LocalSession session, LocalPlayer player, String[] args) {
super(controller, server, config, session, player); super(controller, server, config, session, player);
this.args = args;
} }
public EditSession startEditSession() { /**
* Get an edit session. Every subsequent call returns a new edit session.
* Usually you only need to use one edit session.
*
* @return
*/
public EditSession remember() {
EditSession editSession = EditSession editSession =
new EditSession(server, player.getWorld(), new EditSession(server, player.getWorld(),
session.getBlockChangeLimit(), session.getBlockBag(player)); session.getBlockChangeLimit(), session.getBlockBag(player));
@ -48,35 +67,170 @@ public class CraftScriptContext extends CraftScriptEnvironment {
return editSession; return editSession;
} }
/**
* Get the player.
*
* @return
*/
public LocalPlayer getPlayer() { public LocalPlayer getPlayer() {
return player; return player;
} }
/**
* Get the player's session.
*
* @return
*/
public LocalSession getSession() { public LocalSession getSession() {
return session; return session;
} }
/**
* Get the configuration for WorldEdit.
*
* @return
*/
public LocalConfiguration getConfiguration() { public LocalConfiguration getConfiguration() {
return config; return config;
} }
public List<EditSession> _getEditSessions() { /**
return editSessions; * Get a list of edit sessions that have been created.
*
* @return
*/
public List<EditSession> getEditSessions() {
return Collections.unmodifiableList(editSessions);
} }
/**
* Print a regular message to the user.
*
* @param msg
*/
public void print(String msg) { public void print(String msg) {
player.print(msg); player.print(msg);
} }
/**
* Print an error message to the user.
*
* @param msg
*/
public void error(String msg) { public void error(String msg) {
player.printError(msg); player.printError(msg);
} }
public BaseBlock getBlock(String arg) throws UnknownItemException, DisallowedItemException { /**
return controller.getBlock(player, arg, false); * Print an raw message to the user.
*
* @param msg
*/
public void printRaw(String msg) {
player.printRaw(msg);
} }
public BaseBlock getAnyBlock(String arg) throws UnknownItemException, DisallowedItemException { /**
return controller.getBlock(player, arg, true); * Checks to make sure that there are enough but not too many arguments.
*
* @param args
* @param min
* @param max -1 for no maximum
* @param usage usage string
* @throws InsufficientArgumentsException
*/
public void checkArgs(int min, int max, String usage)
throws InsufficientArgumentsException {
if (args.length <= min || (max != -1 && args.length - 1 > max)) {
throw new InsufficientArgumentsException("Usage: " + usage);
}
}
/**
* Get an item ID from an item name or an item ID number.
*
* @param arg
* @param allAllowed true to ignore blacklists
* @return
* @throws UnknownItemException
* @throws DisallowedItemException
*/
public BaseBlock getBlock(String arg, boolean allAllowed)
throws UnknownItemException, DisallowedItemException {
return controller.getBlock(player, arg, allAllowed);
}
/**
* Get a block.
*
* @param id
* @return
* @throws UnknownItemException
* @throws DisallowedItemException
*/
public BaseBlock getBlock(String id)
throws UnknownItemException, DisallowedItemException {
return controller.getBlock(player, id, false);
}
/**
* Get a list of blocks as a set. This returns a Pattern.
*
* @param list
* @return pattern
*/
public Pattern getBlockPattern(String list)
throws UnknownItemException, DisallowedItemException {
return controller.getBlockPattern(player, list);
}
/**
* Get a list of blocks as a set.
*
* @param list
* @param allBlocksAllowed
* @return set
*/
public Set<Integer> getBlockIDs(String list, boolean allBlocksAllowed)
throws UnknownItemException, DisallowedItemException {
return controller.getBlockIDs(player, list, allBlocksAllowed);
}
/**
* Gets the path to a file. This method will check to see if the filename
* has valid characters and has an extension. It also prevents directory
* traversal exploits by checking the root directory and the file directory.
* On success, a <code>java.io.File</code> object will be returned,
* otherwise a null will be returned and the player will be informed.
*
* <p>Use this method if you need to read a file from a directory.</p>
*
* @param folder subdirectory to look in
* @param filename filename (user-submitted)
* @return
*/
public File getSafeFile(String folder, String filename) {
File dir = new File(folder);
File f = new File(dir, filename);
if (!filename.matches("^[A-Za-z0-9_\\- \\./\\\\'\\$@~!%\\^\\*\\(\\)\\[\\]\\+\\{\\},\\?]+\\.[A-Za-z0-9]+$")) {
player.printError("Invalid filename specified.");
return null;
}
try {
String filePath = f.getCanonicalPath();
String dirPath = dir.getCanonicalPath();
if (!filePath.substring(0, dirPath.length()).equals(dirPath)) {
player.printError("File could not read or it does not exist.");
return null;
}
return f;
} catch (IOException e) {
player.printError("File could not read or it does not exist: " + e.getMessage());
return null;
}
} }
} }

Datei anzeigen

@ -26,5 +26,5 @@ public interface CraftScriptEngine {
public void setTimeLimit(int milliseconds); public void setTimeLimit(int milliseconds);
public int getTimeLimit(); public int getTimeLimit();
public Object evaluate(String script, String filename, Map<String, Object> args) public Object evaluate(String script, String filename, Map<String, Object> args)
throws ScriptException; throws ScriptException, Throwable;
} }

Datei anzeigen

@ -40,7 +40,7 @@ public class SunRhinoCraftScriptEngine implements CraftScriptEngine {
@Override @Override
public Object evaluate(final String script, final String filename, public Object evaluate(final String script, final String filename,
final Map<String, Object> args) final Map<String, Object> args)
throws ScriptException { throws ScriptException, Throwable {
SunRhinoContextFactory factory = new SunRhinoContextFactory(timeLimit); SunRhinoContextFactory factory = new SunRhinoContextFactory(timeLimit);
factory.initApplicationClassLoader(WorldEditController.class.getClassLoader()); factory.initApplicationClassLoader(WorldEditController.class.getClassLoader());
@ -62,6 +62,10 @@ public class SunRhinoCraftScriptEngine implements CraftScriptEngine {
} catch (Error e) { } catch (Error e) {
throw new ScriptException(e.getMessage()); throw new ScriptException(e.getMessage());
} catch (RhinoException e) { } catch (RhinoException e) {
if (e instanceof WrappedException) {
throw ((WrappedException)e).getCause();
}
String msg; String msg;
int line = (line = e.lineNumber()) == 0 ? -1 : line; int line = (line = e.lineNumber()) == 0 ? -1 : line;