diff options
Diffstat (limited to 'maintenance/removeUnusedAccounts.php')
| -rw-r--r-- | maintenance/removeUnusedAccounts.php | 150 |
1 files changed, 95 insertions, 55 deletions
diff --git a/maintenance/removeUnusedAccounts.php b/maintenance/removeUnusedAccounts.php index 419955b0..7b0535b7 100644 --- a/maintenance/removeUnusedAccounts.php +++ b/maintenance/removeUnusedAccounts.php @@ -3,68 +3,108 @@ * Remove unused user accounts from the database * An unused account is one which has made no edits * - * @file + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * http://www.gnu.org/copyleft/gpl.html + * * @ingroup Maintenance * @author Rob Church <robchur@gmail.com> */ -$options = array( 'help', 'delete' ); -require_once( 'commandLine.inc' ); -require_once( 'removeUnusedAccounts.inc' ); -echo( "Remove Unused Accounts\n\n" ); -$fname = 'removeUnusedAccounts'; +require_once( dirname(__FILE__) . '/Maintenance.php' ); -if( isset( $options['help'] ) ) { - showHelp(); - exit(); -} +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() { -# Do an initial scan for inactive accounts and report the result -echo( "Checking for unused user accounts...\n" ); -$del = array(); -$dbr = wfGetDB( DB_SLAVE ); -$res = $dbr->select( 'user', array( 'user_id', 'user_name', 'user_touched' ), '', $fname ); -if( isset( $options['ignore-groups'] ) ) { - $excludedGroups = explode( ',', $options['ignore-groups'] ); -} else { $excludedGroups = array(); } -$touchedSeconds = 0; -if( isset( $options['ignore-touched'] ) ) { - $touchedParamError = 0; - if( ctype_digit( $options['ignore-touched'] ) ) { - if( $options['ignore-touched'] <= 0 ) { - $touchedParamError = 1; + $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(); } - } else { $touchedParamError = 1; } - if( $touchedParamError == 1 ) { - die( "Please put a valid positive integer on the --ignore-touched parameter.\n" ); - } else { $touchedSeconds = 86400 * $options['ignore-touched']; } -} -while( $row = $dbr->fetchObject( $res ) ) { - # 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 - && 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; - echo( $row->user_name . "\n" ); + $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" ); + } + + /** + * Could the specified user account be deemed inactive? + * (No edits, no deleted edits, no log entries, no current/old uploads) + * + * @param $id User's ID + * @param $master Perform checking on the master + * @return bool + */ + 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' ); + $count = 0; + + $dbo->begin(); + foreach( $checks as $table => $fprefix ) { + $conds = array( $fprefix . '_user' => $id ); + $count += (int)$dbo->selectField( $table, 'COUNT(*)', $conds, __METHOD__ ); + } + $dbo->commit(); + + return $count == 0; } } -$count = count( $del ); -echo( "...found {$count}.\n" ); -# If required, go back and delete each marked account -if( $count > 0 && isset( $options['delete'] ) ) { - echo( "\nDeleting inactive accounts..." ); - $dbw = wfGetDB( DB_MASTER ); - $dbw->delete( 'user', array( 'user_id' => $del ), $fname ); - echo( "done.\n" ); - # Update the site_stats.ss_users field - $users = $dbw->selectField( 'user', 'COUNT(*)', array(), $fname ); - $dbw->update( 'site_stats', array( 'ss_users' => $users ), array( 'ss_row_id' => 1 ), $fname ); -} else { - if( $count > 0 ) - echo( "\nRun the script again with --delete to remove them from the database.\n" ); -} -echo( "\n" ); +$maintClass = "RemoveUnusedAccounts"; +require_once( DO_MAINTENANCE ); |