4 * Created on May 12, 2007
6 * API for MediaWiki 1.8+
8 * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, write to the Free Software Foundation, Inc.,
22 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 * http://www.gnu.org/copyleft/gpl.html
26 if ( !defined( 'MEDIAWIKI' ) ) {
27 // Eclipse helper - will be ignored in production
28 require_once ( "ApiQueryBase.php" );
32 * A query module to list all wiki links on a given set of pages.
36 class ApiQueryLinks extends ApiQueryGeneratorBase {
38 const LINKS = 'links';
39 const TEMPLATES = 'templates';
41 private $table, $prefix, $description;
43 public function __construct( $query, $moduleName ) {
45 switch ( $moduleName ) {
47 $this->table = 'pagelinks';
49 $this->description = 'link';
51 case self::TEMPLATES :
52 $this->table = 'templatelinks';
54 $this->description = 'template';
57 ApiBase :: dieDebug( __METHOD__, 'Unknown module name' );
60 parent :: __construct( $query, $moduleName, $this->prefix );
63 public function execute() {
67 public function getCacheMode( $params ) {
71 public function executeGenerator( $resultPageSet ) {
72 $this->run( $resultPageSet );
75 private function run( $resultPageSet = null ) {
77 if ( $this->getPageSet()->getGoodTitleCount() == 0 )
78 return; // nothing to do
80 $params = $this->extractRequestParams();
82 $this->addFields( array (
83 $this->prefix . '_from AS pl_from',
84 $this->prefix . '_namespace AS pl_namespace',
85 $this->prefix . '_title AS pl_title'
88 $this->addTables( $this->table );
89 $this->addWhereFld( $this->prefix . '_from', array_keys( $this->getPageSet()->getGoodTitles() ) );
90 $this->addWhereFld( $this->prefix . '_namespace', $params['namespace'] );
92 if ( !is_null( $params['continue'] ) ) {
93 $cont = explode( '|', $params['continue'] );
94 if ( count( $cont ) != 3 )
95 $this->dieUsage( "Invalid continue param. You should pass the " .
96 "original value returned by the previous query", "_badcontinue" );
97 $plfrom = intval( $cont[0] );
98 $plns = intval( $cont[1] );
99 $pltitle = $this->getDB()->strencode( $this->titleToKey( $cont[2] ) );
100 $this->addWhere( "{$this->prefix}_from > $plfrom OR " .
101 "({$this->prefix}_from = $plfrom AND " .
102 "({$this->prefix}_namespace > $plns OR " .
103 "({$this->prefix}_namespace = $plns AND " .
104 "{$this->prefix}_title >= '$pltitle')))" );
107 // Here's some MySQL craziness going on: if you use WHERE foo='bar'
108 // and later ORDER BY foo MySQL doesn't notice the ORDER BY is pointless
109 // but instead goes and filesorts, because the index for foo was used
110 // already. To work around this, we drop constant fields in the WHERE
111 // clause from the ORDER BY clause
113 if ( count( $this->getPageSet()->getGoodTitles() ) != 1 )
114 $order[] = "{$this->prefix}_from";
115 if ( count( $params['namespace'] ) != 1 )
116 $order[] = "{$this->prefix}_namespace";
118 $order[] = "{$this->prefix}_title";
119 $this->addOption( 'ORDER BY', implode( ", ", $order ) );
120 $this->addOption( 'USE INDEX', "{$this->prefix}_from" );
121 $this->addOption( 'LIMIT', $params['limit'] + 1 );
123 $db = $this->getDB();
124 $res = $this->select( __METHOD__ );
126 if ( is_null( $resultPageSet ) ) {
128 while ( $row = $db->fetchObject( $res ) ) {
129 if ( ++$count > $params['limit'] ) {
130 // We've reached the one extra which shows that
131 // there are additional pages to be had. Stop here...
132 $this->setContinueEnumParameter( 'continue',
133 "{$row->pl_from}|{$row->pl_namespace}|" .
134 $this->keyToTitle( $row->pl_title ) );
138 ApiQueryBase :: addTitleInfo( $vals, Title :: makeTitle( $row->pl_namespace, $row->pl_title ) );
139 $fit = $this->addPageSubItem( $row->pl_from, $vals );
142 $this->setContinueEnumParameter( 'continue',
143 "{$row->pl_from}|{$row->pl_namespace}|" .
144 $this->keyToTitle( $row->pl_title ) );
151 while ( $row = $db->fetchObject( $res ) ) {
152 if ( ++$count > $params['limit'] ) {
153 // We've reached the one extra which shows that
154 // there are additional pages to be had. Stop here...
155 $this->setContinueEnumParameter( 'continue',
156 "{$row->pl_from}|{$row->pl_namespace}|" .
157 $this->keyToTitle( $row->pl_title ) );
160 $titles[] = Title :: makeTitle( $row->pl_namespace, $row->pl_title );
162 $resultPageSet->populateFromTitles( $titles );
165 $db->freeResult( $res );
168 public function getAllowedParams()
171 'namespace' => array(
172 ApiBase :: PARAM_TYPE => 'namespace',
173 ApiBase :: PARAM_ISMULTI => true
176 ApiBase :: PARAM_DFLT => 10,
177 ApiBase :: PARAM_TYPE => 'limit',
178 ApiBase :: PARAM_MIN => 1,
179 ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1,
180 ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2
186 public function getParamDescription()
189 'namespace' => "Show {$this->description}s in this namespace(s) only",
190 'limit' => "How many {$this->description}s to return",
191 'continue' => 'When more results are available, use this to continue',
195 public function getDescription() {
196 return "Returns all {$this->description}s from the given page(s)";
199 protected function getExamples() {
201 "Get {$this->description}s from the [[Main Page]]:",
202 " api.php?action=query&prop={$this->getModuleName()}&titles=Main%20Page",
203 "Get information about the {$this->description} pages in the [[Main Page]]:",
204 " api.php?action=query&generator={$this->getModuleName()}&titles=Main%20Page&prop=info",
205 "Get {$this->description}s from the Main Page in the User and Template namespaces:",
206 " api.php?action=query&prop={$this->getModuleName()}&titles=Main%20Page&{$this->prefix}namespace=2|10"
210 public function getVersion() {
211 return __CLASS__ . ': $Id: ApiQueryLinks.php 69932 2010-07-26 08:03:21Z tstarling $';