Help us shape the future of Go! Take the 2026 Go Developer Survey

hooks

package
v0.6.7 Latest Latest
Warning

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

 Go to latest Published: Sep 1, 2026 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

View Source 
const AuthenticateString = "authenticate"
View Source 
const AuthnFailureString = "authnFailure"
View Source 
const AuthorizeString = "authorize"
View Source 
const AuthzFailureString = "authzFailure"
View Source 
const ChatNewMessageString = "chatNewMessage"
View Source 
const ClientReadyString = "clientReady"
View Source 
const ClientVarsString = "clientVars"
View Source 
const ExportFileNameString = "exportFileName"
View Source 
const ExportHTMLAdditionalContentString = "exportHTMLAdditionalContent"
View Source 
const ExportHTMLSendString = "exportHTMLSend"
View Source 
const GetAuthorIdString = "getAuthorId"
View Source 
const HandleMessageSecurityString = "handleMessageSecurity"
View Source 
const HandleMessageString = "handleMessage"
View Source 
const ImportEtherpadString = "importEtherpad"
View Source 
const ImportString = "import"
View Source 
const LoadSettingsString = "loadSettings"
View Source 
const OnAccessCheckString = "onAccessCheck"
View Source 
const PadCopyString = "padCopy"
View Source 
const PadCreateString = "padCreate"
View Source 
const PadDefaultContentString = "padDefaultContent"
View Source 
const PadLoadString = "padLoad"
View Source 
const PadRemoveString = "padRemove"
View Source 
const PadUpdateString = "padUpdate"
View Source 
const PreAuthorizeString = "preAuthorize"
View Source 
const PreAuthzFailureString = "preAuthzFailure"
View Source 
const ShutdownString = "shutdown"
View Source 
const StylesForExportString = "stylesForExport"
View Source 
const UserJoinString = "userJoin"
View Source 
const UserLeaveString = "userLeave"

Variables

View Source 
var AllLocales = map[string]map[string]string{}

AllLocales holds every loaded locale's translation map keyed by language tag (e.g. "en", "de"). Each value is map[string]string. Populated by ExpressPreSession at startup. Server-side renderers (e.g. socialmeta) look up translations here without re-parsing the embedded locale files. Upstream #7635 (refactor that exposes i18n.locales for server use).

View Source 
var AvailableLangs = map[string]LanguageInfo{}
View Source 
var SortedAvailableLangs []LanguageEntry

Functions

func ExpressPreSession 

func ExpressPreSession(app *fiber.App, uiAssets embed.FS)

func IsValid 

func IsValid(langcode string) bool

Types

type AttributeContainer 

type AttributeContainer struct {
	// contains filtered or unexported fields
}

type Hook 

type Hook struct {
	// contains filtered or unexported fields
}

func NewHook 

func NewHook() Hook

func (*Hook) DequeueHook 

func (h *Hook) DequeueHook(key, id string)

func (*Hook) EnqueueAuthenticateHook added in v0.6.5 

func (h *Hook) EnqueueAuthenticateHook(cb func(ctx *events.AuthenticateContext)) string

EnqueueAuthenticateHook registers a callback for the authenticate hook, fired during HTTP authentication before the built-in basic-auth check; the first callback to answer wins (see events.AuthenticateContext).

func (*Hook) EnqueueAuthnFailureHook added in v0.6.5 

func (h *Hook) EnqueueAuthnFailureHook(cb func(ctx *events.AuthnFailureContext)) string

EnqueueAuthnFailureHook registers a callback for the authnFailure hook, fired when authentication fails; a callback may override the default 401 response by calling Respond (see events.AuthnFailureContext).

func (*Hook) EnqueueAuthorizeHook added in v0.6.5 

func (h *Hook) EnqueueAuthorizeHook(cb func(ctx *events.AuthorizeContext)) string

EnqueueAuthorizeHook registers a callback for the authorize hook, fired during post-authentication authorization; Deny wins over any Grant, and the first Grant level is used (see events.AuthorizeContext).

func (*Hook) EnqueueAuthzFailureHook added in v0.6.5 

