Maintenance script that checks for articles to fix after adding/deleting namespaces. More...

Inheritance diagram for NamespaceDupes:

Collaboration diagram for NamespaceDupes:

[legend]

Public Member Functions
	__construct ()
	Default constructor. More...

	execute ()
	Do the actual work. More...

Public Member Functions inherited from Maintenance
	checkRequiredExtensions ()
	Verify that the required extensions are installed. More...

	cleanupChanneled ()
	Clean up channeled output. More...

	clearParamsAndArgs ()
	Clear all params and arguments. 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...

	shutdown ()
	Call before shutdown to run any deferred updates. More...

	updateSearchIndex ( $maxLockTime, $callback, $dbw, $results)
	Perform a search index update with locking. More...

	updateSearchIndexForPage (int $pageId)
	Update the searchindex table for a given pageid. More...

	validateParamsAndArgs ()
	Run some validation checks on the params, etc. More...

Protected Attributes
IMaintainableDatabase	$db

Protected Attributes inherited from Maintenance
bool	$mAllowUnregisteredOptions = false
	Allow arbitrary options to be passed, or only specified ones? More...

array	$mArgList = []
	Desired/allowed args. More...

array	$mArgs = []
	This is the list of arguments that were actually passed. More...

int null	$mBatchSize = null
	Batch size. More...

	$mDbUser

string	$mDescription = ''
	A description of the script, children should change this via addDescription() More...

bool	$mInputLoaded = false
	Have we already loaded our user input? More...

array	$mOptions = []
	This is the list of options that were actually passed. More...

array[]	$mParams = []
	Array of desired/allowed params. More...

bool	$mQuiet = false
	Special vars for params that are always used. More...

string null	$mSelf
	Name of the script currently running. More...

array	$mShortParamsMap = []
	Mapping short parameters to long ones. More...

Private Member Functions
	canMerge ( $id, LinkTarget $linkTarget, &$logStatus)
	Determine if we can merge a page. More...

	checkAll ( $options)
	Check all namespaces. More...

	checkLinkTable ( $table, $fieldPrefix, $ns, $name, $options, $extraConds=[])
	Check and repair the destination fields in a link table. More...

	checkNamespace ( $ns, $name, $options)
	Check a given prefix and try to move it into the given destination namespace. More...

	checkPrefix ( $options)
	Move the given pseudo-namespace, either replacing the colon with a hyphen (useful for pseudo-namespaces that conflict with interwiki links) or move them to another namespace if specified. More...

	getAlternateTitle (LinkTarget $linkTarget, $options)
	Get an alternative title to move a page to. More...

	getDestinationTitle ( $ns, $name, $sourceNs, $sourceDbk)
	Get the preferred destination title for a given target page. More...

	getInterwikiList ()

	getTargetList ( $ns, $name, $options)
	Find pages in main and talk namespaces that have a prefix of the new namespace so we know titles that will need migrating. More...

	mergePage ( $row, Title $newTitle)
	Merge page histories. More...

	movePage ( $id, LinkTarget $newLinkTarget)
	Move a page. More...

Private Attributes
int	$deletedLinks = 0
	Total number of links deleted because they weren't automatically resolveable due to the target already existing. More...

int	$resolvableLinks = 0
	Total number of links that need fixing that are automatically resolveable. More...

int	$resolvablePages = 0
	Total number of pages that need fixing that are automatically resolveable. More...

int	$totalLinks = 0
	Total number of erroneous links. More...

int	$totalPages = 0
	Total number of pages that need fixing. 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 null	$fileHandle
	Used when creating separate schema files. More...

	$mDbPass

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 = -1

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 @stable for overriding. More...

	beginTransaction (IDatabase $dbw, $fname)
	Begin a transaction on a DB. More...

	commitTransaction (IDatabase $dbw, $fname)
	Commit the transaction 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...

	getHookContainer ()
	Get a HookContainer, for running extension hooks or for hook metadata. More...

	getHookRunner ()
	Get a HookRunner for running core hooks. 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 was set. More...

	loadSpecialVars ()
	Handle the special variables that are global to all scripts @stable for overriding. More...

	maybeHelp ( $force=false)
	Maybe show the help. More...

	output ( $out, $channel=null)
	Throw some output to the user. More...

	parseIntList ( $text)
	Utility function to parse a string (perhaps from a command line option) into a list of integers (perhaps some kind of numeric IDs). More...

	requireExtension ( $name)
	Indicate that the specified extension must be loaded before the script can run. More...

	rollbackTransaction (IDatabase $dbw, $fname)
	Rollback the transaction 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)

	showHelp ()
	Definitely show the help. More...

	supportsOption ( $name)
	Checks to see if a particular option in supported. More...

	waitForReplication ()
	Wait for replica DBs to catch up. More...

