MediaWiki REL1_28
ImageCleanup Class Reference

Maintenance script to clean up broken, unparseable upload filenames. More...

Inheritance diagram for ImageCleanup:
Collaboration diagram for ImageCleanup:

Public Member Functions

 __construct ()
 Default constructor.
- Public Member Functions inherited from TableCleanup
 execute ()
 Do the actual work.
 runTable ( $params)
- Public Member Functions inherited from Maintenance
function __construct ()
 checkRequiredExtensions ()
 Verify that the required extensions are installed.
 cleanupChanneled ()
 Clean up channeled output.
 clearParamsAndArgs ()
 Clear all params and arguments.
function execute ()
 finalSetup ()
 Handle some last-minute setup here.
 getConfig ()
 getDbType ()
 Does the script need different DB access? By default, we give Maintenance scripts normal rights to the DB.
 getName ()
 Get the script's name.
 globals ()
 Potentially debug globals.
 isQuiet ()
 loadParamsAndArgs ( $self=null, $opts=null, $args=null)
 Process command line arguments $mOptions becomes an array with keys set to the option names $mArgs becomes a zero-based array containing the non-option arguments.
 loadSettings ()
 Generic setup for most installs.
 loadWithArgv ( $argv)
 Load params and arguments from a given array of command-line arguments.
 memoryLimit ()
 Normally we disable the memory_limit when running admin scripts.
 outputChanneled ( $msg, $channel=null)
 Message outputter with channeled message support.
 purgeRedundantText ( $delete=true)
 Support function for cleaning up redundant text records.
 runChild ( $maintClass, $classFile=null)
 Run a child maintenance script.
 setAgentAndTriggers ()
 Set triggers like when to try to run deferred updates.
 setConfig (Config $config)
 setDB (IDatabase $db)
 Sets database object to be returned by getDB().
 setup ()
 Do some sanity checking and basic setup.
 updateSearchIndex ( $maxLockTime, $callback, $dbw, $results)
 Perform a search index update with locking.
 updateSearchIndexForPage ( $dbw, $pageId)
 Update the searchindex table for a given pageid.

Protected Member Functions

 processRow ( $row)
- Protected Member Functions inherited from TableCleanup
 hexChar ( $matches)
 init ( $count, $table)
 progress ( $updated)
