middleware

Documentation

Index

• func ApiRepoAssignment() macaron.Handler
• func ApiReqBasicAuth() macaron.Handler
• func ApiReqToken() macaron.Handler
• func AutoSignIn(ctx *Context) (bool, error)
• func Contexter() macaron.Handler
• func GitHookService() macaron.Handler
• func OrgAssignment(redirect bool, args ...bool) macaron.Handler
• func RepoAssignment(redirect bool, args ...bool) macaron.Handler
• func RepoRef() macaron.Handler
• func RequireRepoAdmin() macaron.Handler
• func RetrieveBaseRepo(ctx *Context, repo *models.Repository)
• func Toggle(options *ToggleOptions) macaron.Handler
• type Context
  • func (ctx *Context) APIError(status int, title string, obj interface{})
  • func (ctx *Context) GetErrMsg() string
  • func (ctx *Context) HTML(status int, name base.TplName)
  • func (ctx *Context) Handle(status int, title string, err error)
  • func (ctx *Context) HandleText(status int, title string)
  • func (ctx *Context) HasApiError() bool
  • func (ctx *Context) HasError() bool
  • func (ctx *Context) HasValue(name string) bool
  • func (ctx *Context) RenderWithErr(msg string, tpl base.TplName, form interface{})
  • func (ctx *Context) ServeContent(name string, r io.ReadSeeker, params ...interface{})
• type RepoContext
  • func (r RepoContext) HasAccess() bool
  • func (r RepoContext) IsAdmin() bool
  • func (r RepoContext) IsOwner() bool
• type ToggleOptions

Functions

func ApiRepoAssignment

func ApiRepoAssignment() macaron.Handler

func ApiReqBasicAuth

func ApiReqBasicAuth() macaron.Handler

func ApiReqToken

func ApiReqToken() macaron.Handler

Contexter middleware already checks token for user sign in process.

func AutoSignIn

func AutoSignIn(ctx *Context) (bool, error)

AutoSignIn reads cookie and try to auto-login.

func Contexter

func Contexter() macaron.Handler

Contexter initializes a classic context for a request.

func GitHookService

func GitHookService() macaron.Handler

GitHookService checks if repository Git hooks service has been enabled.

func OrgAssignment

func OrgAssignment(redirect bool, args ...bool) macaron.Handler

func RepoAssignment

func RepoAssignment(redirect bool, args ...bool) macaron.Handler

func RepoRef

func RepoRef() macaron.Handler

RepoRef handles repository reference name including those contain `/`.

func RequireRepoAdmin

func RequireRepoAdmin() macaron.Handler

func RetrieveBaseRepo

func RetrieveBaseRepo(ctx *Context, repo *models.Repository)

func Toggle

func Toggle(options *ToggleOptions) macaron.Handler

Types

type Context

type Context struct {
	*macaron.Context
	Cache cache.Cache

	Flash   *session.Flash
	Session session.Store

	User        *models.User
	IsSigned    bool
	IsBasicAuth bool

	Repo RepoContext

	Org struct {
		IsOwner      bool
		IsMember     bool
		IsAdminTeam  bool // In owner team or team that has admin permission level.
		Organization *models.User
		OrgLink      string

		Team *models.Team
	}
	// contains filtered or unexported fields
}

Context represents context of a request.

func (*Context) APIError

func (ctx *Context) APIError(status int, title string, obj interface{})

APIError logs error with title if status is 500.

func (*Context) GetErrMsg

func (ctx *Context) GetErrMsg() string

func (*Context) HTML

func (ctx *Context) HTML(status int, name base.TplName)

HTML calls Context.HTML and converts template name to string.

func (*Context) Handle

func (ctx *Context) Handle(status int, title string, err error)

Handle handles and logs error by given status.

func (*Context) HandleText

func (ctx *Context) HandleText(status int, title string)

func (*Context) HasApiError

func (ctx *Context) HasApiError() bool

HasError returns true if error occurs in form validation.

func (*Context) HasError

func (ctx *Context) HasError() bool

HasError returns true if error occurs in form validation.

func (*Context) HasValue

func (ctx *Context) HasValue(name string) bool

HasValue returns true if value of given name exists.

func (*Context) RenderWithErr

func (ctx *Context) RenderWithErr(msg string, tpl base.TplName, form interface{})

RenderWithErr used for page has form validation but need to prompt error to users.

func (*Context) ServeContent

func (ctx *Context) ServeContent(name string, r io.ReadSeeker, params ...interface{})

type RepoContext

type RepoContext struct {
	AccessMode   models.AccessMode
	IsWatching   bool
	IsBranch     bool
	IsTag        bool
	IsCommit     bool
	Repository   *models.Repository
	Owner        *models.User
	Commit       *git.Commit
	Tag          *git.Tag
	GitRepo      *git.Repository
	BranchName   string
	TagName      string
	TreeName     string
	CommitID     string
	RepoLink     string
	CloneLink    models.CloneLink
	CommitsCount int
	Mirror       *models.Mirror
}

func (RepoContext) HasAccess

func (r RepoContext) HasAccess() bool

Return if the current user has read access for this repository

func (RepoContext) IsAdmin

func (r RepoContext) IsAdmin() bool

IsAdmin returns true if current user has admin or higher access of repository.

func (RepoContext) IsOwner

func (r RepoContext) IsOwner() bool

IsOwner returns true if current user is the owner of repository.

type ToggleOptions

type ToggleOptions struct {
	SignInRequire  bool
	SignOutRequire bool
	AdminRequire   bool
	DisableCsrf    bool
}