MediaWiki REL1_35
CategoryChangesAsRdf Class Reference

Maintenance script to provide RDF representation of the recent changes in category tree. More...

Inheritance diagram for CategoryChangesAsRdf:
Collaboration diagram for CategoryChangesAsRdf:

Public Member Functions

 __construct ()
 Default constructor.
 
 execute ()
 Do the actual work.
 
 getRdf ()
 Get accumulated RDF.
 
 handleAdds (IDatabase $dbr, $output)
 
 handleCategorization (IDatabase $dbr, $output)
 Handles categorization changes.
 
 handleDeletes (IDatabase $dbr, $output)
 Handle category deletes.
 
 handleEdits (IDatabase $dbr, $output)
 Handle edits for category texts.
 
 handleMoves (IDatabase $dbr, $output)
 
 handleRestores (IDatabase $dbr, $output)
 
 initialize ()
 Initialize external service classes.
 
 updateTS ( $timestamp)
 Generate SPARQL Update code for updating dump timestamp.
 
- 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.
 

Protected Member Functions

 getCategoryLinksIterator (IDatabase $dbr, array $ids)
 Get iterator for links for categories.
 
 getChangedCatsIterator (IDatabase $dbr, $type)
 Fetch categorization changes or edits.
 
 getDeletedCatsIterator (IDatabase $dbr)
 Fetch deleted categories.
 
 getMovedCatsIterator (IDatabase $dbr)
 Fetch moved categories.
 
 getNewCatsIterator (IDatabase $dbr)
 Fetch newly created categories.
 
 getRestoredCatsIterator (IDatabase $dbr)
 Fetch restored categories.
 
- 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

int[] $processed = []
 List of processed page IDs, so we don't try to process same thing twice.
 
- 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

 addIndex (BatchRowIterator $it)
 Need to force index, somehow on terbium the optimizer chooses wrong one.
 
 addTimestampConditions (BatchRowIterator $it, IDatabase $dbr)
 Add timestamp limits to iterator.
 
 getCategoriesUpdate (IDatabase $dbr, $deleteUrls, $pages, $mark)
 Get SPARQL for updating set of categories.
 
 getInsertRdf ()
 Get the text of SPARQL INSERT DATA clause.
 
 setupChangesIterator (IDatabase $dbr, array $columns=[], array $extra_tables=[])
 Set up standard iterator for retrieving category changes.
 
 writeCategoryData ( $row)
 Write category data to RDF.
 
 writeParentCategories (IDatabase $dbr, $pages)
 Write parent data for a set of categories.
 

Private Attributes

CategoriesRdf $categoriesRdf
 Categories RDF helper.
 
 $endTS
 
RdfWriter $rdfWriter
 
 $startTS
 
const SPARQL_DELETE =
 Delete query.
 
const SPARQL_DELETE_INSERT =
 Delete/Insert query.
 
const SPARQL_INSERT =
 Insert query.
 

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'
 

Detailed Description

Maintenance script to provide RDF representation of the recent changes in category tree.

Since
1.30

Definition at line 31 of file categoryChangesAsRdf.php.

Constructor & Destructor Documentation

◆ __construct()

CategoryChangesAsRdf::__construct ( )

Default constructor.

Children should call this first if implementing their own constructors

Stable for calling

Reimplemented from Maintenance.

Definition at line 94 of file categoryChangesAsRdf.php.

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

Member Function Documentation

◆ addIndex()

CategoryChangesAsRdf::addIndex ( BatchRowIterator  $it)
private

Need to force index, somehow on terbium the optimizer chooses wrong one.

Parameters
BatchRowIterator$it

Definition at line 398 of file categoryChangesAsRdf.php.

References BatchRowIterator\addOptions().

Referenced by getChangedCatsIterator(), getDeletedCatsIterator(), getMovedCatsIterator(), and getRestoredCatsIterator().

◆ addTimestampConditions()

CategoryChangesAsRdf::addTimestampConditions ( BatchRowIterator  $it,
IDatabase  $dbr 
)
private

Add timestamp limits to iterator.

Parameters
BatchRowIterator$itIterator
IDatabase$dbr

Definition at line 387 of file categoryChangesAsRdf.php.

References $dbr, and BatchRowIterator\addConditions().

Referenced by getDeletedCatsIterator(), and setupChangesIterator().

◆ execute()

CategoryChangesAsRdf::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 117 of file categoryChangesAsRdf.php.

References $dbr, $endTS, $startTS, DB_REPLICA, Maintenance\error(), Maintenance\getConfig(), getDB(), Maintenance\getOption(), getRdf(), handleAdds(), handleCategorization(), handleDeletes(), handleEdits(), handleMoves(), handleRestores(), initialize(), and updateTS().

