3 * Remove unused user accounts from the database
4 * An unused account is one which has made no edits
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19 * http://www.gnu.org/copyleft/gpl.html
22 * @ingroup Maintenance
23 * @author Rob Church <robchur@gmail.com>
26 use MediaWiki\MediaWikiServices
;
27 use MediaWiki\User\UserIdentity
;
29 require_once __DIR__
. '/Maintenance.php';
32 * Maintenance script that removes unused user accounts from the database.
34 * @ingroup Maintenance
36 class RemoveUnusedAccounts
extends Maintenance
{
37 public function __construct() {
38 parent
::__construct();
39 $this->addOption( 'delete', 'Actually delete the account' );
40 $this->addOption( 'ignore-groups', 'List of comma-separated groups to exclude', false, true );
41 $this->addOption( 'ignore-touched', 'Skip accounts touched in last N days', false, true );
44 public function execute() {
45 $services = MediaWikiServices
::getInstance();
46 $userFactory = $services->getUserFactory();
47 $userGroupManager = $services->getUserGroupManager();
48 $this->output( "Remove unused accounts\n\n" );
50 # Do an initial scan for inactive accounts and report the result
51 $this->output( "Checking for unused user accounts...\n" );
54 $dbr = $this->getDB( DB_REPLICA
);
57 [ 'user_id', 'user_name', 'user_touched', 'actor_id' ],
61 [ 'actor' => [ 'LEFT JOIN', 'user_id = actor_user' ] ]
63 if ( $this->hasOption( 'ignore-groups' ) ) {
64 $excludedGroups = explode( ',', $this->getOption( 'ignore-groups' ) );
68 $touched = $this->getOption( 'ignore-touched', "1" );
69 if ( !ctype_digit( $touched ) ) {
70 $this->fatalError( "Please put a valid positive integer on the --ignore-touched parameter." );
72 $touchedSeconds = 86400 * $touched;
73 foreach ( $res as $row ) {
74 # Check the account, but ignore it if it's within a $excludedGroups
75 # group or if it's touched within the $touchedSeconds seconds.
76 $instance = $userFactory->newFromId( $row->user_id
);
78 array_intersect( $userGroupManager->getUserEffectiveGroups( $instance ), $excludedGroups ) ) == 0
79 && $this->isInactiveAccount( $instance, $row->actor_id ??
null, true )
80 && wfTimestamp( TS_UNIX
, $row->user_touched
) < wfTimestamp( TS_UNIX
, time() - $touchedSeconds
83 # Inactive; print out the name and flag it
84 $delUser[] = $row->user_id
;
85 if ( isset( $row->actor_id
) && $row->actor_id
) {
86 $delActor[] = $row->actor_id
;
88 $this->output( $row->user_name
. "\n" );
91 $count = count( $delUser );
92 $this->output( "...found {$count}.\n" );
94 # If required, go back and delete each marked account
95 if ( $count > 0 && $this->hasOption( 'delete' ) ) {
96 $this->output( "\nDeleting unused accounts..." );
97 $dbw = $this->getDB( DB_PRIMARY
);
98 $dbw->delete( 'user', [ 'user_id' => $delUser ], __METHOD__
);
99 # Keep actor rows referenced from ipblocks
100 $keep = $dbw->selectFieldValues(
101 'ipblocks', 'ipb_by_actor', [ 'ipb_by_actor' => $delActor ], __METHOD__
103 $del = array_diff( $delActor, $keep );
105 $dbw->delete( 'actor', [ 'actor_id' => $del ], __METHOD__
);
108 $dbw->update( 'actor', [ 'actor_user' => null ], [ 'actor_id' => $keep ], __METHOD__
);
110 $dbw->delete( 'user_groups', [ 'ug_user' => $delUser ], __METHOD__
);
111 $dbw->delete( 'user_former_groups', [ 'ufg_user' => $delUser ], __METHOD__
);
112 $dbw->delete( 'user_properties', [ 'up_user' => $delUser ], __METHOD__
);
113 $dbw->delete( 'logging', [ 'log_actor' => $delActor ], __METHOD__
);
114 $dbw->delete( 'recentchanges', [ 'rc_actor' => $delActor ], __METHOD__
);
115 $this->output( "done.\n" );
116 # Update the site_stats.ss_users field
117 $users = $dbw->selectField( 'user', 'COUNT(*)', [], __METHOD__
);
120 [ 'ss_users' => $users ],
121 [ 'ss_row_id' => 1 ],
124 } elseif ( $count > 0 ) {
125 $this->output( "\nRun the script again with --delete to remove them from the database.\n" );
127 $this->output( "\n" );
131 * Could the specified user account be deemed inactive?
132 * (No edits, no deleted edits, no log entries, no current/old uploads)
134 * @param UserIdentity $user
135 * @param int|null $actor User's actor ID
136 * @param bool $primary Perform checking on the primary DB
139 private function isInactiveAccount( $user, $actor, $primary = false ) {
140 if ( $actor === null ) {
141 // There's no longer a way for a user to be active in any of
142 // these tables without having an actor ID. The only way to link
143 // to a user row is via an actor row.
147 $dbo = $this->getDB( $primary ? DB_PRIMARY
: DB_REPLICA
);
152 'filearchive' => 'fa'
153 // re-add when actor migration is complete
154 // 'revision' => 'rev'
158 $this->beginTransaction( $dbo, __METHOD__
);
159 foreach ( $checks as $table => $prefix ) {
160 $count +
= (int)$dbo->selectField(
163 [ "{$prefix}_actor" => $actor ],
168 // Delete this special case when the actor migration is complete
169 $actorQuery = ActorMigration
::newMigration()->getWhere( $dbo, 'rev_user', $user );
170 $count +
= (int)$dbo->selectField(
171 [ 'revision' ] +
$actorQuery['tables'],
173 $actorQuery['conds'],
179 $count +
= (int)$dbo->selectField(
183 'log_actor' => $actor,
184 'log_type != ' . $dbo->addQuotes( 'newusers' )
189 $this->commitTransaction( $dbo, __METHOD__
);
195 $maintClass = RemoveUnusedAccounts
::class;
196 require_once RUN_MAINTENANCE_IF_MAIN
;