4 * Created on Monday, January 28, 2008
6 * API for MediaWiki 1.8+
8 * Copyright © 2008 Brent Garber
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, write to the Free Software Foundation, Inc.,
22 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 * http://www.gnu.org/copyleft/gpl.html
26 if ( !defined( 'MEDIAWIKI' ) ) {
27 // Eclipse helper - will be ignored in production
28 require_once( 'ApiQueryBase.php' );
32 * Query module to get list of random pages
37 class ApiQueryRandom
extends ApiQueryGeneratorBase
{
39 public function __construct( $query, $moduleName ) {
40 parent
::__construct( $query, $moduleName, 'rn' );
43 public function execute() {
47 public function executeGenerator( $resultPageSet ) {
48 $this->run( $resultPageSet );
51 protected function prepareQuery( $randstr, $limit, $namespace, &$resultPageSet, $redirect ) {
52 $this->resetQueryParams();
53 $this->addTables( 'page' );
54 $this->addOption( 'LIMIT', $limit );
55 $this->addWhereFld( 'page_namespace', $namespace );
56 $this->addWhereRange( 'page_random', 'newer', $randstr, null );
57 $this->addWhereFld( 'page_is_redirect', $redirect );
58 $this->addOption( 'USE INDEX', 'page_random' );
59 if ( is_null( $resultPageSet ) ) {
60 $this->addFields( array( 'page_id', 'page_title', 'page_namespace' ) );
62 $this->addFields( $resultPageSet->getPageTableFields() );
66 protected function runQuery( &$resultPageSet ) {
68 $res = $this->select( __METHOD__
);
70 while ( $row = $db->fetchObject( $res ) ) {
72 if ( is_null( $resultPageSet ) ) {
74 if ( !in_array( $row->page_id
, $this->pageIDs
) ) {
75 $fit = $this->getResult()->addValue(
76 array( 'query', $this->getModuleName() ),
77 null, $this->extractRowInfo( $row ) );
79 // We can't really query-continue a random list.
80 // Return an insanely high value so
81 // $count < $limit is false
84 $this->pageIDs
[] = $row->page_id
;
87 $resultPageSet->processDbRow( $row );
94 public function run( $resultPageSet = null ) {
95 $params = $this->extractRequestParams();
96 $result = $this->getResult();
97 $this->pageIDs
= array();
99 $this->prepareQuery( wfRandom(), $params['limit'], $params['namespace'], $resultPageSet, $params['redirect'] );
100 $count = $this->runQuery( $resultPageSet );
101 if ( $count < $params['limit'] ) {
102 /* We got too few pages, we probably picked a high value
103 * for page_random. We'll just take the lowest ones, see
104 * also the comment in Title::getRandomTitle()
106 $this->prepareQuery( 0, $params['limit'] - $count, $params['namespace'], $resultPageSet, $params['redirect'] );
107 $this->runQuery( $resultPageSet );
110 if ( is_null( $resultPageSet ) ) {
111 $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'page' );
115 private function extractRowInfo( $row ) {
116 $title = Title
::makeTitle( $row->page_namespace
, $row->page_title
);
118 $vals['id'] = intval( $row->page_id
);
119 ApiQueryBase
::addTitleInfo( $vals, $title );
123 public function getAllowedParams() {
125 'namespace' => array(
126 ApiBase
::PARAM_TYPE
=> 'namespace',
127 ApiBase
::PARAM_ISMULTI
=> true
130 ApiBase
::PARAM_TYPE
=> 'limit',
131 ApiBase
::PARAM_DFLT
=> 1,
132 ApiBase
::PARAM_MIN
=> 1,
133 ApiBase
::PARAM_MAX
=> 10,
134 ApiBase
::PARAM_MAX2
=> 20
140 public function getParamDescription() {
142 'namespace' => 'Return pages in these namespaces only',
143 'limit' => 'Limit how many random pages will be returned',
144 'redirect' => 'Load a random redirect instead of a random page'
148 public function getDescription() {
150 'Get a set of random pages',
151 'NOTE: Pages are listed in a fixed sequence, only the starting point is random. This means that if, for example, "Main Page" is the first ',
152 ' random page on your list, "List of fictional monkeys" will *always* be second, "List of people on stamps of Vanuatu" third, etc',
153 'NOTE: If the number of pages in the namespace is lower than rnlimit, you will get fewer pages. You will not get the same page twice'
157 protected function getExamples() {
158 return 'api.php?action=query&list=random&rnnamespace=0&rnlimit=2';
161 public function getVersion() {
162 return __CLASS__
. ': $Id: ApiQueryRandom.php overlordq$';