1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
<?php
/**
* 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\Api;
use MediaWiki\Block\AbstractBlock;
use MediaWiki\Block\Block;
use MediaWiki\Block\CompositeBlock;
use MediaWiki\Block\DatabaseBlock;
use MediaWiki\Block\SystemBlock;
use MediaWiki\Language\Language;
use MediaWiki\User\UserIdentity;
use MediaWiki\Utils\MWTimestamp;
/**
* Helper class for API modules that display block information. Intended for use via
* composition.
*
* @ingroup API
* @since 1.44
*/
class ApiBlockInfoHelper {
/**
* Get basic info about a given block
*
* @return array Array containing several keys:
* - blockid - ID of the block
* - blockedby - username of the blocker
* - blockedbyid - user ID of the blocker
* - blockreason - reason provided for the block
* - blockedtimestamp - timestamp for when the block was placed/modified
* - blockedtimestampformatted - blockedtimestamp, formatted for the current locale
* - blockexpiry - expiry time of the block
* - blockexpiryformatted - blockexpiry formatted for the current locale, omitted if infinite
* - blockexpiryrelative - relative time to blockexpiry (e.g. 'in 5 days'), omitted if infinite
* - blockpartial - block only applies to certain pages, namespaces and/or actions
* - systemblocktype - system block type, if any
* - blockcomponents - If the block is a composite block, this will be an array of block
* info arrays
*/
public function getBlockDetails(
Block $block,
Language $language,
UserIdentity $user
) {
$blocker = $block->getBlocker();
$vals = [];
$vals['blockid'] = $block->getId();
$vals['blockedby'] = $blocker ? $blocker->getName() : '';
$vals['blockedbyid'] = $blocker ? $blocker->getId() : 0;
$vals['blockreason'] = $block->getReasonComment()
->message->inLanguage( $language )->plain();
$vals['blockedtimestamp'] = wfTimestamp( TS_ISO_8601, $block->getTimestamp() );
$expiry = ApiResult::formatExpiry( $block->getExpiry(), 'infinite' );
$vals['blockexpiry'] = $expiry;
$vals['blockpartial'] = !$block->isSitewide();
$vals['blocknocreate'] = $block->isCreateAccountBlocked();
$vals['blockanononly'] = !$block->isHardblock();
if ( $block instanceof AbstractBlock ) {
$vals['blockemail'] = $block->isEmailBlocked();
$vals['blockowntalk'] = !$block->isUsertalkEditAllowed();
}
// Formatted timestamps
$vals['blockedtimestampformatted'] = $language->formatExpiry(
$block->getTimestamp(), true, 'infinity', $user
);
if ( $expiry !== 'infinite' ) {
$vals['blockexpiryformatted'] = $language->formatExpiry(
$expiry, true, 'infinity', $user
);
$vals['blockexpiryrelative'] = $language->getHumanTimestamp(
new MWTimestamp( $expiry ), new MWTimestamp(), $user
);
}
if ( $block instanceof SystemBlock ) {
$vals['systemblocktype'] = $block->getSystemBlockType();
}
if ( $block instanceof CompositeBlock ) {
$components = [];
foreach ( $block->getOriginalBlocks() as $singleBlock ) {
$components[] = $this->getBlockDetails( $singleBlock, $language, $user );
}
$vals['blockcomponents'] = $components;
}
return $vals;
}
/**
* Get the API error code, to be used in ApiMessage::create or ApiBase::dieWithError
* @param Block $block
* @return string
*/
public function getBlockCode( Block $block ): string {
if ( $block instanceof DatabaseBlock && $block->getType() === Block::TYPE_AUTO ) {
return 'autoblocked';
}
return 'blocked';
}
}
|
