BlockLogFormatter.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Logging;
 
use MediaWiki\Api\ApiResult;
use MediaWiki\Language\Language;
use MediaWiki\Linker\Linker;
use MediaWiki\MainConfigNames;
use MediaWiki\Message\Message;
use MediaWiki\SpecialPage\SpecialPage;
use MediaWiki\Title\MalformedTitleException;
use MediaWiki\Title\NamespaceInfo;
use MediaWiki\Title\Title;
use MediaWiki\Title\TitleParser;
use MediaWiki\User\User;
use Wikimedia\Timestamp\TimestampFormat as TS;
 
class BlockLogFormatter extends LogFormatter {
    private TitleParser $titleParser;
    private NamespaceInfo $namespaceInfo;
 
    public function __construct(
        LogEntry $entry,
        TitleParser $titleParser,
        NamespaceInfo $namespaceInfo
    ) {
        parent::__construct( $entry );
        $this->titleParser = $titleParser;
        $this->namespaceInfo = $namespaceInfo;
    }
 
    protected function getMessageParameters() {
        $params = parent::getMessageParameters();
 
        $title = $this->entry->getTarget();
        if ( str_starts_with( $title->getText(), '#' ) ) {
            // autoblock - no user link possible
            $params[2] = $title->getText();
            $params[3] = ''; // no user name for gender use
        } else {
            // Create a user link for the blocked
            $username = $title->getText();
            // @todo Store the user identifier in the parameters
            // to make this faster for future log entries
            $targetUser = User::newFromName( $username, false );
            $params[2] = Message::rawParam( $this->makeUserLink( $targetUser, Linker::TOOL_LINKS_NOBLOCK ) );
            $params[3] = $username; // plain user name for gender use
        }
 
        $subtype = $this->entry->getSubtype();
        if ( $subtype === 'block' || $subtype === 'reblock' ) {
            if ( !isset( $params[4] ) ) {
                // Very old log entry without duration: means infinity
                $params[4] = 'infinity';
            }
            // Localize the duration, and add a tooltip
            // in English to help visitors from other wikis.
            // The lrm is needed to make sure that the number
            // is shown on the correct side of the tooltip text.
            // @phan-suppress-next-line SecurityCheck-DoubleEscaped
            $durationTooltip = '&lrm;' . htmlspecialchars( $params[4] );
            $blockExpiry = $this->context->getLanguage()->translateBlockExpiry(
                $params[4],
                $this->context->getUser(),
                (int)wfTimestamp( TS::UNIX, $this->entry->getTimestamp() )
            );
            if ( $this->plaintext ) {
                // @phan-suppress-next-line SecurityCheck-XSS Unlikely positive, only if language format is bad
                $params[4] = Message::rawParam( $blockExpiry );
            } else {
                $params[4] = Message::rawParam(
                    "<span class=\"blockExpiry\" title=\"$durationTooltip\">" .
                    // @phan-suppress-next-line SecurityCheck-DoubleEscaped language class does not escape
                    htmlspecialchars( $blockExpiry ) .
                    '</span>'
                );
            }
            $params[5] = isset( $params[5] ) ?
                self::formatBlockFlags( $params[5], $this->context->getLanguage() ) : '';
 
            // block restrictions
            if ( isset( $params[6] ) ) {
                $pages = $params[6]['pages'] ?? [];
                $pageLinks = [];
                foreach ( $pages as $page ) {
                    $pageLinks[] = $this->makePageLink( Title::newFromText( $page ) );
                }
 
                $rawNamespaces = $params[6]['namespaces'] ?? [];
                $namespaces = [];
                foreach ( $rawNamespaces as $ns ) {
                    $text = (int)$ns === NS_MAIN
                        ? $this->msg( 'blanknamespace' )->escaped()
                        : htmlspecialchars( $this->context->getLanguage()->getFormattedNsText( $ns ) );
                    if ( $this->plaintext ) {
                        // Because the plaintext cannot link to the Special:AllPages
                        // link that is linked to in non-plaintext mode, just return
                        // the name of the namespace.
                        $namespaces[] = $text;
                    } else {
                        $namespaces[] = $this->makePageLink(
                            SpecialPage::getTitleFor( 'Allpages' ),
                            [ 'namespace' => $ns ],
                            $text
                        );
                    }
                }
 
                $rawActions = $params[6]['actions'] ?? [];
                $actions = [];
                foreach ( $rawActions as $action ) {
                    $actions[] = $this->msg( 'ipb-action-' . $action )->escaped();
                }
 
                $restrictions = [];
                if ( $pageLinks ) {
                    $restrictions[] = $this->msg( 'logentry-partialblock-block-page' )
                        ->numParams( count( $pageLinks ) )
                        ->rawParams( $this->context->getLanguage()->listToText( $pageLinks ) )->escaped();
                }
 
                if ( $namespaces ) {
                    $restrictions[] = $this->msg( 'logentry-partialblock-block-ns' )
                        ->numParams( count( $namespaces ) )
                        ->rawParams( $this->context->getLanguage()->listToText( $namespaces ) )->escaped();
                }
                if ( $actions ) {
                    $restrictions[] = $this->msg( 'logentry-partialblock-block-action' )
                        ->numParams( count( $actions ) )
                        ->rawParams( $this->context->getLanguage()->listToText( $actions ) )->escaped();
                }
 
                $params[6] = Message::rawParam( $this->context->getLanguage()->listToText( $restrictions ) );
            }
        }
 
        return $params;
    }
 
