036b9c4167
Links generated by the API are now aware of the user's preferred language and will show documents in that language if available. To test, log in to mediawiki.org and set your language preference to 'es', then on an MediaWiki installation with this patch view the generated expanded API help at `api.php?action=help&recursivesubmodules=1&modules=main`. Each link to documentation on mediawiki.org should take you to its translated /es subpage, if one exists. Bug: T104518 Change-Id: I339a1f3ae1bce9d759cf251899d57c32b1def91e
360 lines
10 KiB
PHP
360 lines
10 KiB
PHP
<?php
|
|
/**
|
|
*
|
|
*
|
|
* Created on Sep 25, 2006
|
|
*
|
|
* Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
|
|
*
|
|
* 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
|
|
*/
|
|
use MediaWiki\MediaWikiServices;
|
|
|
|
/**
|
|
* Query module to enumerate all available pages.
|
|
*
|
|
* @ingroup API
|
|
*/
|
|
class ApiQueryAllPages extends ApiQueryGeneratorBase {
|
|
|
|
public function __construct( ApiQuery $query, $moduleName ) {
|
|
parent::__construct( $query, $moduleName, 'ap' );
|
|
}
|
|
|
|
public function execute() {
|
|
$this->run();
|
|
}
|
|
|
|
public function getCacheMode( $params ) {
|
|
return 'public';
|
|
}
|
|
|
|
/**
|
|
* @param ApiPageSet $resultPageSet
|
|
* @return void
|
|
*/
|
|
public function executeGenerator( $resultPageSet ) {
|
|
if ( $resultPageSet->isResolvingRedirects() ) {
|
|
$this->dieWithError( 'apierror-allpages-generator-redirects', 'params' );
|
|
}
|
|
|
|
$this->run( $resultPageSet );
|
|
}
|
|
|
|
/**
|
|
* @param ApiPageSet $resultPageSet
|
|
* @return void
|
|
*/
|
|
private function run( $resultPageSet = null ) {
|
|
$db = $this->getDB();
|
|
|
|
$params = $this->extractRequestParams();
|
|
|
|
// Page filters
|
|
$this->addTables( 'page' );
|
|
|
|
if ( !is_null( $params['continue'] ) ) {
|
|
$cont = explode( '|', $params['continue'] );
|
|
$this->dieContinueUsageIf( count( $cont ) != 1 );
|
|
$op = $params['dir'] == 'descending' ? '<' : '>';
|
|
$cont_from = $db->addQuotes( $cont[0] );
|
|
$this->addWhere( "page_title $op= $cont_from" );
|
|
}
|
|
|
|
$miserMode = $this->getConfig()->get( 'MiserMode' );
|
|
if ( !$miserMode ) {
|
|
if ( $params['filterredir'] == 'redirects' ) {
|
|
$this->addWhereFld( 'page_is_redirect', 1 );
|
|
} elseif ( $params['filterredir'] == 'nonredirects' ) {
|
|
$this->addWhereFld( 'page_is_redirect', 0 );
|
|
}
|
|
}
|
|
|
|
$this->addWhereFld( 'page_namespace', $params['namespace'] );
|
|
$dir = ( $params['dir'] == 'descending' ? 'older' : 'newer' );
|
|
$from = ( $params['from'] === null
|
|
? null
|
|
: $this->titlePartToKey( $params['from'], $params['namespace'] ) );
|
|
$to = ( $params['to'] === null
|
|
? null
|
|
: $this->titlePartToKey( $params['to'], $params['namespace'] ) );
|
|
$this->addWhereRange( 'page_title', $dir, $from, $to );
|
|
|
|
if ( isset( $params['prefix'] ) ) {
|
|
$this->addWhere( 'page_title' . $db->buildLike(
|
|
$this->titlePartToKey( $params['prefix'], $params['namespace'] ),
|
|
$db->anyString() ) );
|
|
}
|
|
|
|
if ( is_null( $resultPageSet ) ) {
|
|
$selectFields = [
|
|
'page_namespace',
|
|
'page_title',
|
|
'page_id'
|
|
];
|
|
} else {
|
|
$selectFields = $resultPageSet->getPageTableFields();
|
|
}
|
|
|
|
$miserModeFilterRedirValue = null;
|
|
$miserModeFilterRedir = $miserMode && $params['filterredir'] !== 'all';
|
|
if ( $miserModeFilterRedir ) {
|
|
$selectFields[] = 'page_is_redirect';
|
|
|
|
if ( $params['filterredir'] == 'redirects' ) {
|
|
$miserModeFilterRedirValue = 1;
|
|
} elseif ( $params['filterredir'] == 'nonredirects' ) {
|
|
$miserModeFilterRedirValue = 0;
|
|
}
|
|
}
|
|
|
|
$this->addFields( $selectFields );
|
|
$forceNameTitleIndex = true;
|
|
if ( isset( $params['minsize'] ) ) {
|
|
$this->addWhere( 'page_len>=' . intval( $params['minsize'] ) );
|
|
$forceNameTitleIndex = false;
|
|
}
|
|
|
|
if ( isset( $params['maxsize'] ) ) {
|
|
$this->addWhere( 'page_len<=' . intval( $params['maxsize'] ) );
|
|
$forceNameTitleIndex = false;
|
|
}
|
|
|
|
// Page protection filtering
|
|
if ( count( $params['prtype'] ) || $params['prexpiry'] != 'all' ) {
|
|
$this->addTables( 'page_restrictions' );
|
|
$this->addWhere( 'page_id=pr_page' );
|
|
$this->addWhere( "pr_expiry > {$db->addQuotes( $db->timestamp() )} OR pr_expiry IS NULL" );
|
|
|
|
if ( count( $params['prtype'] ) ) {
|
|
$this->addWhereFld( 'pr_type', $params['prtype'] );
|
|
|
|
if ( isset( $params['prlevel'] ) ) {
|
|
// Remove the empty string and '*' from the prlevel array
|
|
$prlevel = array_diff( $params['prlevel'], [ '', '*' ] );
|
|
|
|
if ( count( $prlevel ) ) {
|
|
$this->addWhereFld( 'pr_level', $prlevel );
|
|
}
|
|
}
|
|
if ( $params['prfiltercascade'] == 'cascading' ) {
|
|
$this->addWhereFld( 'pr_cascade', 1 );
|
|
} elseif ( $params['prfiltercascade'] == 'noncascading' ) {
|
|
$this->addWhereFld( 'pr_cascade', 0 );
|
|
}
|
|
}
|
|
$forceNameTitleIndex = false;
|
|
|
|
if ( $params['prexpiry'] == 'indefinite' ) {
|
|
$this->addWhere( "pr_expiry = {$db->addQuotes( $db->getInfinity() )} OR pr_expiry IS NULL" );
|
|
} elseif ( $params['prexpiry'] == 'definite' ) {
|
|
$this->addWhere( "pr_expiry != {$db->addQuotes( $db->getInfinity() )}" );
|
|
}
|
|
|
|
$this->addOption( 'DISTINCT' );
|
|
} elseif ( isset( $params['prlevel'] ) ) {
|
|
$this->dieWithError(
|
|
[ 'apierror-invalidparammix-mustusewith', 'prlevel', 'prtype' ], 'invalidparammix'
|
|
);
|
|
}
|
|
|
|
if ( $params['filterlanglinks'] == 'withoutlanglinks' ) {
|
|
$this->addTables( 'langlinks' );
|
|
$this->addJoinConds( [ 'langlinks' => [ 'LEFT JOIN', 'page_id=ll_from' ] ] );
|
|
$this->addWhere( 'll_from IS NULL' );
|
|
$forceNameTitleIndex = false;
|
|
} elseif ( $params['filterlanglinks'] == 'withlanglinks' ) {
|
|
$this->addTables( 'langlinks' );
|
|
$this->addWhere( 'page_id=ll_from' );
|
|
$this->addOption( 'STRAIGHT_JOIN' );
|
|
|
|
// MySQL filesorts if we use a GROUP BY that works with the rules
|
|
// in the 1992 SQL standard (it doesn't like having the
|
|
// constant-in-WHERE page_namespace column in there). Using the
|
|
// 1999 rules works fine, but that breaks other DBs. Sigh.
|
|
/// @todo Once we drop support for 1992-rule DBs, we can simplify this.
|
|
$dbType = $db->getType();
|
|
if ( $dbType === 'mysql' || $dbType === 'sqlite' ) {
|
|
// Ignore the rules, or 1999 rules if you count unique keys
|
|
// over non-NULL columns as satisfying the requirement for
|
|
// "functional dependency" and don't require including
|
|
// constant-in-WHERE columns in the GROUP BY.
|
|
$this->addOption( 'GROUP BY', [ 'page_title' ] );
|
|
} elseif ( $dbType === 'postgres' && $db->getServerVersion() >= 9.1 ) {
|
|
// 1999 rules only counting primary keys
|
|
$this->addOption( 'GROUP BY', [ 'page_title', 'page_id' ] );
|
|
} else {
|
|
// 1992 rules
|
|
$this->addOption( 'GROUP BY', $selectFields );
|
|
}
|
|
|
|
$forceNameTitleIndex = false;
|
|
}
|
|
|
|
if ( $forceNameTitleIndex ) {
|
|
$this->addOption( 'USE INDEX', 'name_title' );
|
|
}
|
|
|
|
$limit = $params['limit'];
|
|
$this->addOption( 'LIMIT', $limit + 1 );
|
|
$res = $this->select( __METHOD__ );
|
|
|
|
// Get gender information
|
|
if ( MWNamespace::hasGenderDistinction( $params['namespace'] ) ) {
|
|
$users = [];
|
|
foreach ( $res as $row ) {
|
|
$users[] = $row->page_title;
|
|
}
|
|
MediaWikiServices::getInstance()->getGenderCache()->doQuery( $users, __METHOD__ );
|
|
$res->rewind(); // reset
|
|
}
|
|
|
|
$count = 0;
|
|
$result = $this->getResult();
|
|
foreach ( $res as $row ) {
|
|
if ( ++$count > $limit ) {
|
|
// We've reached the one extra which shows that there are
|
|
// additional pages to be had. Stop here...
|
|
$this->setContinueEnumParameter( 'continue', $row->page_title );
|
|
break;
|
|
}
|
|
|
|
if ( $miserModeFilterRedir && (int)$row->page_is_redirect !== $miserModeFilterRedirValue ) {
|
|
// Filter implemented in PHP due to being in Miser Mode
|
|
continue;
|
|
}
|
|
|
|
if ( is_null( $resultPageSet ) ) {
|
|
$title = Title::makeTitle( $row->page_namespace, $row->page_title );
|
|
$vals = [
|
|
'pageid' => intval( $row->page_id ),
|
|
'ns' => intval( $title->getNamespace() ),
|
|
'title' => $title->getPrefixedText()
|
|
];
|
|
$fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $vals );
|
|
if ( !$fit ) {
|
|
$this->setContinueEnumParameter( 'continue', $row->page_title );
|
|
break;
|
|
}
|
|
} else {
|
|
$resultPageSet->processDbRow( $row );
|
|
}
|
|
}
|
|
|
|
if ( is_null( $resultPageSet ) ) {
|
|
$result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'p' );
|
|
}
|
|
}
|
|
|
|
public function getAllowedParams() {
|
|
$ret = [
|
|
'from' => null,
|
|
'continue' => [
|
|
ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
|
|
],
|
|
'to' => null,
|
|
'prefix' => null,
|
|
'namespace' => [
|
|
ApiBase::PARAM_DFLT => NS_MAIN,
|
|
ApiBase::PARAM_TYPE => 'namespace',
|
|
],
|
|
'filterredir' => [
|
|
ApiBase::PARAM_DFLT => 'all',
|
|
ApiBase::PARAM_TYPE => [
|
|
'all',
|
|
'redirects',
|
|
'nonredirects'
|
|
]
|
|
],
|
|
'minsize' => [
|
|
ApiBase::PARAM_TYPE => 'integer',
|
|
],
|
|
'maxsize' => [
|
|
ApiBase::PARAM_TYPE => 'integer',
|
|
],
|
|
'prtype' => [
|
|
ApiBase::PARAM_TYPE => Title::getFilteredRestrictionTypes( true ),
|
|
ApiBase::PARAM_ISMULTI => true
|
|
],
|
|
'prlevel' => [
|
|
ApiBase::PARAM_TYPE => $this->getConfig()->get( 'RestrictionLevels' ),
|
|
ApiBase::PARAM_ISMULTI => true
|
|
],
|
|
'prfiltercascade' => [
|
|
ApiBase::PARAM_DFLT => 'all',
|
|
ApiBase::PARAM_TYPE => [
|
|
'cascading',
|
|
'noncascading',
|
|
'all'
|
|
],
|
|
],
|
|
'limit' => [
|
|
ApiBase::PARAM_DFLT => 10,
|
|
ApiBase::PARAM_TYPE => 'limit',
|
|
ApiBase::PARAM_MIN => 1,
|
|
ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
|
|
ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
|
|
],
|
|
'dir' => [
|
|
ApiBase::PARAM_DFLT => 'ascending',
|
|
ApiBase::PARAM_TYPE => [
|
|
'ascending',
|
|
'descending'
|
|
]
|
|
],
|
|
'filterlanglinks' => [
|
|
ApiBase::PARAM_TYPE => [
|
|
'withlanglinks',
|
|
'withoutlanglinks',
|
|
'all'
|
|
],
|
|
ApiBase::PARAM_DFLT => 'all'
|
|
],
|
|
'prexpiry' => [
|
|
ApiBase::PARAM_TYPE => [
|
|
'indefinite',
|
|
'definite',
|
|
'all'
|
|
],
|
|
ApiBase::PARAM_DFLT => 'all'
|
|
],
|
|
];
|
|
|
|
if ( $this->getConfig()->get( 'MiserMode' ) ) {
|
|
$ret['filterredir'][ApiBase::PARAM_HELP_MSG_APPEND] = [ 'api-help-param-limited-in-miser-mode' ];
|
|
}
|
|
|
|
return $ret;
|
|
}
|
|
|
|
protected function getExamplesMessages() {
|
|
return [
|
|
'action=query&list=allpages&apfrom=B'
|
|
=> 'apihelp-query+allpages-example-B',
|
|
'action=query&generator=allpages&gaplimit=4&gapfrom=T&prop=info'
|
|
=> 'apihelp-query+allpages-example-generator',
|
|
'action=query&generator=allpages&gaplimit=2&' .
|
|
'gapfilterredir=nonredirects&gapfrom=Re&prop=revisions&rvprop=content'
|
|
=> 'apihelp-query+allpages-example-generator-revisions',
|
|
];
|
|
}
|
|
|
|
public function getHelpUrls() {
|
|
return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Allpages';
|
|
}
|
|
}
|