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 ( $this->getUser()->isAllowed( 'block' ) ) {
142 if ( $row->ipb_auto
) {
143 $links[] = $linkRenderer->makeKnownLink(
144 SpecialPage
::getTitleFor( 'Unblock' ),
147 [ 'wpTarget' => "#{$row->ipb_id}" ]
150 $links[] = $linkRenderer->makeKnownLink(
151 SpecialPage
::getTitleFor( 'Unblock', $row->ipb_address
),
154 $links[] = $linkRenderer->makeKnownLink(
155 SpecialPage
::getTitleFor( 'Block', $row->ipb_address
),
156 $msg['change-blocklink']
159 $formatted .= ' ' . Html
::rawElement(
161 [ 'class' => 'mw-blocklist-actions' ],
162 $this->msg( 'parentheses' )->rawParams(
163 $language->pipeList( $links ) )->escaped()
166 if ( $value !== 'infinity' ) {
167 $timestamp = new MWTimestamp( $value );
168 $formatted .= '<br />' . $this->msg(
169 'ipb-blocklist-duration-left',
170 $language->formatDuration(
171 $timestamp->getTimestamp() - MWTimestamp
::time(),
185 if ( isset( $row->by_user_name
) ) {
186 $formatted = Linker
::userLink( $value, $row->by_user_name
);
187 $formatted .= Linker
::userToolLinks( $value, $row->by_user_name
);
189 $formatted = htmlspecialchars( $row->ipb_by_text
); // foreign user?
194 $value = CommentStore
::getStore()->getComment( 'ipb_reason', $row )->text
;
195 $formatted = Linker
::formatComment( $value );
201 if ( $this->getConfig()->get( 'EnablePartialBlocks' ) && $row->ipb_sitewide
) {
202 $properties[] = htmlspecialchars( $msg['blocklist-editing-sitewide'] );
205 if ( !$row->ipb_sitewide
&& $this->restrictions
) {
206 $list = $this->getRestrictionListHTML( $row );
208 $properties[] = htmlspecialchars( $msg['blocklist-editing'] ) . $list;
212 if ( $row->ipb_anon_only
) {
213 $properties[] = htmlspecialchars( $msg['anononlyblock'] );
215 if ( $row->ipb_create_account
) {
216 $properties[] = htmlspecialchars( $msg['createaccountblock'] );
218 if ( $row->ipb_user
&& !$row->ipb_enable_autoblock
) {
219 $properties[] = htmlspecialchars( $msg['noautoblockblock'] );
222 if ( $row->ipb_block_email
) {
223 $properties[] = htmlspecialchars( $msg['emailblock'] );
226 if ( !$row->ipb_allow_usertalk
) {
227 $properties[] = htmlspecialchars( $msg['blocklist-nousertalk'] );
230 $formatted = Html
::rawElement(
233 implode( '', array_map( function ( $prop ) {
234 return Html
::rawElement(
244 $formatted = "Unable to format $name";
252 * Get Restriction List HTML
254 * @param stdClass $row
258 private function getRestrictionListHTML( stdClass
$row ) {
260 $linkRenderer = $this->getLinkRenderer();
262 foreach ( $this->restrictions
as $restriction ) {
263 if ( $restriction->getBlockId() !== (int)$row->ipb_id
) {
267 switch ( $restriction->getType() ) {
268 case PageRestriction
::TYPE
:
269 '@phan-var PageRestriction $restriction';
270 if ( $restriction->getTitle() ) {
271 $items[$restriction->getType()][] = Html
::rawElement(
274 $linkRenderer->makeLink( $restriction->getTitle() )
278 case NamespaceRestriction
::TYPE
:
279 $text = $restriction->getValue() === NS_MAIN
280 ?
$this->msg( 'blanknamespace' )->text()
281 : $this->getLanguage()->getFormattedNsText(
282 $restriction->getValue()
284 $items[$restriction->getType()][] = Html
::rawElement(
287 $linkRenderer->makeLink(
288 SpecialPage
::getTitleValueFor( 'Allpages' ),
292 'namespace' => $restriction->getValue()
300 if ( empty( $items ) ) {
305 foreach ( $items as $key => $value ) {
306 $sets[] = Html
::rawElement(
309 $this->msg( 'blocklist-editing-' . $key ) . Html
::rawElement(
312 implode( '', $value )
317 return Html
::rawElement(
324 function getQueryInfo() {
325 $commentQuery = CommentStore
::getStore()->getJoin( 'ipb_reason' );
326 $actorQuery = ActorMigration
::newMigration()->getJoin( 'ipb_by' );
329 'tables' => array_merge(
330 [ 'ipblocks' ], $commentQuery['tables'], $actorQuery['tables'], [ 'user' ]
336 'by_user_name' => 'user_name',
340 'ipb_create_account',
341 'ipb_enable_autoblock',
347 'ipb_allow_usertalk',
349 ] +
$commentQuery['fields'] +
$actorQuery['fields'],
350 'conds' => $this->conds
,
352 'user' => [ 'LEFT JOIN', 'user_id = ' . $actorQuery['fields']['ipb_by'] ]
353 ] +
$commentQuery['joins'] +
$actorQuery['joins']
356 # Filter out any expired blocks
357 $db = $this->getDatabase();
358 $info['conds'][] = 'ipb_expiry > ' . $db->addQuotes( $db->timestamp() );
360 # Is the user allowed to see hidden blocks?
361 if ( !$this->getUser()->isAllowed( 'hideuser' ) ) {
362 $info['conds']['ipb_deleted'] = 0;
369 * Get total number of autoblocks at any given time
371 * @return int Total number of unexpired active autoblocks
373 function getTotalAutoblocks() {
374 $dbr = $this->getDatabase();
375 $res = $dbr->selectField( 'ipblocks',
379 'ipb_expiry >= ' . $dbr->addQuotes( $dbr->timestamp() ),
385 return 0; // We found nothing
388 protected function getTableClass() {
389 return parent
::getTableClass() . ' mw-blocklist';
392 function getIndexField() {
393 return 'ipb_timestamp';
396 function getDefaultSort() {
397 return 'ipb_timestamp';
400 function isFieldSortable( $name ) {
405 * Do a LinkBatch query to minimise database load when generating all these links
406 * @param IResultWrapper $result
408 function preprocessResults( $result ) {
409 # Do a link batch query
411 $lb->setCaller( __METHOD__
);
414 foreach ( $result as $row ) {
415 $lb->add( NS_USER
, $row->ipb_address
);
416 $lb->add( NS_USER_TALK
, $row->ipb_address
);
418 if ( isset( $row->by_user_name
) ) {
419 $lb->add( NS_USER
, $row->by_user_name
);
420 $lb->add( NS_USER_TALK
, $row->by_user_name
);
423 if ( !$row->ipb_sitewide
) {
424 $partialBlocks[] = $row->ipb_id
;
428 if ( $partialBlocks ) {
429 // Mutations to the $row object are not persisted. The restrictions will
430 // need be stored in a separate store.
431 $blockRestrictionStore = MediaWikiServices
::getInstance()->getBlockRestrictionStore();
432 $this->restrictions
= $blockRestrictionStore->loadByBlockId( $partialBlocks );