szumielxd/skript-db
1
0
Fork 0
forked from Limework/skript-db
Code Pull Requests Activity

Merge pull request 'cleaning' (#1) from cleaning into master

Browse Source 
Reviewed-on: #1
This commit is contained in:
szumielxd 2025-01-30 01:48:13 +00:00
commit 39cbb6b397
6 changed files with 187 additions and 154 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

121
src/main/java/com/btk5h/skriptdb/SkriptUtil.java
View File

@ -1,61 +1,94 @@
package com.btk5h.skriptdb; package com.btk5h.skriptdb;
import ch.njol.skript.Skript;
import ch.njol.skript.lang.Expression;
import ch.njol.skript.lang.VariableString;
import java.lang.reflect.Field; import java.lang.reflect.Field;
import java.util.Arrays; import java.util.Arrays;
import java.util.Optional; import java.util.Optional;
import org.bukkit.event.Event;
import ch.njol.skript.ScriptLoader;
import ch.njol.skript.Skript;
import ch.njol.skript.lang.Expression;
import ch.njol.skript.lang.VariableString;
import ch.njol.skript.lang.parser.ParserInstance;
public class SkriptUtil { public class SkriptUtil {
private static final Field STRING; private static final Field STRING;
private static final Field EXPR; private static final Field EXPR;
static { static {
Field _FIELD = null; STRING = tryGetOldStringField()
try { .or(() -> tryGetNewStringField())
_FIELD = VariableString.class.getDeclaredField("string"); .orElseGet(() -> {
_FIELD.setAccessible(true); Skript.error("Skript's 'string' field could not be resolved.");
} catch (NoSuchFieldException e) { return null;
Skript.error("Skript's 'string' field could not be resolved."); });
e.printStackTrace();
}
STRING = _FIELD;
try { Field f = null;
Optional<Class<?>> expressionInfo = Arrays.stream(VariableString.class.getDeclaredClasses()) try {
.filter(cls -> cls.getSimpleName().equals("ExpressionInfo")) Optional<Class<?>> expressionInfo = Arrays.stream(VariableString.class.getDeclaredClasses())
.findFirst(); .filter(cls -> cls.getSimpleName().equals("ExpressionInfo"))
if (expressionInfo.isPresent()) { .findFirst();
Class<?> expressionInfoClass = expressionInfo.get(); if (expressionInfo.isPresent()) {
_FIELD = expressionInfoClass.getDeclaredField("expr"); Class<?> expressionInfoClass = expressionInfo.get();
_FIELD.setAccessible(true); f = expressionInfoClass.getDeclaredField("expr");
} else { f.setAccessible(true);
Skript.error("Skript's 'ExpressionInfo' class could not be resolved."); } else {
} Skript.error("Skript's 'ExpressionInfo' class could not be resolved.");
} catch (NoSuchFieldException e) { }
e.printStackTrace(); } catch (NoSuchFieldException e) {
Skript.error("Skript's 'expr' field could not be resolved."); e.printStackTrace();
Skript.error("Skript's 'expr' field could not be resolved.");
}
EXPR = f;
} }
EXPR = _FIELD;
}
public static Object[] getTemplateString(VariableString vs) { public static Object[] getTemplateString(VariableString vs) {
try { try {
return (Object[]) STRING.get(vs); return (Object[]) STRING.get(vs);
} catch (IllegalAccessException e) { } catch (IllegalAccessException e) {
throw new RuntimeException(e); throw new RuntimeException(e);
}
} }
}
public static Expression<?> getExpressionFromInfo(Object o) { public static Expression<?> getExpressionFromInfo(Object o) {
try { try {
return (Expression<?>) EXPR.get(o); return (Expression<?>) EXPR.get(o);
} catch (IllegalAccessException e) { } catch (IllegalAccessException e) {
throw new RuntimeException(e); throw new RuntimeException(e);
}
}
@SuppressWarnings("deprecation")
public static boolean isCurrentEvent(Class<? extends Event> event) {
try {
Class.forName("ch.njol.skript.lang.parser.ParserInstance");
return ParserInstance.get().isCurrentEvent(event);
} catch (ClassNotFoundException e) {
return ScriptLoader.isCurrentEvent(event);
}
}
private static Optional<Field> tryGetOldStringField() {
try {
Field f = VariableString.class.getDeclaredField("string");
f.setAccessible(true);
return Optional.of(f);
} catch (NoSuchFieldException e) {
return Optional.empty();
}
}
private static Optional<Field> tryGetNewStringField() {
try {
Field f = VariableString.class.getDeclaredField("strings");
f.setAccessible(true);
return Optional.of(f);
} catch (NoSuchFieldException e) {
return Optional.empty();
}
} }
}
} }

20
src/main/java/com/btk5h/skriptdb/events/SQLQueryCompleteEvent.java
View File

@ -4,32 +4,26 @@ import org.bukkit.event.Event;
import org.bukkit.event.HandlerList; import org.bukkit.event.HandlerList;
public class SQLQueryCompleteEvent extends Event { public class SQLQueryCompleteEvent extends Event {
private final static HandlerList HANDLERS = new HandlerList();
private static final HandlerList HANDLERS = new HandlerList();
private final String argument; private final String argument;
public SQLQueryCompleteEvent(String argument) { public SQLQueryCompleteEvent(String argument) {
super(true); super(true);
this.argument = argument; this.argument = argument;
// this.variables = variables;
}
public static HandlerList getHandlerList() {
return HANDLERS;
}
@Override
public String getEventName() {
return super.getEventName();
} }
@Override @Override
public HandlerList getHandlers() { public HandlerList getHandlers() {
return HANDLERS; return getHandlerList();
} }
public String getQuery() { public String getQuery() {
return argument; return argument;
} }
// public String getVariables() {return;} public static HandlerList getHandlerList() {
return HANDLERS;
}
} }

