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