Application: gvSIG desktop

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2020 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 3

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 */

package org.gvsig.fmap.dal.store.h2;

import java.io.File;

import java.sql.Connection;

import java.sql.SQLException;

import java.text.MessageFormat;

import org.apache.commons.dbcp.BasicDataSource;

import org.apache.commons.io.FilenameUtils;

import org.apache.commons.lang3.StringUtils;

import org.gvsig.expressionevaluator.GeometryExpressionBuilderHelper.GeometrySupportType;

import static org.gvsig.fmap.dal.DatabaseWorkspaceManager.FIELD_CONFIGURATION_NAME;

import static org.gvsig.fmap.dal.DatabaseWorkspaceManager.FIELD_CONFIGURATION_VALUE;

import static org.gvsig.fmap.dal.DatabaseWorkspaceManager.FIELD_RESOURCES_NAME;

import static org.gvsig.fmap.dal.DatabaseWorkspaceManager.FIELD_RESOURCES_RESOURCE;

import static org.gvsig.fmap.dal.DatabaseWorkspaceManager.TABLE_CONFIGURATION_NAME;

import static org.gvsig.fmap.dal.DatabaseWorkspaceManager.TABLE_RESOURCES_NAME;

import org.gvsig.fmap.dal.exception.InitializeException;

import org.gvsig.fmap.dal.resource.exception.AccessResourceException;

import org.gvsig.fmap.dal.spi.DataServerExplorerProviderServices;

import static org.gvsig.fmap.dal.store.h2.H2SpatialHelper.LOGGER;

import org.gvsig.fmap.dal.store.h2.operations.H2SpatialOperationsFactory;

import org.gvsig.fmap.dal.store.jdbc.JDBCConnectionParameters;

import org.gvsig.fmap.dal.store.jdbc.JDBCNewStoreParameters;

import org.gvsig.fmap.dal.store.jdbc.JDBCServerExplorerParameters;

import org.gvsig.fmap.dal.store.jdbc.JDBCStoreParameters;

import org.gvsig.fmap.dal.store.jdbc.exception.JDBCDriverClassNotFoundException;

import org.gvsig.fmap.dal.store.jdbc2.JDBCServerExplorer;

import org.gvsig.fmap.dal.store.jdbc2.JDBCUtils;

import org.gvsig.fmap.dal.store.jdbc2.OperationsFactory;

import org.gvsig.fmap.dal.store.jdbc2.spi.ConnectionProvider;

import org.gvsig.fmap.dal.store.jdbc2.spi.JDBCHelperBase;

import org.gvsig.fmap.dal.store.jdbc2.spi.JDBCSQLBuilderBase;

import org.gvsig.fmap.dal.store.jdbc2.spi.SRSSolverBase;

import org.gvsig.fmap.dal.store.jdbc2.spi.SRSSolverDumb;

import org.h2.tools.Server;

import org.h2gis.functions.factory.H2GISFunctions;

import org.h2gis.functions.system.H2GISversion;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

@SuppressWarnings("UseSpecificCatch")

public class H2SpatialHelper extends JDBCHelperBase {

    static final Logger LOGGER = LoggerFactory.getLogger(H2SpatialHelper.class);

    public static final String H2SPATIAL_JDBC_DRIVER = "org.h2.Driver";

    public static File getLocalFile(H2SpatialConnectionParameters params) {

        String host = params.getHost();

        if( !StringUtils.isEmpty(host) ) {

          host = host.toLowerCase().trim();

          if( !(host.equals("localhost") || host.equals("127.0.0.1")) ) {

            return null;

          }

        }

        File f = params.getFile();

        if( f == null ) {

          return null;

        }

        String pathname = f.getAbsolutePath().replace("\\","/");

        if( !pathname.endsWith(".mv.db")  ) {

          pathname += ".mv.db";

        }      

        return new File(pathname);

    }

