handlers

package
v0.0.0-...-16c708a Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 12, 2019 License: GPL-3.0 Imports: 29 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

HTTPError defines a package wrapper for middleware's NewHTTPError This is done to prevent needing to specify a package when creating a new error

Functions

func AddTrailingSlash

func AddTrailingSlash(h http.Handler) http.HandlerFunc

AddTrailingSlash redirects the request with an additional / if it does not have one. If the request URL already has a / when it calls the given handlers ServeHTTP method.

func HTTPSRedirectHandler

func HTTPSRedirectHandler(w http.ResponseWriter, r *http.Request)

HTTPSRedirectHandler redirects the given HTTP request to HTTPS. Does not redirect requests to any API route.

func IndexHandler

func IndexHandler(basePath string) func(w http.ResponseWriter, r *http.Request)

IndexHandler handles the serving the webclient from the root resource.

func PreventDirListing

func PreventDirListing(h http.Handler) http.HandlerFunc

PreventDirListing returns a HandlerFunc on the given handler that prevents the root directory from being listed. That is, for a static file server a specific file will need to be supplied.

Types

type AnnouncementContext

type AnnouncementContext struct {
	Store    *models.Database
	Notifier *notify.Notifier
	// contains filtered or unexported fields
}

AnnouncementContext defines the information needed for handlers performing announcement operations.

func NewAnnouncementContext

func NewAnnouncementContext(store *models.Database, notifier *notify.Notifier, pc *models.PermissionChecker) *AnnouncementContext

NewAnnouncementContext returns a pointer to an AnnouncementContext with the given information.

func (*AnnouncementContext) AnnouncementsHandler

func (ctx *AnnouncementContext) AnnouncementsHandler(w http.ResponseWriter, r *http.Request, u *models.User) *middleware.HTTPError

AnnouncementsHandler handles requests related to announcements resource.

func (*AnnouncementContext) DummyAnnouncementHandler

func (ctx *AnnouncementContext) DummyAnnouncementHandler(w http.ResponseWriter, r *http.Request, u *models.User) *middleware.HTTPError

DummyAnnouncementHandler handles requests made to make a dummy announcement. Creates a dummy announcement and sends it over the context's notifier.

func (*AnnouncementContext) SpecificAnnouncementHandler

func (ctx *AnnouncementContext) SpecificAnnouncementHandler(w http.ResponseWriter, r *http.Request, u *models.User) *middleware.HTTPError

SpecificAnnouncementHandler handles requests for a specific announcement

type AuthContext

type AuthContext struct {
	SessionKey    string
	SessionsStore sessions.Store

	MailCredentials *mail.Credentials

	TemplatePath string
	// contains filtered or unexported fields
}

AuthContext defines a list of information that handlers performing authentication functions will need

func NewAuthContext

func NewAuthContext(sessionKey, tp string, sessionStore sessions.Store, database *models.Database, mc *mail.Credentials, pc *models.PermissionChecker) *AuthContext

NewAuthContext Creates a new auth context with the given information

func (*AuthContext) AllUsersHandler

func (ctx *AuthContext) AllUsersHandler(w http.ResponseWriter, r *http.Request, u *models.User) *middleware.HTTPError

AllUsersHandler handles requests for the all users resource

func (*AuthContext) AnnouncementTypesHandler

func (ctx *AuthContext) AnnouncementTypesHandler(w http.ResponseWriter, r *http.Request, u *models.User) *middleware.HTTPError

AnnouncementTypeHandler handles general requests to the announcement types resource.

func (*AuthContext) AuditionObjectDispatcher

func (ctx *AuthContext) AuditionObjectDispatcher(w http.ResponseWriter, r *http.Request, u *models.User) *middleware.HTTPError

AuditionObjectDispatcher further routes requests requests to the auditions/{id}/{object} resource

func (*AuthContext) AuditionsHandler

func (ctx *AuthContext) AuditionsHandler(w http.ResponseWriter, r *http.Request, u *models.User) *middleware.HTTPError

AuditionsHandler handles requests for the auditions resource.

func (*AuthContext) PasswordResetHandler

func (ctx *AuthContext) PasswordResetHandler(w http.ResponseWriter, r *http.Request)

PasswordResetHandler handles requests that will initiate a password reset.

func (*AuthContext) PieceObjectHandler

func (ctx *AuthContext) PieceObjectHandler(w http.ResponseWriter, r *http.Request, u *models.User) *middleware.HTTPError

PieceObjectHandler handles requests for api/v1/pieces/{id}/{object}

func (*AuthContext) PieceObjectIDHandler

func (ctx *AuthContext) PieceObjectIDHandler(w http.ResponseWriter, r *http.Request, u *models.User) *middleware.HTTPError

PieceObjectIDHandler handles requests for api/v1/pieces/{id}/{object}/{id}

func (*AuthContext) PiecesHandler

func (ctx *AuthContext) PiecesHandler(w http.ResponseWriter, r *http.Request, u *models.User) *middleware.HTTPError

PiecesHandler handles requests for the shows resource.

func (*AuthContext) RolesHandler

func (ctx *AuthContext) RolesHandler(w http.ResponseWriter, r *http.Request, u *models.User) *middleware.HTTPError

RolesHandler handles all requests for the roles resource

func (*AuthContext) ShowAuditionRelationshipHandler

func (ctx *AuthContext) ShowAuditionRelationshipHandler(w http.ResponseWriter, r *http.Request, u *models.User) *middleware.HTTPError

ShowAuditionRelationshipHandler handles requests to modify a specific audition in relation to a show.

func (*AuthContext) ShowObjectDispatcher

func (ctx *AuthContext) ShowObjectDispatcher(w http.ResponseWriter, r *http.Request, u *models.User) *middleware.HTTPError

