\t^*$ between the comment and params for consistant formatting
[lhc/web/wiklou.git] / includes / QueryPage.php
index ce602fe..37b4816 100644 (file)
@@ -1,38 +1,54 @@
 <?php
-
+/**
+ * Contain a class for special pages
+ * @package MediaWiki
+ */
+
+/**
+ *
+ */
 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 '';
        }
 
-       # 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.
-
+       /**
+        * 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;
        }
@@ -42,33 +58,59 @@ class QueryPage {
                        ($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 '';
        }
-               
-       # The content returned by this function will be output before any result
-       
+
+       /**
+        * The content returned by this function will be output before any result
+       */
        function getPageHeader( ) {
                return '';
        }
+       
+       /**
+        * 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;
+       }
 
-       # This is the actual workhorse. It does everything needed to make a
-       # real, honest-to-gosh query page.
-
+       /**
+        * 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
+        */
        function doQuery( $offset, $limit ) {
-               global $wgUser, $wgOut, $wgLang, $wgRequest;
+               global $wgUser, $wgOut, $wgLang, $wgRequest, $wgContLang;
                global $wgMiserMode;
 
                $sname = $this->getName();
@@ -78,7 +120,7 @@ class QueryPage {
                $dbw =& wfGetDB( DB_MASTER );
                $querycache = $dbr->tableName( 'querycache' );
 
-               $wgOut->setSyndicated( true );
+               $wgOut->setSyndicated( $this->isSyndicated() );
                $res = false;
 
                if ( $this->isExpensive() ) {
@@ -130,14 +172,14 @@ class QueryPage {
                        }
                }
                if ( $res === false ) {
-                       $res = $dbr->query( $sql . $this->getOrder() . 
+                       $res = $dbr->query( $sql . $this->getOrder() .
                                            $dbr->limitResult( $limit,$offset ), $fname );
                        $num = $dbr->numRows($res);
                }
 
 
                $sk = $wgUser->getSkin( );
-               
+
                $wgOut->addHTML( $this->getPageHeader() );
 
                $top = wfShowingResults( $offset, $num);
@@ -146,24 +188,43 @@ class QueryPage {
                # 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 );
+               $sl = wfViewPrevNext( $offset, $limit , $wgContLang->specialPage( $sname ), "" ,$atend );
                $wgOut->addHTML( "<br />{$sl}</p>\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";
+               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";
+                               }
+                       }
+
+                       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 );
                }
-               $dbr->freeResult( $res );
-               $s .= '</ol>';
-               $wgOut->addHTML( $s );
                $wgOut->addHTML( "<p>{$sl}</p>\n" );
        }
 
-       # Similar to above, but packaging in a syndicated feed instead of a web page
+       /**
+        * Similar to above, but packaging in a syndicated feed instead of a web page
+        */
        function doFeed( $class = '' ) {
                global $wgFeedClasses;
                global $wgOut, $wgLanguageCode, $wgLang;
@@ -190,7 +251,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;
@@ -210,7 +274,7 @@ class QueryPage {
                        }
 
                        return new FeedItem(
-                               $title->getText(),
+                               $title->getPrefixedText(),
                                $this->feedItemDesc( $row ),
                                $title->getFullURL(),
                                $date,
@@ -222,18 +286,9 @@ 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 ) {
@@ -252,7 +307,7 @@ class QueryPage {
        }
 
        function feedDesc() {
-               return wfMsg( 'fromwikipedia' );
+               return wfMsg( 'tagline' );
        }
 
        function feedUrl() {
@@ -262,15 +317,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( $result->title ) );
        }
 }