Skip to content

feat: ScriptObject wrapper for Java objects in scripts #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
KoshakMineDEV merged 1 commit into from
Jan 13, 2025
Merged

feat: ScriptObject wrapper for Java objects in scripts #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions api/src/main/java/com/instancify/scriptify/api/script/ScriptObject.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
package com.instancify.scriptify.api.script;

/**
* Represents a class to wrap an object in a script,
* so if this class is found in a script, it will be converted to its value.
* This is necessary for script runtimes that do not support automatic object conversion.
*/
public interface ScriptObject {

/**
* Returns the stored value.
*
* @return The value held by this object
*/
Object getValue();

/**
* Creates a ScriptObject from the given value.
*
* @param value The value to encapsulate
* @return A new ScriptObject instance
*/
static ScriptObject of(Object value) {
return () -> value;
}
}
2 changes: 1 addition & 1 deletion build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ java {

allprojects {
group = "com.instancify.scriptify"
version = "1.3.4-SNAPSHOT"
version = "1.3.5-SNAPSHOT"
}

subprojects {
Expand Down
12 changes: 11 additions & 1 deletion script-js-graalvm/src/main/java/com/instancify/scriptify/script/JsScript.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

import com.instancify.scriptify.api.exception.ScriptException;
import com.instancify.scriptify.api.script.Script;
import com.instancify.scriptify.api.script.ScriptObject;
import com.instancify.scriptify.api.script.constant.ScriptConstant;
import com.instancify.scriptify.api.script.constant.ScriptConstantManager;
import com.instancify.scriptify.api.script.function.ScriptFunction;
Expand Down Expand Up @@ -46,7 +47,16 @@ public void setConstantManager(ScriptConstantManager constantManager) {
@Override
public Value eval(String script) throws ScriptException {
Context.Builder builder = Context.newBuilder("js")
.allowHostAccess(HostAccess.ALL);
.allowHostAccess(HostAccess.newBuilder(HostAccess.ALL)
// Mapping for the ScriptObject class required
// to convert a ScriptObject to the value it contains
.targetTypeMapping(
ScriptObject.class,
Object.class,
object -> true,
ScriptObject::getValue
)
.build());

// If security mode is enabled, search all exclusions
// and add the classes that were excluded to JsSecurityClassAccessor
Expand Down
6 changes: 4 additions & 2 deletions script-js-rhino/src/main/java/com/instancify/scriptify/script/JsScript.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@
import com.instancify.scriptify.api.script.function.ScriptFunction;
import com.instancify.scriptify.api.script.function.ScriptFunctionManager;
import com.instancify.scriptify.api.script.security.ScriptSecurityManager;
import com.instancify.scriptify.api.script.security.exclude.ClassSecurityExclude;
import com.instancify.scriptify.api.script.security.exclude.SecurityExclude;
import com.instancify.scriptify.core.script.security.StandardSecurityManager;
import org.mozilla.javascript.Context;
import org.mozilla.javascript.ScriptableObject;
Expand All @@ -20,6 +18,10 @@ public class JsScript implements Script<Object> {
private ScriptFunctionManager functionManager;
private ScriptConstantManager constantManager;

public JsScript() {
context.setWrapFactory(new JsWrapFactory());
}

@Override
public ScriptSecurityManager getSecurityManager() {
return securityManager;
Expand Down
22 changes: 22 additions & 0 deletions script-js-rhino/src/main/java/com/instancify/scriptify/script/JsWrapFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
package com.instancify.scriptify.script;

import com.instancify.scriptify.api.script.ScriptObject;
import org.mozilla.javascript.Context;
import org.mozilla.javascript.Scriptable;
import org.mozilla.javascript.WrapFactory;

public class JsWrapFactory extends WrapFactory {

public JsWrapFactory() {
this.setJavaPrimitiveWrap(false);
}

@Override
public Object wrap(Context context, Scriptable scope, Object object, Class<?> staticType) {
// Convert the ScriptObject class to the value it contains
if (object instanceof ScriptObject scriptObject) {
return Context.javaToJS(scriptObject.getValue(), scope);
}
return super.wrap(context, scope, object, staticType);
}
}
Loading