includes/api/ApiQueryProtectedTitles.php

   1 <?php
   2 /**
   3  * API for MediaWiki 1.8+
   4  *
   5  * Created on Feb 13, 2009
   6  *
   7  * Copyright © 2009 Roan Kattouw <Firstname>.<Lastname>@home.nl
   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 enumerate all create-protected pages.
  34  *
  35  * @ingroup API
  36  */
  37 class ApiQueryProtectedTitles extends ApiQueryGeneratorBase {
  38
  39         public function __construct( $query, $moduleName ) {
  40                 parent::__construct( $query, $moduleName, 'pt' );
  41         }
  42
  43         public function execute() {
  44                 $this->run();
  45         }
  46
  47         public function executeGenerator( $resultPageSet ) {
  48                 $this->run( $resultPageSet );
  49         }
  50
  51         private function run( $resultPageSet = null ) {
  52                 $params = $this->extractRequestParams();
  53
  54                 $this->addTables( 'protected_titles' );
  55                 $this->addFields( array( 'pt_namespace', 'pt_title', 'pt_timestamp' ) );
  56
  57                 $prop = array_flip( $params['prop'] );
  58                 $this->addFieldsIf( 'pt_user', isset( $prop['user'] ) );
  59                 $this->addFieldsIf( 'pt_reason', isset( $prop['comment'] ) || isset( $prop['parsedcomment'] ) );
  60                 $this->addFieldsIf( 'pt_expiry', isset( $prop['expiry'] ) );
  61                 $this->addFieldsIf( 'pt_create_perm', isset( $prop['level'] ) );
  62
  63                 $this->addWhereRange( 'pt_timestamp', $params['dir'], $params['start'], $params['end'] );
  64                 $this->addWhereFld( 'pt_namespace', $params['namespace'] );
  65                 $this->addWhereFld( 'pt_create_perm', $params['level'] );
  66
  67                 if ( isset( $prop['user'] ) ) {
  68                         $this->addTables( 'user' );
  69                         $this->addFields( 'user_name' );
  70                         $this->addJoinConds( array( 'user' => array( 'LEFT JOIN',
  71                                 'user_id=pt_user'
  72                         ) ) );
  73                 }
  74
  75                 $this->addOption( 'LIMIT', $params['limit'] + 1 );
  76                 $res = $this->select( __METHOD__ );
  77
  78                 $count = 0;
  79                 $result = $this->getResult();
  80                 foreach ( $res as $row ) {
  81                         if ( ++ $count > $params['limit'] ) {
  82                                 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
  83                                 $this->setContinueEnumParameter( 'start', wfTimestamp( TS_ISO_8601, $row->pt_timestamp ) );
  84                                 break;
  85                         }
  86
  87                         $title = Title::makeTitle( $row->pt_namespace, $row->pt_title );
  88                         if ( is_null( $resultPageSet ) ) {
  89                                 $vals = array();
  90                                 ApiQueryBase::addTitleInfo( $vals, $title );
  91                                 if ( isset( $prop['timestamp'] ) ) {
  92                                         $vals['timestamp'] = wfTimestamp( TS_ISO_8601, $row->pt_timestamp );
  93                                 }
  94
  95                                 if ( isset( $prop['user'] ) && !is_null( $row->user_name ) ) {
  96                                         $vals['user'] = $row->user_name;
  97                                 }
  98
  99                                 if ( isset( $prop['comment'] ) ) {
 100                                         $vals['comment'] = $row->pt_reason;
 101                                 }
 102
 103                                 if ( isset( $prop['parsedcomment'] ) ) {
 104                                         global $wgUser;
 105                                         $vals['parsedcomment'] = $wgUser->getSkin()->formatComment( $row->pt_reason, $title );
 106                                 }
 107
 108                                 if ( isset( $prop['expiry'] ) ) {
 109                                         $vals['expiry'] = Block::decodeExpiry( $row->pt_expiry, TS_ISO_8601 );
 110                                 }
 111
 112                                 if ( isset( $prop['level'] ) ) {
 113                                         $vals['level'] = $row->pt_create_perm;
 114                                 }
 115
 116                                 $fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $vals );
 117                                 if ( !$fit ) {
 118                                         $this->setContinueEnumParameter( 'start',
 119                                                 wfTimestamp( TS_ISO_8601, $row->pt_timestamp ) );
 120                                         break;
 121                                 }
 122                         } else {
 123                                 $titles[] = $title;
 124                         }
 125                 }
 126
 127                 if ( is_null( $resultPageSet ) ) {
 128                         $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), $this->getModulePrefix() );
 129                 } else {
 130                         $resultPageSet->populateFromTitles( $titles );
 131                 }
 132         }
 133
 134         public function getCacheMode( $params ) {
 135                 if ( !is_null( $params['prop'] ) && in_array( 'parsedcomment', $params['prop'] ) ) {
 136                         // formatComment() calls wfMsg() among other things
 137                         return 'anon-public-user-private';
 138                 } else {
 139                         return 'public';
 140                 }
 141         }
 142
 143         public function getAllowedParams() {
 144                 global $wgRestrictionLevels;
 145                 return array(
 146                         'namespace' => array(
 147                                 ApiBase::PARAM_ISMULTI => true,
 148                                 ApiBase::PARAM_TYPE => 'namespace',
 149                         ),
 150                         'level' => array(
 151                                 ApiBase::PARAM_ISMULTI => true,
 152                                 ApiBase::PARAM_TYPE => array_diff( $wgRestrictionLevels, array( '' ) )
 153                         ),
 154                         'limit' => array (
 155                                 ApiBase::PARAM_DFLT => 10,
 156                                 ApiBase::PARAM_TYPE => 'limit',
 157                                 ApiBase::PARAM_MIN => 1,
 158                                 ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
 159                                 ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
 160                         ),
 161                         'dir' => array(
 162                                 ApiBase::PARAM_DFLT => 'older',
 163                                 ApiBase::PARAM_TYPE => array(
 164                                         'older',
 165                                         'newer'
 166                                 )
 167                         ),
 168                         'start' => array(
 169                                 ApiBase::PARAM_TYPE => 'timestamp'
 170                         ),
 171                         'end' => array(
 172                                 ApiBase::PARAM_TYPE => 'timestamp'
 173                         ),
 174                         'prop' => array(
 175                                 ApiBase::PARAM_ISMULTI => true,
 176                                 ApiBase::PARAM_DFLT => 'timestamp|level',
 177                                 ApiBase::PARAM_TYPE => array(
 178                                         'timestamp',
 179                                         'user',
 180                                         'comment',
 181                                         'parsedcomment',
 182                                         'expiry',
 183                                         'level'
 184                                 )
 185                         ),
 186                 );
 187         }
 188
 189         public function getParamDescription() {
 190                 return array(
 191                         'namespace' => 'Only list titles in these namespaces',
 192                         'start' => 'Start listing at this protection timestamp',
 193                         'end' => 'Stop listing at this protection timestamp',
 194                         'dir' => 'The direction in which to list',
 195                         'limit' => 'How many total pages to return',
 196                         'prop' => array(
 197                                 'Which properties to get',
 198                                 ' timestamp      - Adds the timestamp of when protection was added',
 199                                 ' user           - Adds the user to add the protection',
 200                                 ' comment        - Adds the comment for the protection',
 201                                 ' parsedcomment  - Adds the parsed comment for the protection',
 202                                 ' expiry         - Adds the timestamp of when the protection will be lifted',
 203                                 ' level          - Adds the protection level',
 204                         ),
 205                         'level' => 'Only list titles with these protection levels',
 206                 );
 207         }
 208
 209         public function getDescription() {
 210                 return 'List all titles protected from creation';
 211         }
 212
 213         protected function getExamples() {
 214                 return array(
 215                         'api.php?action=query&list=protectedtitles',
 216                 );
 217         }
 218
 219         public function getVersion() {
 220                 return __CLASS__ . ': $Id$';
 221         }
 222 }