(bug 40829) Show cascading protection info on action=info
[lhc/web/wiklou.git] / maintenance / removeUnusedAccounts.php
index 038875f..8bc27c1 100644 (file)
 <?php
-
 /**
  * Remove unused user accounts from the database
  * An unused account is one which has made no edits
  *
- * @package MediaWiki
- * @subpackage Maintenance
+ * 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
+ *
+ * @file
+ * @ingroup Maintenance
  * @author Rob Church <robchur@gmail.com>
  */
-require_once( 'commandLine.inc' );
-require_once( 'removeUnusedAccounts.inc' );
-echo( "REMOVE UNUSED ACCOUNTS\nThis script will delete all users who have made no edits.\n\n" );
-echo( "Syntax: removeUnusedAccounts.php [delete]\n     * delete -> delete the accounts\n       * The first user (usually the site owner) is left alone\n\n" );
-
-# Handle parameters
-if( isset( $args[0] ) ) {
-       $param = array_shift( $args );
-       if( $param == 'delete' ) {
-               $action = ACTION_DELETE;
-       } else {
-               $action = ACTION_REPORT;
+
+require_once( __DIR__ . '/Maintenance.php' );
+
+/**
+ * Maintenance script that removes unused user accounts from the database.
+ *
+ * @ingroup Maintenance
+ */
+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 );
        }
-} else {
-       $action = ACTION_REPORT;
-}
 
-$count = 0;
-$del = array();
-
-# Right, who needs deleting?
-$users = GetUsers();
-echo( "Found " . count( $users ) . " accounts.\n\n" );
-echo( "Locating inactive users..." );
-foreach( $users as $user ) {
-       if( $user != 1 ) {      # Don't *touch* the first user account, ever
-               if( CountEdits( $user ) == 0 ) {
-                       # User has no edits, mark them for deletion
-                       $del[] = $user;
-                       $count++;
+       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" );
+       }
+
+       /**
+        * 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 bool 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', '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;
        }
-}
-echo( "done.\n" );
-
-# Purge the inactive accounts we found
-echo( $count . " inactive accounts found." );
-if( ( $action == ACTION_DELETE ) && ( $count > 0 ) ) {
-       echo( " Deleting..." );
-       DeleteUsers( $del );
-       echo( "done.\n" );
 }
 
-?>
\ No newline at end of file
+$maintClass = "RemoveUnusedAccounts";
+require_once( RUN_MAINTENANCE_IF_MAIN );