Compare commits

..

No commits in common. "master" and "1.3.7" have entirely different histories.

12 changed files with 300 additions and 386 deletions

16
.gitignore vendored
View File

@ -7,19 +7,3 @@
out/ out/
target target
compile/ compile/
# eclipse specific git ignore
*.pydevproject
.project
.metadata
bin/**
tmp/**
tmp/**/*
*.tmp
*.bak
*.swp
*~.nib
local.properties
.classpath
.settings/
.loadpath

View File

@ -5,14 +5,13 @@
### Difference from original skript-db ### Difference from original skript-db
- Fixed local variables disappearance in newer Skript versions (very hacky fix, but it works, so that's good!) - Fixed local variables disappearance in newer Skript versions (very hacky fix, but it works, so that's good!)
- Thread-pool size is now automatically increasing on demand with use of CachedThreadPool, instead of a fixed hard-coded number
- Uses newer versions of dependencies (Increased performance and security) - Uses newer versions of dependencies (Increased performance and security)
- Replaced `synchronously execute` with `quickly execute`, which allows to speed up queries by 50ms with some risk - Replaced `synchronously execute` with `quickly execute`, which allows to speed up queries by 50ms with some risk
- If a sql query is detected to be running on non-main thread, it becomes synchronous automatically - SQL Driver is configurable
- SQL Driver is configurable both in config and in database connection, comes with shaded MariaDB and PostgreSQL drivers
- A few variable type related bugs fixed - A few variable type related bugs fixed
- Uses Java 11 instead of Java 8 - Uses Java 11 instead of Java 8
### Installation ### Installation
1. Use 1.8+ Minecraft server version. 1. Use 1.8+ Minecraft server version.
2. Use Skript 2.5+ (1.8 Skript fork is needed if you're using 1.8) 2. Use Skript 2.5+ (1.8 Skript fork is needed if you're using 1.8)
@ -22,23 +21,15 @@
Stores the connection information for a data source. This should be saved to a variable in a Stores the connection information for a data source. This should be saved to a variable in a
`script load` event or manually through an effect command. `script load` event or manually through an effect command.
The url format for your database may vary depending on database you are using. The url format for your database may vary! The example provided uses a MySQL database.
MariaDB/PostgreSQL users: make sure to check `config.yml` to use the correct driver.
#### Syntax #### Syntax
``` ```
[the] data(base|[ ]source) [(of|at)] %string% [with [a] [max[imum]] [connection] life[ ]time of %timespan%] [[(using|with)] [a] driver %-string%] [the] data(base|[ ]source) [(of|at)] %string%
``` ```
#### Examples #### Examples
``` ```
set {sql} to the database "mysql://localhost:3306/mydatabase?user=admin&password=12345&useSSL=false" set {sql} to the database "mysql://localhost:3306/mydatabase?user=admin&password=12345&useSSL=false"
set {sql} to the database "mariadb://localhost:3306/mydatabase?user=admin&password=12345&useSSL=false"
set {sql} to the database "postgresql://localhost:3306/mydatabase?user=admin&password=12345&ssl=false"
set {sql} to the database "sqlite:database.db"
# Extra parameters:
set {sql} to the database "postgresql://localhost:3306/mydatabase?user=admin&password=12345&ssl=false" with a maximum connection lifetime of 30 minutes
set {sql} to the database "postgresql://localhost:3306/mydatabase?user=admin&password=12345&ssl=false" with a maximum connection lifetime of 30 minutes using driver "org.postgresql.Driver"
``` ```
--- ---
@ -80,7 +71,6 @@ Stores the error from the last executed statement, if there was one.
### Expression `Unsafe Expression` => `text` ### Expression `Unsafe Expression` => `text`
Opts out of automatic SQL injection protection for a specific expression in a statement. Opts out of automatic SQL injection protection for a specific expression in a statement.
Note: If using PostgreSQL, this will always be needed, due to skript-db not supporting SQL injection protection for PostgreSQL currently.
#### Syntax #### Syntax
``` ```
unsafe %text% unsafe %text%
@ -94,18 +84,6 @@ execute "select %unsafe {columns variable}% from %{table variable}%" in {sql}
execute unsafe {fully dynamic query} in {sql} execute unsafe {fully dynamic query} in {sql}
``` ```
#### FAQ: How to return sql data in a function?
You can't because functions don't allow delays, but you can use skript-reflect sections for this:
```
on load:
create new section stored in {-section::getPlayersFromDatabase}:
execute "SELECT uuid FROM table" in {-sql} and store the result in {_result::*}
return {_result::uuid::*}
command /showplayers [<text>]:
trigger:
run section {-section::getPlayersFromDatabase} async and store result in {_uuids::*} and wait
send "%{_uuids::*}%"
```
--- ---
### Configuration ### Configuration
plugins/skript-db/config.yml plugins/skript-db/config.yml

