MediaWiki 1.17.0

[autoinstallsdev/mediawiki.git] / includes / specials / SpecialRandompage.php

diff --git a/includes/specials/SpecialRandompage.php b/includes/specials/SpecialRandompage.php
index f4bff30bfd2d7a7dbb8d456470a0249d5eebfdfd..6299f3841a8e1a5364a5b272fbceabcaa8f9c16e 100644 (file)
--- a/includes/specials/SpecialRandompage.php
+++ b/includes/specials/SpecialRandompage.php
@@ -1,20 +1,40 @@
 <?php
+/**
+ * Implements Special:Randompage
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ * @ingroup SpecialPage
+ * @author Rob Church <robchur@gmail.com>, Ilmari Karonen
+ */
 
 /**
  * Special page to direct the user to a random page
  *
  * @ingroup SpecialPage
- * @author Rob Church <robchur@gmail.com>, Ilmari Karonen
- * @license GNU General Public Licence 2.0 or later
  */
 class RandomPage extends SpecialPage {
        private $namespaces;  // namespaces to select pages from
+       protected $isRedir = false; // should the result be a redirect?
+       protected $extra = array(); // Extra SQL statements
 
-       function __construct( $name = 'Randompage' ){
+       public function __construct( $name = 'Randompage' ){
                global $wgContentNamespaces;
-
                $this->namespaces = $wgContentNamespaces;
-
                parent::__construct( $name );
        }
 
@@ -23,34 +43,54 @@ class RandomPage extends SpecialPage {
        }
 
        public function setNamespace ( $ns ) {
-               if( $ns < NS_MAIN ) $ns = NS_MAIN;
+               if( !$ns || $ns < NS_MAIN ) $ns = NS_MAIN;
                $this->namespaces = array( $ns );
        }
 
        // select redirects instead of normal pages?
-       // Overriden by SpecialRandomredirect
        public function isRedirect(){
-               return false;
+               return $this->isRedir;
        }
 
        public function execute( $par ) {
-               global $wgOut, $wgContLang;
+               global $wgOut, $wgContLang, $wgRequest;
 
-               if ($par)
+               if ($par) {
                        $this->setNamespace( $wgContLang->getNsIndex( $par ) );
+               }
 
                $title = $this->getRandomTitle();
 
                if( is_null( $title ) ) {
                        $this->setHeaders();
-                       $wgOut->addWikiMsg( strtolower( $this->mName ) . '-nopages',  $wgContLang->getNsText( $this->namespace ) );
+                       $wgOut->addWikiMsg( strtolower( $this->mName ) . '-nopages', 
+                               $this->getNsList(), count( $this->namespaces ) );
                        return;
                }
 
-               $query = $this->isRedirect() ? 'redirect=no' : '';
+               $redirectParam = $this->isRedirect() ? array( 'redirect' => 'no' ) : array();
+               $query = array_merge( $wgRequest->getValues(), $redirectParam );
+               unset( $query['title'] );
                $wgOut->redirect( $title->getFullUrl( $query ) );
        }
 
+       /**
+        * Get a comma-delimited list of namespaces we don't have
+        * any pages in
+        * @return String
+        */
+       private function getNsList() {
+               global $wgContLang;
+               $nsNames = array();
+               foreach( $this->namespaces as $n ) {
+                       if( $n === NS_MAIN )
+                               $nsNames[] = wfMsgForContent( 'blanknamespace' );
+                       else
+                               $nsNames[] = $wgContLang->getNsText( $n );
+               }
+               return $wgContLang->commaList( $nsNames );
+       }
+
 
        /**
         * Choose a random title.
@@ -58,6 +98,10 @@ class RandomPage extends SpecialPage {
         */
        public function getRandomTitle() {
                $randstr = wfRandom();
+               $title = null;
+               if ( !wfRunHooks( 'SpecialRandomGetRandomTitle', array( &$randstr, &$this->isRedir, &$this->namespaces, &$this->extra, &$title ) ) ) {
+                       return $title;
+               }
                $row = $this->selectRandomPageFromDB( $randstr );
 
                /* If we picked a value that was higher than any in
@@ -78,8 +122,6 @@ class RandomPage extends SpecialPage {
 
        private function selectRandomPageFromDB( $randstr ) {
                global $wgExtraRandompageSQL;
-               $fname = 'RandomPage::selectRandomPageFromDB';
-
                $dbr = wfGetDB( DB_SLAVE );
 
                $use_index = $dbr->useIndexClause( 'page_random' );
@@ -87,8 +129,17 @@ class RandomPage extends SpecialPage {
 
                $ns = implode( ",", $this->namespaces );
                $redirect = $this->isRedirect() ? 1 : 0;
-
-               $extra = $wgExtraRandompageSQL ? "AND ($wgExtraRandompageSQL)" : "";
+               
+               if ( $wgExtraRandompageSQL ) {
+                       $this->extra[] = $wgExtraRandompageSQL;
+               }
+               if ( $this->addExtraSQL() ) {
+                       $this->extra[] = $this->addExtraSQL();
+               }
+               $extra = '';
+               if ( $this->extra ) {
+                       $extra = 'AND (' . implode( ') AND (', $this->extra ) . ')';
+               }
                $sql = "SELECT page_title, page_namespace
                        FROM $page $use_index
                        WHERE page_namespace IN ( $ns )
@@ -98,7 +149,15 @@ class RandomPage extends SpecialPage {
                        ORDER BY page_random";
 
                $sql = $dbr->limitResult( $sql, 1, 0 );
-               $res = $dbr->query( $sql, $fname );
+               $res = $dbr->query( $sql, __METHOD__ );
                return $dbr->fetchObject( $res );
        }
+
+       /* an alternative to $wgExtraRandompageSQL so subclasses
+        * can add their own SQL by overriding this function
+        * @deprecated, append to $this->extra instead
+        */
+       public function addExtraSQL() {
+               return '';
+       }
 }