179
src/main/java/com/btk5h/skriptdb/skript/EffExecuteStatement.java
View File

@ -21,8 +21,10 @@ import java.sql.Connection;
import java.sql.PreparedStatement; import java.sql.PreparedStatement;
import java.sql.ResultSetMetaData; import java.sql.ResultSetMetaData;
import java.sql.SQLException; import java.sql.SQLException;
import java.sql.Statement;
import java.util.*; import java.util.*;
import java.util.concurrent.CompletableFuture; import java.util.concurrent.CompletableFuture;
import java.util.concurrent.CompletionException;
import java.util.concurrent.ExecutorService; import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors; import java.util.concurrent.Executors;
import java.util.regex.Pattern; import java.util.regex.Pattern;
@ -51,105 +53,81 @@ public class EffExecuteStatement extends Effect {
static { static {
Skript.registerEffect(EffExecuteStatement.class, Skript.registerEffect(EffExecuteStatement.class,
"execute %string% (in|on) %datasource% " + "[quickly:quickly] execute %string% (in|on) %datasource% " +
"[with arg[ument][s] %-objects%] [and store [[the] (output|result)[s]] (to|in) [the] [var[iable]] %-objects%]", "[with arg[ument][s] %-objects%] [and store [[the] [keys:generated keys] (output|result)[s]] (to|in) [the] [var[iable]] %-objects%]");
"quickly execute %string% (in|on) %datasource% " +
"[with arg[ument][s] %-objects%] [and store [[the] (output|result)[s]] (to|in) [the] [var[iable]] %-objects%]");
} }
private Expression<String> query; private Expression<String> query;
private Expression<HikariDataSource> dataSource; private Expression<HikariDataSource> dataSource;
private Expression<Object> queryArguments; private Expression<Object> queryArguments;
private VariableString var; private VariableString resultVariableName;
private boolean isLocal; private boolean isLocal;
private boolean isList; private boolean isList;
private boolean quickly; private boolean quickly;
private boolean generatedKeys;
private boolean isSync = false; private boolean isSync = false;
private void continueScriptExecution(Event e, Object populatedVariables) {
lastError = null;
if (populatedVariables instanceof String) {
lastError = (String) populatedVariables;
} else {
if (getNext() != null) {
((Map<String, Object>) populatedVariables).forEach((name, value) -> setVariable(e, name, value));
}
}
TriggerItem.walk(getNext(), e);
}
@Override @Override
protected void execute(Event e) { protected void execute(Event e) {
DataSource ds = dataSource.getSingle(e); DataSource ds = dataSource.getSingle(e);
Pair<String, List<Object>> query = parseQuery(e);
String baseVariable = var != null ? var.toString(e).toLowerCase(Locale.ENGLISH) : null;
//if data source isn't set //if data source isn't set
if (ds == null) return; if (ds == null) {
return;
}
Pair<String, List<Object>> parsedQuery = parseQuery(e);
String baseVariable = resultVariableName != null ? resultVariableName.toString(e).toLowerCase(Locale.ENGLISH) : null;
Object locals = Variables.removeLocals(e); Object locals = Variables.removeLocals(e);
//execute SQL statement //execute SQL statement
if (Bukkit.isPrimaryThread()) { if (Bukkit.isPrimaryThread()) {
CompletableFuture<Object> sql = CompletableFuture.supplyAsync(() -> executeStatement(ds, baseVariable, query), threadPool); CompletableFuture.supplyAsync(() -> executeStatement(ds, baseVariable, parsedQuery), threadPool)
sql.whenComplete((res, err) -> { .whenComplete((resources, err) -> {
if (err != null) { //handle last error syntax data
err.printStackTrace(); resetLastSQLError();
} if (err instanceof CompletionException && err.getCause() instanceof SkriptDBQueryException) {
//handle last error syntax data setLastSQLError(err.getCause().getMessage());
lastError = null; }
if (res instanceof String) { //if local variables are present
lastError = (String) res; //bring back local variables
} //populate SQL data into variables
//if local variables are present if (!quickly) {
//bring back local variables Bukkit.getScheduler().runTask(SkriptDB.getInstance(),
//populate SQL data into variables () -> postExecution(e, locals, resources));
if (!quickly) { } else {
Bukkit.getScheduler().runTask(SkriptDB.getInstance(), () -> { postExecution(e, locals, resources);
if (locals != null && getNext() != null) { }
Variables.setLocalVariables(e, locals); });
}
if (!(res instanceof String)) {
((Map<String, Object>) res).forEach((name, value) -> setVariable(e, name, value));
}
TriggerItem.walk(getNext(), e);
//the line below is required to prevent memory leaks
Variables.removeLocals(e);
});
} else {
if (locals != null && getNext() != null) {
Variables.setLocalVariables(e, locals);
}
if (!(res instanceof String)) {
((Map<String, Object>) res).forEach((name, value) -> setVariable(e, name, value));
}
TriggerItem.walk(getNext(), e);
//the line below is required to prevent memory leaks
Variables.removeLocals(e);
}
});
// sync executed SQL query, same as above, just sync // sync executed SQL query, same as above, just sync
} else { } else {
isSync = true; isSync = true;
Object resources = executeStatement(ds, baseVariable, query); Map<String, Object> resources = null;
//handle last error syntax data resetLastSQLError();
lastError = null; try {
if (resources instanceof String) { resources = executeStatement(ds, baseVariable, parsedQuery);
lastError = (String) resources; } catch (SkriptDBQueryException err) {
} //handle last error syntax data
setLastSQLError(err.getMessage());
}
//if local variables are present //if local variables are present
//bring back local variables //bring back local variables
//populate SQL data into variables //populate SQL data into variables
if (locals != null && getNext() != null) { postExecution(e, locals, resources);
Variables.setLocalVariables(e, locals);
}
if (!(resources instanceof String)) {
((Map<String, Object>) resources).forEach((name, value) -> setVariable(e, name, value));
}
TriggerItem.walk(getNext(), e);
Variables.removeLocals(e);
} }
} }
private void postExecution(Event e, Object locals, Map<String, Object> resources) {
if (locals != null && getNext() != null) {
Variables.setLocalVariables(e, locals);
}
if (resources != null) {
resources.forEach((name, value) -> setVariable(e, name, value));
}
TriggerItem.walk(getNext(), e);
//the line below is required to prevent memory leaks
Variables.removeLocals(e);
}
@Override @Override
protected TriggerItem walk(Event e) { protected TriggerItem walk(Event e) {
debug(e, true); debug(e, true);
@ -166,10 +144,16 @@ public class EffExecuteStatement extends Effect {
String queryString = query.getSingle(e); String queryString = query.getSingle(e);
int queryArgCount = (int) ARGUMENT_PLACEHOLDER.matcher(queryString).results().count(); int queryArgCount = (int) ARGUMENT_PLACEHOLDER.matcher(queryString).results().count();
if (queryArgCount != args.length) { if (queryArgCount != args.length) {
Skript.warning("Your query has %d question marks, but you provided %d arguments."); Skript.warning(String.format("Your query has %d question marks, but you provided %d arguments. (%s) [%s]",
queryArgCount,
args.length,
queryArguments.toString(e, true),
Optional.ofNullable(getTrigger())
.map(Trigger::getDebugLabel)
.orElse("unknown")));
args = Arrays.copyOf(args, queryArgCount); args = Arrays.copyOf(args, queryArgCount);
} }
return new Pair<>(query.getSingle(e), List.of(args)); return new Pair<>(query.getSingle(e), Arrays.asList(args));
} else if (query instanceof VariableString && !((VariableString) query).isSimple()) { } else if (query instanceof VariableString && !((VariableString) query).isSimple()) {
return parseVariableQuery(e, (VariableString) query); return parseVariableQuery(e, (VariableString) query);
} }
@ -215,9 +199,9 @@ public class EffExecuteStatement extends Effect {
} }
} }
private Object executeStatement(DataSource ds, String baseVariable, Pair<String, List<Object>> query) { private Map<String, Object> executeStatement(DataSource ds, String baseVariable, Pair<String, List<Object>> query) throws SkriptDBQueryException {
if (ds == null) { if (ds == null) {
return "Data source is not set"; throw new SkriptDBQueryException("Data source is not set");
} }
try (Connection conn = ds.getConnection()) { try (Connection conn = ds.getConnection()) {
try (PreparedStatement stmt = createStatement(conn, query)) { try (PreparedStatement stmt = createStatement(conn, query)) {
@ -229,25 +213,24 @@ public class EffExecuteStatement extends Effect {
return Map.of(); return Map.of();
} }
} catch (SQLException ex) { } catch (SQLException ex) {
return ex.getMessage(); throw new SkriptDBQueryException(ex.getMessage());
} }
} }
private Object processBaseVariable(String baseVariable, PreparedStatement stmt, boolean hasResultSet) throws SQLException { private Map<String, Object> processBaseVariable(String baseVariable, PreparedStatement stmt, boolean hasResultSet) throws SQLException {
Map<String, Object> variableList = new HashMap<>();
if (isList) { if (isList) {
baseVariable = baseVariable.substring(0, baseVariable.length() - 1); baseVariable = baseVariable.substring(0, baseVariable.length() - 1);
} }
if (hasResultSet) { if (hasResultSet) {
CachedRowSet crs = SkriptDB.getRowSetFactory().createCachedRowSet(); CachedRowSet crs = SkriptDB.getRowSetFactory().createCachedRowSet();
crs.populate(stmt.getResultSet()); crs.populate(generatedKeys ? stmt.getGeneratedKeys() : stmt.getResultSet());
if (isList) { if (isList) {
return fetchQueryResultSet(crs, baseVariable); return fetchQueryResultSet(crs, baseVariable);
} else { } else {
crs.last(); crs.last();
variableList.put(baseVariable, crs.getRow()); return Map.of(baseVariable, crs.getRow());
} }
} else if (!isList) { } else if (!isList) {
//if no results are returned and the specified variable isn't a list variable, put the affected rows count in the variable //if no results are returned and the specified variable isn't a list variable, put the affected rows count in the variable
@ -278,7 +261,9 @@ public class EffExecuteStatement extends Effect {
} }
private PreparedStatement createStatement(Connection conn, Pair<String, List<Object>> query) throws SQLException { private PreparedStatement createStatement(Connection conn, Pair<String, List<Object>> query) throws SQLException {
PreparedStatement stmt = conn.prepareStatement(query.getFirst()); PreparedStatement stmt = generatedKeys ?
conn.prepareStatement(query.getFirst(), Statement.RETURN_GENERATED_KEYS)
: conn.prepareStatement(query.getFirst(), Statement.NO_GENERATED_KEYS);
if (query.getSecond() != null) { if (query.getSecond() != null) {
Iterator<Object> iter = query.getSecond().iterator(); Iterator<Object> iter = query.getSecond().iterator();
for (int i = 1; iter.hasNext(); i++) { for (int i = 1; iter.hasNext(); i++) {
@ -306,7 +291,7 @@ public class EffExecuteStatement extends Effect {
//fix mediumblob and similar column types, so they return a String correctly //fix mediumblob and similar column types, so they return a String correctly
if (obj != null) { if (obj != null) {
if (obj.getClass().getName().equals("[B")) { if (obj instanceof byte[]) {
obj = new String((byte[]) obj); obj = new String((byte[]) obj);
//in some servers instead of being byte array, it appears as SerialBlob (depends on mc version, 1.12.2 is bvte array, 1.16.5 SerialBlob) //in some servers instead of being byte array, it appears as SerialBlob (depends on mc version, 1.12.2 is bvte array, 1.16.5 SerialBlob)
@ -321,6 +306,14 @@ public class EffExecuteStatement extends Effect {
Variables.setVariable(name.toLowerCase(Locale.ENGLISH), obj, e, isLocal); Variables.setVariable(name.toLowerCase(Locale.ENGLISH), obj, e, isLocal);
} }
private static void resetLastSQLError() {
lastError = null;
}
private static void setLastSQLError(String error) {
lastError = error;
}
@Override @Override
public String toString(Event e, boolean debug) { public String toString(Event e, boolean debug) {
return "execute " + query.toString(e, debug) + " in " + dataSource.toString(e, debug); return "execute " + query.toString(e, debug) + " in " + dataSource.toString(e, debug);
@ -328,8 +321,7 @@ public class EffExecuteStatement extends Effect {
@SuppressWarnings("unchecked") @SuppressWarnings("unchecked")
@Override @Override
public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult) {
SkriptParser.ParseResult parseResult) {
Expression<String> statementExpr = (Expression<String>) exprs[0]; Expression<String> statementExpr = (Expression<String>) exprs[0];
if (statementExpr instanceof VariableString || statementExpr instanceof ExprUnsafe) { if (statementExpr instanceof VariableString || statementExpr instanceof ExprUnsafe) {
query = statementExpr; query = statementExpr;
@ -346,17 +338,30 @@ public class EffExecuteStatement extends Effect {
} }
queryArguments = (Expression<Object>) exprs[2]; queryArguments = (Expression<Object>) exprs[2];
} }
;
Expression<?> resultHolder = exprs[3]; Expression<?> resultHolder = exprs[3];
quickly = matchedPattern == 1; quickly = parseResult.hasTag("quickly");
if (resultHolder instanceof Variable) { if (resultHolder instanceof Variable) {
Variable<?> varExpr = (Variable<?>) resultHolder; Variable<?> varExpr = (Variable<?>) resultHolder;
var = varExpr.getName(); resultVariableName = varExpr.getName();
isLocal = varExpr.isLocal(); isLocal = varExpr.isLocal();
isList = varExpr.isList(); isList = varExpr.isList();
generatedKeys = parseResult.hasTag("keys");
} else if (resultHolder != null) { } else if (resultHolder != null) {
Skript.error(resultHolder + " is not a variable"); Skript.error(resultHolder + " is not a variable");
return false; return false;
} }
return true; return true;
} }
public static class SkriptDBQueryException extends RuntimeException {
private static final long serialVersionUID = -1869895286406538884L;
public SkriptDBQueryException(String message) {
super(message);
}
}
} }

8
src/main/java/com/btk5h/skriptdb/skript/ExprDataSource.java
View File

@ -32,8 +32,9 @@ public class ExprDataSource extends SimpleExpression<HikariDataSource> {
static { static {
Skript.registerExpression(ExprDataSource.class, HikariDataSource.class, Skript.registerExpression(ExprDataSource.class, HikariDataSource.class,
ExpressionType.COMBINED, "[the] data(base|[ ]source) [(of|at)] %string% " + ExpressionType.COMBINED, "[the] data(base|[ ]source) [(of|at)] %string% "
"[with [a] [max[imum]] [connection] life[ ]time of %-timespan%] " + "[[(using|with)] [a] driver %-string%]"); + "[with [a] [max[imum]] [connection] life[ ]time of %-timespan%] "
+ "[[(using|with)] [a] driver %-string%]");
} }
private Expression<String> url; private Expression<String> url;
@ -100,8 +101,7 @@ public class ExprDataSource extends SimpleExpression<HikariDataSource> {
@SuppressWarnings("unchecked") @SuppressWarnings("unchecked")
@Override @Override
public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult) {
SkriptParser.ParseResult parseResult) {
url = (Expression<String>) exprs[0]; url = (Expression<String>) exprs[0];
maxLifetime = (Expression<Timespan>) exprs[1]; maxLifetime = (Expression<Timespan>) exprs[1];
driver = (Expression<String>) exprs[2]; driver = (Expression<String>) exprs[2];

10
src/main/java/com/btk5h/skriptdb/skript/ExprSQLQuery.java
View File

@ -1,6 +1,10 @@
package com.btk5h.skriptdb.skript; package com.btk5h.skriptdb.skript;
import ch.njol.skript.ScriptLoader; import org.bukkit.event.Event;
import com.btk5h.skriptdb.SkriptUtil;
import com.btk5h.skriptdb.events.SQLQueryCompleteEvent;
import ch.njol.skript.Skript; import ch.njol.skript.Skript;
import ch.njol.skript.lang.Expression; import ch.njol.skript.lang.Expression;
import ch.njol.skript.lang.ExpressionType; import ch.njol.skript.lang.ExpressionType;
@ -8,8 +12,6 @@ import ch.njol.skript.lang.SkriptParser;
import ch.njol.skript.lang.util.SimpleExpression; import ch.njol.skript.lang.util.SimpleExpression;
import ch.njol.skript.log.ErrorQuality; import ch.njol.skript.log.ErrorQuality;
import ch.njol.util.Kleenean; import ch.njol.util.Kleenean;
import com.btk5h.skriptdb.events.SQLQueryCompleteEvent;
import org.bukkit.event.Event;
/** /**
* Stores the error from the last executed statement, if there was one. * Stores the error from the last executed statement, if there was one.
@ -51,7 +53,7 @@ public class ExprSQLQuery extends SimpleExpression<String> {
@Override @Override
public boolean init(final Expression<?>[] expressions, final int matchedPattern, final Kleenean isDelayed, final SkriptParser.ParseResult parseResult) { public boolean init(final Expression<?>[] expressions, final int matchedPattern, final Kleenean isDelayed, final SkriptParser.ParseResult parseResult) {
if (!ScriptLoader.isCurrentEvent(SQLQueryCompleteEvent.class)) { if (!SkriptUtil.isCurrentEvent(SQLQueryCompleteEvent.class)) {
Skript.error("Cannot use 'sql query' outside of a complete of sql query event", ErrorQuality.SEMANTIC_ERROR); Skript.error("Cannot use 'sql query' outside of a complete of sql query event", ErrorQuality.SEMANTIC_ERROR);
return false; return false;
} }

3
src/main/java/com/btk5h/skriptdb/skript/ExprUnsafe.java
View File

@ -53,8 +53,7 @@ public class ExprUnsafe extends SimpleExpression<String> {
@SuppressWarnings("unchecked") @SuppressWarnings("unchecked")
@Override @Override
public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult) {
SkriptParser.ParseResult parseResult) {
stringExpression = (Expression<String>) exprs[0]; stringExpression = (Expression<String>) exprs[0];
rawExpression = parseResult.expr.substring("unsafe".length()).trim(); rawExpression = parseResult.expr.substring("unsafe".length()).trim();
return true; return true;