wikimedia/mediawiki-extensions-Wikibase

<?php

namespace Wikibase\Repo\Specials;

use MediaWiki\Html\Html;
use MediaWiki\HTMLForm\HTMLForm;
use MediaWiki\Message\Message;
use MediaWiki\Output\OutputPage;
use MediaWiki\Status\Status;
use UserBlockedError;
use Wikibase\DataModel\Entity\EntityDocument;
use Wikibase\Lib\Store\EntityNamespaceLookup;
use Wikibase\Lib\Store\EntityTitleLookup;
use Wikibase\Lib\Summary;
use Wikibase\Repo\EditEntity\EditEntityStatus;
use Wikibase\Repo\EditEntity\MediaWikiEditEntityFactory;
use Wikibase\Repo\SummaryFormatter;

/**
 * Page for creating new Wikibase entities that contain a Fingerprint.
 *
 * @license GPL-2.0-or-later
 */
abstract class SpecialNewEntity extends SpecialWikibaseRepoPage {

    /**
     * Contains pieces of the subpage name of this special page if a subpage was called.
     * E.g. [ 'a', 'b' ] in case of 'Special:NewEntity/a/b'
     * @var string[]|null
     */
    protected $parts = null;

    /**
     * @var EntityNamespaceLookup
     */
    protected $entityNamespaceLookup;

    private bool $isMobileView;

    /**
     * @param string $name Name of the special page, as seen in links and URLs.
     * @param string $restriction User right required,
     * @param string[] $tags List of tags to add to edits
     * @param SpecialPageCopyrightView $copyrightView
     * @param EntityNamespaceLookup $entityNamespaceLookup
     * @param SummaryFormatter $summaryFormatter
     * @param EntityTitleLookup $entityTitleLookup
     * @param MediaWikiEditEntityFactory $editEntityFactory
     */
    public function __construct(
        $name,
        $restriction,
        array $tags,
        SpecialPageCopyrightView $copyrightView,
        EntityNamespaceLookup $entityNamespaceLookup,
        SummaryFormatter $summaryFormatter,
        EntityTitleLookup $entityTitleLookup,
        MediaWikiEditEntityFactory $editEntityFactory,
        bool $isMobileView
    ) {
        parent::__construct(
            $name,
            $restriction,
            $tags,
            $copyrightView,
            $summaryFormatter,
            $entityTitleLookup,
            $editEntityFactory
        );

        $this->entityNamespaceLookup = $entityNamespaceLookup;
        $this->isMobileView = $isMobileView;
    }

    /**
     * @see SpecialPage::doesWrites
     *
     * @return bool
     */
    public function doesWrites() {
        return true;
    }

    /**
     * @inheritDoc
     */
    public function isListed() {
        return $this->entityNamespaceLookup->getEntityNamespace( $this->getEntityType() ) !== null;
    }

    /**
     * @return string Type id of the entity that will be created (eg: Item::ENTITY_TYPE value)
     */
    abstract protected function getEntityType();

    /**
     * @see SpecialWikibasePage::execute
     *
     * @param string|null $subPage
     */
    public function execute( $subPage ) {
        parent::execute( $subPage );

        $this->checkPermissions();
        $this->checkBlocked();
        $this->checkBlockedOnNamespace();
        $this->checkReadOnly();

        $this->parts = $subPage ? explode( '/', $subPage ) : [];

        $form = $this->createForm();

        $form->prepareForm();

        /** @var Status|false $submitStatus `false` if form was not submitted */
        $submitStatus = $form->tryAuthorizedSubmit();

        if ( $submitStatus && $submitStatus->isGood() ) {
            // wrap it, in case HTMLForm turned it into a generic Status
            $submitStatus = EditEntityStatus::wrap( $submitStatus );
            $this->redirectToEntityPage( $submitStatus );

            return;
        }

        $out = $this->getOutput();

        $this->displayBeforeForm( $out );

        $form->displayForm( $submitStatus ?: Status::newGood() );
    }

    /**
     * @return array[]
     */
    abstract protected function getFormFields();

    /**
     * @return string|Message $msg Legend for the fieldset, Message key or Message object
     */
    abstract protected function getLegend();

    /**
     * @return string[] Warnings that should be presented to the user
     */
    abstract protected function getWarnings();

    /**
     * @return HTMLForm
     */
    private function createForm() {
        return HTMLForm::factory( 'ooui', $this->getFormFields(), $this->getContext() )
            ->setId( 'mw-newentity-form1' )
            ->setSubmitID( 'wb-newentity-submit' )
            ->setSubmitName( 'submit' )
            ->setSubmitTextMsg( 'wikibase-newentity-submit' )
            ->setWrapperLegendMsg( $this->getLegend() )
            ->setSubmitCallback(
                function ( $data, HTMLForm $form ) {
                    $validationStatus = $this->validateFormData( $data );
                    if ( !$validationStatus->isGood() ) {
                        return $validationStatus;
                    }

                    $entity = $this->createEntityFromFormData( $data );

                    $summary = $this->createSummary( $entity );

                    $this->prepareEditEntity();
                    return $this->saveEntity(
                        $entity,
                        $summary,
                        $form->getRequest()->getRawVal( 'wpEditToken' ) ?? '',
                        EDIT_NEW
                    );
                }
            );
    }

    /**
     * @param array $formData
     *
     * @return EntityDocument
     */
    abstract protected function createEntityFromFormData( array $formData );

    /**
     * @param array $formData
     *
     * @return Status
     */
    abstract protected function validateFormData( array $formData );

    /**
     * @param EntityDocument $entity
     *
     * @return Summary
     */
    abstract protected function createSummary( EntityDocument $entity );

    protected function displayBeforeForm( OutputPage $output ) {
        // T324991
        if ( !$this->isMobileView ) {
            $output->addModules( 'wikibase.special.newEntity' );
        }

        $output->addHTML( $this->getCopyrightHTML() );

        foreach ( $this->getWarnings() as $warning ) {
            $output->addHTML( Html::rawElement( 'div', [ 'class' => 'warning' ], $warning ) );
        }
    }

    /**
     * @param string|null $messageKey ignored here
     *
     * @return string HTML
     */
    protected function getCopyrightHTML( $messageKey = null ) {
        return parent::getCopyrightHTML( 'wikibase-newentity-submit' );
    }

    /**
     * @throws UserBlockedError
     */
    private function checkBlockedOnNamespace() {
        $namespace = $this->entityNamespaceLookup->getEntityNamespace( $this->getEntityType() );
        $block = $this->getUser()->getBlock();
        if ( $block && $block->appliesToNamespace( $namespace ) ) {
            throw new UserBlockedError( $block );
        }
    }

}