ShowObjectDispatcher further routes requests requests to the shows/{id}/{object} resource

func (*AuthContext) ShowTypeHandler

func (ctx *AuthContext) ShowTypeHandler(w http.ResponseWriter, r *http.Request, u *models.User) *middleware.HTTPError

ShowTypeHandler handles general requests to the show type resource.

func (*AuthContext) ShowsHandler

func (ctx *AuthContext) ShowsHandler(w http.ResponseWriter, r *http.Request, u *models.User) *middleware.HTTPError

ShowsHandler handles requests for the shows resource.

func (*AuthContext) SpecificAuditionHandler

func (ctx *AuthContext) SpecificAuditionHandler(w http.ResponseWriter, r *http.Request, u *models.User) *middleware.HTTPError

SpecificAuditionHandler handles requests to a specific audition.

func (*AuthContext) SpecificPieceHandler

func (ctx *AuthContext) SpecificPieceHandler(w http.ResponseWriter, r *http.Request, u *models.User) *middleware.HTTPError

SpecificPieceHandler handles requests to a specific piece.

func (*AuthContext) SpecificRoleHandler

func (ctx *AuthContext) SpecificRoleHandler(w http.ResponseWriter, r *http.Request, u *models.User) *middleware.HTTPError

SpecificRoleHandler handles requests for specific roles

func (*AuthContext) SpecificShowHandler

func (ctx *AuthContext) SpecificShowHandler(w http.ResponseWriter, r *http.Request, u *models.User) *middleware.HTTPError

SpecificShowHandler handles requests to a specific show.

func (*AuthContext) SpecificUserHandler

func (ctx *AuthContext) SpecificUserHandler(w http.ResponseWriter, r *http.Request, u *models.User) *middleware.HTTPError

SpecificUserHandler handles requests for a specific user

func (*AuthContext) UserMemberShipHandler

func (ctx *AuthContext) UserMemberShipHandler(w http.ResponseWriter, r *http.Request, u *models.User) *middleware.HTTPError

UserMemberShipHandler handles all requests to add or remove a user to an entity.

func (*AuthContext) UserMembershipActionDispatcher

func (ctx *AuthContext) UserMembershipActionDispatcher(w http.ResponseWriter, r *http.Request, u *models.User) *middleware.HTTPError

UserMembershipActionDispatcher acts a second layer mux that filters requests about a user membership requests specific object types and actions.

func (*AuthContext) UserObjectDispatcher

func (ctx *AuthContext) UserObjectDispatcher(w http.ResponseWriter, r *http.Request, u *models.User) *middleware.HTTPError

UserObjectDispatcher further routes requests for the users/id/object resource

func (*AuthContext) UserObjectsHandler

func (ctx *AuthContext) UserObjectsHandler(w http.ResponseWriter, r *http.Request, u *models.User) *middleware.HTTPError

UserObjectsHandler handles requests for a specific object on a user

func (*AuthContext) UserSignInHandler

func (ctx *AuthContext) UserSignInHandler(w http.ResponseWriter, r *http.Request)

UserSignInHandler handles requests for user sign ins

func (*AuthContext) UserSignUpHandler

func (ctx *AuthContext) UserSignUpHandler(w http.ResponseWriter, r *http.Request)

UserSignUpHandler handles requests for user sign ups

type CastingContext

type CastingContext struct {
	Session         *notify.CastingSession
	CastingTPLPath  string
	MailCredentials *mail.Credentials
	IsDebugMode     bool
	// contains filtered or unexported fields
}

CastingContext defines information needed for handlers that handle casting requests.

func NewCastingContext

func NewCastingContext(pc *models.PermissionChecker,
	session *notify.CastingSession,
	tplPath string,
	credentials *mail.Credentials,
	debugMode bool) *CastingContext

NewCastingContext returns a new CastingContext from the given inputs.

func (*CastingContext) CastingHandlerDispatcher

func (ctx *CastingContext) CastingHandlerDispatcher(w http.ResponseWriter, r *http.Request, u *models.User) *middleware.HTTPError

CastingHandlerDispatcher dispatches requests for the auditions/id/casting resource.

func (*CastingContext) DebugCastingStateHandler

func (ctx *CastingContext) DebugCastingStateHandler(w http.ResponseWriter, r *http.Request, u *models.User) *middleware.HTTPError

DebugCastingStateHandler is a debug handle that will return the current state of the casting session. This is a debug handle and should be used in production.

func (*CastingContext) FlushCastingHandler

func (ctx *CastingContext) FlushCastingHandler(w http.ResponseWriter, r *http.Request, u *models.User) *middleware.HTTPError

FlushCastingHandler handles requests to flush the casting session

type HandlerContext

type HandlerContext struct {
	Store *models.Database
}

HandlerContext defines context for non-auth related handlers.

func NewHandlerContext

func NewHandlerContext(store *models.Database) *HandlerContext

NewHandlerContext creates a new HandlerContext with the given arguments.

type MailContext

type MailContext mail.Credentials

MailContext is context used to invoke mail related handlers This is defined so that handlers can be invoked on a set of mail credentials

func NewMailContext

func NewMailContext(user, password string, pc *models.PermissionChecker) *MailContext

NewMailContext returns a new mail context from the given information

func (*MailContext) AsMailCredentials

func (mc *MailContext) AsMailCredentials() *mail.Credentials

AsMailCredentials returns this mail context as mail credentials as a full copy

func (*MailContext) MailHandler

MailHandler handles all mail related requests

type Validator

type Validator interface {
	// Validate validates the current struct
	// and returns an error if one occurred.
	// Returns nil if validation was successful.
	Validate() error
}

Validator defines structs that can be validated.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
⌂ 换网址