func (h *Hook) EnqueueAuthzFailureHook(cb func(ctx *events.AuthzFailureContext)) string

EnqueueAuthzFailureHook registers a callback for the authzFailure hook, fired when authorization fails; a callback may override the default 403 response by calling Respond (see events.AuthzFailureContext).

func (*Hook) EnqueueChatNewMessageHook added in v0.6.5 

func (h *Hook) EnqueueChatNewMessageHook(cb func(ctx *events.ChatNewMessageContext)) string

EnqueueChatNewMessageHook registers a callback for the chatNewMessage hook, fired before a chat message is stored and broadcast; a callback may edit the text or drop it (see events.ChatNewMessageContext).

func (*Hook) EnqueueClientReadyHook added in v0.6.5 

func (h *Hook) EnqueueClientReadyHook(cb func(ctx *events.ClientReadyContext)) string

EnqueueClientReadyHook registers a callback for the clientReady hook, fired once a client has finished joining a pad (see events.ClientReadyContext).

func (*Hook) EnqueueClientVarsHook added in v0.6.5 

func (h *Hook) EnqueueClientVarsHook(cb func(ctx *events.ClientVarsContext)) string

EnqueueClientVarsHook registers a callback for the clientVars hook, fired just before the CLIENT_VARS payload is sent; a callback may mutate typed fields or add keys via Extra (see events.ClientVarsContext).

func (*Hook) EnqueueExportFileNameHook added in v0.6.5 

func (h *Hook) EnqueueExportFileNameHook(cb func(ctx *events.ExportFileNameContext)) string

EnqueueExportFileNameHook registers a callback for the exportFileName hook, which can override the export download filename (first non-empty SetFileName wins; see events.ExportFileNameContext).

func (*Hook) EnqueueExportHTMLAdditionalContentHook added in v0.6.5 

func (h *Hook) EnqueueExportHTMLAdditionalContentHook(cb func(ctx *events.ExportHTMLAdditionalContentContext)) string

EnqueueExportHTMLAdditionalContentHook registers a callback for the exportHTMLAdditionalContent hook, fired during HTML export; each Add appends HTML to the exported body (see events.ExportHTMLAdditionalContentContext).

func (*Hook) EnqueueExportHTMLSendHook added in v0.6.5 

func (h *Hook) EnqueueExportHTMLSendHook(cb func(ctx *events.ExportHTMLSendContext)) string

EnqueueExportHTMLSendHook registers a callback for the exportHTMLSend hook, fired just before the HTML export response is sent; a callback may replace the document via *ctx.HTML (see events.ExportHTMLSendContext).

func (*Hook) EnqueueGetAuthorIdHook added in v0.6.5 

func (h *Hook) EnqueueGetAuthorIdHook(cb func(ctx *events.GetAuthorIdContext)) string

EnqueueGetAuthorIdHook registers a callback for the getAuthorId hook, which lets plugins resolve or override the author id from a token (first non-empty answer wins; see events.GetAuthorIdContext).

func (*Hook) EnqueueGetLineHtmlForExportHook added in v0.0.4 

func (h *Hook) EnqueueGetLineHtmlForExportHook(ctx func(ctx any))

func (*Hook) EnqueueGetPluginTranslationHooks added in v0.0.4 

func (h *Hook) EnqueueGetPluginTranslationHooks(cb func(ctx *events.LocaleLoadContext))

func (*Hook) EnqueueHandleMessageHook added in v0.6.5 

func (h *Hook) EnqueueHandleMessageHook(cb func(ctx *events.HandleMessageContext)) string

EnqueueHandleMessageHook registers a callback for the handleMessage hook, fired before an incoming socket message is dispatched; a callback may drop it (see events.HandleMessageContext).

func (*Hook) EnqueueHandleMessageSecurityHook added in v0.6.5 

func (h *Hook) EnqueueHandleMessageSecurityHook(cb func(ctx *events.HandleMessageSecurityContext)) string

EnqueueHandleMessageSecurityHook registers a callback for the handleMessageSecurity hook, which may grant write access to a read-only connection for a single message (see events.HandleMessageSecurityContext).

