router

Apr 24, 2024

Changes in this version

type APIBuilder

+ func (api *APIBuilder) MiddlewareExists(handlerNameOrFunc any) bool

type Party

+ MiddlewareExists func(handlerNameOrFunc any) bool

Jan 10, 2024

Changes in this version

type APIBuilder

+ func (api *APIBuilder) HandleServer(path string, server ServerHandler)

type Party

+ HandleServer func(path string, server ServerHandler)

+ type ServerHandler interface

+ ServeHTTPC func(*context.Context)

Aug 12, 2023

Changes in this version

type RequestHandler

+ func NewDynamicHandler(config context.ConfigurationReadOnly, logger *golog.Logger) RequestHandler

+ type RouteAdder interface

+ AddRoute func(*Route) error

Jul 17, 2023

Changes in this version

type APIContainer

+ func (api *APIContainer) EnableStructDependents() *APIContainer

Mar 11, 2023

Changes in this version

+ var DefaultDirOptions = DirOptions

+ var DirListRichTemplate = template.Must(...(...))

+ func DirList(ctx *context.Context, dirOptions DirOptions, dirName string, dir http.File) error

+ func FormatBytes(b int64) string

+ func IsHidden(file os.FileInfo) bool

+ func NewSubdomainPartyRedirectHandler(to Party) context.Handler

+ func NewSubdomainRedirectHandler(toSubdomain string) context.Handler

+ func RedirectAbsolute(w http.ResponseWriter, r *http.Request, url string, code int)

+ func RegisterMethods(newCustomHTTPVerbs ...string)

+ func TraceTitleColorCode(method string) int

type APIBuilder

+ func (api *APIBuilder) ConfigureContainer(builder ...func(*APIContainer)) *APIContainer

+ func (api *APIBuilder) CountHandlers() int

+ func (api *APIBuilder) EnsureStaticBindings() Party

+ func (api *APIBuilder) FallbackView(provider context.FallbackViewProvider)

+ func (api *APIBuilder) GetDefaultErrorMiddleware() context.Handlers

+ func (api *APIBuilder) GetRouterFilters() map[Party]*Filter

+ func (api *APIBuilder) HandleFunc(method, relativePath string, handlersFn ...interface{}) *Route

+ func (api *APIBuilder) IsRoot() bool

+ func (api *APIBuilder) Logger() *golog.Logger

+ func (api *APIBuilder) Match(ctx *context.Context) bool

+ func (api *APIBuilder) PartyConfigure(relativePath string, partyReg ...PartyConfigurator) Party

+ func (api *APIBuilder) Properties() context.Map

+ func (api *APIBuilder) RegisterDependency(dependencies ...interface{})

+ func (api *APIBuilder) RegisterView(viewEngine context.ViewEngine)

+ func (api *APIBuilder) RemoveHandler(namesOrHandlers ...interface{}) Party

+ func (api *APIBuilder) RemoveRoute(routeName string) bool

+ func (api *APIBuilder) ResetRouterFilters() Party

+ func (api *APIBuilder) SetPartyMatcher(matcherFunc PartyMatcherFunc)

+ func (api *APIBuilder) SetRoutesNoLog(disable bool) Party

+ func (api *APIBuilder) UseError(handlers ...context.Handler)

+ func (api *APIBuilder) UseFunc(handlersFn ...interface{})

+ func (api *APIBuilder) UseOnce(handlers ...context.Handler)

+ func (api *APIBuilder) UseRouter(handlers ...context.Handler)

+ type APIContainer struct

+ Container *hero.Container

+ Self Party

+ func (api *APIContainer) Any(relativePath string, handlersFn ...interface{}) (routes []*Route)

+ func (api *APIContainer) Connect(relativePath string, handlersFn ...interface{}) *Route

+ func (api *APIContainer) Delete(relativePath string, handlersFn ...interface{}) *Route

+ func (api *APIContainer) Done(handlersFn ...interface{})

