feature

package

Go to main page

Versions in this module

v0

v0.7.7

Sep 8, 2024

v0.7.6

Sep 6, 2024

v0.7.5

Aug 21, 2024

v0.7.4

Aug 9, 2024

v0.7.3

Jun 19, 2024

v0.7.2

Jun 18, 2024

v0.7.1

Jun 17, 2024

v0.7.0

Jun 16, 2024

Changes in this version

+ type DataBase interface

+ Build func() (b sqlbuilder.Buildable)

+ Get func(column, query string, argv ...interface{}) (value interface{}, err error)

+ GetFloat func(column, query string, argv ...interface{}) (value float64, err error)

+ GetFloats func(column, query string, argv ...interface{}) (value []float64, err error)

+ GetInt func(column, query string, argv ...interface{}) (value int64, err error)

+ GetInts func(column, query string, argv ...interface{}) (value []int64, err error)

+ GetString func(column, query string, argv ...interface{}) (value string, err error)

+ GetStrings func(column, query string, argv ...interface{}) (value []string, err error)

+ GormDB func() (db *gorm.DB)

+ SelectAll func(sql string, argv ...interface{}) (rows []context.Context, err error)

+ SelectRows func(query string, fn func(row context.Context) (stop bool), argv ...interface{}) (err error)

+ SqlDB func() (db *sql.DB)

+ type DatabaseFeature interface

+ DB func(tag string) (db DataBase, err error)

+ ListDB func() (tags []string)

+ MustDB func(tag string) (db DataBase)

+ type EditorFile struct

+ Actions editor.Actions

+ Base string

+ Binary bool

+ Code string

+ Context clContext.Context

+ Created time.Time

+ FSBT string

+ FSID string

+ File string

+ HasDraft bool

+ Indicators editor.Indicators

+ Locale *language.Tag

+ Locked bool

+ LockedBy string

+ MimeType string

+ MountPoint interface{}

+ Name string

+ Path string

+ ReadOnly bool

+ Shasum string

+ Tilde string

+ Updated time.Time

+ func ParseDirectory(fsid, filePath string) *EditorFile

+ func ParseFile(fsid, filePath string, t Theme) *EditorFile

+ func (f *EditorFile) BaseName() (fileName string)

+ func (f *EditorFile) BaseNamePath() (filePath string)

+ func (f *EditorFile) Clone() (file *EditorFile)

+ func (f *EditorFile) CodeFilePath() (filePath string)

+ func (f *EditorFile) DirectoryPath() (dirPath string)

+ func (f *EditorFile) EditCodeDirectoryPath() (directory string)

+ func (f *EditorFile) EditCodeFilePath() (filePath string)

+ func (f *EditorFile) EditCodeParentDirectoryPath() (directory string)

+ func (f *EditorFile) EditDirectoryPath() (directory string)

+ func (f *EditorFile) EditFilePath() (filePath string)

+ func (f *EditorFile) EditParentDirectoryPath() (directory string)

+ func (f *EditorFile) EditPath() (filePath string)

+ func (f *EditorFile) FileName() (name string)

+ func (f *EditorFile) FilePath() (filePath string)

+ func (f *EditorFile) Url() (path string)

+ type EditorFiles []*EditorFile

+ func (l EditorFiles) Find(fsid, filePath string) (f *EditorFile)

+ func (l EditorFiles) Sort() (sorted EditorFiles)

type Internals

+ ListPageContextFields func() (kebabs []string)

type Page

+ DeepCopy func() interface{}

type PageContextFieldsProvider

+ ListPageContextFields func() (kebabs []string)

+ type PageIndexReport map[Tag]time.Duration

+ type PageIndexingFeature interface

+ AddToIndexWithReport func(stub *PageStub, p Page) (report PageIndexReport, err error)

+ RemoveFromIndexWithReport func(stub *PageStub, p Page) (report PageIndexReport, err error)

type PageStub

+ func MakePageStub(data []byte) (s *PageStub, err error)

+ func (ps *PageStub) Copy() *PageStub

+ func (ps *PageStub) DeepCopy() interface{}

+ func (ps *PageStub) Marshal() (data []byte, err error)

+ func (ps *PageStub) MarshalJSON() (data []byte, err error)

+ func (ps *PageStub) Unmarshal(data []byte) (err error)

+ func (ps *PageStub) UnmarshalJSON(data []byte) (err error)

type QueryIndexFeature

+ EQL func() enjinql.EnjinQL

+ FindPageID func(shasum string) (id int64, ok bool)

+ PerformLookup func(format string, argv ...interface{}) (columns []string, results context.Contexts, err error)

+ type QueryIndexSourceFeature interface

+ AddSources func() (sources enjinql.ConfigSources)

+ AddToSource func(tx enjinql.SqlTX, sid int64, stub *PageStub, p Page) (err error)

+ RemoveFromSource func(tx enjinql.SqlTX, sid int64, stub *PageStub, p Page) (err error)

type Service

+ PerformLookup func(format string, argv ...interface{}) (columns []string, results []context.Context, err error)

+ PerformQuery func(r *http.Request, format string, argv ...interface{}) (stubs PageStubs, err error)

+ PerformQueryPages func(r *http.Request, format string, argv ...interface{}) (pages Pages, err error)

type Tags

+ func (t Tags) Prune(tags ...Tag) (pruned Tags)

v0.5.12

Feb 18, 2024

v0.5.11

Feb 16, 2024

Changes in this version

+ type CloudTag struct

+ Count int

+ Link string

+ Weight int

+ Word string

+ type CloudTagPage struct

+ Created time.Time

+ Tags TagCloud

+ Title string

+ Updated time.Time

+ Url string

+ type TagCloud []*CloudTag

+ func (c TagCloud) Rank()

+ func (c TagCloud) Sort()

+ func (c TagCloud) Update(baseurl string)

+ type TagCloudProvider interface

+ GetPageTagCloud func(shasum string) (tags TagCloud)

+ GetTagCloud func() (tc TagCloud)

type ThemeConfig

+ Err error

v0.5.10

Feb 13, 2024

v0.5.9

Feb 12, 2024

v0.5.8

Feb 11, 2024

Changes in this version

type Internals

+ ApplyPageContextUpdaters func(r *http.Request, pages ...Page)

v0.5.7

Feb 8, 2024

Changes in this version

type ExtendedKeyValueStore

+ StreamKeys func(prefix string, ctx context.Context) (keys chan string)

v0.5.6

Dec 16, 2023

Changes in this version

type CFeature

+ KebabTag string

+ func (f *CFeature) SetState(state LifeCycleState)

+ func (f *CFeature) State() (state LifeCycleState)

+ type ExtendedKeyValueStore interface

+ Keys func(prefix string) (keys []string)

+ Range func(prefix string, fn KeyValueStoreRangeFn)

+ Size func() (count int)

type Feature

+ State func() (state LifeCycleState)

+ type KeyValueCacheFeature interface

+ Build func(b Buildable) (err error)

+ Shutdown func()

+ Startup func(ctx *cli.Context) (err error)

+ type KeyValueStoreRangeFn func(key string, value []byte) (stop bool)

+ type LifeCycleState uint8

+ const EndLifeCycleStates

+ const StateBuilt

+ const StateConstructed

+ const StateCreated

+ const StateInitialized

+ const StateMade

+ const StatePostStarted

+ const StateSetup

+ const StateShutdown

+ const StateStarted

+ func (l LifeCycleState) String() (name string)

+ func (l LifeCycleState) Valid() (valid bool)

+ type ReloadableFeature interface

+ Reload func()

type User

+ Bytes func() (data []byte)

+ Can func(action ...Action) (allowed bool)

+ CanAll func(action ...Action) (allowed bool)

+ GetActions func() (groups Actions)

+ GetActive func() (active bool)

+ GetAdminLocked func() (locked bool)

+ GetEID func() (eid string)

+ GetEmail func() (email string)

+ GetGroups func() (groups Groups)

+ GetImage func() (image string)

+ GetName func() (name string)

+ GetOrigin func() (origin string)

+ GetRID func() (rid string)

+ GetSetting func(key string) (value interface{})

+ GetSettings func(includeKeys ...string) (settings context.Context)

+ IsVisitor func() (visitor bool)

+ SafeContext func(includeKeys ...string) (ctx context.Context)

+ UnsafeContext func() (ctx context.Context)

type UserProvider

+ UserPresent func(eid string) (present bool)

v0.5.5

Dec 6, 2023

v0.5.4

Dec 6, 2023

Changes in this version

type Builder

+ SetAlwaysHtmlRedirect func(always bool) Builder

+ SetHtmlRedirectDelay func(seconds int) Builder

v0.5.3

Dec 3, 2023

v0.5.2

Nov 30, 2023

v0.5.1

Nov 30, 2023

Changes in this version

type Builder

+ AddCspModifierFn func(tag string, fn CspModifierFn) Builder

+ SetEnjinTextFn func(fn EnjinTextFn) Builder

+ SiteCopyrightYear func(year string) Builder

+ type CspModifierFn func(policy csp.Policy, r *http.Request) (modified csp.Policy)

type EnjinBase

+ SiteCopyrightName func() (name string)

+ SiteCopyrightNotice func() (notice string)

+ SiteCopyrightYear func() (year string)

+ type EnjinText struct

+ CopyrightName string

+ CopyrightNotice string

+ CopyrightYear string

+ Name string

+ TagLine string

+ type EnjinTextFn func(printer *message.Printer) (text EnjinText)

type Site

+ ApplyContext func(eid string, changes beContext.Context)

+ DeleteContextKeys func(eid string, keys ...string)

type SiteAuthFeature

+ SetUserFactor func(r *http.Request, claim *CSiteAuthClaimsFactor)

+ type SiteUserRequestModifier interface

+ ModifyUserRequest func(au AuthUser, r *http.Request) (modified *http.Request)

+ type ThemeAuthor struct

+ Homepage string

+ Name string

type ThemeConfig

+ func (tc *ThemeConfig) Copy() (config *ThemeConfig)

v0.5.0

Nov 19, 2023

Changes in this version

+ const ChangeActionSignal

+ const CommitFileSignal

+ const CopyFileSignal

+ const DeleteFileSignal

+ const DeletePathSignal

+ const FileNameRequiredSignal

+ const LockFileSignal

+ const MoveFileSignal

+ const PreChangeActionSignal

+ const PreCommitFileSignal

+ const PreCopyFileSignal

+ const PreDeleteFileSignal

+ const PreDeletePathSignal

+ const PreLockFileSignal

+ const PreMoveFileSignal

+ const PrePublishFileSignal

+ const PreRepublishFileSignal

+ const PreRetakeFileSignal

+ const PreTranslateFileActionSignal

+ const PreUnlockFileSignal

+ const PublishFileSignal

+ const RepublishFileSignal

+ const RetakeFileSignal

+ const TranslateFileActionSignal

+ const UnlockFileSignal

