mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/Popups
synced 2024-11-23 23:24:39 +00:00
75ef7c4f93
Bug: T168384 Change-Id: I8d7b750503ca9c951267a948862c3685ea036100
223 lines
5.9 KiB
PHP
223 lines
5.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 MediaWiki\Logger\LoggerFactory;
|
|
use MediaWiki\MediaWikiServices;
|
|
use ExtensionRegistry;
|
|
use Config;
|
|
use Popups\EventLogging\EventLogger;
|
|
use Popups\EventLogging\EventLoggerFactory;
|
|
use Popups\EventLogging\MWEventLogger;
|
|
use Popups\EventLogging\NullLogger;
|
|
|
|
/**
|
|
* Popups Module
|
|
*
|
|
* @package Popups
|
|
*/
|
|
class PopupsContext {
|
|
|
|
/**
|
|
* Extension name
|
|
* @var string
|
|
*/
|
|
const EXTENSION_NAME = 'popups';
|
|
/**
|
|
* Logger channel (name)
|
|
* @var string
|
|
*/
|
|
const LOGGER_CHANNEL = 'popups';
|
|
/**
|
|
* User preference value for enabled Page Previews
|
|
* Identical to \HTMLFeatureField::OPTION_ENABLED in BetaFeatures
|
|
*
|
|
* @var string
|
|
*/
|
|
const PREVIEWS_ENABLED = '1';
|
|
/**
|
|
* User preference value for disabled Page Previews
|
|
* Identical to \HTMLFeatureField::OPTION_DISABLED in BetaFeatures
|
|
*
|
|
* @var string
|
|
*/
|
|
const PREVIEWS_DISABLED = '0';
|
|
/**
|
|
* User preference to enable/disable Page Previews
|
|
* Currently for BETA and regular opt in we use same preference name
|
|
*
|
|
* @var string
|
|
*/
|
|
const PREVIEWS_OPTIN_PREFERENCE_NAME = 'popups';
|
|
/**
|
|
* User preference to enable/disable Page Preivews as a beta feature
|
|
* @var string
|
|
*/
|
|
const PREVIEWS_BETA_PREFERENCE_NAME = 'popups';
|
|
/**
|
|
* @var \Config
|
|
*/
|
|
private $config;
|
|
|
|
/**
|
|
* @var PopupsContext
|
|
*/
|
|
protected static $instance;
|
|
/**
|
|
* Module constructor.
|
|
* @param Config $config Mediawiki configuration
|
|
* @param ExtensionRegistry $extensionRegistry MediaWiki extension registry
|
|
* @param PopupsGadgetsIntegration $gadgetsIntegration Gadgets integration helper
|
|
* @param EventLogger $eventLogger A logger capable of logging EventLogging
|
|
* events
|
|
*/
|
|
protected function __construct( Config $config, ExtensionRegistry $extensionRegistry,
|
|
PopupsGadgetsIntegration $gadgetsIntegration, EventLogger $eventLogger ) {
|
|
/** @todo Use MediaWikiServices Service Locator when it's ready */
|
|
$this->extensionRegistry = $extensionRegistry;
|
|
$this->gadgetsIntegration = $gadgetsIntegration;
|
|
$this->eventLogger = $eventLogger;
|
|
|
|
$this->config = $config;
|
|
}
|
|
|
|
/**
|
|
* Get a PopupsContext instance
|
|
*
|
|
* @return PopupsContext
|
|
*/
|
|
public static function getInstance() {
|
|
if ( !self::$instance ) {
|
|
/** @todo Use MediaWikiServices Service Locator when it's ready */
|
|
|
|
$registry = ExtensionRegistry::getInstance();
|
|
$config = MediaWikiServices::getInstance()->getConfigFactory()
|
|
->makeConfig( PopupsContext::EXTENSION_NAME );
|
|
$gadgetsIntegration = new PopupsGadgetsIntegration( $config, $registry );
|
|
$eventLoggerFactory = new EventLoggerFactory( $config, $registry );
|
|
|
|
self::$instance = new PopupsContext( $config, $registry,
|
|
$gadgetsIntegration, $eventLoggerFactory->get() );
|
|
}
|
|
return self::$instance;
|
|
}
|
|
|
|
/**
|
|
* @param \User $user User whose gadgets settings are being checked
|
|
* @return bool
|
|
*/
|
|
public function conflictsWithNavPopupsGadget( \User $user ) {
|
|
return $this->gadgetsIntegration->conflictsWithNavPopupsGadget( $user );
|
|
}
|
|
/**
|
|
* Is Beta Feature mode enabled
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function isBetaFeatureEnabled() {
|
|
return $this->config->get( 'PopupsBetaFeature' ) === true;
|
|
}
|
|
|
|
/**
|
|
* Get default Page previews state
|
|
*
|
|
* @see PopupsContext::PREVIEWS_ENABLED
|
|
* @see PopupsContext::PREVIEWS_DISABLED
|
|
* @return string
|
|
*/
|
|
public function getDefaultIsEnabledState() {
|
|
return $this->config->get( 'PopupsOptInDefaultState' );
|
|
}
|
|
/**
|
|
* Are Page previews visible on User Preferences Page
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function showPreviewsOptInOnPreferencesPage() {
|
|
return !$this->isBetaFeatureEnabled()
|
|
&& $this->config->get( 'PopupsHideOptInOnPreferencesPage' ) === false;
|
|
}
|
|
|
|
/**
|
|
* @param \User $user User whose preferences are checked
|
|
* @return bool
|
|
*/
|
|
public function shouldSendModuleToUser( \User $user ) {
|
|
if ( $this->isBetaFeatureEnabled() ) {
|
|
return $user->isAnon() ? false :
|
|
\BetaFeatures::isFeatureEnabled( $user, self::PREVIEWS_BETA_PREFERENCE_NAME );
|
|
}
|
|
return $user->isAnon() ? true :
|
|
$user->getOption( self::PREVIEWS_OPTIN_PREFERENCE_NAME ) === self::PREVIEWS_ENABLED;
|
|
}
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
public function areDependenciesMet() {
|
|
$areMet = $this->extensionRegistry->isLoaded( 'TextExtracts' )
|
|
&& $this->extensionRegistry->isLoaded( 'PageImages' );
|
|
|
|
if ( $this->isBetaFeatureEnabled() ) {
|
|
$areMet = $areMet && $this->extensionRegistry->isLoaded( 'BetaFeatures' );
|
|
}
|
|
|
|
return $areMet;
|
|
}
|
|
/**
|
|
* Get module logger
|
|
*
|
|
* @return \Psr\Log\LoggerInterface
|
|
*/
|
|
public function getLogger() {
|
|
return LoggerFactory::getInstance( self::LOGGER_CHANNEL );
|
|
}
|
|
|
|
/**
|
|
* Get Module config
|
|
*
|
|
* @return \Config
|
|
*/
|
|
public function getConfig() {
|
|
return $this->config;
|
|
}
|
|
|
|
/**
|
|
* Log disabled event
|
|
*/
|
|
public function logUserDisabledPagePreviewsEvent() {
|
|
// @see https://phabricator.wikimedia.org/T167365
|
|
$this->eventLogger->log( [
|
|
'pageTitleSource' => 'Special:Preferences',
|
|
'namespaceIdSource' => NS_SPECIAL,
|
|
'pageIdSource' => -1,
|
|
'hovercardsSuppressedByGadget' => false,
|
|
'pageToken' => wfRandomString(),
|
|
'sessionToken' => wfRandomString(), // we don't have access to mw.user.sessionId()
|
|
'action' => 'disabled',
|
|
'isAnon' => false,
|
|
'popupEnabled' => false,
|
|
'previewCountBucket' => 'unknown'
|
|
] );
|
|
}
|
|
|
|
}
|