MediaWiki  1.27.2
removeUnusedAccounts.php
Go to the documentation of this file.
1 <?php
26 require_once __DIR__ . '/Maintenance.php';
27 
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 = [];
48  $dbr = $this->getDB( DB_SLAVE );
49  $res = $dbr->select( 'user', [ 'user_id', 'user_name', 'user_touched' ], '', __METHOD__ );
50  if ( $this->hasOption( 'ignore-groups' ) ) {
51  $excludedGroups = explode( ',', $this->getOption( 'ignore-groups' ) );
52  } else {
53  $excludedGroups = [];
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 = $this->getDB( DB_MASTER );
80  $dbw->delete( 'user', [ 'user_id' => $del ], __METHOD__ );
81  $dbw->delete( 'user_groups', [ 'ug_user' => $del ], __METHOD__ );
82  $dbw->delete( 'user_former_groups', [ 'ufg_user' => $del ], __METHOD__ );
83  $dbw->delete( 'user_properties', [ 'up_user' => $del ], __METHOD__ );
84  $dbw->delete( 'logging', [ 'log_user' => $del ], __METHOD__ );
85  $dbw->delete( 'recentchanges', [ 'rc_user' => $del ], __METHOD__ );
86  $this->output( "done.\n" );
87  # Update the site_stats.ss_users field
88  $users = $dbw->selectField( 'user', 'COUNT(*)', [], __METHOD__ );
89  $dbw->update(
90  'site_stats',
91  [ 'ss_users' => $users ],
92  [ '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 
109  private function isInactiveAccount( $id, $master = false ) {
110  $dbo = $this->getDB( $master ? DB_MASTER : DB_SLAVE );
111  $checks = [
112  'revision' => 'rev',
113  'archive' => 'ar',
114  'image' => 'img',
115  'oldimage' => 'oi',
116  'filearchive' => 'fa'
117  ];
118  $count = 0;
119 
120  $this->beginTransaction( $dbo, __METHOD__ );
121  foreach ( $checks as $table => $fprefix ) {
122  $conds = [ $fprefix . '_user' => $id ];
123  $count += (int)$dbo->selectField( $table, 'COUNT(*)', $conds, __METHOD__ );
124  }
125 
126  $conds = [ 'log_user' => $id, 'log_type != ' . $dbo->addQuotes( 'newusers' ) ];
127  $count += (int)$dbo->selectField( 'logging', 'COUNT(*)', $conds, __METHOD__ );
128 
129  $this->commitTransaction( $dbo, __METHOD__ );
130 
131  return $count == 0;
132  }
133 }
134 
135 $maintClass = "RemoveUnusedAccounts";
136 require_once RUN_MAINTENANCE_IF_MAIN;
isInactiveAccount($id, $master=false)
Could the specified user account be deemed inactive? (No edits, no deleted edits, no log entries...
commitTransaction(IDatabase $dbw, $fname)
Commit the transcation on a DB handle and wait for slaves to catch up.
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: maintenance.txt:39
static newFromId($id)
Static factory method for creation from a given user ID.
Definition: User.php:591
Maintenance script that removes unused user accounts from the database.
getDB($db, $groups=[], $wiki=false)
Returns a database to be used by current maintenance script.
hasOption($name)
Checks to see if a particular param exists.
require_once RUN_MAINTENANCE_IF_MAIN
Definition: maintenance.txt:50
wfTimestamp($outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
addOption($name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
$res
Definition: database.txt:21
const DB_SLAVE
Definition: Defines.php:46
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
getOption($name, $default=null)
Get an option, or return the default.
output($out, $channel=null)
Throw some output to the user.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
error($err, $die=0)
Throw an error to the user.
$count
const DB_MASTER
Definition: Defines.php:47
const TS_UNIX
Unix time - the number of seconds since 1970-01-01 00:00:00 UTC.
beginTransaction(IDatabase $dbw, $fname)
Begin a transcation on a DB.