From d2eff4ae1597776d2f728dcfdb24aaa08e9de2b6 Mon Sep 17 00:00:00 2001 From: Runxi Yu Date: Wed, 12 Feb 2025 02:02:17 +0800 Subject: 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 +--- 6 files changed, 34 insertions(+), 34 deletions(-) diff --git a/handle_repo_index.go b/handle_repo_index.go index da19332..af6a625 100644 --- a/handle_repo_index.go +++ b/handle_repo_index.go @@ -37,7 +37,7 @@ func handle_repo_index(w http.ResponseWriter, r *http.Request) { 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 62e0e4f..67079c8 100644 --- a/handle_repo_log.go +++ b/handle_repo_log.go @@ -22,25 +22,12 @@ func handle_repo_log(w http.ResponseWriter, r *http.Request) { 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 1d18598..7ed6f1d 100644 --- a/handle_repo_tree.go +++ b/handle_repo_tree.go @@ -103,7 +103,7 @@ func handle_repo_tree(w http.ResponseWriter, r *http.Request) { 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 72e0ec4..32a3a7d 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 @@ import ( 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 "" - } - readme_file_contents, err := readme_file.Contents() - if err != nil { - return "Unable to fetch contents of README: " + err.Error() +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("
" + html.EscapeString(readme_file_contents) + "
") } - 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() + 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())) } - 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 47c6381..de2d1da 100644 --- a/templates/repo_index.html.tmpl +++ b/templates/repo_index.html.tmpl @@ -62,7 +62,7 @@ - + diff --git a/templates/repo_tree_dir.html.tmpl b/templates/repo_tree_dir.html.tmpl index 07a8df5..dd5ecaf 100644 --- a/templates/repo_tree_dir.html.tmpl +++ b/templates/repo_tree_dir.html.tmpl @@ -39,9 +39,7 @@
- + -- cgit v1.2.3
- README.md - {{ .readme_filename }}