MergeItems::factory() - Code Metrics - wikimedia/mediawiki-extensions-Wikibase - Measure and Improve Code Quality continuously with Scrutinizer

MergeItems::factory() A
last analyzed 2020-11-13 17:34 UTC

↳ Parent: MergeItems

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	15
rs	9.7666
c	0
b	0
f	0
cc	1
nc	1
nop	2

<?php

declare( strict_types = 1 );

namespace Wikibase\Repo\Api;

use ApiBase;
use ApiMain;
use ApiUsageException;
use Exception;
use InvalidArgumentException;
use LogicException;
use Wikibase\DataModel\Entity\EntityIdParser;
use Wikibase\DataModel\Entity\EntityIdParsingException;
use Wikibase\DataModel\Entity\ItemId;
use Wikibase\Lib\Store\EntityRevision;
use Wikibase\Repo\ChangeOp\ChangeOpsMerge;
use Wikibase\Repo\Interactors\ItemMergeException;
use Wikibase\Repo\Interactors\ItemMergeInteractor;
use Wikibase\Repo\Interactors\RedirectCreationException;
use Wikibase\Repo\WikibaseRepo;

/**
 * @license GPL-2.0-or-later
 * @author Addshore
 * @author Daniel Kinzler
 * @author Lucie-Aimée Kaffee
 */
class MergeItems extends ApiBase {

	/**
	 * @var EntityIdParser
	 */
	private $idParser;

	/**
	 * @var ApiErrorReporter
	 */
	private $errorReporter;

	/**
	 * @var ItemMergeInteractor
	 */
	private $interactor;

	/**
	 * @var ResultBuilder
	 */
	private $resultBuilder;

	/**
	 * @see ApiBase::__construct
	 *
	 * @param ApiMain $mainModule
	 * @param string $moduleName
	 * @param EntityIdParser $idParser
	 * @param ItemMergeInteractor $interactor
	 * @param ApiErrorReporter $errorReporter
	 * @param callable $resultBuilderInstantiator
	 */
	public function __construct(
		ApiMain $mainModule,
		string $moduleName,
		EntityIdParser $idParser,
		ItemMergeInteractor $interactor,
		ApiErrorReporter $errorReporter,
		callable $resultBuilderInstantiator
	) {
		parent::__construct( $mainModule, $moduleName );

		$this->idParser = $idParser;
		$this->interactor = $interactor;

		$this->errorReporter = $errorReporter;
		$this->resultBuilder = $resultBuilderInstantiator( $this );
	}

	public static function factory( ApiMain $mainModule, string $moduleName ): self {
		$wikibaseRepo = WikibaseRepo::getDefaultInstance();
		$apiHelperFactory = $wikibaseRepo->getApiHelperFactory( $mainModule->getContext() );

		return new self(
			$mainModule,
			$moduleName,
			$wikibaseRepo->getEntityIdParser(),
			$wikibaseRepo->newItemMergeInteractor( $mainModule->getContext() ),
			$apiHelperFactory->getErrorReporter( $mainModule ),
			function ( $module ) use ( $apiHelperFactory ) {
				return $apiHelperFactory->getResultBuilder( $module );
			}
		);
	}

	/**
	 * @param array $parameters
	 * @param string $name
	 *
	 * @return ItemId
	 * @throws ApiUsageException if the given parameter is not a valid ItemId
	 * @throws LogicException
	 */
	private function getItemIdParam( array $parameters, string $name ): ItemId {
		if ( !isset( $parameters[$name] ) ) {
			$this->errorReporter->dieWithError( [ 'param-missing', $name ], 'param-missing' );
		}

		$value = $parameters[$name];

		try {
			return new ItemId( $value );
		} catch ( InvalidArgumentException $ex ) {
			$this->errorReporter->dieError( $ex->getMessage(), 'invalid-entity-id' );

			throw new LogicException( 'ApiErrorReporter::dieError did not throw an exception' );
		}
	}

	/**
	 * @inheritDoc
	 */
	public function execute(): void {
		$params = $this->extractRequestParams();

		try {
			$fromId = $this->getItemIdParam( $params, 'fromid' );
			$toId = $this->getItemIdParam( $params, 'toid' );

			$ignoreConflicts = $params['ignoreconflicts'];
			$summary = $params['summary'];

			if ( $ignoreConflicts === null ) {
				$ignoreConflicts = [];
			}

			$this->mergeItems( $fromId, $toId, $ignoreConflicts, $summary, $params['bot'] );
		} catch ( EntityIdParsingException $ex ) {
			$this->errorReporter->dieException( $ex, 'invalid-entity-id' );
		} catch ( ItemMergeException $ex ) {
			$this->handleException( $ex, $ex->getErrorCode() );
		} catch ( RedirectCreationException $ex ) {
			$this->handleException( $ex, $ex->getErrorCode() );
		}
	}

