Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
0.00% covered (danger)
0.00%
0 / 10
0.00% covered (danger)
0.00%
0 / 2
CRAP
0.00% covered (danger)
0.00%
0 / 1
PurgeExpiredUserrights
0.00% covered (danger)
0.00%
0 / 7
0.00% covered (danger)
0.00%
0 / 2
12
0.00% covered (danger)
0.00%
0 / 1
 __construct
0.00% covered (danger)
0.00%
0 / 2
0.00% covered (danger)
0.00%
0 / 1
2
 execute
0.00% covered (danger)
0.00%
0 / 5
0.00% covered (danger)
0.00%
0 / 1
6
1<?php
2/**
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.
7 *
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.
12 *
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
17 *
18 * @file
19 */
20
21require_once __DIR__ . '/Maintenance.php';
22
23/*
24 * Remove expired userrights from user_groups table and move them to former_user_groups.
25 *
26 * By default, this does not need to be run. The UserGroupManager service naturally
27 * takes care of detecting expired rows when it is written to (e.g. from SpecialUserrights)
28 * and queues UserGroupExpiryJob to purge expired rows.
29 *
30 * Large wiki farms may experience stale rows if their users manage local groups
31 * via a central wiki. In that case, UserGroupExpiryJob may run rarely or never
32 * from local wikis, in which case this script can help to periodically clean up
33 * expired rows.
34 *
35 * @since 1.31
36 * @ingroup Maintenance
37 * @author Eddie Greiner-Petter <wikimedia.org at eddie-sh.de>
38 */
39class PurgeExpiredUserrights extends Maintenance {
40    public function __construct() {
41        parent::__construct();
42        $this->addDescription( 'Move expired userrights from user_groups to former_user_groups table.' );
43    }
44
45    public function execute() {
46        $this->output( "Purging expired user rights...\n" );
47        $res = $this->getServiceContainer()->getUserGroupManager()->purgeExpired();
48        if ( $res === false ) {
49            $this->output( "Purging failed.\n" );
50        } else {
51            $this->output( "$res rows purged.\n" );
52        }
53    }
54}
55
56$maintClass = PurgeExpiredUserrights::class;
57require_once RUN_MAINTENANCE_IF_MAIN;