MediaWiki  1.23.2
ApiQueryAllLinks.php
Go to the documentation of this file.
1 <?php
33 
36  private $fieldTitle = 'title';
38  private $hasNamespace = true;
39  private $useIndex = null;
40  private $props = array(), $propHelp = array();
41 
42  public function __construct( $query, $moduleName ) {
43  switch ( $moduleName ) {
44  case 'alllinks':
45  $prefix = 'al';
46  $this->table = 'pagelinks';
47  $this->tablePrefix = 'pl_';
48  $this->useIndex = 'pl_namespace';
49  $this->indexTag = 'l';
50  $this->description = 'Enumerate all links that point to a given namespace';
51  $this->descriptionWhat = 'link';
52  $this->descriptionTargets = 'linked titles';
53  $this->descriptionLinking = 'linking';
54  break;
55  case 'alltransclusions':
56  $prefix = 'at';
57  $this->table = 'templatelinks';
58  $this->tablePrefix = 'tl_';
59  $this->dfltNamespace = NS_TEMPLATE;
60  $this->useIndex = 'tl_namespace';
61  $this->indexTag = 't';
62  $this->description =
63  'List all transclusions (pages embedded using {{x}}), including non-existing';
64  $this->descriptionWhat = 'transclusion';
65  $this->descriptionTargets = 'transcluded titles';
66  $this->descriptionLinking = 'transcluding';
67  break;
68  case 'allfileusages':
69  $prefix = 'af';
70  $this->table = 'imagelinks';
71  $this->tablePrefix = 'il_';
72  $this->fieldTitle = 'to';
73  $this->dfltNamespace = NS_FILE;
74  $this->hasNamespace = false;
75  $this->indexTag = 'f';
76  $this->description = 'List all file usages, including non-existing';
77  $this->descriptionWhat = 'file';
78  $this->descriptionTargets = 'file titles';
79  $this->descriptionLinking = 'using';
80  break;
81  case 'allredirects':
82  $prefix = 'ar';
83  $this->table = 'redirect';
84  $this->tablePrefix = 'rd_';
85  $this->indexTag = 'r';
86  $this->description = 'List all redirects to a namespace';
87  $this->descriptionWhat = 'redirect';
88  $this->descriptionTargets = 'target pages';
89  $this->descriptionLinking = 'redirecting';
90  $this->props = array(
91  'fragment' => 'rd_fragment',
92  'interwiki' => 'rd_interwiki',
93  );
94  $this->propHelp = array(
95  ' fragment - Adds the fragment from the redirect, if any',
96  ' interwiki - Adds the interwiki prefix from the redirect, if any',
97  );
98  break;
99  default:
100  ApiBase::dieDebug( __METHOD__, 'Unknown module name' );
101  }
102 
103  parent::__construct( $query, $moduleName, $prefix );
104  }
105 
106  public function execute() {
107  $this->run();
108  }
109 
110  public function getCacheMode( $params ) {
111  return 'public';
112  }
113 
114  public function executeGenerator( $resultPageSet ) {
115  $this->run( $resultPageSet );
116  }
117 
122  private function run( $resultPageSet = null ) {
123  $db = $this->getDB();
124  $params = $this->extractRequestParams();
125 
126  $pfx = $this->tablePrefix;
128  $prop = array_flip( $params['prop'] );
129  $fld_ids = isset( $prop['ids'] );
130  $fld_title = isset( $prop['title'] );
131  if ( $this->hasNamespace ) {
132  $namespace = $params['namespace'];
133  } else {
134  $namespace = $this->dfltNamespace;
135  }
136 
137  if ( $params['unique'] ) {
138  $matches = array_intersect_key( $prop, $this->props + array( 'ids' => 1 ) );
139  if ( $matches ) {
140  $p = $this->getModulePrefix();
141  $this->dieUsage(
142  "Cannot use {$p}prop=" . join( '|', array_keys( $matches ) ) . " with {$p}unique",
143  'params'
144  );
145  }
146  $this->addOption( 'DISTINCT' );
147  }
148 
149  $this->addTables( $this->table );
150  if ( $this->hasNamespace ) {
151  $this->addWhereFld( $pfx . 'namespace', $namespace );
152  }
153 
154  $continue = !is_null( $params['continue'] );
155  if ( $continue ) {
156  $continueArr = explode( '|', $params['continue'] );
157  $op = $params['dir'] == 'descending' ? '<' : '>';
158  if ( $params['unique'] ) {
159  $this->dieContinueUsageIf( count( $continueArr ) != 1 );
160  $continueTitle = $db->addQuotes( $continueArr[0] );
161  $this->addWhere( "{$pfx}{$fieldTitle} $op= $continueTitle" );
162  } else {
163  $this->dieContinueUsageIf( count( $continueArr ) != 2 );
164  $continueTitle = $db->addQuotes( $continueArr[0] );
165  $continueFrom = intval( $continueArr[1] );
166  $this->addWhere(
167  "{$pfx}{$fieldTitle} $op $continueTitle OR " .
168  "({$pfx}{$fieldTitle} = $continueTitle AND " .
169  "{$pfx}from $op= $continueFrom)"
170  );
171  }
172  }
173 
174  // 'continue' always overrides 'from'
175  $from = ( $continue || $params['from'] === null ? null :
176  $this->titlePartToKey( $params['from'], $namespace ) );
177  $to = ( $params['to'] === null ? null :
178  $this->titlePartToKey( $params['to'], $namespace ) );
179  $this->addWhereRange( $pfx . $fieldTitle, 'newer', $from, $to );
180 
181  if ( isset( $params['prefix'] ) ) {
182  $this->addWhere( $pfx . $fieldTitle . $db->buildLike( $this->titlePartToKey(
183  $params['prefix'], $namespace ), $db->anyString() ) );
184  }
185 
186  $this->addFields( array( 'pl_title' => $pfx . $fieldTitle ) );
187  $this->addFieldsIf( array( 'pl_from' => $pfx . 'from' ), !$params['unique'] );
188  foreach ( $this->props as $name => $field ) {
189  $this->addFieldsIf( $field, isset( $prop[$name] ) );
190  }
191 
192  if ( $this->useIndex ) {
193  $this->addOption( 'USE INDEX', $this->useIndex );
194  }
195  $limit = $params['limit'];
196  $this->addOption( 'LIMIT', $limit + 1 );
197 
198  $sort = ( $params['dir'] == 'descending' ? ' DESC' : '' );
199  $orderBy = array();
200  $orderBy[] = $pfx . $fieldTitle . $sort;
201  if ( !$params['unique'] ) {
202  $orderBy[] = $pfx . 'from' . $sort;
203  }
204  $this->addOption( 'ORDER BY', $orderBy );
205 
206  $res = $this->select( __METHOD__ );
207 
208  $pageids = array();
209  $titles = array();
210  $count = 0;
211  $result = $this->getResult();
212  foreach ( $res as $row ) {
213  if ( ++$count > $limit ) {
214  // We've reached the one extra which shows that there are
215  // additional pages to be had. Stop here...
216  if ( $params['unique'] ) {
217  $this->setContinueEnumParameter( 'continue', $row->pl_title );
218  } else {
219  $this->setContinueEnumParameter( 'continue', $row->pl_title . '|' . $row->pl_from );
220  }
221  break;
222  }
223 
224  if ( is_null( $resultPageSet ) ) {
225  $vals = array();
226  if ( $fld_ids ) {
227  $vals['fromid'] = intval( $row->pl_from );
228  }
229  if ( $fld_title ) {
230  $title = Title::makeTitle( $namespace, $row->pl_title );
232  }
233  foreach ( $this->props as $name => $field ) {
234  if ( isset( $prop[$name] ) && $row->$field !== null && $row->$field !== '' ) {
235  $vals[$name] = $row->$field;
236  }
237  }
238  $fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $vals );
239  if ( !$fit ) {
240  if ( $params['unique'] ) {
241  $this->setContinueEnumParameter( 'continue', $row->pl_title );
242  } else {
243  $this->setContinueEnumParameter( 'continue', $row->pl_title . '|' . $row->pl_from );
244  }
245  break;
246  }
247  } elseif ( $params['unique'] ) {
248  $titles[] = Title::makeTitle( $namespace, $row->pl_title );
249  } else {
250  $pageids[] = $row->pl_from;
251  }
252  }
253 
254  if ( is_null( $resultPageSet ) ) {
255  $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), $this->indexTag );
256  } elseif ( $params['unique'] ) {
257  $resultPageSet->populateFromTitles( $titles );
258  } else {
259  $resultPageSet->populateFromPageIDs( $pageids );
260  }
261  }
262 
263  public function getAllowedParams() {
264  $allowedParams = array(
265  'continue' => null,
266  'from' => null,
267  'to' => null,
268  'prefix' => null,
269  'unique' => false,
270  'prop' => array(
271  ApiBase::PARAM_ISMULTI => true,
272  ApiBase::PARAM_DFLT => 'title',
273  ApiBase::PARAM_TYPE => array_merge(
274  array( 'ids', 'title' ), array_keys( $this->props )
275  ),
276  ),
277  'namespace' => array(
278  ApiBase::PARAM_DFLT => $this->dfltNamespace,
279  ApiBase::PARAM_TYPE => 'namespace'
280  ),
281  'limit' => array(
282  ApiBase::PARAM_DFLT => 10,
283  ApiBase::PARAM_TYPE => 'limit',
284  ApiBase::PARAM_MIN => 1,
287  ),
288  'dir' => array(
289  ApiBase::PARAM_DFLT => 'ascending',
291  'ascending',
292  'descending'
293  )
294  ),
295  );
296  if ( !$this->hasNamespace ) {
297  unset( $allowedParams['namespace'] );
298  }
299 
300  return $allowedParams;
301  }
302 
303  public function getParamDescription() {
304  $p = $this->getModulePrefix();
305  $what = $this->descriptionWhat;
306  $targets = $this->descriptionTargets;
307  $linking = $this->descriptionLinking;
308  $paramDescription = array(
309  'from' => "The title of the $what to start enumerating from",
310  'to' => "The title of the $what to stop enumerating at",
311  'prefix' => "Search for all $targets that begin with this value",
312  'unique' => array(
313  "Only show distinct $targets. Cannot be used with {$p}prop=" .
314  join( '|', array_keys( array( 'ids' => 1 ) + $this->props ) ) . '.',
315  'When used as a generator, yields target pages instead of source pages.',
316  ),
317  'prop' => array(
318  'What pieces of information to include',
319  " ids - Adds the pageid of the $linking page (Cannot be used with {$p}unique)",
320  " title - Adds the title of the $what",
321  ),
322  'namespace' => 'The namespace to enumerate',
323  'limit' => 'How many total items to return',
324  'continue' => 'When more results are available, use this to continue',
325  'dir' => 'The direction in which to list',
326  );
327  foreach ( $this->propHelp as $help ) {
328  $paramDescription['prop'][] = "$help (Cannot be used with {$p}unique)";
329  }
330  if ( !$this->hasNamespace ) {
331  unset( $paramDescription['namespace'] );
332  }
333 
334  return $paramDescription;
335  }
336 
337  public function getResultProperties() {
338  return array(
339  'ids' => array(
340  'fromid' => 'integer'
341  ),
342  'title' => array(
343  'ns' => 'namespace',
344  'title' => 'string'
345  )
346  );
347  }
348 
349  public function getDescription() {
350  return $this->description;
351  }
352 
353  public function getPossibleErrors() {
354  $m = $this->getModuleName();
355  $what = $this->descriptionWhat;
356 
357  return array_merge( parent::getPossibleErrors(), array(
358  array(
359  'code' => 'params',
360  'info' => "{$m} cannot return corresponding page ids in unique {$what}s mode"
361  ),
362  ) );
363  }
364 
365  public function getExamples() {
366  $p = $this->getModulePrefix();
367  $name = $this->getModuleName();
368  $what = $this->descriptionWhat;
369  $targets = $this->descriptionTargets;
370 
371  return array(
372  "api.php?action=query&list={$name}&{$p}from=B&{$p}prop=ids|title"
373  => "List $targets with page ids they are from, including missing ones. Start at B",
374  "api.php?action=query&list={$name}&{$p}unique=&{$p}from=B"
375  => "List unique $targets",
376  "api.php?action=query&generator={$name}&g{$p}unique=&g{$p}from=B"
377  => "Gets all $targets, marking the missing ones",
378  "api.php?action=query&generator={$name}&g{$p}from=B"
379  => "Gets pages containing the {$what}s",
380  );
381  }
382 
383  public function getHelpUrls() {
384  $name = ucfirst( $this->getModuleName() );
385 
386  return "https://www.mediawiki.org/wiki/API:{$name}";
387  }
388 }
Title\makeTitle
static & makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:398
$result
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. $reader:XMLReader object $logInfo:Array of information Return false to stop further processing of the tag 'ImportHandlePageXMLTag':When parsing a XML tag in a page. $reader:XMLReader object $pageInfo:Array of information Return false to stop further processing of the tag 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information Return false to stop further processing of the tag 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. $reader:XMLReader object Return false to stop further processing of the tag 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. $reader:XMLReader object $revisionInfo:Array of information Return false to stop further processing of the tag 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. $title:Title object for the current page $request:WebRequest $ignoreRedirect:boolean to skip redirect check $target:Title/string of redirect target $article:Article object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) $article:article(object) being checked 'IsTrustedProxy':Override the result of wfIsTrustedProxy() $ip:IP being check $result:Change this value to override the result of wfIsTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of User::isValidEmailAddr(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetMagic':DEPRECATED, use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetSpecialPageAliases':DEPRECATED, use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Associative array mapping language codes to prefixed links of the form "language:title". & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LinkBegin':Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1528
ApiQueryBase\addFields
addFields( $value)
Add a set of fields to select to the internal array.
Definition: ApiQueryBase.php:117
php
skin txt MediaWiki includes four core it has been set as the default in MediaWiki since the replacing Monobook it had been been the default skin since before being replaced by Vector largely rewritten in while keeping its appearance Several legacy skins were removed in the as the burden of supporting them became too heavy to bear Those in etc for skin dependent CSS etc for skin dependent JavaScript These can also be customised on a per user by etc This feature has led to a wide variety of user styles becoming that gallery is a good place to ending in php
Definition: skin.txt:62
ApiBase\PARAM_TYPE
const PARAM_TYPE
Definition: ApiBase.php:50
ApiBase\getResult
getResult()
Get the result object.
Definition: ApiBase.php:205
ApiQueryBase\select
select( $method, $extraQuery=array())
Execute a SELECT query based on the values in the internal arrays.
Definition: ApiQueryBase.php:274
$from
$from
Definition: importImages.php:90
NS_FILE
const NS_FILE
Definition: Defines.php:85
$params
$params
Definition: styleTest.css.php:40
$limit
if( $sleep) $limit
Definition: importImages.php:99
NS_TEMPLATE
const NS_TEMPLATE
Definition: Defines.php:89
ApiQueryBase\addOption
addOption( $name, $value=null)
Add an option such as LIMIT or USE INDEX.
Definition: ApiQueryBase.php:252
ApiQueryBase\addFieldsIf
addFieldsIf( $value, $condition)
Same as addFields(), but add the fields only if a condition is met.
Definition: ApiQueryBase.php:131
NS_MAIN
const NS_MAIN
Definition: Defines.php:79
ApiQueryGeneratorBase\setContinueEnumParameter
setContinueEnumParameter( $paramName, $paramValue)
Overrides base in case of generator & smart continue to notify ApiQueryMain instead of adding them to...
Definition: ApiQueryBase.php:676
ApiBase\PARAM_MIN
const PARAM_MIN
Definition: ApiBase.php:56
$titles
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
table
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:11
ApiBase\LIMIT_BIG1
const LIMIT_BIG1
Definition: ApiBase.php:78
ApiQueryBase\getDB
getDB()
Get the Query database connection (read-only)
Definition: ApiQueryBase.php:417
ApiBase\PARAM_MAX
const PARAM_MAX
Definition: ApiBase.php:52
ApiQueryBase\addTables
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
Definition: ApiQueryBase.php:82
array
the array() calling protocol came about after MediaWiki 1.4rc1.
List of Api Query prop modules.
$sort
$sort
Definition: profileinfo.php:301
ApiBase\getModulePrefix
getModulePrefix()
Get parameter prefix (usually two letters or an empty string).
Definition: ApiBase.php:165
ApiQueryBase\addWhereRange
addWhereRange( $field, $dir, $start, $end, $sort=true)
Add a WHERE clause corresponding to a range, and an ORDER BY clause to sort in the right direction.
Definition: ApiQueryBase.php:205
ApiBase\extractRequestParams
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:687
$title
presenting them properly to the user as errors is done by the caller $title
Definition: hooks.txt:1324
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:336
$matches
if(!defined( 'MEDIAWIKI')) if(!isset( $wgVersion)) $matches
Definition: NoLocalSettings.php:33
ApiBase\dieContinueUsageIf
dieContinueUsageIf( $condition)
Die with the $prefix.
Definition: ApiBase.php:1965
ApiBase\dieUsage
dieUsage( $description, $errorCode, $httpRespCode=0, $extradata=null)
Throw a UsageException, which will (if uncaught) call the main module's error handler and die with an...
Definition: ApiBase.php:1363
ApiQueryBase\titlePartToKey
titlePartToKey( $titlePart, $defaultNamespace=NS_MAIN)
An alternative to titleToKey() that doesn't trim trailing spaces, and does not mangle the input if st...
Definition: ApiQueryBase.php:491
ApiQueryBase\addWhereFld
addWhereFld( $field, $value)
Equivalent to addWhere(array($field => $value))
Definition: ApiQueryBase.php:185
$count
$count
Definition: UtfNormalTest2.php:96
ApiQueryGeneratorBase
Definition: ApiQueryBase.php:626
ApiBase\LIMIT_BIG2
const LIMIT_BIG2
Definition: ApiBase.php:79
ApiBase\PARAM_DFLT
const PARAM_DFLT
Definition: ApiBase.php:46
as
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
Definition: distributors.txt:9
ApiBase\getModuleName
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:148
ApiBase\PARAM_ISMULTI
const PARAM_ISMULTI
Definition: ApiBase.php:48
ApiBase\PARAM_MAX2
const PARAM_MAX2
Definition: ApiBase.php:54
$help
$help
Definition: mcc.php:31
ApiQueryBase\addWhere
addWhere( $value)
Add a set of WHERE clauses to the internal array.
Definition: ApiQueryBase.php:152
$query
return true to allow those checks to and false if checking is done use this to change the tables headers temp or archived zone change it to an object instance and return false override the list derivative used the name of the old file when set the default code will be skipped add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition: hooks.txt:1105
$res
$res
Definition: database.txt:21
ApiBase\dieDebug
static dieDebug( $method, $message)
Internal code errors should be reported with this method.
Definition: ApiBase.php:2006
ApiQueryBase\addTitleInfo
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
Definition: ApiQueryBase.php:339