◆ getCategoriesUpdate()

CategoryChangesAsRdf::getCategoriesUpdate ( IDatabase  $dbr,
  $deleteUrls,
  $pages,
  $mark 
)
private

Get SPARQL for updating set of categories.

Parameters
IDatabase$dbr
string[]$deleteUrlsList of URIs to be deleted, with <>
string[]$pagesList of categories: id => title
string$markMarks which operation requests the query
Returns
string SPARQL query

Definition at line 192 of file categoryChangesAsRdf.php.

References getInsertRdf(), and writeParentCategories().

Referenced by handleCategorization(), handleDeletes(), handleEdits(), and handleMoves().

◆ getCategoryLinksIterator()

CategoryChangesAsRdf::getCategoryLinksIterator ( IDatabase  $dbr,
array  $ids 
)
protected

Get iterator for links for categories.

Parameters
IDatabase$dbr
int[]$idsList of page IDs
Returns
Traversable

Definition at line 410 of file categoryChangesAsRdf.php.

References $dbr.

Referenced by writeParentCategories().

◆ getChangedCatsIterator()

CategoryChangesAsRdf::getChangedCatsIterator ( IDatabase  $dbr,
  $type 
)
protected

Fetch categorization changes or edits.

Parameters
IDatabase$dbr
int$type
Returns
BatchRowIterator

Definition at line 370 of file categoryChangesAsRdf.php.

References $type, addIndex(), NS_CATEGORY, and setupChangesIterator().

Referenced by handleCategorization(), and handleEdits().

◆ getDeletedCatsIterator()

CategoryChangesAsRdf::getDeletedCatsIterator ( IDatabase  $dbr)
protected

Fetch deleted categories.

Parameters
IDatabase$dbr
Returns
BatchRowIterator

Definition at line 322 of file categoryChangesAsRdf.php.

References $dbr, addIndex(), addTimestampConditions(), NS_CATEGORY, and RC_LOG.

Referenced by handleDeletes().

◆ getInsertRdf()

CategoryChangesAsRdf::getInsertRdf ( )
private

Get the text of SPARQL INSERT DATA clause.

Returns
string

Definition at line 176 of file categoryChangesAsRdf.php.

References getRdf().

Referenced by getCategoriesUpdate(), handleAdds(), and handleRestores().

◆ getMovedCatsIterator()

CategoryChangesAsRdf::getMovedCatsIterator ( IDatabase  $dbr)
protected

Fetch moved categories.

Parameters
IDatabase$dbr
Returns
BatchRowIterator

Definition at line 302 of file categoryChangesAsRdf.php.

References addIndex(), NS_CATEGORY, RC_LOG, and setupChangesIterator().

Referenced by handleMoves().

◆ getNewCatsIterator()

CategoryChangesAsRdf::getNewCatsIterator ( IDatabase  $dbr)
protected

Fetch newly created categories.

Parameters
IDatabase$dbr
Returns
BatchRowIterator

Definition at line 288 of file categoryChangesAsRdf.php.

References NS_CATEGORY, and setupChangesIterator().

Referenced by handleAdds().

◆ getRdf()

CategoryChangesAsRdf::getRdf ( )

Get accumulated RDF.

Returns
string

Definition at line 429 of file categoryChangesAsRdf.php.

Referenced by execute(), and getInsertRdf().

◆ getRestoredCatsIterator()

CategoryChangesAsRdf::getRestoredCatsIterator ( IDatabase  $dbr)
protected

Fetch restored categories.

Parameters
IDatabase$dbr
Returns
BatchRowIterator

Definition at line 349 of file categoryChangesAsRdf.php.

References addIndex(), NS_CATEGORY, RC_LOG, and setupChangesIterator().

Referenced by handleRestores().

◆ handleAdds()

CategoryChangesAsRdf::handleAdds ( IDatabase  $dbr,
  $output 
)
Parameters
IDatabase$dbr
resource$output

Definition at line 527 of file categoryChangesAsRdf.php.

References getInsertRdf(), getNewCatsIterator(), writeCategoryData(), and writeParentCategories().

Referenced by execute().

◆ handleCategorization()

CategoryChangesAsRdf::handleCategorization ( IDatabase  $dbr,
  $output 
)

Handles categorization changes.

Parameters
IDatabase$dbr
resource$output

Definition at line 585 of file categoryChangesAsRdf.php.

References $dbr, getCategoriesUpdate(), getChangedCatsIterator(), NS_CATEGORY, RC_CATEGORIZE, and writeCategoryData().

Referenced by execute().

◆ handleDeletes()

CategoryChangesAsRdf::handleDeletes ( IDatabase  $dbr,
  $output 
)

Handle category deletes.

Parameters
IDatabase$dbr
resource$outputFile to write the output

