3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2 of the License, or
6 * (at your option) any later version.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 * http://www.gnu.org/copyleft/gpl.html
25 use MediaWiki\Block\Restriction\Restriction
;
26 use MediaWiki\Block\Restriction\PageRestriction
;
27 use MediaWiki\Block\Restriction\NamespaceRestriction
;
28 use MediaWiki\MediaWikiServices
;
29 use Wikimedia\Rdbms\IResultWrapper
;
31 class BlockListPager
extends TablePager
{
36 * Array of restrictions.
40 protected $restrictions = [];
43 * @param SpecialPage $page
46 public function __construct( $page, $conds ) {
47 $this->conds
= $conds;
48 $this->mDefaultDirection
= IndexPager
::DIR_DESCENDING
;
49 parent
::__construct( $page->getContext() );
52 function getFieldNames() {
53 static $headers = null;
55 if ( $headers === null ) {
57 'ipb_timestamp' => 'blocklist-timestamp',
58 'ipb_target' => 'blocklist-target',
59 'ipb_expiry' => 'blocklist-expiry',
60 'ipb_by' => 'blocklist-by',
61 'ipb_params' => 'blocklist-params',
62 'ipb_reason' => 'blocklist-reason',
64 foreach ( $headers as $key => $val ) {
65 $headers[$key] = $this->msg( $val )->text();
72 function formatValue( $name, $value ) {
74 if ( $msg === null ) {
80 'blocklist-nousertalk',
84 'blocklist-editing-sitewide',
87 foreach ( $keys as $key ) {
88 $msg[$key] = $this->msg( $key )->text();
92 /** @var object $row */
93 $row = $this->mCurrentRow
;
95 $language = $this->getLanguage();
99 $linkRenderer = MediaWikiServices
::getInstance()->getLinkRenderer();
102 case 'ipb_timestamp':
103 $formatted = htmlspecialchars( $language->userTimeAndDate( $value, $this->getUser() ) );
107 if ( $row->ipb_auto
) {
108 $formatted = $this->msg( 'autoblockid', $row->ipb_id
)->parse();
110 list( $target, $type ) = Block
::parseTarget( $row->ipb_address
);
112 case Block
::TYPE_USER
:
114 $formatted = Linker
::userLink( $target->getId(), $target );
115 $formatted .= Linker
::userToolLinks(
119 Linker
::TOOL_LINKS_NOBLOCK
122 case Block
::TYPE_RANGE
:
123 $formatted = htmlspecialchars( $target );
129 $formatted = htmlspecialchars( $language->formatExpiry(
131 /* User preference timezone */true
133 if ( $this->getUser()->isAllowed( 'block' ) ) {
134 if ( $row->ipb_auto
) {
135 $links[] = $linkRenderer->makeKnownLink(
136 SpecialPage
::getTitleFor( 'Unblock' ),
139 [ 'wpTarget' => "#{$row->ipb_id}" ]
142 $links[] = $linkRenderer->makeKnownLink(
143 SpecialPage
::getTitleFor( 'Unblock', $row->ipb_address
),
146 $links[] = $linkRenderer->makeKnownLink(
147 SpecialPage
::getTitleFor( 'Block', $row->ipb_address
),
148 $msg['change-blocklink']
151 $formatted .= ' ' . Html
::rawElement(
153 [ 'class' => 'mw-blocklist-actions' ],
154 $this->msg( 'parentheses' )->rawParams(
155 $language->pipeList( $links ) )->escaped()
158 if ( $value !== 'infinity' ) {
159 $timestamp = new MWTimestamp( $value );
160 $formatted .= '<br />' . $this->msg(
161 'ipb-blocklist-duration-left',
162 $language->formatDuration(
163 $timestamp->getTimestamp() - MWTimestamp
::time(),
177 if ( isset( $row->by_user_name
) ) {
178 $formatted = Linker
::userLink( $value, $row->by_user_name
);
179 $formatted .= Linker
::userToolLinks( $value, $row->by_user_name
);
181 $formatted = htmlspecialchars( $row->ipb_by_text
); // foreign user?
186 $value = CommentStore
::getStore()->getComment( 'ipb_reason', $row )->text
;
187 $formatted = Linker
::formatComment( $value );
193 if ( $this->getConfig()->get( 'EnablePartialBlocks' ) && $row->ipb_sitewide
) {
194 $properties[] = htmlspecialchars( $msg['blocklist-editing-sitewide'] );
197 if ( !$row->ipb_sitewide
&& $this->restrictions
) {
198 $list = $this->getRestrictionListHTML( $row );
200 $properties[] = htmlspecialchars( $msg['blocklist-editing'] ) . $list;
204 if ( $row->ipb_anon_only
) {
205 $properties[] = htmlspecialchars( $msg['anononlyblock'] );
207 if ( $row->ipb_create_account
) {
208 $properties[] = htmlspecialchars( $msg['createaccountblock'] );
210 if ( $row->ipb_user
&& !$row->ipb_enable_autoblock
) {
211 $properties[] = htmlspecialchars( $msg['noautoblockblock'] );
214 if ( $row->ipb_block_email
) {
215 $properties[] = htmlspecialchars( $msg['emailblock'] );
218 if ( !$row->ipb_allow_usertalk
) {
219 $properties[] = htmlspecialchars( $msg['blocklist-nousertalk'] );
222 $formatted = Html
::rawElement(
225 implode( '', array_map( function ( $prop ) {
226 return Html
::rawElement(
236 $formatted = "Unable to format $name";
244 * Get Restriction List HTML
246 * @param stdClass $row
250 private function getRestrictionListHTML( stdClass
$row ) {
252 $linkRenderer = MediaWikiServices
::getInstance()->getLinkRenderer();
254 foreach ( $this->restrictions
as $restriction ) {
255 if ( $restriction->getBlockId() !== (int)$row->ipb_id
) {
259 switch ( $restriction->getType() ) {
260 case PageRestriction
::TYPE
:
261 if ( $restriction->getTitle() ) {
262 $items[$restriction->getType()][] = Html
::rawElement(
265 $linkRenderer->makeLink( $restriction->getTitle() )
269 case NamespaceRestriction
::TYPE
:
270 $text = $restriction->getValue() === NS_MAIN
271 ?
$this->msg( 'blanknamespace' )->text()
272 : $this->getLanguage()->getFormattedNsText(
273 $restriction->getValue()
275 $items[$restriction->getType()][] = Html
::rawElement(
278 $linkRenderer->makeLink(
279 SpecialPage
::getTitleValueFor( 'Allpages' ),
283 'namespace' => $restriction->getValue()
291 if ( empty( $items ) ) {
296 foreach ( $items as $key => $value ) {
297 $sets[] = Html
::rawElement(
300 $this->msg( 'blocklist-editing-' . $key ) . Html
::rawElement(
303 implode( '', $value )
308 return Html
::rawElement(
315 function getQueryInfo() {
316 $commentQuery = CommentStore
::getStore()->getJoin( 'ipb_reason' );
317 $actorQuery = ActorMigration
::newMigration()->getJoin( 'ipb_by' );
320 'tables' => array_merge(
321 [ 'ipblocks' ], $commentQuery['tables'], $actorQuery['tables'], [ 'user' ]
327 'by_user_name' => 'user_name',
331 'ipb_create_account',
332 'ipb_enable_autoblock',
338 'ipb_allow_usertalk',
340 ] +
$commentQuery['fields'] +
$actorQuery['fields'],
341 'conds' => $this->conds
,
343 'user' => [ 'LEFT JOIN', 'user_id = ' . $actorQuery['fields']['ipb_by'] ]
344 ] +
$commentQuery['joins'] +
$actorQuery['joins']
347 # Filter out any expired blocks
348 $db = $this->getDatabase();
349 $info['conds'][] = 'ipb_expiry > ' . $db->addQuotes( $db->timestamp() );
351 # Is the user allowed to see hidden blocks?
352 if ( !$this->getUser()->isAllowed( 'hideuser' ) ) {
353 $info['conds']['ipb_deleted'] = 0;
360 * Get total number of autoblocks at any given time
362 * @return int Total number of unexpired active autoblocks
364 function getTotalAutoblocks() {
365 $dbr = $this->getDatabase();
366 $res = $dbr->selectField( 'ipblocks',
367 [ 'COUNT(*) AS totalautoblocks' ],
370 'ipb_expiry >= ' . $dbr->addQuotes( $dbr->timestamp() ),
376 return 0; // We found nothing
379 protected function getTableClass() {
380 return parent
::getTableClass() . ' mw-blocklist';
383 function getIndexField() {
384 return 'ipb_timestamp';
387 function getDefaultSort() {
388 return 'ipb_timestamp';
391 function isFieldSortable( $name ) {
396 * Do a LinkBatch query to minimise database load when generating all these links
397 * @param IResultWrapper $result
399 function preprocessResults( $result ) {
400 # Do a link batch query
402 $lb->setCaller( __METHOD__
);
405 foreach ( $result as $row ) {
406 $lb->add( NS_USER
, $row->ipb_address
);
407 $lb->add( NS_USER_TALK
, $row->ipb_address
);
409 if ( isset( $row->by_user_name
) ) {
410 $lb->add( NS_USER
, $row->by_user_name
);
411 $lb->add( NS_USER_TALK
, $row->by_user_name
);
414 if ( !$row->ipb_sitewide
) {
415 $partialBlocks[] = $row->ipb_id
;
419 if ( $partialBlocks ) {
420 // Mutations to the $row object are not persisted. The restrictions will
421 // need be stored in a separate store.
422 $blockRestrictionStore = MediaWikiServices
::getInstance()->getBlockRestrictionStore();
423 $this->restrictions
= $blockRestrictionStore->loadByBlockId( $partialBlocks );