+ const UserNoticesRequestKey

+ func AddErrorNotice(r *http.Request, dismiss bool, message string, argv ...interface{}) (modified *http.Request)

+ func AddImportantNotice(r *http.Request, dismiss bool, message string, argv ...interface{}) (modified *http.Request)

+ func AddInfoNotice(r *http.Request, dismiss bool, message string, argv ...interface{}) (modified *http.Request)

+ func AddUserNotices(r *http.Request, notes ...*UserNotice) (modified *http.Request)

+ func AddWarnNotice(r *http.Request, dismiss bool, message string, argv ...interface{}) (modified *http.Request)

+ func FilterUserNotices(r *http.Request, fn func(notice *UserNotice) (keep bool)) (m *http.Request)

+ func GetTyped[T interface{}](tag Tag, list Features) (f T, err error)

+ func MakeRawPage(matter context.Context, content string) (raw string)

+ func ParseEditorOpKey(action string) (op, tgt string)

+ func ParseEditorOpTargetValue(target string) (tgt, value string)

type Action

+ func (a Action) IsNil() (empty bool)

type Actions

+ func (a Actions) Bytes() (data []byte)

+ func (a Actions) HasAllOf(actions Actions) (present bool)

+ func (a Actions) HasOneOf(actions Actions) (present bool)

+ type AuthProvider interface

+ AuthenticateRequest func(w http.ResponseWriter, r *http.Request) (handled bool, modified *http.Request)

+ type AuthUser interface

+ Bytes func() (data []byte)

+ Can func(action ...Action) (allowed bool)

+ CanAll func(action ...Action) (allowed bool)

+ GetActions func() (groups Actions)

+ GetActive func() (active bool)

+ GetAdminLocked func() (locked bool)

+ GetEID func() (eid string)

+ GetEmail func() (email string)

+ GetGroups func() (groups Groups)

+ GetImage func() (image string)

+ GetName func() (name string)

+ GetOrigin func() (origin string)

+ GetRID func() (rid string)

+ GetSetting func(key string) (value interface{})

+ GetSettings func(includeKeys ...string) (settings context.Context)

+ IsVisitor func() (visitor bool)

+ SafeContext func(includeKeys ...string) (ctx context.Context)

+ UnsafeContext func() (ctx context.Context)

+ type AuthUserApi interface

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

+ RequireUserCan func(action Action) func(next http.Handler) http.Handler

+ type AuthUserManager interface

+ NewAuthUser func(rid, name, email, picture, audience string, attributes map[string]interface{}) (user AuthUser, err error)

+ RemoveAuthUser func(eid string) (err error)

+ SetAuthUser func(user AuthUser) (err error)

+ type AuthUserProvider interface

+ AuthUserPresent func(eid string) (present bool)

+ GetAuthUser func(eid string) (user AuthUser, err error)

type Buildable

+ Features func() (cache *FeaturesCache)

type CFeature

+ func (f *CFeature) Construct(this interface{})

+ type CMountPoint struct

+ Mount string

+ Path string

+ ROFS fs.FileSystem

+ RWFS fs.RWFileSystem

+ type CNjnFeature struct

+ func (f *CNjnFeature) NjnCheckClass(tagClass NjnClass) (allow bool)

+ func (f *CNjnFeature) NjnCheckTag(tagName string) (allow bool)

+ func (f *CNjnFeature) NjnClassAllowed() (allowed NjnClass, ok bool)

+ func (f *CNjnFeature) NjnTagsAllowed() (allowed []string, ok bool)

+ func (f *CNjnFeature) NjnTagsDenied() (denied []string, ok bool)

+ type CSiteAuthClaims struct

+ Context beContext.Context

+ EID string

+ Email string

+ RID string

+ func (c *CSiteAuthClaims) GetAllFactors() (factors SiteAuthClaimsFactors)

+ func (c *CSiteAuthClaims) GetAudience() (name string)

+ func (c *CSiteAuthClaims) GetFactor(kebab, name string) (factor *CSiteAuthClaimsFactor, ok bool)

+ func (c *CSiteAuthClaims) GetFactors(kebab string) (factors SiteAuthClaimsFactors)

+ func (c *CSiteAuthClaims) GetVerifiedFactor(target string) (factor *CSiteAuthClaimsFactor, ok bool)

+ func (c *CSiteAuthClaims) ResetFactorValueTypes()

+ func (c *CSiteAuthClaims) RevokeFactor(kebab, name string)

+ func (c *CSiteAuthClaims) RevokeFactors(kebab string)

+ func (c *CSiteAuthClaims) RevokeVerifiedFactor(target string)

+ func (c *CSiteAuthClaims) SetFactor(factor *CSiteAuthClaimsFactor)

+ func (c *CSiteAuthClaims) SetVerifiedFactor(target string, factor *CSiteAuthClaimsFactor)

+ type CSiteAuthClaimsFactor struct

+ C string

+ E int64

+ K string

+ N string

+ T int64

+ func NewSiteAuthClaimsFactor(k, n string, e, t int64, c string) (p *CSiteAuthClaimsFactor)

+ func ParseSiteAuthClaimsFactor(m map[string]interface{}) (p *CSiteAuthClaimsFactor, ok bool)

+ func (p CSiteAuthClaimsFactor) ToMap() (m map[string]interface{})

+ type CSiteAuthMultiFactorInfo struct

+ Claimed []string

+ Factors []string

+ Ready bool

+ Submit bool

+ func NewSiteAuthMultiFactorInfo(tag, key, icon, label string, factors ...string) (info *CSiteAuthMultiFactorInfo)

+ type CSiteFeatureInfo struct

+ Backup bool

+ Hint string

+ Icon string

+ Key string

+ Label string

+ Placeholder string

+ Tag string

+ Usage string

+ func NewSiteFeatureInfo(tag, key, icon, label string) (info *CSiteFeatureInfo)

+ type EditorFeature interface

+ DraftExists func(info *editor.File) (present bool)

+ EditorMenu func(r *http.Request) (m menu.Menu)

+ FileExists func(info *editor.File) (exists bool)

+ GetEditorKey func() (name string)

+ GetEditorMenu func() (m menu.Menu)

+ GetEditorPath func() (path string)

+ IsEditorFileLocked func(fsid, filePath string) (eid string, locked bool)

+ ListFileSystemDirectories func(r *http.Request, fsid, code, dirs string) (list editor.Files)

+ ListFileSystemFiles func(r *http.Request, fsid, code, dirs string) (list editor.Files)

+ ListFileSystemLocales func(fsid string) (list editor.Files)

+ ListFileSystems func() (list editor.Files)

+ LockEditorFile func(eid, fsid, filePath string) (err error)

+ OpFileCancelHandler func(r *http.Request, pg Page, ctx, form beContext.Context, info *editor.File, ...) (redirect string)

+ OpFileCancelValidate func(r *http.Request, pg Page, ctx, form beContext.Context, info *editor.File, ...) (err error)

+ OpFileCommitHandler func(r *http.Request, pg Page, ctx, form beContext.Context, info *editor.File, ...) (redirect string)

+ OpFileCommitValidate func(r *http.Request, pg Page, ctx, form beContext.Context, info *editor.File, ...) (err error)

+ OpFileCopyHandler func(r *http.Request, pg Page, ctx, form beContext.Context, info *editor.File, ...) (redirect string)

+ OpFileCopyValidate func(r *http.Request, pg Page, ctx, form beContext.Context, info *editor.File, ...) (err error)

+ OpFileDeleteHandler func(r *http.Request, pg Page, ctx, form beContext.Context, info *editor.File, ...) (redirect string)

+ OpFileDeleteValidate func(r *http.Request, pg Page, ctx, form beContext.Context, info *editor.File, ...) (err error)

+ OpFileMoveHandler func(r *http.Request, pg Page, ctx, form beContext.Context, info *editor.File, ...) (redirect string)

+ OpFileMoveValidate func(r *http.Request, pg Page, ctx, form beContext.Context, info *editor.File, ...) (err error)

+ OpFilePublishHandler func(r *http.Request, pg Page, ctx, form beContext.Context, info *editor.File, ...) (redirect string)

+ OpFilePublishValidate func(r *http.Request, pg Page, ctx, form beContext.Context, info *editor.File, ...) (err error)

+ OpFileRetakeHandler func(r *http.Request, pg Page, ctx, form beContext.Context, info *editor.File, ...) (redirect string)

+ OpFileTranslateHandler func(r *http.Request, pg Page, ctx, form beContext.Context, info *editor.File, ...) (redirect string)

+ OpFileTranslateValidate func(r *http.Request, pg Page, ctx, form beContext.Context, info *editor.File, ...) (err error)

+ OpFileUnlockHandler func(r *http.Request, pg Page, ctx, form beContext.Context, info *editor.File, ...) (redirect string)

+ OpPathDeleteHandler func(r *http.Request, pg Page, ctx, form beContext.Context, info *editor.File, ...) (redirect string)

+ OpPathDeleteValidate func(r *http.Request, pg Page, ctx, form beContext.Context, info *editor.File, ...) (err error)

+ ParseEditorUrlParams func(r *http.Request) (fsid, code, file string, locale *language.Tag)

+ PrepareEditPage func(pageType, editorType string, r *http.Request) (pg Page, ctx beContext.Context, err error)

+ PrepareEditableFile func(r *http.Request, info *editor.File) (editFile *editor.File)

+ ProcessMountPointFile func(r *http.Request, printer *message.Printer, ...) (ef *editor.File, ignored bool)

+ PublishDraft func(info *editor.File) (err error)

+ ReadDraft func(info *editor.File) (contents []byte, err error)

+ ReadDraftMatter func(info *editor.File) (pm *matter.PageMatter, err error)

+ ReadFile func(info *editor.File) (data []byte, err error)

+ ReceiveFileEditorChanges func(w http.ResponseWriter, r *http.Request)

+ RemoveDirectory func(info *editor.File) (err error)

+ RemoveDraft func(info *editor.File) (err error)

+ RemoveFile func(info *editor.File) (err error)

+ RenderFileBrowser func(w http.ResponseWriter, r *http.Request)

+ RenderFileEditor func(w http.ResponseWriter, r *http.Request)

+ SelfEditor func() (self EditorFeature)

+ ServePreparedEditPage func(pg Page, ctx beContext.Context, w http.ResponseWriter, r *http.Request)

+ SetupEditor func(editor EditorSite)

+ SetupEditorRoute func(r chi.Router)

+ UnLockEditorFile func(fsid, filePath string) (err error)

+ UpdateFileInfo func(info *editor.File, r *http.Request)

+ UpdateFileInfoForEditing func(info *editor.File, r *http.Request)

+ UpdatePathInfo func(info *editor.File, r *http.Request)

+ WriteDraft func(info *editor.File, contents []byte) (err error)

+ WriteFile func(info *editor.File, data []byte) (err error)

+ type EditorMakeFeature interface

