Page MenuHomeWickedGov Phorge
Files F4059478

JsonSchemaHooks.php
No OneTemporary
Actions

Size
4 KB
Referenced Files
None
Subscribers
None

JsonSchemaHooks.php
View Options

<?php
/**
* Hooks for managing JSON Schema namespace and content model.
*
* @file
* @ingroup Extensions
* @ingroup EventLogging
*
* @author Ori Livneh <ori@wikimedia.org>
*/
// phpcs:disable MediaWiki.NamingConventions.LowerCamelFunctionsName.FunctionName
namespace MediaWiki\Extension\EventLogging;
use MediaWiki\Api\ApiModuleManager;
use MediaWiki\Api\Hook\ApiMain__moduleManagerHook;
use MediaWiki\Content\Content;
use MediaWiki\Context\IContextSource;
use MediaWiki\EditPage\EditPage;
use MediaWiki\Extension\EventLogging\Libs\JsonSchemaValidation\JsonSchemaException;
use MediaWiki\Hook\EditFilterMergedContentHook;
use MediaWiki\Hook\MovePageIsValidMoveHook;
use MediaWiki\Output\Hook\BeforePageDisplayHook;
use MediaWiki\Output\OutputPage;
use MediaWiki\Skin\Skin;
use MediaWiki\Status\Status;
use MediaWiki\Title\Title;
use MediaWiki\User\User;
class JsonSchemaHooks implements
BeforePageDisplayHook,
EditFilterMergedContentHook,
MovePageIsValidMoveHook,
ApiMain__moduleManagerHook
{
/**
* Convenience function to determine whether the
* Schema namespace is enabled
*
* @return bool
*/
public static function isSchemaNamespaceEnabled() {
global $wgEventLoggingDBname, $wgDBname;
return $wgEventLoggingDBname === $wgDBname;
}
/**
* ApiMain::moduleManager hook to register jsonschema
* API module only if the Schema namespace is enabled
*
* @param ApiModuleManager $moduleManager
*/
public function onApiMain__moduleManager( $moduleManager ): void {
if ( self::isSchemaNamespaceEnabled() ) {
$moduleManager->addModule(
'jsonschema',
'action',
ApiJsonSchema::class
);
}
}
/**
* Declares JSON as the code editor language for Schema: pages.
* This hook only runs if the CodeEditor extension is enabled.
*
* @param Title $title
* @param string &$lang Page language.
*/
public static function onCodeEditorGetPageLanguage( $title, &$lang ): void {
if ( self::isSchemaNamespaceEnabled()
&& $title->inNamespace( NS_SCHEMA )
) {
$lang = 'json';
}
}
/**
* Validates that the revised contents are valid JSON.
* If not valid, rejects edit with error message.
*
* @param IContextSource $context
* @param Content $content
* @param Status $status
* @param string $summary
* @param User $user
* @param bool $minoredit
* @return bool
*/
public function onEditFilterMergedContent(
IContextSource $context,
Content $content,
Status $status,
$summary,
User $user,
$minoredit
): bool {
$title = $context->getTitle();
if ( !self::isSchemaNamespaceEnabled()
|| !$title->inNamespace( NS_SCHEMA )
) {
return true;
}
if ( !preg_match( '/^[a-zA-Z0-9_-]{1,63}$/', $title->getText() ) ) {
$status->fatal( 'badtitle' );
// @todo Remove this line after this extension do not support mediawiki version 1.36 and before
$status->value = EditPage::AS_HOOK_ERROR_EXPECTED;
return false;
}
if ( !$content instanceof JsonSchemaContent ) {
return true;
}
try {
$content->validate();
return true;
} catch ( JsonSchemaException $e ) {
$status->fatal( $context->msg( $e->getCode(), $e->args ) );
// @todo Remove this line after this extension do not support mediawiki version 1.36 and before
$status->value = EditPage::AS_HOOK_ERROR_EXPECTED;
return false;
}
}
/**
* Add the revision id as the subtitle on NS_SCHEMA pages.
*
* @param OutputPage $out
* @param Skin $skin
*/
public function onBeforePageDisplay( $out, $skin ): void {
$title = $out->getTitle();
$revId = $out->getRevisionId();
if ( self::isSchemaNamespaceEnabled()
&& $title->inNamespace( NS_SCHEMA )
&& $revId !== null
) {
$out->addSubtitle( $out->msg( 'eventlogging-revision-id' )
// We use 'rawParams' rather than 'numParams' to make it
// easy to copy/paste the value into code.
->rawParams( $revId )
->escaped() );
}
}
/**
* Prohibit moving (renaming) Schema pages, as doing so violates
* immutability guarantees.
*
* @param Title $currentTitle
* @param Title $newTitle
* @param Status $status
* @return bool
*/
public function onMovePageIsValidMove(
$currentTitle, $newTitle, $status
) {
if ( !self::isSchemaNamespaceEnabled() ) {
// Namespace isn't even enabled
return true;
} elseif ( $currentTitle->inNamespace( NS_SCHEMA ) ) {
$status->fatal( 'eventlogging-error-move-source' );
return false;
} elseif ( $newTitle->inNamespace( NS_SCHEMA ) ) {
$status->fatal( 'eventlogging-error-move-destination' );
return false;
}
return true;
}
}

File Metadata

Mime Type
text/x-php
Expires
Aug 16 2026, 05:31 (12 w, 2 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
bc/9c/697648e8b6b341bf8bcd9da83735
Default Alt Text
JsonSchemaHooks.php (4 KB)

Event Timeline