-
Notifications
You must be signed in to change notification settings - Fork 0
/
query.go
1884 lines (1704 loc) · 52.6 KB
/
query.go
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
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
Copyright 2013 The Camlistore Authors
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
import (
"bytes"
"encoding/json"
"errors"
"fmt"
"io"
"log"
"math"
"net/http"
"os"
"reflect"
"sort"
"strconv"
"strings"
"sync"
"time"
"camlistore.org/pkg/blob"
"camlistore.org/pkg/index"
"camlistore.org/pkg/types/camtypes"
"context"
"go4.org/strutil"
"go4.org/types"
)
type SortType int
const (
UnspecifiedSort SortType = iota
Unsorted
LastModifiedDesc
LastModifiedAsc
CreatedDesc
CreatedAsc
BlobRefAsc
// MapSort requests that any limited search results are optimized
// for rendering on a map. If there are fewer matches than the
// requested limit, no results are pruned. When limiting results,
// MapSort prefers results spread around the map before clustering
// items too tightly.
MapSort
maxSortType
)
var sortName = map[SortType][]byte{
Unsorted: []byte(`"unsorted"`),
LastModifiedDesc: []byte(`"-mod"`),
LastModifiedAsc: []byte(`"mod"`),
CreatedDesc: []byte(`"-created"`),
CreatedAsc: []byte(`"created"`),
BlobRefAsc: []byte(`"blobref"`),
MapSort: []byte(`"map"`),
}
func (t SortType) MarshalJSON() ([]byte, error) {
v, ok := sortName[t]
if !ok {
panic("unnamed SortType " + strconv.Itoa(int(t)))
}
return v, nil
}
func (t *SortType) UnmarshalJSON(v []byte) error {
for n, nv := range sortName {
if bytes.Equal(v, nv) {
*t = n
return nil
}
}
return fmt.Errorf("Bogus search sort type %q", v)
}
type SearchQuery struct {
// Exactly one of Expression or Contraint must be set.
// If an Expression is set, it's compiled to a Constraint.
// Expression is a textual search query in minimal form,
// e.g. "hawaii before:2008" or "tag:foo" or "foo" or "location:portland"
// See expr.go and expr_test.go for all the operators.
Expression string `json:"expression,omitempty"`
Constraint *Constraint `json:"constraint,omitempty"`
// Limit is the maximum number of returned results. A negative value means no
// limit. If unspecified, a default (of 200) will be used.
Limit int `json:"limit,omitempty"`
// Sort specifies how the results will be sorted. It defaults to CreatedDesc when the
// query is about permanodes only.
Sort SortType `json:"sort,omitempty"`
// Around specifies that the results, after sorting, should be centered around
// this result. If Around is not found the returned results will be empty.
// If both Continue and Around are set, an error is returned.
Around blob.Ref `json:"around,omitempty"`
// Continue specifies the opaque token (as returned by a
// SearchResult) for where to continue fetching results when
// the Limit on a previous query was interrupted.
// Continue is only valid for the same query (Expression or Constraint),
// Limit, and Sort values.
// If empty, the top-most query results are returned, as given
// by Limit and Sort.
// Continue is not compatible with the Around option.
Continue string `json:"continue,omitempty"`
// If Describe is specified, the matched blobs are also described,
// as if the Describe.BlobRefs field was populated.
Describe *DescribeRequest `json:"describe,omitempty"`
}
func (q *SearchQuery) URLSuffix() string { return "camli/search/query" }
func (q *SearchQuery) FromHTTP(req *http.Request) error {
dec := json.NewDecoder(io.LimitReader(req.Body, 1<<20))
if err := dec.Decode(q); err != nil {
return err
}
if q.Constraint == nil && q.Expression == "" {
return errors.New("query must have at least a constraint or an expression")
}
return nil
}
// exprQuery optionally specifies the *SearchQuery prototype that was generated
// by parsing the search expression
func (q *SearchQuery) plannedQuery(expr *SearchQuery) *SearchQuery {
pq := new(SearchQuery)
*pq = *q
if expr != nil {
pq.Constraint = expr.Constraint
if expr.Sort != 0 {
pq.Sort = expr.Sort
}
if expr.Limit != 0 {
pq.Limit = expr.Limit
}
}
if pq.Sort == UnspecifiedSort {
if pq.Constraint.onlyMatchesPermanode() {
pq.Sort = CreatedDesc
}
}
if pq.Limit == 0 {
pq.Limit = 200 // arbitrary
}
if err := pq.addContinueConstraint(); err != nil {
log.Printf("Ignoring continue token: %v", err)
}
pq.Constraint = optimizePlan(pq.Constraint)
return pq
}
// For permanodes, the continue token is (currently!)
// of form "pn:nnnnnnn:sha1-xxxxx" where "pn" is a
// literal, "nnnnnn" is the UnixNano of the time
// (modified or created) and "sha1-xxxxx" was the item
// seen in the final result set, used as a tie breaker
// if multiple permanodes had the same mod/created
// time. This format is NOT an API promise or standard and
// clients should not rely on it. It may change without notice
func parsePermanodeContinueToken(v string) (t time.Time, br blob.Ref, ok bool) {
if !strings.HasPrefix(v, "pn:") {
return
}
v = v[len("pn:"):]
col := strings.Index(v, ":")
if col < 0 {
return
}
nano, err := strconv.ParseUint(v[:col], 10, 64)
if err != nil {
return
}
t = time.Unix(0, int64(nano))
br, ok = blob.Parse(v[col+1:])
return
}
// addContinueConstraint conditionally modifies q.Constraint to scroll
// past the results as indicated by q.Continue.
func (q *SearchQuery) addContinueConstraint() error {
cont := q.Continue
if cont == "" {
return nil
}
if q.Constraint.onlyMatchesPermanode() {
tokent, lastbr, ok := parsePermanodeContinueToken(cont)
if !ok {
return errors.New("Unexpected continue token")
}
if q.Sort == LastModifiedDesc || q.Sort == CreatedDesc {
var lastMod, lastCreated time.Time
switch q.Sort {
case LastModifiedDesc:
lastMod = tokent
case CreatedDesc:
lastCreated = tokent
}
baseConstraint := q.Constraint
q.Constraint = &Constraint{
Logical: &LogicalConstraint{
Op: "and",
A: &Constraint{
Permanode: &PermanodeConstraint{
Continue: &PermanodeContinueConstraint{
LastCreated: lastCreated,
LastMod: lastMod,
Last: lastbr,
},
},
},
B: baseConstraint,
},
}
}
return nil
}
return errors.New("token not valid for query type")
}
func (q *SearchQuery) checkValid(ctx context.Context) (sq *SearchQuery, err error) {
if q.Sort >= maxSortType || q.Sort < 0 {
return nil, errors.New("invalid sort type")
}
if q.Continue != "" && q.Around.Valid() {
return nil, errors.New("Continue and Around parameters are mutually exclusive")
}
if q.Sort == MapSort && (q.Continue != "" || q.Around.Valid()) {
return nil, errors.New("Continue or Around parameters are not available with MapSort")
}
if q.Constraint == nil {
if expr := q.Expression; expr != "" {
sq, err := parseExpression(ctx, expr)
if err != nil {
return nil, fmt.Errorf("Error parsing search expression %q: %v", expr, err)
}
if err := sq.Constraint.checkValid(); err != nil {
return nil, fmt.Errorf("Internal error: parseExpression(%q) returned invalid constraint: %v", expr, err)
}
return sq, nil
}
return nil, errors.New("no search constraint or expression")
}
return nil, q.Constraint.checkValid()
}
// SearchResult is the result of the Search method for a given SearchQuery.
type SearchResult struct {
Blobs []*SearchResultBlob `json:"blobs"`
Describe *DescribeResponse `json:"description"`
// LocationArea is non-nil if the search result mentioned any location terms. It
// is the bounds of the locations of the matched permanodes, for the permanodes
// with locations.
LocationArea *camtypes.LocationBounds
// Continue optionally specifies the continuation token to to
// continue fetching results in this result set, if interrupted
// by a Limit.
Continue string `json:"continue,omitempty"`
}
type SearchResultBlob struct {
Blob blob.Ref `json:"blob"`
// ... file info, permanode info, blob info ... ?
}
func (r *SearchResultBlob) String() string {
return fmt.Sprintf("[blob: %s]", r.Blob)
}
// Constraint specifies a blob matching constraint.
// A blob matches if it matches all non-zero fields' predicates.
// A zero constraint matches nothing.
type Constraint struct {
// If Logical is non-nil, all other fields are ignored.
Logical *LogicalConstraint `json:"logical,omitempty"`
// Anything, if true, matches all blobs.
Anything bool `json:"anything,omitempty"`
CamliType string `json:"camliType,omitempty"` // camliType of the JSON blob
AnyCamliType bool `json:"anyCamliType,omitempty"` // if true, any camli JSON blob matches
BlobRefPrefix string `json:"blobRefPrefix,omitempty"`
File *FileConstraint `json:"file,omitempty"`
Dir *DirConstraint `json:"dir,omitempty"`
Claim *ClaimConstraint `json:"claim,omitempty"`
BlobSize *IntConstraint `json:"blobSize,omitempty"`
Permanode *PermanodeConstraint `json:"permanode,omitempty"`
matcherOnce sync.Once
matcherFn matchFn
}
func (c *Constraint) checkValid() error {
type checker interface {
checkValid() error
}
if c.Claim != nil {
return errors.New("TODO: implement ClaimConstraint")
}
for _, cv := range []checker{
c.Logical,
c.File,
c.Dir,
c.BlobSize,
c.Permanode,
} {
if err := cv.checkValid(); err != nil {
return err
}
}
return nil
}
func (c *Constraint) onlyMatchesPermanode() bool {
if c.Permanode != nil || c.CamliType == "permanode" {
return true
}
if c.Logical != nil && c.Logical.Op == "and" {
if c.Logical.A.onlyMatchesPermanode() || c.Logical.B.onlyMatchesPermanode() {
return true
}
}
// TODO: There are other cases we can return true here, like:
// Logical:{Op:'or', A:PermanodeConstraint{...}, B:PermanodeConstraint{...}
return false
}
func (c *Constraint) matchesFileByWholeRef() bool {
if c.Logical != nil && c.Logical.Op == "and" {
if c.Logical.A.matchesFileByWholeRef() || c.Logical.B.matchesFileByWholeRef() {
return true
}
}
if c.File == nil {
return false
}
return c.File.WholeRef.Valid()
}
type FileConstraint struct {
// (All non-zero fields must match)
FileSize *IntConstraint `json:"fileSize,omitempty"`
FileName *StringConstraint `json:"fileName,omitempty"`
MIMEType *StringConstraint `json:"mimeType,omitempty"`
Time *TimeConstraint `json:"time,omitempty"`
ModTime *TimeConstraint `json:"modTime,omitempty"`
// WholeRef if non-zero only matches if the entire checksum of the
// file (the concatenation of all its blobs) is equal to the
// provided blobref. The index may not have every file's digest for
// every known hash algorithm.
WholeRef blob.Ref `json:"wholeRef,omitempty"`
// For images:
IsImage bool `json:"isImage,omitempty"`
EXIF *EXIFConstraint `json:"exif,omitempty"` // TODO: implement
Width *IntConstraint `json:"width,omitempty"`
Height *IntConstraint `json:"height,omitempty"`
WHRatio *FloatConstraint `json:"widthHeightRation,omitempty"`
Location *LocationConstraint `json:"location,omitempty"`
// MediaTag is for ID3 (and similar) embedded metadata in files.
MediaTag *MediaTagConstraint `json:"mediaTag,omitempty"`
}
type MediaTagConstraint struct {
// Tag is the tag to match.
// For ID3, this includes: title, artist, album, genre, musicbrainzalbumid, year, track, disc, mediaref, durationms.
Tag string `json:"tag"`
String *StringConstraint `json:"string,omitempty"`
Int *IntConstraint `json:"int,omitempty"`
}
type DirConstraint struct {
// (All non-zero fields must match)
// TODO: implement. mostly need more things in the index.
FileName *StringConstraint `json:"fileName,omitempty"`
TopFileSize, // not recursive
TopFileCount, // not recursive
FileSize,
FileCount *IntConstraint
// TODO: these would need thought on how to index efficiently:
// (Also: top-only variants?)
// ContainsFile *FileConstraint
// ContainsDir *DirConstraint
}
// An IntConstraint specifies constraints on an integer.
type IntConstraint struct {
// Min and Max are both optional and inclusive bounds.
// Zero means don't check.
Min int64 `json:"min,omitempty"`
Max int64 `json:"max,omitempty"`
ZeroMin bool `json:"zeroMin,omitempty"` // if true, min is actually zero
ZeroMax bool `json:"zeroMax,omitempty"` // if true, max is actually zero
}
func (c *IntConstraint) hasMin() bool { return c.Min != 0 || c.ZeroMin }
func (c *IntConstraint) hasMax() bool { return c.Max != 0 || c.ZeroMax }
func (c *IntConstraint) checkValid() error {
if c == nil {
return nil
}
if c.ZeroMin && c.Min != 0 {
return errors.New("in IntConstraint, can't set both ZeroMin and Min")
}
if c.ZeroMax && c.Max != 0 {
return errors.New("in IntConstraint, can't set both ZeroMax and Max")
}
if c.hasMax() && c.hasMin() && c.Min > c.Max {
return errors.New("in IntConstraint, min is greater than max")
}
return nil
}
func (c *IntConstraint) intMatches(v int64) bool {
if c.hasMin() && v < c.Min {
return false
}
if c.hasMax() && v > c.Max {
return false
}
return true
}
// A FloatConstraint specifies constraints on a float.
type FloatConstraint struct {
// Min and Max are both optional and inclusive bounds.
// Zero means don't check.
Min float64 `json:"min,omitempty"`
Max float64 `json:"max,omitempty"`
ZeroMin bool `json:"zeroMin,omitempty"` // if true, min is actually zero
ZeroMax bool `json:"zeroMax,omitempty"` // if true, max is actually zero
}
func (c *FloatConstraint) hasMin() bool { return c.Min != 0 || c.ZeroMin }
func (c *FloatConstraint) hasMax() bool { return c.Max != 0 || c.ZeroMax }
func (c *FloatConstraint) checkValid() error {
if c == nil {
return nil
}
if c.ZeroMin && c.Min != 0 {
return errors.New("in FloatConstraint, can't set both ZeroMin and Min")
}
if c.ZeroMax && c.Max != 0 {
return errors.New("in FloatConstraint, can't set both ZeroMax and Max")
}
if c.hasMax() && c.hasMin() && c.Min > c.Max {
return errors.New("in FloatConstraint, min is greater than max")
}
return nil
}
func (c *FloatConstraint) floatMatches(v float64) bool {
if c.hasMin() && v < c.Min {
return false
}
if c.hasMax() && v > c.Max {
return false
}
return true
}
type EXIFConstraint struct {
// TODO. need to put this in the index probably.
// Maybe: GPS *LocationConstraint
// ISO, Aperature, Camera Make/Model, etc.
}
type LocationConstraint struct {
// Any, if true, matches any photo with a known location.
Any bool
// North, West, East, and South define a region in which a photo
// must be in order to match.
North float64
West float64
East float64
South float64
}
func (c *LocationConstraint) matchesLatLong(lat, long float64) bool {
if c.Any {
return true
}
if !(c.South <= lat && lat <= c.North) {
return false
}
if c.West < c.East {
return c.West <= long && long <= c.East
}
// boundary spanning longitude ±180°
return c.West <= long || long <= c.East
}
// A StringConstraint specifies constraints on a string.
// All non-zero must match.
type StringConstraint struct {
Empty bool `json:"empty,omitempty"` // matches empty string
Equals string `json:"equals,omitempty"`
Contains string `json:"contains,omitempty"`
HasPrefix string `json:"hasPrefix,omitempty"`
HasSuffix string `json:"hasSuffix,omitempty"`
ByteLength *IntConstraint `json:"byteLength,omitempty"` // length in bytes (not chars)
CaseInsensitive bool `json:"caseInsensitive,omitempty"`
// TODO: CharLength (assume UTF-8)
}
// stringCompareFunc contains a function to get a value from a StringConstraint and a second function to compare it
// against the string s that's being matched.
type stringConstraintFunc struct {
v func(*StringConstraint) string
fn func(s, v string) bool
}
// Functions to compare fields of a StringConstraint against strings in a case-sensitive manner.
var stringConstraintFuncs = []stringConstraintFunc{
{func(c *StringConstraint) string { return c.Equals }, func(a, b string) bool { return a == b }},
{func(c *StringConstraint) string { return c.Contains }, strings.Contains},
{func(c *StringConstraint) string { return c.HasPrefix }, strings.HasPrefix},
{func(c *StringConstraint) string { return c.HasSuffix }, strings.HasSuffix},
}
// Functions to compare fields of a StringConstraint against strings in a case-insensitive manner.
var stringConstraintFuncsFold = []stringConstraintFunc{
{func(c *StringConstraint) string { return c.Equals }, strings.EqualFold},
{func(c *StringConstraint) string { return c.Contains }, strutil.ContainsFold},
{func(c *StringConstraint) string { return c.HasPrefix }, strutil.HasPrefixFold},
{func(c *StringConstraint) string { return c.HasSuffix }, strutil.HasSuffixFold},
}
func (c *StringConstraint) stringMatches(s string) bool {
if c.Empty && len(s) > 0 {
return false
}
if c.ByteLength != nil && !c.ByteLength.intMatches(int64(len(s))) {
return false
}
funcs := stringConstraintFuncs
if c.CaseInsensitive {
funcs = stringConstraintFuncsFold
}
for _, pair := range funcs {
if v := pair.v(c); v != "" && !pair.fn(s, v) {
return false
}
}
return true
}
type TimeConstraint struct {
Before types.Time3339 `json:"before"` // <
After types.Time3339 `json:"after"` // >=
// TODO: this won't JSON-marshal/unmarshal well. Make a time.Duration marshal type?
// Likewise with time that supports omitempty?
InLast time.Duration `json:"inLast"` // >=
}
type ClaimConstraint struct {
SignedBy string `json:"signedBy"` // identity
SignedAfter time.Time `json:"signedAfter"`
SignedBefore time.Time `json:"signedBefore"`
}
func (c *ClaimConstraint) checkValid() error {
return errors.New("TODO: implement blobMatches and checkValid on ClaimConstraint")
}
type LogicalConstraint struct {
Op string `json:"op"` // "and", "or", "xor", "not"
A *Constraint `json:"a"`
B *Constraint `json:"b"` // only valid if Op != "not"
}
// PermanodeConstraint matches permanodes.
type PermanodeConstraint struct {
// At specifies the time at which to pretend we're resolving attributes.
// Attribute claims after this point in time are ignored.
// If zero, the current time is used.
At time.Time `json:"at,omitempty"`
// ModTime optionally matches on the last modtime of the permanode.
ModTime *TimeConstraint `json:"modTime,omitempty"`
// Time optionally matches the permanode's time. A Permanode
// may not have a known time. If the permanode does not have a
// known time, one may be guessed if the top-level search
// parameters request so.
Time *TimeConstraint `json:"time,omitempty"`
// Attr optionally specifies the attribute to match.
// e.g. "camliContent", "camliMember", "tag"
// This is required if any of the items below are used.
Attr string `json:"attr,omitempty"`
// SkipHidden skips hidden or other boring files.
SkipHidden bool `json:"skipHidden,omitempty"`
// NumValue optionally tests the number of values this
// permanode has for Attr.
NumValue *IntConstraint `json:"numValue,omitempty"`
// ValueAll modifies the matching behavior when an attribute
// is multi-valued. By default, when ValueAll is false, only
// one value of a multi-valued attribute needs to match. If
// ValueAll is true, all attributes must match.
ValueAll bool `json:"valueAllMatch,omitempty"`
// Value specifies an exact string to match.
// This is a convenience form for the simple case of exact
// equality. The same can be accomplished with ValueMatches.
Value string `json:"value,omitempty"` // if non-zero, absolute match
// ValueMatches optionally specifies a StringConstraint to
// match the value against.
ValueMatches *StringConstraint `json:"valueMatches,omitempty"`
// ValueMatchesInt optionally specifies an IntConstraint to match
// the value against. Non-integer values will not match.
ValueMatchesInt *IntConstraint `json:"valueMatchesInt,omitempty"`
// ValueMatchesFloat optionally specifies a FloatConstraint to match
// the value against. Non-float values will not match.
ValueMatchesFloat *FloatConstraint `json:"valueMatchesFloat,omitempty"`
// ValueInSet optionally specifies a sub-query which the value
// (which must be a blobref) must be a part of.
ValueInSet *Constraint `json:"valueInSet,omitempty"`
// Relation optionally specifies a constraint based on relations
// to other permanodes (e.g. camliMember or camliPath sets).
// You can use it to test the properties of a parent, ancestor,
// child, or progeny.
Relation *RelationConstraint `json:"relation,omitempty"`
// Location optionally restricts matches to permanodes having
// this location. This only affects permanodes with a known
// type to have an lat/long location.
Location *LocationConstraint `json:"location,omitempty"`
// Continue is for internal use.
Continue *PermanodeContinueConstraint `json:"-"`
// TODO:
// NumClaims *IntConstraint // by owner
// Owner blob.Ref // search for permanodes by an owner
// Note: When adding a field, update hasValueConstraint.
}
type PermanodeContinueConstraint struct {
// LastMod if non-zero is the modtime of the last item
// that was seen. One of this or LastCreated will be set.
LastMod time.Time
// LastCreated if non-zero is the creation time of the last
// item that was seen.
LastCreated time.Time
// Last is the last blobref that was shown at the time
// given in ModLessEqual or CreateLessEqual.
// This is used as a tie-breaker.
// If the time is equal, permanodes <= this are not matched.
// If the time is past this in the scroll position, then this
// field is ignored.
Last blob.Ref
}
func (pcc *PermanodeContinueConstraint) checkValid() error {
if pcc.LastMod.IsZero() == pcc.LastCreated.IsZero() {
return errors.New("exactly one of PermanodeContinueConstraint LastMod or LastCreated must be defined")
}
return nil
}
type RelationConstraint struct {
// Relation must be one of:
// * "child"
// * "parent" (immediate parent only)
// * "progeny" (any level down)
// * "ancestor" (any level up)
Relation string
// EdgeType optionally specifies an edge type.
// By default it matches "camliMember" and "camliPath:*".
EdgeType string
// After finding all the nodes matching the Relation and
// EdgeType, either one or all (depending on whether Any or
// All is set) must then match for the RelationConstraint
// itself to match.
//
// It is an error to set both.
Any, All *Constraint
}
func (rc *RelationConstraint) checkValid() error {
if rc.Relation != "parent" && rc.Relation != "child" {
return errors.New("only RelationConstraint.Relation of \"parent\" or \"child\" is currently supported")
}
if (rc.Any == nil) == (rc.All == nil) {
return errors.New("exactly one of RelationConstraint Any or All must be defined")
}
return nil
}
func (rc *RelationConstraint) matchesAttr(attr string) bool {
if rc.EdgeType != "" {
return attr == rc.EdgeType
}
return attr == "camliMember" || strings.HasPrefix(attr, "camliPath:")
}
// The PermanodeConstraint matching of RelationConstraint.
func (rc *RelationConstraint) match(ctx context.Context, s *search, pn blob.Ref, at time.Time) (ok bool, err error) {
corpus := s.h.corpus
if corpus == nil {
// TODO: care?
return false, errors.New("RelationConstraint requires an in-memory corpus")
}
var foreachClaim func(pn blob.Ref, at time.Time, f func(cl *camtypes.Claim) bool)
// relationRef returns the relevant blobRef from the claim if cl defines
// the kind of relation we are looking for, (blob.Ref{}, false) otherwise.
var relationRef func(cl *camtypes.Claim) (blob.Ref, bool)
switch rc.Relation {
case "parent":
foreachClaim = corpus.ForeachClaimBack
relationRef = func(cl *camtypes.Claim) (blob.Ref, bool) { return cl.Permanode, true }
case "child":
foreachClaim = corpus.ForeachClaim
relationRef = func(cl *camtypes.Claim) (blob.Ref, bool) { return blob.Parse(cl.Value) }
default:
panic("bogus")
}
var matcher matchFn
if rc.Any != nil {
matcher = rc.Any.matcher()
} else {
matcher = rc.All.matcher()
}
var anyGood bool
var anyBad bool
var lastChecked blob.Ref
var permanodesChecked map[blob.Ref]bool // lazily created to optimize for common case of 1 match
foreachClaim(pn, at, func(cl *camtypes.Claim) bool {
if !rc.matchesAttr(cl.Attr) {
return true // skip claim
}
if lastChecked.Valid() {
if permanodesChecked == nil {
permanodesChecked = make(map[blob.Ref]bool)
}
permanodesChecked[lastChecked] = true
lastChecked = blob.Ref{} // back to zero
}
relRef, ok := relationRef(cl)
if !ok {
// The claim does not define the kind of relation we're looking for
// (e.g. it sets a tag vale), so we continue to the next claim.
return true
}
if permanodesChecked[relRef] {
return true // skip checking
}
if !corpus.PermanodeHasAttrValue(cl.Permanode, at, cl.Attr, cl.Value) {
return true // claim once matched permanode, but no longer
}
var bm camtypes.BlobMeta
bm, err = s.blobMeta(ctx, relRef)
if err != nil {
return false
}
ok, err = matcher(ctx, s, relRef, bm)
if err != nil {
return false
}
if ok {
anyGood = true
if rc.Any != nil {
return false // done. stop searching.
}
} else {
anyBad = true
if rc.All != nil {
return false // fail fast
}
}
lastChecked = relRef
return true
})
if err != nil {
return false, err
}
if rc.All != nil {
return anyGood && !anyBad, nil
}
return anyGood, nil
}
// search is the state of an in-progress search
type search struct {
h *Handler
q *SearchQuery
res *SearchResult
// ss is a scratch string slice to avoid allocations.
// We assume (at least so far) that only 1 goroutine is used
// for a given search, so anything can use this.
ss []string // scratch
// loc is a cache of calculated locations.
//
// TODO: if location-of-permanode were cheaper and cached in
// the corpus instead, then we wouldn't need this. And then
// searches would be faster anyway. This is a hack.
loc map[blob.Ref]camtypes.Location
}
func (s *search) blobMeta(ctx context.Context, br blob.Ref) (camtypes.BlobMeta, error) {
if c := s.h.corpus; c != nil {
return c.GetBlobMeta(ctx, br)
}
return s.h.index.GetBlobMeta(ctx, br)
}
func (s *search) fileInfo(ctx context.Context, br blob.Ref) (camtypes.FileInfo, error) {
if c := s.h.corpus; c != nil {
return c.GetFileInfo(ctx, br)
}
return s.h.index.GetFileInfo(ctx, br)
}
// optimizePlan returns an optimized version of c which will hopefully
// execute faster than executing c literally.
func optimizePlan(c *Constraint) *Constraint {
// TODO: what the comment above says.
return c
}
var debugQuerySpeed, _ = strconv.ParseBool(os.Getenv("CAMLI_DEBUG_QUERY_SPEED"))
func (h *Handler) Query(rawq *SearchQuery) (ret_ *SearchResult, _ error) {
if debugQuerySpeed {
t0 := time.Now()
jq, _ := json.Marshal(rawq)
log.Printf("Start %v, Doing search %s... ", t0.Format(time.RFC3339), jq)
defer func() {
d := time.Since(t0)
if ret_ != nil {
log.Printf("Start %v + %v = %v results", t0.Format(time.RFC3339), d, len(ret_.Blobs))
} else {
log.Printf("Start %v + %v = error")
}
}()
}
ctx := context.TODO() // TODO: set from rawq
exprResult, err := rawq.checkValid(ctx)
if err != nil {
return nil, fmt.Errorf("Invalid SearchQuery: %v", err)
}
q := rawq.plannedQuery(exprResult)
res := new(SearchResult)
s := &search{
h: h,
q: q,
res: res,
loc: make(map[blob.Ref]camtypes.Location),
}
h.index.RLock()
defer h.index.RUnlock()
ctx, cancelSearch := context.WithCancel(context.TODO())
defer cancelSearch()
corpus := h.corpus
cands := q.pickCandidateSource(s)
if candSourceHook != nil {
candSourceHook(cands.name)
}
wantAround, foundAround := false, false
if q.Around.Valid() {
wantAround = true
}
blobMatches := q.Constraint.matcher()
var enumErr error
cands.send(ctx, s, func(meta camtypes.BlobMeta) bool {
match, err := blobMatches(ctx, s, meta.Ref, meta)
if err != nil {
enumErr = err
return false
}
if match {
res.Blobs = append(res.Blobs, &SearchResultBlob{
Blob: meta.Ref,
})
if q.Sort == MapSort {
// We need all the matching blobs to apply the MapSort selection afterwards, so
// we temporarily ignore the limit.
// TODO(mpl): the above means that we also ignore Continue and Around here. I
// don't think we need them for the map aspect for now though.
return true
}
if q.Limit <= 0 || !cands.sorted {
if wantAround && !foundAround && q.Around == meta.Ref {
foundAround = true
}
return true
}
if !wantAround || foundAround {
if len(res.Blobs) == q.Limit {
return false
}
return true
}
if q.Around == meta.Ref {
foundAround = true
if len(res.Blobs)*2 > q.Limit {
// If we've already collected more than half of the Limit when Around is found,
// we ditch the surplus from the beginning of the slice of results.
// If Limit is even, and the number of results before and after Around
// are both greater than half the limit, then there will be one more result before
// than after.
discard := len(res.Blobs) - q.Limit/2 - 1
if discard < 0 {
discard = 0
}
res.Blobs = res.Blobs[discard:]
}
if len(res.Blobs) == q.Limit {
return false
}
return true
}
if len(res.Blobs) == q.Limit {
n := copy(res.Blobs, res.Blobs[len(res.Blobs)/2:])
res.Blobs = res.Blobs[:n]
}
}
return true
})
if enumErr != nil {
return nil, enumErr
}
if wantAround && !foundAround {
// results are ignored if Around was not found
res.Blobs = nil
}
if !cands.sorted {
switch q.Sort {
// TODO(mpl): maybe someday we'll want both a sort, and then the MapSort
// selection, as MapSort is technically not really a sort. In which case, MapSort