| /* |
| * 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.sling.commons.compiler.impl; |
| |
| import java.io.BufferedReader; |
| import java.io.ByteArrayOutputStream; |
| import java.io.IOException; |
| import java.io.InputStream; |
| import java.io.OutputStream; |
| import java.io.Reader; |
| import java.net.URL; |
| import java.util.HashMap; |
| import java.util.Locale; |
| import java.util.Map; |
| import java.util.Set; |
| import java.util.concurrent.CopyOnWriteArraySet; |
| |
| import org.apache.sling.commons.classloader.ClassLoaderWriter; |
| import org.apache.sling.commons.compiler.CompilationResult; |
| import org.apache.sling.commons.compiler.CompilationUnit; |
| import org.apache.sling.commons.compiler.CompilationUnitWithSource; |
| import org.apache.sling.commons.compiler.JavaCompiler; |
| import org.apache.sling.commons.compiler.Options; |
| import org.eclipse.jdt.core.compiler.CategorizedProblem; |
| import org.eclipse.jdt.core.compiler.CharOperation; |
| import org.eclipse.jdt.internal.compiler.ClassFile; |
| import org.eclipse.jdt.internal.compiler.DefaultErrorHandlingPolicies; |
| import org.eclipse.jdt.internal.compiler.ICompilerRequestor; |
| import org.eclipse.jdt.internal.compiler.IErrorHandlingPolicy; |
| import org.eclipse.jdt.internal.compiler.IProblemFactory; |
| import org.eclipse.jdt.internal.compiler.classfmt.ClassFileReader; |
| import org.eclipse.jdt.internal.compiler.env.ICompilationUnit; |
| import org.eclipse.jdt.internal.compiler.env.INameEnvironment; |
| import org.eclipse.jdt.internal.compiler.env.NameEnvironmentAnswer; |
| import org.eclipse.jdt.internal.compiler.impl.CompilerOptions; |
| import org.eclipse.jdt.internal.compiler.problem.DefaultProblemFactory; |
| import org.osgi.service.component.annotations.Component; |
| import org.osgi.service.component.annotations.Reference; |
| import org.slf4j.Logger; |
| import org.slf4j.LoggerFactory; |
| |
| /** |
| * The <code>EclipseJavaCompiler</code> provides platform independent |
| * Java compilation support using the Eclipse Java Compiler (org.eclipse.jdt). |
| * |
| */ |
| @Component(service = JavaCompiler.class) |
| public class EclipseJavaCompiler implements JavaCompiler { |
| |
| /** Logger instance */ |
| private final Logger logger = LoggerFactory.getLogger(EclipseJavaCompiler.class); |
| |
| @Reference |
| private ClassLoaderWriter classLoaderWriter; |
| |
| /** the static problem factory */ |
| private IProblemFactory problemFactory = new DefaultProblemFactory(Locale.getDefault()); |
| |
| /** the static policy. */ |
| private final IErrorHandlingPolicy policy = DefaultErrorHandlingPolicies.exitAfterAllProblems(); |
| |
| private final Set<String> warningEmittedForUnsupportedJavaVersion = new CopyOnWriteArraySet<>(); |
| |
| /** |
| * Get the classloader for the compilation. |
| */ |
| private ClassLoader getClassLoader(final Options options, final ClassLoaderWriter classLoaderWriter) { |
| final ClassLoader loader; |
| if ( options.get(Options.KEY_CLASS_LOADER) != null ) { |
| loader = (ClassLoader)options.get(Options.KEY_CLASS_LOADER); |
| } else if ( options.get(Options.KEY_ADDITIONAL_CLASS_LOADER) != null ) { |
| final ClassLoader additionalClassLoader = (ClassLoader)options.get(Options.KEY_ADDITIONAL_CLASS_LOADER); |
| loader = new ClassLoader(classLoaderWriter.getClassLoader()) { |
| @Override |
| protected Class<?> findClass(String name) |
| throws ClassNotFoundException { |
| return additionalClassLoader.loadClass(name); |
| } |
| |
| @Override |
| protected URL findResource(String name) { |
| return additionalClassLoader.getResource(name); |
| } |
| }; |
| } else { |
| final ClassLoader cl = classLoaderWriter.getClassLoader(); |
| if ( cl == null ) { |
| loader = this.classLoaderWriter.getClassLoader(); |
| } else { |
| loader = cl; |
| } |
| } |
| return loader; |
| } |
| |
| /** |
| * Get the class loader writer for the compilation. |
| */ |
| private ClassLoaderWriter getClassLoaderWriter(final Options options) { |
| if (options.get(Options.KEY_CLASS_LOADER_WRITER) != null ) { |
| return (ClassLoaderWriter)options.get(Options.KEY_CLASS_LOADER_WRITER); |
| } |
| return this.classLoaderWriter; |
| } |
| |
| /** |
| * Check if the compiled class file is older than the source file |
| */ |
| private boolean isOutDated(final CompilationUnit unit, |
| final ClassLoaderWriter writer) { |
| final long targetLastModified = writer.getLastModified('/' + unit.getMainClassName().replace('.', '/') + ".class"); |
| if (targetLastModified < 0) { |
| return true; |
| } |
| |
| return targetLastModified < unit.getLastModified(); |
| } |
| |
| /** |
| * Return the force compilation value |
| */ |
| private boolean isForceCompilation(final Options options) { |
| final Boolean flag = (Boolean)options.get(Options.KEY_FORCE_COMPILATION); |
| if ( flag != null ) { |
| return flag; |
| } |
| return false; |
| } |
| |
| /** |
| * Return the ignore warnings value |
| */ |
| private boolean isIgnoreWarnings(final Options options) { |
| final Boolean flag = (Boolean)options.get(Options.KEY_IGNORE_WARNINGS); |
| if ( flag != null ) { |
| return flag; |
| } |
| return false; |
| } |
| |
| private static final Options EMPTY_OPTIONS = new Options(); |
| |
| /** |
| * @see org.apache.sling.commons.compiler.JavaCompiler#compile(org.apache.sling.commons.compiler.CompilationUnit[], org.apache.sling.commons.compiler.Options) |
| */ |
| @Override |
| public CompilationResult compile(final CompilationUnit[] units, |
| final Options compileOptions) { |
| // make sure we have an options object (to avoid null checks all over the place) |
| final Options options = (compileOptions != null ? compileOptions : EMPTY_OPTIONS); |
| |
| // get classloader and classloader writer |
| final ClassLoaderWriter writer = this.getClassLoaderWriter(options); |
| if ( writer == null ) { |
| return new CompilationResultImpl("Class loader writer for compilation is not available."); |
| } |
| final ClassLoader loader = this.getClassLoader(options, writer); |
| if ( loader == null ) { |
| return new CompilationResultImpl("Class loader for compilation is not available."); |
| } |
| |
| // check sources for compilation |
| boolean needsCompilation = isForceCompilation(options); |
| if ( !needsCompilation ) { |
| for(final CompilationUnit unit : units) { |
| if ( this.isOutDated(unit, writer) ) { |
| needsCompilation = true; |
| break; |
| } |
| } |
| } |
| if ( !needsCompilation ) { |
| logger.debug("All source files are recent - no compilation required."); |
| return new CompilationResultImpl(writer); |
| } |
| |
| // delete old class files |
| for(final CompilationUnit unit : units) { |
| final String name = '/' + unit.getMainClassName().replace('.', '/') + ".class"; |
| writer.delete(name); |
| } |
| |
| // create properties for the settings object |
| final Map<String, String> props = new HashMap<>(); |
| if (options.isGenerateDebugInfo()) { |
| props.put(CompilerOptions.OPTION_LocalVariableAttribute, "generate"); |
| props.put(CompilerOptions.OPTION_LineNumberAttribute, "generate"); |
| props.put(CompilerOptions.OPTION_SourceFileAttribute, "generate"); |
| } |
| if (options.getSourceVersion() != null) { |
| props.put(CompilerOptions.OPTION_Source, adjustJavaVersion(options.getSourceVersion())); |
| props.put(CompilerOptions.OPTION_Compliance, adjustJavaVersion(options.getSourceVersion())); |
| } |
| if (options.getTargetVersion() != null) { |
| props.put(CompilerOptions.OPTION_TargetPlatform, adjustJavaVersion(options.getTargetVersion())); |
| } |
| props.put(CompilerOptions.OPTION_Encoding, "UTF8"); |
| |
| // create the settings |
| final CompilerOptions settings = new CompilerOptions(props); |
| logger.debug("Compiling with settings {}.", settings); |
| |
| // create the result |
| final CompilationResultImpl result = new CompilationResultImpl(isIgnoreWarnings(options), writer); |
| // create the context |
| final CompileContext context = new CompileContext(units, result, writer, loader); |
| |
| // create the compiler |
| final org.eclipse.jdt.internal.compiler.Compiler compiler = |
| new org.eclipse.jdt.internal.compiler.Compiler( |
| context, |
| this.policy, |
| settings, |
| context, |
| this.problemFactory, |
| null, |
| null); |
| |
| // compile |
| compiler.compile(context.getSourceUnits()); |
| |
| return result; |
| } |
| |
| private String adjustJavaVersion(String javaVersion) { |
| // use latest supported version (Java 11) in case the given java version is not supported by ECJ yet |
| if (CompilerOptions.versionToJdkLevel(javaVersion) == 0) { |
| String latestSupportedVersion = CompilerOptions.VERSION_11; |
| // only log once per invalid javaVersion |
| if (!warningEmittedForUnsupportedJavaVersion.contains(javaVersion) && warningEmittedForUnsupportedJavaVersion.add(javaVersion)) { |
| logger.warn("Using unsupported java version '{}', assuming latest supported version '{}'", javaVersion, latestSupportedVersion); |
| } |
| return latestSupportedVersion; |
| } |
| return javaVersion; |
| } |
| |
| //--------------------------------------------------------< inner classes > |
| |
| private class CompileContext implements ICompilerRequestor, INameEnvironment { |
| |
| private final Map<String,ICompilationUnit> compUnits; |
| |
| private final CompilationResultImpl errorHandler; |
| private final ClassLoaderWriter classLoaderWriter; |
| private final ClassLoader classLoader; |
| |
| public CompileContext(final CompilationUnit[] units, |
| final CompilationResultImpl errorHandler, |
| final ClassLoaderWriter classWriter, |
| final ClassLoader classLoader) { |
| this.compUnits = new HashMap<>(); |
| for (int i = 0; i < units.length; i++) { |
| CompilationUnitAdapter cua = new CompilationUnitAdapter(units[i], errorHandler); |
| char[][] compoundName = CharOperation.arrayConcat(cua.getPackageName(), cua.getMainTypeName()); |
| this.compUnits.put(CharOperation.toString(compoundName), new CompilationUnitAdapter(units[i], errorHandler)); |
| } |
| |
| this.errorHandler = errorHandler; |
| this.classLoaderWriter = classWriter; |
| this.classLoader = classLoader; |
| } |
| |
| public ICompilationUnit[] getSourceUnits() { |
| return compUnits.values().toArray( |
| new ICompilationUnit[compUnits.size()]); |
| } |
| |
| /** |
| * @see org.eclipse.jdt.internal.compiler.ICompilerRequestor#acceptResult(org.eclipse.jdt.internal.compiler.CompilationResult) |
| */ |
| @Override |
| public void acceptResult(org.eclipse.jdt.internal.compiler.CompilationResult result) { |
| if (result.hasProblems()) { |
| CategorizedProblem[] problems = result.getProblems(); |
| for (int i = 0; i < problems.length; i++) { |
| CategorizedProblem problem = problems[i]; |
| String msg = problem.getMessage(); |
| String fileName = CharOperation.charToString(problem.getOriginatingFileName()); |
| int line = problem.getSourceLineNumber(); |
| int pos = problem.getSourceStart(); |
| |
| if (problem.isError()) { |
| this.errorHandler.onError(msg, fileName, line, pos); |
| } else if (problem.isWarning()) { |
| this.errorHandler.onWarning(msg, fileName, line, pos); |
| } else { |
| logger.debug("unknown problem category: {}", problem); |
| } |
| } |
| } |
| if ( this.errorHandler.getErrors() == null ) { |
| ClassFile[] classFiles = result.getClassFiles(); |
| for (int i = 0; i < classFiles.length; i++) { |
| ClassFile classFile = classFiles[i]; |
| String className = CharOperation.toString(classFile.getCompoundName()); |
| try { |
| this.write(className, classFile.getBytes()); |
| } catch (IOException e) { |
| this.errorHandler.onError("Unable to write class file: " + e.getMessage(), className, 0, 0); |
| } |
| } |
| } |
| } |
| |
| /** |
| * @see org.eclipse.jdt.internal.compiler.env.INameEnvironment#findType(char[][]) |
| */ |
| @Override |
| public NameEnvironmentAnswer findType(char[][] compoundTypeName) { |
| // check 1st if type corresponds with any of current compilation units |
| String fqn = CharOperation.toString(compoundTypeName); |
| ICompilationUnit cu = compUnits.get(fqn); |
| if (cu != null) { |
| return new NameEnvironmentAnswer(cu, null); |
| } |
| |
| // locate the class through the class loader |
| try { |
| byte[] bytes = this.findClass(CharOperation.toString(compoundTypeName)); |
| if (bytes == null) { |
| return null; |
| } |
| ClassFileReader classFileReader = |
| new ClassFileReader(bytes, fqn.toCharArray(), true); |
| return new NameEnvironmentAnswer(classFileReader, null); |
| } catch (Exception e) { |
| return null; |
| } |
| } |
| |
| /** |
| * @see org.eclipse.jdt.internal.compiler.env.INameEnvironment#findType(char[], char[][]) |
| */ |
| @Override |
| public NameEnvironmentAnswer findType(char[] typeName, char[][] packageName) { |
| return findType(CharOperation.arrayConcat(packageName, typeName)); |
| } |
| |
| /** |
| * @see org.eclipse.jdt.internal.compiler.env.INameEnvironment#isPackage(char[][], char[]) |
| */ |
| @Override |
| public boolean isPackage(char[][] parentPackageName, char[] packageName) { |
| String fqn = CharOperation.toString( |
| CharOperation.arrayConcat(parentPackageName, packageName)); |
| return compUnits.get(fqn) == null && this.isPackage(fqn); |
| } |
| |
| /** |
| * @see org.eclipse.jdt.internal.compiler.env.INameEnvironment#cleanup() |
| */ |
| @Override |
| public void cleanup() { |
| // nothing to do |
| } |
| |
| /** |
| * Write the classfile |
| */ |
| private void write(String name, byte[] data) throws IOException { |
| final OutputStream os = this.classLoaderWriter.getOutputStream('/' + name.replace('.', '/') + ".class"); |
| os.write(data); |
| os.close(); |
| } |
| |
| private boolean isPackage(String result) { |
| String resourceName = result.replace('.', '/') + ".class"; |
| if ( resourceName.startsWith("/") ) { |
| resourceName = resourceName.substring(1); |
| } |
| final InputStream is = this.classLoader.getResourceAsStream(resourceName); |
| if ( is != null ) { |
| try { |
| is.close(); |
| } catch (IOException ignore) {} |
| } |
| return is == null; |
| } |
| |
| private byte[] findClass(String name) throws Exception { |
| final String resourceName = name.replace('.', '/') + ".class"; |
| final InputStream is = this.classLoader.getResourceAsStream(resourceName); |
| if (is != null) { |
| try { |
| byte[] buf = new byte[8192]; |
| ByteArrayOutputStream baos = new ByteArrayOutputStream(buf.length); |
| int count; |
| while ((count = is.read(buf, 0, buf.length)) > 0) { |
| baos.write(buf, 0, count); |
| } |
| baos.flush(); |
| return baos.toByteArray(); |
| } finally { |
| try { |
| is.close(); |
| } catch (IOException ignore) {} |
| } |
| } |
| return null; |
| } |
| } |
| |
| private class CompilationUnitAdapter implements ICompilationUnit { |
| |
| private final CompilationResultImpl errorHandler; |
| private final CompilationUnit compUnit; |
| private final String mainTypeName; |
| private final String packageName; |
| |
| public CompilationUnitAdapter(final CompilationUnit compUnit, final CompilationResultImpl errorHandler) { |
| this.compUnit = compUnit; |
| this.errorHandler = errorHandler; |
| final int pos = compUnit.getMainClassName().lastIndexOf('.'); |
| if ( pos == -1 ) { |
| this.packageName = ""; |
| this.mainTypeName = compUnit.getMainClassName(); |
| } else { |
| this.packageName = compUnit.getMainClassName().substring(0, pos); |
| this.mainTypeName = compUnit.getMainClassName().substring(pos + 1); |
| } |
| } |
| |
| /** |
| * @see org.eclipse.jdt.internal.compiler.env.ICompilationUnit#getContents() |
| */ |
| @Override |
| public char[] getContents() { |
| Reader fr = null; |
| try { |
| fr = this.compUnit.getSource(); |
| final Reader reader = new BufferedReader(fr); |
| try { |
| char[] chars = new char[8192]; |
| StringBuilder buf = new StringBuilder(); |
| int count; |
| while ((count = reader.read(chars, 0, chars.length)) > 0) { |
| buf.append(chars, 0, count); |
| } |
| final char[] result = new char[buf.length()]; |
| buf.getChars(0, result.length, result, 0); |
| return result; |
| } finally { |
| reader.close(); |
| } |
| } catch (IOException e) { |
| this.errorHandler.onError("Unable to read source file " + this.compUnit.getMainClassName() + " : " + e.getMessage(), |
| this.compUnit.getMainClassName(), 0, 0); |
| return null; |
| } finally { |
| if ( fr != null ) { |
| try { fr.close(); } catch (IOException ignore) {} |
| } |
| } |
| } |
| |
| /** |
| * @see org.eclipse.jdt.internal.compiler.env.ICompilationUnit#getMainTypeName() |
| */ |
| @Override |
| public char[] getMainTypeName() { |
| return this.mainTypeName.toCharArray(); |
| } |
| |
| /** |
| * @see org.eclipse.jdt.internal.compiler.env.ICompilationUnit#getPackageName() |
| */ |
| @Override |
| public char[][] getPackageName() { |
| return CharOperation.splitOn('.', this.packageName.toCharArray()); |
| } |
| |
| /** |
| * @see org.eclipse.jdt.internal.compiler.env.IDependent#getFileName() |
| */ |
| @Override |
| public char[] getFileName() { |
| if (compUnit instanceof CompilationUnitWithSource) { |
| return ((CompilationUnitWithSource)compUnit).getFileName().toCharArray(); |
| } else { |
| return (this.packageName.replace('.', '/') + '/' + this.mainTypeName + ".java").toCharArray(); |
| } |
| } |
| |
| /** |
| * @see org.eclipse.jdt.internal.compiler.env.ICompilationUnit#ignoreOptionalProblems() |
| */ |
| @Override |
| public boolean ignoreOptionalProblems() { |
| return false; |
| } |
| } |
| } |