Code Coverage |
||||||||||
Classes and Traits |
Functions and Methods |
Lines |
||||||||
| Total | |
100.00% |
1 / 1 |
|
100.00% |
10 / 10 |
CRAP | |
100.00% |
111 / 111 |
| EntitySchema\MediaWiki\Specials\NewEntitySchema | |
100.00% |
1 / 1 |
|
100.00% |
10 / 10 |
17 | |
100.00% |
111 / 111 |
| __construct | |
100.00% |
1 / 1 |
1 | |
100.00% |
4 / 4 |
|||
| execute | |
100.00% |
1 / 1 |
4 | |
100.00% |
21 / 21 |
|||
| submitCallback | |
100.00% |
1 / 1 |
1 | |
100.00% |
15 / 15 |
|||
| getDescription | |
100.00% |
1 / 1 |
1 | |
100.00% |
1 / 1 |
|||
| getGroupName | n/a |
0 / 0 |
1 | n/a |
0 / 0 |
|||||
| getFormFields | |
100.00% |
1 / 1 |
1 | |
100.00% |
46 / 46 |
|||
| displayBeforeForm | |
100.00% |
1 / 1 |
2 | |
100.00% |
4 / 4 |
|||
| getCopyrightHTML | |
100.00% |
1 / 1 |
1 | |
100.00% |
6 / 6 |
|||
| getWarnings | |
100.00% |
1 / 1 |
2 | |
100.00% |
4 / 4 |
|||
| addJavaScript | |
100.00% |
1 / 1 |
1 | |
100.00% |
7 / 7 |
|||
| checkBlocked | |
100.00% |
1 / 1 |
2 | |
100.00% |
3 / 3 |
|||
| <?php | |
| namespace EntitySchema\MediaWiki\Specials; | |
| use Html; | |
| use HTMLForm; | |
| use Language; | |
| use MediaWiki\MediaWikiServices; | |
| use OutputPage; | |
| use SpecialPage; | |
| use Status; | |
| use Title; | |
| use UserBlockedError; | |
| use EntitySchema\DataAccess\MediaWikiPageUpdaterFactory; | |
| use EntitySchema\DataAccess\MediaWikiRevisionSchemaInserter; | |
| use EntitySchema\DataAccess\SqlIdGenerator; | |
| use EntitySchema\DataAccess\WatchlistUpdater; | |
| use EntitySchema\Presentation\InputValidator; | |
| /** | |
| * Page for creating a new EntitySchema. | |
| * | |
| * @license GPL-2.0-or-later | |
| */ | |
| class NewEntitySchema extends SpecialPage { | |
| /* public */ | |
| const FIELD_DESCRIPTION = 'description'; | |
| /* public */ | |
| const FIELD_LABEL = 'label'; | |
| /* public */ | |
| const FIELD_ALIASES = 'aliases'; | |
| /* public */ | |
| const FIELD_SCHEMA_TEXT = 'schema-text'; | |
| /* public */ | |
| const FIELD_LANGUAGE = 'languagecode'; | |
| public function __construct() { | |
| parent::__construct( | |
| 'NewEntitySchema', | |
| 'createpage' | |
| ); | |
| } | |
| public function execute( $subPage ) { | |
| parent::execute( $subPage ); | |
| $this->checkPermissions(); | |
| $this->checkBlocked( $subPage ); | |
| $this->checkReadOnly(); | |
| $form = HTMLForm::factory( 'ooui', $this->getFormFields(), $this->getContext() ) | |
| ->setSubmitName( 'submit' ) | |
| ->setSubmitID( 'wbschema-newschema-submit' ) | |
| ->setSubmitTextMsg( 'entityschema-newschema-submit' ) | |
| ->setValidationErrorMessage( [ [ | |
| 'entityschema-error-possibly-multiple-messages-available' | |
| ] ] ) | |
| ->setSubmitCallback( [ $this, 'submitCallback' ] ); | |
| $form->prepareForm(); | |
| /** @var Status|false $submitStatus `false` if form was not submitted */ | |
| $submitStatus = $form->tryAuthorizedSubmit(); | |
| if ( $submitStatus && $submitStatus->isGood() ) { | |
| $this->getOutput()->redirect( | |
| $submitStatus->getValue() | |
| ); | |
| return; | |
| } | |
| $this->addJavaScript(); | |
| $this->displayBeforeForm( $this->getOutput() ); | |
| $form->displayForm( $submitStatus ?: Status::newGood() ); | |
| } | |
| public function submitCallback( $data, HTMLForm $form ) { | |
| // TODO: no form data validation?? | |
| $idGenerator = new SqlIdGenerator( | |
| MediaWikiServices::getInstance()->getDBLoadBalancer(), | |
| 'wbschema_id_counter' | |
| ); | |
| $pageUpdaterFactory = new MediaWikiPageUpdaterFactory( $this->getUser() ); | |
| $schemaInserter = new MediaWikiRevisionSchemaInserter( | |
| $pageUpdaterFactory, | |
| new WatchlistUpdater( $this->getUser(), NS_ENTITYSCHEMA_JSON ), | |
| $idGenerator | |
| ); | |
| $newId = $schemaInserter->insertSchema( | |
| $data[self::FIELD_LANGUAGE], | |
| $data[self::FIELD_LABEL], | |
| $data[self::FIELD_DESCRIPTION], | |
| array_filter( array_map( 'trim', explode( '|', $data[self::FIELD_ALIASES] ) ) ), | |
| $data[self::FIELD_SCHEMA_TEXT] | |
| ); | |
| $title = Title::makeTitle( NS_ENTITYSCHEMA_JSON, $newId->getId() ); | |
| return Status::newGood( $title->getFullURL() ); | |
| } | |
| public function getDescription() { | |
| return $this->msg( 'special-newschema' )->text(); | |
| } | |
| protected function getGroupName() { | |
| return 'wikibase'; | |
| } | |
| private function getFormFields(): array { | |
| $langCode = $this->getLanguage()->getCode(); | |
| $langName = Language::fetchLanguageName( $langCode, $langCode ); | |
| $inputValidator = InputValidator::newFromGlobalState(); | |
| return [ | |
| self::FIELD_LABEL => [ | |
| 'name' => self::FIELD_LABEL, | |
| 'type' => 'text', | |
| 'id' => 'wbschema-newschema-label', | |
| 'required' => true, | |
| 'default' => '', | |
| 'placeholder-message' => $this->msg( 'entityschema-label-edit-placeholder' ) | |
| ->params( $langName ), | |
| 'label-message' => 'entityschema-newschema-label', | |
| 'validation-callback' => [ | |
| $inputValidator, | |
| 'validateStringInputLength' | |
| ], | |
| ], | |
| self::FIELD_DESCRIPTION => [ | |
| 'name' => self::FIELD_DESCRIPTION, | |
| 'type' => 'text', | |
| 'default' => '', | |
| 'id' => 'wbschema-newschema-description', | |
| 'placeholder-message' => $this->msg( 'entityschema-description-edit-placeholder' ) | |
| ->params( $langName ), | |
| 'label-message' => 'entityschema-newschema-description', | |
| 'validation-callback' => [ | |
| $inputValidator, | |
| 'validateStringInputLength' | |
| ], | |
| ], | |
| self::FIELD_ALIASES => [ | |
| 'name' => self::FIELD_ALIASES, | |
| 'type' => 'text', | |
| 'default' => '', | |
| 'id' => 'wbschema-newschema-aliases', | |
| 'placeholder-message' => $this->msg( 'entityschema-aliases-edit-placeholder' ) | |
| ->params( $langName ), | |
| 'label-message' => 'entityschema-newschema-aliases', | |
| 'validation-callback' => [ | |
| $inputValidator, | |
| 'validateAliasesLength' | |
| ], | |
| ], | |
| self::FIELD_SCHEMA_TEXT => [ | |
| 'name' => self::FIELD_SCHEMA_TEXT, | |
| 'type' => 'textarea', | |
| 'default' => '', | |
| 'id' => 'wbschema-newschema-schema-text', | |
| 'placeholder' => "<human> {\n wdt:P31 [wd:Q5]\n}", | |
| 'label-message' => 'entityschema-newschema-schema-shexc', | |
| 'validation-callback' => [ | |
| $inputValidator, | |
| 'validateSchemaTextLength' | |
| ], | |
| 'useeditfont' => true, | |
| ], | |
| self::FIELD_LANGUAGE => [ | |
| 'name' => self::FIELD_LANGUAGE, | |
| 'type' => 'hidden', | |
| 'default' => $langCode, | |
| ], | |
| ]; | |
| } | |
| private function displayBeforeForm( OutputPage $output ) { | |
| $output->addHTML( $this->getCopyrightHTML() ); | |
| foreach ( $this->getWarnings() as $warning ) { | |
| $output->addHTML( Html::rawElement( 'div', [ 'class' => 'warning' ], $warning ) ); | |
| } | |
| } | |
| /** | |
| * @return string HTML | |
| */ | |
| private function getCopyrightHTML() { | |
| return $this->msg( 'entityschema-newschema-copyright' ) | |
| ->params( | |
| $this->msg( 'entityschema-newschema-submit' )->text(), | |
| $this->msg( 'copyrightpage' )->text(), | |
| // FIXME: make license configurable | |
| '[https://creativecommons.org/publicdomain/zero/1.0/ Creative Commons CC0 License]' | |
| ) | |
| ->parse(); | |
| } | |
| private function getWarnings(): array { | |
| if ( $this->getUser()->isAnon() ) { | |
| return [ | |
| $this->msg( | |
| 'entityschema-anonymouseditwarning' | |
| )->parse(), | |
| ]; | |
| } | |
| return []; | |
| } | |
| private function addJavaScript() { | |
| $output = $this->getOutput(); | |
| $output->addModules( [ | |
| 'ext.EntitySchema.special.newSchema', | |
| ] ); | |
| $output->addJsConfigVars( [ | |
| 'wgWBSchemaSchemaTextMaxSizeBytes' => | |
| intval( $this->getConfig()->get( 'WBSchemaSchemaTextMaxSizeBytes' ) ), | |
| 'wgWBSchemaNameBadgeMaxSizeChars' => | |
| intval( $this->getConfig()->get( 'WBSchemaNameBadgeMaxSizeChars' ) ) | |
| ] ); | |
| } | |
| /** | |
| * Checks if the user is blocked from this page, | |
| * and if they are, throws a {@link UserBlockedError}. | |
| * | |
| * @throws UserBlockedError | |
| */ | |
| protected function checkBlocked( $subPage ) { | |
| if ( $this->getUser()->isBlockedFrom( $this->getPageTitle( $subPage ) ) ) { | |
| throw new UserBlockedError( $this->getUser()->getBlock() ); | |
| } | |
| } | |
| } |