    public static String getConnectionURL(H2SpatialConnectionParameters params) {

        String connectionURL;

        String dbfilename = params.getFile().getAbsolutePath().replace("\\","/");

        if( dbfilename!=null && dbfilename.endsWith(".mv.db") ) {

            dbfilename = dbfilename.substring(0, dbfilename.length()-6);

        }

        StringBuilder commonParameters = new StringBuilder();

        commonParameters.append(";MODE=PostgreSQL");

        commonParameters.append(";SCHEMA=PUBLIC");

        commonParameters.append(";ALLOW_LITERALS=ALL");

        if( StringUtils.isEmpty(params.getHost()) ) {

            // Asumimos que es una conexion directa sobre el filesystem

            if( StringUtils.equalsIgnoreCase(FilenameUtils.getExtension(params.getFile().getName()),"zip") ) {

                connectionURL =  MessageFormat.format(

                    "jdbc:h2:zip:{0}!/{1}"+commonParameters.toString(),

                    dbfilename,

                    params.getDBName()

                );

            } else {

                connectionURL =  MessageFormat.format(

                    "jdbc:h2:file:{0}"+commonParameters.toString(),

                    dbfilename

                );

            }

        } else if( params.getPort() == null ) {

            connectionURL =  MessageFormat.format(

                "jdbc:h2:tcp://{0}/{1}"+commonParameters.toString(),

                params.getHost(),

                dbfilename

            );            

        } else {

            connectionURL =  MessageFormat.format("jdbc:h2:tcp://{0}:{1,number,#######}/{2}"+commonParameters.toString(),

                params.getHost(),

                (int) params.getPort(),

                dbfilename

            );

        }

        LOGGER.debug("connectionURL: {}", connectionURL);

        return connectionURL;

    }

    public static class ConnectionProviderImpl implements ConnectionProvider {

        private static boolean needRegisterDriver = true;

        private BasicDataSource dataSource = null;

        private final H2SpatialConnectionParameters connectionParameters;

        private static Server server = null;

        private static boolean startServer = true;

        public ConnectionProviderImpl(H2SpatialConnectionParameters connectionParameters) {

            this.connectionParameters = connectionParameters;

        }

        @Override

        public String getStatus() {

            StringBuilder builder = new StringBuilder();

            builder.append("Pool: ");

            builder.append(JDBCUtils.getHexId(dataSource));

            builder.append(" Actives: ");

            builder.append(dataSource.getNumActive());

            builder.append("/");

            builder.append(dataSource.getMaxActive());

            builder.append(" idle: ");

            builder.append(dataSource.getNumIdle());

            builder.append("/");

            builder.append(dataSource.getMinIdle());

            builder.append(":");

            builder.append(dataSource.getMaxIdle());

            return builder.toString();

        }

        @SuppressWarnings("ConvertToTryWithResources")

        public void shutdown() {

            LOGGER.info("Shutdown H2 connection.");

            try {

                Connection conn = this.getConnection();

                conn.createStatement().execute("SHUTDOWN");

                conn.close();

            } catch (Throwable th) {

                LOGGER.warn("Problems shutdown the database.", th);

            }

            try {

                if( dataSource!=null ) {

                    LOGGER.info("Clossing connection pool.");

                    LOGGER.info(this.getStatus());

                    dataSource.close();

                    LOGGER.info("Connection pool closed.");

                    LOGGER.info(this.getStatus());

                }

            } catch (Throwable th) {

                LOGGER.warn("Problems closing connections pool.", th);

            }

        }

        public static void stopServer() {

            if (server == null) {

                LOGGER.info("The H2 server is already stopped.");

            } else {

                LOGGER.info("Stopping the H2 server.");

                LOGGER.info("  port  :" + server.getPort());

                LOGGER.info("  URL   :" + server.getURL());

                LOGGER.info("  shutdown server...");

                try {

                    server.shutdown();

                } catch (Throwable th) {

                    LOGGER.warn("Problems shutdown the H2 server.", th);

                }

                LOGGER.info("  Stoping server...");

                try {

                    server.stop();

                } catch (Throwable th) {

                    LOGGER.warn("Problems stopping the H2 server.", th);

                }

                LOGGER.info("  status:" + server.getStatus());

                server = null;

                LOGGER.info("H2 Server stopped");

            }

            startServer = true;

        }

