Code Coverage |
||||||||||
Classes and Traits |
Functions and Methods |
Lines |
||||||||
| Total | |
0.00% |
0 / 1 |
|
10.00% |
1 / 10 |
CRAP | |
17.57% |
13 / 74 |
| EntitySchema\MediaWiki\EntitySchemaHooks | |
0.00% |
0 / 1 |
|
10.00% |
1 / 10 |
404.65 | |
17.57% |
13 / 74 |
| onCreateDBSchema | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 8 |
|||
| onExtensionTypes | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 2 |
|||
| onSkinTemplateNavigation | |
0.00% |
0 / 1 |
6 | |
0.00% |
0 / 5 |
|||
| onBeforeDisplayNoArticleText | |
0.00% |
0 / 1 |
6 | |
0.00% |
0 / 14 |
|||
| onPageHistoryLineEnding | |
0.00% |
0 / 1 |
30 | |
0.00% |
0 / 15 |
|||
| onFormatAutocomments | |
100.00% |
1 / 1 |
5 | |
100.00% |
13 / 13 |
|||
| onContentModelCanBeUsedOn | |
0.00% |
0 / 1 |
12 | |
0.00% |
0 / 5 |
|||
| onImportHandleRevisionXMLTag | |
0.00% |
0 / 1 |
12 | |
0.00% |
0 / 5 |
|||
| onNamespaceIsMovable | |
0.00% |
0 / 1 |
6 | |
0.00% |
0 / 4 |
|||
| onTitleGetRestrictionTypes | |
0.00% |
0 / 1 |
6 | |
0.00% |
0 / 3 |
|||
| <?php | |
| namespace EntitySchema\MediaWiki; | |
| use Article; | |
| use DatabaseUpdater; | |
| use HistoryPager; | |
| use Html; | |
| use MediaWiki\MediaWikiServices; | |
| use MediaWiki\Revision\RevisionRecord; | |
| use MWException; | |
| use MWNamespace; | |
| use SkinTemplate; | |
| use Title; | |
| use EntitySchema\MediaWiki\Content\EntitySchemaContent; | |
| use EntitySchema\Presentation\AutocommentFormatter; | |
| use WikiImporter; | |
| /** | |
| * Hooks utilized by the EntitySchema extension | |
| */ | |
| final class EntitySchemaHooks { | |
| /** | |
| * @param DatabaseUpdater $updater | |
| */ | |
| public static function onCreateDBSchema( DatabaseUpdater $updater ) { | |
| $updater->addExtensionTable( | |
| 'wbschema_id_counter', | |
| __DIR__ . '/../../sql/WikibaseSchema.sql' | |
| ); | |
| $updater->modifyExtensionField( | |
| 'page', | |
| 'page_namespace', | |
| __DIR__ . '/../../sql/patch-move-page-namespace.sql' | |
| ); | |
| } | |
| public static function onExtensionTypes( array &$extTypes ) { | |
| $extTypes['wikibase'] = 'Wikibase'; | |
| } | |
| public static function onSkinTemplateNavigation( SkinTemplate $skinTemplate, array &$links ) { | |
| $title = $skinTemplate->getRelevantTitle(); | |
| if ( !$title->inNamespace( NS_ENTITYSCHEMA_JSON ) ) { | |
| return; | |
| } | |
| unset( $links['views']['edit'] ); | |
| } | |
| /** | |
| * Handler for the BeforeDisplayNoArticleText called by Article. | |
| * We implement this solely to replace the standard message that | |
| * is shown when a Schema does not exists. | |
| * | |
| * @param Article $article | |
| * | |
| * @return bool | |
| */ | |
| public static function onBeforeDisplayNoArticleText( Article $article ) { | |
| if ( $article->getTitle()->getNamespace() !== NS_ENTITYSCHEMA_JSON ) { | |
| return true; | |
| } | |
| $context = $article->getContext(); | |
| $dir = $context->getLanguage()->getDir(); | |
| $lang = $context->getLanguage()->getHtmlCode(); | |
| $outputPage = $context->getOutput(); | |
| $outputPage->wrapWikiMsg( | |
| Html::element( 'div', [ | |
| 'class' => "noarticletext mw-content-$dir", | |
| 'dir' => $dir, | |
| 'lang' => $lang, | |
| ], '$1' ), | |
| 'entityschema-noschema' | |
| ); | |
| return false; | |
| } | |
| /** | |
| * Modify line endings on history page. | |
| * | |
| * @see https://www.mediawiki.org/wiki/Manual:Hooks/PageHistoryLineEnding | |
| * | |
| * @param HistoryPager $history | |
| * @param object &$row | |
| * @param string &$html | |
| * @param array &$classes | |
| */ | |
| public static function onPageHistoryLineEnding( | |
| HistoryPager $history, | |
| &$row, | |
| &$html, | |
| array &$classes | |
| ) { | |
| $rev = MediaWikiServices::getInstance()->getRevisionStore()->newRevisionFromRow( $row ); | |
| $wikiPage = $history->getWikiPage(); | |
| if ( $wikiPage->getContentModel() === EntitySchemaContent::CONTENT_MODEL_ID | |
| && $wikiPage->getLatest() !== $rev->getId() | |
| && $wikiPage->getTitle()->quickUserCan( 'edit', $history->getUser() ) | |
| && !$rev->isDeleted( RevisionRecord::DELETED_TEXT ) | |
| ) { | |
| $linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer(); | |
| $link = $linkRenderer->makeKnownLink( | |
| $wikiPage->getTitle(), | |
| $history->msg( 'entityschema-restoreold' )->text(), | |
| [], | |
| [ | |
| 'action' => 'edit', | |
| 'restore' => $rev->getId(), | |
| ] | |
| ); | |
| $html .= ' ' . $history->msg( 'parentheses' )->rawParams( $link )->escaped(); | |
| } | |
| } | |
| /** | |
| * Handler for the FormatAutocomments hook, used to translate parts of edit summaries | |
| * into the user language. Only supports a fixed set of autocomments. | |
| * | |
| * @param string|null &$comment The comment HTML. Initially null; if set to a string, | |
| * Linker::formatAutocomments() will skip the default formatting. In that case, | |
| * the actual autocomment should be wrapped in <span dir="auto"><span class="autocomment">. | |
| * @param bool $pre Whether any text appears in the summary before this autocomment. | |
| * If true, we insert the autocomment-prefix before the autocomment | |
| * (outside the two <span>s) to separate it from that. | |
| * @param string $auto The autocomment content (without the surrounding comment marks) | |
| * @param bool $post Whether any text appears in the summary after this autocomment. | |
| * If true, we append the colon-separator after the autocomment (still inside the two <span>s) | |
| * to separate it from that. | |
| * @param Title|null $title The title to which the comment applies. A null $title is taken to | |
| * refer to the current page ($wgTitle), though that’s not quite clear from Linker’s documentation. | |
| * @param bool $local If true, don’t actually use the $title for links, e. g. generate | |
| * <a href="#foo"> instead of <a href="/wiki/Namespace:Title#foo">. Unused here. | |
| * | |
| * @return null|false | |
| */ | |
| public static function onFormatAutocomments( &$comment, $pre, $auto, $post, $title, $local ) { | |
| // phpcs:ignore MediaWiki.VariableAnalysis.ForbiddenGlobalVariables.ForbiddenGlobal$wgTitle | |
| global $wgTitle; | |
| if ( !( $title instanceof Title ) ) { | |
| $title = $wgTitle; | |
| } | |
| if ( !( $title instanceof Title ) ) { | |
| return null; | |
| } | |
| if ( $title->getNamespace() !== NS_ENTITYSCHEMA_JSON ) { | |
| return null; | |
| } | |
| $autocommentFormatter = new AutocommentFormatter(); | |
| $formattedComment = $autocommentFormatter->formatAutocomment( $pre, $auto, $post ); | |
| if ( $formattedComment !== null ) { | |
| $comment = $formattedComment; | |
| return false; | |
| } | |
| return null; | |
| } | |
| /** | |
| * @see ContentHandler::canBeUsedOn() | |
| * | |
| * @param string $modelId The content model ID. | |
| * @param Title $title The title where the content model may or may not be used on. | |
| * @param bool &$ok Whether the content model can be used on the title or not. | |
| * | |
| * @return null|false | |
| */ | |
| public static function onContentModelCanBeUsedOn( $modelId, Title $title, &$ok ) { | |
| if ( | |
| $title->inNamespace( NS_ENTITYSCHEMA_JSON ) && | |
| $modelId !== EntitySchemaContent::CONTENT_MODEL_ID | |
| ) { | |
| $ok = false; | |
| return false; // skip other hooks | |
| } | |
| // the other direction is guarded by EntitySchemaContentHandler::canBeUsedOn() | |
| return null; | |
| } | |
| public static function onImportHandleRevisionXMLTag( | |
| WikiImporter $importer, | |
| array $pageInfo, | |
| array $revisionInfo | |
| ) { | |
| if ( | |
| array_key_exists( 'model', $revisionInfo ) && | |
| $revisionInfo['model'] === EntitySchemaContent::CONTENT_MODEL_ID | |
| ) { | |
| throw new MWException( | |
| 'To avoid ID conflicts, the import of Schemas is not supported.' | |
| ); | |
| } | |
| } | |
| /** | |
| * @see MWNamespace::isMovable() | |
| * @see https://www.mediawiki.org/wiki/Manual:Hooks/NamespaceIsMovable | |
| * | |
| * @param int $index | |
| * @param bool &$result | |
| * @return null|false | |
| */ | |
| public static function onNamespaceIsMovable( $index, &$result ) { | |
| if ( MWNamespace::equals( $index, NS_ENTITYSCHEMA_JSON ) ) { | |
| $result = false; | |
| return false; // skip other hooks | |
| } | |
| return null; | |
| } | |
| /** | |
| * Handler for the TitleGetRestrictionTypes hook. | |
| * | |
| * Implemented to prevent people from protecting pages from being | |
| * created or moved in a Schema namespace (which is pointless). | |
| * | |
| * @see https://www.mediawiki.org/wiki/Manual:Hooks/TitleGetRestrictionTypes | |
| * | |
| * @param Title $title | |
| * @param string[] &$types The types of protection available | |
| */ | |
| public static function onTitleGetRestrictionTypes( Title $title, array &$types ) { | |
| if ( $title->getNamespace() === NS_ENTITYSCHEMA_JSON ) { | |
| // Remove create and move protection for Schema namespaces | |
| $types = array_diff( $types, [ 'create', 'move' ] ); | |
| } | |
| } | |
| } |