wikimedia/mediawiki-extensions-DiscussionTools
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/DiscussionTools synced 2024-11-27 17:51:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge "Store reply links in the parser cache"

Browse source
This commit is contained in:
jenkins-bot 2021-01-19 21:35:36 +00:00 committed by Gerrit Code Review
parent 234198d9b1 32789a9a55
commit 994abdac39
2 changed files with 86 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
extension.json
View file

@ -336,12 +336,15 @@
"discussiontoolsedit": "MediaWiki\\Extension\\DiscussionTools\\ApiDiscussionToolsEdit"
},
"Hooks": {
"ArticleParserOptions": "\\MediaWiki\\Extension\\DiscussionTools\\Hooks::onArticleParserOptions",
"BeforePageDisplay": "\\MediaWiki\\Extension\\DiscussionTools\\Hooks::onBeforePageDisplay",
"OutputPageBeforeHTML": "\\MediaWiki\\Extension\\DiscussionTools\\Hooks::onOutputPageBeforeHTML",
"ParserAfterTidy": "\\MediaWiki\\Extension\\DiscussionTools\\Hooks::onParserAfterTidy",
"ParserOptionsRegister": "\\MediaWiki\\Extension\\DiscussionTools\\Hooks::onParserOptionsRegister",
"ResourceLoaderGetConfigVars": "\\MediaWiki\\Extension\\DiscussionTools\\Hooks::onResourceLoaderGetConfigVars",
"GetBetaFeaturePreferences": "\\MediaWiki\\Extension\\DiscussionTools\\Hooks::onGetBetaPreferences",
"GetPreferences": "\\MediaWiki\\Extension\\DiscussionTools\\Hooks::onGetPreferences",
"ListDefinedTags": "\\MediaWiki\\Extension\\DiscussionTools\\Hooks::onListDefinedTags",
"OutputPageBeforeHTML": "\\MediaWiki\\Extension\\DiscussionTools\\Hooks::onOutputPageBeforeHTML",
"ChangeTagsListActive": "\\MediaWiki\\Extension\\DiscussionTools\\Hooks::onListDefinedTags",
"RecentChange_save": "\\MediaWiki\\Extension\\DiscussionTools\\Hooks::onRecentChangeSave"
},
@ -376,6 +379,10 @@
"value": false,
"description": "Enable the 2017 wikitext editor for wikitext mode (not yet supported)."
},
"DiscussionToolsUseParserCache": {
"value": true,
"description": "Allow DiscussionTools to use the parser cache."
},
"DTSchemaEditAttemptStepSamplingRate": {
"value": false,
"description": "Rate at which to sample sessions for instrumentation; overrides WikimediaEvents rate if set"

86
includes/Hooks.php
View file

@ -10,12 +10,16 @@
namespace MediaWiki\Extension\DiscussionTools;
use Action;
use Article;
use ConfigException;
use ExtensionRegistry;
use Language;
use MediaWiki\MediaWikiServices;
use MWExceptionHandler;
use OutputPage;
use PageProps;
use Parser;
use ParserOptions;
use RecentChange;
use RequestContext;
use Skin;
@ -38,6 +42,8 @@ class Hooks {
'discussiontools-visual',
];
private const REPLY_LINKS_COMMENT = '<!-- DiscussionTools addReplyLinks called -->';
public static function onRegistration() : void {
// Use globals instead of Config. Accessing it so early blows up unrelated extensions (T255704).
global $wgLocaltimezone, $wgFragmentMode;
@ -322,6 +328,20 @@ class Hooks {
$dtConfig->get( 'DTSchemaEditAttemptStepOversample' );
}
/**
* @see https://www.mediawiki.org/wiki/Manual:Hooks/ParserAfterTidy
*
* @param Parser $parser
* @param string &$text
*/
public static function onParserAfterTidy( Parser $parser, string &$text ) : void {
$popts = $parser->getOptions();
// ParserOption for dtreply was set in onArticleParserOptions
if ( $popts->getOption( 'dtreply' ) ) {
static::addReplyLinks( $text, $popts->getUserLangObj() );
}
}
/**
* OutputPageBeforeHTML hook handler
* @see https://www.mediawiki.org/wiki/Manual:Hooks/OutputPageBeforeHTML
@ -331,15 +351,37 @@ class Hooks {
* @return bool
*/
public static function onOutputPageBeforeHTML( OutputPage $output, string &$text ) : bool {
// TODO: This is based on the current user, is there an issue with caching?
if ( !static::isFeatureEnabledForOutput( $output, 'replytool' ) ) {
return true;
// Check after the parser cache if reply links need to be added for
// non-cacheable reasons i.e. query string or cookie
// The addReplyLinks method is responsible for ensuring that
// reply links aren't added twice.
if ( static::isFeatureEnabledForOutput( $output, 'replytool' ) ) {
static::addReplyLinks( $text, $output->getLanguage() );
}
return true;
}
/**
* Add reply links to some HTML
*
* @param string &$text Parser text output
* @param Language $lang Interface language
*/
private static function addReplyLinks( string &$text, Language $lang ) {
$start = microtime( true );
// Never add links twice.
// This is required because we try again to add links to cached content
// to support query string or cookie enabling
if ( strpos( $text, static::REPLY_LINKS_COMMENT ) !== false ) {
return;
}
$start = microtime( true );
$text = $text . "\n" . static::REPLY_LINKS_COMMENT;
try {
// Add reply links and hidden data about comment ranges.
$newText = CommentFormatter::addReplyLinks( $text, $output->getLanguage() );
$newText = CommentFormatter::addReplyLinks( $text, $lang );
} catch ( Throwable $e ) {
// Catch errors, so that they don't cause the entire page to not display.
// Log it and add the request ID in a comment to make it easier to find in the logs.
@ -349,17 +391,45 @@ class Hooks {
$info = "<!-- [$requestId] DiscussionTools could not add reply links on this page -->";
$text .= "\n" . $info;
return true;
return;
}
$text = $newText;
$duration = microtime( true ) - $start;
$stats = MediaWikiServices::getInstance()->getStatsdDataFactory();
$stats->timing( 'discussiontools.addReplyLinks', $duration * 1000 );
}
return true;
/**
* @param Article $article Article about to be parsed
* @param ParserOptions $popts Mutable parser options
* @return bool|void True or no return value to continue or false to abort
*/
public static function onArticleParserOptions( Article $article, ParserOptions $popts ) {
$services = MediaWikiServices::getInstance();
$dtConfig = $services->getConfigFactory()->makeConfig( 'discussiontools' );
if (
$dtConfig->get( 'DiscussionToolsUseParserCache' ) &&
static::isAvailableForTitle( $article->getTitle() ) &&
static::isFeatureEnabledForUser( $popts->getUser(), 'replytool' )
) {
$popts->setOption( 'dtreply', true );
}
}
/**
* Register additional parser options
*
* @param array &$defaults
* @param array &$inCacheKey
* @param array &$lazyLoad
* @return bool|void
*/
public static function onParserOptionsRegister( &$defaults, &$inCacheKey, &$lazyLoad ) {
$defaults['dtreply'] = null;
$inCacheKey['dtreply'] = true;
}
/**