<?php
/**
- * API for MediaWiki 1.8+
+ *
*
* Created on July 7, 2007
*
- * Copyright © 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
+ * 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
* @file
*/
-if ( !defined( 'MEDIAWIKI' ) ) {
- // Eclipse helper - will be ignored in production
- require_once( 'ApiQueryBase.php' );
-}
-
/**
* Query module to enumerate links from all pages together.
*
*/
class ApiQueryAllLinks extends ApiQueryGeneratorBase {
- public function __construct( $query, $moduleName ) {
- parent::__construct( $query, $moduleName, 'al' );
+ private $table, $tablePrefix, $indexTag;
+ private $fieldTitle = 'title';
+ private $dfltNamespace = NS_MAIN;
+ private $hasNamespace = true;
+ private $useIndex = null;
+ private $props = [];
+
+ public function __construct( ApiQuery $query, $moduleName ) {
+ 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 );
}
public function execute() {
$this->run( $resultPageSet );
}
+ /**
+ * @param ApiPageSet $resultPageSet
+ * @return void
+ */
private function run( $resultPageSet = null ) {
$db = $this->getDB();
$params = $this->extractRequestParams();
+ $pfx = $this->tablePrefix;
+ $fieldTitle = $this->fieldTitle;
$prop = array_flip( $params['prop'] );
$fld_ids = isset( $prop['ids'] );
$fld_title = isset( $prop['title'] );
+ if ( $this->hasNamespace ) {
+ $namespace = $params['namespace'];
+ } else {
+ $namespace = $this->dfltNamespace;
+ }
if ( $params['unique'] ) {
- if ( !is_null( $resultPageSet ) ) {
- $this->dieUsage( $this->getModuleName() . ' cannot be used as a generator in unique links mode', 'params' );
- }
- if ( $fld_ids ) {
- $this->dieUsage( $this->getModuleName() . ' cannot return corresponding page ids in unique links mode', 'params' );
+ $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' );
}
- $this->addTables( 'pagelinks' );
- $this->addWhereFld( 'pl_namespace', $params['namespace'] );
-
- if ( !is_null( $params['from'] ) && !is_null( $params['continue'] ) ) {
- $this->dieUsage( 'alcontinue and alfrom cannot be used together', 'params' );
+ $this->addTables( $this->table );
+ if ( $this->hasNamespace ) {
+ $this->addWhereFld( $pfx . 'namespace', $namespace );
}
- if ( !is_null( $params['continue'] ) ) {
- $arr = explode( '|', $params['continue'] );
- if ( count( $arr ) != 2 ) {
- $this->dieUsage( 'Invalid continue parameter', 'badcontinue' );
+
+ $continue = !is_null( $params['continue'] );
+ 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( "{$pfx}{$fieldTitle} $op= $continueTitle" );
+ } else {
+ $this->dieContinueUsageIf( count( $continueArr ) != 2 );
+ $continueTitle = $db->addQuotes( $continueArr[0] );
+ $continueFrom = intval( $continueArr[1] );
+ $this->addWhere(
+ "{$pfx}{$fieldTitle} $op $continueTitle OR " .
+ "({$pfx}{$fieldTitle} = $continueTitle AND " .
+ "{$pfx}from $op= $continueFrom)"
+ );
}
- $from = $this->getDB()->strencode( $this->titleToKey( $arr[0] ) );
- $id = intval( $arr[1] );
- $this->addWhere(
- "pl_title > '$from' OR " .
- "(pl_title = '$from' AND " .
- "pl_from > $id)"
- );
}
- if ( !is_null( $params['from'] ) ) {
- $this->addWhere( 'pl_title>=' . $db->addQuotes( $this->titlePartToKey( $params['from'] ) ) );
- }
- if ( !is_null( $params['to'] ) ) {
- $this->addWhere( 'pl_title<=' . $db->addQuotes( $this->titlePartToKey( $params['to'] ) ) );
- }
+ // '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( $pfx . $fieldTitle, 'newer', $from, $to );
+
if ( isset( $params['prefix'] ) ) {
- $this->addWhere( 'pl_title' . $db->buildLike( $this->titlePartToKey( $params['prefix'] ), $db->anyString() ) );
+ $this->addWhere( $pfx . $fieldTitle . $db->buildLike( $this->titlePartToKey(
+ $params['prefix'], $namespace ), $db->anyString() ) );
}
- $this->addFields( array(
- 'pl_title',
- ) );
- $this->addFieldsIf( 'pl_from', !$params['unique'] );
+ $this->addFields( [ 'pl_title' => $pfx . $fieldTitle ] );
+ $this->addFieldsIf( [ 'pl_from' => $pfx . 'from' ], !$params['unique'] );
+ foreach ( $this->props as $name => $field ) {
+ $this->addFieldsIf( $field, isset( $prop[$name] ) );
+ }
- $this->addOption( 'USE INDEX', 'pl_namespace' );
+ if ( $this->useIndex ) {
+ $this->addOption( 'USE INDEX', $this->useIndex );
+ }
$limit = $params['limit'];
$this->addOption( 'LIMIT', $limit + 1 );
- if ( $params['unique'] ) {
- $this->addOption( 'ORDER BY', 'pl_title' );
- } else {
- $this->addOption( 'ORDER BY', 'pl_title, pl_from' );
+
+ $sort = ( $params['dir'] == 'descending' ? ' DESC' : '' );
+ $orderBy = [];
+ $orderBy[] = $pfx . $fieldTitle . $sort;
+ if ( !$params['unique'] ) {
+ $orderBy[] = $pfx . 'from' . $sort;
}
+ $this->addOption( 'ORDER BY', $orderBy );
$res = $this->select( __METHOD__ );
- $pageids = array();
+ $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...
- // TODO: Security issue - if the user has no right to view next title, it will still be shown
+ 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( 'from', $this->keyToTitle( $row->pl_title ) );
+ $this->setContinueEnumParameter( 'continue', $row->pl_title );
} else {
- $this->setContinueEnumParameter( 'continue', $this->keyToTitle( $row->pl_title ) . "|" . $row->pl_from );
+ $this->setContinueEnumParameter( 'continue', $row->pl_title . '|' . $row->pl_from );
}
break;
}
if ( is_null( $resultPageSet ) ) {
- $vals = array();
+ $vals = [
+ ApiResult::META_TYPE => 'assoc',
+ ];
if ( $fld_ids ) {
$vals['fromid'] = intval( $row->pl_from );
}
if ( $fld_title ) {
- $title = Title::makeTitle( $params['namespace'], $row->pl_title );
+ $title = Title::makeTitle( $namespace, $row->pl_title );
ApiQueryBase::addTitleInfo( $vals, $title );
}
- $fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $vals );
+ 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( 'from', $this->keyToTitle( $row->pl_title ) );
+ $this->setContinueEnumParameter( 'continue', $row->pl_title );
} else {
- $this->setContinueEnumParameter( 'continue', $this->keyToTitle( $row->pl_title ) . "|" . $row->pl_from );
+ $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 ( is_null( $resultPageSet ) ) {
- $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'l' );
+ $result->addIndexedTagName( [ 'query', $this->getModuleName() ], $this->indexTag );
+ } elseif ( $params['unique'] ) {
+ $resultPageSet->populateFromTitles( $titles );
} else {
$resultPageSet->populateFromPageIDs( $pageids );
}
}
public function getAllowedParams() {
- return array(
- 'continue' => null,
+ $allowedParams = [
+ 'continue' => [
+ ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
+ ],
'from' => null,
'to' => null,
'prefix' => null,
'unique' => false,
- 'prop' => array(
+ 'prop' => [
ApiBase::PARAM_ISMULTI => true,
ApiBase::PARAM_DFLT => 'title',
- ApiBase::PARAM_TYPE => array(
- 'ids',
- 'title'
- )
- ),
- 'namespace' => array(
- ApiBase::PARAM_DFLT => 0,
- ApiBase::PARAM_TYPE => 'namespace'
- ),
- 'limit' => array(
+ 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'] );
+ }
- public function getParamDescription() {
- $p = $this->getModulePrefix();
- return array(
- 'from' => 'The page title to start enumerating from',
- 'to' => 'The page title to stop enumerating at',
- 'prefix' => 'Search for all page titles that begin with this value',
- 'unique' => "Only show unique links. Cannot be used with generator or {$p}prop=ids",
- 'prop' => array(
- 'What pieces of information to include',
- " ids - Adds pageid of where the link is from (Cannot be used with {$p}unique)",
- ' title - Adds the title of the link',
- ),
- 'namespace' => 'The namespace to enumerate',
- 'limit' => 'How many total links to return',
- 'continue' => 'When more results are available, use this to continue',
- );
+ return $allowedParams;
}
- public function getDescription() {
- return 'Enumerate all links that point to a given namespace';
- }
+ protected function getExamplesMessages() {
+ $p = $this->getModulePrefix();
+ $name = $this->getModuleName();
+ $path = $this->getModulePath();
- public function getPossibleErrors() {
- $m = $this->getModuleName();
- return array_merge( parent::getPossibleErrors(), array(
- array( 'code' => 'params', 'info' => "{$m} cannot be used as a generator in unique links mode" ),
- array( 'code' => 'params', 'info' => "{$m} cannot return corresponding page ids in unique links mode" ),
- array( 'code' => 'params', 'info' => 'alcontinue and alfrom cannot be used together' ),
- array( 'code' => 'badcontinue', 'info' => 'Invalid continue parameter' ),
- ) );
+ 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",
+ ];
}
- protected function getExamples() {
- return array(
- 'api.php?action=query&list=alllinks&alunique=&alfrom=B',
- );
- }
+ public function getHelpUrls() {
+ $name = ucfirst( $this->getModuleName() );
- public function getVersion() {
- return __CLASS__ . ': $Id$';
+ return "https://www.mediawiki.org/wiki/Special:MyLanguage/API:{$name}";
}
}
scripts.mit.edu / autoinstallsdev / mediawiki.git / blobdiff