+ func (api *APIContainer) EnableStrictMode(strictMode bool) *APIContainer

+ func (api *APIContainer) Get(relativePath string, handlersFn ...interface{}) *Route

+ func (api *APIContainer) Handle(method, relativePath string, handlersFn ...interface{}) *Route

+ func (api *APIContainer) Handler(handlerFn interface{}, handlerParamsCount int) context.Handler

+ func (api *APIContainer) Head(relativePath string, handlersFn ...interface{}) *Route

+ func (api *APIContainer) OnError(errorHandler func(*context.Context, error))

+ func (api *APIContainer) Options(relativePath string, handlersFn ...interface{}) *Route

+ func (api *APIContainer) Party(relativePath string, handlersFn ...interface{}) *APIContainer

+ func (api *APIContainer) PartyFunc(relativePath string, fn func(*APIContainer)) *APIContainer

+ func (api *APIContainer) Patch(relativePath string, handlersFn ...interface{}) *Route

+ func (api *APIContainer) Post(relativePath string, handlersFn ...interface{}) *Route

+ func (api *APIContainer) Put(relativePath string, handlersFn ...interface{}) *Route

+ func (api *APIContainer) RegisterDependency(dependency interface{}) *hero.Dependency

+ func (api *APIContainer) SetDependencyMatcher(fn hero.DependencyMatcher) *APIContainer

+ func (api *APIContainer) Trace(relativePath string, handlersFn ...interface{}) *Route

+ func (api *APIContainer) Use(handlersFn ...interface{})

+ func (api *APIContainer) UseResultHandler(handler func(next hero.ResultHandler) hero.ResultHandler) *APIContainer

+ type Attachments struct

+ Burst int

+ Enable bool

+ Limit float64

+ NameFunc func(systemName string) (attachmentName string)

+ type DirCacheOptions struct

+ CompressIgnore *regexp.Regexp

+ CompressMinSize int64

+ Enable bool

+ Encodings []string

+ Verbose uint8

+ type DirListFunc func(ctx *context.Context, dirOptions DirOptions, dirName string, dir http.File) error

+ func DirListRich(opts ...DirListRichOptions) DirListFunc

+ type DirListRichOptions struct

+ Tmpl *template.Template

+ TmplName string

type DirOptions

+ Attachments Attachments

+ Cache DirCacheOptions

+ Compress bool

+ PushTargets map[string][]string

+ PushTargetsRegexp map[string]*regexp.Regexp

+ SPA bool

+ ShowHidden bool

+ type Filter struct

+ Handlers context.Handlers

+ Matcher PartyMatcher

+ Path string

+ Skippers map[*APIBuilder]struct{}

+ Subdomain string

+ type HTTPErrorHandler interface

+ FireErrorCode func(ctx *context.Context)

type Party

+ ConfigureContainer func(builder ...func(*APIContainer)) *APIContainer

+ EnsureStaticBindings func() Party

+ FallbackView func(provider context.FallbackViewProvider)

+ HandleFunc func(method, relativePath string, handlersFn ...interface{}) *Route

+ IsRoot func() bool

+ Logger func() *golog.Logger

+ OnAnyErrorCode func(handlers ...context.Handler) []*Route

+ OnErrorCode func(statusCode int, handlers ...context.Handler) []*Route

+ PartyConfigure func(relativePath string, partyReg ...PartyConfigurator) Party

+ Properties func() context.Map

+ RegisterDependency func(dependencies ...interface{})

+ RegisterView func(viewEngine context.ViewEngine)

+ RemoveHandler func(namesOrHandlers ...interface{}) Party

+ RemoveRoute func(routeName string) bool

+ ResetRouterFilters func() Party

+ SetRoutesNoLog func(disable bool) Party

+ UseError func(handlers ...context.Handler)

+ UseFunc func(handlersFn ...interface{})

+ UseOnce func(handlers ...context.Handler)

