mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/Popups
synced 2024-11-23 23:24:39 +00:00
776f4af6c5
This is a direct follow up for I4d31805. Note the previous patch was only testing the code path when Beta is disabled. But the bug was about what happens when Beta is enabled. This is now properly covered by these tests. Bug: T240947 Change-Id: I54c5e9751e14a94808e85d935e1972eea0395002
243 lines
9 KiB
PHP
243 lines
9 KiB
PHP
<?php
|
|
/*
|
|
* This file is part of the MediaWiki extension Popups.
|
|
*
|
|
* Popups is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* Popups is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with Popups. If not, see <http://www.gnu.org/licenses/>.
|
|
*
|
|
* @file
|
|
* @ingroup extensions
|
|
*/
|
|
namespace Popups;
|
|
|
|
use Config;
|
|
use MediaWiki\MediaWikiServices;
|
|
use OutputPage;
|
|
use Skin;
|
|
use User;
|
|
|
|
/**
|
|
* Hooks definitions for Popups extension
|
|
*
|
|
* @package Popups
|
|
*/
|
|
class PopupsHooks {
|
|
|
|
private const PREVIEWS_PREFERENCES_SECTION = 'rendering/reading';
|
|
|
|
/**
|
|
* Add Page Previews options to user Preferences page
|
|
*
|
|
* @param User $user User whose preferences are being modified
|
|
* @param array[] &$prefs Preferences description array, to be fed to a HTMLForm object
|
|
*/
|
|
public static function onGetPreferences( User $user, array &$prefs ) {
|
|
/** @var PopupsContext $context */
|
|
$context = MediaWikiServices::getInstance()->getService( 'Popups.Context' );
|
|
|
|
if ( !$context->showPreviewsOptInOnPreferencesPage() ) {
|
|
return;
|
|
}
|
|
|
|
$option = [
|
|
'type' => 'radio',
|
|
'label-message' => 'popups-prefs-optin-title',
|
|
'help-message' => 'popups-prefs-conflicting-gadgets-info',
|
|
'options' => [
|
|
wfMessage( 'popups-prefs-optin-enabled-label' )->escaped()
|
|
=> PopupsContext::PREVIEWS_ENABLED,
|
|
wfMessage( 'popups-prefs-optin-disabled-label' )->escaped()
|
|
=> PopupsContext::PREVIEWS_DISABLED
|
|
],
|
|
'section' => self::PREVIEWS_PREFERENCES_SECTION
|
|
];
|
|
if ( $context->conflictsWithNavPopupsGadget( $user ) ) {
|
|
$option[ 'disabled' ] = true;
|
|
$option[ 'help-message' ] = [ 'popups-prefs-disable-nav-gadgets-info',
|
|
'Special:Preferences#mw-prefsection-gadgets' ];
|
|
}
|
|
|
|
$skinPosition = array_search( 'skin', array_keys( $prefs ) );
|
|
$readingOptions = [
|
|
PopupsContext::PREVIEWS_OPTIN_PREFERENCE_NAME => $option,
|
|
];
|
|
|
|
$config = MediaWikiServices::getInstance()->getService( 'Popups.Config' );
|
|
if ( $config->get( 'PopupsReferencePreviews' ) &&
|
|
!$config->get( 'PopupsReferencePreviewsBetaFeature' )
|
|
) {
|
|
$readingOptions[PopupsContext::REFERENCE_PREVIEWS_PREFERENCE_NAME] = [
|
|
'type' => 'toggle',
|
|
'label-message' => 'popups-refpreview-user-preference-label',
|
|
'section' => self::PREVIEWS_PREFERENCES_SECTION,
|
|
'disabled' => $option['disabled'] ?? false,
|
|
];
|
|
}
|
|
|
|
if ( $skinPosition !== false ) {
|
|
$injectIntoIndex = $skinPosition + 1;
|
|
$prefs = array_slice( $prefs, 0, $injectIntoIndex, true )
|
|
+ $readingOptions
|
|
+ array_slice( $prefs, $injectIntoIndex, null, true );
|
|
} else {
|
|
$prefs += $readingOptions;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Allows last minute changes to the output page, e.g. adding of CSS or JavaScript by extensions.
|
|
*
|
|
* @param OutputPage $out The Output page object
|
|
* @param Skin $skin Skin object that will be used to generate the page
|
|
*/
|
|
public static function onBeforePageDisplay( OutputPage $out, Skin $skin ) {
|
|
/** @var PopupsContext $context */
|
|
$context = MediaWikiServices::getInstance()->getService( 'Popups.Context' );
|
|
if ( $context->isTitleBlacklisted( $out->getTitle() ) ) {
|
|
return;
|
|
}
|
|
|
|
if ( !$context->areDependenciesMet() ) {
|
|
$logger = $context->getLogger();
|
|
$logger->error( 'Popups requires the PageImages extensions.
|
|
TextExtracts extension is required when using mwApiPlain gateway.' );
|
|
return;
|
|
}
|
|
|
|
$user = $out->getUser();
|
|
if ( $context->shouldSendModuleToUser( $user ) ) {
|
|
$out->addModules( [ 'ext.popups' ] );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Hook handler for the ResourceLoaderStartUpModule that makes static configuration visible to
|
|
* the frontend. These variables end in the only "startup" ResourceLoader module that is loaded
|
|
* before all others.
|
|
*
|
|
* Dynamic configuration that depends on the context needs to be published via the
|
|
* MakeGlobalVariablesScript hook.
|
|
*
|
|
* @param array &$vars Array of variables to be added into the output of the startup module
|
|
* @param string $skin
|
|
*/
|
|
public static function onResourceLoaderGetConfigVars( array &$vars, $skin ) {
|
|
/** @var Config $config */
|
|
$config = MediaWikiServices::getInstance()->getService( 'Popups.Config' );
|
|
|
|
$vars['wgPopupsVirtualPageViews'] = $config->get( 'PopupsVirtualPageViews' );
|
|
$vars['wgPopupsGateway'] = $config->get( 'PopupsGateway' );
|
|
$vars['wgPopupsEventLogging'] = $config->get( 'PopupsEventLogging' );
|
|
$vars['wgPopupsRestGatewayEndpoint'] = $config->get( 'PopupsRestGatewayEndpoint' );
|
|
$vars['wgPopupsStatsvSamplingRate'] = $config->get( 'PopupsStatsvSamplingRate' );
|
|
}
|
|
|
|
/**
|
|
* Hook handler publishing dynamic configuration that depends on the context, e.g. the page or
|
|
* the users settings. These variables end in an inline <script> in the documents head.
|
|
*
|
|
* Variables added:
|
|
* * `wgPopupsReferencePreviews' - The server's notion of whether or not the reference
|
|
* previews should be enabled. Depending on the general setting done on the wiki and
|
|
* - in cases where the feature is used as BetaFeature - of the user's BetaFeature
|
|
* setting.
|
|
* * `wgPopupsConflictsWithNavPopupGadget' - The server's notion of whether or not the
|
|
* user has enabled conflicting Navigational Popups Gadget.
|
|
*
|
|
* @param array &$vars variables to be added into the output of OutputPage::headElement
|
|
* @param \IContextSource $out OutputPage instance calling the hook
|
|
*/
|
|
public static function onMakeGlobalVariablesScript( array &$vars, \IContextSource $out ) {
|
|
$services = MediaWikiServices::getInstance();
|
|
/** @var PopupsContext $context */
|
|
$context = $services->getService( 'Popups.Context' );
|
|
$user = $out->getUser();
|
|
|
|
// TODO: Remove all references to wgPopupsReferencePreviews when not in Beta any more, and
|
|
// the temporary feature flag is not needed any more.
|
|
$vars['wgPopupsReferencePreviews'] = $context->isReferencePreviewsEnabled( $user );
|
|
$vars['wgPopupsConflictsWithNavPopupGadget'] = $context->conflictsWithNavPopupsGadget(
|
|
$user
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Called whenever a user wants to reset their preferences.
|
|
*
|
|
* @param array &$defaultOptions
|
|
*/
|
|
public static function onUserGetDefaultOptions( array &$defaultOptions ) {
|
|
/** @var Config $config */
|
|
$config = MediaWikiServices::getInstance()->getService( 'Popups.Config' );
|
|
$default = $config->get( 'PopupsOptInDefaultState' );
|
|
$defaultOptions[PopupsContext::PREVIEWS_OPTIN_PREFERENCE_NAME] = $default;
|
|
|
|
// As long as in Beta, don't set a default for Reference Previews. Rely on it either being
|
|
// null (= disabled), or follow what the "betafeatures-auto-enroll" flag says.
|
|
if ( $config->get( 'PopupsReferencePreviews' ) &&
|
|
!$config->get( 'PopupsReferencePreviewsBetaFeature' )
|
|
) {
|
|
$defaultOptions[PopupsContext::REFERENCE_PREVIEWS_PREFERENCE_NAME] = $default;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Called one time when initializing a users preferences for a newly created account.
|
|
*
|
|
* @param User $user Newly created user object
|
|
* @param bool $isAutoCreated
|
|
*/
|
|
public static function onLocalUserCreated( User $user, $isAutoCreated ) {
|
|
/** @var Config $config */
|
|
$config = MediaWikiServices::getInstance()->getService( 'Popups.Config' );
|
|
$default = $config->get( 'PopupsOptInStateForNewAccounts' );
|
|
$user->setOption( PopupsContext::PREVIEWS_OPTIN_PREFERENCE_NAME, $default );
|
|
|
|
// As long as in Beta, don't set a default for Reference Previews. Rely on it either being
|
|
// null (= disabled), or follow what the "betafeatures-auto-enroll" flag says.
|
|
if ( $config->get( 'PopupsReferencePreviews' ) &&
|
|
!$config->get( 'PopupsReferencePreviewsBetaFeature' )
|
|
) {
|
|
$user->setOption( PopupsContext::REFERENCE_PREVIEWS_PREFERENCE_NAME, $default );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Register preferences that enable experimental features.
|
|
*
|
|
* @param User $user User whose preferences are being modified
|
|
* @param array[] &$prefs Array of beta features
|
|
*/
|
|
public static function onGetBetaFeaturePreferences( User $user, array &$prefs ) {
|
|
/** @var Config $config */
|
|
$config = MediaWikiServices::getInstance()->getService( 'Popups.Config' );
|
|
$extensionAssetsPath = $config->get( 'ExtensionAssetsPath' );
|
|
|
|
if ( $config->get( 'PopupsReferencePreviewsBetaFeature' ) &&
|
|
$config->get( 'PopupsReferencePreviews' )
|
|
) {
|
|
$prefs[PopupsContext::REFERENCE_PREVIEWS_PREFERENCE_NAME] = [
|
|
'label-message' => 'popups-refpreview-beta-feature-message',
|
|
'desc-message' => 'popups-refpreview-beta-feature-description',
|
|
'screenshot' => [
|
|
'ltr' => "$extensionAssetsPath/Popups/resources/ext.popups.images/refpreview-beta-ltr.svg",
|
|
'rtl' => "$extensionAssetsPath/Popups/resources/ext.popups.images/refpreview-beta-rtl.svg",
|
|
],
|
|
'info-link' => 'https://mediawiki.org/wiki/Help:Reference_Previews',
|
|
'discussion-link' => 'https://mediawiki.org/wiki/Help_Talk:Reference_Previews',
|
|
];
|
|
}
|
|
}
|
|
|
|
}
|