]> scripts.mit.edu Git - autoinstallsdev/mediawiki.git/blobdiff - includes/QueryPage.php
MediaWiki 1.15.0
[autoinstallsdev/mediawiki.git] / includes / QueryPage.php
index 6ed0de439dcf39f92b4a6dbe470d37f320ca6ca0..1cef31ea56c610cf4f7e63f6a85708dec6eaaf4f 100644 (file)
@@ -1,50 +1,89 @@
 <?php
 /**
  * Contain a class for special pages
- * @package MediaWiki
+ * @file
+ * @ingroup SpecialPages
  */
 
 /**
+ * List of query page classes and their associated special pages,
+ * for periodic updates.
  *
+ * DO NOT CHANGE THIS LIST without testing that
+ * maintenance/updateSpecialPages.php still works.
  */
-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
-//------------------------------------------------------------
-    array( 'AncientPagesPage',          'Ancientpages'      ),
-    array( 'BrokenRedirectsPage',       'BrokenRedirects'   ),
-    array( 'DeadendPagesPage',          'Deadendpages'      ),
-    array( 'DisambiguationsPage',       'Disambiguations'   ),
-    array( 'DoubleRedirectsPage',       'DoubleRedirects'   ),
-    array( 'ListUsersPage',             'Listusers'         ), 
-    array( 'LonelyPagesPage',           'Lonelypages'       ),
-    array( 'LongPagesPage',             'Longpages'         ),
-    array( 'NewPagesPage',              'Newpages'          ),
-    array( 'ShortPagesPage',            'Shortpages'        ),
-    array( 'UncategorizedCategoriesPage','Uncategorizedcategories'),
-    array( 'UncategorizedPagesPage',    'Uncategorizedpages'),
-    array( 'UnusedimagesPage',          'Unusedimages'      ),
-    array( 'WantedPagesPage',           'Wantedpages'       ),
-    array( 'MostlinkedPage',           'Mostlinked'        ),
+//         QueryPage subclass           Special page name         Limit (false for none, none for the default)
+//----------------------------------------------------------------------------
+       array( 'AncientPagesPage',              'Ancientpages'                  ),
+       array( 'BrokenRedirectsPage',           'BrokenRedirects'               ),
+       array( 'DeadendPagesPage',              'Deadendpages'                  ),
+       array( 'DisambiguationsPage',           'Disambiguations'               ),
+       array( 'DoubleRedirectsPage',           'DoubleRedirects'               ),
+       array( 'LinkSearchPage',                'LinkSearch'                    ),
+       array( 'ListredirectsPage',             'Listredirects'                                 ),
+       array( 'LonelyPagesPage',               'Lonelypages'                   ),
+       array( 'LongPagesPage',                 'Longpages'                     ),
+       array( 'MostcategoriesPage',            'Mostcategories'                ),
+       array( 'MostimagesPage',                'Mostimages'                    ),
+       array( 'MostlinkedCategoriesPage',      'Mostlinkedcategories'          ),
+       array( 'SpecialMostlinkedtemplates',    'Mostlinkedtemplates'                   ),
+       array( 'MostlinkedPage',                'Mostlinked'                    ),
+       array( 'MostrevisionsPage',             'Mostrevisions'                 ),
+       array( 'FewestrevisionsPage',           'Fewestrevisions'               ),
+       array( 'ShortPagesPage',                'Shortpages'                    ),
+       array( 'UncategorizedCategoriesPage',   'Uncategorizedcategories'       ),
+       array( 'UncategorizedPagesPage',        'Uncategorizedpages'            ),
+       array( 'UncategorizedImagesPage',       'Uncategorizedimages'                   ),
+       array( 'UncategorizedTemplatesPage',    'Uncategorizedtemplates'                ),
+       array( 'UnusedCategoriesPage',          'Unusedcategories'              ),
+       array( 'UnusedimagesPage',              'Unusedimages'                  ),
+       array( 'WantedCategoriesPage',          'Wantedcategories'              ),
+       array( 'WantedFilesPage',               'Wantedfiles'                   ),
+       array( 'WantedPagesPage',               'Wantedpages'                   ),
+       array( 'WantedTemplatesPage',          'Wantedtemplates'              ),
+       array( 'UnwatchedPagesPage',            'Unwatchedpages'                ),
+       array( 'UnusedtemplatesPage',           'Unusedtemplates'                               ),
+       array( 'WithoutInterwikiPage',                  'Withoutinterwiki'                              ),
 );