+ UseRouter func(handlers ...context.Handler)

+ type PartyConfigurator interface

+ Configure func(parent Party)

+ type PartyMatcher interface

+ Match func(ctx *context.Context) bool

+ type PartyMatcherFunc func(*context.Context, Party) bool

type Route

+ Description string

+ MainHandlerIndex int

+ NoLog bool

+ NoSitemap bool

+ OnBuild func(r *Route)

+ Party Party

+ ReadOnly context.RouteReadOnly

+ RegisterFileName string

+ RegisterLineNumber int

+ StatusCode int

+ Title string

+ func (r *Route) Describe(description string) *Route

+ func (r *Route) ExcludeSitemap() *Route

+ func (r *Route) GetTitle() string

+ func (r *Route) RemoveHandler(namesOrHandlers ...interface{}) (count int)

+ func (r *Route) SetName(newRouteName string) *Route

+ func (r *Route) SetSourceLine(fileName string, lineNumber int) *Route

+ func (r *Route) UseOnce(handlers ...context.Handler)

type RouteRegisterRule

+ const RouteOverlap

type Router

+ func (router *Router) AddRouterWrapper(wrapperFunc WrapperFunc)

+ func (router *Router) PrependRouterWrapper(wrapperFunc WrapperFunc)

+ func (router *Router) SetTimeoutHandler(timeout time.Duration, msg string)

type RoutesProvider

+ GetDefaultErrorMiddleware func() context.Handlers

+ GetRouterFilters func() map[Party]*Filter

Feb 25, 2022 GO-2022-0272

  GO-2022-0272: Directory traversal in github.com/kataras/iris and github.com/kataras/iris/v12

Feb 18, 2022 GO-2022-0272

  GO-2022-0272: Directory traversal in github.com/kataras/iris and github.com/kataras/iris/v12

Dec 2, 2021 GO-2022-0272

  GO-2022-0272: Directory traversal in github.com/kataras/iris and github.com/kataras/iris/v12

Oct 13, 2021 GO-2022-0272

  GO-2022-0272: Directory traversal in github.com/kataras/iris and github.com/kataras/iris/v12

Sep 22, 2021 GO-2022-0272

  GO-2022-0272: Directory traversal in github.com/kataras/iris and github.com/kataras/iris/v12

Jan 10, 2021 GO-2022-0272

  GO-2022-0272: Directory traversal in github.com/kataras/iris and github.com/kataras/iris/v12

Sep 13, 2020 GO-2022-0272

  GO-2022-0272: Directory traversal in github.com/kataras/iris and github.com/kataras/iris/v12

Feb 16, 2020

retracted

GO-2022-0272

  GO-2022-0272: Directory traversal in github.com/kataras/iris and github.com/kataras/iris/v12

Feb 10, 2020

retracted

GO-2022-0272

  GO-2022-0272: Directory traversal in github.com/kataras/iris and github.com/kataras/iris/v12

Changes in this version

type APIBuilder

+ func (api *APIBuilder) SetRegisterRule(rule RouteRegisterRule) Party

type Party

+ SetRegisterRule func(rule RouteRegisterRule) Party

+ type RouteRegisterRule uint8

+ const RouteError

+ const RouteOverride

+ const RouteSkip

Feb 5, 2020

retracted

GO-2022-0272

  GO-2022-0272: Directory traversal in github.com/kataras/iris and github.com/kataras/iris/v12

Feb 2, 2020

retracted

GO-2022-0272

  GO-2022-0272: Directory traversal in github.com/kataras/iris and github.com/kataras/iris/v12

Dec 29, 2019

retracted

GO-2022-0272

  GO-2022-0272: Directory traversal in github.com/kataras/iris and github.com/kataras/iris/v12

Dec 25, 2019

retracted

GO-2022-0272

  GO-2022-0272: Directory traversal in github.com/kataras/iris and github.com/kataras/iris/v12

Dec 19, 2019

retracted

