-
Notifications
You must be signed in to change notification settings - Fork 0
/
system.go
244 lines (198 loc) · 8.3 KB
/
system.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
// Copyright (c) 2022 The Go-Enjin Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package feature
import (
"net/http"
"github.com/Shopify/gomail"
"github.com/go-chi/chi/v5"
"github.com/urfave/cli/v2"
cllang "github.com/go-corelibs/lang"
"github.com/go-corelibs/x-text/language"
"github.com/go-corelibs/x-text/message"
"github.com/go-corelibs/x-text/message/catalog"
"github.com/go-enjin/be/pkg/context"
"github.com/go-enjin/be/pkg/feature/signaling"
"github.com/go-enjin/be/pkg/fs"
"github.com/go-enjin/be/pkg/lang"
"github.com/go-enjin/be/pkg/net/headers"
"github.com/go-enjin/be/pkg/net/headers/policy/csp"
"github.com/go-enjin/be/pkg/net/headers/policy/permissions"
)
type EnjinBase interface {
SiteTag() (key string)
SiteName() (name string)
SiteTagLine() (tagLine string)
SiteCopyrightName() (name string)
SiteCopyrightYear() (year string)
SiteCopyrightNotice() (notice string)
SiteLocales() (locales cllang.Tags)
SiteLanguageMode() (mode lang.Mode)
SiteLanguageCatalog() (c catalog.Catalog)
SiteDefaultLanguage() (tag language.Tag)
SiteSupportsLanguage(tag language.Tag) (supported bool)
SiteLanguageDisplayName(tag language.Tag) (name string, ok bool)
FindTranslations(url string) (pages Pages)
FindTranslationUrls(url string) (pages map[language.Tag]string)
FindPage(r *http.Request, tag language.Tag, url string) (p Page)
FindPages(prefix string) (pages []Page)
}
type Service interface {
Prefix() (prefix string)
Context(r *http.Request) (ctx context.Context)
GetTheme() (t Theme, err error)
MustGetTheme() (t Theme)
ThemeNames() (names []string)
GetThemeName() (name string)
GetThemeNamed(name string) (t Theme, err error)
MustGetThemeNamed(name string) (t Theme)
ServerName() (name string)
ServiceInfo() (scheme, listen string, port int)
PermissionsPolicy() (handler *permissions.PolicyHandler)
ContentSecurityPolicy() (handler *csp.PolicyHandler)
FinalizeServeRequest(w http.ResponseWriter, r *http.Request) (modified *http.Request)
ServeRedirect(destination string, w http.ResponseWriter, r *http.Request)
ServeRedirectHomePath(w http.ResponseWriter, r *http.Request)
Serve204(w http.ResponseWriter, r *http.Request)
Serve400(w http.ResponseWriter, r *http.Request)
Serve401(w http.ResponseWriter, r *http.Request)
ServeBasic401(w http.ResponseWriter, r *http.Request)
Serve403(w http.ResponseWriter, r *http.Request)
Serve404(w http.ResponseWriter, r *http.Request)
Serve405(w http.ResponseWriter, r *http.Request)
Serve500(w http.ResponseWriter, r *http.Request)
ServeNotFound(w http.ResponseWriter, r *http.Request)
ServeForbidden(w http.ResponseWriter, r *http.Request)
ServeInternalServerError(w http.ResponseWriter, r *http.Request)
ServeStatusPage(status int, w http.ResponseWriter, r *http.Request)
ServePage(p Page, w http.ResponseWriter, r *http.Request) (err error)
ServePath(urlPath string, w http.ResponseWriter, r *http.Request) (err error)
ServeJSON(v interface{}, w http.ResponseWriter, r *http.Request) (err error)
ServeStatusJSON(status int, v interface{}, w http.ResponseWriter, r *http.Request) (err error)
ServeData(data []byte, mime string, w http.ResponseWriter, r *http.Request)
MatchQL(query string) (pages []Page)
MatchStubsQL(query string) (stubs []*PageStub)
SelectQL(query string) (selected map[string]interface{})
CheckMatchQL(query string) (pages []Page, err error)
CheckMatchStubsQL(query string) (stubs []*PageStub, err error)
CheckSelectQL(query string) (selected map[string]interface{}, err error)
FindPageStub(shasum string) (stub *PageStub)
FindPage(r *http.Request, tag language.Tag, url string) (p Page)
FindFile(path string) (data []byte, mime string, err error)
FindEmailAccount(account string) (emailSender EmailSender)
SendEmail(r *http.Request, account string, message *gomail.Message) (err error)
GetPublicAccess() (actions Actions)
FindAllUserActions() (list Actions)
NonceFactory
TokenFactory
SyncLockerFactory
Notify(tag string)
NotifyF(tag, format string, argv ...interface{})
TranslateShortcodes(content string, ctx context.Context) (modified string)
GetThemeRenderer(ctx context.Context) (renderer ThemeRenderer)
signaling.EmitterSupport
}
type System interface {
Service
signaling.Signaling
Router() (router *chi.Mux)
}
type RootInternals interface {
Internals
SetupRootEnjin(ctx *cli.Context) (err error)
}
type Internals interface {
Service
signaling.Signaling
EnjinBase
Self() (self interface{})
Features() (cache *FeaturesCache)
Pages() (pages map[string]Page)
Theme() (theme string)
Theming() (theming map[string]Theme)
Headers() (headers []headers.ModifyHeadersFn)
Domains() (domains []string)
Consoles() (consoles map[Tag]Console)
Processors() (processors map[string]ReqProcessFn)
Translators() (translators map[string]TranslateOutputFn)
Transformers() (transformers map[string]TransformOutputFn)
Slugsums() (enabled bool)
ReloadLocales()
HotReloading() (enabled bool)
DB(tag string) (db interface{}, err error)
MustDB(tag string) (db interface{})
SpecificDB(fTag Tag, tag string) (db interface{}, err error)
MustSpecificDB(fTag Tag, tag string) (db interface{})
MakeFuncMap(ctx context.Context) (fm FuncMap)
PublicFileSystems() (registry fs.Registry)
ListTemplatePartials(block, position string) (names []string)
GetTemplatePartial(block, position, name string) (tmpl string, ok bool)
MakeLanguagePrinter(requested string) (tag language.Tag, printer *message.Printer)
PublicUserActions() (actions Actions)
ValidateUserRequest(action Action, w http.ResponseWriter, r *http.Request) (valid bool)
PageContextParsers() (parsers context.Parsers)
MakePageContextField(key string, r *http.Request) (field *context.Field, ok bool)
MakePageContextFields(r *http.Request) (fields context.Fields)
ApplyPageContextUpdaters(r *http.Request, pages ...Page)
GetFormatProviders() []PageFormatProvider
GetRequestFilters() []RequestFilter
GetPageContextModifiers() []PageContextModifier
GetPageContextUpdaters() []PageContextUpdater
GetPageRestrictionHandlers() []PageRestrictionHandler
GetMenuProviders() []MenuProvider
GetDataRestrictionHandlers() []DataRestrictionHandler
GetOutputTranslators() []OutputTranslator
GetOutputTransformers() []OutputTransformer
GetPageTypeProcessors() []PageTypeProcessor
GetServePathFeatures() []ServePathFeature
GetDatabases() []Database
GetEmailSenders() []EmailSender
GetRequestModifiers() []RequestModifier
GetRequestRewriters() []RequestRewriter
GetPermissionsPolicyModifiers() []PermissionsPolicyModifier
GetContentSecurityPolicyModifiers() []ContentSecurityPolicyModifier
GetUseMiddlewares() []UseMiddleware
GetHeadersModifiers() []HeadersModifier
GetProcessors() []Processor
GetApplyMiddlewares() []ApplyMiddleware
GetPageProviders() []PageProvider
GetFileProviders() []FileProvider
GetQueryIndexFeatures() []QueryIndexFeature
GetPageContextProviders() []PageContextProvider
GetAuthProviders() []AuthProvider
GetUserActionsProviders() []UserActionsProvider
GetEnjinContextProvider() []EnjinContextProvider
GetPageShortcodeProcessors() []PageShortcodeProcessor
GetFuncMapProviders() []FuncMapProvider
GetTemplatePartialsProvider() []TemplatePartialsProvider
GetThemeRenderers() []ThemeRenderer
GetServiceLoggers() []ServiceLogger
GetLocalesProviders() []LocalesProvider
GetPrepareServePagesFeatures() []PrepareServePagesFeature
GetFinalizeServePagesFeatures() []FinalizeServeRequestFeature
GetPageContextFieldsProviders() []PageContextFieldsProvider
GetPageContextParsersProviders() []PageContextParsersProvider
GetPanicHandler() PanicHandler
GetLocaleHandler() LocaleHandler
GetServiceListener() ServiceListener
GetRoutePagesHandler() RoutePagesHandler
GetServePagesHandler() ServePagesHandler
GetServiceLogHandler() ServiceLogHandler
}
type CanSetupInternals interface {
Setup(enjin Internals)
}
type HotReloadableFeature interface {
Feature
HotReload() (err error)
}