* Fixed unclosed <p> tag
[lhc/web/wiklou.git] / includes / QueryPage.php
index 57d412d..8c6e110 100644 (file)
 <?php
+/**
+ * Contain a class for special pages
+ * @package MediaWiki
+ */
+
+/**
+ *
+ */
+require_once ( 'Feed.php' );
+
+/**
+ * List of query page classes and their associated special pages, for periodic update purposes
+ */
+$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'       ),
+);
+    
+global $wgDisableCounters;
+if( !$wgDisableCounters ) {
+       $wgQueryPages[] = array( 'PopularPagesPage',          'Popularpages'      );
+}
 
-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
-# subclasses derive from it.
-
+/**
+ * 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
+ */
 class QueryPage {
-       # Subclasses return their name here. Make sure the name is also
-       # specified in SpecialPage.php and in Language.php as a language message param.
 
+       /**
+        * Subclasses return their name here. Make sure the name is also
+        * specified in SpecialPage.php and in Language.php as a language message
+        * param.
+        */
        function getName() {
-               return "";
+               return '';
        }
 
-       # 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.
-       #
-       # Don't include an ORDER or LIMIT clause, this will be added.
-
+       /**
+        * 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() {
                return "SELECT 'sample' as type, 0 as namespace, 'Sample result' as title, 42 as value";
        }
 
-       # Override to sort by increasing values
+       /**
+        * 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" : "");
+               return ' ORDER BY value ' .
+                       ($this->sortDescending() ? 'DESC' : '');
        }
 
-       # Is this query expensive (for some definition of expensive)? Then we
-       # don't let it run in miser mode. $wgDisableQueryPages causes all query
-       # pages to be declared expensive. Some query pages are always expensive.
+       /**
+        * Is this query expensive (for some definition of expensive)? Then we
+        * don't let it run in miser mode. $wgDisableQueryPages causes all query
+        * pages to be declared expensive. Some query pages are always expensive.
+        */
        function isExpensive( ) {
                global $wgDisableQueryPages;
                return $wgDisableQueryPages;
        }
 
-       # 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.
+       /**
+        * 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 "";
+               return '';
        }
 
-       # This is the actual workhorse. It does everything needed to make a
-       # real, honest-to-gosh query page.
+       /**
+        * 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( $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
+               $res = $dbr->query( $this->getSQL() . $this->getOrder() . $dbr->limitResult( 1000,0 ), $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;
+       }
 
-       function doQuery( $offset, $limit ) {
-               global $wgUser, $wgOut, $wgLang, $wgRequest;
+       /**
+        * 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, $shownavigation=true ) {
+               global $wgUser, $wgOut, $wgLang, $wgRequest, $wgContLang;
                global $wgMiserMode;
 
                $sname = $this->getName();
-               $fname = get_class($this) . "::doQuery";
+               $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;
+               $wgOut->setSyndicated( $this->isSyndicated() );
 
                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 ) {
+                       // 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'";
-                       }
-                       if( $wgMiserMode ) {
-                               $wgOut->addWikiText( wfMsg( "perfcached" ) );
+                               $wgOut->addWikiText( wfMsg( 'perfcached' ) );
                        }
                }
-               if ( $res === false ) {
-                       $res = $dbr->query( $sql . $this->getOrder() . 
-                                           $dbr->limitResult( $limit,$offset ), $fname );
-                       $num = $dbr->numRows($res);
-               }
-
-
+               
+               $res = $dbr->query( $sql . $this->getOrder() .
+                                   $dbr->limitResult( $limit,$offset ), $fname );
+               $num = $dbr->numRows($res);
+               
                $sk = $wgUser->getSkin( );
 
-               $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 , $wgLang->specialPage( $sname ), "" ,$atend );
-               $wgOut->addHTML( "<br />{$sl}</p>\n" );
+               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 ) {
+                       $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";
+                               }
+                       }
 
-               $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 = ( !is_null ( $obj->usepatrol ) && $obj->usepatrol &&
-                                 $obj->patrolled == 0 ) ? ' class="not_patrolled"' : '';
-                       $s .= "<li{$attr}>{$format}</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";
+                               }
+                       }
+                       
+                       $dbr->freeResult( $res );
+                       $s .= '</ol>';
+                       $wgOut->addHTML( $s );
+               }
+               if($shownavigation) {
+                       $wgOut->addHTML( "<p>{$sl}</p>\n" );
                }
-               $dbr->freeResult( $res );
-               $s .= "</ol>";
-               $wgOut->addHTML( $s );
-               $wgOut->addHTML( "<p>{$sl}</p>\n" );
+               return $num;
        }
 
-       # Similar to above, but packaging in a syndicated feed instead of a web page
-       function doFeed( $class = "" ) {
+       /**
+        * 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]) ) {
@@ -172,7 +305,7 @@ class QueryPage {
 
                        $dbr =& wfGetDB( DB_SLAVE );
                        $sql = $this->getSQL() . $this->getOrder().$dbr->limitResult( 50, 0 );
-                       $res = $dbr->query( $sql, "QueryPage::doFeed" );
+                       $res = $dbr->query( $sql, 'QueryPage::doFeed' );
                        while( $obj = $dbr->fetchObject( $res ) ) {
                                $item = $this->feedResult( $obj );
                                if( $item ) $feed->outItem( $item );
@@ -186,7 +319,10 @@ class QueryPage {
                }
        }
 
-       # Override for custom handling. If the titles/links are ok, just do feedItemDesc()
+       /**
+        * Override for custom handling. If the titles/links are ok, just do
+        * feedItemDesc()
+        */
        function feedResult( $row ) {
                if( !isset( $row->title ) ) {
                        return NULL;
@@ -196,17 +332,17 @@ class QueryPage {
                        if( isset( $row->timestamp ) ) {
                                $date = $row->timestamp;
                        } else {
-                               $date = "";
+                               $date = '';
                        }
 
-                       $comments = "";
+                       $comments = '';
                        if( $title ) {
                                $talkpage = $title->getTalkPage();
                                $comments = $talkpage->getFullURL();
                        }
 
                        return new FeedItem(
-                               $title->getText(),
+                               $title->getPrefixedText(),
                                $this->feedItemDesc( $row ),
                                $title->getFullURL(),
                                $date,
@@ -218,25 +354,16 @@ 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 '';
                }
        }
 
@@ -248,7 +375,7 @@ class QueryPage {
        }
 
        function feedDesc() {
-               return wfMsg( "fromwikipedia" );
+               return wfMsg( 'tagline' );
        }
 
        function feedUrl() {
@@ -258,15 +385,19 @@ class QueryPage {
        }
 }
 
-# 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.
-
+/**
+ * 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, "" );
+               return $skin->makeKnownLinkObj( $nt, $wgContLang->convert( $nt->getPrefixedText() ) );
        }
 }