diff --git a/models/repo/user_repo.go b/models/repo/user_repo.go index cdb266e014a9..dd2ef6220116 100644 --- a/models/repo/user_repo.go +++ b/models/repo/user_repo.go @@ -155,14 +155,25 @@ func GetReviewers(ctx context.Context, repo *Repository, doerID, posterID int64) return users, db.GetEngine(ctx).Where(cond).OrderBy(user_model.GetOrderByName()).Find(&users) } -// GetIssuePosters returns all users that have authored an issue/pull request for the given repository -func GetIssuePosters(ctx context.Context, repo *Repository, isPull bool) ([]*user_model.User, error) { - users := make([]*user_model.User, 0, 8) +// GetIssuePostersWithSearch returns users with limit of 30 whose username started with prefix that have authored an issue/pull request for the given repository +// If isShowFullName is set to true, also include full name prefix search +func GetIssuePostersWithSearch(ctx context.Context, repo *Repository, isPull bool, search string, isShowFullName bool) ([]*user_model.User, error) { + users := make([]*user_model.User, 0, 30) + var prefixCond builder.Cond = builder.Like{"name", search + "%"} + if isShowFullName { + prefixCond = prefixCond.Or(builder.Like{"full_name", "%" + search + "%"}) + } + cond := builder.In("`user`.id", builder.Select("poster_id").From("issue").Where( builder.Eq{"repo_id": repo.ID}. And(builder.Eq{"is_pull": isPull}), - ).GroupBy("poster_id"), - ) - return users, db.GetEngine(ctx).Where(cond).OrderBy(user_model.GetOrderByName()).Find(&users) + ).GroupBy("poster_id")).And(prefixCond) + + return users, db.GetEngine(ctx). + Where(cond). + Cols("id", "name", "full_name", "avatar", "avatar_email", "use_custom_avatar"). + OrderBy("name"). + Limit(30). + Find(&users) } diff --git a/options/locale/locale_en-US.ini b/options/locale/locale_en-US.ini index 5834703556c2..4e711ffad2ca 100644 --- a/options/locale/locale_en-US.ini +++ b/options/locale/locale_en-US.ini @@ -933,6 +933,7 @@ delete_preexisting = Delete pre-existing files delete_preexisting_content = Delete files in %s delete_preexisting_success = Deleted unadopted files in %s blame_prior = View blame prior to this change +author_search_tooltip = Shows a maximum of 30 users transfer.accept = Accept Transfer transfer.accept_desc = Transfer to "%s" diff --git a/routers/web/repo/helper.go b/routers/web/repo/helper.go new file mode 100644 index 000000000000..6f9ca4874b00 --- /dev/null +++ b/routers/web/repo/helper.go @@ -0,0 +1,23 @@ +// Copyright 2023 The Gitea Authors. All rights reserved. +// SPDX-License-Identifier: MIT + +package repo + +import ( + "sort" + + "code.gitea.io/gitea/models/user" + "code.gitea.io/gitea/modules/context" +) + +func makeSelfOnTop(ctx *context.Context, users []*user.User) []*user.User { + if ctx.Doer != nil { + sort.Slice(users, func(i, j int) bool { + if users[i].ID == users[j].ID { + return false + } + return users[i].ID == ctx.Doer.ID // if users[i] is self, put it before others, so less=true + }) + } + return users +} diff --git a/routers/web/repo/helper_test.go b/routers/web/repo/helper_test.go new file mode 100644 index 000000000000..e9ab44fe69f9 --- /dev/null +++ b/routers/web/repo/helper_test.go @@ -0,0 +1,27 @@ +// Copyright 2023 The Gitea Authors. All rights reserved. +// SPDX-License-Identifier: MIT + +package repo + +import ( + "testing" + + "code.gitea.io/gitea/models/user" + "code.gitea.io/gitea/modules/context" + + "github.com/stretchr/testify/assert" +) + +func TestMakeSelfOnTop(t *testing.T) { + users := makeSelfOnTop(&context.Context{}, []*user.User{{ID: 2}, {ID: 1}}) + assert.Len(t, users, 2) + assert.EqualValues(t, 2, users[0].ID) + + users = makeSelfOnTop(&context.Context{Doer: &user.User{ID: 1}}, []*user.User{{ID: 2}, {ID: 1}}) + assert.Len(t, users, 2) + assert.EqualValues(t, 1, users[0].ID) + + users = makeSelfOnTop(&context.Context{Doer: &user.User{ID: 2}}, []*user.User{{ID: 2}, {ID: 1}}) + assert.Len(t, users, 2) + assert.EqualValues(t, 2, users[0].ID) +} diff --git a/routers/web/repo/issue.go b/routers/web/repo/issue.go index e4f1172dd966..5401d60b5509 100644 --- a/routers/web/repo/issue.go +++ b/routers/web/repo/issue.go @@ -303,17 +303,12 @@ func issues(ctx *context.Context, milestoneID, projectID int64, isPullOption uti ctx.Data["CommitStatuses"] = commitStatuses // Get assignees. - ctx.Data["Assignees"], err = repo_model.GetRepoAssignees(ctx, repo) + assigneeUsers, err := repo_model.GetRepoAssignees(ctx, repo) if err != nil { - ctx.ServerError("GetAssignees", err) - return - } - - ctx.Data["Posters"], err = repo_model.GetIssuePosters(ctx, repo, isPullOption.IsTrue()) - if err != nil { - ctx.ServerError("GetIssuePosters", err) + ctx.ServerError("GetRepoAssignees", err) return } + ctx.Data["Assignees"] = makeSelfOnTop(ctx, assigneeUsers) handleTeamMentions(ctx) if ctx.Written() { @@ -479,11 +474,12 @@ func RetrieveRepoMilestonesAndAssignees(ctx *context.Context, repo *repo_model.R return } - ctx.Data["Assignees"], err = repo_model.GetRepoAssignees(ctx, repo) + assigneeUsers, err := repo_model.GetRepoAssignees(ctx, repo) if err != nil { - ctx.ServerError("GetAssignees", err) + ctx.ServerError("GetRepoAssignees", err) return } + ctx.Data["Assignees"] = makeSelfOnTop(ctx, assigneeUsers) handleTeamMentions(ctx) } @@ -3354,3 +3350,46 @@ func handleTeamMentions(ctx *context.Context) { ctx.Data["MentionableTeamsOrg"] = ctx.Repo.Owner.Name ctx.Data["MentionableTeamsOrgAvatar"] = ctx.Repo.Owner.AvatarLink(ctx) } + +type userSearchInfo struct { + UserID int64 `json:"user_id"` + UserName string `json:"username"` + AvatarLink string `json:"avatar_link"` + FullName string `json:"full_name"` +} + +type userSearchResponse struct { + Results []*userSearchInfo `json:"results"` +} + +// IssuePosters get posters for current repo's issues/pull requests +func IssuePosters(ctx *context.Context) { + repo := ctx.Repo.Repository + isPullList := ctx.Params(":type") == "pulls" + search := strings.TrimSpace(ctx.FormString("q")) + posters, err := repo_model.GetIssuePostersWithSearch(ctx, repo, isPullList, search, setting.UI.DefaultShowFullName) + if err != nil { + ctx.JSON(http.StatusInternalServerError, err) + return + } + + if search == "" && ctx.Doer != nil { + // the returned posters slice only contains limited number of users, + // to make the current user (doer) can quickly filter their own issues, always add doer to the posters slice + if !util.SliceContainsFunc(posters, func(user *user_model.User) bool { return user.ID == ctx.Doer.ID }) { + posters = append(posters, ctx.Doer) + } + } + + posters = makeSelfOnTop(ctx, posters) + + resp := &userSearchResponse{} + resp.Results = make([]*userSearchInfo, len(posters)) + for i, user := range posters { + resp.Results[i] = &userSearchInfo{UserID: user.ID, UserName: user.Name, AvatarLink: user.AvatarLink(ctx)} + if setting.UI.DefaultShowFullName { + resp.Results[i].FullName = user.FullName + } + } + ctx.JSON(http.StatusOK, resp) +} diff --git a/routers/web/repo/pull.go b/routers/web/repo/pull.go index 30004cefb70b..070fc109dcec 100644 --- a/routers/web/repo/pull.go +++ b/routers/web/repo/pull.go @@ -792,10 +792,13 @@ func ViewPullFiles(ctx *context.Context) { setCompareContext(ctx, baseCommit, commit, ctx.Repo.Owner.Name, ctx.Repo.Repository.Name) - if ctx.Data["Assignees"], err = repo_model.GetRepoAssignees(ctx, ctx.Repo.Repository); err != nil { - ctx.ServerError("GetAssignees", err) + assigneeUsers, err := repo_model.GetRepoAssignees(ctx, ctx.Repo.Repository) + if err != nil { + ctx.ServerError("GetRepoAssignees", err) return } + ctx.Data["Assignees"] = makeSelfOnTop(ctx, assigneeUsers) + handleTeamMentions(ctx) if ctx.Written() { return diff --git a/routers/web/repo/release.go b/routers/web/repo/release.go index b8c5f67f45a7..5083056ebb1e 100644 --- a/routers/web/repo/release.go +++ b/routers/web/repo/release.go @@ -333,13 +333,12 @@ func NewRelease(ctx *context.Context) { } } ctx.Data["IsAttachmentEnabled"] = setting.Attachment.Enabled - var err error - // Get assignees. - ctx.Data["Assignees"], err = repo_model.GetRepoAssignees(ctx, ctx.Repo.Repository) + assigneeUsers, err := repo_model.GetRepoAssignees(ctx, ctx.Repo.Repository) if err != nil { - ctx.ServerError("GetAssignees", err) + ctx.ServerError("GetRepoAssignees", err) return } + ctx.Data["Assignees"] = makeSelfOnTop(ctx, assigneeUsers) upload.AddUploadContext(ctx, "release") ctx.HTML(http.StatusOK, tplReleaseNew) @@ -496,11 +495,12 @@ func EditRelease(ctx *context.Context) { ctx.Data["attachments"] = rel.Attachments // Get assignees. - ctx.Data["Assignees"], err = repo_model.GetRepoAssignees(ctx, rel.Repo) + assigneeUsers, err := repo_model.GetRepoAssignees(ctx, rel.Repo) if err != nil { - ctx.ServerError("GetAssignees", err) + ctx.ServerError("GetRepoAssignees", err) return } + ctx.Data["Assignees"] = makeSelfOnTop(ctx, assigneeUsers) ctx.HTML(http.StatusOK, tplReleaseNew) } diff --git a/routers/web/web.go b/routers/web/web.go index 6b62ff6f8372..36304493c91c 100644 --- a/routers/web/web.go +++ b/routers/web/web.go @@ -1228,7 +1228,10 @@ func RegisterRoutes(m *web.Route) { m.Group("/{username}/{reponame}", func() { m.Group("", func() { - m.Get("/{type:issues|pulls}", repo.Issues) + m.Group("/{type:issues|pulls}", func() { + m.Get("", repo.Issues) + m.Get("/posters", repo.IssuePosters) + }) m.Get("/{type:issues|pulls}/{index}", repo.ViewIssue) m.Group("/{type:issues|pulls}/{index}/content-history", func() { m.Get("/overview", repo.GetContentHistoryOverview) diff --git a/templates/repo/issue/list.tmpl b/templates/repo/issue/list.tmpl index cfc9a930484f..06cc3aba910f 100644 --- a/templates/repo/issue/list.tmpl +++ b/templates/repo/issue/list.tmpl @@ -1,5 +1,5 @@ {{template "base/head" .}} -
+
{{template "repo/header" .}}
@@ -117,7 +117,11 @@
-
@@ -150,7 +149,7 @@ {{.locale.Tr "repo.issues.filter_assginee_no_select"}} {{range .Assignees}} - {{avatar $.Context .}}{{template "repo/search_name" .}} + {{avatar $.Context . 20}}{{template "repo/search_name" .}} {{end}}
@@ -299,7 +298,7 @@
{{range .Assignees}}
- {{avatar $.Context .}} {{.GetDisplayName}} + {{avatar $.Context . 20}} {{.GetDisplayName}}
{{end}} diff --git a/templates/repo/issue/milestone_issues.tmpl b/templates/repo/issue/milestone_issues.tmpl index 2ca2fa2bce70..148a23db6675 100644 --- a/templates/repo/issue/milestone_issues.tmpl +++ b/templates/repo/issue/milestone_issues.tmpl @@ -1,5 +1,5 @@ {{template "base/head" .}} -
+
{{template "repo/header" .}}
@@ -71,7 +71,11 @@
-
@@ -104,7 +103,7 @@ {{.locale.Tr "repo.issues.filter_assginee_no_select"}} {{range .Assignees}} - {{avatar $.Context . 28 "gt-mr-2"}}{{template "repo/search_name" .}} + {{avatar $.Context . 20}}{{template "repo/search_name" .}} {{end}}
@@ -190,7 +189,7 @@
{{range .Assignees}}
- {{avatar $.Context . 28 "gt-mr-2"}} + {{avatar $.Context . 20}} {{.GetDisplayName}}
{{end}} diff --git a/templates/repo/issue/view_content/sidebar.tmpl b/templates/repo/issue/view_content/sidebar.tmpl index 25df29e5fb38..521d6ba1d3da 100644 --- a/templates/repo/issue/view_content/sidebar.tmpl +++ b/templates/repo/issue/view_content/sidebar.tmpl @@ -254,7 +254,7 @@ {{end}} {{svg "octicon-check"}} - {{avatar $.Context . 28 "gt-mr-3"}}{{template "repo/search_name" .}} + {{avatar $.Context . 20 "gt-mr-3"}}{{template "repo/search_name" .}} {{end}} diff --git a/web_src/css/repository.css b/web_src/css/repository.css index a80222239478..b4bfd17352be 100644 --- a/web_src/css/repository.css +++ b/web_src/css/repository.css @@ -72,8 +72,8 @@ max-height: 500px; } -.repository .metas .ui.list.assignees .icon { - line-height: 2em; +.repository .metas .ui.list.assignees .item { + line-height: 2.5em; } .repository .metas .ui.list.assignees .teamavatar { diff --git a/web_src/js/features/common-issue.js b/web_src/js/features/common-issue.js deleted file mode 100644 index 25d41edde348..000000000000 --- a/web_src/js/features/common-issue.js +++ /dev/null @@ -1,59 +0,0 @@ -import $ from 'jquery'; -import {updateIssuesMeta} from './repo-issue.js'; -import {toggleElem} from '../utils/dom.js'; - -export function initCommonIssue() { - const $issueSelectAll = $('.issue-checkbox-all'); - const $issueCheckboxes = $('.issue-checkbox'); - - const syncIssueSelectionState = () => { - const $checked = $issueCheckboxes.filter(':checked'); - const anyChecked = $checked.length !== 0; - const allChecked = anyChecked && $checked.length === $issueCheckboxes.length; - - if (allChecked) { - $issueSelectAll.prop({'checked': true, 'indeterminate': false}); - } else if (anyChecked) { - $issueSelectAll.prop({'checked': false, 'indeterminate': true}); - } else { - $issueSelectAll.prop({'checked': false, 'indeterminate': false}); - } - // if any issue is selected, show the action panel, otherwise show the filter panel - toggleElem($('#issue-filters'), !anyChecked); - toggleElem($('#issue-actions'), anyChecked); - // there are two panels but only one select-all checkbox, so move the checkbox to the visible panel - $('#issue-filters, #issue-actions').filter(':visible').find('.column:first').prepend($issueSelectAll); - }; - - $issueCheckboxes.on('change', syncIssueSelectionState); - - $issueSelectAll.on('change', () => { - $issueCheckboxes.prop('checked', $issueSelectAll.is(':checked')); - syncIssueSelectionState(); - }); - - $('.issue-action').on('click', async function (e) { - e.preventDefault(); - let action = this.getAttribute('data-action'); - let elementId = this.getAttribute('data-element-id'); - const url = this.getAttribute('data-url'); - const issueIDs = $('.issue-checkbox:checked').map((_, el) => { - return el.getAttribute('data-issue-id'); - }).get().join(','); - if (elementId === '0' && url.slice(-9) === '/assignee') { - elementId = ''; - action = 'clear'; - } - if (action === 'toggle' && e.altKey) { - action = 'toggle-alt'; - } - updateIssuesMeta( - url, - action, - issueIDs, - elementId - ).then(() => { - window.location.reload(); - }); - }); -} diff --git a/web_src/js/features/repo-issue-list.js b/web_src/js/features/repo-issue-list.js new file mode 100644 index 000000000000..6c5d1244fd7e --- /dev/null +++ b/web_src/js/features/repo-issue-list.js @@ -0,0 +1,124 @@ +import $ from 'jquery'; +import {updateIssuesMeta} from './repo-issue.js'; +import {toggleElem} from '../utils/dom.js'; +import {htmlEscape} from 'escape-goat'; + +function initRepoIssueListCheckboxes() { + const $issueSelectAll = $('.issue-checkbox-all'); + const $issueCheckboxes = $('.issue-checkbox'); + + const syncIssueSelectionState = () => { + const $checked = $issueCheckboxes.filter(':checked'); + const anyChecked = $checked.length !== 0; + const allChecked = anyChecked && $checked.length === $issueCheckboxes.length; + + if (allChecked) { + $issueSelectAll.prop({'checked': true, 'indeterminate': false}); + } else if (anyChecked) { + $issueSelectAll.prop({'checked': false, 'indeterminate': true}); + } else { + $issueSelectAll.prop({'checked': false, 'indeterminate': false}); + } + // if any issue is selected, show the action panel, otherwise show the filter panel + toggleElem($('#issue-filters'), !anyChecked); + toggleElem($('#issue-actions'), anyChecked); + // there are two panels but only one select-all checkbox, so move the checkbox to the visible panel + $('#issue-filters, #issue-actions').filter(':visible').find('.column:first').prepend($issueSelectAll); + }; + + $issueCheckboxes.on('change', syncIssueSelectionState); + + $issueSelectAll.on('change', () => { + $issueCheckboxes.prop('checked', $issueSelectAll.is(':checked')); + syncIssueSelectionState(); + }); + + $('.issue-action').on('click', async function (e) { + e.preventDefault(); + let action = this.getAttribute('data-action'); + let elementId = this.getAttribute('data-element-id'); + const url = this.getAttribute('data-url'); + const issueIDs = $('.issue-checkbox:checked').map((_, el) => { + return el.getAttribute('data-issue-id'); + }).get().join(','); + if (elementId === '0' && url.slice(-9) === '/assignee') { + elementId = ''; + action = 'clear'; + } + if (action === 'toggle' && e.altKey) { + action = 'toggle-alt'; + } + updateIssuesMeta( + url, + action, + issueIDs, + elementId + ).then(() => { + window.location.reload(); + }); + }); +} + +function initRepoIssueListAuthorDropdown() { + const $searchDropdown = $('.user-remote-search'); + if (!$searchDropdown.length) return; + + let searchUrl = $searchDropdown.attr('data-search-url'); + const actionJumpUrl = $searchDropdown.attr('data-action-jump-url'); + const selectedUserId = $searchDropdown.attr('data-selected-user-id'); + if (!searchUrl.includes('?')) searchUrl += '?'; + + $searchDropdown.dropdown('setting', { + fullTextSearch: true, + selectOnKeydown: false, + apiSettings: { + cache: false, + url: `${searchUrl}&q={query}`, + onResponse(resp) { + // the content is provided by backend IssuePosters handler + const processedResults = []; // to be used by dropdown to generate menu items + for (const item of resp.results) { + let html = `${htmlEscape(item.username)}`; + if (item.full_name) html += `${htmlEscape(item.full_name)}`; + processedResults.push({value: item.user_id, name: html}); + } + resp.results = processedResults; + return resp; + }, + }, + action: (_text, value) => { + window.location.href = actionJumpUrl.replace('{user_id}', encodeURIComponent(value)); + }, + onShow: () => { + $searchDropdown.dropdown('filter', ' '); // trigger a search on first show + }, + }); + + // we want to generate the dropdown menu items by ourselves, replace its internal setup functions + const dropdownSetup = {...$searchDropdown.dropdown('internal', 'setup')}; + const dropdownTemplates = $searchDropdown.dropdown('setting', 'templates'); + $searchDropdown.dropdown('internal', 'setup', dropdownSetup); + dropdownSetup.menu = function (values) { + const $menu = $searchDropdown.find('> .menu'); + $menu.find('> .dynamic-item').remove(); // remove old dynamic items + + const newMenuHtml = dropdownTemplates.menu(values, $searchDropdown.dropdown('setting', 'fields'), true /* html */, $searchDropdown.dropdown('setting', 'className')); + if (newMenuHtml) { + const $newMenuItems = $(newMenuHtml); + $newMenuItems.addClass('dynamic-item'); + $menu.append('
', ...$newMenuItems); + } + $searchDropdown.dropdown('refresh'); + // defer our selection to the next tick, because dropdown will set the selection item after this `menu` function + setTimeout(() => { + $menu.find('.item.active, .item.selected').removeClass('active selected'); + $menu.find(`.item[data-value="${selectedUserId}"]`).addClass('selected'); + }, 0); + }; +} + +export function initRepoIssueList() { + if (!document.querySelectorAll('.page-content.repository.issue-list, .page-content.repository.milestone-issue-list').length) return; + initRepoIssueListCheckboxes(); + initRepoIssueListAuthorDropdown(); +} diff --git a/web_src/js/features/repo-issue.js b/web_src/js/features/repo-issue.js index f2a6f5815b08..a6105f7b2419 100644 --- a/web_src/js/features/repo-issue.js +++ b/web_src/js/features/repo-issue.js @@ -86,7 +86,7 @@ export function initRepoIssueDue() { }); } -export function initRepoIssueList() { +export function initRepoIssueSidebarList() { const repolink = $('#repolink').val(); const repoId = $('#repoId').val(); const crossRepoSearch = $('#crossRepoSearch').val(); diff --git a/web_src/js/index.js b/web_src/js/index.js index e727acfa0651..f5584d29403a 100644 --- a/web_src/js/index.js +++ b/web_src/js/index.js @@ -31,13 +31,12 @@ import { } from './features/repo-diff.js'; import { initRepoIssueDue, - initRepoIssueList, initRepoIssueReferenceRepositorySearch, initRepoIssueTimeTracking, initRepoIssueWipTitle, initRepoPullRequestMergeInstruction, initRepoPullRequestAllowMaintainerEdit, - initRepoPullRequestReview, + initRepoPullRequestReview, initRepoIssueSidebarList, } from './features/repo-issue.js'; import { initRepoEllipsisButton, @@ -77,7 +76,6 @@ import {initRepoEditor} from './features/repo-editor.js'; import {initCompSearchUserBox} from './features/comp/SearchUserBox.js'; import {initInstall} from './features/install.js'; import {initCompWebHookEditor} from './features/comp/WebHookEditor.js'; -import {initCommonIssue} from './features/common-issue.js'; import {initRepoBranchButton} from './features/repo-branch.js'; import {initCommonOrganization} from './features/common-organization.js'; import {initRepoWikiForm} from './features/repo-wiki.js'; @@ -89,6 +87,7 @@ import {initRepositoryActionView} from './components/RepoActionView.vue'; import {initGlobalTooltips} from './modules/tippy.js'; import {initGiteaFomantic} from './modules/fomantic.js'; import {onDomReady} from './utils/dom.js'; +import {initRepoIssueList} from './features/repo-issue-list.js'; // Run time-critical code as soon as possible. This is safe to do because this // script appears at the end of and rendered HTML is accessible at that point. @@ -109,7 +108,6 @@ onDomReady(() => { initGlobalFormDirtyLeaveConfirm(); initGlobalLinkActions(); - initCommonIssue(); initCommonOrganization(); initCompSearchUserBox(); @@ -163,6 +161,7 @@ onDomReady(() => { initRepoIssueContentHistory(); initRepoIssueDue(); initRepoIssueList(); + initRepoIssueSidebarList(); initRepoIssueReferenceRepositorySearch(); initRepoIssueTimeTracking(); initRepoIssueWipTitle(); diff --git a/web_src/js/modules/aria/dropdown.js b/web_src/js/modules/aria/dropdown.js index e4c881b6af3c..26c135241682 100644 --- a/web_src/js/modules/aria/dropdown.js +++ b/web_src/js/modules/aria/dropdown.js @@ -132,6 +132,11 @@ function attachInit($dropdown) { const $focusable = $textSearch.length ? $textSearch : $dropdown; // the primary element for focus, see comment above if (!$focusable.length) return; + // as a combobox, the input should not have autocomplete by default + if ($textSearch.length && !$textSearch.attr('autocomplete')) { + $textSearch.attr('autocomplete', 'off'); + } + let $menu = $dropdown.find('> .menu'); if (!$menu.length) { // some "multiple selection" dropdowns don't have a static menu element in HTML, we need to pre-create it to make it have correct aria attributes diff --git a/web_src/js/modules/fomantic.js b/web_src/js/modules/fomantic.js index 2109ff1726a4..1495b311ca60 100644 --- a/web_src/js/modules/fomantic.js +++ b/web_src/js/modules/fomantic.js @@ -19,7 +19,48 @@ export function initGiteaFomantic() { return escape(text, preserveHTML) + svg('octicon-x', 16, `${className.delete} icon`); }; + initFomanticApiPatch(); + // Use the patches to improve accessibility, these patches are designed to be as independent as possible, make it easy to modify or remove in the future. initAriaCheckboxPatch(); initAriaDropdownPatch(); } + +function initFomanticApiPatch() { + // + // Fomantic API module has some very buggy behaviors: + // + // If encodeParameters=true, it calls `urlEncodedValue` to encode the parameter. + // However, `urlEncodedValue` just tries to "guess" whether the parameter is already encoded, by decoding the parameter and encoding it again. + // + // There are 2 problems: + // 1. It may guess wrong, and skip encoding a parameter which looks like encoded. + // 2. If the parameter can't be decoded, `decodeURIComponent` will throw an error, and the whole request will fail. + // + // This patch only fixes the second error behavior at the moment. + // + const patchKey = '_giteaFomanticApiPatch'; + const oldApi = $.api; + $.api = $.fn.api = function(...args) { + const apiCall = oldApi.bind(this); + const ret = oldApi.apply(this, args); + + if (typeof args[0] !== 'string') { + const internalGet = apiCall('internal', 'get'); + if (!internalGet.urlEncodedValue[patchKey]) { + const oldUrlEncodedValue = internalGet.urlEncodedValue; + internalGet.urlEncodedValue = function (value) { + try { + return oldUrlEncodedValue(value); + } catch { + // if Fomantic API module's `urlEncodedValue` throws an error, we encode it by ourselves. + return encodeURIComponent(value); + } + }; + internalGet.urlEncodedValue[patchKey] = true; + } + } + return ret; + }; + $.api.settings = oldApi.settings; +}