SchemaManager.java 18 KB
Newer Older
1 2 3 4
/**
 * $Revision$
 * $Date$
 *
5
 * Copyright (C) 2005-2008 Jive Software. All rights reserved.
6 7
 *
 * This software is published under the terms of the GNU Public License (GPL),
8 9
 * a copy of which is included in this distribution, or a commercial license
 * agreement with Jive.
10 11 12 13
 */

package org.jivesoftware.database;

14
import org.jivesoftware.util.JiveGlobals;
15
import org.jivesoftware.util.LocaleUtils;
16
import org.jivesoftware.util.Log;
17 18 19
import org.jivesoftware.openfire.XMPPServer;
import org.jivesoftware.openfire.container.Plugin;
import org.jivesoftware.openfire.container.PluginManager;
20

21
import java.io.*;
22
import java.sql.*;
23 24 25
import java.util.Arrays;

/**
26
 * Manages database schemas for Openfire and Openfire plugins. The manager uses the
27
 * ofVersion database table to figure out which database schema is currently installed
28 29 30 31 32 33 34 35 36 37 38 39 40
 * and then attempts to automatically apply database schema changes as necessary.<p>
 *
 * Running database schemas automatically requires appropriate database permissions.
 * Without those permissions, the automatic installation/upgrade process will fail
 * and users will be prompted to apply database changes manually.
 *
 * @see DbConnectionManager#getSchemaManager()
 *
 * @author Matt Tucker
 */
public class SchemaManager {

    private static final String CHECK_VERSION_OLD =
41
            "SELECT minorVersion FROM jiveVersion";
42
    private static final String CHECK_VERSION =
43
            "SELECT version FROM ofVersion WHERE name=?";
44 45
    private static final String CHECK_VERSION_JIVE =
            "SELECT version FROM jiveVersion WHERE name=?";
46 47

    /**
48
     * Current Openfire database schema version.
49
     */
50
    private static final int DATABASE_VERSION = 20;
51 52 53 54 55 56 57 58 59

    /**
     * Creates a new Schema manager.
     */
    SchemaManager() {

    }

    /**
60
     * Checks the Openfire database schema to ensure that it's installed and up to date.
61 62 63 64 65 66
     * If the schema isn't present or up to date, an automatic update will be attempted.
     *
     * @param con a connection to the database.
     * @return true if database schema checked out fine, or was automatically installed
     *      or updated successfully.
     */
67
    public boolean checkOpenfireSchema(Connection con) {
68
        // Change 'wildfire' to 'openfire' in ofVersion table (update to new name)
69
        updateToOpenfire(con);
70
        try {
71
            return checkSchema(con, "openfire", DATABASE_VERSION,
72 73
                    new ResourceLoader() {
                        public InputStream loadResource(String resourceName) {
74 75 76 77
                            File file = new File(JiveGlobals.getHomeDirectory() + File.separator +
                                    "resources" + File.separator + "database", resourceName);
                            try {
                                return new FileInputStream(file);
78 79
                            }
                            catch (FileNotFoundException e) {
80 81
                                return null;
                            }
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
                        }
                    });
        }
        catch (Exception e) {
            Log.error(LocaleUtils.getLocalizedString("upgrade.database.failure"), e);
            System.out.println(LocaleUtils.getLocalizedString("upgrade.database.failure"));
        }
        return false;
    }

