MediaWiki REL1_33
dumpCategoriesAsRdf.php
Go to the documentation of this file.
1<?php
19use Wikimedia\Purtle\RdfWriter;
20use Wikimedia\Purtle\RdfWriterFactory;
22
23require_once __DIR__ . '/Maintenance.php';
24
35 private $rdfWriter;
41
42 public function __construct() {
43 parent::__construct();
44
45 $this->addDescription( "Generate RDF dump of categories in a wiki." );
46
47 $this->setBatchSize( 200 );
48 $this->addOption( 'output', "Output file (default is stdout). Will be overwritten.",
49 false, true );
50 $this->addOption( 'format', "Set the dump format.", false, true );
51 }
52
58 public function getCategoryIterator( IDatabase $dbr ) {
59 $it = new BatchRowIterator(
60 $dbr,
61 [ 'page', 'page_props', 'category' ],
62 [ 'page_title' ],
63 $this->getBatchSize()
64 );
65 $it->addConditions( [
66 'page_namespace' => NS_CATEGORY,
67 ] );
68 $it->setFetchColumns( [
69 'page_title',
70 'page_id',
71 'pp_propname',
72 'cat_pages',
73 'cat_subcats',
74 'cat_files'
75 ] );
76 $it->addJoinConditions(
77 [
78 'page_props' => [
79 'LEFT JOIN', [ 'pp_propname' => 'hiddencat', 'pp_page = page_id' ]
80 ],
81 'category' => [
82 'LEFT JOIN', [ 'cat_title = page_title' ]
83 ]
84 ]
85
86 );
87 return $it;
88 }
89
96 public function getCategoryLinksIterator( IDatabase $dbr, array $ids ) {
97 $it = new BatchRowIterator(
98 $dbr,
99 'categorylinks',
100 [ 'cl_from', 'cl_to' ],
101 $this->getBatchSize()
102 );
103 $it->addConditions( [
104 'cl_type' => 'subcat',
105 'cl_from' => $ids
106 ] );
107 $it->setFetchColumns( [ 'cl_from', 'cl_to' ] );
108 return new RecursiveIteratorIterator( $it );
109 }
110
114 public function addDumpHeader( $timestamp ) {
115 global $wgRightsUrl;
116 $licenseUrl = $wgRightsUrl;
117 if ( substr( $licenseUrl, 0, 2 ) == '//' ) {
118 $licenseUrl = 'https:' . $licenseUrl;
119 }
120 $this->rdfWriter->about( $this->categoriesRdf->getDumpURI() )
121 ->a( 'schema', 'Dataset' )
122 ->a( 'owl', 'Ontology' )
123 ->say( 'cc', 'license' )->is( $licenseUrl )
124 ->say( 'schema', 'softwareVersion' )->value( CategoriesRdf::FORMAT_VERSION )
125 ->say( 'schema', 'dateModified' )
126 ->value( wfTimestamp( TS_ISO_8601, $timestamp ), 'xsd', 'dateTime' )
127 ->say( 'schema', 'isPartOf' )->is( wfExpandUrl( '/', PROTO_CANONICAL ) )
128 ->say( 'owl', 'imports' )->is( CategoriesRdf::OWL_URL );
129 }
130
131 public function execute() {
132 $outFile = $this->getOption( 'output', 'php://stdout' );
133
134 if ( $outFile === '-' ) {
135 $outFile = 'php://stdout';
136 }
137
138 $output = fopen( $outFile, 'w' );
139 $this->rdfWriter = $this->createRdfWriter( $this->getOption( 'format', 'ttl' ) );
140 $this->categoriesRdf = new CategoriesRdf( $this->rdfWriter );
141
142 $this->categoriesRdf->setupPrefixes();
143 $this->rdfWriter->start();
144
145 $this->addDumpHeader( time() );
146 fwrite( $output, $this->rdfWriter->drain() );
147
148 $dbr = $this->getDB( DB_REPLICA, [ 'vslow' ] );
149
150 foreach ( $this->getCategoryIterator( $dbr ) as $batch ) {
151 $pages = [];
152 foreach ( $batch as $row ) {
153 $this->categoriesRdf->writeCategoryData(
154 $row->page_title,
155 $row->pp_propname === 'hiddencat',
156 (int)$row->cat_pages - (int)$row->cat_subcats - (int)$row->cat_files,
157 (int)$row->cat_subcats
158 );
159 $pages[$row->page_id] = $row->page_title;
160 }
161
162 foreach ( $this->getCategoryLinksIterator( $dbr, array_keys( $pages ) ) as $row ) {
163 $this->categoriesRdf->writeCategoryLinkData( $pages[$row->cl_from], $row->cl_to );
164 }
165 fwrite( $output, $this->rdfWriter->drain() );
166 }
167 fflush( $output );
168 if ( $outFile !== '-' ) {
169 fclose( $output );
170 }
171 }
172
177 private function createRdfWriter( $format ) {
178 $factory = new RdfWriterFactory();
179 return $factory->getWriter( $factory->getFormatName( $format ) );
180 }
181}
182
183$maintClass = DumpCategoriesAsRdf::class;
184require_once RUN_MAINTENANCE_IF_MAIN;
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
$wgRightsUrl
Set this to specify an external URL containing details about the content license used on your wiki.
wfExpandUrl( $url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
Helper class to produce RDF representation of categories.
const FORMAT_VERSION
Current version of the dump format.
const OWL_URL
OWL description of the ontology.
Maintenance script to provide RDF representation of the category tree.
getCategoryIterator(IDatabase $dbr)
Produce row iterator for categories.
getCategoryLinksIterator(IDatabase $dbr, array $ids)
Get iterator for links for categories.
execute()
Do the actual work.
CategoriesRdf $categoriesRdf
Categories RDF helper.
__construct()
Default constructor.
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
getDB( $db, $groups=[], $wiki=false)
Returns a database to be used by current maintenance script.
getBatchSize()
Returns batch size.
addDescription( $text)
Set the description text.
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
getOption( $name, $default=null)
Get an option, or return the default.
setBatchSize( $s=0)
Set the batch size.
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
const PROTO_CANONICAL
Definition Defines.php:232
const NS_CATEGORY
Definition Defines.php:87
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response after the basic globals have been set but before ordinary actions take place $output
Definition hooks.txt:2272
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition injection.txt:37
Basic database interface for live and lazy-loaded relation database handles.
Definition IDatabase.php:38
$batch
Definition linkcache.txt:23
require_once RUN_MAINTENANCE_IF_MAIN
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
const DB_REPLICA
Definition defines.php:25