upstream-corteza/extra/server-discovery/searcher/rest/conv.go

package rest

import (
	"encoding/json"
	"fmt"
	"html"
	"reflect"
	"sort"
	"strings"
	"time"

	"github.com/microcosm-cc/bluemonday"
	"github.com/spf13/cast"
)

type (
	// corteza discovery results
	cdResults struct {
		Total struct {
			Value   int    `json:"value"`
			TotalOp string `json:"op"`
		} `json:"-"`

		Hits         []cdHit         `json:"hits"`
		TotalHits    int             `json:"total_hits"`
		Aggregations []cdAggregation `json:"aggregations"`

		pagination

		// Context ldCtx `json:"@context"`
	}

	pagination struct {
		Size         int `json:"size"`
		From         int `json:"from"`
		TotalResults int `json:"total_results"`
	}

	cdHit struct {
		Type  string                 `json:"type"`
		Value map[string]interface{} `json:"value"`
	}

	cdAggregation struct {
		Resource     string              `json:"resource"`
		Name         string              `json:"name"`
		Hits         int                 `json:"hits"`
		ResourceName []cdAggregationHits `json:"resource_name"`
	}

	cdAggregationHits struct {
		Name  string `json:"name"`
		Label string `json:"label"`
		Hits  int    `json:"hits"`
	}
	// ldCtx map[string]interface{}

	createdBy struct {
		UserID   uint64 `json:"userID,string"`
		Email    string `json:"email,omitempty"`
		Name     string `json:"name,omitempty"`
		Username string `json:"username,omitempty"`
		Handle   string `json:"handle,omitempty"`
	}
)

