41 Commits
1.3.8 ... 1.3.1

Author SHA1 Message Date
Govindas
6e1e3ce14b Add Java 8 support 2021-05-12 12:20:13 +03:00
Govindas
aa65a4e7e8 set api version to 1.13
I think this will help with performance in 1.13+ version, but will keep working in 1.9+
2021-05-07 15:42:01 +03:00
Govindas
d00fc2b6a0 Merge pull request #10 from ham1255/master
Fixed Govindas weirdness on project files (maven fix)
2021-05-04 14:02:42 +00:00
mohammed jasem alaajel
a72da39839 Fixed Govindas weirdness on project files 2021-05-04 18:00:16 +04:00
Govindas
d98bc34b38 partially fixed pom.xml 2021-05-04 16:46:46 +03:00
Govindas
ce64eda9e2 Fix pom.xml & update HikariCP 2021-04-30 11:50:23 +03:00
Govindass
d9f95ac101 make sql auto sync if not main thread 2021-03-16 15:05:26 +02:00
Govindass
fbb35937e6 Preparations for quicker queries (no 50ms delay) feature 2021-03-03 14:27:09 +02:00
Govindas
852e5e0477 Update README.md 2021-02-12 12:44:58 +02:00
Govindass
7620da85f1 remove thread pool config option & Use CachedThreadPool to make sure all threads are used properly
CachedThreadPool automatically creates threads on demand and automatically deletes unused threads after 60 seconds of no usage, so we can remove config option
2021-02-12 12:43:57 +02:00
Govindass
e3a6cc1fca 1.2.1 2021-02-09 14:25:35 +02:00
Govindass
678d6d49d8 Make config more informative 2021-02-07 17:22:07 +02:00
Govindass
7227496c1c Support missing config options 2021-02-07 17:20:00 +02:00
Govindass
1ad3813c73 Shade MariaDB driver & add configurable driver class to config 2021-02-06 13:56:48 +02:00
Govindass
619a6831e5 bump HikariCP version 2021-02-05 11:15:21 +02:00
Govindass
7e444ed0ca Fix memory leak introduced by last commit 2021-02-01 14:11:01 +02:00
Govindass
c7766fe11f Merge branch 'master' of https://github.com/Govindass/skript-db 2021-02-01 13:58:17 +02:00
Govindass
e18cd3d28c Switch from gradle to maven (preference) and optimize code 2021-02-01 13:58:13 +02:00
Govindas
280a0cb38d Update README.md 2021-01-18 14:59:08 +02:00
Govindas
3473007bd6 Add synchronous syntax to readme 2020-07-31 11:52:58 +03:00
Govindass
59d209540b Fix local variables in sql queries within the same tick & first startup errors 2020-07-31 11:50:44 +03:00
Govindass
3e7cf7a6dd Bump HikariCP 3.4.3 -> 3.4.5 2020-06-24 08:19:09 +03:00
Govindass
185a324e8c Remove debug message 2020-05-20 14:18:23 +03:00
Govindass
e75941d75a Make thread pool configurable 2020-05-18 15:34:43 +03:00
Govindass
efa37217c2 Add synchronous support on current thread 2020-05-18 13:20:01 +03:00
Govindass
0d8d834929 Merge FranKusmiruk's Pull Request 2020-05-02 20:25:36 +03:00
Govindass
b2a53078a6 add gradle fatJar task 2020-05-02 20:02:25 +03:00
Govindas
83f71e147b Update HikariCP, should fix a lot of issues 2020-05-02 19:48:35 +03:00
Govindass
e610fc1357 Remove unused class 2020-05-02 19:30:48 +03:00
Govindass
aa1a1d14c7 add synchronous 2019-09-30 15:28:32 +03:00
Govindass
3a1ec76a0b Delete EffSyncExecuteStatement.java 2019-09-30 15:27:26 +03:00
Govindass
2eb691cd69 Delete EffExecuteStatement.java 2019-09-30 15:27:16 +03:00
Govindass
6dbd2effb3 Delete plugin.yml 2019-09-30 15:26:48 +03:00
Govindass
88b76f1b5b Add files via upload 2019-09-30 15:25:37 +03:00
Bryan Terce
b692047878 0.2.1 Hotfix 2019-06-26 01:56:29 -07:00
Bryan Terce
3e57cae866 Fix sync execute logic (fixes #16) 2019-06-26 01:55:08 -07:00
Bryan Terce
1e95b818eb 0.2.0 Update 2019-06-22 12:12:27 -07:00
Bryan Terce
688ea9d46b Manually fix README 2019-06-22 12:11:29 -07:00
Bryan Terce
dd6d574479 Update README 2019-06-22 12:09:59 -07:00
Bryan Terce
1f6091eb95 Add synchronous execution flag 2019-06-22 12:09:17 -07:00
Bryan Terce
74d4918f44 Fix lifespan syntax 2019-06-22 12:05:22 -07:00
11 changed files with 469 additions and 575 deletions

View File

@@ -5,18 +5,10 @@
### 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 - Thread-pool size is now automatically increasing on demand to use of CachedThreadPool, instead of a fixed hard-coded number
- Uses newer versions of dependencies (Increased performance and security) - Uses a newer version of HikariCP
- Replaced `synchronously execute` with `quickly execute`, which allows to speed up queries by 50ms with some risk - Only meant to be used by newer Minecraft versions (1.8 is not supported)
- 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` ### 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.
@@ -44,10 +36,10 @@ 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 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>}` variable in the form `{test::<column name>::<row number>}`
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` If `synchronously` is specified, the SQL query will be done on the current thread.
#### Syntax #### Syntax
``` ```
[quickly] 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%]
``` ```
#### Examples #### Examples
@@ -84,23 +76,5 @@ 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
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"
```

16
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.3.8</version> <version>1.3.1</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>mvnrepository</id> <id>commons-pool2</id>
<url>https://mvnrepository.com</url> <url>https://mvnrepository.com/artifact/org.apache.commons/commons-pool2</url>
</repository> </repository>
<repository> <repository>
<id>PaperMC</id> <id>PaperMC</id>
@@ -45,8 +45,8 @@
<artifactId>maven-compiler-plugin</artifactId> <artifactId>maven-compiler-plugin</artifactId>
<version>3.6.1</version> <version>3.6.1</version>
<configuration> <configuration>
<source>11</source> <source>8</source>
<target>11</target> <target>8</target>
<encoding>UTF-8</encoding> <encoding>UTF-8</encoding>
</configuration> </configuration>
</plugin> </plugin>
@@ -81,7 +81,7 @@
<dependency> <dependency>
<groupId>com.zaxxer</groupId> <groupId>com.zaxxer</groupId>
<artifactId>HikariCP</artifactId> <artifactId>HikariCP</artifactId>
<version>5.0.1</version> <version>4.0.3</version>
<scope>compile</scope> <scope>compile</scope>
</dependency> </dependency>
<dependency> <dependency>
@@ -93,14 +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.5.3</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.9</version> <version>2.7.2</version>
<scope>compile</scope> <scope>compile</scope>
</dependency> </dependency>

View File

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

View File

@@ -8,15 +8,13 @@ import ch.njol.util.Kleenean;
import ch.njol.util.Pair; import ch.njol.util.Pair;
import com.btk5h.skriptdb.SkriptDB; import com.btk5h.skriptdb.SkriptDB;
import com.btk5h.skriptdb.SkriptUtil; import com.btk5h.skriptdb.SkriptUtil;
import com.btk5h.skriptdb.events.SQLQueryCompleteEvent;
import com.zaxxer.hikari.HikariDataSource; import com.zaxxer.hikari.HikariDataSource;
import org.bukkit.Bukkit; import org.bukkit.Bukkit;
import org.bukkit.event.Event; import org.bukkit.event.Event;
import javax.sql.DataSource; import javax.sql.DataSource;
import javax.sql.rowset.CachedRowSet; 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.Connection;
import java.sql.PreparedStatement; import java.sql.PreparedStatement;
import java.sql.ResultSetMetaData; import java.sql.ResultSetMetaData;
@@ -44,308 +42,283 @@ 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 = static {
Executors.newCachedThreadPool(); Skript.registerEffect(EffExecuteStatement.class,
static String lastError; "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 { static String lastError;
Skript.registerEffect(EffExecuteStatement.class,
"execute %string% (in|on) %datasource% " + private static final ExecutorService threadPool =
"[and store [[the] (output|result)[s]] (to|in) [the] [var[iable]] %-objects%]", "quickly execute %string% (in|on) %datasource% " + Executors.newCachedThreadPool();
"[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;
private Expression<String> query; //if data source isn't set
private Expression<HikariDataSource> dataSource; if (ds == null) return;
private VariableString var;
private boolean isLocal;
private boolean isList;
private boolean quickly;
private boolean isSync = false;
private void continueScriptExecution(Event e, Object populatedVariables) { boolean sync = false;
lastError = null; if (!Bukkit.isPrimaryThread()) {
if (populatedVariables instanceof String) { sync = true;
lastError = (String) populatedVariables; }
} else { Object locals = Variables.removeLocals(e);
if (getNext() != null) { //execute SQL statement
((Map<String, Object>) populatedVariables).forEach((name, value) -> setVariable(e, name, value)); CompletableFuture<Object> sql =
} CompletableFuture.supplyAsync(() -> executeStatement(ds, baseVariable, query), threadPool);
}
TriggerItem.walk(getNext(), e);
}
@Override //when SQL statement is completed
protected void execute(Event e) { boolean finalSync = sync;
DataSource ds = dataSource.getSingle(e); sql.whenComplete((res, err) -> {
Pair<String, List<Object>> query = parseQuery(e); if (err != null) { err.printStackTrace(); }
String baseVariable = var != null ? var.toString(e).toLowerCase(Locale.ENGLISH) : null;
//if data source isn't set
if (ds == null) return;
Object locals = Variables.removeLocals(e);
//execute SQL statement //handle last error syntax data
if (Bukkit.isPrimaryThread()) { lastError = null;
CompletableFuture<Object> sql = CompletableFuture.supplyAsync(() -> executeStatement(ds, baseVariable, query), threadPool); if (res instanceof String) {
sql.whenComplete((res, err) -> { lastError = (String) res;
if (err != null) { }
err.printStackTrace();
} if (getNext() != null) {
//handle last error syntax data
lastError = null;
if (res instanceof String) {
lastError = (String) res;
}
//if local variables are present
//bring back local variables
//populate SQL data into variables
if (!quickly) {
Bukkit.getScheduler().runTask(SkriptDB.getInstance(), () -> {
if (locals != null && getNext() != null) {
Variables.setLocalVariables(e, locals);
}
if (!(res instanceof String)) {
((Map<String, Object>) res).forEach((name, value) -> setVariable(e, name, value));
}
TriggerItem.walk(getNext(), e);
//the line below is required to prevent memory leaks
Variables.removeLocals(e);
});
} else {
if (locals != null && getNext() != null) {
Variables.setLocalVariables(e, locals);
}
if (!(res instanceof String)) {
((Map<String, Object>) res).forEach((name, value) -> setVariable(e, name, value));
}
TriggerItem.walk(getNext(), e);
//the line below is required to prevent memory leaks
Variables.removeLocals(e);
}
});
// sync executed SQL query, same as above, just sync
} 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 //if local variables are present
//bring back local variables if (locals != null)
//bring back local variables
//populate SQL data into variables //populate SQL data into variables
if (locals != null && getNext() != null) { if (!(res instanceof String)) {
Variables.setLocalVariables(e, locals);
//also set variables in the sql query complete event
SQLQueryCompleteEvent event = new SQLQueryCompleteEvent("something");
((Map<String, Object>) res).forEach((name, value) -> setVariable(event, name, value));
SkriptDB.getPlugin(SkriptDB.class).getServer().getPluginManager().callEvent(event);
} }
if (!(resources instanceof String)) { if (isSync || finalSync) {
((Map<String, Object>) resources).forEach((name, value) -> setVariable(e, name, value));
}
TriggerItem.walk(getNext(), e);
Variables.removeLocals(e);
}
}
@Override Variables.setLocalVariables(e, locals);
protected TriggerItem walk(Event e) { if (!(res instanceof String)) { ((Map<String, Object>) res).forEach((name, value) -> setVariable(e, name, value)); }
debug(e, true); TriggerItem.walk(getNext(), e);
if (!quickly || !isSync) { Variables.removeLocals(e);
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 { } else {
Expression<?> expr; Bukkit.getScheduler().runTask(SkriptDB.getInstance(), () -> {
if (o instanceof Expression) Variables.setLocalVariables(e, locals);
expr = (Expression<?>) o; if (!(res instanceof String)) { ((Map<String, Object>) res).forEach((name, value) -> setVariable(e, name, value)); }
else TriggerItem.walk(getNext(), e);
expr = SkriptUtil.getExpressionFromInfo(o); //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
String before = getString(objects, i - 1); //so it must be kept
String after = getString(objects, i + 1); Variables.removeLocals(e);
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); });
}
@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);
} }
private Object executeStatement(DataSource ds, String baseVariable, Pair<String, List<Object>> query) { StringBuilder sb = new StringBuilder();
if (ds == null) { List<Object> parameters = new ArrayList<>();
return "Data source is not set"; Object[] objects = SkriptUtil.getTemplateString(q);
}
Map<String, Object> variableList = new HashMap<>();
try (Connection conn = ds.getConnection();
PreparedStatement stmt = createStatement(conn, query)) {
boolean hasResultSet = stmt.execute(); 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);
if (baseVariable != null) { String before = getString(objects, i - 1);
if (isList) { String after = getString(objects, i + 1);
baseVariable = baseVariable.substring(0, baseVariable.length() - 1); boolean standaloneString = false;
}
if (hasResultSet) { if (before != null && after != null) {
CachedRowSet crs = SkriptDB.getRowSetFactory().createCachedRowSet(); if (before.endsWith("'") && after.endsWith("'")) {
crs.populate(stmt.getResultSet()); standaloneString = true;
}
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; Object expressionValue = expr.getSingle(e);
}
private String getString(Object[] objects, int index) { if (expr instanceof ExprUnsafe) {
if (index < 0 || index >= objects.length) { sb.append(expressionValue);
return null;
}
Object object = objects[index]; if (standaloneString && expressionValue instanceof String) {
String rawExpression = ((ExprUnsafe) expr).getRawExpression();
if (object instanceof String) { Skript.warning(
return (String) object; String.format("Unsafe may have been used unnecessarily. Try replacing 'unsafe %1$s' with %1$s",
} rawExpression));
}
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 { } else {
Skript.error("Database statements must be string literals. If you must use an expression, " + parameters.add(expressionValue);
"you may use \"%unsafe (your expression)%\", but keep in mind, you may be vulnerable " + sb.append('?');
"to SQL injection attacks!");
return false; if (standaloneString) {
Skript.warning("Do not surround expressions with quotes!");
}
} }
dataSource = (Expression<HikariDataSource>) exprs[1]; }
Expression<?> expr = exprs[2];
quickly = 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;
} }
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;
}
} }

View File

@@ -6,24 +6,24 @@ import ch.njol.skript.lang.SkriptEvent;
import ch.njol.skript.lang.SkriptParser; import ch.njol.skript.lang.SkriptParser;
import com.btk5h.skriptdb.events.SQLQueryCompleteEvent; import com.btk5h.skriptdb.events.SQLQueryCompleteEvent;
import org.bukkit.event.Event; import org.bukkit.event.Event;
import org.eclipse.jdt.annotation.Nullable;
public class EvtSQLQueryComplete extends SkriptEvent { public class EvtSQLQueryComplete extends SkriptEvent {
static { static {
Skript.registerEvent("complete of sql query", EvtSQLQueryComplete.class, SQLQueryCompleteEvent.class, "complete of [(sql|database)] query"); 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 @Override
public boolean init(final Literal<?>[] literals, final int i, final SkriptParser.ParseResult parseResult) { public String toString(@Nullable Event event, boolean debug) {
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"; return "complete of sql query";
} }
} }

View File

@@ -1,12 +1,13 @@
package com.btk5h.skriptdb.skript; package com.btk5h.skriptdb.skript;
import org.bukkit.event.Event;
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;
import ch.njol.skript.lang.SkriptParser; import ch.njol.skript.lang.SkriptParser;
import ch.njol.skript.lang.util.SimpleExpression; import ch.njol.skript.lang.util.SimpleExpression;
import ch.njol.util.Kleenean; import ch.njol.util.Kleenean;
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.
@@ -17,33 +18,33 @@ import org.bukkit.event.Event;
* @since 0.1.0 * @since 0.1.0
*/ */
public class ExprDBError extends SimpleExpression<String> { public class ExprDBError extends SimpleExpression<String> {
static { static {
Skript.registerExpression(ExprDBError.class, String.class, Skript.registerExpression(ExprDBError.class, String.class,
ExpressionType.SIMPLE, "[the] [last] (sql|db|data(base|[ ]source)) error"); ExpressionType.SIMPLE, "[the] [last] (sql|db|data(base|[ ]source)) error");
} }
@Override @Override
protected String[] get(Event e) { protected String[] get(Event e) {
return new String[]{EffExecuteStatement.lastError}; return new String[]{EffExecuteStatement.lastError};
} }
@Override @Override
public boolean isSingle() { public boolean isSingle() {
return true; return true;
} }
@Override @Override
public Class<? extends String> getReturnType() { public Class<? extends String> getReturnType() {
return String.class; return String.class;
} }
@Override @Override
public String toString(Event e, boolean debug) { public String toString(Event e, boolean debug) {
return "last database error"; return "last database error";
} }
@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) {
return true; return true;
} }
} }

View File

@@ -1,5 +1,13 @@
package com.btk5h.skriptdb.skript; 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.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;
@@ -7,17 +15,11 @@ import ch.njol.skript.lang.SkriptParser;
import ch.njol.skript.lang.util.SimpleExpression; import ch.njol.skript.lang.util.SimpleExpression;
import ch.njol.skript.util.Timespan; import ch.njol.skript.util.Timespan;
import ch.njol.util.Kleenean; 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 * 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.
* <p> *
* The url format for your database may vary! The example provided uses a MySQL database. * The url format for your database may vary! The example provided uses a MySQL database.
* *
* @name Data Source * @name Data Source
@@ -28,74 +30,74 @@ import java.util.Map;
* @since 0.1.0 * @since 0.1.0
*/ */
public class ExprDataSource extends SimpleExpression<HikariDataSource> { 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%]");
}
static { private static Map<String, HikariDataSource> connectionCache = new HashMap<>();
Skript.registerExpression(ExprDataSource.class, HikariDataSource.class,
ExpressionType.COMBINED, "[the] data(base|[ ]source) [(of|at)] %string% " + private Expression<String> url;
"[with [a] [max[imum]] [connection] life[ ]time of %-timespan%]"); private Expression<Timespan> maxLifetime;
@Override
protected HikariDataSource[] get(Event e) {
String jdbcUrl = url.getSingle(e);
if (jdbcUrl == null) {
return null;
} }
private Expression<String> url; if (!jdbcUrl.startsWith("jdbc:")) {
private Expression<Timespan> maxLifetime; jdbcUrl = "jdbc:" + jdbcUrl;
@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 if (connectionCache.containsKey(jdbcUrl)) {
public boolean isSingle() { return new HikariDataSource[]{connectionCache.get(jdbcUrl)};
return true;
} }
@Override HikariDataSource ds = new HikariDataSource();
public Class<? extends HikariDataSource> getReturnType() {
return HikariDataSource.class; //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());
}
} }
@Override connectionCache.put(jdbcUrl, ds);
public String toString(Event e, boolean debug) {
return "datasource " + url.toString(e, debug);
}
@SuppressWarnings("unchecked") return new HikariDataSource[]{ds};
@Override }
public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed,
SkriptParser.ParseResult parseResult) { @Override
url = (Expression<String>) exprs[0]; public boolean isSingle() {
maxLifetime = (Expression<Timespan>) exprs[1]; return true;
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;
}
} }

