MediaWiki  master
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 ()
 
 execute ()
 
 getRdf ()
 Get accumulated RDF. More...
 
 handleAdds (IDatabase $dbr, $output)
 
 handleCategorization (IDatabase $dbr, $output)
 Handles categorization changes. More...
 
 handleDeletes (IDatabase $dbr, $output)
 Handle category deletes. More...
 
 handleEdits (IDatabase $dbr, $output)
 Handle edits for category texts. More...
 
 handleMoves (IDatabase $dbr, $output)
 
 handleRestores (IDatabase $dbr, $output)
 
 initialize ()
 Initialize external service classes. More...
 
 updateTS ( $timestamp)
 Generate SPARQL Update code for updating dump timestamp. More...
 
- Public Member Functions inherited from Maintenance
 __construct ()
 Default constructor. More...
 
 checkRequiredExtensions ()
 Verify that the required extensions are installed. More...
 
 cleanupChanneled ()
 Clean up channeled output. More...
 
 clearParamsAndArgs ()
 Clear all params and arguments. More...
 
 execute ()
 Do the actual work. More...
 
 finalSetup ()
 Handle some last-minute setup here. More...
 
 getConfig ()
 
 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...
 
 loadWithArgv ( $argv)
 Load params and arguments from a given array of command-line arguments. 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...
 
 setAgentAndTriggers ()
 Set triggers like when to try to run deferred updates. More...
 
 setConfig (Config $config)
 
 setDB (IMaintainableDatabase $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...
 
 validateParamsAndArgs ()
 Run some validation checks on the params, etc. More...
 

Public Attributes

 SPARQL
 
const SPARQL_DELETE
 Delete query. More...
 
const SPARQL_DELETE_INSERT
 Delete/Insert query. More...
 
const SPARQL_INSERT
 Insert query. More...
 
 SPARQLD
 
 SPARQLDI
 
- Public Attributes inherited from Maintenance
resource $fileHandle
 Used when creating separate schema files. More...
 
 $mDbPass
 
array $orderedOptions = []
 Used to read the options in the order they were passed. More...
 
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

 getCategoryLinksIterator (IDatabase $dbr, array $ids)
 Get iterator for links for categories. More...
 
 getChangedCatsIterator (IDatabase $dbr, $type)
 Fetch categorization changes or edits. More...
 
 getDeletedCatsIterator (IDatabase $dbr)
 Fetch deleted categories. More...
 
 getMovedCatsIterator (IDatabase $dbr)
 Fetch moved categories. More...
 
 getNewCatsIterator (IDatabase $dbr)
 Fetch newly created categories. More...
 
 getRestoredCatsIterator (IDatabase $dbr)
 Fetch restored categories. More...
 
- Protected Member Functions inherited from Maintenance
 activateProfiler ()
 Activate the profiler (assuming $wgProfiler is set) More...
 
 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, $multiOccurrence=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...
 
 beginTransaction (IDatabase $dbw, $fname)
 Begin a transcation on a DB. More...
 
 commitTransaction (IDatabase $dbw, $fname)
 Commit the transcation on a DB handle and wait for replica DBs to catch up. More...
 
 countDown ( $seconds)
 Count down from $seconds to zero on the terminal, with a one-second pause between showing each number. More...
 
 deleteOption ( $name)
 Remove an option. More...
 
 error ( $err, $die=0)
 Throw an error to the user. More...
 
 fatalError ( $msg, $exitCode=1)
 Output a message and terminate the current script. More...
 
 getArg ( $argId=0, $default=null)
 Get an argument. More...
 
 getBatchSize ()
 Returns batch size. More...
 
 getDB ( $db, $groups=[], $dbDomain=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 option 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...
 
 requireExtension ( $name)
 Indicate that the specified extension must be loaded before the script can run. More...
 
 rollbackTransaction (IDatabase $dbw, $fname)
 Rollback the transcation on a DB handle. More...
 
 setAllowUnregisteredOptions ( $allow)
 Sets whether to allow unregistered options, which are options passed to a script that do not match an expected parameter. More...
 
 setBatchSize ( $s=0)
 Set the batch size. More...
 
 supportsOption ( $name)
 Checks to see if a particular option in supported. More...
 

Protected Attributes

int [] $processed = []
 List of processed page IDs, so we don't try to process same thing twice. More...
 
- Protected Attributes inherited from Maintenance
 $mAllowUnregisteredOptions = false
 
 $mArgList = []
 
 $mArgs = []
 
int $mBatchSize = null
 Batch size. More...
 
 $mDbUser
 
 $mDescription = ''
 
 $mInputLoaded = false
 
 $mOptions = []
 
array [] $mParams = []
 Array of desired/allowed params. More...
 
 $mQuiet = false
 
 $mSelf
 
 $mShortParamsMap = []
 

Private Member Functions

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

Private Attributes

CategoriesRdf $categoriesRdf
 Categories RDF helper. More...
 
 $endTS
 
RdfWriter $rdfWriter
 
 $startTS
 

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). More...
 
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 requireTestsAutoloader ()
 Call this to set up the autoloader to allow classes to be used from the tests directory. More...
 
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) More...
 

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

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 397 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 386 of file categoryChangesAsRdf.php.