19
pom.xml
View File

@ -6,7 +6,7 @@
<groupId>com.btk5h</groupId> <groupId>com.btk5h</groupId>
<artifactId>skript-db</artifactId> <artifactId>skript-db</artifactId>
<version>1.4.0</version> <version>1.3.7</version>
<packaging>jar</packaging> <packaging>jar</packaging>
<repositories> <repositories>
@ -28,11 +28,7 @@
</repository> </repository>
<repository> <repository>
<id>sk89q</id> <id>sk89q</id>
<url>https://maven.sk89q.com/repo</url> <url>http://maven.sk89q.com/repo</url>
</repository>
<repository>
<id>skript</id>
<url>https://repo.skriptlang.org/releases</url>
</repository> </repository>
</repositories> </repositories>
@ -97,21 +93,14 @@
<dependency> <dependency>
<groupId>com.github.SkriptLang</groupId> <groupId>com.github.SkriptLang</groupId>
<artifactId>Skript</artifactId> <artifactId>Skript</artifactId>
<version>2.6.1</version> <version>2.6-beta3</version>
<scope>provided</scope> <scope>provided</scope>
</dependency> </dependency>
<!-- https://mvnrepository.com/artifact/org.mariadb.jdbc/mariadb-java-client --> <!-- https://mvnrepository.com/artifact/org.mariadb.jdbc/mariadb-java-client -->
<dependency> <dependency>
<groupId>org.mariadb.jdbc</groupId> <groupId>org.mariadb.jdbc</groupId>
<artifactId>mariadb-java-client</artifactId> <artifactId>mariadb-java-client</artifactId>
<version>3.1.2</version> <version>3.0.3</version>
<scope>compile</scope>
</dependency>
<!-- https://mvnrepository.com/artifact/org.postgresql/postgresql -->
<dependency>
<groupId>org.postgresql</groupId>
<artifactId>postgresql</artifactId>
<version>42.6.0</version>
<scope>compile</scope> <scope>compile</scope>
</dependency> </dependency>

View File

