mediawiki-extensions-Discus.../includes/Hooks/PageHooks.php
Bartosz Dziewoński fce317ace4 Move TOC metadata generation to a post-processing step
Instead of generating the TOC HTML additions immediately, store
the data we need using ParserOutput::setExtensionData(), and use
the OutputPageParserOutput hook to fetch it and generate the HTML.

We check that the stored data is present before using it to avoid
issues with cached ParserOutput objects.

Bug: T328122
Change-Id: I7d4988cd568f10b7995a4d744e0ec6e7ce081b0e
2023-02-07 02:39:11 +01:00

537 lines
19 KiB
PHP

<?php
/**
* DiscussionTools page hooks
*
* @file
* @ingroup Extensions
* @license MIT
*/
namespace MediaWiki\Extension\DiscussionTools\Hooks;
use Article;
use Config;
use ConfigFactory;
use ExtensionRegistry;
use Html;
use IContextSource;
use MediaWiki\Actions\Hook\GetActionNameHook;
use MediaWiki\Extension\DiscussionTools\CommentFormatter;
use MediaWiki\Extension\DiscussionTools\SubscriptionStore;
use MediaWiki\Extension\VisualEditor\Hooks as VisualEditorHooks;
use MediaWiki\Hook\BeforePageDisplayHook;
use MediaWiki\Hook\OutputPageBeforeHTMLHook;
use MediaWiki\Hook\OutputPageParserOutputHook;
use MediaWiki\Hook\TitleGetEditNoticesHook;
use MediaWiki\MediaWikiServices;
use MediaWiki\Page\Hook\BeforeDisplayNoArticleTextHook;
use MediaWiki\User\UserNameUtils;
use MediaWiki\User\UserOptionsLookup;
use OOUI\ButtonWidget;
use OOUI\HtmlSnippet;
use OOUI\MessageWidget;
use OutputPage;
use ParserOutput;
use RequestContext;
use Skin;
use SpecialPage;
use Title;
class PageHooks implements
BeforeDisplayNoArticleTextHook,
BeforePageDisplayHook,
GetActionNameHook,
OutputPageBeforeHTMLHook,
OutputPageParserOutputHook,
TitleGetEditNoticesHook
{
private Config $config;
private SubscriptionStore $subscriptionStore;
private UserNameUtils $userNameUtils;
private UserOptionsLookup $userOptionsLookup;
public function __construct(
ConfigFactory $configFactory,
SubscriptionStore $subscriptionStore,
UserNameUtils $userNameUtils,
UserOptionsLookup $userOptionsLookup
) {
$this->config = $configFactory->makeConfig( 'discussiontools' );
$this->subscriptionStore = $subscriptionStore;
$this->userNameUtils = $userNameUtils;
$this->userOptionsLookup = $userOptionsLookup;
}
private function isMobile(): bool {
if ( ExtensionRegistry::getInstance()->isLoaded( 'MobileFrontend' ) ) {
$mobFrontContext = MediaWikiServices::getInstance()->getService( 'MobileFrontend.Context' );
return $mobFrontContext->shouldDisplayMobileView();
}
return false;
}
/**
* Adds DiscussionTools JS to the output.
*
* This is attached to the MediaWiki 'BeforePageDisplay' hook.
*
* @param OutputPage $output
* @param Skin $skin
* @return void This hook must not abort, it must return no value
*/
public function onBeforePageDisplay( $output, $skin ): void {
$user = $output->getUser();
$req = $output->getRequest();
foreach ( HookUtils::FEATURES as $feature ) {
// Add a CSS class for each enabled feature
if ( HookUtils::isFeatureEnabledForOutput( $output, $feature ) ) {
$output->addBodyClasses( "ext-discussiontools-$feature-enabled" );
}
}
if ( $this->isMobile() && HookUtils::isFeatureEnabledForOutput( $output, HookUtils::VISUALENHANCEMENTS ) ) {
$output->addBodyClasses( 'collapsible-headings-collapsed' );
}
// Load style modules if the tools can be available for the title
// to selectively hide DT features, depending on the body classes added above.
$availableForTitle = HookUtils::isAvailableForTitle( $output->getTitle() );
if ( $availableForTitle ) {
$output->addModuleStyles( 'ext.discussionTools.init.styles' );
}
// Load modules if any DT feature is enabled for this user
if (
HookUtils::isFeatureEnabledForOutput( $output ) ||
// If there's an a/b test we need to include the JS for unregistered users just so
// we can make sure we store the bucket
( $this->config->get( 'DiscussionToolsABTest' ) && !$user->isRegistered() )
) {
$output->addModules( [
'ext.discussionTools.init'
] );
$enabledVars = [];
foreach ( HookUtils::FEATURES as $feature ) {
$enabledVars[$feature] = HookUtils::isFeatureEnabledForOutput( $output, $feature );
}
$output->addJsConfigVars( 'wgDiscussionToolsFeaturesEnabled', $enabledVars );
$editor = $this->userOptionsLookup->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
);
}
}
// This doesn't involve any DB checks, and so we can put it on every
// page to make it easy to pick for logging in WikiEditor. If this
// becomes not-cheap, move it elsewhere.
$abstate = HookUtils::determineUserABTestBucket( $user );
if ( $abstate ) {
$output->addJsConfigVars(
'wgDiscussionToolsABTestBucket',
$abstate
);
}
// Replace the action=edit&section=new form with the new topic tool.
if ( HookUtils::shouldOpenNewTopicTool( $output->getContext() ) ) {
$output->addJsConfigVars( 'wgDiscussionToolsStartNewTopicTool', true );
// For no-JS compatibility, redirect to the old new section editor if JS is unavailable.
// This isn't great, because the user has to load the page twice. But making a page that is
// both a view mode and an edit mode seems difficult, so I'm cutting some corners here.
// (Code below adapted from VisualEditor.)
$params = $output->getRequest()->getValues();
$params['dtenable'] = '0';
$url = wfScript() . '?' . wfArrayToCgi( $params );
$escapedUrl = htmlspecialchars( $url );
// Redirect if the user has no JS (<noscript>)
$output->addHeadItem(
'dt-noscript-fallback',
"<noscript><meta http-equiv=\"refresh\" content=\"0; url=$escapedUrl\"></noscript>"
);
// Redirect if the user has no ResourceLoader
$output->addScript( Html::inlineScript(
"(window.NORLQ=window.NORLQ||[]).push(" .
"function(){" .
"location.href=\"$url\";" .
"}" .
");"
) );
}
if ( $output->getSkin()->getSkinName() === 'minerva' ) {
$title = $output->getTitle();
if (
HookUtils::isFeatureEnabledForOutput( $output, HookUtils::NEWTOPICTOOL ) &&
// Only add the button if "New section" tab would be shown in a normal skin.
HookUtils::shouldShowNewSectionTab( $output->getContext() )
) {
$output->enableOOUI();
$output->addModuleStyles( [
// For speechBubbleAdd
'oojs-ui.styles.icons-alerts',
] );
$output->addBodyClasses( 'ext-discussiontools-init-new-topic-opened' );
// Minerva doesn't show a new topic button by default, unless the MobileFrontend
// talk page feature is enabled, but we shouldn't depend on code from there.
$output->addHTML( Html::rawElement( 'div',
[ 'class' => 'ext-discussiontools-init-new-topic' ],
( new ButtonWidget( [
'classes' => [ 'ext-discussiontools-init-new-topic-button' ],
'href' => $title->getLinkURL( [ 'action' => 'edit', 'section' => 'new' ] ),
'icon' => 'speechBubbleAdd',
'label' => $output->getContext()->msg( 'skin-action-addsection' )->text(),
'flags' => [ 'progressive', 'primary' ],
'infusable' => true,
] ) )
// For compatibility with Minerva click tracking (T295490)
->setAttributes( [ 'data-event-name' => 'talkpage.add-topic' ] )
) );
}
if (
$title->isTalkPage() &&
HookUtils::isFeatureEnabledForOutput( $output, HookUtils::REPLYTOOL ) && (
CommentFormatter::hasLedeContent( $output->getHTML() ) || (
// Header shown on all talk pages, see Article::showNamespaceHeader
!$output->getContext()->msg( 'talkpageheader' )->isDisabled() &&
// Check if it isn't empty since it may use parser functions to only show itself on some pages
trim( $output->getContext()->msg( 'talkpageheader' )->text() ) !== ''
)
) &&
// If there are comments in the lede section, we can't really separate them from other lede
// content, so keep the whole section visible.
!CommentFormatter::hasCommentsInLedeContent( $output->getHTML() )
) {
$output->addBodyClasses( 'ext-discussiontools-init-lede-hidden' );
$output->enableOOUI();
$output->prependHTML(
Html::rawElement( 'div',
[ 'class' => 'ext-discussiontools-init-lede-button-container' ],
( new ButtonWidget( [
'label' => $output->getContext()->msg( 'discussiontools-ledesection-button' )->text(),
'classes' => [ 'ext-discussiontools-init-lede-button' ],
'framed' => false,
'icon' => 'info',
'infusable' => true,
] ) )
)
);
// Preload jquery.makeCollapsible for LedeSectionDialog.
// Using the same approach as in Skin::getDefaultModules in MediaWiki core.
if ( strpos( $output->getHTML(), 'mw-collapsible' ) !== false ) {
$output->addModules( 'jquery.makeCollapsible' );
$output->addModuleStyles( 'jquery.makeCollapsible.styles' );
}
}
}
}
/**
* OutputPageBeforeHTML hook handler
* @see https://www.mediawiki.org/wiki/Manual:Hooks/OutputPageBeforeHTML
*
* @param OutputPage $output OutputPage object that corresponds to the page
* @param string &$text Text that will be displayed, in HTML
* @return bool|void This hook must not abort, it must return true or null.
*/
public function onOutputPageBeforeHTML( $output, &$text ) {
// ParserOutputPostCacheTransform hook would be a better place to do this,
// so that when the ParserOutput is used directly without using this hook,
// we don't leave half-baked interface elements in it (see e.g. T292345, T294168).
// But that hook doesn't provide parameters that we need to render correctly
// (including the page title, interface language, and current user).
// This hook can be executed more than once per page view if the page content is composed from
// multiple sources!
$isMobile = $this->isMobile();
$lang = $output->getLanguage();
if ( HookUtils::isFeatureEnabledForOutput( $output, HookUtils::TOPICSUBSCRIPTION ) ) {
// Just enable OOUI PHP - the OOUI subscribe button isn't infused unless VISUALENHANCEMENTS are enabled
$output->setupOOUI();
$text = CommentFormatter::postprocessTopicSubscription(
$text, $lang, $this->subscriptionStore, $output->getUser(), $isMobile
);
}
if ( HookUtils::isFeatureEnabledForOutput( $output, HookUtils::REPLYTOOL ) ) {
$output->enableOOUI();
$text = CommentFormatter::postprocessReplyTool(
$text, $lang, $isMobile
);
}
if (
CommentFormatter::isEmptyTalkPage( $text ) &&
HookUtils::shouldDisplayEmptyState( $output->getContext() )
) {
$output->enableOOUI();
$text = CommentFormatter::appendToEmptyTalkPage(
$text, $this->getEmptyStateHtml( $output->getContext() )
);
$output->addBodyClasses( 'ext-discussiontools-emptystate-shown' );
}
if ( HookUtils::isFeatureEnabledForOutput( $output, HookUtils::VISUALENHANCEMENTS ) ) {
$output->enableOOUI();
if ( HookUtils::isFeatureEnabledForOutput( $output, HookUtils::TOPICSUBSCRIPTION ) ) {
$output->addModuleStyles( [
// Visually enhanced topic subscriptions
// bell, bellOutline
'oojs-ui.styles.icons-alerts',
] );
}
if (
$isMobile ||
(
HookUtils::isFeatureEnabledForOutput( $output, HookUtils::VISUALENHANCEMENTS_REPLY ) &&
CommentFormatter::isLanguageRequiringReplyIcon( $lang )
)
) {
$output->addModuleStyles( [
// Reply button:
// share
'oojs-ui.styles.icons-content',
] );
}
if ( $isMobile ) {
$output->addModuleStyles( [
// Mobile overflow menu:
// ellipsis
'oojs-ui.styles.icons-interactions',
// edit
'oojs-ui.styles.icons-editing-core',
] );
}
$text = CommentFormatter::postprocessVisualEnhancements(
$text, $lang, $output->getUser(), $isMobile
);
$subtitle = CommentFormatter::postprocessVisualEnhancementsSubtitle(
$text, $lang, $output->getUser()
);
if ( $subtitle ) {
$output->addSubtitle( $subtitle );
}
}
return true;
}
/**
* OutputPageParserOutput hook handler
* @see https://www.mediawiki.org/wiki/Manual:Hooks/OutputPageParserOutput
*
* @param OutputPage $output
* @param ParserOutput $pout ParserOutput instance being added in $output
* @return void This hook must not abort, it must return no value
*/
public function onOutputPageParserOutput( $output, $pout ): void {
CommentFormatter::postprocessTableOfContents( $pout, $output->getLanguage() );
}
/**
* GetActionName hook handler
*
* @param IContextSource $context Request context
* @param string &$action Default action name, reassign to change it
* @return void This hook must not abort, it must return no value
*/
public function onGetActionName( IContextSource $context, string &$action ): void {
if ( $action === 'edit' && (
HookUtils::shouldOpenNewTopicTool( $context ) ||
HookUtils::shouldDisplayEmptyState( $context )
) ) {
$action = 'view';
}
}
/**
* BeforeDisplayNoArticleText hook handler
* @see https://www.mediawiki.org/wiki/Manual:Hooks/BeforeDisplayNoArticleText
*
* @param Article $article The (empty) article
* @return bool|void This hook can abort
*/
public function onBeforeDisplayNoArticleText( $article ) {
// We want to override the empty state for articles on which we would be enabled
$context = $article->getContext();
if ( !HookUtils::shouldDisplayEmptyState( $context ) ) {
// Our empty states are all about using the new topic tool, but
// expect to be on a talk page, so fall back if it's not
// available or if we're in a non-talk namespace that still has
// DT features enabled
return true;
}
$output = $context->getOutput();
$output->enableOOUI();
$output->disableClientCache();
$html = $this->getEmptyStateHtml( $context );
$output->addHTML(
// This being mw-parser-output is a lie, but makes the reply controller cope much better with everything
Html::rawElement( 'div', [ 'class' => 'mw-parser-output noarticletext' ], $html )
);
$output->addBodyClasses( 'ext-discussiontools-emptystate-shown' );
return false;
}
/**
* Generate HTML markup for the new topic tool's empty state, shown on talk pages that don't exist
* or have no topics.
*
* @param IContextSource $context
* @return string HTML
*/
private function getEmptyStateHtml( IContextSource $context ): string {
$coreConfig = RequestContext::getMain()->getConfig();
$iconpath = $coreConfig->get( 'ExtensionAssetsPath' ) . '/DiscussionTools/images';
$dir = $context->getLanguage()->getDir();
$lang = $context->getLanguage()->getHtmlCode();
$titleMsg = false;
$descMsg = false;
$descParams = [];
$buttonMsg = 'discussiontools-emptystate-button';
$title = $context->getTitle();
if ( $title->getNamespace() == NS_USER_TALK && !$title->isSubpage() ) {
// This is a user talk page
$isIP = $this->userNameUtils->isIP( $title->getText() );
if ( $title->equals( $context->getUser()->getTalkPage() ) ) {
// This is your own user talk page
if ( $isIP ) {
// You're an IP editor, so this is only *sort of* your talk page
$titleMsg = 'discussiontools-emptystate-title-self-anon';
$descMsg = 'discussiontools-emptystate-desc-self-anon';
$query = $context->getRequest()->getValues();
unset( $query['title'] );
$descParams = [
SpecialPage::getTitleFor( 'CreateAccount' )->getFullURL( [
'returnto' => $context->getTitle()->getFullText(),
'returntoquery' => wfArrayToCgi( $query ),
] ),
SpecialPage::getTitleFor( 'Userlogin' )->getFullURL( [
'returnto' => $context->getTitle()->getFullText(),
'returntoquery' => wfArrayToCgi( $query ),
] ),
];
} else {
// You're logged in, this is very much your talk page
$titleMsg = 'discussiontools-emptystate-title-self';
$descMsg = 'discussiontools-emptystate-desc-self';
}
$buttonMsg = false;
} elseif ( $isIP ) {
// This is an IP editor
$titleMsg = 'discussiontools-emptystate-title-user-anon';
$descMsg = 'discussiontools-emptystate-desc-user-anon';
} else {
// This is any other user
$titleMsg = 'discussiontools-emptystate-title-user';
$descMsg = 'discussiontools-emptystate-desc-user';
}
} else {
// This is any other page on which DT is enabled
$titleMsg = 'discussiontools-emptystate-title';
$descMsg = 'discussiontools-emptystate-desc';
}
$text =
Html::rawElement( 'h3', [],
$context->msg( $titleMsg )->parse()
) .
Html::rawElement( 'div', [ 'class' => 'plainlinks' ],
$context->msg( $descMsg, $descParams )->parseAsBlock()
);
if ( $buttonMsg ) {
$text .= new ButtonWidget( [
'label' => $context->msg( $buttonMsg )->text(),
'href' => $title->getLocalURL( 'action=edit&section=new' ),
'flags' => [ 'primary', 'progressive' ]
] );
}
$wrapped =
Html::rawElement( 'div', [ 'class' => 'ext-discussiontools-emptystate' ],
Html::rawElement( 'div', [ 'class' => 'ext-discussiontools-emptystate-text' ], $text ) .
Html::element( 'img', [
'src' => $iconpath . '/emptystate.svg',
'class' => 'ext-discussiontools-emptystate-logo',
// This is a purely decorative element
'alt' => '',
] )
);
return $wrapped;
}
/**
* @param Title $title Title object for the page the edit notices are for
* @param int $oldid Revision ID that the edit notices are for (or 0 for latest)
* @param array &$notices Array of notices. Keys are i18n message keys, values are
* parseAsBlock()ed messages.
* @return bool|void True or no return value to continue or false to abort
*/
public function onTitleGetEditNotices( $title, $oldid, &$notices ) {
$context = RequestContext::getMain();
if (
// Hint is active
$this->userOptionsLookup->getOption( $context->getUser(), 'discussiontools-newtopictool-hint-shown' ) &&
// Turning off the new topic tool also dismisses the hint
$this->userOptionsLookup->getOption( $context->getUser(), 'discussiontools-' . HookUtils::NEWTOPICTOOL ) &&
// Only show when following the link from the new topic tool, never on normal edit attempts.
// This can be called from within ApiVisualEditor, so we can't access most request parameters
// for the main request. However, we can access 'editintro', because it's passed to the API.
$context->getRequest()->getRawVal( 'editintro' ) === 'mw-dt-topic-hint'
) {
$context->getOutput()->enableOOUI();
$returnUrl = $title->getFullURL( [
'action' => 'edit',
'section' => 'new',
'dtenable' => '1',
] );
$prefUrl = SpecialPage::getTitleFor( 'Preferences' )
->createFragmentTarget( 'mw-prefsection-editing-discussion' )->getFullURL();
$topicHint = new MessageWidget( [
'label' => new HtmlSnippet( wfMessage( 'discussiontools-newtopic-legacy-hint-return' )
->params( $returnUrl, $prefUrl )->parse() ),
'icon' => 'article',
'classes' => [ 'ext-discussiontools-ui-newTopic-hint-return' ],
] );
// Add our notice above the built-in ones
$notices = [
'discussiontools-newtopic-legacy-hint-return' => (string)$topicHint,
] + $notices;
}
}
}