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 if ( !defined( 'MEDIAWIKI' ) ) {
  28         // Eclipse helper - will be ignored in production
  29         require_once( 'ApiQueryBase.php' );
  30 }
  31
  32 /**
  33  * Query module to get the results of a QueryPage-based special page
  34  *
  35  * @ingroup API
  36  */
  37 class ApiQueryQueryPage extends ApiQueryGeneratorBase {
  38         private $qpMap;
  39
  40         /**
  41          * Some query pages are useless because they're available elsewhere in the API
  42          */
  43         private $uselessQueryPages = array(
  44                 'MIMEsearch', // aiprop=mime
  45                 'LinkSearch', // list=exturlusage
  46                 'FileDuplicateSearch', // prop=duplicatefiles
  47         );
  48
  49         public function __construct( $query, $moduleName ) {
  50                 parent::__construct( $query, $moduleName, 'qp' );
  51                 // We need to do this to make sure $wgQueryPages is set up
  52                 // This SUCKS
  53                 global $IP;
  54                 require_once( "$IP/includes/QueryPage.php" );
  55
  56                 // Build mapping from special page names to QueryPage classes
  57                 global $wgQueryPages;
  58                 $this->qpMap = array();
  59                 foreach ( $wgQueryPages as $page ) {
  60                         if( !in_array( $page[1], $this->uselessQueryPages ) ) {
  61                                 $this->qpMap[$page[1]] = $page[0];
  62                         }
  63                 }
  64         }
  65
  66         public function execute() {
  67                 $this->run();
  68         }
  69
  70         public function executeGenerator( $resultPageSet ) {
  71                 $this->run( $resultPageSet );
  72         }
  73
  74         /**
  75          * @param $resultPageSet ApiPageSet
  76          */
  77         public function run( $resultPageSet = null ) {
  78                 global $wgUser;
  79                 $params = $this->extractRequestParams();
  80                 $result = $this->getResult();
  81
  82                 $qp = new $this->qpMap[$params['page']]();
  83                 if ( !$qp->userCanExecute( $wgUser ) ) {
  84                         $this->dieUsageMsg( 'specialpage-cantexecute' );
  85                 }
  86
  87                 $r = array( 'name' => $params['page'] );
  88                 if ( $qp->isCached() ) {
  89                         if ( !$qp->isCacheable() ) {
  90                                 $r['disabled'] = '';
  91                         } else {
  92                                 $r['cached'] = '';
  93                                 $ts = $qp->getCachedTimestamp();
  94                                 if ( $ts ) {
  95                                         $r['cachedtimestamp'] = wfTimestamp( TS_ISO_8601, $ts );
  96                                 }
  97                         }
  98                 }
  99                 $result->addValue( array( 'query' ), $this->getModuleName(), $r );
 100
 101                 if ( $qp->isCached() && !$qp->isCacheable() ) {
 102                         // Disabled query page, don't run the query
 103                         return;
 104                 }
 105
 106                 $res = $qp->doQuery( $params['limit'] + 1, $params['offset'] );
 107                 $count = 0;
 108                 $titles = array();
 109                 foreach ( $res as $row ) {
 110                         if ( ++$count > $params['limit'] ) {
 111                                 // We've had enough
 112                                 $this->setContinueEnumParameter( 'offset', $params['offset'] + $params['limit'] );
 113                                 break;
 114                         }
 115
 116                         $title = Title::makeTitle( $row->namespace, $row->title );
 117                         if ( is_null( $resultPageSet ) ) {
 118                                 $data = array( 'value' => $row->value );
 119                                 if ( $qp->usesTimestamps() ) {
 120                                         $data['timestamp'] = wfTimestamp( TS_ISO_8601, $row->value );
 121                                 }
 122                                 self::addTitleInfo( $data, $title );
 123
 124                                 foreach ( $row as $field => $value ) {
 125                                         if ( !in_array( $field, array( 'namespace', 'title', 'value', 'qc_type' ) ) ) {
 126                                                 $data['databaseResult'][$field] = $value;
 127                                         }
 128                                 }
 129
 130                                 $fit = $result->addValue( array( 'query', $this->getModuleName(), 'results' ), null, $data );
 131                                 if ( !$fit ) {
 132                                         $this->setContinueEnumParameter( 'offset', $params['offset'] + $count - 1 );
 133                                         break;
 134                                 }
 135                         } else {
 136                                 $titles[] = $title;
 137                         }
 138                 }
 139                 if ( is_null( $resultPageSet ) ) {
 140                         $result->setIndexedTagName_internal( array( 'query', $this->getModuleName(), 'results' ), 'page' );
 141                 } else {
 142                         $resultPageSet->populateFromTitles( $titles );
 143                 }
 144         }
 145
 146         public function getCacheMode( $params ) {
 147                 $qp = new $this->qpMap[$params['page']]();
 148                 if ( $qp->getRestriction() != '' ) {
 149                         return 'private';
 150                 }
 151                 return 'public';
 152         }
 153
 154         public function getAllowedParams() {
 155                 return array(
 156                         'page' => array(
 157                                 ApiBase::PARAM_TYPE => array_keys( $this->qpMap ),
 158                                 ApiBase::PARAM_REQUIRED => true
 159                         ),
 160                         'offset' => 0,
 161                         'limit' => array(
 162                                 ApiBase::PARAM_DFLT => 10,
 163                                 ApiBase::PARAM_TYPE => 'limit',
 164                                 ApiBase::PARAM_MIN => 1,
 165                                 ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
 166                                 ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
 167                         ),
 168                 );
 169         }
 170
 171         public function getParamDescription() {
 172                 return array(
 173                         'page' => 'The name of the special page. Note, this is case sensitive',
 174                         'offset' => 'When more results are available, use this to continue',
 175                         'limit' => 'Number of results to return',
 176                 );
 177         }
 178
 179         public function getDescription() {
 180                 return 'Get a list provided by a QueryPage-based special page';
 181         }
 182
 183         public function getPossibleErrors() {
 184                 return array_merge( parent::getPossibleErrors(), array(
 185                          array( 'specialpage-cantexecute' )
 186                 ) );
 187         }
 188
 189         protected function getExamples() {
 190                 return array(
 191                         'api.php?action=query&list=querypage&qppage=Ancientpages'
 192                 );
 193         }
 194
 195         public function getVersion() {
 196                 return __CLASS__ . ': $Id$';
 197         }
 198 }