context

Nov 14, 2023

Changes in this version

type Base

+ func (b *Base) WrittenStatus() int

type Context

+ TemplateContext TemplateContext

+ func NewWebContext(base *Base, render Render, session session.Store) *Context

+ func (ctx *Context) JSONError(msg string)

+ func (ctx *Context) JSONOK()

+ func (ctx *Context) JSONRedirect(redirect string)

type Organization

+ PublicMemberOnly bool

type Response

+ func (r *Response) WrittenStatus() int

+ type TemplateContext map[string]any

+ func NewTemplateContext(ctx context.Context) TemplateContext

+ func NewTemplateContextForWeb(ctx *Context) TemplateContext

+ func (c TemplateContext) DataRaceCheck(dataCtx context.Context) (string, error)

+ func (c TemplateContext) Deadline() (deadline time.Time, ok bool)

+ func (c TemplateContext) Done() <-chan struct{}

+ func (c TemplateContext) Err() error

+ func (c TemplateContext) Value(key any) any

Aug 20, 2023

Changes in this version

type Base

+ func (b *Base) PathParamRaw(p string) string

Jul 16, 2023

Changes in this version

+ const CookieNameFlash

+ var WebContextKey = webContextKeyType

type APIContext

+ Cache cache.Cache

+ ContextUser *user_model.User

+ Doer *user_model.User

+ IsBasicAuth bool

+ IsSigned bool

+ Package *Package

+ Repo *Repository

+ func (ctx *APIContext) GetErrMsg() string

+ func (ctx *APIContext) HasAPIError() bool

+ func (ctx *APIContext) IsUserRepoAdmin() bool

+ func (ctx *APIContext) IsUserRepoWriter(unitTypes []unit.Type) bool

+ func (ctx *APIContext) IsUserSiteAdmin() bool

+ func (ctx *APIContext) NotFoundOrServerError(logMsg string, errCheck func(error) bool, logErr error)

+ type Base struct

+ Data middleware.ContextData

+ Locale translation.Locale

+ Req *http.Request

+ Resp ResponseWriter

+ func NewBaseContext(resp http.ResponseWriter, req *http.Request) (b *Base, closeFunc func())

+ func (b *Base) AppendAccessControlExposeHeaders(names ...string)

+ func (b *Base) AppendContextValue(key, value any) any

+ func (b *Base) AppendContextValueFunc(key any, valueFn func() any) any

+ func (b *Base) Deadline() (deadline time.Time, ok bool)

+ func (b *Base) Done() <-chan struct{}

+ func (b *Base) Err() error

+ func (b *Base) Error(status int, contents ...string)

+ func (b *Base) FormBool(key string) bool

+ func (b *Base) FormInt(key string) int

+ func (b *Base) FormInt64(key string) int64

+ func (b *Base) FormOptionalBool(key string) util.OptionalBool

+ func (b *Base) FormString(key string) string

+ func (b *Base) FormStrings(key string) []string

+ func (b *Base) FormTrim(key string) string

+ func (b *Base) GetData() middleware.ContextData

+ func (b *Base) JSON(status int, content any)

+ func (b *Base) Params(p string) string

+ func (b *Base) ParamsInt64(p string) int64

+ func (b *Base) PlainText(status int, text string)

+ func (b *Base) PlainTextBytes(status int, bs []byte)

+ func (b *Base) Redirect(location string, status ...int)

+ func (b *Base) RemoteAddr() string

+ func (b *Base) RespHeader() http.Header

+ func (b *Base) ServeContent(r io.ReadSeeker, opts *ServeHeaderOptions)

+ func (b *Base) SetFormString(key, value string)

+ func (b *Base) SetParams(k, v string)

+ func (b *Base) SetServeHeaders(opt *ServeHeaderOptions)

+ func (b *Base) SetTotalCountHeader(total int64)

+ func (b *Base) Status(status int)

+ func (b *Base) Tr(msg string, args ...any) string

+ func (b *Base) TrN(cnt any, key1, keyN string, args ...any) string

