* Use call_user_func( $func ) rather than $func(), like wgHooks and parser hooks
[lhc/web/wiklou.git] / includes / QueryPage.php
index 8b75eca..9488751 100644 (file)
@@ -7,7 +7,47 @@
 /**
  *
  */
-require_once ( 'Feed.php' );
+require_once 'Feed.php';
+
+/**
+ * List of query page classes and their associated special pages, for periodic update purposes
+ */
+global $wgQueryPages; // not redundant
+$wgQueryPages = array(
+//         QueryPage subclass           Special page name         Limit (false for none, none for the default)
+//----------------------------------------------------------------------------
+       array( 'AncientPagesPage',              'Ancientpages'                  ),
+       array( 'BrokenRedirectsPage',           'BrokenRedirects'               ),
+       array( 'CategoriesPage',                'Categories'                    ),
+       array( 'DeadendPagesPage',              'Deadendpages'                  ),
+       array( 'DisambiguationsPage',           'Disambiguations'               ),
+       array( 'DoubleRedirectsPage',           'DoubleRedirects'               ),
+       array( 'ListUsersPage',                 'Listusers'                     ),
+       array( 'LonelyPagesPage',               'Lonelypages'                   ),
+       array( 'LongPagesPage',                 'Longpages'                     ),
+       array( 'MostcategoriesPage',            'Mostcategories'                ),
+       array( 'MostimagesPage',                'Mostimages'                    ),
+       array( 'MostlinkedCategoriesPage',      'Mostlinkedcategories'          ),
+       array( 'MostlinkedPage',                'Mostlinked'                    ),
+       array( 'MostrevisionsPage',             'Mostrevisions'                 ),
+       array( 'NewPagesPage',                  'Newpages'                      ),
+       array( 'ShortPagesPage',                'Shortpages'                    ),
+       array( 'UncategorizedCategoriesPage',   'Uncategorizedcategories'       ),
+       array( 'UncategorizedPagesPage',        'Uncategorizedpages'            ),
+       array( 'UnusedCategoriesPage',          'Unusedcategories'              ),
+       array( 'UnusedimagesPage',              'Unusedimages'                  ),
+       array( 'WantedCategoriesPage',          'Wantedcategories'              ),
+       array( 'WantedPagesPage',               'Wantedpages'                   ),
+);
+wfRunHooks( 'wgQueryPages', array( &$wgQueryPages ) );
+
+global $wgDisableCounters;
+if ( !$wgDisableCounters )
+       $wgQueryPages[] = array( 'PopularPagesPage',            'Popularpages'          );
+global $wgEnableUnwatchedpages;
+if ( $wgEnableUnwatchedpages )
+       $wgQueryPages[] = array( 'UnwatchedPagesPage',          'Unwatchedpages'        );
+
 
 /**
  * This is a class for doing query pages; since they're almost all the same,
@@ -17,6 +57,21 @@ require_once ( 'Feed.php' );
  * @package MediaWiki
  */
 class QueryPage {
+       /**
+        * Whether or not we want plain listoutput rather than an ordered list
+        *
+        * @var bool
+        */
+       var $listoutput = false;
+
+       /**
+        * A mutator for $this->listoutput;
+        *
+        * @param bool $bool
+        */
+       function setListoutput( $bool ) {
+               $this->listoutput = $bool;
+       }
 
        /**
         * Subclasses return their name here. Make sure the name is also
@@ -68,10 +123,30 @@ class QueryPage {
                return $wgDisableQueryPages;
        }
 
+       /**
+        * Whether or not the output of the page in question is retrived from
+        * the database cache.
+        *
+        * @return bool
+        */
+       function isCached() {
+               global $wgMiserMode;
+               
+               return $this->isExpensive() && $wgMiserMode;
+       }
+
+       /**
+        * Sometime we dont want to build rss / atom feeds.
+        */
+       function isSyndicated() {
+               return true;
+       }
+
        /**
         * Formats the results of the query for display. The skin is the current
         * skin; you can use it for making links. The result is a single row of
         * result data. You should be able to grab SQL results off of it.
+        * If the function return "false", the line output will be skipped.
         */
        function formatResult( $skin, $result ) {
                return '';
@@ -79,120 +154,200 @@ class QueryPage {
 
        /**
         * The content returned by this function will be output before any result
-       */
+        */
        function getPageHeader( ) {
                return '';
        }
 
+       /**
+        * If using extra form wheely-dealies, return a set of parameters here
+        * as an associative array. They will be encoded and added to the paging
+        * links (prev/next/lengths).
+        * @return array
+        */
+       function linkParameters() {
+               return array();
+       }
+
+       /**
+        * Some special pages (for example SpecialListusers) might not return the
+        * current object formatted, but return the previous one instead.
+        * Setting this to return true, will call one more time wfFormatResult to
+        * be sure that the very last result is formatted and shown.
+        */
+       function tryLastResult( ) {
+               return false;
+       }
+
+       /**
+        * Clear the cache and save new results
+        */
+       function recache( $limit, $ignoreErrors = true ) {
+               $fname = get_class($this) . '::recache';
+               $dbw =& wfGetDB( DB_MASTER );
+               $dbr =& wfGetDB( DB_SLAVE, array( $this->getName(), 'QueryPage::recache', 'vslow' ) );
+               if ( !$dbw || !$dbr ) {
+                       return false;
+               }
+
+               $querycache = $dbr->tableName( 'querycache' );
+
+               if ( $ignoreErrors ) {
+                       $ignoreW = $dbw->ignoreErrors( true );
+                       $ignoreR = $dbr->ignoreErrors( true );
+               }
+
+               # Clear out any old cached data
+               $dbw->delete( 'querycache', array( 'qc_type' => $this->getName() ), $fname );
+               # Do query
+               $sql = $this->getSQL() . $this->getOrder();
+               if ($limit !== false)
+                       $sql = $dbr->limitResult($sql, $limit, 0);
+               $res = $dbr->query($sql, $fname);
+               $num = false;
+               if ( $res ) {
+                       $num = $dbr->numRows( $res );
+                       # Fetch results
+                       $insertSql = "INSERT INTO $querycache (qc_type,qc_namespace,qc_title,qc_value) VALUES ";
+                       $first = true;
+                       while ( $res && $row = $dbr->fetchObject( $res ) ) {
+                               if ( $first ) {
+                                       $first = false;
+                               } else {
+                                       $insertSql .= ',';
+                               }
+                               if ( isset( $row->value ) ) {
+                                       $value = $row->value;
+                               } else {
+                                       $value = '';
+                               }
+
+                               $insertSql .= '(' .
+                                       $dbw->addQuotes( $row->type ) . ',' .
+                                       $dbw->addQuotes( $row->namespace ) . ',' .
+                                       $dbw->addQuotes( $row->title ) . ',' .
+                                       $dbw->addQuotes( $value ) . ')';
+                       }
+
+                       # Save results into the querycache table on the master
+                       if ( !$first ) {
+                               if ( !$dbw->query( $insertSql, $fname ) ) {
+                                       // Set result to false to indicate error
+                                       $dbr->freeResult( $res );
+                                       $res = false;
+                               }
+                       }
+                       if ( $res ) {
+                               $dbr->freeResult( $res );
+                       }
+                       if ( $ignoreErrors ) {
+                               $dbw->ignoreErrors( $ignoreW );
+                               $dbr->ignoreErrors( $ignoreR );
+                       }
+               }
+               return $num;
+       }
+
        /**
         * This is the actual workhorse. It does everything needed to make a
         * real, honest-to-gosh query page.
         *
         * @param $offset database query offset
         * @param $limit database query limit
+        * @param $shownavigation show navigation like "next 200"?
         */
-       function doQuery( $offset, $limit ) {
-               global $wgUser, $wgOut, $wgLang, $wgRequest;
-               global $wgMiserMode;
-
+       function doQuery( $offset, $limit, $shownavigation=true ) {
+               global $wgUser, $wgOut, $wgContLang;
+               
                $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 );
-               $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 ) . ')';
-                               }
+               $wgOut->setSyndicated( $this->isSyndicated() );
 
-                               # 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 ) {
+               if ( $this->isCached() ) {
+                       $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 ( ! $this->listoutput )
                                $wgOut->addWikiText( wfMsg( 'perfcached' ) );
-                       }
-               }
-               if ( $res === false ) {
-                       $res = $dbr->query( $sql . $this->getOrder() .
-                                           $dbr->limitResult( $limit,$offset ), $fname );
-                       $num = $dbr->numRows($res);
                }
 
+               $sql .= $this->getOrder();
+               $sql = $dbr->limitResult($sql, $limit, $offset);
+               $res = $dbr->query( $sql );
+               $num = $dbr->numRows($res);
+
+               $this->preprocessResults( $dbr, $res );
 
                $sk = $wgUser->getSkin( );
 
-               $wgOut->addHTML( $this->getPageHeader() );
+               if($shownavigation) {
+                       $wgOut->addHTML( $this->getPageHeader() );
+                       $top = wfShowingResults( $offset, $num);
+                       $wgOut->addHTML( "<p>{$top}\n" );
 
-               $top = wfShowingResults( $offset, $num);
-               $wgOut->addHTML( "<p>{$top}\n" );
+                       # often disable 'next' link when we reach the end
+                       $atend = $num < $limit;
 
-               # often disable 'next' link when we reach the end
-               if($num < $limit) { $atend = true; } else { $atend = false; }
+                       $sl = wfViewPrevNext( $offset, $limit ,
+                               $wgContLang->specialPage( $sname ),
+                               wfArrayToCGI( $this->linkParameters() ), $atend );
+                       $wgOut->addHTML( "<br />{$sl}</p>\n" );
+               }
+               if ( $num > 0 ) {
+                       $s = array();
+                       if ( ! $this->listoutput )
+                               $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 );
+                               if ( $format ) {
+                                       $attr = ( isset ( $obj->usepatrol ) && $obj->usepatrol &&
+                                                                               $obj->patrolled == 0 ) ? ' class="not-patrolled"' : '';
+                                       $s[] = $this->listoutput ? $format : "<li{$attr}>{$format}</li>\n";
+                               }
+                       }
 
