3 * API module to return redirects to a page
5 * Created on Dec 30, 2013
7 * Copyright © 2013 Brad Jorsch <bjorsch@wikimedia.org>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 * http://www.gnu.org/copyleft/gpl.html
29 * This query lists redirects to the given pages.
33 class ApiQueryRedirects
extends ApiQueryGeneratorBase
{
35 public function __construct( $query, $moduleName ) {
36 parent
::__construct( $query, $moduleName, 'rd' );
39 public function execute() {
43 public function executeGenerator( $resultPageSet ) {
44 $this->run( $resultPageSet );
48 * @param $resultPageSet ApiPageSet
50 private function run( ApiPageSet
$resultPageSet = null ) {
52 $params = $this->extractRequestParams();
53 $emptyString = $db->addQuotes( '' );
55 $pageSet = $this->getPageSet();
56 $titles = $pageSet->getGoodTitles() +
$pageSet->getMissingTitles();
58 if ( !is_null( $params['continue'] ) ) {
59 $cont = explode( '|', $params['continue'] );
60 $this->dieContinueUsageIf( count( $cont ) != 3 );
61 $rd_namespace = (int)$cont[0];
62 $this->dieContinueUsageIf( $rd_namespace != $cont[0] );
63 $rd_title = $db->addQuotes( $cont[1] );
64 $rd_from = (int)$cont[2];
65 $this->dieContinueUsageIf( $rd_from != $cont[2] );
67 "rd_namespace > $rd_namespace OR " .
68 "(rd_namespace = $rd_namespace AND " .
69 "(rd_title > $rd_title OR " .
70 "(rd_title = $rd_title AND " .
71 "rd_from >= $rd_from)))"
74 // Remove titles that we're past already
75 $titles = array_filter( $titles, function ( $t ) use ( $rd_namespace, $rd_title ) {
76 $ns = $t->getNamespace();
77 return ( $ns > $rd_namespace ||
78 $ns == $rd_namespace && $t->getDBKey() >= $rd_title
84 return; // nothing to do
87 $this->addTables( array( 'redirect', 'page' ) );
88 $this->addFields( array(
94 if ( is_null( $resultPageSet ) ) {
95 $prop = array_flip( $params['prop'] );
96 $fld_pageid = isset( $prop['pageid'] );
97 $fld_title = isset( $prop['title'] );
98 $fld_fragment = isset( $prop['fragment'] );
100 $this->addFieldsIf( 'rd_fragment', $fld_fragment );
101 $this->addFieldsIf( array( 'page_namespace', 'page_title' ), $fld_title );
103 $this->addFields( array( 'page_namespace', 'page_title' ) );
106 $lb = new LinkBatch( $titles );
107 $this->addWhere( array(
109 "rd_interwiki = $emptyString OR rd_interwiki IS NULL",
110 $lb->constructSet( 'rd', $db ),
113 if ( $params['show'] !== null ) {
114 $show = array_flip( $params['show'] );
115 if ( isset( $show['fragment'] ) && isset( $show['!fragment'] ) ) {
116 $this->dieUsageMsg( 'show' );
118 $this->addWhereIf( "rd_fragment != $emptyString", isset( $show['fragment'] ) );
119 $this->addWhereIf( "rd_fragment = $emptyString OR rd_fragment IS NULL", isset( $show['!fragment'] ) );
122 $map = $pageSet->getAllTitlesByNamespace();
124 // Why, MySQL? Why do you do this to us?
126 if ( count( $map ) > 1 ) {
127 $sortby[] = 'rd_namespace';
130 foreach ( $map as $nsTitles ) {
132 $key = key( $nsTitles );
133 if ( $theTitle === null ) {
136 if ( count( $nsTitles ) > 1 ||
$key !== $theTitle ) {
137 $sortby[] = 'rd_title';
141 $sortby[] = 'rd_from';
142 $this->addOption( 'ORDER BY', $sortby );
144 $this->addOption( 'LIMIT', $params['limit'] +
1 );
146 $res = $this->select( __METHOD__
);
148 if ( is_null( $resultPageSet ) ) {
150 foreach ( $res as $row ) {
151 if ( ++
$count > $params['limit'] ) {
152 // We've reached the one extra which shows that
153 // there are additional pages to be had. Stop here...
154 $this->setContinueEnumParameter( 'continue',
155 "$row->rd_namespace|$row->rd_title|$row->rd_from"
160 # Get the ID of the current page
161 $id = $map[$row->rd_namespace
][$row->rd_title
];
165 $vals['pageid'] = $row->rd_from
;
168 ApiQueryBase
::addTitleInfo( $vals,
169 Title
::makeTitle( $row->page_namespace
, $row->page_title
)
172 if ( $fld_fragment && $row->rd_fragment
!== null && $row->rd_fragment
!== '' ) {
173 $vals['fragment'] = $row->rd_fragment
;
175 $fit = $this->addPageSubItem( $id, $vals );
177 $this->setContinueEnumParameter( 'continue',
178 "$row->rd_namespace|$row->rd_title|$row->rd_from"
186 foreach ( $res as $row ) {
187 if ( ++
$count > $params['limit'] ) {
188 // We've reached the one extra which shows that
189 // there are additional pages to be had. Stop here...
190 $this->setContinueEnumParameter( 'continue',
191 "$row->rd_namespace|$row->rd_title|$row->rd_from"
195 $titles[] = Title
::makeTitle( $row->page_namespace
, $row->page_title
);
197 $resultPageSet->populateFromTitles( $titles );
201 public function getCacheMode( $params ) {
205 public function getAllowedParams() {
208 ApiBase
::PARAM_TYPE
=> array(
213 ApiBase
::PARAM_ISMULTI
=> true,
214 ApiBase
::PARAM_DFLT
=> 'pageid|title',
217 ApiBase
::PARAM_TYPE
=> array(
218 'fragment', '!fragment',
220 ApiBase
::PARAM_ISMULTI
=> true,
223 ApiBase
::PARAM_DFLT
=> 10,
224 ApiBase
::PARAM_TYPE
=> 'limit',
225 ApiBase
::PARAM_MIN
=> 1,
226 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
227 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
233 public function getParamDescription() {
236 'Which properties to get:',
237 ' pageid - Page id of each redirect',
238 ' title - Title of each redirect',
239 ' fragment - Fragment of each redirect, if any',
242 'Show only items that meet this criteria.',
243 ' fragment - Only show redirects with a fragment',
244 ' !fragment - Only show redirects without a fragment',
246 'limit' => 'How many redirects to return',
247 'continue' => 'When more results are available, use this to continue',
251 public function getDescription() {
252 return 'Returns all redirects to the given page(s).';
255 public function getExamples() {
257 'api.php?action=query&prop=redirects&titles=Main%20Page'
258 => 'Get a list of redirects to the [[Main Page]]',
259 'api.php?action=query&generator=redirects&titles=Main%20Page&prop=info'
260 => 'Get information about all redirects to the [[Main Page]]',
264 public function getHelpUrls() {
265 return 'https://www.mediawiki.org/wiki/API:Properties#redirects_.2F_rd';