+ func (b *Base) Value(key any) any

+ func (b *Base) Write(bs []byte) (int, error)

+ func (b *Base) Written() bool

type CSRFProtector

+ DeleteCookie func(ctx *Context)

type Context

+ Csrf CSRFProtector

+ func GetWebContext(req *http.Request) *Context

+ func (ctx *Context) DeleteSiteCookie(name string)

+ func (ctx *Context) GetSiteCookie(name string) string

+ func (ctx *Context) SetSiteCookie(name, value string, maxAge int)

type PrivateContext

+ Repo *Repository

type Response

+ func WrapResponseWriter(resp http.ResponseWriter) *Response

+ type ValidateContext struct

+ func GetValidateContext(req *http.Request) (ctx *ValidateContext)

Apr 27, 2023

Changes in this version

+ func CheckRepoScopedToken(ctx *Context, repo *repo_model.Repository)

Mar 20, 2023

Changes in this version

+ func GetOrganizationByParams(ctx *Context)

type Organization

+ func (org *Organization) CanReadUnit(ctx *Context, unitType unit.Type) bool

+ func (org *Organization) CanWriteUnit(ctx *Context, unitType unit.Type) bool

Dec 21, 2022

Changes in this version

+ func SetCaptchaData(ctx *Context)

+ func VerifyCaptcha(ctx *Context, tpl base.TplName, form interface{})

type Context

+ func (ctx *Context) IssueTemplatesErrorsFromDefaultBranch() ([]*api.IssueTemplate, map[string]error)

+ type ServeHeaderOptions struct

+ CacheDuration time.Duration

+ ContentLength *int64

+ ContentType string

+ ContentTypeCharset string

+ Disposition string

+ Filename string

+ LastModified time.Time

Jul 30, 2022

Changes in this version

+ const CsrfTokenTimeout

+ var CsrfTokenRegenerationInterval = 10 * time.Minute

+ var SearchOrderByMap = map[string]map[string]db.SearchOrderBy

+ func CanEnableEditor() func(ctx *Context)

+ func GenerateCsrfToken(key, userID, actionID string, now time.Time) string

+ func GetQueryBeforeSince(ctx *Context) (before, since int64, err error)

+ func OverrideContext(ctx *PrivateContext) (cancel context.CancelFunc)

+ func PackageAssignment() func(ctx *Context)

+ func PackageAssignmentAPI() func(ctx *APIContext)

+ func PackageContexter() func(next http.Handler) http.Handler

+ func ParseCsrfToken(token string) (issueTime time.Time, ok bool)

+ func ValidCsrfToken(token, key, userID, actionID string, now time.Time) bool

+ type CSRFProtector interface

+ GetFormName func() string

+ GetHeaderName func() string

+ GetToken func() string

+ Validate func(ctx *Context)

+ func PrepareCSRFProtector(opt CsrfOptions, ctx *Context) CSRFProtector

type Context

+ ContextUser *user_model.User

+ Doer *user_model.User

+ Package *Package

+ func (ctx *Context) AppendAccessControlExposeHeaders(names ...string)

+ func (ctx *Context) SetServeHeaders(filename string)

+ func (ctx *Context) SetTotalCountHeader(total int64)

+ func (ctx *Context) UploadStream() (rd io.ReadCloser, needToClose bool, err error)

+ type Package struct

+ AccessMode perm.AccessMode

+ Descriptor *packages_model.PackageDescriptor

+ Owner *user_model.User

type PrivateContext

+ Override context.Context

+ func (ctx *PrivateContext) Deadline() (deadline time.Time, ok bool)

+ func (ctx *PrivateContext) Done() <-chan struct{}

+ func (ctx *PrivateContext) Err() error

type Repository

+ func (r *Repository) CanWriteToBranch(user *user_model.User, branch string) bool

May 16, 2022

Changes in this version

type Context

+ func (ctx *Context) Close() error

Jan 30, 2022

Changes in this version

type APIContext

+ func (ctx *APIContext) AppendAccessControlExposeHeaders(names ...string)

