removeUnusedAccounts.php

Go to the documentation of this file.

<?php
require_once( __DIR__ . '/Maintenance.php' );

class RemoveUnusedAccounts extends Maintenance {
        public function __construct() {
                parent::__construct();
                $this->addOption( 'delete', 'Actually delete the account' );
                $this->addOption( 'ignore-groups', 'List of comma-separated groups to exclude', false, true );
                $this->addOption( 'ignore-touched', 'Skip accounts touched in last N days', false, true );
        }

        public function execute() {

                $this->output( "Remove unused accounts\n\n" );

                # Do an initial scan for inactive accounts and report the result
                $this->output( "Checking for unused user accounts...\n" );
                $del = array();
                $dbr = wfGetDB( DB_SLAVE );
                $res = $dbr->select( 'user', array( 'user_id', 'user_name', 'user_touched' ), '', __METHOD__ );
                if ( $this->hasOption( 'ignore-groups' ) ) {
                        $excludedGroups = explode( ',', $this->getOption( 'ignore-groups' ) );
                } else {
                        $excludedGroups = array();
                }
                $touched = $this->getOption( 'ignore-touched', "1" );
                if ( !ctype_digit( $touched ) ) {
                        $this->error( "Please put a valid positive integer on the --ignore-touched parameter.", true );
                }
                $touchedSeconds = 86400 * $touched;
                foreach ( $res as $row ) {
                        # Check the account, but ignore it if it's within a $excludedGroups group or if it's touched within the $touchedSeconds seconds.
                        $instance = User::newFromId( $row->user_id );
                        if ( count( array_intersect( $instance->getEffectiveGroups(), $excludedGroups ) ) == 0
                                && $this->isInactiveAccount( $row->user_id, true )
                                && wfTimestamp( TS_UNIX, $row->user_touched ) < wfTimestamp( TS_UNIX, time() - $touchedSeconds )
                                ) {
                                # Inactive; print out the name and flag it
                                $del[] = $row->user_id;
                                $this->output( $row->user_name . "\n" );
                        }
                }
                $count = count( $del );
                $this->output( "...found {$count}.\n" );

                # If required, go back and delete each marked account
                if ( $count > 0 && $this->hasOption( 'delete' ) ) {
                        $this->output( "\nDeleting inactive accounts..." );
                        $dbw = wfGetDB( DB_MASTER );
                        $dbw->delete( 'user', array( 'user_id' => $del ), __METHOD__ );
                        $this->output( "done.\n" );
                        # Update the site_stats.ss_users field
                        $users = $dbw->selectField( 'user', 'COUNT(*)', array(), __METHOD__ );
                        $dbw->update( 'site_stats', array( 'ss_users' => $users ), array( 'ss_row_id' => 1 ), __METHOD__ );
                } elseif ( $count > 0 ) {
                        $this->output( "\nRun the script again with --delete to remove them from the database.\n" );
                }
                $this->output( "\n" );
        }

        private function isInactiveAccount( $id, $master = false ) {
                $dbo = wfGetDB( $master ? DB_MASTER : DB_SLAVE );
                $checks = array( 'revision' => 'rev', 'archive' => 'ar', 'logging' => 'log',
                                                 'image' => 'img', 'oldimage' => 'oi', 'filearchive' => 'fa' );
                $count = 0;

                $dbo->begin( __METHOD__ );
                foreach ( $checks as $table => $fprefix ) {
                        $conds = array( $fprefix . '_user' => $id );
                        $count += (int)$dbo->selectField( $table, 'COUNT(*)', $conds, __METHOD__ );
                }
                $dbo->commit( __METHOD__ );

                return $count == 0;
        }
}

$maintClass = "RemoveUnusedAccounts";
require_once( RUN_MAINTENANCE_IF_MAIN );