Maintenance script to refresh link tables. More...

Inheritance diagram for RefreshLinks:

Collaboration diagram for RefreshLinks:

[legend]

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

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

Public Member Functions inherited from Maintenance
	cleanupChanneled ()
	Clean up channeled output. More...

	clearParamsAndArgs ()
	Clear all params and arguments. More...

	finalSetup ()
	Handle some last-minute setup here. More...

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

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

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

	setup ()
	Do some sanity checking and basic setup. More...

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

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

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

Static Public Member Functions inherited from Maintenance
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	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...

Private Member Functions
	deleteLinksFromNonexistent ( $maxLag=0, $batchSize=100)
	Removes non-existing links from pages from pagelinks, imagelinks, categorylinks, templatelinks, externallinks, interwikilinks, langlinks and redirect tables. More...

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

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

Additional Inherited Members
Public Attributes inherited from Maintenance
resource	$fileHandle
	Used when creating separate schema files. More...

	$mDbPass

const	DB_ADMIN = 2

const	DB_NONE = 0
	Constants for DB access type. More...

const	DB_STD = 1

const	STDIN_ALL = 'all'

Protected Member Functions inherited from Maintenance
	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)
	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. More...

	deleteOption ( $name)
	Remove an option. More...

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

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

&	getDB ( $db, $groups=array(), $wiki=false)
	Returns a database to be used by current maintenance script. More...

	getDir ()
	Get the maintenance directory. 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 param exists. More...

	loadSpecialVars ()
	Handle the special variables that are global to all scripts. More...

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

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

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

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

Protected Attributes inherited from Maintenance
	$mArgList = array()

	$mArgs = array()

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

	$mDbUser

	$mDescription = ''

	$mInputLoaded = false

	$mOptions = array()

	$mParams = array()

	$mQuiet = false

	$mSelf

	$mShortParamsMap = array()

Detailed Description

Maintenance script to refresh link tables.

Definition at line 31 of file refreshLinks.php.

Constructor & Destructor Documentation

◆ __construct()

RefreshLinks::__construct ( )

Default constructor.

Children should call this first if implementing their own constructors

Reimplemented from Maintenance.

Definition at line 32 of file refreshLinks.php.

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

Member Function Documentation

◆ deleteLinksFromNonexistent()

RefreshLinks::deleteLinksFromNonexistent	(	$maxLag = `0`,
		$batchSize = `100`
	)

private

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

Parameters

$maxLag	int
$batchSize	int The size of deletion batches

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

Definition at line 259 of file refreshLinks.php.

References $dbr, $lb, array(), as, DB_MASTER, DB_SLAVE, Maintenance\output(), wfGetDB(), wfGetLBFactory(), and wfWaitForSlaves().

Referenced by execute().

◆ doRefreshLinks()

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

private

Do the actual link refreshing.

Parameters

$start	int Page_id to start from
$newOnly	bool Only do pages with 1 edit
$maxLag	int Max DB replication lag
$end	int Page_id to stop at
$redirectsOnly	bool Only fix redirects
$oldRedirectsOnly	bool Only fix redirects without redirect entries

Definition at line 67 of file refreshLinks.php.

References $dbr, $res, $wgParser, array(), as, DB_SLAVE, fixLinksFromArticle(), fixRedirect(), global, Maintenance\output(), wfGetDB(), wfRunHooks(), and wfWaitForSlaves().

Referenced by execute().

◆ execute()

RefreshLinks::execute ( )

Do the actual work.

All child classes will need to implement this

Reimplemented from Maintenance.

Definition at line 45 of file refreshLinks.php.

References deleteLinksFromNonexistent(), doRefreshLinks(), Maintenance\getArg(), Maintenance\getOption(), and Maintenance\hasOption().

◆ fixLinksFromArticle()

static RefreshLinks::fixLinksFromArticle ( $id )

static

Run LinksUpdate for all links on a given page_id.

Parameters

$id	int The page_id

Definition at line 227 of file refreshLinks.php.

References DB_MASTER, WikiPage\newFromID(), Revision\RAW, DataUpdate\runUpdates(), LinkCache\singleton(), and wfGetDB().

Referenced by doRefreshLinks().

◆ 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