includes/api/ApiQueryPagesWithProp.php

   1 <?php
   2 /**
   3  * Created on December 31, 2012
   4  *
   5  * Copyright © 2012 Brad Jorsch <bjorsch@wikimedia.org>
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with this program; if not, write to the Free Software Foundation, Inc.,
  19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  20  * http://www.gnu.org/copyleft/gpl.html
  21  *
  22  * @file
  23  * @since 1.21
  24  * @author Brad Jorsch
  25  */
  26
  27 /**
  28  * A query module to enumerate pages that use a particular prop
  29  *
  30  * @ingroup API
  31  * @since 1.21
  32  */
  33 class ApiQueryPagesWithProp extends ApiQueryGeneratorBase {
  34
  35         public function __construct( $query, $moduleName ) {
  36                 parent::__construct( $query, $moduleName, 'pwp' );
  37         }
  38
  39         public function execute() {
  40                 $this->run();
  41         }
  42
  43         public function getCacheMode( $params ) {
  44                 return 'public';
  45         }
  46
  47         public function executeGenerator( $resultPageSet ) {
  48                 $this->run( $resultPageSet );
  49         }
  50
  51         /**
  52          * @param $resultPageSet ApiPageSet
  53          * @return void
  54          */
  55         private function run( $resultPageSet = null ) {
  56                 $params = $this->extractRequestParams();
  57
  58                 $prop = array_flip( $params['prop'] );
  59                 $fld_ids = isset( $prop['ids'] );
  60                 $fld_title = isset( $prop['title'] );
  61                 $fld_value = isset( $prop['value'] );
  62
  63                 if ( $resultPageSet === null ) {
  64                         $this->addFields( array( 'page_id' ) );
  65                         $this->addFieldsIf( array( 'page_title', 'page_namespace' ), $fld_title );
  66                         $this->addFieldsIf( 'pp_value', $fld_value );
  67                 } else {
  68                         $this->addFields( $resultPageSet->getPageTableFields() );
  69                 }
  70                 $this->addTables( array( 'page_props', 'page' ) );
  71                 $this->addWhere( 'pp_page=page_id' );
  72                 $this->addWhereFld( 'pp_propname', $params['propname'] );
  73
  74                 $dir = ( $params['dir'] == 'ascending' ) ? 'newer' : 'older';
  75
  76                 if ( $params['continue'] ) {
  77                         $cont = explode( '|', $params['continue'] );
  78                         $this->dieContinueUsageIf( count( $cont ) != 1 );
  79
  80                         // Add a WHERE clause
  81                         $from = (int)$cont[0];
  82                         $this->addWhereRange( 'pp_page', $dir, $from, null );
  83                 }
  84
  85                 $sort = ( $params['dir'] === 'descending' ? ' DESC' : '' );
  86                 $this->addOption( 'ORDER BY', 'pp_page' . $sort );
  87
  88                 $limit = $params['limit'];
  89                 $this->addOption( 'LIMIT', $limit + 1 );
  90
  91                 $result = $this->getResult();
  92                 $count = 0;
  93                 foreach ( $this->select( __METHOD__ ) as $row ) {
  94                         if ( ++$count > $limit ) {
  95                                 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
  96                                 $this->setContinueEnumParameter( 'continue', $row->page_id );
  97                                 break;
  98                         }
  99
 100                         if ( $resultPageSet === null ) {
 101                                 $vals = array();
 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( array( '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->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'page' );
 124                 }
 125         }
 126
 127         public function getAllowedParams() {
 128                 return array(
 129                         'propname' => array(
 130                                 ApiBase::PARAM_TYPE => 'string',
 131                                 ApiBase::PARAM_REQUIRED => true,
 132                         ),
 133                         'prop' => array(
 134                                 ApiBase::PARAM_DFLT => 'ids|title',
 135                                 ApiBase::PARAM_ISMULTI => true,
 136                                 ApiBase::PARAM_TYPE => array(
 137                                         'ids',
 138                                         'title',
 139                                         'value',
 140                                 )
 141                         ),
 142                         'continue' => null,
 143                         'limit' => array(
 144                                 ApiBase::PARAM_TYPE => 'limit',
 145                                 ApiBase::PARAM_DFLT => 10,
 146                                 ApiBase::PARAM_MIN => 1,
 147                                 ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
 148                                 ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
 149                         ),
 150                         'dir' => array(
 151                                 ApiBase::PARAM_DFLT => 'ascending',
 152                                 ApiBase::PARAM_TYPE => array(
 153                                         'ascending',
 154                                         'descending',
 155                                 )
 156                         ),
 157                 );
 158         }
 159
 160         public function getParamDescription() {
 161                 return array(
 162                         'propname' => 'Page prop for which to enumerate pages',
 163                         'prop' => array(
 164                                 'What pieces of information to include',
 165                                 ' ids   - Adds the page ID',
 166                                 ' title - Adds the title and namespace ID of the page',
 167                                 ' value - Adds the value of the page prop',
 168                         ),
 169                         'dir' => 'In which direction to sort',
 170                         'continue' => 'When more results are available, use this to continue',
 171                         'limit' => 'The maximum number of pages to return',
 172                 );
 173         }
 174
 175         public function getDescription() {
 176                 return 'List all pages using a given page prop';
 177         }
 178
 179         public function getExamples() {
 180                 return array(
 181                         'api.php?action=query&list=pageswithprop&pwppropname=displaytitle&pwpprop=ids|title|value' => 'Get first 10 pages using {{DISPLAYTITLE:}}',
 182                         'api.php?action=query&generator=pageswithprop&gpwppropname=notoc&prop=info' => 'Get page info about first 10 pages using __NOTOC__',
 183                 );
 184         }
 185
 186         public function getHelpUrls() {
 187                 return 'https://www.mediawiki.org/wiki/API:Pageswithprop';
 188         }
 189 }