func (*Hook) EnqueueHook 

func (h *Hook) EnqueueHook(key string, ctx func(ctx any)) string

func (*Hook) EnqueueImportEtherpadHook added in v0.6.5 

func (h *Hook) EnqueueImportEtherpadHook(cb func(ctx *events.ImportEtherpadContext)) string

EnqueueImportEtherpadHook registers a callback for the importEtherpad hook, fired after a .etherpad file is parsed and before its records are persisted; plugins may inspect or augment the Data map (see events.ImportEtherpadContext).

func (*Hook) EnqueueImportHook added in v0.6.5 

func (h *Hook) EnqueueImportHook(cb func(ctx *events.ImportContext)) string

EnqueueImportHook registers a callback for the import hook, fired before the built-in file-extension dispatch; a callback may handle the import by calling Handle(), SetHTML, or SetText (see events.ImportContext).

func (*Hook) EnqueueLoadSettingsHook added in v0.6.5 

func (h *Hook) EnqueueLoadSettingsHook(cb func(ctx *events.LoadSettingsContext)) string

EnqueueLoadSettingsHook registers a callback for the loadSettings hook, fired once settings are loaded and plugins have registered at server startup (see events.LoadSettingsContext).

func (*Hook) EnqueueOnAccessCheckHook added in v0.6.5 

func (h *Hook) EnqueueOnAccessCheckHook(cb func(ctx *events.OnAccessCheckContext)) string

EnqueueOnAccessCheckHook registers a callback for the onAccessCheck hook, fired when access to a concrete pad is being checked via the socket; a callback may call Deny() to block access (see events.OnAccessCheckContext).

func (*Hook) EnqueuePadCopyHook added in v0.6.5 

func (h *Hook) EnqueuePadCopyHook(cb func(ctx *events.PadCopyContext)) string

EnqueuePadCopyHook registers a callback for the padCopy hook, fired after a pad is copied to a new destination (see events.PadCopyContext).

func (*Hook) EnqueuePadCreateHook added in v0.6.5 

func (h *Hook) EnqueuePadCreateHook(cb func(ctx *events.PadCreateContext)) string

EnqueuePadCreateHook registers a callback for the padCreate hook, fired right after a pad's first revision is persisted (see events.PadCreateContext).

func (*Hook) EnqueuePadDefaultContentHook added in v0.6.5 

func (h *Hook) EnqueuePadDefaultContentHook(cb func(ctx *events.PadDefaultContentContext)) string

EnqueuePadDefaultContentHook registers a callback for the padDefaultContent hook, which runs before a new pad's initial revision is written and may replace the default content (see events.PadDefaultContentContext).

func (*Hook) EnqueuePadLoadHook added in v0.6.5 

func (h *Hook) EnqueuePadLoadHook(cb func(ctx *events.PadLoadContext)) string

EnqueuePadLoadHook registers a callback for the padLoad hook, fired whenever a pad is materialized (see events.PadLoadContext).

func (*Hook) EnqueuePadRemoveHook added in v0.6.5 

func (h *Hook) EnqueuePadRemoveHook(cb func(ctx *events.PadRemoveContext)) string

EnqueuePadRemoveHook registers a callback for the padRemove hook, fired when a pad is deleted (see events.PadRemoveContext).

func (*Hook) EnqueuePadUpdateHook added in v0.6.5 

func (h *Hook) EnqueuePadUpdateHook(cb func(ctx *events.PadUpdateContext)) string

EnqueuePadUpdateHook registers a callback for the padUpdate hook, fired after a revision is appended (see events.PadUpdateContext).

func (*Hook) EnqueuePreAuthorizeHook added in v0.6.3 

func (h *Hook) EnqueuePreAuthorizeHook(cb func(ctx *events.PreAuthorizeContext)) string

EnqueuePreAuthorizeHook registers a callback for the preAuthorize hook, which lets plugins permit or deny a request before authentication runs (see events.PreAuthorizeContext).