+ func (ctx *APIContext) SetTotalCountHeader(total int64)

type APIInvalidTopicsError

+ InvalidTopics []string

type Context

+ PageData map[string]interface{}

+ func (ctx *Context) FormBool(key string) bool

+ func (ctx *Context) FormInt(key string) int

+ func (ctx *Context) FormInt64(key string) int64

+ func (ctx *Context) FormOptionalBool(key string) util.OptionalBool

+ func (ctx *Context) FormString(key string) string

+ func (ctx *Context) FormStrings(key string) []string

+ func (ctx *Context) FormTrim(key string) string

+ func (ctx *Context) PlainTextBytes(status int, bs []byte)

+ func (ctx *Context) RenderToString(name base.TplName, data map[string]interface{}) (string, error)

+ func (ctx *Context) RespHeader() http.Header

+ func (ctx *Context) TrHTMLEscapeArgs(msg string, args ...string) string

type Organization

+ Teams []*models.Team

type PullRequest

+ HeadInfoSubURL string

Dec 2, 2021

Changes in this version

type Repository

+ RefName string

Oct 8, 2021

Changes in this version

+ func GetContextUser(req *http.Request) *models.User

Aug 22, 2021

Changes in this version

+ func APIAuth(authMethod auth.Auth) func(*APIContext)

+ func Auth(authMethod auth.Auth) func(*Context)

type Context

+ func (ctx *Context) Deadline() (deadline time.Time, ok bool)

+ func (ctx *Context) Done() <-chan struct{}

+ func (ctx *Context) Err() error

+ func (ctx *Context) QueryOptionalBool(key string, defaults ...util.OptionalBool) util.OptionalBool

+ func (ctx *Context) ServeStream(rd io.Reader, name string)

+ func (ctx *Context) Value(key interface{}) interface{}

type Forms

+ func (f *Forms) MustOptionalBool(key string, defaults ...util.OptionalBool) util.OptionalBool

Apr 11, 2021

Changes in this version

+ const Timeout

+ func AccessLogger() func(http.Handler) http.Handler

+ func AesDecrypt(key, text []byte) ([]byte, error)

+ func AesEncrypt(key, text []byte) ([]byte, error)

+ func DecryptSecret(key string, cipherhex string) (string, error)

+ func EncryptSecret(key string, str string) (string, error)

+ func GenerateToken(key, userID, actionID string) string

+ func GetImageCaptcha() *captcha.Captcha

+ func NewSecret() (string, error)

+ func NewSecretWithLength(length int64) (string, error)

+ func PrivateContexter() func(http.Handler) http.Handler

+ func RedirectToUser(ctx *Context, userName string, redirectUserID int64)

+ func SignedUserName(req *http.Request) string

+ func ToggleAPI(options *ToggleOptions) func(ctx *APIContext)

+ func ValidToken(token, key, userID, actionID string) bool

+ func Validate(ctx *Context, x CSRF)

+ func WithAPIContext(req *http.Request, ctx *APIContext) *http.Request

+ func WithContext(req *http.Request, ctx *Context) *http.Request

+ func WithPrivateContext(req *http.Request, ctx *PrivateContext) *http.Request

+ type APIConflict struct

type APIContext

+ func GetAPIContext(req *http.Request) *APIContext

+ func (ctx *APIContext) ServerError(title string, err error)

+ type CSRF interface

+ Error func(w http.ResponseWriter)

+ GetCookieDomain func() string

+ GetCookieHTTPOnly func() bool

+ GetCookieName func() string

+ GetCookiePath func() string

+ GetFormName func() string

+ GetHeaderName func() string

+ GetToken func() string

+ ValidToken func(t string) bool

+ func Csrfer(opt CsrfOptions, ctx *Context) CSRF

type Context

+ Data map[string]interface{}

+ Render Render

+ Req *http.Request

+ Resp ResponseWriter

+ func GetContext(req *http.Request) *Context

+ func (ctx *Context) CookieDecrypt(secret, val string) (string, bool)

