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

SpecialSetAliases::getValue() A
last analyzed 2020-11-13 17:34 UTC

↳ Parent: SpecialSetAliases

Complexity

Conditions	3
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	10
rs	9.9332
c	0
b	0
f	0
cc	3
nc	3
nop	2

<?php

namespace Wikibase\Repo\Specials;

use InvalidArgumentException;
use MediaWiki\Logger\LoggerFactory;
use Wikibase\DataModel\Entity\EntityDocument;
use Wikibase\DataModel\Term\AliasesProvider;
use Wikibase\Lib\Store\EntityTitleLookup;
use Wikibase\Lib\Summary;
use Wikibase\Lib\UserInputException;
use Wikibase\Repo\ChangeOp\ChangeOps;
use Wikibase\Repo\CopyrightMessageBuilder;
use Wikibase\Repo\EditEntity\MediawikiEditEntityFactory;
use Wikibase\Repo\Store\EntityPermissionChecker;
use Wikibase\Repo\SummaryFormatter;
use Wikibase\Repo\WikibaseRepo;

/**
 * Special page for setting the aliases of a Wikibase entity.
 *
 * @license GPL-2.0-or-later
 * @author Bene* < [email protected] >
 */
class SpecialSetAliases extends SpecialModifyTerm {


	public function __construct(
		SpecialPageCopyrightView $copyrightView,
		SummaryFormatter $summaryFormatter,
		EntityTitleLookup $entityTitleLookup,
		MediawikiEditEntityFactory $editEntityFactory,
		EntityPermissionChecker $entityPermissionChecker
	) {
		parent::__construct(
			'SetAliases',
			$copyrightView,
			$summaryFormatter,
			$entityTitleLookup,
			$editEntityFactory,
			$entityPermissionChecker
		);
	}

	public static function factory(): self {
		$wikibaseRepo = WikibaseRepo::getDefaultInstance();

		$settings = $wikibaseRepo->getSettings();
		$copyrightView = new SpecialPageCopyrightView(
			new CopyrightMessageBuilder(),
			$settings->getSetting( 'dataRightsUrl' ),
			$settings->getSetting( 'dataRightsText' )
		);

		return new self(
			$copyrightView,
			$wikibaseRepo->getSummaryFormatter(),
			$wikibaseRepo->getEntityTitleLookup(),
			$wikibaseRepo->newEditEntityFactory(),
			$wikibaseRepo->getEntityPermissionChecker()
		);
	}

	public function doesWrites() {
		return true;
	}

	/**
	 * @see SpecialModifyTerm::validateInput
	 *
	 * @return bool
	 */
	protected function validateInput() {
		if ( !parent::validateInput() ) {
			return false;
		}

		return $this->getBaseRevision()->getEntity() instanceof AliasesProvider;
	}

	/**
	 * @see SpecialModifyTerm::getPostedValue()
	 *
	 * @return string|null
	 */
	protected function getPostedValue() {
		return $this->getRequest()->getVal( 'aliases' );
	}

	/**
	 * @see SpecialModifyTerm::getValue()
	 *
	 * @param EntityDocument $entity
	 * @param string $languageCode
	 *
	 * @throws InvalidArgumentException
	 * @return string
	 */
	protected function getValue( EntityDocument $entity, $languageCode ) {
		if ( !( $entity instanceof AliasesProvider ) ) {
			throw new InvalidArgumentException( '$entity must be an AliasesProvider' );
		}
		$aliases = $entity->getAliasGroups();
		if ( $aliases->hasGroupForLanguage( $languageCode ) ) {
			return implode( '|', $aliases->getByLanguage( $languageCode )->getAliases() );
		}
		return '';
	}

