MediaWiki  1.23.8
Go to the documentation of this file.
1 <?php
33  private $qpMap;
35  public function __construct( $query, $moduleName ) {
36  parent::__construct( $query, $moduleName, 'qp' );
37  // Build mapping from special page names to QueryPage classes
38  global $wgAPIUselessQueryPages;
39  $this->qpMap = array();
40  foreach ( QueryPage::getPages() as $page ) {
41  if ( !in_array( $page[1], $wgAPIUselessQueryPages ) ) {
42  $this->qpMap[$page[1]] = $page[0];
43  }
44  }
45  }
47  public function execute() {
48  $this->run();
49  }
51  public function executeGenerator( $resultPageSet ) {
52  $this->run( $resultPageSet );
53  }
58  public function run( $resultPageSet = null ) {
59  global $wgQueryCacheLimit;
61  $params = $this->extractRequestParams();
62  $result = $this->getResult();
65  $qp = new $this->qpMap[$params['page']]();
66  if ( !$qp->userCanExecute( $this->getUser() ) ) {
67  $this->dieUsageMsg( 'specialpage-cantexecute' );
68  }
70  $r = array( 'name' => $params['page'] );
71  if ( $qp->isCached() ) {
72  if ( !$qp->isCacheable() ) {
73  $r['disabled'] = '';
74  } else {
75  $r['cached'] = '';
76  $ts = $qp->getCachedTimestamp();
77  if ( $ts ) {
78  $r['cachedtimestamp'] = wfTimestamp( TS_ISO_8601, $ts );
79  }
80  $r['maxresults'] = $wgQueryCacheLimit;
81  }
82  }
83  $result->addValue( array( 'query' ), $this->getModuleName(), $r );
85  if ( $qp->isCached() && !$qp->isCacheable() ) {
86  // Disabled query page, don't run the query
87  return;
88  }
90  $res = $qp->doQuery( $params['offset'], $params['limit'] + 1 );
91  $count = 0;
92  $titles = array();
93  foreach ( $res as $row ) {
94  if ( ++$count > $params['limit'] ) {
95  // We've had enough
96  $this->setContinueEnumParameter( 'offset', $params['offset'] + $params['limit'] );
97  break;
98  }
100  $title = Title::makeTitle( $row->namespace, $row->title );
101  if ( is_null( $resultPageSet ) ) {
102  $data = array( 'value' => $row->value );
103  if ( $qp->usesTimestamps() ) {
104  $data['timestamp'] = wfTimestamp( TS_ISO_8601, $row->value );
105  }
106  self::addTitleInfo( $data, $title );
108  foreach ( $row as $field => $value ) {
109  if ( !in_array( $field, array( 'namespace', 'title', 'value', 'qc_type' ) ) ) {
110  $data['databaseResult'][$field] = $value;
111  }
112  }
114  $fit = $result->addValue( array( 'query', $this->getModuleName(), 'results' ), null, $data );
115  if ( !$fit ) {
116  $this->setContinueEnumParameter( 'offset', $params['offset'] + $count - 1 );
117  break;
118  }
119  } else {
120  $titles[] = $title;
121  }
122  }
123  if ( is_null( $resultPageSet ) ) {
124  $result->setIndexedTagName_internal(
125  array( 'query', $this->getModuleName(), 'results' ),
126  'page'
127  );
128  } else {
129  $resultPageSet->populateFromTitles( $titles );
130  }
131  }
133  public function getCacheMode( $params ) {
135  $qp = new $this->qpMap[$params['page']]();
136  if ( $qp->getRestriction() != '' ) {
137  return 'private';
138  }
140  return 'public';
141  }
143  public function getAllowedParams() {
144  return array(
145  'page' => array(
146  ApiBase::PARAM_TYPE => array_keys( $this->qpMap ),
148  ),
149  'offset' => 0,
150  'limit' => array(
151  ApiBase::PARAM_DFLT => 10,
152  ApiBase::PARAM_TYPE => 'limit',
153  ApiBase::PARAM_MIN => 1,
156  ),
157  );
158  }
160  public function getParamDescription() {
161  return array(
162  'page' => 'The name of the special page. Note, this is case sensitive',
163  'offset' => 'When more results are available, use this to continue',
164  'limit' => 'Number of results to return',
165  );
166  }
168  public function getResultProperties() {
169  return array(
171  'name' => array(
172  ApiBase::PROP_TYPE => 'string',
173  ApiBase::PROP_NULLABLE => false
174  ),
175  'disabled' => array(
176  ApiBase::PROP_TYPE => 'boolean',
177  ApiBase::PROP_NULLABLE => false
178  ),
179  'cached' => array(
180  ApiBase::PROP_TYPE => 'boolean',
181  ApiBase::PROP_NULLABLE => false
182  ),
183  'cachedtimestamp' => array(
184  ApiBase::PROP_TYPE => 'timestamp',
185  ApiBase::PROP_NULLABLE => true
186  )
187  ),
188  '' => array(
189  'value' => 'string',
190  'timestamp' => array(
191  ApiBase::PROP_TYPE => 'timestamp',
192  ApiBase::PROP_NULLABLE => true
193  ),
194  'ns' => 'namespace',
195  'title' => 'string'
196  )
197  );
198  }
200  public function getDescription() {
201  return 'Get a list provided by a QueryPage-based special page.';
202  }
204  public function getPossibleErrors() {
205  return array_merge( parent::getPossibleErrors(), array(
206  array( 'specialpage-cantexecute' )
207  ) );
208  }
210  public function getExamples() {
211  return array(
212  'api.php?action=query&list=querypage&qppage=Ancientpages'
213  );
214  }
216  public function getHelpUrls() {
217  return '';
218  }
219 }
static & makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:398
Evaluates the parameters, performs the requested query, and sets up the result.
Definition: ApiQueryQueryPage.php:47
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
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
Definition: ApiBase.php:62
dieUsageMsg( $error)
Output the error message related to a certain array.
Definition: ApiBase.php:1933
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
Definition: GlobalFunctions.php:2483
Definition: ApiBase.php:50
Get the result object.
Definition: ApiBase.php:205
Returns an array of parameter descriptions.
Definition: ApiQueryQueryPage.php:160
Definition: styleTest.css.php:40
Returns usage examples for this module.
Definition: ApiQueryQueryPage.php:210
Returns the description string for this module.
Definition: ApiQueryQueryPage.php:200
getCacheMode( $params)
Get the cache mode for the data generated by this module.
Definition: ApiQueryQueryPage.php:133
Returns possible properties in the result, grouped by the value of the prop parameter that shows them...
Definition: ApiQueryQueryPage.php:168
setContinueEnumParameter( $paramName, $paramValue)
Overrides base in case of generator & smart continue to notify ApiQueryMain instead of adding them to...
Definition: ApiQueryBase.php:676
Query module to get the results of a QueryPage-based special page.
Definition: ApiQueryQueryPage.php:32
Definition: ApiBase.php:56
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
Definition: ApiQueryQueryPage.php:216
const LIMIT_BIG1
Definition: ApiBase.php:78
const TS_ISO_8601
ISO 8601 format with no timezone: 1986-02-09T20:00:00Z.
Definition: GlobalFunctions.php:2448
Definition: ApiBase.php:52
the array() calling protocol came about after MediaWiki 1.4rc1.
List of Api Query prop modules.
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:93
Definition: ApiQueryQueryPage.php:33
Definition: ApiBase.php:74
executeGenerator( $resultPageSet)
Execute this module as a generator.
Definition: ApiQueryQueryPage.php:51
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:687
presenting them properly to the user as errors is done by the caller $title
Definition: hooks.txt:1324
__construct( $query, $moduleName)
Definition: ApiQueryQueryPage.php:35
Definition: styleTest.css.php:45
Definition: ApiQueryQueryPage.php:204
Definition: ApiBase.php:76
run( $resultPageSet=null)
Definition: ApiQueryQueryPage.php:58
Definition: UtfNormalTest2.php:96
Definition: ApiQueryBase.php:626
const LIMIT_BIG2
Definition: ApiBase.php:79
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Definition: ApiQueryQueryPage.php:143
Definition: ApiBase.php:46
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
Get the name of the module being executed by this instance.
Definition: ApiBase.php:148
const PARAM_MAX2
Definition: ApiBase.php:54
static getPages()
Get a list of query page classes and their associated special pages, for periodic updates.
Definition: QueryPage.php:66
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
Definition: database.txt:21
Definition: ApiBase.php:70
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
Definition: ApiQueryBase.php:339