Lock SQLite databases to stop concurrent writes and bump to 1.0.1

Author: SupremeMortal

pom.xml

@@ -5,7 +5,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>ru.nukkit.dblib</groupId>
     <artifactId>DbLib</artifactId>
-    <version>1.0-SNAPSHOT</version>
+    <version>1.0.1</version>
 
     <properties>
         <maven.compiler.source>1.8</maven.compiler.source>
@@ -75,6 +75,16 @@
 
 
     <build>
+        <finalName>${project.name}</finalName>
+        <defaultGoal>clean package</defaultGoal>
+
+        <resources>
+            <resource>
+                <directory>src/main/resources</directory>
+                <filtering>true</filtering>
+            </resource>
+        </resources>
+
         <plugins>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>

src/main/java/ru/nukkit/dblib/DbLib.java

@@ -1,10 +1,17 @@
 package ru.nukkit.dblib;
 
+import com.j256.ormlite.db.DatabaseType;
+import com.j256.ormlite.db.DatabaseTypeUtils;
+import com.j256.ormlite.db.SqliteDatabaseType;
+import com.j256.ormlite.jdbc.DataSourceConnectionSource;
 import com.j256.ormlite.jdbc.JdbcConnectionSource;
 import com.j256.ormlite.jdbc.JdbcPooledConnectionSource;
+import com.j256.ormlite.jdbc.JdbcSingleConnectionSource;
 import com.j256.ormlite.logger.LocalLog;
 import com.j256.ormlite.support.ConnectionSource;
+import com.j256.ormlite.support.DatabaseConnection;
 import org.sql2o.Sql2o;
+import ru.nukkit.dblib.connectionsource.LockedJdbcSingleConnectionSource;
 import ru.nukkit.dblib.core.M;
 import ru.nukkit.dblib.nukkit.ConfigNukkit;
 
@@ -43,7 +50,7 @@ public static void init(ConfigNukkit cfg, File dataFolder) {
      * Get DbLib's default ORMLite connection source.
      * All plugins used this method will share same database
      *
-     * @return - ConnectionSource (ORMlite)
+     * @return - {@link ConnectionSource}
      */
     public static ConnectionSource getConnectionSource() {
         return connectionSource;
@@ -54,18 +61,21 @@ public static ConnectionSource getConnectionSource() {
      * Allows plugins to use custom connection source
      *
      * @param url      - database url (including database protocol). Examples:
-     *                 jdbc:sqlite:c:\server\plugins\MyPugin\data.db
+     *                 jdbc:sqlite:c:\server\plugins\MyPlugin\data.db
      *                 jdbc:mysql://localhost:3306/db
      * @param userName - Database user name, will be ignored for sqlite
      * @param password - Database user password, will be ignored for sqlite
-     * @return - ConnectionSource (ORMlite)
+     * @return - {@link ConnectionSource}
      */
     public static ConnectionSource getConnectionSource(String url, String userName, String password) {
+        DatabaseType type = DatabaseTypeUtils.createDatabaseType(url);
         try {
-            if (config.ormLiteKeepAlive() <= 0) {
+            if (type instanceof SqliteDatabaseType) {
+                return new LockedJdbcSingleConnectionSource(url, userName, password, type);
+            } else if (config.ormLiteKeepAlive() <= 0) {
                 return new JdbcConnectionSource(url, userName, password);
             } else {
-                JdbcPooledConnectionSource jdbcCon = new JdbcPooledConnectionSource(url, userName, password);
+                JdbcPooledConnectionSource jdbcCon = new JdbcPooledConnectionSource(url, userName, password, type);
                 jdbcCon.setCheckConnectionsEveryMillis(config.ormLiteKeepAlive());
                 return jdbcCon;
             }
@@ -80,7 +90,7 @@ public static ConnectionSource getConnectionSource(String url, String userName,
      * Get custom SQLite ORMLite connection source.
      *
      * @param fileName - database file name
-     * @return - ConnectionSource (ORMlite)
+     * @return - {@link ConnectionSource}
      */
     public static ConnectionSource getConnectionSourceSQLite(String fileName) {
         File f = new File(folder + File.separator + fileName);
@@ -98,7 +108,7 @@ public static ConnectionSource getConnectionSourceSQLite(String fileName) {
      * @param database - MySQL database
      * @param user     - MySQL user name
      * @param password - MySQL password
-     * @return - ConnectionSource (ORMlite)
+     * @return - {@link ConnectionSource}
      */
     public static ConnectionSource getConnectionSourceMySql(String host, int port, String database, String user, String password) {
         return getConnectionSource(getMySqlUrl(host, port, database), user, password);
@@ -122,7 +132,7 @@ public static Connection getDefaultConnection() {
      * @param url      - MySQL url, example: localhost:3306/db
      * @param user     - MySQL user name
      * @param password - MySQL password
-     * @return - Connection (SQL)
+     * @return - {@link Connection}
      */
     public static Connection getMySqlConnection(String url, String user, String password) {
         try {

src/main/java/ru/nukkit/dblib/connectionsource/LockedJdbcSingleConnectionSource.java

@@ -0,0 +1,62 @@
+package ru.nukkit.dblib.connectionsource;
+
+import com.j256.ormlite.db.DatabaseType;
+import com.j256.ormlite.jdbc.JdbcConnectionSource;
+import com.j256.ormlite.logger.Logger;
+import com.j256.ormlite.logger.LoggerFactory;
+import com.j256.ormlite.support.DatabaseConnection;
+
+import java.sql.SQLException;
+import java.util.concurrent.locks.Lock;
+import java.util.concurrent.locks.ReentrantLock;
+
+public class LockedJdbcSingleConnectionSource extends JdbcConnectionSource {
+    private static final Logger logger = LoggerFactory.getLogger(LockedJdbcSingleConnectionSource.class);
+    private final Lock lock = new ReentrantLock(true);
+    private DatabaseConnection connection;
+
+    public LockedJdbcSingleConnectionSource() {
+        // for spring type wiring
+        super();
+    }
+
+    public LockedJdbcSingleConnectionSource(String url) throws SQLException {
+        super(url);
+    }
+
+    public LockedJdbcSingleConnectionSource(String url, DatabaseType databaseType) throws SQLException {
+        super(url, databaseType);
+    }
+
+    public LockedJdbcSingleConnectionSource(String url, String username, String password) throws SQLException {
+        super(url, username, password);
+    }
+
+    public LockedJdbcSingleConnectionSource(String url, String username, String password, DatabaseType type) throws SQLException {
+        super(url, username, password, type);
+    }
+
+    @Override
+    public void initialize() throws SQLException {
+        super.initialize();
+        this.connection = this.makeConnection(logger);
+    }
+
+    @Override
+    public void close() {
+        // no-op because we don't want to close the connection
+    }
+
+    @Override
+    public void releaseConnection(DatabaseConnection connection) {
+        lock.unlock();
+        // no-op because we don't want to close the connection
+    }
+
+
+    @Override
+    public DatabaseConnection getReadWriteConnection(String tableName) throws SQLException {
+        lock.lock();
+        return this.connection;
+    }
+}

src/main/resources/plugin.yml

@@ -1,6 +1,6 @@
 name: DbLib
 main: ru.nukkit.dblib.nukkit.DbLibPlugin
-version: "0.2.5"
+version: ${project.version}
 author: fromgate, nukkit.ru
-api: ["1.0.7"]
+api: ["1.0.8"]
 description: SQLite/MySQL library for your plugins (Nukkit)