GO-2022-0272

  GO-2022-0272: Directory traversal in github.com/kataras/iris and github.com/kataras/iris/v12

Dec 16, 2019

retracted

GO-2022-0272

  GO-2022-0272: Directory traversal in github.com/kataras/iris and github.com/kataras/iris/v12

Changes in this version

type Route

+ func (r *Route) IsStatic() bool

type Router

+ func (router *Router) FindClosestPaths(subdomain, searchPath string, n int) []string

Dec 13, 2019

retracted

GO-2022-0272

  GO-2022-0272: Directory traversal in github.com/kataras/iris and github.com/kataras/iris/v12

Changes in this version

+ var ErrNotRouteAdder = errors.New("request handler does not implement AddRoute method")

type APIBuilder

+ func (api *APIBuilder) CreateRoutes(methods []string, relativePath string, handlers ...context.Handler) []*Route

type Party

+ CreateRoutes func(methods []string, relativePath string, handlers ...context.Handler) []*Route

type Route

+ ChangeFreq string

+ LastMod time.Time

+ Priority float32

+ func (r *Route) SetChangeFreq(freq string) *Route

+ func (r *Route) SetLastMod(t time.Time) *Route

+ func (r *Route) SetPriority(prio float32) *Route

type Router

+ func (router *Router) AddRouteUnsafe(r *Route) error

Oct 26, 2019

retracted

GO-2022-0272

  GO-2022-0272: Directory traversal in github.com/kataras/iris and github.com/kataras/iris/v12

Oct 24, 2019

retracted

GO-2022-0272

  GO-2022-0272: Directory traversal in github.com/kataras/iris and github.com/kataras/iris/v12

Changes in this version

+ const MethodNone

+ const ParamStart

+ const SubdomainPrefix

+ const SubdomainWildcardIndicator

+ const SubdomainWildcardPrefix

+ const WildcardParamStart

+ var AllMethods = []string

+ func Abs(path string) string

+ func DirectoryExists(dir string) bool

+ func FileServer(directory string, opts ...DirOptions) context.Handler

+ func NewWrapper(...) http.Handler

+ func Param(name string) string

+ func StripPrefix(prefix string, h context.Handler) context.Handler

+ func TypeByExtension(ext string) (typ string)

+ func TypeByFilename(fullFilename string) string

+ func WildcardFileParam() string

+ func WildcardParam(name string) string

+ type APIBuilder struct

+ func NewAPIBuilder() *APIBuilder

+ func (api *APIBuilder) AllowMethods(methods ...string) Party

+ func (api *APIBuilder) Any(relativePath string, handlers ...context.Handler) (routes []*Route)

+ func (api *APIBuilder) Connect(relativePath string, handlers ...context.Handler) *Route

+ func (api *APIBuilder) Delete(relativePath string, handlers ...context.Handler) *Route

+ func (api *APIBuilder) Done(handlers ...context.Handler)

+ func (api *APIBuilder) DoneGlobal(handlers ...context.Handler)

+ func (api *APIBuilder) Favicon(favPath string, requestPath ...string) *Route

+ func (api *APIBuilder) FireErrorCode(ctx context.Context)

+ func (api *APIBuilder) Get(relativePath string, handlers ...context.Handler) *Route

+ func (api *APIBuilder) GetRelPath() string

+ func (api *APIBuilder) GetReporter() *errgroup.Group

+ func (api *APIBuilder) GetRoute(routeName string) *Route

+ func (api *APIBuilder) GetRouteByPath(tmplPath string) *Route

+ func (api *APIBuilder) GetRouteReadOnly(routeName string) context.RouteReadOnly

+ func (api *APIBuilder) GetRouteReadOnlyByPath(tmplPath string) context.RouteReadOnly

+ func (api *APIBuilder) GetRoutes() []*Route

+ func (api *APIBuilder) GetRoutesReadOnly() []context.RouteReadOnly