+ func (ctx *Context) CookieEncrypt(secret, value string) string

+ func (ctx *Context) DeleteCookie(name string)

+ func (ctx *Context) Error(status int, contents ...string)

+ func (ctx *Context) GetCookie(name string) string

+ func (ctx *Context) GetCookieFloat64(name string) float64

+ func (ctx *Context) GetCookieInt(name string) int

+ func (ctx *Context) GetCookieInt64(name string) int64

+ func (ctx *Context) GetData() map[string]interface{}

+ func (ctx *Context) GetSuperSecureCookie(secret, name string) (string, bool)

+ func (ctx *Context) HTMLString(name string, data interface{}) (string, error)

+ func (ctx *Context) Header() http.Header

+ func (ctx *Context) JSON(status int, content interface{})

+ func (ctx *Context) Params(p string) string

+ func (ctx *Context) ParamsInt64(p string) int64

+ func (ctx *Context) PlainText(status int, bs []byte)

+ func (ctx *Context) Query(key string, defaults ...string) string

+ func (ctx *Context) QueryBool(key string, defaults ...bool) bool

+ func (ctx *Context) QueryInt(key string, defaults ...int) int

+ func (ctx *Context) QueryInt64(key string, defaults ...int64) int64

+ func (ctx *Context) QueryStrings(key string, defaults ...[]string) []string

+ func (ctx *Context) QueryTrim(key string, defaults ...string) string

+ func (ctx *Context) Redirect(location string, status ...int)

+ func (ctx *Context) RemoteAddr() string

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

+ func (ctx *Context) SetCookie(name, value string, expiry int)

+ func (ctx *Context) SetParams(k, v string)

+ func (ctx *Context) SetSuperSecureCookie(secret, name, value string, expiry int)

+ func (ctx *Context) Status(status int)

+ func (ctx *Context) Write(bs []byte) (int, error)

+ func (ctx *Context) Written() bool

+ type CsrfOptions struct

+ Cookie string

+ CookieDomain string

+ CookieHTTPOnly bool

+ CookieLifeTime int

+ CookiePath string

+ ErrorFunc func(w http.ResponseWriter)

+ Form string

+ Header string

+ Origin bool

+ SameSite http.SameSite

+ Secret string

+ Secure bool

+ SessionKey string

+ SetCookie bool

+ SetHeader bool

+ type Forms http.Request

+ func (f *Forms) Bool(key string) (bool, error)

+ func (f *Forms) Escape(key string) (string, error)

+ func (f *Forms) Float32(key string) (float32, error)

+ func (f *Forms) Float64(key string) (float64, error)

+ func (f *Forms) Int(key string) (int, error)

+ func (f *Forms) Int32(key string) (int32, error)

+ func (f *Forms) Int64(key string) (int64, error)

+ func (f *Forms) MustBool(key string, defaults ...bool) bool

+ func (f *Forms) MustEscape(key string, defaults ...string) string

+ func (f *Forms) MustFloat32(key string, defaults ...float32) float32

+ func (f *Forms) MustFloat64(key string, defaults ...float64) float64

+ func (f *Forms) MustInt(key string, defaults ...int) int

+ func (f *Forms) MustInt32(key string, defaults ...int32) int32

+ func (f *Forms) MustInt64(key string, defaults ...int64) int64

+ func (f *Forms) MustString(key string, defaults ...string) string

+ func (f *Forms) MustStrings(key string, defaults ...[]string) []string

+ func (f *Forms) MustTrimmed(key string, defaults ...string) string

+ func (f *Forms) MustUint(key string, defaults ...uint) uint

+ func (f *Forms) MustUint32(key string, defaults ...uint32) uint32

+ func (f *Forms) MustUint64(key string, defaults ...uint64) uint64

+ func (f *Forms) String(key string) (string, error)

+ func (f *Forms) Strings(key string) ([]string, error)

+ func (f *Forms) Trimmed(key string) (string, error)

+ func (f *Forms) Uint(key string) (uint, error)

