• Home
• org.jetbrains.kotlin
• kotlin-main-kts
• 2.0.10
• source code
• jvmClasspathUtil.kt

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

kotlin.script.experimental.jvm.util.jvmClasspathUtil.kt Maven / Gradle / Ivy

/*
 * Copyright 2010-2018 JetBrains s.r.o. and Kotlin Programming Language contributors.
 * Use of this source code is governed by the Apache 2.0 license that can be found in the license/LICENSE.txt file.
 */

package kotlin.script.experimental.jvm.util

import java.io.File
import java.io.FileInputStream
import java.io.FileNotFoundException
import java.net.JarURLConnection
import java.net.URL
import java.net.URLClassLoader
import java.util.jar.JarInputStream
import kotlin.reflect.KClass
import kotlin.script.experimental.jvm.impl.toContainingJarOrNull
import kotlin.script.experimental.jvm.impl.toFileOrNull
import kotlin.script.experimental.jvm.impl.tryGetResourcePathForClass
import kotlin.script.experimental.jvm.impl.tryGetResourcePathForClassByName
import kotlin.script.templates.standard.ScriptTemplateWithArgs

// TODO: consider moving all these utilites to the build-common or some other shared compiler API module

// Kotlin Compiler dependencies
internal const val KOTLIN_JAVA_STDLIB_JAR = "kotlin-stdlib.jar"
internal const val KOTLIN_JAVA_REFLECT_JAR = "kotlin-reflect.jar"
internal const val KOTLIN_JAVA_SCRIPT_RUNTIME_JAR = "kotlin-script-runtime.jar"
internal const val TROVE4J_JAR = "trove4j.jar"
internal const val KOTLIN_SCRIPTING_COMPILER_JAR = "kotlin-scripting-compiler.jar"
internal const val KOTLIN_SCRIPTING_COMPILER_EMBEDDABLE_JAR = "kotlin-scripting-compiler-embeddable.jar"
internal const val KOTLIN_SCRIPTING_COMPILER_IMPL_JAR = "kotlin-scripting-compiler-impl.jar"
internal const val KOTLIN_SCRIPTING_COMPILER_IMPL_EMBEDDABLE_JAR = "kotlin-scripting-compiler-impl-embeddable.jar"
internal const val KOTLIN_SCRIPTING_COMMON_JAR = "kotlin-scripting-common.jar"
internal const val KOTLIN_SCRIPTING_JVM_JAR = "kotlin-scripting-jvm.jar"

internal const val KOTLIN_COMPILER_NAME = "kotlin-compiler"
internal const val KOTLIN_COMPILER_JAR = "$KOTLIN_COMPILER_NAME.jar"

private val JAR_COLLECTIONS_CLASSES_PATHS = arrayOf("BOOT-INF/classes", "WEB-INF/classes")
private val JAR_COLLECTIONS_LIB_PATHS = arrayOf("BOOT-INF/lib", "WEB-INF/lib")
private val JAR_COLLECTIONS_KEY_PATHS = JAR_COLLECTIONS_CLASSES_PATHS + JAR_COLLECTIONS_LIB_PATHS
internal const val JAR_MANIFEST_RESOURCE_NAME = "META-INF/MANIFEST.MF"

internal const val KOTLIN_SCRIPT_CLASSPATH_PROPERTY = "kotlin.script.classpath"
internal const val KOTLIN_COMPILER_CLASSPATH_PROPERTY = "kotlin.compiler.classpath"
internal const val KOTLIN_COMPILER_JAR_PROPERTY = "kotlin.compiler.jar"
internal const val KOTLIN_STDLIB_JAR_PROPERTY = "kotlin.java.stdlib.jar"
internal const val KOTLIN_REFLECT_JAR_PROPERTY = "kotlin.java.reflect.jar"
// obsolete name, but maybe still used in the wild
// TODO: consider removing
internal const val KOTLIN_RUNTIME_JAR_PROPERTY = "kotlin.java.runtime.jar"
internal const val KOTLIN_SCRIPT_RUNTIME_JAR_PROPERTY = "kotlin.script.runtime.jar"

private val validClasspathFilesExtensions = setOf("jar", "zip", "java")
private val validJarCollectionFilesExtensions = setOf("jar", "war", "zip")

class ClasspathExtractionException(message: String) : Exception(message)

