Cloudpods/backend/pkg/mcclient/modulebase/base.go

// Copyright 2019 Yunion
//
// 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 modulebase

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
	"regexp"
	"strings"
	"time"

	"yunion.io/x/jsonutils"
	"yunion.io/x/log"
	"yunion.io/x/pkg/errors"
	"yunion.io/x/pkg/util/httputils"
	"yunion.io/x/pkg/util/printutils"
	"yunion.io/x/pkg/util/sets"

	"yunion.io/x/onecloud/pkg/httperrors"
	"yunion.io/x/onecloud/pkg/mcclient"
)

type BaseManager struct {
	serviceType  string
	endpointType string
	version      string
	// apiVersion   string

	columns      []string
	adminColumns []string

	specificMethods sets.String
}

func NewBaseManager(serviceType, endpointType, version string, columns, adminColumns []string) *BaseManager {
	return &BaseManager{
		serviceType:  serviceType,
		endpointType: endpointType,
		version:      version,
		// apiVersion:   apiVersion,
		columns:         columns,
		adminColumns:    adminColumns,
		specificMethods: sets.NewString(),
	}
}

func (m *BaseManager) GetSpecificMethods() sets.String {
	return m.specificMethods
}

func (m *BaseManager) SetSpecificMethods(ms ...string) {
	m.specificMethods = sets.NewString(ms...)
}

func (this *BaseManager) GetColumns(session *mcclient.ClientSession) []string {
	cols := this.columns
	if session.HasSystemAdminPrivilege() && len(this.adminColumns) > 0 {
		cols = append(cols, this.adminColumns...)
	}
	return cols
}

func (this *BaseManager) SetVersion(v string) {
	this.version = v
}

/*func (this *BaseManager) GetApiVersion() string {
	return this.apiVersion
}*/

func (this *BaseManager) versionedURL(path string) string {
	offset := 0
	for ; path[offset] == '/'; offset++ {
	}
	var ret string
	if len(this.version) > 0 {
		ret = fmt.Sprintf("/%s/%s", this.version, path[offset:])
	} else {
		ret = fmt.Sprintf("/%s", path[offset:])
	}
	// log.Debugf("versionedURL %s %s => %s", this.version, path, ret)
	return ret
}

func (this *BaseManager) jsonRequest(session *mcclient.ClientSession,
	method httputils.THttpMethod, path string,
	header http.Header, body jsonutils.JSONObject) (http.Header, jsonutils.JSONObject, error) {
	hdr, resp, err := session.JSONVersionRequest(this.serviceType, this.endpointType,
		method, this.versionedURL(path),
		header, body)
	if err != nil {
		if e, ok := err.(*httputils.JSONClientError); ok && strings.Contains(e.Details, e.Request.Url) {
			switch e.Class {
			case errors.ErrConnectRefused.Error():
				return nil, nil, httperrors.NewServiceAbnormalError("%s service is abnormal, please check service status", this.serviceType)
			case errors.ErrNetwork.Error():
				return nil, nil, httperrors.NewServiceAbnormalError("%s service is abnormal or network error, please try again", this.serviceType)
			case errors.ErrDNS.Error():
				return nil, nil, httperrors.NewServiceAbnormalError("%s service dns resolve error, please check dns setting", this.serviceType)
			case errors.ErrTimeout.Error():
				return nil, nil, httperrors.NewServiceAbnormalError("%s service request timeout, please try again later", this.serviceType)
			}
		}
		return nil, nil, err
	}
	return hdr, resp, nil
}

func (this *BaseManager) rawRequest(session *mcclient.ClientSession,
	method httputils.THttpMethod, path string,
	header http.Header, body io.Reader) (*http.Response, error) {
	return session.RawVersionRequest(this.serviceType, this.endpointType,
		method, this.versionedURL(path),
		header, body)
}

/*func (this *BaseManager) GetBaseUrl(s *mcclient.ClientSession) (string, error) {
	return s.GetBaseUrl(this.serviceType, this.endpointType)
}*/

func (this *BaseManager) rawBaseUrlRequest(s *mcclient.ClientSession,
	method httputils.THttpMethod, path string,
	header http.Header, body io.Reader) (*http.Response, error) {
	baseUrlF := func(baseurl string) string {
		obj, _ := url.Parse(baseurl)
		lastSlashPos := strings.LastIndex(obj.Path, "/")
		if lastSlashPos >= 0 {
			lastSeg := obj.Path[lastSlashPos+1:]
			verReg := regexp.MustCompile(`^v\d+`)
			if verReg.MatchString(lastSeg) {
				obj.Path = obj.Path[:lastSlashPos]
			}
		}
		ret := obj.String()
		log.Debugf("baseurl %s ret %s", baseurl, ret)
		return ret
	}
	return s.RawBaseUrlRequest(
		this.serviceType, this.endpointType,
		method, this.versionedURL(path),
		header, body, baseUrlF)
}

