wikimedia / mediawiki-extensions-Wikibase

repo/includes/Specials/SpecialWikibaseRepoPage.php

<?php

namespace Wikibase\Repo\Specials;

use MWException;
use RuntimeException;
use Status;
use Title;
use Wikibase\DataModel\Entity\EntityDocument;
use Wikibase\DataModel\Entity\EntityId;
use Wikibase\DataModel\Entity\ItemId;
use Wikibase\Lib\FormatableSummary;
use Wikibase\Lib\Store\EntityTitleLookup;
use Wikibase\Lib\UserInputException;
use Wikibase\Repo\EditEntity\EditEntity;
use Wikibase\Repo\EditEntity\MediawikiEditEntityFactory;
use Wikibase\Repo\SummaryFormatter;
use Wikibase\Repo\WikibaseRepo;

/**
 * Abstract base class for special pages of the WikibaseRepo extension.
 *
 * @license GPL-2.0-or-later
 * @author Bene* < benestar.wikimedia@gmail.com >
 */
abstract class SpecialWikibaseRepoPage extends SpecialWikibasePage {

	/**
	 * @var SpecialPageCopyrightView
	 */
	private $copyrightView;

	/**
	 * @var SummaryFormatter
	 */
	protected $summaryFormatter;

	/**
	 * @var EntityTitleLookup
	 */
	private $entityTitleLookup;

	/**
	 * @var MediawikiEditEntityFactory
	 */
	private $editEntityFactory;

	/**
	 * @var EditEntity
	 */
	private $editEntity = null;

	/**
	 * @param string $title The title of the special page
	 * @param string $restriction The required user right
	 * @param SpecialPageCopyrightView $copyrightView
	 * @param SummaryFormatter $summaryFormatter
	 * @param EntityTitleLookup $entityTitleLookup
	 * @param MediawikiEditEntityFactory $editEntityFactory
	 */
	public function __construct(
		$title,
		$restriction,
		SpecialPageCopyrightView $copyrightView,
		SummaryFormatter $summaryFormatter,
		EntityTitleLookup $entityTitleLookup,
		MediawikiEditEntityFactory $editEntityFactory
	) {
		parent::__construct( $title, $restriction );
		$this->copyrightView = $copyrightView;
		$this->summaryFormatter = $summaryFormatter;
		$this->entityTitleLookup = $entityTitleLookup;
		$this->editEntityFactory = $editEntityFactory;
	}

	/**
	 * @param EntityId|null $id
	 * @param int $baseRev
	 * @return EditEntity
	 */
	protected function prepareEditEntity( EntityId $id = null, $baseRev = 0 ) {
		$this->editEntity = $this->editEntityFactory->newEditEntity(
			$this->getUser(),
			$id,
			$baseRev,
			$this->getRequest()->wasPosted()
		);

		return $this->editEntity;
	}

	/**
	 * Returns the EditEntity interactor.
	 *
	 * @note Call only after calling prepareEditEntity() first.
	 *
	 * @return EditEntity
	 */
	protected function getEditEntity() {
		if ( !$this->editEntity ) {
			throw new RuntimeException( 'Call prepareEditEntity() before calling getEditEntity()' );
		}

		return $this->editEntity;
	}

	/**
	 * Parses an entity id.
	 *
	 * @param string $rawId
	 *
	 * @return EntityId
	 * @throws UserInputException
	 */
	protected function parseEntityId( $rawId ) {
		$idParser = WikibaseRepo::getDefaultInstance()->getEntityIdParser();

		try {
			$id = $idParser->parse( $rawId );
		} catch ( RuntimeException $ex ) {
			throw new UserInputException(
				'wikibase-wikibaserepopage-invalid-id',
				[ $rawId ],
				"Entity ID \"$rawId\" is not valid"
			);
		}

		return $id;
	}

	/**
	 * Parses an item id.
	 *
	 * @param string $rawId
	 *
	 * @return ItemId
	 * @throws UserInputException
	 */
	protected function parseItemId( $rawId ) {
		$id = $this->parseEntityId( $rawId );

		if ( !( $id instanceof ItemId ) ) {
			throw new UserInputException(
				'wikibase-wikibaserepopage-not-itemid',
				[ $rawId ],
				"Entity ID \"$rawId\" does not refer to an Item"
			);
		}

		return $id;
	}

	/**
	 * @param EntityId $id
	 *
	 * @throws MWException
	 * @return null|Title
	 */
	protected function getEntityTitle( EntityId $id ) {
		return $this->entityTitleLookup->getTitleForId( $id );
	}

	/**
	 * Saves the entity using the given summary.
	 *
	 * @note Call prepareEditEntity() first.
	 *
	 * @param EntityDocument $entity
	 * @param FormatableSummary $summary
	 * @param string $token
	 * @param int $flags The edit flags (see WikiPage::doEditContent)
	 *
	 * @return Status
	 */
	protected function saveEntity(
		EntityDocument $entity,
		FormatableSummary $summary,
		$token,
		$flags = EDIT_UPDATE
	) {
		$status = $this->getEditEntity()->attemptSave(
			$entity,
			$this->summaryFormatter->formatSummary( $summary ),
			$flags,
			$token
		);

		return $status;
	}

	/**
	 * @param string|null $saveMessageKey Defaults to "wikibase-<special page name>-submit".
	 *
	 * @return string HTML
	 */
	protected function getCopyrightHTML( $saveMessageKey = null ) {
		if ( $saveMessageKey === null ) {
			$saveMessageKey = 'wikibase-' . strtolower( $this->getName() ) . '-submit';

Consider using $this->name. There is an issue with getName() and APC-enabled PHP versions.

		}

		return $this->copyrightView->getHtml( $this->getLanguage(), $saveMessageKey );
	}

}