MediaWiki  master
ApiQueryAllLinks.php
Go to the documentation of this file.
1 <?php
29 
31  private $fieldTitle = 'title';
33  private $hasNamespace = true;
34  private $useIndex = null;
35  private $props = [];
36 
37  public function __construct( ApiQuery $query, $moduleName ) {
38  switch ( $moduleName ) {
39  case 'alllinks':
40  $prefix = 'al';
41  $this->table = 'pagelinks';
42  $this->tablePrefix = 'pl_';
43  $this->useIndex = 'pl_namespace';
44  $this->indexTag = 'l';
45  break;
46  case 'alltransclusions':
47  $prefix = 'at';
48  $this->table = 'templatelinks';
49  $this->tablePrefix = 'tl_';
50  $this->dfltNamespace = NS_TEMPLATE;
51  $this->useIndex = 'tl_namespace';
52  $this->indexTag = 't';
53  break;
54  case 'allfileusages':
55  $prefix = 'af';
56  $this->table = 'imagelinks';
57  $this->tablePrefix = 'il_';
58  $this->fieldTitle = 'to';
59  $this->dfltNamespace = NS_FILE;
60  $this->hasNamespace = false;
61  $this->indexTag = 'f';
62  break;
63  case 'allredirects':
64  $prefix = 'ar';
65  $this->table = 'redirect';
66  $this->tablePrefix = 'rd_';
67  $this->indexTag = 'r';
68  $this->props = [
69  'fragment' => 'rd_fragment',
70  'interwiki' => 'rd_interwiki',
71  ];
72  break;
73  default:
74  ApiBase::dieDebug( __METHOD__, 'Unknown module name' );
75  }
76 
77  parent::__construct( $query, $moduleName, $prefix );
78  }
79 
80  public function execute() {
81  $this->run();
82  }
83 
84  public function getCacheMode( $params ) {
85  return 'public';
86  }
87 
88  public function executeGenerator( $resultPageSet ) {
89  $this->run( $resultPageSet );
90  }
91 
96  private function run( $resultPageSet = null ) {
97  $db = $this->getDB();
98  $params = $this->extractRequestParams();
99 
100  $pfx = $this->tablePrefix;
102  $prop = array_flip( $params['prop'] );
103  $fld_ids = isset( $prop['ids'] );
104  $fld_title = isset( $prop['title'] );
105  if ( $this->hasNamespace ) {
106  $namespace = $params['namespace'];
107  } else {
108  $namespace = $this->dfltNamespace;
109  }
110 
111  if ( $params['unique'] ) {
112  $matches = array_intersect_key( $prop, $this->props + [ 'ids' => 1 ] );
113  if ( $matches ) {
114  $p = $this->getModulePrefix();
115  $this->dieWithError(
116  [
117  'apierror-invalidparammix-cannotusewith',
118  "{$p}prop=" . implode( '|', array_keys( $matches ) ),
119  "{$p}unique"
120  ],
121  'invalidparammix'
122  );
123  }
124  $this->addOption( 'DISTINCT' );
125  }
126 
127  $this->addTables( $this->table );
128  if ( $this->hasNamespace ) {
129  $this->addWhereFld( $pfx . 'namespace', $namespace );
130  }
131 
132  $continue = !is_null( $params['continue'] );
133  if ( $continue ) {
134  $continueArr = explode( '|', $params['continue'] );
135  $op = $params['dir'] == 'descending' ? '<' : '>';
136  if ( $params['unique'] ) {
137  $this->dieContinueUsageIf( count( $continueArr ) != 1 );
138  $continueTitle = $db->addQuotes( $continueArr[0] );
139  $this->addWhere( "{$pfx}{$fieldTitle} $op= $continueTitle" );
140  } else {
141  $this->dieContinueUsageIf( count( $continueArr ) != 2 );
142  $continueTitle = $db->addQuotes( $continueArr[0] );
143  $continueFrom = (int)$continueArr[1];
144  $this->addWhere(
145  "{$pfx}{$fieldTitle} $op $continueTitle OR " .
146  "({$pfx}{$fieldTitle} = $continueTitle AND " .
147  "{$pfx}from $op= $continueFrom)"
148  );
149  }
150  }
151 
152  // 'continue' always overrides 'from'
153  $from = $continue || $params['from'] === null ? null :
154  $this->titlePartToKey( $params['from'], $namespace );
155  $to = $params['to'] === null ? null :
156  $this->titlePartToKey( $params['to'], $namespace );
157  $this->addWhereRange( $pfx . $fieldTitle, 'newer', $from, $to );
158 
159  if ( isset( $params['prefix'] ) ) {
160  $this->addWhere( $pfx . $fieldTitle . $db->buildLike( $this->titlePartToKey(
161  $params['prefix'], $namespace ), $db->anyString() ) );
162  }
163 
164  $this->addFields( [ 'pl_title' => $pfx . $fieldTitle ] );
165  $this->addFieldsIf( [ 'pl_from' => $pfx . 'from' ], !$params['unique'] );
166  foreach ( $this->props as $name => $field ) {
167  $this->addFieldsIf( $field, isset( $prop[$name] ) );
168  }
169 
170  if ( $this->useIndex ) {
171  $this->addOption( 'USE INDEX', $this->useIndex );
172  }
173  $limit = $params['limit'];
174  $this->addOption( 'LIMIT', $limit + 1 );
175 
176  $sort = ( $params['dir'] == 'descending' ? ' DESC' : '' );
177  $orderBy = [];
178  $orderBy[] = $pfx . $fieldTitle . $sort;
179  if ( !$params['unique'] ) {
180  $orderBy[] = $pfx . 'from' . $sort;
181  }
182  $this->addOption( 'ORDER BY', $orderBy );
183 
184  $res = $this->select( __METHOD__ );
185 
186  $pageids = [];
187  $titles = [];
188  $count = 0;
189  $result = $this->getResult();
190  foreach ( $res as $row ) {
191  if ( ++$count > $limit ) {
192  // We've reached the one extra which shows that there are
193  // additional pages to be had. Stop here...
194  if ( $params['unique'] ) {
195  $this->setContinueEnumParameter( 'continue', $row->pl_title );
196  } else {
197  $this->setContinueEnumParameter( 'continue', $row->pl_title . '|' . $row->pl_from );
198  }
199  break;
200  }
201 
202  if ( is_null( $resultPageSet ) ) {
203  $vals = [
204  ApiResult::META_TYPE => 'assoc',
205  ];
206  if ( $fld_ids ) {
207  $vals['fromid'] = (int)$row->pl_from;
208  }
209  if ( $fld_title ) {
210  $title = Title::makeTitle( $namespace, $row->pl_title );
212  }
213  foreach ( $this->props as $name => $field ) {
214  if ( isset( $prop[$name] ) && $row->$field !== null && $row->$field !== '' ) {
215  $vals[$name] = $row->$field;
216  }
217  }
218  $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $vals );
219  if ( !$fit ) {
220  if ( $params['unique'] ) {
221  $this->setContinueEnumParameter( 'continue', $row->pl_title );
222  } else {
223  $this->setContinueEnumParameter( 'continue', $row->pl_title . '|' . $row->pl_from );
224  }
225  break;
226  }
227  } elseif ( $params['unique'] ) {
228  $titles[] = Title::makeTitle( $namespace, $row->pl_title );
229  } else {
230  $pageids[] = $row->pl_from;
231  }
232  }
233 
234  if ( is_null( $resultPageSet ) ) {
235  $result->addIndexedTagName( [ 'query', $this->getModuleName() ], $this->indexTag );
236  } elseif ( $params['unique'] ) {
237  $resultPageSet->populateFromTitles( $titles );
238  } else {
239  $resultPageSet->populateFromPageIDs( $pageids );
240  }
241  }
242 
243  public function getAllowedParams() {
244  $allowedParams = [
245  'continue' => [
246  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
247  ],
248  'from' => null,
249  'to' => null,
250  'prefix' => null,
251  'unique' => false,
252  'prop' => [
253  ApiBase::PARAM_ISMULTI => true,
254  ApiBase::PARAM_DFLT => 'title',
255  ApiBase::PARAM_TYPE => array_merge(
256  [ 'ids', 'title' ], array_keys( $this->props )
257  ),
259  ],
260  'namespace' => [
262  ApiBase::PARAM_TYPE => 'namespace',
264  ],
265  'limit' => [
266  ApiBase::PARAM_DFLT => 10,
267  ApiBase::PARAM_TYPE => 'limit',
268  ApiBase::PARAM_MIN => 1,
271  ],
272  'dir' => [
273  ApiBase::PARAM_DFLT => 'ascending',
274  ApiBase::PARAM_TYPE => [
275  'ascending',
276  'descending'
277  ]
278  ],
279  ];
280  if ( !$this->hasNamespace ) {
281  unset( $allowedParams['namespace'] );
282  }
283 
284  return $allowedParams;
285  }
286 
287  protected function getExamplesMessages() {
288  $p = $this->getModulePrefix();
289  $name = $this->getModuleName();
290  $path = $this->getModulePath();
291 
292  return [
293  "action=query&list={$name}&{$p}from=B&{$p}prop=ids|title"
294  => "apihelp-$path-example-b",
295  "action=query&list={$name}&{$p}unique=&{$p}from=B"
296  => "apihelp-$path-example-unique",
297  "action=query&generator={$name}&g{$p}unique=&g{$p}from=B"
298  => "apihelp-$path-example-unique-generator",
299  "action=query&generator={$name}&g{$p}from=B"
300  => "apihelp-$path-example-generator",
301  ];
302  }
303 
304  public function getHelpUrls() {
305  $name = ucfirst( $this->getModuleName() );
306 
307  return "https://www.mediawiki.org/wiki/Special:MyLanguage/API:{$name}";
308  }
309 }
select( $method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below...
Definition: ApiBase.php:94
getDB()
Get the Query database connection (read-only)
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition: ApiBase.php:261
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
return true to allow those checks to and false if checking is done remove or add to the links of a group of changes in EnhancedChangesList Hook subscribers can return false to omit this line from recentchanges use this to change the tables headers change it to an object instance and return false override the list derivative used $groups Array of ChangesListFilterGroup objects(added in 1.34) 'FileDeleteComplete' 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:1535
getResult()
Get the result object.
Definition: ApiBase.php:640
const NS_MAIN
Definition: Defines.php:60
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:55
const LIMIT_BIG1
Fast query, standard limit.
Definition: ApiBase.php:259
const PARAM_MAX
(integer) Max value allowed for the parameter, for PARAM_TYPE &#39;integer&#39; and &#39;limit&#39;.
Definition: ApiBase.php:97
$sort
const NS_SPECIAL
Definition: Defines.php:49
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition: ApiBase.php:2009
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:761
const META_TYPE
Key for the &#39;type&#39; metadata item.
Definition: ApiResult.php:110
const PARAM_HELP_MSG_PER_VALUE
((string|array|Message)[]) When PARAM_TYPE is an array, this is an array mapping those values to $msg...
Definition: ApiBase.php:164
setContinueEnumParameter( $paramName, $paramValue)
Overridden to set the generator param if in generator mode.
const NS_TEMPLATE
Definition: Defines.php:70
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. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\*-\*)") will be honored when streaming the file. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. '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 '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 '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 '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. '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 IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() '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 Sanitizer::validateEmail(), 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 '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:Array with elements of the form "language:title" in the order that they will be output. & $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. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead. 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:1976
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
titlePartToKey( $titlePart, $namespace=NS_MAIN)
Convert an input title or title prefix into a dbkey.
const NS_MEDIA
Definition: Defines.php:48
$res
Definition: database.txt:21
dieContinueUsageIf( $condition)
Die with the &#39;badcontinue&#39; error.
Definition: ApiBase.php:2200
getModulePath()
Get the path to this module.
Definition: ApiBase.php:584
$params
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:773
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:918
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:520
addFields( $value)
Add a set of fields to select to the internal array.
const NS_FILE
Definition: Defines.php:66
const PARAM_MAX2
(integer) Max value allowed for the parameter for users with the apihighlimits right, for PARAM_TYPE &#39;limit&#39;.
Definition: ApiBase.php:103
This is the main query class.
Definition: ApiQuery.php:36
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
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter...
Definition: ApiBase.php:131
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:592
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:35
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
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
getModulePrefix()
Get parameter prefix (usually two letters or an empty string).
Definition: ApiBase.php:528
addWhere( $value)
Add a set of WHERE clauses to the internal array.
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:58
static dieDebug( $method, $message)
Internal code errors should be reported with this method.
Definition: ApiBase.php:2212
addWhereFld( $field, $value)
Equivalent to addWhere( [ $field => $value ] )
addFieldsIf( $value, $condition)
Same as addFields(), but add the fields only if a condition is met.
const PARAM_EXTRA_NAMESPACES
(int[]) When PARAM_TYPE is &#39;namespace&#39;, include these as additional possible values.
Definition: ApiBase.php:193
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:277
addOption( $name, $value=null)
Add an option such as LIMIT or USE INDEX.
const PARAM_MIN
(integer) Lowest value allowed for the parameter, for PARAM_TYPE &#39;integer&#39; and &#39;limit&#39;.
Definition: ApiBase.php:106
$matches
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...