kubevela/pkg/addon/reader_oss.go

/*
Copyright 2021 The KubeVela Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

	http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package addon

import (
	"encoding/xml"
	"fmt"
	"path"
	"sort"
	"strings"
	"time"

	"github.com/go-resty/resty/v2"
	"github.com/pkg/errors"
)

var _ AsyncReader = &ossReader{}

// ListBucketResult describe a file list from OSS
type ListBucketResult struct {
	Files []File `xml:"Contents"`
	Count int    `xml:"KeyCount"`
}

// File is for oss xml parse
type File struct {
	Name         string    `xml:"Key"`
	Size         int       `xml:"Size"`
	LastModified time.Time `xml:"LastModified"`
	Type         string    `xml:"Type"`
	StorageClass string    `xml:"StorageClass"`
}

type ossReader struct {
	bucketEndPoint string
	path           string
	client         *resty.Client
}

// OSSItem is Item implement for OSS
type OSSItem struct {
	tp   string
	path string
	name string
}

// GetType from OSSItem
func (i OSSItem) GetType() string {
	return i.tp
}

// GetPath from OSSItem
func (i OSSItem) GetPath() string {
	return i.path
}

// GetName from OSSItem
func (i OSSItem) GetName() string {
	return i.name
}

// ReadFile read file content from OSS bucket, path is relative to oss bucket and sub-path in reader
func (o *ossReader) ReadFile(relativePath string) (content string, err error) {
	resp, err := o.client.R().Get(fmt.Sprintf(singleOSSFileTmpl, o.bucketEndPoint, path.Join(o.path, relativePath)))
	if err != nil {
		return "", err
	}
	return string(resp.Body()), nil
}

// ListAddonMeta list object from OSS and convert it to metadata
func (o *ossReader) ListAddonMeta() (map[string]SourceMeta, error) {
	resp, err := o.client.R().Get(fmt.Sprintf(listOSSFileTmpl, o.bucketEndPoint, o.path))
	if err != nil {
		return nil, errors.Wrapf(err, "fail to read path %s", o.path)
	}

	list := ListBucketResult{}
	err = xml.Unmarshal(resp.Body(), &list)
	if err != nil {
		return nil, err
	}
	list = filterEmptyObj(list)
	addons := o.convertOSSFiles2Addons(list.Files)
	return addons, nil
}

// convertOSSFiles2Addons convert OSS list result to map of addon meta information
func (o *ossReader) convertOSSFiles2Addons(files []File) map[string]SourceMeta {
	addonMetas := make(map[string]SourceMeta)
	pathBuckets := make(map[string][]Item)
	fPaths := make(map[string][]string)
	actualFiles := make([]File, 0)
	// first traversal to confirm addon and initialize addonMetas
	for _, f := range files {
		fPath := trimAndSplitPath(f.Name, o.path)
		if len(fPath) < 2 || f.Size == 0 {
			// this is a file or directory in root, remove it
			continue
		}
		fPaths[f.Name] = fPath
		actualFiles = append(actualFiles, f)
		var addonName = fPath[0]
		if len(fPath) == 2 && fPath[1] == MetadataFileName {
			addonMetas[addonName] = SourceMeta{Name: addonName}
			pathBuckets[addonName] = make([]Item, 0)
		}
	}
	// second sort all addon file item by name
	for _, f := range actualFiles {
		fPath := fPaths[f.Name]
		addonName := fPath[0]
		pathList, ok := pathBuckets[addonName]
		// this path doesn't belong to an addon
		if !ok {
			continue
		}
		pathList = append(pathList, &OSSItem{
			path: path.Join(fPath...),
			tp:   FileType,
			name: fPath[len(fPath)-1],
		})
		pathBuckets[addonName] = pathList
	}
	var addonList = make(map[string]SourceMeta)
	for k, v := range addonMetas {
		items := pathBuckets[k]
		sort.Slice(items, func(i, j int) bool {
			return items[i].GetPath() < items[j].GetPath()
		})
		v.Items = pathBuckets[k]
		addonList[k] = v
	}
	return addonList
}

func trimAndSplitPath(absPath string, path2Bucket string) []string {
	const slash = "/"
	var p = absPath
	if path2Bucket != "" {
		p = strings.TrimPrefix(p, path2Bucket)
		p = strings.TrimPrefix(p, "/")
	}
	return strings.Split(p, slash)
}

func (o *ossReader) RelativePath(item Item) string {
	return item.GetPath()
}

// OSSAddonSource is UIData source from alibaba cloud OSS style source
type OSSAddonSource struct {
	Endpoint string `json:"end_point" validate:"required"`
	Bucket   string `json:"bucket"`
	Path     string `json:"path"`
}

func filterEmptyObj(list ListBucketResult) ListBucketResult {
	var actualFiles []File
	for _, f := range list.Files {
		if f.Size > 0 {
			actualFiles = append(actualFiles, f)
		}
	}
	return ListBucketResult{
		Files: actualFiles,
		Count: len(actualFiles),
	}
}