Preferences.php
No OneTemporary
Actions

Size

6 KB

Referenced Files

None

Subscribers

None

Preferences.php
View Options

	<?php

	namespace MediaWiki\CheckUser\HookHandler;

	use MediaWiki\CheckUser\Logging\TemporaryAccountLoggerFactory;
	use MediaWiki\Config\Config;
	use MediaWiki\Context\RequestContext;
	use MediaWiki\Language\Language;
	use MediaWiki\Permissions\PermissionManager;
	use MediaWiki\Preferences\Hook\GetPreferencesHook;
	use MediaWiki\User\UserIdentity;
	use MessageLocalizer;

	class Preferences implements GetPreferencesHook {

	/** @var string */
	public const INVESTIGATE_TOUR_SEEN = 'checkuser-investigate-tour-seen';

	/** @var string */
	public const INVESTIGATE_FORM_TOUR_SEEN = 'checkuser-investigate-form-tour-seen';

	/** @var string Preference value used to indicate that the CheckUser helper table should collapse on load */
	public const CHECKUSER_HELPER_ALWAYS_COLLAPSE_BY_DEFAULT = 'always';

	/** @var string Preference value used to indicate that the CheckUser helper table should never collapse on load */
	public const CHECKUSER_HELPER_NEVER_COLLAPSE_BY_DEFAULT = 'never';

	/**
	* @var string Preference value used to indicate that the site configuration value should be used to determine
	* if to collapse the CheckUser helper table on load
	*/
	public const CHECKUSER_HELPER_USE_CONFIG_TO_COLLAPSE_BY_DEFAULT = 'config';

	private PermissionManager $permissionManager;
	private TemporaryAccountLoggerFactory $loggerFactory;
	private Language $language;
	private MessageLocalizer $messageLocalizer;
	private Config $config;

	/**
	* @param PermissionManager $permissionManager
	* @param TemporaryAccountLoggerFactory $loggerFactory
	* @param Config $config
	*/
	public function __construct(
	PermissionManager $permissionManager,
	TemporaryAccountLoggerFactory $loggerFactory,
	Config $config
	) {
	$this->permissionManager = $permissionManager;
	$this->loggerFactory = $loggerFactory;
	$this->config = $config;
	$this->messageLocalizer = RequestContext::getMain();
	$this->language = RequestContext::getMain()->getLanguage();
	}

	/**
	* @inheritDoc
	*/
	public function onGetPreferences( $user, &$preferences ) {
	$preferences[self::INVESTIGATE_TOUR_SEEN] = [
	'type' => 'api',
	];

	$preferences[self::INVESTIGATE_FORM_TOUR_SEEN] = [
	'type' => 'api',
	];

	if (
	$this->permissionManager->userHasRight( $user, 'checkuser-temporary-account' ) &&
	!$this->permissionManager->userHasRight( $user, 'checkuser-temporary-account-no-preference' )
	) {
	$preferences['checkuser-temporary-account-enable-description'] = [
	'type' => 'info',
	'default' => $this->messageLocalizer->msg( 'checkuser-tempaccount-enable-preference-description' )
	->parse(),
	// The following message is generated here:
	// * prefs-checkuser-tempaccount
	'section' => 'personal/checkuser-tempaccount',
	'raw' => true,
	// Forces the info text to be shown on Special:GlobalPreferences, as 'info' preference types are
	// excluded by default. This needs to be shown as it contains important information about
	// what checking the checkbox below this text means.
	'canglobal' => true,
	];
	$preferences['checkuser-temporary-account-enable'] = [
	'type' => 'toggle',
	'label-message' => 'checkuser-tempaccount-enable-preference',
	'section' => 'personal/checkuser-tempaccount',
	];
	}

	if ( $this->permissionManager->userHasRight( $user, 'checkuser' ) ) {
	$collapseByDefaultSiteConfig = $this->config->get( 'CheckUserCollapseCheckUserHelperByDefault' );

	$defaultPreferenceMessage = $this->messageLocalizer
	->msg( 'checkuser-helper-table-collapse-by-default-preference-default' );
	$alwaysPreferenceMessage = $this->messageLocalizer
	->msg( 'checkuser-helper-table-collapse-by-default-preference-always' )->escaped();
	$neverPreferenceMessage = $this->messageLocalizer
	->msg( 'checkuser-helper-table-collapse-by-default-preference-never' )->escaped();
	if ( is_int( $collapseByDefaultSiteConfig ) ) {
	$defaultPreferenceMessage->numParams( $collapseByDefaultSiteConfig );
	} elseif ( $collapseByDefaultSiteConfig ) {
	$defaultPreferenceMessage->rawParams( $alwaysPreferenceMessage );
	} else {
	$defaultPreferenceMessage->rawParams( $neverPreferenceMessage );
	}
	$defaultPreferenceMessage = $defaultPreferenceMessage->escaped();

	$preferences['checkuser-helper-table-collapse-by-default'] = [
	'type' => 'limitselect',
	'label-message' => 'checkuser-helper-table-collapse-by-default-preference',
	'options' => [
	$defaultPreferenceMessage => self::CHECKUSER_HELPER_USE_CONFIG_TO_COLLAPSE_BY_DEFAULT,
	$alwaysPreferenceMessage => self::CHECKUSER_HELPER_ALWAYS_COLLAPSE_BY_DEFAULT,
	$neverPreferenceMessage => self::CHECKUSER_HELPER_NEVER_COLLAPSE_BY_DEFAULT,
	],
	// The following message is generated here:
	// * prefs-checkuser
	'section' => 'rc/checkuser',
	];

	// Generate options for the list which are the same as the options for the number of results per page in
	// Special:CheckUser (see AbstractCheckUserPager::__construct).
	$maximumRowCount = $this->config->get( 'CheckUserMaximumRowCount' );
	$rowCountOptions = [
	$maximumRowCount / 25,
	$maximumRowCount / 10,
	$maximumRowCount / 5,
	$maximumRowCount / 2,
	$maximumRowCount,
	];
	$rowCountOptions = array_map( 'ceil', $rowCountOptions );
	$rowCountOptions = array_unique( $rowCountOptions );
	$rowCountOptions = array_map( 'intval', $rowCountOptions );

	foreach ( $rowCountOptions as $option ) {
	$preferences['checkuser-helper-table-collapse-by-default']
	['options'][$this->language->formatNum( $option )] = $option;
	}
	}
	}

	/**
	* @param UserIdentity $user
	* @param array &$modifiedOptions
	* @param array $originalOptions
	*/
	public function onSaveUserOptions( UserIdentity $user, array &$modifiedOptions, array $originalOptions ) {
	$wasEnabled = !empty( $originalOptions['checkuser-temporary-account-enable'] );
	$wasDisabled = !$wasEnabled;

	$willEnable = !empty( $modifiedOptions['checkuser-temporary-account-enable'] );
	$willDisable = isset( $modifiedOptions['checkuser-temporary-account-enable'] ) &&
	!$modifiedOptions['checkuser-temporary-account-enable'];

	if (
	( $wasDisabled && $willEnable ) \|\|
	( $wasEnabled && $willDisable )
	) {
	$logger = $this->loggerFactory->getLogger();
	if ( $willEnable ) {
	$logger->logAccessEnabled( $user );
	} else {
	$logger->logAccessDisabled( $user );
	}
	}
	}

	}

File Metadata

Mime Type: text/x-php
Expires: Sun, Oct 4, 00:32 (3 w, 1 d ago)
Storage Engine: local-disk
Storage Format: Raw Data
Storage Handle: 77/f8/0c07cda03dcc4141137b48ad0f31
Default Alt Text: Preferences.php (6 KB)

Preferences.phpNo OneTemporaryActions

Preferences.phpView Options

File Metadata

Event Timeline

Preferences.php
No OneTemporary
Actions

Preferences.php
View Options