mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/CodeMirror
synced 2024-12-11 22:06:00 +00:00
ed2f9944ea
Introduces a new config variable `CodeMirrorLineNumberingNamespaces` that can restrict line numbering to only appear for specified namespaces. Setting to null enables everywhere. This takes some liberties with the `lib` module, turning it into a container for shared functionality. This can be pursued in later work, by cleaning up duplicated code in this repo. FIXME: failed to deduplicate the code for now. Bug: T267911 Change-Id: Ida2b33eef38edc57d29756ec472c6f2c83bd7b11
88 lines
2.8 KiB
PHP
88 lines
2.8 KiB
PHP
<?php
|
|
|
|
use MediaWiki\MediaWikiServices;
|
|
|
|
class CodeMirrorHooks {
|
|
|
|
/**
|
|
* Checks if CodeMirror for textarea wikitext editor should be loaded on this page or not.
|
|
*
|
|
* @param OutputPage $out
|
|
* @return bool
|
|
*/
|
|
private static function isCodeMirrorOnPage( OutputPage $out ) {
|
|
// Disable CodeMirror when CodeEditor is active on this page
|
|
// Depends on ext.codeEditor being added by EditPage::showEditForm:initial
|
|
if ( in_array( 'ext.codeEditor', $out->getModules() ) ) {
|
|
return false;
|
|
}
|
|
// Disable CodeMirror when the WikiEditor toolbar is not enabled in preferences
|
|
if ( !$out->getUser()->getOption( 'usebetatoolbar' ) ) {
|
|
return false;
|
|
}
|
|
$context = $out->getContext();
|
|
return in_array( Action::getActionName( $context ), [ 'edit', 'submit' ] ) &&
|
|
// CodeMirror on textarea wikitext editors doesn't support RTL (T170001)
|
|
!$context->getTitle()->getPageLanguage()->isRTL();
|
|
}
|
|
|
|
/**
|
|
* BeforePageDisplay hook handler
|
|
*
|
|
* @see https://www.mediawiki.org/wiki/Manual:Hooks/BeforePageDisplay
|
|
*
|
|
* @param OutputPage $out
|
|
* @param Skin $skin
|
|
*/
|
|
public static function onBeforePageDisplay( OutputPage $out, Skin $skin ) {
|
|
if ( self::isCodeMirrorOnPage( $out ) ) {
|
|
$out->addModules( 'ext.CodeMirror' );
|
|
|
|
if ( $out->getUser()->getOption( 'usecodemirror' ) ) {
|
|
// These modules are predelivered for performance when needed
|
|
// keep these modules in sync with ext.CodeMirror.js
|
|
$out->addModules( [ 'ext.CodeMirror.lib', 'ext.CodeMirror.mode.mediawiki' ] );
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Hook handler for enabling bracket matching.
|
|
*
|
|
* TODO: restrict to pages where codemirror might be enabled.
|
|
*
|
|
* @param array &$vars Array of variables to be added into the output of the startup module
|
|
*/
|
|
public static function onResourceLoaderGetConfigVars( array &$vars ) {
|
|
/** @var Config $config */
|
|
$config = MediaWikiServices::getInstance()->getMainConfig();
|
|
|
|
$vars['wgCodeMirrorEnableBracketMatching'] = $config->get( 'CodeMirrorEnableBracketMatching' )
|
|
// Allows tests to override the configuration.
|
|
|| RequestContext::getMain()->getRequest()
|
|
->getCookie( '-codemirror-bracket-matching-test', 'mw' );
|
|
|
|
$vars['wgCodeMirrorAccessibilityColors'] = $config->get( 'CodeMirrorAccessibilityColors' );
|
|
|
|
$vars['wgCodeMirrorLineNumberingNamespaces'] = $config->get( 'CodeMirrorLineNumberingNamespaces' );
|
|
}
|
|
|
|
/**
|
|
* GetPreferences hook handler
|
|
*
|
|
* @see https://www.mediawiki.org/wiki/Manual:Hooks/GetPreferences
|
|
*
|
|
* @param User $user
|
|
* @param array &$defaultPreferences
|
|
*/
|
|
public static function onGetPreferences( User $user, array &$defaultPreferences ) {
|
|
// CodeMirror is enabled by default for users. It can
|
|
// be changed by adding '$wgDefaultUserOptions['usecodemirror'] = 0;' into LocalSettings.php
|
|
$defaultPreferences['usecodemirror'] = [
|
|
'type' => 'api',
|
|
'default' => '1',
|
|
];
|
|
}
|
|
|
|
}
|