+ func (f *Forms) Uint32(key string) (uint32, error)

+ func (f *Forms) Uint64(key string) (uint64, error)

+ func (f *Forms) Values() url.Values

+ type Handler func(*Context)

type Pagination

+ func (p *Pagination) AddParamString(key string, value string)

+ type PrivateContext struct

+ func GetPrivateContext(req *http.Request) *PrivateContext

+ type Render interface

+ HTML func(w io.Writer, status int, name string, binding interface{}, ...) error

+ TemplateLookup func(tmpl string) *template.Template

type Repository

+ func (r *Repository) GetCommitGraphsCount(hidePRRefs bool, branches []string, files []string) (int64, error)

+ type Response struct

+ func NewResponse(resp http.ResponseWriter) *Response

+ func (r *Response) Before(f func(ResponseWriter))

+ func (r *Response) Flush()

+ func (r *Response) Size() int

+ func (r *Response) Status() int

+ func (r *Response) Write(bs []byte) (int, error)

+ func (r *Response) WriteHeader(statusCode int)

+ type ResponseWriter interface

+ Before func(func(ResponseWriter))

+ Flush func()

+ Size func() int

+ Status func() int

Dec 2, 2020

Changes in this version

+ var IssueTemplateDirCandidates = []string

+ type APIString string

type Context

+ func (ctx *Context) IssueTemplatesFromDefaultBranch() []api.IssueTemplate

Nov 16, 2020

Changes in this version

+ func RepoRefForAPI() macaron.Handler

Jun 18, 2020

Changes in this version

+ type CanCommitToBranchResults struct

+ CanCommitToBranch bool

+ EditorEnabled bool

+ RequireSigned bool

+ SigningKey string

+ UserCanPush bool

+ WillSign bool

+ WontSignReason string

May 30, 2020

Changes in this version

type APIContext

+ func (ctx *APIContext) InternalServerError(err error)

Feb 10, 2020

Changes in this version

+ func RetrieveTemplateRepo(ctx *Context, repo *models.Repository)

+ type APIInvalidTopicsError struct

+ Message string

+ Topics []string

type Organization

+ CanCreateOrgRepo bool

type RepoRefType

+ func (rt RepoRefType) RefTypeIncludesBranches() bool

+ func (rt RepoRefType) RefTypeIncludesTags() bool

Jul 31, 2019

Changes in this version

type APIContext

+ func (ctx *APIContext) NotFound(objs ...interface{})

type Context

+ func (ctx *Context) IsUserRepoAdmin() bool

+ func (ctx *Context) IsUserRepoOwner() bool

+ func (ctx *Context) IsUserRepoReaderAny() bool

+ func (ctx *Context) IsUserRepoReaderSpecific(unitType models.UnitType) bool

+ func (ctx *Context) IsUserRepoWriter(unitTypes []models.UnitType) bool

+ func (ctx *Context) IsUserSiteAdmin() bool

+ type Pagination struct

+ Paginater *paginater.Paginater

+ func NewPagination(total int, page int, issueNum int, numPages int) *Pagination

+ func (p *Pagination) AddParam(ctx *Context, paramKey string, ctxKey string)

+ func (p *Pagination) GetParams() template.URL

+ func (p *Pagination) SetDefaultParams(ctx *Context)

type Repository

+ func (r *Repository) FileExists(path string, branch string) (bool, error)

Apr 20, 2019

Changes in this version

+ func Recovery() macaron.Handler

+ func RepoMustNotBeArchived() macaron.Handler

type APIContext

+ func (ctx *APIContext) CheckForOTP()

Jan 22, 2019

Changes in this version

+ func RequireRepoReader(unitType models.UnitType) macaron.Handler

+ func RequireRepoReaderOr(unitTypes ...models.UnitType) macaron.Handler

+ func RequireRepoWriterOr(unitTypes ...models.UnitType) macaron.Handler

type RepoRefType

+ const RepoRefBlob

Nov 23, 2018

Changes in this version

type APIContext

+ func (ctx *APIContext) RequireCSRF()

