feat: allow any README for .profile (#8798)

closes #1624

Co-authored-by: Maxim Slipenko <maks1ms@altlinux.org>
Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/8798
Reviewed-by: Otto <otto@codeberg.org>
Co-authored-by: Maxim Slipenko <maks1ms@noreply.codeberg.org>
Co-committed-by: Maxim Slipenko <maks1ms@noreply.codeberg.org>
This commit is contained in:
Maxim Slipenko 2025-09-01 13:58:00 +02:00 committed by Otto
commit ed3b70cbb9
7 changed files with 102 additions and 34 deletions

View file

@ -5,6 +5,8 @@ package org
import (
"fmt"
gotemplate "html/template"
"io"
"net/http"
"path"
"strings"
@ -180,20 +182,30 @@ func prepareOrgProfileReadme(ctx *context.Context, profileGitRepo *git.Repositor
} else {
defer rc.Close()
if profileContent, err := markdown.RenderReader(&markup.RenderContext{
Ctx: ctx,
GitRepo: profileGitRepo,
Links: markup.Links{
// Pass repo link to markdown render for the full link of media elements.
// The profile of default branch would be shown.
Base: profileDbRepo.Link(),
BranchPath: path.Join("branch", util.PathEscapeSegments(profileDbRepo.DefaultBranch)),
},
Metas: map[string]string{"mode": "document"},
}, rc); err != nil {
log.Error("failed to RenderString: %v", err)
if markupType := markup.Type(profileReadme.Name()); markupType != "" {
if profileContent, err := markdown.RenderReader(&markup.RenderContext{
Ctx: ctx,
Type: markupType,
GitRepo: profileGitRepo,
Links: markup.Links{
// Pass repo link to markdown render for the full link of media elements.
// The profile of default branch would be shown.
Base: profileDbRepo.Link(),
BranchPath: path.Join("branch", util.PathEscapeSegments(profileDbRepo.DefaultBranch)),
},
Metas: map[string]string{"mode": "document"},
}, rc); err != nil {
log.Error("failed to RenderString: %v", err)
} else {
ctx.Data["ProfileReadme"] = profileContent
}
} else {
ctx.Data["ProfileReadme"] = profileContent
content, err := io.ReadAll(rc)
if err != nil {
log.Error("Read readme content failed: %v", err)
}
ctx.Data["ProfileReadme"] = gotemplate.HTMLEscapeString(util.UnsafeBytesToString(content))
ctx.Data["IsProfileReadmePlain"] = true
}
}
}

View file

@ -22,6 +22,7 @@ import (
"forgejo.org/modules/markup/markdown"
"forgejo.org/modules/optional"
"forgejo.org/modules/setting"
"forgejo.org/routers/web/repo"
"forgejo.org/services/context"
)
@ -104,7 +105,22 @@ func FindUserProfileReadme(ctx *context.Context, doer *user_model.User) (profile
if commit, err := profileGitRepo.GetBranchCommit(profileDbRepo.DefaultBranch); err != nil {
log.Error("FindUserProfileReadme failed to GetBranchCommit: %v", err)
} else {
profileReadmeBlob, _ = commit.GetBlobByFoldedPath("README.md")
tree, err := commit.SubTree("")
if err != nil {
log.Error("FindUserProfileReadme failed to get SubTree: %v", err)
} else {
entries, err := tree.ListEntries()
if err != nil {
log.Error("FindUserProfileReadme failed to list entries: %v", err)
} else {
_, readmeEntry, err := repo.FindReadmeFileInEntries(ctx, entries, true)
if err != nil {
log.Error("FindUserProfileReadme failed to find readme in entries: %v", err)
} else if readmeEntry != nil {
profileReadmeBlob = readmeEntry.Blob()
}
}
}
}
}
}

View file

@ -8,6 +8,8 @@ package user
import (
"errors"
"fmt"
gotemplate "html/template"
"io"
"net/http"
"path"
"strings"
@ -269,23 +271,33 @@ func prepareUserProfileTabData(ctx *context.Context, showPrivate bool, profileDb
} else {
defer rc.Close()
if profileContent, err := markdown.RenderReader(&markup.RenderContext{
Ctx: ctx,
GitRepo: profileGitRepo,
Links: markup.Links{
// Give the repo link to the markdown render for the full link of media element.
// the media link usually be like /[user]/[repoName]/media/branch/[branchName],
// Eg. /Tom/.profile/media/branch/main
// The branch shown on the profile page is the default branch, this need to be in sync with doc, see:
// https://docs.gitea.com/usage/profile-readme
Base: profileDbRepo.Link(),
BranchPath: path.Join("branch", util.PathEscapeSegments(profileDbRepo.DefaultBranch)),
},
Metas: map[string]string{"mode": "document"},
}, rc); err != nil {
log.Error("failed to RenderString: %v", err)
if markupType := markup.Type(profileReadme.Name()); markupType != "" {
if profileContent, err := markdown.RenderReader(&markup.RenderContext{
Ctx: ctx,
Type: markupType,
GitRepo: profileGitRepo,
Links: markup.Links{
// Give the repo link to the markdown render for the full link of media element.
// the media link usually be like /[user]/[repoName]/media/branch/[branchName],
// Eg. /Tom/.profile/media/branch/main
// The branch shown on the profile page is the default branch, this need to be in sync with doc, see:
// https://docs.gitea.com/usage/profile-readme
Base: profileDbRepo.Link(),
BranchPath: path.Join("branch", util.PathEscapeSegments(profileDbRepo.DefaultBranch)),
},
Metas: map[string]string{"mode": "document"},
}, rc); err != nil {
log.Error("failed to RenderString: %v", err)
} else {
ctx.Data["ProfileReadme"] = profileContent
}
} else {
ctx.Data["ProfileReadme"] = profileContent
content, err := io.ReadAll(rc)
if err != nil {
log.Error("Read readme content failed: %v", err)
}
ctx.Data["ProfileReadme"] = gotemplate.HTMLEscapeString(util.UnsafeBytesToString(content))
ctx.Data["IsProfileReadmePlain"] = true
}
}
default: // default to "repositories"