Compare commits
21 Commits
1.3.6
...
110f3982ad
| Author | SHA1 | Date | |
|---|---|---|---|
|
110f3982ad
|
|||
|
52d111dbfa
|
|||
|
4de7dff0ad
|
|||
| c11980eea5 | |||
| 4124994b83 | |||
| cf61d7589b | |||
| 4d4af1622e | |||
| af25e695f0 | |||
| 54e260e56b | |||
| 587f303ba5 | |||
| 8586aeefcd | |||
| eb89699ed5 | |||
| f92b16a09f | |||
| dbce1d33f9 | |||
| a97ba3aee8 | |||
| bf5429634a | |||
| abd2d6fe03 | |||
| 2cc46fdae5 | |||
| 4fee9f2898 | |||
| bbbfb83518 | |||
| f51db586ef |
16
.gitignore
vendored
16
.gitignore
vendored
@@ -7,3 +7,19 @@
|
|||||||
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
|
||||||
|
|||||||
39
README.md
39
README.md
@@ -5,30 +5,40 @@
|
|||||||
|
|
||||||
### 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
|
||||||
- SQL Driver is configurable
|
- If a sql query is detected to be running on non-main thread, it becomes synchronous automatically
|
||||||
|
- 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 Skript 2.5+
|
1. Use 1.8+ Minecraft server version.
|
||||||
2. Use Java 11+
|
2. Use Skript 2.5+ (1.8 Skript fork is needed if you're using 1.8)
|
||||||
3. Put skript-db in plugins folder and restart the server
|
3. Use Java 11+ (If you use 1.8, a spigot fork is needed to support Java 11+)
|
||||||
|
4. Put skript-db in plugins folder and restart the server
|
||||||
### Expression `Data Source` => `datasource`
|
### Expression `Data Source` => `datasource`
|
||||||
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! The example provided uses a MySQL database.
|
The url format for your database may vary depending on database you are using.
|
||||||
|
MariaDB/PostgreSQL users: make sure to check `config.yml` to use the correct driver.
|
||||||
#### Syntax
|
#### Syntax
|
||||||
```
|
```
|
||||||
[the] data(base|[ ]source) [(of|at)] %string%
|
[the] data(base|[ ]source) [(of|at)] %string% [with [a] [max[imum]] [connection] life[ ]time of %timespan%] [[(using|with)] [a] driver %-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"
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
@@ -70,6 +80,7 @@ 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%
|
||||||
@@ -83,6 +94,18 @@ 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
|
||||||
@@ -90,4 +113,4 @@ plugins/skript-db/config.yml
|
|||||||
# Only change this if you wish to use a different driver than Java's default, like MariaDB driver.
|
# Only change this if you wish to use a different driver than Java's default, like MariaDB driver.
|
||||||
# If you use MariaDB, its driver is shaded together with skript-db, so you can just specify: "org.mariadb.jdbc.Driver"
|
# If you use MariaDB, its driver is shaded together with skript-db, so you can just specify: "org.mariadb.jdbc.Driver"
|
||||||
sql-driver-class-name: "default"
|
sql-driver-class-name: "default"
|
||||||
```
|
```
|
||||||
|
|||||||
23
pom.xml
23
pom.xml
@@ -6,7 +6,7 @@
|
|||||||
|
|
||||||
<groupId>com.btk5h</groupId>
|
<groupId>com.btk5h</groupId>
|
||||||
<artifactId>skript-db</artifactId>
|
<artifactId>skript-db</artifactId>
|
||||||
<version>1.3.5</version>
|
<version>1.4.0</version>
|
||||||
<packaging>jar</packaging>
|
<packaging>jar</packaging>
|
||||||
|
|
||||||
<repositories>
|
<repositories>
|
||||||
@@ -19,8 +19,8 @@
|
|||||||
<url>https://jitpack.io</url>
|
<url>https://jitpack.io</url>
|
||||||
</repository>
|
</repository>
|
||||||
<repository>
|
<repository>
|
||||||
<id>commons-pool2</id>
|
<id>mvnrepository</id>
|
||||||
<url>https://mvnrepository.com/artifact/org.apache.commons/commons-pool2</url>
|
<url>https://mvnrepository.com</url>
|
||||||
</repository>
|
</repository>
|
||||||
<repository>
|
<repository>
|
||||||
<id>PaperMC</id>
|
<id>PaperMC</id>
|
||||||
@@ -28,7 +28,11 @@
|
|||||||
</repository>
|
</repository>
|
||||||
<repository>
|
<repository>
|
||||||
<id>sk89q</id>
|
<id>sk89q</id>
|
||||||
<url>http://maven.sk89q.com/repo</url>
|
<url>https://maven.sk89q.com/repo</url>
|
||||||
|
</repository>
|
||||||
|
<repository>
|
||||||
|
<id>skript</id>
|
||||||
|
<url>https://repo.skriptlang.org/releases</url>
|
||||||
</repository>
|
</repository>
|
||||||
</repositories>
|
</repositories>
|
||||||
|
|
||||||
@@ -93,14 +97,21 @@
|
|||||||
<dependency>
|
<dependency>
|
||||||
<groupId>com.github.SkriptLang</groupId>
|
<groupId>com.github.SkriptLang</groupId>
|
||||||
<artifactId>Skript</artifactId>
|
<artifactId>Skript</artifactId>
|
||||||
<version>2.6-beta3</version>
|
<version>2.6.1</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.0.3</version>
|
<version>3.1.2</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>
|
||||||
|
|
||||||
|
|||||||
@@ -73,8 +73,14 @@ 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("# If you use MariaDB, its driver is shaded together with skript-db, so you can just specify:" + "\"org.mariadb.jdbc.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 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();
|
||||||
|
|||||||
@@ -10,7 +10,6 @@ import com.btk5h.skriptdb.SkriptDB;
|
|||||||
import com.btk5h.skriptdb.SkriptUtil;
|
import com.btk5h.skriptdb.SkriptUtil;
|
||||||
import com.zaxxer.hikari.HikariDataSource;
|
import com.zaxxer.hikari.HikariDataSource;
|
||||||
import org.bukkit.Bukkit;
|
import org.bukkit.Bukkit;
|
||||||
import org.bukkit.entity.Player;
|
|
||||||
import org.bukkit.event.Event;
|
import org.bukkit.event.Event;
|
||||||
|
|
||||||
import javax.sql.DataSource;
|
import javax.sql.DataSource;
|
||||||
@@ -26,6 +25,7 @@ import java.util.*;
|
|||||||
import java.util.concurrent.CompletableFuture;
|
import java.util.concurrent.CompletableFuture;
|
||||||
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
|
||||||
@@ -45,23 +45,26 @@ import java.util.concurrent.Executors;
|
|||||||
* @since 0.1.0
|
* @since 0.1.0
|
||||||
*/
|
*/
|
||||||
public class EffExecuteStatement extends Effect {
|
public class EffExecuteStatement extends Effect {
|
||||||
private static final ExecutorService threadPool =
|
private static final ExecutorService threadPool = Executors.newFixedThreadPool(SkriptDB.getInstance().getConfig().getInt("thread-pool-size", 10));
|
||||||
Executors.newCachedThreadPool();
|
private static final Pattern ARGUMENT_PLACEHOLDER = Pattern.compile("(?<!\\\\)\\?");
|
||||||
static String lastError;
|
static String lastError;
|
||||||
|
|
||||||
static {
|
static {
|
||||||
Skript.registerEffect(EffExecuteStatement.class,
|
Skript.registerEffect(EffExecuteStatement.class,
|
||||||
"execute %string% (in|on) %datasource% " +
|
"execute %string% (in|on) %datasource% " +
|
||||||
"[and store [[the] (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%]",
|
||||||
"[and store [[the] (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 VariableString var;
|
private VariableString var;
|
||||||
private boolean isLocal;
|
private boolean isLocal;
|
||||||
private boolean isList;
|
private boolean isList;
|
||||||
private boolean isSync;
|
private boolean quickly;
|
||||||
|
private boolean isSync = false;
|
||||||
|
|
||||||
private void continueScriptExecution(Event e, Object populatedVariables) {
|
private void continueScriptExecution(Event e, Object populatedVariables) {
|
||||||
lastError = null;
|
lastError = null;
|
||||||
@@ -83,58 +86,26 @@ public class EffExecuteStatement extends Effect {
|
|||||||
String baseVariable = var != null ? var.toString(e).toLowerCase(Locale.ENGLISH) : null;
|
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;
|
||||||
|
|
||||||
boolean sync = !Bukkit.isPrimaryThread();
|
|
||||||
|
|
||||||
//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
|
||||||
CompletableFuture<Object> sql =
|
if (Bukkit.isPrimaryThread()) {
|
||||||
CompletableFuture.supplyAsync(() -> executeStatement(ds, baseVariable, query), threadPool);
|
CompletableFuture<Object> sql = CompletableFuture.supplyAsync(() -> executeStatement(ds, baseVariable, query), threadPool);
|
||||||
|
sql.whenComplete((res, err) -> {
|
||||||
//when SQL statement is completed
|
if (err != null) {
|
||||||
boolean finalSync = sync;
|
err.printStackTrace();
|
||||||
sql.whenComplete((res, err) -> {
|
}
|
||||||
if (err != null) {
|
//handle last error syntax data
|
||||||
err.printStackTrace();
|
lastError = null;
|
||||||
}
|
if (res instanceof String) {
|
||||||
|
lastError = (String) res;
|
||||||
//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 (!(res instanceof String)) {
|
if (!quickly) {
|
||||||
|
|
||||||
//also set variables in the sql query complete event
|
|
||||||
|
|
||||||
//TEMPORARILY DISABLED, AS THIS WOULD WORSEN PERFORMANCE OF THE QUERIES AND NOT BE USED BY MOST PEOPLE.
|
|
||||||
//I may add config option to enable this later?
|
|
||||||
|
|
||||||
//SQLQueryCompleteEvent event = new SQLQueryCompleteEvent(this.query.getSingle(e));
|
|
||||||
//((Map<String, Object>) res).forEach((name, value) -> setVariable(event, name, value));
|
|
||||||
//SkriptDB.getPlugin(SkriptDB.class).getServer().getPluginManager().callEvent(event);
|
|
||||||
}
|
|
||||||
if (isSync || finalSync) {
|
|
||||||
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);
|
|
||||||
Variables.removeLocals(e);
|
|
||||||
} else {
|
|
||||||
Bukkit.getScheduler().runTask(SkriptDB.getInstance(), () -> {
|
Bukkit.getScheduler().runTask(SkriptDB.getInstance(), () -> {
|
||||||
if (locals != null) {
|
if (locals != null && getNext() != null) {
|
||||||
Variables.setLocalVariables(e, locals);
|
Variables.setLocalVariables(e, locals);
|
||||||
}
|
}
|
||||||
if (!(res instanceof String)) {
|
if (!(res instanceof String)) {
|
||||||
@@ -142,20 +113,47 @@ public class EffExecuteStatement extends Effect {
|
|||||||
}
|
}
|
||||||
TriggerItem.walk(getNext(), e);
|
TriggerItem.walk(getNext(), e);
|
||||||
//the line below is required to prevent memory leaks
|
//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);
|
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
|
||||||
|
} else {
|
||||||
|
isSync = true;
|
||||||
|
Object resources = executeStatement(ds, baseVariable, query);
|
||||||
|
//handle last error syntax data
|
||||||
|
lastError = null;
|
||||||
|
if (resources instanceof String) {
|
||||||
|
lastError = (String) resources;
|
||||||
}
|
}
|
||||||
});
|
//if local variables are present
|
||||||
|
//bring back local variables
|
||||||
|
//populate SQL data into variables
|
||||||
|
if (locals != null && getNext() != null) {
|
||||||
|
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);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
protected TriggerItem walk(Event e) {
|
protected TriggerItem walk(Event e) {
|
||||||
debug(e, true);
|
debug(e, true);
|
||||||
//I think no longer needed as of 1.3.0, uncomment if something breaks
|
if (!quickly || !isSync) {
|
||||||
if (!isSync) {
|
|
||||||
Delay.addDelayedEvent(e);
|
Delay.addDelayedEvent(e);
|
||||||
}
|
}
|
||||||
execute(e);
|
execute(e);
|
||||||
@@ -163,142 +161,144 @@ public class EffExecuteStatement extends Effect {
|
|||||||
}
|
}
|
||||||
|
|
||||||
private Pair<String, List<Object>> parseQuery(Event e) {
|
private Pair<String, List<Object>> parseQuery(Event e) {
|
||||||
if (!(query instanceof VariableString)) {
|
if (queryArguments != null) {
|
||||||
return new Pair<>(query.getSingle(e), null);
|
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("Your query has %d question marks, but you provided %d arguments.");
|
||||||
|
args = Arrays.copyOf(args, queryArgCount);
|
||||||
|
}
|
||||||
|
return new Pair<>(query.getSingle(e), List.of(args));
|
||||||
|
} else if (query instanceof VariableString && !((VariableString) query).isSimple()) {
|
||||||
|
return parseVariableQuery(e, (VariableString) query);
|
||||||
}
|
}
|
||||||
VariableString q = (VariableString) query;
|
return new Pair<>(query.getSingle(e), null);
|
||||||
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 ArrayList<>();
|
List<Object> parameters = new LinkedList<>();
|
||||||
Object[] objects = SkriptUtil.getTemplateString(q);
|
Object[] objects = SkriptUtil.getTemplateString(varQuery);
|
||||||
|
|
||||||
for (int i = 0; i < objects.length; i++) {
|
for (int i = 0; i < objects.length; i++) {
|
||||||
Object o = objects[i];
|
if (objects[i] instanceof String) {
|
||||||
if (o instanceof String) {
|
sb.append(objects[i]);
|
||||||
sb.append(o);
|
|
||||||
} else {
|
} else {
|
||||||
Expression<?> expr;
|
Expression<?> expr = objects[i] instanceof Expression ? (Expression<?>) objects[i] : SkriptUtil.getExpressionFromInfo(objects[i]);
|
||||||
if (o instanceof Expression)
|
boolean standaloneString = isStandaloneString(objects, i);
|
||||||
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);
|
||||||
|
|
||||||
if (expr instanceof ExprUnsafe) {
|
Pair<String, Object> toAppend = parseExpressionQuery(expr, expressionValue, standaloneString);
|
||||||
sb.append(expressionValue);
|
sb.append(toAppend.getFirst());
|
||||||
|
if (toAppend.getSecond() != null) {
|
||||||
if (standaloneString && expressionValue instanceof String) {
|
parameters.add(toAppend.getSecond());
|
||||||
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) {
|
||||||
|
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 Object executeStatement(DataSource ds, String baseVariable, Pair<String, List<Object>> query) {
|
private Object executeStatement(DataSource ds, String baseVariable, Pair<String, List<Object>> query) {
|
||||||
if (ds == null) {
|
if (ds == null) {
|
||||||
return "Data source is not set";
|
return "Data source is not set";
|
||||||
}
|
}
|
||||||
Map<String, Object> variableList = new HashMap<>();
|
try (Connection conn = ds.getConnection()) {
|
||||||
try (Connection conn = ds.getConnection();
|
try (PreparedStatement stmt = createStatement(conn, query)) {
|
||||||
PreparedStatement stmt = createStatement(conn, query)) {
|
boolean hasResultSet = stmt.execute();
|
||||||
|
|
||||||
boolean hasResultSet = stmt.execute();
|
if (baseVariable != null) {
|
||||||
|
return processBaseVariable(baseVariable, stmt, hasResultSet);
|
||||||
if (baseVariable != null) {
|
|
||||||
if (isList) {
|
|
||||||
baseVariable = baseVariable.substring(0, baseVariable.length() - 1);
|
|
||||||
}
|
|
||||||
|
|
||||||
if (hasResultSet) {
|
|
||||||
CachedRowSet crs = SkriptDB.getRowSetFactory().createCachedRowSet();
|
|
||||||
crs.populate(stmt.getResultSet());
|
|
||||||
|
|
||||||
if (isList) {
|
|
||||||
ResultSetMetaData meta = crs.getMetaData();
|
|
||||||
int columnCount = meta.getColumnCount();
|
|
||||||
|
|
||||||
for (int i = 1; i <= columnCount; i++) {
|
|
||||||
String label = meta.getColumnLabel(i);
|
|
||||||
variableList.put(baseVariable + label, label);
|
|
||||||
}
|
|
||||||
|
|
||||||
int rowNumber = 1;
|
|
||||||
try {
|
|
||||||
while (crs.next()) {
|
|
||||||
for (int i = 1; i <= columnCount; i++) {
|
|
||||||
variableList.put(baseVariable + meta.getColumnLabel(i).toLowerCase(Locale.ENGLISH)
|
|
||||||
+ Variable.SEPARATOR + rowNumber, crs.getObject(i));
|
|
||||||
}
|
|
||||||
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());
|
|
||||||
}
|
}
|
||||||
|
return Map.of();
|
||||||
}
|
}
|
||||||
} catch (SQLException ex) {
|
} catch (SQLException ex) {
|
||||||
return ex.getMessage();
|
return ex.getMessage();
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private Object processBaseVariable(String baseVariable, PreparedStatement stmt, boolean hasResultSet) throws SQLException {
|
||||||
|
Map<String, Object> variableList = new HashMap<>();
|
||||||
|
if (isList) {
|
||||||
|
baseVariable = baseVariable.substring(0, baseVariable.length() - 1);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (hasResultSet) {
|
||||||
|
CachedRowSet crs = SkriptDB.getRowSetFactory().createCachedRowSet();
|
||||||
|
crs.populate(stmt.getResultSet());
|
||||||
|
|
||||||
|
if (isList) {
|
||||||
|
return fetchQueryResultSet(crs, baseVariable);
|
||||||
|
} 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
|
||||||
|
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();
|
||||||
|
int columnCount = meta.getColumnCount();
|
||||||
|
|
||||||
|
for (int i = 1; i <= columnCount; i++) {
|
||||||
|
String label = meta.getColumnLabel(i);
|
||||||
|
variableList.put(baseVariable + label, label);
|
||||||
|
}
|
||||||
|
|
||||||
|
int rowNumber = 1;
|
||||||
|
while (crs.next()) {
|
||||||
|
for (int i = 1; i <= columnCount; i++) {
|
||||||
|
variableList.put(baseVariable + meta.getColumnLabel(i).toLowerCase(Locale.ENGLISH)
|
||||||
|
+ Variable.SEPARATOR + rowNumber, crs.getObject(i));
|
||||||
|
}
|
||||||
|
rowNumber++;
|
||||||
|
}
|
||||||
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 = conn.prepareStatement(query.getFirst());
|
PreparedStatement stmt = conn.prepareStatement(query.getFirst());
|
||||||
List<Object> parameters = query.getSecond();
|
if (query.getSecond() != null) {
|
||||||
|
Iterator<Object> iter = query.getSecond().iterator();
|
||||||
if (parameters != null) {
|
for (int i = 1; iter.hasNext(); i++) {
|
||||||
for (int i = 0; i < parameters.size(); i++) {
|
stmt.setObject(i, iter.next());
|
||||||
stmt.setObject(i + 1, parameters.get(i));
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return stmt;
|
return stmt;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
private boolean isStandaloneString(Object[] objects, int index) {
|
||||||
|
String before = getString(objects, index - 1);
|
||||||
|
String after = getString(objects, index + 1);
|
||||||
|
return before != null && before.endsWith("'") && after != null && after.endsWith("'");
|
||||||
|
}
|
||||||
|
|
||||||
private String getString(Object[] objects, int index) {
|
private String getString(Object[] objects, int index) {
|
||||||
if (index < 0 || index >= objects.length) {
|
if (index >= 0 && index < objects.length && objects[index] instanceof String) {
|
||||||
return null;
|
return (String) objects[index];
|
||||||
}
|
}
|
||||||
|
|
||||||
Object object = objects[index];
|
|
||||||
|
|
||||||
if (object instanceof String) {
|
|
||||||
return (String) object;
|
|
||||||
}
|
|
||||||
|
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -340,15 +340,21 @@ public class EffExecuteStatement extends Effect {
|
|||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
dataSource = (Expression<HikariDataSource>) exprs[1];
|
dataSource = (Expression<HikariDataSource>) exprs[1];
|
||||||
Expression<?> expr = exprs[2];
|
if (exprs[2] != null) {
|
||||||
isSync = matchedPattern == 1;
|
if (query instanceof VariableString && !((VariableString) query).isSimple()) {
|
||||||
if (expr instanceof Variable) {
|
Skript.warning("Your query string contains expresions, but you've also provided query arguments. Consider using `unsafe` keyword before your query.");
|
||||||
Variable<?> varExpr = (Variable<?>) expr;
|
}
|
||||||
|
queryArguments = (Expression<Object>) exprs[2];
|
||||||
|
}
|
||||||
|
Expression<?> resultHolder = exprs[3];
|
||||||
|
quickly = matchedPattern == 1;
|
||||||
|
if (resultHolder instanceof Variable) {
|
||||||
|
Variable<?> varExpr = (Variable<?>) resultHolder;
|
||||||
var = varExpr.getName();
|
var = varExpr.getName();
|
||||||
isLocal = varExpr.isLocal();
|
isLocal = varExpr.isLocal();
|
||||||
isList = varExpr.isList();
|
isList = varExpr.isList();
|
||||||
} 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;
|
||||||
|
|||||||
@@ -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%]"
|
* @pattern [the] data(base|[ ]source) [(of|at)] %string% [with [a] [max[imum]] [connection] life[ ]time of %timespan%] [[(using|with)] [a] driver %-string%]"
|
||||||
* @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
|
||||||
@@ -33,11 +33,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) {
|
||||||
@@ -55,11 +56,18 @@ public class ExprDataSource extends SimpleExpression<HikariDataSource> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
HikariDataSource ds = new HikariDataSource();
|
HikariDataSource ds = new HikariDataSource();
|
||||||
|
ds.setMaximumPoolSize(SkriptDB.getInstance().getConfig().getInt("thread-pool-size", 10));
|
||||||
|
|
||||||
//allow specifying of own sql driver class name
|
// 30 minutes by default
|
||||||
if (!SkriptDB.getInstance().getConfig().getString("sql-driver-class-name", "default").equals("default")) {
|
ds.setMaxLifetime(SkriptDB.getInstance().getConfig().getInt("max-connection-lifetime", 1800000));
|
||||||
|
|
||||||
|
// 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) {
|
||||||
@@ -96,6 +104,7 @@ public class ExprDataSource extends SimpleExpression<HikariDataSource> {
|
|||||||
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];
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -30,10 +30,6 @@ 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
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
name: skript-db
|
name: skript-db
|
||||||
version: 1.3.5
|
version: 1.4.0
|
||||||
main: com.btk5h.skriptdb.SkriptDB
|
main: com.btk5h.skriptdb.SkriptDB
|
||||||
depend: [Skript]
|
depend: [Skript]
|
||||||
authors: [btk5h, FranKusmiruk, Govindas, TPGamesNL]
|
authors: [btk5h, FranKusmiruk, Govindas, TPGamesNL]
|
||||||
|
|||||||
Reference in New Issue
Block a user