-               $sl = wfViewPrevNext( $offset, $limit , $wgLang->specialPage( $sname ), "" ,$atend );
-               $wgOut->addHTML( "<br />{$sl}</p>\n" );
+                       if($this->tryLastResult()) {
+                               // flush the very last result
+                               $obj = null;
+                               $format = $this->formatResult( $sk, $obj );
+                               if( $format ) {
+                                       $attr = ( isset ( $obj->usepatrol ) && $obj->usepatrol &&
+                                                                               $obj->patrolled == 0 ) ? ' class="not-patrolled"' : '';
+                                       $s[] = "<li{$attr}>{$format}</li>\n";
+                               }
+                       }
 
-               $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 );
-                       $attr = ( isset ( $obj->usepatrol ) && $obj->usepatrol &&
-                                 $obj->patrolled == 0 ) ? ' class="not_patrolled"' : '';
-                       $s .= "<li{$attr}>{$format}</li>\n";
+                       $dbr->freeResult( $res );
+                       if ( ! $this->listoutput )
+                               $s[] = '</ol>';
+                       $str = $this->listoutput ? $wgContLang->listToText( $s ) : implode( '', $s );
+                       $wgOut->addHTML( $str );
                }
-               $dbr->freeResult( $res );
-               $s .= '</ol>';
-               $wgOut->addHTML( $s );
-               $wgOut->addHTML( "<p>{$sl}</p>\n" );
+               if($shownavigation) {
+                       $wgOut->addHTML( "<p>{$sl}</p>\n" );
+               }
+               return $num;
        }
 