@ -73,14 +73,8 @@ public final class SkriptDB extends JavaPlugin {
} }
try { try {
if (out == null) return; if (out == null) return;
out.write("# Only change this if you wish to use a different driver than Java's default, like MariaDB driver.\n");
out.write("# How many connections can be awaited for simultaneously, may be useful to increase if SQL database is hosted on a separate machine to account for ping.\n"); out.write("# If you use MariaDB, its driver is shaded together with skript-db, so you can just specify:" + "\"org.mariadb.jdbc.Driver\"" + ".\n");
out.write("# If it is hosted within the same machine, set it to the count of cores your processor has or the count of threads your processor can process at once.\n");
out.write("thread-pool-size: " + (Runtime.getRuntime().availableProcessors() + 2) + "\n");
out.write("# How long SQL connections should be kept alive in HikariCP. Default: 1800000 (30 minutes)");
out.write("max-connection-lifetime: 1800000");
out.write("# Only change this if you wish to use a different driver than Java's default, like MariaDB/PostgreSQL driver.\n");
out.write("# If you use MariaDB or PostgreSQL, its driver is shaded together with skript-db, so you can just specify:" + "\"org.mariadb.jdbc.Driver\"" + " or " + "\"org.postgresql.Driver\"" + ".\n");
out.write("sql-driver-class-name: " + "\"default\"" + "\n"); out.write("sql-driver-class-name: " + "\"default\"" + "\n");
} catch (IOException e) { } catch (IOException e) {
e.printStackTrace(); e.printStackTrace();

View File

@ -1,39 +1,37 @@
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 {
STRING = tryGetOldStringField() Field _FIELD = null;
.or(() -> tryGetNewStringField()) try {
.orElseGet(() -> { _FIELD = VariableString.class.getDeclaredField("string");
_FIELD.setAccessible(true);
} catch (NoSuchFieldException e) {
Skript.error("Skript's 'string' field could not be resolved."); Skript.error("Skript's 'string' field could not be resolved.");
return null; e.printStackTrace();
}); }
STRING = _FIELD;
Field f = null;
try { try {
Optional<Class<?>> expressionInfo = Arrays.stream(VariableString.class.getDeclaredClasses()) Optional<Class<?>> expressionInfo = Arrays.stream(VariableString.class.getDeclaredClasses())
.filter(cls -> cls.getSimpleName().equals("ExpressionInfo")) .filter(cls -> cls.getSimpleName().equals("ExpressionInfo"))
.findFirst(); .findFirst();
if (expressionInfo.isPresent()) { if (expressionInfo.isPresent()) {
Class<?> expressionInfoClass = expressionInfo.get(); Class<?> expressionInfoClass = expressionInfo.get();
f = expressionInfoClass.getDeclaredField("expr"); _FIELD = expressionInfoClass.getDeclaredField("expr");
f.setAccessible(true); _FIELD.setAccessible(true);
} else { } else {
Skript.error("Skript's 'ExpressionInfo' class could not be resolved."); Skript.error("Skript's 'ExpressionInfo' class could not be resolved.");
} }
@ -41,7 +39,7 @@ public class SkriptUtil {
e.printStackTrace(); e.printStackTrace();
Skript.error("Skript's 'expr' field could not be resolved."); 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) {
@ -60,35 +58,4 @@ public class SkriptUtil {
} }
} }
@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();
}
}
} }

View File

@ -4,26 +4,32 @@ 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 getHandlerList(); return HANDLERS;
} }
public String getQuery() { public String getQuery() {
return argument; return argument;
} }
public static HandlerList getHandlerList() { // public String getVariables() {return;}
return HANDLERS;
}
} }

View File

