Fix no vars if execute is last line & fix code cleanup

Reviewed-on: #20

README.md

@@ -5,11 +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 automatically increasing on demand to use of CachedThreadPool, instead of a fixed hard-coded number
+- Thread-pool size is now automatically increasing on demand with use of CachedThreadPool, instead of a fixed hard-coded number
-- Uses a newer version of HikariCP
+- Uses newer versions of dependencies (Increased performance and security)
-- Only meant to be used by newer Minecraft versions (1.8 is not supported)
 - 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.
@@ -77,4 +84,23 @@ execute "select %unsafe {columns variable}% from %{table variable}%" 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"
+```

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>com.btk5h</groupId>
     <artifactId>skript-db</artifactId>
-    <version>1.3.3</version>
+    <version>1.3.8</version>
     <packaging>jar</packaging>
 
     <repositories>
@@ -19,8 +19,8 @@
             <url>https://jitpack.io</url>
         </repository>
         <repository>
-            <id>commons-pool2</id>
+            <id>mvnrepository</id>
-            <url>https://mvnrepository.com/artifact/org.apache.commons/commons-pool2</url>
+            <url>https://mvnrepository.com</url>
         </repository>
         <repository>
             <id>PaperMC</id>
@@ -45,8 +45,8 @@
                 <artifactId>maven-compiler-plugin</artifactId>
                 <version>3.6.1</version>
                 <configuration>
-                    <source>8</source>
+                    <source>11</source>
-                    <target>8</target>
+                    <target>11</target>
                     <encoding>UTF-8</encoding>
                 </configuration>
             </plugin>
@@ -81,7 +81,7 @@
         <dependency>
             <groupId>com.zaxxer</groupId>
             <artifactId>HikariCP</artifactId>
-            <version>4.0.3</version>
+            <version>5.0.1</version>
             <scope>compile</scope>
         </dependency>
         <dependency>
@@ -93,14 +93,14 @@
         <dependency>
             <groupId>com.github.SkriptLang</groupId>
             <artifactId>Skript</artifactId>
-            <version>2.6-alpha1</version>
+            <version>2.6.1</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.9</version>
             <scope>compile</scope>
         </dependency>
 

src/main/java/com/btk5h/skriptdb/skript/EffExecuteStatement.java

@@ -14,6 +14,9 @@ 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;
@@ -57,7 +60,8 @@ public class EffExecuteStatement extends Effect {
     private VariableString var;
     private boolean isLocal;
     private boolean isList;
-    private boolean isSync;
+    private boolean quickly;
+    private boolean isSync = false;
 
     private void continueScriptExecution(Event e, Object populatedVariables) {
         lastError = null;
@@ -79,58 +83,26 @@ public class EffExecuteStatement extends Effect {
         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 =
+        if (Bukkit.isPrimaryThread()) {
-                CompletableFuture.supplyAsync(() -> executeStatement(ds, baseVariable, query), threadPool);
+            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)) {
+                if (!quickly) {
-
-                    //also set variables in the sql query complete event
-
-                    //TEMPORARILY DISABLED, AS THIS WOULD WORSEN PERFORMANCE OF THE QUERIES AND NOT BE USED BY MOST PEOPLE.
-                    //I may add config option to enable this later?
-
-                    //SQLQueryCompleteEvent event = new SQLQueryCompleteEvent(this.query.getSingle(e));
-                    //((Map<String, Object>) res).forEach((name, value) -> setVariable(event, name, value));
-                    //SkriptDB.getPlugin(SkriptDB.class).getServer().getPluginManager().callEvent(event);
-                }
-                if (isSync || finalSync) {
-                    if (locals != null) {
-                        Variables.setLocalVariables(e, locals);
-                    }
-                    if (!(res instanceof String)) {
-                        ((Map<String, Object>) res).forEach((name, value) -> setVariable(e, name, value));
-                    }
-                    TriggerItem.walk(getNext(), e);
-                    Variables.removeLocals(e);
-                } else {
                     Bukkit.getScheduler().runTask(SkriptDB.getInstance(), () -> {
-                        if (locals != null) {
+                        if (locals != null && getNext() != null) {
                             Variables.setLocalVariables(e, locals);
                         }
                         if (!(res instanceof String)) {
@@ -138,20 +110,47 @@ public class EffExecuteStatement extends Effect {
                         }
                         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);
                     });
+                } else {
+                    if (locals != null && getNext() != null) {
+                        Variables.setLocalVariables(e, locals);
                     }
+                    if (!(res instanceof String)) {
+                        ((Map<String, Object>) res).forEach((name, value) -> setVariable(e, name, value));
+                    }
+                    TriggerItem.walk(getNext(), e);
+                    //the line below is required to prevent memory leaks
+                    Variables.removeLocals(e);
                 }
             });
+            // sync executed SQL query, same as above, just sync
+        } else {
+            isSync = true;
+            Object resources = executeStatement(ds, baseVariable, query);
+            //handle last error syntax data
+            lastError = null;
+            if (resources instanceof String) {
+                lastError = (String) resources;
+            }
+            //if local variables are present
+            //bring back local variables
+            //populate SQL data into variables
+            if (locals != null && getNext() != null) {
+                Variables.setLocalVariables(e, locals);
+            }
+            if (!(resources instanceof String)) {
+                ((Map<String, Object>) resources).forEach((name, value) -> setVariable(e, name, value));
+            }
+            TriggerItem.walk(getNext(), e);
+            Variables.removeLocals(e);
+        }
     }
 
     @Override
     protected TriggerItem walk(Event e) {
         debug(e, true);
-        //I think no longer needed as of 1.3.0, uncomment if something breaks
+        if (!quickly || !isSync) {
-        if (!isSync) {
             Delay.addDelayedEvent(e);
         }
         execute(e);
@@ -299,6 +298,21 @@ public class EffExecuteStatement extends Effect {
     }
 
     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);
     }
 
@@ -322,7 +336,7 @@ public class EffExecuteStatement extends Effect {
         }
         dataSource = (Expression<HikariDataSource>) exprs[1];
         Expression<?> expr = exprs[2];
-        isSync = matchedPattern == 1;
+        quickly = matchedPattern == 1;
         if (expr instanceof Variable) {
             Variable<?> varExpr = (Variable<?>) expr;
             var = varExpr.getName();

src/main/java/com/btk5h/skriptdb/skript/EvtSQLQueryComplete.java

@@ -6,7 +6,6 @@ import ch.njol.skript.lang.SkriptEvent;
 import ch.njol.skript.lang.SkriptParser;
 import com.btk5h.skriptdb.events.SQLQueryCompleteEvent;
 import org.bukkit.event.Event;
-import org.eclipse.jdt.annotation.Nullable;
 
 public class EvtSQLQueryComplete extends SkriptEvent {
     static {
@@ -24,7 +23,7 @@ public class EvtSQLQueryComplete extends SkriptEvent {
     }
 
     @Override
-    public String toString(@Nullable Event event, boolean debug) {
+    public String toString(Event event, boolean debug) {
         return "complete of sql query";
     }
 }

src/main/java/com/btk5h/skriptdb/skript/Types.java

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

src/main/resources/plugin.yml

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