// conv converts results from the backend into corteza-discovery (jsonld-ish) format
func conv(sr *esSearchResponse, aggregation *esSearchResponse, noHits bool, moduleMeta map[string][]string, nsHandleMap map[string]nsMeta, mHandleMap map[string]mMeta, page pagination) (out *cdResults, err error) {
	if sr == nil {
		return
	}

	out = &cdResults{}
	out.Total.Value = sr.Hits.Total.Value
	out.Total.TotalOp = sr.Hits.Total.Relation

	// Pagination
	out.TotalResults = sr.Hits.Total.Value
	out.From = page.From
	out.Size = page.Size

	// Aggregation
	out.Aggregations = []cdAggregation{}

	nsTotalHits := make(map[string]cdAggregationHits)
	mTotalHits := make(map[string]cdAggregationHits)

	aggsRes := sr.Aggregations
	if aggregation != nil {
		aggsRes = aggregation.Aggregations
	}
	// for _, bucket := range aggsRes.Resource.Buckets {
	//	bucketName := getResourceName(bucket.Key)
	//	if bucketName == "User" {
	//		continue
	//	}
	//
	//	for _, subBucket := range bucket.ResourceName.Buckets {
	//		resourceName := subBucket.Key
	//		if bucketName == "Namespace" {
	//			if val, is := nsTotalHits[resourceName]; is {
	//				val.Hits += subBucket.DocCount
	//				nsTotalHits[resourceName] = val
	//			} else {
	//				nsTotalHits[resourceName] = cdAggregationHits{
	//					Name:  resourceName,
	//					Label: nsHandleMap[resourceName],
	//					Hits:  subBucket.DocCount,
	//				}
	//			}
	//		}
	//
	//		if bucketName == "Module" {
	//			if val, is := mTotalHits[resourceName]; is {
	//				val.Hits += subBucket.DocCount
	//				mTotalHits[resourceName] = val
	//			} else {
	//				mTotalHits[resourceName] = cdAggregationHits{
	//					Name:  resourceName,
	//					Label: mHandleMap[resourceName],
	//					Hits:  subBucket.DocCount,
	//				}
	//			}
	//		}
	//	}
	//
	//	// Namespace total aggs hit counts
	//	for _, nsBucket := range bucket.Namespaces.Buckets {
	//		resourceName := nsBucket.Key
	//		if val, is := nsTotalHits[resourceName]; is {
	//			val.Hits += nsBucket.DocCount
	//			nsTotalHits[resourceName] = val
	//		} else {
	//			nsTotalHits[resourceName] = cdAggregationHits{
	//				Name:  resourceName,
	//				Label: nsHandleMap[resourceName],
	//				Hits:  nsBucket.DocCount,
	//			}
	//		}
	//	}
	//
	//	// Module total aggs hit counts
	//	for _, mBucket := range bucket.Modules.Buckets {
	//		resourceName := mBucket.Key
	//		if val, is := mTotalHits[resourceName]; is {
	//			val.Hits += mBucket.DocCount
	//			mTotalHits[resourceName] = val
	//
	//		} else {
	//			mTotalHits[resourceName] = cdAggregationHits{
	//				Name:  resourceName,
	//				Label: mHandleMap[resourceName],
	//				Hits:  mBucket.DocCount,
	//			}
	//		}
	//	}
	// }

	nsAggregation := cdAggregation{
		Name:         "Namespace",
		Resource:     "compose:namespace",
		Hits:         0,
		ResourceName: []cdAggregationHits{},
	}
	for _, bucket := range aggsRes.Namespace.Namespace.Buckets {
		resourceName := bucket.Key

		if val, is := nsTotalHits[resourceName]; is {
			val.Hits += bucket.DocCount
			nsTotalHits[resourceName] = val
		} else {
			var name string
			if nsHandleMap != nil {
				name = nsHandleMap[resourceName].Name
			}
			if len(name) > 0 {
				nsTotalHits[resourceName] = cdAggregationHits{
					Name:  name,
					Label: resourceName,
					Hits:  bucket.DocCount,
				}
			}
		}
	}
	for _, nsHits := range nsTotalHits {
		nsAggregation.Hits += nsHits.Hits
		nsAggregation.ResourceName = append(nsAggregation.ResourceName, nsHits)
	}
	if len(nsAggregation.ResourceName) > 0 {
		sort.Slice(nsAggregation.ResourceName, func(i, j int) bool {
			return nsAggregation.ResourceName[i].Name < nsAggregation.ResourceName[j].Name
		})
		out.Aggregations = append(out.Aggregations, nsAggregation)
	}

	mAggregation := cdAggregation{
		Name:         "Module",
		Resource:     "compose:module",
		Hits:         0,
		ResourceName: []cdAggregationHits{},
	}

	for _, bucket := range aggsRes.Module.Module.Buckets {
		resourceName := bucket.Key

		if val, is := mTotalHits[resourceName]; is {
			val.Hits += bucket.DocCount
			mTotalHits[resourceName] = val
		} else {
			var name string
			if mHandleMap != nil {
				name = mHandleMap[resourceName].Name
			}
			mTotalHits[resourceName] = cdAggregationHits{
				Name:  name,
				Label: resourceName,
				Hits:  bucket.DocCount,
			}
		}
	}

	for _, mHits := range mTotalHits {
		mAggregation.Hits += mHits.Hits
		mAggregation.ResourceName = append(mAggregation.ResourceName, mHits)
	}
	if len(mAggregation.ResourceName) > 0 {
		sort.Slice(mAggregation.ResourceName, func(i, j int) bool {
			return mAggregation.ResourceName[i].Name < mAggregation.ResourceName[j].Name
		})
		out.Aggregations = append(out.Aggregations, mAggregation)
	}

	// if !noHits {
hits:
	for _, h := range sr.Hits.Hits {
		aux := map[string]interface{}{}
		if err = json.Unmarshal(h.Source, &aux); err != nil {
			return
		}

		resType := cast.ToString(aux["resourceType"])
		delete(aux, "resourceType")
		switch resType {
		case "system:user":
			aux["id"] = aux["userID"]
			delete(aux, "userID")

		case "compose:record":
			// @todo: Remove below line and find proper solution for searsia as value needs to be in json
			ssVal := make(map[string]interface{})
			// @todo refactor record related values
			type (
				created struct {
					At *time.Time `json:"at,omitempty"`
					By string     `json:"by,omitempty"`
				}

				record struct {
					Created struct {
						At *time.Time `json:"at,omitempty"`
						By *createdBy `json:"by,omitempty"`
					} `json:"created"`
					Module struct {
						Name     string `json:"name"`
						Handle   string `json:"handle"`
						ModuleId uint64 `json:"moduleId,string"`
					} `json:"module"`
					Namespace struct {
						Name        string `json:"name"`
						Handle      string `json:"handle"`
						NamespaceId uint64 `json:"namespaceId,string"`
					} `json:"namespace"`
					Values      map[string]interface{} `json:"values"`
					ValueLabels map[string]string      `json:"valueLabels"`
				}
			)

			var r record
			if err = json.Unmarshal(h.Source, &r); err != nil {
				return
			}

			type valueJson struct {
				Name  string      `json:"name"`
				Label string      `json:"label"`
				Value interface{} `json:"value"`
			}
			key := fmt.Sprintf("%d-%d", r.Namespace.NamespaceId, r.Module.ModuleId)
			var (
				slice []valueJson
				uc    = created{
					At: r.Created.At,
					By: getCreatedBy(r.Created.By),
				}
			)

			if val, is := moduleMeta[key]; is {
				for _, f := range val {
					slice = append(slice, valueJson{
						Name:  f,
						Label: r.ValueLabels[f],
						Value: sanitize(r.Values[f]),
					})

					if vv, ok := r.Values[f].([]interface{}); ok {
						if len(vv) > 0 {
							ssVal[f] = sanitize(vv[0])
						}
					}
				}
			} else {
				for k, v := range r.Values {
					// @todo hardcoded value
					sanitizedVal := sanitize(v)
					if len(slice) < 5 && sanitizedVal != nil {
						slice = append(slice, valueJson{
							Name:  k,
							Label: r.ValueLabels[k],
							Value: sanitizedVal,
						})

						if vv, ok := v.([]interface{}); ok {
							if len(vv) > 0 {
								ssVal[k] = sanitize(vv[0])
							}
						}
					}
				}
			}

			matching_fields := make(map[string]any)

			for key, value := range h.Highlight {
				newKey := strings.TrimPrefix(key, "values.")
				matching_fields[newKey] = value
			}

			aux["created"] = uc
			aux["customValues"] = ssVal
			aux["values"] = slice
			aux["matching_fields"] = matching_fields
			aux["@id"] = aux["_id"]
			delete(aux, "_id")
			delete(aux, "valueLabels")

		case "compose:namespace":
			aux["@id"] = aux["_id"]
			delete(aux, "_id")
			delete(aux, "Namespace")

		case "compose:module":
			aux["@id"] = aux["_id"]
			delete(aux, "_id")
			delete(aux, "Namespace")
			delete(aux, "Module")

		default:
			continue hits
		}

		out.Hits = append(out.Hits, cdHit{
			Type:  resType,
			Value: aux,
		})
	}
	out.TotalHits = len(out.Hits)
	// }
	return
}

