includes/api/ApiQueryInfo.php

   1 <?php
   2
   3 /*
   4  * Created on Sep 25, 2006
   5  *
   6  * API for MediaWiki 1.8+
   7  *
   8  * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License along
  21  * with this program; if not, write to the Free Software Foundation, Inc.,
  22  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  23  * http://www.gnu.org/copyleft/gpl.html
  24  */
  25
  26 if (!defined('MEDIAWIKI')) {
  27         // Eclipse helper - will be ignored in production
  28         require_once ('ApiQueryBase.php');
  29 }
  30
  31 /**
  32  * A query module to show basic page information.
  33  *
  34  * @addtogroup API
  35  */
  36 class ApiQueryInfo extends ApiQueryBase {
  37
  38         public function __construct($query, $moduleName) {
  39                 parent :: __construct($query, $moduleName, 'in');
  40         }
  41
  42         public function requestExtraData($pageSet) {
  43                 $pageSet->requestField('page_restrictions');
  44                 $pageSet->requestField('page_is_redirect');
  45                 $pageSet->requestField('page_is_new');
  46                 $pageSet->requestField('page_counter');
  47                 $pageSet->requestField('page_touched');
  48                 $pageSet->requestField('page_latest');
  49                 $pageSet->requestField('page_len');
  50         }
  51
  52         public function execute() {
  53
  54                 global $wgUser;
  55
  56                 $params = $this->extractRequestParams();
  57                 $fld_protection = false;
  58                 if(!is_null($params['prop'])) {
  59                         $prop = array_flip($params['prop']);
  60                         $fld_protection = isset($prop['protection']);
  61                 }
  62                 if(!is_null($params['token'])) {
  63                         $token = $params['token'];
  64                         $tok_edit = $this->getTokenFlag($token, 'edit');
  65                         $tok_delete = $this->getTokenFlag($token, 'delete');
  66                         $tok_protect = $this->getTokenFlag($token, 'protect');
  67                         $tok_move = $this->getTokenFlag($token, 'move');
  68                 }
  69                 else
  70                         // Fix E_NOTICEs about unset variables
  71                         $token = $tok_edit = $tok_delete = $tok_protect = $tok_move = null;
  72
  73                 $pageSet = $this->getPageSet();
  74                 $titles = $pageSet->getGoodTitles();
  75                 $missing = $pageSet->getMissingTitles();
  76                 $result = $this->getResult();
  77
  78                 $pageRestrictions = $pageSet->getCustomField('page_restrictions');
  79                 $pageIsRedir = $pageSet->getCustomField('page_is_redirect');
  80                 $pageIsNew = $pageSet->getCustomField('page_is_new');
  81                 $pageCounter = $pageSet->getCustomField('page_counter');
  82                 $pageTouched = $pageSet->getCustomField('page_touched');
  83                 $pageLatest = $pageSet->getCustomField('page_latest');
  84                 $pageLength = $pageSet->getCustomField('page_len');
  85
  86                 $db = $this->getDB();
  87                 if ($fld_protection && !empty($titles)) {
  88                         $this->addTables('page_restrictions');
  89                         $this->addFields(array('pr_page', 'pr_type', 'pr_level', 'pr_expiry', 'pr_cascade'));
  90                         $this->addWhereFld('pr_page', array_keys($titles));
  91
  92                         $res = $this->select(__METHOD__);
  93                         while($row = $db->fetchObject($res)) {
  94                                 $a = array(
  95                                         'type' => $row->pr_type,
  96                                         'level' => $row->pr_level,
  97                                         'expiry' => Block::decodeExpiry( $row->pr_expiry, TS_ISO_8601 )
  98                                 );
  99                                 if($row->pr_cascade)
 100                                         $a['cascade'] = '';
 101                                 $protections[$row->pr_page][] = $a;
 102                         }
 103                         $db->freeResult($res);
 104                 }
 105                 // We don't need to check for pt stuff if there are no nonexistent titles
 106                 if($fld_protection && !empty($missing))
 107                 {
 108                         $this->resetQueryParams();
 109                         // Construct a custom WHERE clause that matches all titles in $missing
 110                         $lb = new LinkBatch($missing);
 111                         $this->addTables('protected_titles');
 112                         $this->addFields(array('pt_title', 'pt_namespace', 'pt_create_perm', 'pt_expiry'));
 113                         $this->addWhere($lb->constructSet('pt', $db));
 114                         $res = $this->select(__METHOD__);
 115                         $prottitles = array();
 116                         while($row = $db->fetchObject($res)) {
 117                                 $prottitles[$row->pt_namespace][$row->pt_title] = array(
 118                                         'type' => 'create',
 119                                         'level' => $row->pt_create_perm,
 120                                         'expiry' => Block::decodeExpiry($row->pt_expiry, TS_ISO_8601)
 121                                 );
 122                         }
 123                         $db->freeResult($res);
 124                 }
 125
 126                 foreach ( $titles as $pageid => $title ) {
 127                         $pageInfo = array (
 128                                 'touched' => wfTimestamp(TS_ISO_8601, $pageTouched[$pageid]),
 129                                 'lastrevid' => intval($pageLatest[$pageid]),
 130                                 'counter' => intval($pageCounter[$pageid]),
 131                                 'length' => intval($pageLength[$pageid]),
 132                         );
 133
 134                         if ($pageIsRedir[$pageid])
 135                                 $pageInfo['redirect'] = '';
 136
 137                         if ($pageIsNew[$pageid])
 138                                 $pageInfo['new'] = '';
 139
 140                         if (!is_null($token)) {
 141                                 // Currently all tokens are generated the same way, but it might change
 142                                 if ($tok_edit)
 143                                         $pageInfo['edittoken'] = $wgUser->editToken();
 144                                 if ($tok_delete)
 145                                         $pageInfo['deletetoken'] = $wgUser->editToken();
 146                                 if ($tok_protect)
 147                                         $pageInfo['protecttoken'] = $wgUser->editToken();
 148                                 if ($tok_move)
 149                                         $pageInfo['movetoken'] = $wgUser->editToken();
 150                         }
 151
 152                         if($fld_protection) {
 153                                 if (isset($protections[$pageid])) {
 154                                         $pageInfo['protection'] = $protections[$pageid];
 155                                         $result->setIndexedTagName($pageInfo['protection'], 'pr');
 156                                 } else {
 157                                         # Also check old restrictions
 158                                         if( $pageRestrictions[$pageid] ) {
 159                                                 foreach( explode( ':', trim( $pageRestrictions[$pageid] ) ) as $restrict ) {
 160                                                         $temp = explode( '=', trim( $restrict ) );
 161                                                         if(count($temp) == 1) {
 162                                                                 // old old format should be treated as edit/move restriction
 163                                                                 $restriction = trim( $temp[0] );
 164                                                                 $pageInfo['protection'][] = array(
 165                                                                         'type' => 'edit',
 166                                                                         'level' => $restriction,
 167                                                                         'expiry' => 'infinity',
 168                                                                 );
 169                                                                 $pageInfo['protection'][] = array(
 170                                                                         'type' => 'move',
 171                                                                         'level' => $restriction,
 172                                                                         'expiry' => 'infinity',
 173                                                                 );
 174                                                         } else {
 175                                                                 $restriction = trim( $temp[1] );
 176                                                                 $pageInfo['protection'][] = array(
 177                                                                         'type' => $temp[0],
 178                                                                         'level' => $restriction,
 179                                                                         'expiry' => 'infinity',
 180                                                                 );
 181                                                         }
 182                                                 }
 183                                                 $result->setIndexedTagName($pageInfo['protection'], 'pr');
 184                                         } else {
 185                                                 $pageInfo['protection'] = array();
 186                                         }
 187                                 }
 188                         }
 189
 190                         $result->addValue(array (
 191                                 'query',
 192                                 'pages'
 193                         ), $pageid, $pageInfo);
 194                 }
 195
 196                 // Get edit/protect tokens and protection data for missing titles if requested
 197                 // Delete and move tokens are N/A for missing titles anyway
 198                 if($tok_edit || $tok_protect || $fld_protection)
 199                 {
 200                         $res = &$result->getData();
 201                         foreach($missing as $pageid => $title) {
 202                                 if($tok_edit)
 203                                         $res['query']['pages'][$pageid]['edittoken'] = $wgUser->editToken();
 204                                 if($tok_protect)
 205                                         $res['query']['pages'][$pageid]['protecttoken'] = $wgUser->editToken();
 206                                 if($fld_protection)
 207                                 {
 208                                         // Apparently the XML formatting code doesn't like array(null)
 209                                         // This is painful to fix, so we'll just work around it
 210                                         if(isset($prottitles[$title->getNamespace()][$title->getDBkey()]))
 211                                                 $res['query']['pages'][$pageid]['protection'][] = $prottitles[$title->getNamespace()][$title->getDBkey()];
 212                                         else
 213                                                 $res['query']['pages'][$pageid]['protection'] = array();
 214                                         $result->setIndexedTagName($res['query']['pages'][$pageid]['protection'], 'pr');
 215                                 }
 216                         }
 217                 }
 218         }
 219
 220         protected function getAllowedParams() {
 221                 return array (
 222                         'prop' => array (
 223                                 ApiBase :: PARAM_DFLT => NULL,
 224                                 ApiBase :: PARAM_ISMULTI => true,
 225                                 ApiBase :: PARAM_TYPE => array (
 226                                         'protection'
 227                                 )),
 228                         'token' => array (
 229                                 ApiBase :: PARAM_DFLT => NULL,
 230                                 ApiBase :: PARAM_ISMULTI => true,
 231                                 ApiBase :: PARAM_TYPE => array (
 232                                         'edit',
 233                                         'delete',
 234                                         'protect',
 235                                         'move',
 236                                 )),
 237                 );
 238         }
 239
 240         protected function getParamDescription() {
 241                 return array (
 242                         'prop' => array (
 243                                 'Which additional properties to get:',
 244                                 ' "protection"   - List the protection level of each page'
 245                         ),
 246                         'token' => 'Request a token to perform a data-modifying action on a page',
 247                 );
 248         }
 249
 250
 251         protected function getDescription() {
 252                 return 'Get basic page information such as namespace, title, last touched date, ...';
 253         }
 254
 255         protected function getExamples() {
 256                 return array (
 257                         'api.php?action=query&prop=info&titles=Main%20Page',
 258                         'api.php?action=query&prop=info&inprop=protection&titles=Main%20Page'
 259                 );
 260         }
 261
 262         public function getVersion() {
 263                 return __CLASS__ . ': $Id$';
 264         }
 265 }
 266