Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
80.95% covered (warning)
80.95%
51 / 63
83.33% covered (warning)
83.33%
5 / 6
 CRAP
0.00% covered (danger)
0.00%
0 / 1
SpecialAbuseFilter
80.95% covered (warning)
80.95%
51 / 63
83.33% covered (warning)
83.33%
5 / 6
 34.81
0.00% covered (danger)
0.00%
0 / 1
 __construct
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
 1
 getRestriction
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
 1
 doesWrites
n/a
0 / 0
n/a
0 / 0
 1
 getGroupName
n/a
0 / 0
n/a
0 / 0
 1
 execute
47.83% covered (danger)
47.83%
11 / 23
0.00% covered (danger)
0.00%
0 / 1
 2.57
 instantiateView
100.00% covered (success)
100.00%
5 / 5
100.00% covered (success)
100.00%
1 / 1
 1
 getViewClassAndPageType
100.00% covered (success)
100.00%
32 / 32
100.00% covered (success)
100.00%
1 / 1
 21
 getTitleForSubpage
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
 1
1<?php
2
3namespace MediaWiki\Extension\AbuseFilter\Special;
4
5use MediaWiki\Extension\AbuseFilter\AbuseFilterPermissionManager;
6use MediaWiki\Extension\AbuseFilter\AbuseLoggerFactory;
7use MediaWiki\Extension\AbuseFilter\CentralDBManager;
8use MediaWiki\Extension\AbuseFilter\Consequences\ConsequencesFactory;
9use MediaWiki\Extension\AbuseFilter\Consequences\ConsequencesRegistry;
10use MediaWiki\Extension\AbuseFilter\EditBox\EditBoxBuilderFactory;
11use MediaWiki\Extension\AbuseFilter\FilterImporter;
12use MediaWiki\Extension\AbuseFilter\FilterLookup;
13use MediaWiki\Extension\AbuseFilter\FilterProfiler;
14use MediaWiki\Extension\AbuseFilter\FilterStore;
15use MediaWiki\Extension\AbuseFilter\Parser\RuleCheckerFactory;
16use MediaWiki\Extension\AbuseFilter\SpecsFormatter;
17use MediaWiki\Extension\AbuseFilter\VariableGenerator\VariableGeneratorFactory;
18use MediaWiki\Extension\AbuseFilter\Variables\VariablesBlobStore;
19use MediaWiki\Extension\AbuseFilter\Variables\VariablesFormatter;
20use MediaWiki\Extension\AbuseFilter\Variables\VariablesManager;
21use MediaWiki\Extension\AbuseFilter\View\AbuseFilterView;
22use MediaWiki\Extension\AbuseFilter\View\AbuseFilterViewDiff;
23use MediaWiki\Extension\AbuseFilter\View\AbuseFilterViewEdit;
24use MediaWiki\Extension\AbuseFilter\View\AbuseFilterViewExamine;
25use MediaWiki\Extension\AbuseFilter\View\AbuseFilterViewHistory;
26use MediaWiki\Extension\AbuseFilter\View\AbuseFilterViewImport;
27use MediaWiki\Extension\AbuseFilter\View\AbuseFilterViewList;
28use MediaWiki\Extension\AbuseFilter\View\AbuseFilterViewRevert;
29use MediaWiki\Extension\AbuseFilter\View\AbuseFilterViewTestBatch;
30use MediaWiki\Extension\AbuseFilter\View\AbuseFilterViewTools;
31use MediaWiki\Html\Html;
32use MediaWiki\Title\Title;
33use Wikimedia\ObjectFactory\ObjectFactory;
34
35class SpecialAbuseFilter extends AbuseFilterSpecialPage {
36
37    private const PAGE_NAME = 'AbuseFilter';
38
39    private const SERVICES_PER_VIEW = [
40        AbuseFilterViewDiff::class => [
41            AbuseFilterPermissionManager::SERVICE_NAME,
42            SpecsFormatter::SERVICE_NAME,
43            FilterLookup::SERVICE_NAME,
44        ],
45        AbuseFilterViewEdit::class => [
46            'DBLoadBalancerFactory',
47            AbuseFilterPermissionManager::SERVICE_NAME,
48            FilterProfiler::SERVICE_NAME,
49            FilterLookup::SERVICE_NAME,
50            FilterImporter::SERVICE_NAME,
51            FilterStore::SERVICE_NAME,
52            EditBoxBuilderFactory::SERVICE_NAME,
53            ConsequencesRegistry::SERVICE_NAME,
54            SpecsFormatter::SERVICE_NAME,
55        ],
56        AbuseFilterViewExamine::class => [
57            'DBLoadBalancerFactory',
58            AbuseFilterPermissionManager::SERVICE_NAME,
59            FilterLookup::SERVICE_NAME,
60            EditBoxBuilderFactory::SERVICE_NAME,
61            VariablesBlobStore::SERVICE_NAME,
62            VariablesFormatter::SERVICE_NAME,
63            VariablesManager::SERVICE_NAME,
64            VariableGeneratorFactory::SERVICE_NAME,
65            AbuseLoggerFactory::SERVICE_NAME,
66            'RecentChangeStore',
67            'ReadOnlyMode',
68        ],
69        AbuseFilterViewHistory::class => [
70            'UserNameUtils',
71            'LinkBatchFactory',
72            AbuseFilterPermissionManager::SERVICE_NAME,
73            FilterLookup::SERVICE_NAME,
74            SpecsFormatter::SERVICE_NAME,
75        ],
76        AbuseFilterViewImport::class => [
77            AbuseFilterPermissionManager::SERVICE_NAME,
78        ],
79        AbuseFilterViewList::class => [
80            'LinkBatchFactory',
81            'ConnectionProvider',
82            AbuseFilterPermissionManager::SERVICE_NAME,
83            FilterProfiler::SERVICE_NAME,
84            SpecsFormatter::SERVICE_NAME,
85            CentralDBManager::SERVICE_NAME,
86            FilterLookup::SERVICE_NAME,
87        ],
88        AbuseFilterViewRevert::class => [
89            'DBLoadBalancerFactory',
90            'UserFactory',
91            AbuseFilterPermissionManager::SERVICE_NAME,
92            FilterLookup::SERVICE_NAME,
93            ConsequencesFactory::SERVICE_NAME,
94            VariablesBlobStore::SERVICE_NAME,
95            SpecsFormatter::SERVICE_NAME,
96        ],
97        AbuseFilterViewTestBatch::class => [
98            'DBLoadBalancerFactory',
99            AbuseFilterPermissionManager::SERVICE_NAME,
100            EditBoxBuilderFactory::SERVICE_NAME,
101            RuleCheckerFactory::SERVICE_NAME,
102            VariableGeneratorFactory::SERVICE_NAME,
103            AbuseLoggerFactory::SERVICE_NAME,
104            'RecentChangeFactory',
105            'ReadOnlyMode',
106        ],
107        AbuseFilterViewTools::class => [
108            AbuseFilterPermissionManager::SERVICE_NAME,
109            EditBoxBuilderFactory::SERVICE_NAME,
110        ],
111    ];
112
113    public function __construct(
114        AbuseFilterPermissionManager $afPermissionManager,
115        private readonly ObjectFactory $objectFactory
116    ) {
117        parent::__construct( self::PAGE_NAME, $afPermissionManager );
118    }
119
120    /** @inheritDoc */
121    public function getRestriction(): string {
122        return 'abusefilter-view';
123    }
124
125    /**
126     * @codeCoverageIgnore Merely declarative
127     * @inheritDoc
128     */
129    public function doesWrites() {
130        return true;
131    }
132
133    /**
134     * @codeCoverageIgnore Merely declarative
135     * @inheritDoc
136     */
137    protected function getGroupName() {
138        return 'wiki';
139    }
140
141    /**
142     * @param string|null $subpage
143     */
144    public function execute( $subpage ) {
145        $out = $this->getOutput();
146        $request = $this->getRequest();
147
148        $out->addModuleStyles( 'ext.abuseFilter' );
149
150        $this->setHeaders();
151        $this->addHelpLink( 'Extension:AbuseFilter' );
152
153        $this->checkPermissions();
154
155        if ( $request->getVal( 'result' ) === 'success' ) {
156            $out->setSubtitle( $this->msg( 'abusefilter-edit-done-subtitle' ) );
157            $changedFilter = intval( $request->getVal( 'changedfilter' ) );
158            $changeId = intval( $request->getVal( 'changeid' ) );
159            $out->addModuleStyles( 'mediawiki.codex.messagebox.styles' );
160            $out->addHTML( Html::successBox(
161                $this->msg(
162                    'abusefilter-edit-done',
163                    $changedFilter,
164                    $changeId,
165                    $this->getLanguage()->formatNum( $changedFilter )
166                )->parse()
167            ) );
168        }
169
170        [ $view, $pageType, $params ] = $this->getViewClassAndPageType( $subpage );
171
172        // Links at the top
173        $this->addNavigationLinks( $pageType );
174
175        $view = $this->instantiateView( $view, $params );
176        $view->show();
177    }
178
179    /**
180     * Instantiate the view class
181     *
182     * @param class-string<AbuseFilterView> $viewClass
183     * @param array $params
184     * @return AbuseFilterView
185     */
186    public function instantiateView( string $viewClass, array $params ): AbuseFilterView {
187        return $this->objectFactory->createObject( [
188            'class' => $viewClass,
189            'services' => self::SERVICES_PER_VIEW[$viewClass],
190            'args' => [ $this->getContext(), $this->getLinkRenderer(), self::PAGE_NAME, $params ]
191        ] );
192    }
193
194    /**
195     * Determine the view class to instantiate
196     *
197     * @param string|null $subpage
198     * @return array{0:class-string,1:string,2:array} A tuple of three elements:
199     *      - a subclass of AbuseFilterView
200     *      - type of page for addNavigationLinks
201     *      - array of parameters for the class
202     */
203    public function getViewClassAndPageType( ?string $subpage ): array {
204        // Filter by removing blanks.
205        $params = preg_split( '{/+}', $subpage ?: '' );
206
207        if ( $subpage === 'tools' ) {
208            return [ AbuseFilterViewTools::class, 'tools', [] ];
209        }
210
211        if ( $subpage === 'import' ) {
212            return [ AbuseFilterViewImport::class, 'import', [] ];
213        }
214
215        if ( is_numeric( $subpage ) || $subpage === 'new' ) {
216            return [
217                AbuseFilterViewEdit::class,
218                'edit',
219                [ 'filter' => is_numeric( $subpage ) ? (int)$subpage : null ]
220            ];
221        }
222
223        if ( $params ) {
224            if ( count( $params ) === 2 && $params[0] === 'revert' && is_numeric( $params[1] ) ) {
225                $params[1] = (int)$params[1];
226                return [ AbuseFilterViewRevert::class, 'revert', $params ];
227            }
228
229            if ( $params[0] === 'test' ) {
230                return [ AbuseFilterViewTestBatch::class, 'test', $params ];
231            }
232
233            if ( $params[0] === 'examine' ) {
234                return [ AbuseFilterViewExamine::class, 'examine', $params ];
235            }
236
237            if ( $params[0] === 'history' || $params[0] === 'log' ) {
238                if ( count( $params ) <= 2 ) {
239                    $params = isset( $params[1] ) ? [ 'filter' => (int)$params[1] ] : [];
240                    return [ AbuseFilterViewHistory::class, 'recentchanges', $params ];
241                }
242                if ( count( $params ) === 4 && $params[2] === 'item' ) {
243                    return [
244                        AbuseFilterViewEdit::class,
245                        '',
246                        [ 'filter' => (int)$params[1], 'history' => (int)$params[3] ]
247                    ];
248                }
249                if ( count( $params ) === 5 && $params[2] === 'diff' ) {
250                    // Special:AbuseFilter/history/<filter>/diff/<oldid>/<newid>
251                    return [ AbuseFilterViewDiff::class, '', $params ];
252                }
253            }
254        }
255
256        return [ AbuseFilterViewList::class, 'home', [] ];
257    }
258
259    /**
260     * Static variant to get the associated Title.
261     *
262     * @param string|int $subpage
263     * @return Title
264     */
265    public static function getTitleForSubpage( $subpage ): Title {
266        return self::getTitleFor( self::PAGE_NAME, $subpage );
267    }
268}