fun classpathFromClassloader(currentClassLoader: ClassLoader, unpackJarCollections: Boolean = false): List? {
    val processedJars = hashSetOf()
    val unpackJarCollectionsDir by lazy {
        File.createTempFile("unpackedJarCollections", null).canonicalFile.apply {
            delete()
            mkdir()
            setReadable(false, false)
            setWritable(false, false)
            setExecutable(false, false)
            setReadable(true, true)
            setWritable(true, true)
            setExecutable(true, true)

            Runtime.getRuntime().addShutdownHook(Thread {
                deleteRecursively()
            })
        }
    }
    return allRelatedClassLoaders(currentClassLoader).flatMap { classLoader ->
        var classPath = emptySequence()
        if (unpackJarCollections && JAR_COLLECTIONS_KEY_PATHS.any { classLoader.getResource(it)?.file?.isNotEmpty() == true }) {
            // if cache dir is specified, find all jar collections (spring boot fat jars and WARs so far, and unpack it accordingly
            val jarCollections = JAR_COLLECTIONS_KEY_PATHS.asSequence().flatMap { currentClassLoader.getResources(it).asSequence() }
                .mapNotNull {
                    it.toContainingJarOrNull()?.takeIf { file ->
                        // additionally mark/check processed collection jars since unpacking is expensive
                        file.extension in validJarCollectionFilesExtensions && processedJars.add(file)
                    }
                }
            classPath += jarCollections.flatMap { it.unpackJarCollection(unpackJarCollectionsDir) }.filter { it.isValidClasspathFile() }
        }
        classPath += when (classLoader) {
            is URLClassLoader -> {
                classLoader.urLs.asSequence().mapNotNull { url -> url.toValidClasspathFileOrNull() }
            }
            else -> {
                classLoader.classPathFromGetUrlsMethodOrNull()
                    ?: classLoader.classPathFromTypicalResourceUrls()
            }
        }
        classPath
    }.filter { processedJars.add(it) }
        .toList().takeIf { it.isNotEmpty() }
}

internal fun URL.toValidClasspathFileOrNull(): File? =
    (toContainingJarOrNull() ?: toFileOrNull())?.takeIf { it.isValidClasspathFile() }

internal fun File.isValidClasspathFile(): Boolean =
    isDirectory || (isFile && extension in validClasspathFilesExtensions)

private fun ClassLoader.classPathFromGetUrlsMethodOrNull(): Sequence? {
    return try {
        // e.g. for IDEA platform UrlClassLoader
        val getUrls = this::class.java.getMethod("getUrls")
        getUrls.isAccessible = true
        val result = getUrls.invoke(this) as? List
        result?.asSequence()?.filterIsInstance()?.mapNotNull { it.toValidClasspathFileOrNull() }
    } catch (e: Throwable) {
        null
    }
}

internal class ClassLoaderResourceRootFIlePathCalculator(private val keyResourcePath: String) {
    private var keyResourcePathDepth = -1

    operator fun invoke(resourceFile: File): File {
        if (keyResourcePathDepth < 0) {
            keyResourcePathDepth = if (keyResourcePath.isBlank()) 0 else (keyResourcePath.trim('/').count { it == '/' } + 1)
        }
        var root = resourceFile
        for (i in 0 until keyResourcePathDepth) {
            root = root.parentFile
        }
        return root
    }
}

internal fun ClassLoader.rawClassPathFromKeyResourcePath(keyResourcePath: String): Sequence {
    val resourceRootCalc = ClassLoaderResourceRootFIlePathCalculator(keyResourcePath)
    return getResources(keyResourcePath).asSequence().mapNotNull { url ->
        if (url.protocol == "jar") {
            (url.openConnection() as? JarURLConnection)?.jarFileURL?.toFileOrNull()
        } else {
            url.toFileOrNull()?.let { resourceRootCalc(it) }
        }
    }
}

fun ClassLoader.classPathFromTypicalResourceUrls(): Sequence =
// roots without manifest cases are detected in some test scenarios
// manifests without containing directory entries are detected in some optimized jars, e.g. after proguard
// TODO: investigate whether getting resources with empty name works in all situations
    (rawClassPathFromKeyResourcePath("") + rawClassPathFromKeyResourcePath(JAR_MANIFEST_RESOURCE_NAME))
        .distinct()
        .filter { it.isValidClasspathFile() }

