mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2024-12-30 11:23:56 -05:00
65248945c9
Clarify when "string" should be used (and be escaped), and when "template.HTML" should be used (no need to escape) And help PRs like #29059 , to render the error messages correctly. (cherry picked from commit f3eb835886031df7a562abc123c3f6011c81eca8) Conflicts: modules/web/middleware/binding.go routers/web/feed/convert.go tests/integration/branches_test.go tests/integration/repo_branch_test.go trivial context conflicts
65 lines
1.6 KiB
Go
65 lines
1.6 KiB
Go
// Copyright 2020 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package middleware
|
|
|
|
import (
|
|
"fmt"
|
|
"html/template"
|
|
"net/url"
|
|
)
|
|
|
|
// Flash represents a one time data transfer between two requests.
|
|
type Flash struct {
|
|
DataStore ContextDataStore
|
|
url.Values
|
|
ErrorMsg, WarningMsg, InfoMsg, SuccessMsg string
|
|
}
|
|
|
|
func (f *Flash) set(name, msg string, current ...bool) {
|
|
if f.Values == nil {
|
|
f.Values = make(map[string][]string)
|
|
}
|
|
showInCurrentPage := len(current) > 0 && current[0]
|
|
if showInCurrentPage {
|
|
// assign it to the context data, then the template can use ".Flash.XxxMsg" to render the message
|
|
f.DataStore.GetData()["Flash"] = f
|
|
} else {
|
|
// the message map will be saved into the cookie and be shown in next response (a new page response which decodes the cookie)
|
|
f.Set(name, msg)
|
|
}
|
|
}
|
|
|
|
func flashMsgStringOrHTML(msg any) string {
|
|
switch v := msg.(type) {
|
|
case string:
|
|
return v
|
|
case template.HTML:
|
|
return string(v)
|
|
}
|
|
panic(fmt.Sprintf("unknown type: %T", msg))
|
|
}
|
|
|
|
// Error sets error message
|
|
func (f *Flash) Error(msg any, current ...bool) {
|
|
f.ErrorMsg = flashMsgStringOrHTML(msg)
|
|
f.set("error", f.ErrorMsg, current...)
|
|
}
|
|
|
|
// Warning sets warning message
|
|
func (f *Flash) Warning(msg any, current ...bool) {
|
|
f.WarningMsg = flashMsgStringOrHTML(msg)
|
|
f.set("warning", f.WarningMsg, current...)
|
|
}
|
|
|
|
// Info sets info message
|
|
func (f *Flash) Info(msg any, current ...bool) {
|
|
f.InfoMsg = flashMsgStringOrHTML(msg)
|
|
f.set("info", f.InfoMsg, current...)
|
|
}
|
|
|
|
// Success sets success message
|
|
func (f *Flash) Success(msg any, current ...bool) {
|
|
f.SuccessMsg = flashMsgStringOrHTML(msg)
|
|
f.set("success", f.SuccessMsg, current...)
|
|
}
|