Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
C
caddy
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Łukasz Nowak
caddy
Commits
da674fd5
Commit
da674fd5
authored
Mar 28, 2017
by
Henrique Dias
Committed by
Matt Holt
Mar 27, 2017
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Introducing Event Hooks Plugins (#1537)
* add Hook * update hooks * remove parenthesis * Update requests
parent
4e1229e7
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
46 additions
and
33 deletions
+46
-33
caddy/caddymain/run.go
caddy/caddymain/run.go
+2
-5
plugins.go
plugins.go
+41
-28
sigtrap.go
sigtrap.go
+3
-0
No files found.
caddy/caddymain/run.go
View file @
da674fd5
...
@@ -100,11 +100,8 @@ func Run() {
...
@@ -100,11 +100,8 @@ func Run() {
mustLogFatalf
(
"%v"
,
err
)
mustLogFatalf
(
"%v"
,
err
)
}
}
// Execute plugins that are registered to run as the process starts
// Executes Startup events
err
=
caddy
.
StartupHooks
(
serverType
)
caddy
.
EmitEvent
(
caddy
.
StartupEvent
)
if
err
!=
nil
{
mustLogFatalf
(
"%v"
,
err
)
}
// Get Caddyfile input
// Get Caddyfile input
caddyfileinput
,
err
:=
caddy
.
LoadCaddyfile
(
serverType
)
caddyfileinput
,
err
:=
caddy
.
LoadCaddyfile
(
serverType
)
...
...
plugins.go
View file @
da674fd5
...
@@ -2,6 +2,7 @@ package caddy
...
@@ -2,6 +2,7 @@ package caddy
import
(
import
(
"fmt"
"fmt"
"log"
"net"
"net"
"sort"
"sort"
...
@@ -21,6 +22,10 @@ var (
...
@@ -21,6 +22,10 @@ var (
// must have a name.
// must have a name.
plugins
=
make
(
map
[
string
]
map
[
string
]
Plugin
)
plugins
=
make
(
map
[
string
]
map
[
string
]
Plugin
)
// eventHooks is a map of hook name to Hook. All hooks plugins
// must have a name.
eventHooks
=
make
(
map
[
string
]
EventHook
)
// parsingCallbacks maps server type to map of directive
// parsingCallbacks maps server type to map of directive
// to list of callback functions. These aren't really
// to list of callback functions. These aren't really
// plugins on their own, but are often registered from
// plugins on their own, but are often registered from
...
@@ -69,30 +74,6 @@ func DescribePlugins() string {
...
@@ -69,30 +74,6 @@ func DescribePlugins() string {
return
str
return
str
}
}
// StartupHooks executes the startup hooks defined when the
// plugins were registered and returns the first error
// it encounters.
func
StartupHooks
(
serverType
string
)
error
{
for
stype
,
stypePlugins
:=
range
plugins
{
if
stype
!=
""
&&
stype
!=
serverType
{
continue
}
for
name
:=
range
stypePlugins
{
if
stypePlugins
[
name
]
.
StartupHook
==
nil
{
continue
}
err
:=
stypePlugins
[
name
]
.
StartupHook
()
if
err
!=
nil
{
return
err
}
}
}
return
nil
}
// ValidDirectives returns the list of all directives that are
// ValidDirectives returns the list of all directives that are
// recognized for the server type serverType. However, not all
// recognized for the server type serverType. However, not all
// directives may be installed. This makes it possible to give
// directives may be installed. This makes it possible to give
...
@@ -200,10 +181,6 @@ type Plugin struct {
...
@@ -200,10 +181,6 @@ type Plugin struct {
// Action is the plugin's setup function, if associated
// Action is the plugin's setup function, if associated
// with a directive in the Caddyfile.
// with a directive in the Caddyfile.
Action
SetupFunc
Action
SetupFunc
// StartupHook is the plugin's function that is executed
// immediately after the flag parsing.
StartupHook
func
()
error
}
}
// RegisterPlugin plugs in plugin. All plugins should register
// RegisterPlugin plugs in plugin. All plugins should register
...
@@ -228,6 +205,42 @@ func RegisterPlugin(name string, plugin Plugin) {
...
@@ -228,6 +205,42 @@ func RegisterPlugin(name string, plugin Plugin) {
plugins
[
plugin
.
ServerType
][
name
]
=
plugin
plugins
[
plugin
.
ServerType
][
name
]
=
plugin
}
}
// EventName represents the name of an event used with event hooks.
type
EventName
string
const
(
StartupEvent
EventName
=
"startup"
ShutdownEvent
EventName
=
"shutdown"
)
// EventHook is a type which holds information about a startup hook plugin.
type
EventHook
func
(
eventType
EventName
)
error
// RegisterEventHook plugs in hook. All the hooks should register themselves
// and they must have a name.
func
RegisterEventHook
(
name
string
,
hook
EventHook
)
{
if
name
==
""
{
panic
(
"event hook must have a name"
)
}
if
_
,
dup
:=
eventHooks
[
name
];
dup
{
panic
(
"hook named "
+
name
+
" already registered"
)
}
eventHooks
[
name
]
=
hook
}
// EmitEvent executes the different hooks passing the EventType as an
// argument. This is a blocking function. Hook developers should
// use 'go' keyword if they don't want to block Caddy.
func
EmitEvent
(
event
EventName
)
{
for
name
,
hook
:=
range
eventHooks
{
err
:=
hook
(
event
)
if
err
!=
nil
{
log
.
Printf
(
"error on '%s' hook: %v"
,
name
,
err
)
}
}
}
// ParsingCallback is a function that is called after
// ParsingCallback is a function that is called after
// a directive's setup functions have been executed
// a directive's setup functions have been executed
// for all the server blocks.
// for all the server blocks.
...
...
sigtrap.go
View file @
da674fd5
...
@@ -52,6 +52,9 @@ func trapSignalsCrossPlatform() {
...
@@ -52,6 +52,9 @@ func trapSignalsCrossPlatform() {
// This function is idempotent; subsequent invocations always return 0.
// This function is idempotent; subsequent invocations always return 0.
func
executeShutdownCallbacks
(
signame
string
)
(
exitCode
int
)
{
func
executeShutdownCallbacks
(
signame
string
)
(
exitCode
int
)
{
shutdownCallbacksOnce
.
Do
(
func
()
{
shutdownCallbacksOnce
.
Do
(
func
()
{
// execute third-party shutdown hooks
EmitEvent
(
ShutdownEvent
)
errs
:=
allShutdownCallbacks
()
errs
:=
allShutdownCallbacks
()
if
len
(
errs
)
>
0
{
if
len
(
errs
)
>
0
{
for
_
,
err
:=
range
errs
{
for
_
,
err
:=
range
errs
{
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment