path: root/datarouter-prov/src/main/java/org/onap/dmaap/datarouter/provisioning/utils/DB.java

/*******************************************************************************
 * ============LICENSE_START==================================================
 * * org.onap.dmaap
 * * ===========================================================================
 * * Copyright © 2017 AT&T Intellectual Property. All rights reserved.
 * * ===========================================================================
 * * Licensed under the Apache License, Version 2.0 (the "License");
 * * you may not use this file except in compliance with the License.
 * * You may obtain a copy of the License at
 * *
 *  *      http://www.apache.org/licenses/LICENSE-2.0
 * *
 *  * Unless required by applicable law or agreed to in writing, software
 * * distributed under the License is distributed on an "AS IS" BASIS,
 * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * * See the License for the specific language governing permissions and
 * * limitations under the License.
 * * ============LICENSE_END====================================================
 * *
 * * ECOMP is a trademark and service mark of AT&T Intellectual Property.
 * *
 ******************************************************************************/


package org.onap.dmaap.datarouter.provisioning.utils;

import static java.lang.System.exit;
import static java.lang.System.getProperty;

import com.att.eelf.configuration.EELFLogger;
import com.att.eelf.configuration.EELFManager;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileReader;
import java.io.IOException;
import java.io.LineNumberReader;
import java.sql.Connection;
import java.sql.DatabaseMetaData;
import java.sql.DriverManager;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Statement;
import java.util.HashSet;
import java.util.LinkedList;
import java.util.NoSuchElementException;
import java.util.Properties;
import java.util.Queue;
import java.util.Set;

/**
 * Load the DB JDBC driver, and manage a simple pool of connections to the DB.
 *
 * @author Robert Eby
 * @version $Id$
 */
public class DB {

    private static EELFLogger intlogger = EELFManager.getInstance().getLogger("InternalLog");

    private static String dbUrl;
    private static String dbLogin;
    private static String dbPassword;
    private static Properties props;
    private static final Queue<Connection> queue = new LinkedList<>();

    private static String httpsPort;
    private static String httpPort;

    /**
     * Construct a DB object.  If this is the very first creation of this object, it will load a copy of the properties
     * for the server, and attempt to load the JDBC driver for the database. If a fatal error occurs (e.g. either the
     * properties file or the DB driver is missing), the JVM will exit.
     */
    public DB() {
        if (props == null) {
            props = new Properties();
            try {
                props.load(new FileInputStream(getProperty(
                    "org.onap.dmaap.datarouter.provserver.properties",
                    "/opt/app/datartr/etc/provserver.properties")));
                String dbDriver = (String) props.get("org.onap.dmaap.datarouter.db.driver");
                dbUrl = (String) props.get("org.onap.dmaap.datarouter.db.url");
                dbLogin = (String) props.get("org.onap.dmaap.datarouter.db.login");
                dbPassword = (String) props.get("org.onap.dmaap.datarouter.db.password");
                httpsPort = (String) props.get("org.onap.dmaap.datarouter.provserver.https.port");
                httpPort = (String) props.get("org.onap.dmaap.datarouter.provserver.http.port");
                Class.forName(dbDriver);
            } catch (IOException e) {
                intlogger.error("PROV9003 Opening properties: " + e.getMessage(), e);
                exit(1);
            } catch (ClassNotFoundException e) {
                intlogger.error("PROV9004 cannot find the DB driver: " + e);
                exit(1);
            }
        }
    }

    /**
     * Get the provisioning server properties (loaded from provserver.properties).
     *
     * @return the Properties object
     */
    public Properties getProperties() {
        return props;
    }

    /**
     * Get a JDBC connection to the DB from the pool.  Creates a new one if none are available.
     *
     * @return the Connection
     */
    public Connection getConnection() throws SQLException {
        Connection connection = null;
        while (connection == null) {
            synchronized (queue) {
                try {
                    connection = queue.remove();
                } catch (NoSuchElementException nseEx) {
                    intlogger.error("PROV9006 No connection on queue: " + nseEx.getMessage(), nseEx);
                    int n = 0;
                    do {
                        // Try up to 3 times to get a connection
                        try {
                            connection = DriverManager.getConnection(dbUrl, dbLogin, dbPassword);
                        } catch (SQLException sqlEx) {
                            if (++n >= 3) {
                                throw sqlEx;
                            }
                        }
                    } while (connection == null);
                }
            }
            if (connection != null && !connection.isValid(1)) {
                connection.close();
                connection = null;
            }
        }
        return connection;
    }

