new 'plugin' 'ready' and 'command' functions

This commit is contained in:
walterhiggins 2013-01-17 00:05:17 +00:00
parent 5f930b8df3
commit eb42cf3c11
4 changed files with 664 additions and 78 deletions

View file

@ -124,7 +124,7 @@ public class ScriptCraftPlugin extends JavaPlugin
} }
result = true; result = true;
} else if (cmd.getName().equalsIgnoreCase("jsp")){ } else if (cmd.getName().equalsIgnoreCase("jsp")){
javascriptCode = "command.invoke()"; javascriptCode = "command()";
this.engine.put("__cmdArgs",args); this.engine.put("__cmdArgs",args);
result = true; result = true;
} }

View file

@ -1,7 +1,24 @@
/*
This file defines commonly used functions by all plugins...
load (filename) - loads and evaluates a javascript file, returning the evaluated object.
save (object, filename) - saves an object to a file.
plugin (name, interface, isPersistent) - defines a new plugin. If isPersistent is true then
the plugin doesn't have to worry about loading and saving
state - that will be done by the framework. Just make sure
that anything you want to save (and restore) is in the 'store'
property - this will be created automatically if not already defined.
(its type is object {} )
ready (function) - specifies code to be executed only when all the plugins have loaded.
command (name, function) - defines a command that can be used by non-operators.
*/
var global = this; var global = this;
var verbose = verbose || false; var verbose = true;//verbose || false;
var ScriptCraft = ScriptCraft || {};
ScriptCraft.core = ScriptCraft.core || {};
// //
// private implementation // private implementation
// //
@ -11,13 +28,23 @@ ScriptCraft.core = ScriptCraft.core || {};
// //
if (typeof load == "function") if (typeof load == "function")
return ; return ;
var _canonize = function(file){ return file.getCanonicalPath().replaceAll("\\\\","/"); };
var _originalScript = __script; var _originalScript = __script;
//importPackage(java.io); var parentFileObj = new java.io.File(__script).getParentFile();
var _canonize = function(file){ var jsPluginsRootDir = parentFileObj.getParentFile();
return file.getCanonicalPath().replaceAll("\\\\","/"); var jsPluginsRootDirName = _canonize(jsPluginsRootDir);
};
var _load = function(filename){
/*
Load the contents of the file and evaluate as javascript
*/
var _load = function(filename)
{
var result = null;
var file = new java.io.File(filename); var file = new java.io.File(filename);
var canonizedFilename = _canonize(file); var canonizedFilename = _canonize(file);
@ -30,11 +57,17 @@ ScriptCraft.core = ScriptCraft.core || {};
var reader = new java.io.FileReader(file); var reader = new java.io.FileReader(file);
__engine.put("__script",canonizedFilename); __engine.put("__script",canonizedFilename);
__engine.put("__folder",(parent?_canonize(parent):"")+"/"); __engine.put("__folder",(parent?_canonize(parent):"")+"/");
__engine.eval(reader); result = __engine.eval(reader);
}else{ }else{
print("Error: " + canonizedFilename + " not found"); print("Error: " + canonizedFilename + " not found");
} }
return result;
}; };
/*
recursively walk the given directory and return a list of all .js files
*/
var _listJsFiles = function(store,dir) var _listJsFiles = function(store,dir)
{ {
if (typeof dir == "undefined"){ if (typeof dir == "undefined"){
@ -55,6 +88,11 @@ ScriptCraft.core = ScriptCraft.core || {};
} }
} }
}; };
/*
Reload all of the .js files in the given directory
*/
var _reload = function(pluginDir) var _reload = function(pluginDir)
{ {
var jsFiles = []; var jsFiles = [];
@ -73,6 +111,77 @@ ScriptCraft.core = ScriptCraft.core || {};
load(_canonize(jsFiles[i])); load(_canonize(jsFiles[i]));
} }
}; };
/*
Save a javascript object to a file (saves using JSON notation)
*/
var _save = function(object, filename){
var objectToStr = JSON.stringify(object);
var f = new java.io.File(filename);
print(filename);
var out = new java.io.PrintWriter(new java.io.FileWriter(f));
out.println("__data = " + objectToStr);
out.close();
};
/*
plugin mgmt
*/
var _plugins = {};
var _plugin = function(/* String */ moduleName, /* Object */ moduleObject, isPersistent)
{
//
// don't load plugin more than once
//
if (typeof _plugins[moduleName] != "undefined")
return;
var pluginData = {persistent: isPersistent, module: moduleObject};
moduleObject.store = moduleObject.store || {};
_plugins[moduleName] = pluginData;
if (isPersistent)
moduleObject.store = load(jsPluginsRootDirName + "/" + moduleName + "-store.txt") || {};
global[moduleName] = moduleObject;
};
/*
allow for deferred execution (once all modules have loaded)
*/
var _deferred = [];
var _ready = function( func ){
_deferred.push(func);
};
/*
command management - allow for non-ops to execute approved javascript code.
*/
var _commands = {};
var _command = function(name,func){
if (typeof name == "undefined"){
// it's an invocation from the Java Plugin!
if (__cmdArgs.length === 0)
throw new Error("Usage: jsp command-name command-parameters");
var name = __cmdArgs[0];
func = _commands[name]
if (typeof func === "undefined")
throw new Error("Command '" + name + "' does not exist.");
var params = [];
for (var i =1; i < __cmdArgs.length;i++){
params.push("" + __cmdArgs[i]);
}
return func(params);
}else{
_commands[name] = func;
return func;
}
};
/*
Tab Completion of the /js and /jsp commands
*/
var _isJavaObject = function(o){ var _isJavaObject = function(o){
var result = false; var result = false;
try { try {
@ -88,9 +197,11 @@ ScriptCraft.core = ScriptCraft.core || {};
var _getProperties = function(o) var _getProperties = function(o)
{ {
var result = []; var result = [];
if (_isJavaObject(o)){ if (_isJavaObject(o))
{
propertyLoop: propertyLoop:
for (var i in o){ for (var i in o)
{
// //
// don't include standard Object methods // don't include standard Object methods
// //
@ -117,9 +228,23 @@ ScriptCraft.core = ScriptCraft.core || {};
} }
return result.sort(); return result.sort();
}; };
/*
var __onTabComplete2 = function() Tab completion for the /jsp commmand
*/
var __onTabCompleteJSP = function() {
var result = global.__onTC_result;
for (var i in _commands)
result.add(i);
return result;
};
/*
Tab completion for the /js command
*/
var __onTabCompleteJS = function()
{ {
if (__onTC_cmd.name == "jsp")
return __onTabCompleteJSP()
var _globalSymbols = _getProperties(global) var _globalSymbols = _getProperties(global)
var result = global.__onTC_result; var result = global.__onTC_result;
var args = global.__onTC_args; var args = global.__onTC_args;
@ -127,9 +252,9 @@ ScriptCraft.core = ScriptCraft.core || {};
var statement = args.join(" "); var statement = args.join(" ");
statement = statement.replace(/^\s+/,"").replace(/\s+$/,""); statement = statement.replace(/^\s+/,"").replace(/\s+$/,"");
if (statement.length == 0){ if (statement.length == 0)
propsOfLastArg = _globalSymbols; propsOfLastArg = _globalSymbols;
}else{ else{
var statementSyms = statement.split(/[^a-zA-Z0-9_\.]/); var statementSyms = statement.split(/[^a-zA-Z0-9_\.]/);
var lastSymbol = statementSyms[statementSyms.length-1]; var lastSymbol = statementSyms[statementSyms.length-1];
// //
@ -158,54 +283,68 @@ ScriptCraft.core = ScriptCraft.core || {};
// ScriptCraft. // ScriptCraft.
// //
for (var i =0;i < objectProps.length;i++) for (var i =0;i < objectProps.length;i++)
propsOfLastArg.push(statement+objectProps[i]);; propsOfLastArg.push(statement+objectProps[i]);
}else{
}else{
// it looks like this.. // it looks like this..
// ScriptCraft.co // ScriptCraft.co
// //
var li = statement.lastIndexOf(name); var li = statement.lastIndexOf(name);
statement = statement.substring(0,li); statement = statement.substring(0,li);
for (var i = 0; i < objectProps.length;i++){ for (var i = 0; i < objectProps.length;i++)
if (objectProps[i].indexOf(name) == 0){ if (objectProps[i].indexOf(name) == 0)
propsOfLastArg.push(statement + objectProps[i]); propsOfLastArg.push(statement + objectProps[i]);
}
}
} }
}else{ }else{
var objectProps = _getProperties(symbol); var objectProps = _getProperties(symbol);
for (var i = 0; i < objectProps.length; i++){ for (var i = 0; i < objectProps.length; i++)
propsOfLastArg.push(statement + objectProps[i]); propsOfLastArg.push(statement + objectProps[i]);
}
} }
}else{ }else{
// loop thru globalSymbols looking for a good match // loop thru globalSymbols looking for a good match
for (var i = 0;i < _globalSymbols.length; i++){ for (var i = 0;i < _globalSymbols.length; i++)
if (_globalSymbols[i].indexOf(lastSymbol) == 0){ if (_globalSymbols[i].indexOf(lastSymbol) == 0)
propsOfLastArg.push(statement.replace(lastSymbol,_globalSymbols[i])); propsOfLastArg.push(statement.replace(lastSymbol,_globalSymbols[i]));
}
}
} }
} }
for (var i = 0;i < propsOfLastArg.length; i++){ for (var i = 0;i < propsOfLastArg.length; i++)
result.add(propsOfLastArg[i]); result.add(propsOfLastArg[i]);
}
}; };
global._onTabComplete = __onTabComplete2;
global.load = _load;
global.save = _save;
global.reload = _reload;
global.plugin = _plugin;
global.ready = _ready;
global.command = _command;
global._onTabComplete = __onTabCompleteJS;
ScriptCraft.core.load = _load;
ScriptCraft.core.reload = _reload;
for (var f in ScriptCraft.core){
global[f] = ScriptCraft.core[f];
}
ScriptCraft.core.initialized = true;
// //
// assumes this was loaded from js-plugins/core/ // assumes this was loaded from js-plugins/core/
// load all of the plugins.
// //
reload(new java.io.File(__script).getParentFile().getParentFile()); reload(jsPluginsRootDir);
//
// all modules have loaded
//
for (var i =0;i < _deferred.length;i++)
_deferred[i]();
events.on("server.PluginDisableEvent",function(l,e){
//
// save all plugins which have persistent data
//
for (var moduleName in _plugins){
var pluginData = _plugins[moduleName];
if (pluginData.persistent)
save(pluginData.module.store, jsPluginsRootDirName + "/" + moduleName + "-store.txt");
}
});
}()); }());