References BatchRowIterator\addConditions(), Wikimedia\Rdbms\IDatabase\addQuotes(), and Wikimedia\Rdbms\IDatabase\timestamp().

Referenced by getDeletedCatsIterator(), and setupChangesIterator().

◆ execute()

◆ getCategoriesUpdate()

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

Get SPARQL for updating set of categories.

Parameters
IDatabase$dbr
string[]$deleteUrls List of URIs to be deleted, with <>
string[]$pages List 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 handleDeletes(), handleEdits(), and handleMoves().

◆ getCategoryLinksIterator()

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

Get iterator for links for categories.

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

Definition at line 409 of file categoryChangesAsRdf.php.

Referenced by writeParentCategories().

◆ getChangedCatsIterator()

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

Fetch categorization changes or edits.

Parameters
IDatabase$dbr
Returns
BatchRowIterator

Definition at line 369 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 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 428 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 526 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 584 of file categoryChangesAsRdf.php.

References getChangedCatsIterator(), NS_CATEGORY, RC_CATEGORIZE, Wikimedia\Rdbms\IDatabase\select(), 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 437 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 554 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 467 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 497 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[]$columns List of additional fields to get
string[]$extra_tables List of additional tables to join
Returns
BatchRowIterator

Definition at line 247 of file categoryChangesAsRdf.php.

References 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 SPARQL, and wfTimestamp().

Referenced by execute().

◆ writeCategoryData()

CategoryChangesAsRdf::writeCategoryData (   $row)
private

Write category data to RDF.

Parameters
stdclass$rowDatabase row

Definition at line 454 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[]$pages List 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

CategoryChangesAsRdf::SPARQL

Definition at line 40 of file categoryChangesAsRdf.php.

Referenced by updateTS().

◆ SPARQL_DELETE

const CategoryChangesAsRdf::SPARQL_DELETE
Initial value:
= <<<SPARQLD
DELETE {
?category ?x ?y
} WHERE {
?category ?x ?y
VALUES ?category {
%s
}
}

Delete query.

Definition at line 45 of file categoryChangesAsRdf.php.

◆ SPARQL_DELETE_INSERT

const CategoryChangesAsRdf::SPARQL_DELETE_INSERT
Initial value:
DELETE {
?category ?x ?y
} INSERT {
%s
} WHERE {
?category ?x ?y
VALUES ?category {
%s
}
}

Delete/Insert query.

Definition at line 60 of file categoryChangesAsRdf.php.

◆ SPARQL_INSERT

const CategoryChangesAsRdf::SPARQL_INSERT
Initial value:
= <<<SPARQL
INSERT DATA {
%s
}

Insert query.

Definition at line 35 of file categoryChangesAsRdf.php.

◆ SPARQLD

CategoryChangesAsRdf::SPARQLD

Definition at line 55 of file categoryChangesAsRdf.php.

◆ SPARQLDI

CategoryChangesAsRdf::SPARQLDI

Definition at line 72 of file categoryChangesAsRdf.php.


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