mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2026-05-16 15:56:34 +00:00
`Option[T]` currently exposes a method `Value()` which is permitted to be called on an option that has a value, and an option that doesn't have a value. This API is awkward because the behaviour if the option doesn't have a value isn't clear to the caller, and, because almost all accesses end up being `.Has()?` then `OK, use .Value()`. `Get() (bool, T)` is added as a better replacement, which both returns whether the option has a value, and the value if present. Most call-sites are rewritten to this form. `ValueOrZeroValue()` is a direct replacement that has the same behaviour that `Value()` had, but describes the behaviour if the value is missing. In addition to the current API being awkward, the core reason for this change is that `Value()` conflicts with the `Value()` function from the `driver.Valuer` interface. If this interface was implemented, it would allow `Option[T]` to be used to represent a nullable field in an xorm bean struct (requires: https://code.forgejo.org/xorm/xorm/pulls/66). _Note:_ changes are extensive in this PR, but are almost all changes are easy, mechanical transitions from `.Has()` to `.Get()`. All of this work was performed by hand. ## Checklist The [contributor guide](https://forgejo.org/docs/next/contributor/) contains information that will be helpful to first time contributors. There also are a few [conditions for merging Pull Requests in Forgejo repositories](https://codeberg.org/forgejo/governance/src/branch/main/PullRequestsAgreement.md). You are also welcome to join the [Forgejo development chatroom](https://matrix.to/#/#forgejo-development:matrix.org). ### Tests - I added test coverage for Go changes... - [ ] in their respective `*_test.go` for unit tests. - [ ] in the `tests/integration` directory if it involves interactions with a live Forgejo server. - I added test coverage for JavaScript changes... - [ ] in `web_src/js/*.test.js` if it can be unit tested. - [ ] in `tests/e2e/*.test.e2e.js` if it requires interactions with a live Forgejo server (see also the [developer guide for JavaScript testing](https://codeberg.org/forgejo/forgejo/src/branch/forgejo/tests/e2e/README.md#end-to-end-tests)). ### Documentation - [ ] I created a pull request [to the documentation](https://codeberg.org/forgejo/docs) to explain to Forgejo users how to use this change. - [x] I did not document these changes and I do not expect someone else to do it. ### Release notes - [ ] This change will be noticed by a Forgejo user or admin (feature, bug fix, performance, etc.). I suggest to include a release note for this change. - [x] This change is not visible to a Forgejo user or admin (refactor, dependency upgrade, etc.). I think there is no need to add a release note for this change. *The decision if the pull request will be shown in the release notes is up to the mergers / release team.* The content of the `release-notes/<pull request number>.md` file will serve as the basis for the release notes. If the file does not exist, the title of the pull request will be used instead. Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/11218 Reviewed-by: Otto <otto@codeberg.org> Reviewed-by: Gusted <gusted@noreply.codeberg.org> Co-authored-by: Mathieu Fenniak <mathieu@fenniak.net> Co-committed-by: Mathieu Fenniak <mathieu@fenniak.net>
195 lines
5.3 KiB
Go
195 lines
5.3 KiB
Go
// Copyright 2021 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package explore
|
|
|
|
import (
|
|
"fmt"
|
|
"net/http"
|
|
|
|
"forgejo.org/models/db"
|
|
repo_model "forgejo.org/models/repo"
|
|
"forgejo.org/modules/base"
|
|
"forgejo.org/modules/log"
|
|
"forgejo.org/modules/setting"
|
|
"forgejo.org/modules/sitemap"
|
|
"forgejo.org/services/context"
|
|
)
|
|
|
|
const (
|
|
// tplExploreRepos explore repositories page template
|
|
tplExploreRepos base.TplName = "explore/repos"
|
|
relevantReposOnlyParam string = "only_show_relevant"
|
|
)
|
|
|
|
// RepoSearchOptions when calling search repositories
|
|
type RepoSearchOptions struct {
|
|
OwnerID int64
|
|
Private bool
|
|
Restricted bool
|
|
PageSize int
|
|
OnlyShowRelevant bool
|
|
TplName base.TplName
|
|
}
|
|
|
|
// RenderRepoSearch render repositories search page
|
|
// This function is also used to render the Admin Repository Management page.
|
|
func RenderRepoSearch(ctx *context.Context, opts *RepoSearchOptions) {
|
|
// Sitemap index for sitemap paths
|
|
page := int(ctx.ParamsInt64("idx"))
|
|
isSitemap := ctx.Params("idx") != ""
|
|
if page <= 1 {
|
|
page = ctx.FormInt("page")
|
|
}
|
|
|
|
if page <= 0 {
|
|
page = 1
|
|
}
|
|
|
|
if isSitemap {
|
|
opts.PageSize = setting.UI.SitemapPagingNum
|
|
}
|
|
|
|
var (
|
|
repos []*repo_model.Repository
|
|
count int64
|
|
err error
|
|
orderBy db.SearchOrderBy
|
|
)
|
|
|
|
sortOrder := ctx.FormString("sort")
|
|
if sortOrder == "" {
|
|
sortOrder = setting.UI.ExploreDefaultSort
|
|
}
|
|
|
|
if order, ok := repo_model.OrderByFlatMap[sortOrder]; ok {
|
|
orderBy = order
|
|
} else {
|
|
sortOrder = "recentupdate"
|
|
orderBy = db.SearchOrderByRecentUpdated
|
|
}
|
|
ctx.Data["SortType"] = sortOrder
|
|
|
|
keyword := ctx.FormTrim("q")
|
|
|
|
ctx.Data["OnlyShowRelevant"] = opts.OnlyShowRelevant
|
|
|
|
topicOnly := ctx.FormBool("topic")
|
|
ctx.Data["TopicOnly"] = topicOnly
|
|
|
|
language := ctx.FormTrim("language")
|
|
ctx.Data["Language"] = language
|
|
|
|
archived := ctx.FormOptionalBool("archived")
|
|
ctx.Data["IsArchived"] = archived
|
|
|
|
fork := ctx.FormOptionalBool("fork")
|
|
ctx.Data["IsFork"] = fork
|
|
|
|
mirror := ctx.FormOptionalBool("mirror")
|
|
ctx.Data["IsMirror"] = mirror
|
|
|
|
template := ctx.FormOptionalBool("template")
|
|
ctx.Data["IsTemplate"] = template
|
|
|
|
private := ctx.FormOptionalBool("private")
|
|
ctx.Data["IsPrivate"] = private
|
|
|
|
repos, count, err = repo_model.SearchRepository(ctx, &repo_model.SearchRepoOptions{
|
|
ListOptions: db.ListOptions{
|
|
Page: page,
|
|
PageSize: opts.PageSize,
|
|
},
|
|
Actor: ctx.Doer,
|
|
OrderBy: orderBy,
|
|
Private: opts.Private,
|
|
Keyword: keyword,
|
|
OwnerID: opts.OwnerID,
|
|
AllPublic: true,
|
|
AllLimited: true,
|
|
TopicOnly: topicOnly,
|
|
Language: language,
|
|
IncludeDescription: setting.UI.SearchRepoDescription,
|
|
OnlyShowRelevant: opts.OnlyShowRelevant,
|
|
Archived: archived,
|
|
Fork: fork,
|
|
Mirror: mirror,
|
|
Template: template,
|
|
IsPrivate: private,
|
|
})
|
|
if err != nil {
|
|
ctx.ServerError("SearchRepository", err)
|
|
return
|
|
}
|
|
if isSitemap {
|
|
m := sitemap.NewSitemap()
|
|
for _, item := range repos {
|
|
m.Add(sitemap.URL{URL: item.HTMLURL(), LastMod: item.UpdatedUnix.AsTimePtr()})
|
|
}
|
|
ctx.Resp.Header().Set("Content-Type", "text/xml")
|
|
if _, err := m.WriteTo(ctx.Resp); err != nil {
|
|
log.Error("Failed writing sitemap: %v", err)
|
|
}
|
|
return
|
|
}
|
|
|
|
ctx.Data["Keyword"] = keyword
|
|
ctx.Data["Total"] = count
|
|
ctx.Data["Repos"] = repos
|
|
ctx.Data["IsRepoIndexerEnabled"] = setting.Indexer.RepoIndexerEnabled
|
|
|
|
pager := context.NewPagination(int(count), opts.PageSize, page, 5)
|
|
pager.SetDefaultParams(ctx)
|
|
pager.AddParam(ctx, "topic", "TopicOnly")
|
|
pager.AddParam(ctx, "language", "Language")
|
|
pager.AddParamString(relevantReposOnlyParam, fmt.Sprint(opts.OnlyShowRelevant))
|
|
if has, value := archived.Get(); has {
|
|
pager.AddParamString("archived", fmt.Sprint(value))
|
|
}
|
|
if has, value := fork.Get(); has {
|
|
pager.AddParamString("fork", fmt.Sprint(value))
|
|
}
|
|
if has, value := mirror.Get(); has {
|
|
pager.AddParamString("mirror", fmt.Sprint(value))
|
|
}
|
|
if has, value := template.Get(); has {
|
|
pager.AddParamString("template", fmt.Sprint(value))
|
|
}
|
|
if has, value := private.Get(); has {
|
|
pager.AddParamString("private", fmt.Sprint(value))
|
|
}
|
|
ctx.Data["Page"] = pager
|
|
|
|
ctx.HTML(http.StatusOK, opts.TplName)
|
|
}
|
|
|
|
// Repos render explore repositories page
|
|
func Repos(ctx *context.Context) {
|
|
ctx.Data["UsersPageIsDisabled"] = setting.Service.Explore.DisableUsersPage
|
|
ctx.Data["OrganizationsPageIsDisabled"] = setting.Service.Explore.DisableOrganizationsPage
|
|
ctx.Data["CodePageIsDisabled"] = setting.Service.Explore.DisableCodePage
|
|
ctx.Data["Title"] = ctx.Tr("explore")
|
|
ctx.Data["PageIsExplore"] = true
|
|
ctx.Data["PageIsExploreRepositories"] = true
|
|
ctx.Data["IsRepoIndexerEnabled"] = setting.Indexer.RepoIndexerEnabled
|
|
|
|
var ownerID int64
|
|
if ctx.Doer != nil && !ctx.Doer.IsAdmin {
|
|
ownerID = ctx.Doer.ID
|
|
}
|
|
|
|
onlyShowRelevant := setting.UI.OnlyShowRelevantRepos
|
|
|
|
_ = ctx.Req.ParseForm() // parse the form first, to prepare the ctx.Req.Form field
|
|
if len(ctx.Req.Form[relevantReposOnlyParam]) != 0 {
|
|
onlyShowRelevant = ctx.FormBool(relevantReposOnlyParam)
|
|
}
|
|
|
|
RenderRepoSearch(ctx, &RepoSearchOptions{
|
|
PageSize: setting.UI.ExplorePagingNum,
|
|
OwnerID: ownerID,
|
|
Private: ctx.Doer != nil,
|
|
TplName: tplExploreRepos,
|
|
OnlyShowRelevant: onlyShowRelevant,
|
|
})
|
|
}
|