X-Git-Url: https://git.cyclocoop.org/%27.WWW_URL.%27admin/?a=blobdiff_plain;f=includes%2Fapi%2FApiComparePages.php;h=ed72b29bd7261a9d7016a0b5730dc98bc43195a3;hb=2e352de1de5c136d0e79d6a898e8b1bbcf3dd6cb;hp=c5aa0fd79fdad3dde70153d8443c9d90fea1e494;hpb=c6490439d7327dbf86f15b5df172eb9bb2f0d5b6;p=lhc%2Fweb%2Fwiklou.git

diff --git a/includes/api/ApiComparePages.php b/includes/api/ApiComparePages.php
index c5aa0fd79f..ed72b29bd7 100644
--- a/includes/api/ApiComparePages.php
+++ b/includes/api/ApiComparePages.php
@@ -32,10 +32,10 @@ class ApiComparePages extends ApiBase {
 	public function execute() {
 		$params = $this->extractRequestParams();
 
-		$rev1 = $this->revisionOrTitle( $params['fromrev'], $params['fromtitle'] );
-		$rev2 = $this->revisionOrTitle( $params['torev'], $params['totitle'] );
+		$rev1 = $this->revisionOrTitleOrId( $params['fromrev'], $params['fromtitle'], $params['fromid'] );
+		$rev2 = $this->revisionOrTitleOrId( $params['torev'], $params['totitle'], $params['toid'] );
 
-		$de = new DifferenceEngine( null,
+		$de = new DifferenceEngine( $this->getContext(),
 			$rev1,
 			$rev2,
 			null, // rcid
@@ -46,14 +46,26 @@ class ApiComparePages extends ApiBase {
 		if ( isset( $params['fromtitle'] ) ) {
 			$vals['fromtitle'] = $params['fromtitle'];
 		}
+		if ( isset( $params['fromid'] ) ) {
+			$vals['fromid'] = $params['fromid'];
+		}
 		$vals['fromrevid'] = $rev1;
 		if ( isset( $params['totitle'] ) ) {
 			$vals['totitle'] = $params['totitle'];
 		}
+		if ( isset( $params['toid'] ) ) {
+			$vals['toid'] = $params['toid'];
+		}
 		$vals['torevid'] = $rev2;
 
 		$difftext = $de->getDiffBody();
-		ApiResult::setContent( $vals, $difftext );
+
+		if ( $difftext === false ) {
+			$this->dieUsage( 'The diff cannot be retrieved. ' .
+				'Maybe one or both revisions do not exist or you do not have permission to view them.', 'baddiff' );
+		} else {
+			ApiResult::setContent( $vals, $difftext );
+		}
 
 		$this->getResult()->addValue( null, $this->getModuleName(), $vals );
 	}
@@ -61,9 +73,10 @@ class ApiComparePages extends ApiBase {
 	/**
 	 * @param $revision int
 	 * @param $titleText string
+	 * @param $titleId int
 	 * @return int
 	 */
-	private function revisionOrTitle( $revision, $titleText ) {
+	private function revisionOrTitleOrId( $revision, $titleText, $titleId ) {
 		if( $revision ){
 			return $revision;
 		} elseif( $titleText ) {
@@ -72,17 +85,29 @@ class ApiComparePages extends ApiBase {
 				$this->dieUsageMsg( array( 'invalidtitle', $titleText ) );
 			}
 			return $title->getLatestRevID();
+		} elseif ( $titleId ) {
+			$title = Title::newFromID( $titleId );
+			if( !$title ) {
+				$this->dieUsageMsg( array( 'nosuchpageid', $titleId ) );
+			}
+			return $title->getLatestRevID();
 		}
-		$this->dieUsage( 'inputneeded', 'A title or a revision number is needed for both the from and the to parameters' );
+		$this->dieUsage( 'inputneeded', 'A title, a page ID, or a revision number is needed for both the from and the to parameters' );
 	}
 
 	public function getAllowedParams() {
 		return array(
 			'fromtitle' => null,
+			'fromid' => array(
+				ApiBase::PARAM_TYPE => 'integer'
+			),
 			'fromrev' => array(
 				ApiBase::PARAM_TYPE => 'integer'
 			),
 			'totitle' => null,
+			'toid' => array(
+				ApiBase::PARAM_TYPE => 'integer'
+			),
 			'torev' => array(
 				ApiBase::PARAM_TYPE => 'integer'
 			),
@@ -92,15 +117,36 @@ class ApiComparePages extends ApiBase {
 	public function getParamDescription() {
 		return array(
 			'fromtitle' => 'First title to compare',
+			'fromid' => 'First page ID to compare',
 			'fromrev' => 'First revision to compare',
 			'totitle' => 'Second title to compare',
+			'toid' => 'Second page ID to compare',
 			'torev' => 'Second revision to compare',
 		);
 	}
+
+	public function getResultProperties() {
+		return array(
+			'' => array(
+				'fromtitle' => array(
+					ApiBase::PROP_TYPE => 'string',
+					ApiBase::PROP_NULLABLE => true
+				),
+				'fromrevid' => 'integer',
+				'totitle' => array(
+					ApiBase::PROP_TYPE => 'string',
+					ApiBase::PROP_NULLABLE => true
+				),
+				'torevid' => 'integer',
+				'*' => 'string'
+			)
+		);
+	}
+
 	public function getDescription() {
 		return array(
 			'Get the difference between 2 pages',
-			'You must pass a revision number or a page title for each part (1 and 2)'
+			'You must pass a revision number or a page title or a page ID id for each part (1 and 2)'
 		);
 	}
 
@@ -108,12 +154,14 @@ class ApiComparePages extends ApiBase {
 		return array_merge( parent::getPossibleErrors(), array(
 			array( 'code' => 'inputneeded', 'info' => 'A title or a revision is needed' ),
 			array( 'invalidtitle', 'title' ),
+			array( 'nosuchpageid', 'pageid' ),
+			array( 'code' => 'baddiff', 'info' => 'The diff cannot be retrieved. Maybe one or both revisions do not exist or you do not have permission to view them.' ),
 		) );
 	}
 
-	protected function getExamples() {
+	public function getExamples() {
 		return array(
-			'api.php?action=compare&rev1=1&rev2=2',
+			'api.php?action=compare&fromrev=1&torev=2' => 'Create a diff between revision 1 and 2',
 		);
 	}