net.sourceforge.pldoc.PLDoc Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pldoc Show documentation
Show all versions of pldoc Show documentation
Documentation tool for PLSQL
/* Copyright (C) 2002 Albert Tumanov
This library 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 library 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 library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package net.sourceforge.pldoc;
import java.io.*;
import java.util.*;
import java.text.DateFormat;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.Transformer;
import javax.xml.transform.URIResolver;
import javax.xml.transform.stream.StreamSource;
import javax.xml.transform.stream.StreamResult;
import javax.xml.transform.dom.DOMResult;
import net.sourceforge.pldoc.parser.PLSQLParser;
import net.sourceforge.pldoc.parser.ParseException;
import net.sourceforge.pldoc.DbmsMetadata;
import org.w3c.dom.Document;
import org.w3c.dom.NodeList;
import org.w3c.dom.Node;
import org.w3c.dom.NamedNodeMap;
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.SQLException;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.ResultSetMetaData;
/**
* PL/SQL documentation generator.
*
*
* 2006-05-16 - Matthias Hendler - Rewritten execption handling in Methode run and processPackage.
* Now the program ignores not only exceptions thrown by the parser
* but also thrown errors.
* Also a summary of skipped packages will be written to stderr at the program end.
* User can specify if he wants to get a generator summary in which he can see errors
* encountered during processing packages.
* Creation date is also added to the XML document (application.xml) for further XSLT processing.
*
* @author Albert Tumanov
* @version $Header: /cvsroot/pldoc/sources/src/java/net/sourceforge/pldoc/PLDoc.java,v 1.13 2005/11/29 08:25:00 gpaulissen Exp $
*
*/
public class PLDoc
{
// The exception is used when system exit is desired but "finally" clause need also to be run.
private static class SystemExitException extends RuntimeException {
/** Serial UID */
static final long serialVersionUID = 1L;
/** Default-Konstruktor */
SystemExitException() {
super();
}
/** Konstruktor with cause */
SystemExitException(Throwable t) {
super(t);
}
}
private static final String lineSeparator = System.getProperty("line.separator");
private static String programName = "PLDoc version: " + Version.id();
private static HashMap hashMap = new HashMap();
static {
/*
Put mappings for object types where the DBMS_METADATA.GET_DDL(OBJECT_TYPE) parameter
differs from the contents of the dba_objects.object_type column,
either because the because we just want the spcification
*/
hashMap.put( "PACKAGE", "PACKAGE_SPEC" );
hashMap.put( "TYPE", "TYPE_SPEC" );
hashMap.put( "PACKAGE BODY", "PACKAGE_BODY" );
hashMap.put( "TYPE BODY", "TYPE_BODY" );
hashMap.put( "JAVA SOURCE", "JAVA_SOURCE" ); // Attempt to document Java
}
/** Map OBJECT TYPES to source file suffixes
*/
private static HashMap fileSuffixMap = new HashMap();
static {
fileSuffixMap.put( "PROCEDURE", "prc" );
fileSuffixMap.put( "FUNCTION", "fns" );
fileSuffixMap.put( "TRIGGER", "trg" );
fileSuffixMap.put( "PACKAGE", "pks" );
fileSuffixMap.put( "TYPE", "tps" );
fileSuffixMap.put( "PACKAGE BODY", "pkb" );
fileSuffixMap.put( "TYPE BODY", "tpb" );
fileSuffixMap.put( "JAVA SOURCE", "java" );
}
// Helper objects for retrieving resources relative to the installation.
public static final ResourceResolver resResolver = new ResourceResolver();
public static final ResourceLoader resLoader = new ResourceLoader();
// Runtime settings
public Settings settings;
/**
* Constructor.
*/
public PLDoc(Settings settings)
{
this.settings = settings;
}
/** All processing is via the main method */
public static void main(String[] args) throws Exception
{
long startTime = System.currentTimeMillis();
System.out.println("");
System.out.println(programName);
// process arguments
Settings settings = new Settings();
settings.processCommandString(args);
PLDoc pldoc = new PLDoc(settings);
// start running
try {
pldoc.run();
} catch (SystemExitException e) {
System.exit(-1);
}
long finishTime = System.currentTimeMillis();
System.out.println("Done (" + (finishTime-startTime)/1000.00 + " seconds).");
}
/**
* Runs pldoc using the specified settings.
*
* 2006-05-16 - Matthias Hendler - Collect some status information during the processing
* and add them to the application.xml.
* More verbose output to console added.
*/
public void run() throws Exception
{
long startTime = System.currentTimeMillis();
// Map with all the packages (like files or database objects) which were skipped
final SortedMap skippedPackages = new TreeMap();
// Counts all the packages (like files or database objects) which were processed successfully
long processedPackages = 0;
Connection conn = null;
PreparedStatement pstmt = null;
File outputDirectory = settings.getOutputDirectory();
// if the output directory do not exist, create it
if (!settings.getOutputDirectory().exists()) {
System.out.println("Directory \"" + settings.getOutputDirectory() + "\" does not exist, creating ...");
settings.getOutputDirectory().mkdir();
}
// open the output file (named application.xml)
File applicationFile = new File(
settings.getOutputDirectory().getPath() + File.separator + "application.xml");
OutputStream output = null;
try {
output = new FileOutputStream(applicationFile);
XMLWriter xmlOut = new XMLWriter(output);
xmlOut.setMethod("xml");
if (settings.getOutputEncoding() != null)
xmlOut.setEncoding(settings.getOutputEncoding());
xmlOut.setIndent(true);
xmlOut.setDocType(null, "application.dtd");
xmlOut.startDocument();
xmlOut.pushAttribute("NAME", settings.getApplicationName());
xmlOut.startElement("APPLICATION");
// read overview file content
if (settings.getOverviewFile() != null) {
// overview of the application
xmlOut.startElement("OVERVIEW");
xmlOut.cdata(getOverviewFileContent(settings.getOverviewFile()));
xmlOut.endElement("OVERVIEW");
}
//Frig to allow compilation with JAVA_UNICODE_ESCAPE without allowing Unicode Escape characters
//String oldpropertyValue = settings.getDefines().setProperty("\\u","\\\\");
// for all the input files
Iterator it = settings.getInputFiles().iterator();
while (it.hasNext()) {
String inputFileName = (String) it.next();
final String packagename = inputFileName;
// open the input file
if (settings.isVerbose() ) System.out.println("Parsing file " + inputFileName + " ...");
try {
/* Allow the schema to be defaulted even when parsing files */
String schemaName = settings.getDbUser() ;
InputStreamReader inputStreamReader;
BufferedReader bufferedReader =
new BufferedReader(
inputStreamReader = new InputStreamReader(
new FileInputStream(inputFileName)
,settings.getInputEncoding()
)
)
;
if (settings.isVerbose() )
{
System.out.println("Processing : " + inputFileName + " as inputEncoding=\"" + settings.getInputEncoding()
+ "\" via inputStreamReader encoding=\""+inputStreamReader.getEncoding() +"\""
);
}
final Throwable throwable = processPackage(
bufferedReader
,
xmlOut, packagename
, (null == schemaName || schemaName.equals("") ) ? "" : schemaName//SRT 20110418""
, (null == schemaName || schemaName.equals("") ) ? "_GLOBAL" : ("_" + schemaName) //SRT 20110418
);
// Test the processing result
if (throwable == null) {
processedPackages++;
} else {
skippedPackages.put(packagename, throwable);
}
} catch(FileNotFoundException e) {
System.err.println("File not found: " + inputFileName);
throw new SystemExitException(e);
}
} // for all the input files.
// for all the specified packages from the dictionary
if ( settings.getDbUrl() != null && settings.getDbUser() != null && settings.getDbPassword() != null ) {
// Load the Required JDBC driver class.
// DriverManager.registerDriver(new OracleDriver());
Class.forName(settings.getDriverName());
// Connection conn = null;
// PreparedStatement pstmt = null;
try {
/* Move query generation before connecting in order to allow validation of the query with needing a valid datbae to connect to */
Collection inputTypes ;
String typeList = "" ;
/*
*/
if ( null != ( inputTypes = settings.getInputTypes() ) && ! inputTypes.isEmpty() )
{
for (Iterator tt = inputTypes.iterator(); tt.hasNext() ; )
{
String inputType = ((String) tt.next());
//Convert the list into quoted, UPPER-cased comma-separated list string
typeList += ((0 == typeList.length()) ? "" : ",") // prefix type name with comma for all except first type name
+ "'" + inputType.toUpperCase() + "'" ;
}
}
//Default List to procedural code only
if (typeList.equals(""))
{
// typeList = 'PACKAGE', 'TABLE', 'VIEW','TYPE','PROCEDURE','FUNCTION','MATERIALIZED VIEW' ;
typeList = "'PACKAGE','TYPE','PROCEDURE','FUNCTION','TRIGGER','TABLE','VIEW'" ;
}
String sqlStatement = "SELECT object_name"+
", object_type"+
" FROM dba_objects"+
" WHERE owner = ?"+
" AND object_name LIKE ?"+
" AND object_type in (" + typeList + ")"+
" ORDER BY "+
" object_name"
;
if (settings.isVerbose() ) System.out.println("Using \"" + sqlStatement + "\"" );
if (settings.isVerbose() ) System.out.println("Connecting ..");
conn = DriverManager.getConnection( settings.getDbUrl(), settings.getDbUser(), settings.getDbPassword() );
if (settings.isVerbose() ) System.out.println("Connected");
//Attempt to use DBA_OBJECTS, reverting to ALL_OBJECTS on any error
try
{
pstmt = conn.prepareStatement(sqlStatement);
}
catch (Exception e)
{ //Revert to ALL_OBJECTS
sqlStatement = sqlStatement.replaceFirst(" dba_", " all_");
if (settings.isVerbose() ) System.out.println("Reverting to \"" + sqlStatement + "\"" );
pstmt = conn.prepareStatement(sqlStatement);
}
DbmsMetadata dbmsMetadata = new DbmsMetadata(conn,settings.getGetMetadataStatement(), settings.getReturnType());
it = settings.getInputObjects().iterator();
while (it.hasNext()) {
String input[] = ((String) it.next()).split("\\."); /* [ SCHEMA . ] PACKAGE */
if ( input.length == 0 || input.length > 2 )
{
continue;
}
String inputSchemaName = ( input.length == 2 ? input[0] : settings.getDbUser() );
String inputObjectName = ( input.length == 2 ? input[1] : input[0] );
// get the package name(s)
ResultSet rset = null;
try {
pstmt.setString(1, inputSchemaName);
pstmt.setString(2, inputObjectName);
rset = pstmt.executeQuery();
// If the object is not present return false
if (!rset.next()) {
// package does not exist
System.err.println("Object(s) like " + inputSchemaName + "." + inputObjectName + " do not exist or " + settings.getDbUser() + " does not have enough permissions (SELECT_CATALOG_ROLE role).");
} else {
do {
final String packagename = inputSchemaName + "." + rset.getString(1);
final String objectType = rset.getString(2) ;
//Remap DBA_OBJECTS.OBJECT_TYPE column contents to DBMS_METADATA.GET_DDL(OBJECT_TYPE) parameter if necessary
final String dbmsMetadataObjectType = hashMap.containsKey(rset.getString(2)) ? (String) hashMap.get(objectType) : objectType;
if (settings.isVerbose() ) System.out.println("Parsing " + objectType + " name " + packagename + " ...");
if (settings.isVerbose() ) System.err.println("Extracting DBMS_METADATA DDL for (object_type,object_name,schema)=(" + dbmsMetadataObjectType + "," +rset.getString(1) + "," +inputSchemaName + ") ...");
final File savedSchemaDirectory = new File (settings.getOutputDirectory(), inputSchemaName);
if ( settings.isSaveSourceCode() && !savedSchemaDirectory.exists())
{
savedSchemaDirectory.mkdir();
}
final File savedObjectTypeDirectory = new File (savedSchemaDirectory, objectType.replace(' ','_') );
if (settings.isSaveSourceCode() )
{
//Create the directory if it does not already exist
if (!savedObjectTypeDirectory.exists())
{
savedObjectTypeDirectory.mkdir();
// copy required static files into the source code directory
copyStaticSourceDirectoryFiles(savedObjectTypeDirectory, "../../" );
}
//Refresh sattic files if ther directory existed previously but has not yet been modified in this run
else if (startTime > savedObjectTypeDirectory.lastModified())
{
// copy required static files into the source code directory
copyStaticSourceDirectoryFiles(savedObjectTypeDirectory, "../../" );
if (settings.isVerbose() ) System.err.println("Refreshed static files in " + savedObjectTypeDirectory.getCanonicalPath() );
}
}
final File savedSourceFile = new File (savedObjectTypeDirectory, rset.getString(1).replace(' ','_') + "." + fileSuffixMap.get(rset.getString(2)) + ".xml" );
FileWriter savedSourceFileWriter = null; //Set only if needed
// crashing the application
BufferedReader bufferedReader = null;
try {
if (settings.isSaveSourceCode() )
{
if (settings.isVerbose() )
System.err.println("Saving DDL for (object_type,object_name,schema)=(" + dbmsMetadataObjectType + "," +rset.getString(1) + "," +inputSchemaName + ") to "
+ savedSourceFile.getCanonicalPath()
);
savedSourceFileWriter = new FileWriter(savedSourceFile);
bufferedReader =
new BufferedReader(
new SourceCodeScraper(
dbmsMetadata.getDdl(dbmsMetadataObjectType,
rset.getString(1),
inputSchemaName,
"COMPATIBLE",
"ORACLE",
"DDL"
)
,savedSourceFileWriter
,false
,"sourcecode.xsl"
)
)
;
}
else
{
bufferedReader =
new BufferedReader(
dbmsMetadata.getDdl(dbmsMetadataObjectType,
rset.getString(1),
inputSchemaName,
"COMPATIBLE",
"ORACLE",
"DDL"
)
)
;
}
final Throwable throwable = processPackage(
bufferedReader
,xmlOut, packagename
,inputSchemaName
, ("_" + inputSchemaName) // ("-" + inputSchemaName + " Schema Level" ) //SRT 20110503 //"_GLOBAL" //SRT 20110418
);
// Test the processing result
if (throwable == null) {
processedPackages++;
} else {
skippedPackages.put(packagename, throwable);
}
}
catch (SQLException sqlE)
{
sqlE.printStackTrace(System.err);
skippedPackages.put(packagename, sqlE);
}
finally
{
if (null != bufferedReader)
{
bufferedReader.close();
bufferedReader = null;
}
if (null != savedSourceFileWriter)
{
savedSourceFileWriter.flush();
savedSourceFileWriter.close();
savedSourceFileWriter = null ;
}
}
} while (rset.next());
}
} finally {
if( rset != null ) rset.close();
}
}
} /* Keep Connect for PLSCOPE extract */
finally {
if( pstmt != null ) pstmt.close();
//if ( conn != null ) conn.close();
}
} // for all the specified packages from the dictionary
// generator summary
xmlOut.startElement("GENERATOR");
// objects like files or database objects
xmlOut.startElement("OBJECTS");
// save count processed objects
xmlOut.pushAttribute("COUNT", String.valueOf(processedPackages));
xmlOut.startElement("PROCESSED");
xmlOut.endElement("PROCESSED");
// save errors
xmlOut.pushAttribute("COUNT", String.valueOf(skippedPackages.size()));
xmlOut.startElement("SKIPPED");
if (settings.isShowSkippedPackages()) {
for (Iterator iter = skippedPackages.keySet().iterator(); iter.hasNext();) {
final String packagename = (String) iter.next();
final String error = ((Throwable) skippedPackages.get(packagename)).getLocalizedMessage();
xmlOut.pushAttribute("ERROR", error);
xmlOut.pushAttribute("NAME", packagename);
xmlOut.startElement("OBJECT");
xmlOut.endElement("OBJECT");
}
}
xmlOut.endElement("SKIPPED");
xmlOut.endElement("OBJECTS");
// save creation date and time
final Date date = new Date();
final String creationdate = DateFormat.getDateInstance(DateFormat.SHORT).format(date);
final String creationtime = DateFormat.getTimeInstance(DateFormat.SHORT).format(date);
xmlOut.pushAttribute("DATE", creationdate);
xmlOut.pushAttribute("TIME", creationtime);
xmlOut.startElement("CREATED");
xmlOut.endElement("CREATED");
xmlOut.pushAttribute("VERBOSE", settings.isVerbose() ? "TRUE" : "FALSE" );
xmlOut.pushAttribute("SHOW_SKIPPED_PACKAGES", settings.isShowSkippedPackages() ? "TRUE" : "FALSE" );
xmlOut.pushAttribute("IGNORE_INFORMAL_COMMENTS", settings.isIgnoreInformalComments() ? "TRUE" : "FALSE" );
xmlOut.pushAttribute("INPUT_ENCODING", settings.getInputEncoding() );
xmlOut.pushAttribute("DEFAULT_NAMES_CASE", settings.getDefaultNamescase().toUpperCase() );
xmlOut.pushAttribute("DEFAULT_KEYWORDS_CASE", settings.getDefaultKeywordscase().toUpperCase() );
xmlOut.pushAttribute("NAMES_TO_DEFAULT_CASE", settings.isNamesDefaultcase() ? "TRUE" : "FALSE" );
xmlOut.pushAttribute("NAMES_TO_UPPER_CASE", settings.isNamesUppercase() ? "TRUE" : "FALSE" );
xmlOut.pushAttribute("NAMES_TO_LOWER_CASE", settings.isNamesLowercase() ? "TRUE" : "FALSE" );
xmlOut.pushAttribute("KEYWORDS_TO_DEFAULT_CASE", settings.isKeywordsDefaultcase() ? "TRUE" : "FALSE" );
xmlOut.pushAttribute("KEYWORDS_TO_UPPER_CASE", settings.isKeywordsUppercase() ? "TRUE" : "FALSE" );
xmlOut.pushAttribute("KEYWORDS_TO_LOWER_CASE", settings.isKeywordsLowercase() ? "TRUE" : "FALSE" );
xmlOut.startElement("SETTINGS");
xmlOut.endElement("SETTINGS");
xmlOut.endElement("GENERATOR");
xmlOut.endElement("APPLICATION");
// All Nodes of the type PACKAGE with the same name will be collapsed to one node
// This is necessary to put all global defined functions/procedures/triggers into one
// big dummy package _GLOBAL.
collapseSimilarNodes(xmlOut.getDocument(), "PACKAGE", "NAME" );
//SRT Work In Progress collapseSimilarNodes(xmlOut.getDocument(), "TRIGGER", "SCHEMA" ); //111G Triggers have been moved up to Schema Level
xmlOut.endDocument();
} catch(FileNotFoundException e) {
System.err.println("File cannot be created: " + applicationFile);
e.printStackTrace();
throw new SystemExitException();
} finally {
if(output != null) {
output.close();
}
}
// copy required static files into the output directory
copyStaticFiles(settings.getOutputDirectory());
//If we are connected to the database and want PLScope , extract PLSCOPE
if ( conn != null && settings.isPlscope() ) {
try {
//Reuse pstmt = conn.prepareStatement(sqlStatement);
//Generate identifiers
String plscopeQuery = getStringFromInputStream( getResourceStream("plscope/plscope_signatures.sql") ) ;
pstmt = conn.prepareStatement( plscopeQuery );
ResultSet resultSet = pstmt.executeQuery();
OutputStream outputStream = new FileOutputStream( new File (settings.getOutputDirectory(), "plscope_identifiers.xml"));
resultSetToXml(resultSet, outputStream, "PLSCOPE", "IDENTIFIER", null) ;
//Extract the calls
plscopeQuery = getStringFromInputStream( getResourceStream("plscope/plscope_call.sql") ) ;
pstmt = conn.prepareStatement( plscopeQuery );
resultSet = pstmt.executeQuery();
outputStream = new FileOutputStream( new File (settings.getOutputDirectory(), "plscope.xml"));
resultSetToXml(resultSet, outputStream, "PLSCOPE", "CALL", null) ;
File signatureFile = new File (settings.getOutputDirectory(), "application-signatures.xml") ;
File mergedFile = new File (settings.getOutputDirectory(), "application-plscope.xml") ;
//Merge PL/Scope calling information into Application XML
{
System.out.println("Merging PLDoc and PL/Scope XML files ...");
TransformerFactory tFactory = TransformerFactory.newInstance();
//tFactory.setURIResolver(resResolver);
Transformer transformer;
transformer = tFactory.newTransformer(new StreamSource( resLoader.getResourceStream("xslt/pldoc_merge_plscope_signatures.xslt")));
//Have to pass in Absolute location of output directory in order to avoid problems with redirect File locations when called from PLDocTask
transformer.setParameter("targetFolder", settings.getOutputDirectory().getAbsolutePath() + File.separator );
transformer.setParameter("plscopeDocument", new File( settings.getOutputDirectory() , "plscope_identifiers.xml") );
transformer.setParameter("pldocDocument", new File( settings.getOutputDirectory() , "application.xml" ) );
transformer.transform(new StreamSource(applicationFile), new StreamResult(new FileOutputStream( signatureFile) ) );
transformer = tFactory.newTransformer(new StreamSource( resLoader.getResourceStream("xslt/pldoc_merge_plscope_calls.xslt")));
//Have to pass in Absolute location of output directory in order to avoid problems with redirect File locations when called from PLDocTask
transformer.setParameter("targetFolder", settings.getOutputDirectory().getAbsolutePath() + File.separator );
transformer.setParameter("plscopeDocument", new File( settings.getOutputDirectory() , "plscope.xml") );
transformer.setParameter("pldocDocument", signatureFile );
transformer.transform(new StreamSource(signatureFile), new StreamResult(new FileOutputStream( mergedFile) ) );
}
//Use the merged file rather than the originally generated application.xml
applicationFile = mergedFile ;
}
finally { //Close Any remaining output
if( pstmt != null ) pstmt.close();
if ( conn != null ) conn.close();
}
}
// generate HTML files from the applicationFile
generateHtml(applicationFile);
// write skipped packagenames to console
if (!skippedPackages.isEmpty()) {
System.err.println("Following packages were skipped due to errors:");
for (Iterator iter = skippedPackages.keySet().iterator(); iter.hasNext();) {
final String packagename = (String) iter.next();
System.err.print(packagename);
if (iter.hasNext()) {
System.err.print(", ");
}
}
System.err.println();
System.err.println(skippedPackages.size()+" packages skipped!");
}
// successfully processed packages
System.out.println(""+processedPackages+" packages processed successfully.");
}
/**
* Write ResultSet to Output As XML using the specified settings.
*
*@param resultSet the database information to write
*@param OutputStream outputStream
*@param documentRootName the root Element of the XML document
*@param rowElementNameof the element containing each row document
*@param dtd Optional DTD that the XML should validate against
*
*/
public void resultSetToXml(ResultSet resultSet, OutputStream outputStream, String documentRootName, String rowElementName, String dtd ) throws Exception
{
try {
ResultSetMetaData resultSetMetaData = resultSet.getMetaData();
XMLWriter xmlOut = new XMLWriter(outputStream);
xmlOut.setMethod("xml");
if (settings.getOutputEncoding() != null)
xmlOut.setEncoding(settings.getOutputEncoding());
xmlOut.setIndent(true);
if (null!=dtd && !dtd.equals("")) { xmlOut.setDocType(null, dtd); }
xmlOut.startDocument();
//xmlOut.pushAttribute("NAME", );
xmlOut.startElement(documentRootName);
int numberOfColumns = resultSetMetaData.getColumnCount();
// for all rows
while (resultSet.next()) {
//Attributes are pushed before the containing Element is created
for (int i = 1 ; i <= numberOfColumns; i++ )
{
xmlOut.pushAttribute(resultSetMetaData.getColumnName(i), resultSet.getString(i) );
}
xmlOut.startElement(rowElementName);
xmlOut.endElement(rowElementName);
}
xmlOut.endElement(documentRootName);
xmlOut.endDocument();
} finally {
if(outputStream != null) {
outputStream.close();
}
}
}
/**
* Processes a package.
*
* 2006-05-16 - Matthias Hendler - Rewritten exception handling and methode signature.
*
* @param packageSpec Package specification to parse
* @param xmlOut XML writer
* @param pPackageName The name of the package which is processed
* @return Null, if successfully processed or otherwise throwable which was encountered during processing.
* @throws SystemExitException Thrown if an error occurred and the user specified the halt on errors option.
* All other throwables will be caught.
*/
public Throwable processPackage(BufferedReader packageSpec, XMLWriter xmlOut, String pPackageName
, String pSchemaName, String pGlobalPackageName
)
throws SystemExitException
{
Throwable result = null;
SubstitutionReader input = null;
try {
input = new SubstitutionReader(packageSpec, settings.getDefines());
// parse the input file
PLSQLParser parser = new PLSQLParser(input);
// start writing new XML for the input file
XMLWriter outXML = new XMLWriter();
outXML.startDocument();
outXML.startElement("FILE");
// set parser params
parser.setXMLWriter(outXML);
parser.setIgnoreInformalComments(settings.isIgnoreInformalComments());
parser.setDefaultNamescase(settings.getDefaultNamescase());
parser.setDefaultKeywordscase(settings.getDefaultKeywordscase());
parser.setNamesDefaultcase(settings.isNamesDefaultcase());
parser.setNamesUppercase(settings.isNamesUppercase());
parser.setNamesLowercase(settings.isNamesLowercase());
parser.setKeywordsDefaultcase(settings.isKeywordsDefaultcase());
parser.setKeywordsUppercase(settings.isKeywordsUppercase());
parser.setKeywordsLowercase(settings.isKeywordsLowercase());
if (null != pSchemaName) parser.setSchemaName(pSchemaName); //SRT 20110418
if (null != pGlobalPackageName) parser.setGlobalPackageName(pGlobalPackageName); //SRT 20110418
// run parser
parser.input();
outXML.endElement("FILE");
outXML.endDocument();
// file parsed successfully
// append all nodes below FILE to the main XML
xmlOut.appendNodeChildren(outXML.getDocument().getDocumentElement());
} catch(ParseException e) {
System.err.println("ParseException at package <"+pPackageName+">: "+e);
System.err.println("Last consumed token: \"" + e.currentToken + "\"");
e.printStackTrace(System.err);
// exit with error only if specifically required by user
if (settings.isExitOnError()) {
throw new SystemExitException(e);
}
System.err.println("Package " + pPackageName + " skipped.");
result = e;
} catch (Throwable t) {
// Parser can cause errors which we also want to skip
System.err.println("Throwable at package <"+pPackageName+">: "+t);
t.printStackTrace(System.err);
if (settings.isExitOnError()) {
throw new SystemExitException(t);
}
System.err.println("Package " + pPackageName + " skipped.");
result = t;
} finally {
try {
if(input != null) {
input.close();
}
} catch (IOException ioe) {
System.err.println("Can't close input stream! Ignored!");
System.err.println("IOException: "+ioe);
}
}
return result;
}
/*
* Helper method to return fixed resources to alternative applications
*/
public static InputStream getResourceStream(String path) throws java.io.IOException {
return resLoader.getResourceStream(path);
}
/*
* Helper method to return fixed URIResolver to alternative applications
*/
public static URIResolver getResourceResolver() {
return resResolver;
}
/**
* Reads the text from the overview file.
*
* @param overviewFile The overview file to read from
*/
private String getOverviewFileContent(File overviewFile) throws IOException {
StringBuffer overview = new StringBuffer("");
try {
BufferedReader overviewReader =
new BufferedReader(
new InputStreamReader(
new FileInputStream(settings.getOverviewFile()),
settings.getInputEncoding())
);
String line = null;
while ((line = overviewReader.readLine()) != null) {
overview.append(line);
overview.append(lineSeparator);
}
overviewReader.close();
} catch(FileNotFoundException e) {
System.err.println("File not found: " + settings.getOverviewFile());
throw e;
} catch(UnsupportedEncodingException e) {
throw new IOException(e.toString());
}
// extract the text between and
int start = overview.toString().toUpperCase().lastIndexOf("");
if (start != -1)
overview.delete(0, start + 6);
int end = overview.toString().toUpperCase().indexOf("");
if (end != -1)
overview.delete(end, overview.length());
return overview.toString();
}
private String getStringFromInputStream(InputStream inputStream) throws IOException
{
byte[] inputBuffer = new byte[1024];
StringBuffer stringBuffer = new StringBuffer(1024);
int bytesRead;
while (inputStream.available() > 0) {
bytesRead = inputStream.read(inputBuffer);
stringBuffer.append(new String(inputBuffer, 0, bytesRead));
}
if (settings.isVerbose())
System.out.println("String derived from inputStream: \"" +
stringBuffer + "\"");
return stringBuffer.toString();
}
/**
* Generates HTML files from the provided XML file.
*
* 2006-05-16 - Matthias Hendler - Generates now a generator summary page, deprecated list and index list.
*
* @param applicationFile XML application file
*/
private void generateHtml(File applicationFile) throws Exception {
// apply xsl to generate the HTML frames
System.out.println("Generating HTML files ...");
TransformerFactory tFactory = TransformerFactory.newInstance();
tFactory.setURIResolver(resResolver);
Transformer transformer;
// list of schemas
System.out.println("Generating allschemas.html ...");
transformer = tFactory.newTransformer(new StreamSource(
resLoader.getResourceStream("allschemas.xsl")));
//Have to pass in Absolute location of output directory in order to avoid problems with redirect File locations when called from PLDocTask
transformer.setParameter("targetFolder", settings.getOutputDirectory().getAbsolutePath() + File.separator );
transformer.transform(new StreamSource(applicationFile),
new StreamResult(new FileOutputStream(
//settings.getOutputDirectory().getPath() + File.separator + "allschemas.html"
new File (settings.getOutputDirectory(), "allschemas.html")
)));
// summary
System.out.println("Generating summary.html ...");
transformer = tFactory.newTransformer(new StreamSource(
resLoader.getResourceStream("summary.xsl")));
transformer.transform(new StreamSource(applicationFile),
new StreamResult(new FileOutputStream(
settings.getOutputDirectory().getPath() + File.separator + "summary.html")));
// summary generator
System.out.println("Generating generator.html ...");
transformer = tFactory.newTransformer(new StreamSource(
resLoader.getResourceStream("generator.xsl")));
transformer.transform(new StreamSource(applicationFile),
new StreamResult(new FileOutputStream(
settings.getOutputDirectory().getPath() + File.separator + "generator.html")));
// deprecated list
System.out.println("Generating deprecated-list.html ...");
transformer = tFactory.newTransformer(new StreamSource(
resLoader.getResourceStream("deprecated-list.xsl")));
transformer.transform(new StreamSource(applicationFile),
new StreamResult(new FileOutputStream(
settings.getOutputDirectory().getPath() + File.separator + "deprecated-list.html")));
// index list
System.out.println("Generating index-list.html ...");
transformer = tFactory.newTransformer(new StreamSource(
resLoader.getResourceStream("index-list.xsl")));
transformer.transform(new StreamSource(applicationFile),
new StreamResult(new FileOutputStream(
settings.getOutputDirectory().getPath() + File.separator + "index-list.html")));
// list of packages
System.out.println("Generating allpackages.html ...");
transformer = tFactory.newTransformer(new StreamSource(
resLoader.getResourceStream("allpackages.xsl")));
transformer.transform(new StreamSource(applicationFile),
new StreamResult(new FileOutputStream(
settings.getOutputDirectory().getPath() + File.separator + "allpackages.html")));
// index
System.out.println("Generating index.html ...");
transformer = tFactory.newTransformer(new StreamSource(
resLoader.getResourceStream("index.xsl")));
transformer.transform(new StreamSource(applicationFile),
new StreamResult(new FileOutputStream(
settings.getOutputDirectory().getPath() + File.separator + "index.html")));
// description for each package; the DOMResult is actually ignored
System.out.println("Generating .html ...");
transformer = tFactory.newTransformer(new StreamSource(
resLoader.getResourceStream("unit.xsl")));
//Have to pass in Absolute location of output directory in order to avoid problems with spaces in paths
transformer.setParameter("targetFolder", settings.getOutputDirectory().getAbsolutePath() + File.separator );
if ( settings.isSaveSourceCode() ) // Generate links to source code
{
transformer.setParameter("sourceRootFolder", '.' );
}
transformer.transform(new StreamSource(applicationFile), new DOMResult());
}
/**
* Copies required static files into the output directory.
*
* @param outputDirectory
*/
private void copyStaticFiles(File outputDirectory) throws Exception {
try {
// Copy the stylesheet
Utils.CopyStreamToFile(
settings.getStylesheetFile(),
new File(outputDirectory.getPath() + File.separator + "stylesheet.css"));
// Copy the DTD
Utils.CopyStreamToFile(
resLoader.getResourceStream("application.dtd"),
new File(outputDirectory.getPath() + File.separator + "application.dtd"));
// Copy the sourcestylesheet
Utils.CopyStreamToFile(
settings.getSourceStylesheetFile(),
new File(outputDirectory.getPath() + File.separator + "sourcestylesheet.css"));
// Copy sourcecode.xsl to top-level directory
Utils.CopyStreamToFile(
resLoader.getResourceStream("sourcecode.xsl"),
new File(outputDirectory.getPath() + File.separator + "sourcecode.xsl"));
} catch(FileNotFoundException e) {
System.err.println("File not found. ");
e.printStackTrace();
throw e;
}
}
/**
* Copies required static files into the source code directory.
*
* This allows the XSL and CSS hrefs to cope with relocation of the root output directory
* or access through a web browser.
*
* @param outputDirectory directory to copy files
* @param relativePath the relative path to the location of the root output directory
*/
private void copyStaticSourceDirectoryFiles(File outputDirectory, String relativePath) throws Exception {
try {
// Copy sourcecode.xsl, replacing the stylesheet href with the relative href
Properties replacementProperties = new Properties();
replacementProperties.put("sourcestylesheet.css", relativePath + "sourcestylesheet.css");
Utils.CopyReaderToFile(
new BufferedReader(
new SubstitutionReader(
new BufferedReader(
new InputStreamReader(
(new ResourceLoader()).getResourceStream("sourcecode.xsl")
)
)
,replacementProperties
)
)
, new File(outputDirectory.getPath() + File.separator + "sourcecode.xsl")
);
} catch(FileNotFoundException e) {
System.err.println("File not found. ");
e.printStackTrace();
throw e;
}
}
/**
* Collapse all the nodes of specifed type with the same attribute NAME to one node.
*
* 2006-05-18 - Matthias Hendler - added
* 2011-05-1r4- SRT - renamed and added
*
* @param pDocument The document to work on
* @param pNodeName The node name to collapse to one node
* @param pAttributeName The attribute to identify duplicates
*/
private void collapseSimilarNodes(Document pDocument, String pNodeName, String pAttributeName) {
final String[] equalValues = findEqualNodesOnAttribute(pDocument, pNodeName, pAttributeName);
for (int index = 0; index < equalValues.length; index++) {
final String value = equalValues[index];
System.out.println("Collapsing all nodes of type <"+pNodeName+"> on their attribute <"+pAttributeName+"> with value <"+value+">.");
collapseNodes(pDocument, pNodeName, pAttributeName, value);
}
}
/**
* Collapse all the nodes in the document which have the given value in the specified attribute.
*
* 2006-05-18 - Matthias Hendler - added
*
* @param pDocument document to work on
* @param pNodeName node name
* @param pAttribute attribute name
* @param pValue value
*/
private void collapseNodes(Document pDocument, String pNodeName, String pAttribute, String pValue) {
Node supernode = null;
final List remove = new LinkedList();
final NodeList nl = pDocument.getElementsByTagName(pNodeName);
for (int index = 0; index < nl.getLength(); index++) {
final Node node = nl.item(index);
if (node.hasAttributes()) {
final NamedNodeMap attributes = node.getAttributes();
final Node attribute = attributes.getNamedItem(pAttribute);
if (attribute != null) {
final String value = attribute.getNodeValue();
if (pValue.equalsIgnoreCase(value)) {
if (supernode == null) {
supernode = node;
} else {
if (node.hasChildNodes()) {
final NodeList childs = node.getChildNodes();
for (int index2 = 0; index2 < childs.getLength(); index2++) {
final Node child = childs.item(index2);
final Node clone = child.cloneNode(true);
supernode.appendChild(clone);
}
}
remove.add(node);
}
}
}
}
}
if (!remove.isEmpty()) {
for (Iterator iter = remove.iterator(); iter.hasNext();) {
final Node node = (Node) iter.next();
node.getParentNode().removeChild(node);
}
}
}
/**
* Find all the nodes with equal attributes an return the value of this attribute.
*
* 2006-05-18 - Matthias Hendler - added
*
* @param pDocument document
* @param pNodeName name of the element
* @param pAttribute name of the attribute
* @return List of values which were identical
*/
private String[] findEqualNodesOnAttribute(Document pDocument, String pNodeName, String pAttribute) {
final Map result = new HashMap();
final Map found = new HashMap();
final NodeList nl = pDocument.getElementsByTagName(pNodeName);
for (int index = 0; index < nl.getLength(); index++) {
final Node node = nl.item(index);
if (node.hasAttributes()) {
final NamedNodeMap attributes = node.getAttributes();
final Node attribute = attributes.getNamedItem(pAttribute);
if (attribute != null) {
final String value = attribute.getNodeValue();
if (value != null) {
if (found.containsKey(value)) {
result.put(value, null);
} else {
found.put(value, null);
}
}
}
}
}
return (String[]) result.keySet().toArray(new String[] {});
}
}