+ SetEditingTags func(tags ...Tag) MakeTypedFeature

+ SetEditorName func(name string) MakeTypedFeature

+ SetEditorType func(editorType string) MakeTypedFeature

+ type EditorOperation struct

+ Action Action

+ Confirm string

+ Key string

+ Operation EditorOperationFn

+ Validate EditorValidateFn

+ type EditorOperationFn = func(r *http.Request, pg Page, ctx, form beContext.Context, info *editor.File, ...) (redirect string)

+ type EditorSite interface

+ ListPageLayouts func() (names []string)

+ ListPageTypes func() (values []string)

+ type EditorValidateFn = func(r *http.Request, pg Page, ctx, form beContext.Context, info *editor.File, ...) (err error)

type EmailProvider

+ HasTemplate func(name string) (present bool)

+ ListTemplates func() (names []string)

+ type EnjinBase interface

+ FindPage func(tag language.Tag, url string) (p Page)

+ FindPages func(prefix string) (pages []Page)

+ FindTranslationUrls func(url string) (pages map[language.Tag]string)

+ FindTranslations func(url string) (pages Pages)

+ SiteDefaultLanguage func() (tag language.Tag)

+ SiteLanguageCatalog func() (c catalog.Catalog)

+ SiteLanguageDisplayName func(tag language.Tag) (name string, ok bool)

+ SiteLanguageMode func() (mode lang.Mode)

+ SiteLocales func() (locales []language.Tag)

+ SiteName func() (name string)

+ SiteSupportsLanguage func(tag language.Tag) (supported bool)

+ SiteTag func() (key string)

+ SiteTagLine func() (tagLine string)

+ type EnjinInfo struct

+ DefaultLang language.Tag

+ LangMode lang.Mode

+ Locales []language.Tag

+ Name string

+ Tag string

+ TagLine string

+ func MakeEnjinInfo(e EnjinBase) (info EnjinInfo)

type Feature

+ Construct func(this interface{})

type Features

+ func (f Features) Get(tag Tag) (found Feature)

+ func (f Features) Has(tag Tag) (present bool)

+ type FileSystemFeature interface

+ Exists func(path string) (present bool)

+ FindPageMatterPath func(prefix string) (path string, err error)

+ FindPathMountPoint func(path string) (mps MountPoints)

+ FindReadPageMatter func(path string) (pm *matter.PageMatter, err error)

+ GetMountedPoints func() (mountPoints MountedPoints)

+ IsLocalized func() (supported bool)

+ MountPathROFS func(path string, point string, rofs fs.FileSystem)

+ MountPathRWFS func(path string, point string, rwfs fs.RWFileSystem)

+ ReadPageMatter func(path string) (pm *matter.PageMatter, err error)

+ WritePageMatter func(pm *matter.PageMatter) (err error)

+ type FinalizeServeRequestFeature interface

+ FinalizeServeRequest func(w http.ResponseWriter, r *http.Request) (modified *http.Request)

+ type Group string

+ func NewGroup(group string) Group

+ func (g Group) String() string

+ type Groups []Group

+ func NewGroupsFromStringNL(newlines string) (groups Groups)

+ func NewGroupsFromStrings(slice ...string) (groups Groups)

+ func (g Groups) Append(groups ...Group) (modified Groups)

+ func (g Groups) AppendString(names ...string) (modified Groups)

+ func (g Groups) AsNewlines() (newlines string)

+ func (g Groups) Has(group Group) (present bool)

+ func (g Groups) Len() int

+ func (g Groups) Remove(groups ...Group) (modified Groups)

+ func (g Groups) String() (s string)

+ type GroupsManager interface

+ AddUserToGroup func(eid string, groups ...Group) (err error)

+ GetGroupActions func(group Group) (actions Actions)

+ RemoveGroup func(group Group) (err error)

+ RemoveUserFromGroup func(eid string, groups ...Group) (err error)

+ UpdateGroup func(group Group, actions ...Action) (err error)

+ type GroupsProvider interface

+ GetUserGroups func(eid string) (groups Groups)

+ IsUserInGroup func(eid string, group Group) (present bool)

+ type HotReloadableFeature interface

+ HotReload func() (err error)

type Internals

+ GetApplyMiddlewares func() []ApplyMiddleware

+ GetAuthProviders func() []AuthProvider

+ GetContentSecurityPolicyModifiers func() []ContentSecurityPolicyModifier

+ GetDataRestrictionHandlers func() []DataRestrictionHandler

+ GetDatabases func() []Database

+ GetEmailSenders func() []EmailSender

+ GetEnjinContextProvider func() []EnjinContextProvider

+ GetFileProviders func() []FileProvider

+ GetFinalizeServePagesFeatures func() []FinalizeServeRequestFeature

+ GetFormatProviders func() []PageFormatProvider

+ GetFuncMapProviders func() []FuncMapProvider

+ GetHeadersModifiers func() []HeadersModifier

+ GetLocaleHandler func() LocaleHandler

+ GetLocalesProviders func() []LocalesProvider

+ GetMenuProviders func() []MenuProvider

+ GetOutputTransformers func() []OutputTransformer

+ GetOutputTranslators func() []OutputTranslator

+ GetPageContextFieldsProviders func() []PageContextFieldsProvider

+ GetPageContextModifiers func() []PageContextModifier

+ GetPageContextParsersProviders func() []PageContextParsersProvider

+ GetPageContextProviders func() []PageContextProvider

+ GetPageContextUpdaters func() []PageContextUpdater

+ GetPageProviders func() []PageProvider

+ GetPageRestrictionHandlers func() []PageRestrictionHandler

+ GetPageShortcodeProcessors func() []PageShortcodeProcessor

+ GetPageTypeProcessors func() []PageTypeProcessor

+ GetPanicHandler func() PanicHandler

+ GetPermissionsPolicyModifiers func() []PermissionsPolicyModifier

+ GetPrepareServePagesFeatures func() []PrepareServePagesFeature

+ GetProcessors func() []Processor

+ GetQueryIndexFeatures func() []QueryIndexFeature

+ GetRequestFilters func() []RequestFilter

+ GetRequestModifiers func() []RequestModifier

+ GetRequestRewriters func() []RequestRewriter

+ GetRoutePagesHandler func() RoutePagesHandler

+ GetServePagesHandler func() ServePagesHandler

+ GetServePathFeatures func() []ServePathFeature

+ GetServiceListener func() ServiceListener

+ GetServiceLogHandler func() ServiceLogHandler

+ GetServiceLoggers func() []ServiceLogger

+ GetTemplatePartialsProvider func() []TemplatePartialsProvider

+ GetThemeRenderers func() []ThemeRenderer

+ GetUseMiddlewares func() []UseMiddleware

+ GetUserActionsProviders func() []UserActionsProvider

+ HotReloading func() (enabled bool)

+ MakeLanguagePrinter func(requested string) (tag language.Tag, printer *message.Printer)

+ MakePageContextField func(key string, r *http.Request) (field *context.Field, ok bool)

+ MakePageContextFields func(r *http.Request) (fields context.Fields)

+ PageContextParsers func() (parsers context.Parsers)

+ PublicUserActions func() (actions Actions)

+ ReloadLocales func()

+ ValidateUserRequest func(action Action, w http.ResponseWriter, r *http.Request) (valid bool)

+ type KeyValueCache interface

+ AddBucket func(name string) (kvs KeyValueStore, err error)

+ Bucket func(name string) (kvs KeyValueStore, err error)

+ GetBucket func(name string) (kvs KeyValueStore, err error)

+ GetBucketSource func(name string) (src interface{})

+ ListBuckets func() (names []string)

+ MustBucket func(name string) (kvs KeyValueStore)

+ type KeyValueCaches interface

+ Get func(name string) (kvs KeyValueCache, err error)

+ type KeyValueStore interface

+ Delete func(key interface{}) (err error)

+ Get func(key interface{}) (value interface{}, err error)

+ Set func(key interface{}, value interface{}) (err error)

+ type KeyValueStoreAny interface

+ Get func(key interface{}) (value interface{}, ok bool)

+ Set func(key interface{}, value interface{})

+ type LocaleHandler interface

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

+ type LocalesProvider interface

+ AddLocales func(c beCatalog.Catalog)

+ type Manager interface

type MenuProvider

+ GetAllMenus func() (menus map[language.Tag]map[string]menu.Menu)

+ type MenuSupport struct

+ Area string

+ Key string

+ Name string

+ type MenuSupports []MenuSupport

+ func ParseMenuSupports(input interface{}) (supports MenuSupports)

+ func (m MenuSupports) Append(others MenuSupports) (merged MenuSupports)

+ func (m MenuSupports) Has(key string) (supported bool)

+ func (m MenuSupports) Keys() (keys []string)

+ type MessagePrinterFn func(printer *message.Printer) (text string)

+ type MountPoints []*CMountPoint

+ func (m MountPoints) Append(mountPoint *CMountPoint) (modified MountPoints)

+ func (m MountPoints) HasRWFS() (rw bool)

+ func (m MountPoints) Len() (count int)

+ type MountedPoints map[string]MountPoints

+ func (m MountedPoints) Exists(path string) (present bool)

+ func (m MountedPoints) FindPathPoints(path string) (mountPoints MountPoints)

+ func (m MountedPoints) FindRWPathPoint(path string) (readWrite *CMountPoint)

+ func (m MountedPoints) HasRWFS() (rw bool)

+ func (m MountedPoints) HasRootOrAllOf(mounts ...string) (present bool)

+ func (m MountedPoints) IsReadOnly(path string) (readOnly bool)

+ func (m MountedPoints) ListDirs(path string) (dirs []string)

+ func (m MountedPoints) ListFiles(path string) (files []string)

+ func (m MountedPoints) ListMounts() (mounts []string)

+ func (m MountedPoints) ReadFile(path string) (data []byte, err error)

+ func (m MountedPoints) RemoveFile(path string) (err error)

+ func (m MountedPoints) WriteFile(path string, data []byte) (err error)

+ type NjnFeature interface

+ NjnCheckClass func(tagClass NjnClass) (allow bool)

+ NjnCheckTag func(tagName string) (allow bool)

+ NjnClass func() (tagClass NjnClass)

+ NjnClassAllowed func() (allowed NjnClass, ok bool)

+ NjnTagsAllowed func() (allowed []string, ok bool)

+ NjnTagsDenied func() (denied []string, ok bool)

+ type Nonce struct

+ Key string

+ Name string

+ Value string

+ type NonceFactory interface

+ CreateNonce func(key string) (value string)

+ VerifyNonce func(key, value string) (valid bool)

+ type NonceFactoryFeature interface

+ type Nonces []Nonce

type Page

+ func ParseSignalArgv(argv []interface{}) (r *http.Request, pg Page, ctx, form beContext.Context, info *editor.File, ...)

+ type PageContextFieldsProvider interface

+ MakePageContextFields func(r *http.Request) (fields context.Fields)

