pluginManger.go

package plugin

import (
	"bytes"
	"fmt"
	"io"
	"io/ioutil"
	"mime/multipart"
	"net/http"
	"os"
	"path/filepath"
	"strings"

	"github.com/jenkins-zh/jenkins-client/pkg/core"

	httpdownloader "github.com/linuxsuren/http-downloader/pkg"
)

// Manager is the client of plugin manager
type Manager struct {
	core.JenkinsCore

	UseMirror    bool
	MirrorURL    string
	ShowProgress bool
}

// Plugin represents a plugin of Jenkins
type Plugin struct {
	Active       bool
	Enabled      bool
	Bundled      bool
	Downgradable bool
	Deleted      bool
}

// InstalledPluginList represent a list of plugins
type InstalledPluginList struct {
	Plugins []InstalledPlugin
}

// AvailablePluginList represents a list of available plugins
type AvailablePluginList struct {
	Data   []AvailablePlugin
	Status string
}

// AvailablePlugin represetns a available plugin
type AvailablePlugin struct {
	Plugin

	// for the available list
	Name      string
	Installed bool
	Website   string
	Title     string
}

// InstalledPlugin represent the installed plugin from Jenkins
type InstalledPlugin struct {
	Plugin

	Enable             bool
	ShortName          string
	LongName           string
	Version            string
	URL                string
	HasUpdate          bool
	Pinned             bool
	RequiredCoreVesion string
	MinimumJavaVersion string
	SupportDynamicLoad string
	BackVersion        string
	Dependencies       []Dependency
}

var debugLogFile = "debug.html"

// CheckUpdate fetch the latest plugins from update center site
func (p *Manager) CheckUpdate(handle func(*http.Response)) (err error) {
	api := "/pluginManager/checkUpdatesServer"
	var response *http.Response
	response, err = p.RequestWithResponseHeader(http.MethodPost, api, nil, nil, nil)
	if err == nil {
		p.handleCheck(handle)(response)
	}
	return
}

// GetAvailablePlugins get the aviable plugins from Jenkins
func (p *Manager) GetAvailablePlugins() (pluginList *AvailablePluginList, err error) {
	err = p.RequestWithData(http.MethodGet, "/pluginManager/plugins", nil, nil, 200, &pluginList)
	return
}

// GetPlugins get installed plugins
func (p *Manager) GetPlugins(depth int) (pluginList *InstalledPluginList, err error) {
	if depth > 1 {
		err = p.RequestWithData(http.MethodGet, fmt.Sprintf("/pluginManager/api/json?depth=%d", depth), nil, nil, 200, &pluginList)
	} else {
		err = p.RequestWithData(http.MethodGet, "/pluginManager/api/json?depth=1", nil, nil, 200, &pluginList)
	}
	return
}

// GetPluginsFormula get the plugin list with Jenkins formula format
func (p *Manager) GetPluginsFormula(data interface{}) (err error) {
	api := "jcliPluginManager/pluginList"
	err = p.RequestWithData(http.MethodGet, api, nil, nil, 200, data)
	return
}

// FindInstalledPlugin find the exist plugin by name
func (p *Manager) FindInstalledPlugin(name string) (targetPlugin *InstalledPlugin, err error) {
	var plugins *InstalledPluginList
	if plugins, err = p.GetPlugins(1); err == nil {
		for _, plugin := range plugins.Plugins {
			if plugin.ShortName == name {
				targetPlugin = &plugin
				break
			}
		}
	}
	return
}

func (p *Manager) getPluginsInstallQuery(names []string) string {
	pluginNames := make([]string, 0)
	for _, name := range names {
		if name == "" {
			continue
		}
		if !strings.Contains(name, "@") {
			pluginNames = append(pluginNames, fmt.Sprintf("plugin.%s=", name))
		}
	}
	if len(pluginNames) == 0 {
		return ""
	}
	return strings.Join(pluginNames, "&")
}

func (p *Manager) getVersionalPlugins(names []string) []string {
	pluginNames := make([]string, 0)
	for _, name := range names {
		if strings.Contains(name, "@") {
			pluginNames = append(pluginNames, name)
		}
	}
	return pluginNames
}

// InstallPlugin install a plugin by name
func (p *Manager) InstallPlugin(names []string) (err error) {
	plugins := p.getPluginsInstallQuery(names)
	versionalPlugins := p.getVersionalPlugins(names)
	if plugins != "" {
		for _, plugin := range strings.Split(plugins, "&") {
			if err = p.installPluginsWithoutVersion(plugin); err != nil {
				return
			}
		}
	}

	if err == nil && len(versionalPlugins) > 0 {
		err = p.installPluginsWithVersion(versionalPlugins)
	}
	return
}

