asdf/internal/plugins/plugins.go

// Package plugins provides functions for interacting with asdf plugins
package plugins

import (
	"errors"
	"fmt"
	"io"
	"io/fs"
	"os"
	"path/filepath"
	"regexp"
	"strings"

	"github.com/asdf-vm/asdf/internal/config"
	"github.com/asdf-vm/asdf/internal/data"
	"github.com/asdf-vm/asdf/internal/execute"
	"github.com/asdf-vm/asdf/internal/git"
	"github.com/asdf-vm/asdf/internal/hook"
	"github.com/asdf-vm/asdf/internal/pluginindex"
)

// NewPluginAlreadyExists generates a new PluginAlreadyExists error instance for
// a particular plugin
func NewPluginAlreadyExists(plugin string) PluginAlreadyExists {
	return PluginAlreadyExists{plugin: plugin}
}

// PluginAlreadyExists is an error returned when the specified plugin already
// exists
type PluginAlreadyExists struct {
	plugin string
}

func (e PluginAlreadyExists) Error() string {
	return fmt.Sprintf(pluginAlreadyExistsMsg, e.plugin)
}

// PluginMissing is the error returned when Plugin.Exists is call and the plugin
// doesn't exist on disk.
type PluginMissing struct {
	plugin string
}

func (e PluginMissing) Error() string {
	return fmt.Sprintf(pluginMissingMsg, e.plugin)
}

// NoCallbackError is an error returned by RunCallback when a callback with
// particular name does not exist
type NoCallbackError struct {
	callback string
	plugin   string
}

func (e NoCallbackError) Error() string {
	return fmt.Sprintf(hasNoCallbackMsg, e.plugin, e.callback)
}

// NoCommandError is an error returned by ExtensionCommandPath when an extension
// command with the given name does not exist
type NoCommandError struct {
	command string
	plugin  string
}

func (e NoCommandError) Error() string {
	return fmt.Sprintf(hasNoCommandMsg, e.plugin, e.command)
}

const (
	dataDirPlugins         = "plugins"
	invalidPluginNameMsg   = "%s is invalid. Name may only contain lowercase letters, numbers, '_', and '-'"
	pluginAlreadyExistsMsg = "Plugin named %s already added"
	pluginMissingMsg       = "Plugin named %s not installed"
	hasNoCallbackMsg       = "Plugin named %s does not have a callback named %s"
	hasNoCommandMsg        = "Plugin named %s does not have a extension command named %s"
)

// Plugin struct represents an asdf plugin to all asdf code. The name and dir
// fields are the most used fields. Ref and Dir only still git info, which is
// only information and shown to the user at times.
type Plugin struct {
	Name string
	Dir  string
	Ref  string
	URL  string
}

// New takes config and a plugin name and returns a Plugin struct. It is
// intended for functions that need to quickly initialize a plugin.
func New(config config.Config, name string) Plugin {
	pluginsDir := data.PluginDirectory(config.DataDir, name)
	return Plugin{Dir: pluginsDir, Name: name}
}

// LegacyFilenames returns a slice of filenames if the plugin contains the
// list-legacy-filenames callback.
func (p Plugin) LegacyFilenames() (filenames []string, err error) {
	var stdOut strings.Builder
	var stdErr strings.Builder
	err = p.RunCallback("list-legacy-filenames", []string{}, map[string]string{}, &stdOut, &stdErr)
	if err != nil {
		_, ok := err.(NoCallbackError)
		if ok {
			return []string{}, nil
		}

		return []string{}, err
	}

	for _, filename := range strings.Split(stdOut.String(), " ") {
		filenames = append(filenames, strings.TrimSpace(filename))
	}
	return filenames, nil
}

// ParseLegacyVersionFile takes a file and uses the parse-legacy-file callback
// script to parse it if the script is present. Otherwise just reads the file
// directly. In either case the returned string is split on spaces and a slice
// of versions is returned.
func (p Plugin) ParseLegacyVersionFile(path string) (versions []string, err error) {
	parseLegacyFileName := "parse-legacy-file"
	parseCallbackPath := filepath.Join(p.Dir, "bin", parseLegacyFileName)

	var rawVersions string

	if _, err := os.Stat(parseCallbackPath); err == nil {
		var stdOut strings.Builder
		var stdErr strings.Builder

		err = p.RunCallback(parseLegacyFileName, []string{path}, map[string]string{}, &stdOut, &stdErr)
		if err != nil {
			return versions, err
		}

		rawVersions = stdOut.String()
	} else {
		bytes, err := os.ReadFile(path)
		if err != nil {
			return versions, err
		}

		rawVersions = string(bytes)
	}

	for _, version := range strings.Split(rawVersions, " ") {
		versions = append(versions, strings.TrimSpace(version))
	}

	return versions, err
}

