<?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 $namespace = NS_MAIN; // namespace to select pages from
+ 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 );
}
- public function getNamespace() {
- return $this->namespace;
+ public function getNamespaces() {
+ return $this->namespaces;
}
public function setNamespace ( $ns ) {
- if( $ns < NS_MAIN ) $ns = NS_MAIN;
- $this->namespace = $ns;
+ 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.
*/
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
* any more bias than what the page_random scheme
* causes anyway. Trust me, I'm a mathematician. :)
*/
- if( !$row )
+ if( !$row ) {
$row = $this->selectRandomPageFromDB( "0" );
+ }
- if( $row )
- return Title::makeTitleSafe( $this->namespace, $row->page_title );
- else
+ if( $row ) {
+ return Title::makeTitleSafe( $row->page_namespace, $row->page_title );
+ } else {
return null;
+ }
}
- private function selectRandomPageFromDB( $randstr ) {
+ protected function getQueryInfo( $randstr ) {
global $wgExtraRandompageSQL;
- $fname = 'RandomPage::selectRandomPageFromDB';
+ $redirect = $this->isRedirect() ? 1 : 0;
- $dbr = wfGetDB( DB_SLAVE );
+ if ( $wgExtraRandompageSQL ) {
+ $this->extra[] = $wgExtraRandompageSQL;
+ }
+ if ( $this->addExtraSQL() ) {
+ $this->extra[] = $this->addExtraSQL();
+ }
- $use_index = $dbr->useIndexClause( 'page_random' );
- $page = $dbr->tableName( 'page' );
+ return array(
+ 'tables' => array( 'page' ),
+ 'fields' => array( 'page_title', 'page_namespace' ),
+ 'conds' => array_merge( array(
+ 'page_namespace' => $this->namespaces,
+ 'page_is_redirect' => $redirect,
+ 'page_random >= ' . $randstr
+ ), $this->extra ),
+ 'options' => array(
+ 'ORDER BY' => 'page_random',
+ 'USE INDEX' => 'page_random',
+ 'LIMIT' => 1,
+ ),
+ 'join_conds' => array()
+ );
+ }
- $ns = (int) $this->namespace;
- $redirect = $this->isRedirect() ? 1 : 0;
+ private function selectRandomPageFromDB( $randstr, $fname = __METHOD__ ) {
+ $dbr = wfGetDB( DB_SLAVE );
+
+ $query = $this->getQueryInfo( $randstr );
+ $res = $dbr->select(
+ $query['tables'],
+ $query['fields'],
+ $query['conds'],
+ $fname,
+ $query['options'],
+ $query['join_conds']
+ );
- $extra = $wgExtraRandompageSQL ? "AND ($wgExtraRandompageSQL)" : "";
- $sql = "SELECT page_title
- FROM $page $use_index
- WHERE page_namespace = $ns
- AND page_is_redirect = $redirect
- AND page_random >= $randstr
- $extra
- ORDER BY page_random";
-
- $sql = $dbr->limitResult( $sql, 1, 0 );
- $res = $dbr->query( $sql, $fname );
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 '';
+ }
}