aboutsummaryrefslogtreecommitdiff
path: root/core/src/main/kotlin/resolvers/ExternalLocationProvider.kt
blob: d3d8fa0dba50a08a033a35610198788eaa075e19 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
package org.jetbrains.dokka.resolvers

import org.jetbrains.dokka.DokkaConfiguration.ExternalDocumentationLink
import org.jetbrains.dokka.links.DRI
import java.net.HttpURLConnection
import java.net.URL
import java.net.URLConnection

object ExternalLocationProvider { // TODO: Refactor this!!!
    private const val DOKKA_PARAM_PREFIX = "\$dokka."

    private val cache: MutableMap<URL, LocationInfo> = mutableMapOf()

    fun getLocation(dri: DRI, externalDocumentationLinks: List<ExternalDocumentationLink>): String {
        val toResolve: MutableList<ExternalDocumentationLink> = mutableListOf()
        for(link in externalDocumentationLinks){
            val info = cache[link.packageListUrl]
            if(info == null) {
                toResolve.add(link)
            } else if(info.packages.contains(dri.packageName)) {
                return link.url.toExternalForm() + getLink(dri, info)
            }
        }
        // Not in cache, resolve packageLists
        while (toResolve.isNotEmpty()){
            val link = toResolve.first().also { toResolve.remove(it) }
            val locationInfo = loadPackageList(link.packageListUrl)
            if(locationInfo.packages.contains(dri.packageName)) {
                return link.url.toExternalForm() + getLink(dri, locationInfo)
            }
        }
        return ""
    }

    private fun getLink(dri: DRI, locationInfo: LocationInfo): String = when(locationInfo.format) {
        "javadoc" ->  dri.toJavadocLocation(8)
        "kotlin-website-html", "html" -> locationInfo.locations[dri.packageName + "." + dri.classNames] ?: dri.toDokkaLocation(".html")
        "markdown" -> locationInfo.locations[dri.packageName + "." + dri.classNames] ?: dri.toDokkaLocation(".md")
        // TODO: rework this
        else -> throw RuntimeException("Unrecognized format")
    }


    private fun loadPackageList(url: URL): LocationInfo {
        val packageListStream = url.doOpenConnectionToReadContent().getInputStream()
        val (params, packages) =
            packageListStream
                .bufferedReader()
                .useLines { lines -> lines.partition { it.startsWith(DOKKA_PARAM_PREFIX) } }

        val paramsMap = params.asSequence()
            .map { it.removePrefix(DOKKA_PARAM_PREFIX).split(":", limit = 2) }
            .groupBy({ (key, _) -> key }, { (_, value) -> value })

        val format = paramsMap["format"]?.singleOrNull() ?: "javadoc"

        val locations = paramsMap["location"].orEmpty()
            .map { it.split("\u001f", limit = 2) }
            .map { (key, value) -> key to value }
            .toMap()

        val info = LocationInfo(format, packages.toSet(), locations)
        cache[url] = info
        return info
    }

    private fun URL.doOpenConnectionToReadContent(timeout: Int = 10000, redirectsAllowed: Int = 16): URLConnection {
        val connection = this.openConnection().apply {
            connectTimeout = timeout
            readTimeout = timeout
        }

        when (connection) {
            is HttpURLConnection -> {
                return when (connection.responseCode) {
                    in 200..299 -> {
                        connection
                    }
                    HttpURLConnection.HTTP_MOVED_PERM,
                    HttpURLConnection.HTTP_MOVED_TEMP,
                    HttpURLConnection.HTTP_SEE_OTHER -> {
                        if (redirectsAllowed > 0) {
                            val newUrl = connection.getHeaderField("Location")
                            URL(newUrl).doOpenConnectionToReadContent(timeout, redirectsAllowed - 1)
                        } else {
                            throw RuntimeException("Too many redirects")
                        }
                    }
                    else -> {
                        throw RuntimeException("Unhandled http code: ${connection.responseCode}")
                    }
                }
            }
            else -> return connection
        }
    }
    data class LocationInfo(val format: String, val packages: Set<String>, val locations: Map<String, String>)

}