+ type PageContextParsersProvider interface

+ PageContextParsers func() (fields context.Parsers)

+ type PageContextUpdater interface

+ UpdatePageContext func(pageCtx context.Context, r *http.Request) (additions context.Context)

+ type PageFileSystemFeature interface

+ AddIndexing func(filePath string)

+ RemoveIndexing func(filePath string)

type PageProvider

+ FindTranslationUrls func(url string) (pages map[language.Tag]string)

type PageTypeProcessor

+ PageTypeNames func() (names []string)

+ type Pages []Page

+ type PanicHandler interface

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

+ type PostStartupFeature interface

+ PostStartup func(ctx *cli.Context) (err error)

+ type PrepareServePagesFeature interface

+ PrepareServePage func(ctx context.Context, t Theme, p Page, w http.ResponseWriter, r *http.Request) (out context.Context, modified *http.Request, stop bool)

+ type SecretsProvider interface

+ GetUserSecret func(id string) (hash string)

+ type ServePagesHandler interface

+ ServePage func(p Page, t Theme, ctx context.Context, w http.ResponseWriter, r *http.Request) (err error)

type Service

+ FinalizeServeRequest func(w http.ResponseWriter, r *http.Request)

+ GetThemeName func() (name string)

+ GetThemeNamed func(name string) (t Theme, err error)

+ MustGetThemeNamed func(name string) (t Theme)

+ ServeForbidden func(w http.ResponseWriter, r *http.Request)

+ ServeRedirectHomePath func(w http.ResponseWriter, r *http.Request)

+ type Site interface

+ GetContext func(eid string) (ctx beContext.Context)

+ MustRequireVerification func(path string, w http.ResponseWriter, r *http.Request) (allowed bool)

+ PrepareAndServePage func(layout, pageType, pagePath string, t Theme, w http.ResponseWriter, ...) (err error)

+ PreparePage func(layout, pageType, pagePath string, t Theme, r *http.Request) (pg Page, ctx beContext.Context, err error)

+ PullNotices func(eid string) (notices UserNotices)

+ PushErrorNotice func(eid string, dismiss bool, message string, argv ...interface{})

+ PushImportantNotice func(eid string, dismiss bool, message string, argv ...interface{})

+ PushInfoNotice func(eid string, dismiss bool, message string, argv ...interface{})

+ PushNotices func(eid string, notices ...*UserNotice)

+ PushWarnNotice func(eid string, dismiss bool, message string, argv ...interface{})

+ RequireVerification func(path string, w http.ResponseWriter, r *http.Request) (allowed bool)

+ ServePreparedPage func(pg Page, ctx beContext.Context, t Theme, w http.ResponseWriter, ...)

+ SetContext func(eid string, ctx beContext.Context)

+ SiteAuth func() (sup SiteAuthFeature)

+ SiteFeatures func() (list SiteFeatures)

+ SiteMenu func(r *http.Request) (siteMenu beContext.Context)

+ SitePath func() (path string)

+ SiteTheme func() (t Theme)

+ SiteUsers func() (sup SiteUsersProvider)

+ type SiteAuthClaimsFactors []*CSiteAuthClaimsFactor

+ func ParseSiteAuthClaimsFactors(v interface{}) (p SiteAuthClaimsFactors, ok bool)

+ func (f SiteAuthClaimsFactors) Filter(provision string) (modified SiteAuthClaimsFactors)

+ func (f SiteAuthClaimsFactors) Find(provision string) (found *CSiteAuthClaimsFactor, ok bool)

+ func (f SiteAuthClaimsFactors) Len() (count int)

+ type SiteAuthFeature interface

+ AuthorizeUserSignIn func(w http.ResponseWriter, r *http.Request, claims *CSiteAuthClaims) (handled bool, modified *http.Request)

+ GenerateJWT func(claims *CSiteAuthClaims) (token string, err error)

+ GetSessionDuration func() (duration time.Duration)

+ GetSignUpsAllowed func() (allowed bool)

+ GetVerifiedDuration func() (duration time.Duration)

+ IsUserAllowed func(email string) (allowed bool)

+ MakeAuthClaims func(aud, email string, ctx context.Context) (claims *CSiteAuthClaims)

+ NumFactorsPresent func() (count int)

+ NumFactorsRequired func() (count int)

+ RequireVerification func(path string, w http.ResponseWriter, r *http.Request) (handled bool, redirect string)

+ ResetUserFactors func(r *http.Request, eid string) (err error)

+ ServeChallengeRequest func(w http.ResponseWriter, r *http.Request)

+ ServeSignInPage func(w http.ResponseWriter, r *http.Request)

+ ServeSignOutPage func(w http.ResponseWriter, r *http.Request)

+ ServeVerificationRequest func(verifyTarget string, w http.ResponseWriter, r *http.Request) (handled bool, redirect string)

+ Site func() Site

+ SiteAuthChallengePath func() (path string)

+ SiteAuthSignInPath func() (url string)

+ SiteAuthSignOutPath func() (url string)

+ SiteFeatureKey func() (name string)

+ SiteFeaturePath func() (path string)

+ SiteFeatureTheme func() (t Theme)

+ VerifyJWT func(r *http.Request) (claims *CSiteAuthClaims, err error)

+ type SiteAuthProvider interface

+ IsBackupProvider func() (backup bool)

+ SiteAuthLoginCallback func(w http.ResponseWriter, r *http.Request, saf SiteAuthFeature) (err error)

+ SiteAuthSignInHandler func(w http.ResponseWriter, r *http.Request, saf SiteAuthFeature) (claims *CSiteAuthClaims, redirect string, err error)

+ SiteAuthSignOutHandler func(w http.ResponseWriter, r *http.Request, saf SiteAuthFeature) (handled bool, redirect string, err error)

+ type SiteAuthRequestHandler interface

+ AuthenticateSiteRequest func(w http.ResponseWriter, r *http.Request) (handled bool, modified *http.Request)

+ FinalizeSiteRequest func(w http.ResponseWriter, r *http.Request) (modified *http.Request)

+ type SiteAuthSettingsPanel interface

+ SiteAuthSettingsPanel func(settingsPath string, saf SiteAuthFeature) (serve, handle http.HandlerFunc)

+ type SiteFeature interface

+ Action func(verb string, details ...string) (action Action)

+ RouteSiteFeature func(r chi.Router)

+ SetupSiteFeature func(s Site) (err error)

+ Site func() (s Site)

+ SiteFeatureIcon func() (icon string)

+ SiteFeatureInfo func(r *http.Request) (info *CSiteFeatureInfo)

+ SiteFeatureKey func() (name string)

+ SiteFeatureLabel func(printer *message.Printer) (label string)

+ SiteFeatureMenu func(r *http.Request) (m menu.Menu)

+ SiteFeaturePath func() (path string)

+ SiteFeatureTheme func() (t Theme)

+ SiteSettingsFields func(r *http.Request) (fields beContext.Fields)

+ SiteSettingsPanel func(settingsPath string) (serve, handle http.HandlerFunc)

+ type SiteFeatureLabelFn func(printer *message.Printer) (label string)

+ type SiteFeatures TypedFeatures[SiteFeature]

+ type SiteInfosLookup struct

+ func NewSiteInfosLookup[T interface{}]() (lookup *SiteInfosLookup[T])

+ func (l *SiteInfosLookup[T]) Get(key string) (info T)

+ func (l *SiteInfosLookup[T]) Keys() (keys []string)

+ func (l *SiteInfosLookup[T]) Len() (count int)

+ func (l *SiteInfosLookup[T]) Set(key string, info T)

+ type SiteMakeFeature interface

+ SetSiteFeatureIcon func(icon string) MakeTypedFeature

+ SetSiteFeatureKey func(key string) MakeTypedFeature

+ SetSiteFeatureLabel func(fn SiteFeatureLabelFn) MakeTypedFeature

+ SetSiteFeatureTheme func(name string) MakeTypedFeature

+ type SiteMultiFactorProvider interface

+ CurrentUserFactorsReady func(r *http.Request) (names []string)

+ CurrentUserFactorsReadyCount func(r *http.Request) (count int)

+ IsMultiFactorBackup func() (backup bool)

+ ProcessChallenge func(factor, challenge string, saf SiteAuthFeature, claims *CSiteAuthClaims, ...) (handled bool, redirect string)

+ ProcessSetupPage func(saf SiteAuthFeature, w http.ResponseWriter, r *http.Request) (handled bool)

+ ProcessVerification func(verifyTarget, factor, challenge string, saf SiteAuthFeature, ...) (handled bool, redirect string)

+ ResetUserFactors func(r *http.Request, eid string) (err error)

+ SetupSiteAuthProvider func(saf SiteAuthFeature)

+ SiteMultiFactorInfo func(r *http.Request) (info *CSiteAuthMultiFactorInfo)

+ SiteMultiFactorKey func() (key string)

+ SiteMultiFactorLabel func(printer *message.Printer) (label string)

+ VerifyClaimFactor func(claim *CSiteAuthClaimsFactor, saf SiteAuthFeature, r *http.Request) (verified bool)

+ type SiteRootFeature interface

+ SiteRootHandler func() (this http.Handler)

+ type SiteUserSetupStage interface

+ SiteUserSetupStageHandler func(saf SiteAuthFeature, w http.ResponseWriter, r *http.Request)

+ SiteUserSetupStageReady func(eid string, r *http.Request) (ready bool)

+ type SiteUsersProvider interface

+ CreateGroup func(r *http.Request, group Group, permissions ...Action) (err error)

+ CreateUser func(r *http.Request, origin, rid, eid, email string) (err error)

+ DeleteGroup func(r *http.Request, group Group) (err error)

+ DeleteUser func(r *http.Request, eid string) (err error)

+ GetUserActive func(r *http.Request, eid string) (active bool, err error)

+ GetUserAdminLocked func(r *http.Request, eid string) (locked bool, err error)

+ GetUserStatus func(r *http.Request, eid string) (active, locked, visitor bool, err error)

+ GroupPresent func(group Group) (present bool)

+ IsUserLocked func(r *http.Request, eid string) (locked bool)

+ ListUsers func(r *http.Request, pg, numPerPage int, sortDesc bool) (list []AuthUser, total int)

+ LockUser func(r *http.Request, eid string)

+ MakeEnjinID func(rid string) (eid string)

+ MakeRealID func(email string) (rid string)

+ RLockUser func(r *http.Request, eid string)

+ RUnlockUser func(r *http.Request, eid string)

+ RetrieveGroup func(r *http.Request, group Group) (permissions Actions, err error)

+ RetrieveUser func(r *http.Request, eid string) (user AuthUser, err error)

+ SetUserActive func(r *http.Request, eid string, active bool) (err error)

+ SetUserAdminLocked func(r *http.Request, eid string, active bool) (err error)

+ SetUserContext func(r *http.Request, eid string, ctx beContext.Context) (err error)

+ SetUserGroups func(r *http.Request, eid string, groups ...Group) (err error)