@ -21,13 +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;
/** /**
* Executes a statement on a database and optionally stores the result in a variable. Expressions * Executes a statement on a database and optionally stores the result in a variable. Expressions
@ -47,91 +44,131 @@ import java.util.regex.Pattern;
* @since 0.1.0 * @since 0.1.0
*/ */
public class EffExecuteStatement extends Effect { public class EffExecuteStatement extends Effect {
private static final ExecutorService threadPool = Executors.newFixedThreadPool(SkriptDB.getInstance().getConfig().getInt("thread-pool-size", 10)); private static final ExecutorService threadPool =
private static final Pattern ARGUMENT_PLACEHOLDER = Pattern.compile("(?<!\\\\)\\?"); Executors.newCachedThreadPool();
static String lastError; static String lastError;
static { static {
Skript.registerEffect(EffExecuteStatement.class, Skript.registerEffect(EffExecuteStatement.class,
"[quickly:quickly] execute %string% (in|on) %datasource% " + "execute %string% (in|on) %datasource% " +
"[with arg[ument][s] %-objects%] [and store [[the] [keys:generated keys] (output|result)[s]] (to|in) [the] [var[iable]] %-objects%]"); "[and store [[the] (output|result)[s]] (to|in) [the] [var[iable]] %-objects%]", "quickly execute %string% (in|on) %datasource% " +
"[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 VariableString var;
private VariableString resultVariableName;
private boolean isLocal; private boolean isLocal;
private boolean isList; private boolean isList;
private boolean quickly; private boolean isSync;
private boolean generatedKeys;
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) { if (ds == null) return;
return;
} boolean sync = !Bukkit.isPrimaryThread();
Pair<String, List<Object>> parsedQuery = parseQuery(e);
String baseVariable = resultVariableName != null ? resultVariableName.toString(e).toLowerCase(Locale.ENGLISH) : null; //if current thread is not main thread, then make this query to not have delays
Object locals = Variables.removeLocals(e); Object locals = Variables.removeLocals(e);
//execute SQL statement //execute SQL statement
if (Bukkit.isPrimaryThread()) {
CompletableFuture.supplyAsync(() -> executeStatement(ds, baseVariable, parsedQuery), threadPool) CompletableFuture<Object> sql = null;
.whenComplete((resources, err) -> { Object resources = null;
//handle last error syntax data if (!sync) {
resetLastSQLError(); sql = CompletableFuture.supplyAsync(() -> executeStatement(ds, baseVariable, query), threadPool);
if (err instanceof CompletionException && err.getCause() instanceof SkriptDBQueryException) { } else {
setLastSQLError(err.getCause().getMessage()); resources = executeStatement(ds, baseVariable, query);
} }
//when SQL statement is completed
boolean finalSync = sync;
if (sql != null) {
sql.whenComplete((res, err) -> {
if (err != null) {
err.printStackTrace();
}
//handle last error syntax data
lastError = null;
if (res instanceof String) {
lastError = (String) res;
}
if (getNext() != null) {
//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 (!quickly) { if (isSync || finalSync) {
Bukkit.getScheduler().runTask(SkriptDB.getInstance(), if (locals != null) {
() -> postExecution(e, locals, resources)); Variables.setLocalVariables(e, locals);
}
if (!(res instanceof String)) {
((Map<String, Object>) res).forEach((name, value) -> setVariable(e, name, value));
}
TriggerItem.walk(getNext(), e);
Variables.removeLocals(e);
} else { } else {
postExecution(e, locals, resources); Bukkit.getScheduler().runTask(SkriptDB.getInstance(), () -> {
if (locals != 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
//no functionality difference notice with it being removed from my test, but the memory gets filled with leaks
//so it must be kept
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;
Map<String, Object> resources = null;
resetLastSQLError();
try {
resources = executeStatement(ds, baseVariable, parsedQuery);
} catch (SkriptDBQueryException err) {
//handle last error syntax data //handle last error syntax data
setLastSQLError(err.getMessage()); lastError = null;
if (resources instanceof String) {
lastError = (String) resources;
} }
if (getNext() != null) {
//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
postExecution(e, locals, resources); if (locals != null) {
}
}
private void postExecution(Event e, Object locals, Map<String, Object> resources) {
if (locals != null && getNext() != null) {
Variables.setLocalVariables(e, locals); Variables.setLocalVariables(e, locals);
} }
if (resources != null) { if (!(resources instanceof String)) {
resources.forEach((name, value) -> setVariable(e, name, value)); ((Map<String, Object>) resources).forEach((name, value) -> setVariable(e, name, value));
} }
TriggerItem.walk(getNext(), e); TriggerItem.walk(getNext(), e);
//the line below is required to prevent memory leaks
Variables.removeLocals(e); Variables.removeLocals(e);
} }
}
}
@Override @Override
protected TriggerItem walk(Event e) { protected TriggerItem walk(Event e) {
debug(e, true); debug(e, true);
if (!quickly || !isSync) { //I think no longer needed as of 1.3.0, uncomment if something breaks
if (!isSync) {
Delay.addDelayedEvent(e); Delay.addDelayedEvent(e);
} }
execute(e); execute(e);
@ -139,108 +176,83 @@ public class EffExecuteStatement extends Effect {
} }
private Pair<String, List<Object>> parseQuery(Event e) { private Pair<String, List<Object>> parseQuery(Event e) {
if (queryArguments != null) { if (!(query instanceof VariableString)) {
Object[] args = queryArguments.getArray(e);
String queryString = query.getSingle(e);
int queryArgCount = (int) ARGUMENT_PLACEHOLDER.matcher(queryString).results().count();
if (queryArgCount != args.length) {
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);
}
return new Pair<>(query.getSingle(e), Arrays.asList(args));
} else if (query instanceof VariableString && !((VariableString) query).isSimple()) {
return parseVariableQuery(e, (VariableString) query);
}
return new Pair<>(query.getSingle(e), null); return new Pair<>(query.getSingle(e), null);
} }
VariableString q = (VariableString) query;
if (q.isSimple()) {
return new Pair<>(q.toString(e), null);
}
private Pair<String, List<Object>> parseVariableQuery(Event e, VariableString varQuery) {
StringBuilder sb = new StringBuilder(); StringBuilder sb = new StringBuilder();
List<Object> parameters = new LinkedList<>(); List<Object> parameters = new ArrayList<>();
Object[] objects = SkriptUtil.getTemplateString(varQuery); Object[] objects = SkriptUtil.getTemplateString(q);
for (int i = 0; i < objects.length; i++) { for (int i = 0; i < objects.length; i++) {
if (objects[i] instanceof String) { Object o = objects[i];
sb.append(objects[i]); if (o instanceof String) {
sb.append(o);
} else { } else {
Expression<?> expr = objects[i] instanceof Expression ? (Expression<?>) objects[i] : SkriptUtil.getExpressionFromInfo(objects[i]); Expression<?> expr;
boolean standaloneString = isStandaloneString(objects, i); if (o instanceof Expression)
expr = (Expression<?>) o;
else
expr = SkriptUtil.getExpressionFromInfo(o);
String before = getString(objects, i - 1);
String after = getString(objects, i + 1);
boolean standaloneString = false;
if (before != null && after != null) {
if (before.endsWith("'") && after.endsWith("'")) {
standaloneString = true;
}
}
Object expressionValue = expr.getSingle(e); Object expressionValue = expr.getSingle(e);
Pair<String, Object> toAppend = parseExpressionQuery(expr, expressionValue, standaloneString); if (expr instanceof ExprUnsafe) {
sb.append(toAppend.getFirst()); sb.append(expressionValue);
if (toAppend.getSecond() != null) {
parameters.add(toAppend.getSecond()); if (standaloneString && expressionValue instanceof String) {
String rawExpression = ((ExprUnsafe) expr).getRawExpression();
Skript.warning(
String.format("Unsafe may have been used unnecessarily. Try replacing 'unsafe %1$s' with %1$s",
rawExpression));
}
} else {
parameters.add(expressionValue);
sb.append('?');
if (standaloneString) {
Skript.warning("Do not surround expressions with quotes!");
}
} }
} }
} }
return new Pair<>(sb.toString(), parameters); return new Pair<>(sb.toString(), parameters);
} }
private Pair<String, Object> parseExpressionQuery(Expression<?> expr, Object expressionValue, boolean standaloneString) { private Object executeStatement(DataSource ds, String baseVariable, Pair<String, List<Object>> query) {
if (expr instanceof ExprUnsafe) {
if (standaloneString && expressionValue instanceof String) {
Skript.warning(
String.format("Unsafe may have been used unnecessarily. Try replacing 'unsafe %1$s' with %1$s",
((ExprUnsafe) expr).getRawExpression()));
}
return new Pair<>((String) expressionValue, null);
} else {
if (standaloneString) {
Skript.warning("Do not surround expressions with quotes!");
}
return new Pair<>("?", expressionValue);
}
}
private Map<String, Object> executeStatement(DataSource ds, String baseVariable, Pair<String, List<Object>> query) throws SkriptDBQueryException {
if (ds == null) { if (ds == null) {
throw new SkriptDBQueryException("Data source is not set"); return "Data source is not set";
} }
try (Connection conn = ds.getConnection()) { Map<String, Object> variableList = new HashMap<>();
try (PreparedStatement stmt = createStatement(conn, query)) { try (Connection conn = ds.getConnection();
PreparedStatement stmt = createStatement(conn, query)) {
boolean hasResultSet = stmt.execute(); boolean hasResultSet = stmt.execute();
if (baseVariable != null) { if (baseVariable != null) {
return processBaseVariable(baseVariable, stmt, hasResultSet);
}
return Map.of();
}
} catch (SQLException ex) {
throw new SkriptDBQueryException(ex.getMessage());
}
}
private Map<String, Object> processBaseVariable(String baseVariable, PreparedStatement stmt, boolean hasResultSet) throws SQLException {
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(generatedKeys ? stmt.getGeneratedKeys() : stmt.getResultSet()); crs.populate(stmt.getResultSet());
if (isList) { if (isList) {
return fetchQueryResultSet(crs, baseVariable);
} else {
crs.last();
return Map.of(baseVariable, crs.getRow());
}
} 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
return Map.of(baseVariable, stmt.getUpdateCount());
}
return Map.of();
}
private Map<String, Object> fetchQueryResultSet(CachedRowSet crs, String baseVariable) throws SQLException {
Map<String, Object> variableList = new HashMap<>();
ResultSetMetaData meta = crs.getMetaData(); ResultSetMetaData meta = crs.getMetaData();
int columnCount = meta.getColumnCount(); int columnCount = meta.getColumnCount();
@ -250,6 +262,7 @@ public class EffExecuteStatement extends Effect {
} }
int rowNumber = 1; int rowNumber = 1;
try {
while (crs.next()) { while (crs.next()) {
for (int i = 1; i <= columnCount; i++) { for (int i = 1; i <= columnCount; i++) {
variableList.put(baseVariable + meta.getColumnLabel(i).toLowerCase(Locale.ENGLISH) variableList.put(baseVariable + meta.getColumnLabel(i).toLowerCase(Locale.ENGLISH)
@ -257,33 +270,48 @@ public class EffExecuteStatement extends Effect {
} }
rowNumber++; rowNumber++;
} }
} catch (SQLException ex) {
return ex.getMessage();
}
} else {
crs.last();
variableList.put(baseVariable, crs.getRow());
}
} 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
variableList.put(baseVariable, stmt.getUpdateCount());
}
}
} catch (SQLException ex) {
return ex.getMessage();
}
return variableList; return variableList;
} }
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 = generatedKeys ? PreparedStatement stmt = conn.prepareStatement(query.getFirst());
conn.prepareStatement(query.getFirst(), Statement.RETURN_GENERATED_KEYS) List<Object> parameters = query.getSecond();
: conn.prepareStatement(query.getFirst(), Statement.NO_GENERATED_KEYS);
if (query.getSecond() != null) { if (parameters != null) {
Iterator<Object> iter = query.getSecond().iterator(); for (int i = 0; i < parameters.size(); i++) {
for (int i = 1; iter.hasNext(); i++) { stmt.setObject(i + 1, parameters.get(i));
stmt.setObject(i, iter.next());
} }
} }
return stmt; return stmt;
} }
private boolean isStandaloneString(Object[] objects, int index) { private String getString(Object[] objects, int index) {
String before = getString(objects, index - 1); if (index < 0 || index >= objects.length) {
String after = getString(objects, index + 1); return null;
return before != null && before.endsWith("'") && after != null && after.endsWith("'");
} }
private String getString(Object[] objects, int index) { Object object = objects[index];
if (index >= 0 && index < objects.length && objects[index] instanceof String) {
return (String) objects[index]; if (object instanceof String) {
return (String) object;
} }
return null; return null;
} }
@ -291,7 +319,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 instanceof byte[]) { if (obj.getClass().getName().equals("[B")) {
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)
@ -306,14 +334,6 @@ 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);
@ -321,7 +341,8 @@ public class EffExecuteStatement extends Effect {
@SuppressWarnings("unchecked") @SuppressWarnings("unchecked")
@Override @Override
public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult) { public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed,
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;
@ -332,36 +353,17 @@ public class EffExecuteStatement extends Effect {
return false; return false;
} }
dataSource = (Expression<HikariDataSource>) exprs[1]; dataSource = (Expression<HikariDataSource>) exprs[1];
if (exprs[2] != null) { Expression<?> expr = exprs[2];
if (query instanceof VariableString && !((VariableString) query).isSimple()) { isSync = matchedPattern == 1;
Skript.warning("Your query string contains expresions, but you've also provided query arguments. Consider using `unsafe` keyword before your query."); if (expr instanceof Variable) {
} Variable<?> varExpr = (Variable<?>) expr;
queryArguments = (Expression<Object>) exprs[2]; var = varExpr.getName();
}
;
Expression<?> resultHolder = exprs[3];
quickly = parseResult.hasTag("quickly");
if (resultHolder instanceof Variable) {
Variable<?> varExpr = (Variable<?>) resultHolder;
resultVariableName = varExpr.getName();
isLocal = varExpr.isLocal(); isLocal = varExpr.isLocal();
isList = varExpr.isList(); isList = varExpr.isList();
generatedKeys = parseResult.hasTag("keys"); } else if (expr != null) {
} else if (resultHolder != null) { Skript.error(expr + " 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);
}
}
} }

View File

@ -22,7 +22,7 @@ import java.util.Map;
* *
* @name Data Source * @name Data Source
* @index -1 * @index -1
* @pattern [the] data(base|[ ]source) [(of|at)] %string% [with [a] [max[imum]] [connection] life[ ]time of %timespan%] [[(using|with)] [a] driver %-string%]" * @pattern [the] data(base|[ ]source) [(of|at)] %string% [with [a] [max[imum]] [connection] life[ ]time of %timespan%]"
* @return datasource * @return datasource
* @example set {sql} to the database "mysql://localhost:3306/mydatabase?user=admin&password=12345&useSSL=false" * @example set {sql} to the database "mysql://localhost:3306/mydatabase?user=admin&password=12345&useSSL=false"
* @since 0.1.0 * @since 0.1.0
@ -32,14 +32,12 @@ 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%] " "[with [a] [max[imum]] [connection] life[ ]time of %-timespan%]");
+ "[[(using|with)] [a] driver %-string%]");
} }
private Expression<String> url; private Expression<String> url;
private Expression<Timespan> maxLifetime; private Expression<Timespan> maxLifetime;
private Expression<String> driver;
@Override @Override
protected HikariDataSource[] get(Event e) { protected HikariDataSource[] get(Event e) {
@ -57,18 +55,11 @@ public class ExprDataSource extends SimpleExpression<HikariDataSource> {
} }
HikariDataSource ds = new HikariDataSource(); HikariDataSource ds = new HikariDataSource();
ds.setMaximumPoolSize(SkriptDB.getInstance().getConfig().getInt("thread-pool-size", 10));
// 30 minutes by default //allow specifying of own sql driver class name
ds.setMaxLifetime(SkriptDB.getInstance().getConfig().getInt("max-connection-lifetime", 1800000)); if (!SkriptDB.getInstance().getConfig().getString("sql-driver-class-name", "default").equals("default")) {
// Allow specifying of own sql driver class name
if (driver != null && driver.getSingle(e) != null) {
ds.setDriverClassName(driver.getSingle(e));
} else if (!SkriptDB.getInstance().getConfig().getString("sql-driver-class-name", "default").equals("default")) {
ds.setDriverClassName(SkriptDB.getInstance().getConfig().getString("sql-driver-class-name")); ds.setDriverClassName(SkriptDB.getInstance().getConfig().getString("sql-driver-class-name"));
} }
ds.setJdbcUrl(jdbcUrl); ds.setJdbcUrl(jdbcUrl);
if (maxLifetime != null) { if (maxLifetime != null) {
@ -101,10 +92,10 @@ public class ExprDataSource extends SimpleExpression<HikariDataSource> {
@SuppressWarnings("unchecked") @SuppressWarnings("unchecked")
@Override @Override
public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult) { public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed,
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];
return true; return true;
} }
} }

