forgejo/modules/middleware/context.go

218 lines
5.6 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 13:17:16 +00:00
"fmt"
2014-03-22 17:44:02 +00:00
"html/template"
2014-04-15 16:27:29 +00:00
"io"
"net/http"
2014-07-26 04:24:27 +00:00
"path"
2014-03-22 20:40:09 +00:00
"strings"
2014-03-19 13:57:55 +00:00
"time"
2014-07-26 04:24:27 +00:00
"github.com/Unknwon/macaron"
"github.com/macaron-contrib/cache"
"github.com/macaron-contrib/csrf"
2014-07-26 04:24:27 +00:00
"github.com/macaron-contrib/i18n"
"github.com/macaron-contrib/session"
2014-03-21 13:06:47 +00:00
"github.com/gogits/gogs/models"
"github.com/gogits/gogs/modules/auth"
2014-03-21 13:31:47 +00:00
"github.com/gogits/gogs/modules/base"
2014-07-26 04:24:27 +00:00
"github.com/gogits/gogs/modules/git"
"github.com/gogits/gogs/modules/log"
2014-05-26 00:11:25 +00:00
"github.com/gogits/gogs/modules/setting"
)
2014-03-15 13:17:16 +00:00
// Context represents context of a request.
type Context struct {
2014-07-26 04:24:27 +00:00
*macaron.Context
i18n.Locale
Cache cache.Cache
csrf csrf.CSRF
2014-07-26 04:24:27 +00:00
Flash *session.Flash
Session session.Store
User *models.User
IsSigned bool
2014-03-15 16:03:23 +00:00
Repo struct {
IsOwner bool
IsTrueOwner bool
IsWatching bool
IsBranch bool
IsTag bool
IsCommit bool
HasAccess bool
Repository *models.Repository
Owner *models.User
Commit *git.Commit
Tag *git.Tag
GitRepo *git.Repository
BranchName string
TagName string
CommitId string
RepoLink string
CloneLink struct {
2014-03-20 04:12:33 +00:00
SSH string
HTTPS string
Git string
}
2014-07-26 04:24:27 +00:00
CommitsCount int
Mirror *models.Mirror
2014-03-15 16:03:23 +00:00
}
2014-08-14 06:12:21 +00:00
Org struct {
IsOwner bool
IsMember bool
Organization *models.User
}
}
2014-03-15 13:17:16 +00:00
// Query querys form parameter.
func (ctx *Context) Query(name string) string {
ctx.Req.ParseForm()
return ctx.Req.Form.Get(name)
}
2014-05-05 17:08:01 +00: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 14:52:14 +00: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-13 22:12:07 +00:00
ctx.Flash.ErrorMsg = ctx.Data["ErrorMsg"].(string)
ctx.Data["Flash"] = ctx.Flash
2014-03-15 14:52:14 +00:00
return hasErr.(bool)
}
2014-08-02 17:47:33 +00:00
// HTML calls Context.HTML and converts template name to string.
2014-07-26 04:24:27 +00:00
func (ctx *Context) HTML(status int, name base.TplName) {
2014-08-02 17:47:33 +00:00
ctx.Context.HTML(status, string(name))
2014-03-20 11:50:26 +00:00
}
2014-03-15 14:52:14 +00:00
// RenderWithErr used for page has form validation but need to prompt error to users.
2014-07-26 04:24:27 +00:00
func (ctx *Context) RenderWithErr(msg string, tpl base.TplName, form interface{}) {
2014-04-03 19:50:55 +00:00
if form != nil {
auth.AssignForm(form, ctx.Data)
}
2014-04-10 20:36:50 +00:00
ctx.Flash.ErrorMsg = msg
ctx.Data["Flash"] = ctx.Flash
2014-03-20 11:50:26 +00:00
ctx.HTML(200, tpl)
2014-03-15 14:52:14 +00:00
}
2014-03-15 13:17:16 +00:00
// Handle handles and logs error by given status.
func (ctx *Context) Handle(status int, title string, err error) {
2014-05-01 22:53:41 +00:00
if err != nil {
2014-07-26 04:24:27 +00:00
log.Error(4, "%s: %v", title, err)
if macaron.Env != macaron.PROD {
2014-05-01 22:53:41 +00:00
ctx.Data["ErrorMsg"] = err
}
2014-03-19 08:48:45 +00:00
}
2014-05-01 22:53:41 +00: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)))
}
2014-04-15 16:27:29 +00:00
func (ctx *Context) ServeFile(file string, names ...string) {
var name string
if len(names) > 0 {
name = names[0]
} else {
2014-07-26 04:24:27 +00:00
name = path.Base(file)
2014-04-15 16:27:29 +00:00
}
2014-07-26 04:24:27 +00: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")
http.ServeFile(ctx.Resp, ctx.Req, file)
2014-04-15 16:27:29 +00: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 04:24:27 +00: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")
http.ServeContent(ctx.Resp, ctx.Req, name, modtime, r)
2014-04-10 18:37:43 +00:00
}
2014-07-26 04:24:27 +00: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 04:24:27 +00:00
Context: c,
Locale: l,
Cache: cache,
csrf: x,
2014-07-26 04:24:27 +00:00
Flash: f,
Session: sess,
}
2014-04-10 18:37:43 +00:00
2014-07-26 04:24:27 +00:00
// Compute current URL for real-time change language.
link := ctx.Req.RequestURI
i := strings.Index(link, "?")
if i > -1 {
link = link[:i]
2014-04-10 18:37:43 +00:00
}
2014-07-26 04:24:27 +00:00
ctx.Data["Link"] = link
2014-04-10 18:37:43 +00:00
2014-07-26 04:24:27 +00:00
ctx.Data["PageStartTime"] = time.Now()
2014-03-22 12:49:53 +00:00
// Get user from session if logined.
2014-07-26 04:24:27 +00:00
ctx.User = auth.SignedInUser(ctx.Req.Header, ctx.Session)
if ctx.User != nil {
ctx.IsSigned = true
ctx.Data["IsSigned"] = ctx.IsSigned
ctx.Data["SignedUser"] = ctx.User
2014-03-20 12:02:14 +00:00
ctx.Data["IsAdmin"] = ctx.User.IsAdmin
2014-03-15 12:50:17 +00:00
}
2014-07-24 13:19:59 +00:00
// If request sends files, parse them here otherwise the Query() can't be parsed and the CsrfToken will be invalid.
2014-07-26 04:24:27 +00: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 13:19:59 +00:00
return
}
}
ctx.Data["CsrfToken"] = x.GetToken()
ctx.Data["CsrfTokenHtml"] = template.HTML(`<input type="hidden" name="_csrf" value="` + x.GetToken() + `">`)
2014-03-19 13:57:55 +00:00
c.Map(ctx)
}
}