package de.juplo.plugins.hibernate4;
/*
* Copyright 2001-2005 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import com.pyx4j.log4j.MavenLogAppender;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
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.security.NoSuchAlgorithmException;
import java.sql.Connection;
import java.sql.Driver;
import java.sql.DriverManager;
import java.sql.DriverPropertyInfo;
import java.sql.SQLException;
import java.sql.SQLFeatureNotSupportedException;
import java.util.Comparator;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Properties;
import java.util.Set;
import java.util.TreeSet;
import java.util.logging.Logger;
import javax.persistence.Embeddable;
import javax.persistence.Entity;
import javax.persistence.MappedSuperclass;
import org.apache.maven.model.Resource;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.project.MavenProject;
import org.hibernate.cfg.Configuration;
import org.hibernate.cfg.NamingStrategy;
import org.hibernate.envers.configuration.AuditConfiguration;
import org.hibernate.tool.hbm2ddl.SchemaExport;
import org.hibernate.tool.hbm2ddl.SchemaExport.Type;
import org.hibernate.tool.hbm2ddl.Target;
import org.scannotation.AnnotationDB;
/**
* Goal which extracts the hibernate-mapping-configuration and
* exports an according SQL-database-schema.
*
* @goal export
* @phase process-classes
* @threadSafe
* @requiresDependencyResolution runtime
*/
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";
public final static String NAMING_STRATEGY="hibernate.ejb.naming_strategy";
public final static String ENVERS = "hibernate.envers";
private final static String MD5S = "schema.md5s";
/**
* The maven project.
*
* This parameter defaults to the maven build-output-directory for classes.
* Additonally, all dependencies are scanned for annotated classes.
*
* @parameter property="project.build.outputDirectory"
*/
private String outputDirectory;
/**
* Wether to scan test-classes too, or not.
*
* If this parameter is set to true the test-classes of the
* artifact will be scanned for hibernate-annotated classes additionally.
*
* @parameter property="hibernate.export.scan_testclasses" default-value="false"
*/
private boolean scanTestClasses;
/**
* Test-Classes-Directory to scan.
*
* This parameter defaults to the maven build-output-directory for
* test-classes.
*
* This parameter is only used, when scanTestClasses is set
* to true!
*
* @parameter property="project.build.testOutputDirectory"
*/
private String testOutputDirectory;
/**
* Skip execution
*
* If set to true, the execution is skipped.
*
* A skipped excecution is signaled via the maven-property
* ${hibernate.export.skipped}.
*
* The excecution is skipped automatically, if no modified or newly added
* annotated classes are found and the dialect was not changed.
*
* @parameter property="hibernate.export.skip" default-value="false"
*/
private boolean skip;
/**
* Force execution
*
* Force execution, even if no modified or newly added annotated classes
* where found and the dialect was not changed.
*
SCRIPT export schema to SQL-script and print it to STDOUT
*
BOTH
*
*
* A databaseconnection is only needed for EXPORT and BOTH, but a
* Hibernate-Dialect must always be choosen.
*
* @parameter property="hibernate.export.target" default-value="EXPORT"
*/
private String target;
/**
* Type of execution.
*
*
NONE do nothing - just validate the configuration
*
CREATE create database-schema
*
DROP drop database-schema
*
BOTH (DEFAULT!)
*
*
* If NONE is choosen, no databaseconnection is needed.
*
* @parameter property="hibernate.export.type" default-value="BOTH"
*/
private String type;
/**
* Output file.
*
* @parameter property="hibernate.export.schema.filename" default-value="${project.build.directory}/schema.sql"
*/
private String outputFile;
/**
* Delimiter in output-file.
*
* @parameter property="hibernate.export.schema.delimiter" default-value=";"
*/
private String delimiter;
/**
* Format output-file.
*
* @parameter property="hibernate.export.schema.format" default-value="true"
*/
private boolean format;
/**
* Generate envers schema for auditing tables.
*
* @parameter expression="${hibernate.envers}" default-value="false"
*/
private boolean envers;
@Override
public void execute()
throws
MojoFailureException,
MojoExecutionException
{
if (skip)
{
getLog().info("Exectuion of hibernate4-maven-plugin:export was skipped!");
project.getProperties().setProperty(EXPORT_SKIPPED_PROPERTY, "true");
return;
}
Map md5s;
boolean modified = false;
File saved = new File(buildDirectory + File.separator + MD5S);
if (saved.exists())
{
try
{
FileInputStream fis = new FileInputStream(saved);
ObjectInputStream ois = new ObjectInputStream(fis);
md5s = (HashMap)ois.readObject();
ois.close();
}
catch (Exception e)
{
md5s = new HashMap();
getLog().warn("Cannot read timestamps from saved: " + e);
}
}
else
{
md5s = new HashMap();
try
{
saved.createNewFile();
}
catch (IOException e)
{
getLog().debug("Cannot create file \"" + saved.getPath() + "\" for timestamps: " + e);
}
}
ClassLoader classLoader = null;
try
{
getLog().debug("Creating ClassLoader for project-dependencies...");
List classpathFiles = project.getCompileClasspathElements();
if (scanTestClasses)
classpathFiles.addAll(project.getTestClasspathElements());
URL[] urls = new URL[classpathFiles.size()];
for (int i = 0; i < classpathFiles.size(); ++i)
{
getLog().debug("Dependency: " + classpathFiles.get(i));
urls[i] = new File(classpathFiles.get(i)).toURI().toURL();
}
classLoader = new URLClassLoader(urls, getClass().getClassLoader());
}
catch (Exception e)
{
getLog().error("Error while creating ClassLoader!", e);
throw new MojoExecutionException(e.getMessage());
}
Set> classes =
new TreeSet>(
new Comparator>() {
@Override
public int compare(Class> a, Class> b)
{
return a.getName().compareTo(b.getName());
}
}
);
try
{
AnnotationDB db = new AnnotationDB();
File dir = new File(outputDirectory);
if (dir.exists())
{
getLog().info("Scanning directory " + outputDirectory + " for annotated classes...");
URL dirUrl = dir.toURI().toURL();
db.scanArchives(dirUrl);
}
if (scanTestClasses)
{
dir = new File(testOutputDirectory);
if (dir.exists())
{
getLog().info("Scanning directory " + testOutputDirectory + " for annotated classes...");
URL dirUrl = dir.toURI().toURL();
db.scanArchives(dirUrl);
}
}
Set classNames = new HashSet();
if (db.getAnnotationIndex().containsKey(Entity.class.getName()))
classNames.addAll(db.getAnnotationIndex().get(Entity.class.getName()));
if (db.getAnnotationIndex().containsKey(MappedSuperclass.class.getName()))
classNames.addAll(db.getAnnotationIndex().get(MappedSuperclass.class.getName()));
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);
String resourceName = annotatedClass.getName();
resourceName = resourceName.substring(resourceName.lastIndexOf(".") + 1, resourceName.length()) + ".class";
InputStream is =
annotatedClass
.getResourceAsStream(resourceName);
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;
md5s.put(name, newMd5);
}
else
{
getLog().debug(oldMd5 + " -> class unchanged: " + name);
}
}
}
catch (ClassNotFoundException e)
{
getLog().error("Error while adding annotated classes!", e);
throw new MojoExecutionException(e.getMessage());
}
catch (Exception e)
{
getLog().error("Error while scanning!", e);
throw new MojoFailureException(e.getMessage());
}
if (classes.isEmpty())
{
if (hibernateMapping == null || hibernateMapping.isEmpty())
throw new MojoFailureException("No annotated classes found in directory " + outputDirectory);
}
else
{
getLog().debug("Detected classes with mapping-annotations:");
for (Class> annotatedClass : classes)
getLog().debug(" " + annotatedClass.getName());
}
Properties properties = new Properties();
/** Try to read configuration from properties-file */
try
{
File file = new File(hibernateProperties);
if (file.exists())
{
getLog().info("Reading properties from file " + hibernateProperties + "...");
properties.load(new FileInputStream(file));
}
else
getLog().info("No hibernate-properties-file found! (Checked path: " + hibernateProperties + ")");
}
catch (IOException e)
{
getLog().error("Error while reading properties!", e);
throw new MojoExecutionException(e.getMessage());
}
/** Overwrite values from propertie-file or set, if given */
if (driverClassName != null)
{
if (properties.containsKey(DRIVER_CLASS))
getLog().debug(
"Overwriting property " +
DRIVER_CLASS + "=" + properties.getProperty(DRIVER_CLASS) +
" with the value " + driverClassName
);
else
getLog().debug("Using the value " + driverClassName);
properties.setProperty(DRIVER_CLASS, driverClassName);
}
if (url != null)
{
if (properties.containsKey(URL))
getLog().debug(
"Overwriting property " +
URL + "=" + properties.getProperty(URL) +
" with the value " + url
);
else
getLog().debug("Using the value " + url);
properties.setProperty(URL, url);
}
if (username != null)
{
if (properties.containsKey(USERNAME))
getLog().debug(
"Overwriting property " +
USERNAME + "=" + properties.getProperty(USERNAME) +
" with the value " + username
);
else
getLog().debug("Using the value " + username);
properties.setProperty(USERNAME, username);
}
if (password != null)
{
if (properties.containsKey(PASSWORD))
getLog().debug(
"Overwriting property " +
PASSWORD + "=" + properties.getProperty(PASSWORD) +
" with the value " + password
);
else
getLog().debug("Using the value " + password);
properties.setProperty(PASSWORD, password);
}
if (hibernateDialect != null)
{
if (properties.containsKey(DIALECT))
getLog().debug(
"Overwriting property " +
DIALECT + "=" + properties.getProperty(DIALECT) +
" with the value " + hibernateDialect
);
else
getLog().debug("Using the value " + hibernateDialect);
properties.setProperty(DIALECT, hibernateDialect);
}
if ( hibernateNamingStrategy != null )
{
if ( properties.contains(NAMING_STRATEGY))
getLog().debug(
"Overwriting property " +
NAMING_STRATEGY + "=" + properties.getProperty(NAMING_STRATEGY) +
" with the value " + hibernateNamingStrategy
);
else
getLog().debug("Using the value " + hibernateNamingStrategy);
properties.setProperty(NAMING_STRATEGY, hibernateNamingStrategy);
}
if (envers)
{
if (properties.containsKey(ENVERS))
getLog().debug(
"Overwriting property " +
ENVERS + "=" + properties.getProperty(ENVERS) +
" with the value " + envers
);
else
getLog().debug("Using the value " + envers);
properties.setProperty(ENVERS, Boolean.toString(envers));
}
/** 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));
}
/** The generated SQL varies with the envers-configuration */
if (md5s.containsKey(ENVERS))
{
String envers = properties.getProperty(ENVERS);
if (md5s.get(ENVERS).equals(envers))
getLog().debug("Envers unchanged.");
else
{
getLog().debug("Envers changed: " + envers);
modified = true;
md5s.put(ENVERS, envers);
}
}
else
{
modified = true;
md5s.put(ENVERS, properties.getProperty(ENVERS));
}
if (properties.isEmpty())
{
getLog().error("No properties set!");
throw new MojoFailureException("Hibernate-Configuration is missing!");
}
Configuration config = new Configuration();
config.setProperties(properties);
if ( properties.containsKey(NAMING_STRATEGY))
{
String namingStrategy = properties.getProperty(NAMING_STRATEGY);
getLog().debug("Explicitly set NamingStrategy: " + namingStrategy);
try
{
@SuppressWarnings("unchecked")
Class namingStrategyClass = (Class) Class.forName(namingStrategy);
config.setNamingStrategy(namingStrategyClass.newInstance());
}
catch (Exception e)
{
getLog().error("Error setting NamingStrategy", e);
throw new MojoExecutionException(e.getMessage());
}
}
getLog().debug("Adding annotated classes to hibernate-mapping-configuration...");
for (Class> annotatedClass : classes)
{
getLog().debug("Class " + annotatedClass);
config.addAnnotatedClass(annotatedClass);
}
if (hibernateMapping != null)
{
try
{
MessageDigest digest = java.security.MessageDigest.getInstance("MD5");
for (String filename : hibernateMapping.split("[\\s,]+"))
{
// First try the filename as absolute/relative path
File file = new File(filename);
if (!file.exists())
{
// If the file was not found, search for it in the resource-directories
for (Resource resource : project.getResources())
{
file = new File(resource.getDirectory() + File.separator + filename);
if (file.exists())
break;
}
}
if (file != null && file.exists())
{
InputStream is = new FileInputStream(file);
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(filename) ? "" : md5s.get(filename);
if (!newMd5.equals(oldMd5))
{
getLog().debug("Found new or modified mapping-file: " + filename);
modified = true;
md5s.put(filename, newMd5);
}
else
{
getLog().debug(oldMd5 + " -> mapping-file unchanged: " + filename);
}
getLog().debug("Adding mappings from XML-configurationfile: " + file);
config.addFile(file);
}
else
throw new MojoFailureException("File " + filename + " could not be found in any of the configured resource-directories!");
}
}
catch (NoSuchAlgorithmException e)
{
throw new MojoFailureException("Cannot calculate MD5-summs!", e);
}
catch (FileNotFoundException e)
{
throw new MojoFailureException("Cannot calculate MD5-summs!", e);
}
catch (IOException e)
{
throw new MojoFailureException("Cannot calculate MD5-summs!", e);
}
}
Target target = null;
try
{
target = Target.valueOf(this.target.toUpperCase());
}
catch (IllegalArgumentException e)
{
getLog().error("Invalid value for configuration-option \"target\": " + this.target);
getLog().error("Valid values are: NONE, SCRIPT, EXPORT, BOTH");
throw new MojoExecutionException("Invalid value for configuration-option \"target\"");
}
Type type = null;
try
{
type = Type.valueOf(this.type.toUpperCase());
}
catch (IllegalArgumentException e)
{
getLog().error("Invalid value for configuration-option \"type\": " + this.type);
getLog().error("Valid values are: NONE, CREATE, DROP, BOTH");
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)
&& !force
)
{
getLog().info("No modified annotated classes or mapping-files 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