+ func (api *APIBuilder) Handle(method string, relativePath string, handlers ...context.Handler) *Route

+ func (api *APIBuilder) HandleDir(requestPath, directory string, opts ...DirOptions) (getRoute *Route)

+ func (api *APIBuilder) HandleMany(methodOrMulti string, relativePathorMulti string, handlers ...context.Handler) (routes []*Route)

+ func (api *APIBuilder) Head(relativePath string, handlers ...context.Handler) *Route

+ func (api *APIBuilder) Layout(tmplLayoutFile string) Party

+ func (api *APIBuilder) Macros() *macro.Macros

+ func (api *APIBuilder) None(relativePath string, handlers ...context.Handler) *Route

+ func (api *APIBuilder) OnAnyErrorCode(handlers ...context.Handler)

+ func (api *APIBuilder) OnErrorCode(statusCode int, handlers ...context.Handler)

+ func (api *APIBuilder) Options(relativePath string, handlers ...context.Handler) *Route

+ func (api *APIBuilder) Party(relativePath string, handlers ...context.Handler) Party

+ func (api *APIBuilder) PartyFunc(relativePath string, partyBuilderFunc func(p Party)) Party

+ func (api *APIBuilder) Patch(relativePath string, handlers ...context.Handler) *Route

+ func (api *APIBuilder) Post(relativePath string, handlers ...context.Handler) *Route

+ func (api *APIBuilder) Put(relativePath string, handlers ...context.Handler) *Route

+ func (api *APIBuilder) Reset() Party

+ func (api *APIBuilder) SetExecutionRules(executionRules ExecutionRules) Party

+ func (api *APIBuilder) StaticContent(reqPath string, cType string, content []byte) *Route

+ func (api *APIBuilder) Subdomain(subdomain string, middleware ...context.Handler) Party

+ func (api *APIBuilder) Trace(relativePath string, handlers ...context.Handler) *Route

+ func (api *APIBuilder) Use(handlers ...context.Handler)

+ func (api *APIBuilder) UseGlobal(handlers ...context.Handler)

+ func (api *APIBuilder) WildcardSubdomain(middleware ...context.Handler) Party

+ type DirOptions struct

+ Asset func(name string) ([]byte, error)

+ AssetInfo func(name string) (os.FileInfo, error)

+ AssetNames func() []string

+ AssetValidator func(ctx context.Context, name string) bool

+ DirList func(ctx context.Context, dirName string, dir http.File) error

+ Gzip bool

+ IndexName string

+ ShowList bool

+ type ErrorCodeHandler struct

+ Handlers context.Handlers

+ StatusCode int

+ func (ch *ErrorCodeHandler) Fire(ctx context.Context)

+ type ErrorCodeHandlers struct

+ func (s *ErrorCodeHandlers) Fire(ctx context.Context)

+ func (s *ErrorCodeHandlers) Get(statusCode int) *ErrorCodeHandler

+ func (s *ErrorCodeHandlers) Register(statusCode int, handlers ...context.Handler) *ErrorCodeHandler

+ type ExecutionOptions struct

+ Force bool

+ type ExecutionRules struct

+ Begin ExecutionOptions

+ Done ExecutionOptions

+ Main ExecutionOptions

+ type Party interface

+ AllowMethods func(methods ...string) Party

+ Any func(registeredPath string, handlers ...context.Handler) []*Route

+ Connect func(path string, handlers ...context.Handler) *Route

+ Delete func(path string, handlers ...context.Handler) *Route

+ Done func(handlers ...context.Handler)

+ Favicon func(favPath string, requestPath ...string) *Route

+ Get func(path string, handlers ...context.Handler) *Route

+ GetRelPath func() string

+ GetReporter func() *errgroup.Group

+ Handle func(method string, registeredPath string, handlers ...context.Handler) *Route

+ HandleDir func(requestPath, directory string, opts ...DirOptions) *Route

+ HandleMany func(method string, relativePath string, handlers ...context.Handler) []*Route

