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 require_once __DIR__
. '/Maintenance.php';
29 * Maintenance script that removes unused user accounts from the database.
31 * @ingroup Maintenance
33 class RemoveUnusedAccounts
extends Maintenance
{
34 public function __construct() {
35 parent
::__construct();
36 $this->addOption( 'delete', 'Actually delete the account' );
37 $this->addOption( 'ignore-groups', 'List of comma-separated groups to exclude', false, true );
38 $this->addOption( 'ignore-touched', 'Skip accounts touched in last N days', false, true );
41 public function execute() {
42 global $wgActorTableSchemaMigrationStage;
44 $this->output( "Remove unused accounts\n\n" );
46 # Do an initial scan for inactive accounts and report the result
47 $this->output( "Checking for unused user accounts...\n" );
50 $dbr = $this->getDB( DB_REPLICA
);
51 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) {
54 [ 'user_id', 'user_name', 'user_touched', 'actor_id' ],
58 [ 'actor' => [ 'LEFT JOIN', 'user_id = actor_user' ] ]
61 $res = $dbr->select( 'user', [ 'user_id', 'user_name', 'user_touched' ], '', __METHOD__
);
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 = User
::newFromId( $row->user_id
);
77 if ( count( array_intersect( $instance->getEffectiveGroups(), $excludedGroups ) ) == 0
78 && $this->isInactiveAccount( $row->user_id
, $row->actor_id ??
null, true )
79 && wfTimestamp( TS_UNIX
, $row->user_touched
) < wfTimestamp( TS_UNIX
, time() - $touchedSeconds )
81 # Inactive; print out the name and flag it
82 $delUser[] = $row->user_id
;
83 if ( isset( $row->actor_id
) && $row->actor_id
) {
84 $delActor[] = $row->actor_id
;
86 $this->output( $row->user_name
. "\n" );
89 $count = count( $delUser );
90 $this->output( "...found {$count}.\n" );
92 # If required, go back and delete each marked account
93 if ( $count > 0 && $this->hasOption( 'delete' ) ) {
94 $this->output( "\nDeleting unused accounts..." );
95 $dbw = $this->getDB( DB_MASTER
);
96 $dbw->delete( 'user', [ 'user_id' => $delUser ], __METHOD__
);
97 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) {
98 # Keep actor rows referenced from ipblocks
99 $keep = $dbw->selectFieldValues(
100 'ipblocks', 'ipb_by_actor', [ 'ipb_by_actor' => $delActor ], __METHOD__
102 $del = array_diff( $delActor, $keep );
104 $dbw->delete( 'actor', [ 'actor_id' => $del ], __METHOD__
);
107 $dbw->update( 'actor', [ 'actor_user' => 0 ], [ '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 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW
) {
114 $dbw->delete( 'logging', [ 'log_actor' => $delActor ], __METHOD__
);
115 $dbw->delete( 'recentchanges', [ 'rc_actor' => $delActor ], __METHOD__
);
117 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_OLD
) {
118 $dbw->delete( 'logging', [ 'log_user' => $delUser ], __METHOD__
);
119 $dbw->delete( 'recentchanges', [ 'rc_user' => $delUser ], __METHOD__
);
121 $this->output( "done.\n" );
122 # Update the site_stats.ss_users field
123 $users = $dbw->selectField( 'user', 'COUNT(*)', [], __METHOD__
);
126 [ 'ss_users' => $users ],
127 [ 'ss_row_id' => 1 ],
130 } elseif ( $count > 0 ) {
131 $this->output( "\nRun the script again with --delete to remove them from the database.\n" );
133 $this->output( "\n" );
137 * Could the specified user account be deemed inactive?
138 * (No edits, no deleted edits, no log entries, no current/old uploads)
140 * @param int $id User's ID
141 * @param int|null $actor User's actor ID
142 * @param bool $master Perform checking on the master
145 private function isInactiveAccount( $id, $actor, $master = false ) {
146 $dbo = $this->getDB( $master ? DB_MASTER
: DB_REPLICA
);
152 'filearchive' => 'fa'
156 $migration = ActorMigration
::newMigration();
158 $user = User
::newFromAnyId( $id, null, $actor );
160 $this->beginTransaction( $dbo, __METHOD__
);
161 foreach ( $checks as $table => $prefix ) {
162 $actorQuery = $migration->getWhere(
163 $dbo, $prefix . '_user', $user, $prefix !== 'oi' && $prefix !== 'fa'
165 $count +
= (int)$dbo->selectField(
166 [ $table ] +
$actorQuery['tables'],
168 $actorQuery['conds'],
175 $actorQuery = $migration->getWhere( $dbo, 'log_user', $user, false );
176 $count +
= (int)$dbo->selectField(
177 [ 'logging' ] +
$actorQuery['tables'],
180 $actorQuery['conds'],
181 'log_type != ' . $dbo->addQuotes( 'newusers' )
188 $this->commitTransaction( $dbo, __METHOD__
);
194 $maintClass = RemoveUnusedAccounts
::class;
195 require_once RUN_MAINTENANCE_IF_MAIN
;