bleve.go

package provider

import (
	"errors"
	"fmt"
	"strconv"
	"strings"

	"github.com/CiscoM31/godata"
	"github.com/blevesearch/bleve"
	"github.com/blevesearch/bleve/search/query"
)

func init() {
	// add (ap)prox filter
	godata.GlobalFilterTokenizer = FilterTokenizer()
	godata.GlobalFilterParser.DefineOperator("ap", 2, godata.OpAssociationLeft, 4, false)
}

// BuildBleveQuery converts a GoDataFilterQuery into a bleve query
func BuildBleveQuery(r *godata.GoDataFilterQuery) (query.Query, error) {
	return recursiveBuildQuery(r.Tree)
}

// Builds the filter recursively using DFS
func recursiveBuildQuery(n *godata.ParseNode) (query.Query, error) {
	if n.Token.Type == godata.FilterTokenFunc {
		switch n.Token.Value {
		case "startswith":
			if len(n.Children) != 2 {
				return nil, errors.New("startswith match must have two children")
			}
			if n.Children[0].Token.Type != godata.FilterTokenLiteral {
				return nil, errors.New("startswith expected a literal as the first param")
			}
			if n.Children[1].Token.Type != godata.FilterTokenString {
				return nil, errors.New("startswith expected a string as the second param")
			} // remove enclosing ' of string tokens (looks like 'some ol'' string')
			value := n.Children[1].Token.Value[1 : len(n.Children[1].Token.Value)-1]
			// unescape '' as '
			unescaped := strings.ReplaceAll(value, "''", "'")
			q := bleve.NewPrefixQuery(unescaped)
			q.SetField(n.Children[0].Token.Value)
			return q, nil
			// TODO contains as regex?
			// TODO endswith as regex?
		default:
			return nil, godata.NotImplementedError(n.Token.Value + " is not implemented.")
		}
	}
	if n.Token.Type == godata.FilterTokenLogical {
		switch n.Token.Value {
		case "eq":
			if len(n.Children) != 2 {
				return nil, errors.New("equality match must have two children")
			}
			if n.Children[0].Token.Type != godata.FilterTokenLiteral {
				return nil, errors.New("equality expected a literal on the lhs")
			}
			if n.Children[1].Token.Type == godata.FilterTokenString {
				// for escape rules see http://docs.oasis-open.org/odata/odata/v4.01/cs01/part2-url-conventions/odata-v4.01-cs01-part2-url-conventions.html#sec_URLComponents
				// remove enclosing ' of string tokens (looks like 'some ol'' string')
				value := n.Children[1].Token.Value[1 : len(n.Children[1].Token.Value)-1]
				// unescape '' as '
				unescaped := strings.ReplaceAll(value, "''", "'")
				// use a match query, so the field mapping, e.g. lowercase is applied to the value
				// remember we defined the field mapping for `preferred_name` to be lowercase
				// a term query like `preferred_name eq 'Artur'` would use `Artur` to search in the index and come up empty
				// a match query will apply the field mapping (lowercasing `Artur` to `artur`) before doing the search
				// TODO there is a mismatch between the LDAP and odata filters:
				// - LDAP matching rules depend on the attribute: see https://ldapwiki.com/wiki/MatchingRule
				// - odata has functions like `startswith`, `contains`, `tolower`, `toupper`, `matchesPattern` andy more: see http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_BuiltinQueryFunctions
				// - ocis-glauth should do the mapping between LDAP and odata filter
				q := bleve.NewMatchQuery(unescaped)
				q.SetField(n.Children[0].Token.Value)
				return q, nil
			} else if n.Children[1].Token.Type == godata.FilterTokenInteger {
				v, err := strconv.ParseFloat(n.Children[1].Token.Value, 64)
				if err != nil {
					return nil, err
				}
				incl := true
				q := bleve.NewNumericRangeInclusiveQuery(&v, &v, &incl, &incl)
				q.SetField(n.Children[0].Token.Value)
				return q, nil
			}
			return nil, fmt.Errorf("equality expected a string or int on the rhs, got %d", n.Children[1].Token.Type)
		case "and":
			q := query.NewConjunctionQuery([]query.Query{})
			for _, child := range n.Children {
				subQuery, err := recursiveBuildQuery(child)
				if err != nil {
					return nil, err
				}
				if subQuery != nil {
					q.AddQuery(subQuery)
				}
			}
			return q, nil
		case "or":
			q := query.NewDisjunctionQuery([]query.Query{})
			for _, child := range n.Children {
				subQuery, err := recursiveBuildQuery(child)
				if err != nil {
					return nil, err
				}
				if subQuery != nil {
					q.AddQuery(subQuery)
				}
			}
			return q, nil
		case "Not":
			if len(n.Children) != 1 {
				return nil, errors.New("not filter must have only one child")
			}
			subQuery, err := recursiveBuildQuery(n.Children[0])
			if err != nil {
				return nil, err
			}
			q := query.NewBooleanQuery(nil, nil, []query.Query{subQuery})
			return q, nil
		default:
			return nil, godata.NotImplementedError(n.Token.Value + " is not implemented.")
		}
	}

	return nil, godata.NotImplementedError(n.Token.Value + " is not implemented.")
}