+ SetUserImage func(r *http.Request, eid string, image string) (err error)

+ SetUserName func(r *http.Request, eid string, name string) (err error)

+ SetUserPermissions func(r *http.Request, eid string, permissions ...Action) (err error)

+ SetUserSetting func(r *http.Request, eid string, key string, value interface{}) (err error)

+ SetUserSettings func(r *http.Request, eid string, ctx beContext.Context) (err error)

+ SignUpUser func(r *http.Request, claims *CSiteAuthClaims) (err error)

+ UnlockUser func(r *http.Request, eid string)

+ UpdateGroup func(r *http.Request, group Group, permissions ...Action) (err error)

+ UpdateUserActive func(r *http.Request, eid string, active bool) (err error)

+ UpdateUserAdminLocked func(r *http.Request, eid string, active bool) (err error)

+ UpdateUserContext func(r *http.Request, eid string, ctx beContext.Context) (err error)

+ UpdateUserGroups func(r *http.Request, eid string, groups ...Group) (err error)

+ UpdateUserImage func(r *http.Request, eid string, image string) (err error)

+ UpdateUserName func(r *http.Request, eid string, name string) (err error)

+ UpdateUserPermissions func(r *http.Request, eid string, permissions ...Action) (err error)

+ UserPresent func(eid string) (present bool)

+ type SyncLocker interface

+ IsLocked func() (locked bool)

+ Lock func(key string)

+ Unlock func(key string)

+ type SyncLockerFactory interface

+ NewSyncLocker func(tag Tag, key string, store KeyValueStore) (l SyncLocker)

+ NewSyncLockerWith func(tag Tag, key string, store KeyValueStore, timeout, interval time.Duration) (l SyncLocker)

+ NewSyncRWLocker func(tag Tag, key string, readStore, writeStore KeyValueStore) (l SyncRWLocker)

+ NewSyncRWLockerWith func(tag Tag, key string, readStore, writeStore KeyValueStore, ...) (l SyncRWLocker)

+ type SyncLockerFactoryFeature interface

+ type SyncRWLocker interface

+ RLock func(key string)

+ RUnlock func(key string)

type Tag

+ const EnjinLocalesTag

+ func (t Tag) Spaced() string

+ func (t Tag) SpacedCamel() string

type Tags

+ func (t Tags) Find(name string) (found Tag, ok bool)

type Theme

+ ListArchetypes func() (names []string)

+ MakeArchetype func(enjin Internals, name string) (format string, data []byte, err error)

+ ReadStaticFile func(path string) (data []byte, mime string, err error)

type ThemeConfig

+ Supports ThemeSupports

type ThemeLayout

+ Apply func(other ThemeLayout)

+ CacheKeys func() (keys []string)

+ CacheValue func(key string) (value string)

type ThemeLayouts

+ ListLayouts func() (names []string)

type ThemeRenderer

+ PrepareRenderPage func(t Theme, ctx context.Context, p Page) (data htmlTemplate.HTML, redirect string, err error)

+ type ThemeSupports struct

+ Archetypes map[string]context.Fields

+ Layouts []string

+ Locales []language.Tag

+ Menus MenuSupports

+ type TokenFactory interface

+ CreateToken func(key string) (value, shasum string)

+ CreateTokenWith func(key string, duration time.Duration) (value, shasum string)

+ VerifyToken func(key, value string) (valid bool)

+ type TokenFactoryFeature interface

+ type TypedFeatures []T

+ func (tf TypedFeatures[T]) AsFeatures() (features Features)

+ func (tf TypedFeatures[T]) Find(name string) (tag Tag)

+ func (tf TypedFeatures[T]) Get(tag Tag) (found T)

+ func (tf TypedFeatures[T]) Has(tag Tag) (present bool)

+ func (tf TypedFeatures[T]) Len() (count int)

+ func (tf TypedFeatures[T]) Tags() (tags Tags)

+ type UpdateSiteRoutesFeature interface

+ UpdateSiteRoutes func(r chi.Router)

+ type User interface

+ AsPage func() (pg Page)

+ FilteredContext func(includeKeys ...string) (ctx context.Context)

+ type UserActionsProvider interface

+ Action func(verb string, details ...string) (action Action)

+ UserActions func() (list Actions)

+ type UserManager interface

+ NewUser func(au AuthUser) (user User, err error)

+ RemoveUser func(eid string) (err error)

+ SetUser func(user User) (err error)

+ type UserNotice struct

+ Actions []UserNoticeLink

+ Content []string

+ Dismiss bool

+ Summary string

+ Type string

+ func MakeErrorNotice(dismiss bool, message string, argv ...interface{}) (notice *UserNotice)

+ func MakeImportantNotice(dismiss bool, message string, argv ...interface{}) (notice *UserNotice)

+ func MakeInfoNotice(dismiss bool, message string, argv ...interface{}) (notice *UserNotice)

+ func MakeWarnNotice(dismiss bool, message string, argv ...interface{}) (notice *UserNotice)

+ func NewNotice(key string, dismiss bool, summary string, actions ...UserNoticeLink) (notice *UserNotice)

+ type UserNoticeLink struct

+ Href string

+ Target string

+ Text string

+ type UserNotices []*UserNotice

+ func GetUserNotices(r *http.Request) (notices UserNotices)

+ type UserProvider interface

+ GetUser func(eid string) (user User, err error)

+ ListUsers func(start, page, numPerPage int) (list []string)

+ type UsersManager interface

v0.4.0

Aug 28, 2023

Changes in this version

+ func AnyStubsInStubs(src, tgt PageStubs) (found bool)

+ func RegisterPageMatcherFuncs(matchers ...MatcherFn)

+ type Action string

+ func NewAction(subject string, verb string, details ...string) Action

+ func ParseAction(line string) (action Action)

+ func (a Action) Details() (details []string)

+ func (a Action) String() string

+ func (a Action) Subject() string

+ func (a Action) Verb() string

+ type Actions []Action

+ func NewActionsFromStringNL(newlines string) (actions Actions)

+ func NewActionsFromStrings(slice ...string) (actions Actions)

+ func ParseActions(lines string) (actions Actions, err error)

+ func (a Actions) Append(actions ...Action) (modified Actions)

+ func (a Actions) AsNewlines() (newlines string)

+ func (a Actions) FilterKnown(other Actions) (known Actions)

+ func (a Actions) FilterUnknown(other Actions) (unknown Actions)

+ func (a Actions) Has(action Action) (present bool)

+ func (a Actions) HasSubject(subject string) (present bool)

+ func (a Actions) HasVerb(verb string) (present bool)

+ func (a Actions) Len() int

+ func (a Actions) String() (s string)

+ type Author struct

+ Homepage string

+ Name string

+ type BaseMakePreset interface

+ Include func(features ...Feature) MakeTypedPreset

+ OmitTags func(features ...Tag) MakeTypedPreset

+ Overload func(tag Tag, feature Feature) MakeTypedPreset

+ Prepend func(features ...Feature) MakeTypedPreset

type Buildable

+ RegisterPublicFileSystem func(mount string, filesystems ...fs.FileSystem)

+ RegisterTemplatePartial func(block, position, name, tmpl string) (err error)

type Builder

+ AddPreset func(presets ...Preset) Builder

+ PrependFeature func(f Feature) Builder

type CFeature

+ PackageTag Tag

+ func (f *CFeature) BaseTag() (pkg Tag)

+ func (f *CFeature) UsageNotes() (notes []string)

+ type CPreset struct

+ Features Features

+ Name string

+ func (p *CPreset[MakeTypedPreset]) Include(features ...Feature) MakeTypedPreset

+ func (p *CPreset[MakeTypedPreset]) IncludeFeature(b Builder, f Feature)

+ func (p *CPreset[MakeTypedPreset]) Init(this interface{})

+ func (p *CPreset[MakeTypedPreset]) Label() (name string)

+ func (p *CPreset[MakeTypedPreset]) Make() Preset

+ func (p *CPreset[MakeTypedPreset]) OmitTags(features ...Tag) MakeTypedPreset

+ func (p *CPreset[MakeTypedPreset]) Overload(tag Tag, feature Feature) MakeTypedPreset

+ func (p *CPreset[MakeTypedPreset]) Prepend(features ...Feature) MakeTypedPreset

+ func (p *CPreset[MakeTypedPreset]) Preset(b Builder) (err error)

+ type CacheEnjinFeature interface

+ Lookup func(bucket string, tag language.Tag, url string) (mount, path string, p Page, err error)

+ LookupPrefix func(bucket, prefix string) (found []Page)

+ LookupRedirect func(bucket, url string) (p Page, ok bool)

+ LookupTranslations func(bucket, url string) (pgs []Page)

+ Mount func(bucket, mount, path string, mfs fs.FileSystem)

+ Mounted func(bucket, path string) (ok bool)

+ NewCache func(bucket string) (err error)

+ Rebuild func(bucket string) (ok bool)

+ TotalCached func(bucket string) (count uint64)

+ type EnjinContextProvider interface

+ EnjinContext func() (ctx context.Context)

type Feature

+ BaseTag func() (pkg Tag)

+ UsageNotes func() (notes []string)

type FeaturesCache

+ func (c *FeaturesCache) Prepend(f Feature) (err error)

+ type FuncMap textTemplate.FuncMap

+ func (fm FuncMap) Apply(other FuncMap)

+ func (fm FuncMap) AsHTML() htmlTemplate.FuncMap

+ func (fm FuncMap) AsTEXT() textTemplate.FuncMap

+ type FuncMapProvider interface

+ MakeFuncMap func(ctx context.Context) (fm FuncMap)

type Internals

+ GetTemplatePartial func(block, position, name string) (tmpl string, ok bool)

+ ListTemplatePartials func(block, position string) (names []string)

+ MakeFuncMap func(ctx context.Context) (fm FuncMap)

+ PublicFileSystems func() (registry fs.Registry)

+ type KeywordProvider interface

+ KeywordStubs func(keyword string) (stubs PageStubs)

+ KnownKeywords func() (keywords []string)

+ Range func(fn func(key string, value []string) (proceed bool))

+ Size func() (count int)

+ type LoggerContext interface

+ Duration func() (duration time.Duration)

+ Request func() (r *http.Request)

+ Size func() (size int)

+ StatusCode func() (status int)

+ TimeStamp func() (when time.Time)

+ URL func() (parsed *url.URL)

+ type MakePreset interface

+ Make func() Preset

+ func NewPresetWith(name string, features ...Feature) MakePreset

+ type MatcherFn func(path string, pg Page) (found string, ok bool)

+ func GetPageMatcherFuncs() (funcs []MatcherFn)

+ type Page interface

+ Archetype func() (archetype string)

+ Content func() (content string)

+ Context func() (ctx beContext.Context)

+ Copy func() (copy Page)

+ CreatedAt func() (at time.Time)

+ DeletedAt func() (at sql.NullTime)

