MediaWiki  master
CleanupInvalidDbKeys Class Reference

Maintenance script that cleans up invalid titles in various tables. More...

Inheritance diagram for CleanupInvalidDbKeys:
Collaboration diagram for CleanupInvalidDbKeys:

Public Member Functions

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

Protected Member Functions

 cleanupTable ( $tableParams)
 Identifies, and optionally cleans up, invalid titles. More...
 outputStatus ( $str, $channel=null)
 Prints text to STDOUT, and STDERR if STDOUT was redirected to a file. More...
 writeToReport ( $str)
 Prints text to STDOUT. More...
- Protected Member Functions inherited from Maintenance
 activateProfiler ()
 Activate the profiler (assuming $wgProfiler is set) More...
 addArg ( $arg, $description, $required=true)
 Add some args that are needed. More...
 addDefaultParams ()
 Add the default parameters to the scripts. More...
 addDescription ( $text)
 Set the description text. More...
 addOption ( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
 Add a parameter to the script. More...
 adjustMemoryLimit ()
 Adjusts PHP's memory limit to better suit our needs, if needed. More...
 afterFinalSetup ()
 Execute a callback function at the end of initialisation. More...
 beginTransaction (IDatabase $dbw, $fname)
 Begin a transcation on a DB. More...
 commitTransaction (IDatabase $dbw, $fname)
 Commit the transcation on a DB handle and wait for replica DBs to catch up. More...
 countDown ( $seconds)
 Count down from $seconds to zero on the terminal, with a one-second pause between showing each number. More...
 deleteOption ( $name)
 Remove an option. More...
 error ( $err, $die=0)
 Throw an error to the user. More...
 fatalError ( $msg, $exitCode=1)
 Output a message and terminate the current script. More...
 getArg ( $argId=0, $default=null)
 Get an argument. More...
 getBatchSize ()
 Returns batch size. More...
 getDB ( $db, $groups=[], $dbDomain=false)
 Returns a database to be used by current maintenance script. More...
 getDir ()
 Get the maintenance directory. More...
 getOption ( $name, $default=null)
 Get an option, or return the default. More...
 getStdin ( $len=null)
 Return input from stdin. More...
 hasArg ( $argId=0)
 Does a given argument exist? More...
 hasOption ( $name)
 Checks to see if a particular option exists. More...
 loadSpecialVars ()
 Handle the special variables that are global to all scripts. More...
 maybeHelp ( $force=false)
 Maybe show the help. More...
 output ( $out, $channel=null)
 Throw some output to the user. More...
 requireExtension ( $name)
 Indicate that the specified extension must be loaded before the script can run. More...
 rollbackTransaction (IDatabase $dbw, $fname)
 Rollback the transcation on a DB handle. More...
 setAllowUnregisteredOptions ( $allow)
 Sets whether to allow unregistered options, which are options passed to a script that do not match an expected parameter. More...
 setBatchSize ( $s=0)
 Set the batch size. More...
 supportsOption ( $name)
 Checks to see if a particular option in supported. More...

Static Protected Member Functions

static makeValidTitle ( $invalidTitle)
 Fix possible validation issues in the given title (DB key). More...

Static Protected Attributes

static array [] $tables
 List of tables to clean up, and the field prefix for that table. More...

Additional Inherited Members

- Static Public Member Functions inherited from Maintenance
static getTermSize ()
 Get the terminal size as a two-element array where the first element is the width (number of columns) and the second element is the height (number of rows). More...
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. More...
static readconsole ( $prompt='> ')
 Prompt the console for input. More...
static requireTestsAutoloader ()
 Call this to set up the autoloader to allow classes to be used from the tests directory. More...
static setLBFactoryTriggers (LBFactory $LBFactory, Config $config)
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) More...
- Public Attributes inherited from Maintenance
resource $fileHandle
 Used when creating separate schema files. More...
array $orderedOptions = []
 Used to read the options in the order they were passed. More...
const DB_ADMIN = 2
const DB_NONE = 0
 Constants for DB access type. More...
const DB_STD = 1
const STDIN_ALL = 'all'
- Protected Attributes inherited from Maintenance
 $mAllowUnregisteredOptions = false
 $mArgList = []
 $mArgs = []
int $mBatchSize = null
 Batch size. More...
 $mDescription = ''
 $mInputLoaded = false
 $mOptions = []
array [] $mParams = []
 Array of desired/allowed params. More...
 $mQuiet = false
 $mShortParamsMap = []

Detailed Description

Maintenance script that cleans up invalid titles in various tables.


Definition at line 32 of file cleanupInvalidDbKeys.php.

Constructor & Destructor Documentation

◆ __construct()

static array [] CleanupInvalidDbKeys::__construct ( )

Member Function Documentation

◆ cleanupTable()

CleanupInvalidDbKeys::cleanupTable (   $tableParams)

Identifies, and optionally cleans up, invalid titles.

array$tableParamsA child array of self::$tables

Definition at line 124 of file cleanupInvalidDbKeys.php.

References $dbr, $res, DB_MASTER, DB_REPLICA, RefreshLinks\fixLinksFromArticle(), Maintenance\getBatchSize(), Maintenance\getDB(), Maintenance\hasOption(), LIST_OR, WikiPage\newFromID(), outputStatus(), wfWaitForSlaves(), and writeToReport().

Referenced by execute().

◆ execute()

CleanupInvalidDbKeys::execute ( )

◆ makeValidTitle()

static CleanupInvalidDbKeys::makeValidTitle (   $invalidTitle)

Fix possible validation issues in the given title (DB key).


Definition at line 297 of file cleanupInvalidDbKeys.php.

References $maintClass, and RUN_MAINTENANCE_IF_MAIN.

◆ outputStatus()

CleanupInvalidDbKeys::outputStatus (   $str,
  $channel = null 

Prints text to STDOUT, and STDERR if STDOUT was redirected to a file.

Used for progress reporting.

string$strText to write to both places
string | null$channelIgnored

Definition at line 102 of file cleanupInvalidDbKeys.php.

Referenced by cleanupTable(), and execute().

◆ writeToReport()

CleanupInvalidDbKeys::writeToReport (   $str)

Prints text to STDOUT.

Used for logging output.

string$strText to write

Definition at line 115 of file cleanupInvalidDbKeys.php.

Referenced by cleanupTable().

Member Data Documentation

◆ $tables

array [] CleanupInvalidDbKeys::$tables
Initial value:
= [
[ 'page', 'page' ],
[ 'redirect', 'rd', 'idField' => 'rd_from' ]

List of tables to clean up, and the field prefix for that table.

Definition at line 34 of file cleanupInvalidDbKeys.php.

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