type Repository

+ func (r *Repository) CanCreateIssueDependencies(user *models.User) bool

Mar 25, 2018

Changes in this version

type Context

+ EscapedLink string

+ func (ctx *Context) NotFound(title string, err error)

+ func (ctx *Context) RedirectToFirst(location ...string)

+ func (ctx *Context) ServerError(title string, err error)

Nov 29, 2017

Changes in this version

+ func RepoRefByType(refType RepoRefType) macaron.Handler

+ type RepoRefType int

+ const RepoRefAny

+ const RepoRefBranch

+ const RepoRefCommit

+ const RepoRefLegacy

+ const RepoRefTag

type Repository

+ func (r *Repository) BranchNameSubURL() string

+ func (r *Repository) CanCreateBranch() bool

+ func (r *Repository) CanUseTimetracker(issue *models.Issue, user *models.User) bool

+ func (r *Repository) GetCommitsCount() (int64, error)

Oct 16, 2017

Changes in this version

+ func CheckAnyUnit(unitTypes ...models.UnitType) macaron.Handler

Oct 12, 2017

Changes in this version

+ func CheckUnit(unitType models.UnitType) macaron.Handler

+ func ComposeGoGetImport(owner, repo string) string

+ func EarlyResponseForGoGetMeta(ctx *Context)

+ func LoadRepoUnits() macaron.Handler

+ func RepoIDAssignment() macaron.Handler

+ type APIEmpty struct

+ type APIError struct

+ Message string

+ URL string

+ type APIForbiddenError struct

+ type APINotFound struct

+ type APIRedirect struct

+ type APIValidationError struct

+ Message string

+ URL string

type Context

+ Link string

type Repository

+ func (r *Repository) CanCommitToBranch() (bool, error)

Mar 9, 2017

Changes in this version

+ func RedirectToRepo(ctx *Context, redirectRepoID int64)

+ func UnitTypes() macaron.Handler

Dec 23, 2016

Changes in this version

+ func ExtractOwnerAndRepo() macaron.Handler

+ func ReferencesGitRepo() macaron.Handler

type Context

+ func (ctx *Context) HasAPIError() bool

Oct 17, 2016

Changes in this version

+ 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(args ...bool) macaron.Handler

+ func RepoRef() macaron.Handler

+ func RequireRepoAdmin() macaron.Handler

+ func RequireRepoWriter() macaron.Handler

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

+ func Toggle(options *ToggleOptions) macaron.Handler

+ type APIContext struct

+ Org *APIOrganization

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

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

+ type APIOrganization struct

+ Organization *models.User

+ Team *models.Team

+ type Context struct

+ Cache cache.Cache

+ Flash *session.Flash

+ IsBasicAuth bool

+ IsSigned bool

+ Org *Organization

+ Repo *Repository

+ Session session.Store

+ User *models.User

+ 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) NotFoundOrServerError(title string, errck func(error) bool, err error)

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

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

+ type Organization struct

+ IsMember bool

+ IsOwner bool

+ IsTeamAdmin bool

+ IsTeamMember bool

+ OrgLink string

+ Organization *models.User

+ Team *models.Team

+ type PullRequest struct

+ Allowed bool

+ BaseRepo *models.Repository

+ HeadInfo string

+ SameRepo bool

+ type Repository struct

+ AccessMode models.AccessMode

+ BranchName string

+ CloneLink models.CloneLink

+ Commit *git.Commit

+ CommitID string

+ CommitsCount int64

+ GitRepo *git.Repository

+ IsViewBranch bool

+ IsViewCommit bool

+ IsViewTag bool

+ IsWatching bool

+ Mirror *models.Mirror

+ Owner *models.User

+ PullRequest *PullRequest

+ RepoLink string

+ Repository *models.Repository

+ Tag *git.Tag

+ TagName string

+ TreePath string

+ 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

+ type ToggleOptions struct

+ AdminRequired bool

+ DisableCSRF bool

+ SignInRequired bool

+ SignOutRequired bool