Replace ugly abuse of log pages to store cached results of query pages
[lhc/web/wiklou.git] / includes / QueryPage.php
index b7a19ff..5b68965 100644 (file)
@@ -1,7 +1,6 @@
 <?php
 
-include_once ( "LogPage.php" ) ;
-include_once ( "Feed.php" );
+require_once ( "Feed.php" );
 
 # This is a class for doing query pages; since they're almost all the same,
 # we factor out some of the functionality into a superclass, and let
@@ -16,10 +15,30 @@ class QueryPage {
                return "";
        }
 
-       # Subclasses return a SQL query here.
+       # Subclasses return an SQL query here.
+       #
+       # Note that the query itself should return the following three columns:
+       # 'type' (your special page's name), 'namespace, 'title', and 'value'
+       # (numeric) *in that order*. These may be stored in the querycache table
+       # for expensive queries, and that cached data will be returned sometimes,
+       # so the presence of extra fields can't be relied on.
+       #
+       # Don't include an ORDER or LIMIT clause, this will be added.
+
+       function getSQL() {
+               return "SELECT 'sample' as type, 0 as namespace, 'Sample result' as title, 42 as value";
+       }
+       
+       # Override to sort by increasing values
+       function sortDescending() {
+               return true;
+       }
 
-       function getSQL( $offset, $limit ) {
-               return "";
+       # Don't override this unless you're darn sure.
+       function getOrderLimit( $offset, $limit ) {
+               return " ORDER BY value " .
+                       ($this->sortDescending() ? "DESC" : "")
+                       . " LIMIT {$offset}, {$limit}";
        }
 
        # Is this query expensive (for some definition of expensive)? Then we
@@ -40,39 +59,58 @@ class QueryPage {
        
        # This is the actual workhorse. It does everything needed to make a
        # real, honest-to-gosh query page.
-
+       
        function doQuery( $offset, $limit ) {
-
-               global $wgUser, $wgOut, $wgLang, $wgMiserMode;
+               global $wgUser, $wgOut, $wgLang, $wgRequest;
+               global $wgMiserMode;
 
                $sname = $this->getName();
                $fname = get_class($this) . "::doQuery";
+               $sql = $this->getSQL( $offset, $limit );
 
-               if ( $this->isExpensive( ) ) {
-
-                       $vsp = $wgLang->getValidSpecialPages();
-                       $logpage = new LogPage( "!" . $vsp[$sname] );
-                       $logpage->mUpdateRecentChanges = false;
-
-                       if ( $wgMiserMode ) {
-                               $logpage->showAsDisabledPage();
-                               return;
+               $wgOut->setSyndicated( true );
+               
+               if ( $this->isExpensive() ) {
+                       $type = wfStrencode( $sname );
+                       $recache = $wgRequest->getBool( "recache" );
+                       if( $recache ) {
+                               # Clear out any old cached data
+                               $res = wfQuery( "DELETE FROM querycache WHERE qc_type='$type'", DB_WRITE, $fname );
+
+                               # Save results into the querycache table
+                               $maxstored = 1000;
+                               $res = wfQuery(
+                                       "INSERT INTO querycache(qc_type,qc_namespace,qc_title,qc_value) " .
+                                       $this->getSQL() .
+                                       $this->getOrderLimit( 0, $maxstored ),
+                                       DB_WRITE, $fname );
+                       }
+                       if( $wgMiserMode || $recache ) {
+                               $sql =
+                                       "SELECT qc_type as type, qc_namespace as namespace,qc_title as title, qc_value as value
+                                        FROM querycache WHERE qc_type='$type'";
+                       }
+                       if( $wgMiserMode ) {
+                               $wgOut->addWikiText( wfMsg( "perfcached" ) );
                        }
                }
 
-               $sql = $this->getSQL( $offset, $limit );
-
-               $res = wfQuery( $sql, DB_READ, $fname );
-
+               $res = wfQuery( $sql . $this->getOrderLimit( $offset, $limit ), DB_READ, $fname );
+               
+               $num = wfNumRows($res);
+               
                $sk = $wgUser->getSkin( );
 
-               $top = wfShowingResults( $offset, $limit );
+               $top = wfShowingResults( $offset, $num);
                $wgOut->addHTML( "<p>{$top}\n" );
 
-               $sl = wfViewPrevNext( $offset, $limit, $wgLang->specialPage( $sname ) );
-               $wgOut->addHTML( "<br>{$sl}\n" );
+               # often disable 'next' link when we reach the end
+               if($num < $limit) { $atend = true; } else { $atend = false; }
+               
+               $sl = wfViewPrevNext( $offset, $limit , $wgLang->specialPage( $sname ), "" ,$atend );
+               $wgOut->addHTML( "<br />{$sl}</p>\n" );
 
-               $s = "<ol start=" . ( $offset + 1 ) . ">";
+               $s = "<ol start='" . ( $offset + 1 ) . "'>";
                while ( $obj = wfFetchObject( $res ) ) {
                        $format = $this->formatResult( $sk, $obj );
                        $s .= "<li>{$format}</li>\n";
@@ -80,23 +118,15 @@ class QueryPage {
                wfFreeResult( $res );
                $s .= "</ol>";
                $wgOut->addHTML( $s );
-               $wgOut->addHTML( "<p>{$sl}\n" );
-
-               # Saving cache
-
-               if ( $this->isExpensive() && $offset == 0 && $limit >= 50 ) {
-                       $logpage->replaceContent( $s );
-               }
+               $wgOut->addHTML( "<p>{$sl}</p>\n" );
        }
        
        # Similar to above, but packaging in a syndicated feed instead of a web page
        function doFeed( $class = "" ) {
                global $wgFeedClasses;
                global $wgOut, $wgLanguageCode, $wgLang;
-               if( $class == "rss" ) {
-                       $wgOut->disable();
-                       
-                       $feed = new RSSFeed(
+               if( isset($wgFeedClasses[$class]) ) {
+                       $feed = new $wgFeedClasses[$class](
                                $this->feedTitle(),
                                $this->feedDesc(),
                                $this->feedUrl() );
@@ -119,45 +149,58 @@ class QueryPage {
 
        # Override for custom handling. If the titles/links are ok, just do feedItemDesc()
        function feedResult( $row ) {
-               if( isset( $row->cur_title ) ) {
-                       $title = Title::MakeTitle( $row->cur_namespace, $row->cur_title );
-               } elseif( isset( $row->old_title ) ) {
-                       $title = Title::MakeTitle( $row->old_namespace, $row->old_title );
-               } elseif( isset( $row->rc_title ) ) {
-                       $title = Title::MakeTitle( $row->rc_namespace, $row->rc_title );
-               } else {
+               if( !isset( $row->title ) ) {
                        return NULL;
                }
+               $title = Title::MakeTitle( IntVal( $row->namespace ), $row->title );
                if( $title ) {
-                       $date = "";
-                       if( isset( $row->cur_timestamp ) ) {
-                               $date = $row->cur_timestamp;
-                       } elseif( isset( $row->old_timestamp ) ) {
-                               $date = $row->old_timestamp;
-                       } elseif( isset( $row->rc_cur_timestamp ) ) {
-                               $date = $row->rc_cur_timestamp;
+                       if( isset( $row->timestamp ) ) {
+                               $date = $row->timestamp;
+                       } else {
+                               $date = "";
                        }
+                       
+                       $comments = "";
+                       if( $title ) {
+                               $talkpage = $title->getTalkPage();
+                               $comments = $talkpage->getFullURL();
+                       }
+                       
                        return new FeedItem(
                                $title->getText(),
                                $this->feedItemDesc( $row ),
                                $title->getFullURL(),
-                               $date);
+                               $date,
+                               $this->feedItemAuthor( $row ),
+                               $comments);
                } else {
                        return NULL;
                }
        }
        
        function feedItemDesc( $row ) {
-               if( isset( $row->cur_comment ) ) {
-                       return $row->cur_comment;
-               } elseif( isset( $row->old_comment ) ) {
-                       return $row->old_comment;
-               } elseif( isset( $row->rc_comment ) ) {
-                       return $row->rc_comment;
+               $text = "";
+               if( isset( $row->comment ) ) {
+                       $text = htmlspecialchars( $row->comment );
+               } else {
+                       $text = "";
                }
-               return "";
+               
+               if( isset( $row->text ) ) {
+                       $text = "<p>" . htmlspecialchars( wfMsg( "summary" ) ) . ": " . $text . "</p>\n<hr />\n<div>" .
+                               nl2br( htmlspecialchars( $row->text ) ) . "</div>";;
+               }
+               return $text;
        }
-
+       
+       function feedItemAuthor( $row ) {
+               if( isset( $row->user_text ) ) {
+                       return $row->user_text;
+               } else {
+                       return "";
+               }
+       }
+       
        function feedTitle() {
                global $wgLanguageCode, $wgSitename, $wgLang;
                $pages = $wgLang->getValidSpecialPages();
@@ -171,7 +214,8 @@ class QueryPage {
        
        function feedUrl() {
                global $wgLang;
-               return wfFullUrl( $wgLang->SpecialPage( $this->getName() ) );
+               $title = Title::MakeTitle( NS_SPECIAL, $this->getName() );
+               return $title->getFullURL();
        }
 }
 
@@ -182,7 +226,8 @@ class QueryPage {
 class PageQueryPage extends QueryPage {
 
        function formatResult( $skin, $result ) {
-               return $skin->makeKnownLink( $result->cur_title, "" );
+               $nt = Title::makeTitle( $result->namespace, $result->title );
+               return $skin->makeKnownLinkObj( $nt, "" );
        }
 }