Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
86.79% covered (warning)
86.79%
92 / 106
50.00% covered (danger)
50.00%
1 / 2
CRAP
0.00% covered (danger)
0.00%
0 / 1
AbuseFilterViewHistory
86.79% covered (warning)
86.79%
92 / 106
50.00% covered (danger)
50.00%
1 / 2
22.02
0.00% covered (danger)
0.00%
0 / 1
 __construct
100.00% covered (success)
100.00%
3 / 3
100.00% covered (success)
100.00%
1 / 1
1
 show
86.41% covered (warning)
86.41%
89 / 103
0.00% covered (danger)
0.00%
0 / 1
21.00
1<?php
2
3namespace MediaWiki\Extension\AbuseFilter\View;
4
5use MediaWiki\Context\IContextSource;
6use MediaWiki\Extension\AbuseFilter\AbuseFilterPermissionManager;
7use MediaWiki\Extension\AbuseFilter\Filter\FilterNotFoundException;
8use MediaWiki\Extension\AbuseFilter\FilterLookup;
9use MediaWiki\Extension\AbuseFilter\Pager\AbuseFilterHistoryPager;
10use MediaWiki\Extension\AbuseFilter\SpecsFormatter;
11use MediaWiki\HTMLForm\HTMLForm;
12use MediaWiki\Linker\Linker;
13use MediaWiki\Linker\LinkRenderer;
14use MediaWiki\Page\LinkBatchFactory;
15use MediaWiki\Parser\ParserOptions;
16use MediaWiki\User\UserNameUtils;
17use OOUI;
18
19class AbuseFilterViewHistory extends AbuseFilterView {
20
21    /** @var int|null */
22    private $filter;
23
24    public function __construct(
25        private readonly UserNameUtils $userNameUtils,
26        private readonly LinkBatchFactory $linkBatchFactory,
27        AbuseFilterPermissionManager $afPermManager,
28        private readonly FilterLookup $filterLookup,
29        private readonly SpecsFormatter $specsFormatter,
30        IContextSource $context,
31        LinkRenderer $linkRenderer,
32        string $basePageName,
33        array $params
34    ) {
35        parent::__construct( $afPermManager, $context, $linkRenderer, $basePageName, $params );
36        $this->specsFormatter->setMessageLocalizer( $context );
37        $this->filter = $this->mParams['filter'] ?? null;
38    }
39
40    /**
41     * Shows the page
42     */
43    public function show() {
44        $out = $this->getOutput();
45        $out->enableOOUI();
46        $filter = $this->getRequest()->getIntOrNull( 'filter' ) ?: $this->filter;
47        $canViewSuppressed = $this->afPermManager->canViewSuppressed( $this->getAuthority() );
48        $canViewPrivate = $this->afPermManager->canViewPrivateFilters( $this->getAuthority() );
49
50        if ( $filter ) {
51            $filterObj = null;
52            try {
53                $filterObj = $this->filterLookup->getFilter( $filter, false );
54            } catch ( FilterNotFoundException ) {
55                $filter = null;
56            }
57            if ( $filterObj && $filterObj->isSuppressed() && !$canViewSuppressed ) {
58                $out->addWikiMsg( 'abusefilter-history-error-suppressed' );
59                return;
60            }
61            if ( $filterObj && $filterObj->isHidden() && !$canViewPrivate ) {
62                $out->addWikiMsg( 'abusefilter-history-error-hidden' );
63                return;
64            }
65
66            if ( $filterObj && $filterObj->isProtected() ) {
67                $permStatus = $this->afPermManager
68                    ->canViewProtectedVariablesInFilter( $this->getAuthority(), $filterObj );
69                if ( !$permStatus->isGood() ) {
70                    if ( $permStatus->getPermission() ) {
71                        $out->addWikiMsg( $this->msg(
72                            'abusefilter-history-error-protected-due-to-permission',
73                            $this->msg( "action-{$permStatus->getPermission()}" )->plain()
74                        ) );
75                        return;
76                    }
77
78                    // Add any messages in the status after a generic error message.
79                    $additional = '';
80                    foreach ( $permStatus->getMessages() as $message ) {
81                        $additional .= $this->msg( $message )->parseAsBlock();
82                    }
83
84                    $out->addWikiMsg(
85                        $this->msg( 'abusefilter-history-error-protected' )->rawParams( $additional )
86                    );
87                    return;
88                }
89            }
90        }
91
92        if ( $filter ) {
93            // Parse wikitext in this message to allow formatting of numero signs (T343994#9209383)
94            $out->setPageTitle( $this->msg( 'abusefilter-history' )->numParams( $filter )->parse() );
95        } else {
96            $out->setPageTitleMsg( $this->msg( 'abusefilter-filter-log' ) );
97        }
98
99        // Useful links
100        $links = [];
101        if ( $filter ) {
102            $links['abusefilter-history-backedit'] = $this->getTitle( $filter )->getFullURL();
103        }
104
105        foreach ( $links as $msg => $title ) {
106            $links[$msg] =
107                new OOUI\ButtonWidget( [
108                    'label' => $this->msg( $msg )->text(),
109                    'href' => $title
110                ] );
111        }
112
113        $backlinks =
114            new OOUI\HorizontalLayout( [
115                'items' => array_values( $links )
116            ] );
117        $out->addHTML( (string)$backlinks );
118
119        // For user
120        $user = $this->userNameUtils->getCanonical(
121            $this->getRequest()->getText( 'user' ),
122            UserNameUtils::RIGOR_VALID
123        );
124        if ( $user !== false ) {
125            $out->addSubtitle(
126                $this->msg( 'abusefilter-history-foruser' )
127                    // We don't really need to pass the real user ID
128                    ->rawParams( Linker::userLink( 1, $user ) )
129                    // For GENDER
130                    ->params( $user )
131                    ->parse()
132            );
133        } else {
134            $user = null;
135        }
136
137        $formDescriptor = [
138            'user' => [
139                'type' => 'user',
140                'name' => 'user',
141                'default' => $user,
142                'size' => '45',
143                'label-message' => 'abusefilter-history-select-user'
144            ],
145            'filter' => [
146                'type' => 'int',
147                'name' => 'filter',
148                'default' => $filter ?: '',
149                'size' => '45',
150                'label-message' => 'abusefilter-history-select-filter'
151            ],
152        ];
153
154        $htmlForm = HTMLForm::factory( 'ooui', $formDescriptor, $this->getContext() );
155        $htmlForm->setSubmitTextMsg( 'abusefilter-history-select-submit' )
156            ->setWrapperLegendMsg( 'abusefilter-history-select-legend' )
157            ->setTitle( $this->getTitle( 'history' ) )
158            ->setMethod( 'get' )
159            ->prepareForm()
160            ->displayForm( false );
161
162        $pager = new AbuseFilterHistoryPager(
163            $this->getContext(),
164            $this->linkRenderer,
165            $this->linkBatchFactory,
166            $this->filterLookup,
167            $this->specsFormatter,
168            $this->afPermManager,
169            $filter,
170            $user,
171            $canViewPrivate,
172            $canViewSuppressed
173        );
174
175        $out->addParserOutputContent(
176            $pager->getFullOutput(),
177            ParserOptions::newFromContext( $this->getContext() )
178        );
179    }
180}