<?php
-/*
- * Created on Monday, January 28, 2008
+/**
*
- * API for MediaWiki 1.8+
*
- * Copyright (C) 2008 Brent Garber
+ * Created on Monday, January 28, 2008
+ *
+ * Copyright © 2008 Brent Garber
*
* 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
*
* 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.,
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
*/
-if (!defined('MEDIAWIKI')) {
- // Eclipse helper - will be ignored in production
- require_once ('ApiQueryBase.php');
-}
-
/**
* Query module to get list of random pages
*
* @ingroup API
*/
-
- class ApiQueryRandom extends ApiQueryGeneratorBase {
-
- public function __construct($query, $moduleName) {
- parent :: __construct($query, $moduleName, 'rn');
+class ApiQueryRandom extends ApiQueryGeneratorBase {
+ public function __construct( ApiQuery $query, $moduleName ) {
+ parent::__construct( $query, $moduleName, 'rn' );
}
public function execute() {
$this->run();
}
- public function executeGenerator($resultPageSet) {
- $this->run($resultPageSet);
+ public function executeGenerator( $resultPageSet ) {
+ $this->run( $resultPageSet );
}
- protected function prepareQuery($randstr, $limit, $namespace, &$resultPageSet, $redirect) {
+ /**
+ * Actually perform the query and add pages to the result.
+ * @param ApiPageSet|null $resultPageSet
+ * @param int $limit Number of pages to fetch
+ * @param string|null $start Starting page_random
+ * @param int $startId Starting page_id
+ * @param string|null $end Ending page_random
+ * @return array (int, string|null) Number of pages left to query and continuation string
+ */
+ protected function runQuery( $resultPageSet, $limit, $start, $startId, $end ) {
+ $params = $this->extractRequestParams();
+
$this->resetQueryParams();
- $this->addTables('page');
- $this->addOption('LIMIT', $limit);
- $this->addWhereFld('page_namespace', $namespace);
- $this->addWhereRange('page_random', 'newer', $randstr, null);
- $this->addWhereFld('page_is_redirect', $redirect);
- $this->addOption('USE INDEX', 'page_random');
- if(is_null($resultPageSet))
- $this->addFields(array('page_id', 'page_title', 'page_namespace'));
- else
- $this->addFields($resultPageSet->getPageTableFields());
- }
+ $this->addTables( 'page' );
+ $this->addFields( [ 'page_id', 'page_random' ] );
+ if ( is_null( $resultPageSet ) ) {
+ $this->addFields( [ 'page_title', 'page_namespace' ] );
+ } else {
+ $this->addFields( $resultPageSet->getPageTableFields() );
+ }
+ $this->addWhereFld( 'page_namespace', $params['namespace'] );
+ if ( $params['redirect'] || $params['filterredir'] === 'redirects' ) {
+ $this->addWhereFld( 'page_is_redirect', 1 );
+ } elseif ( $params['filterredir'] === 'nonredirects' ) {
+ $this->addWhereFld( 'page_is_redirect', 0 );
+ } elseif ( is_null( $resultPageSet ) ) {
+ $this->addFields( [ 'page_is_redirect' ] );
+ }
+ $this->addOption( 'LIMIT', $limit + 1 );
+
+ if ( $start !== null ) {
+ $start = $this->getDB()->addQuotes( $start );
+ if ( $startId > 0 ) {
+ $startId = (int)$startId; // safety
+ $this->addWhere( "page_random = $start AND page_id >= $startId OR page_random > $start" );
+ } else {
+ $this->addWhere( "page_random >= $start" );
+ }
+ }
+ if ( $end !== null ) {
+ $this->addWhere( 'page_random < ' . $this->getDB()->addQuotes( $end ) );
+ }
+ $this->addOption( 'ORDER BY', [ 'page_random', 'page_id' ] );
- protected function runQuery(&$data, &$resultPageSet) {
- $db = $this->getDB();
- $res = $this->select(__METHOD__);
+ $result = $this->getResult();
+ $path = [ 'query', $this->getModuleName() ];
+
+ $res = $this->select( __METHOD__ );
$count = 0;
- while($row = $db->fetchObject($res)) {
- $count++;
- if(is_null($resultPageSet))
- {
- // Prevent duplicates
- if(!in_array($row->page_id, $this->pageIDs))
- {
- $data[] = $this->extractRowInfo($row);
- $this->pageIDs[] = $row->page_id;
+ foreach ( $res as $row ) {
+ if ( $count++ >= $limit ) {
+ return [ 0, "{$row->page_random}|{$row->page_id}" ];
+ }
+ if ( is_null( $resultPageSet ) ) {
+ $title = Title::makeTitle( $row->page_namespace, $row->page_title );
+ $page = [
+ 'id' => (int)$row->page_id,
+ ];
+ ApiQueryBase::addTitleInfo( $page, $title );
+ if ( isset( $row->page_is_redirect ) ) {
+ $page['redirect'] = (bool)$row->page_is_redirect;
}
+ $fit = $result->addValue( $path, null, $page );
+ if ( !$fit ) {
+ return [ 0, "{$row->page_random}|{$row->page_id}" ];
+ }
+ } else {
+ $resultPageSet->processDbRow( $row );
}
- else
- $resultPageSet->processDbRow($row);
}
- $db->freeResult($res);
- return $count;
+
+ return [ $limit - $count, null ];
}
- public function run($resultPageSet = null) {
+ /**
+ * @param ApiPageSet|null $resultPageSet
+ */
+ public function run( $resultPageSet = null ) {
$params = $this->extractRequestParams();
- $result = $this->getResult();
- $data = array();
- $this->pageIDs = array();
-
- $this->prepareQuery(wfRandom(), $params['limit'], $params['namespace'], $resultPageSet, $params['redirect']);
- $count = $this->runQuery($data, $resultPageSet);
- if($count < $params['limit'])
- {
- /* We got too few pages, we probably picked a high value
- * for page_random. We'll just take the lowest ones, see
- * also the comment in Title::getRandomTitle()
- */
- $this->prepareQuery(0, $params['limit'] - $count, $params['namespace'], $resultPageSet, $params['redirect']);
- $this->runQuery($data, $resultPageSet);
+
+ // Since 'filterredir" will always be set in $params, we have to dig
+ // into the WebRequest to see if it was actually passed.
+ $request = $this->getMain()->getRequest();
+ if ( $request->getCheck( $this->encodeParamName( 'filterredir' ) ) ) {
+ $this->requireMaxOneParameter( $params, 'filterredir', 'redirect' );
}
- if(is_null($resultPageSet)) {
- $result->setIndexedTagName($data, 'page');
- $result->addValue('query', $this->getModuleName(), $data);
+ if ( isset( $params['continue'] ) ) {
+ $cont = explode( '|', $params['continue'] );
+ $this->dieContinueUsageIf( count( $cont ) != 4 );
+ $rand = $cont[0];
+ $start = $cont[1];
+ $startId = (int)$cont[2];
+ $end = $cont[3] ? $rand : null;
+ $this->dieContinueUsageIf( !preg_match( '/^0\.\d+$/', $rand ) );
+ $this->dieContinueUsageIf( !preg_match( '/^0\.\d+$/', $start ) );
+ $this->dieContinueUsageIf( $cont[2] !== (string)$startId );
+ $this->dieContinueUsageIf( $cont[3] !== '0' && $cont[3] !== '1' );
+ } else {
+ $rand = wfRandom();
+ $start = $rand;
+ $startId = 0;
+ $end = null;
}
- }
- private function extractRowInfo($row) {
- $title = Title::makeTitle($row->page_namespace, $row->page_title);
- $vals = array();
- $vals['title'] = $title->getPrefixedText();
- $vals['ns'] = $row->page_namespace;
- $vals['id'] = $row->page_id;
- return $vals;
- }
+ // Set the non-continue if this is being used as a generator
+ // (as a list it doesn't matter because lists never non-continue)
+ if ( $resultPageSet !== null ) {
+ $endFlag = $end === null ? 0 : 1;
+ $this->getContinuationManager()->addGeneratorNonContinueParam(
+ $this, 'continue', "$rand|$start|$startId|$endFlag"
+ );
+ }
- public function getAllowedParams() {
- return array (
- 'namespace' => array(
- ApiBase :: PARAM_TYPE => 'namespace',
- ApiBase :: PARAM_ISMULTI => true
- ),
- 'limit' => array (
- ApiBase :: PARAM_TYPE => 'limit',
- ApiBase :: PARAM_DFLT => 1,
- ApiBase :: PARAM_MIN => 1,
- ApiBase :: PARAM_MAX => 10,
- ApiBase :: PARAM_MAX2 => 20
- ),
- 'redirect' => false,
- );
+ list( $left, $continue ) =
+ $this->runQuery( $resultPageSet, $params['limit'], $start, $startId, $end );
+ if ( $end === null && $continue === null ) {
+ // Wrap around. We do this even if $left === 0 for continuation
+ // (saving a DB query in this rare case probably isn't worth the
+ // added code complexity it would require).
+ $end = $rand;
+ list( $left, $continue ) = $this->runQuery( $resultPageSet, $left, null, null, $end );
+ }
+
+ if ( $continue !== null ) {
+ $endFlag = $end === null ? 0 : 1;
+ $this->setContinueEnumParameter( 'continue', "$rand|$continue|$endFlag" );
+ }
+
+ if ( is_null( $resultPageSet ) ) {
+ $this->getResult()->addIndexedTagName( [ 'query', $this->getModuleName() ], 'page' );
+ }
}
- public function getParamDescription() {
- return array (
- 'namespace' => 'Return pages in these namespaces only',
- 'limit' => 'Limit how many random pages will be returned',
- 'redirect' => 'Load a random redirect instead of a random page'
- );
+ public function getCacheMode( $params ) {
+ return 'public';
}
- public function getDescription() {
- return array( 'Get a set of random pages',
- '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 ',
- ' random page on your list, "List of fictional monkeys" will *always* be second, "List of people on stamps of Vanuatu" third, etc.',
- '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.'
- );
+ public function getAllowedParams() {
+ return [
+ 'namespace' => [
+ ApiBase::PARAM_TYPE => 'namespace',
+ ApiBase::PARAM_ISMULTI => true
+ ],
+ 'filterredir' => [
+ ApiBase::PARAM_TYPE => [ 'all', 'redirects', 'nonredirects' ],
+ ApiBase::PARAM_DFLT => 'nonredirects', // for BC
+ ],
+ 'redirect' => [
+ ApiBase::PARAM_DEPRECATED => true,
+ ApiBase::PARAM_DFLT => false,
+ ],
+ 'limit' => [
+ ApiBase::PARAM_TYPE => 'limit',
+ ApiBase::PARAM_DFLT => 1,
+ ApiBase::PARAM_MIN => 1,
+ ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
+ ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
+ ],
+ 'continue' => [
+ ApiBase::PARAM_HELP_MSG => 'api-help-param-continue'
+ ],
+ ];
}
- protected function getExamples() {
- return 'api.php?action=query&list=random&rnnamespace=0&rnlimit=2';
+ protected function getExamplesMessages() {
+ return [
+ 'action=query&list=random&rnnamespace=0&rnlimit=2'
+ => 'apihelp-query+random-example-simple',
+ 'action=query&generator=random&grnnamespace=0&grnlimit=2&prop=info'
+ => 'apihelp-query+random-example-generator',
+ ];
}
- public function getVersion() {
- return __CLASS__ . ': $Id: ApiQueryRandom.php overlordq$';
+ public function getHelpUrls() {
+ return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Random';
}
}
scripts.mit.edu / autoinstallsdev / mediawiki.git / blobdiff