forked from mozilla/gecko-dev
-
Notifications
You must be signed in to change notification settings - Fork 2
/
nsXULTemplateQueryProcessorRDF.cpp
1966 lines (1621 loc) · 63.5 KB
/
nsXULTemplateQueryProcessorRDF.cpp
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
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (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.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is Mozilla Communicator client code.
*
* The Initial Developer of the Original Code is
* Netscape Communications Corporation.
* Portions created by the Initial Developer are Copyright (C) 1998
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Robert Churchill <rjc@netscape.com>
* David Hyatt <hyatt@netscape.com>
* Chris Waterson <waterson@netscape.com>
* Pierre Phaneuf <pp@ludusdesign.com>
* Joe Hewitt <hewitt@netscape.com>
* Neil Deakin <enndeakin@sympatico.ca>
* Laurent Jouanneau <laurent.jouanneau@disruptive-innovations.com>
*
* Alternatively, the contents of this file may be used under the terms of
* either of the GNU General Public License Version 2 or later (the "GPL"),
* or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
#include "nsCOMPtr.h"
#include "nsIDOMNode.h"
#include "nsIRDFNode.h"
#include "nsIRDFObserver.h"
#include "nsIRDFRemoteDataSource.h"
#include "nsIRDFInferDataSource.h"
#include "nsIRDFService.h"
#include "nsRDFCID.h"
#include "nsIServiceManager.h"
#include "nsINameSpaceManager.h"
#include "nsGkAtoms.h"
#include "nsIDocument.h"
#include "nsIXULDocument.h"
#include "nsAttrName.h"
#include "rdf.h"
#include "nsArrayUtils.h"
#include "nsContentTestNode.h"
#include "nsRDFConInstanceTestNode.h"
#include "nsRDFConMemberTestNode.h"
#include "nsRDFPropertyTestNode.h"
#include "nsInstantiationNode.h"
#include "nsRDFTestNode.h"
#include "nsXULContentUtils.h"
#include "nsXULTemplateBuilder.h"
#include "nsXULTemplateResultRDF.h"
#include "nsXULTemplateResultSetRDF.h"
#include "nsXULTemplateQueryProcessorRDF.h"
#include "nsXULSortService.h"
//----------------------------------------------------------------------
static NS_DEFINE_CID(kRDFContainerUtilsCID, NS_RDFCONTAINERUTILS_CID);
static NS_DEFINE_CID(kRDFServiceCID, NS_RDFSERVICE_CID);
#define PARSE_TYPE_INTEGER "Integer"
nsrefcnt nsXULTemplateQueryProcessorRDF::gRefCnt = 0;
nsIRDFService* nsXULTemplateQueryProcessorRDF::gRDFService;
nsIRDFContainerUtils* nsXULTemplateQueryProcessorRDF::gRDFContainerUtils;
nsIRDFResource* nsXULTemplateQueryProcessorRDF::kNC_BookmarkSeparator;
nsIRDFResource* nsXULTemplateQueryProcessorRDF::kRDF_type;
NS_IMPL_CYCLE_COLLECTION_CLASS(nsXULTemplateQueryProcessorRDF)
NS_IMPL_CYCLE_COLLECTION_UNLINK_BEGIN(nsXULTemplateQueryProcessorRDF)
tmp->Done();
NS_IMPL_CYCLE_COLLECTION_UNLINK_END
static PLDHashOperator
BindingDependenciesTraverser(nsISupports* key,
nsCOMArray<nsXULTemplateResultRDF>* array,
void* userArg)
{
nsCycleCollectionTraversalCallback *cb =
static_cast<nsCycleCollectionTraversalCallback*>(userArg);
PRInt32 i, count = array->Count();
for (i = 0; i < count; ++i) {
cb->NoteXPCOMChild(array->ObjectAt(i));
}
return PL_DHASH_NEXT;
}
static PLDHashOperator
MemoryElementTraverser(const PRUint32& key,
nsCOMArray<nsXULTemplateResultRDF>* array,
void* userArg)
{
nsCycleCollectionTraversalCallback *cb =
static_cast<nsCycleCollectionTraversalCallback*>(userArg);
PRInt32 i, count = array->Count();
for (i = 0; i < count; ++i) {
cb->NoteXPCOMChild(array->ObjectAt(i));
}
return PL_DHASH_NEXT;
}
static PLDHashOperator
RuleToBindingTraverser(nsISupports* key, RDFBindingSet* binding, void* userArg)
{
nsCycleCollectionTraversalCallback *cb =
static_cast<nsCycleCollectionTraversalCallback*>(userArg);
cb->NoteXPCOMChild(key);
return PL_DHASH_NEXT;
}
NS_IMPL_CYCLE_COLLECTION_TRAVERSE_BEGIN(nsXULTemplateQueryProcessorRDF)
NS_IMPL_CYCLE_COLLECTION_TRAVERSE_NSCOMPTR(mDB)
NS_IMPL_CYCLE_COLLECTION_TRAVERSE_NSCOMPTR(mLastRef)
if (tmp->mBindingDependencies.IsInitialized()) {
tmp->mBindingDependencies.EnumerateRead(BindingDependenciesTraverser,
&cb);
}
if (tmp->mMemoryElementToResultMap.IsInitialized()) {
tmp->mMemoryElementToResultMap.EnumerateRead(MemoryElementTraverser,
&cb);
}
if (tmp->mRuleToBindingsMap.IsInitialized()) {
tmp->mRuleToBindingsMap.EnumerateRead(RuleToBindingTraverser, &cb);
}
NS_IMPL_CYCLE_COLLECTION_TRAVERSE_NSCOMARRAY(mQueries)
NS_IMPL_CYCLE_COLLECTION_TRAVERSE_END
NS_IMPL_CYCLE_COLLECTING_ADDREF(nsXULTemplateQueryProcessorRDF)
NS_IMPL_CYCLE_COLLECTING_RELEASE(nsXULTemplateQueryProcessorRDF)
NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION(nsXULTemplateQueryProcessorRDF)
NS_INTERFACE_MAP_ENTRY(nsIXULTemplateQueryProcessor)
NS_INTERFACE_MAP_ENTRY(nsIRDFObserver)
NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, nsIXULTemplateQueryProcessor)
NS_INTERFACE_MAP_END
nsXULTemplateQueryProcessorRDF::nsXULTemplateQueryProcessorRDF(void)
: mDB(nsnull),
mBuilder(nsnull),
mQueryProcessorRDFInited(false),
mGenerationStarted(false),
mUpdateBatchNest(0),
mSimpleRuleMemberTest(nsnull)
{
gRefCnt++;
}
nsXULTemplateQueryProcessorRDF::~nsXULTemplateQueryProcessorRDF(void)
{
if (--gRefCnt == 0) {
NS_IF_RELEASE(gRDFService);
NS_IF_RELEASE(gRDFContainerUtils);
NS_IF_RELEASE(kNC_BookmarkSeparator);
NS_IF_RELEASE(kRDF_type);
}
}
nsresult
nsXULTemplateQueryProcessorRDF::InitGlobals()
{
nsresult rv;
// Initialize the global shared reference to the service
// manager and get some shared resource objects.
if (!gRDFService) {
rv = CallGetService(kRDFServiceCID, &gRDFService);
if (NS_FAILED(rv))
return rv;
}
if (!gRDFContainerUtils) {
rv = CallGetService(kRDFContainerUtilsCID, &gRDFContainerUtils);
if (NS_FAILED(rv))
return rv;
}
if (!kNC_BookmarkSeparator) {
gRDFService->GetResource(
NS_LITERAL_CSTRING(NC_NAMESPACE_URI "BookmarkSeparator"),
&kNC_BookmarkSeparator);
}
if (!kRDF_type) {
gRDFService->GetResource(
NS_LITERAL_CSTRING(RDF_NAMESPACE_URI "type"),
&kRDF_type);
}
return MemoryElement::Init() ? NS_OK : NS_ERROR_FAILURE;
}
//----------------------------------------------------------------------
//
// nsIXULTemplateQueryProcessor interface
//
NS_IMETHODIMP
nsXULTemplateQueryProcessorRDF::GetDatasource(nsIArray* aDataSources,
nsIDOMNode* aRootNode,
bool aIsTrusted,
nsIXULTemplateBuilder* aBuilder,
bool* aShouldDelayBuilding,
nsISupports** aResult)
{
nsCOMPtr<nsIRDFCompositeDataSource> compDB;
nsCOMPtr<nsIContent> root = do_QueryInterface(aRootNode);
nsresult rv;
*aResult = nsnull;
*aShouldDelayBuilding = false;
NS_ENSURE_TRUE(root, NS_ERROR_UNEXPECTED);
// make sure the RDF service is set up
rv = InitGlobals();
NS_ENSURE_SUCCESS(rv, rv);
// create a database for the builder
compDB = do_CreateInstance(NS_RDF_DATASOURCE_CONTRACTID_PREFIX
"composite-datasource");
if (!compDB) {
NS_ERROR("unable to construct new composite data source");
return NS_ERROR_UNEXPECTED;
}
// check for magical attributes. XXX move to ``flags''?
if (root->AttrValueIs(kNameSpaceID_None,
nsGkAtoms::coalesceduplicatearcs,
nsGkAtoms::_false, eCaseMatters))
compDB->SetCoalesceDuplicateArcs(false);
if (root->AttrValueIs(kNameSpaceID_None,
nsGkAtoms::allownegativeassertions,
nsGkAtoms::_false, eCaseMatters))
compDB->SetAllowNegativeAssertions(false);
if (aIsTrusted) {
// If we're a privileged (e.g., chrome) document, then add the
// local store as the first data source in the db. Note that
// we _might_ not be able to get a local store if we haven't
// got a profile to read from yet.
nsCOMPtr<nsIRDFDataSource> localstore;
rv = gRDFService->GetDataSource("rdf:local-store",
getter_AddRefs(localstore));
NS_ENSURE_SUCCESS(rv, rv);
rv = compDB->AddDataSource(localstore);
NS_ASSERTION(NS_SUCCEEDED(rv), "unable to add local store to db");
NS_ENSURE_SUCCESS(rv, rv);
}
PRUint32 length, index;
rv = aDataSources->GetLength(&length);
NS_ENSURE_SUCCESS(rv,rv);
for (index = 0; index < length; index++) {
nsCOMPtr<nsIURI> uri = do_QueryElementAt(aDataSources, index);
if (!uri) // we ignore other datasources than uri
continue;
nsCOMPtr<nsIRDFDataSource> ds;
nsCAutoString uristrC;
uri->GetSpec(uristrC);
rv = gRDFService->GetDataSource(uristrC.get(), getter_AddRefs(ds));
if (NS_FAILED(rv)) {
// This is only a warning because the data source may not
// be accessible for any number of reasons, including
// security, a bad URL, etc.
#ifdef DEBUG
nsCAutoString msg;
msg.Append("unable to load datasource '");
msg.Append(uristrC);
msg.Append('\'');
NS_WARNING(msg.get());
#endif
continue;
}
compDB->AddDataSource(ds);
}
// check if we were given an inference engine type
nsAutoString infer;
nsCOMPtr<nsIRDFDataSource> db;
root->GetAttr(kNameSpaceID_None, nsGkAtoms::infer, infer);
if (!infer.IsEmpty()) {
nsCString inferCID(NS_RDF_INFER_DATASOURCE_CONTRACTID_PREFIX);
AppendUTF16toUTF8(infer, inferCID);
nsCOMPtr<nsIRDFInferDataSource> inferDB =
do_CreateInstance(inferCID.get());
if (inferDB) {
inferDB->SetBaseDataSource(compDB);
db = do_QueryInterface(inferDB);
}
else {
NS_WARNING("failed to construct inference engine specified on template");
}
}
if (!db)
db = compDB;
return CallQueryInterface(db, aResult);
}
NS_IMETHODIMP
nsXULTemplateQueryProcessorRDF::InitializeForBuilding(nsISupports* aDatasource,
nsIXULTemplateBuilder* aBuilder,
nsIDOMNode* aRootNode)
{
if (!mQueryProcessorRDFInited) {
nsresult rv = InitGlobals();
if (NS_FAILED(rv))
return rv;
if (!mMemoryElementToResultMap.IsInitialized() &&
!mMemoryElementToResultMap.Init())
return NS_ERROR_OUT_OF_MEMORY;
if (!mBindingDependencies.IsInitialized() &&
!mBindingDependencies.Init())
return NS_ERROR_OUT_OF_MEMORY;
if (!mRuleToBindingsMap.IsInitialized() &&
!mRuleToBindingsMap.Init())
return NS_ERROR_OUT_OF_MEMORY;
mQueryProcessorRDFInited = true;
}
// don't do anything if generation has already been done
if (mGenerationStarted)
return NS_ERROR_UNEXPECTED;
mDB = do_QueryInterface(aDatasource);
mBuilder = aBuilder;
ComputeContainmentProperties(aRootNode);
// Add ourselves as a datasource observer
if (mDB)
mDB->AddObserver(this);
return NS_OK;
}
NS_IMETHODIMP
nsXULTemplateQueryProcessorRDF::Done()
{
if (!mQueryProcessorRDFInited)
return NS_OK;
if (mDB)
mDB->RemoveObserver(this);
mDB = nsnull;
mBuilder = nsnull;
mRefVariable = nsnull;
mLastRef = nsnull;
mGenerationStarted = false;
mUpdateBatchNest = 0;
mContainmentProperties.Clear();
for (ReteNodeSet::Iterator node = mAllTests.First();
node != mAllTests.Last(); ++node)
delete *node;
mAllTests.Clear();
mRDFTests.Clear();
mQueries.Clear();
mSimpleRuleMemberTest = nsnull;
mBindingDependencies.Clear();
mMemoryElementToResultMap.Clear();
mRuleToBindingsMap.Clear();
return NS_OK;
}
NS_IMETHODIMP
nsXULTemplateQueryProcessorRDF::CompileQuery(nsIXULTemplateBuilder* aBuilder,
nsIDOMNode* aQueryNode,
nsIAtom* aRefVariable,
nsIAtom* aMemberVariable,
nsISupports** _retval)
{
nsRefPtr<nsRDFQuery> query = new nsRDFQuery(this);
if (!query)
return NS_ERROR_OUT_OF_MEMORY;
query->mRefVariable = aRefVariable;
if (!mRefVariable)
mRefVariable = aRefVariable;
if (!aMemberVariable)
query->mMemberVariable = do_GetAtom("?");
else
query->mMemberVariable = aMemberVariable;
nsresult rv;
TestNode *lastnode = nsnull;
nsCOMPtr<nsIContent> content = do_QueryInterface(aQueryNode);
if (content->NodeInfo()->Equals(nsGkAtoms::_template, kNameSpaceID_XUL)) {
// simplified syntax with no rules
query->SetSimple();
NS_ASSERTION(!mSimpleRuleMemberTest,
"CompileQuery called twice with the same template");
if (!mSimpleRuleMemberTest)
rv = CompileSimpleQuery(query, content, &lastnode);
else
rv = NS_ERROR_FAILURE;
}
else if (content->NodeInfo()->Equals(nsGkAtoms::rule, kNameSpaceID_XUL)) {
// simplified syntax with at least one rule
query->SetSimple();
rv = CompileSimpleQuery(query, content, &lastnode);
}
else {
rv = CompileExtendedQuery(query, content, &lastnode);
}
if (NS_FAILED(rv))
return rv;
query->SetQueryNode(aQueryNode);
nsInstantiationNode* instnode = new nsInstantiationNode(this, query);
if (!instnode)
return NS_ERROR_OUT_OF_MEMORY;
// this and other functions always add nodes to mAllTests first. That
// way if something fails, the node will just sit harmlessly in mAllTests
// where it can be deleted later.
rv = mAllTests.Add(instnode);
if (NS_FAILED(rv)) {
delete instnode;
return rv;
}
rv = lastnode->AddChild(instnode);
if (NS_FAILED(rv))
return rv;
rv = mQueries.AppendObject(query);
if (NS_FAILED(rv))
return rv;
*_retval = query;
NS_ADDREF(*_retval);
return NS_OK;
}
NS_IMETHODIMP
nsXULTemplateQueryProcessorRDF::GenerateResults(nsISupports* aDatasource,
nsIXULTemplateResult* aRef,
nsISupports* aQuery,
nsISimpleEnumerator** aResults)
{
nsCOMPtr<nsITemplateRDFQuery> rdfquery = do_QueryInterface(aQuery);
if (! rdfquery)
return NS_ERROR_INVALID_ARG;
mGenerationStarted = true;
// should be safe to cast here since the query is a
// non-scriptable nsITemplateRDFQuery
nsRDFQuery* query = static_cast<nsRDFQuery *>(aQuery);
*aResults = nsnull;
nsCOMPtr<nsISimpleEnumerator> results;
if (aRef) {
// make sure that cached results were generated for this ref, and if not,
// regenerate them. Otherwise, things will go wrong for templates bound to
// an HTML element as they are not generated lazily.
if (aRef == mLastRef) {
query->UseCachedResults(getter_AddRefs(results));
}
else {
// clear the cached results
PRInt32 count = mQueries.Count();
for (PRInt32 r = 0; r < count; r++) {
mQueries[r]->ClearCachedResults();
}
}
if (! results) {
if (! query->mRefVariable)
query->mRefVariable = do_GetAtom("?uri");
nsCOMPtr<nsIRDFResource> refResource;
aRef->GetResource(getter_AddRefs(refResource));
if (! refResource)
return NS_ERROR_FAILURE;
// Propagate the assignments through the network
TestNode* root = query->GetRoot();
if (query->IsSimple() && mSimpleRuleMemberTest) {
// get the top node in the simple rule tree
root = mSimpleRuleMemberTest->GetParent();
mLastRef = aRef;
}
#ifdef PR_LOGGING
if (PR_LOG_TEST(gXULTemplateLog, PR_LOG_DEBUG)) {
nsAutoString id;
aRef->GetId(id);
nsAutoString rvar;
query->mRefVariable->ToString(rvar);
nsAutoString mvar;
query->mMemberVariable->ToString(mvar);
PR_LOG(gXULTemplateLog, PR_LOG_ALWAYS,
("QueryProcessor::GenerateResults using ref %s and vars [ ref: %s member: %s]",
NS_ConvertUTF16toUTF8(id).get(),
NS_ConvertUTF16toUTF8(rvar).get(),
NS_ConvertUTF16toUTF8(mvar).get()));
}
#endif
if (root) {
// the seed is the initial instantiation, which has a single
// assignment holding the reference point
Instantiation seed;
seed.AddAssignment(query->mRefVariable, refResource);
InstantiationSet* instantiations = new InstantiationSet();
if (!instantiations)
return NS_ERROR_OUT_OF_MEMORY;
instantiations->Append(seed);
// if the propagation caused a match, then the results will be
// cached in the query, retrieved below by calling
// UseCachedResults. The matching result set owns the
// instantiations and will delete them when results have been
// iterated over. If the propagation did not match, the
// instantiations need to be deleted.
bool owned = false;
nsresult rv = root->Propagate(*instantiations, false, owned);
if (! owned)
delete instantiations;
if (NS_FAILED(rv))
return rv;
query->UseCachedResults(getter_AddRefs(results));
}
}
}
if (! results) {
// no results were found so create an empty set
results = new nsXULTemplateResultSetRDF(this, query, nsnull);
if (! results)
return NS_ERROR_OUT_OF_MEMORY;
}
results.swap(*aResults);
return NS_OK;
}
NS_IMETHODIMP
nsXULTemplateQueryProcessorRDF::AddBinding(nsIDOMNode* aRuleNode,
nsIAtom* aVar,
nsIAtom* aRef,
const nsAString& aExpr)
{
// add a <binding> to a rule. When a result is matched, the bindings are
// examined to add additional variable assignments
// bindings can't be added once result generation has started, otherwise
// the array sizes will get out of sync
if (mGenerationStarted)
return NS_ERROR_UNEXPECTED;
nsCOMPtr<nsIRDFResource> property;
nsresult rv = gRDFService->GetUnicodeResource(aExpr, getter_AddRefs(property));
if (NS_FAILED(rv))
return rv;
nsRefPtr<RDFBindingSet> bindings = mRuleToBindingsMap.GetWeak(aRuleNode);
if (!bindings) {
bindings = new RDFBindingSet();
if (!bindings || !mRuleToBindingsMap.Put(aRuleNode, bindings))
return NS_ERROR_OUT_OF_MEMORY;
}
return bindings->AddBinding(aVar, aRef, property);
}
NS_IMETHODIMP
nsXULTemplateQueryProcessorRDF::TranslateRef(nsISupports* aDatasource,
const nsAString& aRefString,
nsIXULTemplateResult** aRef)
{
// make sure the RDF service is set up
nsresult rv = InitGlobals();
if (NS_FAILED(rv))
return rv;
nsCOMPtr<nsIRDFResource> uri;
gRDFService->GetUnicodeResource(aRefString, getter_AddRefs(uri));
nsXULTemplateResultRDF* refresult = new nsXULTemplateResultRDF(uri);
if (! refresult)
return NS_ERROR_OUT_OF_MEMORY;
*aRef = refresult;
NS_ADDREF(*aRef);
return NS_OK;
}
NS_IMETHODIMP
nsXULTemplateQueryProcessorRDF::CompareResults(nsIXULTemplateResult* aLeft,
nsIXULTemplateResult* aRight,
nsIAtom* aVar,
PRUint32 aSortHints,
PRInt32* aResult)
{
NS_ENSURE_ARG_POINTER(aLeft);
NS_ENSURE_ARG_POINTER(aRight);
*aResult = 0;
// for natural order sorting, use the index in the RDF container for the
// order. If there is no container, just sort them arbitrarily.
if (!aVar) {
// if a result has a negative index, just sort it first
PRInt32 leftindex = GetContainerIndexOf(aLeft);
PRInt32 rightindex = GetContainerIndexOf(aRight);
*aResult = leftindex == rightindex ? 0 :
leftindex > rightindex ? 1 :
-1;
return NS_OK;
}
nsDependentAtomString sortkey(aVar);
nsCOMPtr<nsISupports> leftNode, rightNode;
if (!sortkey.IsEmpty() && sortkey[0] != '?' &&
!StringBeginsWith(sortkey, NS_LITERAL_STRING("rdf:")) &&
mDB) {
// if the sort key is not a template variable, it should be an RDF
// predicate. Get the targets and compare those instead.
nsCOMPtr<nsIRDFResource> predicate;
nsresult rv = gRDFService->GetUnicodeResource(sortkey, getter_AddRefs(predicate));
NS_ENSURE_SUCCESS(rv, rv);
// create a predicate with '?sort=true' appended. This special
// predicate may be used to have a different sort value than the
// displayed value
sortkey.AppendLiteral("?sort=true");
nsCOMPtr<nsIRDFResource> sortPredicate;
rv = gRDFService->GetUnicodeResource(sortkey, getter_AddRefs(sortPredicate));
NS_ENSURE_SUCCESS(rv, rv);
rv = GetSortValue(aLeft, predicate, sortPredicate, getter_AddRefs(leftNode));
NS_ENSURE_SUCCESS(rv, rv);
rv = GetSortValue(aRight, predicate, sortPredicate, getter_AddRefs(rightNode));
NS_ENSURE_SUCCESS(rv, rv);
}
else {
// get the values for the sort key from the results
aLeft->GetBindingObjectFor(aVar, getter_AddRefs(leftNode));
aRight->GetBindingObjectFor(aVar, getter_AddRefs(rightNode));
}
{
// Literals?
nsCOMPtr<nsIRDFLiteral> l = do_QueryInterface(leftNode);
if (l) {
nsCOMPtr<nsIRDFLiteral> r = do_QueryInterface(rightNode);
if (r) {
const PRUnichar *lstr, *rstr;
l->GetValueConst(&lstr);
r->GetValueConst(&rstr);
*aResult = XULSortServiceImpl::CompareValues(
nsDependentString(lstr),
nsDependentString(rstr), aSortHints);
}
return NS_OK;
}
}
{
// Dates?
nsCOMPtr<nsIRDFDate> l = do_QueryInterface(leftNode);
if (l) {
nsCOMPtr<nsIRDFDate> r = do_QueryInterface(rightNode);
if (r) {
PRTime ldate, rdate;
l->GetValue(&ldate);
r->GetValue(&rdate);
PRInt64 delta;
LL_SUB(delta, ldate, rdate);
if (LL_IS_ZERO(delta))
*aResult = 0;
else if (LL_GE_ZERO(delta))
*aResult = 1;
else
*aResult = -1;
}
return NS_OK;
}
}
{
// Integers?
nsCOMPtr<nsIRDFInt> l = do_QueryInterface(leftNode);
if (l) {
nsCOMPtr<nsIRDFInt> r = do_QueryInterface(rightNode);
if (r) {
PRInt32 lval, rval;
l->GetValue(&lval);
r->GetValue(&rval);
*aResult = lval - rval;
}
return NS_OK;
}
}
nsICollation* collation = nsXULContentUtils::GetCollation();
if (collation) {
// Blobs? (We can only compare these reasonably if we have a
// collation object.)
nsCOMPtr<nsIRDFBlob> l = do_QueryInterface(leftNode);
if (l) {
nsCOMPtr<nsIRDFBlob> r = do_QueryInterface(rightNode);
if (r) {
const PRUint8 *lval, *rval;
PRInt32 llen, rlen;
l->GetValue(&lval);
l->GetLength(&llen);
r->GetValue(&rval);
r->GetLength(&rlen);
collation->CompareRawSortKey(lval, llen, rval, rlen, aResult);
}
}
}
// if the results are none of the above, just pretend that they are equal
return NS_OK;
}
//----------------------------------------------------------------------
//
// nsIRDFObserver interface
//
NS_IMETHODIMP
nsXULTemplateQueryProcessorRDF::OnAssert(nsIRDFDataSource* aDataSource,
nsIRDFResource* aSource,
nsIRDFResource* aProperty,
nsIRDFNode* aTarget)
{
// Ignore updates if we're batching
if (mUpdateBatchNest)
return(NS_OK);
if (! mBuilder)
return NS_OK;
LOG("onassert", aSource, aProperty, aTarget);
Propagate(aSource, aProperty, aTarget);
SynchronizeAll(aSource, aProperty, nsnull, aTarget);
return NS_OK;
}
NS_IMETHODIMP
nsXULTemplateQueryProcessorRDF::OnUnassert(nsIRDFDataSource* aDataSource,
nsIRDFResource* aSource,
nsIRDFResource* aProperty,
nsIRDFNode* aTarget)
{
// Ignore updates if we're batching
if (mUpdateBatchNest)
return NS_OK;
if (! mBuilder)
return NS_OK;
LOG("onunassert", aSource, aProperty, aTarget);
Retract(aSource, aProperty, aTarget);
SynchronizeAll(aSource, aProperty, aTarget, nsnull);
return NS_OK;
}
NS_IMETHODIMP
nsXULTemplateQueryProcessorRDF::OnChange(nsIRDFDataSource* aDataSource,
nsIRDFResource* aSource,
nsIRDFResource* aProperty,
nsIRDFNode* aOldTarget,
nsIRDFNode* aNewTarget)
{
// Ignore updates if we're batching
if (mUpdateBatchNest)
return NS_OK;
if (! mBuilder)
return NS_OK;
LOG("onchange", aSource, aProperty, aNewTarget);
if (aOldTarget) {
// Pull any old results that were relying on aOldTarget
Retract(aSource, aProperty, aOldTarget);
}
if (aNewTarget) {
// Fire any new results that are activated by aNewTarget
Propagate(aSource, aProperty, aNewTarget);
}
// Synchronize any of the content model that may have changed.
SynchronizeAll(aSource, aProperty, aOldTarget, aNewTarget);
return NS_OK;
}
NS_IMETHODIMP
nsXULTemplateQueryProcessorRDF::OnMove(nsIRDFDataSource* aDataSource,
nsIRDFResource* aOldSource,
nsIRDFResource* aNewSource,
nsIRDFResource* aProperty,
nsIRDFNode* aTarget)
{
// Ignore updates if we're batching
if (mUpdateBatchNest)
return NS_OK;
NS_NOTYETIMPLEMENTED("write me");
return NS_ERROR_NOT_IMPLEMENTED;
}
NS_IMETHODIMP
nsXULTemplateQueryProcessorRDF::OnBeginUpdateBatch(nsIRDFDataSource* aDataSource)
{
mUpdateBatchNest++;
return NS_OK;
}
NS_IMETHODIMP
nsXULTemplateQueryProcessorRDF::OnEndUpdateBatch(nsIRDFDataSource* aDataSource)
{
NS_ASSERTION(mUpdateBatchNest > 0, "badly nested update batch");
if (--mUpdateBatchNest <= 0) {
mUpdateBatchNest = 0;
if (mBuilder)
mBuilder->Rebuild();
}
return NS_OK;
}
nsresult
nsXULTemplateQueryProcessorRDF::Propagate(nsIRDFResource* aSource,
nsIRDFResource* aProperty,
nsIRDFNode* aTarget)
{
// When a new assertion is added to the graph, determine any new matches
// that must be added to the template builder. First, iterate through all
// the RDF tests (<member> and <triple> tests), and find the topmost test
// that would be affected by the new assertion.
nsresult rv;
ReteNodeSet livenodes;
#ifdef PR_LOGGING
if (PR_LOG_TEST(gXULTemplateLog, PR_LOG_DEBUG)) {
const char* sourceStr;
aSource->GetValueConst(&sourceStr);
const char* propertyStr;
aProperty->GetValueConst(&propertyStr);
nsAutoString targetStr;
nsXULContentUtils::GetTextForNode(aTarget, targetStr);
PR_LOG(gXULTemplateLog, PR_LOG_ALWAYS,
("nsXULTemplateQueryProcessorRDF::Propagate: [%s] -> [%s] -> [%s]\n",
sourceStr, propertyStr, NS_ConvertUTF16toUTF8(targetStr).get()));
}
#endif
{
ReteNodeSet::Iterator last = mRDFTests.Last();
for (ReteNodeSet::Iterator i = mRDFTests.First(); i != last; ++i) {
nsRDFTestNode* rdftestnode = static_cast<nsRDFTestNode*>(*i);
Instantiation seed;
if (rdftestnode->CanPropagate(aSource, aProperty, aTarget, seed)) {
rv = livenodes.Add(rdftestnode);
if (NS_FAILED(rv))
return rv;
}
}
}
// Now, we'll go through each, and any that aren't dominated by
// another live node will be used to propagate the assertion
// through the rule network
{
ReteNodeSet::Iterator last = livenodes.Last();
for (ReteNodeSet::Iterator i = livenodes.First(); i != last; ++i) {
nsRDFTestNode* rdftestnode = static_cast<nsRDFTestNode*>(*i);
// What happens here is we create an instantiation as if we were
// at the found test in the rule network. For example, if the
// found test was a member test (parent => child), the parent
// and child variables are assigned the values provided by the new
// RDF assertion in the graph. The Constrain call is used to go
// up to earlier RDF tests, filling in variables as it goes.
// Constrain will eventually get up to the top node, an
// nsContentTestNode, which takes the value of the reference
// variable and calls the template builder to see if a result has
// been generated already for the reference value. If it hasn't,
// the new assertion couldn't cause a new match. If the result
// exists, call Propagate to continue to the later RDF tests to
// fill in the rest of the variable assignments.
// Bogus, to get the seed instantiation
Instantiation seed;
rdftestnode->CanPropagate(aSource, aProperty, aTarget, seed);
InstantiationSet* instantiations = new InstantiationSet();
if (!instantiations)
return NS_ERROR_OUT_OF_MEMORY;
instantiations->Append(seed);
rv = rdftestnode->Constrain(*instantiations);
if (NS_FAILED(rv)) {
delete instantiations;
return rv;
}
bool owned = false;
if (!instantiations->Empty())
rv = rdftestnode->Propagate(*instantiations, true, owned);
// owned should always be false in update mode, but check just
// to be sure
if (!owned)