* move email unsubscription page outside of API and make it HTML * make separate HTML template for SendErrorHTML * fix error template name * add test for SendErrorHTML, introduce MustExecute function * fix content check in test of TestSendErrorHTML * fix logging test to be more generic and not depend on line numbers
111 lines
3.9 KiB
Go
111 lines
3.9 KiB
Go
package rest
|
|
|
|
import (
|
|
"bytes"
|
|
"fmt"
|
|
"html/template"
|
|
"io"
|
|
"net/http"
|
|
"net/url"
|
|
"runtime"
|
|
"strings"
|
|
|
|
"github.com/go-chi/render"
|
|
log "github.com/go-pkgz/lgr"
|
|
"github.com/go-pkgz/rest"
|
|
)
|
|
|
|
// All error codes for UI mapping and translation
|
|
const (
|
|
ErrInternal = 0 // any internal error
|
|
ErrCommentNotFound = 1 // can't find comment
|
|
ErrDecode = 2 // failed to unmarshal incoming request
|
|
ErrNoAccess = 3 // rejected by auth
|
|
ErrCommentValidation = 4 // validation failed
|
|
ErrPostNotFound = 5 // can't find post
|
|
ErrSiteNotFound = 6 // can't find site
|
|
ErrUserBlocked = 7 // user blocked
|
|
ErrReadOnly = 8 // write failed on read only
|
|
ErrCommentRejected = 9 // general error on rejected comment change
|
|
ErrCommentEditExpired = 10 // too late for edit
|
|
ErrCommentEditChanged = 11 // parent comment cannot be changed
|
|
ErrVoteRejected = 12 // general error on vote rejected
|
|
ErrVoteSelf = 13 // vote for own comment
|
|
ErrVoteDbl = 14 // already voted for the comment
|
|
ErrVoteMax = 15 // too many votes for the comment
|
|
ErrVoteMinScore = 16 // min score reached for the comment
|
|
ErrActionRejected = 17 // general error for rejected actions
|
|
ErrAssetNotFound = 18 // requested file not found
|
|
)
|
|
|
|
const errorHtml = `<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta name="viewport" content="width=device-width"/>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
|
</head>
|
|
<body>
|
|
<div style="text-align: center; font-family: Arial, sans-serif; font-size: 18px;">
|
|
<h1 style="position: relative; color: #4fbbd6; margin-top: 0.2em;">Remark42</h1>
|
|
<p style="position: relative; max-width: 20em; margin: 0 auto 1em auto; line-height: 1.4em;">{{.Error}}: {{.Details}}.</p>
|
|
</div>
|
|
</body>
|
|
</html>
|
|
`
|
|
|
|
// errTmplData store data for error message
|
|
type errTmplData struct {
|
|
Error string
|
|
Details string
|
|
}
|
|
|
|
// SendErrorHTML makes html body with provided template and responds with provided http status code,
|
|
// error code is not included in render as it is intended for UI developers and not for the users
|
|
func SendErrorHTML(w http.ResponseWriter, r *http.Request, httpStatusCode int, err error, details string, errCode int) {
|
|
// MustExecute behaves like template.Execute, but panics if an error occurs.
|
|
MustExecute := func(tmpl *template.Template, wr io.Writer, data interface{}) {
|
|
if err := tmpl.Execute(wr, data); err != nil {
|
|
panic(err)
|
|
}
|
|
}
|
|
|
|
tmpl := template.Must(template.New("error").Parse(errorHtml))
|
|
log.Printf("[WARN] %s", errDetailsMsg(r, httpStatusCode, err, details, errCode))
|
|
render.Status(r, httpStatusCode)
|
|
msg := bytes.Buffer{}
|
|
MustExecute(tmpl, &msg, errTmplData{
|
|
Error: err.Error(),
|
|
Details: details,
|
|
})
|
|
render.HTML(w, r, msg.String())
|
|
}
|
|
|
|
// SendErrorJSON makes {error: blah, details: blah} json body and responds with error code
|
|
func SendErrorJSON(w http.ResponseWriter, r *http.Request, httpStatusCode int, err error, details string, errCode int) {
|
|
log.Printf("[WARN] %s", errDetailsMsg(r, httpStatusCode, err, details, errCode))
|
|
render.Status(r, httpStatusCode)
|
|
render.JSON(w, r, rest.JSON{"error": err.Error(), "details": details, "code": errCode})
|
|
}
|
|
|
|
func errDetailsMsg(r *http.Request, httpStatusCode int, err error, details string, errCode int) string {
|
|
uinfoStr := ""
|
|
if user, e := GetUserInfo(r); e == nil {
|
|
uinfoStr = user.Name + "/" + user.ID + " - "
|
|
}
|
|
q := r.URL.String()
|
|
if qun, e := url.QueryUnescape(q); e == nil {
|
|
q = qun
|
|
}
|
|
|
|
srcFileInfo := ""
|
|
if pc, file, line, ok := runtime.Caller(2); ok {
|
|
fnameElems := strings.Split(file, "/")
|
|
funcNameElems := strings.Split(runtime.FuncForPC(pc).Name(), "/")
|
|
srcFileInfo = fmt.Sprintf("[%s:%d %s]", strings.Join(fnameElems[len(fnameElems)-3:], "/"),
|
|
line, funcNameElems[len(funcNameElems)-1])
|
|
}
|
|
|
|
return fmt.Sprintf("%s - %v - %d (%d) - %s%s - %s",
|
|
details, err, httpStatusCode, errCode, uinfoStr, q, srcFileInfo)
|
|
}
|