	/**
	 * @see SpecialModifyTerm::setValue()
	 *
	 * @param EntityDocument $entity
	 * @param string $languageCode
	 * @param string $value
	 *
	 * @throws UserInputException|InvalidArgumentException
	 * @return Summary
	 * @suppress PhanTypeMismatchArgument
	 */
	protected function setValue( EntityDocument $entity, $languageCode, $value ) {
		if ( !( $entity instanceof AliasesProvider ) ) {
			throw new InvalidArgumentException( '$entity must be an AliasesProvider' );
		}

		$summary = new Summary( 'wbsetaliases' );
		if ( $value === '' ) {
			$aliases = $entity->getAliasGroups()->getByLanguage( $languageCode )->getAliases();
			$changeOp = $this->termChangeOpFactory->newRemoveAliasesOp( $languageCode, $aliases );
		} else {
			$this->assertNoPipeCharacterInAliases( $entity, $languageCode );
			$changeOp = $this->termChangeOpFactory->newSetAliasesOp( $languageCode, explode( '|', $value ) );
		}

		$fingerprintChangeOp = $this->termChangeOpFactory->newFingerprintChangeOp( new ChangeOps( [ $changeOp ] ) );

		$this->applyChangeOp( $fingerprintChangeOp, $entity, $summary );

		return $summary;
	}

	/**
	 * Screams and throws an error if any of existing aliases has pipe character
	 *
	 * @param EntityDocument $entity
	 * @param string $languageCode
	 *
	 * @throws UserInputException
	 * @suppress PhanTypeMismatchDeclaredParam Intersection type
	 */
	private function assertNoPipeCharacterInAliases( AliasesProvider $entity, $languageCode ) {
		$aliases = $entity->getAliasGroups();
		if ( !$aliases->hasGroupForLanguage( $languageCode ) ) {
			return;
		}
		$aliasesInLang = $entity->getAliasGroups()->getByLanguage( $languageCode )->getAliases();

		foreach ( $aliasesInLang as $alias ) {
			if ( strpos( $alias, '|' ) !== false ) {
				$logger = LoggerFactory::getInstance( 'Wikibase' );
				$logger->error( 'Special:SetAliases attempt to save pipes in aliases' );
				throw new UserInputException(
					'wikibase-wikibaserepopage-pipe-in-alias',
					[],
					$this->msg( 'wikibase-wikibaserepopage-pipe-in-alias' )->text()
				);
			}
		}
	}

}


