MediaWiki  master
ApiQueryQueryPage.php
Go to the documentation of this file.
1 <?php
25 
32 
36  private $queryPages;
37 
42 
43  public function __construct( ApiQuery $query, $moduleName ) {
44  parent::__construct( $query, $moduleName, 'qp' );
45  $this->queryPages = array_values( array_diff(
46  array_column( QueryPage::getPages(), 1 ), // [ class, name ]
47  $this->getConfig()->get( 'APIUselessQueryPages' )
48  ) );
49  $this->specialPageFactory = MediaWikiServices::getInstance()->getSpecialPageFactory();
50  }
51 
52  public function execute() {
53  $this->run();
54  }
55 
56  public function executeGenerator( $resultPageSet ) {
57  $this->run( $resultPageSet );
58  }
59 
64  private function getSpecialPage( $name ) : QueryPage {
65  $qp = $this->specialPageFactory->getPage( $name );
66  if ( !$qp ) {
67  self::dieDebug(
68  __METHOD__,
69  'SpecialPageFactory failed to create special page ' . $name
70  );
71  }
72  if ( !( $qp instanceof QueryPage ) ) {
73  self::dieDebug(
74  __METHOD__,
75  'Special page ' . $name . ' is not a QueryPage'
76  );
77  }
78  return $qp;
79  }
80 
84  public function run( $resultPageSet = null ) {
85  $params = $this->extractRequestParams();
86  $result = $this->getResult();
87 
88  $qp = $this->getSpecialPage( $params['page'] );
89  if ( !$qp->userCanExecute( $this->getUser() ) ) {
90  $this->dieWithError( 'apierror-specialpage-cantexecute' );
91  }
92 
93  $r = [ 'name' => $params['page'] ];
94  if ( $qp->isCached() ) {
95  if ( !$qp->isCacheable() ) {
96  $r['disabled'] = true;
97  } else {
98  $r['cached'] = true;
99  $ts = $qp->getCachedTimestamp();
100  if ( $ts ) {
101  $r['cachedtimestamp'] = wfTimestamp( TS_ISO_8601, $ts );
102  }
103  $r['maxresults'] = $this->getConfig()->get( 'QueryCacheLimit' );
104  }
105  }
106  $result->addValue( [ 'query' ], $this->getModuleName(), $r );
107 
108  if ( $qp->isCached() && !$qp->isCacheable() ) {
109  // Disabled query page, don't run the query
110  return;
111  }
112 
113  $res = $qp->doQuery( $params['offset'], $params['limit'] + 1 );
114  $count = 0;
115  $titles = [];
116  foreach ( $res as $row ) {
117  if ( ++$count > $params['limit'] ) {
118  // We've had enough
119  $this->setContinueEnumParameter( 'offset', $params['offset'] + $params['limit'] );
120  break;
121  }
122 
123  $title = Title::makeTitle( $row->namespace, $row->title );
124  if ( is_null( $resultPageSet ) ) {
125  $data = [];
126  if ( isset( $row->value ) ) {
127  $data['value'] = $row->value;
128  if ( $qp->usesTimestamps() ) {
129  $data['timestamp'] = wfTimestamp( TS_ISO_8601, $row->value );
130  }
131  }
132  self::addTitleInfo( $data, $title );
133 
134  foreach ( $row as $field => $value ) {
135  if ( !in_array( $field, [ 'namespace', 'title', 'value', 'qc_type' ] ) ) {
136  $data['databaseResult'][$field] = $value;
137  }
138  }
139 
140  $fit = $result->addValue( [ 'query', $this->getModuleName(), 'results' ], null, $data );
141  if ( !$fit ) {
142  $this->setContinueEnumParameter( 'offset', $params['offset'] + $count - 1 );
143  break;
144  }
145  } else {
146  $titles[] = $title;
147  }
148  }
149  if ( is_null( $resultPageSet ) ) {
150  $result->addIndexedTagName(
151  [ 'query', $this->getModuleName(), 'results' ],
152  'page'
153  );
154  } else {
155  $resultPageSet->populateFromTitles( $titles );
156  }
157  }
158 
159  public function getCacheMode( $params ) {
160  $qp = $this->getSpecialPage( $params['page'] );
161  if ( $qp->getRestriction() != '' ) {
162  return 'private';
163  }
164 
165  return 'public';
166  }
167 
168  public function getAllowedParams() {
169  return [
170  'page' => [
173  ],
174  'offset' => [
175  ApiBase::PARAM_DFLT => 0,
176  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
177  ],
178  'limit' => [
179  ApiBase::PARAM_DFLT => 10,
180  ApiBase::PARAM_TYPE => 'limit',
181  ApiBase::PARAM_MIN => 1,
184  ],
185  ];
186  }
187 
188  protected function getExamplesMessages() {
189  return [
190  'action=query&list=querypage&qppage=Ancientpages'
191  => 'apihelp-query+querypage-example-ancientpages',
192  ];
193  }
194 
195  public function getHelpUrls() {
196  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Querypage';
197  }
198 }
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below...
Definition: ApiBase.php:94
__construct(ApiQuery $query, $moduleName)
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition: ApiBase.php:261
getResult()
Get the result object.
Definition: ApiBase.php:640
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
const PARAM_REQUIRED
(boolean) Is the parameter required?
Definition: ApiBase.php:118
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition: ApiBase.php:2006
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:761
setContinueEnumParameter( $paramName, $paramValue)
Overridden to set the generator param if in generator mode.
Query module to get the results of a QueryPage-based special page.
This is a class for doing query pages; since they&#39;re almost all the same, we factor out some of the f...
Definition: QueryPage.php:36
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
executeGenerator( $resultPageSet)
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:520
string [] $queryPages
list of special page names
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:37
SpecialPageFactory $specialPageFactory
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter...
Definition: ApiBase.php:131
run( $resultPageSet=null)
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:584
const PARAM_MIN
(integer) Lowest value allowed for the parameter, for PARAM_TYPE &#39;integer&#39; and &#39;limit&#39;.
Definition: ApiBase.php:106
return true
Definition: router.php:92
static getPages()
Get a list of query page classes and their associated special pages, for periodic updates...
Definition: QueryPage.php:74