PopupsContext.php
No OneTemporary
Actions

Size

4 KB

Referenced Files

None

Subscribers

None

PopupsContext.php
View Options

	<?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\Config\Config;
	use MediaWiki\Registration\ExtensionRegistry;
	use MediaWiki\SpecialPage\SpecialPageFactory;
	use MediaWiki\Title\Title;
	use MediaWiki\User\Options\UserOptionsLookup;
	use MediaWiki\User\User;

	/**
	* Popups Module
	*
	* @package Popups
	*/
	class PopupsContext {

	public const EXTENSION_NAME = 'popups';

	/**
	* Logger channel name
	*/
	public const LOGGER_CHANNEL = 'popups';

	/**
	* User preference value for enabled Page Previews
	*/
	public const PREVIEWS_ENABLED = true;

	/**
	* User preference value for disabled Page Previews
	*/
	public const PREVIEWS_DISABLED = false;

	/**
	* Flags passed on to JS representing preferences
	*/
	private const NAV_POPUPS_ENABLED = 1;

	/**
	* @var Config
	*/
	private $config;

	/**
	* @var PopupsContext
	*/
	protected static $instance;

	/**
	* @var ExtensionRegistry
	*/
	private $extensionRegistry;

	/**
	* @var PopupsGadgetsIntegration
	*/
	private $gadgetsIntegration;

	/**
	* @var SpecialPageFactory
	*/
	private $specialPageFactory;

	/**
	* @var UserOptionsLookup
	*/
	private $userOptionsLookup;

	/**
	* @param Config $config Mediawiki configuration
	* @param ExtensionRegistry $extensionRegistry MediaWiki extension registry
	* @param PopupsGadgetsIntegration $gadgetsIntegration Gadgets integration helper
	* @param SpecialPageFactory $specialPageFactory
	* @param UserOptionsLookup $userOptionsLookup
	*/
	public function __construct(
	Config $config,
	ExtensionRegistry $extensionRegistry,
	PopupsGadgetsIntegration $gadgetsIntegration,
	SpecialPageFactory $specialPageFactory,
	UserOptionsLookup $userOptionsLookup
	) {
	$this->config = $config;
	$this->extensionRegistry = $extensionRegistry;
	$this->gadgetsIntegration = $gadgetsIntegration;
	$this->specialPageFactory = $specialPageFactory;
	$this->userOptionsLookup = $userOptionsLookup;
	}

	/**
	* @param User $user User whose gadgets settings are being checked
	* @return bool
	*/
	public function conflictsWithNavPopupsGadget( User $user ) {
	return $this->gadgetsIntegration->conflictsWithNavPopupsGadget( $user );
	}

	/**
	* Are Page previews visible on User Preferences Page
	*
	* @return bool
	*/
	public function showPreviewsOptInOnPreferencesPage() {
	return $this->config->get( 'PopupsHideOptInOnPreferencesPage' ) === false;
	}

	/**
	* @param User $user User whose preferences are checked
	* @return int
	*/
	public function getConfigBitmaskFromUser( User $user ) {
	return ( $this->conflictsWithNavPopupsGadget( $user ) ? self::NAV_POPUPS_ENABLED : 0 );
	}

	/**
	* @return bool
	*/
	public function areDependenciesMet() {
	if ( $this->config->get( 'PopupsGateway' ) === 'mwApiPlain' ) {
	return $this->extensionRegistry->isLoaded( 'TextExtracts' )
	&& $this->extensionRegistry->isLoaded( 'PageImages' );
	}

	return true;
	}

	/**
	* Whether popups code should be shipped to $title
	*
	* For example, if 'Special:UserLogin' is excluded, and the user is on 'Special:UserLogin',
	* then the title is considered excluded.
	*
	* A title is also considered excluded if its root matches one of the page names
	* from the config variable. For example, if 'User:A' is excluded, and the
	* title is 'User:A/b', then this title is considered excluded.
	*
	* Language specific excluded titles affect all languages. For example, if "Main_Page" is
	* excluded, "Bosh_Sahifa" (which is "Main_Page" in Uzbek) is considered excluded too.
	*
	* @param Title $title title being tested
	* @return bool
	*/
	public function isTitleExcluded( $title ) {
	$excludedPages = $this->config->get( 'PopupsPageDisabled' );

	$canonicalTitle = $title->getRootTitle();

	if ( $title->isSpecialPage() ) {
	// it's special page, translate it to canonical name
	[ $name, $subpage ] = $this->specialPageFactory
	->resolveAlias( $canonicalTitle->getText() );

	if ( $name !== null ) {
	$canonicalTitle = Title::newFromText( $name, NS_SPECIAL );
	}
	}

	foreach ( $excludedPages as $page ) {
	$excludedTitle = Title::newFromText( $page );

	if ( $canonicalTitle->equals( $excludedTitle ) ) {
	return true;
	}
	}
	return false;
	}
	}

File Metadata

Mime Type: text/x-php
Expires: Tue, Aug 18, 18:51 (3 w, 1 d ago)
Storage Engine: local-disk
Storage Format: Raw Data
Storage Handle: 4a/82/fe48f3d961a97888a190e725d8ab
Default Alt Text: PopupsContext.php (4 KB)

PopupsContext.phpNo OneTemporaryActions

PopupsContext.phpView Options

File Metadata

Event Timeline

PopupsContext.php
No OneTemporary
Actions

PopupsContext.php
View Options