wiki.techinc.nl/includes/block/SystemBlock.php
Thalia df20197250 Introduce a formatter service for block errors
The main reasons for adding this service layer are:
* It allows error messages to be more consistent, by defining
  a set of reportable information that can describe any block
  type and is consistently formatted.
* It decouples formatting from the block classes, removing
  their dependency on language, for the most part.

The service provides one public method, getMessage, which
returns a Message object whose key and parameters are
determined by the type of block. This should be used instead
of the deprecated AbstractBlock::getPermissionsError and
AbstractBlock::getBlockErrorParams.

Calls to AbstractBlock::getPermissionsError are replaced in
this patch.

Bug: T227174
Change-Id: I8caae7e30a46ef7120a86a4e5e6f30ae00855063
2019-10-08 12:29:23 +01:00

97 lines
2.8 KiB
PHP

<?php
/**
* Class for temporary blocks created on enforcement.
*
* This program 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.
*
* This program 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 this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
namespace MediaWiki\Block;
/**
* System blocks are temporary blocks that are created on enforcement (e.g.
* from IP blacklists) and are not saved to the database. The target of a
* system block is an IP address. System blocks do not give rise to
* autoblocks and are not tracked with cookies.
*
* @since 1.34
*/
class SystemBlock extends AbstractBlock {
/** @var string|null */
private $systemBlockType;
/**
* Create a new block with specified parameters on a user, IP or IP range.
*
* @param array $options Parameters of the block, with options supported by
* `AbstractBlock::__construct`, and also:
* - systemBlock: (string) Indicate that this block is automatically created by
* MediaWiki rather than being stored in the database. Value is a string to
* return from self::getSystemBlockType().
*/
public function __construct( array $options = [] ) {
parent::__construct( $options );
$defaults = [
'systemBlock' => null,
];
$options += $defaults;
$this->systemBlockType = $options['systemBlock'];
}
/**
* Get the system block type, if any. A SystemBlock can have the following types:
* - 'proxy': the IP is blacklisted in $wgProxyList
* - 'dnsbl': the IP is associated with a blacklisted domain in $wgDnsBlacklistUrls
* - 'wgSoftBlockRanges': the IP is covered by $wgSoftBlockRanges
* - 'global-block': for backwards compatability with the UserIsBlockedGlobally hook
*
* @since 1.29
* @return string|null
*/
public function getSystemBlockType() {
return $this->systemBlockType;
}
/**
* @inheritDoc
*/
public function getIdentifier() {
return $this->getSystemBlockType();
}
/**
* @inheritDoc
*/
public function appliesToPasswordReset() {
switch ( $this->getSystemBlockType() ) {
case null:
case 'global-block':
return $this->isCreateAccountBlocked();
case 'proxy':
return true;
case 'dnsbl':
case 'wgSoftBlockRanges':
return false;
default:
return true;
}
}
}