private fun File.unpackJarCollection(rootTempDir: File): Sequence {
    val targetDir = File.createTempFile(nameWithoutExtension, null, rootTempDir).apply {
        delete()
        mkdir()
    }

    return try {
        ArrayList().apply {
            JarInputStream(FileInputStream(this@unpackJarCollection)).use { jarInputStream ->
                for (classesDir in JAR_COLLECTIONS_CLASSES_PATHS) {
                    add(File(targetDir, classesDir))
                }
                do {
                    val entry = jarInputStream.nextJarEntry
                    if (entry != null) {
                        try {
                            if (!entry.isDirectory) {
                                val file = File(targetDir, entry.name)
                                if (JAR_COLLECTIONS_LIB_PATHS.any { entry.name.startsWith("$it/") }) {
                                    add(file)
                                }
                                file.parentFile.mkdirs()
                                file.outputStream().use { outputStream ->
                                    jarInputStream.copyTo(outputStream)
                                    outputStream.flush()
                                }
                            }
                        } finally {
                            jarInputStream.closeEntry()
                        }
                    }
                } while (entry != null)
            }
        }.asSequence()
    } catch (e: Throwable) {
        targetDir.deleteRecursively()
        throw e
    }
}

fun classpathFromClasspathProperty(): List? =
    System.getProperty("java.class.path")
        ?.split(String.format("\\%s", File.pathSeparatorChar).toRegex())
        ?.dropLastWhile(String::isEmpty)
        ?.map(::File)

fun classpathFromClass(classLoader: ClassLoader, klass: KClass): List? =
    classpathFromFQN(classLoader, klass.qualifiedName!!)

fun classpathFromClass(klass: KClass): List? =
    classpathFromClass(klass.java.classLoader, klass)

inline fun  classpathFromClass(): List? = classpathFromClass(T::class)

fun classpathFromFQN(classLoader: ClassLoader, fqn: String): List? {
    val clp = "${fqn.replace('.', '/')}.class"
    return classLoader.rawClassPathFromKeyResourcePath(clp).filter { it.isValidClasspathFile() }.toList().takeIf { it.isNotEmpty() }
}

fun File.matchMaybeVersionedFile(baseName: String) =
    name == baseName ||
            name == baseName.removeSuffix(".jar") || // for classes dirs
            Regex(Regex.escape(baseName.removeSuffix(".jar")) + "(-\\d.*)?\\.jar").matches(name)

fun File.hasParentNamed(baseName: String): Boolean =
    nameWithoutExtension == baseName || parentFile?.hasParentNamed(baseName) ?: false

private const val KOTLIN_COMPILER_EMBEDDABLE_JAR = "$KOTLIN_COMPILER_NAME-embeddable.jar"

// Iterating over classloaders tree in a regular, parent-first order
private fun allRelatedClassLoaders(clsLoader: ClassLoader, visited: MutableSet = HashSet()): Sequence {
    if (!visited.add(clsLoader)) return emptySequence()

    val singleParent = clsLoader.parent
    if (singleParent != null)
        return sequenceOf(singleParent).flatMap { allRelatedClassLoaders(it, visited) } + clsLoader

    return try {
        val arrayOfClassLoaders = getParentClassLoaders(clsLoader)
        // TODO: PluginClassLoader uses filtering (mustBeLoadedByPlatform), consider using the same logic, if possible
        // (untill proper compiling from classloader instead of classpath is implemented)
        arrayOfClassLoaders.asSequence().flatMap { allRelatedClassLoaders(it, visited) } + clsLoader
    } catch (e: Throwable) {
        sequenceOf(clsLoader)
    }
}

private fun getParentClassLoaders(clsLoader: ClassLoader): Array {
    return try {
        getParentsForNewClassLoader(clsLoader)
    } catch (exception: NoSuchMethodException) {
        try {
            getParentsForOldClassLoader(clsLoader)
        } catch (exception: NoSuchFieldException) {
            // Possibly idea sources and kotlin compiler had diverged
            emptyArray()
        }
    }
}

@Throws(NoSuchFieldException::class)
private fun getParentsForOldClassLoader(clsLoader: ClassLoader): Array {
    // Correct way of getting parents in com.intellij.ide.plugins.cl.PluginClassLoader from IDEA 202 and earlier
    val field = clsLoader.javaClass.getDeclaredField("myParents") // com.intellij.ide.plugins.cl.PluginClassLoader
    field.isAccessible = true

    @Suppress("UNCHECKED_CAST")
    return field.get(clsLoader) as Array
}

