Plugin ignores upper- or lower-case mismatches for "type" and "target"
[hibernate4-maven-plugin] / src / main / java / de / juplo / plugins / hibernate4 / Hbm2DdlMojo.java
index 8db0fd6..a2306ac 100644 (file)
@@ -21,10 +21,13 @@ import java.io.File;
 import java.io.FileInputStream;
 import java.io.FileOutputStream;
 import java.io.IOException;
+import java.io.InputStream;
 import java.io.ObjectInputStream;
 import java.io.ObjectOutputStream;
+import java.math.BigInteger;
 import java.net.URL;
 import java.net.URLClassLoader;
+import java.security.MessageDigest;
 import java.sql.Connection;
 import java.sql.Driver;
 import java.sql.DriverManager;
@@ -67,16 +70,18 @@ import org.scannotation.AnnotationDB;
  */
 public class Hbm2DdlMojo extends AbstractMojo
 {
+  public final static String EXPORT_SKIPPED_PROPERTY = "hibernate.export.skipped";
+
   public final static String DRIVER_CLASS = "hibernate.connection.driver_class";
   public final static String URL = "hibernate.connection.url";
   public final static String USERNAME = "hibernate.connection.username";
   public final static String PASSWORD = "hibernate.connection.password";
   public final static String DIALECT = "hibernate.dialect";
 
-  private final static String TIMESTAMPS = "schema.timestamp";
+  private final static String MD5S = "schema.md5s";
 
   /**
-   * The project whose project files to create.
+   * The maven project.
    *
    * @parameter expression="${project}"
    * @required
@@ -85,7 +90,14 @@ public class Hbm2DdlMojo extends AbstractMojo
   private MavenProject project;
 
   /**
-   * Directories to scan.
+   * Build-directory.
+   *
+   * @parameter expression="${project.build.directory}"
+   */
+  private String buildDirectory;
+
+  /**
+   * Class-directory to scan.
    *
    * @parameter expression="${project.build.outputDirectory}"
    */
@@ -94,7 +106,7 @@ public class Hbm2DdlMojo extends AbstractMojo
   /**
    * Skip execution
    *
-   * @parameter expression="${maven.test.skip}"
+   * @parameter expression="${maven.test.skip}" default-value="false"
    */
   private boolean skip;
 
@@ -134,7 +146,7 @@ public class Hbm2DdlMojo extends AbstractMojo
   private String hibernateDialect;
 
   /**
-   * Hibernate configuration file.
+   * Path to Hibernate configuration file.
    *
    * @parameter default-value="${project.build.outputDirectory}/hibernate.properties"
    */
@@ -148,7 +160,7 @@ public class Hbm2DdlMojo extends AbstractMojo
    *   <li><strong>SCRIPT</strong> export schema to SQL-script</li>
    *   <li><strong>BOTH</strong></li>
    * </ul>
-   * @parameter default-value="EXPORT"
+   * @parameter expression="${hibernate.export.target}" default-value="EXPORT"
    */
   private String target;
 
@@ -160,28 +172,28 @@ public class Hbm2DdlMojo extends AbstractMojo
    *   <li><strong>DROP</strong> drop database-schema</li>
    *   <li><strong>BOTH</strong> <strong>(DEFAULT!)</strong></li>
    * </ul>
-   * @parameter default-value="BOTH"
+   * @parameter expression="${hibernate.export.type}" default-value="BOTH"
    */
   private String type;
 
   /**
    * Output file.
    *
-   * @parameter default-value="${project.build.outputDirectory}/schema.sql"
+   * @parameter expression="${hibernate.export.schema.filename}" default-value="${project.build.directory}/schema.sql"
    */
   private String outputFile;
 
   /**
    * Delimiter in output-file.
    *
-   * @parameter default-value=";"
+   * @parameter expression="${hibernate.export.schema.delimiter}" default-value=";"
    */
   private String delimiter;
 
   /**
    * Format output-file.
    *
-   * @parameter default-value="true"
+   * @parameter expression="${hibernate.export.schema.format}" default-value="true"
    */
   private boolean format;
 
@@ -195,6 +207,7 @@ public class Hbm2DdlMojo extends AbstractMojo
     if (skip)
     {
       getLog().info("Exectuion of hibernate4-maven-plugin:export was skipped!");
+      project.getProperties().setProperty(EXPORT_SKIPPED_PROPERTY, "true");
       return;
     }
 
@@ -202,9 +215,9 @@ public class Hbm2DdlMojo extends AbstractMojo
     if (!dir.exists())
       throw new MojoExecutionException("Cannot scan for annotated classes in " + outputDirectory + ": directory does not exist!");
 
-    Map<String,Long> timestamps;
+    Map<String,String> md5s;
     boolean modified = false;
-    File saved = new File(outputDirectory + File.separator + TIMESTAMPS);
+    File saved = new File(buildDirectory + File.separator + MD5S);
 
     if (saved.exists())
     {
@@ -212,18 +225,18 @@ public class Hbm2DdlMojo extends AbstractMojo
       {
         FileInputStream fis = new FileInputStream(saved);
         ObjectInputStream ois = new ObjectInputStream(fis);
-        timestamps = (HashMap<String,Long>)ois.readObject();
+        md5s = (HashMap<String,String>)ois.readObject();
         ois.close();
       }
       catch (Exception e)
       {
-        timestamps = new HashMap<String,Long>();
+        md5s = new HashMap<String,String>();
         getLog().warn("Cannot read timestamps from saved: " + e);
       }
     }
     else
     {
-      timestamps = new HashMap<String,Long>();
+      md5s = new HashMap<String,String>();
       try
       {
         saved.createNewFile();
@@ -279,19 +292,32 @@ public class Hbm2DdlMojo extends AbstractMojo
       if (db.getAnnotationIndex().containsKey(Embeddable.class.getName()))
         classNames.addAll(db.getAnnotationIndex().get(Embeddable.class.getName()));
 
+      MessageDigest digest = java.security.MessageDigest.getInstance("MD5");
       for (String name : classNames)
       {
         Class<?> annotatedClass = classLoader.loadClass(name);
         classes.add(annotatedClass);
-        URL classUrl = annotatedClass.getResource(annotatedClass.getSimpleName() + ".class");
-        File classFile = new File(classUrl.toURI());
-        long lastModified = classFile.lastModified();
-        long timestamp = !timestamps.containsKey(name) ? 0 : timestamps.get(name);
-        if (lastModified > timestamp)
+        InputStream is =
+            annotatedClass
+                .getResourceAsStream(annotatedClass.getSimpleName() + ".class");
+        byte[] buffer = new byte[1024*4]; // copy data in 4MB-chunks
+        int i;
+        while((i = is.read(buffer)) > -1)
+          digest.update(buffer, 0, i);
+        is.close();
+        byte[] bytes = digest.digest();
+        BigInteger bi = new BigInteger(1, bytes);
+        String newMd5 = String.format("%0" + (bytes.length << 1) + "x", bi);
+        String oldMd5 = !md5s.containsKey(name) ? "" : md5s.get(name);
+        if (!newMd5.equals(oldMd5))
         {
           getLog().debug("Found new or modified annotated class: " + name);
           modified = true;
-          timestamps.put(name, lastModified);
+          md5s.put(name, newMd5);
+        }
+        else
+        {
+          getLog().debug(oldMd5 + " -> class unchanged: " + name);
         }
       }
     }
@@ -309,14 +335,6 @@ public class Hbm2DdlMojo extends AbstractMojo
     if (classes.isEmpty())
       throw new MojoFailureException("No annotated classes found in directory " + outputDirectory);
 
-    if (!modified)
-    {
-      getLog().info("No modified annotated classes found.");
-      getLog().info("Skipping schema generation!");
-      project.getProperties().setProperty("hibernate4.skipped", "true");
-      return;
-    }
-
     getLog().debug("Detected classes with mapping-annotations:");
     for (Class<?> annotatedClass : classes)
       getLog().debug("  " + annotatedClass.getName());
@@ -424,14 +442,30 @@ public class Hbm2DdlMojo extends AbstractMojo
       properties.setProperty(DIALECT, hibernateDialect);
     }
 
-    getLog().info("Gathered hibernate-configuration (turn on debugging for details):");
+    /** The generated SQL varies with the dialect! */
+    if (md5s.containsKey(DIALECT))
+    {
+      String dialect = properties.getProperty(DIALECT);
+      if (md5s.get(DIALECT).equals(dialect))
+        getLog().debug("SQL-dialect unchanged.");
+      else
+      {
+        getLog().debug("SQL-dialect changed: " + dialect);
+        modified = true;
+        md5s.put(DIALECT, dialect);
+      }
+    }
+    else
+    {
+      modified = true;
+      md5s.put(DIALECT, properties.getProperty(DIALECT));
+    }
+
     if (properties.isEmpty())
     {
       getLog().error("No properties set!");
       throw new MojoFailureException("Hibernate-Configuration is missing!");
     }
-    for (Entry<Object,Object> entry : properties.entrySet())
-      getLog().info("  " + entry.getKey() + " = " + entry.getValue());
 
     Configuration config = new Configuration();
     config.setProperties(properties);
@@ -445,7 +479,7 @@ public class Hbm2DdlMojo extends AbstractMojo
     Target target = null;
     try
     {
-      target = Target.valueOf(this.target);
+      target = Target.valueOf(this.target.toUpperCase());
     }
     catch (IllegalArgumentException e)
     {
@@ -456,7 +490,7 @@ public class Hbm2DdlMojo extends AbstractMojo
     Type type = null;
     try
     {
-      type = Type.valueOf(this.type);
+      type = Type.valueOf(this.type.toUpperCase());
     }
     catch (IllegalArgumentException e)
     {
@@ -465,6 +499,26 @@ public class Hbm2DdlMojo extends AbstractMojo
       throw new MojoExecutionException("Invalid value for configuration-option \"type\"");
     }
 
+    if (target.equals(Target.SCRIPT) || target.equals(Target.NONE))
+    {
+      project.getProperties().setProperty(EXPORT_SKIPPED_PROPERTY, "true");
+    }
+    if (
+        !modified
+        && !target.equals(Target.SCRIPT)
+        && !target.equals(Target.NONE)
+      )
+    {
+      getLog().info("No modified annotated classes found and dialect unchanged.");
+      getLog().info("Skipping schema generation!");
+      project.getProperties().setProperty(EXPORT_SKIPPED_PROPERTY, "true");
+      return;
+    }
+
+    getLog().info("Gathered hibernate-configuration (turn on debugging for details):");
+    for (Entry<Object,Object> entry : properties.entrySet())
+      getLog().info("  " + entry.getKey() + " = " + entry.getValue());
+
     Connection connection = null;
     try
     {
@@ -544,18 +598,18 @@ public class Hbm2DdlMojo extends AbstractMojo
       }
     }
 
-    /** Write timestamps for annotated classes to file */
+    /** Write md5-sums for annotated classes to file */
     try
     {
       FileOutputStream fos = new FileOutputStream(saved);
       ObjectOutputStream oos = new ObjectOutputStream(fos);
-      oos.writeObject(timestamps);
+      oos.writeObject(md5s);
       oos.close();
       fos.close();
     }
     catch (Exception e)
     {
-      getLog().error("Cannot write timestamps to file: " + e);
+      getLog().error("Cannot write md5-sums to file: " + e);
     }
   }
 
@@ -563,7 +617,7 @@ public class Hbm2DdlMojo extends AbstractMojo
    * Needed, because DriverManager won't pick up drivers, that were not
    * loaded by the system-classloader!
    * See:
-   * http://stackoverflow.com/questions/288828/how-to-use-a-jdbc-driver-from-an-arbitrary-location
+   * http://stackoverflow.com/questions/288828/how-to-use-a-jdbc-driver-fromodifiedm-an-arbitrary-location
    */
   static final class DriverProxy implements Driver
   {