middleware

Documentation

Index

• func Contexter() macaron.Handler
• func OrgAssignment(redirect bool, args ...bool) macaron.Handler
• func RepoAssignment(redirect bool, args ...bool) macaron.Handler
• func RequireTrueOwner() macaron.Handler
• func Toggle(options *ToggleOptions) macaron.Handler
• type Context
  • 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) HasApiError() bool
  • func (ctx *Context) HasError() bool
  • func (ctx *Context) Query(name string) string
  • func (ctx *Context) RenderWithErr(msg string, tpl base.TplName, form interface{})
  • func (ctx *Context) ServeContent(name string, r io.ReadSeeker, params ...interface{})
  • func (ctx *Context) ServeFile(file string, names ...string)
• type ToggleOptions

Functions

func Contexter

func Contexter() macaron.Handler

Contexter initializes a classic context for a request.

func OrgAssignment

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

func RepoAssignment

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

func RequireTrueOwner

func RequireTrueOwner() macaron.Handler

func Toggle

func Toggle(options *ToggleOptions) macaron.Handler

Types

type Context

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

	Flash   *session.Flash
	Session session.Store

	User     *models.User
	IsSigned bool

	Repo struct {
		IsOwner     bool
		IsTrueOwner bool
		IsWatching  bool
		IsBranch    bool
		IsTag       bool
		IsCommit    bool
		IsAdmin     bool // Current user is admin level.
		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 {
			SSH   string
			HTTPS string
			Git   string
		}
		CommitsCount int
		Mirror       *models.Mirror
	}

	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) 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) 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) Query

func (ctx *Context) Query(name string) string

Query querys form parameter.

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{})

func (*Context) ServeFile

func (ctx *Context) ServeFile(file string, names ...string)

type ToggleOptions

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