    protected function extractParameters() {
        $params = parent::extractParameters();
        // Legacy log params returning the params in index 3 and 4, moved to 4 and 5
        if ( $this->entry->isLegacy() && isset( $params[3] ) ) {
            if ( isset( $params[4] ) ) {
                $params[5] = $params[4];
            }
            $params[4] = $params[3];
            $params[3] = '';
        }
        return $params;
    }
 
    public function getPreloadTitles() {
        $title = $this->entry->getTarget();
        $preload = [];
        // Preload user page for non-autoblocks
        if ( substr( $title->getText(), 0, 1 ) !== '#' && $title->canExist() ) {
            $preload[] = $this->namespaceInfo->getTalkPage( $title );
        }
        // Preload page restriction
        $params = $this->extractParameters();
        if ( isset( $params[6]['pages'] ) ) {
            foreach ( $params[6]['pages'] as $page ) {
                try {
                    $preload[] = $this->titleParser->parseTitle( $page );
                } catch ( MalformedTitleException ) {
                }
            }
        }
        return $preload;
    }
 
    public function getActionLinks() {
        $subtype = $this->entry->getSubtype();
        $linkRenderer = $this->getLinkRenderer();
 
        // Don't show anything if the action is hidden
        if ( $this->entry->isDeleted( LogPage::DELETED_ACTION )
            || !( $subtype === 'block' || $subtype === 'reblock' )
            || !$this->context->getAuthority()->isAllowed( 'block' )
        ) {
            return '';
        }
 
        $title = $this->entry->getTarget();
        if ( $this->context->getConfig()->get( MainConfigNames::UseCodexSpecialBlock ) ) {
            $params = $this->entry->getParameters();
            if ( isset( $params['blockId'] ) ) {
                // If we have a block ID, show remove/change links
                $query = isset( $params['blockId'] ) ? [ 'id' => $params['blockId'] ] : [];
                $links = [
                    $linkRenderer->makeKnownLink(
                        SpecialPage::getTitleFor( 'Block', $title->getDBkey() ),
                        $this->msg( 'remove-blocklink' )->text(),
                        [],
                        $query + [ 'remove' => '1' ]
                    ),
                    $linkRenderer->makeKnownLink(
                        SpecialPage::getTitleFor( 'Block', $title->getDBkey() ),
                        $this->msg( 'change-blocklink' )->text(),
                        [],
                        $query
                    )
                ];
            } else {
                // For legacy log entries, just show "manage blocks" since the
                // Codex block page doesn't have an "unblock by target" mode
                $links = [
                    $linkRenderer->makeKnownLink(
                        SpecialPage::getTitleFor( 'Block', $title->getDBkey() ),
                        $this->msg( 'manage-blocklink' )->text(),
                    ),
                ];
            }
        } else {
            // Show unblock/change links
            $links = [
                $linkRenderer->makeKnownLink(
                    SpecialPage::getTitleFor( 'Unblock', $title->getDBkey() ),
                    $this->msg( 'unblocklink' )->text()
                ),
                $linkRenderer->makeKnownLink(
                    SpecialPage::getTitleFor( 'Block', $title->getDBkey() ),
                    $this->msg( 'change-blocklink' )->text()
                )
            ];
        }
 
        return $this->msg( 'parentheses' )->rawParams(
            $this->context->getLanguage()->pipeList( $links ) )->escaped();
    }
 
    public static function formatBlockFlags( $flags, Language $lang ) {
        $flags = trim( $flags );
        if ( $flags === '' ) {
            return ''; // nothing to do
        }
        $flags = explode( ',', $flags );
        $flagsCount = count( $flags );
 
        for ( $i = 0; $i < $flagsCount; $i++ ) {
            $flags[$i] = self::formatBlockFlag( $flags[$i], $lang );
        }
 
        return wfMessage( 'parentheses' )->inLanguage( $lang )
            ->rawParams( $lang->commaList( $flags ) )->escaped();
    }
 
    public static function formatBlockFlag( $flag, Language $lang ) {
        static $messages = [];
 
        if ( !isset( $messages[$flag] ) ) {
            $messages[$flag] = htmlspecialchars( $flag ); // Fallback
 
            // For grepping. The following core messages can be used here:
            // * block-log-flags-angry-autoblock
            // * block-log-flags-anononly
            // * block-log-flags-hiddenname
            // * block-log-flags-noautoblock
            // * block-log-flags-nocreate
            // * block-log-flags-noemail
            // * block-log-flags-nousertalk
            $msg = wfMessage( 'block-log-flags-' . $flag )->inLanguage( $lang );
 
            if ( $msg->exists() ) {
                $messages[$flag] = $msg->escaped();
            }
        }
 
        return $messages[$flag];
    }
 
    protected function getParametersForApi() {
        $entry = $this->entry;
        $params = $entry->getParameters();
 
        static $map = [
            // While this looks wrong to be starting at 5 rather than 4, it's
            // because getMessageParameters uses $4 for its own purposes.
            '5::duration',
            '6:array:flags',
            '6::flags' => '6:array:flags',
        ];
 
        foreach ( $map as $index => $key ) {
            if ( isset( $params[$index] ) ) {
                $params[$key] = $params[$index];
                unset( $params[$index] );
            }
        }
 
        ksort( $params );
 
        $subtype = $entry->getSubtype();
        if ( $subtype === 'block' || $subtype === 'reblock' ) {
            // Defaults for old log entries missing some fields
            $params += [
                '5::duration' => 'infinity',
                '6:array:flags' => [],
            ];
 
            if ( !is_array( $params['6:array:flags'] ) ) {
                $params['6:array:flags'] = $params['6:array:flags'] === ''
                    ? []
                    : explode( ',', $params['6:array:flags'] );
            }
 
            if ( wfIsInfinity( $params['5::duration'] ) ) {
                // Normalize all possible values to one for pre-T241709 rows
                $params['5::duration'] = 'infinity';
                $params[':plain:duration-l10n'] = $this->msg( 'infiniteblock' )->plain();
            } else {
                $ts = (int)wfTimestamp( TS::UNIX, $entry->getTimestamp() );
                $expiry = strtotime( $params['5::duration'], $ts );
                if ( $expiry !== false && $expiry > 0 ) {
                    $params[':timestamp:expiry'] = $expiry;
                }
                $params[':plain:duration-l10n'] = $this->context->getLanguage()
                    ->formatDurationBetweenTimestamps( $ts, $expiry );
            }
        }
 
        return $params;
    }
 
    public function formatParametersForApi() {
        $ret = parent::formatParametersForApi();
        if ( isset( $ret['flags'] ) ) {
            ApiResult::setIndexedTagName( $ret['flags'], 'f' );
        }
 
        if ( isset( $ret['restrictions']['pages'] ) ) {
            $ret['restrictions']['pages'] = array_map( function ( $title ) {
                return $this->formatParameterValueForApi( 'page', 'title-link', $title );
            }, $ret['restrictions']['pages'] );
            ApiResult::setIndexedTagName( $ret['restrictions']['pages'], 'p' );
        }
 
        if ( isset( $ret['restrictions']['namespaces'] ) ) {
            // @phan-suppress-next-line PhanTypeMismatchArgument False positive
            ApiResult::setIndexedTagName( $ret['restrictions']['namespaces'], 'ns' );
        }
 
        return $ret;
    }
 
    protected function getMessageKey() {
        $type = $this->entry->getType();
        $subtype = $this->entry->getSubtype();
        $params = $this->entry->getParameters();
        $sitewide = $params['sitewide'] ?? true;
        $count = $params['finalTargetCount'] ?? 0;
 
        $key = "logentry-$type-$subtype";
        if ( ( $subtype === 'block' || $subtype === 'reblock' ) && !$sitewide ) {
            // $this->getMessageParameters is doing too much. We just need
            // to check the presence of restrictions ($param[6]) and calling
            // on parent gives us that
            $params = parent::getMessageParameters();
 
            // message changes depending on whether there are editing restrictions or not
            if ( isset( $params[6] ) ) {
                $key = "logentry-partial$type-$subtype";
            } else {
                $key = "logentry-non-editing-$type-$subtype";
            }
        }
        if ( $subtype === 'block' && $count > 1 ) {
            // logentry-block-block-multi, logentry-partialblock-block-multi,
            // logentry-non-editing-block-block-multi
            $key .= '-multi';
        }
 
        return $key;
    }
}
 
class_alias( BlockLogFormatter::class, 'BlockLogFormatter' );