Detailed Description

Maintenance script that checks for articles to fix after adding/deleting namespaces.

Definition at line 41 of file namespaceDupes.php.

Constructor & Destructor Documentation

◆ __construct()

NamespaceDupes::__construct ( )

Default constructor.

Children should call this first if implementing their own constructors

Stability: stable: for calling

Reimplemented from Maintenance.

Definition at line 79 of file namespaceDupes.php.

References Maintenance\addDescription(), and Maintenance\addOption().

Member Function Documentation

◆ canMerge()

NamespaceDupes::canMerge	(		$id,
		LinkTarget	$linkTarget,
		&	$logStatus
	)

private

Determine if we can merge a page.

We check if an inaccessible revision would become the latest and deny the merge if so – it's theoretically possible to update the latest revision, but opens a can of worms – search engine updates, recentchanges review, etc.

Parameters

int	$id	The page_id
LinkTarget	$linkTarget	The new link target
string	&$logStatus	This is set to the log status message on failure

Returns: bool

Definition at line 618 of file namespaceDupes.php.

Referenced by checkNamespace().

◆ checkAll()

NamespaceDupes::checkAll ( $options )

private

Check all namespaces.

Parameters

array $options Associative array of validated command-line options

Returns: bool

Definition at line 131 of file namespaceDupes.php.

References checkLinkTable(), checkNamespace(), Maintenance\getConfig(), getInterwikiList(), and Maintenance\output().

Referenced by execute().

◆ checkLinkTable()

NamespaceDupes::checkLinkTable	(	$table,
		$fieldPrefix,
		$ns,
		$name,
		$options,
		$extraConds = `[]`
	)

private

Check and repair the destination fields in a link table.

Parameters

string	$table	The link table name
string	$fieldPrefix	The field prefix in the link table
int	$ns	Destination namespace id
string	$name
array	$options	Associative array of validated command-line options
array	$extraConds	Extra conditions for the SQL query

Definition at line 356 of file namespaceDupes.php.

References $res, DB_MASTER, Maintenance\getDB(), getDestinationTitle(), LIST_AND, LIST_OR, and Maintenance\output().

Referenced by checkAll().

◆ checkNamespace()

NamespaceDupes::checkNamespace	(	$ns,
		$name,
		$options
	)

private

Check a given prefix and try to move it into the given destination namespace.

Parameters

int	$ns	Destination namespace id
string	$name
array	$options	Associative array of validated command-line options

Returns: bool

Definition at line 261 of file namespaceDupes.php.

References canMerge(), getAlternateTitle(), getDestinationTitle(), getTargetList(), mergePage(), movePage(), and Maintenance\output().

Referenced by checkAll(), and checkPrefix().

◆ checkPrefix()

NamespaceDupes::checkPrefix ( $options )

private

Move the given pseudo-namespace, either replacing the colon with a hyphen (useful for pseudo-namespaces that conflict with interwiki links) or move them to another namespace if specified.

Parameters

array $options Associative array of validated command-line options

Returns: bool

Definition at line 469 of file namespaceDupes.php.

References checkNamespace(), and Maintenance\output().

Referenced by execute().

◆ execute()

NamespaceDupes::execute ( )

Do the actual work.

All child classes will need to implement this

Returns: bool|null|void True for success, false for failure. Not returning a value, or returning null, is also interpreted as success. Returning false for failure will cause doMaintenance.php to exit the process with a non-zero exit status.

Reimplemented from Maintenance.

Definition at line 100 of file namespaceDupes.php.

References checkAll(), checkPrefix(), Maintenance\getOption(), Maintenance\hasOption(), and Maintenance\output().

◆ getAlternateTitle()

NamespaceDupes::getAlternateTitle	(	LinkTarget	$linkTarget,
			$options
	)

private

Get an alternative title to move a page to.

This is used if the preferred destination title already exists.

Parameters