+ Head func(path string, handlers ...context.Handler) *Route

+ Layout func(tmplLayoutFile string) Party

+ Macros func() *macro.Macros

+ None func(path string, handlers ...context.Handler) *Route

+ Options func(path string, handlers ...context.Handler) *Route

+ Party func(relativePath string, middleware ...context.Handler) Party

+ PartyFunc func(relativePath string, partyBuilderFunc func(p Party)) Party

+ Patch func(path string, handlers ...context.Handler) *Route

+ Post func(path string, handlers ...context.Handler) *Route

+ Put func(path string, handlers ...context.Handler) *Route

+ Reset func() Party

+ SetExecutionRules func(executionRules ExecutionRules) Party

+ StaticContent func(requestPath string, cType string, content []byte) *Route

+ Subdomain func(subdomain string, middleware ...context.Handler) Party

+ Trace func(path string, handlers ...context.Handler) *Route

+ Use func(middleware ...context.Handler)

+ type RequestHandler interface

+ Build func(provider RoutesProvider) error

+ HandleRequest func(context.Context)

+ RouteExists func(ctx context.Context, method, path string) bool

+ func NewDefaultHandler() RequestHandler

+ type Route struct

+ FormattedPath string

+ Handlers context.Handlers

+ MainHandlerName string

+ Method string

+ Name string

+ Path string

+ SourceFileName string

+ SourceLineNumber int

+ StaticSites []context.StaticSite

+ Subdomain string

+ func NewRoute(method, subdomain, unparsedPath, mainHandlerName string, ...) (*Route, error)

+ func (r *Route) BuildHandlers()

+ func (r *Route) ChangeMethod(newMethod string) bool

+ func (r *Route) DeepEqual(other *Route) bool

+ func (r *Route) Done(handlers ...context.Handler)

+ func (r *Route) Equal(other *Route) bool

+ func (r *Route) RestoreStatus() bool

+ func (r *Route) SetStatusOffline() bool

+ func (r *Route) Use(handlers ...context.Handler)

+ func (r Route) IsOnline() bool

+ func (r Route) RegisteredHandlersLen() int

+ func (r Route) ResolvePath(args ...string) string

+ func (r Route) StaticPath() string

+ func (r Route) String() string

+ func (r Route) Tmpl() macro.Template

+ func (r Route) Trace() string

+ type RoutePathReverser struct

+ func NewRoutePathReverser(apiRoutesProvider RoutesProvider, options ...RoutePathReverserOption) *RoutePathReverser

+ func (ps *RoutePathReverser) Path(routeName string, paramValues ...interface{}) string

+ func (ps *RoutePathReverser) URL(routeName string, paramValues ...interface{}) (url string)

+ type RoutePathReverserOption func(*RoutePathReverser)

+ func WithHost(host string) RoutePathReverserOption

+ func WithScheme(scheme string) RoutePathReverserOption

+ func WithServer(srv *http.Server) RoutePathReverserOption

+ type Router struct

+ func NewRouter() *Router

+ func (router *Router) BuildRouter(cPool *context.Pool, requestHandler RequestHandler, ...) error

+ func (router *Router) Downgrade(newMainHandler http.HandlerFunc)

+ func (router *Router) Downgraded() bool

+ func (router *Router) RefreshRouter() error

+ func (router *Router) RouteExists(ctx context.Context, method, path string) bool

+ func (router *Router) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ func (router *Router) ServeHTTPC(ctx context.Context)

+ func (router *Router) WrapRouter(wrapperFunc WrapperFunc)

+ type RoutesProvider interface

+ GetRoute func(routeName string) *Route

+ GetRoutes func() []*Route

+ type WrapperFunc func(w http.ResponseWriter, r *http.Request, firstNextIsTheRouter http.HandlerFunc)

+ func NewSubdomainRedirectWrapper(rootDomainGetter func() string, from, to string) WrapperFunc