A major reworking of [[Special:Allmessages]].
[lhc/web/wiklou.git] / includes / QueryPage.php
index 6ba0339..92a9911 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
@@ -9,17 +8,45 @@ include_once ( "Feed.php" );
 
 class QueryPage {
        # Subclasses return their name here. Make sure the name is also
-       # specified in Language.php, both in the $wgValidSpecialPagesEn
-       # variable, and as a language message param.
+       # specified in SpecialPage.php and in Language.php as a language message param.
 
        function getName() {
                return "";
        }
 
-       # Subclasses return a SQL query here.
+       # Subclasses return an SQL query here.
+       #
+       # Note that the query itself should return the following four columns:
+       # 'type' (your special page's name), 'namespace', 'title', and 'value'
+       # *in that order*. 'value' is used for sorting.
+       #
+       # 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 upon. The cached 'value' column will be
+       # an integer; non-numeric values are useful only for sorting the initial
+       # query.
+       #
+       # Don't include an ORDER or LIMIT clause, this will be added.
 
-       function getSQL( $offset, $limit ) {
-               return "";
+       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;
+       }
+
+       # Don't override this unless you're darn sure.
+       function getOrderLimit( $offset, $limit ) {
+               return " ORDER BY value " .
+                       ($this->sortDescending() ? "DESC" : "")
+                       . wfLimitResult($limit,$offset);
+       }
+
+       function getOrder() {
+               return " ORDER BY value " .
+                       ($this->sortDescending() ? "DESC" : "");
        }
 
        # Is this query expensive (for some definition of expensive)? Then we
@@ -37,76 +64,123 @@ class QueryPage {
        function formatResult( $skin, $result ) {
                return "";
        }
-       
+
        # 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();
+               $dbr =& wfGetDB( DB_SLAVE );
+               $dbw =& wfGetDB( DB_MASTER );
+               $querycache = $dbr->tableName( 'querycache' );
 
                $wgOut->setSyndicated( true );
-               
-               if ( $this->isExpensive( ) ) {
-                       $vsp = $wgLang->getValidSpecialPages();
-                       $logpage = new LogPage( "!" . $vsp[$sname] );
-                       $logpage->mUpdateRecentChanges = false;
-
-                       if ( $wgMiserMode ) {
-                               $logpage->showAsDisabledPage();
-                               return;
+               $res = false;
+
+               if ( $this->isExpensive() ) {
+                       $recache = $wgRequest->getBool( "recache" );
+                       if( $recache ) {
+                               # Clear out any old cached data
+                               $dbw->delete( 'querycache', array( 'qc_type' => $sname ), $fname );
+
+                               # Do query on the (possibly out of date) slave server
+                               $maxstored = 1000;
+                               $res = $dbr->query( $sql . $this->getOrder() . $dbr->limitResult( $maxstored,0 ), $fname );
+
+                               # Fetch results
+                               $insertSql = "INSERT INTO $querycache (qc_type,qc_namespace,qc_title,qc_value) VALUES ";
+                               $first = true;
+                               while ( $row = $dbr->fetchObject( $res ) ) {
+                                       if ( $first ) {
+                                               $first = false;
+                                       } else {
+                                               $insertSql .= ",";
+                                       }
+                                       $insertSql .= "(" .
+                                               $dbw->addQuotes( $row->type ) . "," .
+                                               $dbw->addQuotes( $row->namespace ) . "," .
+                                               $dbw->addQuotes( $row->title ) . "," .
+                                               $dbw->addQuotes( $row->value ) . ")";
+                               }
+
+                               # Save results into the querycache table on the master
+                               $dbw->query( $insertSql, $fname );
+
+                               # Set result pointer to allow reading for display
+                               $numRows = $dbr->numRows( $res );
+                               if ( $numRows <= $offset ) {
+                                       $num = 0;
+                               } else {
+                                       $dbr->dataSeek( $res, $offset );
+                                       $num = max( $limit, $numRows - $offset );
+                               }
+                       }
+                       if( $wgMiserMode || $recache ) {
+                               $type = $dbr->strencode( $sname );
+                               $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" ) );
                        }
                }
+               if ( $res === false ) {
+                       $res = $dbr->query( $sql . $this->getOrder() . 
+                                           $dbr->limitResult( $limit,$offset ), $fname );
+                       $num = $dbr->numRows($res);
+               }
 
-               $sql = $this->getSQL( $offset, $limit );
-
-               $res = wfQuery( $sql, DB_READ, $fname );
 
                $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 ) . ">";
-               while ( $obj = wfFetchObject( $res ) ) {
+               $s = "<ol start='" . ( $offset + 1 ) . "' class='special'>";
+               # Only read at most $num rows, because $res may contain the whole 1000
+               for ( $i = 0; $i < $num && $obj = $dbr->fetchObject( $res ); $i++ ) {
                        $format = $this->formatResult( $sk, $obj );
-                       $s .= "<li>{$format}</li>\n";
+                       $attr = ( !is_null ( $obj->usepatrol ) && $obj->usepatrol &&
+                                 $obj->patrolled == 0 ) ? ' class="not_patrolled"' : '';
+                       $s .= "<li{$attr}>{$format}</li>\n";
                }
-               wfFreeResult( $res );
+               $dbr->freeResult( $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" ) {
-                       $feed = new RSSFeed(
+               if( isset($wgFeedClasses[$class]) ) {
+                       $feed = new $wgFeedClasses[$class](
                                $this->feedTitle(),
                                $this->feedDesc(),
                                $this->feedUrl() );
                        $feed->outHeader();
-                       
-                       $sql = $this->getSQL( 0, 50 );
-                       $res = wfQuery( $sql, DB_READ, "QueryPage::doFeed" );
-                       while( $obj = wfFetchObject( $res ) ) {
+
+                       $dbr =& wfGetDB( DB_SLAVE );
+                       $sql = $this->getSQL() . $this->getOrder().$dbr->limitResult( 50, 0 );
+                       $res = $dbr->query( $sql, "QueryPage::doFeed" );
+                       while( $obj = $dbr->fetchObject( $res ) ) {
                                $item = $this->feedResult( $obj );
                                if( $item ) $feed->outItem( $item );
                        }
-                       wfFreeResult( $res );
+                       $dbr->freeResult( $res );
 
                        $feed->outFooter();
                        return true;
@@ -117,72 +191,69 @@ 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,
-                               $this->feedItemAuthor( $row ) );
+                               $this->feedItemAuthor( $row ),
+                               $comments);
                } else {
                        return NULL;
                }
        }
-       
+
        function feedItemDesc( $row ) {
                $text = "";
-               if( isset( $row->cur_comment ) ) {
-                       $text = $row->cur_comment;
-               } elseif( isset( $row->old_comment ) ) {
-                       $text = $row->old_comment;
-               } elseif( isset( $row->rc_comment ) ) {
-                       $text = $row->rc_comment;
+               if( isset( $row->comment ) ) {
+                       $text = htmlspecialchars( $row->comment );
+               } else {
+                       $text = "";
                }
-               $text = htmlspecialchars( $text );
-               
-               if( isset( $row->cur_text ) ) {
+
+               if( isset( $row->text ) ) {
                        $text = "<p>" . htmlspecialchars( wfMsg( "summary" ) ) . ": " . $text . "</p>\n<hr />\n<div>" .
-                               nl2br( $row->cur_text ) . "</div>";;
+                               nl2br( htmlspecialchars( $row->text ) ) . "</div>";;
                }
                return $text;
        }
-       
+
        function feedItemAuthor( $row ) {
-               $fields = array( "cur_user_text", "old_user_text", "rc_user_text" );
-               foreach( $fields as $field ) {
-                       if( isset( $row->$field ) ) return $row->field;
+               if( isset( $row->user_text ) ) {
+                       return $row->user_text;
+               } else {
+                       return "";
                }
-               return "";
        }
-       
+
        function feedTitle() {
                global $wgLanguageCode, $wgSitename, $wgLang;
-               $pages = $wgLang->getValidSpecialPages();
-               $title = $pages[$this->getName()];
-               return "$wgSitename - $title [$wgLanguageCode]";
+               $page = SpecialPage::getPage( $this->getName() );
+               $desc = $page->getDescription();
+               return "$wgSitename - $desc [$wgLanguageCode]";
        }
-       
+
        function feedDesc() {
                return wfMsg( "fromwikipedia" );
        }
-       
+
        function feedUrl() {
                global $wgLang;
                $title = Title::MakeTitle( NS_SPECIAL, $this->getName() );
@@ -197,7 +268,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, "" );
        }
 }