forgejo/modules/middleware/context.go

256 lines
6.9 KiB
Go
Raw Normal View History

// Copyright 2014 The Gogs Authors. All rights reserved.
// Use of this source code is governed by a MIT-style
// license that can be found in the LICENSE file.
package middleware
import (
2014-03-15 14:17:16 +01:00
"fmt"
2014-03-22 18:44:02 +01:00
"html/template"
2014-04-15 18:27:29 +02:00
"io"
"net/http"
2014-03-22 21:40:09 +01:00
"strings"
2014-03-19 14:57:55 +01:00
"time"
2015-10-16 03:28:12 +02:00
"github.com/go-macaron/cache"
"github.com/go-macaron/csrf"
"github.com/go-macaron/i18n"
"github.com/go-macaron/session"
"gopkg.in/macaron.v1"
2014-03-21 14:06:47 +01:00
2015-12-15 23:25:45 +01:00
"github.com/gogits/git-module"
"github.com/gogits/gogs/models"
"github.com/gogits/gogs/modules/auth"
2014-03-21 14:31:47 +01:00
"github.com/gogits/gogs/modules/base"
"github.com/gogits/gogs/modules/log"
2014-05-26 02:11:25 +02:00
"github.com/gogits/gogs/modules/setting"
)
2015-08-26 18:30:06 +02:00
type RepoContext struct {
AccessMode models.AccessMode
IsWatching bool
IsViewBranch bool
IsViewTag bool
IsViewCommit bool
2015-08-26 18:30:06 +02:00
Repository *models.Repository
Owner *models.User
Commit *git.Commit
Tag *git.Tag
GitRepo *git.Repository
BranchName string
TagName string
TreeName string
2015-08-31 09:24:28 +02:00
CommitID string
2015-08-26 18:30:06 +02:00
RepoLink string
CloneLink models.CloneLink
CommitsCount int64
2015-08-26 18:30:06 +02:00
Mirror *models.Mirror
}
2014-03-15 14:17:16 +01:00
// Context represents context of a request.
type Context struct {
2014-07-26 06:24:27 +02:00
*macaron.Context
Cache cache.Cache
csrf csrf.CSRF
2014-07-26 06:24:27 +02:00
Flash *session.Flash
Session session.Store
2014-11-18 17:07:16 +01:00
User *models.User
IsSigned bool
IsBasicAuth bool
2014-03-15 17:03:23 +01:00
2015-11-27 07:50:38 +01:00
Repo *RepoContext
2014-08-14 08:12:21 +02:00
Org struct {
IsOwner bool
IsMember bool
2016-01-31 14:28:42 +01:00
IsTeamMember bool // Is member of team.
IsAdminTeam bool // In owner team or team that has admin permission level.
2014-08-14 08:12:21 +02:00
Organization *models.User
OrgLink string
Team *models.Team
2014-08-14 08:12:21 +02:00
}
}
// IsOwner returns true if current user is the owner of repository.
2015-11-27 07:50:38 +01:00
func (r *RepoContext) IsOwner() bool {
return r.AccessMode >= models.ACCESS_MODE_OWNER
}
// IsAdmin returns true if current user has admin or higher access of repository.
2015-11-27 07:50:38 +01:00
func (r *RepoContext) IsAdmin() bool {
return r.AccessMode >= models.ACCESS_MODE_ADMIN
}
2015-11-27 07:50:38 +01:00
// IsPusher returns true if current user has write or higher access of repository.
func (r *RepoContext) IsPusher() bool {
return r.AccessMode >= models.ACCESS_MODE_WRITE
}
// Return if the current user has read access for this repository
2015-11-27 07:50:38 +01:00
func (r *RepoContext) HasAccess() bool {
return r.AccessMode >= models.ACCESS_MODE_READ
}
2014-05-05 19:08:01 +02:00
// HasError returns true if error occurs in form validation.
func (ctx *Context) HasApiError() bool {
hasErr, ok := ctx.Data["HasError"]
if !ok {
return false
}
return hasErr.(bool)
}
func (ctx *Context) GetErrMsg() string {
return ctx.Data["ErrorMsg"].(string)
}
2014-03-15 15:52:14 +01:00
// HasError returns true if error occurs in form validation.
func (ctx *Context) HasError() bool {
hasErr, ok := ctx.Data["HasError"]
if !ok {
return false
}
2014-04-14 00:12:07 +02:00
ctx.Flash.ErrorMsg = ctx.Data["ErrorMsg"].(string)
ctx.Data["Flash"] = ctx.Flash
2014-03-15 15:52:14 +01:00
return hasErr.(bool)
}
2015-07-08 13:47:56 +02:00
// HasValue returns true if value of given name exists.
func (ctx *Context) HasValue(name string) bool {
_, ok := ctx.Data[name]
return ok
}
2014-08-02 19:47:33 +02:00
// HTML calls Context.HTML and converts template name to string.
2014-07-26 06:24:27 +02:00
func (ctx *Context) HTML(status int, name base.TplName) {
log.Debug("Template: %s", name)
2014-08-02 19:47:33 +02:00
ctx.Context.HTML(status, string(name))
2014-03-20 12:50:26 +01:00
}
2014-03-15 15:52:14 +01:00
// RenderWithErr used for page has form validation but need to prompt error to users.
2014-07-26 06:24:27 +02:00
func (ctx *Context) RenderWithErr(msg string, tpl base.TplName, form interface{}) {
2014-04-03 21:50:55 +02:00
if form != nil {
auth.AssignForm(form, ctx.Data)
}
2014-04-10 22:36:50 +02:00
ctx.Flash.ErrorMsg = msg
ctx.Data["Flash"] = ctx.Flash
2014-03-20 12:50:26 +01:00
ctx.HTML(200, tpl)
2014-03-15 15:52:14 +01:00
}
2014-03-15 14:17:16 +01:00
// Handle handles and logs error by given status.
func (ctx *Context) Handle(status int, title string, err error) {
2014-05-02 00:53:41 +02:00
if err != nil {
2014-07-26 06:24:27 +02:00
log.Error(4, "%s: %v", title, err)
if macaron.Env != macaron.PROD {
2014-05-02 00:53:41 +02:00
ctx.Data["ErrorMsg"] = err
}
2014-03-19 09:48:45 +01:00
}
2014-05-02 00:53:41 +02:00
switch status {
case 404:
ctx.Data["Title"] = "Page Not Found"
case 500:
ctx.Data["Title"] = "Internal Server Error"
}
ctx.HTML(status, base.TplName(fmt.Sprintf("status/%d", status)))
}
func (ctx *Context) HandleText(status int, title string) {
2015-07-08 13:47:56 +02:00
if (status/100 == 4) || (status/100 == 5) {
log.Error(4, "%s", title)
}
2015-10-16 03:28:12 +02:00
ctx.PlainText(status, []byte(title))
}
2015-10-09 02:36:07 +02:00
// APIError logs error with title if status is 500.
func (ctx *Context) APIError(status int, title string, obj interface{}) {
var message string
if err, ok := obj.(error); ok {
message = err.Error()
} else {
message = obj.(string)
}
2015-10-09 02:36:07 +02:00
if status == 500 {
log.Error(4, "%s: %s", title, message)
}
ctx.JSON(status, map[string]string{
"message": message,
2015-10-09 02:36:07 +02:00
"url": base.DOC_URL,
})
}
2014-04-15 18:27:29 +02:00
func (ctx *Context) ServeContent(name string, r io.ReadSeeker, params ...interface{}) {
modtime := time.Now()
for _, p := range params {
switch v := p.(type) {
case time.Time:
modtime = v
}
}
2014-07-26 06:24:27 +02:00
ctx.Resp.Header().Set("Content-Description", "File Transfer")
ctx.Resp.Header().Set("Content-Type", "application/octet-stream")
ctx.Resp.Header().Set("Content-Disposition", "attachment; filename="+name)
ctx.Resp.Header().Set("Content-Transfer-Encoding", "binary")
ctx.Resp.Header().Set("Expires", "0")
ctx.Resp.Header().Set("Cache-Control", "must-revalidate")
ctx.Resp.Header().Set("Pragma", "public")
2014-10-19 05:26:55 +02:00
http.ServeContent(ctx.Resp, ctx.Req.Request, name, modtime, r)
2014-04-10 20:37:43 +02:00
}
2014-07-26 06:24:27 +02:00
// Contexter initializes a classic context for a request.
func Contexter() macaron.Handler {
return func(c *macaron.Context, l i18n.Locale, cache cache.Cache, sess session.Store, f *session.Flash, x csrf.CSRF) {
ctx := &Context{
2014-07-26 06:24:27 +02:00
Context: c,
Cache: cache,
csrf: x,
2014-07-26 06:24:27 +02:00
Flash: f,
Session: sess,
2015-12-04 23:20:23 +01:00
Repo: &RepoContext{},
}
2014-07-26 06:24:27 +02:00
// Compute current URL for real-time change language.
2015-11-13 22:43:43 +01:00
ctx.Data["Link"] = setting.AppSubUrl + strings.TrimSuffix(ctx.Req.URL.Path, "/")
2014-04-10 20:37:43 +02:00
2014-07-26 06:24:27 +02:00
ctx.Data["PageStartTime"] = time.Now()
2014-03-22 13:49:53 +01:00
// Get user from session if logined.
ctx.User, ctx.IsBasicAuth = auth.SignedInUser(ctx.Context, ctx.Session)
2014-11-07 20:46:13 +01:00
2014-07-26 06:24:27 +02:00
if ctx.User != nil {
ctx.IsSigned = true
ctx.Data["IsSigned"] = ctx.IsSigned
ctx.Data["SignedUser"] = ctx.User
2015-08-19 17:14:57 +02:00
ctx.Data["SignedUserID"] = ctx.User.Id
2014-11-07 04:06:41 +01:00
ctx.Data["SignedUserName"] = ctx.User.Name
2014-03-20 13:02:14 +01:00
ctx.Data["IsAdmin"] = ctx.User.IsAdmin
2014-11-07 04:06:41 +01:00
} else {
2015-08-19 17:14:57 +02:00
ctx.Data["SignedUserID"] = 0
2014-11-07 04:06:41 +01:00
ctx.Data["SignedUserName"] = ""
2014-03-15 13:50:17 +01:00
}
2014-07-24 15:19:59 +02:00
// If request sends files, parse them here otherwise the Query() can't be parsed and the CsrfToken will be invalid.
2014-07-26 06:24:27 +02:00
if ctx.Req.Method == "POST" && strings.Contains(ctx.Req.Header.Get("Content-Type"), "multipart/form-data") {
if err := ctx.Req.ParseMultipartForm(setting.AttachmentMaxSize << 20); err != nil && !strings.Contains(err.Error(), "EOF") { // 32MB max size
ctx.Handle(500, "ParseMultipartForm", err)
2014-07-24 15:19:59 +02:00
return
}
}
ctx.Data["CsrfToken"] = x.GetToken()
ctx.Data["CsrfTokenHtml"] = template.HTML(`<input type="hidden" name="_csrf" value="` + x.GetToken() + `">`)
log.Debug("Session ID: %s", sess.ID())
log.Debug("CSRF Token: %v", ctx.Data["CsrfToken"])
2014-03-19 14:57:55 +01:00
2015-02-07 03:16:23 +01:00
ctx.Data["ShowRegistrationButton"] = setting.Service.ShowRegistrationButton
ctx.Data["ShowFooterBranding"] = setting.ShowFooterBranding
ctx.Data["ShowFooterVersion"] = setting.ShowFooterVersion
2015-02-07 03:16:23 +01:00
c.Map(ctx)
}
}