    /**
     * Checks the plugin's database schema (if one is required) to ensure that it's
     * installed and up to date. If the schema isn't present or up to date, an automatic
     * update will be attempted.
     *
     * @param plugin the plugin.
     * @return true if database schema checked out fine, or was automatically installed
Matt Tucker's avatar
Matt Tucker committed
99 100
     *      or updated successfully, or if it isn't needed. False will only be returned
     *      if there is an error.
101 102 103 104 105 106 107 108
     */
    public boolean checkPluginSchema(final Plugin plugin) {
        final PluginManager pluginManager = XMPPServer.getInstance().getPluginManager();
        String schemaKey = pluginManager.getDatabaseKey(plugin);
        int schemaVersion = pluginManager.getDatabaseVersion(plugin);
        // If the schema key or database version aren't defined, then the plugin doesn't
        // need database tables.
        if (schemaKey == null || schemaVersion == -1) {
Matt Tucker's avatar
Matt Tucker committed
109
            return true;
110 111 112 113 114
        }
        Connection con = null;
        try {
            con = DbConnectionManager.getConnection();
            return checkSchema(con, schemaKey, schemaVersion, new ResourceLoader() {
115 116 117 118 119 120 121 122 123 124 125
                public InputStream loadResource(String resourceName) {
                    File file = new File(pluginManager.getPluginDirectory(plugin) +
                            File.separator + "database", resourceName);
                    try {
                        return new FileInputStream(file);
                    }
                    catch (FileNotFoundException e) {
                        return null;
                    }
                }
            });
126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
        }
        catch (Exception e) {
            Log.error(LocaleUtils.getLocalizedString("upgrade.database.failure"), e);
            System.out.println(LocaleUtils.getLocalizedString("upgrade.database.failure"));
        }
        finally {
            DbConnectionManager.closeConnection(con);
        }
        return false;
    }

