forked from Limework/skript-db
Compare commits
67 Commits
Author | SHA1 | Date |
---|---|---|
rigbot | bf5429634a | |
rigbot | abd2d6fe03 | |
rigbot | 2cc46fdae5 | |
rigbot | 4fee9f2898 | |
rigbot | bbbfb83518 | |
Govindas | f51db586ef | |
Govindas | 3466a04ec8 | |
Govindas | d0191007a5 | |
Govindas | b1df041ccb | |
Govindas | b9e14652ea | |
Govindas | 0098450441 | |
Govindas | 9c41039217 | |
Govindas | 46a72639af | |
Govindas | cbd1565896 | |
Govindas | 0332ad9334 | |
Govindas | 32f40af484 | |
Govindas | 2a24a974ef | |
Govindas | d80df616c3 | |
Govindas | 0b3b183a14 | |
Govindas | 70fa7b7105 | |
Govindas | c85d579645 | |
Govindas | 1e039c1bfe | |
Govindas | 2a4d7f6a6d | |
Govindas | 2dcd4edf58 | |
Govindas | 9b694206d3 | |
Govindas | d8cb6fedb5 | |
Govindas | 2eda1418cf | |
Govindas | 83d2795519 | |
Govindas | 66459c6190 | |
Govindas | b1ef437b96 | |
mohammed jasem alaajel | 35cfb0b4bb | |
Govindas | 4da64624d8 | |
Govindas | 0c16b98553 | |
Govindas | 9e7c5fcbee | |
Govindas | 8b3d26cf78 | |
Govindas | 5a22864650 | |
Govindas | 05554a0043 | |
Govindas | f6a43f0b53 | |
Govindas | 5803be55b7 | |
Govindas | d57b921b4f | |
Govindas | 4fd654c743 | |
Govindas | 233d21a30b | |
Govindas | 8e760c4d8b | |
Govindas | fe2231ae23 | |
Govindas | a132912f6b | |
Govindas | d4f9a394fd | |
Govindas | a63a4c6d6f | |
Govindas | 11063c166d | |
Govindas | b5f2d56263 | |
Govindas | 8b5121d5fb | |
Govindas | b435696385 | |
Govindas | 4d795edf01 | |
Govindas | 2570408906 | |
Govindas | 8d94a85779 | |
Govindas | 6d0ec81e2e | |
Govindas | c4379d45b7 | |
Govindas | 434ea07410 | |
Govindas | 8ca308802f | |
Govindas | 2ce1dd924e | |
Govindas | b20740b020 | |
Bryan Terce | 7906dd8eb1 | |
Bryan Terce | 33f4d5ff54 | |
Bryan Terce | 9a20da02a0 | |
Bryan Terce | f13bf78007 | |
Bryan Terce | 55081e5d28 | |
Bryan Terce | d88e431f07 | |
Bryan Terce | e6606a012a |
|
@ -6,3 +6,4 @@
|
|||
*.iml
|
||||
out/
|
||||
target
|
||||
compile/
|
||||
|
|
28
README.md
28
README.md
|
@ -5,10 +5,18 @@
|
|||
|
||||
### Difference from original skript-db
|
||||
- Fixed local variables disappearance in newer Skript versions (very hacky fix, but it works, so that's good!)
|
||||
- Thread-pool size is now configurable
|
||||
- Uses a newer version of HikariCP
|
||||
- Only meant to be used by newer Minecraft versions (1.8 is not supported)
|
||||
- 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)
|
||||
- Replaced `synchronously execute` with `quickly execute`, which allows to speed up queries by 50ms with some risk
|
||||
- SQL Driver is configurable
|
||||
- A few variable type related bugs fixed
|
||||
- Uses Java 11 instead of Java 8
|
||||
|
||||
### Installation
|
||||
1. Use 1.8+ Minecraft server version.
|
||||
2. Use Skript 2.5+ (1.8 Skript fork is needed if you're using 1.8)
|
||||
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`
|
||||
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.
|
||||
|
@ -35,11 +43,11 @@ Executes a statement on a database and optionally stores the result in a variabl
|
|||
|
||||
If a list variable, such as `{test::*}`, is passed, the query result will be mapped to the list
|
||||
variable in the form `{test::<column name>::<row number>}`
|
||||
|
||||
If `synchronously` is specified, the SQL query will be done on the current thread.
|
||||
|
||||
If `quickly` is specified, the SQL query will be done without jumping back to main thread, which speeds it up by 50ms, however that makes code after it to also be on separate thread, you can jump back to main thread by adding `wait a tick`
|
||||
#### Syntax
|
||||
```
|
||||
[synchronously] execute %string% (in|on) %datasource% [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%]
|
||||
```
|
||||
|
||||
#### Examples
|
||||
|
@ -77,4 +85,10 @@ execute unsafe {fully dynamic query} in {sql}
|
|||
```
|
||||
|
||||
---
|
||||
|
||||
### Configuration
|
||||
plugins/skript-db/config.yml
|
||||
```
|
||||
# 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"
|
||||
sql-driver-class-name: "default"
|
||||
```
|
31
pom.xml
31
pom.xml
|
@ -6,7 +6,7 @@
|
|||
|
||||
<groupId>com.btk5h</groupId>
|
||||
<artifactId>skript-db</artifactId>
|
||||
<version>1.2.1</version>
|
||||
<version>1.3.5</version>
|
||||
<packaging>jar</packaging>
|
||||
|
||||
<repositories>
|
||||
|
@ -45,11 +45,28 @@
|
|||
<artifactId>maven-compiler-plugin</artifactId>
|
||||
<version>3.6.1</version>
|
||||
<configuration>
|
||||
<source>10</source>
|
||||
<target>10</target>
|
||||
<source>11</source>
|
||||
<target>11</target>
|
||||
<encoding>UTF-8</encoding>
|
||||
</configuration>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-shade-plugin</artifactId>
|
||||
<version>3.2.3</version>
|
||||
<configuration>
|
||||
<createDependencyReducedPom>false</createDependencyReducedPom>
|
||||
<minimizeJar>true</minimizeJar>
|
||||
</configuration>
|
||||
<executions>
|
||||
<execution>
|
||||
<phase>package</phase>
|
||||
<goals>
|
||||
<goal>shade</goal>
|
||||
</goals>
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-jar-plugin</artifactId>
|
||||
|
@ -65,7 +82,7 @@
|
|||
<dependency>
|
||||
<groupId>com.zaxxer</groupId>
|
||||
<artifactId>HikariCP</artifactId>
|
||||
<version>4.0.1</version>
|
||||
<version>5.0.1</version>
|
||||
<scope>compile</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
|
@ -77,16 +94,16 @@
|
|||
<dependency>
|
||||
<groupId>com.github.SkriptLang</groupId>
|
||||
<artifactId>Skript</artifactId>
|
||||
<version>2.5.3</version>
|
||||
<version>2.6-beta3</version>
|
||||
<scope>provided</scope>
|
||||
</dependency>
|
||||
<!-- https://mvnrepository.com/artifact/org.mariadb.jdbc/mariadb-java-client -->
|
||||
<dependency>
|
||||
<groupId>org.mariadb.jdbc</groupId>
|
||||
<artifactId>mariadb-java-client</artifactId>
|
||||
<version>2.7.2</version>
|
||||
<version>3.0.3</version>
|
||||
<scope>compile</scope>
|
||||
</dependency>
|
||||
|
||||
</dependencies>
|
||||
</project>
|
||||
</project>
|
||||
|
|
|
@ -1,314 +0,0 @@
|
|||
package com.btk5h.skriptdb.skript;
|
||||
|
||||
import ch.njol.skript.Skript;
|
||||
import ch.njol.skript.effects.Delay;
|
||||
import ch.njol.skript.lang.*;
|
||||
import ch.njol.skript.variables.Variables;
|
||||
import ch.njol.util.Kleenean;
|
||||
import ch.njol.util.Pair;
|
||||
import com.btk5h.skriptdb.SkriptDB;
|
||||
import com.btk5h.skriptdb.SkriptUtil;
|
||||
import com.zaxxer.hikari.HikariDataSource;
|
||||
import org.bukkit.Bukkit;
|
||||
import org.bukkit.event.Event;
|
||||
|
||||
import javax.sql.DataSource;
|
||||
import javax.sql.rowset.CachedRowSet;
|
||||
import java.sql.Connection;
|
||||
import java.sql.PreparedStatement;
|
||||
import java.sql.ResultSetMetaData;
|
||||
import java.sql.SQLException;
|
||||
import java.util.*;
|
||||
import java.util.concurrent.CompletableFuture;
|
||||
import java.util.concurrent.ExecutorService;
|
||||
import java.util.concurrent.Executors;
|
||||
|
||||
/**
|
||||
* Executes a statement on a database and optionally stores the result in a variable. Expressions
|
||||
* embedded in the query will be escaped to avoid SQL injection.
|
||||
* <p>
|
||||
* If a single variable, such as `{test}`, is passed, the variable will be set to the number of
|
||||
* affected rows.
|
||||
* <p>
|
||||
* If a list variable, such as `{test::*}`, is passed, the query result will be mapped to the list
|
||||
* variable in the form `{test::<column name>::<row number>}`
|
||||
*
|
||||
* @name Execute Statement
|
||||
* @pattern [synchronously] execute %string% (in|on) %datasource% [and store [[the] (output|result)[s]] (to|in)
|
||||
* [the] [var[iable]] %-objects%]
|
||||
* @example execute "select * from table" in {sql} and store the result in {output::*}
|
||||
* @example execute "select * from %{table variable}%" in {sql} and store the result in {output::*}
|
||||
* @since 0.1.0
|
||||
*/
|
||||
public class EffExecuteStatement extends Effect {
|
||||
static {
|
||||
Skript.registerEffect(EffExecuteStatement.class,
|
||||
"execute %string% (in|on) %datasource% " +
|
||||
"[and store [[the] (output|result)[s]] (to|in) [the] [var[iable]] %-objects%]", "synchronously execute %string% (in|on) %datasource% " +
|
||||
"[and store [[the] (output|result)[s]] (to|in) [the] [var[iable]] %-objects%]");
|
||||
}
|
||||
|
||||
static String lastError;
|
||||
|
||||
private static final ExecutorService threadPool =
|
||||
Executors.newFixedThreadPool(SkriptDB.getInstance().getConfig().getInt("thread-pool-size", 2));
|
||||
|
||||
private Expression<String> query;
|
||||
private Expression<HikariDataSource> dataSource;
|
||||
private VariableString var;
|
||||
private boolean isLocal;
|
||||
private boolean isList;
|
||||
private boolean isSync;
|
||||
|
||||
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
|
||||
protected void execute(Event 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 (ds == null)
|
||||
return;
|
||||
|
||||
|
||||
if (isSync) {
|
||||
Object populatedVariables = executeStatement(ds, baseVariable, query);
|
||||
continueScriptExecution(e, populatedVariables);
|
||||
} else {
|
||||
Object locals = Variables.removeLocals(e);
|
||||
|
||||
//execute SQL statement
|
||||
CompletableFuture<Object> sql =
|
||||
CompletableFuture.supplyAsync(() -> executeStatement(ds, baseVariable, query), threadPool);
|
||||
|
||||
//when SQL statement is completed
|
||||
sql.whenComplete((res, err) -> {
|
||||
if (err != null) {
|
||||
err.printStackTrace();
|
||||
}
|
||||
|
||||
Bukkit.getScheduler().runTask(SkriptDB.getInstance(), () -> {
|
||||
|
||||
//handle last error syntax data
|
||||
lastError = null;
|
||||
if (res instanceof String) {
|
||||
lastError = (String) res;
|
||||
}
|
||||
|
||||
if (getNext() != null) {
|
||||
//if local variables are present
|
||||
if (locals != null)
|
||||
|
||||
//bring back local variables
|
||||
Variables.setLocalVariables(e, locals);
|
||||
|
||||
//populate SQL data into variables
|
||||
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);
|
||||
}
|
||||
});
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
protected TriggerItem walk(Event e) {
|
||||
debug(e, true);
|
||||
if (!isSync) {
|
||||
Delay.addDelayedEvent(e);
|
||||
}
|
||||
execute(e);
|
||||
return null;
|
||||
}
|
||||
|
||||
private Pair<String, List<Object>> parseQuery(Event e) {
|
||||
if (!(query instanceof VariableString)) {
|
||||
return new Pair<>(query.getSingle(e), null);
|
||||
}
|
||||
VariableString q = (VariableString) query;
|
||||
if (q.isSimple()) {
|
||||
return new Pair<>(q.toString(e), null);
|
||||
}
|
||||
|
||||
StringBuilder sb = new StringBuilder();
|
||||
List<Object> parameters = new ArrayList<>();
|
||||
Object[] objects = SkriptUtil.getTemplateString(q);
|
||||
|
||||
for (int i = 0; i < objects.length; i++) {
|
||||
Object o = objects[i];
|
||||
if (o instanceof String) {
|
||||
sb.append(o);
|
||||
} else {
|
||||
Expression<?> 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);
|
||||
|
||||
if (expr instanceof ExprUnsafe) {
|
||||
sb.append(expressionValue);
|
||||
|
||||
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);
|
||||
}
|
||||
|
||||
private Object executeStatement(DataSource ds, String baseVariable, Pair<String, List<Object>> query) {
|
||||
if (ds == null) {
|
||||
return "Data source is not set";
|
||||
}
|
||||
Map<String, Object> variableList = new HashMap<>();
|
||||
try (Connection conn = ds.getConnection();
|
||||
PreparedStatement stmt = createStatement(conn, query)) {
|
||||
|
||||
boolean hasResultSet = stmt.execute();
|
||||
|
||||
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());
|
||||
}
|
||||
}
|
||||
} catch (SQLException ex) {
|
||||
return ex.getMessage();
|
||||
}
|
||||
return variableList;
|
||||
}
|
||||
|
||||
private PreparedStatement createStatement(Connection conn, Pair<String, List<Object>> query) throws SQLException {
|
||||
PreparedStatement stmt = conn.prepareStatement(query.getFirst());
|
||||
List<Object> parameters = query.getSecond();
|
||||
|
||||
if (parameters != null) {
|
||||
for (int i = 0; i < parameters.size(); i++) {
|
||||
stmt.setObject(i + 1, parameters.get(i));
|
||||
}
|
||||
}
|
||||
|
||||
return stmt;
|
||||
}
|
||||
|
||||
private String getString(Object[] objects, int index) {
|
||||
if (index < 0 || index >= objects.length) {
|
||||
return null;
|
||||
}
|
||||
|
||||
Object object = objects[index];
|
||||
|
||||
if (object instanceof String) {
|
||||
return (String) object;
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
private void setVariable(Event e, String name, Object obj) {
|
||||
Variables.setVariable(name.toLowerCase(Locale.ENGLISH), obj, e, isLocal);
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toString(Event e, boolean debug) {
|
||||
return "execute " + query.toString(e, debug) + " in " + dataSource.toString(e, debug);
|
||||
}
|
||||
|
||||
@SuppressWarnings("unchecked")
|
||||
@Override
|
||||
public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed,
|
||||
SkriptParser.ParseResult parseResult) {
|
||||
Expression<String> statementExpr = (Expression<String>) exprs[0];
|
||||
if (statementExpr instanceof VariableString || statementExpr instanceof ExprUnsafe) {
|
||||
query = statementExpr;
|
||||
} else {
|
||||
Skript.error("Database statements must be string literals. If you must use an expression, " +
|
||||
"you may use \"%unsafe (your expression)%\", but keep in mind, you may be vulnerable " +
|
||||
"to SQL injection attacks!");
|
||||
return false;
|
||||
}
|
||||
dataSource = (Expression<HikariDataSource>) exprs[1];
|
||||
Expression<?> expr = exprs[2];
|
||||
isSync = matchedPattern == 1;
|
||||
if (expr instanceof Variable) {
|
||||
Variable<?> varExpr = (Variable<?>) expr;
|
||||
var = varExpr.getName();
|
||||
isLocal = varExpr.isLocal();
|
||||
isList = varExpr.isList();
|
||||
} else if (expr != null) {
|
||||
Skript.error(expr + " is not a variable");
|
||||
return false;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
}
|
|
@ -1,50 +0,0 @@
|
|||
package com.btk5h.skriptdb.skript;
|
||||
|
||||
import org.bukkit.event.Event;
|
||||
|
||||
import ch.njol.skript.Skript;
|
||||
import ch.njol.skript.lang.Expression;
|
||||
import ch.njol.skript.lang.ExpressionType;
|
||||
import ch.njol.skript.lang.SkriptParser;
|
||||
import ch.njol.skript.lang.util.SimpleExpression;
|
||||
import ch.njol.util.Kleenean;
|
||||
|
||||
/**
|
||||
* Stores the error from the last executed statement, if there was one.
|
||||
*
|
||||
* @name Last Data Source Error
|
||||
* @pattern [the] [last] (sql|db|data(base|[ ]source)) error
|
||||
* @return text
|
||||
* @since 0.1.0
|
||||
*/
|
||||
public class ExprDBError extends SimpleExpression<String> {
|
||||
static {
|
||||
Skript.registerExpression(ExprDBError.class, String.class,
|
||||
ExpressionType.SIMPLE, "[the] [last] (sql|db|data(base|[ ]source)) error");
|
||||
}
|
||||
|
||||
@Override
|
||||
protected String[] get(Event e) {
|
||||
return new String[]{EffExecuteStatement.lastError};
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean isSingle() {
|
||||
return true;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Class<? extends String> getReturnType() {
|
||||
return String.class;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toString(Event e, boolean debug) {
|
||||
return "last database error";
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult) {
|
||||
return true;
|
||||
}
|
||||
}
|
|
@ -1,103 +0,0 @@
|
|||
package com.btk5h.skriptdb.skript;
|
||||
|
||||
import com.btk5h.skriptdb.SkriptDB;
|
||||
import com.zaxxer.hikari.HikariDataSource;
|
||||
|
||||
import org.bukkit.event.Event;
|
||||
|
||||
import java.util.HashMap;
|
||||
import java.util.Map;
|
||||
|
||||
import ch.njol.skript.Skript;
|
||||
import ch.njol.skript.lang.Expression;
|
||||
import ch.njol.skript.lang.ExpressionType;
|
||||
import ch.njol.skript.lang.SkriptParser;
|
||||
import ch.njol.skript.lang.util.SimpleExpression;
|
||||
import ch.njol.skript.util.Timespan;
|
||||
import ch.njol.util.Kleenean;
|
||||
|
||||
/**
|
||||
* 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.
|
||||
*
|
||||
* The url format for your database may vary! The example provided uses a MySQL database.
|
||||
*
|
||||
* @name Data Source
|
||||
* @index -1
|
||||
* @pattern [the] data(base|[ ]source) [(of|at)] %string% [with [a] [max[imum]] [connection] life[ ]time of %timespan%]"
|
||||
* @return datasource
|
||||
* @example set {sql} to the database "mysql://localhost:3306/mydatabase?user=admin&password=12345&useSSL=false"
|
||||
* @since 0.1.0
|
||||
*/
|
||||
public class ExprDataSource extends SimpleExpression<HikariDataSource> {
|
||||
static {
|
||||
Skript.registerExpression(ExprDataSource.class, HikariDataSource.class,
|
||||
ExpressionType.COMBINED, "[the] data(base|[ ]source) [(of|at)] %string% " +
|
||||
"[with [a] [max[imum]] [connection] life[ ]time of %-timespan%]");
|
||||
}
|
||||
|
||||
private static Map<String, HikariDataSource> connectionCache = new HashMap<>();
|
||||
|
||||
private Expression<String> url;
|
||||
private Expression<Timespan> maxLifetime;
|
||||
|
||||
@Override
|
||||
protected HikariDataSource[] get(Event e) {
|
||||
String jdbcUrl = url.getSingle(e);
|
||||
if (jdbcUrl == null) {
|
||||
return null;
|
||||
}
|
||||
|
||||
if (!jdbcUrl.startsWith("jdbc:")) {
|
||||
jdbcUrl = "jdbc:" + jdbcUrl;
|
||||
}
|
||||
|
||||
if (connectionCache.containsKey(jdbcUrl)) {
|
||||
return new HikariDataSource[]{connectionCache.get(jdbcUrl)};
|
||||
}
|
||||
|
||||
HikariDataSource ds = new HikariDataSource();
|
||||
|
||||
//allow specifying of own sql driver class name
|
||||
if (!SkriptDB.getInstance().getConfig().getString("sql-driver-class-name", "default").equals("default")) {
|
||||
ds.setDriverClassName(SkriptDB.getInstance().getConfig().getString("sql-driver-class-name"));
|
||||
}
|
||||
ds.setJdbcUrl(jdbcUrl);
|
||||
|
||||
if (maxLifetime != null) {
|
||||
Timespan l = maxLifetime.getSingle(e);
|
||||
|
||||
if (l != null) {
|
||||
ds.setMaxLifetime(l.getMilliSeconds());
|
||||
}
|
||||
}
|
||||
|
||||
connectionCache.put(jdbcUrl, ds);
|
||||
|
||||
return new HikariDataSource[]{ds};
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean isSingle() {
|
||||
return true;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Class<? extends HikariDataSource> getReturnType() {
|
||||
return HikariDataSource.class;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toString(Event e, boolean debug) {
|
||||
return "datasource " + url.toString(e, debug);
|
||||
}
|
||||
|
||||
@SuppressWarnings("unchecked")
|
||||
@Override
|
||||
public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed,
|
||||
SkriptParser.ParseResult parseResult) {
|
||||
url = (Expression<String>) exprs[0];
|
||||
maxLifetime = (Expression<Timespan>) exprs[1];
|
||||
return true;
|
||||
}
|
||||
}
|
|
@ -1,63 +0,0 @@
|
|||
package com.btk5h.skriptdb.skript;
|
||||
|
||||
import org.bukkit.event.Event;
|
||||
|
||||
import ch.njol.skript.Skript;
|
||||
import ch.njol.skript.lang.Expression;
|
||||
import ch.njol.skript.lang.ExpressionType;
|
||||
import ch.njol.skript.lang.SkriptParser;
|
||||
import ch.njol.skript.lang.util.SimpleExpression;
|
||||
import ch.njol.util.Kleenean;
|
||||
|
||||
/**
|
||||
* Opts out of automatic SQL injection protection for a specific expression in a statement.
|
||||
*
|
||||
* @name Unsafe Expression
|
||||
* @pattern unsafe %text%
|
||||
* @return text
|
||||
* @example execute "select %unsafe {columns variable}% from %{table variable}%" in {sql}
|
||||
* @example execute unsafe {fully dynamic query} in {sql}
|
||||
* @since 0.1.0
|
||||
*/
|
||||
public class ExprUnsafe extends SimpleExpression<String> {
|
||||
static {
|
||||
Skript.registerExpression(ExprUnsafe.class, String.class, ExpressionType.COMBINED,
|
||||
"unsafe %string%");
|
||||
}
|
||||
|
||||
private Expression<String> stringExpression;
|
||||
private String rawExpression;
|
||||
|
||||
public String getRawExpression() {
|
||||
return rawExpression;
|
||||
}
|
||||
|
||||
@Override
|
||||
protected String[] get(Event e) {
|
||||
return stringExpression.getArray(e);
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean isSingle() {
|
||||
return true;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Class<? extends String> getReturnType() {
|
||||
return String.class;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toString(Event e, boolean debug) {
|
||||
return "unsafe " + stringExpression.toString(e, debug);
|
||||
}
|
||||
|
||||
@SuppressWarnings("unchecked")
|
||||
@Override
|
||||
public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed,
|
||||
SkriptParser.ParseResult parseResult) {
|
||||
stringExpression = (Expression<String>) exprs[0];
|
||||
rawExpression = parseResult.expr.substring("unsafe".length()).trim();
|
||||
return true;
|
||||
}
|
||||
}
|
|
@ -1,68 +0,0 @@
|
|||
package com.btk5h.skriptdb.skript;
|
||||
|
||||
import ch.njol.skript.classes.ClassInfo;
|
||||
import ch.njol.skript.classes.Parser;
|
||||
import ch.njol.skript.classes.Serializer;
|
||||
import ch.njol.skript.lang.ParseContext;
|
||||
import ch.njol.skript.registrations.Classes;
|
||||
import ch.njol.yggdrasil.Fields;
|
||||
import com.zaxxer.hikari.HikariDataSource;
|
||||
|
||||
import java.io.StreamCorruptedException;
|
||||
|
||||
public class Types {
|
||||
static {
|
||||
Classes.registerClass(new ClassInfo<>(HikariDataSource.class, "datasource")
|
||||
.user("datasources?")
|
||||
.parser(new Parser<>() {
|
||||
@Override
|
||||
public HikariDataSource parse(String s, ParseContext context) {
|
||||
return null;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toString(HikariDataSource o, int flags) {
|
||||
return o.getJdbcUrl();
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toVariableNameString(HikariDataSource o) {
|
||||
return o.getJdbcUrl();
|
||||
}
|
||||
|
||||
@Override
|
||||
public String getVariableNamePattern() {
|
||||
return "jdbc:.+";
|
||||
}
|
||||
})
|
||||
.serializer(new Serializer<>() {
|
||||
@Override
|
||||
public Fields serialize(HikariDataSource o) {
|
||||
Fields fields = new Fields();
|
||||
fields.putObject("jdbcurl", o.getJdbcUrl());
|
||||
return fields;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void deserialize(HikariDataSource o, Fields f) {
|
||||
}
|
||||
|
||||
@Override
|
||||
protected HikariDataSource deserialize(Fields fields) throws StreamCorruptedException {
|
||||
HikariDataSource ds = new HikariDataSource();
|
||||
ds.setJdbcUrl((String) fields.getObject("jdbcurl"));
|
||||
return ds;
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean mustSyncDeserialization() {
|
||||
return false;
|
||||
}
|
||||
|
||||
@Override
|
||||
protected boolean canBeInstantiated() {
|
||||
return false;
|
||||
}
|
||||
}));
|
||||
}
|
||||
}
|
|
@ -1,3 +1,3 @@
|
|||
Manifest-Version: 1.0
|
||||
Main-Class: com.btk5h.skriptdb.SkriptDB
|
||||
|
||||
Manifest-Version: 1.0
|
||||
Main-Class: com.btk5h.skriptdb.SkriptDB
|
||||
|
|
@ -73,13 +73,9 @@ public final class SkriptDB extends JavaPlugin {
|
|||
}
|
||||
try {
|
||||
if (out == null) return;
|
||||
|
||||
out.write("# How many connections can be awaited for simultaneously, may be useful to increase if mysql 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() + 1) + "\n");
|
||||
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("sql-driver-class-name:" + "\"default\"" + "\n");
|
||||
out.write("sql-driver-class-name: " + "\"default\"" + "\n");
|
||||
} catch (IOException e) {
|
||||
e.printStackTrace();
|
||||
}
|
|
@ -0,0 +1,35 @@
|
|||
package com.btk5h.skriptdb.events;
|
||||
|
||||
import org.bukkit.event.Event;
|
||||
import org.bukkit.event.HandlerList;
|
||||
|
||||
public class SQLQueryCompleteEvent extends Event {
|
||||
private final static HandlerList HANDLERS = new HandlerList();
|
||||
private final String argument;
|
||||
|
||||
public SQLQueryCompleteEvent(String argument) {
|
||||
super(true);
|
||||
this.argument = argument;
|
||||
// this.variables = variables;
|
||||
}
|
||||
|
||||
public static HandlerList getHandlerList() {
|
||||
return HANDLERS;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String getEventName() {
|
||||
return super.getEventName();
|
||||
}
|
||||
|
||||
@Override
|
||||
public HandlerList getHandlers() {
|
||||
return HANDLERS;
|
||||
}
|
||||
|
||||
public String getQuery() {
|
||||
return argument;
|
||||
}
|
||||
|
||||
// public String getVariables() {return;}
|
||||
}
|
|
@ -0,0 +1,355 @@
|
|||
package com.btk5h.skriptdb.skript;
|
||||
|
||||
import ch.njol.skript.Skript;
|
||||
import ch.njol.skript.effects.Delay;
|
||||
import ch.njol.skript.lang.*;
|
||||
import ch.njol.skript.variables.Variables;
|
||||
import ch.njol.util.Kleenean;
|
||||
import ch.njol.util.Pair;
|
||||
import com.btk5h.skriptdb.SkriptDB;
|
||||
import com.btk5h.skriptdb.SkriptUtil;
|
||||
import com.zaxxer.hikari.HikariDataSource;
|
||||
import org.bukkit.Bukkit;
|
||||
import org.bukkit.event.Event;
|
||||
|
||||
import javax.sql.DataSource;
|
||||
import javax.sql.rowset.CachedRowSet;
|
||||
import javax.sql.rowset.serial.SerialBlob;
|
||||
import javax.sql.rowset.serial.SerialException;
|
||||
import java.io.IOException;
|
||||
import java.sql.Connection;
|
||||
import java.sql.PreparedStatement;
|
||||
import java.sql.ResultSetMetaData;
|
||||
import java.sql.SQLException;
|
||||
import java.util.*;
|
||||
import java.util.concurrent.CompletableFuture;
|
||||
import java.util.concurrent.ExecutorService;
|
||||
import java.util.concurrent.Executors;
|
||||
|
||||
/**
|
||||
* Executes a statement on a database and optionally stores the result in a variable. Expressions
|
||||
* embedded in the query will be escaped to avoid SQL injection.
|
||||
* <p>
|
||||
* If a single variable, such as `{test}`, is passed, the variable will be set to the number of
|
||||
* affected rows.
|
||||
* <p>
|
||||
* If a list variable, such as `{test::*}`, is passed, the query result will be mapped to the list
|
||||
* variable in the form `{test::<column name>::<row number>}`
|
||||
*
|
||||
* @name Execute Statement
|
||||
* @pattern [synchronously] execute %string% (in|on) %datasource% [and store [[the] (output|result)[s]] (to|in)
|
||||
* [the] [var[iable]] %-objects%]
|
||||
* @example execute "select * from table" in {sql} and store the result in {output::*}
|
||||
* @example execute "select * from %{table variable}%" in {sql} and store the result in {output::*}
|
||||
* @since 0.1.0
|
||||
*/
|
||||
public class EffExecuteStatement extends Effect {
|
||||
private static final ExecutorService threadPool =
|
||||
Executors.newCachedThreadPool();
|
||||
static String lastError;
|
||||
|
||||
static {
|
||||
Skript.registerEffect(EffExecuteStatement.class,
|
||||
"execute %string% (in|on) %datasource% " +
|
||||
"[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<HikariDataSource> dataSource;
|
||||
private VariableString var;
|
||||
private boolean isLocal;
|
||||
private boolean isList;
|
||||
private boolean isSync;
|
||||
|
||||
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
|
||||
protected void execute(Event 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 (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);
|
||||
|
||||
//execute SQL statement
|
||||
CompletableFuture<Object> sql =
|
||||
CompletableFuture.supplyAsync(() -> executeStatement(ds, baseVariable, query), threadPool);
|
||||
|
||||
//when SQL statement is completed
|
||||
boolean finalSync = sync;
|
||||
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
|
||||
//bring back local variables
|
||||
|
||||
//populate SQL data into variables
|
||||
if (!(res instanceof String)) {
|
||||
|
||||
//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(), () -> {
|
||||
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);
|
||||
});
|
||||
}
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
@Override
|
||||
protected TriggerItem walk(Event e) {
|
||||
debug(e, true);
|
||||
//I think no longer needed as of 1.3.0, uncomment if something breaks
|
||||
if (!isSync) {
|
||||
Delay.addDelayedEvent(e);
|
||||
}
|
||||
execute(e);
|
||||
return null;
|
||||
}
|
||||
|
||||
private Pair<String, List<Object>> parseQuery(Event e) {
|
||||
if (!(query instanceof VariableString)) {
|
||||
return new Pair<>(query.getSingle(e), null);
|
||||
}
|
||||
VariableString q = (VariableString) query;
|
||||
if (q.isSimple()) {
|
||||
return new Pair<>(q.toString(e), null);
|
||||
}
|
||||
|
||||
StringBuilder sb = new StringBuilder();
|
||||
List<Object> parameters = new ArrayList<>();
|
||||
Object[] objects = SkriptUtil.getTemplateString(q);
|
||||
|
||||
for (int i = 0; i < objects.length; i++) {
|
||||
Object o = objects[i];
|
||||
if (o instanceof String) {
|
||||
sb.append(o);
|
||||
} else {
|
||||
Expression<?> expr;
|
||||
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);
|
||||
|
||||
if (expr instanceof ExprUnsafe) {
|
||||
sb.append(expressionValue);
|
||||
|
||||
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);
|
||||
}
|
||||
|
||||
private Object executeStatement(DataSource ds, String baseVariable, Pair<String, List<Object>> query) {
|
||||
if (ds == null) {
|
||||
return "Data source is not set";
|
||||
}
|
||||
Map<String, Object> variableList = new HashMap<>();
|
||||
try (Connection conn = ds.getConnection();
|
||||
PreparedStatement stmt = createStatement(conn, query)) {
|
||||
|
||||
boolean hasResultSet = stmt.execute();
|
||||
|
||||
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());
|
||||
}
|
||||
}
|
||||
} catch (SQLException ex) {
|
||||
return ex.getMessage();
|
||||
}
|
||||
return variableList;
|
||||
}
|
||||
|
||||
private PreparedStatement createStatement(Connection conn, Pair<String, List<Object>> query) throws SQLException {
|
||||
PreparedStatement stmt = conn.prepareStatement(query.getFirst());
|
||||
List<Object> parameters = query.getSecond();
|
||||
|
||||
if (parameters != null) {
|
||||
for (int i = 0; i < parameters.size(); i++) {
|
||||
stmt.setObject(i + 1, parameters.get(i));
|
||||
}
|
||||
}
|
||||
|
||||
return stmt;
|
||||
}
|
||||
|
||||
private String getString(Object[] objects, int index) {
|
||||
if (index < 0 || index >= objects.length) {
|
||||
return null;
|
||||
}
|
||||
|
||||
Object object = objects[index];
|
||||
|
||||
if (object instanceof String) {
|
||||
return (String) object;
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
private void setVariable(Event e, String name, Object obj) {
|
||||
|
||||
//fix mediumblob and similar column types, so they return a String correctly
|
||||
if (obj != null) {
|
||||
if (obj.getClass().getName().equals("[B")) {
|
||||
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)
|
||||
} else if (obj instanceof SerialBlob) {
|
||||
try {
|
||||
obj = new String(((SerialBlob) obj).getBinaryStream().readAllBytes());
|
||||
} catch (IOException | SerialException ex) {
|
||||
ex.printStackTrace();
|
||||
}
|
||||
}
|
||||
}
|
||||
Variables.setVariable(name.toLowerCase(Locale.ENGLISH), obj, e, isLocal);
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toString(Event e, boolean debug) {
|
||||
return "execute " + query.toString(e, debug) + " in " + dataSource.toString(e, debug);
|
||||
}
|
||||
|
||||
@SuppressWarnings("unchecked")
|
||||
@Override
|
||||
public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed,
|
||||
SkriptParser.ParseResult parseResult) {
|
||||
Expression<String> statementExpr = (Expression<String>) exprs[0];
|
||||
if (statementExpr instanceof VariableString || statementExpr instanceof ExprUnsafe) {
|
||||
query = statementExpr;
|
||||
} else {
|
||||
Skript.error("Database statements must be string literals. If you must use an expression, " +
|
||||
"you may use \"%unsafe (your expression)%\", but keep in mind, you may be vulnerable " +
|
||||
"to SQL injection attacks!");
|
||||
return false;
|
||||
}
|
||||
dataSource = (Expression<HikariDataSource>) exprs[1];
|
||||
Expression<?> expr = exprs[2];
|
||||
isSync = matchedPattern == 1;
|
||||
if (expr instanceof Variable) {
|
||||
Variable<?> varExpr = (Variable<?>) expr;
|
||||
var = varExpr.getName();
|
||||
isLocal = varExpr.isLocal();
|
||||
isList = varExpr.isList();
|
||||
} else if (expr != null) {
|
||||
Skript.error(expr + " is not a variable");
|
||||
return false;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
}
|
|
@ -0,0 +1,29 @@
|
|||
package com.btk5h.skriptdb.skript;
|
||||
|
||||
import ch.njol.skript.Skript;
|
||||
import ch.njol.skript.lang.Literal;
|
||||
import ch.njol.skript.lang.SkriptEvent;
|
||||
import ch.njol.skript.lang.SkriptParser;
|
||||
import com.btk5h.skriptdb.events.SQLQueryCompleteEvent;
|
||||
import org.bukkit.event.Event;
|
||||
|
||||
public class EvtSQLQueryComplete extends SkriptEvent {
|
||||
static {
|
||||
Skript.registerEvent("complete of sql query", EvtSQLQueryComplete.class, SQLQueryCompleteEvent.class, "complete of [(sql|database)] query");
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean init(final Literal<?>[] literals, final int i, final SkriptParser.ParseResult parseResult) {
|
||||
return true;
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean check(Event event) {
|
||||
return (event instanceof SQLQueryCompleteEvent);
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toString(Event event, boolean debug) {
|
||||
return "complete of sql query";
|
||||
}
|
||||
}
|
|
@ -0,0 +1,49 @@
|
|||
package com.btk5h.skriptdb.skript;
|
||||
|
||||
import ch.njol.skript.Skript;
|
||||
import ch.njol.skript.lang.Expression;
|
||||
import ch.njol.skript.lang.ExpressionType;
|
||||
import ch.njol.skript.lang.SkriptParser;
|
||||
import ch.njol.skript.lang.util.SimpleExpression;
|
||||
import ch.njol.util.Kleenean;
|
||||
import org.bukkit.event.Event;
|
||||
|
||||
/**
|
||||
* Stores the error from the last executed statement, if there was one.
|
||||
*
|
||||
* @name Last Data Source Error
|
||||
* @pattern [the] [last] (sql|db|data(base|[ ]source)) error
|
||||
* @return text
|
||||
* @since 0.1.0
|
||||
*/
|
||||
public class ExprDBError extends SimpleExpression<String> {
|
||||
static {
|
||||
Skript.registerExpression(ExprDBError.class, String.class,
|
||||
ExpressionType.SIMPLE, "[the] [last] (sql|db|data(base|[ ]source)) error");
|
||||
}
|
||||
|
||||
@Override
|
||||
protected String[] get(Event e) {
|
||||
return new String[]{EffExecuteStatement.lastError};
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean isSingle() {
|
||||
return true;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Class<? extends String> getReturnType() {
|
||||
return String.class;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toString(Event e, boolean debug) {
|
||||
return "last database error";
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult) {
|
||||
return true;
|
||||
}
|
||||
}
|
|
@ -0,0 +1,101 @@
|
|||
package com.btk5h.skriptdb.skript;
|
||||
|
||||
import ch.njol.skript.Skript;
|
||||
import ch.njol.skript.lang.Expression;
|
||||
import ch.njol.skript.lang.ExpressionType;
|
||||
import ch.njol.skript.lang.SkriptParser;
|
||||
import ch.njol.skript.lang.util.SimpleExpression;
|
||||
import ch.njol.skript.util.Timespan;
|
||||
import ch.njol.util.Kleenean;
|
||||
import com.btk5h.skriptdb.SkriptDB;
|
||||
import com.zaxxer.hikari.HikariDataSource;
|
||||
import org.bukkit.event.Event;
|
||||
|
||||
import java.util.HashMap;
|
||||
import java.util.Map;
|
||||
|
||||
/**
|
||||
* 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.
|
||||
* <p>
|
||||
* The url format for your database may vary! The example provided uses a MySQL database.
|
||||
*
|
||||
* @name Data Source
|
||||
* @index -1
|
||||
* @pattern [the] data(base|[ ]source) [(of|at)] %string% [with [a] [max[imum]] [connection] life[ ]time of %timespan%]"
|
||||
* @return datasource
|
||||
* @example set {sql} to the database "mysql://localhost:3306/mydatabase?user=admin&password=12345&useSSL=false"
|
||||
* @since 0.1.0
|
||||
*/
|
||||
public class ExprDataSource extends SimpleExpression<HikariDataSource> {
|
||||
private static final Map<String, HikariDataSource> connectionCache = new HashMap<>();
|
||||
|
||||
static {
|
||||
Skript.registerExpression(ExprDataSource.class, HikariDataSource.class,
|
||||
ExpressionType.COMBINED, "[the] data(base|[ ]source) [(of|at)] %string% " +
|
||||
"[with [a] [max[imum]] [connection] life[ ]time of %-timespan%]");
|
||||
}
|
||||
|
||||
private Expression<String> url;
|
||||
private Expression<Timespan> maxLifetime;
|
||||
|
||||
@Override
|
||||
protected HikariDataSource[] get(Event e) {
|
||||
String jdbcUrl = url.getSingle(e);
|
||||
if (jdbcUrl == null) {
|
||||
return null;
|
||||
}
|
||||
|
||||
if (!jdbcUrl.startsWith("jdbc:")) {
|
||||
jdbcUrl = "jdbc:" + jdbcUrl;
|
||||
}
|
||||
|
||||
if (connectionCache.containsKey(jdbcUrl)) {
|
||||
return new HikariDataSource[]{connectionCache.get(jdbcUrl)};
|
||||
}
|
||||
|
||||
HikariDataSource ds = new HikariDataSource();
|
||||
|
||||
//allow specifying of own sql driver class name
|
||||
if (!SkriptDB.getInstance().getConfig().getString("sql-driver-class-name", "default").equals("default")) {
|
||||
ds.setDriverClassName(SkriptDB.getInstance().getConfig().getString("sql-driver-class-name"));
|
||||
}
|
||||
ds.setJdbcUrl(jdbcUrl);
|
||||
|
||||
if (maxLifetime != null) {
|
||||
Timespan l = maxLifetime.getSingle(e);
|
||||
|
||||
if (l != null) {
|
||||
ds.setMaxLifetime(l.getMilliSeconds());
|
||||
}
|
||||
}
|
||||
|
||||
connectionCache.put(jdbcUrl, ds);
|
||||
|
||||
return new HikariDataSource[]{ds};
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean isSingle() {
|
||||
return true;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Class<? extends HikariDataSource> getReturnType() {
|
||||
return HikariDataSource.class;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toString(Event e, boolean debug) {
|
||||
return "datasource " + url.toString(e, debug);
|
||||
}
|
||||
|
||||
@SuppressWarnings("unchecked")
|
||||
@Override
|
||||
public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed,
|
||||
SkriptParser.ParseResult parseResult) {
|
||||
url = (Expression<String>) exprs[0];
|
||||
maxLifetime = (Expression<Timespan>) exprs[1];
|
||||
return true;
|
||||
}
|
||||
}
|
|
@ -0,0 +1,60 @@
|
|||
package com.btk5h.skriptdb.skript;
|
||||
|
||||
import ch.njol.skript.ScriptLoader;
|
||||
import ch.njol.skript.Skript;
|
||||
import ch.njol.skript.lang.Expression;
|
||||
import ch.njol.skript.lang.ExpressionType;
|
||||
import ch.njol.skript.lang.SkriptParser;
|
||||
import ch.njol.skript.lang.util.SimpleExpression;
|
||||
import ch.njol.skript.log.ErrorQuality;
|
||||
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.
|
||||
*
|
||||
* @name Last Data Source Error
|
||||
* @pattern [the] [last] (sql|db|data(base|[ ]source)) error
|
||||
* @return text
|
||||
* @since 0.1.0
|
||||
*/
|
||||
public class ExprSQLQuery extends SimpleExpression<String> {
|
||||
static {
|
||||
Skript.registerExpression(ExprSQLQuery.class, String.class,
|
||||
ExpressionType.SIMPLE, "sql query");
|
||||
}
|
||||
|
||||
|
||||
@Override
|
||||
protected String[] get(Event e) {
|
||||
if (e instanceof SQLQueryCompleteEvent) {
|
||||
return new String[]{((SQLQueryCompleteEvent) e).getQuery()};
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean isSingle() {
|
||||
return true;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Class<? extends String> getReturnType() {
|
||||
return String.class;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toString(Event e, boolean debug) {
|
||||
return "sql query";
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean init(final Expression<?>[] expressions, final int matchedPattern, final Kleenean isDelayed, final SkriptParser.ParseResult parseResult) {
|
||||
if (!ScriptLoader.isCurrentEvent(SQLQueryCompleteEvent.class)) {
|
||||
Skript.error("Cannot use 'sql query' outside of a complete of sql query event", ErrorQuality.SEMANTIC_ERROR);
|
||||
return false;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
}
|
|
@ -0,0 +1,62 @@
|
|||
package com.btk5h.skriptdb.skript;
|
||||
|
||||
import ch.njol.skript.Skript;
|
||||
import ch.njol.skript.lang.Expression;
|
||||
import ch.njol.skript.lang.ExpressionType;
|
||||
import ch.njol.skript.lang.SkriptParser;
|
||||
import ch.njol.skript.lang.util.SimpleExpression;
|
||||
import ch.njol.util.Kleenean;
|
||||
import org.bukkit.event.Event;
|
||||
|
||||
/**
|
||||
* Opts out of automatic SQL injection protection for a specific expression in a statement.
|
||||
*
|
||||
* @name Unsafe Expression
|
||||
* @pattern unsafe %text%
|
||||
* @return text
|
||||
* @example execute "select %unsafe {columns variable}% from %{table variable}%" in {sql}
|
||||
* @example execute unsafe {fully dynamic query} in {sql}
|
||||
* @since 0.1.0
|
||||
*/
|
||||
public class ExprUnsafe extends SimpleExpression<String> {
|
||||
static {
|
||||
Skript.registerExpression(ExprUnsafe.class, String.class, ExpressionType.COMBINED,
|
||||
"unsafe %string%");
|
||||
}
|
||||
|
||||
private Expression<String> stringExpression;
|
||||
private String rawExpression;
|
||||
|
||||
public String getRawExpression() {
|
||||
return rawExpression;
|
||||
}
|
||||
|
||||
@Override
|
||||
protected String[] get(Event e) {
|
||||
return stringExpression.getArray(e);
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean isSingle() {
|
||||
return true;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Class<? extends String> getReturnType() {
|
||||
return String.class;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toString(Event e, boolean debug) {
|
||||
return "unsafe " + stringExpression.toString(e, debug);
|
||||
}
|
||||
|
||||
@SuppressWarnings("unchecked")
|
||||
@Override
|
||||
public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed,
|
||||
SkriptParser.ParseResult parseResult) {
|
||||
stringExpression = (Expression<String>) exprs[0];
|
||||
rawExpression = parseResult.expr.substring("unsafe".length()).trim();
|
||||
return true;
|
||||
}
|
||||
}
|
|
@ -0,0 +1,68 @@
|
|||
package com.btk5h.skriptdb.skript;
|
||||
|
||||
import ch.njol.skript.classes.ClassInfo;
|
||||
import ch.njol.skript.classes.Parser;
|
||||
import ch.njol.skript.classes.Serializer;
|
||||
import ch.njol.skript.lang.ParseContext;
|
||||
import ch.njol.skript.registrations.Classes;
|
||||
import ch.njol.yggdrasil.Fields;
|
||||
import com.zaxxer.hikari.HikariDataSource;
|
||||
|
||||
import java.io.StreamCorruptedException;
|
||||
|
||||
public class Types {
|
||||
static {
|
||||
Classes.registerClass(new ClassInfo<>(HikariDataSource.class, "datasource")
|
||||
.user("datasources?")
|
||||
.parser(new Parser<HikariDataSource>() {
|
||||
@Override
|
||||
public HikariDataSource parse(String s, ParseContext context) {
|
||||
return null;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toString(HikariDataSource o, int flags) {
|
||||
return o.getJdbcUrl();
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toVariableNameString(HikariDataSource o) {
|
||||
return o.getJdbcUrl();
|
||||
}
|
||||
|
||||
@Override
|
||||
public String getVariableNamePattern() {
|
||||
return "jdbc:.+";
|
||||
}
|
||||
})
|
||||
.serializer(new Serializer<HikariDataSource>() {
|
||||
@Override
|
||||
public Fields serialize(HikariDataSource o) {
|
||||
Fields fields = new Fields();
|
||||
fields.putObject("jdbcurl", o.getJdbcUrl());
|
||||
return fields;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void deserialize(HikariDataSource o, Fields f) {
|
||||
}
|
||||
|
||||
@Override
|
||||
protected HikariDataSource deserialize(Fields fields) throws StreamCorruptedException {
|
||||
HikariDataSource ds = new HikariDataSource();
|
||||
ds.setJdbcUrl((String) fields.getObject("jdbcurl"));
|
||||
return ds;
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean mustSyncDeserialization() {
|
||||
return false;
|
||||
}
|
||||
|
||||
@Override
|
||||
protected boolean canBeInstantiated() {
|
||||
return false;
|
||||
}
|
||||
}));
|
||||
}
|
||||
}
|
|
@ -0,0 +1,6 @@
|
|||
name: skript-db
|
||||
version: 1.3.5
|
||||
main: com.btk5h.skriptdb.SkriptDB
|
||||
depend: [Skript]
|
||||
authors: [btk5h, FranKusmiruk, Govindas, TPGamesNL]
|
||||
api-version: 1.13
|
|
@ -1,5 +0,0 @@
|
|||
name: skript-db
|
||||
version: 1.2.0
|
||||
main: com.btk5h.skriptdb.SkriptDB
|
||||
depend: [Skript]
|
||||
authors: [btk5h, FranKusmiruk, Govindas]
|
Loading…
Reference in New Issue