func (*Hook) EnqueuePreAuthzFailureHook added in v0.6.3 

func (h *Hook) EnqueuePreAuthzFailureHook(cb func(ctx *events.PreAuthzFailureContext)) string

EnqueuePreAuthzFailureHook registers a callback for the preAuthzFailure hook, which lets plugins override the default 403 response after a preAuthorize deny (see events.PreAuthzFailureContext).

func (*Hook) EnqueueShutdownHook added in v0.6.5 

func (h *Hook) EnqueueShutdownHook(cb func(ctx *events.ShutdownContext)) string

EnqueueShutdownHook registers a callback for the shutdown hook, fired during graceful shutdown; callbacks must return quickly as the database may be unavailable (see events.ShutdownContext).

func (*Hook) EnqueueStylesForExportHook added in v0.6.5 

func (h *Hook) EnqueueStylesForExportHook(cb func(ctx *events.StylesForExportContext)) string

EnqueueStylesForExportHook registers a callback for the stylesForExport hook, fired during HTML export; each AddStyle appends CSS that is concatenated into the document <style> (see events.StylesForExportContext).

func (*Hook) EnqueueUserJoinHook added in v0.6.5 

func (h *Hook) EnqueueUserJoinHook(cb func(ctx *events.UserJoinLeaveContext)) string

EnqueueUserJoinHook registers a callback for the userJoin hook, fired when a user finishes joining a pad (see events.UserJoinLeaveContext).

func (*Hook) EnqueueUserLeaveHook added in v0.6.5 

func (h *Hook) EnqueueUserLeaveHook(cb func(ctx *events.UserJoinLeaveContext)) string

EnqueueUserLeaveHook registers a callback for the userLeave hook, fired when a user disconnects from a pad (see events.UserJoinLeaveContext).

func (*Hook) ExecuteAuthenticateHooks added in v0.6.5 

func (h *Hook) ExecuteAuthenticateHooks(ctx *events.AuthenticateContext)

func (*Hook) ExecuteAuthnFailureHooks added in v0.6.5 

func (h *Hook) ExecuteAuthnFailureHooks(ctx *events.AuthnFailureContext)

func (*Hook) ExecuteAuthorizeHooks added in v0.6.5 

func (h *Hook) ExecuteAuthorizeHooks(ctx *events.AuthorizeContext)

func (*Hook) ExecuteAuthzFailureHooks added in v0.6.5 

func (h *Hook) ExecuteAuthzFailureHooks(ctx *events.AuthzFailureContext)

func (*Hook) ExecuteChatNewMessageHooks added in v0.6.5 

func (h *Hook) ExecuteChatNewMessageHooks(ctx *events.ChatNewMessageContext)

func (*Hook) ExecuteClientReadyHooks added in v0.6.5 

func (h *Hook) ExecuteClientReadyHooks(ctx *events.ClientReadyContext)

func (*Hook) ExecuteClientVarsHooks added in v0.6.5 

func (h *Hook) ExecuteClientVarsHooks(ctx *events.ClientVarsContext)

func (*Hook) ExecuteExportFileNameHooks added in v0.6.5 

func (h *Hook) ExecuteExportFileNameHooks(ctx *events.ExportFileNameContext)

func (*Hook) ExecuteExportHTMLAdditionalContentHooks added in v0.6.5 

func (h *Hook) ExecuteExportHTMLAdditionalContentHooks(ctx *events.ExportHTMLAdditionalContentContext)

func (*Hook) ExecuteExportHTMLSendHooks added in v0.6.5 

func (h *Hook) ExecuteExportHTMLSendHooks(ctx *events.ExportHTMLSendContext)

func (*Hook) ExecuteGetAuthorIdHooks added in v0.6.5 

func (h *Hook) ExecuteGetAuthorIdHooks(ctx *events.GetAuthorIdContext)

func (*Hook) ExecuteGetLineHtmlForExportHooks added in v0.0.4 

func (h *Hook) ExecuteGetLineHtmlForExportHooks(ctx any)

func (*Hook) ExecuteGetPluginTranslationHooks added in v0.0.4 

