mediawiki-extensions-Discus.../includes/Hooks.php

211 lines
6.7 KiB
PHP
Raw Normal View History

<?php
/**
* DiscussionTools extension hooks
*
* @file
* @ingroup Extensions
* @license MIT
*/
namespace MediaWiki\Extension\DiscussionTools;
use Action;
use ConfigException;
use MediaWiki\MediaWikiServices;
use OutputPage;
use RecentChange;
use RequestContext;
use Skin;
use User;
use VisualEditorHooks;
class Hooks {
private static $tags = [
'discussiontools',
// Features:
'discussiontools-reply',
'discussiontools-edit',
'discussiontools-newtopic',
// Input methods:
'discussiontools-source',
'discussiontools-visual',
];
public static function onRegistration() : void {
$coreConfig = RequestContext::getMain()->getConfig();
// If $wgLocaltimezone isn't hard-coded, it is evaluated from the system
// timezone. On some systems this isn't guaranteed to be static, for example
// on Debian, GMT can get converted to UTC, instead of Europe/London.
//
// Timestamp parsing assumes that the timezone never changes.
//
// HACK: Do not run this test on CI as $wgLocaltimezone is not configured.
if ( !$coreConfig->get( 'Localtimezone' ) && !getenv( 'ZUUL_PROJECT' ) ) {
throw new ConfigException( 'DiscussionTools requires $wgLocaltimezone to be set' );
}
}
/**
* Adds DiscussionTools JS to the output.
*
* This is attached to the MediaWiki 'BeforePageDisplay' hook.
*
* @param OutputPage $output The page view.
* @param Skin $skin The skin that's going to build the UI.
*/
public static function onBeforePageDisplay( OutputPage $output, Skin $skin ) : void {
$services = MediaWikiServices::getInstance();
$dtConfig = $services->getConfigFactory()->makeConfig( 'discussiontools' );
$optionsLookup = $services->getUserOptionsLookup();
$title = $output->getTitle();
$actionName = Action::getActionName( $output->getContext() );
$req = $output->getRequest();
$user = $skin->getUser();
$enabled = $dtConfig->get( 'DiscussionToolsEnable' ) && (
!$dtConfig->get( 'DiscussionToolsBeta' ) ||
$optionsLookup->getOption( $user, 'discussiontools-betaenable' )
);
if (
// Don't show on edit pages, history, etc.
$actionName === 'view' &&
// Only wikitext pages (e.g. not Flow boards)
$title->getContentModel() === CONTENT_MODEL_WIKITEXT &&
(
// Query parameter to load on any wikitext page for testing
$req->getVal( 'dtenable' ) ||
// If configured, load on all pages that probably have discussions
( $enabled && (
// `wantSignatures` includes talk pages
$services->getNamespaceInfo()->wantSignatures( $title->getNamespace() ) ||
// Treat pages with __NEWSECTIONLINK__ as talk pages (T245890)
$output->showNewSectionLink()
// TODO: Consider not loading if forceHideNewSectionLink is true.
) )
)
) {
$output->addModules( [
'ext.discussionTools.init'
] );
$editor = $optionsLookup->getOption( $user, 'discussiontools-editmode' );
// User has no preferred editor yet
// If the user has a preferred editor, this will be evaluated in the client
if ( !$editor ) {
// Check which editor we would use for articles
// VE pref is 'visualeditor'/'wikitext'. Here we describe the mode,
// not the editor, so 'visual'/'source'
$editor = VisualEditorHooks::getPreferredEditor( $user, $req ) === 'visualeditor' ?
'visual' : 'source';
$output->addJsConfigVars(
'wgDiscussionToolsFallbackEditMode',
$editor
);
}
}
}
/**
* Set static (not request-specific) JS configuration variables
*
* @see https://www.mediawiki.org/wiki/Manual:Hooks/ResourceLoaderGetConfigVars
* @param array &$vars Array of variables to be added into the output of the startup module
* @param string $skinName Current skin name to restrict config variables to a certain skin
*/
public static function onResourceLoaderGetConfigVars( array &$vars, string $skinName ) : void {
$dtConfig = MediaWikiServices::getInstance()->getConfigFactory()
->makeConfig( 'discussiontools' );
$vars['wgDTSchemaEditAttemptStepSamplingRate'] =
$dtConfig->get( 'DTSchemaEditAttemptStepSamplingRate' );
$vars['wgDTSchemaEditAttemptStepOversample'] =
$dtConfig->get( 'DTSchemaEditAttemptStepOversample' );
}
/**
* Handler for the GetPreferences hook, to add and hide user preferences as configured
*
* @param User $user The user object
* @param array &$preferences Their preferences object
*/
public static function onGetPreferences( User $user, array &$preferences ) {
$api = [ 'type' => 'api' ];
$preferences['discussiontools-editmode'] = [
'type' => 'api',
'validation-callback' => function ( $value ) {
return in_array( $value, [ '', 'source', 'visual' ], true );
},
];
}
/**
* Handler for the GetBetaPreferences hook, to add and hide user beta preferences as configured
*
* @param User $user The user object
* @param array &$preferences Their preferences object
*/
public static function onGetBetaPreferences( User $user, array &$preferences ) : void {
$coreConfig = RequestContext::getMain()->getConfig();
$iconpath = $coreConfig->get( 'ExtensionAssetsPath' ) . '/DiscussionTools/images';
$dtConfig = MediaWikiServices::getInstance()->getConfigFactory()
->makeConfig( 'discussiontools' );
if (
$dtConfig->get( 'DiscussionToolsEnable' ) &&
$dtConfig->get( 'DiscussionToolsBeta' )
) {
$preferences['discussiontools-betaenable'] = [
'version' => '1.0',
'label-message' => 'discussiontools-preference-label',
'desc-message' => 'discussiontools-preference-description',
'screenshot' => [
'ltr' => "$iconpath/betafeatures-icon-DiscussionTools-ltr.svg",
'rtl' => "$iconpath/betafeatures-icon-DiscussionTools-rtl.svg",
],
'info-message' => 'discussiontools-preference-info-link',
'discussion-message' => 'discussiontools-preference-discussion-link',
'requirements' => [
'javascript' => true
]
];
}
}
/**
* Implements the ListDefinedTags and ChangeTagsListActive hooks, to
* populate core Special:Tags with the change tags in use by DiscussionTools.
*
* @param array &$tags Available change tags.
*/
public static function onListDefinedTags( array &$tags ) : void {
$tags = array_merge( $tags, static::$tags );
}
/**
* Implements the RecentChange_save hook, to add a whitelisted set of changetags
* to edits.
*
* @param RecentChange $recentChange
* @return bool
*/
public static function onRecentChangeSave( RecentChange $recentChange ) : bool {
// only apply to api edits, since there's no case where discussiontools
// should be using the form-submit method.
if ( !defined( 'MW_API' ) ) {
return true;
}
$request = RequestContext::getMain()->getRequest();
$tags = explode( ',', $request->getVal( 'dttags' ) );
$tags = array_values( array_intersect( $tags, static::$tags ) );
if ( $tags ) {
$recentChange->addTags( $tags );
}
return true;
}
}