+ Description func() (description string)

+ Format func() (pageFormat string)

+ FrontMatter func() (frontMatter string)

+ FrontMatterType func() (frontMatterType matter.FrontMatterType)

+ HasTranslation func() (ok bool)

+ IsRedirection func(path string) (ok bool)

+ IsTranslation func(path string) (ok bool)

+ Language func() (code string)

+ LanguageTag func() (tag language.Tag)

+ Layout func() (layoutName string)

+ Match func(path string) (found string, ok bool)

+ MatchPrefix func(prefix string) (found string, ok bool)

+ MatchQL func(query string) (ok bool, err error)

+ PageMatter func() (pageMatter *matter.PageMatter)

+ Path func() (path string)

+ Permalink func() (id uuid.UUID)

+ PermalinkSha func() (shasum string)

+ Redirections func() (redirects []string)

+ Section func() (section string)

+ SetArchetype func(archetype string)

+ SetContent func(content string)

+ SetCreatedAt func(at time.Time)

+ SetDeletedAt func(at sql.NullTime)

+ SetDescription func(description string)

+ SetFormat func(pageFormat string) (path string)

+ SetFrontMatter func(frontMatter string)

+ SetFrontMatterType func(frontMatterType matter.FrontMatterType)

+ SetLanguage func(tag language.Tag)

+ SetLayout func(layoutName string)

+ SetPermalink func(value string) (err error)

+ SetSlugUrl func(url string)

+ SetSummary func(summary string)

+ SetTitle func(title string)

+ SetTranslates func(url string)

+ SetType func(pageType string)

+ SetUpdatedAt func(at time.Time)

+ Shasum func() (shasum string)

+ Slug func() (slug string)

+ String func() (jsonPage string)

+ Summary func() (summary string)

+ Title func() (title string)

+ Translates func() (url string)

+ Type func() (pageType string)

+ UpdatedAt func() (at time.Time)

+ Url func() (url string)

+ type PageContextProvider interface

+ FilterPageContextValueStubs func(include bool, key string, value interface{}) (stubs PageStubs)

+ FindPageStub func(shasum string) (stub *PageStub)

+ PageContextValueCounts func(key string) (counts map[interface{}]uint64)

+ PageContextValuesCount func(key string) (count uint64)

+ YieldFilterPageContextValueStubs func(include bool, key string, value interface{}) (pairs chan *ValueStubPair)

+ YieldPageContextValueStubs func(key string) (pairs chan *ValueStubPair)

+ YieldPageContextValues func(key string) (values chan interface{})

+ type PageFormat interface

+ Extensions func() (extensions []string)

+ IndexDocument func(pg Page) (doc interface{}, err error)

+ Label func() (label string)

+ Name func() (name string)

+ NewDocumentMapping func(tag language.Tag) (doctype, analyzer string, dm *mapping.DocumentMapping)

+ Prepare func(ctx context.Context, content string) (out context.Context, err error)

+ Process func(ctx context.Context, content string) (html template.HTML, redirect string, err error)

+ type PageFormatProvider interface

+ GetFormat func(name string) (format PageFormat)

+ ListFormats func() (names []string)

+ MatchFormat func(filename string) (format PageFormat, match string)

+ type PageIndexFeature interface

+ AddToIndex func(stub *PageStub, p Page) (err error)

+ RemoveFromIndex func(tag language.Tag, file, shasum string)

+ type PageShortcodeProcessor interface

+ TranslateShortcodes func(content string, ctx context.Context) (modified string)

+ type PageStub struct

+ EnjinCtx beContext.Context

+ FS fs.FileSystem

+ Fallback language.Tag

+ Language language.Tag

+ Origin string

+ Point string

+ Shasum string

+ Source string

+ func NewPageStub(origin string, enjin beContext.Context, bfs fs.FileSystem, ...) (s *PageStub)

+ func (ps *PageStub) GobDecode(data []byte) (err error)

+ func (ps *PageStub) GobEncode() (data []byte, err error)

+ func (ps *PageStub) MarshalBinary() (data []byte, err error)

+ func (ps *PageStub) UnmarshalBinary(data []byte) (err error)

+ type PageStubs []*PageStub

+ func (s PageStubs) GetShasum(shasum string) (found *PageStub)

+ func (s PageStubs) GetSource(source string) (found *PageStub)

+ func (s PageStubs) HasShasum(shasum string) (found bool)

+ func (s PageStubs) Random() (stub *PageStub)

+ type Preset interface

+ Label func() (name string)

+ Preset func(b Builder) (err error)

+ type QueryIndexFeature interface

+ PerformQuery func(input string) (stubs []*PageStub, err error)

+ PerformSelect func(input string) (selected map[string]interface{}, err error)

+ type RoutePagesHandler interface

+ RoutePage func(w http.ResponseWriter, r *http.Request)

+ type SearchDocumentMapperFeature interface

+ AddSearchDocumentMapping func(tag language.Tag, indexMapping *mapping.IndexMappingImpl)

+ SearchDocumentMapping func(tag language.Tag) (doctype string, dm *mapping.DocumentMapping)

+ type SearchEnjinFeature interface

+ AddToSearchIndex func(stub *PageStub, p Page) (err error)

+ PerformSearch func(tag language.Tag, input string, size, pg int) (results *bleve.SearchResult, err error)

+ PrepareSearch func(tag language.Tag, input string) (query string)

+ RemoveFromSearchIndex func(tag language.Tag, file, shasum string)

type Service

+ GetThemeRenderer func(ctx context.Context) (renderer ThemeRenderer)

+ TranslateShortcodes func(content string, ctx context.Context) (modified string)

+ type ServiceListener interface

+ ServiceInfo func() (scheme, listen string, port int)

+ StartListening func(router *chi.Mux, e EnjinRunner) (err error)

+ StopListening func() (err error)

+ type ServiceLogHandler interface

+ LogHandler func(next http.Handler) (this http.Handler)

+ type ServiceLogger interface

+ RequestLogger func(ctx LoggerContext) (err error)

+ type ServiceResponseLogger interface

+ Size func() int

+ Status func() int

+ type SiteEnjin interface

+ FindPage func(tag language.Tag, url string) (p Page)

+ FindPages func(prefix string) (pages []Page)

+ FindTranslations func(url string) (pages []Page)

+ SiteDefaultLanguage func() (tag language.Tag)

+ SiteLangCatalog func() (c *catalog.Catalog)

+ SiteLanguageCatalog func() (c catalog2.Catalog)

+ SiteLanguageDisplayName func(tag language.Tag) (name string, ok bool)

+ SiteLanguageMode func() (mode lang.Mode)

+ SiteLocales func() (locales []language.Tag)

+ SiteName func() (name string)

+ SiteSupportsLanguage func(tag language.Tag) (supported bool)

+ SiteTag func() (key string)

+ SiteTagLine func() (tagLine string)

+ type SiteInfo struct

+ DefaultLang language.Tag

+ LangMode lang.Mode

+ Locales []language.Tag

+ Name string

+ Tag string

+ TagLine string

+ func MakeSiteInfo(e SiteEnjin) (info SiteInfo)

type Tag

+ const EnjinTag

+ func (t Tag) Equal(other Tag) (same bool)

+ func (t Tag) IsNil() (empty bool)

+ type TemplatePartialsProvider interface

+ GetTemplatePartial func(block, position, name string) (tmpl string, ok bool)

+ ListTemplatePartials func(block, position string) (names []string)

+ RegisterTemplatePartial func(block, position, name, tmpl string) (err error)

+ type Theme interface

+ AddFormatProvider func(providers ...PageFormatProvider)

+ FindLayout func(named string) (layout ThemeLayout, name string, ok bool)

+ GetBlockThemeNames func() (names []string)

+ GetConfig func() (config ThemeConfig)

+ GetParent func() (parent Theme)

+ Layouts func() ThemeLayouts

+ Locales func() (locales fs.FileSystem, ok bool)

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

+ Name func() (name string)

+ NewHtmlTemplate func(enjin Internals, name string, ctx context.Context) (tmpl *htmlTemplate.Template, err error)

+ NewTextTemplate func(enjin Internals, name string, ctx context.Context) (tmpl *textTemplate.Template, err error)

+ Reload func() (err error)

+ StaticFS func() fs.FileSystem

+ ThemeFS func() fs.FileSystem

+ type ThemeConfig struct

+ Authors []Author

+ BlockStyles map[string][]htmlTemplate.CSS

+ BlockThemes map[string]map[string]interface{}

+ CacheControl string

+ ContentSecurityPolicy csp.ContentSecurityPolicyConfig

+ Context context.Context

+ Description string

+ Extends string

+ FontawesomeClasses []string

+ FontawesomeLinks map[string]string

+ Homepage string

+ License string

+ LicenseLink string

+ Name string

+ Parent string

+ PermissionsPolicy []permissions.Directive

+ RootStyles []htmlTemplate.CSS

+ type ThemeLayout interface

+ ApplyHtmlTemplate func(enjin Internals, tt *htmlTemplate.Template, ctx context.Context) (err error)

+ ApplyTextTemplate func(enjin Internals, tt *textTemplate.Template, ctx context.Context) (err error)

+ Name func() (name string)

+ NewHtmlTemplate func(enjin Internals, ctx context.Context) (tmpl *htmlTemplate.Template, err error)

+ NewHtmlTemplateFrom func(enjin Internals, parent ThemeLayout, ctx context.Context) (tmpl *htmlTemplate.Template, err error)

+ NewTextTemplate func(enjin Internals, ctx context.Context) (tmpl *textTemplate.Template, err error)

+ NewTextTemplateFrom func(enjin Internals, parent ThemeLayout, ctx context.Context) (tmpl *textTemplate.Template, err error)

+ type ThemeLayouts interface

+ ApplyHtmlTemplates func(enjin Internals, tmpl *htmlTemplate.Template, ctx context.Context) (err error)

+ ApplyTextTemplates func(enjin Internals, tmpl *textTemplate.Template, ctx context.Context) (err error)

+ GetLayout func(name string) (layout ThemeLayout)

+ NewHtmlTemplate func(enjin Internals, name string, ctx context.Context) (tmpl *htmlTemplate.Template, err error)

+ NewTextTemplate func(enjin Internals, name string, ctx context.Context) (tmpl *textTemplate.Template, err error)

+ SetLayout func(name string, layout ThemeLayout)

+ type ThemeRenderer interface

+ NewHtmlTemplateFromContext func(view string, ctx context.Context) (tt *htmlTemplate.Template, err error)

+ NewHtmlTemplateWith func(name string, ctx context.Context) (tt *htmlTemplate.Template, err error)

+ NewTextTemplateFromContext func(view string, ctx context.Context) (tt *textTemplate.Template, err error)

+ NewTextTemplateWith func(name string, ctx context.Context) (tt *textTemplate.Template, err error)

+ Render func(view string, ctx context.Context) (data []byte, err error)

