/
mapquery.c
2232 lines (1861 loc) · 76.9 KB
/
mapquery.c
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
/******************************************************************************
* $Id$
*
* Project: MapServer
* Purpose: Layer query support.
* Author: Steve Lime and the MapServer team.
*
******************************************************************************
* Copyright (c) 1996-2005 Regents of the University of Minnesota.
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies of this Software or works derived from this Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
****************************************************************************/
#include "mapserver.h"
#include "mapows.h"
/* This object is used by the various mapQueryXXXXX() functions. It stores
* the total amount of shapes and their RAM footprint, when they are cached
* in the resultCacheObj* of layers. This is the total number accross all queried
* layers. However this is isn't persistant accross several calls to
* mapQueryXXXXX(), if the resultCacheObj* objects weren't cleaned up. This
* is not needed in the context of WFS, for which this is used for now.
*/
typedef struct
{
int cachedShapeCountWarningEmitted;
int cachedShapeCount;
int cachedShapeRAMWarningEmitted;
int cachedShapeRAM;
} queryCacheObj;
int msInitQuery(queryObj *query) {
if(!query) return MS_FAILURE;
msFreeQuery(query); /* clean up anything previously allocated */
query->type = MS_QUERY_IS_NULL; /* nothing defined */
query->mode = MS_QUERY_SINGLE;
query->layer = query->slayer = -1;
query->point.x = query->point.y = -1;
query->buffer = 0.0;
query->maxresults = 0; /* only used by msQueryByPoint() apparently */
query->rect.minx = query->rect.miny = query->rect.maxx = query->rect.maxy = -1;
query->shape = NULL;
query->shapeindex = query->tileindex = -1;
query->clear_resultcache = MS_TRUE; /* index queries allow the old results to persist */
query->maxfeatures = -1;
query->startindex = -1;
query->only_cache_result_count = 0;
query->filteritem = NULL;
msInitExpression(&query->filter);
query->cache_shapes = MS_FALSE;
query->max_cached_shape_count = 0;
query->max_cached_shape_ram_amount = 0;
return MS_SUCCESS;
}
void msFreeQuery(queryObj *query)
{
if(query->shape) {
msFreeShape(query->shape);
free(query->shape);
}
if(query->filteritem) free(query->filteritem);
msFreeExpression(&query->filter);
}
/*
** Wrapper for all query functions, just feed is a mapObj with a populated queryObj...
*/
int msExecuteQuery(mapObj *map)
{
int tmp=-1, status;
/* handle slayer/qlayer management for feature queries */
if(map->query.slayer >= 0) {
tmp = map->query.layer;
map->query.layer = map->query.slayer;
}
switch(map->query.type) {
case MS_QUERY_BY_POINT:
status = msQueryByPoint(map);
break;
case MS_QUERY_BY_RECT:
status = msQueryByRect(map);
break;
case MS_QUERY_BY_FILTER:
status = msQueryByFilter(map);
break;
case MS_QUERY_BY_SHAPE:
status = msQueryByShape(map);
break;
case MS_QUERY_BY_INDEX:
status = msQueryByIndex(map);
break;
default:
msSetError(MS_QUERYERR, "Malformed queryObj.", "msExecuteQuery()");
return(MS_FAILURE);
}
if(map->query.slayer >= 0) {
map->query.layer = tmp; /* restore layer */
if(status == MS_SUCCESS) status = msQueryByFeatures(map);
}
return status;
}
/*
** msIsLayerQueryable() returns MS_TRUE/MS_FALSE
*/
int msIsLayerQueryable(layerObj *lp)
{
int i;
if ( lp->type == MS_LAYER_TILEINDEX )
return MS_FALSE;
if(lp->template && strlen(lp->template) > 0) return MS_TRUE;
for(i=0; i<lp->numclasses; i++) {
if(lp->class[i]->template && strlen(lp->class[i]->template) > 0)
return MS_TRUE;
}
return MS_FALSE;
}
static void initQueryCache(queryCacheObj* queryCache)
{
queryCache->cachedShapeCountWarningEmitted = MS_FALSE;
queryCache->cachedShapeCount = 0;
queryCache->cachedShapeRAMWarningEmitted = MS_FALSE;
queryCache->cachedShapeRAM = 0;
}
/** Check whether we should store the shape in resultCacheObj* given the
* limits allowed in map->query.max_cached_shape_count and
* map->query.max_cached_shape_ram_amount.
*/
static int canCacheShape(mapObj* map, queryCacheObj *queryCache,
shapeObj* shape, int shape_ram_size)
{
if( !map->query.cache_shapes )
return MS_FALSE;
if( queryCache->cachedShapeCountWarningEmitted ||
(map->query.max_cached_shape_count > 0 &&
queryCache->cachedShapeCount >= map->query.max_cached_shape_count) )
{
if( !queryCache->cachedShapeCountWarningEmitted )
{
queryCache->cachedShapeCountWarningEmitted = MS_TRUE;
msDebug("map->query.max_cached_shape_count = %d reached. "
"Next features will not be cached.\n",
map->query.max_cached_shape_count);
}
return MS_FALSE;
}
if( queryCache->cachedShapeRAMWarningEmitted ||
(map->query.max_cached_shape_ram_amount > 0 &&
queryCache->cachedShapeRAM + shape_ram_size > map->query.max_cached_shape_ram_amount) )
{
if( !queryCache->cachedShapeRAMWarningEmitted )
{
queryCache->cachedShapeRAMWarningEmitted = MS_TRUE;
msDebug("map->query.max_cached_shape_ram_amount = %d reached after %d cached features. "
"Next features will not be cached.\n",
map->query.max_cached_shape_ram_amount,
queryCache->cachedShapeCount);
}
return MS_FALSE;
}
return MS_TRUE;
}
static int addResult(mapObj* map, resultCacheObj *cache,
queryCacheObj* queryCache, shapeObj *shape)
{
int i;
int shape_ram_size = (map->query.max_cached_shape_ram_amount > 0) ?
msGetShapeRAMSize( shape ) : 0;
int store_shape = canCacheShape (map, queryCache, shape, shape_ram_size);
if(cache->numresults == cache->cachesize) { /* just add it to the end */
if(cache->cachesize == 0)
cache->results = (resultObj *) malloc(sizeof(resultObj)*MS_RESULTCACHEINCREMENT);
else
cache->results = (resultObj *) realloc(cache->results, sizeof(resultObj)*(cache->cachesize+MS_RESULTCACHEINCREMENT));
if(!cache->results) {
msSetError(MS_MEMERR, "Realloc() error.", "addResult()");
return(MS_FAILURE);
}
cache->cachesize += MS_RESULTCACHEINCREMENT;
}
i = cache->numresults;
cache->results[i].classindex = shape->classindex;
cache->results[i].tileindex = shape->tileindex;
cache->results[i].shapeindex = shape->index;
cache->results[i].resultindex = shape->resultindex;
if( store_shape )
{
cache->results[i].shape = (shapeObj*)msSmallMalloc(sizeof(shapeObj));
msInitShape(cache->results[i].shape);
msCopyShape(shape, cache->results[i].shape);
queryCache->cachedShapeCount ++;
queryCache->cachedShapeRAM += shape_ram_size;
}
else
cache->results[i].shape = NULL;
cache->numresults++;
cache->previousBounds = cache->bounds;
if(cache->numresults == 1)
cache->bounds = shape->bounds;
else
msMergeRect(&(cache->bounds), &(shape->bounds));
return(MS_SUCCESS);
}
/*
** Serialize a query result set to disk.
*/
static int saveQueryResults(mapObj *map, char *filename)
{
FILE *stream;
int i, j, n=0;
if(!filename) {
msSetError(MS_MISCERR, "No filename provided to save query results to.", "saveQueryResults()");
return MS_FAILURE;
}
stream = fopen(filename, "w");
if(!stream) {
msSetError(MS_IOERR, "(%s)", "saveQueryResults()", filename);
return MS_FAILURE;
}
fprintf(stream, "%s - Generated by msSaveQuery()\n", MS_QUERY_RESULTS_MAGIC_STRING);
/* count the number of layers with results */
for(i=0; i<map->numlayers; i++)
if(GET_LAYER(map, i)->resultcache) n++;
fwrite(&n, sizeof(int), 1, stream);
/* now write the result set for each layer */
for(i=0; i<map->numlayers; i++) {
if(GET_LAYER(map, i)->resultcache) {
fwrite(&i, sizeof(int), 1, stream); /* layer index */
fwrite(&(GET_LAYER(map, i)->resultcache->numresults), sizeof(int), 1, stream); /* number of results */
fwrite(&(GET_LAYER(map, i)->resultcache->bounds), sizeof(rectObj), 1, stream); /* bounding box */
for(j=0; j<GET_LAYER(map, i)->resultcache->numresults; j++)
fwrite(&(GET_LAYER(map, i)->resultcache->results[j]), sizeof(resultObj), 1, stream); /* each result */
}
}
fclose(stream);
return MS_SUCCESS;
}
static int loadQueryResults(mapObj *map, FILE *stream)
{
int i, j, k, n=0;
if(1 != fread(&n, sizeof(int), 1, stream)) {
msSetError(MS_MISCERR,"failed to read query count from query file stream", "loadQueryResults()");
return MS_FAILURE;
}
/* now load the result set for each layer found in the query file */
for(i=0; i<n; i++) {
if(1 != fread(&j, sizeof(int), 1, stream)) { /* layer index */
msSetError(MS_MISCERR,"failed to read layer index from query file stream", "loadQueryResults()");
return MS_FAILURE;
}
if(j<0 || j>map->numlayers) {
msSetError(MS_MISCERR, "Invalid layer index loaded from query file.", "loadQueryResults()");
return MS_FAILURE;
}
/* inialize the results for this layer */
GET_LAYER(map, j)->resultcache = (resultCacheObj *)malloc(sizeof(resultCacheObj)); /* allocate and initialize the result cache */
MS_CHECK_ALLOC(GET_LAYER(map, j)->resultcache, sizeof(resultCacheObj), MS_FAILURE);
if(1 != fread(&(GET_LAYER(map, j)->resultcache->numresults), sizeof(int), 1, stream) || (GET_LAYER(map, j)->resultcache->numresults < 0)) { /* number of results */
msSetError(MS_MISCERR,"failed to read number of results from query file stream", "loadQueryResults()");
free(GET_LAYER(map, j)->resultcache);
GET_LAYER(map, j)->resultcache = NULL;
return MS_FAILURE;
}
GET_LAYER(map, j)->resultcache->cachesize = GET_LAYER(map, j)->resultcache->numresults;
if(1 != fread(&(GET_LAYER(map, j)->resultcache->bounds), sizeof(rectObj), 1, stream)) { /* bounding box */
msSetError(MS_MISCERR,"failed to read bounds from query file stream", "loadQueryResults()");
free(GET_LAYER(map, j)->resultcache);
GET_LAYER(map, j)->resultcache = NULL;
return MS_FAILURE;
}
GET_LAYER(map, j)->resultcache->results = (resultObj *) malloc(sizeof(resultObj)*GET_LAYER(map, j)->resultcache->numresults);
if (GET_LAYER(map, j)->resultcache->results == NULL) {
msSetError(MS_MEMERR, "%s: %d: Out of memory allocating %u bytes.\n", "loadQueryResults()",
__FILE__, __LINE__, (unsigned int)(sizeof(resultObj)*GET_LAYER(map, j)->resultcache->numresults));
free(GET_LAYER(map, j)->resultcache);
GET_LAYER(map, j)->resultcache = NULL;
return MS_FAILURE;
}
for(k=0; k<GET_LAYER(map, j)->resultcache->numresults; k++) {
if(1 != fread(&(GET_LAYER(map, j)->resultcache->results[k]), sizeof(resultObj), 1, stream)) { /* each result */
msSetError(MS_MISCERR,"failed to read result %d from query file stream", "loadQueryResults()", k);
free(GET_LAYER(map, j)->resultcache->results);
free(GET_LAYER(map, j)->resultcache);
GET_LAYER(map, j)->resultcache = NULL;
return MS_FAILURE;
}
if(!GET_LAYER(map, j)->tileindex) GET_LAYER(map, j)->resultcache->results[k].tileindex = -1; /* reset the tile index for non-tiled layers */
GET_LAYER(map, j)->resultcache->results[k].resultindex = -1; /* all results loaded this way have a -1 result (set) index */
}
}
return MS_SUCCESS;
}
/*
** Serialize the parameters necessary to duplicate a query to disk. (TODO: add filter query...)
*/
static int saveQueryParams(mapObj *map, char *filename)
{
FILE *stream;
if(!filename) {
msSetError(MS_MISCERR, "No filename provided to save query to.", "saveQueryParams()");
return MS_FAILURE;
}
stream = fopen(filename, "w");
if(!stream) {
msSetError(MS_IOERR, "(%s)", "saveQueryParams()", filename);
return MS_FAILURE;
}
fprintf(stream, "%s - Generated by msSaveQuery()\n", MS_QUERY_PARAMS_MAGIC_STRING);
fprintf(stream, "%d %d %d %d\n", map->query.mode, map->query.type, map->query.layer, map->query.slayer); /* all queries */
fprintf(stream, "%.15g %.15g %g %d\n", map->query.point.x, map->query.point.y, map->query.buffer, map->query.maxresults); /* by point */
fprintf(stream, "%.15g %.15g %.15g %.15g\n", map->query.rect.minx, map->query.rect.miny, map->query.rect.maxx, map->query.rect.maxy); /* by rect */
fprintf(stream, "%ld %ld %d\n", map->query.shapeindex, map->query.tileindex, map->query.clear_resultcache); /* by index */
fprintf(stream, "%s\n", (map->query.filteritem)?map->query.filteritem:"NULL"); /* by filter */
fprintf(stream, "%s\n", (map->query.filter.string)?map->query.filter.string:"NULL");
if(map->query.shape) { /* by shape */
int i, j;
shapeObj *s = map->query.shape;
fprintf(stream, "%d\n", s->type);
fprintf(stream, "%d\n", s->numlines);
for(i=0; i<s->numlines; i++) {
fprintf(stream, "%d\n", s->line[i].numpoints);
for(j=0; j<s->line[i].numpoints; j++)
fprintf(stream, "%.15g %.15g\n", s->line[i].point[j].x, s->line[i].point[j].y);
}
} else {
fprintf(stream, "%d\n", MS_SHAPE_NULL); /* NULL shape */
}
fclose(stream);
return MS_SUCCESS;
}
static int loadQueryParams(mapObj *map, FILE *stream)
{
char buffer[MS_BUFFER_LENGTH];
int lineno;
int shapetype, numlines, numpoints;
msInitQuery(&(map->query)); /* this will free any previous query as well */
lineno = 2; /* line 1 is the magic string */
while(fgets(buffer, MS_BUFFER_LENGTH, stream) != NULL) {
switch(lineno) {
case 2:
if(sscanf(buffer, "%d %d %d %d\n", &(map->query.mode), &(map->query.type), &(map->query.layer), &(map->query.slayer)) != 4) goto parse_error;
break;
case 3:
if(sscanf(buffer, "%lf %lf %lf %d\n", &map->query.point.x, &map->query.point.y, &map->query.buffer, &map->query.maxresults) != 4) goto parse_error;
break;
case 4:
if(sscanf(buffer, "%lf %lf %lf %lf\n", &map->query.rect.minx, &map->query.rect.miny, &map->query.rect.maxx, &map->query.rect.maxy) != 4) goto parse_error;
break;
case 5:
if(sscanf(buffer, "%ld %ld %d\n", &map->query.shapeindex, &map->query.tileindex, &map->query.clear_resultcache) != 3) goto parse_error;
break;
case 6:
if(strncmp(buffer, "NULL", 4) != 0) {
map->query.filteritem = msStrdup(buffer);
msStringChop(map->query.filteritem);
}
break;
case 7:
if(strncmp(buffer, "NULL", 4) != 0)
msLoadExpressionString(&map->query.filter, buffer); /* chop buffer */
break;
case 8:
if(sscanf(buffer, "%d\n", &shapetype) != 1) goto parse_error;
if(shapetype != MS_SHAPE_NULL) { /* load the rest of the shape */
int i, j;
lineObj line;
map->query.shape = (shapeObj *) msSmallMalloc(sizeof(shapeObj));
msInitShape(map->query.shape);
map->query.shape->type = shapetype;
if(fscanf(stream, "%d\n", &numlines) != 1) goto parse_error;
for(i=0; i<numlines; i++) {
if(fscanf(stream, "%d\n", &numpoints) != 1 || numpoints<0) goto parse_error;
line.numpoints = numpoints;
line.point = (pointObj *) msSmallMalloc(line.numpoints*sizeof(pointObj));
for(j=0; j<numpoints; j++)
if(fscanf(stream, "%lf %lf\n", &line.point[j].x, &line.point[j].y) != 2) goto parse_error;
msAddLine(map->query.shape, &line);
free(line.point);
}
}
break;
default:
break;
}
lineno++;
}
/* TODO: should we throw an error if lineno != 10? */
/* force layer and slayer on */
if(map->query.layer >= 0 && map->query.layer < map->numlayers) GET_LAYER(map, map->query.layer)->status = MS_ON;
if(map->query.slayer >= 0 && map->query.slayer < map->numlayers) GET_LAYER(map, map->query.slayer)->status = MS_ON;
/* now execute the query */
return msExecuteQuery(map);
parse_error:
msSetError(MS_MISCERR, "Parse error line %d.", "loadQueryParameters()", lineno);
return MS_FAILURE;
}
/*
** Save (serialize) a query to disk. There are two methods, one saves the query parameters and the other saves
** all the shape indexes. Note the latter can be very slow against certain data sources but has a certain usefulness
** on occation.
*/
int msSaveQuery(mapObj *map, char *filename, int results)
{
if(results)
return saveQueryResults(map, filename);
else
return saveQueryParams(map, filename);
}
/*
** Loads a query file contained either serialized 1) query parameters or 2) query results (e.g. indexes).
*/
int msLoadQuery(mapObj *map, char *filename)
{
FILE *stream;
char buffer[MS_BUFFER_LENGTH];
int retval=MS_FAILURE;
if(!filename) {
msSetError(MS_MISCERR, "No filename provided to load query from.", "msLoadQuery()");
return MS_FAILURE;
}
/*
** Make sure the file at least has the right extension.
*/
if(msEvalRegex("\\.qy$", filename) != MS_TRUE) {
msSetError(MS_MISCERR, "Queryfile %s has incorrect file extension.", "msLoadQuery()", filename);
return MS_FAILURE;
}
/*
** Open the file and inspect the first line.
*/
stream = fopen(filename, "r");
if(!stream) {
msSetError(MS_IOERR, "(%s)", "msLoadQuery()", filename);
return MS_FAILURE;
}
if(fgets(buffer, MS_BUFFER_LENGTH, stream) != NULL) {
/*
** Call correct reader based on the magic string.
*/
if(strncasecmp(buffer, MS_QUERY_RESULTS_MAGIC_STRING, strlen(MS_QUERY_RESULTS_MAGIC_STRING)) == 0) {
retval = loadQueryResults(map, stream);
} else if(strncasecmp(buffer, MS_QUERY_PARAMS_MAGIC_STRING, strlen(MS_QUERY_PARAMS_MAGIC_STRING)) == 0) {
retval = loadQueryParams(map, stream);
} else {
msSetError(MS_WEBERR, "Missing magic string, %s doesn't look like a MapServer query file.", "msLoadQuery()", filename);
retval = MS_FAILURE;
}
} else {
msSetError(MS_WEBERR, "Empty file or failed read for %s.", "msLoadQuery()", filename);
retval = MS_FAILURE;
}
fclose(stream);
return retval;
}
int msQueryByIndex(mapObj *map)
{
layerObj *lp;
int status;
resultObj record;
queryCacheObj queryCache;
shapeObj shape;
double minfeaturesize = -1;
initQueryCache(&queryCache);
if(map->query.type != MS_QUERY_BY_INDEX) {
msSetError(MS_QUERYERR, "The query is not properly defined.", "msQueryByIndex()");
return(MS_FAILURE);
}
if(map->query.layer < 0 || map->query.layer >= map->numlayers) {
msSetError(MS_QUERYERR, "No query layer defined.", "msQueryByIndex()");
return(MS_FAILURE);
}
lp = (GET_LAYER(map, map->query.layer));
if(!msIsLayerQueryable(lp)) {
msSetError(MS_QUERYERR, "Requested layer has no templates defined.", "msQueryByIndex()");
return(MS_FAILURE);
}
if(map->query.clear_resultcache) {
if(lp->resultcache) {
cleanupResultCache(lp->resultcache);
free(lp->resultcache);
lp->resultcache = NULL;
}
}
msLayerClose(lp); /* reset */
status = msLayerOpen(lp);
if(status != MS_SUCCESS) return(MS_FAILURE);
/* disable driver paging */
msLayerEnablePaging(lp, MS_FALSE);
/* build item list, we want *all* items */
status = msLayerWhichItems(lp, MS_TRUE, NULL);
if(status != MS_SUCCESS) return(MS_FAILURE);
if(map->query.clear_resultcache || lp->resultcache == NULL) {
lp->resultcache = (resultCacheObj *)malloc(sizeof(resultCacheObj)); /* allocate and initialize the result cache */
MS_CHECK_ALLOC(lp->resultcache, sizeof(resultCacheObj), MS_FAILURE);
initResultCache( lp->resultcache);
}
msInitShape(&shape);
record.resultindex = -1;
record.shapeindex = map->query.shapeindex;
record.tileindex = map->query.tileindex;
status = msLayerGetShape(lp, &shape, &record);
if(status != MS_SUCCESS) {
msSetError(MS_NOTFOUND, "Not valid record request.", "msQueryByIndex()");
return(MS_FAILURE);
}
/*
* The resultindex is used to retrieve a specific item from the result cache.
* Usually, the row number will be used as resultindex. But when working with
* databases and querying a single result, the row number is typically 0 and
* thus useless as the index in the result cache. See #4926 #4076. Only shape
* files are considered to have consistent row numbers.
*/
if ( !(lp->connectiontype == MS_SHAPEFILE || lp->connectiontype == MS_TILED_SHAPEFILE) ) {
shape.resultindex = -1;
}
if (lp->minfeaturesize > 0)
minfeaturesize = Pix2LayerGeoref(map, lp, lp->minfeaturesize);
/* Check if the shape size is ok to be drawn */
if ( (shape.type == MS_SHAPE_LINE || shape.type == MS_SHAPE_POLYGON) && (minfeaturesize > 0) ) {
if (msShapeCheckSize(&shape, minfeaturesize) == MS_FALSE) {
msSetError(MS_NOTFOUND, "Requested shape not valid against layer minfeaturesize.", "msQueryByIndex()");
msFreeShape(&shape);
msLayerClose(lp);
return(MS_FAILURE);
}
}
shape.classindex = msShapeGetClass(lp, map, &shape, NULL, 0);
if(!(lp->template) && ((shape.classindex == -1) || (lp->class[shape.classindex]->status == MS_OFF))) { /* not a valid shape */
msSetError(MS_NOTFOUND, "Requested shape not valid against layer classification scheme.", "msQueryByIndex()");
msFreeShape(&shape);
msLayerClose(lp);
return(MS_FAILURE);
}
if(!(lp->template) && !(lp->class[shape.classindex]->template)) { /* no valid template */
msSetError(MS_NOTFOUND, "Requested shape does not have a valid template, no way to present results.", "msQueryByIndex()");
msFreeShape(&shape);
msLayerClose(lp);
return(MS_FAILURE);
}
addResult(map, lp->resultcache, &queryCache, &shape);
msFreeShape(&shape);
/* msLayerClose(lp); */
return(MS_SUCCESS);
}
static char *filterTranslateToLogical(expressionObj *filter, char *filteritem) {
char *string = NULL;
if(filter->type == MS_STRING && filteritem) {
string = msStrdup("'[");
string = msStringConcatenate(string, filteritem);
string = msStringConcatenate(string, "]'");
if(filter->flags & MS_EXP_INSENSITIVE)
string = msStringConcatenate(string, " =* '");
else
string = msStringConcatenate(string, " = '");
string = msStringConcatenate(string, filter->string);
string = msStringConcatenate(string, "'");
} else if(filter->type == MS_REGEX && filteritem) {
string = msStrdup("'[");
string = msStringConcatenate(string, filteritem);
string = msStringConcatenate(string, "]'");
if(filter->flags & MS_EXP_INSENSITIVE)
string = msStringConcatenate(string, " ~* '");
else
string = msStringConcatenate(string, " ~ '");
string = msStringConcatenate(string, filter->string);
string = msStringConcatenate(string, "'");
} else if(filter->type == MS_EXPRESSION) {
string = msStrdup(filter->string);
} else {
/* native expression, nothing we can do - sigh */
}
return string;
}
static expressionObj mergeFilters(expressionObj *filter1, char *filteritem1, expressionObj *filter2, char *filteritem2) {
expressionObj filter;
char *tmpstr1=NULL;
char *tmpstr2=NULL;
msInitExpression(&filter);
filter.type = MS_EXPRESSION; /* we're building a logical expression */
tmpstr1 = filterTranslateToLogical(filter1, filteritem1);
if(!tmpstr1) return filter; /* should only happen if the filter was a native filter */
tmpstr2 = filterTranslateToLogical(filter2, filteritem2);
if(!tmpstr2) {
msFree(tmpstr1);
return filter; /* should only happen if the filter was a native filter */
}
filter.string = msStrdup(tmpstr1);
filter.string = msStringConcatenate(filter.string, " AND ");
filter.string = msStringConcatenate(filter.string, tmpstr2);
msFree(tmpstr1);
msFree(tmpstr2);
return filter;
}
/*
** Query using common expression syntax.
*/
int msQueryByFilter(mapObj *map)
{
int l;
int start, stop=0;
layerObj *lp;
char status;
char *old_filteritem=NULL;
expressionObj old_filter;
rectObj search_rect;
const rectObj invalid_rect = MS_INIT_INVALID_RECT;
shapeObj shape;
int paging;
int nclasses = 0;
int *classgroup = NULL;
double minfeaturesize = -1;
queryCacheObj queryCache;
initQueryCache(&queryCache);
if(map->query.type != MS_QUERY_BY_FILTER) {
msSetError(MS_QUERYERR, "The query is not properly defined.", "msQueryByFilter()");
return(MS_FAILURE);
}
if(!map->query.filter.string) {
msSetError(MS_QUERYERR, "Filter is not set.", "msQueryByFilter()");
return(MS_FAILURE);
}
// fprintf(stderr, "in msQueryByFilter: filter=%s, filteritem=%s\n", map->query.filter.string, map->query.filteritem);
msInitShape(&shape);
if(map->query.layer < 0 || map->query.layer >= map->numlayers)
start = map->numlayers-1;
else
start = stop = map->query.layer;
for(l=start; l>=stop; l--) {
reprojectionObj* reprojector = NULL;
lp = (GET_LAYER(map, l));
if (map->query.maxfeatures == 0)
break; /* nothing else to do */
else if (map->query.maxfeatures > 0)
lp->maxfeatures = map->query.maxfeatures;
/* using mapscript, the map->query.startindex will be unset... */
if (lp->startindex > 1 && map->query.startindex < 0)
map->query.startindex = lp->startindex;
/* conditions may have changed since this layer last drawn, so set
layer->project true to recheck projection needs (Bug #673) */
lp->project = MS_TRUE;
/* free any previous search results, do it now in case one of the next few tests fail */
if(lp->resultcache) {
if(lp->resultcache->results) free(lp->resultcache->results);
free(lp->resultcache);
lp->resultcache = NULL;
}
if(!msIsLayerQueryable(lp)) continue;
if(lp->status == MS_OFF) continue;
if(lp->type == MS_LAYER_RASTER) continue; /* ok to skip? */
if(map->scaledenom > 0) {
if((lp->maxscaledenom > 0) && (map->scaledenom > lp->maxscaledenom)) continue;
if((lp->minscaledenom > 0) && (map->scaledenom <= lp->minscaledenom)) continue;
}
if (lp->maxscaledenom <= 0 && lp->minscaledenom <= 0) {
if((lp->maxgeowidth > 0) && ((map->extent.maxx - map->extent.minx) > lp->maxgeowidth)) continue;
if((lp->mingeowidth > 0) && ((map->extent.maxx - map->extent.minx) < lp->mingeowidth)) continue;
}
paging = msLayerGetPaging(lp);
msLayerClose(lp); /* reset */
status = msLayerOpen(lp);
if(status != MS_SUCCESS) return MS_FAILURE;
msLayerEnablePaging(lp, paging);
/* disable driver paging */
// msLayerEnablePaging(lp, MS_FALSE);
old_filteritem = lp->filteritem; /* cache the existing filter/filteritem */
msInitExpression(&old_filter);
msCopyExpression(&old_filter, &lp->filter);
/*
** Set the lp->filter and lp->filteritem (may need to merge). Remember filters are *always* MapServer syntax.
*/
lp->filteritem = map->query.filteritem; /* re-point lp->filteritem */
if(old_filter.string != NULL) { /* need to merge filters to create one logical expression */
msFreeExpression(&lp->filter);
lp->filter = mergeFilters(&map->query.filter, map->query.filteritem, &old_filter, old_filteritem);
if(!lp->filter.string) {
msSetError(MS_MISCERR, "Filter merge failed, able to process query.", "msQueryByFilter()");
goto restore_old_filter;
}
} else {
msCopyExpression(&lp->filter, &map->query.filter); /* apply new filter */
}
/* build item list, we want *all* items, note this *also* build tokens for the layer filter */
status = msLayerWhichItems(lp, MS_TRUE, NULL);
if(status != MS_SUCCESS) goto restore_old_filter;
search_rect = map->query.rect;
/* If only result count is needed, we can use msLayerGetShapeCount() */
/* that has optimizations to avoid retrieving individual features */
if( map->query.only_cache_result_count &&
lp->template != NULL && /* always TRUE for WFS case */
lp->minfeaturesize <= 0 )
{
int bUseLayerSRS = MS_FALSE;
int numFeatures = -1;
#if defined(USE_WMS_SVR) || defined (USE_WFS_SVR) || defined (USE_WCS_SVR) || defined(USE_SOS_SVR) || defined(USE_WMS_LYR) || defined(USE_WFS_LYR)
/* Optimization to detect the case where a WFS query uses in fact the */
/* whole layer extent, but expressed in a map SRS different from the layer SRS */
/* In the case, we can directly request against the layer extent in its native SRS */
if( lp->project &&
memcmp( &search_rect, &invalid_rect, sizeof(search_rect) ) != 0 &&
msProjectionsDiffer(&(lp->projection), &(map->projection)) )
{
rectObj layerExtent;
if ( msOWSGetLayerExtent(map, lp, "FO", &layerExtent) == MS_SUCCESS)
{
rectObj ext = layerExtent;
ext.minx -= 1e-5;
ext.miny -= 1e-5;
ext.maxx += 1e-5;
ext.maxy += 1e-5;
msProjectRect(&(lp->projection), &(map->projection), &ext);
if( fabs(ext.minx - search_rect.minx) <= 2e-5 &&
fabs(ext.miny - search_rect.miny) <= 2e-5 &&
fabs(ext.maxx - search_rect.maxx) <= 2e-5 &&
fabs(ext.maxy - search_rect.maxy) <= 2e-5 )
{
bUseLayerSRS = MS_TRUE;
numFeatures = msLayerGetShapeCount(lp, layerExtent, &(lp->projection));
}
}
}
#endif
if( !bUseLayerSRS )
numFeatures = msLayerGetShapeCount(lp, search_rect, &(map->projection));
if( numFeatures >= 0 )
{
lp->resultcache = (resultCacheObj *)malloc(sizeof(resultCacheObj)); /* allocate and initialize the result cache */
MS_CHECK_ALLOC(lp->resultcache, sizeof(resultCacheObj), MS_FAILURE);
initResultCache( lp->resultcache);
lp->resultcache->numresults = numFeatures;
if (!msLayerGetPaging(lp) && map->query.startindex > 1) {
lp->resultcache->numresults -= (map->query.startindex-1);
}
lp->filteritem = old_filteritem; /* point back to original value */
msCopyExpression(&lp->filter, &old_filter); /* restore old filter */
msFreeExpression(&old_filter);
continue;
}
// Fallback in case of error (should not happen normally)
}
lp->project = msProjectionsDiffer(&(lp->projection), &(map->projection));
if(lp->project && memcmp( &search_rect, &invalid_rect, sizeof(search_rect) ) != 0 )
msProjectRect(&(map->projection), &(lp->projection), &search_rect); /* project the searchrect to source coords */
status = msLayerWhichShapes(lp, search_rect, MS_TRUE);
if(status == MS_DONE) { /* no overlap */
msLayerClose(lp);
continue;
} else if(status != MS_SUCCESS) goto restore_old_filter;
lp->resultcache = (resultCacheObj *)malloc(sizeof(resultCacheObj)); /* allocate and initialize the result cache */
initResultCache( lp->resultcache);
nclasses = 0;
classgroup = NULL;
if (lp->classgroup && lp->numclasses > 0)
classgroup = msAllocateValidClassGroups(lp, &nclasses);
if (lp->minfeaturesize > 0)
minfeaturesize = Pix2LayerGeoref(map, lp, lp->minfeaturesize);
while((status = msLayerNextShape(lp, &shape)) == MS_SUCCESS) { /* step through the shapes - if necessary the filter is applied in msLayerNextShape(...) */
/* Check if the shape size is ok to be drawn */
if ( (shape.type == MS_SHAPE_LINE || shape.type == MS_SHAPE_POLYGON) && (minfeaturesize > 0) ) {
if (msShapeCheckSize(&shape, minfeaturesize) == MS_FALSE) {
if( lp->debug >= MS_DEBUGLEVEL_V )
msDebug("msQueryByFilter(): Skipping shape (%ld) because LAYER::MINFEATURESIZE is bigger than shape size\n", shape.index);
msFreeShape(&shape);
continue;
}
}
shape.classindex = msShapeGetClass(lp, map, &shape, classgroup, nclasses);
if(!(lp->template) && ((shape.classindex == -1) || (lp->class[shape.classindex]->status == MS_OFF))) { /* not a valid shape */
msFreeShape(&shape);
continue;
}
if(!(lp->template) && !(lp->class[shape.classindex]->template)) { /* no valid template */
msFreeShape(&shape);
continue;
}
if(lp->project) {
if( reprojector == NULL ) {
reprojector = msProjectCreateReprojector(&(lp->projection), &(map->projection));
if( reprojector == NULL ) {
msFreeShape(&shape);
status = MS_FAILURE;
break;
}
}
msProjectShapeEx(reprojector, &shape);
}
/* Should we skip this feature? */
if (!paging && map->query.startindex > 1) {
--map->query.startindex;
msFreeShape(&shape);
continue;
}
if( map->query.only_cache_result_count )
lp->resultcache->numresults ++;
else
addResult(map, lp->resultcache, &queryCache, &shape);
msFreeShape(&shape);
if(map->query.mode == MS_QUERY_SINGLE) { /* no need to look any further */
status = MS_DONE;
break;
}
/* check shape count */
if(lp->maxfeatures > 0 && lp->maxfeatures == lp->resultcache->numresults) {
status = MS_DONE;
break;
}
} /* next shape */
if(classgroup) msFree(classgroup);
lp->filteritem = old_filteritem; /* point back to original value */
msCopyExpression(&lp->filter, &old_filter); /* restore old filter */
msFreeExpression(&old_filter);
msProjectDestroyReprojector(reprojector);
if(status != MS_DONE) return MS_FAILURE;
if(!map->query.only_cache_result_count && lp->resultcache->numresults == 0)
msLayerClose(lp); /* no need to keep the layer open */
} /* next layer */
/* was anything found? */
for(l=start; l>=stop; l--) {
if(GET_LAYER(map, l)->resultcache && GET_LAYER(map, l)->resultcache->numresults > 0)
return MS_SUCCESS;
}
msSetError(MS_NOTFOUND, "No matching record(s) found.", "msQueryByFilter()");
return MS_FAILURE;