	/**
	 * @param ItemId $fromId
	 * @param ItemId $toId
	 * @param string[] $ignoreConflicts
	 * @param string|null $summary
	 * @param bool $bot
	 * @throws ItemMergeException
	 * @throws RedirectCreationException
	 */
	private function mergeItems( ItemId $fromId, ItemId $toId, array $ignoreConflicts, ?string $summary, bool $bot ): void {
		list( $newRevisionFrom, $newRevisionTo, $redirected )
			= $this->interactor->mergeItems( $fromId, $toId, $ignoreConflicts, $summary, $bot );

		$this->resultBuilder->setValue( null, 'success', 1 );
		$this->resultBuilder->setValue( null, 'redirected', (int)$redirected );

		$this->addEntityToOutput( $newRevisionFrom, 'from' );
		$this->addEntityToOutput( $newRevisionTo, 'to' );
	}

	/**
	 * @param Exception $ex
	 * @param string $errorCode
	 * @param string[] $extraData
	 *
	 * @throws ApiUsageException always
	 */
	private function handleException( Exception $ex, string $errorCode, array $extraData = [] ): void {
		$cause = $ex->getPrevious();

		if ( $cause ) {
			$extraData[] = $ex->getMessage();
			$this->handleException( $cause, $errorCode, $extraData );
		} else {
			$this->errorReporter->dieException( $ex, $errorCode, 0, [ 'extradata' => $extraData ] );
		}
	}

	private function addEntityToOutput( EntityRevision $entityRevision, string $name ): void {
		$entityId = $entityRevision->getEntity()->getId();
		$revisionId = $entityRevision->getRevisionId();

		$this->resultBuilder->addBasicEntityInformation( $entityId, $name );
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}

		$this->resultBuilder->setValue(
			$name,
			'lastrevid',
			(int)$revisionId
		);
	}

	/**
	 * @see ApiBase::needsToken
	 *
	 * @return string
	 */
	public function needsToken(): string {
		return 'csrf';
	}

	/**
	 * @inheritDoc
	 */
	protected function getAllowedParams(): array {
		return [
			'fromid' => [
				self::PARAM_TYPE => 'string',
				self::PARAM_REQUIRED => true,
			],
			'toid' => [
				self::PARAM_TYPE => 'string',
				self::PARAM_REQUIRED => true,
			],
			'ignoreconflicts' => [
				self::PARAM_ISMULTI => true,
				self::PARAM_TYPE => ChangeOpsMerge::$conflictTypes,
				self::PARAM_REQUIRED => false,
			],
			'summary' => [
				self::PARAM_TYPE => 'string',
			],
			'bot' => [
				self::PARAM_TYPE => 'boolean',
				self::PARAM_DFLT => false,
			],
			'token' => [
				self::PARAM_TYPE => 'string',
				self::PARAM_REQUIRED => true,
			]
		];
	}

	/**
	 * @inheritDoc
	 */
	protected function getExamplesMessages(): array {
		return [
			'action=wbmergeitems&fromid=Q42&toid=Q222' =>
				'apihelp-wbmergeitems-example-1',
			'action=wbmergeitems&fromid=Q555&toid=Q3' =>
				'apihelp-wbmergeitems-example-2',
			'action=wbmergeitems&fromid=Q66&toid=Q99&ignoreconflicts=sitelink' =>
				'apihelp-wbmergeitems-example-3',
			'action=wbmergeitems&fromid=Q66&toid=Q99&ignoreconflicts=sitelink|description' =>
				'apihelp-wbmergeitems-example-4',
		];
	}

	/**
	 * @see ApiBase::isWriteMode
	 *
	 * @return bool Always true.
	 */
	public function isWriteMode(): bool {
		return true;
	}

}