/*type ListResult struct {
	Data   []jsonutils.JSONObject `json:"data,allowempty"`
	Total  int
	Limit  int
	Offset int

	NextMarker  string
	MarkerField string
	MarkerOrder string
}*/

func ListResult2JSONWithKey(result *printutils.ListResult, key string) jsonutils.JSONObject {
	obj := jsonutils.NewDict()
	if result.Total > 0 {
		obj.Add(jsonutils.NewInt(int64(result.Total)), "total")
	}
	if result.Totals != nil {
		obj.Add(result.Totals, "totals")
	}
	if result.Limit > 0 {
		obj.Add(jsonutils.NewInt(int64(result.Limit)), "limit")
	}
	if result.Offset > 0 {
		obj.Add(jsonutils.NewInt(int64(result.Offset)), "offset")
	}
	if len(result.NextMarker) > 0 || len(result.MarkerField) > 0 {
		obj.Add(jsonutils.NewString(result.NextMarker), "next_marker")
	}
	if len(result.MarkerField) > 0 {
		obj.Add(jsonutils.NewString(result.MarkerField), "marker_field")
	}
	if len(result.MarkerOrder) > 0 {
		obj.Add(jsonutils.NewString(result.MarkerOrder), "marker_order")
	}
	arr := jsonutils.NewArray(result.Data...)
	obj.Add(arr, key)
	return obj
}

func ListResult2JSON(result *printutils.ListResult) jsonutils.JSONObject {
	return ListResult2JSONWithKey(result, "data")
}

func JSON2ListResult(result jsonutils.JSONObject) *printutils.ListResult {
	total, _ := result.Int("total")
	limit, _ := result.Int("limit")
	offset, _ := result.Int("offset")
	nextMarker, _ := result.GetString("next_marker")
	markerField, _ := result.GetString("marker_field")
	markerOrder, _ := result.GetString("marker_order")
	data, _ := result.GetArray("data")
	if len(markerField) == 0 && total == 0 {
		total = int64(len(data))
	}
	totalJson, _ := result.Get("totals")
	return &printutils.ListResult{
		Data:  data,
		Total: int(total), Limit: int(limit), Offset: int(offset),
		Totals:      totalJson,
		NextMarker:  nextMarker,
		MarkerField: markerField,
		MarkerOrder: markerOrder,
	}
}

func (this *BaseManager) _list(session *mcclient.ClientSession, path, responseKey string) (*printutils.ListResult, error) {
	_, body, err := this.jsonRequest(session, "GET", path, nil, nil)
	if err != nil {
		return nil, err
	}
	if body == nil {
		return nil, fmt.Errorf("empty response")
	}
	rets, err := body.GetArray(responseKey)
	if err != nil {
		return nil, errors.Wrapf(err, "key:%s", responseKey)
	}
	nextMarker, _ := body.GetString("next_marker")
	markerField, _ := body.GetString("marker_field")
	markerOrder, _ := body.GetString("marker_order")
	total, _ := body.Int("total")
	limit, _ := body.Int("limit")
	offset, _ := body.Int("offset")
	if len(nextMarker) == 0 && total == 0 {
		total = int64(len(rets))
	}
	totalJson, _ := body.Get("totals")
	return &printutils.ListResult{
		Data:  rets,
		Total: int(total), Limit: int(limit), Offset: int(offset),
		Totals:      totalJson,
		NextMarker:  nextMarker,
		MarkerField: markerField,
		MarkerOrder: markerOrder,
	}, nil
}

func (this *BaseManager) _submit(session *mcclient.ClientSession, method httputils.THttpMethod, path string, body jsonutils.JSONObject, respKey string) (jsonutils.JSONObject, error) {
	hdr, resp, e := this.jsonRequest(session, method, path, nil, body)
	if e != nil {
		return nil, e
	}
	if method == "HEAD" {
		ret := jsonutils.NewDict()
		hdrPrefix := fmt.Sprintf("x-%s-", respKey)
		for k, v := range hdr {
			k = strings.ToLower(k)
			if strings.HasPrefix(k, hdrPrefix) && len(v) > 0 {
				if len(v) == 1 {
					ret.Add(jsonutils.NewString(v[0]), k)
				} else {
					ret.Add(jsonutils.NewStringArray(v), k)
				}
			}
		}
		return ret, nil
	}
	if resp == nil { // no reslt
		return jsonutils.NewDict(), nil
	}
	if len(respKey) == 0 {
		return resp, nil
	}
	ret, e := resp.Get(respKey)
	if e != nil {
		return nil, errors.Wrapf(e, "key:%s", respKey)
	}
	return ret, nil
}

/*type SubmitResult struct {
	Status int
	Id     interface{}
	Data   jsonutils.JSONObject
}*/

//type SubmitResult printutils.SubmitResult

