f2ab3e7b38
It should be generalized enough to be used in future tables as well. Note that it removes the useIndex when the table is in mapping even if it's read old because useIndex is evil and should not be used like this. Bug: T304780 Change-Id: I0471064b0c33ed596bcea4a79a3fd4aa3fbd19f3
358 lines
10 KiB
PHP
358 lines
10 KiB
PHP
<?php
|
|
/**
|
|
* 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\Linker\LinksMigration;
|
|
use MediaWiki\MediaWikiServices;
|
|
|
|
/**
|
|
* Query module to enumerate links from all pages together.
|
|
*
|
|
* @ingroup API
|
|
*/
|
|
class ApiQueryAllLinks extends ApiQueryGeneratorBase {
|
|
|
|
private $table, $tablePrefix, $indexTag;
|
|
private $fieldTitle = 'title';
|
|
private $dfltNamespace = NS_MAIN;
|
|
private $hasNamespace = true;
|
|
private $useIndex = null;
|
|
private $props = [];
|
|
|
|
/** @var NamespaceInfo */
|
|
private $namespaceInfo;
|
|
|
|
/** @var GenderCache */
|
|
private $genderCache;
|
|
|
|
/** @var LinksMigration */
|
|
private $linksMigration;
|
|
|
|
/**
|
|
* @param ApiQuery $query
|
|
* @param string $moduleName
|
|
* @param NamespaceInfo $namespaceInfo
|
|
* @param GenderCache $genderCache
|
|
*/
|
|
public function __construct(
|
|
ApiQuery $query,
|
|
$moduleName,
|
|
NamespaceInfo $namespaceInfo,
|
|
GenderCache $genderCache
|
|
) {
|
|
switch ( $moduleName ) {
|
|
case 'alllinks':
|
|
$prefix = 'al';
|
|
$this->table = 'pagelinks';
|
|
$this->tablePrefix = 'pl_';
|
|
$this->useIndex = 'pl_namespace';
|
|
$this->indexTag = 'l';
|
|
break;
|
|
case 'alltransclusions':
|
|
$prefix = 'at';
|
|
$this->table = 'templatelinks';
|
|
$this->tablePrefix = 'tl_';
|
|
$this->dfltNamespace = NS_TEMPLATE;
|
|
$this->useIndex = 'tl_namespace';
|
|
$this->indexTag = 't';
|
|
break;
|
|
case 'allfileusages':
|
|
$prefix = 'af';
|
|
$this->table = 'imagelinks';
|
|
$this->tablePrefix = 'il_';
|
|
$this->fieldTitle = 'to';
|
|
$this->dfltNamespace = NS_FILE;
|
|
$this->hasNamespace = false;
|
|
$this->indexTag = 'f';
|
|
break;
|
|
case 'allredirects':
|
|
$prefix = 'ar';
|
|
$this->table = 'redirect';
|
|
$this->tablePrefix = 'rd_';
|
|
$this->indexTag = 'r';
|
|
$this->props = [
|
|
'fragment' => 'rd_fragment',
|
|
'interwiki' => 'rd_interwiki',
|
|
];
|
|
break;
|
|
default:
|
|
ApiBase::dieDebug( __METHOD__, 'Unknown module name' );
|
|
}
|
|
|
|
parent::__construct( $query, $moduleName, $prefix );
|
|
$this->namespaceInfo = $namespaceInfo;
|
|
$this->genderCache = $genderCache;
|
|
}
|
|
|
|
public function execute() {
|
|
$this->run();
|
|
}
|
|
|
|
public function getCacheMode( $params ) {
|
|
return 'public';
|
|
}
|
|
|
|
public function executeGenerator( $resultPageSet ) {
|
|
$this->run( $resultPageSet );
|
|
}
|
|
|
|
/**
|
|
* @param ApiPageSet|null $resultPageSet
|
|
* @return void
|
|
*/
|
|
private function run( $resultPageSet = null ) {
|
|
$db = $this->getDB();
|
|
$params = $this->extractRequestParams();
|
|
$this->linksMigration = MediaWikiServices::getInstance()->getLinksMigration();
|
|
|
|
$pfx = $this->tablePrefix;
|
|
|
|
$nsField = $pfx . 'namespace';
|
|
$titleField = $pfx . $this->fieldTitle;
|
|
if ( isset( $this->linksMigration::$mapping[$this->table] ) ) {
|
|
list( $nsField, $titleField ) = $this->linksMigration->getTitleFields( $this->table );
|
|
$queryInfo = $this->linksMigration->getQueryInfo( $this->table );
|
|
$this->addTables( $queryInfo['tables'] );
|
|
$this->addJoinConds( $queryInfo['joins'] );
|
|
} else {
|
|
if ( $this->useIndex ) {
|
|
$this->addOption( 'USE INDEX', $this->useIndex );
|
|
}
|
|
$this->addTables( $this->table );
|
|
}
|
|
|
|
$prop = array_fill_keys( $params['prop'], true );
|
|
$fld_ids = isset( $prop['ids'] );
|
|
$fld_title = isset( $prop['title'] );
|
|
if ( $this->hasNamespace ) {
|
|
$namespace = $params['namespace'];
|
|
} else {
|
|
$namespace = $this->dfltNamespace;
|
|
}
|
|
|
|
if ( $params['unique'] ) {
|
|
$matches = array_intersect_key( $prop, $this->props + [ 'ids' => 1 ] );
|
|
if ( $matches ) {
|
|
$p = $this->getModulePrefix();
|
|
$this->dieWithError(
|
|
[
|
|
'apierror-invalidparammix-cannotusewith',
|
|
"{$p}prop=" . implode( '|', array_keys( $matches ) ),
|
|
"{$p}unique"
|
|
],
|
|
'invalidparammix'
|
|
);
|
|
}
|
|
$this->addOption( 'DISTINCT' );
|
|
}
|
|
|
|
if ( $this->hasNamespace ) {
|
|
$this->addWhereFld( $nsField, $namespace );
|
|
}
|
|
|
|
$continue = $params['continue'] !== null;
|
|
if ( $continue ) {
|
|
$continueArr = explode( '|', $params['continue'] );
|
|
$op = $params['dir'] == 'descending' ? '<' : '>';
|
|
if ( $params['unique'] ) {
|
|
$this->dieContinueUsageIf( count( $continueArr ) != 1 );
|
|
$continueTitle = $db->addQuotes( $continueArr[0] );
|
|
$this->addWhere( "{$titleField} $op= $continueTitle" );
|
|
} else {
|
|
$this->dieContinueUsageIf( count( $continueArr ) != 2 );
|
|
$continueTitle = $db->addQuotes( $continueArr[0] );
|
|
$continueFrom = (int)$continueArr[1];
|
|
$this->addWhere(
|
|
"{$titleField} $op $continueTitle OR " .
|
|
"({$titleField} = $continueTitle AND " .
|
|
"{$pfx}from $op= $continueFrom)"
|
|
);
|
|
}
|
|
}
|
|
|
|
// 'continue' always overrides 'from'
|
|
$from = $continue || $params['from'] === null ? null :
|
|
$this->titlePartToKey( $params['from'], $namespace );
|
|
$to = $params['to'] === null ? null :
|
|
$this->titlePartToKey( $params['to'], $namespace );
|
|
$this->addWhereRange( $titleField, 'newer', $from, $to );
|
|
|
|
if ( isset( $params['prefix'] ) ) {
|
|
$this->addWhere( $titleField . $db->buildLike( $this->titlePartToKey(
|
|
$params['prefix'], $namespace ), $db->anyString() ) );
|
|
}
|
|
|
|
$this->addFields( [ 'pl_title' => $titleField ] );
|
|
$this->addFieldsIf( [ 'pl_from' => $pfx . 'from' ], !$params['unique'] );
|
|
foreach ( $this->props as $name => $field ) {
|
|
$this->addFieldsIf( $field, isset( $prop[$name] ) );
|
|
}
|
|
|
|
$limit = $params['limit'];
|
|
$this->addOption( 'LIMIT', $limit + 1 );
|
|
|
|
$sort = ( $params['dir'] == 'descending' ? ' DESC' : '' );
|
|
$orderBy = [];
|
|
$orderBy[] = $titleField . $sort;
|
|
if ( !$params['unique'] ) {
|
|
$orderBy[] = $pfx . 'from' . $sort;
|
|
}
|
|
$this->addOption( 'ORDER BY', $orderBy );
|
|
|
|
$res = $this->select( __METHOD__ );
|
|
|
|
// Get gender information
|
|
if ( $res->numRows() && $resultPageSet === null ) {
|
|
if ( $this->namespaceInfo->hasGenderDistinction( $namespace ) ) {
|
|
$users = [];
|
|
foreach ( $res as $row ) {
|
|
$users[] = $row->pl_title;
|
|
}
|
|
if ( $users !== [] ) {
|
|
$this->genderCache->doQuery( $users, __METHOD__ );
|
|
}
|
|
}
|
|
}
|
|
|
|
$pageids = [];
|
|
$titles = [];
|
|
$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...
|
|
if ( $params['unique'] ) {
|
|
$this->setContinueEnumParameter( 'continue', $row->pl_title );
|
|
} else {
|
|
$this->setContinueEnumParameter( 'continue', $row->pl_title . '|' . $row->pl_from );
|
|
}
|
|
break;
|
|
}
|
|
|
|
if ( $resultPageSet === null ) {
|
|
$vals = [
|
|
ApiResult::META_TYPE => 'assoc',
|
|
];
|
|
if ( $fld_ids ) {
|
|
$vals['fromid'] = (int)$row->pl_from;
|
|
}
|
|
if ( $fld_title ) {
|
|
$title = Title::makeTitle( $namespace, $row->pl_title );
|
|
ApiQueryBase::addTitleInfo( $vals, $title );
|
|
}
|
|
foreach ( $this->props as $name => $field ) {
|
|
if ( isset( $prop[$name] ) && $row->$field !== null && $row->$field !== '' ) {
|
|
$vals[$name] = $row->$field;
|
|
}
|
|
}
|
|
$fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $vals );
|
|
if ( !$fit ) {
|
|
if ( $params['unique'] ) {
|
|
$this->setContinueEnumParameter( 'continue', $row->pl_title );
|
|
} else {
|
|
$this->setContinueEnumParameter( 'continue', $row->pl_title . '|' . $row->pl_from );
|
|
}
|
|
break;
|
|
}
|
|
} elseif ( $params['unique'] ) {
|
|
$titles[] = Title::makeTitle( $namespace, $row->pl_title );
|
|
} else {
|
|
$pageids[] = $row->pl_from;
|
|
}
|
|
}
|
|
|
|
if ( $resultPageSet === null ) {
|
|
$result->addIndexedTagName( [ 'query', $this->getModuleName() ], $this->indexTag );
|
|
} elseif ( $params['unique'] ) {
|
|
$resultPageSet->populateFromTitles( $titles );
|
|
} else {
|
|
$resultPageSet->populateFromPageIDs( $pageids );
|
|
}
|
|
}
|
|
|
|
public function getAllowedParams() {
|
|
$allowedParams = [
|
|
'continue' => [
|
|
ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
|
|
],
|
|
'from' => null,
|
|
'to' => null,
|
|
'prefix' => null,
|
|
'unique' => false,
|
|
'prop' => [
|
|
ApiBase::PARAM_ISMULTI => true,
|
|
ApiBase::PARAM_DFLT => 'title',
|
|
ApiBase::PARAM_TYPE => array_merge(
|
|
[ 'ids', 'title' ], array_keys( $this->props )
|
|
),
|
|
ApiBase::PARAM_HELP_MSG_PER_VALUE => [],
|
|
],
|
|
'namespace' => [
|
|
ApiBase::PARAM_DFLT => $this->dfltNamespace,
|
|
ApiBase::PARAM_TYPE => 'namespace',
|
|
ApiBase::PARAM_EXTRA_NAMESPACES => [ NS_MEDIA, NS_SPECIAL ],
|
|
],
|
|
'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'
|
|
]
|
|
],
|
|
];
|
|
if ( !$this->hasNamespace ) {
|
|
unset( $allowedParams['namespace'] );
|
|
}
|
|
|
|
return $allowedParams;
|
|
}
|
|
|
|
protected function getExamplesMessages() {
|
|
$p = $this->getModulePrefix();
|
|
$name = $this->getModuleName();
|
|
$path = $this->getModulePath();
|
|
|
|
return [
|
|
"action=query&list={$name}&{$p}from=B&{$p}prop=ids|title"
|
|
=> "apihelp-$path-example-b",
|
|
"action=query&list={$name}&{$p}unique=&{$p}from=B"
|
|
=> "apihelp-$path-example-unique",
|
|
"action=query&generator={$name}&g{$p}unique=&g{$p}from=B"
|
|
=> "apihelp-$path-example-unique-generator",
|
|
"action=query&generator={$name}&g{$p}from=B"
|
|
=> "apihelp-$path-example-generator",
|
|
];
|
|
}
|
|
|
|
public function getHelpUrls() {
|
|
$name = ucfirst( $this->getModuleName() );
|
|
|
|
return "https://www.mediawiki.org/wiki/Special:MyLanguage/API:{$name}";
|
|
}
|
|
}
|