        private void startServer() {

            if( startServer && server == null ) {

                String port = "9123";

                try {

                    Server theServer;

                    if( this.connectionParameters.getServerPort()>0 ) {

                        port = String.valueOf(this.connectionParameters.getServerPort());

                    }

                    if( this.connectionParameters.getServerAllowOthers() ) {

                        theServer = Server.createTcpServer("-tcpPort", port, "-ifExists", "-tcpAllowOthers");

                    } else {

                        theServer = Server.createTcpServer("-tcpPort", port, "-ifExists");

                    }

                    theServer.start();

                    server = theServer;

                    LOGGER.info("H2 Server started" );

                    LOGGER.info("  Engine version : h2 "+ org.h2.engine.Constants.getFullVersion()+", h2gis "+H2GISversion.geth2gisVersion());

                    LOGGER.info("  Connection url : jdbc:h2:"+server.getURL()+"/ABSOLUTE_DATABASE_PATH;MODE=PostgreSQL;SCHEMA=PUBLIC;ALLOW_LITERALS=ALL");

//                    LOGGER.info("  port  :"+ server.getPort());

//                    LOGGER.info("  URL   :"+ server.getURL());

                    LOGGER.info("  status:"+ server.getStatus());

                    Runtime.getRuntime().addShutdownHook(new Thread() {

                        @Override

                        public void run() {

                            stopServer();

                        }

                    });

                } catch (SQLException ex) {

                    LOGGER.warn("H2 Server not started",ex);

                }

                // Tanto si consigue lanzar el server como si no, no lo vuelve a intentar

                startServer = false;

            }

        }

        @Override

        public String toString() {

            StringBuilder builder = new StringBuilder();

            builder.append(" url=").append(connectionParameters.getUrl());

            builder.append(" driver name=").append(connectionParameters.getJDBCDriverClassName());

            builder.append(" user=").append(connectionParameters.getUser());

            return builder.toString();

        }

        @Override

        public synchronized Connection getConnection() throws SQLException {

            File f = H2SpatialHelper.getLocalFile(connectionParameters);

            boolean newdb = !f.exists();

            if (this.dataSource == null) {

                this.dataSource = this.createDataSource();               

            }

            Connection conn;

            try {

                conn = this.dataSource.getConnection();

            } catch(Throwable th) {

                LOGGER.warn("Can't create connection to '"+this.dataSource.getUrl()+"'. "+this.getStatus());

                LOGGER.warn("Can't create connection to '"+this.dataSource.getUrl()+"'.",th);

                throw th;

            }

            try {

                conn.createStatement().execute("SELECT TOP 1 SRID FROM SPATIAL_REF_SYS");

            } catch(SQLException ex) {

                H2GISFunctions.load(conn);

            }

            try {

                conn.createStatement().execute("CREATE SCHEMA IF NOT EXISTS PUBLIC;SET SCHEMA PUBLIC");

            } catch(SQLException ex) {

                LOGGER.trace("Can't create schema public.",ex);

                // Ignore this error.

            }

            if( newdb ) {

                    String[] sqls = new String[] {

                        "CREATE CACHED TABLE PUBLIC.\""+TABLE_RESOURCES_NAME+"\"(\""+FIELD_RESOURCES_NAME+"\" VARCHAR(150) NOT NULL, \""+FIELD_RESOURCES_RESOURCE+"\" BLOB DEFAULT NULL)",

                        "ALTER TABLE PUBLIC.\""+TABLE_RESOURCES_NAME+"\" ADD CONSTRAINT PUBLIC.CONSTRAINT_E PRIMARY KEY(\""+FIELD_RESOURCES_NAME+"\")",

                        "CREATE CACHED TABLE PUBLIC.\""+TABLE_CONFIGURATION_NAME+"\"(\""+FIELD_CONFIGURATION_NAME+"\" VARCHAR(200) NOT NULL, \""+FIELD_CONFIGURATION_VALUE+"\" VARCHAR(200) DEFAULT NULL)",

                        "ALTER TABLE PUBLIC.\""+TABLE_CONFIGURATION_NAME+"\" ADD CONSTRAINT PUBLIC.CONSTRAINT_2 PRIMARY KEY(\""+FIELD_CONFIGURATION_NAME+"\")"

                    };

                    for (String sql : sqls) {

                        try {

                            conn.createStatement().execute(sql);

                        } catch(SQLException ex) {

                            LOGGER.debug("Can't configure gvsig tables.",ex);

                            LOGGER.warn("Can't configure gvsig tables. "+sql);

                            // Ignore this error.

                        }

                    }

            }

            return conn;

        }