Definition at line 438 of file categoryChangesAsRdf.php.

References getCategoriesUpdate(), and getDeletedCatsIterator().

Referenced by execute().

◆ handleEdits()

CategoryChangesAsRdf::handleEdits ( IDatabase  $dbr,
  $output 
)

Handle edits for category texts.

Parameters
IDatabase$dbr
resource$output

Definition at line 555 of file categoryChangesAsRdf.php.

References getCategoriesUpdate(), getChangedCatsIterator(), RC_EDIT, and writeCategoryData().

Referenced by execute().

◆ handleMoves()

CategoryChangesAsRdf::handleMoves ( IDatabase  $dbr,
  $output 
)
Parameters
IDatabase$dbr
resource$output

Definition at line 468 of file categoryChangesAsRdf.php.

References getCategoriesUpdate(), getMovedCatsIterator(), NS_CATEGORY, and writeCategoryData().

Referenced by execute().

◆ handleRestores()

CategoryChangesAsRdf::handleRestores ( IDatabase  $dbr,
  $output 
)
Parameters
IDatabase$dbr
resource$output

Definition at line 498 of file categoryChangesAsRdf.php.

References getInsertRdf(), getRestoredCatsIterator(), writeCategoryData(), and writeParentCategories().

Referenced by execute().

◆ initialize()

CategoryChangesAsRdf::initialize ( )

Initialize external service classes.

Definition at line 111 of file categoryChangesAsRdf.php.

Referenced by execute().

◆ setupChangesIterator()

CategoryChangesAsRdf::setupChangesIterator ( IDatabase  $dbr,
array  $columns = [],
array  $extra_tables = [] 
)
private

Set up standard iterator for retrieving category changes.

Parameters
IDatabase$dbr
string[]$columnsList of additional fields to get
string[]$extra_tablesList of additional tables to join
Returns
BatchRowIterator

Definition at line 247 of file categoryChangesAsRdf.php.

References $dbr, and addTimestampConditions().

Referenced by getChangedCatsIterator(), getMovedCatsIterator(), getNewCatsIterator(), and getRestoredCatsIterator().

◆ updateTS()

CategoryChangesAsRdf::updateTS (   $timestamp)

Generate SPARQL Update code for updating dump timestamp.

Parameters
string | int$timestampTimestamp for last change
Returns
string SPARQL Update query for timestamp.

Definition at line 222 of file categoryChangesAsRdf.php.

References wfTimestamp().

Referenced by execute().

◆ writeCategoryData()

CategoryChangesAsRdf::writeCategoryData (   $row)
private

Write category data to RDF.

Parameters
stdclass$rowDatabase row

Definition at line 455 of file categoryChangesAsRdf.php.

Referenced by handleAdds(), handleCategorization(), handleEdits(), handleMoves(), and handleRestores().

◆ writeParentCategories()

CategoryChangesAsRdf::writeParentCategories ( IDatabase  $dbr,
  $pages 
)
private

Write parent data for a set of categories.

The list has the child categories.

Parameters
IDatabase$dbr
string[]$pagesList of child categories: id => title

Definition at line 211 of file categoryChangesAsRdf.php.

References getCategoryLinksIterator().

Referenced by getCategoriesUpdate(), handleAdds(), and handleRestores().

Member Data Documentation

◆ $categoriesRdf

CategoriesRdf CategoryChangesAsRdf::$categoriesRdf
private

Categories RDF helper.

Definition at line 82 of file categoryChangesAsRdf.php.

◆ $endTS

CategoryChangesAsRdf::$endTS
private

Definition at line 85 of file categoryChangesAsRdf.php.

Referenced by execute().

◆ $processed

int [] CategoryChangesAsRdf::$processed = []
protected

List of processed page IDs, so we don't try to process same thing twice.

Definition at line 92 of file categoryChangesAsRdf.php.

◆ $rdfWriter

RdfWriter CategoryChangesAsRdf::$rdfWriter
private

Definition at line 77 of file categoryChangesAsRdf.php.

◆ $startTS

CategoryChangesAsRdf::$startTS
private

Definition at line 84 of file categoryChangesAsRdf.php.

Referenced by execute().

◆ SPARQL_DELETE

const CategoryChangesAsRdf::SPARQL_DELETE =
private

Delete query.

Definition at line 45 of file categoryChangesAsRdf.php.

◆ SPARQL_DELETE_INSERT

const CategoryChangesAsRdf::SPARQL_DELETE_INSERT =
private

Delete/Insert query.

Definition at line 60 of file categoryChangesAsRdf.php.

◆ SPARQL_INSERT

const CategoryChangesAsRdf::SPARQL_INSERT =
private

Insert query.

Definition at line 35 of file categoryChangesAsRdf.php.


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