2014-03-15 19:01:50 +08:00
|
|
|
// 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.
|
|
|
|
|
2016-03-12 00:56:52 +08:00
|
|
|
package context
|
2014-03-15 19:01:50 +08:00
|
|
|
|
|
|
|
import (
|
2014-03-15 21:17:16 +08:00
|
|
|
"fmt"
|
2014-03-23 01:44:02 +08:00
|
|
|
"html/template"
|
2014-04-16 00:27:29 +08:00
|
|
|
"io"
|
2014-03-15 19:01:50 +08:00
|
|
|
"net/http"
|
2014-03-23 04:40:09 +08:00
|
|
|
"strings"
|
2014-03-19 21:57:55 +08:00
|
|
|
"time"
|
2014-03-15 19:01:50 +08:00
|
|
|
|
2016-11-11 00:24:48 +08:00
|
|
|
"code.gitea.io/gitea/models"
|
|
|
|
"code.gitea.io/gitea/modules/auth"
|
|
|
|
"code.gitea.io/gitea/modules/base"
|
|
|
|
"code.gitea.io/gitea/modules/log"
|
|
|
|
"code.gitea.io/gitea/modules/setting"
|
2016-11-06 00:56:35 +08:00
|
|
|
"github.com/go-macaron/cache"
|
|
|
|
"github.com/go-macaron/csrf"
|
|
|
|
"github.com/go-macaron/i18n"
|
|
|
|
"github.com/go-macaron/session"
|
|
|
|
macaron "gopkg.in/macaron.v1"
|
2014-03-15 19:01:50 +08:00
|
|
|
)
|
|
|
|
|
2014-03-15 21:17:16 +08:00
|
|
|
// Context represents context of a request.
|
2014-03-15 19:01:50 +08:00
|
|
|
type Context struct {
|
2014-07-26 12:24:27 +08:00
|
|
|
*macaron.Context
|
2014-08-01 05:25:34 +08:00
|
|
|
Cache cache.Cache
|
|
|
|
csrf csrf.CSRF
|
2014-07-26 12:24:27 +08:00
|
|
|
Flash *session.Flash
|
|
|
|
Session session.Store
|
|
|
|
|
2014-11-19 00:07:16 +08:00
|
|
|
User *models.User
|
|
|
|
IsSigned bool
|
|
|
|
IsBasicAuth bool
|
2014-03-16 00:03:23 +08:00
|
|
|
|
2016-03-12 00:56:52 +08:00
|
|
|
Repo *Repository
|
2016-03-14 05:37:44 +08:00
|
|
|
Org *Organization
|
2014-03-15 19:01:50 +08:00
|
|
|
}
|
|
|
|
|
2016-11-25 14:51:01 +08:00
|
|
|
// HasAPIError returns true if error occurs in form validation.
|
|
|
|
func (ctx *Context) HasAPIError() bool {
|
2014-05-06 01:08:01 +08:00
|
|
|
hasErr, ok := ctx.Data["HasError"]
|
|
|
|
if !ok {
|
|
|
|
return false
|
|
|
|
}
|
|
|
|
return hasErr.(bool)
|
|
|
|
}
|
|
|
|
|
2016-11-25 14:51:01 +08:00
|
|
|
// GetErrMsg returns error message
|
2014-05-06 01:08:01 +08:00
|
|
|
func (ctx *Context) GetErrMsg() string {
|
|
|
|
return ctx.Data["ErrorMsg"].(string)
|
|
|
|
}
|
|
|
|
|
2014-03-15 22:52:14 +08: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 06:12:07 +08:00
|
|
|
ctx.Flash.ErrorMsg = ctx.Data["ErrorMsg"].(string)
|
|
|
|
ctx.Data["Flash"] = ctx.Flash
|
2014-03-15 22:52:14 +08:00
|
|
|
return hasErr.(bool)
|
|
|
|
}
|
|
|
|
|
2015-07-08 19:47:56 +08: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-03 01:47:33 +08:00
|
|
|
// HTML calls Context.HTML and converts template name to string.
|
2014-07-26 12:24:27 +08:00
|
|
|
func (ctx *Context) HTML(status int, name base.TplName) {
|
2015-12-20 14:06:54 +08:00
|
|
|
log.Debug("Template: %s", name)
|
2014-08-03 01:47:33 +08:00
|
|
|
ctx.Context.HTML(status, string(name))
|
2014-03-20 19:50:26 +08:00
|
|
|
}
|
|
|
|
|
2014-03-15 22:52:14 +08:00
|
|
|
// RenderWithErr used for page has form validation but need to prompt error to users.
|
2014-07-26 12:24:27 +08:00
|
|
|
func (ctx *Context) RenderWithErr(msg string, tpl base.TplName, form interface{}) {
|
2014-04-04 03:50:55 +08:00
|
|
|
if form != nil {
|
|
|
|
auth.AssignForm(form, ctx.Data)
|
|
|
|
}
|
2014-04-11 04:36:50 +08:00
|
|
|
ctx.Flash.ErrorMsg = msg
|
|
|
|
ctx.Data["Flash"] = ctx.Flash
|
2014-03-20 19:50:26 +08:00
|
|
|
ctx.HTML(200, tpl)
|
2014-03-15 22:52:14 +08:00
|
|
|
}
|
|
|
|
|
2014-03-15 21:17:16 +08:00
|
|
|
// Handle handles and logs error by given status.
|
|
|
|
func (ctx *Context) Handle(status int, title string, err error) {
|
2014-05-02 06:53:41 +08:00
|
|
|
if err != nil {
|
2014-07-26 12:24:27 +08:00
|
|
|
log.Error(4, "%s: %v", title, err)
|
|
|
|
if macaron.Env != macaron.PROD {
|
2014-05-02 06:53:41 +08:00
|
|
|
ctx.Data["ErrorMsg"] = err
|
|
|
|
}
|
2014-03-19 16:48:45 +08:00
|
|
|
}
|
|
|
|
|
2014-05-02 06:53:41 +08:00
|
|
|
switch status {
|
|
|
|
case 404:
|
|
|
|
ctx.Data["Title"] = "Page Not Found"
|
|
|
|
case 500:
|
|
|
|
ctx.Data["Title"] = "Internal Server Error"
|
|
|
|
}
|
2014-06-23 01:14:03 +08:00
|
|
|
ctx.HTML(status, base.TplName(fmt.Sprintf("status/%d", status)))
|
2014-03-15 19:01:50 +08:00
|
|
|
}
|
|
|
|
|
2016-08-30 17:08:38 +08:00
|
|
|
// NotFoundOrServerError 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 (ctx *Context) NotFoundOrServerError(title string, errck func(error) bool, err error) {
|
2016-07-26 02:48:17 +08:00
|
|
|
if errck(err) {
|
2016-08-30 17:08:38 +08:00
|
|
|
ctx.Handle(404, title, err)
|
2016-07-26 02:48:17 +08:00
|
|
|
return
|
|
|
|
}
|
|
|
|
|
|
|
|
ctx.Handle(500, title, err)
|
|
|
|
}
|
|
|
|
|
2016-11-25 14:51:01 +08:00
|
|
|
// HandleText handles HTTP status code
|
2015-03-28 22:30:05 +08:00
|
|
|
func (ctx *Context) HandleText(status int, title string) {
|
2015-07-08 19:47:56 +08:00
|
|
|
if (status/100 == 4) || (status/100 == 5) {
|
2015-03-28 22:30:05 +08:00
|
|
|
log.Error(4, "%s", title)
|
|
|
|
}
|
2015-10-16 09:28:12 +08:00
|
|
|
ctx.PlainText(status, []byte(title))
|
2015-03-28 22:30:05 +08:00
|
|
|
}
|
|
|
|
|
2016-11-25 14:51:01 +08:00
|
|
|
// ServeContent serves content to http request
|
2014-04-16 00:27:29 +08: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 12:24:27 +08: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 11:26:55 +08:00
|
|
|
http.ServeContent(ctx.Resp, ctx.Req.Request, name, modtime, r)
|
2014-04-11 02:37:43 +08:00
|
|
|
}
|
|
|
|
|
2014-07-26 12:24:27 +08:00
|
|
|
// Contexter initializes a classic context for a request.
|
|
|
|
func Contexter() macaron.Handler {
|
2014-08-01 05:25:34 +08:00
|
|
|
return func(c *macaron.Context, l i18n.Locale, cache cache.Cache, sess session.Store, f *session.Flash, x csrf.CSRF) {
|
2014-03-15 19:01:50 +08:00
|
|
|
ctx := &Context{
|
2014-07-26 12:24:27 +08:00
|
|
|
Context: c,
|
2014-08-01 05:25:34 +08:00
|
|
|
Cache: cache,
|
|
|
|
csrf: x,
|
2014-07-26 12:24:27 +08:00
|
|
|
Flash: f,
|
|
|
|
Session: sess,
|
2016-03-12 00:56:52 +08:00
|
|
|
Repo: &Repository{
|
|
|
|
PullRequest: &PullRequest{},
|
2016-03-07 12:57:46 +08:00
|
|
|
},
|
2016-03-14 05:37:44 +08:00
|
|
|
Org: &Organization{},
|
2014-03-15 19:01:50 +08:00
|
|
|
}
|
2014-07-26 12:24:27 +08:00
|
|
|
// Compute current URL for real-time change language.
|
2015-11-14 05:43:43 +08:00
|
|
|
ctx.Data["Link"] = setting.AppSubUrl + strings.TrimSuffix(ctx.Req.URL.Path, "/")
|
2014-04-11 02:37:43 +08:00
|
|
|
|
2014-07-26 12:24:27 +08:00
|
|
|
ctx.Data["PageStartTime"] = time.Now()
|
2014-03-22 20:49:53 +08:00
|
|
|
|
2014-03-15 19:01:50 +08:00
|
|
|
// Get user from session if logined.
|
2015-09-02 14:40:15 +08:00
|
|
|
ctx.User, ctx.IsBasicAuth = auth.SignedInUser(ctx.Context, ctx.Session)
|
2014-11-08 03:46:13 +08:00
|
|
|
|
2014-07-26 12:24:27 +08:00
|
|
|
if ctx.User != nil {
|
|
|
|
ctx.IsSigned = true
|
|
|
|
ctx.Data["IsSigned"] = ctx.IsSigned
|
|
|
|
ctx.Data["SignedUser"] = ctx.User
|
2016-07-24 01:08:22 +08:00
|
|
|
ctx.Data["SignedUserID"] = ctx.User.ID
|
2014-11-07 11:06:41 +08:00
|
|
|
ctx.Data["SignedUserName"] = ctx.User.Name
|
2014-03-20 20:02:14 +08:00
|
|
|
ctx.Data["IsAdmin"] = ctx.User.IsAdmin
|
2014-11-07 11:06:41 +08:00
|
|
|
} else {
|
2015-08-19 23:14:57 +08:00
|
|
|
ctx.Data["SignedUserID"] = 0
|
2014-11-07 11:06:41 +08:00
|
|
|
ctx.Data["SignedUserName"] = ""
|
2014-03-15 20:50:17 +08:00
|
|
|
}
|
2014-03-15 19:01:50 +08:00
|
|
|
|
2014-07-24 21:19:59 +08:00
|
|
|
// If request sends files, parse them here otherwise the Query() can't be parsed and the CsrfToken will be invalid.
|
2014-07-26 12:24:27 +08: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 21:19:59 +08:00
|
|
|
return
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2014-08-01 05:25:34 +08:00
|
|
|
ctx.Data["CsrfToken"] = x.GetToken()
|
|
|
|
ctx.Data["CsrfTokenHtml"] = template.HTML(`<input type="hidden" name="_csrf" value="` + x.GetToken() + `">`)
|
2015-12-21 20:24:11 +08:00
|
|
|
log.Debug("Session ID: %s", sess.ID())
|
|
|
|
log.Debug("CSRF Token: %v", ctx.Data["CsrfToken"])
|
2014-03-19 21:57:55 +08:00
|
|
|
|
2015-02-07 10:16:23 +08:00
|
|
|
ctx.Data["ShowRegistrationButton"] = setting.Service.ShowRegistrationButton
|
2015-03-23 22:19:19 +08:00
|
|
|
ctx.Data["ShowFooterBranding"] = setting.ShowFooterBranding
|
2015-11-19 05:32:31 +08:00
|
|
|
ctx.Data["ShowFooterVersion"] = setting.ShowFooterVersion
|
2015-02-07 10:16:23 +08:00
|
|
|
|
2014-03-15 19:01:50 +08:00
|
|
|
c.Map(ctx)
|
|
|
|
}
|
|
|
|
}
|