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\DatabaseBlock
;
26 use MediaWiki\Block\Restriction\Restriction
;
27 use MediaWiki\Block\Restriction\PageRestriction
;
28 use MediaWiki\Block\Restriction\NamespaceRestriction
;
29 use MediaWiki\MediaWikiServices
;
30 use Wikimedia\Rdbms\IResultWrapper
;
32 class BlockListPager
extends TablePager
{
37 * Array of restrictions.
41 protected $restrictions = [];
44 * @param SpecialPage $page
47 public function __construct( $page, $conds ) {
48 parent
::__construct( $page->getContext(), $page->getLinkRenderer() );
49 $this->conds
= $conds;
50 $this->mDefaultDirection
= IndexPager
::DIR_DESCENDING
;
53 function getFieldNames() {
54 static $headers = null;
56 if ( $headers === null ) {
58 'ipb_timestamp' => 'blocklist-timestamp',
59 'ipb_target' => 'blocklist-target',
60 'ipb_expiry' => 'blocklist-expiry',
61 'ipb_by' => 'blocklist-by',
62 'ipb_params' => 'blocklist-params',
63 'ipb_reason' => 'blocklist-reason',
65 foreach ( $headers as $key => $val ) {
66 $headers[$key] = $this->msg( $val )->text();
75 * @param string $value
77 * @suppress PhanTypeArraySuspicious
79 function formatValue( $name, $value ) {
81 if ( $msg === null ) {
87 'blocklist-nousertalk',
91 'blocklist-editing-sitewide',
94 foreach ( $keys as $key ) {
95 $msg[$key] = $this->msg( $key )->text();
99 /** @var object $row */
100 $row = $this->mCurrentRow
;
102 $language = $this->getLanguage();
106 $linkRenderer = $this->getLinkRenderer();
109 case 'ipb_timestamp':
110 $formatted = htmlspecialchars( $language->userTimeAndDate( $value, $this->getUser() ) );
114 if ( $row->ipb_auto
) {
115 $formatted = $this->msg( 'autoblockid', $row->ipb_id
)->parse();
117 list( $target, $type ) = DatabaseBlock
::parseTarget( $row->ipb_address
);
119 case DatabaseBlock
::TYPE_USER
:
120 case DatabaseBlock
::TYPE_IP
:
121 $formatted = Linker
::userLink( $target->getId(), $target );
122 $formatted .= Linker
::userToolLinks(
126 Linker
::TOOL_LINKS_NOBLOCK
129 case DatabaseBlock
::TYPE_RANGE
:
130 $formatted = htmlspecialchars( $target );
136 $formatted = htmlspecialchars( $language->formatExpiry(
138 /* User preference timezone */true
140 if ( MediaWikiServices
::getInstance()
141 ->getPermissionManager()
142 ->userHasRight( $this->getUser(), 'block' )
145 if ( $row->ipb_auto
) {
146 $links[] = $linkRenderer->makeKnownLink(
147 SpecialPage
::getTitleFor( 'Unblock' ),
150 [ 'wpTarget' => "#{$row->ipb_id}" ]
153 $links[] = $linkRenderer->makeKnownLink(
154 SpecialPage
::getTitleFor( 'Unblock', $row->ipb_address
),
157 $links[] = $linkRenderer->makeKnownLink(
158 SpecialPage
::getTitleFor( 'Block', $row->ipb_address
),
159 $msg['change-blocklink']
162 $formatted .= ' ' . Html
::rawElement(
164 [ 'class' => 'mw-blocklist-actions' ],
165 $this->msg( 'parentheses' )->rawParams(
166 $language->pipeList( $links ) )->escaped()
169 if ( $value !== 'infinity' ) {
170 $timestamp = new MWTimestamp( $value );
171 $formatted .= '<br />' . $this->msg(
172 'ipb-blocklist-duration-left',
173 $language->formatDuration(
174 $timestamp->getTimestamp() - MWTimestamp
::time(),
188 if ( isset( $row->by_user_name
) ) {
189 $formatted = Linker
::userLink( $value, $row->by_user_name
);
190 $formatted .= Linker
::userToolLinks( $value, $row->by_user_name
);
192 $formatted = htmlspecialchars( $row->ipb_by_text
); // foreign user?
197 $value = CommentStore
::getStore()->getComment( 'ipb_reason', $row )->text
;
198 $formatted = Linker
::formatComment( $value );
204 if ( $this->getConfig()->get( 'EnablePartialBlocks' ) && $row->ipb_sitewide
) {
205 $properties[] = htmlspecialchars( $msg['blocklist-editing-sitewide'] );
208 if ( !$row->ipb_sitewide
&& $this->restrictions
) {
209 $list = $this->getRestrictionListHTML( $row );
211 $properties[] = htmlspecialchars( $msg['blocklist-editing'] ) . $list;
215 if ( $row->ipb_anon_only
) {
216 $properties[] = htmlspecialchars( $msg['anononlyblock'] );
218 if ( $row->ipb_create_account
) {
219 $properties[] = htmlspecialchars( $msg['createaccountblock'] );
221 if ( $row->ipb_user
&& !$row->ipb_enable_autoblock
) {
222 $properties[] = htmlspecialchars( $msg['noautoblockblock'] );
225 if ( $row->ipb_block_email
) {
226 $properties[] = htmlspecialchars( $msg['emailblock'] );
229 if ( !$row->ipb_allow_usertalk
) {
230 $properties[] = htmlspecialchars( $msg['blocklist-nousertalk'] );
233 $formatted = Html
::rawElement(
236 implode( '', array_map( function ( $prop ) {
237 return Html
::rawElement(
247 $formatted = "Unable to format $name";
255 * Get Restriction List HTML
257 * @param stdClass $row
261 private function getRestrictionListHTML( stdClass
$row ) {
263 $linkRenderer = $this->getLinkRenderer();
265 foreach ( $this->restrictions
as $restriction ) {
266 if ( $restriction->getBlockId() !== (int)$row->ipb_id
) {
270 switch ( $restriction->getType() ) {
271 case PageRestriction
::TYPE
:
272 '@phan-var PageRestriction $restriction';
273 if ( $restriction->getTitle() ) {
274 $items[$restriction->getType()][] = Html
::rawElement(
277 $linkRenderer->makeLink( $restriction->getTitle() )
281 case NamespaceRestriction
::TYPE
:
282 $text = $restriction->getValue() === NS_MAIN
283 ?
$this->msg( 'blanknamespace' )->text()
284 : $this->getLanguage()->getFormattedNsText(
285 $restriction->getValue()
287 $items[$restriction->getType()][] = Html
::rawElement(
290 $linkRenderer->makeLink(
291 SpecialPage
::getTitleValueFor( 'Allpages' ),
295 'namespace' => $restriction->getValue()
303 if ( empty( $items ) ) {
308 foreach ( $items as $key => $value ) {
309 $sets[] = Html
::rawElement(
312 $this->msg( 'blocklist-editing-' . $key ) . Html
::rawElement(
315 implode( '', $value )
320 return Html
::rawElement(
327 function getQueryInfo() {
328 $commentQuery = CommentStore
::getStore()->getJoin( 'ipb_reason' );
329 $actorQuery = ActorMigration
::newMigration()->getJoin( 'ipb_by' );
332 'tables' => array_merge(
333 [ 'ipblocks' ], $commentQuery['tables'], $actorQuery['tables'], [ 'user' ]
339 'by_user_name' => 'user_name',
343 'ipb_create_account',
344 'ipb_enable_autoblock',
350 'ipb_allow_usertalk',
352 ] +
$commentQuery['fields'] +
$actorQuery['fields'],
353 'conds' => $this->conds
,
355 'user' => [ 'LEFT JOIN', 'user_id = ' . $actorQuery['fields']['ipb_by'] ]
356 ] +
$commentQuery['joins'] +
$actorQuery['joins']
359 # Filter out any expired blocks
360 $db = $this->getDatabase();
361 $info['conds'][] = 'ipb_expiry > ' . $db->addQuotes( $db->timestamp() );
363 # Is the user allowed to see hidden blocks?
364 if ( !MediaWikiServices
::getInstance()
365 ->getPermissionManager()
366 ->userHasRight( $this->getUser(), 'hideuser' )
368 $info['conds']['ipb_deleted'] = 0;
375 * Get total number of autoblocks at any given time
377 * @return int Total number of unexpired active autoblocks
379 function getTotalAutoblocks() {
380 $dbr = $this->getDatabase();
381 $res = $dbr->selectField( 'ipblocks',
385 'ipb_expiry >= ' . $dbr->addQuotes( $dbr->timestamp() ),
391 return 0; // We found nothing
394 protected function getTableClass() {
395 return parent
::getTableClass() . ' mw-blocklist';
398 function getIndexField() {
399 return 'ipb_timestamp';
402 function getDefaultSort() {
403 return 'ipb_timestamp';
406 function isFieldSortable( $name ) {
411 * Do a LinkBatch query to minimise database load when generating all these links
412 * @param IResultWrapper $result
414 function preprocessResults( $result ) {
415 # Do a link batch query
417 $lb->setCaller( __METHOD__
);
420 foreach ( $result as $row ) {
421 $lb->add( NS_USER
, $row->ipb_address
);
422 $lb->add( NS_USER_TALK
, $row->ipb_address
);
424 if ( isset( $row->by_user_name
) ) {
425 $lb->add( NS_USER
, $row->by_user_name
);
426 $lb->add( NS_USER_TALK
, $row->by_user_name
);
429 if ( !$row->ipb_sitewide
) {
430 $partialBlocks[] = $row->ipb_id
;
434 if ( $partialBlocks ) {
435 // Mutations to the $row object are not persisted. The restrictions will
436 // need be stored in a separate store.
437 $blockRestrictionStore = MediaWikiServices
::getInstance()->getBlockRestrictionStore();
438 $this->restrictions
= $blockRestrictionStore->loadByBlockId( $partialBlocks );