View File

@ -1,10 +1,6 @@
package com.btk5h.skriptdb.skript; package com.btk5h.skriptdb.skript;
import org.bukkit.event.Event; import ch.njol.skript.ScriptLoader;
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;
@ -12,6 +8,8 @@ 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.
@ -53,7 +51,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 (!SkriptUtil.isCurrentEvent(SQLQueryCompleteEvent.class)) { if (!ScriptLoader.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;
} }

View File

@ -53,7 +53,8 @@ public class ExprUnsafe extends SimpleExpression<String> {
@SuppressWarnings("unchecked") @SuppressWarnings("unchecked")
@Override @Override
public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult) { public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed,
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;

View File

@ -30,6 +30,10 @@ public class Types {
return o.getJdbcUrl(); return o.getJdbcUrl();
} }
@Override
public String getVariableNamePattern() {
return "jdbc:.+";
}
}) })
.serializer(new Serializer<HikariDataSource>() { .serializer(new Serializer<HikariDataSource>() {
@Override @Override

View File

@ -1,5 +1,5 @@
name: skript-db name: skript-db
version: 1.4.0 version: 1.3.5
main: com.btk5h.skriptdb.SkriptDB main: com.btk5h.skriptdb.SkriptDB
depend: [Skript] depend: [Skript]
authors: [btk5h, FranKusmiruk, Govindas, TPGamesNL] authors: [btk5h, FranKusmiruk, Govindas, TPGamesNL]