// @todo use RBAC resource stringify
// getResourceName return name of resource based on resource type
func getResourceName(resType string) string {
	switch resType {
	case "system:user":
		return "User"
	case "compose:record":
		return "Record"
	case "compose:namespace":
		return "Namespace"
	case "compose:module":
		return "Module"
	default:
		return "Resource"
	}
}

func getCreatedBy(user *createdBy) string {
	if user == nil {
		return ""
	}
	if len(user.Name) > 0 {
		return user.Name
	} else if len(user.Username) > 0 {
		return user.Username
	} else if len(user.Email) > 0 {
		return user.Email
	} else if user.UserID > 0 {
		return fmt.Sprintf("%d", user.UserID)
	}
	return ""
}

func sanitize(v interface{}) interface{} {
	if v == nil {
		return v
	}

	switch v.(type) {
	case string:
		v = richText(v.(string))
	case []interface{}:
		vv := reflect.ValueOf(v)
		for i, val := range v.([]interface{}) {
			// Wee need to do a failsafe here because we're working with reflect values
			// In case sanitize returns nil, we'll get a runtime panic
			sanitized := sanitize(val)
			var v reflect.Value

			// Since we're working with types, we need the zero value of interface{} over nil
			if sanitized == nil {
				v = reflect.Zero(reflect.TypeOf((*any)(nil)).Elem())
			} else {
				v = reflect.ValueOf(sanitized)
			}
			vv.Index(i).Set(v)
		}
	default:
		return v
	}

	return v
}

// RichText assures safe HTML content
func richText(in string) string {
	// use standard html escaping policy
	p := bluemonday.StrictPolicy()

	sanitized := p.Sanitize(in)

	// handle escaped strings and unescape them
	// all the dangerous chars should have been stripped
	// by now
	return html.UnescapeString(sanitized)
}