LinkTarget	$linkTarget
array	$options	Associative array of validated command-line options

Returns: Title|bool

Definition at line 548 of file namespaceDupes.php.

References $title, MediaWiki\Linker\LinkTarget\getDBkey(), MediaWiki\Linker\LinkTarget\getNamespace(), and Title\makeTitleSafe().

Referenced by checkNamespace().

◆ getDestinationTitle()

NamespaceDupes::getDestinationTitle	(	$ns,
		$name,
		$sourceNs,
		$sourceDbk
	)

private

Get the preferred destination title for a given target page.

Parameters

int	$ns	The destination namespace ID
string	$name	The conflicting prefix
int	$sourceNs	The source namespace
int	$sourceDbk	The source DB key (i.e. page_title)

Returns: Title|false

Definition at line 521 of file namespaceDupes.php.

References Title\makeTitleSafe(), and NS_TALK.

Referenced by checkLinkTable(), and checkNamespace().

◆ getInterwikiList()

NamespaceDupes::getInterwikiList ( )

private

Returns: string[]

Definition at line 248 of file namespaceDupes.php.

Referenced by checkAll().

◆ getTargetList()

NamespaceDupes::getTargetList	(	$ns,
		$name,
		$options
	)

private

Find pages in main and talk namespaces that have a prefix of the new namespace so we know titles that will need migrating.

Parameters

int	$ns	Destination namespace id
string	$name	Prefix that is being made a namespace
array	$options	Associative array of validated command-line options

Returns: IResultWrapper

Definition at line 487 of file namespaceDupes.php.

References DB_MASTER, Maintenance\getDB(), NS_MAIN, and NS_TALK.

Referenced by checkNamespace().

◆ mergePage()

NamespaceDupes::mergePage	(		$row,
		Title	$newTitle
	)

private

Merge page histories.

Parameters

stdClass	$row	Page row
Title	$newTitle	The new title

Returns: bool

Definition at line 639 of file namespaceDupes.php.

References DeferredUpdates\addUpdate(), Maintenance\beginTransaction(), Maintenance\commitTransaction(), DB_MASTER, DeferredUpdates\doUpdates(), Title\getArticleID(), Maintenance\getDB(), and Title\makeTitle().

Referenced by checkNamespace().

◆ movePage()

NamespaceDupes::movePage	(		$id,
		LinkTarget	$newLinkTarget
	)

private

Move a page.

Parameters

int	$id	The page_id
LinkTarget	$newLinkTarget	The new title link target

Returns: bool

Definition at line 573 of file namespaceDupes.php.

References DB_MASTER, Maintenance\getDB(), MediaWiki\Linker\LinkTarget\getDBkey(), and MediaWiki\Linker\LinkTarget\getNamespace().

Referenced by checkNamespace().

Member Data Documentation

◆ $db

IMaintainableDatabase NamespaceDupes::$db

protected

Definition at line 46 of file namespaceDupes.php.

◆ $deletedLinks

int NamespaceDupes::$deletedLinks = 0

private

Total number of links deleted because they weren't automatically resolveable due to the target already existing.

Definition at line 77 of file namespaceDupes.php.

◆ $resolvableLinks

int NamespaceDupes::$resolvableLinks = 0

private

Total number of links that need fixing that are automatically resolveable.

Definition at line 64 of file namespaceDupes.php.

◆ $resolvablePages

int NamespaceDupes::$resolvablePages = 0

private

Total number of pages that need fixing that are automatically resolveable.

Definition at line 52 of file namespaceDupes.php.

◆ $totalLinks

int NamespaceDupes::$totalLinks = 0

private

Total number of erroneous links.

Definition at line 70 of file namespaceDupes.php.

◆ $totalPages

int NamespaceDupes::$totalPages = 0

private

Total number of pages that need fixing.

Definition at line 58 of file namespaceDupes.php.

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

maintenance/namespaceDupes.php

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ canMerge()

◆ checkAll()

◆ checkLinkTable()

◆ checkNamespace()

◆ checkPrefix()

◆ execute()

◆ getAlternateTitle()

◆ getDestinationTitle()

◆ getInterwikiList()

◆ getTargetList()

◆ mergePage()

◆ movePage()

Member Data Documentation

◆ $db

◆ $deletedLinks

◆ $resolvableLinks

◆ $resolvablePages

◆ $totalLinks

◆ $totalPages