        private BasicDataSource createDataSource() throws SQLException {

            if (!this.isRegistered()) {

                this.registerDriver();

            }

            startServer();

            H2SpatialConnectionParameters params = connectionParameters;

            BasicDataSource ds = new BasicDataSource();

            ds.setDriverClassName(params.getJDBCDriverClassName());

            if( !StringUtils.isEmpty(params.getUser()) ) {

                ds.setUsername(params.getUser());

            }

            if( !StringUtils.isEmpty(params.getPassword()) ) {

                ds.setPassword(params.getPassword());

            }

            ds.setUrl(params.getUrl());

            ds.setMaxWait(60L * 1000);

            //

            // Ajustamos el pool para que las conexiones se cierren a los

            // 10 segundos, asi tratamos de que al salir de gvSIG no queden

            // conexiones abiertas con la BBDD y pueda quedar corrupta esta.

            // Hay que tener en cuenta que es una BBDD embebida, y mientras

            // hayan conexiones abiertas pueden quedar cosas por bajar a disco.

            //

            int sidle = this.connectionParameters.getMaxSecondsIdle();

            if( sidle < 0 ) {

                ds.setTimeBetweenEvictionRunsMillis(-1);

                ds.setMinEvictableIdleTimeMillis(30*1000);

            } else {

                // Revisamos las conexiones inactivas cada 10 segundos

                ds.setTimeBetweenEvictionRunsMillis(sidle*1000);

                // Eliminadmos las conexiones que lleven inactivas mas de 10 segundos.

                ds.setMinEvictableIdleTimeMillis(sidle*1000);

            }

            // Ajustamos el numero minimo de conexiones a 0 para permitir

            // que se lleguen a cerrar todas las conexiones del pool.

            ds.setMinIdle(0);

            // dejaremos el MaxIdle a 20, no parece importante. .

            ds.setMaxIdle(20);

            return ds;

        }

        private boolean isRegistered() {

            return needRegisterDriver;

        }

        @Override

        public void registerDriver() throws SQLException {

            String className = this.connectionParameters.getJDBCDriverClassName();

            if (className == null) {

                return;

            }

            try {

                Class theClass = Class.forName(className);

                if (theClass == null) {

                    throw new JDBCDriverClassNotFoundException(H2SpatialLibrary.NAME, className);

                }

            } catch (Exception e) {

                throw new SQLException("Can't register JDBC driver '" + className + "'.", e);

            }

            needRegisterDriver = false;

        }

    }

    private ConnectionProvider connectionProvider = null;

    /**

     * Constructor for use only for testing purposes.

     * 

     * @param connectionParameters

     * @param connectionProvider

     */

    public H2SpatialHelper(JDBCConnectionParameters connectionParameters, ConnectionProvider connectionProvider) { 

        super(connectionParameters);

        this.srssolver = new SRSSolverDumb(this);

        this.connectionProvider = connectionProvider;

    }

    public H2SpatialHelper(JDBCConnectionParameters connectionParameters) {

        super(connectionParameters);

        this.srssolver = new SRSSolverBase(this);

    }

    public void  shutdown() {

        try {

            if( this.connectionProvider!=null ) {

                ((ConnectionProviderImpl) this.connectionProvider).shutdown();

                this.connectionProvider = null;

            }

            ConnectionProviderImpl.stopServer();

        } catch (Throwable ex) {

            LOGGER.warn("Problems shutdown H2", ex);

        }

    }

    private void logConnectionStatus(String msg, Connection conn) {

        ConnectionProvider cp = this.getConnectionProvider();

        StringBuilder builder = new StringBuilder();

        builder.append(msg);

        if( conn == null ) {

            builder.append(": connection null");

        } else {

            Boolean closed = null;

            try {

                closed = conn.isClosed();

            } catch(Throwable th) {

            }

            builder.append(": connection ");

            builder.append(JDBCUtils.getConnId(conn));

            if( closed ) {

                builder.append(" (c)");

            }

            builder.append(" ");

        }

        builder.append(cp.getStatus());

        LOGGER.info(builder.toString());

    }