+       /**
+        * Do any necessary preprocessing of the result object.
+        * You should pass this by reference: &$db , &$res
+        */
+       function preprocessResults( $db, $res ) {}
+
        /**
         * Similar to above, but packaging in a syndicated feed instead of a web page
         */
        function doFeed( $class = '' ) {
                global $wgFeedClasses;
-               global $wgOut, $wgLanguageCode, $wgLang;
+               
                if( isset($wgFeedClasses[$class]) ) {
                        $feed = new $wgFeedClasses[$class](
                                $this->feedTitle(),
@@ -201,7 +356,8 @@ class QueryPage {
                        $feed->outHeader();
 
                        $dbr =& wfGetDB( DB_SLAVE );
-                       $sql = $this->getSQL() . $this->getOrder().$dbr->limitResult( 50, 0 );
+                       $sql = $this->getSQL() . $this->getOrder();
+                       $sql = $dbr->limitResult( $sql, 50, 0 );
                        $res = $dbr->query( $sql, 'QueryPage::doFeed' );
                        while( $obj = $dbr->fetchObject( $res ) ) {
                                $item = $this->feedResult( $obj );
@@ -224,14 +380,9 @@ class QueryPage {
                if( !isset( $row->title ) ) {
                        return NULL;
                }
-               $title = Title::MakeTitle( IntVal( $row->namespace ), $row->title );
+               $title = Title::MakeTitle( intval( $row->namespace ), $row->title );
                if( $title ) {
-                       if( isset( $row->timestamp ) ) {
-                               $date = $row->timestamp;
-                       } else {
-                               $date = '';
-                       }
-
+                       $date = isset( $row->timestamp ) ? $row->timestamp : '';
                        $comments = '';
                        if( $title ) {
                                $talkpage = $title->getTalkPage();
@@ -239,7 +390,7 @@ class QueryPage {
                        }
 
                        return new FeedItem(
-                               $title->getText(),
+                               $title->getPrefixedText(),
                                $this->feedItemDesc( $row ),
                                $title->getFullURL(),
                                $date,
@@ -251,30 +402,15 @@ class QueryPage {
        }
 
        function feedItemDesc( $row ) {
-               $text = '';
-               if( isset( $row->comment ) ) {
-                       $text = htmlspecialchars( $row->comment );
-               } else {
-                       $text = '';
-               }
-
-               if( isset( $row->text ) ) {
-                       $text = '<p>' . htmlspecialchars( wfMsg( 'summary' ) ) . ': ' . $text . "</p>\n<hr />\n<div>" .
-                               nl2br( htmlspecialchars( $row->text ) ) . "</div>";;
-               }
-               return $text;
+               return isset( $row->comment ) ? htmlspecialchars( $row->comment ) : '';
        }
 
        function feedItemAuthor( $row ) {
-               if( isset( $row->user_text ) ) {
-                       return $row->user_text;
-               } else {
-                       return '';
-               }
+               return isset( $row->user_text ) ? $row->user_text : '';
        }
 
        function feedTitle() {
-               global $wgLanguageCode, $wgSitename, $wgLang;
+               global $wgLanguageCode, $wgSitename;
                $page = SpecialPage::getPage( $this->getName() );
                $desc = $page->getDescription();
                return "$wgSitename - $desc [$wgLanguageCode]";
@@ -285,7 +421,6 @@ class QueryPage {
        }
 
        function feedUrl() {
-               global $wgLang;
                $title = Title::MakeTitle( NS_SPECIAL, $this->getName() );
                return $title->getFullURL();
        }
@@ -301,8 +436,9 @@ class QueryPage {
 class PageQueryPage extends QueryPage {
 
        function formatResult( $skin, $result ) {
+               global $wgContLang;
                $nt = Title::makeTitle( $result->namespace, $result->title );
-               return $skin->makeKnownLinkObj( $nt, '' );
+               return $skin->makeKnownLinkObj( $nt, htmlspecialchars( $wgContLang->convert( $nt->getPrefixedText() ) ) );
        }
 }