NamespaceAwareForeignTitleFactory.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Title;
 
class NamespaceAwareForeignTitleFactory implements ForeignTitleFactory {
    protected $foreignNamespaces;
    private $foreignNamespacesFlipped;
 
    private function normalizeNamespaceName( $name ) {
        return strtolower( str_replace( ' ', '_', $name ) );
    }
 
    public function __construct( $foreignNamespaces ) {
        $this->foreignNamespaces = $foreignNamespaces;
        if ( $foreignNamespaces !== null ) {
            $this->foreignNamespacesFlipped = [];
            foreach ( $foreignNamespaces as $id => $name ) {
                $newKey = self::normalizeNamespaceName( $name );
                $this->foreignNamespacesFlipped[$newKey] = $id;
            }
        }
    }
 
    public function createForeignTitle( $title, $ns = null ) {
        // Export schema version 0.5 and earlier (MW 1.18 and earlier) does not
        // contain a <ns> tag, so we need to be able to handle that case.
        if ( $ns === null ) {
            return self::parseTitleNoNs( $title );
        } else {
            return self::parseTitleWithNs( $title, $ns );
        }
    }
 
    protected function parseTitleNoNs( $title ) {
        $pieces = explode( ':', $title, 2 );
        $key = self::normalizeNamespaceName( $pieces[0] );
 
        // Does the part before the colon match a known namespace? Check the
        // foreign namespaces
        $isNamespacePartValid = isset( $this->foreignNamespacesFlipped[$key] );
 
        if ( count( $pieces ) === 2 && $isNamespacePartValid ) {
            [ $namespaceName, $pageName ] = $pieces;
            $ns = $this->foreignNamespacesFlipped[$key];
        } else {
            $namespaceName = '';
            $pageName = $title;
            $ns = 0;
        }
 
        return new ForeignTitle( $ns, $namespaceName, $pageName );
    }
 
    protected function parseTitleWithNs( $title, $ns ) {
        $pieces = explode( ':', $title, 2 );
 
        // Is $title of the form Namespace:Title (true), or just Title (false)?
        $titleIncludesNamespace = ( $ns != '0' && count( $pieces ) === 2 );
 
        if ( isset( $this->foreignNamespaces[$ns] ) ) {
            $namespaceName = $this->foreignNamespaces[$ns];
        } else {
            // If the foreign wiki is misconfigured, XML dumps can contain a page with
            // a non-zero namespace ID, but whose title doesn't contain a colon
            // (T114115). In those cases, output a made-up namespace name to avoid
            // collisions. The ImportTitleFactory might replace this with something
            // more appropriate.
            $namespaceName = $titleIncludesNamespace ? $pieces[0] : "Ns$ns";
        }
 
        // We assume that the portion of the page title before the colon is the
        // namespace name, except in the case of namespace 0.
        if ( $titleIncludesNamespace ) {
            $pageName = $pieces[1];
        } else {
            $pageName = $title;
        }
 
        return new ForeignTitle( $ns, $namespaceName, $pageName );
    }
}
 
class_alias( NamespaceAwareForeignTitleFactory::class, 'NamespaceAwareForeignTitleFactory' );