1			<?php
2
3			declare( strict_types = 1 );
4
5			namespace Wikibase\Repo\Api;
6
7			use ApiBase;
8			use ApiMain;
9			use ApiUsageException;
10			use Exception;
11			use InvalidArgumentException;
12			use LogicException;
13			use Wikibase\DataModel\Entity\EntityIdParser;
14			use Wikibase\DataModel\Entity\EntityIdParsingException;
15			use Wikibase\DataModel\Entity\ItemId;
16			use Wikibase\Lib\Store\EntityRevision;
17			use Wikibase\Repo\ChangeOp\ChangeOpsMerge;
18			use Wikibase\Repo\Interactors\ItemMergeException;
19			use Wikibase\Repo\Interactors\ItemMergeInteractor;
20			use Wikibase\Repo\Interactors\RedirectCreationException;
21			use Wikibase\Repo\WikibaseRepo;
22
23			/**
24			* @license GPL-2.0-or-later
25			* @author Addshore
26			* @author Daniel Kinzler
27			* @author Lucie-Aimée Kaffee
28			*/
29			class MergeItems extends ApiBase {
30
31			/**
32			* @var EntityIdParser
33			*/
34			private $idParser;
35
36			/**
37			* @var ApiErrorReporter
38			*/
39			private $errorReporter;
40
41			/**
42			* @var ItemMergeInteractor
43			*/
44			private $interactor;
45
46			/**
47			* @var ResultBuilder
48			*/
49			private $resultBuilder;
50
51			/**
52			* @see ApiBase::__construct
53			*
54			* @param ApiMain $mainModule
55			* @param string $moduleName
56			* @param EntityIdParser $idParser
57			* @param ItemMergeInteractor $interactor
58			* @param ApiErrorReporter $errorReporter
59			* @param callable $resultBuilderInstantiator
60			*/
61			public function __construct(
62			ApiMain $mainModule,
63			string $moduleName,
64			EntityIdParser $idParser,
65			ItemMergeInteractor $interactor,
66			ApiErrorReporter $errorReporter,
67			callable $resultBuilderInstantiator
68			) {
69			parent::__construct( $mainModule, $moduleName );
70
71			$this->idParser = $idParser;
72			$this->interactor = $interactor;
73
74			$this->errorReporter = $errorReporter;
75			$this->resultBuilder = $resultBuilderInstantiator( $this );
76			}
77
78			public static function factory( ApiMain $mainModule, string $moduleName ): self {
79			$wikibaseRepo = WikibaseRepo::getDefaultInstance();
80			$apiHelperFactory = $wikibaseRepo->getApiHelperFactory( $mainModule->getContext() );
81
82			return new self(
83			$mainModule,
84			$moduleName,
85			$wikibaseRepo->getEntityIdParser(),
86			$wikibaseRepo->newItemMergeInteractor( $mainModule->getContext() ),
87			$apiHelperFactory->getErrorReporter( $mainModule ),
88			function ( $module ) use ( $apiHelperFactory ) {
89			return $apiHelperFactory->getResultBuilder( $module );
90			}
91			);
92			}
93
94			/**
95			* @param array $parameters
96			* @param string $name
97			*
98			* @return ItemId
99			* @throws ApiUsageException if the given parameter is not a valid ItemId
100			* @throws LogicException
101			*/
102			private function getItemIdParam( array $parameters, string $name ): ItemId {
103			if ( !isset( $parameters[$name] ) ) {
104			$this->errorReporter->dieWithError( [ 'param-missing', $name ], 'param-missing' );
105			}
106
107			$value = $parameters[$name];
108
109			try {
110			return new ItemId( $value );
111			} catch ( InvalidArgumentException $ex ) {
112			$this->errorReporter->dieError( $ex->getMessage(), 'invalid-entity-id' );
			0 ignored issues – show Deprecated Code introduced 2019-12-03 12:42 UTC by Report Bug Copy Issue Report The method `Wikibase\Repo\Api\ApiErrorReporter::dieError()` has been deprecated with message: Use dieWithError() instead. This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
113			throw new LogicException( 'ApiErrorReporter::dieError did not throw an exception' );
114			}
115			}
116
117			/**
118			* @inheritDoc
119			*/
120			public function execute(): void {
121			$params = $this->extractRequestParams();
122
123			try {
124			$fromId = $this->getItemIdParam( $params, 'fromid' );
125			$toId = $this->getItemIdParam( $params, 'toid' );
126
127			$ignoreConflicts = $params['ignoreconflicts'];
128			$summary = $params['summary'];
129
130			if ( $ignoreConflicts === null ) {
131			$ignoreConflicts = [];
132			}
133
134			$this->mergeItems( $fromId, $toId, $ignoreConflicts, $summary, $params['bot'] );
135			} catch ( EntityIdParsingException $ex ) {
136			$this->errorReporter->dieException( $ex, 'invalid-entity-id' );
137			} catch ( ItemMergeException $ex ) {
138			$this->handleException( $ex, $ex->getErrorCode() );
139			} catch ( RedirectCreationException $ex ) {
140			$this->handleException( $ex, $ex->getErrorCode() );
141			}
142			}
143
144			/**
145			* @param ItemId $fromId
146			* @param ItemId $toId
147			* @param string[] $ignoreConflicts
148			* @param string\|null $summary
149			* @param bool $bot
150			* @throws ItemMergeException
151			* @throws RedirectCreationException
152			*/
153			private function mergeItems( ItemId $fromId, ItemId $toId, array $ignoreConflicts, ?string $summary, bool $bot ): void {
154			list( $newRevisionFrom, $newRevisionTo, $redirected )
155			= $this->interactor->mergeItems( $fromId, $toId, $ignoreConflicts, $summary, $bot );
156
157			$this->resultBuilder->setValue( null, 'success', 1 );
158			$this->resultBuilder->setValue( null, 'redirected', (int)$redirected );
159
160			$this->addEntityToOutput( $newRevisionFrom, 'from' );
161			$this->addEntityToOutput( $newRevisionTo, 'to' );
162			}
163
164			/**
165			* @param Exception $ex
166			* @param string $errorCode
167			* @param string[] $extraData
168			*
169			* @throws ApiUsageException always
170			*/
171			private function handleException( Exception $ex, string $errorCode, array $extraData = [] ): void {
172			$cause = $ex->getPrevious();
173
174			if ( $cause ) {
175			$extraData[] = $ex->getMessage();
176			$this->handleException( $cause, $errorCode, $extraData );
177			} else {
178			$this->errorReporter->dieException( $ex, $errorCode, 0, [ 'extradata' => $extraData ] );
179			}
180			}
181
182			private function addEntityToOutput( EntityRevision $entityRevision, string $name ): void {
183			$entityId = $entityRevision->getEntity()->getId();
184			$revisionId = $entityRevision->getRevisionId();
185
186			$this->resultBuilder->addBasicEntityInformation( $entityId, $name );
			0 ignored issues – show Bug introduced 2016-02-04 16:59 UTC by Report Bug Copy Issue Report It seems like `$entityId` defined by `$entityRevision->getEntity()->getId()` on line `183` can be `null`; however, `Wikibase\Repo\Api\Result...asicEntityInformation()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
187
188			$this->resultBuilder->setValue(
189			$name,
190			'lastrevid',
191			(int)$revisionId
192			);
193			}
194
195			/**
196			* @see ApiBase::needsToken
197			*
198			* @return string
199			*/
200			public function needsToken(): string {
201			return 'csrf';
202			}
203
204			/**
205			* @inheritDoc
206			*/
207			protected function getAllowedParams(): array {
208			return [
209			'fromid' => [
210			self::PARAM_TYPE => 'string',
211			self::PARAM_REQUIRED => true,
212			],
213			'toid' => [
214			self::PARAM_TYPE => 'string',
215			self::PARAM_REQUIRED => true,
216			],
217			'ignoreconflicts' => [
218			self::PARAM_ISMULTI => true,
219			self::PARAM_TYPE => ChangeOpsMerge::$conflictTypes,
220			self::PARAM_REQUIRED => false,
221			],
222			'summary' => [
223			self::PARAM_TYPE => 'string',
224			],
225			'bot' => [
226			self::PARAM_TYPE => 'boolean',
227			self::PARAM_DFLT => false,
228			],
229			'token' => [
230			self::PARAM_TYPE => 'string',
231			self::PARAM_REQUIRED => true,
232			]
233			];
234			}
235
236			/**
237			* @inheritDoc
238			*/
239			protected function getExamplesMessages(): array {
240			return [
241			'action=wbmergeitems&fromid=Q42&toid=Q222' =>
242			'apihelp-wbmergeitems-example-1',
243			'action=wbmergeitems&fromid=Q555&toid=Q3' =>
244			'apihelp-wbmergeitems-example-2',
245			'action=wbmergeitems&fromid=Q66&toid=Q99&ignoreconflicts=sitelink' =>
246			'apihelp-wbmergeitems-example-3',
247			'action=wbmergeitems&fromid=Q66&toid=Q99&ignoreconflicts=sitelink\|description' =>
248			'apihelp-wbmergeitems-example-4',
249			];
250			}
251
252			/**
253			* @see ApiBase::isWriteMode
254			*
255			* @return bool Always true.
256			*/
257			public function isWriteMode(): bool {
258			return true;
259			}
260
261			}
262

wikimedia / mediawiki-extensions-Wikibase

MergeItems::factory() A last analyzed 2020-11-13 17:34 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

MergeItems::factory() A
last analyzed 2020-11-13 17:34 UTC