/*

  * Copyright (c) 2004 International Decision Systems, Inc.  All Rights Reserved.

  *

  * By using this Software, You acknowledge that the Software is a valuable asset

  * and trade secret of either International Decision Systems, Inc. ("IDSI") or a

  * third party supplier of IDSI and constitutes confidential and proprietary

  * information.

  *

  * NEITHER IDSI NOR ANY AGENT OR PERSON ACTING FOR OR WITH IDSI HAS MADE OR DOES

  * MAKE ANY STATEMENTS, AFFIRMATIONS, REPRESENTATIONS OR WARRANTIES WHATSOEVER

  * TO YOU, WHETHER EXPRESS OR IMPLIED, AS TO THE SOFTWARE, THE QUALITY OR

  * CONDITION OF THE SOFTWARE, OR THE OPERATING CHARACTERISTICS OR RELIABILITY OF

  * THE SOFTWARE, OR ITS SUITABILITY FOR ANY GENERAL OR PARTICULAR PURPOSE, OR AS

  * TO ANY OTHER MATTER WHATSOEVER; ANY AND ALL OTHER WARRANTIES INCLUDING

  * WITHOUT LIMITATION ANY WARRANTIES IMPLIED BY LAW, SUCH AS THE IMPLIED

  * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND TITLE,

  * USE AND NON-INFRINGEMENT; ARE HEREBY EXPRESSLY DISCLAIMED AND EXCLUDED.

 */

 package net.sourceforge.addam.ddlrun;

 import javax.naming.InitialContext;

 import javax.servlet.ServletContext;

 import javax.servlet.ServletContextEvent;

 import javax.servlet.ServletContextListener;

 import javax.sql.DataSource;

 import net.sourceforge.addam.ddlrun.custom.IDSCompletedScriptRetriever;

 import net.sourceforge.addam.ddlrun.custom.IDSRunLogger;

 import net.sourceforge.addam.ddlrun.custom.IDSStartFolderRetriever;

 import net.sourceforge.addam.ddlrun.grammars.ScriptGrammar;

 import net.sourceforge.addam.ddlrun.grammars.ScriptGrammarManager;

 import net.sourceforge.addam.ddlrun.runners.DeploymentRunner;

 import net.sourceforge.addam.ddlrun.runners.DeploymentRunnerFactory;

 import net.sourceforge.addam.ddlrun.utils.ClassLoaderReaderFactory;

 import net.sourceforge.addam.ddlrun.utils.ResourceReaderFactory;

 import net.sourceforge.addam.ddlrun.utils.RunLogger;

 import java.io.File;

 import java.io.FileWriter;

 import java.io.IOException;

 import java.sql.Connection;

 import java.sql.SQLException;

 import java.text.MessageFormat;

 import java.util.ArrayList;

 import java.util.Date;

 import java.util.Properties;

 import java.util.regex.Matcher;

 import java.util.regex.Pattern;

 /**

  * @author TIM3

  * @since Mar 25, 2005

  */

 public class ServletContainerUpgrader implements ServletContextListener, RunLogger {

     ServletContext sCtx = null;

     FileWriter errorLog = null;

     private int scriptsExecuted = 0;

     protected String dbversion = null;

     /**

      * kicks off an UpgradeRunner - requires a configured DataSource and a

      * configured upgrade folder and upgrade script

      */

     public void contextInitialized(final ServletContextEvent event) {

         sCtx = event.getServletContext();

         errorLog = getErrorLogFileWriter(sCtx);

         Connection connection = null;

         try {

             InitialContext iCtx = new InitialContext();

             DataSource dataSource = null;

             try {

                 dataSource = (DataSource) iCtx.lookup("java:comp/env/jdbc/AutoUpgradeDS");

             } catch (Exception e) {

                 // autoupgrade data source not configured

                 String logMessage = "unable to locate DataSource, skipping autoupgrade";

                 log(sCtx, logMessage, errorLog, null);

                 return;

             }

             try {

                 connection = dataSource.getConnection();

                 if (connection != null) {

                     // needed due to weblogic bug

                     connection.setAutoCommit(false);

                 }

             } catch (Exception e) {

                 // data source not configured correctly

                 String logMessage = "unable to create connection, skipping autoupgrade";

                 log(sCtx, logMessage, errorLog, e);

                 return;

             }

             ScriptGrammar grammar = new ScriptGrammarManager().getGrammar(connection);

             ResourceReaderFactory factory = new ClassLoaderReaderFactory("database/upgrade/" + grammar.name());

             if (grammar == null) {

                 String logMessage = "" + connection + " does not use a supported database driver";

                 log(sCtx, logMessage, errorLog, null);

                 throw new RuntimeException(logMessage);

             }

             DeploymentRunner runner = DeploymentRunnerFactory.getInstance().getUpgradeRunner(factory,

                     connection,

                     grammar,

                     new IDSStartFolderRetriever(connection),

                     new IDSCompletedScriptRetriever(connection));

             runner.addRunLogger(new IDSRunLogger(connection, dbversion));

             runner.addRunLogger(this);

             runner.run("upgrade.drv");

             if (scriptsExecuted == 0) {

                 log(sCtx, "no upgrades necessary", errorLog, null);

             } else {

                 log(sCtx, "executed " + scriptsExecuted + " scripts", errorLog, null);

             }

         } catch (Exception e) {

             if (errorLog != null) {

                 try {

                     String logMessage = "unable to execute upgrade: " + e.getMessage();

                     log(sCtx, logMessage, errorLog, null);

                 } catch (IOException ignored) {

                     // what are you gonna do... can't log the first error, can't log this one

                 }

             }

             throw new RuntimeException(e);

         } finally {

             if (connection != null) {

                 try {

                     connection.close();

                 } catch (SQLException e) {

                     // ignore

                 }

             }

             if (errorLog != null) {

                 try {

                     errorLog.close();

                 } catch (IOException e) {

                     // ignore

                 }

             }

         }

     }

     public void logRunScript(String script, long time) throws Exception {

         String logMessage = "executed " + script + " (" + time + "ms)";

         log(sCtx, logMessage, errorLog, null);

         scriptsExecuted++;

     }

     public void logRunComplete(String group, long time) throws Exception {

         String logMessage = "completed execution of available scripts in " + group + " (" + time + "ms)";

         log(sCtx, logMessage, errorLog, null);

     }

     public void logRunFailure(String group, String script, Exception e) throws Exception {

         String logMessage = "failed to execute " + group + "/" + script;

         log(sCtx, logMessage, errorLog, e);

         throw new RuntimeException(logMessage, e);

     }

     private void log(final ServletContext sCtx, String message, final FileWriter errorLog, Exception e) throws IOException {

         Throwable t = (e == null) ? null : e.fillInStackTrace();

         if (t != null) {

             sCtx.log(message, t);

         } else {

             sCtx.log(message);

         }

         if (errorLog != null) {

             if (t != null) {

                 errorLog.write(message + "\n" + t.toString() + "\n");

             } else {

                 errorLog.write(message + "\n");

             }

             errorLog.flush();

         }

     }

     /**

      * 

      * @param sCtx

      * @return

      * @todo defer creation of file until actual writing error

      */

     private FileWriter getErrorLogFileWriter(ServletContext sCtx) {

         FileWriter errorLog = null;

         String errorLogFormat = sCtx.getInitParameter("error.log");

         if (errorLogFormat == null) {

             sCtx.log("dbupgrade log file undefined, using servlet context log only");

         } else {

             try {  // todo defer creation of file until actual writing error

                 String fileName = PropertiesMessageFormat.format(errorLogFormat, System.getProperties());

                 File file = new File(fileName);

                 file.getParentFile().mkdirs();

                 errorLog = new FileWriter(file, true); //append

             } catch (Exception e) {

                 sCtx.log("unable to create log file from " + errorLogFormat, e);

             }

         }

         return errorLog;

     }

     /**

      * does nothing; required for ServletContextListener implementation

      */

     public void contextDestroyed(ServletContextEvent event) {

     }

     static class PropertiesMessageFormat {

         static String format(String format, Properties properties) {

             Pattern p = Pattern.compile("\\{([^\\{\\}\\,]*)[\\}|\\,]");

             Matcher m = p.matcher(format);

             StringBuffer buf = new StringBuffer();

             ArrayList args = new ArrayList();

             while (m.find()) {

                 int location = args.size(); // MessageFormat is zero-based so start here

                 String match = m.group(0);

                 String variable = m.group(1);

                 String replacement = "{" + location + (match.endsWith(",") ? "," : "}");

                 args.add(getReplacement(variable, properties));

                 m.appendReplacement(buf, replacement);

             }

             m.appendTail(buf);

             return MessageFormat.format(buf.toString(), args.toArray());

         }

         static Object getReplacement(String variable, Properties properties) {

             Object replacement = properties.getProperty(variable);

             if (replacement == null) {

                 if (variable.equals("current.time")) {

                     replacement = new Date();

                 } else {

                     replacement = "{" + variable + "}";

                 }

             }

             return replacement;

         }

     }

 }