upstream-mattermost/server/cmd/mmctl/commands/plugin.go

// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
// See LICENSE.txt for license information.

package commands

import (
	"context"
	"fmt"
	"os"

	"github.com/mattermost/mattermost/server/v8/cmd/mmctl/client"
	"github.com/mattermost/mattermost/server/v8/cmd/mmctl/printer"

	"github.com/hashicorp/go-multierror"
	"github.com/pkg/errors"
	"github.com/spf13/cobra"
)

var PluginCmd = &cobra.Command{
	Use:   "plugin",
	Short: "Management of plugins",
}

var PluginAddCmd = &cobra.Command{
	Use:     "add [plugins]",
	Short:   "Add plugins",
	Long:    "Add plugins to your Mattermost server.",
	Example: `  plugin add hovercardexample.tar.gz pluginexample.tar.gz`,
	RunE:    withClient(pluginAddCmdF),
	Args:    cobra.MinimumNArgs(1),
}

var PluginInstallURLCmd = &cobra.Command{
	Use:   "install-url <url>...",
	Short: "Install plugin from url",
	Long:  "Supply one or multiple URLs to plugins compressed in a .tar.gz file. Plugins must be enabled in the server's config settings",
	Example: `  # You can install one plugin
  $ mmctl plugin install-url https://example.com/mattermost-plugin.tar.gz

  # Or install multiple in one go
  $ mmctl plugin install-url https://example.com/mattermost-plugin-one.tar.gz https://example.com/mattermost-plugin-two.tar.gz`,
	RunE: withClient(pluginInstallURLCmdF),
	Args: cobra.MinimumNArgs(1),
}

var PluginDeleteCmd = &cobra.Command{
	Use:     "delete [plugins]",
	Short:   "Delete plugins",
	Long:    "Delete previously uploaded plugins from your Mattermost server.",
	Example: `  plugin delete hovercardexample pluginexample`,
	RunE:    withClient(pluginDeleteCmdF),
	Args:    cobra.MinimumNArgs(1),
}

var PluginEnableCmd = &cobra.Command{
	Use:     "enable [plugins]",
	Short:   "Enable plugins",
	Long:    "Enable plugins for use on your Mattermost server.",
	Example: `  plugin enable hovercardexample pluginexample`,
	RunE:    withClient(pluginEnableCmdF),
	Args:    cobra.MinimumNArgs(1),
}

var PluginDisableCmd = &cobra.Command{
	Use:     "disable [plugins]",
	Short:   "Disable plugins",
	Long:    "Disable plugins. Disabled plugins are immediately removed from the user interface and logged out of all sessions.",
	Example: `  plugin disable hovercardexample pluginexample`,
	RunE:    withClient(pluginDisableCmdF),
	Args:    cobra.MinimumNArgs(1),
}

var PluginListCmd = &cobra.Command{
	Use:     "list",
	Short:   "List plugins",
	Long:    "List all enabled and disabled plugins installed on your Mattermost server.",
	Example: `  plugin list`,
	RunE:    withClient(pluginListCmdF),
}

func init() {
	PluginAddCmd.Flags().BoolP("force", "f", false, "overwrite a previously installed plugin with the same ID, if any")
	PluginInstallURLCmd.Flags().BoolP("force", "f", false, "overwrite a previously installed plugin with the same ID, if any")

	PluginCmd.AddCommand(
		PluginAddCmd,
		PluginInstallURLCmd,
		PluginDeleteCmd,
		PluginEnableCmd,
		PluginDisableCmd,
		PluginListCmd,
	)
	RootCmd.AddCommand(PluginCmd)
}

func pluginAddCmdF(c client.Client, cmd *cobra.Command, args []string) error {
	force, _ := cmd.Flags().GetBool("force")
	var multiErr *multierror.Error

	for i, plugin := range args {
		fileReader, err := os.Open(plugin)
		if err != nil {
			return err
		}

		if force {
			_, _, err = c.UploadPluginForced(context.TODO(), fileReader)
		} else {
			_, _, err = c.UploadPlugin(context.TODO(), fileReader)
		}

		if err != nil {
			printer.PrintError("Unable to add plugin: " + args[i] + ". Error: " + err.Error())
			multiErr = multierror.Append(multiErr, err)
		} else {
			printer.Print("Added plugin: " + plugin)
		}
		fileReader.Close()
	}

	return multiErr.ErrorOrNil()
}

func pluginInstallURLCmdF(c client.Client, cmd *cobra.Command, args []string) error {
	force, _ := cmd.Flags().GetBool("force")
	var multiErr *multierror.Error

	for _, plugin := range args {
		manifest, _, err := c.InstallPluginFromURL(context.TODO(), plugin, force)
		if err != nil {
			printer.PrintError("Unable to install plugin from URL \"" + plugin + "\". Error: " + err.Error())
			multiErr = multierror.Append(multiErr, err)
		} else {
			printer.PrintT("Plugin {{.Name}} successfully installed", manifest)
		}
	}

	return multiErr.ErrorOrNil()
}

func pluginDeleteCmdF(c client.Client, cmd *cobra.Command, args []string) error {
	var multiErr *multierror.Error
	for _, plugin := range args {
		if _, err := c.RemovePlugin(context.TODO(), plugin); err != nil {
			printer.PrintError("Unable to delete plugin: " + plugin + ". Error: " + err.Error())
			multiErr = multierror.Append(multiErr, fmt.Errorf("Unable to delete plugin. %w", err))
		} else {
			printer.Print("Deleted plugin: " + plugin)
		}
	}

	return multiErr.ErrorOrNil()
}

func pluginEnableCmdF(c client.Client, cmd *cobra.Command, args []string) error {
	var multiErr *multierror.Error
	for _, plugin := range args {
		if _, err := c.EnablePlugin(context.TODO(), plugin); err != nil {
			printer.PrintError("Unable to enable plugin: " + plugin + ". Error: " + err.Error())
			multiErr = multierror.Append(multiErr, err)
		} else {
			printer.Print("Enabled plugin: " + plugin)
		}
	}

	return multiErr.ErrorOrNil()
}

func pluginDisableCmdF(c client.Client, cmd *cobra.Command, args []string) error {
	var multiErr *multierror.Error
	for _, plugin := range args {
		if _, err := c.DisablePlugin(context.TODO(), plugin); err != nil {
			printer.PrintError("Unable to disable plugin: " + plugin + ". Error: " + err.Error())
			multiErr = multierror.Append(multiErr, err)
		} else {
			printer.Print("Disabled plugin: " + plugin)
		}
	}

	return multiErr.ErrorOrNil()
}

func pluginListCmdF(c client.Client, cmd *cobra.Command, args []string) error {
	pluginsResp, _, err := c.GetPlugins(context.TODO())
	if err != nil {
		return errors.New("Unable to list plugins. Error: " + err.Error())
	}

	format, _ := cmd.Flags().GetString("format")
	json, _ := cmd.Flags().GetBool("json")
	if format == printer.FormatJSON || json {
		printer.Print(pluginsResp)
	} else {
		printer.Print("Listing enabled plugins")
		for _, plugin := range pluginsResp.Active {
			printer.PrintT("{{.Manifest.Id}}: {{.Manifest.Name}}, Version: {{.Manifest.Version}}", plugin)
		}

		printer.Print("")
		printer.Print("Listing disabled plugins")
		for _, plugin := range pluginsResp.Inactive {
			printer.PrintT("{{.Manifest.Id}}: {{.Manifest.Name}}, Version: {{.Manifest.Version}}", plugin)
		}
	}

	return nil
}