    /**
     * Returns a JDBC connection to the pool.
     *
     * @param connection the Connection to return
     */
    public void release(Connection connection) {
        if (connection != null) {
            synchronized (queue) {
                if (!queue.contains(connection)) {
                    queue.add(connection);
                }
            }
        }
    }

    /**
     * Run all necessary retrofits required to bring the database up to the level required for this version of the
     * provisioning server.  This should be run before the server itself is started.
     *
     * @return true if all retrofits worked, false otherwise
     */
    public boolean runRetroFits() {
        return retroFit1();
    }


    public static String getHttpsPort() {
        return httpsPort;
    }

    public static String getHttpPort() {
        return httpPort;
    }

    /**
     * Retrofit 1 - Make sure the expected tables are in DB and are initialized. Uses sql_init_01.sql to setup the DB.
     *
     * @return true if the retrofit worked, false otherwise
     */
    private boolean retroFit1() {
        final String[] expectedTables = {
            "FEEDS", "FEED_ENDPOINT_ADDRS", "FEED_ENDPOINT_IDS", "PARAMETERS",
            "SUBSCRIPTIONS", "LOG_RECORDS", "INGRESS_ROUTES", "EGRESS_ROUTES",
            "NETWORK_ROUTES", "NODESETS", "NODES", "GROUPS"
        };
        Connection connection = null;
        try {
            connection = getConnection();
            Set<String> actualTables = getTableSet(connection);
            boolean initialize = false;
            for (String tableName : expectedTables) {
                initialize |= !actualTables.contains(tableName);
            }
            if (initialize) {
                intlogger.info("PROV9001: First time startup; The database is being initialized.");
                runInitScript(connection, 1);
            }
        } catch (SQLException e) {
            intlogger.error("PROV9000: The database credentials are not working: " + e.getMessage(), e);
            return false;
        } finally {
            if (connection != null) {
                release(connection);
            }
        }
        return true;
    }

    /**
     * Get a set of all table names in the DB.
     *
     * @param connection a DB connection
     * @return the set of table names
     */
    private Set<String> getTableSet(Connection connection) {
        Set<String> tables = new HashSet<>();
        try {
            DatabaseMetaData md = connection.getMetaData();
            ResultSet rs = md.getTables(null, null, "%", null);
            if (rs != null) {
                while (rs.next()) {
                    tables.add(rs.getString("TABLE_NAME").toUpperCase());
                }
                rs.close();
            }
        } catch (SQLException e) {
            intlogger.error("PROV9010: Failed to get TABLE data from DB: " + e.getMessage(), e);
        }
        return tables;
    }

    /**
     * Initialize the tables by running the initialization scripts located in the directory specified by the property
     * <i>org.onap.dmaap.datarouter.provserver.dbscripts</i>.  Scripts have names of the form
     * sql_init_NN.sql
     *
     * @param connection a DB connection
     * @param scriptId the number of the sql_init_NN.sql script to run
     */
    private void runInitScript(Connection connection, int scriptId) {
        String scriptDir = (String) props.get("org.onap.dmaap.datarouter.provserver.dbscripts");
        String scriptFile = String.format("%s/sql_init_%02d.sql", scriptDir, scriptId);
        if (!(new File(scriptFile)).exists()) {
            intlogger.error("PROV9005 Failed to load sql script from : " + scriptFile);
            exit(1);
        }
        try (LineNumberReader lineReader = new LineNumberReader(new FileReader(scriptFile));
                Statement statement = connection.createStatement()) {
            StringBuilder strBuilder = new StringBuilder();
            String line;
            while ((line = lineReader.readLine()) != null) {
                if (!line.startsWith("--")) {
                    line = line.trim();
                    strBuilder.append(line);
                    executeDdlStatement(statement, strBuilder, line);
                }
            }
            strBuilder.setLength(0);
        } catch (Exception e) {
            intlogger.error("PROV9002 Error when initializing table: " + e.getMessage(), e);
            exit(1);
        }
    }

    private void executeDdlStatement(Statement statement, StringBuilder strBuilder, String line) throws SQLException {
        if (line.endsWith(";")) {
            // Execute one DDL statement
            String sql = strBuilder.toString();
            strBuilder.setLength(0);
            statement.execute(sql);
        }
    }
}