filter.go

// Copyright 2014-2022 Aerospike, Inc.
//
// 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 aerospike

import (
	"fmt"

	kvs "github.com/aerospike/aerospike-client-go/v7/proto/kvs"
	ParticleType "github.com/aerospike/aerospike-client-go/v7/types/particle_type"
)

// Filter specifies a query filter definition.
type Filter struct {
	name              string
	idxType           IndexCollectionType
	valueParticleType int
	begin             Value
	end               Value
	ctx               []*CDTContext
}

// NewEqualFilter creates a new equality filter instance for query.
// Value can be an integer, string or a blob (byte array). Byte arrays are only supported on server v7+.
func NewEqualFilter(binName string, value interface{}, ctx ...*CDTContext) *Filter {
	val := NewValue(value)
	return NewFilter(binName, ICT_DEFAULT, val.GetType(), val, val, ctx)
}

// NewRangeFilter creates a range filter for query.
// Range arguments must be int64 values.
// String ranges are not supported.
func NewRangeFilter(binName string, begin int64, end int64, ctx ...*CDTContext) *Filter {
	vBegin, vEnd := NewValue(begin), NewValue(end)
	return NewFilter(binName, ICT_DEFAULT, vBegin.GetType(), vBegin, vEnd, ctx)
}

// NewContainsFilter creates a contains filter for query on collection index.
// Value can be an integer, string or a blob (byte array). Byte arrays are only supported on server v7+.
func NewContainsFilter(binName string, indexCollectionType IndexCollectionType, value interface{}, ctx ...*CDTContext) *Filter {
	v := NewValue(value)
	return NewFilter(binName, indexCollectionType, v.GetType(), v, v, ctx)
}

// NewContainsRangeFilter creates a contains filter for query on ranges of data in a collection index.
func NewContainsRangeFilter(binName string, indexCollectionType IndexCollectionType, begin, end int64, ctx ...*CDTContext) *Filter {
	vBegin, vEnd := NewValue(begin), NewValue(end)
	return NewFilter(binName, indexCollectionType, vBegin.GetType(), vBegin, vEnd, ctx)
}

// NewGeoWithinRegionFilter creates a geospatial "within region" filter for query.
// Argument must be a valid GeoJSON region.
func NewGeoWithinRegionFilter(binName, region string, ctx ...*CDTContext) *Filter {
	v := NewStringValue(region)
	return NewFilter(binName, ICT_DEFAULT, ParticleType.GEOJSON, v, v, ctx)
}

// NewGeoWithinRegionForCollectionFilter creates a geospatial "within region" filter for query on collection index.
// Argument must be a valid GeoJSON region.
func NewGeoWithinRegionForCollectionFilter(binName string, collectionType IndexCollectionType, region string, ctx ...*CDTContext) *Filter {
	v := NewStringValue(region)
	return NewFilter(binName, collectionType, ParticleType.GEOJSON, v, v, ctx)
}

// NewGeoRegionsContainingPointFilter creates a geospatial "containing point" filter for query.
// Argument must be a valid GeoJSON point.
func NewGeoRegionsContainingPointFilter(binName, point string, ctx ...*CDTContext) *Filter {
	v := NewStringValue(point)
	return NewFilter(binName, ICT_DEFAULT, ParticleType.GEOJSON, v, v, ctx)
}

// NewGeoRegionsContainingPointForCollectionFilter creates a geospatial "containing point" filter for query on collection index.
// Argument must be a valid GeoJSON point.
func NewGeoRegionsContainingPointForCollectionFilter(binName string, collectionType IndexCollectionType, point string, ctx ...*CDTContext) *Filter {
	v := NewStringValue(point)
	return NewFilter(binName, collectionType, ParticleType.GEOJSON, v, v, ctx)
}

// NewGeoWithinRadiusFilter creates a geospatial "within radius" filter for query.
// Arguments must be valid longitude/latitude/radius (meters) values.
func NewGeoWithinRadiusFilter(binName string, lng, lat, radius float64, ctx ...*CDTContext) *Filter {
	rgnStr := fmt.Sprintf("{ \"type\": \"AeroCircle\", "+"\"coordinates\": [[%.8f, %.8f], %f] }", lng, lat, radius)
	return NewFilter(binName, ICT_DEFAULT, ParticleType.GEOJSON, NewValue(rgnStr), NewValue(rgnStr), ctx)
}

