// Version: $Id: $

 // Copyright: Copyright(c) 2007 Trace Financial Limited

 package org.liquibase.maven.plugins;

 import java.io.*;

 import liquibase.resource.ResourceAccessor;

 import liquibase.Liquibase;

 import liquibase.database.Database;

 import liquibase.exception.LiquibaseException;

 import org.apache.maven.plugin.MojoExecutionException;

 import org.apache.maven.plugin.MojoFailureException;

 /**

  * Creates an SQL migration script using the provided DatabaseChangeLog(s) comparing what already exists in the database

  * to what is defined in the DataBaseChangeLog(s).

  * 

  * @author Peter Murray

  * @description Liquibase Migrate SQL Maven plugin

  * @goal migrateSQL

  * @deprecated Use {@link LiquibaseUpdateSQL} or Maven goal "updateSQL" instead.

  */

 public class LiquibaseMigrateSQL extends AbstractLiquibaseUpdateMojo {

     /**

      * The file to output the Migration SQL script to, if it exists it will be overwritten.

      * 

      * @parameter expression="${liquibase.migrationSqlOutputFile}"

      *            default-value="${project.build.directory}/liquibase/migrate.sql"

      */

     protected File migrationSqlOutputFile;

     /** The writer fro writing the migration SQL. */

     private Writer outputWriter;

     @Override

     public void configureFieldsAndValues(ResourceAccessor fo) throws MojoExecutionException, MojoFailureException {

         getLog().warn(

                 "This plugin goal is DEPRICATED and will bre removed in a future "

                         + "release, please use \"updateSQL\" instead of \"migrateSQL\".");

         super.configureFieldsAndValues(fo);

     }

     @Override

     protected boolean isPromptOnNonLocalDatabase() {

         // Always run on an non-local database as we are not actually modifying the database

         // when run on it.

         return false;

     }

     @Override

     protected void doUpdate(Liquibase liquibase) throws LiquibaseException {

         if (changesToApply > 0) {

             liquibase.update(changesToApply, contexts, outputWriter);

         } else {

             liquibase.update(contexts, outputWriter);

         }

     }

     @Override

     protected Liquibase createLiquibase(ResourceAccessor fo, Database db) throws MojoExecutionException {

         Liquibase liquibase = super.createLiquibase(fo, db);

         // Setup the output file writer

         try {

             if (!migrationSqlOutputFile.exists()) {

                 // Ensure the parent directories exist

                 migrationSqlOutputFile.getParentFile().mkdirs();

                 // Create the actual file

                 if (!migrationSqlOutputFile.createNewFile()) {

                     throw new MojoExecutionException("Cannot create the migration SQL file; "

                             + migrationSqlOutputFile.getAbsolutePath());

                 }

             }

             outputWriter = new FileWriter(migrationSqlOutputFile);

         } catch (IOException e) {

             getLog().error(e);

             throw new MojoExecutionException("Failed to create SQL output writer", e);

         }

         getLog().info("Output SQL Migration File: " + migrationSqlOutputFile.getAbsolutePath());

         return liquibase;

     }

     @Override

     protected void printSettings(String indent) {

         super.printSettings(indent);

         getLog().info(indent + "migrationSQLOutputFile: " + migrationSqlOutputFile);

     }

     @Override

     protected void cleanup(Database db) {

         super.cleanup(db);

         if (outputWriter != null) {

             try {

                 outputWriter.close();

             } catch (IOException e) {

                 getLog().error(e);

             }

         }

     }

 }