func (p *Manager) installPluginsWithoutVersion(plugins string) (err error) {
	api := fmt.Sprintf("/pluginManager/install?%s", plugins)
	var response *http.Response
	response, err = p.RequestWithResponse(http.MethodPost, api, nil, nil)
	if response != nil && response.StatusCode == 400 {
		if errMsg, ok := response.Header["X-Error"]; ok {
			for _, msg := range errMsg {
				err = fmt.Errorf(msg)
			}
		} else {
			err = fmt.Errorf("cannot found plugins %s", plugins)
		}
	}
	return
}

func (p *Manager) installPluginsWithVersion(plugins []string) (err error) {
	for _, plugin := range plugins {
		if err = p.installPluginWithVersion(plugin); err != nil {
			break
		}
	}
	return
}

// installPluginWithVersion install a plugin by name & version
func (p *Manager) installPluginWithVersion(name string) (err error) {
	pluginName := fmt.Sprintf("%s.hpi", strings.Split(name, "@")[0])
	defer func(name string) {
		// ignore error
		_ = os.Remove(name)
	}(pluginName)

	if err = p.DownloadPluginWithVersion(name); err == nil {
		err = p.Upload(pluginName)
	}
	return
}

// DownloadPluginWithVersion downloads a plugin with name and version
func (p *Manager) DownloadPluginWithVersion(nameWithVer string) error {
	pluginAPI := API{
		RoundTripper: p.RoundTripper,
		UseMirror:    p.UseMirror,
		MirrorURL:    p.MirrorURL,
		ShowProgress: p.ShowProgress,
	}

	pluginVersion := strings.Split(nameWithVer, "@")
	name := pluginVersion[0]
	version := pluginVersion[1]
	url := fmt.Sprintf("https://updates.jenkins-ci.org/download/plugins/%s/%s/%s.hpi", name, version, name)

	return pluginAPI.download(pluginAPI.getMirrorURL(url), name)
}

// UninstallPlugin uninstall a plugin by name
func (p *Manager) UninstallPlugin(name string) (err error) {
	api := fmt.Sprintf("/pluginManager/plugin/%s/doUninstall", name)
	var (
		statusCode int
		data       []byte
	)

	if statusCode, data, err = p.Request(http.MethodPost, api, nil, nil); err == nil {
		if statusCode != 200 {
			err = fmt.Errorf("unexpected status code: %d", statusCode)
			if p.Debug {
				// ignore error
				_ = ioutil.WriteFile(debugLogFile, data, 0664)
			}
		}
	}
	return
}

// Upload will upload a file from local filesystem into Jenkins
func (p *Manager) Upload(pluginFile string) (err error) {
	api := fmt.Sprintf("%s/pluginManager/uploadPlugin", p.URL)
	extraParams := map[string]string{}
	var request *http.Request
	if request, err = p.newfileUploadRequest(api, extraParams, "@name", pluginFile); err != nil {
		return
	}

	if err = p.AuthHandle(request); err != nil {
		return
	}

	jcli := p.GetClient()
	var response *http.Response
	if response, err = jcli.Do(request); err != nil {
		return
	} else if response.StatusCode != 200 {
		err = fmt.Errorf("StatusCode: %d", response.StatusCode)
	}
	return err
}

func (p *Manager) handleCheck(handle func(*http.Response)) func(*http.Response) {
	if handle == nil {
		handle = func(*http.Response) {
			// Do nothing, just for avoid nil exception
		}
	}
	return handle
}

func (p *Manager) newfileUploadRequest(uri string, params map[string]string, paramName, path string) (req *http.Request, err error) {
	var file *os.File
	file, err = os.Open(path)
	if err != nil {
		return
	}

	var total float64
	var stat os.FileInfo
	if stat, err = file.Stat(); err != nil {
		return
	}
	total = float64(stat.Size())
	defer func(file *os.File) {
		// ignore error
		_ = file.Close()
	}(file)

	bytesBuffer := &bytes.Buffer{}
	writer := multipart.NewWriter(bytesBuffer)

	var part io.Writer
	part, err = writer.CreateFormFile(paramName, filepath.Base(path))
	if err != nil {
		return
	}

	_, err = io.Copy(part, file)

	for key, val := range params {
		_ = writer.WriteField(key, val)
	}
	err = writer.Close()
	if err != nil {
		return
	}

	var progressWriter *httpdownloader.ProgressIndicator
	if p.ShowProgress {
		progressWriter = &httpdownloader.ProgressIndicator{
			Total:  total,
			Writer: bytesBuffer,
			Reader: bytesBuffer,
			Title:  "Uploading",
		}
		progressWriter.Init()
		req, err = http.NewRequest(http.MethodPost, uri, progressWriter)
	} else {
		req, err = http.NewRequest(http.MethodPost, uri, bytesBuffer)
	}

	req.Header.Set("Content-Type", writer.FormDataContentType())
	return
}