X-Git-Url: https://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2Fapi%2FApiExpandTemplates.php;h=eb3f87cb56eeb4faf4e85f0a6d8f2a5f041a609e;hb=ecc71fc9e4bac94a879c0734d90ba0b94211d5d3;hp=d5c789c35f0b09d0aa1cdac790710bb7bd6206f7;hpb=b65669ff7adbbde55872a8ddd93214a9e1df75c6;p=lhc%2Fweb%2Fwiklou.git

diff --git a/includes/api/ApiExpandTemplates.php b/includes/api/ApiExpandTemplates.php
index d5c789c35f..eb3f87cb56 100644
--- a/includes/api/ApiExpandTemplates.php
+++ b/includes/api/ApiExpandTemplates.php
@@ -39,6 +39,15 @@ class ApiExpandTemplates extends ApiBase {
 
 		// Get parameters
 		$params = $this->extractRequestParams();
+		$this->requireMaxOneParameter( $params, 'prop', 'generatexml' );
+
+		if ( $params['prop'] === null ) {
+			$this->setWarning( 'Because no values have been specified for the prop parameter, a legacy format has been used for the output.'
+				 . ' This format is deprecated, and in the future, a default value will be set for the prop parameter, causing the new format to always be used.' );
+			$prop = array();
+		} else {
+			$prop = array_flip( $params['prop'] );
+		}
 
 		// Create title for parser
 		$title_obj = Title::newFromText( $params['title'] );
@@ -56,7 +65,9 @@ class ApiExpandTemplates extends ApiBase {
 			$options->setRemoveComments( false );
 		}
 
-		if ( $params['generatexml'] ) {
+		$retval = array();
+
+		if ( isset( $prop['parsetree'] ) || $params['generatexml'] ) {
 			$wgParser->startExternalParse( $title_obj, $options, OT_PREPROCESS );
 			$dom = $wgParser->preprocessToDom( $params['text'] );
 			if ( is_callable( array( $dom, 'saveXML' ) ) ) {
@@ -64,16 +75,53 @@ class ApiExpandTemplates extends ApiBase {
 			} else {
 				$xml = $dom->__toString();
 			}
-			$xml_result = array();
-			ApiResult::setContent( $xml_result, $xml );
-			$result->addValue( null, 'parsetree', $xml_result );
+			if ( isset( $prop['parsetree'] ) ) {
+				unset( $prop['parsetree'] );
+				$retval['parsetree'] = $xml;
+			} else {
+				// the old way
+				$xml_result = array();
+				ApiResult::setContent( $xml_result, $xml );
+				$result->addValue( null, 'parsetree', $xml_result );
+			}
 		}
-		$retval = $wgParser->preprocess( $params['text'], $title_obj, $options );
 
-		// Return result
-		$retval_array = array();
-		ApiResult::setContent( $retval_array, $retval );
-		$result->addValue( null, $this->getModuleName(), $retval_array );
+		// if they didn't want any output except (probably) the parse tree,
+		// then don't bother actually fully expanding it
+		if ( $prop || $params['prop'] === null ) {
+			$frame = $wgParser->getPreprocessor()->newFrame();
+			$wikitext = $wgParser->preprocess( $params['text'], $title_obj, $options, null, $frame );
+			if ( $params['prop'] === null ) {
+				// the old way
+				ApiResult::setContent( $retval, $wikitext );
+			} else {
+				if ( isset( $prop['categories'] ) ) {
+					$categories = $wgParser->getOutput()->getCategories();
+					if ( !empty( $categories ) ) {
+						$categories_result = array();
+						foreach ( $categories as $category => $sortkey ) {
+							$entry = array();
+							$entry['sortkey'] = $sortkey;
+							ApiResult::setContent( $entry, $category );
+							$categories_result[] = $entry;
+						}
+						$result->setIndexedTagName( $categories_result, 'category' );
+						$retval['categories'] = $categories_result;
+					}
+				}
+				if ( isset( $prop['volatile'] ) && $frame->isVolatile() ) {
+					$retval['volatile'] = '';
+				}
+				if ( isset( $prop['ttl'] ) && $frame->getTTL() !== null ) {
+					$retval['ttl'] = $frame->getTTL();
+				}
+				if ( isset( $prop['wikitext'] ) ) {
+					$retval['wikitext'] = $wikitext;
+				}
+			}
+		}
+		$result->setSubelements( $retval, array( 'wikitext', 'parsetree' ) );
+		$result->addValue( null, $this->getModuleName(), $retval );
 	}
 
 	public function getAllowedParams() {
@@ -85,8 +133,21 @@ class ApiExpandTemplates extends ApiBase {
 				ApiBase::PARAM_TYPE => 'string',
 				ApiBase::PARAM_REQUIRED => true,
 			),
-			'generatexml' => false,
+			'prop' => array(
+				ApiBase::PARAM_TYPE => array(
+					'wikitext',
+					'categories',
+					'volatile',
+					'ttl',
+					'parsetree',
+				),
+				ApiBase::PARAM_ISMULTI => true,
+			),
 			'includecomments' => false,
+			'generatexml' => array(
+				ApiBase::PARAM_TYPE => 'boolean',
+				ApiBase::PARAM_DEPRECATED => true,
+			),
 		);
 	}
 
@@ -94,21 +155,52 @@ class ApiExpandTemplates extends ApiBase {
 		return array(
 			'text' => 'Wikitext to convert',
 			'title' => 'Title of page',
-			'generatexml' => 'Generate XML parse tree',
+			'prop' => array(
+				'Which pieces of information to get',
+				' wikitext   - The expanded wikitext',
+				' categories - Any categories present in the input that are not represented in the wikitext output',
+				' volatile   - Whether the output is volatile and should not be reused elsewhere within the page',
+				' ttl        - The maximum time after which caches of the result should be invalidated',
+				' parsetree  - The XML parse tree of the input',
+				'Note that if no values are selected, the result will contain the wikitext,',
+				'but the output will be in a deprecated format.',
+			),
 			'includecomments' => 'Whether to include HTML comments in the output',
+			'generatexml' => 'Generate XML parse tree (replaced by prop=parsetree)',
 		);
 	}
 
 	public function getResultProperties() {
 		return array(
-			'' => array(
-				'*' => 'string'
-			)
+			'wikitext' => array(
+				'wikitext' => 'string',
+			),
+			'categories' => array(
+				'categories' => array(
+					ApiBase::PROP_TYPE => 'array',
+					ApiBase::PROP_NULLABLE => true,
+				),
+			),
+			'volatile' => array(
+				'volatile' => array(
+					ApiBase::PROP_TYPE => 'boolean',
+					ApiBase::PROP_NULLABLE => true,
+				),
+			),
+			'ttl' => array(
+				'ttl' => array(
+					ApiBase::PROP_TYPE => 'integer',
+					ApiBase::PROP_NULLABLE => true,
+				),
+			),
+			'parsetree' => array(
+				'parsetree' => 'string',
+			),
 		);
 	}
 
 	public function getDescription() {
-		return 'Expands all templates in wikitext';
+		return 'Expands all templates in wikitext.';
 	}
 
 	public function getPossibleErrors() {