includes/api/ApiQueryPagesWithProp.php

   1 <?php
   2 /**
   3  * Copyright © 2012 Wikimedia Foundation and contributors
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @since 1.21
  22  */
  23
  24 /**
  25  * A query module to enumerate pages that use a particular prop
  26  *
  27  * @ingroup API
  28  * @since 1.21
  29  */
  30 class ApiQueryPagesWithProp extends ApiQueryGeneratorBase {
  31
  32         public function __construct( ApiQuery $query, $moduleName ) {
  33                 parent::__construct( $query, $moduleName, 'pwp' );
  34         }
  35
  36         public function execute() {
  37                 $this->run();
  38         }
  39
  40         public function getCacheMode( $params ) {
  41                 return 'public';
  42         }
  43
  44         public function executeGenerator( $resultPageSet ) {
  45                 $this->run( $resultPageSet );
  46         }
  47
  48         /**
  49          * @param ApiPageSet $resultPageSet
  50          * @return void
  51          */
  52         private function run( $resultPageSet = null ) {
  53                 $params = $this->extractRequestParams();
  54
  55                 $prop = array_flip( $params['prop'] );
  56                 $fld_ids = isset( $prop['ids'] );
  57                 $fld_title = isset( $prop['title'] );
  58                 $fld_value = isset( $prop['value'] );
  59
  60                 if ( $resultPageSet === null ) {
  61                         $this->addFields( [ 'page_id' ] );
  62                         $this->addFieldsIf( [ 'page_title', 'page_namespace' ], $fld_title );
  63                         $this->addFieldsIf( 'pp_value', $fld_value );
  64                 } else {
  65                         $this->addFields( $resultPageSet->getPageTableFields() );
  66                 }
  67                 $this->addTables( [ 'page_props', 'page' ] );
  68                 $this->addWhere( 'pp_page=page_id' );
  69                 $this->addWhereFld( 'pp_propname', $params['propname'] );
  70
  71                 $dir = ( $params['dir'] == 'ascending' ) ? 'newer' : 'older';
  72
  73                 if ( $params['continue'] ) {
  74                         $cont = explode( '|', $params['continue'] );
  75                         $this->dieContinueUsageIf( count( $cont ) != 1 );
  76
  77                         // Add a WHERE clause
  78                         $from = (int)$cont[0];
  79                         $this->addWhereRange( 'pp_page', $dir, $from, null );
  80                 }
  81
  82                 $sort = ( $params['dir'] === 'descending' ? ' DESC' : '' );
  83                 $this->addOption( 'ORDER BY', 'pp_page' . $sort );
  84
  85                 $limit = $params['limit'];
  86                 $this->addOption( 'LIMIT', $limit + 1 );
  87
  88                 $result = $this->getResult();
  89                 $count = 0;
  90                 foreach ( $this->select( __METHOD__ ) as $row ) {
  91                         if ( ++$count > $limit ) {
  92                                 // We've reached the one extra which shows that there are
  93                                 // additional pages to be had. Stop here...
  94                                 $this->setContinueEnumParameter( 'continue', $row->page_id );
  95                                 break;
  96                         }
  97
  98                         if ( $resultPageSet === null ) {
  99                                 $vals = [
 100                                         ApiResult::META_TYPE => 'assoc',
 101                                 ];
 102                                 if ( $fld_ids ) {
 103                                         $vals['pageid'] = (int)$row->page_id;
 104                                 }
 105                                 if ( $fld_title ) {
 106                                         $title = Title::makeTitle( $row->page_namespace, $row->page_title );
 107                                         ApiQueryBase::addTitleInfo( $vals, $title );
 108                                 }
 109                                 if ( $fld_value ) {
 110                                         $vals['value'] = $row->pp_value;
 111                                 }
 112                                 $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $vals );
 113                                 if ( !$fit ) {
 114                                         $this->setContinueEnumParameter( 'continue', $row->page_id );
 115                                         break;
 116                                 }
 117                         } else {
 118                                 $resultPageSet->processDbRow( $row );
 119                         }
 120                 }
 121
 122                 if ( $resultPageSet === null ) {
 123                         $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'page' );
 124                 }
 125         }
 126
 127         public function getAllowedParams() {
 128                 return [
 129                         'propname' => [
 130                                 ApiBase::PARAM_TYPE => 'string',
 131                                 ApiBase::PARAM_REQUIRED => true,
 132                         ],
 133                         'prop' => [
 134                                 ApiBase::PARAM_DFLT => 'ids|title',
 135                                 ApiBase::PARAM_ISMULTI => true,
 136                                 ApiBase::PARAM_TYPE => [
 137                                         'ids',
 138                                         'title',
 139                                         'value',
 140                                 ],
 141                                 ApiBase::PARAM_HELP_MSG_PER_VALUE => [],
 142                         ],
 143                         'continue' => [
 144                                 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
 145                         ],
 146                         'limit' => [
 147                                 ApiBase::PARAM_TYPE => 'limit',
 148                                 ApiBase::PARAM_DFLT => 10,
 149                                 ApiBase::PARAM_MIN => 1,
 150                                 ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
 151                                 ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
 152                         ],
 153                         'dir' => [
 154                                 ApiBase::PARAM_DFLT => 'ascending',
 155                                 ApiBase::PARAM_TYPE => [
 156                                         'ascending',
 157                                         'descending',
 158                                 ]
 159                         ],
 160                 ];
 161         }
 162
 163         protected function getExamplesMessages() {
 164                 return [
 165                         'action=query&list=pageswithprop&pwppropname=displaytitle&pwpprop=ids|title|value'
 166                                 => 'apihelp-query+pageswithprop-example-simple',
 167                         'action=query&generator=pageswithprop&gpwppropname=notoc&prop=info'
 168                                 => 'apihelp-query+pageswithprop-example-generator',
 169                 ];
 170         }
 171
 172         public function getHelpUrls() {
 173                 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Pageswithprop';
 174         }
 175 }