-
Notifications
You must be signed in to change notification settings - Fork 173
/
options.go
258 lines (215 loc) · 6.13 KB
/
options.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
245
246
247
248
249
250
251
252
253
254
255
256
257
258
/*
* Copyright (c) 2019-2022. Abstrium SAS <team (at) pydio.com>
* This file is part of Pydio Cells.
*
* Pydio Cells is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Pydio Cells is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with Pydio Cells. If not, see <http://www.gnu.org/licenses/>.
*
* The latest code can be found at <https://pydio.com>.
*/
package service
import (
"context"
"crypto/tls"
"github.com/pydio/cells/v4/common"
"github.com/pydio/cells/v4/common/log"
"github.com/pydio/cells/v4/common/registry"
"github.com/pydio/cells/v4/common/server"
servicecontext "github.com/pydio/cells/v4/common/service/context"
"github.com/pydio/cells/v4/common/service/frontend"
"github.com/pydio/cells/v4/common/utils/uuid"
)
// ServiceOptions stores all options for a pydio service
type ServiceOptions struct {
Name string `json:"name"`
ID string `json:"id"`
Tags []string `json:"tags"`
Version string `json:"version"`
Description string `json:"description"`
Source string `json:"source"`
Metadata map[string]string `json:"metadata"`
rootContext context.Context
runtimeCtx context.Context
runtimeCancel context.CancelFunc
Migrations []*Migration `json:"-"`
// Port string
TLSConfig *tls.Config
customScheme string
Server server.Server `json:"-"`
serverType server.Type
serverStart func(context.Context) error
serverStop func(context.Context) error
// Starting options
ForceRegister bool `json:"-"`
AutoStart bool `json:"-"`
AutoRestart bool `json:"-"`
Fork bool `json:"-"`
Unique bool `json:"-"`
// Before and After funcs
BeforeStart []func(context.Context) (context.Context, error) `json:"-"`
BeforeStop []func(context.Context) error `json:"-"`
AfterServe []func(context.Context) error `json:"-"`
UseWebSession bool `json:"-"`
WebSessionExcludes []string `json:"-"`
Storages []*StorageOptions `json:"-"`
localLogger log.ZapLogger
}
// ServiceOption provides a functional option
type ServiceOption func(*ServiceOptions)
// RootContext returns root context
func (o *ServiceOptions) RootContext() context.Context {
return o.rootContext
}
// Logger returns a local logger
func (o *ServiceOptions) Logger() log.ZapLogger {
if o.localLogger == nil {
o.localLogger = log.Logger(o.rootContext)
}
return o.localLogger
}
// GetRegistry returns the context registry
func (o *ServiceOptions) GetRegistry() registry.Registry {
return servicecontext.GetRegistry(o.rootContext)
}
// SetRegistry sets the registry in the root context
func (o *ServiceOptions) SetRegistry(r registry.Registry) {
o.rootContext = servicecontext.WithRegistry(o.rootContext, r)
}
// ID option for a service
func ID(n string) ServiceOption {
return func(o *ServiceOptions) {
o.ID = n
}
}
// Name option for a service
func Name(n string) ServiceOption {
return func(o *ServiceOptions) {
o.Name = n
}
}
// Tag option for a service
func Tag(t ...string) ServiceOption {
return func(o *ServiceOptions) {
o.Tags = append(o.Tags, t...)
}
}
// Description option for a service
func Description(d string) ServiceOption {
return func(o *ServiceOptions) {
o.Description = d
}
}
// Source option for a service
func Source(s string) ServiceOption {
return func(o *ServiceOptions) {
o.Source = s
}
}
// Context option for a service
func Context(c context.Context) ServiceOption {
return func(o *ServiceOptions) {
o.rootContext = c
}
}
// WithTLSConfig option for a service
func WithTLSConfig(c *tls.Config) ServiceOption {
return func(o *ServiceOptions) {
o.TLSConfig = c
}
}
// WithServer directly presets the server.Server instance
func WithServer(s server.Server) ServiceOption {
return func(o *ServiceOptions) {
o.Server = s
}
}
func WithServerScheme(scheme string) ServiceOption {
return func(o *ServiceOptions) {
o.customScheme = scheme
}
}
// ForceRegister option for a service
func ForceRegister(b bool) ServiceOption {
return func(o *ServiceOptions) {
o.ForceRegister = b
}
}
// AutoStart option for a service
func AutoStart(b bool) ServiceOption {
return func(o *ServiceOptions) {
o.AutoStart = b
}
}
// AutoRestart option for a service
func AutoRestart(b bool) ServiceOption {
return func(o *ServiceOptions) {
o.AutoRestart = b
}
}
// AfterServe registers a callback that is run after Server is finally started (non-blocking)
func AfterServe(f func(ctx context.Context) error) ServiceOption {
return func(o *ServiceOptions) {
o.AfterServe = append(o.AfterServe, f)
}
}
// Fork option for a service
func Fork(f bool) ServiceOption {
return func(o *ServiceOptions) {
o.Fork = f
}
}
// Unique option for a service
func Unique(b bool) ServiceOption {
return func(o *ServiceOptions) {
o.Unique = b
}
}
// Migrations option for a service
func Migrations(migrations []*Migration) ServiceOption {
return func(o *ServiceOptions) {
o.Migrations = migrations
}
}
// Metadata registers a key/value metadata
func Metadata(name, value string) ServiceOption {
return func(o *ServiceOptions) {
o.Metadata[name] = value
}
}
// PluginBoxes option for a service
func PluginBoxes(boxes ...frontend.PluginBox) ServiceOption {
return func(o *ServiceOptions) {
frontend.RegisterPluginBoxes(boxes...)
}
}
func WithWebSession(excludes ...string) ServiceOption {
return func(o *ServiceOptions) {
o.UseWebSession = true
o.WebSessionExcludes = excludes
}
}
func newOptions(opts ...ServiceOption) *ServiceOptions {
opt := &ServiceOptions{}
opt.ID = uuid.New()
opt.Metadata = make(map[string]string)
opt.Version = common.Version().String()
opt.AutoStart = true
opt.rootContext = context.TODO()
for _, o := range opts {
if o == nil {
continue
}
o(opt)
}
return opt
}