X-Git-Url: https://git.cyclocoop.org/%27.WWW_URL.%27admin/?a=blobdiff_plain;f=includes%2Fapi%2FApiComparePages.php;h=51065273136fdaf8937858435ae55af577e3b83b;hb=a830943203e156c4aa242e0f931c1dac0f00925c;hp=3609262f2b1e6cc23fe9acaa2b47a54f06c949f6;hpb=a5628f573480e84b877d914a4278c89ad7fce9d6;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/api/ApiComparePages.php b/includes/api/ApiComparePages.php index 3609262f2b..5106527313 100644 --- a/includes/api/ApiComparePages.php +++ b/includes/api/ApiComparePages.php @@ -32,10 +32,11 @@ 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, + $contentHandler = ContentHandler::getForModelID( $rev1->getContentModel() ); + $de = $contentHandler->createDifferenceEngine( $this->getContext(), $rev1, $rev2, null, // rcid @@ -46,10 +47,16 @@ 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(); @@ -67,9 +74,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 ) { @@ -78,17 +86,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' ), @@ -98,15 +118,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)' ); } @@ -114,13 +155,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.' ), ) ); } public function getExamples() { return array( - 'api.php?action=compare&fromrev=1&torev=2', + 'api.php?action=compare&fromrev=1&torev=2' => 'Create a diff between revision 1 and 2', ); }