1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
|
/*
* Copyright (c) 2013-2017, Jeremy Bingham (<jeremy@goiardi.gl>)
*
* 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 search provides search and index capabilities for goiardi.
package search
import (
"fmt"
"reflect"
"sort"
"strings"
"sync"
"time"
"github.com/ctdk/goiardi/client"
"github.com/ctdk/goiardi/databag"
"github.com/ctdk/goiardi/environment"
"github.com/ctdk/goiardi/indexer"
"github.com/ctdk/goiardi/node"
"github.com/ctdk/goiardi/role"
"github.com/ctdk/goiardi/util"
"github.com/tideland/golib/logger"
)
// Searcher is an interface that any search backend needs to implement. It's
// up to the Searcher to use whatever backend it wants to return the desired
// results.
type Searcher interface {
Search(string, string, int, string, int, map[string]interface{}) ([]map[string]interface{}, error)
GetEndpoints() []string
}
type results struct {
res []map[string]interface{}
sortKey string
}
func (r results) Len() int { return len(r.res) }
func (r results) Swap(i, j int) { r.res[i], r.res[j] = r.res[j], r.res[i] }
func (r results) Less(i, j int) bool {
ibase := r.res[i][r.sortKey]
jbase := r.res[j][r.sortKey]
ival := reflect.ValueOf(ibase)
jval := reflect.ValueOf(jbase)
if (!ival.IsValid() && !jval.IsValid()) || ival.IsValid() && !jval.IsValid() {
return true
} else if !ival.IsValid() && jval.IsValid() {
return false
}
// don't try and compare different types for now. If this ever becomes
// an issue in practice, though, it should be revisited
if ival.Type() == jval.Type() {
switch ibase.(type) {
case int, int8, int32, int64:
return ival.Int() < jval.Int()
case uint, uint8, uint32, uint64:
return ival.Uint() < jval.Uint()
case float32, float64:
return ival.Float() < jval.Float()
case string:
return ival.String() < jval.String()
}
}
return false
}
// SolrQuery holds a parsed query and query chain to run against the index. It's
// called SolrQuery because the search queries use a subset of Solr's syntax.
type SolrQuery struct {
queryChain Queryable
idxName string
docs map[string]indexer.Document
parentOp Op
}
var m *sync.Mutex
func init() {
m = new(sync.Mutex)
}
type TrieSearch struct {
}
// Search parses the given query string and search the given index for any
// matching results.
func (t *TrieSearch) Search(idx string, query string, rows int, sortOrder string, start int, partialData map[string]interface{}) ([]map[string]interface{}, error) {
defer trackSearchTiming(time.Now(), query, inMemSearchTimings)
m.Lock()
defer m.Unlock()
qq := &Tokenizer{Buffer: query}
qq.Init()
if err := qq.Parse(); err != nil {
return nil, err
}
qq.Execute()
qchain := qq.Evaluate()
d := make(map[string]indexer.Document)
solrQ := &SolrQuery{queryChain: qchain, idxName: idx, docs: d}
_, err := solrQ.execute()
if err != nil {
return nil, err
}
qresults := solrQ.results()
objs := getResults(idx, qresults)
res := make([]map[string]interface{}, len(objs))
for i, r := range objs {
switch r := r.(type) {
case *client.Client:
jc := map[string]interface{}{
"name": r.Name,
"chef_type": r.ChefType,
"json_class": r.JSONClass,
"admin": r.Admin,
"public_key": r.PublicKey(),
"validator": r.Validator,
}
res[i] = jc
default:
res[i] = util.MapifyObject(r)
}
}
/* If we're doing partial search, tease out the fields we want. */
if partialData != nil {
res, err = formatPartials(res, objs, partialData)
if err != nil {
return nil, err
}
}
// and at long last, sort
ss := strings.Split(sortOrder, " ")
sortKey := ss[0]
if sortKey == "id" {
sortKey = "name"
}
var ordering string
if len(ss) > 1 {
ordering = strings.ToLower(ss[1])
} else {
ordering = "asc"
}
sortResults := results{res, sortKey}
if ordering == "desc" {
sort.Sort(sort.Reverse(sortResults))
} else {
sort.Sort(sortResults)
}
res = sortResults.res
end := start + rows
if end > len(res) {
end = len(res)
}
res = res[start:end]
return res, nil
}
func (sq *SolrQuery) execute() (map[string]indexer.Document, error) {
s := sq.queryChain
curOp := OpNotAnOp
// set op for subqueries
if sq.parentOp != OpNotAnOp {
curOp = sq.parentOp
}
for s != nil {
var r map[string]indexer.Document
var err error
switch c := s.(type) {
case *SubQuery:
_ = c
newq, nend, nerr := extractSubQuery(s)
if nerr != nil {
return nil, nerr
}
s = nend
var d map[string]indexer.Document
if curOp == OpBinAnd {
d = sq.docs
} else {
d = make(map[string]indexer.Document)
}
nsq := &SolrQuery{queryChain: newq, idxName: sq.idxName, docs: d, parentOp: curOp}
r, err = nsq.execute()
case *NotQuery:
s = s.Next()
continue
default:
if curOp == OpBinAnd {
r, err = s.SearchResults(sq.docs)
} else {
r, err = s.SearchIndex(sq.idxName)
}
}
if err != nil {
return nil, err
}
if len(sq.docs) == 0 || curOp == OpBinAnd { // nothing in place yet
sq.docs = r
} else if curOp == OpBinOr {
for k, v := range r {
sq.docs[k] = v
}
} else {
logger.Debugf("Somehow we got to what should have been an impossible state with search - sq.docs len was %d, op was %s", len(sq.docs), opMap[curOp])
}
curOp = s.Op()
s = s.Next()
}
return sq.docs, nil
}
func extractSubQuery(s Queryable) (Queryable, Queryable, error) {
n := 1
prev := s
s = s.Next()
top := s
for {
logger.Debugf("n: %d s: %T %+v", n, s, s)
switch q := s.(type) {
case *SubQuery:
if q.start {
n++
} else {
n--
}
}
if n == 0 {
// we've followed this subquery chain to its end
prev.SetNext(nil) // snip this chain off at the end
return top, s, nil
}
prev = s
s = s.Next()
if s == nil {
break
}
}
err := fmt.Errorf("Yikes! Somehow we weren't able to finish the subquery.")
return nil, nil, err
}
func (sq *SolrQuery) results() []string {
results := make([]string, len(sq.docs))
n := 0
for k := range sq.docs {
results[n] = k
n++
}
return results
}
// GetEndpoints gets a list from the indexer of all the endpoints available to
// search, namely the defaults (node, role, client, environment) and any data
// bags.
func (t *TrieSearch) GetEndpoints() []string {
// TODO: deal with possible errors
endpoints, _ := indexer.Endpoints()
return endpoints
}
func getResults(variety string, toGet []string) []indexer.Indexable {
var results []indexer.Indexable
if len(toGet) > 0 {
switch variety {
case "node":
ns, _ := node.GetMulti(toGet)
// ....
results = make([]indexer.Indexable, 0, len(ns))
for _, n := range ns {
results = append(results, n)
}
case "role":
rs, _ := role.GetMulti(toGet)
results = make([]indexer.Indexable, 0, len(rs))
for _, r := range rs {
results = append(results, r)
}
case "client":
cs, _ := client.GetMulti(toGet)
results = make([]indexer.Indexable, 0, len(cs))
for _, c := range cs {
results = append(results, c)
}
case "environment":
es, _ := environment.GetMulti(toGet)
results = make([]indexer.Indexable, 0, len(es))
for _, e := range es {
results = append(results, e)
}
default: // It's a data bag
/* These may require further processing later. */
dbag, _ := databag.Get(variety)
if dbag != nil {
ds, _ := dbag.GetMultiDBItems(toGet)
results = make([]indexer.Indexable, 0, len(ds))
for _, d := range ds {
results = append(results, d)
}
}
}
}
return results
}
func partialSearchFormat(results []map[string]interface{}, partialFormat map[string]interface{}) ([]map[string]interface{}, error) {
/* regularize partial search keys */
psearchKeys := make(map[string][]string, len(partialFormat))
for k, v := range partialFormat {
switch v := v.(type) {
case []interface{}:
psearchKeys[k] = make([]string, len(v))
for i, j := range v {
switch j := j.(type) {
case string:
psearchKeys[k][i] = j
default:
err := fmt.Errorf("Partial search key %s badly formatted: %T %v", k, j, j)
return nil, err
}
}
case []string:
psearchKeys[k] = make([]string, len(v))
for i, j := range v {
psearchKeys[k][i] = j
}
default:
err := fmt.Errorf("Partial search key %s badly formatted: %T %v", k, v, v)
return nil, err
}
}
newResults := make([]map[string]interface{}, len(results))
for i, j := range results {
newResults[i] = make(map[string]interface{})
for key, vals := range psearchKeys {
var pval interface{}
/* The first key can either be top or first level.
* Annoying, but that's how it is. */
if len(vals) > 0 {
if step, found := j[vals[0]]; found {
if len(vals) > 1 {
pval = walk(step, vals[1:])
} else {
pval = step
}
} else {
if len(vals) > 0 {
// bear in mind precedence. We need to
// overwrite later values with earlier
// ones.
keyRange := []string{"raw_data", "default", "default_attributes", "normal", "override", "override_attributes", "automatic"}
for _, r := range keyRange {
tval := walk(j[r], vals[0:])
if tval != nil {
switch pv := pval.(type) {
case map[string]interface{}:
// only merge if tval is also a map[string]interface{}
switch tval := tval.(type) {
case map[string]interface{}:
for g, h := range tval {
pv[g] = h
}
pval = pv
}
default:
pval = tval
}
}
}
}
}
}
newResults[i][key] = pval
}
}
return newResults, nil
}
func walk(v interface{}, keys []string) interface{} {
switch v := v.(type) {
case map[string]interface{}:
if _, found := v[keys[0]]; found {
if len(keys) > 1 {
return walk(v[keys[0]], keys[1:])
}
return v[keys[0]]
}
return nil
case map[string]string:
return v[keys[0]]
case map[string][]string:
return v[keys[0]]
default:
if len(keys) == 1 {
return v
}
return nil
}
}
func formatPartials(results []map[string]interface{}, objs []indexer.Indexable, partialData map[string]interface{}) ([]map[string]interface{}, error) {
var err error
results, err = partialSearchFormat(results, partialData)
if err != nil {
return nil, err
}
for x, z := range results {
tmpRes := make(map[string]interface{})
switch ro := objs[x].(type) {
case *databag.DataBagItem:
dbiURL := fmt.Sprintf("/data/%s/%s", ro.DataBagName, ro.RawData["id"].(string))
tmpRes["url"] = util.CustomURL(dbiURL)
default:
tmpRes["url"] = util.ObjURL(objs[x].(util.GoiardiObj))
}
tmpRes["data"] = z
results[x] = tmpRes
}
return results, nil
}
|