/*
* JBoss, Home of Professional Open Source.
* Copyright 2008, Red Hat Middleware LLC, and individual contributors
* as indicated by the @author tags. See the copyright.txt file in the
* distribution for a full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.varia.deployment.convertor;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileFilter;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.InputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.util.Properties;
import org.jboss.logging.Logger;
/**
* JarTransformer is used to transform passed in jar file.
* Transformation algorithm:
* 1. open JarInputStream on passed in Jar file,
* open JarOutputStream for result;
* 2. read next Jar entry;
* 3. check whether Jar entry is an XML file
* - if it's not, copy Jar entry to result and go to step 2.
* 4. check whether there is an XSL file with name equal to XML file's
* in classpath.
* - if there isn't, copy Jar entry to result and go to step 2.
* 5. check whether there is a properties file with the name equal to
* XML file's name + "-output.properties"
* 6. set needed xsl parameters
* 7. transform Jar entry with xsl template and output properties
* (if were found)
* 8. check whether there is a property "newname" in output properties
* - if there is, write transformed entry to result with the value
* of "newname";
* - otherwise write transformed entry to result with the original
* Jar entry name
*
* @author <a href="mailto:aloubyansky@hotmail.com">Alex Loubyansky</a>
*/
public class JarTransformer
{
// Attributes --------------------------------------------------------
private static Logger log = Logger.getLogger(JarTransformer.class);
// Public static methods ---------------------------------------------
/**
* Applies transformations to xml sources for passed in jar file
*/
public static void transform(File root, Properties globalXslParams)
throws Exception
{
// local xsl params
Properties xslParams = new Properties( globalXslParams );
File metaInf = new File(root, "META-INF");
if(!metaInf.exists())
{
return;
//throw new Exception("No META-INF directory found");
}
// set path to ejb-jar.xml in xslParams
File ejbjar = new File(metaInf, "ejb-jar.xml");
if(ejbjar.exists())
xslParams.setProperty("ejb-jar", ejbjar.getAbsolutePath());
// list only xml files.
// Note: returns null only if the path name isn't a directory
// or I/O exception occured
File[] files = metaInf.listFiles(
new FileFilter()
{
public boolean accept(File file)
{
if( file.getName().endsWith( ".xml" )
&& !file.isDirectory() )
return true;
return false;
}
}
);
log.debug("list XML files: " + java.util.Arrays.asList(files));
for(int i = 0; i < files.length; i++)
{
File file = files[i];
// construct names for transformation resources
String xmlName = file.getName();
String xslName = xslParams.getProperty("resources_path")
+ xmlName.substring(0, xmlName.length() - 3)
+ "xsl";
String propsName = xslParams.getProperty("resources_path")
+ xmlName.substring(0, xmlName.length() - 4)
+ "-output.properties";
// try to find XSL template and open InputStream on it
InputStream templateIs = null;
try
{
templateIs = JarTransformer.class.getClassLoader().
getResource(xslName).openStream();
}
catch( Exception e )
{
log.debug("xsl template wasn't found for '" + xmlName + "'");
continue;
}
log.debug("Attempt to transform '" + xmlName + "' with '" + xslName + "'");
// try to load output properties
Properties outputProps = loadProperties( propsName );
// transform Jar entry and write transformed data to result
InputStream input = null;
OutputStream output = null;
try
{
// transformation closes the input stream, so read entry to byte[]
input = new FileInputStream(file);
byte[] bytes = readBytes(input);
input.close();
bytes = transformBytes(bytes, templateIs, outputProps, xslParams);
// Determine the new name for the transformed entry
String entryname = null;
if(outputProps != null)
entryname = outputProps.getProperty("newname");
if(entryname == null)
entryname = file.getName();
output = new FileOutputStream(new File(root, entryname));
writeBytes( output, bytes );
log.debug("Entry '" + file.getName() + "' transformed to '" + entryname + "'");
}
catch(Exception e)
{
log.debug("Exception while transforming entry '" + file.getName(), e);
}
finally
{
if(templateIs != null)
try{ templateIs.close(); } catch(Exception e) {}
if(input != null)
try{ input.close(); } catch(Exception e) {}
if(output != null)
try{ output.close(); } catch(Exception e) {}
}
}
}
// Private static methods ------------------------------------------
/**
* Searches for, loads and returns properties from file
* <code>propsName</code>
*/
private static Properties loadProperties( String propsName )
{
Properties props = new Properties();
InputStream propsIs = null;
try
{
propsIs = JarTransformer.class.getClassLoader().
getResource(propsName).openStream();
props.load(propsIs);
log.debug("Loaded properties '" + propsName + "'");
}
catch(Exception e)
{
log.debug("Couldn't find properties '" + propsName + "'");
}
finally
{
if(propsIs != null)
try{ propsIs.close(); } catch(Exception e) {}
}
return props;
}
/**
* Returns byte array that is the result of transformation of
* the passed in byte array with xsl template and output properties
*/
private static byte[] transformBytes(byte[] bytes,
InputStream xslIs,
Properties outputprops)
throws Exception
{
ByteArrayInputStream bais = new ByteArrayInputStream(bytes);
ByteArrayOutputStream baos = new ByteArrayOutputStream(2048);
try
{
XslTransformer.applyTransformation(bais, baos, xslIs, outputprops);
}
finally
{
if(bais != null)
try{ bais.close(); } catch(Exception e) {}
if(baos != null)
try{ baos.close(); } catch(Exception e) {}
}
return baos.toByteArray();
}
/**
* Returns byte array that is the result of transformation of
* the passed in byte array with xsl template, output properties
* and xsl parameters
*/
private static byte[] transformBytes( byte[] bytes,
InputStream xslIs,
Properties outputProps,
Properties xslParams )
throws Exception
{
ByteArrayInputStream bais = new ByteArrayInputStream(bytes);
ByteArrayOutputStream baos = new ByteArrayOutputStream(2048);
try
{
XslTransformer.applyTransformation(
bais, baos, xslIs, outputProps, xslParams );
}
finally
{
if(bais != null)
try{ bais.close(); } catch(Exception e) {}
if(baos != null)
try{ baos.close(); } catch(Exception e) {}
}
return baos.toByteArray();
}
/**
* Writes byte array to OutputStream.
*/
private static void writeBytes(OutputStream os, byte[] bytes)
throws Exception
{
os.write(bytes, 0, bytes.length);
os.flush();
}
/**
* Copies bytes from InputStream to OutputStream.
* Returns the number of bytes copied.
*/
private static int copyBytes(InputStream is, OutputStream os)
throws Exception
{
byte[] buffer = readBytes(is);
os.write(buffer, 0, buffer.length);
os.flush();
return buffer.length;
}
/**
* Returns byte array read from InputStream
*/
private static byte[] readBytes(InputStream is)
throws IOException
{
byte[] buffer = new byte[ 8192 ];
ByteArrayOutputStream baos = new ByteArrayOutputStream( 2048 );
int n;
baos.reset();
try
{
while((n = is.read(buffer, 0, buffer.length)) != -1)
baos.write(buffer, 0, n);
buffer = baos.toByteArray();
}
finally
{
if(baos != null)
try{ baos.close(); } catch(Exception e) {}
}
return buffer;
}
}