    private ConnectionProvider getConnectionProvider() {

        if (this.connectionProvider == null) {

          H2SpatialConnectionParameters connectionParameters = this.getConnectionParameters();

          if( connectionParameters==null ) {

            return null; // Testing mode?

          }

          this.connectionProvider = new ConnectionProviderImpl(connectionParameters);

        }

        return this.connectionProvider;

    }

    @Override

    public synchronized Connection  getConnection() throws AccessResourceException {

        try {

            if (this.connectionProvider == null) {

              H2SpatialConnectionParameters connectionParameters = this.getConnectionParameters();

              if( connectionParameters==null ) {

                return null; // Testing mode?

              }

              this.connectionProvider = new ConnectionProviderImpl(connectionParameters);

            }

            Connection connection = this.connectionProvider.getConnection();

            if( LOGGER.isDebugEnabled() ) {

                LOGGER.debug("["+JDBCUtils.getConnId(connection)+"] getConnection "+connectionProvider.getStatus()+" "+ connectionProvider.toString());

            }

            return connection;

        } catch (SQLException ex) {

            throw new AccessResourceException(H2SpatialLibrary.NAME, ex);

        }

    }

    @Override

    public void closeConnection(Connection connection) {

      if( connection!=null ) { // In test ???

        LOGGER.debug("["+JDBCUtils.getConnId(connection)+"] closeConnection "+ this.connectionProvider.getStatus());

      }

      super.closeConnection(connection);

    }

    @Override

    public H2SpatialConnectionParameters getConnectionParameters() {

        return (H2SpatialConnectionParameters) super.getConnectionParameters();

    }

    @Override

    public String getConnectionURL() {

        return getConnectionURL(this.getConnectionParameters());

    }

    @Override

    protected String getResourceType() {

        return H2SpatialLibrary.NAME;

    }

    @Override

    public String getProviderName() {

        return H2SpatialLibrary.NAME;

    }

    @Override

    public JDBCSQLBuilderBase createSQLBuilder() {

        return new H2SpatialSQLBuilder(this);

    }

    @Override

    public OperationsFactory getOperations() {

        if (this.operationsFactory == null) {

            this.operationsFactory = new H2SpatialOperationsFactory(this);

        }

        return operationsFactory;

    }

    @Override

    public GeometrySupportType getGeometrySupportType() {

        return GeometrySupportType.WKB;

    }

    @Override

    public boolean hasSpatialFunctions() {

        return true;

    }

    @Override

    public boolean canWriteGeometry(int geometryType, int geometrySubtype) {

        return true;

    }

    @Override

    public String getQuoteForIdentifiers() {

        return "\"";

    }

    @Override

    public boolean allowAutomaticValues() {

        return true;

    }

    @Override

    public boolean supportOffsetInSelect() {

        return true;

    }

    @Override

    public String getQuoteForStrings() {

        return "'";

    }

    @Override

    public String getSourceId(JDBCStoreParameters parameters) {

        H2SpatialStoreParameters h2params = (H2SpatialStoreParameters) parameters;

        StringBuilder builder = new StringBuilder();

        builder.append(h2params.getTable());

        builder.append("(");

        if( StringUtils.isNotBlank(h2params.getHost()) ) {

            builder.append(h2params.getHost());

        }

        if( h2params.getPort()>0 ) {

            builder.append(",");

            builder.append(h2params.getPort());

        }

        File f = h2params.getFile();       

        if( f != null ) {

            builder.append(",");

            builder.append(h2params.getFile().getAbsolutePath());

        }

        builder.append(")");

        return builder.toString();

    }

    @Override

    public JDBCNewStoreParameters createNewStoreParameters() {

        return new H2SpatialNewStoreParameters();

    }

    @Override

    public JDBCStoreParameters createOpenStoreParameters() {

        return new H2SpatialStoreParameters();

    }

    @Override

    public JDBCServerExplorerParameters createServerExplorerParameters() {

        return new H2SpatialExplorerParameters();

    }

    @Override

    public JDBCServerExplorer createServerExplorer(

            JDBCServerExplorerParameters parameters, 

            DataServerExplorerProviderServices providerServices

        ) throws InitializeException {

        JDBCServerExplorer explorer = new H2SpatialExplorer(

                parameters, 

                providerServices, 

                this

        );

        this.initialize(explorer, parameters, null);

        return explorer;

    }

}