API: Fixing a bug that caused inprop=protection to scream when no

[lhc/web/wiklou.git] / includes / api / ApiQueryInfo.php

diff --git a/includes/api/ApiQueryInfo.php b/includes/api/ApiQueryInfo.php
index baee279..f285c72 100644 (file)
--- a/includes/api/ApiQueryInfo.php
+++ b/includes/api/ApiQueryInfo.php
@@ -1,12 +1,11 @@
 <?php
 
-
 /*
  * Created on Sep 25, 2006
  *
  * API for MediaWiki 1.8+
  *
- * Copyright (C) 2006 Yuri Astrakhan <FirstnameLastname@gmail.com>
+ * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -29,37 +28,86 @@ if (!defined('MEDIAWIKI')) {
        require_once ('ApiQueryBase.php');
 }
 
+/**
+ * A query module to show basic page information.
+ * 
+ * @addtogroup API
+ */
 class ApiQueryInfo extends ApiQueryBase {
 
-       //      private $mParameters;
-
-       public function __construct($query, $moduleName, $generator = false) {
-               parent :: __construct($query, $moduleName, $generator);
+       public function __construct($query, $moduleName) {
+               parent :: __construct($query, $moduleName, 'in');
        }
 
-       public function requestExtraData() {
-               $pageSet = $this->getPageSet();
+       public function requestExtraData($pageSet) {
                $pageSet->requestField('page_is_redirect');
+               $pageSet->requestField('page_is_new');
+               $pageSet->requestField('page_counter');
                $pageSet->requestField('page_touched');
                $pageSet->requestField('page_latest');
+               $pageSet->requestField('page_len');
        }
 
        public function execute() {
 
+               $params = $this->extractRequestParams();
+               $fld_protection = false;
+               if(!is_null($params['prop'])) {
+                       $prop = array_flip($params['prop']);
+                       $fld_protection = isset($prop['protection']);
+               }
+               
                $pageSet = $this->getPageSet();
                $titles = $pageSet->getGoodTitles();
-               $result = & $this->getResult();
+               $result = $this->getResult();
 
                $pageIsRedir = $pageSet->getCustomField('page_is_redirect');
+               $pageIsNew = $pageSet->getCustomField('page_is_new');
+               $pageCounter = $pageSet->getCustomField('page_counter');
                $pageTouched = $pageSet->getCustomField('page_touched');
                $pageLatest = $pageSet->getCustomField('page_latest');
-
-               foreach ($titles as $pageid => $title) {
-                       $pageInfo = array ('touched' => $pageTouched[$pageid], 'lastrevid' => $pageLatest[$pageid]);
+               $pageLength = $pageSet->getCustomField('page_len');
+
+               if ($fld_protection && count($titles) > 0) {
+                       $this->addTables('page_restrictions');
+                       $this->addFields(array('pr_page', 'pr_type', 'pr_level', 'pr_expiry'));
+                       $this->addWhereFld('pr_page', array_keys($titles));
+
+                       $db = $this->getDB();
+                       $res = $this->select(__METHOD__);
+                       while($row = $db->fetchObject($res)) {
+                               $protections[$row->pr_page][] = array(
+                                                               'type' => $row->pr_type,
+                                                               'level' => $row->pr_level,
+                                                               'expiry' => Block::decodeExpiry( $row->pr_expiry, TS_ISO_8601 )
+                                                       );
+                       }
+                       $db->freeResult($res);
+               }
+               
+               foreach ( $titles as $pageid => $unused ) {
+                       $pageInfo = array (
+                               'touched' => wfTimestamp(TS_ISO_8601, $pageTouched[$pageid]),
+                               'lastrevid' => intval($pageLatest[$pageid]),
+                               'counter' => intval($pageCounter[$pageid]),
+                               'length' => intval($pageLength[$pageid]),
+                       );
 
                        if ($pageIsRedir[$pageid])
                                $pageInfo['redirect'] = '';
 
+                       if ($pageIsNew[$pageid])
+                               $pageInfo['new'] = '';
+
+                       if($fld_protection) {
+                               if (isset($protections[$pageid])) {
+                                       $pageInfo['protection'] = $protections[$pageid];
+                                       $result->setIndexedTagName($pageInfo['protection'], 'pr');
+                               } else {
+                                       $pageInfo['protection'] = array();
+                               }
+                       }
+
                        $result->addValue(array (
                                'query',
                                'pages'
@@ -67,13 +115,35 @@ class ApiQueryInfo extends ApiQueryBase {
                }
        }
 
+       protected function getAllowedParams() {
+               return array (
+                       'prop' => array (
+                               ApiBase :: PARAM_DFLT => NULL,
+                               ApiBase :: PARAM_ISMULTI => true,
+                               ApiBase :: PARAM_TYPE => array (
+                                       'protection'
+                               ))
+               );
+       }
+
+       protected function getParamDescription() {
+               return array (
+                       'prop' => array (
+                               'Which additional properties to get:',
+                               ' "protection"   - List the protection level of each page'
+                       )
+               );
+       }
+
+
        protected function getDescription() {
                return 'Get basic page information such as namespace, title, last touched date, ...';
        }
 
        protected function getExamples() {
                return array (
-                       'api.php?action=query&prop=info&titles=Main%20Page'
+                       'api.php?action=query&prop=info&titles=Main%20Page',
+                       'api.php?action=query&prop=info&inprop=protection&titles=Main%20Page'
                );
        }
 
@@ -81,4 +151,4 @@ class ApiQueryInfo extends ApiQueryBase {
                return __CLASS__ . ': $Id$';
        }
 }
-?>
\ No newline at end of file
+