Skip to content

O
Openfire
Commit 61bb3b3c authored by Matt Tucker's avatar Matt Tucker Committed by matt
Browse files
Options

Added automatic database upgrading. 


git-svn-id: http://svn.igniterealtime.org/svn/repos/messenger/trunk@840 b35dd754-fafc-0310-a699-88a17e54d16e
parent 5190e1d8
Hide whitespace changes
Inline Side-by-side
Showing with 188 additions and 158 deletions
src/java/org/jivesoftware/database/DbConnectionManager.java
View file @ 61bb3b3c
...@@ -15,11 +15,8 @@ package org.jivesoftware.database; ...@@ -15,11 +15,8 @@ package org.jivesoftware.database;
import org.jivesoftware.util.ClassUtils; import org.jivesoftware.util.ClassUtils;
import org.jivesoftware.util.Log; import org.jivesoftware.util.Log;
import org.jivesoftware.messenger.JiveGlobals; import org.jivesoftware.messenger.JiveGlobals;
import org.jivesoftware.database.ConnectionProvider;
import java.io.Reader; import java.io.*;
import java.io.StringReader;
import java.io.StringWriter;
import java.sql.*; import java.sql.*;
/** /**
...@@ -36,6 +33,21 @@ import java.sql.*; ...@@ -36,6 +33,21 @@ import java.sql.*;
*/ */
public class DbConnectionManager { public class DbConnectionManager {
private static final String CHECK_VERSION =
"SELECT majorVersion, minorVersion FROM jiveVersion";
/**
* Database schema major version. The schema version corresponds to the
* product release version, but may not exactly match in the case that
* the product version has advanced without schema changes.
*/
private static final int CURRENT_MAJOR_VERSION = 2;
/**
* Database schema minor version.
*/
private static final int CURRENT_MINOR_VERSION = 1;
private static ConnectionProvider connectionProvider; private static ConnectionProvider connectionProvider;
private static Object providerLock = new Object(); private static Object providerLock = new Object();
...@@ -57,7 +69,7 @@ public class DbConnectionManager { ...@@ -57,7 +69,7 @@ public class DbConnectionManager {
// True if the database supports batch updates. // True if the database supports batch updates.
private static boolean batchUpdatesSupported; private static boolean batchUpdatesSupported;
private static DatabaseType databaseType = DatabaseType.OTHER; private static DatabaseType databaseType = DatabaseType.unknown;
/** /**
* Returns a database connection from the currently active connection * Returns a database connection from the currently active connection
...@@ -157,7 +169,6 @@ public class DbConnectionManager { ...@@ -157,7 +169,6 @@ public class DbConnectionManager {
catch (Exception e) { catch (Exception e) {
Log.error(e); Log.error(e);
} }
} }
/** /**
...@@ -203,7 +214,7 @@ public class DbConnectionManager { ...@@ -203,7 +214,7 @@ public class DbConnectionManager {
* the feature, the cursor will be moved directly. Otherwise, we scroll through results one by * the feature, the cursor will be moved directly. Otherwise, we scroll through results one by
* one manually by calling <tt>rs.next()</tt>. * one manually by calling <tt>rs.next()</tt>.
* *
* @param rs the ResultSet object to scroll. * @param rs the ResultSet object to scroll.
* @param rowNumber the row number to scroll forward to. * @param rowNumber the row number to scroll forward to.
* @throws SQLException if an error occurs. * @throws SQLException if an error occurs.
*/ */
...@@ -255,16 +266,21 @@ public class DbConnectionManager { ...@@ -255,16 +266,21 @@ public class DbConnectionManager {
try { try {
con = connectionProvider.getConnection(); con = connectionProvider.getConnection();
setMetaData(con); setMetaData(con);
// Check to see if the database schema needs to be upgraded.
try {
upgradeDatabase(con);
}
catch (Exception e) {
Log.error("Database upgrade failed. Please manually upgrade your database.", e);
}
} }
catch (Exception e) { catch (Exception e) {
Log.error(e); Log.error(e);
} }
finally { finally {
try { try { if (con != null) { con.close(); } }
con.close(); catch (Exception e) { Log.error(e); }
}
catch (Exception e) {
}
} }
} }
// Remember what connection provider we want to use for restarts. // Remember what connection provider we want to use for restarts.
...@@ -277,7 +293,7 @@ public class DbConnectionManager { ...@@ -277,7 +293,7 @@ public class DbConnectionManager {
* different JDBC drivers have different capabilities and methods for * different JDBC drivers have different capabilities and methods for
* retrieving large text values. * retrieving large text values.
* *
* @param rs the ResultSet to retrieve the text field from. * @param rs the ResultSet to retrieve the text field from.
* @param columnIndex the column in the ResultSet of the text field. * @param columnIndex the column in the ResultSet of the text field.
* @return the String value of the text field. * @return the String value of the text field.
*/ */
...@@ -323,12 +339,13 @@ public class DbConnectionManager { ...@@ -323,12 +339,13 @@ public class DbConnectionManager {
* different JDBC drivers have different capabilities and methods for * different JDBC drivers have different capabilities and methods for
* setting large text values. * setting large text values.
* *
* @param pstmt the PreparedStatement to set the text field in. * @param pstmt the PreparedStatement to set the text field in.
* @param parameterIndex the index corresponding to the text field. * @param parameterIndex the index corresponding to the text field.
* @param value the String to set. * @param value the String to set.
*/ */
public static void setLargeTextField(PreparedStatement pstmt, public static void setLargeTextField(PreparedStatement pstmt, int parameterIndex,
int parameterIndex, String value) throws SQLException { String value) throws SQLException
{
if (isStreamTextRequired()) { if (isStreamTextRequired()) {
Reader bodyReader = null; Reader bodyReader = null;
try { try {
...@@ -352,7 +369,7 @@ public class DbConnectionManager { ...@@ -352,7 +369,7 @@ public class DbConnectionManager {
* statement. The operation is automatically bypassed if Jive knows that the * statement. The operation is automatically bypassed if Jive knows that the
* the JDBC driver or database doesn't support it. * the JDBC driver or database doesn't support it.
* *
* @param stmt the Statement to set the max number of rows for. * @param stmt the Statement to set the max number of rows for.
* @param maxRows the max number of rows to return. * @param maxRows the max number of rows to return.
*/ */
public static void setMaxRows(Statement stmt, int maxRows) { public static void setMaxRows(Statement stmt, int maxRows) {
...@@ -376,7 +393,7 @@ public class DbConnectionManager { ...@@ -376,7 +393,7 @@ public class DbConnectionManager {
* The operation is automatically bypassed if Jive knows that the * The operation is automatically bypassed if Jive knows that the
* the JDBC driver or database doesn't support it. * the JDBC driver or database doesn't support it.
* *
* @param rs the ResultSet to set the fetch size for. * @param rs the ResultSet to set the fetch size for.
* @param fetchSize the fetchSize. * @param fetchSize the fetchSize.
*/ */
public static void setFetchSize(ResultSet rs, int fetchSize) { public static void setFetchSize(ResultSet rs, int fetchSize) {
...@@ -421,7 +438,7 @@ public class DbConnectionManager { ...@@ -421,7 +438,7 @@ public class DbConnectionManager {
// Oracle properties. // Oracle properties.
if (dbName.indexOf("oracle") != -1) { if (dbName.indexOf("oracle") != -1) {
databaseType = DatabaseType.ORACLE; databaseType = DatabaseType.oracle;
streamTextRequired = true; streamTextRequired = true;
// The i-net AUGURO JDBC driver // The i-net AUGURO JDBC driver
if (driverName.indexOf("auguro") != -1) { if (driverName.indexOf("auguro") != -1) {
...@@ -432,32 +449,39 @@ public class DbConnectionManager { ...@@ -432,32 +449,39 @@ public class DbConnectionManager {
} }
// Postgres properties // Postgres properties
else if (dbName.indexOf("postgres") != -1) { else if (dbName.indexOf("postgres") != -1) {
databaseType = DatabaseType.POSTGRES; databaseType = DatabaseType.postgres;
// Postgres blows, so disable scrolling result sets. // Postgres blows, so disable scrolling result sets.
scrollResultsSupported = false; scrollResultsSupported = false;
fetchSizeSupported = false; fetchSizeSupported = false;
} }
// Interbase properties // Interbase properties
else if (dbName.indexOf("interbase") != -1) { else if (dbName.indexOf("interbase") != -1) {
databaseType = DatabaseType.interbase;
fetchSizeSupported = false; fetchSizeSupported = false;
maxRowsSupported = false; maxRowsSupported = false;
} }
// SQLServer, JDBC driver i-net UNA properties // SQLServer, JDBC driver i-net UNA properties
else if (dbName.indexOf("sql server") != -1 && else if (dbName.indexOf("sql server") != -1 &&
driverName.indexOf("una") != -1) { driverName.indexOf("una") != -1)
{
databaseType = DatabaseType.sqlserver;
fetchSizeSupported = true; fetchSizeSupported = true;
maxRowsSupported = false; maxRowsSupported = false;
} }
// MySQL properties // MySQL properties
else if (dbName.indexOf("mysql") != -1) { else if (dbName.indexOf("mysql") != -1) {
databaseType = DatabaseType.MYSQL; databaseType = DatabaseType.mysql;
transactionsSupported = false; transactionsSupported = false;
} }
// HSQL properties // HSQL properties
else if (dbName.indexOf("hsql") != -1) { else if (dbName.indexOf("hsql") != -1) {
databaseType = DatabaseType.HSQL; databaseType = DatabaseType.hsqldb;
scrollResultsSupported = false; scrollResultsSupported = false;
} }
// DB2 properties.
else if (dbName.indexOf("db2") != 1) {
databaseType = DatabaseType.db2;
}
} }
/** /**
...@@ -537,16 +561,146 @@ public class DbConnectionManager { ...@@ -537,16 +561,146 @@ public class DbConnectionManager {
* there are certain cases where it's critical to know the database for * there are certain cases where it's critical to know the database for
* performance reasons. * performance reasons.
*/ */
public static class DatabaseType { public static enum DatabaseType {
oracle,
public static final DatabaseType ORACLE = new DatabaseType(); postgres,
public static final DatabaseType POSTGRES = new DatabaseType();
public static final DatabaseType MYSQL = new DatabaseType();
public static final DatabaseType HSQL = new DatabaseType();
public static final DatabaseType OTHER = new DatabaseType();
private DatabaseType() { mysql,
/* do nothing */
hsqldb,
db2,
sqlserver,
interbase,
unknown;
}
/**
* Checks to see if the database needs to be upgraded. This method should be
* called once every time the application starts up.
*
* @throws SQLException if an error occured.
*/
private static boolean upgradeDatabase(Connection con) throws Exception {
int majorVersion;
int minorVersion;
PreparedStatement pstmt = null;
try {
pstmt = con.prepareStatement(CHECK_VERSION);
ResultSet rs = pstmt.executeQuery();
// If no results, assume the version is 2.0.
if (!rs.next()) {
majorVersion = 2;
minorVersion = 0;
}
majorVersion = rs.getInt(1);
minorVersion = rs.getInt(2);
rs.close();
}
catch (SQLException sqle) {
// If the table doesn't exist, an error will be thrown. Therefore
// assume the version is 2.0.
majorVersion = 2;
minorVersion = 0;
}
finally {
try { if (pstmt != null) { pstmt.close(); } }
catch (Exception e) { Log.error(e); }
}
if (minorVersion == CURRENT_MINOR_VERSION) {
return false;
}
// The database is an old version that needs to be upgraded.
Log.info("Found old database schema (" + majorVersion + "." + minorVersion + "). " +
"Upgrading to latest schema.");
if (databaseType == DatabaseType.unknown) {
Log.info("Warning: database type unknown. You must manually upgrade your database.");
return false;
}
else if (databaseType == DatabaseType.interbase) {
Log.info("Warning: automatic upgrades of Interbase are not supported. You " +
"must manually upgrade your database.");
return false;
}
// Run all upgrade scripts until we're up to the latest schema.
for (int i=minorVersion; i<CURRENT_MINOR_VERSION; i++) {
BufferedReader in = null;
Statement stmt = null;
try {
// Resource will be like "/database/upgrade/2.0_to_2.1/messenger_hsqldb.sql"
String resourceName = "/database/upgrade/" + CURRENT_MAJOR_VERSION + "." + i +
"_to_" + CURRENT_MAJOR_VERSION + "." + (i+1) + "/messenger_" +
databaseType + ".sql";
in = new BufferedReader(new InputStreamReader(
new DbConnectionManager().getClass().getResourceAsStream(resourceName)));
boolean done = false;
while (!done) {
StringBuffer command = new StringBuffer();
while (true) {
String line = in.readLine();
if (line == null) {
done = true;
break;
}
// Ignore comments and blank lines.
if (isSQLCommandPart(line)) {
command.append(line);
}
if (line.endsWith(";")) {
break;
}
}
// Send command to database.
if (!done && command != null) {
stmt = con.createStatement();
stmt.execute(command.toString());
stmt.close();
}
}
}
finally {
try { if (pstmt != null) { pstmt.close(); } }
catch (Exception e) { Log.error(e); }
if (in != null) {
try { in.close(); }
catch (Exception e) { }
}
}
} }
return true;
}
/**
* Returns true if a line from a SQL schema is a valid command part.
*
* @param line the line of the schema.
* @return true if a valid command part.
*/
public static boolean isSQLCommandPart(String line) {
line = line.trim();
if (line.equals("")) {
return false;
}
// Check to see if the line is a comment. Valid comment types:
// "//" is HSQLDB
// "--" is DB2 and Postgres
// "#" is MySQL
// "REM" is Oracle
// "/*" is SQLServer
if (line.startsWith("//") || line.startsWith("--") || line.startsWith("#") ||
line.startsWith("REM") || line.startsWith("/*"))
{
return false;
}
return true;
}
private DbConnectionManager() {
// Not instantiable.
} }
} }
\ No newline at end of file
src/java/org/jivesoftware/database/EmbeddedConnectionProvider.java
View file @ 61bb3b3c
...@@ -30,22 +30,6 @@ import java.sql.*; ...@@ -30,22 +30,6 @@ import java.sql.*;
*/ */
public class EmbeddedConnectionProvider implements ConnectionProvider { public class EmbeddedConnectionProvider implements ConnectionProvider {
private static final String CHECK_VERSION =
"SELECT majorVersion, minorVersion FROM jiveVersion";
/**
* Database schema major version. The schema version corresponds to the
* product release version, but may not exactly match in the case that
* the product version has advanced without schema changes.
*/
private static final int CURRENT_MAJOR_VERSION = 2;
/**
* Database schema minor version.
*/
private static final int CURRENT_MINOR_VERSION = 1;
private ConnectionPool connectionPool = null; private ConnectionPool connectionPool = null;
private Object initLock = new Object(); private Object initLock = new Object();
...@@ -96,15 +80,6 @@ public class EmbeddedConnectionProvider implements ConnectionProvider { ...@@ -96,15 +80,6 @@ public class EmbeddedConnectionProvider implements ConnectionProvider {
if (initData) { if (initData) {
initializeDatabase(); initializeDatabase();
} }
// Check to see if the database schema needs to be upgraded.
else {
try {
upgradeDatabase();
}
catch (Exception e) {
Log.error(e);
}
}
} }
catch (IOException ioe) { catch (IOException ioe) {
Log.error("Error starting connection pool.", ioe); Log.error("Error starting connection pool.", ioe);
...@@ -170,7 +145,7 @@ public class EmbeddedConnectionProvider implements ConnectionProvider { ...@@ -170,7 +145,7 @@ public class EmbeddedConnectionProvider implements ConnectionProvider {
break; break;
} }
// Ignore comments and blank lines. // Ignore comments and blank lines.
if (isCommandPart(line)) { if (DbConnectionManager.isSQLCommandPart(line)) {
command.append(line); command.append(line);
} }
if (line.endsWith(";")) { if (line.endsWith(";")) {
...@@ -192,107 +167,8 @@ public class EmbeddedConnectionProvider implements ConnectionProvider { ...@@ -192,107 +167,8 @@ public class EmbeddedConnectionProvider implements ConnectionProvider {
try { in.close(); } try { in.close(); }
catch (Exception e) { } catch (Exception e) { }
} }
if (con != null) {
try { con.close(); }
catch (Exception e) { }
}
}
}
private void upgradeDatabase() {
int majorVersion;
int minorVersion;
Connection con = null;
PreparedStatement pstmt = null;
try {
con = getConnection();
pstmt = con.prepareStatement(CHECK_VERSION);
ResultSet rs = pstmt.executeQuery();
// If no results, assume the version is 2.0.
if (!rs.next()) {
majorVersion = 2;
minorVersion = 0;
}
majorVersion = rs.getInt(1);
minorVersion = rs.getInt(2);
rs.close();
}
catch (SQLException sqle) {
// If the table doesn't exist, an error will be thrown. Therefore
// assume the version is 2.0.
majorVersion = 2;
minorVersion = 0;
}
finally {
try { if (pstmt != null) { pstmt.close(); } }
catch (Exception e) { Log.error(e); }
try { if (con != null) { con.close(); } } try { if (con != null) { con.close(); } }
catch (Exception e) { Log.error(e); } catch (Exception e) { Log.error(e); }
} }
if (minorVersion == CURRENT_MINOR_VERSION) {
return;
}
// The database is an old version that needs to be upgraded.
Log.info("Found old database schema (" + majorVersion + "." + minorVersion + "). " +
"Upgrading to latest schema.");
// Run all upgrade scripts until we're up to the latest schema.
for (int i=minorVersion; i<CURRENT_MINOR_VERSION; i++) {
BufferedReader in = null;
try {
// Resource will be like "/database/upgrade/2.0_to_2.1/messenger_hsqldb.sql"
String resourceName = "/database/upgrade/" + CURRENT_MAJOR_VERSION + "." + i +
"_to_" + CURRENT_MAJOR_VERSION + "." + (i+1) + "/messenger_hsqldb.sql";
in = new BufferedReader(new InputStreamReader(getClass().getResourceAsStream(
resourceName)));
con = getConnection();
boolean done = false;
while (!done) {
StringBuffer command = new StringBuffer();
while (true) {
String line = in.readLine();
if (line == null) {
done = true;
break;
}
// Ignore comments and blank lines.
if (isCommandPart(line)) {
command.append(line);
}
if (line.endsWith(";")) {
break;
}
}
// Send command to database.
Statement stmt = con.createStatement();
stmt.execute(command.toString());
stmt.close();
}
}
catch (Exception e) {
Log.error(e);
e.printStackTrace();
}
finally {
if (in != null) {
try { in.close(); }
catch (Exception e) { }
}
if (con != null) {
try { con.close(); }
catch (Exception e) { }
}
}
}
}
private static boolean isCommandPart(String line) {
line = line.trim();
if (line.equals("")) {
return false;
}
if (line.startsWith("//")) {
return false;
}
return true;
} }
} }
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment

Technounit-GROUP 2023