@Throws(NoSuchMethodException::class)
private fun getParentsForNewClassLoader(clsLoader: ClassLoader): Array {
    // Correct way of getting parents in com.intellij.ide.plugins.cl.PluginClassLoader from IDEA 203+
    val method = clsLoader.javaClass.getDeclaredMethod("getAllParents")
    method.isAccessible = true

    @Suppress("UNCHECKED_CAST")
    return method.invoke(clsLoader) as Array
}

internal fun List.takeIfContainsAll(vararg keyNames: String): List? =
    takeIf { classpath ->
        keyNames.all { key -> classpath.any { it.matchMaybeVersionedFile(key) } }
    }

internal fun List.filterIfContainsAll(vararg keyNames: String): List? {
    val foundKeys = mutableSetOf()
    val res = arrayListOf()
    for (cpentry in this) {
        for (prefix in keyNames) {
            if (cpentry.matchMaybeVersionedFile(prefix) || (cpentry.isDirectory && cpentry.hasParentNamed(prefix))) {
                foundKeys.add(prefix)
                res.add(cpentry)
                break
            }
        }
    }
    return res.takeIf { foundKeys.containsAll(keyNames.asList()) }
}

internal fun List.takeIfContainsAny(vararg keyNames: String): List? =
    takeIf { classpath ->
        keyNames.any { key -> classpath.any { it.matchMaybeVersionedFile(key) } }
    }

fun scriptCompilationClasspathFromContextOrNull(
    vararg keyNames: String,
    classLoader: ClassLoader = Thread.currentThread().contextClassLoader,
    wholeClasspath: Boolean = false,
    unpackJarCollections: Boolean = false
): List? {
    fun List.takeAndFilter() = when {
        isEmpty() -> null
        wholeClasspath -> takeIfContainsAll(*keyNames)
        else -> filterIfContainsAll(*keyNames)
    }

    val fromProperty = System.getProperty(KOTLIN_SCRIPT_CLASSPATH_PROPERTY)?.split(File.pathSeparator)?.map(::File)
    if (fromProperty != null) return fromProperty

    return classpathFromClassloader(classLoader, unpackJarCollections)?.takeAndFilter()
        ?: classpathFromClasspathProperty()?.takeAndFilter()
}


fun scriptCompilationClasspathFromContextOrStdlib(
    vararg keyNames: String,
    classLoader: ClassLoader = Thread.currentThread().contextClassLoader,
    wholeClasspath: Boolean = false
): List =
    scriptCompilationClasspathFromContextOrNull(
        *keyNames,
        classLoader = classLoader,
        wholeClasspath = wholeClasspath
    )
        ?: KotlinJars.kotlinScriptStandardJars

fun scriptCompilationClasspathFromContext(
    vararg keyNames: String,
    classLoader: ClassLoader = Thread.currentThread().contextClassLoader,
    wholeClasspath: Boolean = false,
    unpackJarCollections: Boolean = false
): List =
    scriptCompilationClasspathFromContextOrNull(
        *keyNames,
        classLoader = classLoader,
        wholeClasspath = wholeClasspath,
        unpackJarCollections = unpackJarCollections
    )
        ?: throw ClasspathExtractionException("Unable to get script compilation classpath from context, please specify explicit classpath via \"$KOTLIN_SCRIPT_CLASSPATH_PROPERTY\" property")

object KotlinJars {

    private val explicitCompilerClasspath: List? by lazy {
        System.getProperty(KOTLIN_COMPILER_CLASSPATH_PROPERTY)?.split(File.pathSeparator)?.map(::File)
            ?: System.getProperty(KOTLIN_COMPILER_JAR_PROPERTY)?.let(::File)?.takeIf(File::exists)?.let { listOf(it) }
    }

    val compilerClasspath: List by lazy {
        findCompilerClasspath(withScripting = false)
    }

    val compilerWithScriptingClasspath: List by lazy {
        findCompilerClasspath(withScripting = true)
    }

