Merge "Avoid exceptions by first checking language code validity"

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

diff --git a/includes/api/ApiQueryPageProps.php b/includes/api/ApiQueryPageProps.php
index 2b984ba..2de5710 100644 (file)
--- a/includes/api/ApiQueryPageProps.php
+++ b/includes/api/ApiQueryPageProps.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * API for MediaWiki 1.8+
+ *
  *
  * Created on Aug 7, 2010
  *
@@ -24,11 +24,6 @@
  * @file
  */
 
-if ( !defined( 'MEDIAWIKI' ) ) {
-       // Eclipse helper - will be ignored in production
-       require_once( 'ApiQueryBase.php' );
-}
-
 /**
  * A query module to show basic page information.
  *
@@ -36,54 +31,77 @@ if ( !defined( 'MEDIAWIKI' ) ) {
  */
 class ApiQueryPageProps extends ApiQueryBase {
 
-       private $params, $titles, $missing, $everything;
+       private $params;
 
        public function __construct( $query, $moduleName ) {
                parent::__construct( $query, $moduleName, 'pp' );
        }
 
        public function execute() {
-               $this->params = $this->extractRequestParams();
-               
+               # Only operate on existing pages
                $pages = $this->getPageSet()->getGoodTitles();
-               
+               if ( !count( $pages ) ) {
+                       # Nothing to do
+                       return;
+               }
+
+               $this->params = $this->extractRequestParams();
+
                $this->addTables( 'page_props' );
                $this->addFields( array( 'pp_page', 'pp_propname', 'pp_value' ) );
-               $this->addWhereFld( 'pp_page',  array_keys( $pages ) );
-               
+               $this->addWhereFld( 'pp_page', array_keys( $pages ) );
+
                if ( $this->params['continue'] ) {
-                       $this->addWhereFld( 'pp_page >=' . intval( $this->params['continue'] ) );
+                       $this->addWhere( 'pp_page >=' . intval( $this->params['continue'] ) );
+               }
+
+               if ( $this->params['prop'] ) {
+                       $this->addWhereFld( 'pp_propname', $this->params['prop'] );
                }
-               
-               $this->addOption( 'ORDER BY', 'pp_page' );
-               
+
+               # Force a sort order to ensure that properties are grouped by page
+               # But only if pp_page is not constant in the WHERE clause.
+               if ( count( $pages ) > 1 ) {
+                       $this->addOption( 'ORDER BY', 'pp_page' );
+               }
+
                $res = $this->select( __METHOD__ );
-               $currentPage = 0;
+               $currentPage = 0; # Id of the page currently processed
                $props = array();
                $result = $this->getResult();
+
                foreach ( $res as $row ) {
                        if ( $currentPage != $row->pp_page ) {
+                               # Different page than previous row, so add the properties to
+                               # the result and save the new page id
+
                                if ( $currentPage ) {
                                        if ( !$this->addPageProps( $result, $currentPage, $props ) ) {
+                                               # addPageProps() indicated that the result did not fit
+                                               # so stop adding data. Reset props so that it doesn't
+                                               # get added again after loop exit
+
+                                               $props = array();
                                                break;
                                        }
-                                       
+
                                        $props = array();
-                               } else {
-                                       $currentPage = $row->pp_page;
                                }
+
+                               $currentPage = $row->pp_page;
                        }
-                       
+
                        $props[$row->pp_propname] = $row->pp_value;
                }
-               
+
                if ( count( $props ) ) {
+                       # Add any remaining properties to the results
                        $this->addPageProps( $result, $currentPage, $props );
                }
        }
 
        /**
-        * Add page properties to an ApiResult, adding a continue 
+        * Add page properties to an ApiResult, adding a continue
         * parameter if it doesn't fit.
         *
         * @param $result ApiResult
@@ -92,8 +110,8 @@ class ApiQueryPageProps extends ApiQueryBase {
         * @return bool True if it fits in the result
         */
        private function addPageProps( $result, $page, $props ) {
-               $fit = $result->addValue( array( 'query', 'pages' ), $page, $props );
-               
+               $fit = $result->addValue( array( 'query', 'pages', $page ), 'pageprops', $props );
+
                if ( !$fit ) {
                        $this->setContinueEnumParameter( 'continue', $page );
                }
@@ -104,31 +122,33 @@ class ApiQueryPageProps extends ApiQueryBase {
                return 'public';
        }
 
-       public function getAllowedParams() {            
-               return array( 'continue' => null );
+       public function getAllowedParams() {
+               return array(
+                       'continue' => null,
+                       'prop' => array(
+                               ApiBase::PARAM_ISMULTI => true,
+                       ),
+               );
        }
 
        public function getParamDescription() {
-               return  array( 'continue' => 'When more results are available, use this to continue' );
+               return array(
+                       'continue' => 'When more results are available, use this to continue',
+                       'prop' => 'Only list these props. Useful for checking whether a certain page uses a certain page prop',
+               );
        }
 
        public function getDescription() {
                return 'Get various properties defined in the page content';
        }
 
-       public function getPossibleErrors() {
-               return array_merge( parent::getPossibleErrors(), array(
-                       array( 'code' => '_badcontinue', 'info' => 'Invalid continue param. You should pass the original value returned by the previous query' ),
-               ) );
-       }
-
-       protected function getExamples() {
+       public function getExamples() {
                return array(
                        'api.php?action=query&prop=pageprops&titles=Category:Foo',
                );
        }
 
-       public function getVersion() {
-               return __CLASS__ . ': $Id$';
+       public function getHelpUrls() {
+               return 'https://www.mediawiki.org/wiki/API:Properties#pageprops_.2F_pp';
        }
 }