/*

* Licensed to the Apache Software Foundation (ASF) under one or more

* contributor license agreements. See the NOTICE file distributed with

* this work for additional information regarding copyright ownership.

* The ASF licenses this file to You 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.

*/

package org.apache.jasper;

import java.io.BufferedReader;

import java.io.CharArrayWriter;

import java.io.EOFException;

import java.io.File;

import java.io.FileInputStream;

import java.io.FileNotFoundException;

import java.io.FileOutputStream;

import java.io.IOException;

import java.io.InputStreamReader;

import java.io.OutputStreamWriter;

import java.io.PrintWriter;

import java.io.Reader;

import java.io.Writer;

import java.net.URL;

import java.net.URLClassLoader;

import java.util.ArrayList;

import java.util.HashMap;

import java.util.HashSet;

import java.util.Iterator;

import java.util.List;

import java.util.Map;

import java.util.Set;

import java.util.Stack;

import java.util.StringTokenizer;

import java.util.Vector;

import javax.servlet.jsp.JspFactory;

import javax.servlet.jsp.tagext.TagLibraryInfo;

import org.apache.jasper.compiler.Compiler;

import org.apache.jasper.compiler.JspConfig;

import org.apache.jasper.compiler.JspRuntimeContext;

import org.apache.jasper.compiler.Localizer;

import org.apache.jasper.compiler.TagPluginManager;

import org.apache.jasper.compiler.TldCache;

import org.apache.jasper.runtime.JspFactoryImpl;

import org.apache.jasper.servlet.JspCServletContext;

import org.apache.jasper.servlet.TldScanner;

import org.apache.juli.logging.Log;

import org.apache.juli.logging.LogFactory;

import org.apache.tools.ant.AntClassLoader;

import org.apache.tools.ant.BuildException;

import org.apache.tools.ant.Task;

import org.apache.tools.ant.util.FileUtils;

import org.xml.sax.SAXException;

/**

* Shell for the jspc compiler. Handles all options associated with the

* command line and creates compilation contexts which it then compiles

* according to the specified options.

*

* This version can process files from a _single_ webapp at once, i.e.

* a single docbase can be specified.

*

* It can be used as an Ant task using:

* <pre>

* &lt;taskdef classname="org.apache.jasper.JspC" name="jasper" &gt;

* &lt;classpath&gt;

* &lt;pathelement location="${java.home}/../lib/tools.jar"/&gt;

* &lt;fileset dir="${ENV.CATALINA_HOME}/lib"&gt;

* &lt;include name="*.jar"/&gt;

* &lt;/fileset&gt;

* &lt;path refid="myjars"/&gt;

* &lt;/classpath&gt;

* &lt;/taskdef&gt;

*

* &lt;jasper verbose="0"

* package="my.package"

* uriroot="${webapps.dir}/${webapp.name}"

* webXmlFragment="${build.dir}/generated_web.xml"

* outputDir="${webapp.dir}/${webapp.name}/WEB-INF/src/my/package" /&gt;

* </pre>

*

* @author Danno Ferrin

* @author Pierre Delisle

* @author Costin Manolache

* @author Yoav Shapira

*/

