includes/api/ApiQueryQueryPage.php

   1 <?php
   2 /**
   3  *
   4  *
   5  * Created on Dec 22, 2010
   6  *
   7  * Copyright © 2010 Roan Kattouw <Firstname>.<Lastname>@gmail.com
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with this program; if not, write to the Free Software Foundation, Inc.,
  21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  22  * http://www.gnu.org/copyleft/gpl.html
  23  *
  24  * @file
  25  */
  26
  27 /**
  28  * Query module to get the results of a QueryPage-based special page
  29  *
  30  * @ingroup API
  31  */
  32 class ApiQueryQueryPage extends ApiQueryGeneratorBase {
  33         private $qpMap;
  34
  35         /**
  36          * Some query pages are useless because they're available elsewhere in the API
  37          */
  38         private $uselessQueryPages = array(
  39                 'MIMEsearch', // aiprop=mime
  40                 'LinkSearch', // list=exturlusage
  41                 'FileDuplicateSearch', // prop=duplicatefiles
  42         );
  43
  44         public function __construct( $query, $moduleName ) {
  45                 parent::__construct( $query, $moduleName, 'qp' );
  46                 // We need to do this to make sure $wgQueryPages is set up
  47                 // This SUCKS
  48                 global $IP;
  49                 require_once( "$IP/includes/QueryPage.php" );
  50
  51                 // Build mapping from special page names to QueryPage classes
  52                 global $wgQueryPages;
  53                 $this->qpMap = array();
  54                 foreach ( $wgQueryPages as $page ) {
  55                         if( !in_array( $page[1], $this->uselessQueryPages ) ) {
  56                                 $this->qpMap[$page[1]] = $page[0];
  57                         }
  58                 }
  59         }
  60
  61         public function execute() {
  62                 $this->run();
  63         }
  64
  65         public function executeGenerator( $resultPageSet ) {
  66                 $this->run( $resultPageSet );
  67         }
  68
  69         /**
  70          * @param $resultPageSet ApiPageSet
  71          */
  72         public function run( $resultPageSet = null ) {
  73                 global $wgQueryCacheLimit;
  74
  75                 $params = $this->extractRequestParams();
  76                 $result = $this->getResult();
  77
  78                 $qp = new $this->qpMap[$params['page']]();
  79                 if ( !$qp->userCanExecute( $this->getUser() ) ) {
  80                         $this->dieUsageMsg( 'specialpage-cantexecute' );
  81                 }
  82
  83                 $r = array( 'name' => $params['page'] );
  84                 if ( $qp->isCached() ) {
  85                         if ( !$qp->isCacheable() ) {
  86                                 $r['disabled'] = '';
  87                         } else {
  88                                 $r['cached'] = '';
  89                                 $ts = $qp->getCachedTimestamp();
  90                                 if ( $ts ) {
  91                                         $r['cachedtimestamp'] = wfTimestamp( TS_ISO_8601, $ts );
  92                                 }
  93                                 $r['maxresults'] = $wgQueryCacheLimit;
  94                         }
  95                 }
  96                 $result->addValue( array( 'query' ), $this->getModuleName(), $r );
  97
  98                 if ( $qp->isCached() && !$qp->isCacheable() ) {
  99                         // Disabled query page, don't run the query
 100                         return;
 101                 }
 102
 103                 $res = $qp->doQuery( $params['offset'], $params['limit'] + 1 );
 104                 $count = 0;
 105                 $titles = array();
 106                 foreach ( $res as $row ) {
 107                         if ( ++$count > $params['limit'] ) {
 108                                 // We've had enough
 109                                 $this->setContinueEnumParameter( 'offset', $params['offset'] + $params['limit'] );
 110                                 break;
 111                         }
 112
 113                         $title = Title::makeTitle( $row->namespace, $row->title );
 114                         if ( is_null( $resultPageSet ) ) {
 115                                 $data = array( 'value' => $row->value );
 116                                 if ( $qp->usesTimestamps() ) {
 117                                         $data['timestamp'] = wfTimestamp( TS_ISO_8601, $row->value );
 118                                 }
 119                                 self::addTitleInfo( $data, $title );
 120
 121                                 foreach ( $row as $field => $value ) {
 122                                         if ( !in_array( $field, array( 'namespace', 'title', 'value', 'qc_type' ) ) ) {
 123                                                 $data['databaseResult'][$field] = $value;
 124                                         }
 125                                 }
 126
 127                                 $fit = $result->addValue( array( 'query', $this->getModuleName(), 'results' ), null, $data );
 128                                 if ( !$fit ) {
 129                                         $this->setContinueEnumParameter( 'offset', $params['offset'] + $count - 1 );
 130                                         break;
 131                                 }
 132                         } else {
 133                                 $titles[] = $title;
 134                         }
 135                 }
 136                 if ( is_null( $resultPageSet ) ) {
 137                         $result->setIndexedTagName_internal( array( 'query', $this->getModuleName(), 'results' ), 'page' );
 138                 } else {
 139                         $resultPageSet->populateFromTitles( $titles );
 140                 }
 141         }
 142
 143         public function getCacheMode( $params ) {
 144                 $qp = new $this->qpMap[$params['page']]();
 145                 if ( $qp->getRestriction() != '' ) {
 146                         return 'private';
 147                 }
 148                 return 'public';
 149         }
 150
 151         public function getAllowedParams() {
 152                 return array(
 153                         'page' => array(
 154                                 ApiBase::PARAM_TYPE => array_keys( $this->qpMap ),
 155                                 ApiBase::PARAM_REQUIRED => true
 156                         ),
 157                         'offset' => 0,
 158                         'limit' => array(
 159                                 ApiBase::PARAM_DFLT => 10,
 160                                 ApiBase::PARAM_TYPE => 'limit',
 161                                 ApiBase::PARAM_MIN => 1,
 162                                 ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
 163                                 ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
 164                         ),
 165                 );
 166         }
 167
 168         public function getParamDescription() {
 169                 return array(
 170                         'page' => 'The name of the special page. Note, this is case sensitive',
 171                         'offset' => 'When more results are available, use this to continue',
 172                         'limit' => 'Number of results to return',
 173                 );
 174         }
 175
 176         public function getResultProperties() {
 177                 return array(
 178                         ApiBase::PROP_ROOT => array(
 179                                 'name' => array(
 180                                         ApiBase::PROP_TYPE => 'string',
 181                                         ApiBase::PROP_NULLABLE => false
 182                                 ),
 183                                 'disabled' => array(
 184                                         ApiBase::PROP_TYPE => 'boolean',
 185                                         ApiBase::PROP_NULLABLE => false
 186                                 ),
 187                                 'cached' => array(
 188                                         ApiBase::PROP_TYPE => 'boolean',
 189                                         ApiBase::PROP_NULLABLE => false
 190                                 ),
 191                                 'cachedtimestamp' => array(
 192                                         ApiBase::PROP_TYPE => 'timestamp',
 193                                         ApiBase::PROP_NULLABLE => true
 194                                 )
 195                         ),
 196                         '' => array(
 197                                 'value' => 'string',
 198                                 'timestamp' => array(
 199                                         ApiBase::PROP_TYPE => 'timestamp',
 200                                         ApiBase::PROP_NULLABLE => true
 201                                 ),
 202                                 'ns' => 'namespace',
 203                                 'title' => 'string'
 204                         )
 205                 );
 206         }
 207
 208         public function getDescription() {
 209                 return 'Get a list provided by a QueryPage-based special page';
 210         }
 211
 212         public function getPossibleErrors() {
 213                 return array_merge( parent::getPossibleErrors(), array(
 214                          array( 'specialpage-cantexecute' )
 215                 ) );
 216         }
 217
 218         public function getExamples() {
 219                 return array(
 220                         'api.php?action=query&list=querypage&qppage=Ancientpages'
 221                 );
 222         }
 223
 224         public function getVersion() {
 225                 return __CLASS__ . ': $Id$';
 226         }
 227 }