Skip to content

HBX-3210: Improve the implementation of various 'exporter' classes and their helpers #5758

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 6, 2025
Merged

HBX-3210: Improve the implementation of various 'exporter' classes and their helpers #5758

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
290 changes: 137 additions & 153 deletions orm/src/main/java/org/hibernate/tool/internal/export/cfg/CfgExporter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@
import java.io.PrintWriter;
import java.io.Writer;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Properties;
Expand All @@ -42,162 +41,147 @@
*/
public class CfgExporter extends AbstractExporter {

private Writer output;
private Writer output;
private Properties customProperties = new Properties();

public Properties getCustomProperties() {
return customProperties;
}

public void setCustomProperties(Properties customProperties) {
this.customProperties = customProperties;
}

public Writer getOutput() {
return output;
}

public void setOutput(Writer output) {
this.output = output;
}

/* (non-Javadoc)
* @see org.hibernate.tool.hbm2x.Exporter#finish()
*/
public void doStart() {
PrintWriter pw = null;
File file = null;
try {
if(output==null) {
file = new File(getOutputDirectory(), "hibernate.cfg.xml");
getTemplateHelper().ensureExistence(file);
pw = new PrintWriter(new FileWriter(file) );
getArtifactCollector().addFile(file, "cfg.xml");
}
else {
pw = new PrintWriter(output);

public Properties getCustomProperties() {
return customProperties;
}

public void setCustomProperties(Properties customProperties) {
this.customProperties = customProperties;
}

public Writer getOutput() {
return output;
}

public void setOutput(Writer output) {
this.output = output;
}

/* (non-Javadoc)
* @see org.hibernate.tool.hbm2x.Exporter#finish()
*/
public void doStart() {
PrintWriter pw = null;
File file;
try {
if(output==null) {
file = new File(getOutputDirectory(), "hibernate.cfg.xml");
getTemplateHelper().ensureExistence(file);
pw = new PrintWriter(new FileWriter(file) );
getArtifactCollector().addFile(file, "cfg.xml");
}
else {
pw = new PrintWriter(output);
}


pw.println( """
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE hibernate-configuration PUBLIC\r
"-//Hibernate/Hibernate Configuration DTD 3.0//EN"\r
"https://www.hibernate.org/dtd/hibernate-configuration-3.0.dtd">\r
<hibernate-configuration>""" );

boolean ejb3 = Boolean.parseBoolean( (String) getProperties().get( "ejb3" ) );

Map<Object, Object> props = new TreeMap<>();
if (getProperties() != null) {
props.putAll(getProperties());
}
if(customProperties!=null) {
props.putAll(customProperties);
}

String sfname = (String) props.get(Environment.SESSION_FACTORY_NAME);
pw.println(" <session-factory" + (sfname==null?"":" name=\"" + sfname + "\"") + ">");

Map<Object, Object> ignoredProperties = new HashMap<>();
ignoredProperties.put(Environment.SESSION_FACTORY_NAME, null);
ignoredProperties.put(Environment.HBM2DDL_AUTO, "false" );
ignoredProperties.put("hibernate.temp.use_jdbc_metadata_defaults", null );
ignoredProperties.put(Environment.TRANSACTION_COORDINATOR_STRATEGY, "org.hibernate.console.FakeTransactionManagerLookup");

Set<Entry<Object, Object>> set = props.entrySet();
for ( Entry<Object, Object> element : set ) {
String key = (String) element.getKey();
if ( ignoredProperties.containsKey( key ) ) {
Object ignoredValue = ignoredProperties.get( key );
if ( ignoredValue == null || element.getValue().equals( ignoredValue ) ) {
continue;
}
}
if ( key.startsWith( "hibernate." ) ) { // if not starting with hibernate. not relevant for cfg.xml
pw.println( " <property name=\"" + key + "\">" + forXML(
element.getValue().toString() ) + "</property>" );
}
}

if(getMetadata()!=null) {
for ( PersistentClass element : getMetadata().getEntityBindings() ) {
if ( element instanceof RootClass ) {
dump( pw, ejb3, element );
}
}
}
pw.println(" </session-factory>\r\n" +
"</hibernate-configuration>");

}

catch (IOException e) {
throw new RuntimeException("Problems while creating hibernate.cfg.xml", e);
}
finally {
if(pw!=null) {
pw.flush();
pw.close();
}
}


pw.println("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" +
"<!DOCTYPE hibernate-configuration PUBLIC\r\n" +
" \"-//Hibernate/Hibernate Configuration DTD 3.0//EN\"\r\n" +
" \"http://www.hibernate.org/dtd/hibernate-configuration-3.0.dtd\">\r\n" +
"<hibernate-configuration>");

boolean ejb3 = Boolean.valueOf((String)getProperties().get("ejb3")).booleanValue();

Map<Object, Object> props = new TreeMap<Object, Object>();
if (getProperties() != null) {
props.putAll(getProperties());

}

private void dump(PrintWriter pw, boolean useClass, PersistentClass element) {
if(useClass) {
pw.println("<mapping class=\"" + element.getClassName() + "\"/>");
}
if(customProperties!=null) {
props.putAll(customProperties);
else {
pw.println("<mapping resource=\"" + getMappingFileResource(element) + "\"/>");
}

String sfname = (String) props.get(Environment.SESSION_FACTORY_NAME);
pw.println(" <session-factory" + (sfname==null?"":" name=\"" + sfname + "\"") + ">");

Map<Object, Object> ignoredProperties = new HashMap<Object, Object>();
ignoredProperties.put(Environment.SESSION_FACTORY_NAME, null);
ignoredProperties.put(Environment.HBM2DDL_AUTO, "false" );
ignoredProperties.put("hibernate.temp.use_jdbc_metadata_defaults", null );
ignoredProperties.put(Environment.TRANSACTION_COORDINATOR_STRATEGY, "org.hibernate.console.FakeTransactionManagerLookup");

Set<Entry<Object, Object>> set = props.entrySet();
Iterator<Entry<Object, Object>> iterator = set.iterator();
while (iterator.hasNext() ) {
Entry<Object, Object> element = iterator.next();
String key = (String) element.getKey();
if(ignoredProperties.containsKey( key )) {
Object ignoredValue = ignoredProperties.get( key );
if(ignoredValue == null || element.getValue().equals(ignoredValue)) {
continue;
}
}
if(key.startsWith("hibernate.") ) { // if not starting with hibernate. not relevant for cfg.xml
pw.println(" <property name=\"" + key + "\">" + forXML(element.getValue().toString()) + "</property>");

for ( Subclass value : element.getDirectSubclasses() ) {
dump( pw, useClass, value );
}

}

private String getMappingFileResource(PersistentClass element) {

return element.getClassName().replace('.', '/') + ".hbm.xml";
}

public String getName() {
return "cfg2cfgxml";
}

public static String forXML(String text) {
if (text == null) return null;
final StringBuilder result = new StringBuilder();
char[] chars = text.toCharArray();
for ( char character : chars ) {
if ( character == '<' ) {
result.append( "&lt;" );
}
else if ( character == '>' ) {
result.append( "&gt;" );
}
else {
result.append( character );
}
}

if(getMetadata()!=null) {
Iterator<PersistentClass> classMappings = getMetadata().getEntityBindings().iterator();
while (classMappings.hasNext() ) {
PersistentClass element = classMappings.next();
if(element instanceof RootClass) {
dump(pw, ejb3, element);
}
}
}
pw.println(" </session-factory>\r\n" +
"</hibernate-configuration>");

}

catch (IOException e) {
throw new RuntimeException("Problems while creating hibernate.cfg.xml", e);
}
finally {
if(pw!=null) {
pw.flush();
pw.close();
}
}

}

/**
* @param pw
* @param element
*/
private void dump(PrintWriter pw, boolean useClass, PersistentClass element) {
if(useClass) {
pw.println("<mapping class=\"" + element.getClassName() + "\"/>");
} else {
pw.println("<mapping resource=\"" + getMappingFileResource(element) + "\"/>");
}

Iterator<Subclass> directSubclasses = element.getDirectSubclasses().iterator();
while (directSubclasses.hasNext() ) {
PersistentClass subclass = (PersistentClass)directSubclasses.next();
dump(pw, useClass, subclass);
}

}

/**
* @param element
* @return
*/
private String getMappingFileResource(PersistentClass element) {

return element.getClassName().replace('.', '/') + ".hbm.xml";
}

public String getName() {
return "cfg2cfgxml";
}

/**
*
* @param text
* @return String with escaped [<,>] special characters.
*/
public static String forXML(String text) {
if (text == null) return null;
final StringBuilder result = new StringBuilder();
char[] chars = text.toCharArray();
for (int i = 0; i < chars.length; i++){
char character = chars[i];
if (character == '<') {
result.append("&lt;");
} else if (character == '>'){
result.append("&gt;");
} else {
result.append(character);
}
}
return result.toString();
}

return result.toString();
}

}
Loading