Thijs/wiki.techinc.nl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add showPendingTakeover method to OutputPage

Browse source 
This is upstreaming a pattern that's used in VisualEditor,
DiscussionTools, and (prompting this patch) MobileFrontend. These
extensions all take over certain views and want to avoid a flash of
non-taken-over content by using a hook to replace them with a "please
wait" loading message that'll redirect to a fallback page if the user
turns out to not have JavaScript enabled(or if it is but ResourceLoader
isn't available).

Change-Id: I8f25f53a05ce0437b0e9f63033cc151213c797bf
This commit is contained in:
David Lynch 2023-04-05 11:00:28 -05:00
parent 86c274f318
commit 89fc63599e
1 changed files with 50 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

50
includes/OutputPage.php
View file

@ -3215,6 +3215,56 @@ class OutputPage extends ContextSource {
$this->addReturnTo( $linkTarget, wfCgiToArray( $returntoquery ) );
}
/**
* Output a standard "wait for takeover" warning
*
* This is useful for extensions which are hooking an action and
* suppressing its normal output so it can be taken over with JS.
*
* showPendingTakeover( 'url', 'pagetextmsg' );
* showPendingTakeover( 'url', 'pagetextmsg', [ 'param1', 'param2' ] );
* showPendingTakeover( 'url', $messageObject );
*
* @param string $fallbackUrl URL to redirect to if the user doesn't have JavaScript
* or ResourceLoader available; this should ideally be to a page that provides similar
* functionality without requiring JavaScript
* @param string|Message $msg Message key (string) for page text, or a Message object
* @param string|string[]|MessageSpecifier $params Message parameters; ignored if $msg
* is a Message object
*/
public function showPendingTakeover(
$fallbackUrl, $msg, $params = []
) {
if ( $msg instanceof Message ) {
if ( $params !== [] ) {
trigger_error( 'Argument ignored: $params. The message parameters argument '
. 'is discarded when the $msg argument is a Message object instead of '
. 'a string.', E_USER_NOTICE );
}
$this->addHTML( $msg->parseAsBlock() );
} else {
$this->addWikiMsgArray( $msg, $params );
}
// Redirect if the user has no JS (<noscript>)
$escapedUrl = htmlspecialchars( $fallbackUrl );
$this->addHeadItem(
'mw-noscript-fallback',
// https://html.spec.whatwg.org/#attr-meta-http-equiv-refresh
// means that if $fallbackUrl contains unencoded quotation marks
// then this will behave confusingly, but shouldn't break the page
"<noscript><meta http-equiv=\"refresh\" content=\"0; url=$escapedUrl\"></noscript>"
);
// Redirect if the user has no ResourceLoader
$this->addScript( Html::inlineScript(
"(window.NORLQ=window.NORLQ||[]).push(" .
"function(){" .
"location.href=" . json_encode( $fallbackUrl ) . ";" .
"}" .
");"
) );
}
private function getRlClientContext() {
if ( !$this->rlClientContext ) {
$query = ResourceLoader::makeLoaderQuery(