-    
+wfRunHooks( 'wgQueryPages', array( &$wgQueryPages ) );
+
 global $wgDisableCounters;
-if( !$wgDisableCounters ) {
-       $wgQueryPages[] = array( 'PopularPagesPage',          'Popularpages'      );
-}
+if ( !$wgDisableCounters )
+       $wgQueryPages[] = array( 'PopularPagesPage',            'Popularpages'          );
+
 
 /**
  * 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
  * subclasses derive from it.
- *
- * @package MediaWiki
+ * @ingroup SpecialPage
  */
 class QueryPage {
+       /**
+        * Whether or not we want plain listoutput rather than an ordered list
+        *
+        * @var bool
+        */
+       var $listoutput = false;
+
+       /**
+        * The offset and limit in use, as passed to the query() function
+        *
+        * @var integer
+        */
+       var $offset = 0;
+       var $limit = 0;
+
+       /**
+        * 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
@@ -55,6 +94,15 @@ class QueryPage {
                return '';
        }
 
+       /**
+        * Return title object representing this page
+        *
+        * @return Title
+        */
+       function getTitle() {
+               return SpecialPage::getTitleFor( $this->getName() );
+       }
+
        /**
         * Subclasses return an SQL query here.
         *
@@ -96,6 +144,18 @@ 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.
         */
@@ -119,7 +179,7 @@ class QueryPage {
        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
@@ -129,7 +189,7 @@ class QueryPage {
        function linkParameters() {
                return array();
        }
-       
+
        /**
         * Some special pages (for example SpecialListusers) might not return the
         * current object formatted, but return the previous one instead.
@@ -143,16 +203,16 @@ class QueryPage {
        /**
         * Clear the cache and save new results
         */
-       function recache( $ignoreErrors = true ) {
-               $fname = get_class($this) . '::recache';
-               $dbw =& wfGetDB( DB_MASTER );
-               $dbr =& wfGetDB( DB_SLAVE, array( $this->getName(), 'QueryPage::recache', 'vslow' ) );
+       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 );
@@ -161,7 +221,10 @@ class QueryPage {
                # Clear out any old cached data
                $dbw->delete( 'querycache', array( 'qc_type' => $this->getName() ), $fname );
                # Do query
-               $res = $dbr->query( $this->getSQL() . $this->getOrder() . $dbr->limitResult( 1000,0 ), $fname );
+               $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 );
@@ -175,9 +238,9 @@ class QueryPage {
                                        $insertSql .= ',';
                                }
                                if ( isset( $row->value ) ) {
-                                       $value = $row->value;
+                                       $value = intval( $row->value ); // @bug 14414
                                } else {
-                                       $value = '';
+                                       $value = 0;
                                }
 
                                $insertSql .= '(' .
@@ -202,6 +265,11 @@ class QueryPage {
                                $dbw->ignoreErrors( $ignoreW );
                                $dbr->ignoreErrors( $ignoreR );
                        }
+
+                       # Update the querycache_info record for the page
+                       $dbw->delete( 'querycache_info', array( 'qci_type' => $this->getName() ), $fname );
+                       $dbw->insert( 'querycache_info', array( 'qci_type' => $this->getName(), 'qci_timestamp' => $dbw->timestamp() ), $fname );
+
                }
                return $num;
        }
@@ -215,88 +283,188 @@ class QueryPage {
         * @param $shownavigation show navigation like "next 200"?
         */
        function doQuery( $offset, $limit, $shownavigation=true ) {
-               global $wgUser, $wgOut, $wgLang, $wgRequest, $wgContLang;
-               global $wgMiserMode;
+               global $wgUser, $wgOut, $wgLang, $wgContLang;
+
+               $this->offset = $offset;
+               $this->limit = $limit;
 
                $sname = $this->getName();
                $fname = get_class($this) . '::doQuery';
-               $sql = $this->getSQL();
-               $dbr =& wfGetDB( DB_SLAVE );
-               $dbw =& wfGetDB( DB_MASTER );
-               $querycache = $dbr->tableName( 'querycache' );
+               $dbr = wfGetDB( DB_SLAVE );
 
                $wgOut->setSyndicated( $this->isSyndicated() );
 
-               if ( $this->isExpensive() ) {
-                       // Disabled recache parameter due to retry problems -- TS
-                       if( $wgMiserMode ) {
-                               $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'";
-                               $wgOut->addWikiText( wfMsg( 'perfcached' ) );
+               if ( !$this->isCached() ) {
+                       $sql = $this->getSQL();
+               } else {
+                       # Get the cached result
+                       $querycache = $dbr->tableName( 'querycache' );
+                       $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 ) {
+
+                               # Fetch the timestamp of this update
+                               $tRes = $dbr->select( 'querycache_info', array( 'qci_timestamp' ), array( 'qci_type' => $type ), $fname );
+                               $tRow = $dbr->fetchObject( $tRes );
+
+                               if( $tRow ) {
+                                       $updated = $wgLang->timeAndDate( $tRow->qci_timestamp, true, true );
+                                       $wgOut->addMeta( 'Data-Cache-Time', $tRow->qci_timestamp );
+                                       $wgOut->addInlineScript( "var dataCacheTime = '{$tRow->qci_timestamp}';" );
+                                       $wgOut->addWikiMsg( 'perfcachedts', $updated );
+                               } else {
+                                       $wgOut->addWikiMsg( 'perfcached' );
+                               }
+
+                               # If updates on this page have been disabled, let the user know
+                               # that the data set won't be refreshed for now
+                               global $wgDisableQueryPageUpdate;
+                               if( is_array( $wgDisableQueryPageUpdate ) && in_array( $this->getName(), $wgDisableQueryPageUpdate ) ) {
+                                       $wgOut->addWikiMsg( 'querypage-no-updates' );
+                               }
+
                        }
+
                }
-               
-               $res = $dbr->query( $sql . $this->getOrder() .
-                                   $dbr->limitResult( $limit,$offset ), $fname );
+
+               $sql .= $this->getOrder();
+               $sql = $dbr->limitResult($sql, $limit, $offset);
+               $res = $dbr->query( $sql );
                $num = $dbr->numRows($res);
-               
-               $sk = $wgUser->getSkin( );
 
-               if($shownavigation) {
+               $this->preprocessResults( $dbr, $res );
+
+               $wgOut->addHTML( XML::openElement( 'div', array('class' => 'mw-spcontent') ) );
+
+               # Top header and navigation
+               if( $shownavigation ) {
                        $wgOut->addHTML( $this->getPageHeader() );
-                       $top = wfShowingResults( $offset, $num);
-                       $wgOut->addHTML( "<p>{$top}\n" );
-       
-                       # 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 ) {
+                               $wgOut->addHTML( '<p>' . wfShowingResults( $offset, $num ) . '</p>' );
+                               # Disable the "next" link when we reach the end
+                               $paging = wfViewPrevNext( $offset, $limit, $wgContLang->specialPage( $sname ),
+                                       wfArrayToCGI( $this->linkParameters() ), ( $num < $limit ) );
+                               $wgOut->addHTML( '<p>' . $paging . '</p>' );
+                       } else {
+                               # No results to show, so don't bother with "showing X of Y" etc.
+                               # -- just let the user know and give up now
+                               $wgOut->addHTML( '<p>' . wfMsgHtml( 'specialpage-empty' ) . '</p>' );
+                               $wgOut->addHTML( XML::closeElement( 'div' ) );
+                               return;
+                       }
                }
-               if ( $num > 0 ) {
-                       $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 .= "<li{$attr}>{$format}</li>\n";
+
+               # The actual results; specialist subclasses will want to handle this
+               # with more than a straight list, so we hand them the info, plus
+               # an OutputPage, and let them get on with it
+               $this->outputResults( $wgOut,
+                       $wgUser->getSkin(),
+                       $dbr, # Should use a ResultWrapper for this
+                       $res,
+                       $dbr->numRows( $res ),
+                       $offset );
+
+               # Repeat the paging links at the bottom
+               if( $shownavigation ) {
+                       $wgOut->addHTML( '<p>' . $paging . '</p>' );
+               }
+
+               $wgOut->addHTML( XML::closeElement( 'div' ) );
+
+               return $num;
+       }
+
+       /**
+        * Format and output report results using the given information plus
+        * OutputPage
+        *
+        * @param OutputPage $out OutputPage to print to
+        * @param Skin $skin User skin to use
+        * @param Database $dbr Database (read) connection to use
+        * @param int $res Result pointer
+        * @param int $num Number of available result rows
+        * @param int $offset Paging offset
+        */
+       protected function outputResults( $out, $skin, $dbr, $res, $num, $offset ) {
+               global $wgContLang;
+
+               if( $num > 0 ) {
+                       $html = array();
+                       if( !$this->listoutput )
+                               $html[] = $this->openList( $offset );
+
+                       # $res might contain the whole 1,000 rows, so we read up to
+                       # $num [should update this to use a Pager]
+                       for( $i = 0; $i < $num && $row = $dbr->fetchObject( $res ); $i++ ) {
+                               $line = $this->formatResult( $skin, $row );
+                               if( $line ) {
+                                       $attr = ( isset( $row->usepatrol ) && $row->usepatrol && $row->patrolled == 0 )
+                                               ? ' class="not-patrolled"'
+                                               : '';
+                                       $html[] = $this->listoutput
+                                               ? $line
+                                               : "<li{$attr}>{$line}</li>\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";
+                       # Flush the final result
+                       if( $this->tryLastResult() ) {
+                               $row = null;
+                               $line = $this->formatResult( $skin, $row );
+                               if( $line ) {
+                                       $attr = ( isset( $row->usepatrol ) && $row->usepatrol && $row->patrolled == 0 )
+                                               ? ' class="not-patrolled"'
+                                               : '';
+                                       $html[] = $this->listoutput
+                                               ? $line
+                                               : "<li{$attr}>{$line}</li>\n";
                                }
                        }
-                       
-                       $dbr->freeResult( $res );
-                       $s .= '</ol>';
-                       $wgOut->addHTML( $s );
-               }
-               if($shownavigation) {
-                       $wgOut->addHTML( "<p>{$sl}</p>\n" );
+
+                       if( !$this->listoutput )
+                               $html[] = $this->closeList();
+
+                       $html = $this->listoutput
+                               ? $wgContLang->listToText( $html )
+                               : implode( '', $html );
+
+                       $out->addHTML( $html );
                }
-               return $num;
        }
 
+       function openList( $offset ) {
+               return "\n<ol start='" . ( $offset + 1 ) . "' class='special'>\n";
+       }
+
+       function closeList() {
+               return "</ol>\n";
+       }
+
+       /**
+        * Do any necessary preprocessing of the result object.
+        */
+       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;
+       function doFeed( $class = '', $limit = 50 ) {
+               global $wgFeed, $wgFeedClasses;
+
+               if ( !$wgFeed ) {
+                       global $wgOut;
+                       $wgOut->addWikiMsg( 'feed-unavailable' );
+                       return;
+               }
+               
+               global $wgFeedLimit;
+               if( $limit > $wgFeedLimit ) {
+                       $limit = $wgFeedLimit;
+               }
+
                if( isset($wgFeedClasses[$class]) ) {
                        $feed = new $wgFeedClasses[$class](
                                $this->feedTitle(),
@@ -304,8 +472,9 @@ class QueryPage {
                                $this->feedUrl() );
                        $feed->outHeader();
 
-                       $dbr =& wfGetDB( DB_SLAVE );
-                       $sql = $this->getSQL() . $this->getOrder().$dbr->limitResult( 50, 0 );
+                       $dbr = wfGetDB( DB_SLAVE );
+                       $sql = $this->getSQL() . $this->getOrder();
+                       $sql = $dbr->limitResult( $sql, $limit, 0 );
                        $res = $dbr->query( $sql, 'QueryPage::doFeed' );
                        while( $obj = $dbr->fetchObject( $res ) ) {
                                $item = $this->feedResult( $obj );
@@ -328,14 +497,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();
@@ -355,51 +519,26 @@ class QueryPage {
        }
 
        function feedItemDesc( $row ) {
-               return isset( $row->comment )
-                       ? htmlspecialchars( $row->comment )
-                       : '';
+               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 $wgContLanguageCode, $wgSitename;
                $page = SpecialPage::getPage( $this->getName() );
                $desc = $page->getDescription();
-               return "$wgSitename - $desc [$wgLanguageCode]";
+               return "$wgSitename - $desc [$wgContLanguageCode]";
        }
 
        function feedDesc() {
-               return wfMsg( 'tagline' );
+               return wfMsgExt( 'tagline', 'parsemag' );
        }
 
        function feedUrl() {
-               global $wgLang;
-               $title = Title::MakeTitle( NS_SPECIAL, $this->getName() );
+               $title = SpecialPage::getTitleFor( $this->getName() );
                return $title->getFullURL();
        }
 }
-
-/**
- * This is a subclass for very simple queries that are just looking for page
- * titles that match some criteria. It formats each result item as a link to
- * that page.
- *
- * @package MediaWiki
- */
-class PageQueryPage extends QueryPage {
-
-       function formatResult( $skin, $result ) {
-               global $wgContLang;
-               $nt = Title::makeTitle( $result->namespace, $result->title );
-               return $skin->makeKnownLinkObj( $nt, $wgContLang->convert( $nt->getPrefixedText() ) );
-       }
-}
-
-?>