Changeset 9149

Timestamp:

09/16/10 07:29:07 (21 months ago)

Author:

CrawfordCurrie

Message:

Item8841: comment cleanup and correction. No code changes.

Location:

branches/Release01x01/core/lib/Foswiki

Files:

• Query/HoistREs.pm (modified) (1 diff)
• Store/QueryAlgorithms/BruteForce.pm (modified) (14 diffs)

branches/Release01x01/core/lib/Foswiki/Query/HoistREs.pm

@@ -9 +9 @@
 representation to pre-filter topic lists for more efficient query matching.
 
-See =Store/RcsFile.pm= for an example of usage.
+See =Store/QueryAlgorithms/BruteForce.pm= for an example of usage.
 
 =cut

branches/Release01x01/core/lib/Foswiki/Store/QueryAlgorithms/BruteForce.pm

@@ -15 +15 @@
 that it's around 6 topics, though this may vary depending on disk
 speed and memory size. It also depends on the complexity of the query.
+
+TODO: There is an additional opprotunity for optimisation; if we assume
+the grep is solid, we can cut those parts of the query out for the full
+evaluation path. Not done yet, because CDot strongly suspects it won't make
+much difference.
 
 =cut
@@ -29 +34 @@
 use Foswiki::Search::ResultSet ();
 use Foswiki::MetaCache         ();
+use Foswiki::Query::Node       ();
+use Foswiki::Query::HoistREs   ();
 
 # See Foswiki::Query::QueryAlgorithms.pm for details
@@ -34 +41 @@
     my ( $query, $inputTopicSet, $session, $options ) = @_;
 
-    #TODO: th 1==2 and other false optimisations..
-    #if ( !defined($query->{tokens}) or
-    #    (@{ $query->{tokens} } ) == 0) {
-    #    return new Foswiki::Search::InfoCache($session, '');
-    #}
-
-    # Eliminate static expressions
+    # Fold constants
     my $context = Foswiki::Meta->new( $session, $session->{webName} );
     $query->simplify( tom => $context, data => $context );
@@ -59 +60 @@
 
         my $webObject = Foswiki::Meta->new( $session, $web );
-        my $thisWebNoSearchAll = Foswiki::isTrue( $webObject->getPreference('NOSEARCHALL') );
+        my $thisWebNoSearchAll = Foswiki::isTrue(
+            $webObject->getPreference('NOSEARCHALL') );
 
         # make sure we can report this web on an 'all' search
@@ -83 +85 @@
 }
 
-#ok, for initial validation, naively call the code with a web.
+# Query over a single web
 sub _webQuery {
     my ( $query, $web, $inputTopicSet, $session, $options ) = @_;
@@ -90 +92 @@
       new Foswiki::Search::InfoCache( $Foswiki::Plugins::SESSION, $web );
 
-#see if this query can be fasttracked.
-#TODO: is this simplification call appropriate here, or should it go in Search.pm
-#TODO: what about simplify to constant in _this_ web?
-    my $queryIsAConstantFastpath;    #undefined if this is a 'real' query'
+    # see if this query can be fasttracked.
+    # TODO: is this simplification call appropriate here, or should it
+    # go in Search.pm
+    # TODO: what about simplify to constant in _this_ web?
+    my $queryIsAConstantFastpath;    # undefined if this is a 'real' query'
     $query->simplify();
     if ( $query->evaluatesToConstant() ) {
 
-        #SMELL: use any old topic
-        my $cache = $Foswiki::Plugins::SESSION->search->metacache->get( $web,
-            'WebPreferences' );
+        # SMELL: use any old topic
+        my $cache = $Foswiki::Plugins::SESSION->search->metacache->get(
+            $web, 'WebPreferences' );
         my $meta = $cache->{tom};
         $queryIsAConstantFastpath =
           $query->evaluate( tom => $meta, data => $meta );
-
     }
 
@@ -115 +117 @@
     else {
 
-#from here on, FALSE means its not a constant, TRUE means is is a constant and evals to TRUE
+        # from here on, FALSE means its not a constant, TRUE
+        # means is is a constant and evals to TRUE
         $queryIsAConstantFastpath = 0;
     }
 
-    require Foswiki::Query::HoistREs;
+    # Try and hoist regular expressions out of the query that we
+    # can use to refine the topic set
+
     my $hoistedREs = Foswiki::Query::HoistREs::collatedHoist($query);
+
+    # Reduce the input topic set by matching simple topic names hoisted
+    # from the query.
 
     if (
@@ -127 +135 @@
         and (
             scalar( @{ $hoistedREs->{name} } ) == 1
-        ) #only do this if the 'name' query is simple (ie, has only one element)
+        )
       )
     {
+        # only do this if the 'name' query is simple
+        # (ie, has only one element)
         my @filter = @{ $hoistedREs->{name_source} };
 
@@ -136 +146 @@
     }
 
+    # Reduce the input topic set by matching the hoisted REs against
+    # the topics in it.
+
     my $topicSet = $inputTopicSet;
     if ( !defined($topicSet) ) {
 
-        #then we start with the whole web?
-        #TODO: i'm sure that is a flawed assumption
+        # then we start with the whole web?
+        # TODO: i'm sure that is a flawed assumption
         my $webObject = Foswiki::Meta->new( $session, $web );
         $topicSet =
@@ -147 +160 @@
     }
 
-    #TODO: howto ask iterator for list length?
-    #TODO: once the inputTopicSet isa ResultSet we might have an idea
-    #TODO: I presume $hoisetedRE's is undefined for constant queries..
+    # TODO: how to ask iterator for list length?
+    # TODO: once the inputTopicSet isa ResultSet we might have an idea
+    # TODO: I presume $hoisetedRE's is undefined for constant queries..
     #    if (() and ( scalar(@$topics) > 6 )) {
     if ( defined( $hoistedREs->{text} ) ) {
@@ -169 +182 @@
     else {
 
-#TODO: clearly _this_ can be re-written as a FilterIterator, and if we are able to use the sorting hints (ie DB Store) can propogate all the way to FORMAT
+        # TODO: clearly _this_ can be re-written as a FilterIterator,
+        # and if we are able to use the sorting hints (ie DB Store)
+        # can propogate all the way to FORMAT
 
         #print STDERR "WARNING: couldn't hoistREs on ".$query->toString();
@@ -183 +198 @@
             if ( defined( $options->{date} ) ) {
 
-#TODO: preload the meta cache if we're doing date based filtering - else the wrong filedate will be used
+                # TODO: preload the meta cache if we're doing date
+                # based filtering - else the wrong filedate will be used
                 $Foswiki::Plugins::SESSION->search->metacache->get( $Iweb,
                     $topic );
             }
 
-#TODO: frustratingly, there is no way to evaluate a filterIterator without actually iterating over it..
+            # TODO: frustratingly, there is no way to evaluate a
+            # filterIterator without actually iterating over it..
             $resultTopicSet->addTopics( $Iweb, $topic );
         }
@@ -201 +218 @@
             $meta = $meta->load() unless ( $meta->latestIsLoaded() );
             print STDERR "Processing $topic\n"
-              if Foswiki::Query::Node::MONITOR_EVAL();
+              if Foswiki::Query::Node::MONITOR_EVAL;
             my $match = $query->evaluate( tom => $meta, data => $meta );
             if ($match) {
@@ -354 +371 @@
 1;
 __END__
-Author: Crawford Currie http://c-dot.co.uk
+Authors: Crawford Currie http://c-dot.co.uk, Sven Dowideit http://fosiki.com
 
 Foswiki - The Free and Open Source Wiki, http://foswiki.org/