Maintenance script to rename titles affected by changes to Unicode (or otherwise to Language::ucfirst). More...

Inheritance diagram for UppercaseTitlesForUnicodeTransition:

Collaboration diagram for UppercaseTitlesForUnicodeTransition:

[legend]

Public Member Functions
	__construct ()
	Default constructor.

	execute ()
	Do the actual work.

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

	cleanupChanneled ()
	Clean up channeled output.

	clearParamsAndArgs ()
	Clear all params and arguments.

	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 (IMaintainableDatabase $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 (int $pageId)
	Update the searchindex table for a given pageid.

	validateParamsAndArgs ()
	Run some validation checks on the params, etc Stable for overriding.

Private Member Functions
	doMove (IDatabase $db, $ns, $title)
	Use MovePage to move a title.

	doUpdate (IDatabase $db, $op, $table, $nsField, $titleField, $row)
	Directly update a database row.

	getLikeBatches (IDatabase $db, $field, $batchSize=100)
	Get batched LIKE conditions from the charmap.

	getNamespaces ()
	Get the list of namespaces to operate on.

	isUserPage (IDatabase $db, $ns, $title)
	Check if a ns+title is a registered user's page.

	mungeTitle (IDatabase $db, Title $oldTitle, Title &$newTitle)
	Munge a target title, if necessary.

	processTable (IDatabase $db, $op, $table, $nsField, $titleField, $pkFields)
	Rename entries in other tables.

	processUsers (IDatabase $db)
	List users needing renaming.

	shouldDelete (IDatabase $db, Title $oldTitle, Title $newTitle)
	Determine whether the old title should be deleted.

Private Attributes
array	$charmap = []

array null	$namespaces = null

string null	$prefix = null

int null	$prefixNs = null

string	$reason = 'Uppercasing title for Unicode upgrade'

bool	$run = false

array	$seenUsers = []

string null	$suffix = null

string[] null	$tables = null

string[]	$tags = []

User	$user

const	INPLACE_MOVE = 1

const	MOVE = 0

const	UPPERCASE = 2

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).

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, 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)

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'

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 Stable for overriding.

	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.

	countDown ( $seconds)
	Count down from $seconds to zero on the terminal, with a one-second pause between showing each number.

	deleteOption ( $name)
	Remove an option.

	error ( $err, $die=0)
	Throw an error to the user.

	fatalError ( $msg, $exitCode=1)
	Output a message and terminate the current script.

	getArg ( $argId=0, $default=null)
	Get an argument.

	getBatchSize ()
	Returns batch size.

	getDB ( $db, $groups=[], $dbDomain=false)
	Returns a database to be used by current maintenance script.

	getDir ()
	Get the maintenance directory.

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

	getHookRunner ()
	Get a HookRunner for running core hooks.

	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 option was set.

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

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

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

	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).

	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.

	setAllowUnregisteredOptions ( $allow)
	Sets whether to allow unregistered options, which are options passed to a script that do not match an expected parameter.

	setBatchSize ( $s=0)
	Set the batch size.

	showHelp ()
	Definitely show the help.

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

Protected Attributes inherited from Maintenance
	$mAllowUnregisteredOptions = false

	$mArgList = []

	$mArgs = []

int	$mBatchSize = null
	Batch size.

	$mDbPass

	$mDbUser

	$mDescription = ''

	$mInputLoaded = false

	$mOptions = []

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

	$mQuiet = false

	$mSelf

	$mShortParamsMap = []

Detailed Description

Maintenance script to rename titles affected by changes to Unicode (or otherwise to Language::ucfirst).

Definition at line 36 of file uppercaseTitlesForUnicodeTransition.php.

Constructor & Destructor Documentation

◆ __construct()

UppercaseTitlesForUnicodeTransition::__construct ( )

Default constructor.

Children should call this first if implementing their own constructors

Stable for calling

Reimplemented from Maintenance.

Definition at line 72 of file uppercaseTitlesForUnicodeTransition.php.

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

Member Function Documentation

◆ doMove()

UppercaseTitlesForUnicodeTransition::doMove	(	IDatabase	$db,
			$ns,
			$title
	)

private

Use MovePage to move a title.

Parameters

IDatabase	$db	Database handle
int	$ns
string	$title

Returns: bool|null True on success, false on error, null if skipped

Definition at line 367 of file uppercaseTitlesForUnicodeTransition.php.

