[Summary view] [Print] [Text view]

   1  <?php
   2  /**
   3   * Remove unused user accounts from the database
   4   * An unused account is one which has made no edits
   5   *
   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.
  10   *
  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.
  15   *
  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
  20   *
  21   * @file
  22   * @ingroup Maintenance
  23   * @author Rob Church <[email protected]>
  24   */
  25  
  26  require_once  __DIR__ . '/Maintenance.php';
  27  
  28  /**
  29   * Maintenance script that removes unused user accounts from the database.
  30   *
  31   * @ingroup Maintenance
  32   */
  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 );
  39      }
  40  
  41  	public function execute() {
  42  
  43          $this->output( "Remove unused accounts\n\n" );
  44  
  45          # Do an initial scan for inactive accounts and report the result
  46          $this->output( "Checking for unused user accounts...\n" );
  47          $del = array();
  48          $dbr = wfGetDB( DB_SLAVE );
  49          $res = $dbr->select( 'user', array( 'user_id', 'user_name', 'user_touched' ), '', __METHOD__ );
  50          if ( $this->hasOption( 'ignore-groups' ) ) {
  51              $excludedGroups = explode( ',', $this->getOption( 'ignore-groups' ) );
  52          } else {
  53              $excludedGroups = array();
  54          }
  55          $touched = $this->getOption( 'ignore-touched', "1" );
  56          if ( !ctype_digit( $touched ) ) {
  57              $this->error( "Please put a valid positive integer on the --ignore-touched parameter.", true );
  58          }
  59          $touchedSeconds = 86400 * $touched;
  60          foreach ( $res as $row ) {
  61              # Check the account, but ignore it if it's within a $excludedGroups
  62              # group or if it's touched within the $touchedSeconds seconds.
  63              $instance = User::newFromId( $row->user_id );
  64              if ( count( array_intersect( $instance->getEffectiveGroups(), $excludedGroups ) ) == 0
  65                  && $this->isInactiveAccount( $row->user_id, true )
  66                  && wfTimestamp( TS_UNIX, $row->user_touched ) < wfTimestamp( TS_UNIX, time() - $touchedSeconds )
  67              ) {
  68                  # Inactive; print out the name and flag it
  69                  $del[] = $row->user_id;
  70                  $this->output( $row->user_name . "\n" );
  71              }
  72          }
  73          $count = count( $del );
  74          $this->output( "...found {$count}.\n" );
  75  
  76          # If required, go back and delete each marked account
  77          if ( $count > 0 && $this->hasOption( 'delete' ) ) {
  78              $this->output( "\nDeleting unused accounts..." );
  79              $dbw = wfGetDB( DB_MASTER );
  80              $dbw->delete( 'user', array( 'user_id' => $del ), __METHOD__ );
  81              $dbw->delete( 'user_groups', array( 'ug_user' => $del ), __METHOD__ );
  82              $dbw->delete( 'user_former_groups', array( 'ufg_user' => $del ), __METHOD__ );
  83              $dbw->delete( 'user_properties', array( 'up_user' => $del ), __METHOD__ );
  84              $dbw->delete( 'logging', array( 'log_user' => $del ), __METHOD__ );
  85              $dbw->delete( 'recentchanges', array( 'rc_user' => $del ), __METHOD__ );
  86              $this->output( "done.\n" );
  87              # Update the site_stats.ss_users field
  88              $users = $dbw->selectField( 'user', 'COUNT(*)', array(), __METHOD__ );
  89              $dbw->update(
  90                  'site_stats',
  91                  array( 'ss_users' => $users ),
  92                  array( 'ss_row_id' => 1 ),
  93                  __METHOD__
  94              );
  95          } elseif ( $count > 0 ) {
  96              $this->output( "\nRun the script again with --delete to remove them from the database.\n" );
  97          }
  98          $this->output( "\n" );
  99      }
 100  
 101      /**
 102       * Could the specified user account be deemed inactive?
 103       * (No edits, no deleted edits, no log entries, no current/old uploads)
 104       *
 105       * @param int $id User's ID
 106       * @param bool $master Perform checking on the master
 107       * @return bool
 108       */
 109  	private function isInactiveAccount( $id, $master = false ) {
 110          $dbo = wfGetDB( $master ? DB_MASTER : DB_SLAVE );
 111          $checks = array(
 112              'revision' => 'rev',
 113              'archive' => 'ar',
 114              'image' => 'img',
 115              'oldimage' => 'oi',
 116              'filearchive' => 'fa'
 117          );
 118          $count = 0;
 119  
 120          $dbo->begin( __METHOD__ );
 121          foreach ( $checks as $table => $fprefix ) {
 122              $conds = array( $fprefix . '_user' => $id );
 123              $count += (int)$dbo->selectField( $table, 'COUNT(*)', $conds, __METHOD__ );
 124          }
 125  
 126          $conds = array( 'log_user' => $id, 'log_type != ' . $dbo->addQuotes( 'newusers' ) );
 127          $count += (int)$dbo->selectField( 'logging', 'COUNT(*)', $conds, __METHOD__ );
 128  
 129          $dbo->commit( __METHOD__ );
 130  
 131          return $count == 0;
 132      }
 133  }
 134  
 135  $maintClass = "RemoveUnusedAccounts";
 136  require_once RUN_MAINTENANCE_IF_MAIN;