From d2eff4ae1597776d2f728dcfdb24aaa08e9de2b6 Mon Sep 17 00:00:00 2001
From: Runxi Yu <me@runxiyu.org>
Date: Wed, 12 Feb 2025 02:02:17 +0800
Subject: [PATCH] render_readme.go: Render plain READMEs too

---
 handle_repo_index.go              |  2 +-
 handle_repo_log.go                | 17 ++---------------
 handle_repo_tree.go               |  2 +-
 render_readme.go                  | 41 ++++++++++++++++++++++++++++-------------
 templates/repo_index.html.tmpl    |  2 +-
 templates/repo_tree_dir.html.tmpl |  4 +---

diff --git a/handle_repo_index.go b/handle_repo_index.go
index da1933291c81337f0a27d104c79cd40b330deb7f..af6a62517a27edf24ad3f2b19112fed663cc955f 100644
--- a/handle_repo_index.go
+++ b/handle_repo_index.go
@@ -37,7 +37,7 @@ 		_, _ = w.Write([]byte("Error getting file tree: " + err.Error()))
 		return
 	}
 
-	data["readme"] = render_readme_at_tree(tree)
+	data["readme_filename"], data["readme"] = render_readme_at_tree(tree)
 	data["files"] = build_display_git_tree(tree)
 
 	err = templates.ExecuteTemplate(w, "repo_index", data)
diff --git a/handle_repo_log.go b/handle_repo_log.go
index 62e0e4fba49665c9f5c414797b68d38515c64a50..67079c87c737a6f357034c581c60f650cfaa24b7 100644
--- a/handle_repo_log.go
+++ b/handle_repo_log.go
@@ -22,25 +22,12 @@ 		_, _ = w.Write([]byte("Error getting repo reference: " + err.Error()))
 		return
 	}
 	ref_hash := ref.Hash()
-	recent_commits, err := get_recent_commits(repo, ref_hash, -1)
+	commits, err := get_recent_commits(repo, ref_hash, -1)
 	if err != nil {
 		_, _ = w.Write([]byte("Error getting recent commits: " + err.Error()))
 		return
 	}
-	data["commits"] = recent_commits
-	commit_object, err := repo.CommitObject(ref_hash)
-	if err != nil {
-		_, _ = w.Write([]byte("Error getting commit object: " + err.Error()))
-		return
-	}
-	tree, err := commit_object.Tree()
-	if err != nil {
-		_, _ = w.Write([]byte("Error getting file tree: " + err.Error()))
-		return
-	}
-
-	data["readme"] = render_readme_at_tree(tree)
-	data["files"] = build_display_git_tree(tree)
+	data["commits"] = commits
 
 	err = templates.ExecuteTemplate(w, "repo_log", data)
 	if err != nil {
diff --git a/handle_repo_tree.go b/handle_repo_tree.go
index 1d185989956bfde97821e5d59a8f49a783550f3f..7ed6f1d0fb5f15708ef54219284a37f6bc35da3a 100644
--- a/handle_repo_tree.go
+++ b/handle_repo_tree.go
@@ -103,7 +103,7 @@ 		http.Redirect(w, r, path.Base(path_spec)+"/", http.StatusSeeOther)
 		return
 	}
 
-	data["readme"] = render_readme_at_tree(target)
+	data["readme_filename"], data["readme"] = render_readme_at_tree(target)
 	data["files"] = build_display_git_tree(target)
 
 	err = templates.ExecuteTemplate(w, "repo_tree_dir", data)
diff --git a/render_readme.go b/render_readme.go
index 72e0ec4585fd688ad08dbcbf1c071f4cb414de0a..32a3a7de2b5c759b12a1fe48d32a1c3e54408975 100644
--- a/render_readme.go
+++ b/render_readme.go
@@ -2,6 +2,7 @@ package main
 
 import (
 	"bytes"
+	"html"
 	"html/template"
 
 	"github.com/go-git/go-git/v5/plumbing/object"
@@ -12,20 +13,34 @@ )
 
 var markdown_converter = goldmark.New(goldmark.WithExtensions(extension.GFM))
 
-func render_readme_at_tree(tree *object.Tree) any {
-	readme_file, err := tree.File("README.md")
-	if err != nil {
-		return ""
+func render_readme_at_tree(tree *object.Tree) (readme_filename string, readme_content template.HTML) {
+	var readme_rendered_unsafe bytes.Buffer
+
+	readme_file, err := tree.File("README")
+	if err == nil {
+		readme_file_contents, err := readme_file.Contents()
+		if err != nil {
+			return "Error fetching README", string_escape_html("Unable to fetch contents of README: " + err.Error())
+		}
+		return "README", template.HTML("<pre>" + html.EscapeString(readme_file_contents) + "</pre>")
 	}
-	readme_file_contents, err := readme_file.Contents()
-	if err != nil {
-		return "Unable to fetch contents of README: " + err.Error()
+
+	readme_file, err = tree.File("README.md")
+	if err == nil {
+		readme_file_contents, err := readme_file.Contents()
+		if err != nil {
+			return "Error fetching README", string_escape_html("Unable to fetch contents of README: " + err.Error())
+		}
+		err = markdown_converter.Convert([]byte(readme_file_contents), &readme_rendered_unsafe)
+		if err != nil {
+			return "Error fetching README", string_escape_html("Unable to render README: " + err.Error())
+		}
+		return "README.md", template.HTML(bluemonday.UGCPolicy().SanitizeBytes(readme_rendered_unsafe.Bytes()))
 	}
 
-	var readme_rendered_unsafe bytes.Buffer
-	err = markdown_converter.Convert([]byte(readme_file_contents), &readme_rendered_unsafe)
-	if err != nil {
-		return "Unable to render README: " + err.Error()
-	}
-	return template.HTML(bluemonday.UGCPolicy().SanitizeBytes(readme_rendered_unsafe.Bytes()))
+	return "", ""
+}
+
+func string_escape_html(s string) template.HTML {
+	return template.HTML(html.EscapeString(s))
 }
diff --git a/templates/repo_index.html.tmpl b/templates/repo_index.html.tmpl
index 47c6381236e9039aab5b21dda033d5e5874d3697..de2d1da50d722d999deace40fc67a5acf9d1bb8f 100644
--- a/templates/repo_index.html.tmpl
+++ b/templates/repo_index.html.tmpl
@@ -62,7 +62,7 @@ 				<input id="toggle-table-readme" type="checkbox" class="toggle-table-off" />
 				<table class="wide">
 					<thead>
 						<tr class="title-row">
-							<th><label for="toggle-table-readme">README</label></th>
+							<th><label for="toggle-table-readme">{{ .readme_filename }}</label></th>
 						</tr>
 					</thead>
 					<tbody>
diff --git a/templates/repo_tree_dir.html.tmpl b/templates/repo_tree_dir.html.tmpl
index 07a8df5453d2d9e6bfdb6a469f25a4a1d2fee4a4..dd5ecafddac8b1b79f32175264356dfbf7fb0bde 100644
--- a/templates/repo_tree_dir.html.tmpl
+++ b/templates/repo_tree_dir.html.tmpl
@@ -39,9 +39,7 @@ 			{{ if .readme }}
 				<table class="wide">
 					<thead>
 						<tr class="title-row">
-							<th>
-								README.md
-							</th>
+							<th>{{ .readme_filename }}</th>
 						</tr>
 					</thead>
 					<tbody>

-- 
2.48.1