+ RenderHtmlTemplateContent func(ctx context.Context, tmplContent string) (rendered string, err error)

+ RenderPage func(ctx context.Context, p Page) (data []byte, redirect string, err error)

+ RenderTextTemplateContent func(ctx context.Context, tmplContent string) (rendered string, err error)

+ type ValueStubPair struct

+ Stub *PageStub

+ Value interface{}

v0.2.16

Jul 27, 2023

v0.2.15

Jul 27, 2023

Changes in this version

+ func AsTyped(f Feature) (t T, ok bool)

+ func FilterTyped(list Features) (found []T)

+ func FirstTyped(list Features) (found T)

+ func MustTyped(f Feature) (t T)

type Features

+ func (f Features) Len() (count int)

+ type FeaturesCache struct

+ func NewFeaturesCache() (cache *FeaturesCache)

+ func (c *FeaturesCache) Add(f Feature) (err error)

+ func (c *FeaturesCache) Get(tag Tag) (f Feature, ok bool)

+ func (c *FeaturesCache) List() (list Features)

+ func (c *FeaturesCache) MustGet(tag Tag) (f Feature)

+ func (c *FeaturesCache) Tags() (list Tags)

type Tag

+ const NilTag

v0.2.14

Jul 24, 2023

v0.2.13

Jul 18, 2023

v0.2.12

Jul 18, 2023

Changes in this version

type Service

+ FindPageStub func(shasum string) (stub *fs.PageStub)

v0.2.11

Jul 17, 2023

v0.2.10

Jul 9, 2023

v0.2.9

Jul 8, 2023

v0.2.8

Jul 7, 2023

v0.2.7

Jul 6, 2023

v0.2.6

Jul 6, 2023

v0.2.5

Jul 6, 2023

Changes in this version

type CFeature

+ func (f *CFeature) CloneBaseFeature() (cloned CFeature)

v0.2.4

Jul 4, 2023

v0.2.3

Jul 4, 2023

v0.2.2

Jul 3, 2023

Changes in this version

type Service

+ Serve400 func(w http.ResponseWriter, r *http.Request)

+ ServeStatusJSON func(status int, v interface{}, w http.ResponseWriter, r *http.Request) (err error)

v0.2.1

May 22, 2023

Changes in this version

type Builder

+ AddUserAction func(actions ...userbase.Action) Builder

v0.2.0

May 21, 2023

Changes in this version

+ func FindAllTypedFeatures(haystack Features) (found []T)

+ func FindTypedFeatureByTag(needle Tag, haystack Features) (found T)

type Builder

+ SetPublicAccess func(actions ...userbase.Action) Builder

+ type Features []Feature

+ func (f Features) Find(tag Tag) (found Feature)

type Service

+ FindAllUserActions func() (list userbase.Actions)

+ GetPublicAccess func() (actions userbase.Actions)

+ ServeJSON func(v interface{}, w http.ResponseWriter, r *http.Request) (err error)

v0.1.3

May 14, 2023

v0.1.2

May 14, 2023

v0.1.1

May 13, 2023

v0.1.0

May 13, 2023

Changes in this version

+ type ApplyMiddleware interface

+ Apply func(s System) (err error)

type Builder

+ AddFeatureNotes func(tag Tag, notes ...string) Builder

type CFeature

+ Enjin Internals

+ FeatureTag Tag

+ type EmailProvider interface

+ MakeEmailBody func(path string, ctx beContext.Context) (matter beContext.Context, body string, err error)

+ NewEmail func(basename string, bodyCtx beContext.Context) (message *gomail.Message, err error)

+ type EmailSender interface

+ HasEmailAccount func(account string) (present bool)

+ SendEmail func(account string, message *gomail.Message) (err error)

type Feature

+ This func() (this interface{})

+ type FileProvider interface

+ FindFile func(url string) (data []byte, mime string, err error)

+ type ServePathFeature interface

+ ServePath func(path string, s System, w http.ResponseWriter, r *http.Request) (err error)

type Service

+ CheckMatchQL func(query string) (pages []*page.Page, err error)

+ CheckMatchStubsQL func(query string) (stubs []*matter.PageStub, err error)

+ CheckSelectQL func(query string) (selected map[string]interface{}, err error)

+ FindEmailAccount func(account string) (emailSender EmailSender)

+ FindFile func(path string) (data []byte, mime string, err error)

+ MustGetTheme func() (t *theme.Theme)

+ SendEmail func(account string, message *gomail.Message) (err error)

type Tag

+ func (t Tag) Camel() string

+ func (t Tag) Kebab() string

+ func (t Tag) ScreamingKebab() string

+ func (t Tag) ScreamingSnake() string

+ func (t Tag) Snake() string

type Tags

+ func SortedFeatureTags(data map[Tag]V) (tags Tags)

+ func StringsAsTags(names []string) (tags Tags)

+ func (t Tags) Strings() (names []string)

+ func (t Tags) Unique() (tags Tags)

+ type UseMiddleware interface

+ Use func(s System) MiddlewareFn

v0.0.1

Apr 29, 2023

Changes in this version

+ type Buildable interface

+ MakeEnvKey func(name string) (key string)

+ MakeEnvKeys func(names ...string) (key []string)

+ type Builder interface

+ AddCommands func(commands ...*cli.Command) Builder

+ AddConsole func(c Console) Builder

+ AddDomains func(domains ...string) Builder

+ AddFeature func(f Feature) Builder

+ AddFlags func(flags ...cli.Flag) Builder

+ AddHtmlHeadTag func(name string, attr map[string]string) Builder

+ AddLocalesEmbedFS func(path string, efs embed.FS) Builder

+ AddLocalesLocalFS func(path string) Builder

+ AddModifyHeadersFn func(fn headers.ModifyHeadersFn) Builder

+ AddNotifyHook func(name string, hook NotifyHook) Builder

+ AddOutputTranslator func(mime string, filter TranslateOutputFn) Builder

+ AddPageFromString func(path, raw string) Builder

+ AddRouteProcessor func(route string, processor ReqProcessFn) Builder

+ AddTheme func(t *theme.Theme) Builder

+ AddThemes func(path string) Builder

+ Build func() Runner

+ EmbedTheme func(name, path string, tfs embed.FS) Builder

+ EmbedThemes func(path string, fs embed.FS) Builder

+ HotReload func(enabled bool) Builder

+ Set func(key string, value interface{}) Builder

+ SetStatusPage func(status int, path string) Builder

+ SetTheme func(name string) Builder

+ SiteCopyrightName func(name string) Builder

+ SiteCopyrightNotice func(notice string) Builder

+ SiteDefaultLanguage func(tag language.Tag) Builder

+ SiteLanguageDisplayNames func(names map[language.Tag]string) Builder

+ SiteLanguageMode func(mode lang.Mode) Builder

+ SiteName func(name string) Builder

+ SiteSupportedLanguages func(tags ...language.Tag) Builder

+ SiteTag func(key string) Builder

+ SiteTagLine func(title string) Builder

+ type CConsole struct

+ func (c *CConsole) Build(b Buildable) (err error)

+ func (c *CConsole) Depends() (deps Tags)

+ func (c *CConsole) Init(this interface{})

+ func (c *CConsole) Make() Console

+ func (c *CConsole) Self() (self Console)

+ func (c *CConsole) Tag() (tag Tag)

+ func (c *CConsole) This() (this interface{})

+ type CEnjinBlock struct

+ type CEnjinFeature struct

+ func (f *CEnjinFeature) NjnCheckClass(tagClass NjnClass) (allow bool)

+ func (f *CEnjinFeature) NjnCheckTag(tagName string) (allow bool)

+ func (f *CEnjinFeature) NjnClassAllowed() (allowed NjnClass, ok bool)

+ func (f *CEnjinFeature) NjnTagsAllowed() (allowed []string, ok bool)

+ func (f *CEnjinFeature) NjnTagsDenied() (denied []string, ok bool)

+ type CEnjinField struct

+ type CFeature struct

+ func (f *CFeature) Build(b Buildable) (err error)

+ func (f *CFeature) Context() (ctx context.Context)

+ func (f *CFeature) Depends() (deps Tags)

+ func (f *CFeature) Init(this interface{})

+ func (f *CFeature) Make() Feature

+ func (f *CFeature) Self() (self Feature)

+ func (f *CFeature) Setup(enjin Internals)

+ func (f *CFeature) Shutdown()

+ func (f *CFeature) Startup(ctx *cli.Context) (err error)

+ func (f *CFeature) Tag() (tag Tag)

+ func (f *CFeature) This() (this interface{})

+ type CMiddleware struct

+ func (f *CMiddleware) Apply(s System) (err error)

+ func (f *CMiddleware) Middleware(next http.Handler) (this http.Handler)

+ func (f *CMiddleware) Serve(w http.ResponseWriter, r *http.Request) (err error)

+ func (f *CMiddleware) ServePath(path string, s System, w http.ResponseWriter, r *http.Request) (err error)

+ func (f *CMiddleware) Use(s System) MiddlewareFn

+ type CanSetupInternals interface

+ Setup func(enjin Internals)

+ type Console interface

+ Build func(c Buildable) (err error)

+ Depends func() (deps Tags)

+ Init func(this interface{})

+ Self func() (self Console)

+ Tag func() (tag Tag)

+ This func() (this interface{})

+ type ContentSecurityPolicyModifier interface

+ ModifyContentSecurityPolicy func(policy csp.Policy, r *http.Request) (modified csp.Policy)

+ type DataRestrictionHandler interface

+ RestrictServeData func(data []byte, mime string, w http.ResponseWriter, r *http.Request) (out *http.Request, allow bool)

+ type Database interface

+ DB func(tag string) (db interface{}, err error)

+ ListDB func() (tags []string)

+ MustDB func(tag string) (db interface{})

+ type EnjinBlock interface

+ NjnBlockType func() (name string)

+ PrepareBlock func(re EnjinRenderer, blockType string, data map[string]interface{}) (block map[string]interface{}, redirect string, err error)

+ ProcessBlock func(re EnjinRenderer, blockType string, data map[string]interface{}) (html template.HTML, redirect string, err error)

+ RenderPreparedBlock func(re EnjinRenderer, block map[string]interface{}) (html template.HTML, err error)

+ type EnjinFeature interface

+ NjnCheckClass func(tagClass NjnClass) (allow bool)

+ NjnCheckTag func(tagName string) (allow bool)

+ NjnClass func() (tagClass NjnClass)

+ NjnClassAllowed func() (allowed NjnClass, ok bool)

+ NjnTagsAllowed func() (allowed []string, ok bool)

+ NjnTagsDenied func() (denied []string, ok bool)

+ type EnjinField interface

+ NjnFieldNames func() (tagNames []string)

+ PrepareNjnData func(re EnjinRenderer, tagName string, field map[string]interface{}) (data map[string]interface{}, err error)

+ type EnjinRenderer interface