View file

@ -1,39 +0,0 @@
/*
This module is responsible for managing commands which can be used by non-operator.
Since by default the /js command is op-only , there needs to be a way to expose javascript
functions/plugins to non-ops in a safe controlled way.
This is where the 'command' module comes in. It allows javascript plugin authors to expose
javascript functions for use by non-operators. For example, ordinarily, non-ops don't have
permission to use the `/time set 0` command but this functionality can be exposed like this.
1. Operator / plugin-author creates a javascript function called 'day'
var time_set = function(params){ __plugin.server.worlds.get(0).time = params[0]; };
command.register('time_set');
2. The non-operator can now change the time to day...
/jsp time_set 0
plugin("command", {
register: function(name, func){
this.store[name] = func;
},
invoke: function(){
if (__cmdArgs.length === 0)
throw new Error("Usage: jsp command-name command-parameters");
var name = __cmdArgs[0];
var func = this.store[name]
if (typeof func === "undefined")
throw new Error("Command '" + name + "' does not exist.");
var params = [];
for (var i =1; i < __cmdArgs.length;i++){
params.push("" + __cmdArgs[i]);
}
func(params);
}
});
*/

486
js-plugins/ext/json2.js Normal file
View file

@ -0,0 +1,486 @@
/*
json2.js
2012-10-08
Public Domain.
NO WARRANTY EXPRESSED OR IMPLIED. USE AT YOUR OWN RISK.
See http://www.JSON.org/js.html
This code should be minified before deployment.
See http://javascript.crockford.com/jsmin.html
USE YOUR OWN COPY. IT IS EXTREMELY UNWISE TO LOAD CODE FROM SERVERS YOU DO
NOT CONTROL.
This file creates a global JSON object containing two methods: stringify
and parse.
JSON.stringify(value, replacer, space)
value any JavaScript value, usually an object or array.
replacer an optional parameter that determines how object
values are stringified for objects. It can be a
function or an array of strings.
space an optional parameter that specifies the indentation
of nested structures. If it is omitted, the text will
be packed without extra whitespace. If it is a number,
it will specify the number of spaces to indent at each
level. If it is a string (such as '\t' or '&nbsp;'),
it contains the characters used to indent at each level.
This method produces a JSON text from a JavaScript value.
When an object value is found, if the object contains a toJSON
method, its toJSON method will be called and the result will be
stringified. A toJSON method does not serialize: it returns the
value represented by the name/value pair that should be serialized,
or undefined if nothing should be serialized. The toJSON method
will be passed the key associated with the value, and this will be
bound to the value
For example, this would serialize Dates as ISO strings.
Date.prototype.toJSON = function (key) {
function f(n) {
// Format integers to have at least two digits.
return n < 10 ? '0' + n : n;
}
return this.getUTCFullYear() + '-' +
f(this.getUTCMonth() + 1) + '-' +
f(this.getUTCDate()) + 'T' +
f(this.getUTCHours()) + ':' +
f(this.getUTCMinutes()) + ':' +
f(this.getUTCSeconds()) + 'Z';
};
You can provide an optional replacer method. It will be passed the
key and value of each member, with this bound to the containing
object. The value that is returned from your method will be
serialized. If your method returns undefined, then the member will
be excluded from the serialization.
If the replacer parameter is an array of strings, then it will be
used to select the members to be serialized. It filters the results
such that only members with keys listed in the replacer array are
stringified.
Values that do not have JSON representations, such as undefined or
functions, will not be serialized. Such values in objects will be
dropped; in arrays they will be replaced with null. You can use
a replacer function to replace those with JSON values.
JSON.stringify(undefined) returns undefined.
The optional space parameter produces a stringification of the
value that is filled with line breaks and indentation to make it
easier to read.
If the space parameter is a non-empty string, then that string will
be used for indentation. If the space parameter is a number, then
the indentation will be that many spaces.
Example:
text = JSON.stringify(['e', {pluribus: 'unum'}]);
// text is '["e",{"pluribus":"unum"}]'
text = JSON.stringify(['e', {pluribus: 'unum'}], null, '\t');
// text is '[\n\t"e",\n\t{\n\t\t"pluribus": "unum"\n\t}\n]'
text = JSON.stringify([new Date()], function (key, value) {
return this[key] instanceof Date ?
'Date(' + this[key] + ')' : value;
});
// text is '["Date(---current time---)"]'
JSON.parse(text, reviver)
This method parses a JSON text to produce an object or array.
It can throw a SyntaxError exception.
The optional reviver parameter is a function that can filter and
transform the results. It receives each of the keys and values,
and its return value is used instead of the original value.
If it returns what it received, then the structure is not modified.
If it returns undefined then the member is deleted.
Example:
// Parse the text. Values that look like ISO date strings will
// be converted to Date objects.
myData = JSON.parse(text, function (key, value) {
var a;
if (typeof value === 'string') {
a =
/^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2}(?:\.\d*)?)Z$/.exec(value);
if (a) {
return new Date(Date.UTC(+a[1], +a[2] - 1, +a[3], +a[4],
+a[5], +a[6]));
}
}
return value;
});
myData = JSON.parse('["Date(09/09/2001)"]', function (key, value) {
var d;
if (typeof value === 'string' &&
value.slice(0, 5) === 'Date(' &&
value.slice(-1) === ')') {
d = new Date(value.slice(5, -1));
if (d) {
return d;
}
}
return value;
});
This is a reference implementation. You are free to copy, modify, or
redistribute.
*/
/*jslint evil: true, regexp: true */
/*members "", "\b", "\t", "\n", "\f", "\r", "\"", JSON, "\\", apply,
call, charCodeAt, getUTCDate, getUTCFullYear, getUTCHours,
getUTCMinutes, getUTCMonth, getUTCSeconds, hasOwnProperty, join,
lastIndex, length, parse, prototype, push, replace, slice, stringify,
test, toJSON, toString, valueOf
*/
// Create a JSON object only if one does not already exist. We create the
// methods in a closure to avoid creating global variables.
if (typeof JSON !== 'object') {
JSON = {};
}
(function () {
'use strict';
function f(n) {
// Format integers to have at least two digits.
return n < 10 ? '0' + n : n;
}
if (typeof Date.prototype.toJSON !== 'function') {
Date.prototype.toJSON = function (key) {
return isFinite(this.valueOf())
? this.getUTCFullYear() + '-' +
f(this.getUTCMonth() + 1) + '-' +
f(this.getUTCDate()) + 'T' +
f(this.getUTCHours()) + ':' +
f(this.getUTCMinutes()) + ':' +
f(this.getUTCSeconds()) + 'Z'
: null;
};
String.prototype.toJSON =
Number.prototype.toJSON =
Boolean.prototype.toJSON = function (key) {
return this.valueOf();
};
}
var cx = /[\u0000\u00ad\u0600-\u0604\u070f\u17b4\u17b5\u200c-\u200f\u2028-\u202f\u2060-\u206f\ufeff\ufff0-\uffff]/g,
escapable = /[\\\"\x00-\x1f\x7f-\x9f\u00ad\u0600-\u0604\u070f\u17b4\u17b5\u200c-\u200f\u2028-\u202f\u2060-\u206f\ufeff\ufff0-\uffff]/g,
gap,
indent,
meta = { // table of character substitutions
'\b': '\\b',
'\t': '\\t',
'\n': '\\n',
'\f': '\\f',
'\r': '\\r',
'"' : '\\"',
'\\': '\\\\'
},
rep;
function quote(string) {
// If the string contains no control characters, no quote characters, and no
// backslash characters, then we can safely slap some quotes around it.
// Otherwise we must also replace the offending characters with safe escape
// sequences.
escapable.lastIndex = 0;
return escapable.test(string) ? '"' + string.replace(escapable, function (a) {
var c = meta[a];
return typeof c === 'string'
? c
: '\\u' + ('0000' + a.charCodeAt(0).toString(16)).slice(-4);
}) + '"' : '"' + string + '"';
}
function str(key, holder) {
// Produce a string from holder[key].
var i, // The loop counter.
k, // The member key.
v, // The member value.
length,
mind = gap,
partial,
value = holder[key];
// If the value has a toJSON method, call it to obtain a replacement value.
if (value && typeof value === 'object' &&
typeof value.toJSON === 'function') {
value = value.toJSON(key);
}
// If we were called with a replacer function, then call the replacer to
// obtain a replacement value.
if (typeof rep === 'function') {
value = rep.call(holder, key, value);
}
// What happens next depends on the value's type.
switch (typeof value) {
case 'string':
return quote(value);
case 'number':
// JSON numbers must be finite. Encode non-finite numbers as null.
return isFinite(value) ? String(value) : 'null';
case 'boolean':
case 'null':
// If the value is a boolean or null, convert it to a string. Note:
// typeof null does not produce 'null'. The case is included here in
// the remote chance that this gets fixed someday.
return String(value);
// If the type is 'object', we might be dealing with an object or an array or
// null.
case 'object':
// Due to a specification blunder in ECMAScript, typeof null is 'object',
// so watch out for that case.
if (!value) {
return 'null';
}
// Make an array to hold the partial results of stringifying this object value.
gap += indent;
partial = [];
// Is the value an array?
if (Object.prototype.toString.apply(value) === '[object Array]') {
// The value is an array. Stringify every element. Use null as a placeholder
// for non-JSON values.
length = value.length;
for (i = 0; i < length; i += 1) {
partial[i] = str(i, value) || 'null';
}
// Join all of the elements together, separated with commas, and wrap them in
// brackets.
v = partial.length === 0
? '[]'
: gap
? '[\n' + gap + partial.join(',\n' + gap) + '\n' + mind + ']'
: '[' + partial.join(',') + ']';
gap = mind;
return v;
}
// If the replacer is an array, use it to select the members to be stringified.
if (rep && typeof rep === 'object') {
length = rep.length;
for (i = 0; i < length; i += 1) {
if (typeof rep[i] === 'string') {
k = rep[i];
v = str(k, value);
if (v) {
partial.push(quote(k) + (gap ? ': ' : ':') + v);
}
}
}
} else {
// Otherwise, iterate through all of the keys in the object.
for (k in value) {
if (Object.prototype.hasOwnProperty.call(value, k)) {
v = str(k, value);
if (v) {
partial.push(quote(k) + (gap ? ': ' : ':') + v);
}
}
}
}
// Join all of the member texts together, separated with commas,
// and wrap them in braces.
v = partial.length === 0
? '{}'
: gap
? '{\n' + gap + partial.join(',\n' + gap) + '\n' + mind + '}'
: '{' + partial.join(',') + '}';
gap = mind;
return v;
}
}
// If the JSON object does not yet have a stringify method, give it one.
if (typeof JSON.stringify !== 'function') {
JSON.stringify = function (value, replacer, space) {
// The stringify method takes a value and an optional replacer, and an optional
// space parameter, and returns a JSON text. The replacer can be a function
// that can replace values, or an array of strings that will select the keys.
// A default replacer method can be provided. Use of the space parameter can
// produce text that is more easily readable.
var i;
gap = '';
indent = '';
// If the space parameter is a number, make an indent string containing that
// many spaces.
if (typeof space === 'number') {
for (i = 0; i < space; i += 1) {
indent += ' ';
}
// If the space parameter is a string, it will be used as the indent string.
} else if (typeof space === 'string') {
indent = space;
}
// If there is a replacer, it must be a function or an array.
// Otherwise, throw an error.
rep = replacer;
if (replacer && typeof replacer !== 'function' &&
(typeof replacer !== 'object' ||
typeof replacer.length !== 'number')) {
throw new Error('JSON.stringify');
}
// Make a fake root object containing our value under the key of ''.
// Return the result of stringifying the value.
return str('', {'': value});
};
}
// If the JSON object does not yet have a parse method, give it one.
if (typeof JSON.parse !== 'function') {
JSON.parse = function (text, reviver) {
// The parse method takes a text and an optional reviver function, and returns
// a JavaScript value if the text is a valid JSON text.
var j;
function walk(holder, key) {
// The walk method is used to recursively walk the resulting structure so
// that modifications can be made.
var k, v, value = holder[key];
if (value && typeof value === 'object') {
for (k in value) {
if (Object.prototype.hasOwnProperty.call(value, k)) {
v = walk(value, k);
if (v !== undefined) {
value[k] = v;
} else {
delete value[k];
}
}
}
}
return reviver.call(holder, key, value);
}
// Parsing happens in four stages. In the first stage, we replace certain
// Unicode characters with escape sequences. JavaScript handles many characters
// incorrectly, either silently deleting them, or treating them as line endings.
text = String(text);
cx.lastIndex = 0;
if (cx.test(text)) {
text = text.replace(cx, function (a) {
return '\\u' +
('0000' + a.charCodeAt(0).toString(16)).slice(-4);
});
}
// In the second stage, we run the text against regular expressions that look
// for non-JSON patterns. We are especially concerned with '()' and 'new'
// because they can cause invocation, and '=' because it can cause mutation.
// But just to be safe, we want to reject all unexpected forms.
// We split the second stage into 4 regexp operations in order to work around
// crippling inefficiencies in IE's and Safari's regexp engines. First we
// replace the JSON backslash pairs with '@' (a non-JSON character). Second, we
// replace all simple value tokens with ']' characters. Third, we delete all
// open brackets that follow a colon or comma or that begin the text. Finally,
// we look to see that the remaining characters are only whitespace or ']' or
// ',' or ':' or '{' or '}'. If that is so, then the text is safe for eval.
if (/^[\],:{}\s]*$/
.test(text.replace(/\\(?:["\\\/bfnrt]|u[0-9a-fA-F]{4})/g, '@')
.replace(/"[^"\\\n\r]*"|true|false|null|-?\d+(?:\.\d*)?(?:[eE][+\-]?\d+)?/g, ']')
.replace(/(?:^|:|,)(?:\s*\[)+/g, ''))) {
// In the third stage we use the eval function to compile the text into a
// JavaScript structure. The '{' operator is subject to a syntactic ambiguity
// in JavaScript: it can begin a block or an object literal. We wrap the text
// in parens to eliminate the ambiguity.
j = eval('(' + text + ')');
// In the optional fourth stage, we recursively walk the new structure, passing
// each name/value pair to a reviver function for possible transformation.
return typeof reviver === 'function'
? walk({'': j}, '')
: j;
}
// If the text is not JSON parseable, then a SyntaxError is thrown.
throw new SyntaxError('JSON.parse');
};
}
}());