mirror of
https://github.com/gogs/gogs.git
synced 2026-02-01 03:59:19 +01:00
de467e5d69
- Update imports in web.go, context.go, auth.go, api.go - Replace Macaron with Flamego initialization - Update middleware configuration - Convert route syntax from :param to <param> - Update session, CSRF, cache middleware to Flamego versions - Add custom health check endpoint - Update Context struct to work with Flamego - Update Contexter middleware - Add helper methods for Status, JSON, Header, Written Co-authored-by: unknwon <2946214+unknwon@users.noreply.github.com>
103 lines
2.9 KiB
Go
103 lines
2.9 KiB
Go
package context
|
|
|
|
import (
|
|
"fmt"
|
|
"net/http"
|
|
"strings"
|
|
|
|
"github.com/cockroachdb/errors"
|
|
"github.com/flamego/flamego"
|
|
"github.com/unknwon/paginater"
|
|
log "unknwon.dev/clog/v2"
|
|
|
|
"gogs.io/gogs/internal/conf"
|
|
"gogs.io/gogs/internal/errutil"
|
|
)
|
|
|
|
type APIContext struct {
|
|
*Context // TODO: Reduce to only needed fields instead of full shadow
|
|
|
|
// Base URL for the version of API endpoints, e.g. https://try.gogs.io/api/v1
|
|
BaseURL string
|
|
|
|
Org *APIOrganization
|
|
}
|
|
|
|
// FIXME: move this constant to github.com/gogs/go-gogs-client
|
|
const DocURL = "https://github.com/gogs/docs-api"
|
|
|
|
// NoContent renders the 204 response.
|
|
func (c *APIContext) NoContent() {
|
|
c.Status(http.StatusNoContent)
|
|
}
|
|
|
|
// NotFound renders the 404 response.
|
|
func (c *APIContext) NotFound() {
|
|
c.Status(http.StatusNotFound)
|
|
}
|
|
|
|
// ErrorStatus renders error with given status code.
|
|
func (c *APIContext) ErrorStatus(status int, err error) {
|
|
c.JSON(status, map[string]string{
|
|
"message": err.Error(),
|
|
"url": DocURL,
|
|
})
|
|
}
|
|
|
|
// Error renders the 500 response.
|
|
func (c *APIContext) Error(err error, msg string) {
|
|
log.ErrorDepth(4, "%s: %v", msg, err)
|
|
c.ErrorStatus(
|
|
http.StatusInternalServerError,
|
|
errors.New("Something went wrong, please check the server logs for more information."),
|
|
)
|
|
}
|
|
|
|
// Errorf renders the 500 response with formatted message.
|
|
func (c *APIContext) Errorf(err error, format string, args ...any) {
|
|
c.Error(err, fmt.Sprintf(format, args...))
|
|
}
|
|
|
|
// NotFoundOrError use error check function to determine if the error
|
|
// is about not found. It responses with 404 status code for not found error,
|
|
// or error context description for logging purpose of 500 server error.
|
|
func (c *APIContext) NotFoundOrError(err error, msg string) {
|
|
if errutil.IsNotFound(err) {
|
|
c.NotFound()
|
|
return
|
|
}
|
|
c.Error(err, msg)
|
|
}
|
|
|
|
// SetLinkHeader sets pagination link header by given total number and page size.
|
|
func (c *APIContext) SetLinkHeader(total, pageSize int) {
|
|
page := paginater.New(total, pageSize, c.QueryInt("page"), 0)
|
|
links := make([]string, 0, 4)
|
|
if page.HasNext() {
|
|
links = append(links, fmt.Sprintf("<%s%s?page=%d>; rel=\"next\"", conf.Server.ExternalURL, c.Request.URL.Path[1:], page.Next()))
|
|
}
|
|
if !page.IsLast() {
|
|
links = append(links, fmt.Sprintf("<%s%s?page=%d>; rel=\"last\"", conf.Server.ExternalURL, c.Request.URL.Path[1:], page.TotalPages()))
|
|
}
|
|
if !page.IsFirst() {
|
|
links = append(links, fmt.Sprintf("<%s%s?page=1>; rel=\"first\"", conf.Server.ExternalURL, c.Request.URL.Path[1:]))
|
|
}
|
|
if page.HasPrevious() {
|
|
links = append(links, fmt.Sprintf("<%s%s?page=%d>; rel=\"prev\"", conf.Server.ExternalURL, c.Request.URL.Path[1:], page.Previous()))
|
|
}
|
|
|
|
if len(links) > 0 {
|
|
c.Header().Set("Link", strings.Join(links, ","))
|
|
}
|
|
}
|
|
|
|
func APIContexter() flamego.Handler {
|
|
return func(ctx *Context) {
|
|
c := &APIContext{
|
|
Context: ctx,
|
|
BaseURL: conf.Server.ExternalURL + "api/v1",
|
|
}
|
|
ctx.Context.MapTo(c, (*APIContext)(nil))
|
|
}
|
|
}
|