    /**
     * Checks to see if the database needs to be upgraded. This method should be
     * called once every time the application starts up.
     *
     * @param con the database connection to use to check the schema with.
     * @param schemaKey the database schema key (name).
     * @param requiredVersion the version that the schema should be at.
     * @param resourceLoader a resource loader that knows how to load schema files.
     * @throws Exception if an error occured.
146
     * @return True if the schema update was successful.
147 148 149 150 151 152
     */
    private boolean checkSchema(Connection con, String schemaKey, int requiredVersion,
            ResourceLoader resourceLoader) throws Exception
    {
        int currentVersion = -1;
        PreparedStatement pstmt = null;
153
        ResultSet rs = null;
154 155 156
        try {
            pstmt = con.prepareStatement(CHECK_VERSION);
            pstmt.setString(1, schemaKey);
157
            rs = pstmt.executeQuery();
158 159 160
            if (rs.next()) {
                currentVersion = rs.getInt(1);
            }
161 162
        }
        catch (SQLException sqle) {
163 164
            // The database schema must not be installed.
            Log.debug("SchemaManager: Error verifying "+schemaKey+" version, probably ignorable.", sqle);
165 166
            DbConnectionManager.closeResultSet(rs);
            DbConnectionManager.closeStatement(pstmt);
167
            if (schemaKey.equals("openfire")) {
168
                try {
169 170 171
                    // Releases of Openfire before 3.6.0 stored the version in a jiveVersion table.
                    pstmt = con.prepareStatement(CHECK_VERSION_JIVE);
                    pstmt.setString(1, schemaKey);
172
                    rs = pstmt.executeQuery();
173 174 175 176
                    if (rs.next()) {
                        currentVersion = rs.getInt(1);
                    }
                }
177
                catch (SQLException sqlea) {
178 179
                    // The database schema must not be installed.
                    Log.debug("SchemaManager: Error verifying "+schemaKey+" version, probably ignorable.", sqlea);
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196
                    DbConnectionManager.closeResultSet(rs);
                    DbConnectionManager.closeStatement(pstmt);
                    // Releases of Openfire before 2.6.0 stored a major and minor version
                    // number so the normal check for version can fail. Check for the
                    // version using the old format in that case.
                    try {
                        if (pstmt != null) {
                            pstmt.close();
                        }
                        pstmt = con.prepareStatement(CHECK_VERSION_OLD);
                        rs = pstmt.executeQuery();
                        if (rs.next()) {
                            currentVersion = rs.getInt(1);
                        }
                    }
                    catch (SQLException sqle2) {
                        // The database schema must not be installed.
197
                        Log.debug("SchemaManager: Error verifying "+schemaKey+" version, probably ignorable", sqle2);
198
                    }
199 200 201 202
                }
            }
        }
        finally {
203 204
            DbConnectionManager.closeResultSet(rs);
            DbConnectionManager.closeStatement(pstmt);
205 206
        }
        // If already up to date, return.
207
        if (currentVersion >= requiredVersion) {
Matt Tucker's avatar
Matt Tucker committed
208
            return true;
209 210 211
        }
        // If the database schema isn't installed at all, we need to install it.
        else if (currentVersion == -1) {
212
            Log.info(LocaleUtils.getLocalizedString("upgrade.database.missing_schema",
213 214 215
                    Arrays.asList(schemaKey)));
            System.out.println(LocaleUtils.getLocalizedString("upgrade.database.missing_schema",
                    Arrays.asList(schemaKey)));
216
            // Resource will be like "/database/openfire_hsqldb.sql"
217 218 219 220 221 222 223
            String resourceName = schemaKey + "_" +
                    DbConnectionManager.getDatabaseType() + ".sql";
            InputStream resource = resourceLoader.loadResource(resourceName);
            if (resource == null) {
                return false;
            }
            try {
224 225
                // For plugins, we will automatically convert jiveVersion to ofVersion
                executeSQLScript(con, resource, !schemaKey.equals("openfire") && !schemaKey.equals("wildfire"));
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263
            }
            catch (Exception e) {
                Log.error(e);
                return false;
            }
            finally {
                try {
                    resource.close();
                }
                catch (Exception e) {
                    // Ignore.
                }
            }
            Log.info(LocaleUtils.getLocalizedString("upgrade.database.success"));
            System.out.println(LocaleUtils.getLocalizedString("upgrade.database.success"));
            return true;
        }
        // Must have a version of the schema that needs to be upgraded.
        else {
            // The database is an old version that needs to be upgraded.
            Log.info(LocaleUtils.getLocalizedString("upgrade.database.old_schema",
                    Arrays.asList(currentVersion, schemaKey, requiredVersion)));
            System.out.println(LocaleUtils.getLocalizedString("upgrade.database.old_schema",
                    Arrays.asList(currentVersion, schemaKey, requiredVersion)));
            // If the database type is unknown, we don't know how to upgrade it.
            if (DbConnectionManager.getDatabaseType() == DbConnectionManager.DatabaseType.unknown) {
                Log.info(LocaleUtils.getLocalizedString("upgrade.database.unknown_db"));
                System.out.println(LocaleUtils.getLocalizedString("upgrade.database.unknown_db"));
                return false;
            }
            // Upgrade scripts for interbase are not maintained.
            else if (DbConnectionManager.getDatabaseType() == DbConnectionManager.DatabaseType.interbase) {
                Log.info(LocaleUtils.getLocalizedString("upgrade.database.interbase_db"));
                System.out.println(LocaleUtils.getLocalizedString("upgrade.database.interbase_db"));
                return false;
            }

            // Run all upgrade scripts until we're up to the latest schema.
264
            for (int i = currentVersion + 1; i <= requiredVersion; i++) {
265
                InputStream resource = getUpgradeResource(resourceLoader, i, schemaKey);
266
                if (resource == null) {
267 268 269
                    continue;
                }
                try {
270
                    executeSQLScript(con, resource, !schemaKey.equals("openfire") && !schemaKey.equals("wildfire"));
271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
                }
                catch (Exception e) {
                    Log.error(e);
                    return false;
                }
                finally {
                    try {
                        resource.close();
                    }
                    catch (Exception e) {
                        // Ignore.
                    }
                }
            }
            Log.info(LocaleUtils.getLocalizedString("upgrade.database.success"));
            System.out.println(LocaleUtils.getLocalizedString("upgrade.database.success"));
            return true;
        }
    }

291
    private InputStream getUpgradeResource(ResourceLoader resourceLoader, int upgradeVersion,
292
            String schemaKey)
293 294
    {
        InputStream resource = null;
295 296
        if ("openfire".equals(schemaKey)) {
            // Resource will be like "/database/upgrade/6/openfire_hsqldb.sql"
297 298 299 300 301 302 303 304 305 306 307 308 309
            String path = JiveGlobals.getHomeDirectory() + File.separator + "resources" +
                    File.separator + "database" + File.separator + "upgrade" + File.separator +
                    upgradeVersion;
            String filename = schemaKey + "_" + DbConnectionManager.getDatabaseType() + ".sql";
            File file = new File(path, filename);
            try {
                resource = new FileInputStream(file);
            }
            catch (FileNotFoundException e) {
                // If the resource is null, the specific upgrade number is not available.
            }
        }
        else {
310
            String resourceName = "upgrade/" + upgradeVersion + "/" + schemaKey + "_" +
311 312 313 314 315 316
                    DbConnectionManager.getDatabaseType() + ".sql";
            resource = resourceLoader.loadResource(resourceName);
        }
        return resource;
    }

317 318 319
    private void updateToOpenfire(Connection con){
        PreparedStatement pstmt = null;
        try {
320
            pstmt = con.prepareStatement("UPDATE jiveVersion SET name='openfire' WHERE name='wildfire'");
321 322 323
            pstmt.executeUpdate();
        }
        catch (Exception ex) {
324 325 326
//            Log.warn("Error when trying to update to new name", ex);
            // This is "scary" to see in the logs and causes more confusion than it's worth at this point.
            // So silently move on.
327 328 329 330 331 332
        }
        finally {
            DbConnectionManager.closeStatement(pstmt);
        }
    }

333 334 335 336 337
    /**
     * Executes a SQL script.
     *
     * @param con database connection.
     * @param resource an input stream for the script to execute.
338
     * @param autoreplace automatically replace jiveVersion with ofVersion
339 340 341
     * @throws IOException if an IOException occurs.
     * @throws SQLException if an SQLException occurs.
     */
342
    private static void executeSQLScript(Connection con, InputStream resource, Boolean autoreplace) throws IOException,
343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358
            SQLException
    {
        BufferedReader in = null;
        try {
            in = new BufferedReader(new InputStreamReader(resource));
            boolean done = false;
            while (!done) {
                StringBuilder command = new StringBuilder();
                while (true) {
                    String line = in.readLine();
                    if (line == null) {
                        done = true;
                        break;
                    }
                    // Ignore comments and blank lines.
                    if (isSQLCommandPart(line)) {
359
                        command.append(" ").append(line);
360
                    }
361
                    if (line.trim().endsWith(";")) {
362 363 364 365 366
                        break;
                    }
                }
                // Send command to database.
                if (!done && !command.toString().equals("")) {
367 368 369
                    // Remove last semicolon when using Oracle or DB2 to prevent "invalid character error"
                    if (DbConnectionManager.getDatabaseType() == DbConnectionManager.DatabaseType.oracle ||
                            DbConnectionManager.getDatabaseType() == DbConnectionManager.DatabaseType.db2) {
370 371
                        command.deleteCharAt(command.length() - 1);
                    }
372
                    try {
373 374 375 376
                        String cmdString = command.toString();
                        if (autoreplace)  {
                            cmdString = cmdString.replaceAll("jiveVersion", "ofVersion");
                        }
377
                        Statement stmt = con.createStatement();
378
                        stmt.execute(cmdString);
379 380 381 382 383 384 385
                        stmt.close();
                    }
                    catch (SQLException e) {
                        // Lets show what failed
                        Log.error("SchemaManager: Failed to execute SQL:\n"+command.toString());
                        throw e;
                    }
386 387 388 389 390 391 392 393 394
                }
            }
        }
        finally {
            if (in != null) {
                try {
                    in.close();
                }
                catch (Exception e) {
395
                    Log.error(e);
396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427
                }
            }
        }
    }

    private static abstract class ResourceLoader {

        public abstract InputStream loadResource(String resourceName);

    }

    /**
     * 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.
     */
    private 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
        return !(line.startsWith("//") || line.startsWith("--") || line.startsWith("#") ||
                line.startsWith("REM") || line.startsWith("/*") || line.startsWith("*"));
    }
}