// NewGeoWithinRadiusForCollectionFilter creates a geospatial "within radius" filter for query on collection index.
// Arguments must be valid longitude/latitude/radius (meters) values.
func NewGeoWithinRadiusForCollectionFilter(binName string, collectionType IndexCollectionType, lng, lat, radius float64, ctx ...*CDTContext) *Filter {
	rgnStr := fmt.Sprintf("{ \"type\": \"AeroCircle\", "+"\"coordinates\": [[%.8f, %.8f], %f] }", lng, lat, radius)
	return NewFilter(binName, collectionType, ParticleType.GEOJSON, NewValue(rgnStr), NewValue(rgnStr), ctx)
}

// Create a filter for query.
// Range arguments must be longs or integers which can be cast to longs.
// String ranges are not supported.
func NewFilter(name string, indexCollectionType IndexCollectionType, valueParticleType int, begin Value, end Value, ctx []*CDTContext) *Filter {
	return &Filter{
		name:              name,
		idxType:           indexCollectionType,
		valueParticleType: valueParticleType,
		begin:             begin,
		end:               end,
		ctx:               ctx,
	}
}

func (fltr *Filter) String() string {
	return fmt.Sprintf("Filter: {name: %s, index type: %s, value particle type: %d, begin: %s, end: %s, context: %v}",
		fltr.name,
		fltr.idxType,
		fltr.valueParticleType,
		fltr.begin,
		fltr.end,
		fltr.ctx,
	)
}

func (fltr *Filter) grpc() *kvs.Filter {
	if fltr == nil {
		return nil
	}

	res := &kvs.Filter{
		Name:      fltr.name,
		ColType:   fltr.idxType.grpc(),
		PackedCtx: fltr.grpcPackCtxPayload(),
		ValType:   int32(fltr.valueParticleType),
		Begin:     grpcValuePacked(fltr.begin),
		End:       grpcValuePacked(fltr.end),
	}

	return res
}

// IndexCollectionType returns filter's index type.
func (fltr *Filter) IndexCollectionType() IndexCollectionType {
	return fltr.idxType
}

// EstimateSize will estimate the size of the filter for wire protocol
func (fltr *Filter) EstimateSize() (int, Error) {
	// bin name size(1) + particle type size(1) + begin particle size(4) + end particle size(4) = 10
	szBegin, err := fltr.begin.EstimateSize()
	if err != nil {
		return szBegin, err
	}

	szEnd, err := fltr.end.EstimateSize()
	if err != nil {
		return szEnd, err
	}

	return len(fltr.name) + szBegin + szEnd + 10, nil
}

func (fltr *Filter) grpcPackCtxPayload() []byte {
	sz, err := fltr.estimatePackedCtxSize()
	if err != nil {
		panic(err)
	}
	buf := newBuffer(sz)
	if _, err := fltr.packCtx(buf); err != nil {
		panic(err)
	}
	return buf.Bytes()
}

// Retrieve packed Context.
// For internal use only.
func (fltr *Filter) packCtx(cmd BufferEx) (sz int, err Error) {
	if len(fltr.ctx) > 0 {
		sz, err = cdtContextList(fltr.ctx).packArray(cmd)
	}
	return sz, err
}

// Retrieve packed Context size.
// For internal use only.
func (fltr *Filter) estimatePackedCtxSize() (sz int, err Error) {
	if len(fltr.ctx) > 0 {
		sz, err = cdtContextList(fltr.ctx).packArray(nil)
	}
	return sz, err
}

func (fltr *Filter) write(cmd *baseCommand) (int, Error) {
	size := 0

	// Write name length
	cmd.WriteByte(byte(len(fltr.name)))
	size++

	// Write Name
	n, err := cmd.WriteString(fltr.name)
	if err != nil {
		return size + n, err
	}
	size += n

	// Write particle type.
	cmd.WriteByte(byte(fltr.valueParticleType))
	size++

	// Write filter begin.
	esz, err := fltr.begin.EstimateSize()
	if err != nil {
		return size, err
	}

	n = cmd.WriteInt32(int32(esz))
	size += n

	n, err = fltr.begin.write(cmd)
	if err != nil {
		return size + n, err
	}
	size += n

	// Write filter end.
	esz, err = fltr.end.EstimateSize()
	if err != nil {
		return size, err
	}

	n = cmd.WriteInt32(int32(esz))
	size += n

	n, err = fltr.end.write(cmd)
	if err != nil {
		return size + n, err
	}
	size += n

	return size, nil
}