MigrateComments Class Reference

Maintenance script that migrates comments from pre-1.30 columns to the 'comment' table. More...

Inheritance diagram for MigrateComments:

Collaboration diagram for MigrateComments:

Public Member Functions
	__construct ()
	Default constructor.
Public Member Functions inherited from LoggedUpdateMaintenance
	execute ()
	Do the actual work.
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.
	validateParamsAndArgs ()
	Run some validation checks on the params, etc.

Protected Member Functions
	doDBUpdates ()
	Do the actual work.
	getUpdateKey ()
	Get the update key name to go in the update log table.
	migrate ( $table, $primaryKey, $oldField)
	Migrate comments in a table.
	migrateToTemp ( $table, $primaryKey, $oldField, $newPrimaryKey, $newField)
	Migrate comments in a table to a temporary table.
	updateSkippedMessage ()
	Message to show that the update was done already and was just skipped.
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.
	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=[], $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 option 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.
	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.
	supportsOption ( $name)
	Checks to see if a particular option in supported.

Private Member Functions
	loadCommentIDs (IDatabase $dbw, array &$comments)
	Fetch comment IDs for a set of comments.

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 Attributes inherited from Maintenance
	$mAllowUnregisteredOptions = false
	$mArgList = []
	$mArgs = []
int	$mBatchSize = null
	Batch size.
	$mDbPass
	$mDbUser
	$mDescription = ''
	$mInputLoaded = false
	$mOptions = []
	$mParams = []
	$mQuiet = false
	$mSelf
	$mShortParamsMap = []

Detailed Description

Maintenance script that migrates comments from pre-1.30 columns to the 'comment' table.

Definition at line 34 of file migrateComments.php.

Constructor & Destructor Documentation

__construct()

MigrateComments::__construct

(

)

Default constructor.

Children should call this first if implementing their own constructors

Reimplemented from LoggedUpdateMaintenance.

Definition at line 35 of file migrateComments.php.

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

Member Function Documentation

doDBUpdates()

MigrateComments::doDBUpdates ( )

protected

Do the actual work.

All child classes will need to implement this. Return true to log the update as done or false (usually on failure).

Returns

bool

Reimplemented from LoggedUpdateMaintenance.

Definition at line 49 of file migrateComments.php.

References migrate(), and migrateToTemp().

getUpdateKey()

MigrateComments::getUpdateKey ( )

protected

Get the update key name to go in the update log table.

Returns

string

Reimplemented from LoggedUpdateMaintenance.

Definition at line 41 of file migrateComments.php.

References and().

loadCommentIDs()

MigrateComments::loadCommentIDs ( IDatabase $dbw, array & $comments )

private

Fetch comment IDs for a set of comments.

Parameters

IDatabase	$dbw
array	&$comments	Keys are comment names, values will be set to IDs.

Returns

int Count of added comments

Definition at line 71 of file migrateComments.php.

References $res, Wikimedia\Rdbms\IDatabase\affectedRows(), and(), Wikimedia\Rdbms\IDatabase\insert(), LIST_AND, LIST_OR, Wikimedia\Rdbms\IDatabase\makeList(), and Wikimedia\Rdbms\IDatabase\select().

Referenced by migrate(), and migrateToTemp().

migrate()

MigrateComments::migrate ( $table, $primaryKey, $oldField )

protected

Migrate comments in a table.

Assumes any row with the ID field non-zero have already been migrated. Assumes the new field name is the same as the old with '_id' appended. Blanks the old fields while migrating.

Parameters

string	$table	Table to migrate
string | string[]	$primaryKey	Primary key of the table.
string	$oldField	Old comment field name

Definition at line 131 of file migrateComments.php.

References $res, $value, and(), array(), DB_MASTER, Maintenance\getBatchSize(), Maintenance\getDB(), loadCommentIDs(), Maintenance\output(), and wfWaitForSlaves().

Referenced by doDBUpdates().

migrateToTemp()

MigrateComments::migrateToTemp ( $table, $primaryKey, $oldField, $newPrimaryKey, $newField )

protected

Migrate comments in a table to a temporary table.

Assumes any row with the ID field non-zero have already been migrated. Assumes the new table is named "{$table}_comment_temp", and it has two columns, in order, being the primary key of the original table and the comment ID field. Blanks the old fields while migrating.

Parameters

string	$table	Table to migrate
string	$primaryKey	Primary key of the table.
string	$oldField	Old comment field name
string	$newPrimaryKey	Primary key of the new table.
string	$newField	New comment field name

Definition at line 227 of file migrateComments.php.

References $res, Maintenance\beginTransaction(), Maintenance\commitTransaction(), DB_MASTER, Maintenance\getBatchSize(), Maintenance\getDB(), loadCommentIDs(), Maintenance\output(), and wfWaitForSlaves().

Referenced by doDBUpdates().

updateSkippedMessage()

MigrateComments::updateSkippedMessage ( )

protected

Message to show that the update was done already and was just skipped.

Returns

string

Reimplemented from LoggedUpdateMaintenance.

Definition at line 45 of file migrateComments.php.

---

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

• maintenance/migrateComments.php