Maintenance script to refresh link tables. More...

Inheritance diagram for RefreshLinks:

Collaboration diagram for RefreshLinks:

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

Static Public Member Functions
static	fixLinksFromArticle ( $id, $ns=false)
	Run LinksUpdate for all links on a given page_id.

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)

Protected Attributes
int bool	$namespace = false

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 = []

Private Member Functions
	deleteLinksFromNonexistent ( $start=null, $end=null, $batchSize=100, $chunkSize=100000)
	Removes non-existing links from pages from pagelinks, imagelinks, categorylinks, templatelinks, externallinks, interwikilinks, langlinks and redirect tables.

	dfnCheckInterval ( $start=null, $end=null, $batchSize=100)

	doRefreshLinks ( $start, $newOnly=false, $end=null, $redirectsOnly=false, $oldRedirectsOnly=false)
	Do the actual link refreshing.

	fixRedirect ( $id)
	Update the redirect entry for a given page.

	getPossibleCategories ( $categoryKey)
	Returns a list of possible categories for a given tracking category key.

	namespaceCond ()

	refreshCategory (Title $category)
	Refreshes links to a category.

	refreshTrackingCategory ( $category)
	Refershes links for pages in a tracking category.

Static Private Member Functions
static	intervalCond (IDatabase $db, $var, $start, $end)
	Build a SQL expression for a closed interval (i.e.

Private Attributes
const	REPORTING_INTERVAL = 100

Additional Inherited Members
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.

Detailed Description

Maintenance script to refresh link tables.

Definition at line 35 of file refreshLinks.php.

Constructor & Destructor Documentation

◆ __construct()

RefreshLinks::__construct ( )

Default constructor.

Children should call this first if implementing their own constructors

Stable for calling

Reimplemented from Maintenance.

Definition at line 41 of file refreshLinks.php.

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

Member Function Documentation

◆ deleteLinksFromNonexistent()

RefreshLinks::deleteLinksFromNonexistent	(	$start = `null`,
		$end = `null`,
		$batchSize = `100`,
		$chunkSize = `100000`
	)

private

Removes non-existing links from pages from pagelinks, imagelinks, categorylinks, templatelinks, externallinks, interwikilinks, langlinks and redirect tables.

Parameters

int \| null	$start	Page_id to start from
int \| null	$end	Page_id to stop at
int	$batchSize	The size of deletion batches
int	$chunkSize	Maximum number of existent IDs to check per query

Author: Merlijn van Deen valha.nosp@m.llas.nosp@m.w@arc.nosp@m.tus..nosp@m.nl

Definition at line 294 of file refreshLinks.php.

References $dbr, DB_REPLICA, dfnCheckInterval(), getDB(), namespaceCond(), and Maintenance\output().

Referenced by execute().

◆ dfnCheckInterval()

RefreshLinks::dfnCheckInterval	(	$start = `null`,
		$end = `null`,
		$batchSize = `100`
	)

private

See also: RefreshLinks::deleteLinksFromNonexistent()

Parameters

int \| null	$start	Page_id to start from
int \| null	$end	Page_id to stop at
int	$batchSize	The size of deletion batches

Definition at line 339 of file refreshLinks.php.

References $dbr, DB_MASTER, DB_REPLICA, getDB(), and Maintenance\output().

Referenced by deleteLinksFromNonexistent().

◆ doRefreshLinks()

RefreshLinks::doRefreshLinks	(	$start,
		$newOnly = `false`,
		$end = `null`,
		$redirectsOnly = `false`,
		$oldRedirectsOnly = `false`
	)

private

Do the actual link refreshing.

Parameters

int \| null	$start	Page_id to start from
bool	$newOnly	Only do pages with 1 edit
int \| null	$end	Page_id to stop at
bool	$redirectsOnly	Only fix redirects
bool	$oldRedirectsOnly	Only fix redirects without redirect entries

Definition at line 105 of file refreshLinks.php.

References $dbr, $res, DB_REPLICA, fixRedirect(), getDB(), Maintenance\getHookRunner(), namespaceCond(), and Maintenance\output().

Referenced by execute().

◆ execute()

RefreshLinks::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 58 of file refreshLinks.php.

References $title, deleteLinksFromNonexistent(), doRefreshLinks(), Maintenance\fatalError(), Maintenance\getArg(), Maintenance\getBatchSize(), Maintenance\getOption(), Maintenance\hasOption(), NS_CATEGORY, refreshCategory(), and refreshTrackingCategory().

◆ fixLinksFromArticle()

static RefreshLinks::fixLinksFromArticle	(	$id,
		$ns = `false`
	)

static

Run LinksUpdate for all links on a given page_id.

Parameters

int	$id	The page_id
int \| bool	$ns	Only fix links if it is in this namespace

Definition at line 261 of file refreshLinks.php.

◆ fixRedirect()

RefreshLinks::fixRedirect ( $id )

private

Update the redirect entry for a given page.

This methods bypasses the "redirect" table to get the redirect target, and parses the page's content to fetch it. This allows to be sure that the redirect target is up to date and valid. This is particularly useful when modifying namespaces to be sure the entry in the "redirect" table points to the correct page and not to an invalid one.

Parameters

int $id The page ID to check

Definition at line 218 of file refreshLinks.php.

References $content, DB_MASTER, and getDB().

Referenced by doRefreshLinks().

◆ getPossibleCategories()

RefreshLinks::getPossibleCategories ( $categoryKey )

private

Returns a list of possible categories for a given tracking category key.

Parameters

string $categoryKey

Returns: Title[]

Definition at line 485 of file refreshLinks.php.

References Maintenance\fatalError(), and Maintenance\getConfig().

Referenced by refreshTrackingCategory().

◆ intervalCond()

static RefreshLinks::intervalCond	(	IDatabase	$db,
			$var,
			$start,
			$end
	)

staticprivate

Build a SQL expression for a closed interval (i.e.

BETWEEN).

By specifying a null $start or $end, it is also possible to create half-bounded or unbounded intervals using this function.

Parameters

IDatabase	$db
string	$var	Field name
mixed	$start	First value to include or null
mixed	$end	Last value to include or null

Returns: string

Definition at line 400 of file refreshLinks.php.

◆ namespaceCond()

RefreshLinks::namespaceCond ( )

private

Definition at line 91 of file refreshLinks.php.

Referenced by deleteLinksFromNonexistent(), and doRefreshLinks().

◆ refreshCategory()

RefreshLinks::refreshCategory ( Title $category )

private

Refreshes links to a category.

Parameters

Title $category

Definition at line 435 of file refreshLinks.php.

References $dbr, $res, DB_REPLICA, Maintenance\getBatchSize(), getDB(), Title\getDBkey(), and Maintenance\output().

Referenced by execute(), and refreshTrackingCategory().

◆ refreshTrackingCategory()

RefreshLinks::refreshTrackingCategory ( $category )

private

Refershes links for pages in a tracking category.

Parameters

string $category Category key

Definition at line 417 of file refreshLinks.php.

References Maintenance\error(), getPossibleCategories(), and refreshCategory().

Referenced by execute().

Member Data Documentation

◆ $namespace

int bool RefreshLinks::$namespace = false

protected

Definition at line 39 of file refreshLinks.php.

◆ REPORTING_INTERVAL

const RefreshLinks::REPORTING_INTERVAL = 100

private

Definition at line 36 of file refreshLinks.php.

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

maintenance/refreshLinks.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ deleteLinksFromNonexistent()

◆ dfnCheckInterval()

◆ doRefreshLinks()

◆ execute()

◆ fixLinksFromArticle()

◆ fixRedirect()

◆ getPossibleCategories()

◆ intervalCond()

◆ namespaceCond()

◆ refreshCategory()

◆ refreshTrackingCategory()

Member Data Documentation

◆ $namespace

◆ REPORTING_INTERVAL