mirror of
https://github.com/mattermost/mattermost.git
synced 2026-02-20 00:10:19 -05:00
580b546862
* MM-12193: remove auto configuration unmarshalling Since plugin hook events are called concurrently, there's no way for the plugin framework to coordinate safe access to the automatically unmarshalled configuration fields. Remove this functionality, and update documentation to illustrate a safe way to do this. * better Fprint example * fix unit tests * log when OnConfigurationChange fails through OnActivate * clarify lifecycle when OnConfigurationChange returns an error * call SetAPI even if OnConfigurationChange not implemented
41 lines
1.1 KiB
Go
41 lines
1.1 KiB
Go
// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
|
|
// See LICENSE.txt for license information.
|
|
|
|
package plugin
|
|
|
|
import (
|
|
"github.com/hashicorp/go-plugin"
|
|
)
|
|
|
|
// Starts the serving of a Mattermost plugin over net/rpc. gRPC is not yet supported.
|
|
//
|
|
// Call this when your plugin is ready to start.
|
|
func ClientMain(pluginImplementation interface{}) {
|
|
if impl, ok := pluginImplementation.(interface {
|
|
SetAPI(api API)
|
|
}); !ok {
|
|
panic("Plugin implementation given must embed plugin.MattermostPlugin")
|
|
} else {
|
|
impl.SetAPI(nil)
|
|
}
|
|
|
|
pluginMap := map[string]plugin.Plugin{
|
|
"hooks": &hooksPlugin{hooks: pluginImplementation},
|
|
}
|
|
|
|
plugin.Serve(&plugin.ServeConfig{
|
|
HandshakeConfig: handshake,
|
|
Plugins: pluginMap,
|
|
})
|
|
}
|
|
|
|
type MattermostPlugin struct {
|
|
// API exposes the plugin api, and becomes available just prior to the OnActive hook.
|
|
API API
|
|
}
|
|
|
|
// SetAPI persists the given API interface to the plugin. It is invoked just prior to the
|
|
// OnActivate hook, exposing the API for use by the plugin.
|
|
func (p *MattermostPlugin) SetAPI(api API) {
|
|
p.API = api
|
|
}
|