View File

@@ -1,60 +0,0 @@
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;
}
}

View File

@@ -1,12 +1,13 @@
package com.btk5h.skriptdb.skript; package com.btk5h.skriptdb.skript;
import org.bukkit.event.Event;
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;
import ch.njol.skript.lang.SkriptParser; import ch.njol.skript.lang.SkriptParser;
import ch.njol.skript.lang.util.SimpleExpression; import ch.njol.skript.lang.util.SimpleExpression;
import ch.njol.util.Kleenean; import ch.njol.util.Kleenean;
import org.bukkit.event.Event;
/** /**
* 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.
@@ -19,44 +20,44 @@ import org.bukkit.event.Event;
* @since 0.1.0 * @since 0.1.0
*/ */
public class ExprUnsafe extends SimpleExpression<String> { public class ExprUnsafe extends SimpleExpression<String> {
static { static {
Skript.registerExpression(ExprUnsafe.class, String.class, ExpressionType.COMBINED, Skript.registerExpression(ExprUnsafe.class, String.class, ExpressionType.COMBINED,
"unsafe %string%"); "unsafe %string%");
} }
private Expression<String> stringExpression; private Expression<String> stringExpression;
private String rawExpression; private String rawExpression;
public String getRawExpression() { public String getRawExpression() {
return rawExpression; return rawExpression;
} }
@Override @Override
protected String[] get(Event e) { protected String[] get(Event e) {
return stringExpression.getArray(e); return stringExpression.getArray(e);
} }
@Override @Override
public boolean isSingle() { public boolean isSingle() {
return true; return true;
} }
@Override @Override
public Class<? extends String> getReturnType() { public Class<? extends String> getReturnType() {
return String.class; return String.class;
} }
@Override @Override
public String toString(Event e, boolean debug) { public String toString(Event e, boolean debug) {
return "unsafe " + stringExpression.toString(e, debug); return "unsafe " + stringExpression.toString(e, debug);
} }
@SuppressWarnings("unchecked") @SuppressWarnings("unchecked")
@Override @Override
public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed,
SkriptParser.ParseResult parseResult) { SkriptParser.ParseResult parseResult) {
stringExpression = (Expression<String>) exprs[0]; stringExpression = (Expression<String>) exprs[0];
rawExpression = parseResult.expr.substring("unsafe".length()).trim(); rawExpression = parseResult.expr.substring("unsafe".length()).trim();
return true; return true;
} }
} }

View File

@@ -11,54 +11,58 @@ import com.zaxxer.hikari.HikariDataSource;
import java.io.StreamCorruptedException; import java.io.StreamCorruptedException;
public class Types { public class Types {
static { static {
Classes.registerClass(new ClassInfo<>(HikariDataSource.class, "datasource") Classes.registerClass(new ClassInfo<>(HikariDataSource.class, "datasource")
.user("datasources?") .user("datasources?")
.parser(new Parser<HikariDataSource>() { .parser(new Parser<HikariDataSource>() {
@Override @Override
public HikariDataSource parse(String s, ParseContext context) { public HikariDataSource parse(String s, ParseContext context) {
return null; return null;
} }
@Override @Override
public String toString(HikariDataSource o, int flags) { public String toString(HikariDataSource o, int flags) {
return o.getJdbcUrl(); return o.getJdbcUrl();
} }
@Override @Override
public String toVariableNameString(HikariDataSource o) { public String toVariableNameString(HikariDataSource o) {
return o.getJdbcUrl(); return o.getJdbcUrl();
} }
}) @Override
.serializer(new Serializer<HikariDataSource>() { public String getVariableNamePattern() {
@Override return "jdbc:.+";
public Fields serialize(HikariDataSource o) { }
Fields fields = new Fields(); })
fields.putObject("jdbcurl", o.getJdbcUrl()); .serializer(new Serializer<HikariDataSource>() {
return fields; @Override
} public Fields serialize(HikariDataSource o) {
Fields fields = new Fields();
fields.putObject("jdbcurl", o.getJdbcUrl());
return fields;
}
@Override @Override
public void deserialize(HikariDataSource o, Fields f) { public void deserialize(HikariDataSource o, Fields f) {
} }
@Override @Override
protected HikariDataSource deserialize(Fields fields) throws StreamCorruptedException { protected HikariDataSource deserialize(Fields fields) throws StreamCorruptedException {
HikariDataSource ds = new HikariDataSource(); HikariDataSource ds = new HikariDataSource();
ds.setJdbcUrl((String) fields.getObject("jdbcurl")); ds.setJdbcUrl((String) fields.getObject("jdbcurl"));
return ds; return ds;
} }
@Override @Override
public boolean mustSyncDeserialization() { public boolean mustSyncDeserialization() {
return false; return false;
} }
@Override @Override
protected boolean canBeInstantiated() { protected boolean canBeInstantiated() {
return false; return false;
} }
})); }));
} }
} }

View File

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