MediaWiki REL1_32
ApiQueryLinks.php
Go to the documentation of this file.
1<?php
29
30 const LINKS = 'links';
31 const TEMPLATES = 'templates';
32
34
35 public function __construct( ApiQuery $query, $moduleName ) {
36 switch ( $moduleName ) {
37 case self::LINKS:
38 $this->table = 'pagelinks';
39 $this->prefix = 'pl';
40 $this->titlesParam = 'titles';
41 $this->helpUrl = 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Links';
42 break;
43 case self::TEMPLATES:
44 $this->table = 'templatelinks';
45 $this->prefix = 'tl';
46 $this->titlesParam = 'templates';
47 $this->helpUrl = 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Templates';
48 break;
49 default:
50 ApiBase::dieDebug( __METHOD__, 'Unknown module name' );
51 }
52
53 parent::__construct( $query, $moduleName, $this->prefix );
54 }
55
56 public function execute() {
57 $this->run();
58 }
59
60 public function getCacheMode( $params ) {
61 return 'public';
62 }
63
64 public function executeGenerator( $resultPageSet ) {
65 $this->run( $resultPageSet );
66 }
67
71 private function run( $resultPageSet = null ) {
72 if ( $this->getPageSet()->getGoodTitleCount() == 0 ) {
73 return; // nothing to do
74 }
75
77
78 $this->addFields( [
79 'pl_from' => $this->prefix . '_from',
80 'pl_namespace' => $this->prefix . '_namespace',
81 'pl_title' => $this->prefix . '_title'
82 ] );
83
84 $this->addTables( $this->table );
85 $this->addWhereFld( $this->prefix . '_from', array_keys( $this->getPageSet()->getGoodTitles() ) );
86
87 $multiNS = true;
88 $multiTitle = true;
89 if ( $params[$this->titlesParam] ) {
90 // Filter the titles in PHP so our ORDER BY bug avoidance below works right.
91 $filterNS = $params['namespace'] ? array_flip( $params['namespace'] ) : false;
92
93 $lb = new LinkBatch;
94 foreach ( $params[$this->titlesParam] as $t ) {
95 $title = Title::newFromText( $t );
96 if ( !$title ) {
97 $this->addWarning( [ 'apiwarn-invalidtitle', wfEscapeWikiText( $t ) ] );
98 } elseif ( !$filterNS || isset( $filterNS[$title->getNamespace()] ) ) {
99 $lb->addObj( $title );
100 }
101 }
102 $cond = $lb->constructSet( $this->prefix, $this->getDB() );
103 if ( $cond ) {
104 $this->addWhere( $cond );
105 $multiNS = count( $lb->data ) !== 1;
106 $multiTitle = count( array_merge( ...$lb->data ) ) !== 1;
107 } else {
108 // No titles so no results
109 return;
110 }
111 } elseif ( $params['namespace'] ) {
112 $this->addWhereFld( $this->prefix . '_namespace', $params['namespace'] );
113 $multiNS = $params['namespace'] === null || count( $params['namespace'] ) !== 1;
114 }
115
116 if ( !is_null( $params['continue'] ) ) {
117 $cont = explode( '|', $params['continue'] );
118 $this->dieContinueUsageIf( count( $cont ) != 3 );
119 $op = $params['dir'] == 'descending' ? '<' : '>';
120 $plfrom = intval( $cont[0] );
121 $plns = intval( $cont[1] );
122 $pltitle = $this->getDB()->addQuotes( $cont[2] );
123 $this->addWhere(
124 "{$this->prefix}_from $op $plfrom OR " .
125 "({$this->prefix}_from = $plfrom AND " .
126 "({$this->prefix}_namespace $op $plns OR " .
127 "({$this->prefix}_namespace = $plns AND " .
128 "{$this->prefix}_title $op= $pltitle)))"
129 );
130 }
131
132 $sort = ( $params['dir'] == 'descending' ? ' DESC' : '' );
133 // Here's some MySQL craziness going on: if you use WHERE foo='bar'
134 // and later ORDER BY foo MySQL doesn't notice the ORDER BY is pointless
135 // but instead goes and filesorts, because the index for foo was used
136 // already. To work around this, we drop constant fields in the WHERE
137 // clause from the ORDER BY clause
138 $order = [];
139 if ( count( $this->getPageSet()->getGoodTitles() ) != 1 ) {
140 $order[] = $this->prefix . '_from' . $sort;
141 }
142 if ( $multiNS ) {
143 $order[] = $this->prefix . '_namespace' . $sort;
144 }
145 if ( $multiTitle ) {
146 $order[] = $this->prefix . '_title' . $sort;
147 }
148 if ( $order ) {
149 $this->addOption( 'ORDER BY', $order );
150 }
151 $this->addOption( 'LIMIT', $params['limit'] + 1 );
152
153 $res = $this->select( __METHOD__ );
154
155 if ( is_null( $resultPageSet ) ) {
156 $count = 0;
157 foreach ( $res as $row ) {
158 if ( ++$count > $params['limit'] ) {
159 // We've reached the one extra which shows that
160 // there are additional pages to be had. Stop here...
161 $this->setContinueEnumParameter( 'continue',
162 "{$row->pl_from}|{$row->pl_namespace}|{$row->pl_title}" );
163 break;
164 }
165 $vals = [];
166 ApiQueryBase::addTitleInfo( $vals, Title::makeTitle( $row->pl_namespace, $row->pl_title ) );
167 $fit = $this->addPageSubItem( $row->pl_from, $vals );
168 if ( !$fit ) {
169 $this->setContinueEnumParameter( 'continue',
170 "{$row->pl_from}|{$row->pl_namespace}|{$row->pl_title}" );
171 break;
172 }
173 }
174 } else {
175 $titles = [];
176 $count = 0;
177 foreach ( $res as $row ) {
178 if ( ++$count > $params['limit'] ) {
179 // We've reached the one extra which shows that
180 // there are additional pages to be had. Stop here...
181 $this->setContinueEnumParameter( 'continue',
182 "{$row->pl_from}|{$row->pl_namespace}|{$row->pl_title}" );
183 break;
184 }
185 $titles[] = Title::makeTitle( $row->pl_namespace, $row->pl_title );
186 }
187 $resultPageSet->populateFromTitles( $titles );
188 }
189 }
190
191 public function getAllowedParams() {
192 return [
193 'namespace' => [
194 ApiBase::PARAM_TYPE => 'namespace',
197 ],
198 'limit' => [
200 ApiBase::PARAM_TYPE => 'limit',
204 ],
205 'continue' => [
206 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
207 ],
208 $this->titlesParam => [
210 ],
211 'dir' => [
212 ApiBase::PARAM_DFLT => 'ascending',
214 'ascending',
215 'descending'
216 ]
217 ],
218 ];
219 }
220
221 protected function getExamplesMessages() {
222 $name = $this->getModuleName();
223 $path = $this->getModulePath();
224
225 return [
226 "action=query&prop={$name}&titles=Main%20Page"
227 => "apihelp-{$path}-example-simple",
228 "action=query&generator={$name}&titles=Main%20Page&prop=info"
229 => "apihelp-{$path}-example-generator",
230 "action=query&prop={$name}&titles=Main%20Page&{$this->prefix}namespace=2|10"
231 => "apihelp-{$path}-example-namespaces",
232 ];
233 }
234
235 public function getHelpUrls() {
236 return $this->helpUrl;
237 }
238}
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
const PARAM_MAX2
(integer) Max value allowed for the parameter for users with the apihighlimits right,...
Definition ApiBase.php:96
const PARAM_MAX
(integer) Max value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition ApiBase.php:90
dieContinueUsageIf( $condition)
Die with the 'badcontinue' error.
Definition ApiBase.php:2155
static dieDebug( $method, $message)
Internal code errors should be reported with this method.
Definition ApiBase.php:2167
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
Definition ApiBase.php:87
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition ApiBase.php:48
const PARAM_MIN
(integer) Lowest value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition ApiBase.php:99
const LIMIT_BIG1
Fast query, standard limit.
Definition ApiBase.php:252
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition ApiBase.php:770
getModulePath()
Get the path to this module.
Definition ApiBase.php:603
const PARAM_EXTRA_NAMESPACES
(int[]) When PARAM_TYPE is 'namespace', include these as additional possible values.
Definition ApiBase.php:186
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition ApiBase.php:124
addWarning( $msg, $code=null, $data=null)
Add a warning for this module.
Definition ApiBase.php:1906
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition ApiBase.php:254
getModuleName()
Get the name of the module being executed by this instance.
Definition ApiBase.php:539
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition ApiBase.php:51
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
addFields( $value)
Add a set of fields to select to the internal array.
addPageSubItem( $pageId, $item, $elemname=null)
Same as addPageSubItems(), but one element of $data at a time.
addOption( $name, $value=null)
Add an option such as LIMIT or USE INDEX.
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
getDB()
Get the Query database connection (read-only)
addWhereFld( $field, $value)
Equivalent to addWhere(array($field => $value))
addWhere( $value)
Add a set of WHERE clauses to the internal array.
setContinueEnumParameter( $paramName, $paramValue)
Overridden to set the generator param if in generator mode.
getPageSet()
Get the PageSet object to work on.
This is the main query class.
Definition ApiQuery.php:36
Class representing a list of titles The execute() method checks them all for existence and adds them ...
Definition LinkBatch.php:34
We use the convention $dbr for read and $dbw for write to help you keep track of whether the database object is a the world will explode Or to be a subsequent write query which succeeded on the master may fail when replicated to the slave due to a unique key collision Replication on the slave will stop and it may take hours to repair the database and get it back online Setting read_only in my cnf on the slave will avoid this but given the dire we prefer to have as many checks as possible We provide a but the wrapper functions like select() and insert() are usually more convenient. They take care of things like table prefixes and escaping for you. If you really need to make your own SQL
$res
Definition database.txt:21
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global then executing the whole list after the page is displayed We don t do anything smart like collating updates to the same table or such because the list is almost always going to have just one item on if so it s not worth the trouble Since there is a job queue in the jobs table
Definition deferred.txt:16
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
const NS_SPECIAL
Definition Defines.php:53
const NS_MEDIA
Definition Defines.php:52
namespace and then decline to actually register it file or subcat img or subcat $title
Definition hooks.txt:994
Allows to change the fields on the form that will be generated $name
Definition hooks.txt:302
null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition hooks.txt:1656
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition injection.txt:37
linkcache txt The LinkCache class maintains a list of article titles and the information about whether or not the article exists in the database This is used to mark up links when displaying a page If the same link appears more than once on any page then it only has to be looked up once In most cases link lookups are done in batches with the LinkBatch class or the equivalent in so the link cache is mostly useful for short snippets of parsed and for links in the navigation areas of the skin The link cache was formerly used to track links used in a document for the purposes of updating the link tables This application is now deprecated To create a you can use the following $titles
Definition linkcache.txt:17
$sort
$params