plugin.go

// SPDX-License-Identifier: BSD-3-Clause
//
// Authors: Alexander Jung <alex@unikraft.io>
//
// Copyright (c) 2022, Unikraft GmbH.  All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
//
// 1. Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
// 2. Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
// 3. Neither the name of the copyright holder nor the names of its
//    contributors may be used to endorse or promote products derived from
//    this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
// SOFTWARE.

package plugins

import (
	"path/filepath"
	"runtime"
	"strings"
)

const (
	PluginNamePrefix = "kraftkit-"
)

type PluginKind int

const (
	GitKind PluginKind = iota
	BinaryKind
)

type Plugin struct {
	path           string
	url            string
	isLocal        bool
	currentVersion string
	latestVersion  string
	kind           PluginKind
	aliases        []string
}

type PluginOption func(p *Plugin)

func (p *Plugin) Name() string {
	name := strings.TrimPrefix(filepath.Base(p.path), PluginNamePrefix)
	ext := ".so"
	if runtime.GOOS == "windows" {
		ext = ".dll"
	}
	return strings.TrimSuffix(name, ext)
}

func (p *Plugin) Path() string {
	return p.path
}

func (p *Plugin) URL() string {
	return p.url
}

func (p *Plugin) IsLocal() bool {
	return p.isLocal
}

func (p *Plugin) UpdateAvailable() bool {
	if p.isLocal ||
		p.currentVersion == "" ||
		p.latestVersion == "" ||
		p.currentVersion == p.latestVersion {
		return false
	}

	return true
}

func (p *Plugin) IsBinary() bool {
	return p.kind == BinaryKind
}

func (p *Plugin) Aliases() []string {
	return p.aliases
}