- Protected Member Functions inherited from Maintenance
 activateProfiler ()
 Activate the profiler (assuming $wgProfiler is set)
 addArg ( $arg, $description, $required=true)
 Add some args that are needed.
 addDefaultParams ()
 Add the default parameters to the scripts.
 addDescription ( $text)
 Set the description text.
 addOption ( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
 Add a parameter to the script.
 adjustMemoryLimit ()
 Adjusts PHP's memory limit to better suit our needs, if needed.
 afterFinalSetup ()
 Execute a callback function at the end of initialisation.
 beginTransaction (IDatabase $dbw, $fname)
 Begin a transcation on a DB.
 commitTransaction (IDatabase $dbw, $fname)
 Commit the transcation on a DB handle and wait for replica DBs to catch up.
 deleteOption ( $name)
 Remove an option.
 error ( $err, $die=0)
 Throw an error to the user.
 getArg ( $argId=0, $default=null)
 Get an argument.
 getDB ( $db, $groups=[], $wiki=false)
 Returns a database to be used by current maintenance script.
 getDir ()
 Get the maintenance directory.
 getOption ( $name, $default=null)
 Get an option, or return the default.
 getStdin ( $len=null)
 Return input from stdin.
 hasArg ( $argId=0)
 Does a given argument exist?
 hasOption ( $name)
 Checks to see if a particular param exists.
 loadSpecialVars ()
 Handle the special variables that are global to all scripts.
 maybeHelp ( $force=false)
 Maybe show the help.
 output ( $out, $channel=null)
 Throw some output to the user.
 requireExtension ( $name)
 Indicate that the specified extension must be loaded before the script can run.
 rollbackTransaction (IDatabase $dbw, $fname)
 Rollback the transcation on a DB handle.
 setBatchSize ( $s=0)
 Set the batch size.
 validateParamsAndArgs ()
 Run some validation checks on the params, etc.

Protected Attributes

- Protected Attributes inherited from TableCleanup
 $dryrun = false
- Protected Attributes inherited from Maintenance
 $mArgList = []
 $mArgs = []
int $mBatchSize = null
 Batch size.
 $mDescription = ''
 $mInputLoaded = false
 $mOptions = []
 $mParams = []
 $mQuiet = false
 $mShortParamsMap = []

Private Member Functions

 appendTitle ( $name, $suffix)
 buildSafeTitle ( $name)
 filePath ( $name)
 imageExists ( $name, $db)
 killRow ( $name)
 pageExists ( $name, $db)
 pokeFile ( $orig, $new)

Additional Inherited Members

- Static Public Member Functions inherited from Maintenance
static posix_isatty ( $fd)
 Wrapper for posix_isatty() We default as considering stdin a tty (for nice readline methods) but treating stout as not a tty to avoid color codes.
static readconsole ( $prompt='> ')
 Prompt the console for input.
static requireTestsAutoloader ()
 Call this to set up the autoloader to allow classes to be used from the tests directory.
static setLBFactoryTriggers (LBFactory $LBFactory)
static shouldExecute ()
 Should we execute the maintenance script, or just allow it to be included as a standalone class? It checks that the call stack only includes this function and "requires" (meaning was called from the file scope)
- Public Attributes inherited from TableCleanup
 $batchSize = 100
 $reportInterval = 100
- Public Attributes inherited from Maintenance
resource $fileHandle
 Used when creating separate schema files.
array $orderedOptions = []
 Used to read the options in the order they were passed.
const DB_ADMIN = 2
const DB_NONE = 0
 Constants for DB access type.
const DB_STD = 1
const STDIN_ALL = 'all'

Detailed Description

Maintenance script to clean up broken, unparseable upload filenames.

Definition at line 35 of file cleanupImages.php.

Constructor & Destructor Documentation

◆ __construct()

ImageCleanup::__construct ( )

Default constructor.

Children should call this first if implementing their own constructors

Reimplemented from TableCleanup.

Definition at line 43 of file cleanupImages.php.

References Maintenance\addDescription().

Member Function Documentation

◆ appendTitle()

ImageCleanup::appendTitle (   $name,

Definition at line 201 of file cleanupImages.php.

References $name.

Referenced by pokeFile().

◆ buildSafeTitle()

ImageCleanup::buildSafeTitle (   $name)

Definition at line 206 of file cleanupImages.php.

References $name, Maintenance\error(), and NS_FILE.

Referenced by processRow().

◆ filePath()

ImageCleanup::filePath (   $name)

Definition at line 112 of file cleanupImages.php.

References $name, and RepoGroup\singleton().

Referenced by pokeFile().

◆ imageExists()

ImageCleanup::imageExists (   $name,

Definition at line 120 of file cleanupImages.php.

References $name.

Referenced by pokeFile().

◆ killRow()

ImageCleanup::killRow (   $name)

Definition at line 100 of file cleanupImages.php.

References $name, DB_MASTER, Maintenance\getDB(), and output().

Referenced by pokeFile(), and processRow().

◆ pageExists()

ImageCleanup::pageExists (   $name,

Definition at line 124 of file cleanupImages.php.

References $name, and NS_FILE.

Referenced by pokeFile().

◆ pokeFile()

◆ processRow()

ImageCleanup::processRow (   $row)

Member Data Documentation

◆ $defaultParams

Initial value:
= [
'table' => 'image',
'conds' => [],
'index' => 'img_name',
'callback' => 'processRow',

Definition at line 36 of file cleanupImages.php.

The documentation for this class was generated from the following file: