a850704afe
* Move pluginCommands into Channels We move pluginCommands, pluginCommandsLock into Channels. We also move the plugin related route handlers under Channels and move the init code under NewChannels. To achieve this, the router initialization is bumped up. Along with it, we clean up some App methods which were just wrappers over Channel methods. Instead, we call the Channel method directly to make things more readable and easy to understand. ```release-note NONE ``` * fix tests ```release-note NONE ```
464 строки
14 KiB
Go
464 строки
14 KiB
Go
// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
|
|
// See LICENSE.txt for license information.
|
|
|
|
// EXPERIMENTAL - SUBJECT TO CHANGE
|
|
|
|
package api4
|
|
|
|
import (
|
|
"bytes"
|
|
"encoding/json"
|
|
"io"
|
|
"net/http"
|
|
"net/url"
|
|
"strconv"
|
|
|
|
"github.com/mattermost/mattermost-server/v6/audit"
|
|
"github.com/mattermost/mattermost-server/v6/model"
|
|
"github.com/mattermost/mattermost-server/v6/shared/mlog"
|
|
"github.com/mattermost/mattermost-server/v6/store"
|
|
"github.com/pkg/errors"
|
|
)
|
|
|
|
const (
|
|
MaximumPluginFileSize = 50 * 1024 * 1024
|
|
)
|
|
|
|
func (api *API) InitPlugin() {
|
|
mlog.Debug("EXPERIMENTAL: Initializing plugin api")
|
|
|
|
api.BaseRoutes.Plugins.Handle("", api.APISessionRequired(uploadPlugin)).Methods("POST")
|
|
api.BaseRoutes.Plugins.Handle("", api.APISessionRequired(getPlugins)).Methods("GET")
|
|
api.BaseRoutes.Plugin.Handle("", api.APISessionRequired(removePlugin)).Methods("DELETE")
|
|
api.BaseRoutes.Plugins.Handle("/install_from_url", api.APISessionRequired(installPluginFromURL)).Methods("POST")
|
|
api.BaseRoutes.Plugins.Handle("/marketplace", api.APISessionRequired(installMarketplacePlugin)).Methods("POST")
|
|
|
|
api.BaseRoutes.Plugins.Handle("/statuses", api.APISessionRequired(getPluginStatuses)).Methods("GET")
|
|
api.BaseRoutes.Plugin.Handle("/enable", api.APISessionRequired(enablePlugin)).Methods("POST")
|
|
api.BaseRoutes.Plugin.Handle("/disable", api.APISessionRequired(disablePlugin)).Methods("POST")
|
|
|
|
api.BaseRoutes.Plugins.Handle("/webapp", api.APIHandler(getWebappPlugins)).Methods("GET")
|
|
|
|
api.BaseRoutes.Plugins.Handle("/marketplace", api.APISessionRequired(getMarketplacePlugins)).Methods("GET")
|
|
|
|
api.BaseRoutes.Plugins.Handle("/marketplace/first_admin_visit", api.APIHandler(setFirstAdminVisitMarketplaceStatus)).Methods("POST")
|
|
api.BaseRoutes.Plugins.Handle("/marketplace/first_admin_visit", api.APISessionRequired(getFirstAdminVisitMarketplaceStatus)).Methods("GET")
|
|
}
|
|
|
|
func uploadPlugin(c *Context, w http.ResponseWriter, r *http.Request) {
|
|
config := c.App.Config()
|
|
if !*config.PluginSettings.Enable || !*config.PluginSettings.EnableUploads || *config.PluginSettings.RequirePluginSignature {
|
|
c.Err = model.NewAppError("uploadPlugin", "app.plugin.upload_disabled.app_error", nil, "", http.StatusNotImplemented)
|
|
return
|
|
}
|
|
|
|
auditRec := c.MakeAuditRecord("uploadPlugin", audit.Fail)
|
|
defer c.LogAuditRec(auditRec)
|
|
|
|
if !c.App.SessionHasPermissionTo(*c.AppContext.Session(), model.PermissionSysconsoleWritePlugins) {
|
|
c.SetPermissionError(model.PermissionSysconsoleWritePlugins)
|
|
return
|
|
}
|
|
|
|
if err := r.ParseMultipartForm(MaximumPluginFileSize); err != nil {
|
|
http.Error(w, err.Error(), http.StatusBadRequest)
|
|
return
|
|
}
|
|
|
|
m := r.MultipartForm
|
|
|
|
pluginArray, ok := m.File["plugin"]
|
|
if !ok {
|
|
c.Err = model.NewAppError("uploadPlugin", "api.plugin.upload.no_file.app_error", nil, "", http.StatusBadRequest)
|
|
return
|
|
}
|
|
|
|
if len(pluginArray) <= 0 {
|
|
c.Err = model.NewAppError("uploadPlugin", "api.plugin.upload.array.app_error", nil, "", http.StatusBadRequest)
|
|
return
|
|
}
|
|
auditRec.AddMeta("filename", pluginArray[0].Filename)
|
|
|
|
file, err := pluginArray[0].Open()
|
|
if err != nil {
|
|
c.Err = model.NewAppError("uploadPlugin", "api.plugin.upload.file.app_error", nil, "", http.StatusBadRequest)
|
|
return
|
|
}
|
|
defer file.Close()
|
|
|
|
force := false
|
|
if len(m.Value["force"]) > 0 && m.Value["force"][0] == "true" {
|
|
force = true
|
|
}
|
|
|
|
installPlugin(c, w, file, force)
|
|
auditRec.Success()
|
|
}
|
|
|
|
func installPluginFromURL(c *Context, w http.ResponseWriter, r *http.Request) {
|
|
if !*c.App.Config().PluginSettings.Enable ||
|
|
*c.App.Config().PluginSettings.RequirePluginSignature ||
|
|
!*c.App.Config().PluginSettings.EnableUploads {
|
|
c.Err = model.NewAppError("installPluginFromURL", "app.plugin.disabled.app_error", nil, "", http.StatusNotImplemented)
|
|
return
|
|
}
|
|
|
|
auditRec := c.MakeAuditRecord("installPluginFromURL", audit.Fail)
|
|
defer c.LogAuditRec(auditRec)
|
|
|
|
if !c.App.SessionHasPermissionTo(*c.AppContext.Session(), model.PermissionSysconsoleWritePlugins) {
|
|
c.SetPermissionError(model.PermissionSysconsoleWritePlugins)
|
|
return
|
|
}
|
|
|
|
force, _ := strconv.ParseBool(r.URL.Query().Get("force"))
|
|
downloadURL := r.URL.Query().Get("plugin_download_url")
|
|
auditRec.AddMeta("url", downloadURL)
|
|
|
|
pluginFileBytes, err := c.App.DownloadFromURL(downloadURL)
|
|
if err != nil {
|
|
c.Err = model.NewAppError("installPluginFromURL", "api.plugin.install.download_failed.app_error", nil, err.Error(), http.StatusBadRequest)
|
|
return
|
|
}
|
|
|
|
installPlugin(c, w, bytes.NewReader(pluginFileBytes), force)
|
|
auditRec.Success()
|
|
}
|
|
|
|
func installMarketplacePlugin(c *Context, w http.ResponseWriter, r *http.Request) {
|
|
if !*c.App.Config().PluginSettings.Enable {
|
|
c.Err = model.NewAppError("installMarketplacePlugin", "app.plugin.disabled.app_error", nil, "", http.StatusNotImplemented)
|
|
return
|
|
}
|
|
|
|
if !*c.App.Config().PluginSettings.EnableMarketplace {
|
|
c.Err = model.NewAppError("installMarketplacePlugin", "app.plugin.marketplace_disabled.app_error", nil, "", http.StatusNotImplemented)
|
|
return
|
|
}
|
|
|
|
auditRec := c.MakeAuditRecord("installMarketplacePlugin", audit.Fail)
|
|
defer c.LogAuditRec(auditRec)
|
|
|
|
if !c.App.SessionHasPermissionTo(*c.AppContext.Session(), model.PermissionSysconsoleWritePlugins) {
|
|
c.SetPermissionError(model.PermissionSysconsoleWritePlugins)
|
|
return
|
|
}
|
|
|
|
pluginRequest, err := model.PluginRequestFromReader(r.Body)
|
|
if err != nil {
|
|
c.Err = model.NewAppError("installMarketplacePlugin", "app.plugin.marketplace_plugin_request.app_error", nil, err.Error(), http.StatusNotImplemented)
|
|
return
|
|
}
|
|
auditRec.AddMeta("plugin_id", pluginRequest.Id)
|
|
|
|
manifest, appErr := c.App.Channels().InstallMarketplacePlugin(pluginRequest)
|
|
if appErr != nil {
|
|
c.Err = appErr
|
|
return
|
|
}
|
|
|
|
auditRec.Success()
|
|
auditRec.AddMeta("plugin_name", manifest.Name)
|
|
auditRec.AddMeta("plugin_desc", manifest.Description)
|
|
|
|
w.WriteHeader(http.StatusCreated)
|
|
if err := json.NewEncoder(w).Encode(manifest); err != nil {
|
|
mlog.Warn("Error while writing response", mlog.Err(err))
|
|
}
|
|
}
|
|
|
|
func getPlugins(c *Context, w http.ResponseWriter, r *http.Request) {
|
|
if !*c.App.Config().PluginSettings.Enable {
|
|
c.Err = model.NewAppError("getPlugins", "app.plugin.disabled.app_error", nil, "", http.StatusNotImplemented)
|
|
return
|
|
}
|
|
|
|
if !c.App.SessionHasPermissionTo(*c.AppContext.Session(), model.PermissionSysconsoleReadPlugins) {
|
|
c.SetPermissionError(model.PermissionSysconsoleReadPlugins)
|
|
return
|
|
}
|
|
|
|
response, err := c.App.GetPlugins()
|
|
if err != nil {
|
|
c.Err = err
|
|
return
|
|
}
|
|
|
|
if err := json.NewEncoder(w).Encode(response); err != nil {
|
|
mlog.Warn("Error while writing response", mlog.Err(err))
|
|
}
|
|
}
|
|
|
|
func getPluginStatuses(c *Context, w http.ResponseWriter, r *http.Request) {
|
|
if !*c.App.Config().PluginSettings.Enable {
|
|
c.Err = model.NewAppError("getPluginStatuses", "app.plugin.disabled.app_error", nil, "", http.StatusNotImplemented)
|
|
return
|
|
}
|
|
|
|
if !c.App.SessionHasPermissionTo(*c.AppContext.Session(), model.PermissionSysconsoleReadPlugins) {
|
|
c.SetPermissionError(model.PermissionSysconsoleReadPlugins)
|
|
return
|
|
}
|
|
|
|
response, err := c.App.GetClusterPluginStatuses()
|
|
if err != nil {
|
|
c.Err = err
|
|
return
|
|
}
|
|
|
|
if err := json.NewEncoder(w).Encode(response); err != nil {
|
|
mlog.Warn("Error while writing response", mlog.Err(err))
|
|
}
|
|
}
|
|
|
|
func removePlugin(c *Context, w http.ResponseWriter, r *http.Request) {
|
|
c.RequirePluginId()
|
|
if c.Err != nil {
|
|
return
|
|
}
|
|
|
|
if !*c.App.Config().PluginSettings.Enable {
|
|
c.Err = model.NewAppError("removePlugin", "app.plugin.disabled.app_error", nil, "", http.StatusNotImplemented)
|
|
return
|
|
}
|
|
|
|
auditRec := c.MakeAuditRecord("removePlugin", audit.Fail)
|
|
defer c.LogAuditRec(auditRec)
|
|
auditRec.AddMeta("plugin_id", c.Params.PluginId)
|
|
|
|
if !c.App.SessionHasPermissionTo(*c.AppContext.Session(), model.PermissionSysconsoleWritePlugins) {
|
|
c.SetPermissionError(model.PermissionSysconsoleWritePlugins)
|
|
return
|
|
}
|
|
|
|
err := c.App.Channels().RemovePlugin(c.Params.PluginId)
|
|
if err != nil {
|
|
c.Err = err
|
|
return
|
|
}
|
|
|
|
auditRec.Success()
|
|
ReturnStatusOK(w)
|
|
}
|
|
|
|
func getWebappPlugins(c *Context, w http.ResponseWriter, r *http.Request) {
|
|
if !*c.App.Config().PluginSettings.Enable {
|
|
c.Err = model.NewAppError("getWebappPlugins", "app.plugin.disabled.app_error", nil, "", http.StatusNotImplemented)
|
|
return
|
|
}
|
|
|
|
manifests, err := c.App.GetActivePluginManifests()
|
|
if err != nil {
|
|
c.Err = err
|
|
return
|
|
}
|
|
|
|
clientManifests := []*model.Manifest{}
|
|
for _, m := range manifests {
|
|
if m.HasClient() {
|
|
manifest := m.ClientManifest()
|
|
|
|
// There is no reason to expose the SettingsSchema in this API call; it's not used in the webapp.
|
|
manifest.SettingsSchema = nil
|
|
clientManifests = append(clientManifests, manifest)
|
|
}
|
|
}
|
|
|
|
js, jsonErr := json.Marshal(clientManifests)
|
|
if jsonErr != nil {
|
|
c.Err = model.NewAppError("getWebappPlugins", "api.marshal_error", nil, jsonErr.Error(), http.StatusInternalServerError)
|
|
return
|
|
}
|
|
w.Write(js)
|
|
}
|
|
|
|
func getMarketplacePlugins(c *Context, w http.ResponseWriter, r *http.Request) {
|
|
if !*c.App.Config().PluginSettings.Enable {
|
|
c.Err = model.NewAppError("getMarketplacePlugins", "app.plugin.disabled.app_error", nil, "", http.StatusNotImplemented)
|
|
return
|
|
}
|
|
|
|
if !*c.App.Config().PluginSettings.EnableMarketplace {
|
|
c.Err = model.NewAppError("getMarketplacePlugins", "app.plugin.marketplace_disabled.app_error", nil, "", http.StatusNotImplemented)
|
|
return
|
|
}
|
|
|
|
if !c.App.SessionHasPermissionTo(*c.AppContext.Session(), model.PermissionSysconsoleReadPlugins) {
|
|
c.SetPermissionError(model.PermissionSysconsoleReadPlugins)
|
|
return
|
|
}
|
|
|
|
filter, err := parseMarketplacePluginFilter(r.URL)
|
|
if err != nil {
|
|
c.Err = model.NewAppError("getMarketplacePlugins", "app.plugin.marshal.app_error", nil, err.Error(), http.StatusInternalServerError)
|
|
return
|
|
}
|
|
|
|
plugins, appErr := c.App.GetMarketplacePlugins(filter)
|
|
if appErr != nil {
|
|
c.Err = appErr
|
|
return
|
|
}
|
|
|
|
json, err := json.Marshal(plugins)
|
|
if err != nil {
|
|
c.Err = model.NewAppError("getMarketplacePlugins", "app.plugin.marshal.app_error", nil, err.Error(), http.StatusInternalServerError)
|
|
return
|
|
}
|
|
|
|
w.Write(json)
|
|
}
|
|
|
|
func enablePlugin(c *Context, w http.ResponseWriter, r *http.Request) {
|
|
c.RequirePluginId()
|
|
if c.Err != nil {
|
|
return
|
|
}
|
|
|
|
if !*c.App.Config().PluginSettings.Enable {
|
|
c.Err = model.NewAppError("activatePlugin", "app.plugin.disabled.app_error", nil, "", http.StatusNotImplemented)
|
|
return
|
|
}
|
|
|
|
auditRec := c.MakeAuditRecord("enablePlugin", audit.Fail)
|
|
defer c.LogAuditRec(auditRec)
|
|
auditRec.AddMeta("plugin_id", c.Params.PluginId)
|
|
|
|
if !c.App.SessionHasPermissionTo(*c.AppContext.Session(), model.PermissionSysconsoleWritePlugins) {
|
|
c.SetPermissionError(model.PermissionSysconsoleWritePlugins)
|
|
return
|
|
}
|
|
|
|
if err := c.App.EnablePlugin(c.Params.PluginId); err != nil {
|
|
c.Err = err
|
|
return
|
|
}
|
|
|
|
auditRec.Success()
|
|
ReturnStatusOK(w)
|
|
}
|
|
|
|
func disablePlugin(c *Context, w http.ResponseWriter, r *http.Request) {
|
|
c.RequirePluginId()
|
|
if c.Err != nil {
|
|
return
|
|
}
|
|
|
|
if !*c.App.Config().PluginSettings.Enable {
|
|
c.Err = model.NewAppError("deactivatePlugin", "app.plugin.disabled.app_error", nil, "", http.StatusNotImplemented)
|
|
return
|
|
}
|
|
|
|
auditRec := c.MakeAuditRecord("disablePlugin", audit.Fail)
|
|
defer c.LogAuditRec(auditRec)
|
|
auditRec.AddMeta("plugin_id", c.Params.PluginId)
|
|
|
|
if !c.App.SessionHasPermissionTo(*c.AppContext.Session(), model.PermissionSysconsoleWritePlugins) {
|
|
c.SetPermissionError(model.PermissionSysconsoleWritePlugins)
|
|
return
|
|
}
|
|
|
|
if err := c.App.DisablePlugin(c.Params.PluginId); err != nil {
|
|
c.Err = err
|
|
return
|
|
}
|
|
|
|
auditRec.Success()
|
|
ReturnStatusOK(w)
|
|
}
|
|
|
|
func parseMarketplacePluginFilter(u *url.URL) (*model.MarketplacePluginFilter, error) {
|
|
page, err := parseInt(u, "page", 0)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
perPage, err := parseInt(u, "per_page", 100)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
filter := u.Query().Get("filter")
|
|
serverVersion := u.Query().Get("server_version")
|
|
localOnly, _ := strconv.ParseBool(u.Query().Get("local_only"))
|
|
return &model.MarketplacePluginFilter{
|
|
Page: page,
|
|
PerPage: perPage,
|
|
Filter: filter,
|
|
ServerVersion: serverVersion,
|
|
LocalOnly: localOnly,
|
|
}, nil
|
|
}
|
|
|
|
func installPlugin(c *Context, w http.ResponseWriter, plugin io.ReadSeeker, force bool) {
|
|
manifest, appErr := c.App.InstallPlugin(plugin, force)
|
|
if appErr != nil {
|
|
c.Err = appErr
|
|
return
|
|
}
|
|
w.WriteHeader(http.StatusCreated)
|
|
if err := json.NewEncoder(w).Encode(manifest); err != nil {
|
|
mlog.Warn("Error while writing response", mlog.Err(err))
|
|
}
|
|
}
|
|
|
|
func setFirstAdminVisitMarketplaceStatus(c *Context, w http.ResponseWriter, r *http.Request) {
|
|
auditRec := c.MakeAuditRecord("setFirstAdminVisitMarketplaceStatus", audit.Fail)
|
|
defer c.LogAuditRec(auditRec)
|
|
c.LogAudit("attempt")
|
|
|
|
if !c.App.SessionHasPermissionTo(*c.AppContext.Session(), model.PermissionManageSystem) {
|
|
c.SetPermissionError(model.PermissionManageSystem)
|
|
return
|
|
}
|
|
|
|
firstAdminVisitMarketplaceObj := model.System{
|
|
Name: model.SystemFirstAdminVisitMarketplace,
|
|
Value: "true",
|
|
}
|
|
|
|
if err := c.App.Srv().Store.System().SaveOrUpdate(&firstAdminVisitMarketplaceObj); err != nil {
|
|
c.Err = model.NewAppError("setFirstAdminVisitMarketplaceStatus", "api.error_set_first_admin_visit_marketplace_status", nil, err.Error(), http.StatusInternalServerError)
|
|
return
|
|
}
|
|
|
|
message := model.NewWebSocketEvent(model.WebsocketFirstAdminVisitMarketplaceStatusReceived, "", "", "", nil)
|
|
message.Add("firstAdminVisitMarketplaceStatus", firstAdminVisitMarketplaceObj.Value)
|
|
c.App.Publish(message)
|
|
|
|
auditRec.Success()
|
|
ReturnStatusOK(w)
|
|
}
|
|
|
|
func getFirstAdminVisitMarketplaceStatus(c *Context, w http.ResponseWriter, r *http.Request) {
|
|
auditRec := c.MakeAuditRecord("getFirstAdminVisitMarketplaceStatus", audit.Fail)
|
|
defer c.LogAuditRec(auditRec)
|
|
c.LogAudit("attempt")
|
|
|
|
if !c.App.SessionHasPermissionTo(*c.AppContext.Session(), model.PermissionManageSystem) {
|
|
c.SetPermissionError(model.PermissionManageSystem)
|
|
return
|
|
}
|
|
|
|
firstAdminVisitMarketplaceObj, err := c.App.Srv().Store.System().GetByName(model.SystemFirstAdminVisitMarketplace)
|
|
if err != nil {
|
|
var nfErr *store.ErrNotFound
|
|
switch {
|
|
case errors.As(err, &nfErr):
|
|
firstAdminVisitMarketplaceObj = &model.System{
|
|
Name: model.SystemFirstAdminVisitMarketplace,
|
|
Value: "false",
|
|
}
|
|
default:
|
|
c.Err = model.NewAppError("getFirstAdminVisitMarketplaceStatus", "api.error_get_first_admin_visit_marketplace_status", nil, err.Error(), http.StatusInternalServerError)
|
|
|
|
return
|
|
}
|
|
}
|
|
|
|
auditRec.Success()
|
|
if err := json.NewEncoder(w).Encode(firstAdminVisitMarketplaceObj); err != nil {
|
|
mlog.Warn("Error while writing response", mlog.Err(err))
|
|
}
|
|
}
|