// Exists returns a boolean indicating whether or not the plugin exists on disk.
func (p Plugin) Exists() error {
	exists, err := directoryExists(p.Dir)
	if err != nil {
		return err
	}

	if !exists {
		return PluginMissing{plugin: p.Name}
	}

	return nil
}

// RunCallback invokes a callback with the given name if it exists for the plugin
func (p Plugin) RunCallback(name string, arguments []string, environment map[string]string, stdOut io.Writer, errOut io.Writer) error {
	callback, err := p.CallbackPath(name)
	if err != nil {
		return err
	}

	cmd := execute.New(fmt.Sprintf("'%s'", callback), arguments)
	cmd.Env = environment

	cmd.Stdout = stdOut
	cmd.Stderr = errOut

	return cmd.Run()
}

// CallbackPath returns the full file path to a callback script
func (p Plugin) CallbackPath(name string) (string, error) {
	path := filepath.Join(p.Dir, "bin", name)
	_, err := os.Stat(path)
	if errors.Is(err, os.ErrNotExist) {
		return "", NoCallbackError{callback: name, plugin: p.Name}
	}

	return path, nil
}

// GetExtensionCommands returns a slice of strings representing all available
// extension commands for the plugin.
func (p Plugin) GetExtensionCommands() ([]string, error) {
	commands := []string{}
	files, err := os.ReadDir(filepath.Join(p.Dir, "lib/commands"))
	if _, ok := err.(*fs.PathError); ok {
		return commands, nil
	}

	if err != nil {
		return commands, err
	}

	for _, file := range files {
		if !file.IsDir() {
			name := file.Name()
			if name == "command" {
				commands = append(commands, "")
			} else {
				if strings.HasPrefix(name, "command-") {
					commands = append(commands, strings.TrimPrefix(name, "command-"))
				}
			}
		}
	}
	return commands, nil
}

// ExtensionCommandPath returns the path to the plugin's extension command
// script matching the name if it exists.
func (p Plugin) ExtensionCommandPath(name string) (string, error) {
	commandName := "command"

	if name != "" {
		commandName = fmt.Sprintf("command-%s", name)
	}

	path := filepath.Join(p.Dir, "lib", "commands", commandName)
	_, err := os.Stat(path)
	if errors.Is(err, os.ErrNotExist) {
		return "", NoCommandError{command: name, plugin: p.Name}
	}

	return path, nil
}

// Update a plugin to a specific ref, or if no ref provided update to latest
func (p Plugin) Update(conf config.Config, ref string, out, errout io.Writer) (string, error) {
	err := p.Exists()
	if err != nil {
		return "", fmt.Errorf("no such plugin: %s", p.Name)
	}

	repo := git.NewRepo(p.Dir)

	hook.Run(conf, "pre_asdf_plugin_update", []string{p.Name})
	hook.Run(conf, fmt.Sprintf("pre_asdf_plugin_update_%s", p.Name), []string{p.Name})

	newRef, oldSHA, newSHA, err := repo.Update(ref)
	if err != nil {
		return newRef, err
	}

	env := map[string]string{
		"ASDF_PLUGIN_PATH":     p.Dir,
		"ASDF_PLUGIN_PREV_REF": oldSHA,
		"ASDF_PLUGIN_POST_REF": newSHA,
	}

	err = p.RunCallback("post-plugin-update", []string{}, env, out, errout)

	hook.Run(conf, "post_asdf_plugin_update", []string{p.Name})
	hook.Run(conf, fmt.Sprintf("post_asdf_plugin_update_%s", p.Name), []string{})

	return newRef, err
}

// List takes config and flags for what to return and builds a list of plugins
// representing the currently installed plugins on the system.
func List(config config.Config, urls, refs bool) (plugins []Plugin, err error) {
	pluginsDir := data.PluginsDirectory(config.DataDir)
	files, err := os.ReadDir(pluginsDir)
	if err != nil {
		if _, ok := err.(*fs.PathError); ok {
			return []Plugin{}, nil
		}

		return plugins, err
	}

	for _, file := range files {
		if file.IsDir() {
			if refs || urls {
				var url string
				var refString string
				location := filepath.Join(pluginsDir, file.Name())
				repo := git.NewRepo(location)

				// TODO: Improve these error messages
				if err != nil {
					return plugins, err
				}

				if refs {
					refString, err = repo.Head()
					if err != nil {
						return plugins, err
					}
				}

				if urls {
					url, err = repo.RemoteURL()
					if err != nil {
						return plugins, err
					}
				}

				plugins = append(plugins, Plugin{
					Name: file.Name(),
					Dir:  location,
					URL:  url,
					Ref:  refString,
				})
			} else {
				plugins = append(plugins, Plugin{
					Name: file.Name(),
					Dir:  filepath.Join(pluginsDir, file.Name()),
				})
			}
		}
	}

	return plugins, nil
}

