Maintenance script that scans the deletion log and purges affected files within a timeframe. More...

Inheritance diagram for PurgeChangedFiles:

Collaboration diagram for PurgeChangedFiles:

[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 ()
	This method used to be for internal use by doMaintenance.php to apply some optional global state to LBFactory for debugging purposes.

	setConfig (Config $config)

	setDB (IMaintainableDatabase $db)
	Sets database object to be returned by getDB().

	setup ()
	Do some sanity checking and basic setup.

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

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

Protected Member Functions
	getDeletedPath (LocalRepo $repo, LocalFile $file)

	purgeFromArchiveTable (LocalRepo $repo, LocalFile $file)

	purgeFromLogType ( $type)
	Purge cache and thumbnails for changes of the given type.

	verbose ( $msg)
	Send an output message iff the 'verbose' option has been provided.

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 transaction on a DB.

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

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

	showHelp ()
	Definitely show the help.

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

	validateUserOption ( $errorMsg)

	waitForReplication ()
	Wait for replica DBs to catch up.

Private Attributes
string	$endTimestamp

string	$startTimestamp

Static Private Attributes
static array	$typeMappings
	Mapping from type option to log type and actions.

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

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

array	$mArgList = []
	Desired/allowed args.

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

int null	$mBatchSize = null
	Batch size.

	$mDbPass

	$mDbUser

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

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

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

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

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

string null	$mSelf
	Name of the script currently running.

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

Detailed Description

Maintenance script that scans the deletion log and purges affected files within a timeframe.

Definition at line 34 of file purgeChangedFiles.php.

Constructor & Destructor Documentation

◆ __construct()

PurgeChangedFiles::__construct ( )

Default constructor.

Children should call this first if implementing their own constructors

Stability: stable: to call

Reimplemented from Maintenance.

Definition at line 64 of file purgeChangedFiles.php.

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

Member Function Documentation

◆ execute()

PurgeChangedFiles::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 78 of file purgeChangedFiles.php.

References $dbr, $type, $wgHTCPRouting, DB_REPLICA, Maintenance\error(), getDB(), Maintenance\getOption(), Maintenance\hasOption(), Maintenance\maybeHelp(), purgeFromLogType(), and verbose.

◆ getDeletedPath()

PurgeChangedFiles::getDeletedPath	(	LocalRepo	$repo,
		LocalFile	$file
	)

protected

Definition at line 244 of file purgeChangedFiles.php.

References $file, FileRepo\getDeletedHashPath(), and FileRepo\getFileSha1().

Referenced by purgeFromArchiveTable(), and purgeFromLogType().

◆ purgeFromArchiveTable()

PurgeChangedFiles::purgeFromArchiveTable	(	LocalRepo	$repo,
		LocalFile	$file
	)

protected

Definition at line 214 of file purgeChangedFiles.php.

References $dbr, $file, $res, Maintenance\error(), FileRepo\fileExists(), FileRepo\getBackend(), getDeletedPath(), LocalRepo\getReplicaDB(), LocalRepo\newFromArchiveName(), Maintenance\output(), and LocalFile\purgeOldThumbnails().

Referenced by purgeFromLogType().

◆ purgeFromLogType()

PurgeChangedFiles::purgeFromLogType ( $type )

protected

Purge cache and thumbnails for changes of the given type.

Parameters

string $type Type of change to find

Definition at line 140 of file purgeChangedFiles.php.

References $dbr, $file, $res, $type, DB_REPLICA, Maintenance\error(), Maintenance\getBatchSize(), getDB(), getDeletedPath(), Maintenance\getOption(), Maintenance\hasOption(), NS_FILE, purgeFromArchiveTable(), unserialize(), and verbose.

Referenced by execute().

◆ verbose()

PurgeChangedFiles::verbose ( $msg )

protected

Send an output message iff the 'verbose' option has been provided.

Parameters

string $msg Message to output

Definition at line 256 of file purgeChangedFiles.php.

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

Member Data Documentation

◆ $endTimestamp

string PurgeChangedFiles::$endTimestamp

private

Definition at line 62 of file purgeChangedFiles.php.

◆ $startTimestamp

string PurgeChangedFiles::$startTimestamp

private

Definition at line 57 of file purgeChangedFiles.php.

◆ $typeMappings

array PurgeChangedFiles::$typeMappings

staticprivate

Initial value:

= [
        'created' => [
            'upload' => [ 'upload' ],
            'import' => [ 'upload', 'interwiki' ],
        ],
        'deleted' => [
            'delete' => [ 'delete', 'revision' ],
            'suppress' => [ 'delete', 'revision' ],
        ],
        'modified' => [
            'upload' => [ 'overwrite', 'revert' ],
            'move' => [ 'move', 'move_redir' ],
        ],
    ]

Mapping from type option to log type and actions.

Definition at line 39 of file purgeChangedFiles.php.

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

maintenance/purgeChangedFiles.php

Public Member Functions

Protected Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ execute()

◆ getDeletedPath()

◆ purgeFromArchiveTable()

◆ purgeFromLogType()

◆ verbose()

Member Data Documentation

◆ $endTimestamp

◆ $startTimestamp

◆ $typeMappings