func SubmitResults2JSON(results []printutils.SubmitResult) jsonutils.JSONObject {
	arr := jsonutils.NewArray()
	now := time.Now().In(httperrors.GetTimeZone())
	for _, r := range results {
		obj := jsonutils.NewDict()
		obj.Add(jsonutils.NewInt(int64(r.Status)), "status")
		obj.Add(jsonutils.Marshal(r.Id), "id")
		obj.Add(r.Data, "data")
		if r.Status >= 400 {
			obj.Add(jsonutils.NewString(now.Format(time.RFC3339)), "data", "time")
		}
		arr.Add(obj)
	}
	body := jsonutils.NewDict()
	body.Add(arr, "data")
	return body
}

func SubmitResults2ListResult(results []printutils.SubmitResult) *printutils.ListResult {
	arr := make([]jsonutils.JSONObject, 0)
	for _, r := range results {
		if r.Status == 200 {
			arr = append(arr, r.Data)
		}
	}
	return &printutils.ListResult{Data: arr, Total: len(arr), Limit: 0, Offset: 0}
}

func (this *BaseManager) _batch(session *mcclient.ClientSession, method httputils.THttpMethod, path string, ids []string, body jsonutils.JSONObject, respKey string) []printutils.SubmitResult {
	return BatchDo(ids, func(id string) (jsonutils.JSONObject, error) {
		u := fmt.Sprintf(path, url.PathEscape(id))
		return this._submit(session, method, u, body, respKey)
	})
}

func addResult(results chan printutils.SubmitResult, id interface{}, r jsonutils.JSONObject, e error) {
	if e != nil {
		ecls, ok := e.(*httputils.JSONClientError)
		if ok {
			results <- printutils.SubmitResult{Status: ecls.Code, Id: id, Data: jsonutils.Marshal(ecls)}
		} else {
			results <- printutils.SubmitResult{Status: 400, Id: id, Data: jsonutils.NewString(e.Error())}
		}
	} else {
		results <- printutils.SubmitResult{Status: 200, Id: id, Data: r}
	}
}

func waitResults(results chan printutils.SubmitResult, length int) []printutils.SubmitResult {
	ret := make([]printutils.SubmitResult, length)
	for i := 0; i < length; i++ {
		ret[i] = <-results
	}
	return ret
}

func BatchDo(ids []string, do func(id string) (jsonutils.JSONObject, error)) []printutils.SubmitResult {
	results := make(chan printutils.SubmitResult, len(ids))
	for i := 0; i < len(ids); i++ {
		go func(id string) {
			r, e := do(id)
			addResult(results, id, r, e)
		}(ids[i])
	}
	return waitResults(results, len(ids))
}

func BatchParamsDo(
	ids []string, params []jsonutils.JSONObject,
	do func(id string, param jsonutils.JSONObject) (jsonutils.JSONObject, error),
) []printutils.SubmitResult {
	results := make(chan printutils.SubmitResult, len(ids))
	for i := 0; i < len(ids); i++ {
		go func(id string, param jsonutils.JSONObject) {
			r, e := do(id, param)
			addResult(results, id, r, e)
		}(ids[i], params[i])
	}
	return waitResults(results, len(ids))
}

func BatchDoClassAction(
	batchParams []jsonutils.JSONObject, do func(jsonutils.JSONObject) (jsonutils.JSONObject, error),
) []printutils.SubmitResult {
	results := make(chan printutils.SubmitResult, len(batchParams))
	for i := 0; i < len(batchParams); i++ {
		go func(params jsonutils.JSONObject) {
			r, e := do(params)
			addResult(results, params, r, e)
		}(batchParams[i])
	}
	return waitResults(results, len(batchParams))
}

func (this *BaseManager) _get(session *mcclient.ClientSession, path string, respKey string) (jsonutils.JSONObject, error) {
	/* _, body, err := this.jsonRequest(session, "GET", path, nil, nil)
	   if err != nil {
	       return nil, err
	   }
	   con, err := body.Get(responseKey)
	   if err != nil {
	       return nil, err
	   }
	   return con, nil */
	return this._submit(session, "GET", path, nil, respKey)
}

func (this *BaseManager) _head(session *mcclient.ClientSession, path string, respKey string) (jsonutils.JSONObject, error) {
	return this._submit(session, "HEAD", path, nil, respKey)
}

func (this *BaseManager) _post(session *mcclient.ClientSession, path string, body jsonutils.JSONObject, respKey string) (jsonutils.JSONObject, error) {
	return this._submit(session, "POST", path, body, respKey)
}

func (this *BaseManager) _put(session *mcclient.ClientSession, path string, body jsonutils.JSONObject, respKey string) (jsonutils.JSONObject, error) {
	return this._submit(session, "PUT", path, body, respKey)
}

func (this *BaseManager) _patch(session *mcclient.ClientSession, path string, body jsonutils.JSONObject, respKey string) (jsonutils.JSONObject, error) {
	return this._submit(session, "PATCH", path, body, respKey)
}

func (this *BaseManager) _delete(session *mcclient.ClientSession, path string, body jsonutils.JSONObject, respKey string) (jsonutils.JSONObject, error) {
	return this._submit(session, "DELETE", path, body, respKey)
}