References $title, Maintenance\error(), isUserPage(), mungeTitle(), Maintenance\output(), shouldDelete(), and Wikimedia\Rdbms\IDatabase\update().

Referenced by processTable().

◆ doUpdate()

UppercaseTitlesForUnicodeTransition::doUpdate	(	IDatabase	$db,
			$op,
			$table,
			$nsField,
			$titleField,
			$row
	)

private

Directly update a database row.

Parameters

IDatabase	$db	Database handle
int	$op	Operation to perform self::INPLACE_MOVE: Directly update the database table to move the page self::UPPERCASE: Rewrite the table to point to the new uppercase title
string	$table
string \| int	$nsField
string	$titleField
stdClass	$row

Returns: bool|null True on success, false on error, null if skipped

Definition at line 524 of file uppercaseTitlesForUnicodeTransition.php.

References $title, Maintenance\error(), mungeTitle(), Maintenance\output(), and Wikimedia\Rdbms\IDatabase\update().

Referenced by processTable().

◆ execute()

UppercaseTitlesForUnicodeTransition::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 110 of file uppercaseTitlesForUnicodeTransition.php.

References $prefix, $reason, $tables, $title, $user, DB_MASTER, DB_REPLICA, Maintenance\error(), Maintenance\fatalError(), getDB(), Maintenance\getOption(), User\isLoggedIn(), User\newFromName(), User\newSystemUser(), NS_FILE, NS_MAIN, processTable(), and processUsers().

◆ getLikeBatches()

UppercaseTitlesForUnicodeTransition::getLikeBatches	(	IDatabase	$db,
			$field,
			$batchSize = `100`
	)

private

Get batched LIKE conditions from the charmap.

Parameters

IDatabase	$db	Database handle
string	$field	Field name
int	$batchSize	Size of the batches

Returns: array

Definition at line 206 of file uppercaseTitlesForUnicodeTransition.php.

References Wikimedia\Rdbms\IDatabase\anyString(), Wikimedia\Rdbms\IDatabase\buildLike(), and Wikimedia\Rdbms\IDatabase\makeList().

Referenced by processTable(), and processUsers().

◆ getNamespaces()

UppercaseTitlesForUnicodeTransition::getNamespaces ( )

private

Get the list of namespaces to operate on.

We only care about namespaces where we can move pages and titles are capitalized.

Returns: int[]

Definition at line 230 of file uppercaseTitlesForUnicodeTransition.php.

References $namespaces.

Referenced by processTable().

◆ isUserPage()

UppercaseTitlesForUnicodeTransition::isUserPage	(	IDatabase	$db,
			$ns,
			$title
	)

private

Check if a ns+title is a registered user's page.

Parameters

IDatabase	$db	Database handle
int	$ns
string	$title

Returns: bool

Definition at line 276 of file uppercaseTitlesForUnicodeTransition.php.

References $base, $title, NS_USER, NS_USER_TALK, and Wikimedia\Rdbms\IDatabase\selectField().

Referenced by doMove(), and mungeTitle().

◆ mungeTitle()

UppercaseTitlesForUnicodeTransition::mungeTitle	(	IDatabase	$db,
		Title	$oldTitle,
		Title &	$newTitle
	)

private

Munge a target title, if necessary.

Parameters

IDatabase	$db	Database handle
Title	$oldTitle
Title	&$newTitle

Returns: bool If $newTitle is (now) ok

Definition at line 301 of file uppercaseTitlesForUnicodeTransition.php.

References Title\canExist(), Maintenance\error(), Title\exists(), Title\getNamespace(), Title\getPrefixedText(), Title\getText(), isUserPage(), and NS_FILE.

Referenced by doMove(), and doUpdate().

◆ processTable()

UppercaseTitlesForUnicodeTransition::processTable	(	IDatabase	$db,
			$op,
			$table,
			$nsField,
			$titleField,
			$pkFields
	)

private

Rename entries in other tables.

Parameters

IDatabase	$db	Database handle
int	$op	Operation to perform self::MOVE: Use MovePage to move the page self::INPLACE_MOVE: Directly update the database table to move the page self::UPPERCASE: Rewrite the table to point to the new uppercase title
string	$table
string \| int	$nsField
string	$titleField
string[]	$pkFields	Additional fields to match a unique index starting with $nsField and $titleField.