Merge pull request 'Alternative method to provide dynamic arguments into sql query' (#28) from szumielxd/skript-db:master into master

Reviewed-on: szumielxd/skript-db#1

.editorconfig

@@ -1,13 +0,0 @@
-# editorconfig.org
-root = true
-
-[*]
-indent_style = space
-indent_size = 2
-end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true
-
-[*.java]
-continuation_indent_size = 4

.gitignore

@@ -1,10 +1,25 @@
 ## OSX
 *.DS_Store
 
-## Gradle
-.gradle
-build/
-
 ## IntelliJ
 .idea/
 *.iml
+out/
+target
+compile/
+
+# eclipse specific git ignore
+*.pydevproject
+.project
+.metadata
+bin/**
+tmp/**
+tmp/**/*
+*.tmp
+*.bak
+*.swp
+*~.nib
+local.properties
+.classpath
+.settings/
+.loadpath

README.md

@@ -3,19 +3,42 @@
  > Sensible SQL support for Skript.
 ---
 
+### Difference from original skript-db
+- Fixed local variables disappearance in newer Skript versions (very hacky fix, but it works, so that's good!)
+- 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
+- If a sql query is detected to be running on non-main thread, it becomes synchronous automatically
+- SQL Driver is configurable both in config and in database connection, comes with shaded MariaDB and PostgreSQL drivers
+- A few variable type related bugs fixed
+- 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.
 
- The url format for your database may vary! The example provided uses a MySQL database.
+ The url format for your database may vary depending on database you are using. 
+ MariaDB/PostgreSQL users: make sure to check `config.yml` to use the correct driver.
 #### Syntax
 ```
-[the] data(base|[ ]source) [(of|at)] %string%
+[the] data(base|[ ]source) [(of|at)] %string% [with [a] [max[imum]] [connection] life[ ]time of %timespan%] [[(using|with)] [a] driver %-string%]
 ```
 
 #### Examples
 ```
 set {sql} to the database "mysql://localhost:3306/mydatabase?user=admin&password=12345&useSSL=false"
+set {sql} to the database "mariadb://localhost:3306/mydatabase?user=admin&password=12345&useSSL=false"
+set {sql} to the database "postgresql://localhost:3306/mydatabase?user=admin&password=12345&ssl=false"
+set {sql} to the database "sqlite:database.db"
+
+# Extra parameters:
+set {sql} to the database "postgresql://localhost:3306/mydatabase?user=admin&password=12345&ssl=false" with a maximum connection lifetime of 30 minutes
+set {sql} to the database "postgresql://localhost:3306/mydatabase?user=admin&password=12345&ssl=false" with a maximum connection lifetime of 30 minutes using driver "org.postgresql.Driver"
 ```
 
 ---
@@ -29,9 +52,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 `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
 ```
-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
@@ -55,6 +80,7 @@ Stores the error from the last executed statement, if there was one.
 
 ### Expression `Unsafe Expression` => `text`
 Opts out of automatic SQL injection protection for a specific expression in a statement.
+Note: If using PostgreSQL, this will always be needed, due to skript-db not supporting SQL injection protection for PostgreSQL currently.
 #### Syntax
 ```
 unsafe %text%
@@ -68,5 +94,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"
+```

build.gradle

@@ -1,45 +0,0 @@
-group 'com.btk5h.skript-db'
-version '0.1.1'
-
-buildscript {
-  repositories {
-    jcenter()
-  }
-  dependencies {
-    classpath 'com.github.jengelman.gradle.plugins:shadow:2.0.1'
-  }
-}
-
-apply plugin: 'com.github.johnrengelman.shadow'
-apply plugin: 'java'
-
-sourceCompatibility = 1.8
-
-repositories {
-  mavenCentral()
-  maven {
-    url 'https://hub.spigotmc.org/nexus/content/repositories/snapshots/'
-  }
-  maven {
-    url 'https://oss.sonatype.org/content/groups/public/'
-  }
-  maven {
-    url 'http://maven.njol.ch/repo/'
-  }
-}
-
-dependencies {
-  shadow 'org.spigotmc:spigot-api:1.11-R0.1-SNAPSHOT'
-  shadow 'ch.njol:skript:2.2-SNAPSHOT'
-  compile 'com.zaxxer:HikariCP:2.6.2'
-}
-
-task buildReadme(type: Javadoc) {
-  source = sourceSets.main.allJava
-  classpath = sourceSets.main.compileClasspath
-  destinationDir = projectDir
-  options.docletpath = [file('tools/skriptdoclet.jar')]
-  options.doclet = 'com.btk5h.skriptdoclet.SkriptDoclet'
-  options.addStringOption('file', 'README.md')
-  options.addStringOption('markdown', '-quiet')
-}

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +0,0 @@
-#Thu Aug 24 18:49:02 PDT 2017
-distributionBase=GRADLE_USER_HOME
-distributionPath=wrapper/dists
-zipStoreBase=GRADLE_USER_HOME
-zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-3.3-all.zip

gradlew

@@ -1,172 +0,0 @@
-#!/usr/bin/env sh
-
-##############################################################################
-##
-##  Gradle start up script for UN*X
-##
-##############################################################################
-
-# Attempt to set APP_HOME
-# Resolve links: $0 may be a link
-PRG="$0"
-# Need this for relative symlinks.
-while [ -h "$PRG" ] ; do
-    ls=`ls -ld "$PRG"`
-    link=`expr "$ls" : '.*-> \(.*\)$'`
-    if expr "$link" : '/.*' > /dev/null; then
-        PRG="$link"
-    else
-        PRG=`dirname "$PRG"`"/$link"
-    fi
-done
-SAVED="`pwd`"
-cd "`dirname \"$PRG\"`/" >/dev/null
-APP_HOME="`pwd -P`"
-cd "$SAVED" >/dev/null
-
-APP_NAME="Gradle"
-APP_BASE_NAME=`basename "$0"`
-
-# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
-DEFAULT_JVM_OPTS=""
-
-# Use the maximum available, or set MAX_FD != -1 to use that value.
-MAX_FD="maximum"
-
-warn ( ) {
-    echo "$*"
-}
-
-die ( ) {
-    echo
-    echo "$*"
-    echo
-    exit 1
-}
-
-# OS specific support (must be 'true' or 'false').
-cygwin=false
-msys=false
-darwin=false
-nonstop=false
-case "`uname`" in
-  CYGWIN* )
-    cygwin=true
-    ;;
-  Darwin* )
-    darwin=true
-    ;;
-  MINGW* )
-    msys=true
-    ;;
-  NONSTOP* )
-    nonstop=true
-    ;;
-esac
-
-CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
-
-# Determine the Java command to use to start the JVM.
-if [ -n "$JAVA_HOME" ] ; then
-    if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
-        # IBM's JDK on AIX uses strange locations for the executables
-        JAVACMD="$JAVA_HOME/jre/sh/java"
-    else
-        JAVACMD="$JAVA_HOME/bin/java"
-    fi
-    if [ ! -x "$JAVACMD" ] ; then
-        die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
-
-Please set the JAVA_HOME variable in your environment to match the
-location of your Java installation."
-    fi
-else
-    JAVACMD="java"
-    which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
-
-Please set the JAVA_HOME variable in your environment to match the
-location of your Java installation."
-fi
-
-# Increase the maximum file descriptors if we can.
-if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
-    MAX_FD_LIMIT=`ulimit -H -n`
-    if [ $? -eq 0 ] ; then
-        if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
-            MAX_FD="$MAX_FD_LIMIT"
-        fi
-        ulimit -n $MAX_FD
-        if [ $? -ne 0 ] ; then
-            warn "Could not set maximum file descriptor limit: $MAX_FD"
-        fi
-    else
-        warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
-    fi
-fi
-
-# For Darwin, add options to specify how the application appears in the dock
-if $darwin; then
-    GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
-fi
-
-# For Cygwin, switch paths to Windows format before running java
-if $cygwin ; then
-    APP_HOME=`cygpath --path --mixed "$APP_HOME"`
-    CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
-    JAVACMD=`cygpath --unix "$JAVACMD"`
-
-    # We build the pattern for arguments to be converted via cygpath
-    ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
-    SEP=""
-    for dir in $ROOTDIRSRAW ; do
-        ROOTDIRS="$ROOTDIRS$SEP$dir"
-        SEP="|"
-    done
-    OURCYGPATTERN="(^($ROOTDIRS))"
-    # Add a user-defined pattern to the cygpath arguments
-    if [ "$GRADLE_CYGPATTERN" != "" ] ; then
-        OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
-    fi
-    # Now convert the arguments - kludge to limit ourselves to /bin/sh
-    i=0
-    for arg in "$@" ; do
-        CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
-        CHECK2=`echo "$arg"|egrep -c "^-"`                                 ### Determine if an option
-
-        if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then                    ### Added a condition
-            eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
-        else
-            eval `echo args$i`="\"$arg\""
-        fi
-        i=$((i+1))
-    done
-    case $i in
-        (0) set -- ;;
-        (1) set -- "$args0" ;;
-        (2) set -- "$args0" "$args1" ;;
-        (3) set -- "$args0" "$args1" "$args2" ;;
-        (4) set -- "$args0" "$args1" "$args2" "$args3" ;;
-        (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
-        (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
-        (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
-        (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
-        (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
-    esac
-fi
-
-# Escape application args
-save ( ) {
-    for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
-    echo " "
-}
-APP_ARGS=$(save "$@")
-
-# Collect all arguments for the java command, following the shell quoting and substitution rules
-eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
-
-# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
-if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
-  cd "$(dirname "$0")"
-fi
-
-exec "$JAVACMD" "$@"

gradlew.bat

@@ -1,84 +0,0 @@
-@if "%DEBUG%" == "" @echo off
-@rem ##########################################################################
-@rem
-@rem  Gradle startup script for Windows
-@rem
-@rem ##########################################################################
-
-@rem Set local scope for the variables with windows NT shell
-if "%OS%"=="Windows_NT" setlocal
-
-set DIRNAME=%~dp0
-if "%DIRNAME%" == "" set DIRNAME=.
-set APP_BASE_NAME=%~n0
-set APP_HOME=%DIRNAME%
-
-@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
-set DEFAULT_JVM_OPTS=
-
-@rem Find java.exe
-if defined JAVA_HOME goto findJavaFromJavaHome
-
-set JAVA_EXE=java.exe
-%JAVA_EXE% -version >NUL 2>&1
-if "%ERRORLEVEL%" == "0" goto init
-
-echo.
-echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
-echo.
-echo Please set the JAVA_HOME variable in your environment to match the
-echo location of your Java installation.
-
-goto fail
-
-:findJavaFromJavaHome
-set JAVA_HOME=%JAVA_HOME:"=%
-set JAVA_EXE=%JAVA_HOME%/bin/java.exe
-
-if exist "%JAVA_EXE%" goto init
-
-echo.
-echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
-echo.
-echo Please set the JAVA_HOME variable in your environment to match the
-echo location of your Java installation.
-
-goto fail
-
-:init
-@rem Get command-line arguments, handling Windows variants
-
-if not "%OS%" == "Windows_NT" goto win9xME_args
-
-:win9xME_args
-@rem Slurp the command line arguments.
-set CMD_LINE_ARGS=
-set _SKIP=2
-
-:win9xME_args_slurp
-if "x%~1" == "x" goto execute
-
-set CMD_LINE_ARGS=%*
-
-:execute
-@rem Setup the command line
-
-set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
-
-@rem Execute Gradle
-"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
-
-:end
-@rem End local scope for the variables with windows NT shell
-if "%ERRORLEVEL%"=="0" goto mainEnd
-
-:fail
-rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
-rem the _cmd.exe /c_ return code!
-if  not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
-exit /b 1
-
-:mainEnd
-if "%OS%"=="Windows_NT" endlocal
-
-:omega

pom.xml

@@ -0,0 +1,119 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <groupId>com.btk5h</groupId>
+    <artifactId>skript-db</artifactId>
+    <version>1.4.0</version>
+    <packaging>jar</packaging>
+
+    <repositories>
+        <repository>
+            <id>spigot-repo</id>
+            <url>https://hub.spigotmc.org/nexus/content/repositories/snapshots/org/spigotmc/spigot-api/</url>
+        </repository>
+        <repository>
+            <id>jitpack.io</id>
+            <url>https://jitpack.io</url>
+        </repository>
+        <repository>
+            <id>mvnrepository</id>
+            <url>https://mvnrepository.com</url>
+        </repository>
+        <repository>
+            <id>PaperMC</id>
+            <url>https://repo.destroystokyo.com/repository/maven-public/</url>
+        </repository>
+        <repository>
+            <id>sk89q</id>
+            <url>https://maven.sk89q.com/repo</url>
+        </repository>
+        <repository>
+            <id>skript</id>
+            <url>https://repo.skriptlang.org/releases</url>
+        </repository>
+    </repositories>
+
+    <build>
+        <resources>
+            <resource>
+                <directory>src/main/resources</directory>
+                <filtering>true</filtering>
+            </resource>
+        </resources>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <version>3.6.1</version>
+                <configuration>
+                    <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>
+                </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>
+                <version>3.2.0</version>
+                <configuration>
+                    <outputDirectory>${project.basedir}/compile</outputDirectory>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+
+    <dependencies>
+        <dependency>
+            <groupId>com.zaxxer</groupId>
+            <artifactId>HikariCP</artifactId>
+            <version>5.0.1</version>
+            <scope>compile</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.spigotmc</groupId>
+            <artifactId>spigot-api</artifactId>
+            <version>1.16.5-R0.1-SNAPSHOT</version>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>com.github.SkriptLang</groupId>
+            <artifactId>Skript</artifactId>
+            <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>3.1.2</version>
+            <scope>compile</scope>
+        </dependency>
+        <!-- https://mvnrepository.com/artifact/org.postgresql/postgresql -->
+        <dependency>
+            <groupId>org.postgresql</groupId>
+            <artifactId>postgresql</artifactId>
+            <version>42.6.0</version>
+            <scope>compile</scope>
+        </dependency>
+
+    </dependencies>
+</project>

settings.gradle

@@ -1,2 +0,0 @@
-rootProject.name = 'skript-db'
-

src/main/java/META-INF/MANIFEST.MF

@@ -0,0 +1,3 @@
+Manifest-Version: 1.0
+Main-Class: com.btk5h.skriptdb.SkriptDB
+

src/main/java/com/btk5h/skriptdb/SkriptDB.java

@@ -25,9 +25,11 @@
 
 package com.btk5h.skriptdb;
 
+import org.bukkit.configuration.file.FileConfiguration;
 import org.bukkit.plugin.java.JavaPlugin;
 
-import java.io.IOException;
+import java.io.*;
+import java.nio.charset.StandardCharsets;
 import java.sql.SQLException;
 
 import javax.sql.rowset.RowSetFactory;
@@ -49,6 +51,7 @@ public final class SkriptDB extends JavaPlugin {
   private static SkriptAddon addonInstance;
 
   private static RowSetFactory rowSetFactory;
+  protected FileConfiguration config;
 
   public SkriptDB() {
     if (instance == null) {
@@ -58,8 +61,46 @@ public final class SkriptDB extends JavaPlugin {
     }
   }
 
+  private void setupConfig() throws IOException {
+    //don't check if it exists, because mkdir already does that
+    File file = new File("plugins/skript-db/config.yml");
+    if (file.getParentFile().mkdirs()) {
+      BufferedWriter out = null;
+      try {
+        out = new BufferedWriter(new OutputStreamWriter(new FileOutputStream("plugins/skript-db/config.yml", false), StandardCharsets.UTF_8));
+      } catch (FileNotFoundException e) {
+        e.printStackTrace();
+      }
+      try {
+        if (out == null) return;
+
+        out.write("# How many connections can be awaited for simultaneously, may be useful to increase if SQL database is hosted on a separate machine to account for ping.\n");
+        out.write("# If it is hosted within the same machine, set it to the count of cores your processor has or the count of threads your processor can process at once.\n");
+        out.write("thread-pool-size: " + (Runtime.getRuntime().availableProcessors() + 2) + "\n");
+        out.write("# How long SQL connections should be kept alive in HikariCP. Default: 1800000 (30 minutes)");
+        out.write("max-connection-lifetime: 1800000");
+        out.write("# Only change this if you wish to use a different driver than Java's default, like MariaDB/PostgreSQL driver.\n");
+        out.write("# If you use MariaDB or PostgreSQL, its driver is shaded together with skript-db, so you can just specify:" + "\"org.mariadb.jdbc.Driver\"" + " or " + "\"org.postgresql.Driver\"" + ".\n");
+        out.write("sql-driver-class-name: " + "\"default\"" + "\n");
+      } catch (IOException e) {
+        e.printStackTrace();
+      }
+
+      try {
+        out.close();
+      } catch (IOException e) {
+        e.printStackTrace();
+      }
+    }
+  }
+
   @Override
   public void onEnable() {
+    try {
+      setupConfig();
+    } catch (IOException e) {
+      e.printStackTrace();
+    } finally {
       try {
         rowSetFactory = RowSetProvider.newFactory();
 
@@ -70,6 +111,7 @@ public final class SkriptDB extends JavaPlugin {
         e.printStackTrace();
       }
     }
+  }
 
   public static SkriptAddon getAddonInstance() {
     if (addonInstance == null) {

src/main/java/com/btk5h/skriptdb/SkriptUtil.java

@@ -1,64 +1,39 @@
 package com.btk5h.skriptdb;
 
-import org.bukkit.event.Event;
-
 import java.lang.reflect.Field;
 import java.util.Arrays;
 import java.util.Optional;
-import java.util.Set;
 
+import org.bukkit.event.Event;
+
+import ch.njol.skript.ScriptLoader;
 import ch.njol.skript.Skript;
-import ch.njol.skript.effects.Delay;
 import ch.njol.skript.lang.Expression;
-import ch.njol.skript.lang.Variable;
 import ch.njol.skript.lang.VariableString;
+import ch.njol.skript.lang.parser.ParserInstance;
 
 public class SkriptUtil {
 
     private static final Field STRING;
-  private static final Field SIMPLE;
-  private static final Field DELAYED;
     private static final Field EXPR;
-  private static final Field VARIABLE_NAME;
 
     static {
-    Field _FIELD = null;
-    try {
-      _FIELD = VariableString.class.getDeclaredField("string");
-      _FIELD.setAccessible(true);
-    } catch (NoSuchFieldException e) {
+        STRING = tryGetOldStringField()
+                .or(() -> tryGetNewStringField())
+                .orElseGet(() -> {
                     Skript.error("Skript's 'string' field could not be resolved.");
-      e.printStackTrace();
-    }
-    STRING = _FIELD;
-
-    try {
-      _FIELD = VariableString.class.getDeclaredField("simple");
-      _FIELD.setAccessible(true);
-    } catch (NoSuchFieldException e) {
-      Skript.error("Skript's 'simple' field could not be resolved.");
-      e.printStackTrace();
-    }
-    SIMPLE = _FIELD;
-
-    try {
-      _FIELD = Delay.class.getDeclaredField("delayed");
-      _FIELD.setAccessible(true);
-    } catch (NoSuchFieldException e) {
-      e.printStackTrace();
-      Skript.warning("Skript's 'delayed' method could not be resolved. Some Skript warnings may " +
-          "not be available.");
-    }
-    DELAYED = _FIELD;
+                    return null;
+                });
 
+        Field f = null;
         try {
             Optional<Class<?>> expressionInfo = Arrays.stream(VariableString.class.getDeclaredClasses())
                     .filter(cls -> cls.getSimpleName().equals("ExpressionInfo"))
                     .findFirst();
             if (expressionInfo.isPresent()) {
                 Class<?> expressionInfoClass = expressionInfo.get();
-        _FIELD = expressionInfoClass.getDeclaredField("expr");
-        _FIELD.setAccessible(true);
+                f = expressionInfoClass.getDeclaredField("expr");
+                f.setAccessible(true);
             } else {
                 Skript.error("Skript's 'ExpressionInfo' class could not be resolved.");
             }
@@ -66,34 +41,7 @@ public class SkriptUtil {
             e.printStackTrace();
             Skript.error("Skript's 'expr' field could not be resolved.");
         }
-    EXPR = _FIELD;
-
-    try {
-      _FIELD = Variable.class.getDeclaredField("name");
-      _FIELD.setAccessible(true);
-    } catch (NoSuchFieldException e) {
-      e.printStackTrace();
-      Skript.error("Skript's 'variable name' method could not be resolved.");
-    }
-    VARIABLE_NAME = _FIELD;
-  }
-
-  @SuppressWarnings("unchecked")
-  public static void delay(Event e) {
-    if (DELAYED != null) {
-      try {
-        ((Set<Event>) DELAYED.get(null)).add(e);
-      } catch (IllegalAccessException ignored) {
-      }
-    }
-  }
-
-  public static String getSimpleString(VariableString vs) {
-    try {
-      return (String) SIMPLE.get(vs);
-    } catch (IllegalAccessException e) {
-      throw new RuntimeException(e);
-    }
+        EXPR = f;
     }
 
     public static Object[] getTemplateString(VariableString vs) {
@@ -112,12 +60,35 @@ public class SkriptUtil {
         }
     }
     
-  public static VariableString getVariableName(Variable<?> var) {
+    @SuppressWarnings("deprecation")
+	public static boolean isCurrentEvent(Class<? extends Event> event) {
         try {
-      return (VariableString) VARIABLE_NAME.get(var);
-    } catch (IllegalAccessException e) {
-      e.printStackTrace();
+            Class.forName("ch.njol.skript.lang.parser.ParserInstance");
+            return ParserInstance.get().isCurrentEvent(event);
+        } catch (ClassNotFoundException e) {
+            return ScriptLoader.isCurrentEvent(event);
         }
-    return null;
     }
+    
+    
+    private static Optional<Field> tryGetOldStringField() {
+        try {
+            Field f = VariableString.class.getDeclaredField("string");
+            f.setAccessible(true);
+            return Optional.of(f);
+        } catch (NoSuchFieldException e) {
+            return Optional.empty();
+        }
+    }
+    
+    private static Optional<Field> tryGetNewStringField() {
+        try {
+            Field f = VariableString.class.getDeclaredField("strings");
+            f.setAccessible(true);
+            return Optional.of(f);
+        } catch (NoSuchFieldException e) {
+            return Optional.empty();
+        }
+    }
+
 }

src/main/java/com/btk5h/skriptdb/events/SQLQueryCompleteEvent.java

@@ -0,0 +1,29 @@
+package com.btk5h.skriptdb.events;
+
+import org.bukkit.event.Event;
+import org.bukkit.event.HandlerList;
+
+public class SQLQueryCompleteEvent extends Event {
+    
+	private static final HandlerList HANDLERS = new HandlerList();
+	
+    private final String argument;
+
+    public SQLQueryCompleteEvent(String argument) {
+        super(true);
+        this.argument = argument;
+    }
+
+    @Override
+    public HandlerList getHandlers() {
+        return getHandlerList();
+    }
+
+    public String getQuery() {
+        return argument;
+    }
+
+    public static HandlerList getHandlerList() {
+        return HANDLERS;
+    }
+}

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

@@ -1,35 +1,33 @@
 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 org.eclipse.jdt.annotation.Nullable;
 
+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.ArrayList;
-import java.util.List;
-import java.util.Locale;
+import java.sql.Statement;
+import java.util.*;
 import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.CompletionException;
 import java.util.concurrent.ExecutorService;
 import java.util.concurrent.Executors;
-
-import javax.sql.rowset.CachedRowSet;
-
-import ch.njol.skript.Skript;
-import ch.njol.skript.effects.Delay;
-import ch.njol.skript.lang.Expression;
-import ch.njol.skript.lang.SkriptParser;
-import ch.njol.skript.lang.TriggerItem;
-import ch.njol.skript.lang.Variable;
-import ch.njol.skript.lang.VariableString;
-import ch.njol.skript.variables.Variables;
-import ch.njol.util.Kleenean;
+import java.util.regex.Pattern;
 
 /**
  * Executes a statement on a database and optionally stores the result in a variable. Expressions
@@ -42,204 +40,288 @@ import ch.njol.util.Kleenean;
  * variable in the form `{test::<column name>::<row number>}`
  *
  * @name Execute Statement
- * @pattern execute %string% (in|on) %datasource% [and store [[the] (output|result)[s]] (to|in)
+ * @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 Delay {
-  static {
-    Skript.registerEffect(EffExecuteStatement.class,
-        "execute %string% (in|on) %datasource% " +
-            "[and store [[the] (output|result)[s]] (to|in) [the] [var[iable]] %-objects%]");
-  }
-
+public class EffExecuteStatement extends Effect {
+    private static final ExecutorService threadPool = Executors.newFixedThreadPool(SkriptDB.getInstance().getConfig().getInt("thread-pool-size", 10));
+    private static final Pattern ARGUMENT_PLACEHOLDER = Pattern.compile("(?<!\\\\)\\?");
     static String lastError;
 
-  private static final ExecutorService threadPool =
-      Executors.newFixedThreadPool(Runtime.getRuntime().availableProcessors());
+    static {
+        Skript.registerEffect(EffExecuteStatement.class,
+                "[quickly:quickly] execute %string% (in|on) %datasource% " +
+                        "[with arg[ument][s] %-objects%] [and store [[the] [keys:generated keys] (output|result)[s]] (to|in) [the] [var[iable]] %-objects%]");
+    }
 
     private Expression<String> query;
     private Expression<HikariDataSource> dataSource;
-  private VariableString var;
+    private Expression<Object> queryArguments;
+    private VariableString resultVariableName;
     private boolean isLocal;
     private boolean isList;
+    private boolean quickly;
+    private boolean generatedKeys;
+    private boolean isSync = false;
 
     @Override
     protected void execute(Event e) {
-    CompletableFuture<String> sql =
-        CompletableFuture.supplyAsync(() -> executeStatement(e), threadPool);
+        DataSource ds = dataSource.getSingle(e);
+        //if data source isn't set
+        if (ds == null) {
+        	return;
+        }
+        Pair<String, List<Object>> parsedQuery = parseQuery(e);
+        String baseVariable = resultVariableName != null ? resultVariableName.toString(e).toLowerCase(Locale.ENGLISH) : null;
         
-    sql.whenComplete((res, err) -> {
-      if (err != null) {
-        err.printStackTrace();
+        Object locals = Variables.removeLocals(e);
+
+        //execute SQL statement
+        if (Bukkit.isPrimaryThread()) {
+            CompletableFuture.supplyAsync(() -> executeStatement(ds, baseVariable, parsedQuery), threadPool)
+		            .whenComplete((resources, err) -> {
+		            	//handle last error syntax data
+		            	resetLastSQLError();
+		            	if (err instanceof CompletionException && err.getCause() instanceof SkriptDBQueryException) {
+	            			setLastSQLError(err.getCause().getMessage());
+	            		}
+		                //if local variables are present
+		                //bring back local variables
+		                //populate SQL data into variables
+		                if (!quickly) {
+		                    Bukkit.getScheduler().runTask(SkriptDB.getInstance(),
+		                    		() -> postExecution(e, locals, resources));
+		                } else {
+		                	postExecution(e, locals, resources);
+		                }
+		            });
+            // sync executed SQL query, same as above, just sync
+        } else {
+            isSync = true;
+            Map<String, Object> resources = null;
+            resetLastSQLError();
+            try {
+                resources = executeStatement(ds, baseVariable, parsedQuery);
+			} catch (SkriptDBQueryException err) {
+	            //handle last error syntax data
+				setLastSQLError(err.getMessage());
+			}
+            //if local variables are present
+            //bring back local variables
+            //populate SQL data into variables
+			postExecution(e, locals, resources);
+        }
     }
     
-      Bukkit.getScheduler().runTask(SkriptDB.getInstance(), () -> {
-        lastError = res;
-
-        if (getNext() != null) {
+    private void postExecution(Event e, Object locals, Map<String, Object> resources) {
+    	if (locals != null && getNext() != null) {
+            Variables.setLocalVariables(e, locals);
+        }
+        if (resources != null) {
+        	resources.forEach((name, value) -> setVariable(e, name, value));
+        }
         TriggerItem.walk(getNext(), e);
-        }
-      });
-    });
+        //the line below is required to prevent memory leaks
+        Variables.removeLocals(e);
     }
 
     @Override
     protected TriggerItem walk(Event e) {
         debug(e, true);
-    SkriptUtil.delay(e);
+        if (!quickly || !isSync) {
+            Delay.addDelayedEvent(e);
+        }
         execute(e);
         return null;
     }
 
-  private String executeStatement(Event e) {
-    HikariDataSource ds = dataSource.getSingle(e);
-
-    if (ds == null) {
-      return "Data source is not set";
+    private Pair<String, List<Object>> parseQuery(Event e) {
+        if (queryArguments != null) {
+            Object[] args = queryArguments.getArray(e);
+            String queryString = query.getSingle(e);
+            int queryArgCount = (int) ARGUMENT_PLACEHOLDER.matcher(queryString).results().count();
+            if (queryArgCount != args.length) {
+                Skript.warning(String.format("Your query has %d question marks, but you provided %d arguments. (%s) [%s]",
+                		queryArgCount,
+                		args.length,
+                		queryArguments.toString(e, true),
+                		Optional.ofNullable(getTrigger())
+                				.map(Trigger::getDebugLabel)
+                				.orElse("unknown")));
+                args = Arrays.copyOf(args, queryArgCount);
+            }
+            return new Pair<>(query.getSingle(e), Arrays.asList(args));
+        } else if (query instanceof VariableString && !((VariableString) query).isSimple()) {
+            return parseVariableQuery(e, (VariableString) query);
+        }
+        return new Pair<>(query.getSingle(e), null);
     }
     
-    try (Connection conn = ds.getConnection();
-         PreparedStatement stmt = createStatement(e, conn)) {
+    private Pair<String, List<Object>> parseVariableQuery(Event e, VariableString varQuery) {
+        StringBuilder sb = new StringBuilder();
+        List<Object> parameters = new LinkedList<>();
+        Object[] objects = SkriptUtil.getTemplateString(varQuery);
         
+        for (int i = 0; i < objects.length; i++) {
+            if (objects[i] instanceof String) {
+                sb.append(objects[i]);
+            } else {
+                Expression<?> expr = objects[i] instanceof Expression ? (Expression<?>) objects[i] : SkriptUtil.getExpressionFromInfo(objects[i]);
+                boolean standaloneString = isStandaloneString(objects, i);
+                Object expressionValue = expr.getSingle(e);
+
+                Pair<String, Object> toAppend = parseExpressionQuery(expr, expressionValue, standaloneString);
+                sb.append(toAppend.getFirst());
+                if (toAppend.getSecond() != null) {
+                    parameters.add(toAppend.getSecond());
+                }
+            }
+        }
+        return new Pair<>(sb.toString(), parameters);
+    }
+    
+    private Pair<String, Object> parseExpressionQuery(Expression<?> expr, Object expressionValue, boolean standaloneString) {
+        if (expr instanceof ExprUnsafe) {
+            if (standaloneString && expressionValue instanceof String) {
+                Skript.warning(
+                        String.format("Unsafe may have been used unnecessarily. Try replacing 'unsafe %1$s' with %1$s",
+                                ((ExprUnsafe) expr).getRawExpression()));
+            }
+            return new Pair<>((String) expressionValue, null);
+        } else {
+            if (standaloneString) {
+                Skript.warning("Do not surround expressions with quotes!");
+            }
+            return new Pair<>("?", expressionValue);
+        }
+    }
+
+    private Map<String, Object> executeStatement(DataSource ds, String baseVariable, Pair<String, List<Object>> query) throws SkriptDBQueryException {
+        if (ds == null) {
+        	throw new SkriptDBQueryException("Data source is not set");
+        }
+        try (Connection conn = ds.getConnection()) {
+            try (PreparedStatement stmt = createStatement(conn, query)) {
                 boolean hasResultSet = stmt.execute();
 
-      if (var != null) {
-        String baseVariable = var.toString(e)
-            .toLowerCase(Locale.ENGLISH);
+                if (baseVariable != null) {
+                    return processBaseVariable(baseVariable, stmt, hasResultSet);
+                }
+                return Map.of();
+            }
+        } catch (SQLException ex) {
+            throw new SkriptDBQueryException(ex.getMessage());
+        }
+    }
+    
+    private Map<String, Object> processBaseVariable(String baseVariable, PreparedStatement stmt, boolean hasResultSet) throws SQLException {
         if (isList) {
             baseVariable = baseVariable.substring(0, baseVariable.length() - 1);
         }
 
         if (hasResultSet) {
             CachedRowSet crs = SkriptDB.getRowSetFactory().createCachedRowSet();
-          crs.populate(stmt.getResultSet());
+            crs.populate(generatedKeys ? stmt.getGeneratedKeys() : stmt.getResultSet());
 
             if (isList) {
-            populateVariable(e, crs, baseVariable);
+                return fetchQueryResultSet(crs, baseVariable);
             } else {
                 crs.last();
-            setVariable(e, baseVariable, crs.getRow());
+                return Map.of(baseVariable, crs.getRow());
             }
         } else if (!isList) {
-          setVariable(e, baseVariable, stmt.getUpdateCount());
+            //if no results are returned and the specified variable isn't a list variable, put the affected rows count in the variable
+            return Map.of(baseVariable, stmt.getUpdateCount());
         }
-      }
-    } catch (SQLException ex) {
-      return ex.getMessage();
-    }
-    return null;
+        return Map.of();
     }
     
-  private PreparedStatement createStatement(Event e, Connection conn) throws SQLException {
-    if (!(query instanceof VariableString)) {
-      return conn.prepareStatement(query.getSingle(e));
-    }
-
-    if (((VariableString) query).isSimple()) {
-      return conn.prepareStatement(SkriptUtil.getSimpleString(((VariableString) query)));
-    }
-
-    StringBuilder sb = new StringBuilder();
-    List<Object> parameters = new ArrayList<>();
-    Object[] objects = SkriptUtil.getTemplateString(((VariableString) query));
-    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!");
-          }
-        }
-      }
-    }
-
-    PreparedStatement stmt = conn.prepareStatement(sb.toString());
-
-    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);
-  }
-
-  private void populateVariable(Event e, CachedRowSet crs, String baseVariable)
-      throws SQLException {
+    private Map<String, Object> fetchQueryResultSet(CachedRowSet crs, String baseVariable) throws SQLException {
+        Map<String, Object> variableList = new HashMap<>();
         ResultSetMetaData meta = crs.getMetaData();
         int columnCount = meta.getColumnCount();
 
         for (int i = 1; i <= columnCount; i++) {
             String label = meta.getColumnLabel(i);
-      setVariable(e, baseVariable + label, label);
+            variableList.put(baseVariable + label, label);
         }
 
         int rowNumber = 1;
         while (crs.next()) {
             for (int i = 1; i <= columnCount; i++) {
-        setVariable(e, baseVariable + meta.getColumnLabel(i).toLowerCase(Locale.ENGLISH)
+                variableList.put(baseVariable + meta.getColumnLabel(i).toLowerCase(Locale.ENGLISH)
                         + Variable.SEPARATOR + rowNumber, crs.getObject(i));
             }
             rowNumber++;
         }
+        return variableList;
+    }
+
+    private PreparedStatement createStatement(Connection conn, Pair<String, List<Object>> query) throws SQLException {
+        PreparedStatement stmt = generatedKeys ? 
+        		conn.prepareStatement(query.getFirst(), Statement.RETURN_GENERATED_KEYS)
+        		: conn.prepareStatement(query.getFirst(), Statement.NO_GENERATED_KEYS);
+        if (query.getSecond() != null) {
+            Iterator<Object> iter = query.getSecond().iterator();
+            for (int i = 1; iter.hasNext(); i++) {
+                stmt.setObject(i, iter.next());
+            }
+        }
+
+        return stmt;
+    }
+    
+    private boolean isStandaloneString(Object[] objects, int index) {
+        String before = getString(objects, index - 1);
+        String after = getString(objects, index + 1);
+        return before != null && before.endsWith("'") && after != null && after.endsWith("'");
+    }
+
+    private String getString(Object[] objects, int index) {
+        if (index >= 0 && index < objects.length && objects[index] instanceof String) {
+            return (String) objects[index];
+        }
+        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 instanceof byte[]) {
+                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);
+    }
+    
+    private static void resetLastSQLError() {
+    	lastError = null;
+    }
+    
+    private static void setLastSQLError(String error) {
+    	lastError = error;
     }
 
     @Override
-  public String toString(@Nullable Event e, boolean debug) {
+    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) {
+    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;
@@ -250,16 +332,36 @@ public class EffExecuteStatement extends Delay {
             return false;
         }
         dataSource = (Expression<HikariDataSource>) exprs[1];
-    Expression<?> expr = exprs[2];
-    if (expr instanceof Variable) {
-      Variable<?> varExpr = (Variable<?>) expr;
-      var = SkriptUtil.getVariableName(varExpr);
+        if (exprs[2] != null) {
+            if (query instanceof VariableString && !((VariableString) query).isSimple()) {
+                Skript.warning("Your query string contains expresions, but you've also provided query arguments. Consider using `unsafe` keyword before your query.");
+            }
+            queryArguments = (Expression<Object>) exprs[2];
+        }
+        ;
+        Expression<?> resultHolder = exprs[3];
+        quickly = parseResult.hasTag("quickly");
+        if (resultHolder instanceof Variable) {
+            Variable<?> varExpr = (Variable<?>) resultHolder;
+            resultVariableName = varExpr.getName();
             isLocal = varExpr.isLocal();
             isList = varExpr.isList();
-    } else if (expr != null) {
-      Skript.error(expr + " is not a variable");
+            generatedKeys = parseResult.hasTag("keys");
+        } else if (resultHolder != null) {
+            Skript.error(resultHolder + " is not a variable");
             return false;
         }
         return true;
     }
+    
+    public static class SkriptDBQueryException extends RuntimeException {
+
+		private static final long serialVersionUID = -1869895286406538884L;
+		
+		public SkriptDBQueryException(String message) {
+			super(message);
+		}
+    	
+    }
+    
 }

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

@@ -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";
+    }
+}

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

@@ -1,13 +1,12 @@
 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;
+import org.bukkit.event.Event;
 
 /**
  * Stores the error from the last executed statement, if there was one.

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

@@ -1,12 +1,5 @@
 package com.btk5h.skriptdb.skript;
 
-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;
@@ -14,31 +7,39 @@ 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%]"
+ * @pattern [the] data(base|[ ]source) [(of|at)] %string% [with [a] [max[imum]] [connection] life[ ]time of %timespan%] [[(using|with)] [a] driver %-string%]"
  * @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%]");
+                ExpressionType.COMBINED, "[the] data(base|[ ]source) [(of|at)] %string% "
+                		+ "[with [a] [max[imum]] [connection] life[ ]time of %-timespan%] "
+                		+ "[[(using|with)] [a] driver %-string%]");
     }
 
-  private static Map<String, HikariDataSource> connectionCache = new HashMap<>();
-
     private Expression<String> url;
     private Expression<Timespan> maxLifetime;
+    private Expression<String> driver;
 
     @Override
     protected HikariDataSource[] get(Event e) {
@@ -56,6 +57,18 @@ public class ExprDataSource extends SimpleExpression<HikariDataSource> {
         }
 
         HikariDataSource ds = new HikariDataSource();
+        ds.setMaximumPoolSize(SkriptDB.getInstance().getConfig().getInt("thread-pool-size", 10));
+
+        // 30 minutes by default
+        ds.setMaxLifetime(SkriptDB.getInstance().getConfig().getInt("max-connection-lifetime", 1800000));
+
+        // Allow specifying of own sql driver class name
+        if (driver != null && driver.getSingle(e) != null) {
+            ds.setDriverClassName(driver.getSingle(e));
+        } else if (!SkriptDB.getInstance().getConfig().getString("sql-driver-class-name", "default").equals("default")) {
+            ds.setDriverClassName(SkriptDB.getInstance().getConfig().getString("sql-driver-class-name"));
+        }
+
         ds.setJdbcUrl(jdbcUrl);
 
         if (maxLifetime != null) {
@@ -88,10 +101,10 @@ public class ExprDataSource extends SimpleExpression<HikariDataSource> {
 
     @SuppressWarnings("unchecked")
     @Override
-  public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed,
-                      SkriptParser.ParseResult parseResult) {
+    public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult) {
         url = (Expression<String>) exprs[0];
         maxLifetime = (Expression<Timespan>) exprs[1];
+        driver = (Expression<String>) exprs[2];
         return true;
     }
 }

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

@@ -0,0 +1,62 @@
+package com.btk5h.skriptdb.skript;
+
+import org.bukkit.event.Event;
+
+import com.btk5h.skriptdb.SkriptUtil;
+import com.btk5h.skriptdb.events.SQLQueryCompleteEvent;
+
+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;
+
+/**
+ * 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 (!SkriptUtil.isCurrentEvent(SQLQueryCompleteEvent.class)) {
+            Skript.error("Cannot use 'sql query' outside of a complete of sql query event", ErrorQuality.SEMANTIC_ERROR);
+            return false;
+        }
+        return true;
+    }
+}

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

@@ -1,13 +1,12 @@
 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;
+import org.bukkit.event.Event;
 
 /**
  * Opts out of automatic SQL injection protection for a specific expression in a statement.
@@ -54,8 +53,7 @@ public class ExprUnsafe extends SimpleExpression<String> {
 
     @SuppressWarnings("unchecked")
     @Override
-  public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed,
-                      SkriptParser.ParseResult parseResult) {
+    public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult) {
         stringExpression = (Expression<String>) exprs[0];
         rawExpression = parseResult.expr.substring("unsafe".length()).trim();
         return true;

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

@@ -1,16 +1,14 @@
 package com.btk5h.skriptdb.skript;
 
-import com.zaxxer.hikari.HikariDataSource;
-
-import java.io.NotSerializableException;
-import java.io.StreamCorruptedException;
-
 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 {
@@ -32,27 +30,21 @@ public class Types {
                         return o.getJdbcUrl();
                     }
 
-          @Override
-          public String getVariableNamePattern() {
-            return "jdbc:.+";
-          }
                 })
                 .serializer(new Serializer<HikariDataSource>() {
                     @Override
-          public Fields serialize(HikariDataSource o) throws NotSerializableException {
+                    public Fields serialize(HikariDataSource o) {
                         Fields fields = new Fields();
                         fields.putObject("jdbcurl", o.getJdbcUrl());
                         return fields;
                     }
 
                     @Override
-          public void deserialize(HikariDataSource o, Fields f) throws StreamCorruptedException,
-              NotSerializableException {
+                    public void deserialize(HikariDataSource o, Fields f) {
                     }
 
                     @Override
-          protected HikariDataSource deserialize(Fields fields) throws StreamCorruptedException,
-              NotSerializableException {
+                    protected HikariDataSource deserialize(Fields fields) throws StreamCorruptedException {
                         HikariDataSource ds = new HikariDataSource();
                         ds.setJdbcUrl((String) fields.getObject("jdbcurl"));
                         return ds;
@@ -64,7 +56,7 @@ public class Types {
                     }
 
                     @Override
-          public boolean canBeInstantiated(Class<? extends HikariDataSource> c) {
+                    protected boolean canBeInstantiated() {
                         return false;
                     }
                 }));

src/main/resources/plugin.yml

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