    private fun findCompilerClasspath(withScripting: Boolean): List {
        val kotlinCompilerJars = listOf(
            KOTLIN_COMPILER_JAR,
            KOTLIN_COMPILER_EMBEDDABLE_JAR
        )
        val kotlinLibsJars = listOf(
            KOTLIN_JAVA_STDLIB_JAR,
            KOTLIN_JAVA_REFLECT_JAR,
            KOTLIN_JAVA_SCRIPT_RUNTIME_JAR,
            TROVE4J_JAR
        )
        val kotlinScriptingJars = if (withScripting) listOf(
            KOTLIN_SCRIPTING_COMPILER_JAR,
            KOTLIN_SCRIPTING_COMPILER_EMBEDDABLE_JAR,
            KOTLIN_SCRIPTING_COMPILER_IMPL_JAR,
            KOTLIN_SCRIPTING_COMPILER_IMPL_EMBEDDABLE_JAR,
            KOTLIN_SCRIPTING_COMMON_JAR,
            KOTLIN_SCRIPTING_JVM_JAR
        ) else emptyList()

        val kotlinBaseJars = kotlinCompilerJars + kotlinLibsJars + kotlinScriptingJars

        val classpath = explicitCompilerClasspath
        // search classpath from context classloader and `java.class.path` property
            ?: (classpathFromFQN(Thread.currentThread().contextClassLoader, "org.jetbrains.kotlin.cli.jvm.K2JVMCompiler")
                ?: classpathFromClassloader(Thread.currentThread().contextClassLoader)?.takeIf { it.isNotEmpty() }
                ?: classpathFromClasspathProperty()
                    )?.filter { f -> kotlinBaseJars.any { f.matchMaybeVersionedFile(it) } }?.takeIf { it.isNotEmpty() }
        // if autodetected, additionally check for presence of the compiler jars
        if (classpath == null || (explicitCompilerClasspath == null && classpath.none { f ->
                kotlinCompilerJars.any {
                    f.matchMaybeVersionedFile(
                        it
                    )
                }
            })) {
            throw FileNotFoundException("Cannot find kotlin compiler jar, set kotlin.compiler.classpath property to proper location")
        }
        return classpath
    }

    fun getLib(propertyName: String, jarName: String, markerClass: KClass<*>, classLoader: ClassLoader? = null): File? =
        getExplicitLib(propertyName, jarName)
            ?: run {
                val requestedClassloader = classLoader ?: Thread.currentThread().contextClassLoader
                val byName =
                    if (requestedClassloader == markerClass.java.classLoader) null
                    else tryGetResourcePathForClassByName(markerClass.java.name, requestedClassloader)
                byName ?: tryGetResourcePathForClass(markerClass.java)
            }?.takeIf(File::exists)

    fun getLib(propertyName: String, jarName: String, markerClassName: String, classLoader: ClassLoader? = null): File? =
        getExplicitLib(propertyName, jarName)
            ?: tryGetResourcePathForClassByName(
                markerClassName, classLoader ?: Thread.currentThread().contextClassLoader
            )?.takeIf(File::exists)

    private fun getExplicitLib(propertyName: String, jarName: String) =
        System.getProperty(propertyName)?.let(::File)?.takeIf(File::exists)
            ?: explicitCompilerClasspath?.firstOrNull { it.matchMaybeVersionedFile(jarName) }?.takeIf(File::exists)

    val stdlibOrNull: File? by lazy {
        System.getProperty(KOTLIN_STDLIB_JAR_PROPERTY)?.let(::File)?.takeIf(File::exists)
            ?: getLib(
                KOTLIN_RUNTIME_JAR_PROPERTY,
                KOTLIN_JAVA_STDLIB_JAR,
                JvmStatic::class
            )
    }

    val stdlib: File by lazy {
        stdlibOrNull
            ?: throw Exception("Unable to find kotlin stdlib, please specify it explicitly via \"$KOTLIN_STDLIB_JAR_PROPERTY\" property")
    }

    val reflectOrNull: File? by lazy {
        getLib(
            KOTLIN_REFLECT_JAR_PROPERTY,
            KOTLIN_JAVA_REFLECT_JAR,
            "kotlin.reflect.full.KClasses" // using a class that is a part of the kotlin-reflect.jar
        )
    }

    val scriptRuntimeOrNull: File? by lazy {
        getLib(
            KOTLIN_SCRIPT_RUNTIME_JAR_PROPERTY,
            KOTLIN_JAVA_SCRIPT_RUNTIME_JAR,
            ScriptTemplateWithArgs::class
        )
    }

    val scriptRuntime: File by lazy {
        scriptRuntimeOrNull
            ?: throw Exception("Unable to find kotlin script runtime, please specify it explicitly via \"$KOTLIN_SCRIPT_RUNTIME_JAR_PROPERTY\" property")
    }

    val kotlinScriptStandardJars
        get() = listOf(
            stdlibOrNull,
            scriptRuntimeOrNull
        ).filterNotNull()

    val kotlinScriptStandardJarsWithReflect
        get() = listOf(
            stdlibOrNull,
            scriptRuntimeOrNull,
            reflectOrNull
        ).filterNotNull()
}