func (h *Hook) ExecuteGetPluginTranslationHooks(ctx *events.LocaleLoadContext)

func (*Hook) ExecuteHandleMessageHooks added in v0.6.5 

func (h *Hook) ExecuteHandleMessageHooks(ctx *events.HandleMessageContext)

func (*Hook) ExecuteHandleMessageSecurityHooks added in v0.6.5 

func (h *Hook) ExecuteHandleMessageSecurityHooks(ctx *events.HandleMessageSecurityContext)

func (*Hook) ExecuteHooks 

func (h *Hook) ExecuteHooks(key string, ctx any)

func (*Hook) ExecuteImportEtherpadHooks added in v0.6.5 

func (h *Hook) ExecuteImportEtherpadHooks(ctx *events.ImportEtherpadContext)

func (*Hook) ExecuteImportHooks added in v0.6.5 

func (h *Hook) ExecuteImportHooks(ctx *events.ImportContext)

func (*Hook) ExecuteLoadSettingsHooks added in v0.6.5 

func (h *Hook) ExecuteLoadSettingsHooks(ctx *events.LoadSettingsContext)

func (*Hook) ExecuteOnAccessCheckHooks added in v0.6.5 

func (h *Hook) ExecuteOnAccessCheckHooks(ctx *events.OnAccessCheckContext)

func (*Hook) ExecutePadCopyHooks added in v0.6.5 

func (h *Hook) ExecutePadCopyHooks(ctx *events.PadCopyContext)

func (*Hook) ExecutePadCreateHooks added in v0.6.5 

func (h *Hook) ExecutePadCreateHooks(ctx *events.PadCreateContext)

func (*Hook) ExecutePadDefaultContentHooks added in v0.6.5 

func (h *Hook) ExecutePadDefaultContentHooks(ctx *events.PadDefaultContentContext)

func (*Hook) ExecutePadLoadHooks added in v0.6.5 

func (h *Hook) ExecutePadLoadHooks(ctx *events.PadLoadContext)

func (*Hook) ExecutePadRemoveHooks added in v0.6.5 

func (h *Hook) ExecutePadRemoveHooks(ctx *events.PadRemoveContext)

func (*Hook) ExecutePadUpdateHooks added in v0.6.5 

func (h *Hook) ExecutePadUpdateHooks(ctx *events.PadUpdateContext)

func (*Hook) ExecutePreAuthorizeHooks added in v0.6.3 

func (h *Hook) ExecutePreAuthorizeHooks(ctx *events.PreAuthorizeContext)

func (*Hook) ExecutePreAuthzFailureHooks added in v0.6.3 

func (h *Hook) ExecutePreAuthzFailureHooks(ctx *events.PreAuthzFailureContext)

func (*Hook) ExecuteShutdownHooks added in v0.6.5 

func (h *Hook) ExecuteShutdownHooks(ctx *events.ShutdownContext)

func (*Hook) ExecuteStylesForExportHooks added in v0.6.5 

func (h *Hook) ExecuteStylesForExportHooks(ctx *events.StylesForExportContext)

func (*Hook) ExecuteUserJoinHooks added in v0.6.5 

func (h *Hook) ExecuteUserJoinHooks(ctx *events.UserJoinLeaveContext)

func (*Hook) ExecuteUserLeaveHooks added in v0.6.5 

func (h *Hook) ExecuteUserLeaveHooks(ctx *events.UserJoinLeaveContext)

type LanguageContainer 

type LanguageContainer struct {
	// contains filtered or unexported fields
}

type LanguageEntry added in v0.6.0 

type LanguageEntry struct {
	Code string
	Info LanguageInfo
}

LanguageEntry is the ordered (code, info) pair used by templates that render the language dropdown. Go maps have no stable iteration order, so SortedAvailableLangs provides the alphabetical-by-native-name ordering that upstream #7477 added on the Node side.

type LanguageInfo 

type LanguageInfo struct {
	LanguageCode string
	Direction    string
	Attribute    string
	DisplayName  string
}

type Locales 

type Locales = map[string]interface{}

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.