public class JspC extends Task implements Options {

static {

// the Validator uses this to access the EL ExpressionFactory

JspFactory.setDefaultFactory(new JspFactoryImpl());

}

public static final String DEFAULT_IE_CLASS_ID =

"clsid:8AD9C840-044E-11D1-B3E9-00805F499D93";

// Logger

private static final Log log = LogFactory.getLog(JspC.class);

protected static final String SWITCH_VERBOSE = "-v";

protected static final String SWITCH_HELP = "-help";

protected static final String SWITCH_OUTPUT_DIR = "-d";

protected static final String SWITCH_PACKAGE_NAME = "-p";

protected static final String SWITCH_CACHE = "-cache";

protected static final String SWITCH_CLASS_NAME = "-c";

protected static final String SWITCH_FULL_STOP = "--";

protected static final String SWITCH_COMPILE = "-compile";

protected static final String SWITCH_SOURCE = "-source";

protected static final String SWITCH_TARGET = "-target";

protected static final String SWITCH_URI_BASE = "-uribase";

protected static final String SWITCH_URI_ROOT = "-uriroot";

protected static final String SWITCH_FILE_WEBAPP = "-webapp";

protected static final String SWITCH_WEBAPP_INC = "-webinc";

protected static final String SWITCH_WEBAPP_XML = "-webxml";

protected static final String SWITCH_WEBAPP_XML_ENCODING = "-webxmlencoding";

protected static final String SWITCH_ADD_WEBAPP_XML_MAPPINGS = "-addwebxmlmappings";

protected static final String SWITCH_MAPPED = "-mapped";

protected static final String SWITCH_XPOWERED_BY = "-xpoweredBy";

protected static final String SWITCH_TRIM_SPACES = "-trimSpaces";

protected static final String SWITCH_CLASSPATH = "-classpath";

protected static final String SWITCH_DIE = "-die";

protected static final String SWITCH_POOLING = "-poolingEnabled";

protected static final String SWITCH_ENCODING = "-javaEncoding";

protected static final String SWITCH_SMAP = "-smap";

protected static final String SWITCH_DUMP_SMAP = "-dumpsmap";

protected static final String SWITCH_VALIDATE_TLD = "-validateTld";

protected static final String SWITCH_VALIDATE_XML = "-validateXml";

protected static final String SWITCH_BLOCK_EXTERNAL = "-blockExternal";

protected static final String SWITCH_NO_BLOCK_EXTERNAL = "-no-blockExternal";

protected static final String SHOW_SUCCESS ="-s";

protected static final String LIST_ERRORS = "-l";

protected static final int INC_WEBXML = 10;

protected static final int ALL_WEBXML = 20;

protected static final int DEFAULT_DIE_LEVEL = 1;

protected static final int NO_DIE_LEVEL = 0;

protected static final Set<String> insertBefore = new HashSet<>();

static {

insertBefore.add("</web-app>");

insertBefore.add("<servlet-mapping>");

insertBefore.add("<session-config>");

insertBefore.add("<mime-mapping>");

insertBefore.add("<welcome-file-list>");

insertBefore.add("<error-page>");

insertBefore.add("<taglib>");

insertBefore.add("<resource-env-ref>");

insertBefore.add("<resource-ref>");

insertBefore.add("<security-constraint>");

insertBefore.add("<login-config>");

insertBefore.add("<security-role>");

insertBefore.add("<env-entry>");

insertBefore.add("<ejb-ref>");

insertBefore.add("<ejb-local-ref>");

}

protected String classPath = null;

protected ClassLoader loader = null;

protected boolean trimSpaces = false;

protected boolean genStringAsCharArray = false;

protected boolean validateTld;

protected boolean validateXml;

protected boolean blockExternal = true;

protected boolean xpoweredBy;

protected boolean mappedFile = false;

protected boolean poolingEnabled = true;

protected File scratchDir;

protected String ieClassId = DEFAULT_IE_CLASS_ID;

protected String targetPackage;

protected String targetClassName;

protected String uriBase;

protected String uriRoot;

protected int dieLevel;

protected boolean helpNeeded = false;

protected boolean compile = false;

protected boolean smapSuppressed = true;

protected boolean smapDumped = false;

protected boolean caching = true;

protected final Map<String, TagLibraryInfo> cache = new HashMap<>();

protected String compiler = null;

protected String compilerTargetVM = "1.8";

protected String compilerSourceVM = "1.8";

protected boolean classDebugInfo = true;

/**

* Throw an exception if there's a compilation error, or swallow it.

* Default is true to preserve old behavior.

*/

protected boolean failOnError = true;

/**

* The file extensions to be handled as JSP files.

* Default list is .jsp and .jspx.

*/

protected List<String> extensions;

/**

* The pages.

*/

protected final List<String> pages = new Vector<>();

/**

* Needs better documentation, this data member does.

* True by default.

*/

protected boolean errorOnUseBeanInvalidClassAttribute = true;

/**

* The java file encoding. Default

* is UTF-8. Added per bugzilla 19622.

*/

protected String javaEncoding = "UTF-8";

// Generation of web.xml fragments

protected String webxmlFile;

protected int webxmlLevel;

protected String webxmlEncoding;

protected boolean addWebXmlMappings = false;

protected Writer mapout;

protected CharArrayWriter servletout;

protected CharArrayWriter mappingout;

/**

* The servlet context.

*/

protected JspCServletContext context;

/**

* The runtime context.

* Maintain a dummy JspRuntimeContext for compiling tag files.

*/

protected JspRuntimeContext rctxt;

/**

* Cache for the TLD locations

*/

protected TldCache tldCache = null;

protected JspConfig jspConfig = null;

protected TagPluginManager tagPluginManager = null;

protected TldScanner scanner = null;

protected boolean verbose = false;

protected boolean listErrors = false;

protected boolean showSuccess = false;

protected int argPos;

protected boolean fullstop = false;

protected String args[];

public static void main(String arg[]) {

if (arg.length == 0) {

System.out.println(Localizer.getMessage("jspc.usage"));

} else {

JspC jspc = new JspC();

try {

jspc.setArgs(arg);

if (jspc.helpNeeded) {

System.out.println(Localizer.getMessage("jspc.usage"));

} else {

jspc.execute();

}

} catch (JasperException je) {

System.err.println(je);

if (jspc.dieLevel != NO_DIE_LEVEL) {

System.exit(jspc.dieLevel);

}

} catch (BuildException je) {

System.err.println(je);

if (jspc.dieLevel != NO_DIE_LEVEL) {

System.exit(jspc.dieLevel);

}

}

}

}

/**

* Apply command-line arguments.

*

* @param arg

* The arguments

*/

public void setArgs(String[] arg) throws JasperException {

args = arg;

String tok;

dieLevel = NO_DIE_LEVEL;

while ((tok = nextArg()) != null) {

if (tok.equals(SWITCH_VERBOSE)) {

verbose = true;

showSuccess = true;

listErrors = true;

} else if (tok.equals(SWITCH_OUTPUT_DIR)) {

tok = nextArg();

setOutputDir( tok );

} else if (tok.equals(SWITCH_PACKAGE_NAME)) {

targetPackage = nextArg();

} else if (tok.equals(SWITCH_COMPILE)) {

compile=true;

} else if (tok.equals(SWITCH_CLASS_NAME)) {

targetClassName = nextArg();

} else if (tok.equals(SWITCH_URI_BASE)) {

uriBase=nextArg();

} else if (tok.equals(SWITCH_URI_ROOT)) {

setUriroot( nextArg());

} else if (tok.equals(SWITCH_FILE_WEBAPP)) {

setUriroot( nextArg());

} else if ( tok.equals( SHOW_SUCCESS ) ) {

showSuccess = true;

} else if ( tok.equals( LIST_ERRORS ) ) {

listErrors = true;

} else if (tok.equals(SWITCH_WEBAPP_INC)) {

webxmlFile = nextArg();

if (webxmlFile != null) {

webxmlLevel = INC_WEBXML;

}

} else if (tok.equals(SWITCH_WEBAPP_XML)) {

webxmlFile = nextArg();

if (webxmlFile != null) {

webxmlLevel = ALL_WEBXML;

}

} else if (tok.equals(SWITCH_WEBAPP_XML_ENCODING)) {

setWebXmlEncoding(nextArg());

} else if (tok.equals(SWITCH_ADD_WEBAPP_XML_MAPPINGS)) {

setAddWebXmlMappings(true);

} else if (tok.equals(SWITCH_MAPPED)) {

mappedFile = true;

} else if (tok.equals(SWITCH_XPOWERED_BY)) {

xpoweredBy = true;

} else if (tok.equals(SWITCH_TRIM_SPACES)) {

setTrimSpaces(true);

} else if (tok.equals(SWITCH_CACHE)) {

tok = nextArg();

if ("false".equals(tok)) {

caching = false;

} else {

caching = true;

}

} else if (tok.equals(SWITCH_CLASSPATH)) {

setClassPath(nextArg());

} else if (tok.startsWith(SWITCH_DIE)) {

try {

dieLevel = Integer.parseInt(

tok.substring(SWITCH_DIE.length()));

} catch (NumberFormatException nfe) {

dieLevel = DEFAULT_DIE_LEVEL;

}

} else if (tok.equals(SWITCH_HELP)) {

helpNeeded = true;

} else if (tok.equals(SWITCH_POOLING)) {

tok = nextArg();

if ("false".equals(tok)) {

poolingEnabled = false;

} else {

poolingEnabled = true;

}

} else if (tok.equals(SWITCH_ENCODING)) {

setJavaEncoding(nextArg());

} else if (tok.equals(SWITCH_SOURCE)) {

setCompilerSourceVM(nextArg());

} else if (tok.equals(SWITCH_TARGET)) {

setCompilerTargetVM(nextArg());

} else if (tok.equals(SWITCH_SMAP)) {

smapSuppressed = false;

} else if (tok.equals(SWITCH_DUMP_SMAP)) {

smapDumped = true;

} else if (tok.equals(SWITCH_VALIDATE_TLD)) {

setValidateTld(true);

} else if (tok.equals(SWITCH_VALIDATE_XML)) {

setValidateXml(true);

} else if (tok.equals(SWITCH_BLOCK_EXTERNAL)) {

setBlockExternal(true);

} else if (tok.equals(SWITCH_NO_BLOCK_EXTERNAL)) {

setBlockExternal(false);

} else {

if (tok.startsWith("-")) {

throw new JasperException("Unrecognized option: " + tok +

". Use -help for help.");

}

if (!fullstop) {

argPos--;

}

// Start treating the rest as JSP Pages

break;

}

}

// Add all extra arguments to the list of files

while( true ) {

String file = nextFile();

if( file==null ) {

break;

}

pages.add( file );

}

}

/**

* In JspC this always returns <code>true</code>.

* {@inheritDoc}

*/

@Override

public boolean getKeepGenerated() {

// isn't this why we are running jspc?

return true;

}

/**

* {@inheritDoc}

*/

@Override

public boolean getTrimSpaces() {

return trimSpaces;

}

/**

* Sets the option to trim white spaces between directives or actions.

*/

public void setTrimSpaces(boolean ts) {

this.trimSpaces = ts;

}

/**

* {@inheritDoc}

*/

@Override

public boolean isPoolingEnabled() {

return poolingEnabled;

}

/**

* Sets the option to enable the tag handler pooling.

*/

public void setPoolingEnabled(boolean poolingEnabled) {

this.poolingEnabled = poolingEnabled;

}

/**

* {@inheritDoc}

*/

@Override

public boolean isXpoweredBy() {

return xpoweredBy;

}

/**

* Sets the option to enable generation of X-Powered-By response header.

*/

public void setXpoweredBy(boolean xpoweredBy) {

this.xpoweredBy = xpoweredBy;

}

/**

* In JspC this always returns <code>true</code>.

* {@inheritDoc}

*/

@Override

public boolean getDisplaySourceFragment() {

return true;

}

@Override

public int getMaxLoadedJsps() {

return -1;

}

@Override

public int getJspIdleTimeout() {

return -1;

}

/**

* {@inheritDoc}

*/

@Override

public boolean getErrorOnUseBeanInvalidClassAttribute() {

return errorOnUseBeanInvalidClassAttribute;

}

/**

* Sets the option to issue a compilation error if the class attribute

* specified in useBean action is invalid.

*/

public void setErrorOnUseBeanInvalidClassAttribute(boolean b) {

errorOnUseBeanInvalidClassAttribute = b;

}

/**

* {@inheritDoc}

*/

@Override

public boolean getMappedFile() {

return mappedFile;

}

public void setMappedFile(boolean b) {

mappedFile = b;

}

/**

* Sets the option to include debug information in compiled class.

*/

public void setClassDebugInfo( boolean b ) {

classDebugInfo=b;

}

/**

* {@inheritDoc}

*/

@Override

public boolean getClassDebugInfo() {

// compile with debug info

return classDebugInfo;

}

/**

* {@inheritDoc}

*/

@Override

public boolean isCaching() {

return caching;

}

/**

* Sets the option to enable caching.

*

* @see Options#isCaching()

*/

public void setCaching(boolean caching) {

this.caching = caching;

}

/**

* {@inheritDoc}

*/

@Override

public Map<String, TagLibraryInfo> getCache() {

return cache;

}

/**

* In JspC this always returns <code>0</code>.

* {@inheritDoc}

*/

@Override

public int getCheckInterval() {

return 0;

}

/**

* In JspC this always returns <code>0</code>.

* {@inheritDoc}

*/

@Override

public int getModificationTestInterval() {

return 0;

}

/**

* In JspC this always returns <code>false</code>.

* {@inheritDoc}

*/

@Override

public boolean getRecompileOnFail() {

return false;

}

/**

* In JspC this always returns <code>false</code>.

* {@inheritDoc}

*/

@Override

public boolean getDevelopment() {

return false;

}

/**

* {@inheritDoc}

*/

@Override

public boolean isSmapSuppressed() {

return smapSuppressed;

}

/**

* Sets smapSuppressed flag.

*/

public void setSmapSuppressed(boolean smapSuppressed) {

this.smapSuppressed = smapSuppressed;

}

/**

* {@inheritDoc}

*/

@Override

public boolean isSmapDumped() {

return smapDumped;

}

/**

* Sets smapDumped flag.

*

* @see Options#isSmapDumped()

*/

public void setSmapDumped(boolean smapDumped) {

this.smapDumped = smapDumped;

}

/**

* Determines whether text strings are to be generated as char arrays,

* which improves performance in some cases.

*

* @param genStringAsCharArray true if text strings are to be generated as

* char arrays, false otherwise

*/

public void setGenStringAsCharArray(boolean genStringAsCharArray) {

this.genStringAsCharArray = genStringAsCharArray;

}

/**

* {@inheritDoc}

*/

@Override

public boolean genStringAsCharArray() {

return genStringAsCharArray;

}

/**

* Sets the class-id value to be sent to Internet Explorer when using

* &lt;jsp:plugin&gt; tags.

*

* @param ieClassId

* Class-id value

*/

public void setIeClassId(String ieClassId) {

this.ieClassId = ieClassId;

}

/**

* {@inheritDoc}

*/

@Override

public String getIeClassId() {

return ieClassId;

}

/**

* {@inheritDoc}

*/

@Override

public File getScratchDir() {

return scratchDir;

}

/**

* {@inheritDoc}

*/

@Override

public String getCompiler() {

return compiler;

}

/**

* Sets the option to determine what compiler to use.

*

* @see Options#getCompiler()

*/

public void setCompiler(String c) {

compiler=c;

}

/**

* {@inheritDoc}

*/

@Override

public String getCompilerClassName() {

return null;

}

/**

* {@inheritDoc}

*/

@Override

public String getCompilerTargetVM() {

return compilerTargetVM;

}

/**

* Sets the compiler target VM.

*

* @see Options#getCompilerTargetVM()

*/

public void setCompilerTargetVM(String vm) {

compilerTargetVM = vm;

}

/**

* {@inheritDoc}

*/

@Override

public String getCompilerSourceVM() {

return compilerSourceVM;

}

/**

* Sets the compiler source VM.

*

* @see Options#getCompilerSourceVM()

*/

public void setCompilerSourceVM(String vm) {

compilerSourceVM = vm;

}

/**

* {@inheritDoc}

*/

@Override

public TldCache getTldCache() {

return tldCache;

}

/**

* Returns the encoding to use for

* java files. The default is UTF-8.

*

* @return String The encoding

*/

@Override

public String getJavaEncoding() {

return javaEncoding;

}

/**

* Sets the encoding to use for

* java files.

*

* @param encodingName The name, e.g. "UTF-8"

*/

public void setJavaEncoding(String encodingName) {

javaEncoding = encodingName;

}

/**

* {@inheritDoc}

*/

@Override

public boolean getFork() {

return false;

}

/**

* {@inheritDoc}

*/

@Override

public String getClassPath() {

if( classPath != null )

return classPath;

return System.getProperty("java.class.path");

}

/**

* Sets the classpath used while compiling the servlets generated from JSP

* files

*/

public void setClassPath(String s) {

classPath=s;

}

/**

* Returns the list of file extensions

* that are treated as JSP files.

*

* @return The list of extensions

*/

public List<String> getExtensions() {

return extensions;

}

/**

* Adds the given file extension to the

* list of extensions handled as JSP files.

*

* @param extension The extension to add, e.g. "myjsp"

*/

protected void addExtension(final String extension) {

if(extension != null) {

if(extensions == null) {

extensions = new Vector<>();

}

extensions.add(extension);

}

}

/**

* Base dir for the webapp. Used to generate class names and resolve

* includes.

*/

public void setUriroot( String s ) {

if (s == null) {

uriRoot = null;

return;

}

try {

uriRoot = resolveFile(s).getCanonicalPath();

} catch( Exception ex ) {

uriRoot = s;

}

}

/**

* Parses comma-separated list of JSP files to be processed. If the argument

* is null, nothing is done.

*

* <p>Each file is interpreted relative to uriroot, unless it is absolute,

* in which case it must start with uriroot.</p>

*

* @param jspFiles Comma-separated list of JSP files to be processed

*/

public void setJspFiles(final String jspFiles) {

if(jspFiles == null) {

return;

}

StringTokenizer tok = new StringTokenizer(jspFiles, ",");

while (tok.hasMoreTokens()) {

pages.add(tok.nextToken());

}

}

/**

* Sets the compile flag.

*

* @param b Flag value

*/

public void setCompile( final boolean b ) {

compile = b;

}

/**

* Sets the verbosity level. The actual number doesn't

* matter: if it's greater than zero, the verbose flag will

* be true.

*

* @param level Positive means verbose

*/

public void setVerbose( final int level ) {

if (level > 0) {

verbose = true;

showSuccess = true;

listErrors = true;

}

}

public void setValidateTld( boolean b ) {

this.validateTld = b;

}

public boolean isValidateTld() {

return validateTld;

}

public void setValidateXml( boolean b ) {

this.validateXml = b;

}

public boolean isValidateXml() {

return validateXml;

}

public void setBlockExternal( boolean b ) {

this.blockExternal = b;

}

public boolean isBlockExternal() {

return blockExternal;

}

public void setListErrors( boolean b ) {

listErrors = b;

}

public void setOutputDir( String s ) {

if( s!= null ) {

scratchDir = resolveFile(s).getAbsoluteFile();

} else {

scratchDir=null;

}

}

/**

* Sets the package name to be used for the generated servlet classes.

*/

public void setPackage( String p ) {

targetPackage=p;

}

/**

* Class name of the generated file ( without package ).

* Can only be used if a single file is converted.

* XXX Do we need this feature ?

*/

public void setClassName( String p ) {

targetClassName=p;

}

/**

* File where we generate a web.xml fragment with the class definitions.

*/

public void setWebXmlFragment( String s ) {

webxmlFile=resolveFile(s).getAbsolutePath();

webxmlLevel=INC_WEBXML;

}

/**

* File where we generate a complete web.xml with the class definitions.

*/

public void setWebXml( String s ) {

webxmlFile=resolveFile(s).getAbsolutePath();

webxmlLevel=ALL_WEBXML;

}

/**

* Sets the encoding to be used to read and write web.xml files.

*

* <p>

* If not specified, defaults to the platform default encoding.

* </p>

*

* @param encoding

* Encoding, e.g. "UTF-8".

*/

public void setWebXmlEncoding(String encoding) {

webxmlEncoding = encoding;

}

/**

* Sets the option to merge generated web.xml fragment into the

* WEB-INF/web.xml file of the web application that we were processing.

*

* @param b

* <code>true</code> to merge the fragment into the existing

* web.xml file of the processed web application

* ({uriroot}/WEB-INF/web.xml), <code>false</code> to keep the

* generated web.xml fragment

*/

public void setAddWebXmlMappings(boolean b) {

addWebXmlMappings = b;

}

/**

* Sets the option that throws an exception in case of a compilation error.

*/

public void setFailOnError(final boolean b) {

failOnError = b;

}

/**

* Returns true if an exception will be thrown in case of a compilation

* error.

*/

public boolean getFailOnError() {

return failOnError;

}

/**

* {@inheritDoc}

*/

@Override

public JspConfig getJspConfig() {

return jspConfig;

}

/**

* {@inheritDoc}

*/

@Override

public TagPluginManager getTagPluginManager() {

return tagPluginManager;

}

/**

* Adds servlet declaration and mapping for the JSP page servlet to the