Process links from static documentaiton corrently

Author: romanowski

project/Build.scala

@@ -1480,6 +1480,7 @@ object Build {
             "org.jetbrains.kotlinx" % "kotlinx-html-jvm" % "0.7.2", // Needs update when dokka version changes
             "com.vladsch.flexmark" % "flexmark-all" % "0.42.12",
             "nl.big-o" % "liqp" % "0.6.7",
+            "org.jsoup" % "jsoup" % "1.13.1", // Needed to process .html files for static site
             "args4j" % "args4j" % "2.33",
             Dependencies.`jackson-dataformat-yaml`,
 

scala3doc/src/dotty/dokka/site/PartiallyRenderedContent.scala

@@ -4,6 +4,9 @@ package site
 import org.jetbrains.dokka.model.DisplaySourceSet
 import org.jetbrains.dokka.model.properties.PropertyContainer
 import org.jetbrains.dokka.pages.{ContentNode, DCI, Style}
+import org.jetbrains.dokka.base.resolvers.local.LocationProvider
+import com.vladsch.flexmark.convert.html.FlexmarkHtmlParser
+import org.jsoup.Jsoup
 
 case class PartiallyRenderedContent(
   template: TemplateFile,
@@ -23,3 +26,8 @@ case class PartiallyRenderedContent(
     copy(getSourceSets = sourceSets)
 
   lazy val resolved = template.resolveToHtml(context)
+
+  def procsesHtml(linkTo: String => String): String =
+    val document = Jsoup.parse(resolved.code)
+    document.select("a").forEach(element => element.attr("href", linkTo(element.attr("href"))))// forrach does not work here
+    document.outerHtml()

scala3doc/src/dotty/dokka/site/StaticPageNode.scala

@@ -10,10 +10,7 @@ import org.jetbrains.dokka.model.Documentable
 import org.jetbrains.dokka.pages._
 import org.jetbrains.dokka.transformers.pages.PageTransformer
 
-case class LoadedTemplate(templateFile: TemplateFile, children: List[LoadedTemplate], file: File) {
-  def relativePath(root: File): String =
-    root.toPath().relativize(file.toPath()).toString().replace(File.separatorChar, '.')
-}
+case class LoadedTemplate(templateFile: TemplateFile, children: List[LoadedTemplate], file: File)
 
 case class StaticPageNode(
                            template: TemplateFile,

scala3doc/src/dotty/dokka/site/StaticSiteContext.scala

@@ -3,7 +3,8 @@ package site
 
 import java.io.File
 import java.nio.file.Files
-
+import java.nio.file.Path
+import java.nio.file.Paths
 
 import org.jetbrains.dokka.base.parsers.MarkdownParser
 import org.jetbrains.dokka.base.transformers.pages.comments.DocTagToContentConverter
@@ -15,14 +16,16 @@ import org.jetbrains.dokka.pages.{ContentKind, ContentNode, DCI, PageNode}
 import org.jetbrains.dokka.plugability.DokkaContext
 import org.jetbrains.dokka.pages.Style
 import org.jetbrains.dokka.model.DisplaySourceSet
+import util.Try
 
 import scala.collection.JavaConverters._
 
 class StaticSiteContext(val root: File, sourceSets: Set[SourceSetWrapper]):
 
   def indexPage():Option[StaticPageNode] =
     val files = List(new File(root, "index.html"), new File(root, "index.md")).filter { _.exists() }
-    if (files.size > 1) println(s"ERROR: Multiple root index pages found: ${files.map(_.getAbsolutePath)}") // TODO (#14): provide proper error handling
+    // TODO (https://github.com/lampepfl/scala3doc/issues/238): provide proper error handling
+    if (files.size > 1) println(s"ERROR: Multiple root index pages found: ${files.map(_.getAbsolutePath)}")
     files.flatMap(loadTemplate(_, isBlog = false)).headOption.map(templateToPage)
 
   lazy val layouts: Map[String, TemplateFile] =
@@ -52,7 +55,8 @@ class StaticSiteContext(val root: File, sourceSets: Set[SourceSetWrapper]):
         val allFiles = topLevelFiles.filter(_.isDirectory).flatMap(_.listFiles())
         val (indexes, children) = allFiles.flatMap(loadTemplate(_)).partition(_.templateFile.isIndexPage())
         if (indexes.size > 1)
-          println(s"ERROR: Multiple index pages for $from found in ${indexes.map(_.file)}") // TODO (#14): provide proper error handling
+          // TODO (https://github.com/lampepfl/scala3doc/issues/238): provide proper error handling
+          println(s"ERROR: Multiple index pages for $from found in ${indexes.map(_.file)}")
 
         def loadIndexPage(): TemplateFile =
           val indexFiles = from.listFiles { file =>file.getName == "index.md" || file.getName == "index.html" }
@@ -68,7 +72,8 @@ class StaticSiteContext(val root: File, sourceSets: Set[SourceSetWrapper]):
         Some(LoadedTemplate(templateFile, children.toList, from))
       catch
           case e: RuntimeException =>
-            e.printStackTrace() // TODO (#14): provide proper error handling
+            // TODO (https://github.com/lampepfl/scala3doc/issues/238): provide proper error handling
+            e.printStackTrace()
             None
 
   def asContent(doctag: DocTag, dri: DRI) = new DocTagToContentConverter().buildContent(
@@ -95,9 +100,15 @@ class StaticSiteContext(val root: File, sourceSets: Set[SourceSetWrapper]):
     dir("docs").flatMap(_.listFiles()).flatMap(loadTemplate(_, isBlog = false))
       ++ dir("blog").flatMap(loadTemplate(_, isBlog = true))
 
+  def driForLink(template: TemplateFile, link: String): Try[DRI] = Try(driFor(
+        if link.startsWith("/") then root.toPath.resolve(link.drop(1))
+        else template.file.toPath.getParent().resolve(link)
+    ))
+
+  private def driFor(dest: Path): DRI = mkDRI(s"_.${root.toPath.relativize(dest)}")
+
   def templateToPage(myTemplate: LoadedTemplate): StaticPageNode =
-    def pathToDRI(path: String) = mkDRI(s"_.$path")
-    val dri = pathToDRI(myTemplate.relativePath(root))
+    val dri = driFor(myTemplate.file.toPath)
     val content = new PartiallyRenderedContent(
       myTemplate.templateFile,
       this,

scala3doc/src/dotty/dokka/site/processors.scala

@@ -91,7 +91,7 @@ class SitePagesCreator(ctx: Option[StaticSiteContext]) extends BaseStaticSitePro
     val (contentPage, others) = input.getChildren.asScala.toList.partition { _.isInstanceOf[ContentPage] }
     val modifiedModuleRoot = processRootPage(input, contentPage)
     val (indexes, children) = ctx.pages.partition(_.template.isIndexPage())
-      // TODO (#14): provide proper error handling
+    // TODO (https://github.com/lampepfl/scala3doc/issues/238): provide proper error handling
     if (indexes.size > 1) println("ERROR: Multiple index pages found $indexes}")
 
     val rootContent = indexes.headOption.fold(ctx.asContent(Text(), mkDRI(extra = "root_content")).get(0))(_.getContent)

scala3doc/src/dotty/renderers/DotDiagramBuilder.scala

@@ -3,7 +3,6 @@ package dotty.dokka
 import dotty.dokka.model._
 import org.jetbrains.dokka.model._
 import org.jetbrains.dokka.links.DRI
-import org.jetbrains.dokka.base.resolvers.local.LocationProvider
 import org.jetbrains.dokka.pages._
 import dotty.dokka.model.api.Kind
 import HTML._

scala3doc/src/dotty/renderers/ScalaHtmlRenderer.scala

@@ -8,6 +8,7 @@ import org.jetbrains.dokka._
 import HTML._
 import collection.JavaConverters._
 import java.net.URI
+import java.net.URL
 import java.util.{List => JList, Set => JSet}
 import kotlinx.html.FlowContent
 import kotlinx.html.stream.StreamKt
@@ -21,6 +22,7 @@ import dotty.dokka.model.api.HierarchyGraph
 import org.jetbrains.dokka.base.resolvers.local.LocationProvider
 import dotty.dokka.site.StaticPageNode
 import dotty.dokka.site.PartiallyRenderedContent
+import scala.util.Try
 
 class SignatureRenderer(pageContext: ContentPage, sourceSetRestriciton: JSet[DisplaySourceSet], locationProvider: LocationProvider):
   def link(dri: DRI): Option[String] = Option(locationProvider.resolve(dri, sourceSetRestriciton, pageContext))
@@ -240,7 +242,13 @@ class ScalaHtmlRenderer(ctx: DokkaContext) extends HtmlRenderer(ctx) {
 
     page.getContent match
       case prc: PartiallyRenderedContent =>
-        withHtml(context, prc.resolved.code)
+        def processLocalLink(str: String): String =
+          // TODO (https://github.com/lampepfl/scala3doc/issues/238) error handling
+          prc.context.driForLink(prc.template, str).toOption
+            .flatMap(dri => Option(getLocationProvider.resolve(dri, sourceSets, page)))
+            .getOrElse(str)
+
+        withHtml(context, prc.procsesHtml(url => Try(URL(url)).fold(_ => processLocalLink(url), _ => url)))
       case content =>
         build(content, context, page, /*sourceSetRestriction=*/null)