MediaWiki  REL1_31
ApiQueryQueryPage.php
Go to the documentation of this file.
1 <?php
29  private $qpMap;
30 
31  public function __construct( ApiQuery $query, $moduleName ) {
32  parent::__construct( $query, $moduleName, 'qp' );
33  // Build mapping from special page names to QueryPage classes
34  $uselessQueryPages = $this->getConfig()->get( 'APIUselessQueryPages' );
35  $this->qpMap = [];
36  foreach ( QueryPage::getPages() as $page ) {
37  if ( !in_array( $page[1], $uselessQueryPages ) ) {
38  $this->qpMap[$page[1]] = $page[0];
39  }
40  }
41  }
42 
43  public function execute() {
44  $this->run();
45  }
46 
47  public function executeGenerator( $resultPageSet ) {
48  $this->run( $resultPageSet );
49  }
50 
54  public function run( $resultPageSet = null ) {
55  $params = $this->extractRequestParams();
56  $result = $this->getResult();
57 
59  $qp = new $this->qpMap[$params['page']]();
60  if ( !$qp->userCanExecute( $this->getUser() ) ) {
61  $this->dieWithError( 'apierror-specialpage-cantexecute' );
62  }
63 
64  $r = [ 'name' => $params['page'] ];
65  if ( $qp->isCached() ) {
66  if ( !$qp->isCacheable() ) {
67  $r['disabled'] = true;
68  } else {
69  $r['cached'] = true;
70  $ts = $qp->getCachedTimestamp();
71  if ( $ts ) {
72  $r['cachedtimestamp'] = wfTimestamp( TS_ISO_8601, $ts );
73  }
74  $r['maxresults'] = $this->getConfig()->get( 'QueryCacheLimit' );
75  }
76  }
77  $result->addValue( [ 'query' ], $this->getModuleName(), $r );
78 
79  if ( $qp->isCached() && !$qp->isCacheable() ) {
80  // Disabled query page, don't run the query
81  return;
82  }
83 
84  $res = $qp->doQuery( $params['offset'], $params['limit'] + 1 );
85  $count = 0;
86  $titles = [];
87  foreach ( $res as $row ) {
88  if ( ++$count > $params['limit'] ) {
89  // We've had enough
90  $this->setContinueEnumParameter( 'offset', $params['offset'] + $params['limit'] );
91  break;
92  }
93 
94  $title = Title::makeTitle( $row->namespace, $row->title );
95  if ( is_null( $resultPageSet ) ) {
96  $data = [ 'value' => $row->value ];
97  if ( $qp->usesTimestamps() ) {
98  $data['timestamp'] = wfTimestamp( TS_ISO_8601, $row->value );
99  }
100  self::addTitleInfo( $data, $title );
101 
102  foreach ( $row as $field => $value ) {
103  if ( !in_array( $field, [ 'namespace', 'title', 'value', 'qc_type' ] ) ) {
104  $data['databaseResult'][$field] = $value;
105  }
106  }
107 
108  $fit = $result->addValue( [ 'query', $this->getModuleName(), 'results' ], null, $data );
109  if ( !$fit ) {
110  $this->setContinueEnumParameter( 'offset', $params['offset'] + $count - 1 );
111  break;
112  }
113  } else {
114  $titles[] = $title;
115  }
116  }
117  if ( is_null( $resultPageSet ) ) {
118  $result->addIndexedTagName(
119  [ 'query', $this->getModuleName(), 'results' ],
120  'page'
121  );
122  } else {
123  $resultPageSet->populateFromTitles( $titles );
124  }
125  }
126 
127  public function getCacheMode( $params ) {
129  $qp = new $this->qpMap[$params['page']]();
130  if ( $qp->getRestriction() != '' ) {
131  return 'private';
132  }
133 
134  return 'public';
135  }
136 
137  public function getAllowedParams() {
138  return [
139  'page' => [
140  ApiBase::PARAM_TYPE => array_keys( $this->qpMap ),
142  ],
143  'offset' => [
144  ApiBase::PARAM_DFLT => 0,
145  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
146  ],
147  'limit' => [
148  ApiBase::PARAM_DFLT => 10,
149  ApiBase::PARAM_TYPE => 'limit',
150  ApiBase::PARAM_MIN => 1,
153  ],
154  ];
155  }
156 
157  protected function getExamplesMessages() {
158  return [
159  'action=query&list=querypage&qppage=Ancientpages'
160  => 'apihelp-query+querypage-example-ancientpages',
161  ];
162  }
163 
164  public function getHelpUrls() {
165  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Querypage';
166  }
167 }
ContextSource\getConfig
getConfig()
Definition: ContextSource.php:63
ApiQueryQueryPage\execute
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
Definition: ApiQueryQueryPage.php:43
ApiQuery
This is the main query class.
Definition: ApiQuery.php:36
ApiBase\PARAM_REQUIRED
const PARAM_REQUIRED
(boolean) Is the parameter required?
Definition: ApiBase.php:111
ApiBase\dieWithError
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition: ApiBase.php:1895
ApiBase\PARAM_HELP_MSG
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition: ApiBase.php:124
wfTimestamp
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
Definition: GlobalFunctions.php:1980
ApiBase\PARAM_TYPE
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
Definition: ApiBase.php:87
ApiBase\getResult
getResult()
Get the result object.
Definition: ApiBase.php:641
$params
$params
Definition: styleTest.css.php:40
$res
$res
Definition: database.txt:21
$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. '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=(\d*-\d*)") 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. '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) '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 '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: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! 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:1993
true
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return true
Definition: hooks.txt:2006
php
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
ApiQueryQueryPage\getCacheMode
getCacheMode( $params)
Get the cache mode for the data generated by this module.
Definition: ApiQueryQueryPage.php:127
ApiQueryGeneratorBase\setContinueEnumParameter
setContinueEnumParameter( $paramName, $paramValue)
Overridden to set the generator param if in generator mode.
Definition: ApiQueryGeneratorBase.php:84
ApiQueryQueryPage
Query module to get the results of a QueryPage-based special page.
Definition: ApiQueryQueryPage.php:28
ApiBase\PARAM_MIN
const PARAM_MIN
(integer) Lowest value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition: ApiBase.php:99
$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
ApiQueryQueryPage\getHelpUrls
getHelpUrls()
Return links to more detailed help pages about the module.
Definition: ApiQueryQueryPage.php:164
ApiBase\LIMIT_BIG1
const LIMIT_BIG1
Fast query, standard limit.
Definition: ApiBase.php:234
ApiBase\PARAM_MAX
const PARAM_MAX
(integer) Max value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition: ApiBase.php:90
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:964
Title\makeTitle
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:534
ApiQueryQueryPage\$qpMap
$qpMap
Definition: ApiQueryQueryPage.php:29
ApiQueryQueryPage\executeGenerator
executeGenerator( $resultPageSet)
Execute this module as a generator.
Definition: ApiQueryQueryPage.php:47
ApiBase\extractRequestParams
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:749
$value
$value
Definition: styleTest.css.php:45
ApiQueryQueryPage\getExamplesMessages
getExamplesMessages()
Returns usage examples for this module.
Definition: ApiQueryQueryPage.php:157
ApiQueryQueryPage\run
run( $resultPageSet=null)
Definition: ApiQueryQueryPage.php:54
ApiQueryGeneratorBase
Definition: ApiQueryGeneratorBase.php:26
ApiBase\LIMIT_BIG2
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition: ApiBase.php:236
ApiQueryQueryPage\getAllowedParams
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Definition: ApiQueryQueryPage.php:137
ApiBase\PARAM_DFLT
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:48
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:22
ApiBase\getModuleName
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:521
ApiBase\PARAM_MAX2
const PARAM_MAX2
(integer) Max value allowed for the parameter for users with the apihighlimits right,...
Definition: ApiBase.php:96
ApiQueryQueryPage\__construct
__construct(ApiQuery $query, $moduleName)
Definition: ApiQueryQueryPage.php:31
QueryPage\getPages
static getPages()
Get a list of query page classes and their associated special pages, for periodic updates.
Definition: QueryPage.php:66
$query
null for the 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:1620
ApiQueryBase\addTitleInfo
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
Definition: ApiQueryBase.php:482