+ AddFootnote func(blockIndex int, field map[string]interface{}) (index int)

+ DecCurrentDepth func() (depth int)

+ DecHeadingLevel func()

+ GetBlockIndex func() (index int)

+ GetCurrentDepth func() (depth int)

+ GetData func() (data interface{})

+ GetHeadingCount func() (count int)

+ GetHeadingLevel func() (level int)

+ GetWithinAside func() (within bool)

+ IncCurrentDepth func() (depth int)

+ IncHeadingCount func()

+ IncHeadingLevel func()

+ ParseBlockHeadingLevel func(count, current int, blockData map[string]interface{}) (level, headingReset, headingLevel int)

+ ParseFieldAndTypeName func(data interface{}) (field map[string]interface{}, name string, ok bool)

+ ParseTypeName func(data map[string]interface{}) (name string, ok bool)

+ PrepareBlock func(data map[string]interface{}) (block map[string]interface{}, redirect string, err error)

+ PrepareBlockFooter func(content map[string]interface{}) (combined []interface{}, ok bool)

+ PrepareBlockHeader func(content map[string]interface{}) (combined []interface{}, ok bool)

+ PrepareContainerField func(field map[string]interface{}) (prepared map[string]interface{}, err error)

+ PrepareContainerFieldList func(list []interface{}) (fields []interface{}, err error)

+ PrepareContainerFieldText func(field map[string]interface{}) (fields []interface{}, err error)

+ PrepareContainerFields func(fields []interface{}) (combined []map[string]interface{}, err error)

+ PrepareFootnotes func(blockIndex int) (footnotes []map[string]interface{}, err error)

+ PrepareGenericBlock func(typeName string, data map[string]interface{}) (preparedData map[string]interface{})

+ PrepareGenericBlockData func(contentData interface{}) (blockDataContent map[string]interface{}, err error)

+ PrepareInlineField func(field map[string]interface{}) (prepared map[string]interface{}, err error)

+ PrepareInlineFieldList func(list []interface{}) (combined []interface{}, err error)

+ PrepareInlineFieldText func(field map[string]interface{}) (combined []interface{}, err error)

+ PrepareInlineFields func(fields []interface{}) (combined []interface{}, err error)

+ PrepareStringTags func(text string) (data []interface{}, err error)

+ ProcessBlock func(data map[string]interface{}) (html template.HTML, redirect string, err error)

+ RenderBlockFooter func(content map[string]interface{}) (html template.HTML, ok bool)

+ RenderBlockHeader func(content map[string]interface{}) (html template.HTML, ok bool)

+ RenderContainerField func(field map[string]interface{}) (combined []template.HTML, err error)

+ RenderContainerFieldList func(list []interface{}) (html template.HTML, err error)

+ RenderContainerFieldText func(field map[string]interface{}) (text template.HTML, err error)

+ RenderContainerFields func(fields []interface{}) (combined []template.HTML, err error)

+ RenderInlineField func(field map[string]interface{}) (combined []template.HTML, err error)

+ RenderInlineFieldList func(list []interface{}) (html template.HTML, err error)

+ RenderInlineFieldText func(field map[string]interface{}) (text template.HTML, err error)

+ RenderInlineFields func(fields []interface{}) (combined []template.HTML, err error)

+ RenderNjnTemplate func(tag string, data map[string]interface{}) (html template.HTML, err error)

+ RenderPreparedBlock func(block map[string]interface{}) (html template.HTML, err error)

+ RequestArgv func() (reqArgv *argv.RequestArgv)

+ RequestContext func() (ctx context.Context)

+ SetHeadingCount func(count int)

+ SetHeadingLevel func(level int)

+ SetWithinAside func(within bool)

+ WalkStringTags func(doc *html.Node) (prepared []interface{})

+ type EnjinRunner interface

+ Notify func(tag string)

+ NotifyF func(tag, format string, argv ...interface{})

+ Shutdown func()

+ StartupString func() (info string)

+ type EnjinSystem interface

+ ContainerBlocks func() (field map[string]EnjinBlock)

+ ContainerFields func() (field map[string]EnjinField)

+ FindBlock func(tagClass NjnClass, blockType string) (block EnjinBlock, ok bool)

+ FindField func(tagClass NjnClass, fieldType string) (field EnjinField, ok bool)

+ InlineBlocks func() (field map[string]EnjinBlock)

+ InlineFields func() (field map[string]EnjinField)

+ StringTags func() (names []string)

+ type Feature interface

+ Build func(c Buildable) (err error)

+ Context func() (ctx context.Context)

+ Depends func() (deps Tags)

+ Init func(this interface{})

+ Self func() (f Feature)

+ Setup func(enjin Internals)

+ Shutdown func()

+ Startup func(ctx *cli.Context) (err error)

+ Tag func() (tag Tag)

+ type HeadersModifier interface

+ ModifyHeaders func(w http.ResponseWriter, r *http.Request)

+ type Internals interface

+ Consoles func() (consoles map[Tag]Console)

+ DB func(tag string) (db interface{}, err error)

+ Domains func() (domains []string)

+ Features func() (features []Feature)

+ Headers func() (headers []headers.ModifyHeadersFn)

+ MustDB func(tag string) (db interface{})

+ MustSpecificDB func(fTag Tag, tag string) (db interface{})

+ Pages func() (pages map[string]*page.Page)

+ Processors func() (processors map[string]ReqProcessFn)

+ Self func() (self interface{})

+ Slugsums func() (enabled bool)

+ SpecificDB func(fTag Tag, tag string) (db interface{}, err error)

+ Theme func() (theme string)

+ Theming func() (theming map[string]*theme.Theme)

+ Transformers func() (transformers map[string]TransformOutputFn)

+ Translators func() (translators map[string]TranslateOutputFn)

+ type MakeConsole interface

+ Make func() Console

+ type MakeFeature interface

+ Make func() Feature

+ type MenuProvider interface

+ GetMenus func(tag language.Tag) (found map[string]menu.Menu)

+ type Middleware interface

+ Apply func(s System) (err error)

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

+ Serve func(w http.ResponseWriter, r *http.Request) (err error)

+ ServePath func(path string, s System, w http.ResponseWriter, r *http.Request) (err error)

+ Use func(s System) MiddlewareFn

+ type MiddlewareFn = func(next http.Handler) (this http.Handler)

+ type NjnClass uint

+ const AnyNjnClass

+ const ContainerNjnClass

+ const InlineNjnClass

+ func (nc NjnClass) String() string

+ type NotifyHook = func(format string, argv ...interface{})

+ type OutputTransformer interface

+ CanTransform func(mime string, r *http.Request) (ok bool)

+ TransformOutput func(mime string, input []byte) (output []byte)

+ type OutputTranslator interface

+ CanTranslate func(mime string) (ok bool)

+ TranslateOutput func(s Service, input []byte, inputMime string) (output []byte, mime string, err error)

+ type PageContextFilterFn = func(ctx context.Context, r *http.Request) (out context.Context)

+ type PageContextModifier interface

+ FilterPageContext func(themeCtx, pageCtx context.Context, r *http.Request) (themeOut context.Context)

+ type PageProvider interface

+ FindPage func(tag language.Tag, url string) (p *page.Page)

+ FindRedirection func(url string) (p *page.Page)

+ FindTranslations func(url string) (pages []*page.Page)

+ LookupPrefixed func(prefix string) (pages []*page.Page)

+ type PageRestrictionHandler interface

+ RestrictServePage func(ctx context.Context, w http.ResponseWriter, r *http.Request) (co context.Context, ro *http.Request, allow bool)

+ type PageTypeProcessor interface

+ ProcessRequestPageType func(r *http.Request, p *page.Page) (pg *page.Page, redirect string, processed bool, err error)

+ type PermissionsPolicyModifier interface

+ ModifyPermissionsPolicy func(policy permissions.Policy, r *http.Request) (modified permissions.Policy)

+ type Processor interface

+ Process func(s Service, next http.Handler, w http.ResponseWriter, r *http.Request)

+ type ReqProcessFn = func(s Service, w http.ResponseWriter, r *http.Request) (ok bool)

+ type RequestFilter interface

+ FilterRequest func(r *http.Request) (err error)

+ type RequestFilterFn = func(r *http.Request) (err error)

+ type RequestModifier interface

+ ModifyRequest func(w http.ResponseWriter, r *http.Request)

+ type RequestRewriter interface

+ RewriteRequest func(w http.ResponseWriter, r *http.Request) (modified *http.Request)

+ type RootInternals interface

+ SetupRootEnjin func(ctx *cli.Context) (err error)

+ type Runner interface

+ Run func(argv []string) (err error)

+ String func() string

+ type Service interface

+ ContentSecurityPolicy func() (handler *csp.PolicyHandler)

+ Context func() (ctx context.Context)

+ FindPage func(tag language.Tag, url string) (p *page.Page)

+ GetTheme func() (t *theme.Theme, err error)

+ MatchQL func(query string) (pages []*page.Page)

+ MatchStubsQL func(query string) (stubs []*pagecache.Stub)

+ Notify func(tag string)

+ NotifyF func(tag, format string, argv ...interface{})

+ PermissionsPolicy func() (handler *permissions.PolicyHandler)

+ Prefix func() (prefix string)

+ SelectQL func(query string) (selected map[string]interface{})

+ Serve204 func(w http.ResponseWriter, r *http.Request)

+ Serve401 func(w http.ResponseWriter, r *http.Request)

+ Serve403 func(w http.ResponseWriter, r *http.Request)

+ Serve404 func(w http.ResponseWriter, r *http.Request)

+ Serve405 func(w http.ResponseWriter, r *http.Request)

+ Serve500 func(w http.ResponseWriter, r *http.Request)

+ ServeBasic401 func(w http.ResponseWriter, r *http.Request)

+ ServeData func(data []byte, mime string, w http.ResponseWriter, r *http.Request)

+ ServeInternalServerError func(w http.ResponseWriter, r *http.Request)

+ ServeNotFound func(w http.ResponseWriter, r *http.Request)

+ ServePage func(p *page.Page, w http.ResponseWriter, r *http.Request) (err error)

+ ServePath func(urlPath string, w http.ResponseWriter, r *http.Request) (err error)

+ ServeRedirect func(destination string, w http.ResponseWriter, r *http.Request)

+ ServeStatusPage func(status int, w http.ResponseWriter, r *http.Request)

+ ServerName func() (name string)

+ ServiceInfo func() (listen string, port int)

+ ThemeNames func() (names []string)

+ type System interface

+ Router func() (router *chi.Mux)

+ type Tag string

+ const NotImplemented

+ func (t Tag) String() string

+ type Tags []Tag

+ func (t Tags) Append(tag Tag) Tags

+ func (t Tags) Has(tag Tag) bool

+ func (t Tags) Len() int

+ type TransformOutputFn = func(input []byte) (output []byte)

+ type TranslateOutputFn = func(input []byte) (output []byte, mime string)

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