3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2 of the License, or
6 * (at your option) any later version.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 * http://www.gnu.org/copyleft/gpl.html
19 use Wikimedia\Purtle\RdfWriter
;
22 * Helper class to produce RDF representation of categories.
26 * Prefix used for Mediawiki ontology in the dump.
28 const ONTOLOGY_PREFIX
= 'mediawiki';
30 * Base URL for Mediawiki ontology.
32 const ONTOLOGY_URL
= 'https://www.mediawiki.org/ontology#';
34 * OWL description of the ontology.
36 const OWL_URL
= 'https://www.mediawiki.org/ontology/ontology.owl';
38 * Current version of the dump format.
40 const FORMAT_VERSION
= "1.1";
42 * Special page for Dump identification.
43 * Used as head URI for each wiki's category dump, e.g.:
44 * https://en.wikipedia.org/wiki/Special:CategoryDump
46 const SPECIAL_DUMP
= 'Special:CategoryDump';
52 public function __construct( RdfWriter
$writer ) {
53 $this->rdfWriter
= $writer;
57 * Setup prefixes relevant for the dump
59 public function setupPrefixes() {
60 $this->rdfWriter
->prefix( self
::ONTOLOGY_PREFIX
, self
::ONTOLOGY_URL
);
61 $this->rdfWriter
->prefix( 'rdfs', 'http://www.w3.org/2000/01/rdf-schema#' );
62 $this->rdfWriter
->prefix( 'owl', 'http://www.w3.org/2002/07/owl#' );
63 $this->rdfWriter
->prefix( 'schema', 'http://schema.org/' );
64 $this->rdfWriter
->prefix( 'cc', 'http://creativecommons.org/ns#' );
68 * Write RDF data for link between categories.
69 * @param string $fromName Child category name
70 * @param string $toName Parent category name
72 public function writeCategoryLinkData( $fromName, $toName ) {
73 $titleFrom = Title
::makeTitle( NS_CATEGORY
, $fromName );
74 $titleTo = Title
::makeTitle( NS_CATEGORY
, $toName );
75 $this->rdfWriter
->about( $this->titleToUrl( $titleFrom ) )
76 ->say( self
::ONTOLOGY_PREFIX
, 'isInCategory' )
77 ->is( $this->titleToUrl( $titleTo ) );
81 * Write out the data for single category.
82 * @param string $categoryName Category name
83 * @param bool $isHidden Hidden category?
84 * @param int $pages Page count (note this includes only Wiki articles, not subcats or files)
85 * @param int $subcategories Subcategory count
87 public function writeCategoryData( $categoryName, $isHidden, $pages, $subcategories ) {
92 $title = Title
::makeTitle( NS_CATEGORY
, $categoryName );
93 $this->rdfWriter
->about( $this->titleToUrl( $title ) )
95 ->is( self
::ONTOLOGY_PREFIX
, 'Category' );
97 $this->rdfWriter
->is( self
::ONTOLOGY_PREFIX
, 'HiddenCategory' );
99 $titletext = $title->getText();
100 $this->rdfWriter
->say( 'rdfs', 'label' )->value( $titletext );
101 $this->rdfWriter
->say( self
::ONTOLOGY_PREFIX
, 'pages' )->value( $pages );
102 $this->rdfWriter
->say( self
::ONTOLOGY_PREFIX
, 'subcategories' )->value( $subcategories );
103 // TODO: do we want files too here? Easy to add, but don't have use case so far.
107 * Make URL from title label
108 * @param string $titleLabel Short label (without namespace) of the category
109 * @return string URL for the category
111 public function labelToUrl( $titleLabel ) {
112 return $this->titleToUrl( Title
::makeTitle( NS_CATEGORY
, $titleLabel ) );
116 * Convert Title to link to target page.
117 * @param Title $title
118 * @return string URL for the category
120 private function titleToUrl( Title
$title ) {
121 return $title->getFullURL( '', false, PROTO_CANONICAL
);
125 * Get URI of the dump for this particular wiki.
126 * @return false|string
128 public function getDumpURI() {
129 return $this->titleToUrl( Title
::makeTitle( NS_MAIN
, self
::SPECIAL_DUMP
) );