MediaWiki  master
NamespaceAwareForeignTitleFactory.php
Go to the documentation of this file.
1 <?php
21 namespace MediaWiki\Title;
22 
31  protected $foreignNamespaces;
35  private $foreignNamespacesFlipped;
36 
42  private function normalizeNamespaceName( $name ) {
43  return strtolower( str_replace( ' ', '_', $name ) );
44  }
45 
53  public function __construct( $foreignNamespaces ) {
54  $this->foreignNamespaces = $foreignNamespaces;
55  if ( $foreignNamespaces !== null ) {
56  $this->foreignNamespacesFlipped = [];
57  foreach ( $foreignNamespaces as $id => $name ) {
58  $newKey = self::normalizeNamespaceName( $name );
59  $this->foreignNamespacesFlipped[$newKey] = $id;
60  }
61  }
62  }
63 
75  public function createForeignTitle( $title, $ns = null ) {
76  // Export schema version 0.5 and earlier (MW 1.18 and earlier) does not
77  // contain a <ns> tag, so we need to be able to handle that case.
78  if ( $ns === null ) {
79  return self::parseTitleNoNs( $title );
80  } else {
81  return self::parseTitleWithNs( $title, $ns );
82  }
83  }
84 
91  protected function parseTitleNoNs( $title ) {
92  $pieces = explode( ':', $title, 2 );
93  $key = self::normalizeNamespaceName( $pieces[0] );
94 
95  // Does the part before the colon match a known namespace? Check the
96  // foreign namespaces
97  $isNamespacePartValid = isset( $this->foreignNamespacesFlipped[$key] );
98 
99  if ( count( $pieces ) === 2 && $isNamespacePartValid ) {
100  [ $namespaceName, $pageName ] = $pieces;
101  $ns = $this->foreignNamespacesFlipped[$key];
102  } else {
103  $namespaceName = '';
104  $pageName = $title;
105  $ns = 0;
106  }
107 
108  return new ForeignTitle( $ns, $namespaceName, $pageName );
109  }
110 
118  protected function parseTitleWithNs( $title, $ns ) {
119  $pieces = explode( ':', $title, 2 );
120 
121  // Is $title of the form Namespace:Title (true), or just Title (false)?
122  $titleIncludesNamespace = ( $ns != '0' && count( $pieces ) === 2 );
123 
124  if ( isset( $this->foreignNamespaces[$ns] ) ) {
125  $namespaceName = $this->foreignNamespaces[$ns];
126  } else {
127  // If the foreign wiki is misconfigured, XML dumps can contain a page with
128  // a non-zero namespace ID, but whose title doesn't contain a colon
129  // (T114115). In those cases, output a made-up namespace name to avoid
130  // collisions. The ImportTitleFactory might replace this with something
131  // more appropriate.
132  $namespaceName = $titleIncludesNamespace ? $pieces[0] : "Ns$ns";
133  }
134 
135  // We assume that the portion of the page title before the colon is the
136  // namespace name, except in the case of namespace 0.
137  if ( $titleIncludesNamespace ) {
138  $pageName = $pieces[1];
139  } else {
140  $pageName = $title;
141  }
142 
143  return new ForeignTitle( $ns, $namespaceName, $pageName );
144  }
145 }
146 
151 class_alias( NamespaceAwareForeignTitleFactory::class, 'NamespaceAwareForeignTitleFactory' );
A simple, immutable structure to hold the title of a page on a foreign MediaWiki installation.
A parser that translates page titles on a foreign wiki into ForeignTitle objects, using information a...
parseTitleWithNs( $title, $ns)
Helper function to parse the title when the namespace value is known.
createForeignTitle( $title, $ns=null)
Create a ForeignTitle object.
parseTitleNoNs( $title)
Helper function to parse the title when the namespace ID is not specified.
A parser that translates page titles into ForeignTitle objects.