context

Documentation

Index

• Constants
• func APIContexter() macaron.Handler
• func Contexter() macaron.Handler
• func GitHookService() macaron.Handler
• func HandleOrgAssignment(ctx *Context, args ...bool)
• func OrgAssignment(args ...bool) macaron.Handler
• func RepoAssignment(pages ...bool) macaron.Handler
• func RepoRef() macaron.Handler
• func RequireRepoAdmin() macaron.Handler
• func RequireRepoWriter() macaron.Handler
• func Toggle(options *ToggleOptions) macaron.Handler
• type APIContext
  • func (ctx *APIContext) Error(status int, title string, obj interface{})
  • func (ctx *APIContext) SetLinkHeader(total, pageSize int)
• type APIOrganization
• type Context
  • func (ctx *Context) GetErrMsg() string
  • func (ctx *Context) HTML(status int, name string)
  • 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) NotFound()
  • func (c *Context) NotFoundOrServerError(title string, errck func(error) bool, err error)
  • func (ctx *Context) RenderWithErr(msg, tpl string, f interface{})
  • func (ctx *Context) ServeContent(name string, r io.ReadSeeker, params ...interface{})
  • func (c *Context) ServerError(title string, err error)
  • func (c *Context) Success(name string)
  • func (ctx *Context) UserID() int64
• type Organization
• type PullRequest
• type Repository
  • func (r *Repository) CanEnableEditor() bool
  • func (r *Repository) GetEditorconfig() (*editorconfig.Editorconfig, error)
  • func (r *Repository) HasAccess() bool
  • func (r *Repository) IsAdmin() bool
  • func (r *Repository) IsOwner() bool
  • func (r *Repository) IsWriter() bool
  • func (r *Repository) PullRequestURL(baseBranch, headBranch string) string
• type ToggleOptions

Constants

const DOC_URL = "https://github.com/gogits/go-gogs-client/wiki"

FIXME: move to github.com/gogits/go-gogs-client

Functions

func APIContexter

func APIContexter() macaron.Handler

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 HandleOrgAssignment

func HandleOrgAssignment(ctx *Context, args ...bool)

func OrgAssignment

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

func RepoAssignment

func RepoAssignment(pages ...bool) macaron.Handler

[0]: issues, [1]: wiki

func RepoRef

func RepoRef() macaron.Handler

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

func RequireRepoAdmin

func RequireRepoAdmin() macaron.Handler

func RequireRepoWriter

func RequireRepoWriter() macaron.Handler

func Toggle

func Toggle(options *ToggleOptions) macaron.Handler

Types

type APIContext

type APIContext struct {
	*Context
	Org *APIOrganization
}

func (*APIContext) Error

func (ctx *APIContext) Error(status int, title string, obj interface{})

Error responses error message to client with given message. If status is 500, also it prints error to log.

func (*APIContext) SetLinkHeader

func (ctx *APIContext) SetLinkHeader(total, pageSize int)

SetLinkHeader sets pagination link header by given totol number and page size.

type APIOrganization

type APIOrganization struct {
	Organization *models.User
	Team         *models.Team
}

type Context

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

	Flash   *session.Flash
	Session session.Store

	User        *models.User
	IsSigned    bool
	IsBasicAuth bool

	Repo *Repository
	Org  *Organization
	// 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 string)

HTML responses template with given status.

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

func (ctx *Context) NotFound()

NotFound renders the 404 page.

func (*Context) NotFoundOrServerError

func (c *Context) NotFoundOrServerError(title string, errck func(error) bool, err error)

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 (*Context) RenderWithErr

func (ctx *Context) RenderWithErr(msg, tpl string, f 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) ServerError

func (c *Context) ServerError(title string, err error)

ServerError renders the 500 page.

func (*Context) Success

func (c *Context) Success(name string)

Success responses template with status http.StatusOK.

func (*Context) UserID

func (ctx *Context) UserID() int64

type Organization

type Organization struct {
	IsOwner      bool
	IsMember     bool
	IsTeamMember bool // Is member of team.
	IsTeamAdmin  bool // In owner team or team that has admin permission level.
	Organization *models.User
	OrgLink      string

	Team *models.Team
}

type PullRequest

type PullRequest struct {
	BaseRepo *models.Repository
	Allowed  bool
	SameRepo bool
	HeadInfo string // [<user>:]<branch>
}

type Repository

type Repository struct {
	AccessMode   models.AccessMode
	IsWatching   bool
	IsViewBranch bool
	IsViewTag    bool
	IsViewCommit bool
	Repository   *models.Repository
	Owner        *models.User
	Commit       *git.Commit
	Tag          *git.Tag
	GitRepo      *git.Repository
	BranchName   string
	TagName      string
	TreePath     string
	CommitID     string
	RepoLink     string
	CloneLink    models.CloneLink
	CommitsCount int64
	Mirror       *models.Mirror

	PullRequest *PullRequest
}

func (*Repository) CanEnableEditor

func (r *Repository) CanEnableEditor() bool

CanEnableEditor returns true if repository is editable and user has proper access level.

func (*Repository) GetEditorconfig

func (r *Repository) GetEditorconfig() (*editorconfig.Editorconfig, error)

GetEditorconfig returns the .editorconfig definition if found in the HEAD of the default repo branch.

func (*Repository) HasAccess

func (r *Repository) HasAccess() bool

HasAccess returns true if the current user has at least read access for this repository

func (*Repository) IsAdmin

func (r *Repository) IsAdmin() bool

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

func (*Repository) IsOwner

func (r *Repository) IsOwner() bool

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

func (*Repository) IsWriter

func (r *Repository) IsWriter() bool

IsWriter returns true if current user has write or higher access of repository.

func (*Repository) PullRequestURL

func (r *Repository) PullRequestURL(baseBranch, headBranch string) string

PullRequestURL returns URL for composing a pull request. This function does not check if the repository can actually compose a pull request.

type ToggleOptions

type ToggleOptions struct {
	SignInRequired  bool
	SignOutRequired bool
	AdminRequired   bool
	DisableCSRF     bool
}