SpecialGlobalBlockList.php
No OneTemporary
Actions

Size

7 KB

Referenced Files

None

Subscribers

None

SpecialGlobalBlockList.php
View Options

	<?php

	namespace MediaWiki\Extension\GlobalBlocking\Special;

	use MediaWiki\CommentFormatter\CommentFormatter;
	use MediaWiki\Context\DerivativeContext;
	use MediaWiki\Extension\GlobalBlocking\Services\GlobalBlockingConnectionProvider;
	use MediaWiki\Extension\GlobalBlocking\Services\GlobalBlockingGlobalBlockDetailsRenderer;
	use MediaWiki\Extension\GlobalBlocking\Services\GlobalBlockingLinkBuilder;
	use MediaWiki\Extension\GlobalBlocking\Services\GlobalBlockLookup;
	use MediaWiki\Extension\GlobalBlocking\Widget\HTMLUserTextFieldAllowingGlobalBlockIds;
	use MediaWiki\HTMLForm\HTMLForm;
	use MediaWiki\Message\Message;
	use MediaWiki\SpecialPage\FormSpecialPage;
	use MediaWiki\Status\Status;
	use MediaWiki\User\CentralId\CentralIdLookup;
	use MediaWiki\User\UserNameUtils;
	use Wikimedia\IPUtils;
	use Wikimedia\Rdbms\RawSQLExpression;

	class SpecialGlobalBlockList extends FormSpecialPage {
	protected string $target;
	protected array $options;
	private array $conds;
	private bool $queryValid;

	private UserNameUtils $userNameUtils;
	private CommentFormatter $commentFormatter;
	private CentralIdLookup $lookup;
	private GlobalBlockLookup $globalBlockLookup;
	private GlobalBlockingLinkBuilder $globalBlockingLinkBuilder;
	private GlobalBlockingConnectionProvider $globalBlockingConnectionProvider;
	private GlobalBlockingGlobalBlockDetailsRenderer $globalBlockDetailsRenderer;

	public function __construct(
	UserNameUtils $userNameUtils,
	CommentFormatter $commentFormatter,
	CentralIdLookup $lookup,
	GlobalBlockLookup $globalBlockLookup,
	GlobalBlockingLinkBuilder $globalBlockingLinkBuilder,
	GlobalBlockingConnectionProvider $globalBlockingConnectionProvider,
	GlobalBlockingGlobalBlockDetailsRenderer $globalBlockDetailsRenderer
	) {
	parent::__construct( 'GlobalBlockList' );

	$this->userNameUtils = $userNameUtils;
	$this->commentFormatter = $commentFormatter;
	$this->lookup = $lookup;
	$this->globalBlockLookup = $globalBlockLookup;
	$this->globalBlockingLinkBuilder = $globalBlockingLinkBuilder;
	$this->globalBlockingConnectionProvider = $globalBlockingConnectionProvider;
	$this->globalBlockDetailsRenderer = $globalBlockDetailsRenderer;
	}

	/**
	* @param string $par Parameters of the URL, probably the IP being actioned
	* @return void
	*/
	public function execute( $par ) {
	parent::execute( $par );
	$this->addHelpLink( 'Extension:GlobalBlocking' );

	$out = $this->getOutput();
	$out->setSubtitle( $this->globalBlockingLinkBuilder->buildSubtitleLinks( $this ) );
	$out->setArticleRelated( false );
	$out->disableClientCache();
	}

	/**
	* @param string\|null $par Parameter from the URL, may be null or a string
	*/
	protected function setParameter( $par ) {
	$request = $this->getRequest();
	// IP is a deprecated name for the target field, which is retained to not
	// break existing links specifying the 'ip' parameter a GET parameter.
	$target = trim( $request->getText( 'target', $request->getText( 'ip', $par ?? '' ) ) );

	if ( IPUtils::isValidRange( $target ) ) {
	$target = IPUtils::sanitizeRange( $target ) ?? $target;
	} elseif ( IPUtils::isValid( $target ) ) {
	$target = IPUtils::sanitizeIP( $target ) ?? $target;
	} else {
	$target = $this->userNameUtils->getCanonical( $target ) ?: $target;
	}
	$this->target = $target;

	$this->options = $request->getArray( 'wpOptions', [] );
	}

	protected function getFormFields() {
	$optionsMessages = [
	'globalblocking-list-tempblocks' => 'tempblocks',
	'globalblocking-list-indefblocks' => 'indefblocks',
	'globalblocking-list-autoblocks' => 'autoblocks',
	'globalblocking-list-userblocks' => 'userblocks',
	'globalblocking-list-addressblocks' => 'addressblocks',
	'globalblocking-list-rangeblocks' => 'rangeblocks',
	];
	return [
	'target' => [
	'class' => HTMLUserTextFieldAllowingGlobalBlockIds::class,
	'ipallowed' => true,
	'iprange' => true,
	'iprangelimits' => $this->getConfig()->get( 'GlobalBlockingCIDRLimit' ),
	'name' => 'target',
	'id' => 'mw-globalblocking-search-target',
	'label-message' => 'globalblocking-target-with-block-ids',
	'default' => $this->target,
	],
	'Options' => [
	'type' => 'multiselect',
	'options-messages' => $optionsMessages,
	'flatlist' => true,
	],
	];
	}

	protected function alterForm( HTMLForm $form ) {
	$context = new DerivativeContext( $this->getContext() );
	$context->setTitle( $this->getPageTitle() ); // remove subpage
	$form->setName( 'globalblocklist-search' )
	->setSubmitTextMsg( 'globalblocking-search-submit' )
	->setWrapperLegendMsg( 'globalblocking-search-legend' )
	->setContext( $context );
	}

	public function onSubmit( array $data ) {
	$this->queryValid = true;
	// Build a list of blocks.
	$conds = [];

	$dbr = $this->globalBlockingConnectionProvider->getReplicaGlobalBlockingDatabase();
	if ( $this->target !== '' ) {
	$globalBlockId = GlobalBlockLookup::isAGlobalBlockId( $this->target );
	if ( $globalBlockId ) {
	$targetExpr = $dbr->expr( 'gb_id', '=', $globalBlockId );
	} else {
	if ( IPUtils::isIPAddress( $this->target ) ) {
	$ip = $this->target;
	$centralId = 0;
	} else {
	$ip = null;
	$centralId = $this->lookup->centralIdFromName( $this->target, $this->getAuthority() );
	}
	$targetExpr = $this->globalBlockLookup->getGlobalBlockLookupConditions(
	$ip, $centralId,
	GlobalBlockLookup::SKIP_ALLOWED_RANGES_CHECK \| GlobalBlockLookup::SKIP_AUTOBLOCKS
	);
	}
	if ( $targetExpr === null ) {
	$this->queryValid = false;
	return Status::newFatal( 'nosuchusershort', $this->target );
	}
	$conds[] = $targetExpr;
	}

	$hideIP = in_array( 'addressblocks', $this->options );
	$hideRange = in_array( 'rangeblocks', $this->options );
	$hideUser = in_array( 'userblocks', $this->options );
	$hideAutoblocks = in_array( 'autoblocks', $this->options );

	if ( $hideIP && $hideRange && $hideUser && $hideAutoblocks ) {
	$this->queryValid = false;
	}
	if ( $hideIP ) {
	$conds[] = $dbr->orExpr( [
	new RawSQLExpression( 'gb_range_end > gb_range_start' ),
	$dbr->expr( 'gb_target_central_id', '!=', 0 ),
	] );
	}
	if ( $hideRange ) {
	$conds[] = 'gb_range_end = gb_range_start';
	}
	if ( $hideUser ) {
	$conds['gb_target_central_id'] = 0;
	}
	if ( $hideAutoblocks ) {
	$conds['gb_autoblock_parent_id'] = 0;
	}

	$hideTemp = in_array( 'tempblocks', $this->options );
	$hideIndef = in_array( 'indefblocks', $this->options );
	if ( $hideTemp && $hideIndef ) {
	$this->queryValid = false;
	} elseif ( $hideTemp ) {
	$conds['gb_expiry'] = $dbr->getInfinity();
	} elseif ( $hideIndef ) {
	$conds[] = $dbr->expr( 'gb_expiry', '!=', $dbr->getInfinity() );
	}
	$this->conds = $conds;

	return true;
	}

	public function onSuccess() {
	// If the form data was valid, then use the WHERE conditions generated from it to get a page of results.
	$pager = new GlobalBlockListPager(
	$this->getContext(),
	$this->conds,
	$this->getLinkRenderer(),
	$this->commentFormatter,
	$this->globalBlockingLinkBuilder,
	$this->globalBlockingConnectionProvider,
	$this->globalBlockDetailsRenderer
	);

	if ( $this->queryValid && $pager->getNumRows() ) {
	$this->getOutput()->addParserOutputContent( $pager->getFullOutput() );
	} else {
	$this->noResults();
	}
	}

	/**
	* Display an error when no results are found for those parameters
	* @return void
	*/
	private function noResults() {
	$this->getOutput()->wrapWikiMsg(
	"<div class='mw-globalblocking-noresults'>\n$1</div>\n",
	[ 'globalblocking-list-noresults' ]
	);
	}

	public function getShowAlways(): bool {
	return true;
	}

	protected function getDisplayFormat(): string {
	return 'ooui';
	}

	public function getDescription(): Message {
	return $this->msg( 'globalblocking-list' );
	}

	public function requiresPost(): bool {
	return false;
	}

	/**
	* @codeCoverageIgnore
	* @return string
	*/
	protected function getGroupName(): string {
	return 'users';
	}
	}

File Metadata

Mime Type: text/x-php
Expires: Sat, May 16, 14:58 (21 h, 34 m)
Storage Engine: local-disk
Storage Format: Raw Data
Storage Handle: 70/f1/82cba197776913a063401c36501f
Default Alt Text: SpecialGlobalBlockList.php (7 KB)

SpecialGlobalBlockList.phpNo OneTemporaryActions

SpecialGlobalBlockList.phpView Options

File Metadata

Event Timeline

SpecialGlobalBlockList.php
No OneTemporary
Actions

SpecialGlobalBlockList.php
View Options