// Add takes plugin name and Git URL and installs the plugin if it isn't
// already installed
func Add(config config.Config, pluginName, pluginURL, ref string) error {
	err := validatePluginName(pluginName)
	if err != nil {
		return err
	}

	exists, err := PluginExists(config.DataDir, pluginName)
	if err != nil {
		return fmt.Errorf("unable to check if plugin already exists: %w", err)
	}

	if exists {
		return NewPluginAlreadyExists(pluginName)
	}

	plugin := New(config, pluginName)

	if pluginURL == "" {
		// Ignore error here as the default value is fine
		disablePluginIndex, _ := config.DisablePluginShortNameRepository()

		if disablePluginIndex {
			return fmt.Errorf("Short-name plugin repository is disabled")
		}

		lastCheckDuration := 0
		// We don't care about errors here as we can use the default value
		checkDuration, _ := config.PluginRepositoryLastCheckDuration()

		if !checkDuration.Never {
			lastCheckDuration = checkDuration.Every
		}

		index := pluginindex.Build(config.DataDir, config.PluginIndexURL, false, lastCheckDuration)
		var err error
		pluginURL, err = index.GetPluginSourceURL(pluginName)
		if err != nil {
			return fmt.Errorf("error fetching plugin URL: %s", err)
		}
	}

	plugin.URL = pluginURL

	// Run pre hooks
	hook.Run(config, "pre_asdf_plugin_add", []string{plugin.Name})
	hook.Run(config, fmt.Sprintf("pre_asdf_plugin_add_%s", plugin.Name), []string{})

	err = git.NewRepo(plugin.Dir).Clone(plugin.URL, ref)
	if err != nil {
		return err
	}

	err = os.MkdirAll(data.DownloadDirectory(config.DataDir, plugin.Name), 0o777)
	if err != nil {
		return err
	}

	env := map[string]string{"ASDF_PLUGIN_SOURCE_URL": plugin.URL, "ASDF_PLUGIN_PATH": plugin.Dir}
	plugin.RunCallback("post-plugin-add", []string{}, env, os.Stdout, os.Stderr)

	// Run post hooks
	hook.Run(config, "post_asdf_plugin_add", []string{plugin.Name})
	hook.Run(config, fmt.Sprintf("post_asdf_plugin_add_%s", plugin.Name), []string{})

	return nil
}

// Remove uninstalls a plugin by removing it from the file system if installed
func Remove(config config.Config, pluginName string, stdout, stderr io.Writer) error {
	err := validatePluginName(pluginName)
	if err != nil {
		return err
	}

	plugin := New(config, pluginName)

	exists, err := PluginExists(config.DataDir, pluginName)
	if err != nil {
		return fmt.Errorf("unable to check if plugin exists: %w", err)
	}

	if !exists {
		return fmt.Errorf("No such plugin: %s", pluginName)
	}

	hook.Run(config, "pre_asdf_plugin_remove", []string{plugin.Name})
	hook.Run(config, fmt.Sprintf("pre_asdf_plugin_remove_%s", plugin.Name), []string{})

	env := map[string]string{
		"ASDF_PLUGIN_PATH":       plugin.Dir,
		"ASDF_PLUGIN_SOURCE_URL": plugin.URL,
	}
	plugin.RunCallback("pre-plugin-remove", []string{}, env, stdout, stderr)

	pluginDir := data.PluginDirectory(config.DataDir, pluginName)
	downloadDir := data.DownloadDirectory(config.DataDir, pluginName)
	installDir := data.InstallDirectory(config.DataDir, pluginName)

	err = os.RemoveAll(downloadDir)
	err2 := os.RemoveAll(pluginDir)
	err3 := os.RemoveAll(installDir)

	if err != nil {
		return err
	}

	if err2 != nil {
		return err2
	}

	hook.Run(config, "post_asdf_plugin_remove", []string{plugin.Name})
	hook.Run(config, fmt.Sprintf("post_asdf_plugin_remove_%s", plugin.Name), []string{})

	return err3
}

// PluginExists returns a boolean indicating whether or not a plugin with the
// provided name is currently installed
func PluginExists(dataDir, pluginName string) (bool, error) {
	pluginDir := data.PluginDirectory(dataDir, pluginName)
	return directoryExists(pluginDir)
}

func directoryExists(dir string) (bool, error) {
	fileInfo, err := os.Stat(dir)
	if errors.Is(err, os.ErrNotExist) {
		return false, nil
	}

	if err != nil {
		return false, err
	}

	return fileInfo.IsDir(), nil
}

func validatePluginName(name string) error {
	match, err := regexp.MatchString("^[[:lower:][:digit:]_-]+$", name)
	if err != nil {
		return err
	}

	if !match {
		return fmt.Errorf(invalidPluginNameMsg, name)
	}

	return nil
}