1			<?php
2
3			namespace Wikibase\Repo\Specials;
4
5			use InvalidArgumentException;
6			use MediaWiki\Logger\LoggerFactory;
7			use Wikibase\DataModel\Entity\EntityDocument;
8			use Wikibase\DataModel\Term\AliasesProvider;
9			use Wikibase\Lib\Store\EntityTitleLookup;
10			use Wikibase\Lib\Summary;
11			use Wikibase\Lib\UserInputException;
12			use Wikibase\Repo\ChangeOp\ChangeOps;
13			use Wikibase\Repo\CopyrightMessageBuilder;
14			use Wikibase\Repo\EditEntity\MediawikiEditEntityFactory;
15			use Wikibase\Repo\Store\EntityPermissionChecker;
16			use Wikibase\Repo\SummaryFormatter;
17			use Wikibase\Repo\WikibaseRepo;
18
19			/**
20			* Special page for setting the aliases of a Wikibase entity.
21			*
22			* @license GPL-2.0-or-later
23			* @author Bene* < [email protected] >
24			*/
25			class SpecialSetAliases extends SpecialModifyTerm {
			0 ignored issues – show Bug introduced 2020-07-10 14:52 UTC by Report Bug Copy Issue Report There is one abstract method `getName` in this class; you could implement it, or declare this class as abstract. Loading history...
26
27			public function __construct(
28			SpecialPageCopyrightView $copyrightView,
29			SummaryFormatter $summaryFormatter,
30			EntityTitleLookup $entityTitleLookup,
31			MediawikiEditEntityFactory $editEntityFactory,
32			EntityPermissionChecker $entityPermissionChecker
33			) {
34			parent::__construct(
35			'SetAliases',
36			$copyrightView,
37			$summaryFormatter,
38			$entityTitleLookup,
39			$editEntityFactory,
40			$entityPermissionChecker
41			);
42			}
43
44			public static function factory(): self {
45			$wikibaseRepo = WikibaseRepo::getDefaultInstance();
46
47			$settings = $wikibaseRepo->getSettings();
48			$copyrightView = new SpecialPageCopyrightView(
49			new CopyrightMessageBuilder(),
50			$settings->getSetting( 'dataRightsUrl' ),
51			$settings->getSetting( 'dataRightsText' )
52			);
53
54			return new self(
55			$copyrightView,
56			$wikibaseRepo->getSummaryFormatter(),
57			$wikibaseRepo->getEntityTitleLookup(),
58			$wikibaseRepo->newEditEntityFactory(),
59			$wikibaseRepo->getEntityPermissionChecker()
60			);
61			}
62
63			public function doesWrites() {
64			return true;
65			}
66
67			/**
68			* @see SpecialModifyTerm::validateInput
69			*
70			* @return bool
71			*/
72			protected function validateInput() {
73			if ( !parent::validateInput() ) {
74			return false;
75			}
76
77			return $this->getBaseRevision()->getEntity() instanceof AliasesProvider;
78			}
79
80			/**
81			* @see SpecialModifyTerm::getPostedValue()
82			*
83			* @return string\|null
84			*/
85			protected function getPostedValue() {
86			return $this->getRequest()->getVal( 'aliases' );
87			}
88
89			/**
90			* @see SpecialModifyTerm::getValue()
91			*
92			* @param EntityDocument $entity
93			* @param string $languageCode
94			*
95			* @throws InvalidArgumentException
96			* @return string
97			*/
98			protected function getValue( EntityDocument $entity, $languageCode ) {
99			if ( !( $entity instanceof AliasesProvider ) ) {
100			throw new InvalidArgumentException( '$entity must be an AliasesProvider' );
101			}
102			$aliases = $entity->getAliasGroups();
103			if ( $aliases->hasGroupForLanguage( $languageCode ) ) {
104			return implode( '\|', $aliases->getByLanguage( $languageCode )->getAliases() );
105			}
106			return '';
107			}
108
109			/**
110			* @see SpecialModifyTerm::setValue()
111			*
112			* @param EntityDocument $entity
113			* @param string $languageCode
114			* @param string $value
115			*
116			* @throws UserInputException\|InvalidArgumentException
117			* @return Summary
118			* @suppress PhanTypeMismatchArgument
119			*/
120			protected function setValue( EntityDocument $entity, $languageCode, $value ) {
121			if ( !( $entity instanceof AliasesProvider ) ) {
122			throw new InvalidArgumentException( '$entity must be an AliasesProvider' );
123			}
124
125			$summary = new Summary( 'wbsetaliases' );
126			if ( $value === '' ) {
127			$aliases = $entity->getAliasGroups()->getByLanguage( $languageCode )->getAliases();
128			$changeOp = $this->termChangeOpFactory->newRemoveAliasesOp( $languageCode, $aliases );
129			} else {
130			$this->assertNoPipeCharacterInAliases( $entity, $languageCode );
131			$changeOp = $this->termChangeOpFactory->newSetAliasesOp( $languageCode, explode( '\|', $value ) );
132			}
133
134			$fingerprintChangeOp = $this->termChangeOpFactory->newFingerprintChangeOp( new ChangeOps( [ $changeOp ] ) );
135
136			$this->applyChangeOp( $fingerprintChangeOp, $entity, $summary );
137
138			return $summary;
139			}
140
141			/**
142			* Screams and throws an error if any of existing aliases has pipe character
143			*
144			* @param EntityDocument $entity
145			* @param string $languageCode
146			*
147			* @throws UserInputException
148			* @suppress PhanTypeMismatchDeclaredParam Intersection type
149			*/
150			private function assertNoPipeCharacterInAliases( AliasesProvider $entity, $languageCode ) {
151			$aliases = $entity->getAliasGroups();
152			if ( !$aliases->hasGroupForLanguage( $languageCode ) ) {
153			return;
154			}
155			$aliasesInLang = $entity->getAliasGroups()->getByLanguage( $languageCode )->getAliases();
156
157			foreach ( $aliasesInLang as $alias ) {
158			if ( strpos( $alias, '\|' ) !== false ) {
159			$logger = LoggerFactory::getInstance( 'Wikibase' );
160			$logger->error( 'Special:SetAliases attempt to save pipes in aliases' );
161			throw new UserInputException(
162			'wikibase-wikibaserepopage-pipe-in-alias',
163			[],
164			$this->msg( 'wikibase-wikibaserepopage-pipe-in-alias' )->text()
165			);
166			}
167			}
168			}
169
170			}
171

wikimedia / mediawiki-extensions-Wikibase

SpecialSetAliases::getValue() A last analyzed 2020-11-13 17:34 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

SpecialSetAliases::getValue() A
last analyzed 2020-11-13 17:34 UTC